2012-08-15 Segher Boessenkool <segher@kernel.crashing.org>
[official-gcc.git] / gcc / doc / invoke.texi
blob78bcde7a712e75b894a836c10d65d43d8a647cb3
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, 2011, 2012
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, 2011,
15 2012
16 Free Software Foundation, Inc.
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU Free Documentation License, Version 1.3 or
20 any later version published by the Free Software Foundation; with the
21 Invariant Sections being ``GNU General Public License'' and ``Funding
22 Free Software'', the Front-Cover texts being (a) (see below), and with
23 the Back-Cover Texts being (b) (see below).  A copy of the license is
24 included in the gfdl(7) man page.
26 (a) The FSF's Front-Cover Text is:
28      A GNU Manual
30 (b) The FSF's Back-Cover Text is:
32      You have freedom to copy and modify this GNU Manual, like GNU
33      software.  Copies published by the Free Software Foundation raise
34      funds for GNU development.
35 @c man end
36 @c Set file name and title for the man page.
37 @setfilename gcc
38 @settitle GNU project C and C++ compiler
39 @c man begin SYNOPSIS
40 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
41     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
42     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
43     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
44     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
45     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
46     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
48 Only the most useful options are listed here; see below for the
49 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
50 @c man end
51 @c man begin SEEALSO
52 gpl(7), gfdl(7), fsf-funding(7),
53 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
54 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
55 @file{ld}, @file{binutils} and @file{gdb}.
56 @c man end
57 @c man begin BUGS
58 For instructions on reporting bugs, see
59 @w{@value{BUGURL}}.
60 @c man end
61 @c man begin AUTHOR
62 See the Info entry for @command{gcc}, or
63 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
64 for contributors to GCC@.
65 @c man end
66 @end ignore
68 @node Invoking GCC
69 @chapter GCC Command Options
70 @cindex GCC command options
71 @cindex command options
72 @cindex options, GCC command
74 @c man begin DESCRIPTION
75 When you invoke GCC, it normally does preprocessing, compilation,
76 assembly and linking.  The ``overall options'' allow you to stop this
77 process at an intermediate stage.  For example, the @option{-c} option
78 says not to run the linker.  Then the output consists of object files
79 output by the assembler.
81 Other options are passed on to one stage of processing.  Some options
82 control the preprocessor and others the compiler itself.  Yet other
83 options control the assembler and linker; most of these are not
84 documented here, since you rarely need to use any of them.
86 @cindex C compilation options
87 Most of the command-line options that you can use with GCC are useful
88 for C programs; when an option is only useful with another language
89 (usually C++), the explanation says so explicitly.  If the description
90 for a particular option does not mention a source language, you can use
91 that option with all supported languages.
93 @cindex C++ compilation options
94 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
95 options for compiling C++ programs.
97 @cindex grouping options
98 @cindex options, grouping
99 The @command{gcc} program accepts options and file names as operands.  Many
100 options have multi-letter names; therefore multiple single-letter options
101 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
102 -v}}.
104 @cindex order of options
105 @cindex options, order
106 You can mix options and other arguments.  For the most part, the order
107 you use doesn't matter.  Order does matter when you use several
108 options of the same kind; for example, if you specify @option{-L} more
109 than once, the directories are searched in the order specified.  Also,
110 the placement of the @option{-l} option is significant.
112 Many options have long names starting with @samp{-f} or with
113 @samp{-W}---for example,
114 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
115 these have both positive and negative forms; the negative form of
116 @option{-ffoo} is @option{-fno-foo}.  This manual documents
117 only one of these two forms, whichever one is not the default.
119 @c man end
121 @xref{Option Index}, for an index to GCC's options.
123 @menu
124 * Option Summary::      Brief list of all options, without explanations.
125 * Overall Options::     Controlling the kind of output:
126                         an executable, object files, assembler files,
127                         or preprocessed source.
128 * Invoking G++::        Compiling C++ programs.
129 * C Dialect Options::   Controlling the variant of C language compiled.
130 * C++ Dialect Options:: Variations on C++.
131 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
132                         and Objective-C++.
133 * Language Independent Options:: Controlling how diagnostics should be
134                         formatted.
135 * Warning Options::     How picky should the compiler be?
136 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
137 * Optimize Options::    How much optimization?
138 * Preprocessor Options:: Controlling header files and macro definitions.
139                          Also, getting dependency information for Make.
140 * Assembler Options::   Passing options to the assembler.
141 * Link Options::        Specifying libraries and so on.
142 * Directory Options::   Where to find header files and libraries.
143                         Where to find the compiler executable files.
144 * Spec Files::          How to pass switches to sub-processes.
145 * Target Options::      Running a cross-compiler, or an old version of GCC.
146 * Submodel Options::    Specifying minor hardware or convention variations,
147                         such as 68010 vs 68020.
148 * Code Gen Options::    Specifying conventions for function calls, data layout
149                         and register usage.
150 * Environment Variables:: Env vars that affect GCC.
151 * Precompiled Headers:: Compiling a header once, and using it many times.
152 @end menu
154 @c man begin OPTIONS
156 @node Option Summary
157 @section Option Summary
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
166 -pipe  -pass-exit-codes  @gol
167 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
168 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
169 -fdump-ada-spec@r{[}-slim@r{]} -fdump-go-spec=@var{file}}
171 @item C Language Options
172 @xref{C Dialect Options,,Options Controlling C Dialect}.
173 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
174 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
175 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
176 -fhosted  -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
177 -trigraphs  -traditional  -traditional-cpp @gol
178 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
179 -fsigned-bitfields  -fsigned-char @gol
180 -funsigned-bitfields  -funsigned-char}
182 @item C++ Language Options
183 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
184 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
185 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
186 -fno-elide-constructors @gol
187 -fno-enforce-eh-specs @gol
188 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
189 -fno-implicit-templates @gol
190 -fno-implicit-inline-templates @gol
191 -fno-implement-inlines  -fms-extensions @gol
192 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
193 -fno-optional-diags  -fpermissive @gol
194 -fno-pretty-templates @gol
195 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
196 -ftemplate-depth=@var{n} @gol
197 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
198 -fno-default-inline  -fvisibility-inlines-hidden @gol
199 -fvisibility-ms-compat @gol
200 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -freplace-objc-classes @gol
222 -fzero-link @gol
223 -gen-decls @gol
224 -Wassign-intercept @gol
225 -Wno-protocol  -Wselector @gol
226 -Wstrict-selector-match @gol
227 -Wundeclared-selector}
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n}  @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
233 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
238 -pedantic-errors @gol
239 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment @gol
243 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
244 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
261 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
262 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type  -Wsequence-point  -Wshadow @gol
266 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
267 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
268 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
323 -ftree-vectorizer-verbose=@var{n} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
337 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
346 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
347 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
355 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
356 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
357 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
358 -fcompare-elim -fcprop-registers -fcrossjumping @gol
359 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
360 -fcx-limited-range @gol
361 -fdata-sections -fdce -fdelayed-branch @gol
362 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
363 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
364 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
365 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
366 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
367 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
368 -fif-conversion2 -findirect-inlining @gol
369 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
370 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
371 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
372 -fira-algorithm=@var{algorithm} @gol
373 -fira-region=@var{region} @gol
374 -fira-loop-pressure -fno-ira-share-save-slots @gol
375 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
376 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
377 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
378 -floop-parallelize-all -flto -flto-compression-level @gol
379 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
380 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
381 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
382 -fno-default-inline @gol
383 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
384 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
385 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
386 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
387 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
388 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
389 -fprefetch-loop-arrays @gol
390 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
391 -fprofile-generate=@var{path} @gol
392 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
393 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
394 -freorder-blocks-and-partition -freorder-functions @gol
395 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
396 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
397 -fsched-spec-load -fsched-spec-load-dangerous @gol
398 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
399 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
400 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
401 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
402 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
403 -fselective-scheduling -fselective-scheduling2 @gol
404 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
405 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
406 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
407 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
408 -fthread-jumps -ftracer -ftree-bit-ccp @gol
409 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
410 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
411 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
412 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
413 -ftree-loop-if-convert-stores -ftree-loop-im @gol
414 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
415 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
416 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
417 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
418 -ftree-switch-conversion -ftree-tail-merge @gol
419 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
420 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
421 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
422 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
423 -fwhole-program -fwpa -fuse-linker-plugin @gol
424 --param @var{name}=@var{value}
425 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
427 @item Preprocessor Options
428 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
429 @gccoptlist{-A@var{question}=@var{answer} @gol
430 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
431 -C  -dD  -dI  -dM  -dN @gol
432 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
433 -idirafter @var{dir} @gol
434 -include @var{file}  -imacros @var{file} @gol
435 -iprefix @var{file}  -iwithprefix @var{dir} @gol
436 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
437 -imultilib @var{dir} -isysroot @var{dir} @gol
438 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
439 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
440 -remap -trigraphs  -undef  -U@var{macro}  @gol
441 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
443 @item Assembler Option
444 @xref{Assembler Options,,Passing Options to the Assembler}.
445 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
447 @item Linker Options
448 @xref{Link Options,,Options for Linking}.
449 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
450 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
451 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
452 -shared-libgcc  -symbolic @gol
453 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
454 -u @var{symbol}}
456 @item Directory Options
457 @xref{Directory Options,,Options for Directory Search}.
458 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
459 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
460 --sysroot=@var{dir}}
462 @item Machine Dependent Options
463 @xref{Submodel Options,,Hardware Models and Configurations}.
464 @c This list is ordered alphanumerically by subsection name.
465 @c Try and put the significant identifier (CPU or system) first,
466 @c so users have a clue at guessing where the ones they want will be.
468 @emph{Adapteva Epiphany Options}
469 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
470 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
471 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
472 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
473 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
474 -msplit-vecmove-early -m1reg-@var{reg}}
476 @emph{ARM Options}
477 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
478 -mabi=@var{name} @gol
479 -mapcs-stack-check  -mno-apcs-stack-check @gol
480 -mapcs-float  -mno-apcs-float @gol
481 -mapcs-reentrant  -mno-apcs-reentrant @gol
482 -msched-prolog  -mno-sched-prolog @gol
483 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
484 -mfloat-abi=@var{name} @gol
485 -mfp16-format=@var{name}
486 -mthumb-interwork  -mno-thumb-interwork @gol
487 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
488 -mstructure-size-boundary=@var{n} @gol
489 -mabort-on-noreturn @gol
490 -mlong-calls  -mno-long-calls @gol
491 -msingle-pic-base  -mno-single-pic-base @gol
492 -mpic-register=@var{reg} @gol
493 -mnop-fun-dllimport @gol
494 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
495 -mpoke-function-name @gol
496 -mthumb  -marm @gol
497 -mtpcs-frame  -mtpcs-leaf-frame @gol
498 -mcaller-super-interworking  -mcallee-super-interworking @gol
499 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
500 -mword-relocations @gol
501 -mfix-cortex-m3-ldrd @gol
502 -munaligned-access}
504 @emph{AVR Options}
505 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
506 -mcall-prologues -mint8 -mno-interrupts -mrelax -mshort-calls @gol
507 -mstrict-X -mtiny-stack}
509 @emph{Blackfin Options}
510 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
511 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
512 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
513 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
514 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
515 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
516 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
517 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
518 -micplb}
520 @emph{C6X Options}
521 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
522 -msim -msdata=@var{sdata-type}}
524 @emph{CRIS Options}
525 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
526 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
527 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
528 -mstack-align  -mdata-align  -mconst-align @gol
529 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
530 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
531 -mmul-bug-workaround  -mno-mul-bug-workaround}
533 @emph{CR16 Options}
534 @gccoptlist{-mmac @gol
535 -mcr16cplus -mcr16c @gol
536 -msim -mint32 -mbit-ops
537 -mdata-model=@var{model}}
539 @emph{Darwin Options}
540 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
541 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
542 -client_name  -compatibility_version  -current_version @gol
543 -dead_strip @gol
544 -dependency-file  -dylib_file  -dylinker_install_name @gol
545 -dynamic  -dynamiclib  -exported_symbols_list @gol
546 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
547 -force_flat_namespace  -headerpad_max_install_names @gol
548 -iframework @gol
549 -image_base  -init  -install_name  -keep_private_externs @gol
550 -multi_module  -multiply_defined  -multiply_defined_unused @gol
551 -noall_load   -no_dead_strip_inits_and_terms @gol
552 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
553 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
554 -private_bundle  -read_only_relocs  -sectalign @gol
555 -sectobjectsymbols  -whyload  -seg1addr @gol
556 -sectcreate  -sectobjectsymbols  -sectorder @gol
557 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
558 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
559 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
560 -single_module  -static  -sub_library  -sub_umbrella @gol
561 -twolevel_namespace  -umbrella  -undefined @gol
562 -unexported_symbols_list  -weak_reference_mismatches @gol
563 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
564 -mkernel -mone-byte-bool}
566 @emph{DEC Alpha Options}
567 @gccoptlist{-mno-fp-regs  -msoft-float @gol
568 -mieee  -mieee-with-inexact  -mieee-conformant @gol
569 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
570 -mtrap-precision=@var{mode}  -mbuild-constants @gol
571 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
572 -mbwx  -mmax  -mfix  -mcix @gol
573 -mfloat-vax  -mfloat-ieee @gol
574 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
575 -msmall-text  -mlarge-text @gol
576 -mmemory-latency=@var{time}}
578 @emph{FR30 Options}
579 @gccoptlist{-msmall-model -mno-lsim}
581 @emph{FRV Options}
582 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
583 -mhard-float  -msoft-float @gol
584 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
585 -mdouble  -mno-double @gol
586 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
587 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
588 -mlinked-fp  -mlong-calls  -malign-labels @gol
589 -mlibrary-pic  -macc-4  -macc-8 @gol
590 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
591 -moptimize-membar -mno-optimize-membar @gol
592 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
593 -mvliw-branch  -mno-vliw-branch @gol
594 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
595 -mno-nested-cond-exec  -mtomcat-stats @gol
596 -mTLS -mtls @gol
597 -mcpu=@var{cpu}}
599 @emph{GNU/Linux Options}
600 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
601 -tno-android-cc -tno-android-ld}
603 @emph{H8/300 Options}
604 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
606 @emph{HPPA Options}
607 @gccoptlist{-march=@var{architecture-type} @gol
608 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
609 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
610 -mfixed-range=@var{register-range} @gol
611 -mjump-in-delay -mlinker-opt -mlong-calls @gol
612 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
613 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
614 -mno-jump-in-delay  -mno-long-load-store @gol
615 -mno-portable-runtime  -mno-soft-float @gol
616 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
617 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
618 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
619 -munix=@var{unix-std}  -nolibdld  -static  -threads}
621 @emph{i386 and x86-64 Options}
622 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
623 -mfpmath=@var{unit} @gol
624 -masm=@var{dialect}  -mno-fancy-math-387 @gol
625 -mno-fp-ret-in-387  -msoft-float @gol
626 -mno-wide-multiply  -mrtd  -malign-double @gol
627 -mpreferred-stack-boundary=@var{num} @gol
628 -mincoming-stack-boundary=@var{num} @gol
629 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
630 -mrecip -mrecip=@var{opt} @gol
631 -mvzeroupper @gol
632 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
633 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
634 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
635 -mbmi2 -mrtm -mlwp -mthreads @gol
636 -mno-align-stringops  -minline-all-stringops @gol
637 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
638 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
639 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
640 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
641 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
642 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
643 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
644 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
645 -msse2avx -mfentry -m8bit-idiv @gol
646 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
648 @emph{i386 and x86-64 Windows Options}
649 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
650 -mnop-fun-dllimport -mthread @gol
651 -municode -mwin32 -mwindows -fno-set-stack-executable}
653 @emph{IA-64 Options}
654 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
655 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
656 -mconstant-gp  -mauto-pic  -mfused-madd @gol
657 -minline-float-divide-min-latency @gol
658 -minline-float-divide-max-throughput @gol
659 -mno-inline-float-divide @gol
660 -minline-int-divide-min-latency @gol
661 -minline-int-divide-max-throughput  @gol
662 -mno-inline-int-divide @gol
663 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
664 -mno-inline-sqrt @gol
665 -mdwarf2-asm -mearly-stop-bits @gol
666 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
667 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
668 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
669 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
670 -msched-spec-ldc -msched-spec-control-ldc @gol
671 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
672 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
673 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
674 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
676 @emph{LM32 Options}
677 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
678 -msign-extend-enabled -muser-enabled}
680 @emph{M32R/D Options}
681 @gccoptlist{-m32r2 -m32rx -m32r @gol
682 -mdebug @gol
683 -malign-loops -mno-align-loops @gol
684 -missue-rate=@var{number} @gol
685 -mbranch-cost=@var{number} @gol
686 -mmodel=@var{code-size-model-type} @gol
687 -msdata=@var{sdata-type} @gol
688 -mno-flush-func -mflush-func=@var{name} @gol
689 -mno-flush-trap -mflush-trap=@var{number} @gol
690 -G @var{num}}
692 @emph{M32C Options}
693 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
695 @emph{M680x0 Options}
696 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
697 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
698 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
699 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
700 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
701 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
702 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
703 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
704 -mxgot -mno-xgot}
706 @emph{MCore Options}
707 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
708 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
709 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
710 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
711 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
713 @emph{MeP Options}
714 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
715 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
716 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
717 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
718 -mtiny=@var{n}}
720 @emph{MicroBlaze Options}
721 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
722 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
723 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
724 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
725 -mxl-mode-@var{app-model}}
727 @emph{MIPS Options}
728 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
729 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
730 -mips64  -mips64r2 @gol
731 -mips16  -mno-mips16  -mflip-mips16 @gol
732 -minterlink-mips16  -mno-interlink-mips16 @gol
733 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
734 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
735 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
736 -mno-float -msingle-float  -mdouble-float  @gol
737 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
738 -mmcu -mmno-mcu @gol
739 -mfpu=@var{fpu-type} @gol
740 -msmartmips  -mno-smartmips @gol
741 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
742 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
743 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
744 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
745 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
746 -membedded-data  -mno-embedded-data @gol
747 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
748 -mcode-readable=@var{setting} @gol
749 -msplit-addresses  -mno-split-addresses @gol
750 -mexplicit-relocs  -mno-explicit-relocs @gol
751 -mcheck-zero-division  -mno-check-zero-division @gol
752 -mdivide-traps  -mdivide-breaks @gol
753 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
754 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
755 -mfix-24k -mno-fix-24k @gol
756 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
757 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
758 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
759 -mflush-func=@var{func}  -mno-flush-func @gol
760 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
761 -mfp-exceptions -mno-fp-exceptions @gol
762 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
763 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
765 @emph{MMIX Options}
766 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
767 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
768 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
769 -mno-base-addresses  -msingle-exit  -mno-single-exit}
771 @emph{MN10300 Options}
772 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
773 -mno-am33 -mam33 -mam33-2 -mam34 @gol
774 -mtune=@var{cpu-type} @gol
775 -mreturn-pointer-on-d0 @gol
776 -mno-crt0  -mrelax -mliw -msetlb}
778 @emph{PDP-11 Options}
779 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
780 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
781 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
782 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
783 -mbranch-expensive  -mbranch-cheap @gol
784 -munix-asm  -mdec-asm}
786 @emph{picoChip Options}
787 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
788 -msymbol-as-address -mno-inefficient-warnings}
790 @emph{PowerPC Options}
791 See RS/6000 and PowerPC Options.
793 @emph{RL78 Options}
794 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
796 @emph{RS/6000 and PowerPC Options}
797 @gccoptlist{-mcpu=@var{cpu-type} @gol
798 -mtune=@var{cpu-type} @gol
799 -mcmodel=@var{code-model} @gol
800 -mpowerpc64 @gol
801 -maltivec  -mno-altivec @gol
802 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
803 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
804 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
805 -mfprnd  -mno-fprnd @gol
806 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
807 -mnew-mnemonics  -mold-mnemonics @gol
808 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
809 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
810 -malign-power  -malign-natural @gol
811 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
812 -msingle-float -mdouble-float -msimple-fpu @gol
813 -mstring  -mno-string  -mupdate  -mno-update @gol
814 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
815 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
816 -mstrict-align  -mno-strict-align  -mrelocatable @gol
817 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
818 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
819 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
820 -mprioritize-restricted-insns=@var{priority} @gol
821 -msched-costly-dep=@var{dependence_type} @gol
822 -minsert-sched-nops=@var{scheme} @gol
823 -mcall-sysv  -mcall-netbsd @gol
824 -maix-struct-return  -msvr4-struct-return @gol
825 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
826 -mblock-move-inline-limit=@var{num} @gol
827 -misel -mno-isel @gol
828 -misel=yes  -misel=no @gol
829 -mspe -mno-spe @gol
830 -mspe=yes  -mspe=no @gol
831 -mpaired @gol
832 -mgen-cell-microcode -mwarn-cell-microcode @gol
833 -mvrsave -mno-vrsave @gol
834 -mmulhw -mno-mulhw @gol
835 -mdlmzb -mno-dlmzb @gol
836 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
837 -mprototype  -mno-prototype @gol
838 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
839 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
840 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
841 -mno-recip-precision @gol
842 -mveclibabi=@var{type} -mfriz -mno-friz @gol
843 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
844 -msave-toc-indirect -mno-save-toc-indirect}
846 @emph{RX Options}
847 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
848 -mcpu=@gol
849 -mbig-endian-data -mlittle-endian-data @gol
850 -msmall-data @gol
851 -msim  -mno-sim@gol
852 -mas100-syntax -mno-as100-syntax@gol
853 -mrelax@gol
854 -mmax-constant-size=@gol
855 -mint-register=@gol
856 -mpid@gol
857 -msave-acc-in-interrupts}
859 @emph{S/390 and zSeries Options}
860 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
861 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
862 -mlong-double-64 -mlong-double-128 @gol
863 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
864 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
865 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
866 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
867 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
869 @emph{Score Options}
870 @gccoptlist{-meb -mel @gol
871 -mnhwloop @gol
872 -muls @gol
873 -mmac @gol
874 -mscore5 -mscore5u -mscore7 -mscore7d}
876 @emph{SH Options}
877 @gccoptlist{-m1  -m2  -m2e @gol
878 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
879 -m3  -m3e @gol
880 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
881 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
882 -m5-64media  -m5-64media-nofpu @gol
883 -m5-32media  -m5-32media-nofpu @gol
884 -m5-compact  -m5-compact-nofpu @gol
885 -mb  -ml  -mdalign  -mrelax @gol
886 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
887 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
888 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
889 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
890 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
891 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic -mhard-atomic @gol
892 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
893 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
894 -mpretend-cmove -menable-tas}
896 @emph{Solaris 2 Options}
897 @gccoptlist{-mimpure-text  -mno-impure-text @gol
898 -pthreads -pthread}
900 @emph{SPARC Options}
901 @gccoptlist{-mcpu=@var{cpu-type} @gol
902 -mtune=@var{cpu-type} @gol
903 -mcmodel=@var{code-model} @gol
904 -mmemory-model=@var{mem-model} @gol
905 -m32  -m64  -mapp-regs  -mno-app-regs @gol
906 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
907 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
908 -mhard-quad-float  -msoft-quad-float @gol
909 -mlittle-endian @gol
910 -mstack-bias  -mno-stack-bias @gol
911 -munaligned-doubles  -mno-unaligned-doubles @gol
912 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
913 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
914 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
915 -mfix-at697f}
917 @emph{SPU Options}
918 @gccoptlist{-mwarn-reloc -merror-reloc @gol
919 -msafe-dma -munsafe-dma @gol
920 -mbranch-hints @gol
921 -msmall-mem -mlarge-mem -mstdmain @gol
922 -mfixed-range=@var{register-range} @gol
923 -mea32 -mea64 @gol
924 -maddress-space-conversion -mno-address-space-conversion @gol
925 -mcache-size=@var{cache-size} @gol
926 -matomic-updates -mno-atomic-updates}
928 @emph{System V Options}
929 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
931 @emph{TILE-Gx Options}
932 @gccoptlist{-mcpu=CPU -m32 -m64}
934 @emph{TILEPro Options}
935 @gccoptlist{-mcpu=CPU -m32}
937 @emph{V850 Options}
938 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
939 -mprolog-function  -mno-prolog-function  -mspace @gol
940 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
941 -mapp-regs  -mno-app-regs @gol
942 -mdisable-callt  -mno-disable-callt @gol
943 -mv850e2v3 @gol
944 -mv850e2 @gol
945 -mv850e1 -mv850es @gol
946 -mv850e @gol
947 -mv850  -mbig-switch}
949 @emph{VAX Options}
950 @gccoptlist{-mg  -mgnu  -munix}
952 @emph{VMS Options}
953 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
954 -mpointer-size=@var{size}}
956 @emph{VxWorks Options}
957 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
958 -Xbind-lazy  -Xbind-now}
960 @emph{x86-64 Options}
961 See i386 and x86-64 Options.
963 @emph{Xstormy16 Options}
964 @gccoptlist{-msim}
966 @emph{Xtensa Options}
967 @gccoptlist{-mconst16 -mno-const16 @gol
968 -mfused-madd  -mno-fused-madd @gol
969 -mforce-no-pic @gol
970 -mserialize-volatile  -mno-serialize-volatile @gol
971 -mtext-section-literals  -mno-text-section-literals @gol
972 -mtarget-align  -mno-target-align @gol
973 -mlongcalls  -mno-longcalls}
975 @emph{zSeries Options}
976 See S/390 and zSeries Options.
978 @item Code Generation Options
979 @xref{Code Gen Options,,Options for Code Generation Conventions}.
980 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
981 -ffixed-@var{reg}  -fexceptions @gol
982 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
983 -fasynchronous-unwind-tables @gol
984 -finhibit-size-directive  -finstrument-functions @gol
985 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
986 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
987 -fno-common  -fno-ident @gol
988 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
989 -fno-jump-tables @gol
990 -frecord-gcc-switches @gol
991 -freg-struct-return  -fshort-enums @gol
992 -fshort-double  -fshort-wchar @gol
993 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
994 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
995 -fno-stack-limit -fsplit-stack @gol
996 -fleading-underscore  -ftls-model=@var{model} @gol
997 -fstack-reuse=@var{reuse_level} @gol
998 -ftrapv  -fwrapv  -fbounds-check @gol
999 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1000 @end table
1002 @menu
1003 * Overall Options::     Controlling the kind of output:
1004                         an executable, object files, assembler files,
1005                         or preprocessed source.
1006 * C Dialect Options::   Controlling the variant of C language compiled.
1007 * C++ Dialect Options:: Variations on C++.
1008 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1009                         and Objective-C++.
1010 * Language Independent Options:: Controlling how diagnostics should be
1011                         formatted.
1012 * Warning Options::     How picky should the compiler be?
1013 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1014 * Optimize Options::    How much optimization?
1015 * Preprocessor Options:: Controlling header files and macro definitions.
1016                          Also, getting dependency information for Make.
1017 * Assembler Options::   Passing options to the assembler.
1018 * Link Options::        Specifying libraries and so on.
1019 * Directory Options::   Where to find header files and libraries.
1020                         Where to find the compiler executable files.
1021 * Spec Files::          How to pass switches to sub-processes.
1022 * Target Options::      Running a cross-compiler, or an old version of GCC.
1023 @end menu
1025 @node Overall Options
1026 @section Options Controlling the Kind of Output
1028 Compilation can involve up to four stages: preprocessing, compilation
1029 proper, assembly and linking, always in that order.  GCC is capable of
1030 preprocessing and compiling several files either into several
1031 assembler input files, or into one assembler input file; then each
1032 assembler input file produces an object file, and linking combines all
1033 the object files (those newly compiled, and those specified as input)
1034 into an executable file.
1036 @cindex file name suffix
1037 For any given input file, the file name suffix determines what kind of
1038 compilation is done:
1040 @table @gcctabopt
1041 @item @var{file}.c
1042 C source code that must be preprocessed.
1044 @item @var{file}.i
1045 C source code that should not be preprocessed.
1047 @item @var{file}.ii
1048 C++ source code that should not be preprocessed.
1050 @item @var{file}.m
1051 Objective-C source code.  Note that you must link with the @file{libobjc}
1052 library to make an Objective-C program work.
1054 @item @var{file}.mi
1055 Objective-C source code that should not be preprocessed.
1057 @item @var{file}.mm
1058 @itemx @var{file}.M
1059 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1060 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1061 to a literal capital M@.
1063 @item @var{file}.mii
1064 Objective-C++ source code that should not be preprocessed.
1066 @item @var{file}.h
1067 C, C++, Objective-C or Objective-C++ header file to be turned into a
1068 precompiled header (default), or C, C++ header file to be turned into an
1069 Ada spec (via the @option{-fdump-ada-spec} switch).
1071 @item @var{file}.cc
1072 @itemx @var{file}.cp
1073 @itemx @var{file}.cxx
1074 @itemx @var{file}.cpp
1075 @itemx @var{file}.CPP
1076 @itemx @var{file}.c++
1077 @itemx @var{file}.C
1078 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1079 the last two letters must both be literally @samp{x}.  Likewise,
1080 @samp{.C} refers to a literal capital C@.
1082 @item @var{file}.mm
1083 @itemx @var{file}.M
1084 Objective-C++ source code that must be preprocessed.
1086 @item @var{file}.mii
1087 Objective-C++ source code that should not be preprocessed.
1089 @item @var{file}.hh
1090 @itemx @var{file}.H
1091 @itemx @var{file}.hp
1092 @itemx @var{file}.hxx
1093 @itemx @var{file}.hpp
1094 @itemx @var{file}.HPP
1095 @itemx @var{file}.h++
1096 @itemx @var{file}.tcc
1097 C++ header file to be turned into a precompiled header or Ada spec.
1099 @item @var{file}.f
1100 @itemx @var{file}.for
1101 @itemx @var{file}.ftn
1102 Fixed form Fortran source code that should not be preprocessed.
1104 @item @var{file}.F
1105 @itemx @var{file}.FOR
1106 @itemx @var{file}.fpp
1107 @itemx @var{file}.FPP
1108 @itemx @var{file}.FTN
1109 Fixed form Fortran source code that must be preprocessed (with the traditional
1110 preprocessor).
1112 @item @var{file}.f90
1113 @itemx @var{file}.f95
1114 @itemx @var{file}.f03
1115 @itemx @var{file}.f08
1116 Free form Fortran source code that should not be preprocessed.
1118 @item @var{file}.F90
1119 @itemx @var{file}.F95
1120 @itemx @var{file}.F03
1121 @itemx @var{file}.F08
1122 Free form Fortran source code that must be preprocessed (with the
1123 traditional preprocessor).
1125 @item @var{file}.go
1126 Go source code.
1128 @c FIXME: Descriptions of Java file types.
1129 @c @var{file}.java
1130 @c @var{file}.class
1131 @c @var{file}.zip
1132 @c @var{file}.jar
1134 @item @var{file}.ads
1135 Ada source code file that contains a library unit declaration (a
1136 declaration of a package, subprogram, or generic, or a generic
1137 instantiation), or a library unit renaming declaration (a package,
1138 generic, or subprogram renaming declaration).  Such files are also
1139 called @dfn{specs}.
1141 @item @var{file}.adb
1142 Ada source code file containing a library unit body (a subprogram or
1143 package body).  Such files are also called @dfn{bodies}.
1145 @c GCC also knows about some suffixes for languages not yet included:
1146 @c Pascal:
1147 @c @var{file}.p
1148 @c @var{file}.pas
1149 @c Ratfor:
1150 @c @var{file}.r
1152 @item @var{file}.s
1153 Assembler code.
1155 @item @var{file}.S
1156 @itemx @var{file}.sx
1157 Assembler code that must be preprocessed.
1159 @item @var{other}
1160 An object file to be fed straight into linking.
1161 Any file name with no recognized suffix is treated this way.
1162 @end table
1164 @opindex x
1165 You can specify the input language explicitly with the @option{-x} option:
1167 @table @gcctabopt
1168 @item -x @var{language}
1169 Specify explicitly the @var{language} for the following input files
1170 (rather than letting the compiler choose a default based on the file
1171 name suffix).  This option applies to all following input files until
1172 the next @option{-x} option.  Possible values for @var{language} are:
1173 @smallexample
1174 c  c-header  cpp-output
1175 c++  c++-header  c++-cpp-output
1176 objective-c  objective-c-header  objective-c-cpp-output
1177 objective-c++ objective-c++-header objective-c++-cpp-output
1178 assembler  assembler-with-cpp
1180 f77  f77-cpp-input f95  f95-cpp-input
1182 java
1183 @end smallexample
1185 @item -x none
1186 Turn off any specification of a language, so that subsequent files are
1187 handled according to their file name suffixes (as they are if @option{-x}
1188 has not been used at all).
1190 @item -pass-exit-codes
1191 @opindex pass-exit-codes
1192 Normally the @command{gcc} program exits with the code of 1 if any
1193 phase of the compiler returns a non-success return code.  If you specify
1194 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1195 the numerically highest error produced by any phase returning an error
1196 indication.  The C, C++, and Fortran front ends return 4 if an internal
1197 compiler error is encountered.
1198 @end table
1200 If you only want some of the stages of compilation, you can use
1201 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1202 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1203 @command{gcc} is to stop.  Note that some combinations (for example,
1204 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1206 @table @gcctabopt
1207 @item -c
1208 @opindex c
1209 Compile or assemble the source files, but do not link.  The linking
1210 stage simply is not done.  The ultimate output is in the form of an
1211 object file for each source file.
1213 By default, the object file name for a source file is made by replacing
1214 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1216 Unrecognized input files, not requiring compilation or assembly, are
1217 ignored.
1219 @item -S
1220 @opindex S
1221 Stop after the stage of compilation proper; do not assemble.  The output
1222 is in the form of an assembler code file for each non-assembler input
1223 file specified.
1225 By default, the assembler file name for a source file is made by
1226 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1228 Input files that don't require compilation are ignored.
1230 @item -E
1231 @opindex E
1232 Stop after the preprocessing stage; do not run the compiler proper.  The
1233 output is in the form of preprocessed source code, which is sent to the
1234 standard output.
1236 Input files that don't require preprocessing are ignored.
1238 @cindex output file option
1239 @item -o @var{file}
1240 @opindex o
1241 Place output in file @var{file}.  This applies regardless to whatever
1242 sort of output is being produced, whether it be an executable file,
1243 an object file, an assembler file or preprocessed C code.
1245 If @option{-o} is not specified, the default is to put an executable
1246 file in @file{a.out}, the object file for
1247 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1248 assembler file in @file{@var{source}.s}, a precompiled header file in
1249 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1250 standard output.
1252 @item -v
1253 @opindex v
1254 Print (on standard error output) the commands executed to run the stages
1255 of compilation.  Also print the version number of the compiler driver
1256 program and of the preprocessor and the compiler proper.
1258 @item -###
1259 @opindex ###
1260 Like @option{-v} except the commands are not executed and arguments
1261 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1262 This is useful for shell scripts to capture the driver-generated command lines.
1264 @item -pipe
1265 @opindex pipe
1266 Use pipes rather than temporary files for communication between the
1267 various stages of compilation.  This fails to work on some systems where
1268 the assembler is unable to read from a pipe; but the GNU assembler has
1269 no trouble.
1271 @item --help
1272 @opindex help
1273 Print (on the standard output) a description of the command-line options
1274 understood by @command{gcc}.  If the @option{-v} option is also specified
1275 then @option{--help} is also passed on to the various processes
1276 invoked by @command{gcc}, so that they can display the command-line options
1277 they accept.  If the @option{-Wextra} option has also been specified
1278 (prior to the @option{--help} option), then command-line options that
1279 have no documentation associated with them are also displayed.
1281 @item --target-help
1282 @opindex target-help
1283 Print (on the standard output) a description of target-specific command-line
1284 options for each tool.  For some targets extra target-specific
1285 information may also be printed.
1287 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1288 Print (on the standard output) a description of the command-line
1289 options understood by the compiler that fit into all specified classes
1290 and qualifiers.  These are the supported classes:
1292 @table @asis
1293 @item @samp{optimizers}
1294 Display all of the optimization options supported by the
1295 compiler.
1297 @item @samp{warnings}
1298 Display all of the options controlling warning messages
1299 produced by the compiler.
1301 @item @samp{target}
1302 Display target-specific options.  Unlike the
1303 @option{--target-help} option however, target-specific options of the
1304 linker and assembler are not displayed.  This is because those
1305 tools do not currently support the extended @option{--help=} syntax.
1307 @item @samp{params}
1308 Display the values recognized by the @option{--param}
1309 option.
1311 @item @var{language}
1312 Display the options supported for @var{language}, where
1313 @var{language} is the name of one of the languages supported in this
1314 version of GCC@.
1316 @item @samp{common}
1317 Display the options that are common to all languages.
1318 @end table
1320 These are the supported qualifiers:
1322 @table @asis
1323 @item @samp{undocumented}
1324 Display only those options that are undocumented.
1326 @item @samp{joined}
1327 Display options taking an argument that appears after an equal
1328 sign in the same continuous piece of text, such as:
1329 @samp{--help=target}.
1331 @item @samp{separate}
1332 Display options taking an argument that appears as a separate word
1333 following the original option, such as: @samp{-o output-file}.
1334 @end table
1336 Thus for example to display all the undocumented target-specific
1337 switches supported by the compiler the following can be used:
1339 @smallexample
1340 --help=target,undocumented
1341 @end smallexample
1343 The sense of a qualifier can be inverted by prefixing it with the
1344 @samp{^} character, so for example to display all binary warning
1345 options (i.e., ones that are either on or off and that do not take an
1346 argument) that have a description, use:
1348 @smallexample
1349 --help=warnings,^joined,^undocumented
1350 @end smallexample
1352 The argument to @option{--help=} should not consist solely of inverted
1353 qualifiers.
1355 Combining several classes is possible, although this usually
1356 restricts the output by so much that there is nothing to display.  One
1357 case where it does work however is when one of the classes is
1358 @var{target}.  So for example to display all the target-specific
1359 optimization options the following can be used:
1361 @smallexample
1362 --help=target,optimizers
1363 @end smallexample
1365 The @option{--help=} option can be repeated on the command line.  Each
1366 successive use displays its requested class of options, skipping
1367 those that have already been displayed.
1369 If the @option{-Q} option appears on the command line before the
1370 @option{--help=} option, then the descriptive text displayed by
1371 @option{--help=} is changed.  Instead of describing the displayed
1372 options, an indication is given as to whether the option is enabled,
1373 disabled or set to a specific value (assuming that the compiler
1374 knows this at the point where the @option{--help=} option is used).
1376 Here is a truncated example from the ARM port of @command{gcc}:
1378 @smallexample
1379   % gcc -Q -mabi=2 --help=target -c
1380   The following options are target specific:
1381   -mabi=                                2
1382   -mabort-on-noreturn                   [disabled]
1383   -mapcs                                [disabled]
1384 @end smallexample
1386 The output is sensitive to the effects of previous command-line
1387 options, so for example it is possible to find out which optimizations
1388 are enabled at @option{-O2} by using:
1390 @smallexample
1391 -Q -O2 --help=optimizers
1392 @end smallexample
1394 Alternatively you can discover which binary optimizations are enabled
1395 by @option{-O3} by using:
1397 @smallexample
1398 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1399 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1400 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1401 @end smallexample
1403 @item -no-canonical-prefixes
1404 @opindex no-canonical-prefixes
1405 Do not expand any symbolic links, resolve references to @samp{/../}
1406 or @samp{/./}, or make the path absolute when generating a relative
1407 prefix.
1409 @item --version
1410 @opindex version
1411 Display the version number and copyrights of the invoked GCC@.
1413 @item -wrapper
1414 @opindex wrapper
1415 Invoke all subcommands under a wrapper program.  The name of the
1416 wrapper program and its parameters are passed as a comma separated
1417 list.
1419 @smallexample
1420 gcc -c t.c -wrapper gdb,--args
1421 @end smallexample
1423 @noindent
1424 This invokes all subprograms of @command{gcc} under
1425 @samp{gdb --args}, thus the invocation of @command{cc1} is
1426 @samp{gdb --args cc1 @dots{}}.
1428 @item -fplugin=@var{name}.so
1429 Load the plugin code in file @var{name}.so, assumed to be a
1430 shared object to be dlopen'd by the compiler.  The base name of
1431 the shared object file is used to identify the plugin for the
1432 purposes of argument parsing (See
1433 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1434 Each plugin should define the callback functions specified in the
1435 Plugins API.
1437 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1438 Define an argument called @var{key} with a value of @var{value}
1439 for the plugin called @var{name}.
1441 @item -fdump-ada-spec@r{[}-slim@r{]}
1442 For C and C++ source and include files, generate corresponding Ada
1443 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1444 GNAT User's Guide}, which provides detailed documentation on this feature.
1446 @item -fdump-go-spec=@var{file}
1447 For input files in any language, generate corresponding Go
1448 declarations in @var{file}.  This generates Go @code{const},
1449 @code{type}, @code{var}, and @code{func} declarations which may be a
1450 useful way to start writing a Go interface to code written in some
1451 other language.
1453 @include @value{srcdir}/../libiberty/at-file.texi
1454 @end table
1456 @node Invoking G++
1457 @section Compiling C++ Programs
1459 @cindex suffixes for C++ source
1460 @cindex C++ source file suffixes
1461 C++ source files conventionally use one of the suffixes @samp{.C},
1462 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1463 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1464 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1465 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1466 files with these names and compiles them as C++ programs even if you
1467 call the compiler the same way as for compiling C programs (usually
1468 with the name @command{gcc}).
1470 @findex g++
1471 @findex c++
1472 However, the use of @command{gcc} does not add the C++ library.
1473 @command{g++} is a program that calls GCC and treats @samp{.c},
1474 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1475 files unless @option{-x} is used, and automatically specifies linking
1476 against the C++ library.  This program is also useful when
1477 precompiling a C header file with a @samp{.h} extension for use in C++
1478 compilations.  On many systems, @command{g++} is also installed with
1479 the name @command{c++}.
1481 @cindex invoking @command{g++}
1482 When you compile C++ programs, you may specify many of the same
1483 command-line options that you use for compiling programs in any
1484 language; or command-line options meaningful for C and related
1485 languages; or options that are meaningful only for C++ programs.
1486 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1487 explanations of options for languages related to C@.
1488 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1489 explanations of options that are meaningful only for C++ programs.
1491 @node C Dialect Options
1492 @section Options Controlling C Dialect
1493 @cindex dialect options
1494 @cindex language dialect options
1495 @cindex options, dialect
1497 The following options control the dialect of C (or languages derived
1498 from C, such as C++, Objective-C and Objective-C++) that the compiler
1499 accepts:
1501 @table @gcctabopt
1502 @cindex ANSI support
1503 @cindex ISO support
1504 @item -ansi
1505 @opindex ansi
1506 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1507 equivalent to @option{-std=c++98}.
1509 This turns off certain features of GCC that are incompatible with ISO
1510 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1511 such as the @code{asm} and @code{typeof} keywords, and
1512 predefined macros such as @code{unix} and @code{vax} that identify the
1513 type of system you are using.  It also enables the undesirable and
1514 rarely used ISO trigraph feature.  For the C compiler,
1515 it disables recognition of C++ style @samp{//} comments as well as
1516 the @code{inline} keyword.
1518 The alternate keywords @code{__asm__}, @code{__extension__},
1519 @code{__inline__} and @code{__typeof__} continue to work despite
1520 @option{-ansi}.  You would not want to use them in an ISO C program, of
1521 course, but it is useful to put them in header files that might be included
1522 in compilations done with @option{-ansi}.  Alternate predefined macros
1523 such as @code{__unix__} and @code{__vax__} are also available, with or
1524 without @option{-ansi}.
1526 The @option{-ansi} option does not cause non-ISO programs to be
1527 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1528 addition to @option{-ansi}.  @xref{Warning Options}.
1530 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1531 option is used.  Some header files may notice this macro and refrain
1532 from declaring certain functions or defining certain macros that the
1533 ISO standard doesn't call for; this is to avoid interfering with any
1534 programs that might use these names for other things.
1536 Functions that are normally built in but do not have semantics
1537 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1538 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1539 built-in functions provided by GCC}, for details of the functions
1540 affected.
1542 @item -std=
1543 @opindex std
1544 Determine the language standard. @xref{Standards,,Language Standards
1545 Supported by GCC}, for details of these standard versions.  This option
1546 is currently only supported when compiling C or C++.
1548 The compiler can accept several base standards, such as @samp{c90} or
1549 @samp{c++98}, and GNU dialects of those standards, such as
1550 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1551 compiler accepts all programs following that standard plus those
1552 using GNU extensions that do not contradict it.  For example,
1553 @option{-std=c90} turns off certain features of GCC that are
1554 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1555 keywords, but not other GNU extensions that do not have a meaning in
1556 ISO C90, such as omitting the middle term of a @code{?:}
1557 expression. On the other hand, by specifying a GNU dialect of a
1558 standard, all features the compiler support are enabled, even when
1559 those features change the meaning of the base standard and some
1560 strict-conforming programs may be rejected.  The particular standard
1561 is used by @option{-Wpedantic} to identify which features are GNU
1562 extensions given that version of the standard. For example
1563 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1564 comments, while @option{-std=gnu99 -Wpedantic} does not.
1566 A value for this option must be provided; possible values are
1568 @table @samp
1569 @item c90
1570 @itemx c89
1571 @itemx iso9899:1990
1572 Support all ISO C90 programs (certain GNU extensions that conflict
1573 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1575 @item iso9899:199409
1576 ISO C90 as modified in amendment 1.
1578 @item c99
1579 @itemx c9x
1580 @itemx iso9899:1999
1581 @itemx iso9899:199x
1582 ISO C99.  Note that this standard is not yet fully supported; see
1583 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1584 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1586 @item c11
1587 @itemx c1x
1588 @itemx iso9899:2011
1589 ISO C11, the 2011 revision of the ISO C standard.
1590 Support is incomplete and experimental.  The name @samp{c1x} is
1591 deprecated.
1593 @item gnu90
1594 @itemx gnu89
1595 GNU dialect of ISO C90 (including some C99 features). This
1596 is the default for C code.
1598 @item gnu99
1599 @itemx gnu9x
1600 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1601 this will become the default.  The name @samp{gnu9x} is deprecated.
1603 @item gnu11
1604 @item gnu1x
1605 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1606 name @samp{gnu1x} is deprecated.
1608 @item c++98
1609 @itemx c++03
1610 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1611 additional defect reports. Same as @option{-ansi} for C++ code.
1613 @item gnu++98
1614 @itemx gnu++03
1615 GNU dialect of @option{-std=c++98}.  This is the default for
1616 C++ code.
1618 @item c++11
1619 @itemx c++0x
1620 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1621 experimental, and may change in incompatible ways in future releases.
1622 The name @samp{c++0x} is deprecated.
1624 @item gnu++11
1625 @itemx gnu++0x
1626 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1627 experimental, and may change in incompatible ways in future releases.
1628 The name @samp{gnu++0x} is deprecated.
1630 @item c++1y
1631 The next revision of the ISO C++ standard, tentatively planned for
1632 2017.  Support is highly experimental, and will almost certainly
1633 change in incompatible ways in future releases.
1635 @item gnu++1y
1636 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1637 and will almost certainly change in incompatible ways in future
1638 releases.
1639 @end table
1641 @item -fgnu89-inline
1642 @opindex fgnu89-inline
1643 The option @option{-fgnu89-inline} tells GCC to use the traditional
1644 GNU semantics for @code{inline} functions when in C99 mode.
1645 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1646 is accepted and ignored by GCC versions 4.1.3 up to but not including
1647 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1648 C99 mode.  Using this option is roughly equivalent to adding the
1649 @code{gnu_inline} function attribute to all inline functions
1650 (@pxref{Function Attributes}).
1652 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1653 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1654 specifies the default behavior).  This option was first supported in
1655 GCC 4.3.  This option is not supported in @option{-std=c90} or
1656 @option{-std=gnu90} mode.
1658 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1659 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1660 in effect for @code{inline} functions.  @xref{Common Predefined
1661 Macros,,,cpp,The C Preprocessor}.
1663 @item -aux-info @var{filename}
1664 @opindex aux-info
1665 Output to the given filename prototyped declarations for all functions
1666 declared and/or defined in a translation unit, including those in header
1667 files.  This option is silently ignored in any language other than C@.
1669 Besides declarations, the file indicates, in comments, the origin of
1670 each declaration (source file and line), whether the declaration was
1671 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1672 @samp{O} for old, respectively, in the first character after the line
1673 number and the colon), and whether it came from a declaration or a
1674 definition (@samp{C} or @samp{F}, respectively, in the following
1675 character).  In the case of function definitions, a K&R-style list of
1676 arguments followed by their declarations is also provided, inside
1677 comments, after the declaration.
1679 @item -fallow-parameterless-variadic-functions
1680 Accept variadic functions without named parameters.
1682 Although it is possible to define such a function, this is not very
1683 useful as it is not possible to read the arguments.  This is only
1684 supported for C as this construct is allowed by C++.
1686 @item -fno-asm
1687 @opindex fno-asm
1688 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1689 keyword, so that code can use these words as identifiers.  You can use
1690 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1691 instead.  @option{-ansi} implies @option{-fno-asm}.
1693 In C++, this switch only affects the @code{typeof} keyword, since
1694 @code{asm} and @code{inline} are standard keywords.  You may want to
1695 use the @option{-fno-gnu-keywords} flag instead, which has the same
1696 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1697 switch only affects the @code{asm} and @code{typeof} keywords, since
1698 @code{inline} is a standard keyword in ISO C99.
1700 @item -fno-builtin
1701 @itemx -fno-builtin-@var{function}
1702 @opindex fno-builtin
1703 @cindex built-in functions
1704 Don't recognize built-in functions that do not begin with
1705 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1706 functions provided by GCC}, for details of the functions affected,
1707 including those which are not built-in functions when @option{-ansi} or
1708 @option{-std} options for strict ISO C conformance are used because they
1709 do not have an ISO standard meaning.
1711 GCC normally generates special code to handle certain built-in functions
1712 more efficiently; for instance, calls to @code{alloca} may become single
1713 instructions which adjust the stack directly, and calls to @code{memcpy}
1714 may become inline copy loops.  The resulting code is often both smaller
1715 and faster, but since the function calls no longer appear as such, you
1716 cannot set a breakpoint on those calls, nor can you change the behavior
1717 of the functions by linking with a different library.  In addition,
1718 when a function is recognized as a built-in function, GCC may use
1719 information about that function to warn about problems with calls to
1720 that function, or to generate more efficient code, even if the
1721 resulting code still contains calls to that function.  For example,
1722 warnings are given with @option{-Wformat} for bad calls to
1723 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1724 known not to modify global memory.
1726 With the @option{-fno-builtin-@var{function}} option
1727 only the built-in function @var{function} is
1728 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1729 function is named that is not built-in in this version of GCC, this
1730 option is ignored.  There is no corresponding
1731 @option{-fbuiltin-@var{function}} option; if you wish to enable
1732 built-in functions selectively when using @option{-fno-builtin} or
1733 @option{-ffreestanding}, you may define macros such as:
1735 @smallexample
1736 #define abs(n)          __builtin_abs ((n))
1737 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1738 @end smallexample
1740 @item -fhosted
1741 @opindex fhosted
1742 @cindex hosted environment
1744 Assert that compilation takes place in a hosted environment.  This implies
1745 @option{-fbuiltin}.  A hosted environment is one in which the
1746 entire standard library is available, and in which @code{main} has a return
1747 type of @code{int}.  Examples are nearly everything except a kernel.
1748 This is equivalent to @option{-fno-freestanding}.
1750 @item -ffreestanding
1751 @opindex ffreestanding
1752 @cindex hosted environment
1754 Assert that compilation takes place in a freestanding environment.  This
1755 implies @option{-fno-builtin}.  A freestanding environment
1756 is one in which the standard library may not exist, and program startup may
1757 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1758 This is equivalent to @option{-fno-hosted}.
1760 @xref{Standards,,Language Standards Supported by GCC}, for details of
1761 freestanding and hosted environments.
1763 @item -fopenmp
1764 @opindex fopenmp
1765 @cindex OpenMP parallel
1766 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1767 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1768 compiler generates parallel code according to the OpenMP Application
1769 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1770 implies @option{-pthread}, and thus is only supported on targets that
1771 have support for @option{-pthread}.
1773 @item -fgnu-tm
1774 @opindex fgnu-tm
1775 When the option @option{-fgnu-tm} is specified, the compiler
1776 generates code for the Linux variant of Intel's current Transactional
1777 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1778 an experimental feature whose interface may change in future versions
1779 of GCC, as the official specification changes.  Please note that not
1780 all architectures are supported for this feature.
1782 For more information on GCC's support for transactional memory,
1783 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1784 Transactional Memory Library}.
1786 Note that the transactional memory feature is not supported with
1787 non-call exceptions (@option{-fnon-call-exceptions}).
1789 @item -fms-extensions
1790 @opindex fms-extensions
1791 Accept some non-standard constructs used in Microsoft header files.
1793 In C++ code, this allows member names in structures to be similar
1794 to previous types declarations.
1796 @smallexample
1797 typedef int UOW;
1798 struct ABC @{
1799   UOW UOW;
1801 @end smallexample
1803 Some cases of unnamed fields in structures and unions are only
1804 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1805 fields within structs/unions}, for details.
1807 @item -fplan9-extensions
1808 Accept some non-standard constructs used in Plan 9 code.
1810 This enables @option{-fms-extensions}, permits passing pointers to
1811 structures with anonymous fields to functions that expect pointers to
1812 elements of the type of the field, and permits referring to anonymous
1813 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1814 struct/union fields within structs/unions}, for details.  This is only
1815 supported for C, not C++.
1817 @item -trigraphs
1818 @opindex trigraphs
1819 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1820 options for strict ISO C conformance) implies @option{-trigraphs}.
1822 @cindex traditional C language
1823 @cindex C language, traditional
1824 @item -traditional
1825 @itemx -traditional-cpp
1826 @opindex traditional-cpp
1827 @opindex traditional
1828 Formerly, these options caused GCC to attempt to emulate a pre-standard
1829 C compiler.  They are now only supported with the @option{-E} switch.
1830 The preprocessor continues to support a pre-standard mode.  See the GNU
1831 CPP manual for details.
1833 @item -fcond-mismatch
1834 @opindex fcond-mismatch
1835 Allow conditional expressions with mismatched types in the second and
1836 third arguments.  The value of such an expression is void.  This option
1837 is not supported for C++.
1839 @item -flax-vector-conversions
1840 @opindex flax-vector-conversions
1841 Allow implicit conversions between vectors with differing numbers of
1842 elements and/or incompatible element types.  This option should not be
1843 used for new code.
1845 @item -funsigned-char
1846 @opindex funsigned-char
1847 Let the type @code{char} be unsigned, like @code{unsigned char}.
1849 Each kind of machine has a default for what @code{char} should
1850 be.  It is either like @code{unsigned char} by default or like
1851 @code{signed char} by default.
1853 Ideally, a portable program should always use @code{signed char} or
1854 @code{unsigned char} when it depends on the signedness of an object.
1855 But many programs have been written to use plain @code{char} and
1856 expect it to be signed, or expect it to be unsigned, depending on the
1857 machines they were written for.  This option, and its inverse, let you
1858 make such a program work with the opposite default.
1860 The type @code{char} is always a distinct type from each of
1861 @code{signed char} or @code{unsigned char}, even though its behavior
1862 is always just like one of those two.
1864 @item -fsigned-char
1865 @opindex fsigned-char
1866 Let the type @code{char} be signed, like @code{signed char}.
1868 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1869 the negative form of @option{-funsigned-char}.  Likewise, the option
1870 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1872 @item -fsigned-bitfields
1873 @itemx -funsigned-bitfields
1874 @itemx -fno-signed-bitfields
1875 @itemx -fno-unsigned-bitfields
1876 @opindex fsigned-bitfields
1877 @opindex funsigned-bitfields
1878 @opindex fno-signed-bitfields
1879 @opindex fno-unsigned-bitfields
1880 These options control whether a bit-field is signed or unsigned, when the
1881 declaration does not use either @code{signed} or @code{unsigned}.  By
1882 default, such a bit-field is signed, because this is consistent: the
1883 basic integer types such as @code{int} are signed types.
1884 @end table
1886 @node C++ Dialect Options
1887 @section Options Controlling C++ Dialect
1889 @cindex compiler options, C++
1890 @cindex C++ options, command-line
1891 @cindex options, C++
1892 This section describes the command-line options that are only meaningful
1893 for C++ programs; but you can also use most of the GNU compiler options
1894 regardless of what language your program is in.  For example, you
1895 might compile a file @code{firstClass.C} like this:
1897 @smallexample
1898 g++ -g -frepo -O -c firstClass.C
1899 @end smallexample
1901 @noindent
1902 In this example, only @option{-frepo} is an option meant
1903 only for C++ programs; you can use the other options with any
1904 language supported by GCC@.
1906 Here is a list of options that are @emph{only} for compiling C++ programs:
1908 @table @gcctabopt
1910 @item -fabi-version=@var{n}
1911 @opindex fabi-version
1912 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1913 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1914 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1915 the version that conforms most closely to the C++ ABI specification.
1916 Therefore, the ABI obtained using version 0 will change as ABI bugs
1917 are fixed.
1919 The default is version 2.
1921 Version 3 corrects an error in mangling a constant address as a
1922 template argument.
1924 Version 4, which first appeared in G++ 4.5, implements a standard
1925 mangling for vector types.
1927 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1928 attribute const/volatile on function pointer types, decltype of a
1929 plain decl, and use of a function parameter in the declaration of
1930 another parameter.
1932 Version 6, which first appeared in G++ 4.7, corrects the promotion
1933 behavior of C++11 scoped enums and the mangling of template argument
1934 packs, const/static_cast, prefix ++ and --, and a class scope function
1935 used as a template argument.
1937 See also @option{-Wabi}.
1939 @item -fno-access-control
1940 @opindex fno-access-control
1941 Turn off all access checking.  This switch is mainly useful for working
1942 around bugs in the access control code.
1944 @item -fcheck-new
1945 @opindex fcheck-new
1946 Check that the pointer returned by @code{operator new} is non-null
1947 before attempting to modify the storage allocated.  This check is
1948 normally unnecessary because the C++ standard specifies that
1949 @code{operator new} only returns @code{0} if it is declared
1950 @samp{throw()}, in which case the compiler always checks the
1951 return value even without this option.  In all other cases, when
1952 @code{operator new} has a non-empty exception specification, memory
1953 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1954 @samp{new (nothrow)}.
1956 @item -fconstexpr-depth=@var{n}
1957 @opindex fconstexpr-depth
1958 Set the maximum nested evaluation depth for C++11 constexpr functions
1959 to @var{n}.  A limit is needed to detect endless recursion during
1960 constant expression evaluation.  The minimum specified by the standard
1961 is 512.
1963 @item -fdeduce-init-list
1964 @opindex fdeduce-init-list
1965 Enable deduction of a template type parameter as
1966 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1968 @smallexample
1969 template <class T> auto forward(T t) -> decltype (realfn (t))
1971   return realfn (t);
1974 void f()
1976   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1978 @end smallexample
1980 This deduction was implemented as a possible extension to the
1981 originally proposed semantics for the C++11 standard, but was not part
1982 of the final standard, so it is disabled by default.  This option is
1983 deprecated, and may be removed in a future version of G++.
1985 @item -ffriend-injection
1986 @opindex ffriend-injection
1987 Inject friend functions into the enclosing namespace, so that they are
1988 visible outside the scope of the class in which they are declared.
1989 Friend functions were documented to work this way in the old Annotated
1990 C++ Reference Manual, and versions of G++ before 4.1 always worked
1991 that way.  However, in ISO C++ a friend function that is not declared
1992 in an enclosing scope can only be found using argument dependent
1993 lookup.  This option causes friends to be injected as they were in
1994 earlier releases.
1996 This option is for compatibility, and may be removed in a future
1997 release of G++.
1999 @item -fno-elide-constructors
2000 @opindex fno-elide-constructors
2001 The C++ standard allows an implementation to omit creating a temporary
2002 that is only used to initialize another object of the same type.
2003 Specifying this option disables that optimization, and forces G++ to
2004 call the copy constructor in all cases.
2006 @item -fno-enforce-eh-specs
2007 @opindex fno-enforce-eh-specs
2008 Don't generate code to check for violation of exception specifications
2009 at run time.  This option violates the C++ standard, but may be useful
2010 for reducing code size in production builds, much like defining
2011 @samp{NDEBUG}.  This does not give user code permission to throw
2012 exceptions in violation of the exception specifications; the compiler
2013 still optimizes based on the specifications, so throwing an
2014 unexpected exception results in undefined behavior at run time.
2016 @item -ffor-scope
2017 @itemx -fno-for-scope
2018 @opindex ffor-scope
2019 @opindex fno-for-scope
2020 If @option{-ffor-scope} is specified, the scope of variables declared in
2021 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2022 as specified by the C++ standard.
2023 If @option{-fno-for-scope} is specified, the scope of variables declared in
2024 a @i{for-init-statement} extends to the end of the enclosing scope,
2025 as was the case in old versions of G++, and other (traditional)
2026 implementations of C++.
2028 The default if neither flag is given to follow the standard,
2029 but to allow and give a warning for old-style code that would
2030 otherwise be invalid, or have different behavior.
2032 @item -fno-gnu-keywords
2033 @opindex fno-gnu-keywords
2034 Do not recognize @code{typeof} as a keyword, so that code can use this
2035 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2036 @option{-ansi} implies @option{-fno-gnu-keywords}.
2038 @item -fno-implicit-templates
2039 @opindex fno-implicit-templates
2040 Never emit code for non-inline templates that are instantiated
2041 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2042 @xref{Template Instantiation}, for more information.
2044 @item -fno-implicit-inline-templates
2045 @opindex fno-implicit-inline-templates
2046 Don't emit code for implicit instantiations of inline templates, either.
2047 The default is to handle inlines differently so that compiles with and
2048 without optimization need the same set of explicit instantiations.
2050 @item -fno-implement-inlines
2051 @opindex fno-implement-inlines
2052 To save space, do not emit out-of-line copies of inline functions
2053 controlled by @samp{#pragma implementation}.  This causes linker
2054 errors if these functions are not inlined everywhere they are called.
2056 @item -fms-extensions
2057 @opindex fms-extensions
2058 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2059 int and getting a pointer to member function via non-standard syntax.
2061 @item -fno-nonansi-builtins
2062 @opindex fno-nonansi-builtins
2063 Disable built-in declarations of functions that are not mandated by
2064 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2065 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2067 @item -fnothrow-opt
2068 @opindex fnothrow-opt
2069 Treat a @code{throw()} exception specification as if it were a
2070 @code{noexcept} specification to reduce or eliminate the text size
2071 overhead relative to a function with no exception specification.  If
2072 the function has local variables of types with non-trivial
2073 destructors, the exception specification actually makes the
2074 function smaller because the EH cleanups for those variables can be
2075 optimized away.  The semantic effect is that an exception thrown out of
2076 a function with such an exception specification results in a call
2077 to @code{terminate} rather than @code{unexpected}.
2079 @item -fno-operator-names
2080 @opindex fno-operator-names
2081 Do not treat the operator name keywords @code{and}, @code{bitand},
2082 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2083 synonyms as keywords.
2085 @item -fno-optional-diags
2086 @opindex fno-optional-diags
2087 Disable diagnostics that the standard says a compiler does not need to
2088 issue.  Currently, the only such diagnostic issued by G++ is the one for
2089 a name having multiple meanings within a class.
2091 @item -fpermissive
2092 @opindex fpermissive
2093 Downgrade some diagnostics about nonconformant code from errors to
2094 warnings.  Thus, using @option{-fpermissive} allows some
2095 nonconforming code to compile.
2097 @item -fno-pretty-templates
2098 @opindex fno-pretty-templates
2099 When an error message refers to a specialization of a function
2100 template, the compiler normally prints the signature of the
2101 template followed by the template arguments and any typedefs or
2102 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2103 rather than @code{void f(int)}) so that it's clear which template is
2104 involved.  When an error message refers to a specialization of a class
2105 template, the compiler omits any template arguments that match
2106 the default template arguments for that template.  If either of these
2107 behaviors make it harder to understand the error message rather than
2108 easier, you can use @option{-fno-pretty-templates} to disable them.
2110 @item -frepo
2111 @opindex frepo
2112 Enable automatic template instantiation at link time.  This option also
2113 implies @option{-fno-implicit-templates}.  @xref{Template
2114 Instantiation}, for more information.
2116 @item -fno-rtti
2117 @opindex fno-rtti
2118 Disable generation of information about every class with virtual
2119 functions for use by the C++ run-time type identification features
2120 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2121 of the language, you can save some space by using this flag.  Note that
2122 exception handling uses the same information, but G++ generates it as
2123 needed. The @samp{dynamic_cast} operator can still be used for casts that
2124 do not require run-time type information, i.e.@: casts to @code{void *} or to
2125 unambiguous base classes.
2127 @item -fstats
2128 @opindex fstats
2129 Emit statistics about front-end processing at the end of the compilation.
2130 This information is generally only useful to the G++ development team.
2132 @item -fstrict-enums
2133 @opindex fstrict-enums
2134 Allow the compiler to optimize using the assumption that a value of
2135 enumerated type can only be one of the values of the enumeration (as
2136 defined in the C++ standard; basically, a value that can be
2137 represented in the minimum number of bits needed to represent all the
2138 enumerators).  This assumption may not be valid if the program uses a
2139 cast to convert an arbitrary integer value to the enumerated type.
2141 @item -ftemplate-backtrace-limit=@var{n}
2142 @opindex ftemplate-backtrace-limit
2143 Set the maximum number of template instantiation notes for a single
2144 warning or error to @var{n}.  The default value is 10.
2146 @item -ftemplate-depth=@var{n}
2147 @opindex ftemplate-depth
2148 Set the maximum instantiation depth for template classes to @var{n}.
2149 A limit on the template instantiation depth is needed to detect
2150 endless recursions during template class instantiation.  ANSI/ISO C++
2151 conforming programs must not rely on a maximum depth greater than 17
2152 (changed to 1024 in C++11).  The default value is 900, as the compiler
2153 can run out of stack space before hitting 1024 in some situations.
2155 @item -fno-threadsafe-statics
2156 @opindex fno-threadsafe-statics
2157 Do not emit the extra code to use the routines specified in the C++
2158 ABI for thread-safe initialization of local statics.  You can use this
2159 option to reduce code size slightly in code that doesn't need to be
2160 thread-safe.
2162 @item -fuse-cxa-atexit
2163 @opindex fuse-cxa-atexit
2164 Register destructors for objects with static storage duration with the
2165 @code{__cxa_atexit} function rather than the @code{atexit} function.
2166 This option is required for fully standards-compliant handling of static
2167 destructors, but only works if your C library supports
2168 @code{__cxa_atexit}.
2170 @item -fno-use-cxa-get-exception-ptr
2171 @opindex fno-use-cxa-get-exception-ptr
2172 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2173 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2174 if the runtime routine is not available.
2176 @item -fvisibility-inlines-hidden
2177 @opindex fvisibility-inlines-hidden
2178 This switch declares that the user does not attempt to compare
2179 pointers to inline functions or methods where the addresses of the two functions
2180 are taken in different shared objects.
2182 The effect of this is that GCC may, effectively, mark inline methods with
2183 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2184 appear in the export table of a DSO and do not require a PLT indirection
2185 when used within the DSO@.  Enabling this option can have a dramatic effect
2186 on load and link times of a DSO as it massively reduces the size of the
2187 dynamic export table when the library makes heavy use of templates.
2189 The behavior of this switch is not quite the same as marking the
2190 methods as hidden directly, because it does not affect static variables
2191 local to the function or cause the compiler to deduce that
2192 the function is defined in only one shared object.
2194 You may mark a method as having a visibility explicitly to negate the
2195 effect of the switch for that method.  For example, if you do want to
2196 compare pointers to a particular inline method, you might mark it as
2197 having default visibility.  Marking the enclosing class with explicit
2198 visibility has no effect.
2200 Explicitly instantiated inline methods are unaffected by this option
2201 as their linkage might otherwise cross a shared library boundary.
2202 @xref{Template Instantiation}.
2204 @item -fvisibility-ms-compat
2205 @opindex fvisibility-ms-compat
2206 This flag attempts to use visibility settings to make GCC's C++
2207 linkage model compatible with that of Microsoft Visual Studio.
2209 The flag makes these changes to GCC's linkage model:
2211 @enumerate
2212 @item
2213 It sets the default visibility to @code{hidden}, like
2214 @option{-fvisibility=hidden}.
2216 @item
2217 Types, but not their members, are not hidden by default.
2219 @item
2220 The One Definition Rule is relaxed for types without explicit
2221 visibility specifications that are defined in more than one
2222 shared object: those declarations are permitted if they are
2223 permitted when this option is not used.
2224 @end enumerate
2226 In new code it is better to use @option{-fvisibility=hidden} and
2227 export those classes that are intended to be externally visible.
2228 Unfortunately it is possible for code to rely, perhaps accidentally,
2229 on the Visual Studio behavior.
2231 Among the consequences of these changes are that static data members
2232 of the same type with the same name but defined in different shared
2233 objects are different, so changing one does not change the other;
2234 and that pointers to function members defined in different shared
2235 objects may not compare equal.  When this flag is given, it is a
2236 violation of the ODR to define types with the same name differently.
2238 @item -fno-weak
2239 @opindex fno-weak
2240 Do not use weak symbol support, even if it is provided by the linker.
2241 By default, G++ uses weak symbols if they are available.  This
2242 option exists only for testing, and should not be used by end-users;
2243 it results in inferior code and has no benefits.  This option may
2244 be removed in a future release of G++.
2246 @item -nostdinc++
2247 @opindex nostdinc++
2248 Do not search for header files in the standard directories specific to
2249 C++, but do still search the other standard directories.  (This option
2250 is used when building the C++ library.)
2251 @end table
2253 In addition, these optimization, warning, and code generation options
2254 have meanings only for C++ programs:
2256 @table @gcctabopt
2257 @item -fno-default-inline
2258 @opindex fno-default-inline
2259 Do not assume @samp{inline} for functions defined inside a class scope.
2260 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2261 functions have linkage like inline functions; they just aren't
2262 inlined by default.
2264 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2265 @opindex Wabi
2266 @opindex Wno-abi
2267 Warn when G++ generates code that is probably not compatible with the
2268 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2269 all such cases, there are probably some cases that are not warned about,
2270 even though G++ is generating incompatible code.  There may also be
2271 cases where warnings are emitted even though the code that is generated
2272 is compatible.
2274 You should rewrite your code to avoid these warnings if you are
2275 concerned about the fact that code generated by G++ may not be binary
2276 compatible with code generated by other compilers.
2278 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2280 @itemize @bullet
2282 @item
2283 A template with a non-type template parameter of reference type is
2284 mangled incorrectly:
2285 @smallexample
2286 extern int N;
2287 template <int &> struct S @{@};
2288 void n (S<N>) @{2@}
2289 @end smallexample
2291 This is fixed in @option{-fabi-version=3}.
2293 @item
2294 SIMD vector types declared using @code{__attribute ((vector_size))} are
2295 mangled in a non-standard way that does not allow for overloading of
2296 functions taking vectors of different sizes.
2298 The mangling is changed in @option{-fabi-version=4}.
2299 @end itemize
2301 The known incompatibilities in @option{-fabi-version=1} include:
2303 @itemize @bullet
2305 @item
2306 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2307 pack data into the same byte as a base class.  For example:
2309 @smallexample
2310 struct A @{ virtual void f(); int f1 : 1; @};
2311 struct B : public A @{ int f2 : 1; @};
2312 @end smallexample
2314 @noindent
2315 In this case, G++ places @code{B::f2} into the same byte
2316 as@code{A::f1}; other compilers do not.  You can avoid this problem
2317 by explicitly padding @code{A} so that its size is a multiple of the
2318 byte size on your platform; that causes G++ and other compilers to
2319 lay out @code{B} identically.
2321 @item
2322 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2323 tail padding when laying out virtual bases.  For example:
2325 @smallexample
2326 struct A @{ virtual void f(); char c1; @};
2327 struct B @{ B(); char c2; @};
2328 struct C : public A, public virtual B @{@};
2329 @end smallexample
2331 @noindent
2332 In this case, G++ does not place @code{B} into the tail-padding for
2333 @code{A}; other compilers do.  You can avoid this problem by
2334 explicitly padding @code{A} so that its size is a multiple of its
2335 alignment (ignoring virtual base classes); that causes G++ and other
2336 compilers to lay out @code{C} identically.
2338 @item
2339 Incorrect handling of bit-fields with declared widths greater than that
2340 of their underlying types, when the bit-fields appear in a union.  For
2341 example:
2343 @smallexample
2344 union U @{ int i : 4096; @};
2345 @end smallexample
2347 @noindent
2348 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2349 union too small by the number of bits in an @code{int}.
2351 @item
2352 Empty classes can be placed at incorrect offsets.  For example:
2354 @smallexample
2355 struct A @{@};
2357 struct B @{
2358   A a;
2359   virtual void f ();
2362 struct C : public B, public A @{@};
2363 @end smallexample
2365 @noindent
2366 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2367 it should be placed at offset zero.  G++ mistakenly believes that the
2368 @code{A} data member of @code{B} is already at offset zero.
2370 @item
2371 Names of template functions whose types involve @code{typename} or
2372 template template parameters can be mangled incorrectly.
2374 @smallexample
2375 template <typename Q>
2376 void f(typename Q::X) @{@}
2378 template <template <typename> class Q>
2379 void f(typename Q<int>::X) @{@}
2380 @end smallexample
2382 @noindent
2383 Instantiations of these templates may be mangled incorrectly.
2385 @end itemize
2387 It also warns about psABI-related changes.  The known psABI changes at this
2388 point include:
2390 @itemize @bullet
2392 @item
2393 For SysV/x86-64, unions with @code{long double} members are 
2394 passed in memory as specified in psABI.  For example:
2396 @smallexample
2397 union U @{
2398   long double ld;
2399   int i;
2401 @end smallexample
2403 @noindent
2404 @code{union U} is always passed in memory.
2406 @end itemize
2408 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2409 @opindex Wctor-dtor-privacy
2410 @opindex Wno-ctor-dtor-privacy
2411 Warn when a class seems unusable because all the constructors or
2412 destructors in that class are private, and it has neither friends nor
2413 public static member functions.
2415 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2416 @opindex Wdelete-non-virtual-dtor
2417 @opindex Wno-delete-non-virtual-dtor
2418 Warn when @samp{delete} is used to destroy an instance of a class that
2419 has virtual functions and non-virtual destructor. It is unsafe to delete
2420 an instance of a derived class through a pointer to a base class if the
2421 base class does not have a virtual destructor.  This warning is enabled
2422 by @option{-Wall}.
2424 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2425 @opindex Wliteral-suffix
2426 @opindex Wno-literal-suffix
2427 Warn when a string or character literal is followed by a ud-suffix which does
2428 not begin with an underscore.  As a conforming extension, GCC treats such
2429 suffixes as separate preprocessing tokens in order to maintain backwards
2430 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2431 For example:
2433 @smallexample
2434 #define __STDC_FORMAT_MACROS
2435 #include <inttypes.h>
2436 #include <stdio.h>
2438 int main() @{
2439   int64_t i64 = 123;
2440   printf("My int64: %"PRId64"\n", i64);
2442 @end smallexample
2444 In this case, @code{PRId64} is treated as a separate preprocessing token.
2446 This warning is enabled by default.
2448 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2449 @opindex Wnarrowing
2450 @opindex Wno-narrowing
2451 Warn when a narrowing conversion prohibited by C++11 occurs within
2452 @samp{@{ @}}, e.g.
2454 @smallexample
2455 int i = @{ 2.2 @}; // error: narrowing from double to int
2456 @end smallexample
2458 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2460 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2461 required by the standard.  Note that this does not affect the meaning
2462 of well-formed code; narrowing conversions are still considered
2463 ill-formed in SFINAE context.
2465 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2466 @opindex Wnoexcept
2467 @opindex Wno-noexcept
2468 Warn when a noexcept-expression evaluates to false because of a call
2469 to a function that does not have a non-throwing exception
2470 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2471 the compiler to never throw an exception.
2473 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2474 @opindex Wnon-virtual-dtor
2475 @opindex Wno-non-virtual-dtor
2476 Warn when a class has virtual functions and an accessible non-virtual
2477 destructor, in which case it is possible but unsafe to delete
2478 an instance of a derived class through a pointer to the base class.
2479 This warning is also enabled if @option{-Weffc++} is specified.
2481 @item -Wreorder @r{(C++ and Objective-C++ only)}
2482 @opindex Wreorder
2483 @opindex Wno-reorder
2484 @cindex reordering, warning
2485 @cindex warning for reordering of member initializers
2486 Warn when the order of member initializers given in the code does not
2487 match the order in which they must be executed.  For instance:
2489 @smallexample
2490 struct A @{
2491   int i;
2492   int j;
2493   A(): j (0), i (1) @{ @}
2495 @end smallexample
2497 @noindent
2498 The compiler rearranges the member initializers for @samp{i}
2499 and @samp{j} to match the declaration order of the members, emitting
2500 a warning to that effect.  This warning is enabled by @option{-Wall}.
2501 @end table
2503 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2505 @table @gcctabopt
2506 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2507 @opindex Weffc++
2508 @opindex Wno-effc++
2509 Warn about violations of the following style guidelines from Scott Meyers'
2510 @cite{Effective C++, Second Edition} book:
2512 @itemize @bullet
2513 @item
2514 Item 11:  Define a copy constructor and an assignment operator for classes
2515 with dynamically allocated memory.
2517 @item
2518 Item 12:  Prefer initialization to assignment in constructors.
2520 @item
2521 Item 14:  Make destructors virtual in base classes.
2523 @item
2524 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2526 @item
2527 Item 23:  Don't try to return a reference when you must return an object.
2529 @end itemize
2531 Also warn about violations of the following style guidelines from
2532 Scott Meyers' @cite{More Effective C++} book:
2534 @itemize @bullet
2535 @item
2536 Item 6:  Distinguish between prefix and postfix forms of increment and
2537 decrement operators.
2539 @item
2540 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2542 @end itemize
2544 When selecting this option, be aware that the standard library
2545 headers do not obey all of these guidelines; use @samp{grep -v}
2546 to filter out those warnings.
2548 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2549 @opindex Wstrict-null-sentinel
2550 @opindex Wno-strict-null-sentinel
2551 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2552 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2553 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2554 it is guaranteed to be of the same size as a pointer.  But this use is
2555 not portable across different compilers.
2557 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2558 @opindex Wno-non-template-friend
2559 @opindex Wnon-template-friend
2560 Disable warnings when non-templatized friend functions are declared
2561 within a template.  Since the advent of explicit template specification
2562 support in G++, if the name of the friend is an unqualified-id (i.e.,
2563 @samp{friend foo(int)}), the C++ language specification demands that the
2564 friend declare or define an ordinary, nontemplate function.  (Section
2565 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2566 could be interpreted as a particular specialization of a templatized
2567 function.  Because this non-conforming behavior is no longer the default
2568 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2569 check existing code for potential trouble spots and is on by default.
2570 This new compiler behavior can be turned off with
2571 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2572 but disables the helpful warning.
2574 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2575 @opindex Wold-style-cast
2576 @opindex Wno-old-style-cast
2577 Warn if an old-style (C-style) cast to a non-void type is used within
2578 a C++ program.  The new-style casts (@samp{dynamic_cast},
2579 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2580 less vulnerable to unintended effects and much easier to search for.
2582 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2583 @opindex Woverloaded-virtual
2584 @opindex Wno-overloaded-virtual
2585 @cindex overloaded virtual function, warning
2586 @cindex warning for overloaded virtual function
2587 Warn when a function declaration hides virtual functions from a
2588 base class.  For example, in:
2590 @smallexample
2591 struct A @{
2592   virtual void f();
2595 struct B: public A @{
2596   void f(int);
2598 @end smallexample
2600 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2601 like:
2603 @smallexample
2604 B* b;
2605 b->f();
2606 @end smallexample
2608 @noindent
2609 fails to compile.
2611 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2612 @opindex Wno-pmf-conversions
2613 @opindex Wpmf-conversions
2614 Disable the diagnostic for converting a bound pointer to member function
2615 to a plain pointer.
2617 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2618 @opindex Wsign-promo
2619 @opindex Wno-sign-promo
2620 Warn when overload resolution chooses a promotion from unsigned or
2621 enumerated type to a signed type, over a conversion to an unsigned type of
2622 the same size.  Previous versions of G++ tried to preserve
2623 unsignedness, but the standard mandates the current behavior.
2625 @smallexample
2626 struct A @{
2627   operator int ();
2628   A& operator = (int);
2631 main ()
2633   A a,b;
2634   a = b;
2636 @end smallexample
2638 @noindent
2639 In this example, G++ synthesizes a default @samp{A& operator =
2640 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2641 @end table
2643 @node Objective-C and Objective-C++ Dialect Options
2644 @section Options Controlling Objective-C and Objective-C++ Dialects
2646 @cindex compiler options, Objective-C and Objective-C++
2647 @cindex Objective-C and Objective-C++ options, command-line
2648 @cindex options, Objective-C and Objective-C++
2649 (NOTE: This manual does not describe the Objective-C and Objective-C++
2650 languages themselves.  @xref{Standards,,Language Standards
2651 Supported by GCC}, for references.)
2653 This section describes the command-line options that are only meaningful
2654 for Objective-C and Objective-C++ programs, but you can also use most of
2655 the language-independent GNU compiler options.
2656 For example, you might compile a file @code{some_class.m} like this:
2658 @smallexample
2659 gcc -g -fgnu-runtime -O -c some_class.m
2660 @end smallexample
2662 @noindent
2663 In this example, @option{-fgnu-runtime} is an option meant only for
2664 Objective-C and Objective-C++ programs; you can use the other options with
2665 any language supported by GCC@.
2667 Note that since Objective-C is an extension of the C language, Objective-C
2668 compilations may also use options specific to the C front-end (e.g.,
2669 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2670 C++-specific options (e.g., @option{-Wabi}).
2672 Here is a list of options that are @emph{only} for compiling Objective-C
2673 and Objective-C++ programs:
2675 @table @gcctabopt
2676 @item -fconstant-string-class=@var{class-name}
2677 @opindex fconstant-string-class
2678 Use @var{class-name} as the name of the class to instantiate for each
2679 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2680 class name is @code{NXConstantString} if the GNU runtime is being used, and
2681 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2682 @option{-fconstant-cfstrings} option, if also present, overrides the
2683 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2684 to be laid out as constant CoreFoundation strings.
2686 @item -fgnu-runtime
2687 @opindex fgnu-runtime
2688 Generate object code compatible with the standard GNU Objective-C
2689 runtime.  This is the default for most types of systems.
2691 @item -fnext-runtime
2692 @opindex fnext-runtime
2693 Generate output compatible with the NeXT runtime.  This is the default
2694 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2695 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2696 used.
2698 @item -fno-nil-receivers
2699 @opindex fno-nil-receivers
2700 Assume that all Objective-C message dispatches (@code{[receiver
2701 message:arg]}) in this translation unit ensure that the receiver is
2702 not @code{nil}.  This allows for more efficient entry points in the
2703 runtime to be used.  This option is only available in conjunction with
2704 the NeXT runtime and ABI version 0 or 1.
2706 @item -fobjc-abi-version=@var{n}
2707 @opindex fobjc-abi-version
2708 Use version @var{n} of the Objective-C ABI for the selected runtime.
2709 This option is currently supported only for the NeXT runtime.  In that
2710 case, Version 0 is the traditional (32-bit) ABI without support for
2711 properties and other Objective-C 2.0 additions.  Version 1 is the
2712 traditional (32-bit) ABI with support for properties and other
2713 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2714 nothing is specified, the default is Version 0 on 32-bit target
2715 machines, and Version 2 on 64-bit target machines.
2717 @item -fobjc-call-cxx-cdtors
2718 @opindex fobjc-call-cxx-cdtors
2719 For each Objective-C class, check if any of its instance variables is a
2720 C++ object with a non-trivial default constructor.  If so, synthesize a
2721 special @code{- (id) .cxx_construct} instance method which runs
2722 non-trivial default constructors on any such instance variables, in order,
2723 and then return @code{self}.  Similarly, check if any instance variable
2724 is a C++ object with a non-trivial destructor, and if so, synthesize a
2725 special @code{- (void) .cxx_destruct} method which runs
2726 all such default destructors, in reverse order.
2728 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2729 methods thusly generated only operate on instance variables
2730 declared in the current Objective-C class, and not those inherited
2731 from superclasses.  It is the responsibility of the Objective-C
2732 runtime to invoke all such methods in an object's inheritance
2733 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2734 by the runtime immediately after a new object instance is allocated;
2735 the @code{- (void) .cxx_destruct} methods are invoked immediately
2736 before the runtime deallocates an object instance.
2738 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2739 support for invoking the @code{- (id) .cxx_construct} and
2740 @code{- (void) .cxx_destruct} methods.
2742 @item -fobjc-direct-dispatch
2743 @opindex fobjc-direct-dispatch
2744 Allow fast jumps to the message dispatcher.  On Darwin this is
2745 accomplished via the comm page.
2747 @item -fobjc-exceptions
2748 @opindex fobjc-exceptions
2749 Enable syntactic support for structured exception handling in
2750 Objective-C, similar to what is offered by C++ and Java.  This option
2751 is required to use the Objective-C keywords @code{@@try},
2752 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2753 @code{@@synchronized}.  This option is available with both the GNU
2754 runtime and the NeXT runtime (but not available in conjunction with
2755 the NeXT runtime on Mac OS X 10.2 and earlier).
2757 @item -fobjc-gc
2758 @opindex fobjc-gc
2759 Enable garbage collection (GC) in Objective-C and Objective-C++
2760 programs.  This option is only available with the NeXT runtime; the
2761 GNU runtime has a different garbage collection implementation that
2762 does not require special compiler flags.
2764 @item -fobjc-nilcheck
2765 @opindex fobjc-nilcheck
2766 For the NeXT runtime with version 2 of the ABI, check for a nil
2767 receiver in method invocations before doing the actual method call.
2768 This is the default and can be disabled using
2769 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2770 checked for nil in this way no matter what this flag is set to.
2771 Currently this flag does nothing when the GNU runtime, or an older
2772 version of the NeXT runtime ABI, is used.
2774 @item -fobjc-std=objc1
2775 @opindex fobjc-std
2776 Conform to the language syntax of Objective-C 1.0, the language
2777 recognized by GCC 4.0.  This only affects the Objective-C additions to
2778 the C/C++ language; it does not affect conformance to C/C++ standards,
2779 which is controlled by the separate C/C++ dialect option flags.  When
2780 this option is used with the Objective-C or Objective-C++ compiler,
2781 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2782 This is useful if you need to make sure that your Objective-C code can
2783 be compiled with older versions of GCC@.
2785 @item -freplace-objc-classes
2786 @opindex freplace-objc-classes
2787 Emit a special marker instructing @command{ld(1)} not to statically link in
2788 the resulting object file, and allow @command{dyld(1)} to load it in at
2789 run time instead.  This is used in conjunction with the Fix-and-Continue
2790 debugging mode, where the object file in question may be recompiled and
2791 dynamically reloaded in the course of program execution, without the need
2792 to restart the program itself.  Currently, Fix-and-Continue functionality
2793 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2794 and later.
2796 @item -fzero-link
2797 @opindex fzero-link
2798 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2799 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2800 compile time) with static class references that get initialized at load time,
2801 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2802 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2803 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2804 for individual class implementations to be modified during program execution.
2805 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2806 regardless of command-line options.
2808 @item -gen-decls
2809 @opindex gen-decls
2810 Dump interface declarations for all classes seen in the source file to a
2811 file named @file{@var{sourcename}.decl}.
2813 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2814 @opindex Wassign-intercept
2815 @opindex Wno-assign-intercept
2816 Warn whenever an Objective-C assignment is being intercepted by the
2817 garbage collector.
2819 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2820 @opindex Wno-protocol
2821 @opindex Wprotocol
2822 If a class is declared to implement a protocol, a warning is issued for
2823 every method in the protocol that is not implemented by the class.  The
2824 default behavior is to issue a warning for every method not explicitly
2825 implemented in the class, even if a method implementation is inherited
2826 from the superclass.  If you use the @option{-Wno-protocol} option, then
2827 methods inherited from the superclass are considered to be implemented,
2828 and no warning is issued for them.
2830 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2831 @opindex Wselector
2832 @opindex Wno-selector
2833 Warn if multiple methods of different types for the same selector are
2834 found during compilation.  The check is performed on the list of methods
2835 in the final stage of compilation.  Additionally, a check is performed
2836 for each selector appearing in a @code{@@selector(@dots{})}
2837 expression, and a corresponding method for that selector has been found
2838 during compilation.  Because these checks scan the method table only at
2839 the end of compilation, these warnings are not produced if the final
2840 stage of compilation is not reached, for example because an error is
2841 found during compilation, or because the @option{-fsyntax-only} option is
2842 being used.
2844 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2845 @opindex Wstrict-selector-match
2846 @opindex Wno-strict-selector-match
2847 Warn if multiple methods with differing argument and/or return types are
2848 found for a given selector when attempting to send a message using this
2849 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2850 is off (which is the default behavior), the compiler omits such warnings
2851 if any differences found are confined to types that share the same size
2852 and alignment.
2854 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2855 @opindex Wundeclared-selector
2856 @opindex Wno-undeclared-selector
2857 Warn if a @code{@@selector(@dots{})} expression referring to an
2858 undeclared selector is found.  A selector is considered undeclared if no
2859 method with that name has been declared before the
2860 @code{@@selector(@dots{})} expression, either explicitly in an
2861 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2862 an @code{@@implementation} section.  This option always performs its
2863 checks as soon as a @code{@@selector(@dots{})} expression is found,
2864 while @option{-Wselector} only performs its checks in the final stage of
2865 compilation.  This also enforces the coding style convention
2866 that methods and selectors must be declared before being used.
2868 @item -print-objc-runtime-info
2869 @opindex print-objc-runtime-info
2870 Generate C header describing the largest structure that is passed by
2871 value, if any.
2873 @end table
2875 @node Language Independent Options
2876 @section Options to Control Diagnostic Messages Formatting
2877 @cindex options to control diagnostics formatting
2878 @cindex diagnostic messages
2879 @cindex message formatting
2881 Traditionally, diagnostic messages have been formatted irrespective of
2882 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2883 options described below
2884 to control the formatting algorithm for diagnostic messages, 
2885 e.g.@: how many characters per line, how often source location
2886 information should be reported.  Note that some language front ends may not
2887 honor these options.
2889 @table @gcctabopt
2890 @item -fmessage-length=@var{n}
2891 @opindex fmessage-length
2892 Try to format error messages so that they fit on lines of about @var{n}
2893 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2894 the front ends supported by GCC@.  If @var{n} is zero, then no
2895 line-wrapping is done; each error message appears on a single
2896 line.
2898 @item -fdiagnostics-show-location=once
2899 @opindex fdiagnostics-show-location
2900 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2901 reporter to emit @emph{once} source location information; that is, in
2902 case the message is too long to fit on a single physical line and has to
2903 be wrapped, the source location won't be emitted (as prefix) again,
2904 over and over, in subsequent continuation lines.  This is the default
2905 behavior.
2907 @item -fdiagnostics-show-location=every-line
2908 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2909 messages reporter to emit the same source location information (as
2910 prefix) for physical lines that result from the process of breaking
2911 a message which is too long to fit on a single line.
2913 @item -fno-diagnostics-show-option
2914 @opindex fno-diagnostics-show-option
2915 @opindex fdiagnostics-show-option
2916 By default, each diagnostic emitted includes text indicating the
2917 command-line option that directly controls the diagnostic (if such an
2918 option is known to the diagnostic machinery).  Specifying the
2919 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2921 @item -fno-diagnostics-show-caret
2922 @opindex fno-diagnostics-show-caret
2923 @opindex fdiagnostics-show-caret
2924 By default, each diagnostic emitted includes the original source line
2925 and a caret '^' indicating the column.  This option suppresses this
2926 information.
2928 @end table
2930 @node Warning Options
2931 @section Options to Request or Suppress Warnings
2932 @cindex options to control warnings
2933 @cindex warning messages
2934 @cindex messages, warning
2935 @cindex suppressing warnings
2937 Warnings are diagnostic messages that report constructions that
2938 are not inherently erroneous but that are risky or suggest there
2939 may have been an error.
2941 The following language-independent options do not enable specific
2942 warnings but control the kinds of diagnostics produced by GCC@.
2944 @table @gcctabopt
2945 @cindex syntax checking
2946 @item -fsyntax-only
2947 @opindex fsyntax-only
2948 Check the code for syntax errors, but don't do anything beyond that.
2950 @item -fmax-errors=@var{n}
2951 @opindex fmax-errors
2952 Limits the maximum number of error messages to @var{n}, at which point
2953 GCC bails out rather than attempting to continue processing the source
2954 code.  If @var{n} is 0 (the default), there is no limit on the number
2955 of error messages produced.  If @option{-Wfatal-errors} is also
2956 specified, then @option{-Wfatal-errors} takes precedence over this
2957 option.
2959 @item -w
2960 @opindex w
2961 Inhibit all warning messages.
2963 @item -Werror
2964 @opindex Werror
2965 @opindex Wno-error
2966 Make all warnings into errors.
2968 @item -Werror=
2969 @opindex Werror=
2970 @opindex Wno-error=
2971 Make the specified warning into an error.  The specifier for a warning
2972 is appended, for example @option{-Werror=switch} turns the warnings
2973 controlled by @option{-Wswitch} into errors.  This switch takes a
2974 negative form, to be used to negate @option{-Werror} for specific
2975 warnings, for example @option{-Wno-error=switch} makes
2976 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2977 is in effect.
2979 The warning message for each controllable warning includes the
2980 option that controls the warning.  That option can then be used with
2981 @option{-Werror=} and @option{-Wno-error=} as described above.
2982 (Printing of the option in the warning message can be disabled using the
2983 @option{-fno-diagnostics-show-option} flag.)
2985 Note that specifying @option{-Werror=}@var{foo} automatically implies
2986 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2987 imply anything.
2989 @item -Wfatal-errors
2990 @opindex Wfatal-errors
2991 @opindex Wno-fatal-errors
2992 This option causes the compiler to abort compilation on the first error
2993 occurred rather than trying to keep going and printing further error
2994 messages.
2996 @end table
2998 You can request many specific warnings with options beginning
2999 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3000 implicit declarations.  Each of these specific warning options also
3001 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3002 example, @option{-Wno-implicit}.  This manual lists only one of the
3003 two forms, whichever is not the default.  For further,
3004 language-specific options also refer to @ref{C++ Dialect Options} and
3005 @ref{Objective-C and Objective-C++ Dialect Options}.
3007 When an unrecognized warning option is requested (e.g.,
3008 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3009 that the option is not recognized.  However, if the @option{-Wno-} form
3010 is used, the behavior is slightly different: no diagnostic is
3011 produced for @option{-Wno-unknown-warning} unless other diagnostics
3012 are being produced.  This allows the use of new @option{-Wno-} options
3013 with old compilers, but if something goes wrong, the compiler
3014 warns that an unrecognized option is present.
3016 @table @gcctabopt
3017 @item -Wpedantic
3018 @itemx -pedantic
3019 @opindex pedantic
3020 @opindex Wpedantic
3021 Issue all the warnings demanded by strict ISO C and ISO C++;
3022 reject all programs that use forbidden extensions, and some other
3023 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3024 version of the ISO C standard specified by any @option{-std} option used.
3026 Valid ISO C and ISO C++ programs should compile properly with or without
3027 this option (though a rare few require @option{-ansi} or a
3028 @option{-std} option specifying the required version of ISO C)@.  However,
3029 without this option, certain GNU extensions and traditional C and C++
3030 features are supported as well.  With this option, they are rejected.
3032 @option{-Wpedantic} does not cause warning messages for use of the
3033 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3034 warnings are also disabled in the expression that follows
3035 @code{__extension__}.  However, only system header files should use
3036 these escape routes; application programs should avoid them.
3037 @xref{Alternate Keywords}.
3039 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3040 C conformance.  They soon find that it does not do quite what they want:
3041 it finds some non-ISO practices, but not all---only those for which
3042 ISO C @emph{requires} a diagnostic, and some others for which
3043 diagnostics have been added.
3045 A feature to report any failure to conform to ISO C might be useful in
3046 some instances, but would require considerable additional work and would
3047 be quite different from @option{-Wpedantic}.  We don't have plans to
3048 support such a feature in the near future.
3050 Where the standard specified with @option{-std} represents a GNU
3051 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3052 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3053 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3054 where they are required by the base standard.  (It does not make sense
3055 for such warnings to be given only for features not in the specified GNU
3056 C dialect, since by definition the GNU dialects of C include all
3057 features the compiler supports with the given option, and there would be
3058 nothing to warn about.)
3060 @item -pedantic-errors
3061 @opindex pedantic-errors
3062 Like @option{-Wpedantic}, except that errors are produced rather than
3063 warnings.
3065 @item -Wall
3066 @opindex Wall
3067 @opindex Wno-all
3068 This enables all the warnings about constructions that some users
3069 consider questionable, and that are easy to avoid (or modify to
3070 prevent the warning), even in conjunction with macros.  This also
3071 enables some language-specific warnings described in @ref{C++ Dialect
3072 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3074 @option{-Wall} turns on the following warning flags:
3076 @gccoptlist{-Waddress   @gol
3077 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3078 -Wc++11-compat  @gol
3079 -Wchar-subscripts  @gol
3080 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3081 -Wimplicit-int @r{(C and Objective-C only)} @gol
3082 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3083 -Wcomment  @gol
3084 -Wformat   @gol
3085 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3086 -Wmaybe-uninitialized @gol
3087 -Wmissing-braces @r{(only for C/ObjC)} @gol
3088 -Wnonnull  @gol
3089 -Wparentheses  @gol
3090 -Wpointer-sign  @gol
3091 -Wreorder   @gol
3092 -Wreturn-type  @gol
3093 -Wsequence-point  @gol
3094 -Wsign-compare @r{(only in C++)}  @gol
3095 -Wstrict-aliasing  @gol
3096 -Wstrict-overflow=1  @gol
3097 -Wswitch  @gol
3098 -Wtrigraphs  @gol
3099 -Wuninitialized  @gol
3100 -Wunknown-pragmas  @gol
3101 -Wunused-function  @gol
3102 -Wunused-label     @gol
3103 -Wunused-value     @gol
3104 -Wunused-variable  @gol
3105 -Wvolatile-register-var @gol
3108 Note that some warning flags are not implied by @option{-Wall}.  Some of
3109 them warn about constructions that users generally do not consider
3110 questionable, but which occasionally you might wish to check for;
3111 others warn about constructions that are necessary or hard to avoid in
3112 some cases, and there is no simple way to modify the code to suppress
3113 the warning. Some of them are enabled by @option{-Wextra} but many of
3114 them must be enabled individually.
3116 @item -Wextra
3117 @opindex W
3118 @opindex Wextra
3119 @opindex Wno-extra
3120 This enables some extra warning flags that are not enabled by
3121 @option{-Wall}. (This option used to be called @option{-W}.  The older
3122 name is still supported, but the newer name is more descriptive.)
3124 @gccoptlist{-Wclobbered  @gol
3125 -Wempty-body  @gol
3126 -Wignored-qualifiers @gol
3127 -Wmissing-field-initializers  @gol
3128 -Wmissing-parameter-type @r{(C only)}  @gol
3129 -Wold-style-declaration @r{(C only)}  @gol
3130 -Woverride-init  @gol
3131 -Wsign-compare  @gol
3132 -Wtype-limits  @gol
3133 -Wuninitialized  @gol
3134 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3135 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3138 The option @option{-Wextra} also prints warning messages for the
3139 following cases:
3141 @itemize @bullet
3143 @item
3144 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3145 @samp{>}, or @samp{>=}.
3147 @item
3148 (C++ only) An enumerator and a non-enumerator both appear in a
3149 conditional expression.
3151 @item
3152 (C++ only) Ambiguous virtual bases.
3154 @item
3155 (C++ only) Subscripting an array that has been declared @samp{register}.
3157 @item
3158 (C++ only) Taking the address of a variable that has been declared
3159 @samp{register}.
3161 @item
3162 (C++ only) A base class is not initialized in a derived class' copy
3163 constructor.
3165 @end itemize
3167 @item -Wchar-subscripts
3168 @opindex Wchar-subscripts
3169 @opindex Wno-char-subscripts
3170 Warn if an array subscript has type @code{char}.  This is a common cause
3171 of error, as programmers often forget that this type is signed on some
3172 machines.
3173 This warning is enabled by @option{-Wall}.
3175 @item -Wcomment
3176 @opindex Wcomment
3177 @opindex Wno-comment
3178 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3179 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3180 This warning is enabled by @option{-Wall}.
3182 @item -Wno-coverage-mismatch
3183 @opindex Wno-coverage-mismatch
3184 Warn if feedback profiles do not match when using the
3185 @option{-fprofile-use} option.
3186 If a source file is changed between compiling with @option{-fprofile-gen} and
3187 with @option{-fprofile-use}, the files with the profile feedback can fail
3188 to match the source file and GCC cannot use the profile feedback
3189 information.  By default, this warning is enabled and is treated as an
3190 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3191 warning or @option{-Wno-error=coverage-mismatch} can be used to
3192 disable the error.  Disabling the error for this warning can result in
3193 poorly optimized code and is useful only in the
3194 case of very minor changes such as bug fixes to an existing code-base.
3195 Completely disabling the warning is not recommended.
3197 @item -Wno-cpp
3198 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3200 Suppress warning messages emitted by @code{#warning} directives.
3202 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3203 @opindex Wdouble-promotion
3204 @opindex Wno-double-promotion
3205 Give a warning when a value of type @code{float} is implicitly
3206 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3207 floating-point unit implement @code{float} in hardware, but emulate
3208 @code{double} in software.  On such a machine, doing computations
3209 using @code{double} values is much more expensive because of the
3210 overhead required for software emulation.
3212 It is easy to accidentally do computations with @code{double} because
3213 floating-point literals are implicitly of type @code{double}.  For
3214 example, in:
3215 @smallexample
3216 @group
3217 float area(float radius)
3219    return 3.14159 * radius * radius;
3221 @end group
3222 @end smallexample
3223 the compiler performs the entire computation with @code{double}
3224 because the floating-point literal is a @code{double}.
3226 @item -Wformat
3227 @opindex Wformat
3228 @opindex Wno-format
3229 @opindex ffreestanding
3230 @opindex fno-builtin
3231 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3232 the arguments supplied have types appropriate to the format string
3233 specified, and that the conversions specified in the format string make
3234 sense.  This includes standard functions, and others specified by format
3235 attributes (@pxref{Function Attributes}), in the @code{printf},
3236 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3237 not in the C standard) families (or other target-specific families).
3238 Which functions are checked without format attributes having been
3239 specified depends on the standard version selected, and such checks of
3240 functions without the attribute specified are disabled by
3241 @option{-ffreestanding} or @option{-fno-builtin}.
3243 The formats are checked against the format features supported by GNU
3244 libc version 2.2.  These include all ISO C90 and C99 features, as well
3245 as features from the Single Unix Specification and some BSD and GNU
3246 extensions.  Other library implementations may not support all these
3247 features; GCC does not support warning about features that go beyond a
3248 particular library's limitations.  However, if @option{-Wpedantic} is used
3249 with @option{-Wformat}, warnings are given about format features not
3250 in the selected standard version (but not for @code{strfmon} formats,
3251 since those are not in any version of the C standard).  @xref{C Dialect
3252 Options,,Options Controlling C Dialect}.
3254 Since @option{-Wformat} also checks for null format arguments for
3255 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3257 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3258 aspects of format checking, the options @option{-Wformat-y2k},
3259 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3260 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3261 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3263 @item -Wformat-y2k
3264 @opindex Wformat-y2k
3265 @opindex Wno-format-y2k
3266 If @option{-Wformat} is specified, also warn about @code{strftime}
3267 formats that may yield only a two-digit year.
3269 @item -Wno-format-contains-nul
3270 @opindex Wno-format-contains-nul
3271 @opindex Wformat-contains-nul
3272 If @option{-Wformat} is specified, do not warn about format strings that
3273 contain NUL bytes.
3275 @item -Wno-format-extra-args
3276 @opindex Wno-format-extra-args
3277 @opindex Wformat-extra-args
3278 If @option{-Wformat} is specified, do not warn about excess arguments to a
3279 @code{printf} or @code{scanf} format function.  The C standard specifies
3280 that such arguments are ignored.
3282 Where the unused arguments lie between used arguments that are
3283 specified with @samp{$} operand number specifications, normally
3284 warnings are still given, since the implementation could not know what
3285 type to pass to @code{va_arg} to skip the unused arguments.  However,
3286 in the case of @code{scanf} formats, this option suppresses the
3287 warning if the unused arguments are all pointers, since the Single
3288 Unix Specification says that such unused arguments are allowed.
3290 @item -Wno-format-zero-length
3291 @opindex Wno-format-zero-length
3292 @opindex Wformat-zero-length
3293 If @option{-Wformat} is specified, do not warn about zero-length formats.
3294 The C standard specifies that zero-length formats are allowed.
3296 @item -Wformat-nonliteral
3297 @opindex Wformat-nonliteral
3298 @opindex Wno-format-nonliteral
3299 If @option{-Wformat} is specified, also warn if the format string is not a
3300 string literal and so cannot be checked, unless the format function
3301 takes its format arguments as a @code{va_list}.
3303 @item -Wformat-security
3304 @opindex Wformat-security
3305 @opindex Wno-format-security
3306 If @option{-Wformat} is specified, also warn about uses of format
3307 functions that represent possible security problems.  At present, this
3308 warns about calls to @code{printf} and @code{scanf} functions where the
3309 format string is not a string literal and there are no format arguments,
3310 as in @code{printf (foo);}.  This may be a security hole if the format
3311 string came from untrusted input and contains @samp{%n}.  (This is
3312 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3313 in future warnings may be added to @option{-Wformat-security} that are not
3314 included in @option{-Wformat-nonliteral}.)
3316 @item -Wformat=2
3317 @opindex Wformat=2
3318 @opindex Wno-format=2
3319 Enable @option{-Wformat} plus format checks not included in
3320 @option{-Wformat}.  Currently equivalent to @option{-Wformat
3321 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3323 @item -Wnonnull
3324 @opindex Wnonnull
3325 @opindex Wno-nonnull
3326 Warn about passing a null pointer for arguments marked as
3327 requiring a non-null value by the @code{nonnull} function attribute.
3329 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3330 can be disabled with the @option{-Wno-nonnull} option.
3332 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3333 @opindex Winit-self
3334 @opindex Wno-init-self
3335 Warn about uninitialized variables that are initialized with themselves.
3336 Note this option can only be used with the @option{-Wuninitialized} option.
3338 For example, GCC warns about @code{i} being uninitialized in the
3339 following snippet only when @option{-Winit-self} has been specified:
3340 @smallexample
3341 @group
3342 int f()
3344   int i = i;
3345   return i;
3347 @end group
3348 @end smallexample
3350 @item -Wimplicit-int @r{(C and Objective-C only)}
3351 @opindex Wimplicit-int
3352 @opindex Wno-implicit-int
3353 Warn when a declaration does not specify a type.
3354 This warning is enabled by @option{-Wall}.
3356 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3357 @opindex Wimplicit-function-declaration
3358 @opindex Wno-implicit-function-declaration
3359 Give a warning whenever a function is used before being declared. In
3360 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3361 enabled by default and it is made into an error by
3362 @option{-pedantic-errors}. This warning is also enabled by
3363 @option{-Wall}.
3365 @item -Wimplicit @r{(C and Objective-C only)}
3366 @opindex Wimplicit
3367 @opindex Wno-implicit
3368 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3369 This warning is enabled by @option{-Wall}.
3371 @item -Wignored-qualifiers @r{(C and C++ only)}
3372 @opindex Wignored-qualifiers
3373 @opindex Wno-ignored-qualifiers
3374 Warn if the return type of a function has a type qualifier
3375 such as @code{const}.  For ISO C such a type qualifier has no effect,
3376 since the value returned by a function is not an lvalue.
3377 For C++, the warning is only emitted for scalar types or @code{void}.
3378 ISO C prohibits qualified @code{void} return types on function
3379 definitions, so such return types always receive a warning
3380 even without this option.
3382 This warning is also enabled by @option{-Wextra}.
3384 @item -Wmain
3385 @opindex Wmain
3386 @opindex Wno-main
3387 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3388 a function with external linkage, returning int, taking either zero
3389 arguments, two, or three arguments of appropriate types.  This warning
3390 is enabled by default in C++ and is enabled by either @option{-Wall}
3391 or @option{-Wpedantic}.
3393 @item -Wmissing-braces
3394 @opindex Wmissing-braces
3395 @opindex Wno-missing-braces
3396 Warn if an aggregate or union initializer is not fully bracketed.  In
3397 the following example, the initializer for @samp{a} is not fully
3398 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3399 enabled by @option{-Wall} in C.
3401 @smallexample
3402 int a[2][2] = @{ 0, 1, 2, 3 @};
3403 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3404 @end smallexample
3406 This warning is enabled by @option{-Wall}.
3408 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3409 @opindex Wmissing-include-dirs
3410 @opindex Wno-missing-include-dirs
3411 Warn if a user-supplied include directory does not exist.
3413 @item -Wparentheses
3414 @opindex Wparentheses
3415 @opindex Wno-parentheses
3416 Warn if parentheses are omitted in certain contexts, such
3417 as when there is an assignment in a context where a truth value
3418 is expected, or when operators are nested whose precedence people
3419 often get confused about.
3421 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3422 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3423 interpretation from that of ordinary mathematical notation.
3425 Also warn about constructions where there may be confusion to which
3426 @code{if} statement an @code{else} branch belongs.  Here is an example of
3427 such a case:
3429 @smallexample
3430 @group
3432   if (a)
3433     if (b)
3434       foo ();
3435   else
3436     bar ();
3438 @end group
3439 @end smallexample
3441 In C/C++, every @code{else} branch belongs to the innermost possible
3442 @code{if} statement, which in this example is @code{if (b)}.  This is
3443 often not what the programmer expected, as illustrated in the above
3444 example by indentation the programmer chose.  When there is the
3445 potential for this confusion, GCC issues a warning when this flag
3446 is specified.  To eliminate the warning, add explicit braces around
3447 the innermost @code{if} statement so there is no way the @code{else}
3448 can belong to the enclosing @code{if}.  The resulting code
3449 looks like this:
3451 @smallexample
3452 @group
3454   if (a)
3455     @{
3456       if (b)
3457         foo ();
3458       else
3459         bar ();
3460     @}
3462 @end group
3463 @end smallexample
3465 Also warn for dangerous uses of the GNU extension to
3466 @code{?:} with omitted middle operand. When the condition
3467 in the @code{?}: operator is a boolean expression, the omitted value is
3468 always 1.  Often programmers expect it to be a value computed
3469 inside the conditional expression instead.
3471 This warning is enabled by @option{-Wall}.
3473 @item -Wsequence-point
3474 @opindex Wsequence-point
3475 @opindex Wno-sequence-point
3476 Warn about code that may have undefined semantics because of violations
3477 of sequence point rules in the C and C++ standards.
3479 The C and C++ standards defines the order in which expressions in a C/C++
3480 program are evaluated in terms of @dfn{sequence points}, which represent
3481 a partial ordering between the execution of parts of the program: those
3482 executed before the sequence point, and those executed after it.  These
3483 occur after the evaluation of a full expression (one which is not part
3484 of a larger expression), after the evaluation of the first operand of a
3485 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3486 function is called (but after the evaluation of its arguments and the
3487 expression denoting the called function), and in certain other places.
3488 Other than as expressed by the sequence point rules, the order of
3489 evaluation of subexpressions of an expression is not specified.  All
3490 these rules describe only a partial order rather than a total order,
3491 since, for example, if two functions are called within one expression
3492 with no sequence point between them, the order in which the functions
3493 are called is not specified.  However, the standards committee have
3494 ruled that function calls do not overlap.
3496 It is not specified when between sequence points modifications to the
3497 values of objects take effect.  Programs whose behavior depends on this
3498 have undefined behavior; the C and C++ standards specify that ``Between
3499 the previous and next sequence point an object shall have its stored
3500 value modified at most once by the evaluation of an expression.
3501 Furthermore, the prior value shall be read only to determine the value
3502 to be stored.''.  If a program breaks these rules, the results on any
3503 particular implementation are entirely unpredictable.
3505 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3506 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3507 diagnosed by this option, and it may give an occasional false positive
3508 result, but in general it has been found fairly effective at detecting
3509 this sort of problem in programs.
3511 The standard is worded confusingly, therefore there is some debate
3512 over the precise meaning of the sequence point rules in subtle cases.
3513 Links to discussions of the problem, including proposed formal
3514 definitions, may be found on the GCC readings page, at
3515 @uref{http://gcc.gnu.org/@/readings.html}.
3517 This warning is enabled by @option{-Wall} for C and C++.
3519 @item -Wreturn-type
3520 @opindex Wreturn-type
3521 @opindex Wno-return-type
3522 Warn whenever a function is defined with a return-type that defaults
3523 to @code{int}.  Also warn about any @code{return} statement with no
3524 return-value in a function whose return-type is not @code{void}
3525 (falling off the end of the function body is considered returning
3526 without a value), and about a @code{return} statement with an
3527 expression in a function whose return-type is @code{void}.
3529 For C++, a function without return type always produces a diagnostic
3530 message, even when @option{-Wno-return-type} is specified.  The only
3531 exceptions are @samp{main} and functions defined in system headers.
3533 This warning is enabled by @option{-Wall}.
3535 @item -Wswitch
3536 @opindex Wswitch
3537 @opindex Wno-switch
3538 Warn whenever a @code{switch} statement has an index of enumerated type
3539 and lacks a @code{case} for one or more of the named codes of that
3540 enumeration.  (The presence of a @code{default} label prevents this
3541 warning.)  @code{case} labels outside the enumeration range also
3542 provoke warnings when this option is used (even if there is a
3543 @code{default} label).
3544 This warning is enabled by @option{-Wall}.
3546 @item -Wswitch-default
3547 @opindex Wswitch-default
3548 @opindex Wno-switch-default
3549 Warn whenever a @code{switch} statement does not have a @code{default}
3550 case.
3552 @item -Wswitch-enum
3553 @opindex Wswitch-enum
3554 @opindex Wno-switch-enum
3555 Warn whenever a @code{switch} statement has an index of enumerated type
3556 and lacks a @code{case} for one or more of the named codes of that
3557 enumeration.  @code{case} labels outside the enumeration range also
3558 provoke warnings when this option is used.  The only difference
3559 between @option{-Wswitch} and this option is that this option gives a
3560 warning about an omitted enumeration code even if there is a
3561 @code{default} label.
3563 @item -Wsync-nand @r{(C and C++ only)}
3564 @opindex Wsync-nand
3565 @opindex Wno-sync-nand
3566 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3567 built-in functions are used.  These functions changed semantics in GCC 4.4.
3569 @item -Wtrigraphs
3570 @opindex Wtrigraphs
3571 @opindex Wno-trigraphs
3572 Warn if any trigraphs are encountered that might change the meaning of
3573 the program (trigraphs within comments are not warned about).
3574 This warning is enabled by @option{-Wall}.
3576 @item -Wunused-but-set-parameter
3577 @opindex Wunused-but-set-parameter
3578 @opindex Wno-unused-but-set-parameter
3579 Warn whenever a function parameter is assigned to, but otherwise unused
3580 (aside from its declaration).
3582 To suppress this warning use the @samp{unused} attribute
3583 (@pxref{Variable Attributes}).
3585 This warning is also enabled by @option{-Wunused} together with
3586 @option{-Wextra}.
3588 @item -Wunused-but-set-variable
3589 @opindex Wunused-but-set-variable
3590 @opindex Wno-unused-but-set-variable
3591 Warn whenever a local variable is assigned to, but otherwise unused
3592 (aside from its declaration).
3593 This warning is enabled by @option{-Wall}.
3595 To suppress this warning use the @samp{unused} attribute
3596 (@pxref{Variable Attributes}).
3598 This warning is also enabled by @option{-Wunused}, which is enabled
3599 by @option{-Wall}.
3601 @item -Wunused-function
3602 @opindex Wunused-function
3603 @opindex Wno-unused-function
3604 Warn whenever a static function is declared but not defined or a
3605 non-inline static function is unused.
3606 This warning is enabled by @option{-Wall}.
3608 @item -Wunused-label
3609 @opindex Wunused-label
3610 @opindex Wno-unused-label
3611 Warn whenever a label is declared but not used.
3612 This warning is enabled by @option{-Wall}.
3614 To suppress this warning use the @samp{unused} attribute
3615 (@pxref{Variable Attributes}).
3617 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3618 @opindex Wunused-local-typedefs
3619 Warn when a typedef locally defined in a function is not used.
3620 This warning is enabled by @option{-Wall}.
3622 @item -Wunused-parameter
3623 @opindex Wunused-parameter
3624 @opindex Wno-unused-parameter
3625 Warn whenever a function parameter is unused aside from its declaration.
3627 To suppress this warning use the @samp{unused} attribute
3628 (@pxref{Variable Attributes}).
3630 @item -Wno-unused-result
3631 @opindex Wunused-result
3632 @opindex Wno-unused-result
3633 Do not warn if a caller of a function marked with attribute
3634 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3635 its return value. The default is @option{-Wunused-result}.
3637 @item -Wunused-variable
3638 @opindex Wunused-variable
3639 @opindex Wno-unused-variable
3640 Warn whenever a local variable or non-constant static variable is unused
3641 aside from its declaration.
3642 This warning is enabled by @option{-Wall}.
3644 To suppress this warning use the @samp{unused} attribute
3645 (@pxref{Variable Attributes}).
3647 @item -Wunused-value
3648 @opindex Wunused-value
3649 @opindex Wno-unused-value
3650 Warn whenever a statement computes a result that is explicitly not
3651 used. To suppress this warning cast the unused expression to
3652 @samp{void}. This includes an expression-statement or the left-hand
3653 side of a comma expression that contains no side effects. For example,
3654 an expression such as @samp{x[i,j]} causes a warning, while
3655 @samp{x[(void)i,j]} does not.
3657 This warning is enabled by @option{-Wall}.
3659 @item -Wunused
3660 @opindex Wunused
3661 @opindex Wno-unused
3662 All the above @option{-Wunused} options combined.
3664 In order to get a warning about an unused function parameter, you must
3665 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3666 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3668 @item -Wuninitialized
3669 @opindex Wuninitialized
3670 @opindex Wno-uninitialized
3671 Warn if an automatic variable is used without first being initialized
3672 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3673 warn if a non-static reference or non-static @samp{const} member
3674 appears in a class without constructors.
3676 If you want to warn about code that uses the uninitialized value of the
3677 variable in its own initializer, use the @option{-Winit-self} option.
3679 These warnings occur for individual uninitialized or clobbered
3680 elements of structure, union or array variables as well as for
3681 variables that are uninitialized or clobbered as a whole.  They do
3682 not occur for variables or elements declared @code{volatile}.  Because
3683 these warnings depend on optimization, the exact variables or elements
3684 for which there are warnings depends on the precise optimization
3685 options and version of GCC used.
3687 Note that there may be no warning about a variable that is used only
3688 to compute a value that itself is never used, because such
3689 computations may be deleted by data flow analysis before the warnings
3690 are printed.
3692 @item -Wmaybe-uninitialized
3693 @opindex Wmaybe-uninitialized
3694 @opindex Wno-maybe-uninitialized
3695 For an automatic variable, if there exists a path from the function
3696 entry to a use of the variable that is initialized, but there exist
3697 some other paths for which the variable is not initialized, the compiler
3698 emits a warning if it cannot prove the uninitialized paths are not
3699 executed at run time. These warnings are made optional because GCC is
3700 not smart enough to see all the reasons why the code might be correct
3701 in spite of appearing to have an error.  Here is one example of how
3702 this can happen:
3704 @smallexample
3705 @group
3707   int x;
3708   switch (y)
3709     @{
3710     case 1: x = 1;
3711       break;
3712     case 2: x = 4;
3713       break;
3714     case 3: x = 5;
3715     @}
3716   foo (x);
3718 @end group
3719 @end smallexample
3721 @noindent
3722 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3723 always initialized, but GCC doesn't know this. To suppress the
3724 warning, you need to provide a default case with assert(0) or
3725 similar code.
3727 @cindex @code{longjmp} warnings
3728 This option also warns when a non-volatile automatic variable might be
3729 changed by a call to @code{longjmp}.  These warnings as well are possible
3730 only in optimizing compilation.
3732 The compiler sees only the calls to @code{setjmp}.  It cannot know
3733 where @code{longjmp} will be called; in fact, a signal handler could
3734 call it at any point in the code.  As a result, you may get a warning
3735 even when there is in fact no problem because @code{longjmp} cannot
3736 in fact be called at the place that would cause a problem.
3738 Some spurious warnings can be avoided if you declare all the functions
3739 you use that never return as @code{noreturn}.  @xref{Function
3740 Attributes}.
3742 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3744 @item -Wunknown-pragmas
3745 @opindex Wunknown-pragmas
3746 @opindex Wno-unknown-pragmas
3747 @cindex warning for unknown pragmas
3748 @cindex unknown pragmas, warning
3749 @cindex pragmas, warning of unknown
3750 Warn when a @code{#pragma} directive is encountered that is not understood by 
3751 GCC@.  If this command-line option is used, warnings are even issued
3752 for unknown pragmas in system header files.  This is not the case if
3753 the warnings are only enabled by the @option{-Wall} command-line option.
3755 @item -Wno-pragmas
3756 @opindex Wno-pragmas
3757 @opindex Wpragmas
3758 Do not warn about misuses of pragmas, such as incorrect parameters,
3759 invalid syntax, or conflicts between pragmas.  See also
3760 @option{-Wunknown-pragmas}.
3762 @item -Wstrict-aliasing
3763 @opindex Wstrict-aliasing
3764 @opindex Wno-strict-aliasing
3765 This option is only active when @option{-fstrict-aliasing} is active.
3766 It warns about code that might break the strict aliasing rules that the
3767 compiler is using for optimization.  The warning does not catch all
3768 cases, but does attempt to catch the more common pitfalls.  It is
3769 included in @option{-Wall}.
3770 It is equivalent to @option{-Wstrict-aliasing=3}
3772 @item -Wstrict-aliasing=n
3773 @opindex Wstrict-aliasing=n
3774 @opindex Wno-strict-aliasing=n
3775 This option is only active when @option{-fstrict-aliasing} is active.
3776 It warns about code that might break the strict aliasing rules that the
3777 compiler is using for optimization.
3778 Higher levels correspond to higher accuracy (fewer false positives).
3779 Higher levels also correspond to more effort, similar to the way @option{-O} 
3780 works.
3781 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3783 Level 1: Most aggressive, quick, least accurate.
3784 Possibly useful when higher levels
3785 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3786 false negatives.  However, it has many false positives.
3787 Warns for all pointer conversions between possibly incompatible types,
3788 even if never dereferenced.  Runs in the front end only.
3790 Level 2: Aggressive, quick, not too precise.
3791 May still have many false positives (not as many as level 1 though),
3792 and few false negatives (but possibly more than level 1).
3793 Unlike level 1, it only warns when an address is taken.  Warns about
3794 incomplete types.  Runs in the front end only.
3796 Level 3 (default for @option{-Wstrict-aliasing}):
3797 Should have very few false positives and few false
3798 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3799 Takes care of the common pun+dereference pattern in the front end:
3800 @code{*(int*)&some_float}.
3801 If optimization is enabled, it also runs in the back end, where it deals
3802 with multiple statement cases using flow-sensitive points-to information.
3803 Only warns when the converted pointer is dereferenced.
3804 Does not warn about incomplete types.
3806 @item -Wstrict-overflow
3807 @itemx -Wstrict-overflow=@var{n}
3808 @opindex Wstrict-overflow
3809 @opindex Wno-strict-overflow
3810 This option is only active when @option{-fstrict-overflow} is active.
3811 It warns about cases where the compiler optimizes based on the
3812 assumption that signed overflow does not occur.  Note that it does not
3813 warn about all cases where the code might overflow: it only warns
3814 about cases where the compiler implements some optimization.  Thus
3815 this warning depends on the optimization level.
3817 An optimization that assumes that signed overflow does not occur is
3818 perfectly safe if the values of the variables involved are such that
3819 overflow never does, in fact, occur.  Therefore this warning can
3820 easily give a false positive: a warning about code that is not
3821 actually a problem.  To help focus on important issues, several
3822 warning levels are defined.  No warnings are issued for the use of
3823 undefined signed overflow when estimating how many iterations a loop
3824 requires, in particular when determining whether a loop will be
3825 executed at all.
3827 @table @gcctabopt
3828 @item -Wstrict-overflow=1
3829 Warn about cases that are both questionable and easy to avoid.  For
3830 example,  with @option{-fstrict-overflow}, the compiler simplifies
3831 @code{x + 1 > x} to @code{1}.  This level of
3832 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3833 are not, and must be explicitly requested.
3835 @item -Wstrict-overflow=2
3836 Also warn about other cases where a comparison is simplified to a
3837 constant.  For example: @code{abs (x) >= 0}.  This can only be
3838 simplified when @option{-fstrict-overflow} is in effect, because
3839 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3840 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3841 @option{-Wstrict-overflow=2}.
3843 @item -Wstrict-overflow=3
3844 Also warn about other cases where a comparison is simplified.  For
3845 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3847 @item -Wstrict-overflow=4
3848 Also warn about other simplifications not covered by the above cases.
3849 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3851 @item -Wstrict-overflow=5
3852 Also warn about cases where the compiler reduces the magnitude of a
3853 constant involved in a comparison.  For example: @code{x + 2 > y} is
3854 simplified to @code{x + 1 >= y}.  This is reported only at the
3855 highest warning level because this simplification applies to many
3856 comparisons, so this warning level gives a very large number of
3857 false positives.
3858 @end table
3860 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3861 @opindex Wsuggest-attribute=
3862 @opindex Wno-suggest-attribute=
3863 Warn for cases where adding an attribute may be beneficial. The
3864 attributes currently supported are listed below.
3866 @table @gcctabopt
3867 @item -Wsuggest-attribute=pure
3868 @itemx -Wsuggest-attribute=const
3869 @itemx -Wsuggest-attribute=noreturn
3870 @opindex Wsuggest-attribute=pure
3871 @opindex Wno-suggest-attribute=pure
3872 @opindex Wsuggest-attribute=const
3873 @opindex Wno-suggest-attribute=const
3874 @opindex Wsuggest-attribute=noreturn
3875 @opindex Wno-suggest-attribute=noreturn
3877 Warn about functions that might be candidates for attributes
3878 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3879 functions visible in other compilation units or (in the case of @code{pure} and
3880 @code{const}) if it cannot prove that the function returns normally. A function
3881 returns normally if it doesn't contain an infinite loop nor returns abnormally
3882 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3883 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3884 higher.  Higher optimization levels improve the accuracy of the analysis.
3886 @item -Wsuggest-attribute=format
3887 @itemx -Wmissing-format-attribute
3888 @opindex Wsuggest-attribute=format
3889 @opindex Wmissing-format-attribute
3890 @opindex Wno-suggest-attribute=format
3891 @opindex Wno-missing-format-attribute
3892 @opindex Wformat
3893 @opindex Wno-format
3895 Warn about function pointers that might be candidates for @code{format}
3896 attributes.  Note these are only possible candidates, not absolute ones.
3897 GCC guesses that function pointers with @code{format} attributes that
3898 are used in assignment, initialization, parameter passing or return
3899 statements should have a corresponding @code{format} attribute in the
3900 resulting type.  I.e.@: the left-hand side of the assignment or
3901 initialization, the type of the parameter variable, or the return type
3902 of the containing function respectively should also have a @code{format}
3903 attribute to avoid the warning.
3905 GCC also warns about function definitions that might be
3906 candidates for @code{format} attributes.  Again, these are only
3907 possible candidates.  GCC guesses that @code{format} attributes
3908 might be appropriate for any function that calls a function like
3909 @code{vprintf} or @code{vscanf}, but this might not always be the
3910 case, and some functions for which @code{format} attributes are
3911 appropriate may not be detected.
3912 @end table
3914 @item -Warray-bounds
3915 @opindex Wno-array-bounds
3916 @opindex Warray-bounds
3917 This option is only active when @option{-ftree-vrp} is active
3918 (default for @option{-O2} and above). It warns about subscripts to arrays
3919 that are always out of bounds. This warning is enabled by @option{-Wall}.
3921 @item -Wno-div-by-zero
3922 @opindex Wno-div-by-zero
3923 @opindex Wdiv-by-zero
3924 Do not warn about compile-time integer division by zero.  Floating-point
3925 division by zero is not warned about, as it can be a legitimate way of
3926 obtaining infinities and NaNs.
3928 @item -Wsystem-headers
3929 @opindex Wsystem-headers
3930 @opindex Wno-system-headers
3931 @cindex warnings from system headers
3932 @cindex system headers, warnings from
3933 Print warning messages for constructs found in system header files.
3934 Warnings from system headers are normally suppressed, on the assumption
3935 that they usually do not indicate real problems and would only make the
3936 compiler output harder to read.  Using this command-line option tells
3937 GCC to emit warnings from system headers as if they occurred in user
3938 code.  However, note that using @option{-Wall} in conjunction with this
3939 option does @emph{not} warn about unknown pragmas in system
3940 headers---for that, @option{-Wunknown-pragmas} must also be used.
3942 @item -Wtrampolines
3943 @opindex Wtrampolines
3944 @opindex Wno-trampolines
3945  Warn about trampolines generated for pointers to nested functions.
3947  A trampoline is a small piece of data or code that is created at run
3948  time on the stack when the address of a nested function is taken, and
3949  is used to call the nested function indirectly.  For some targets, it
3950  is made up of data only and thus requires no special treatment.  But,
3951  for most targets, it is made up of code and thus requires the stack
3952  to be made executable in order for the program to work properly.
3954 @item -Wfloat-equal
3955 @opindex Wfloat-equal
3956 @opindex Wno-float-equal
3957 Warn if floating-point values are used in equality comparisons.
3959 The idea behind this is that sometimes it is convenient (for the
3960 programmer) to consider floating-point values as approximations to
3961 infinitely precise real numbers.  If you are doing this, then you need
3962 to compute (by analyzing the code, or in some other way) the maximum or
3963 likely maximum error that the computation introduces, and allow for it
3964 when performing comparisons (and when producing output, but that's a
3965 different problem).  In particular, instead of testing for equality, you
3966 should check to see whether the two values have ranges that overlap; and
3967 this is done with the relational operators, so equality comparisons are
3968 probably mistaken.
3970 @item -Wtraditional @r{(C and Objective-C only)}
3971 @opindex Wtraditional
3972 @opindex Wno-traditional
3973 Warn about certain constructs that behave differently in traditional and
3974 ISO C@.  Also warn about ISO C constructs that have no traditional C
3975 equivalent, and/or problematic constructs that should be avoided.
3977 @itemize @bullet
3978 @item
3979 Macro parameters that appear within string literals in the macro body.
3980 In traditional C macro replacement takes place within string literals,
3981 but does not in ISO C@.
3983 @item
3984 In traditional C, some preprocessor directives did not exist.
3985 Traditional preprocessors only considered a line to be a directive
3986 if the @samp{#} appeared in column 1 on the line.  Therefore
3987 @option{-Wtraditional} warns about directives that traditional C
3988 understands but ignores because the @samp{#} does not appear as the
3989 first character on the line.  It also suggests you hide directives like
3990 @samp{#pragma} not understood by traditional C by indenting them.  Some
3991 traditional implementations do not recognize @samp{#elif}, so this option
3992 suggests avoiding it altogether.
3994 @item
3995 A function-like macro that appears without arguments.
3997 @item
3998 The unary plus operator.
4000 @item
4001 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4002 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4003 constants.)  Note, these suffixes appear in macros defined in the system
4004 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4005 Use of these macros in user code might normally lead to spurious
4006 warnings, however GCC's integrated preprocessor has enough context to
4007 avoid warning in these cases.
4009 @item
4010 A function declared external in one block and then used after the end of
4011 the block.
4013 @item
4014 A @code{switch} statement has an operand of type @code{long}.
4016 @item
4017 A non-@code{static} function declaration follows a @code{static} one.
4018 This construct is not accepted by some traditional C compilers.
4020 @item
4021 The ISO type of an integer constant has a different width or
4022 signedness from its traditional type.  This warning is only issued if
4023 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4024 typically represent bit patterns, are not warned about.
4026 @item
4027 Usage of ISO string concatenation is detected.
4029 @item
4030 Initialization of automatic aggregates.
4032 @item
4033 Identifier conflicts with labels.  Traditional C lacks a separate
4034 namespace for labels.
4036 @item
4037 Initialization of unions.  If the initializer is zero, the warning is
4038 omitted.  This is done under the assumption that the zero initializer in
4039 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4040 initializer warnings and relies on default initialization to zero in the
4041 traditional C case.
4043 @item
4044 Conversions by prototypes between fixed/floating-point values and vice
4045 versa.  The absence of these prototypes when compiling with traditional
4046 C causes serious problems.  This is a subset of the possible
4047 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4049 @item
4050 Use of ISO C style function definitions.  This warning intentionally is
4051 @emph{not} issued for prototype declarations or variadic functions
4052 because these ISO C features appear in your code when using
4053 libiberty's traditional C compatibility macros, @code{PARAMS} and
4054 @code{VPARAMS}.  This warning is also bypassed for nested functions
4055 because that feature is already a GCC extension and thus not relevant to
4056 traditional C compatibility.
4057 @end itemize
4059 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4060 @opindex Wtraditional-conversion
4061 @opindex Wno-traditional-conversion
4062 Warn if a prototype causes a type conversion that is different from what
4063 would happen to the same argument in the absence of a prototype.  This
4064 includes conversions of fixed point to floating and vice versa, and
4065 conversions changing the width or signedness of a fixed-point argument
4066 except when the same as the default promotion.
4068 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4069 @opindex Wdeclaration-after-statement
4070 @opindex Wno-declaration-after-statement
4071 Warn when a declaration is found after a statement in a block.  This
4072 construct, known from C++, was introduced with ISO C99 and is by default
4073 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4074 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4076 @item -Wundef
4077 @opindex Wundef
4078 @opindex Wno-undef
4079 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4081 @item -Wno-endif-labels
4082 @opindex Wno-endif-labels
4083 @opindex Wendif-labels
4084 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4086 @item -Wshadow
4087 @opindex Wshadow
4088 @opindex Wno-shadow
4089 Warn whenever a local variable or type declaration shadows another variable,
4090 parameter, type, or class member (in C++), or whenever a built-in function
4091 is shadowed. Note that in C++, the compiler warns if a local variable
4092 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4094 @item -Wlarger-than=@var{len}
4095 @opindex Wlarger-than=@var{len}
4096 @opindex Wlarger-than-@var{len}
4097 Warn whenever an object of larger than @var{len} bytes is defined.
4099 @item -Wframe-larger-than=@var{len}
4100 @opindex Wframe-larger-than
4101 Warn if the size of a function frame is larger than @var{len} bytes.
4102 The computation done to determine the stack frame size is approximate
4103 and not conservative.
4104 The actual requirements may be somewhat greater than @var{len}
4105 even if you do not get a warning.  In addition, any space allocated
4106 via @code{alloca}, variable-length arrays, or related constructs
4107 is not included by the compiler when determining
4108 whether or not to issue a warning.
4110 @item -Wno-free-nonheap-object
4111 @opindex Wno-free-nonheap-object
4112 @opindex Wfree-nonheap-object
4113 Do not warn when attempting to free an object that was not allocated
4114 on the heap.
4116 @item -Wstack-usage=@var{len}
4117 @opindex Wstack-usage
4118 Warn if the stack usage of a function might be larger than @var{len} bytes.
4119 The computation done to determine the stack usage is conservative.
4120 Any space allocated via @code{alloca}, variable-length arrays, or related
4121 constructs is included by the compiler when determining whether or not to
4122 issue a warning.
4124 The message is in keeping with the output of @option{-fstack-usage}.
4126 @itemize
4127 @item
4128 If the stack usage is fully static but exceeds the specified amount, it's:
4130 @smallexample
4131   warning: stack usage is 1120 bytes
4132 @end smallexample
4133 @item
4134 If the stack usage is (partly) dynamic but bounded, it's:
4136 @smallexample
4137   warning: stack usage might be 1648 bytes
4138 @end smallexample
4139 @item
4140 If the stack usage is (partly) dynamic and not bounded, it's:
4142 @smallexample
4143   warning: stack usage might be unbounded
4144 @end smallexample
4145 @end itemize
4147 @item -Wunsafe-loop-optimizations
4148 @opindex Wunsafe-loop-optimizations
4149 @opindex Wno-unsafe-loop-optimizations
4150 Warn if the loop cannot be optimized because the compiler cannot
4151 assume anything on the bounds of the loop indices.  With
4152 @option{-funsafe-loop-optimizations} warn if the compiler makes
4153 such assumptions.
4155 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4156 @opindex Wno-pedantic-ms-format
4157 @opindex Wpedantic-ms-format
4158 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4159 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4160 depending on the MS runtime, when you are using the options @option{-Wformat}
4161 and @option{-Wpedantic} without gnu-extensions.
4163 @item -Wpointer-arith
4164 @opindex Wpointer-arith
4165 @opindex Wno-pointer-arith
4166 Warn about anything that depends on the ``size of'' a function type or
4167 of @code{void}.  GNU C assigns these types a size of 1, for
4168 convenience in calculations with @code{void *} pointers and pointers
4169 to functions.  In C++, warn also when an arithmetic operation involves
4170 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4172 @item -Wtype-limits
4173 @opindex Wtype-limits
4174 @opindex Wno-type-limits
4175 Warn if a comparison is always true or always false due to the limited
4176 range of the data type, but do not warn for constant expressions.  For
4177 example, warn if an unsigned variable is compared against zero with
4178 @samp{<} or @samp{>=}.  This warning is also enabled by
4179 @option{-Wextra}.
4181 @item -Wbad-function-cast @r{(C and Objective-C only)}
4182 @opindex Wbad-function-cast
4183 @opindex Wno-bad-function-cast
4184 Warn whenever a function call is cast to a non-matching type.
4185 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4187 @item -Wc++-compat @r{(C and Objective-C only)}
4188 Warn about ISO C constructs that are outside of the common subset of
4189 ISO C and ISO C++, e.g.@: request for implicit conversion from
4190 @code{void *} to a pointer to non-@code{void} type.
4192 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4193 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4194 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4195 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4196 enabled by @option{-Wall}.
4198 @item -Wcast-qual
4199 @opindex Wcast-qual
4200 @opindex Wno-cast-qual
4201 Warn whenever a pointer is cast so as to remove a type qualifier from
4202 the target type.  For example, warn if a @code{const char *} is cast
4203 to an ordinary @code{char *}.
4205 Also warn when making a cast that introduces a type qualifier in an
4206 unsafe way.  For example, casting @code{char **} to @code{const char **}
4207 is unsafe, as in this example:
4209 @smallexample
4210   /* p is char ** value.  */
4211   const char **q = (const char **) p;
4212   /* Assignment of readonly string to const char * is OK.  */
4213   *q = "string";
4214   /* Now char** pointer points to read-only memory.  */
4215   **p = 'b';
4216 @end smallexample
4218 @item -Wcast-align
4219 @opindex Wcast-align
4220 @opindex Wno-cast-align
4221 Warn whenever a pointer is cast such that the required alignment of the
4222 target is increased.  For example, warn if a @code{char *} is cast to
4223 an @code{int *} on machines where integers can only be accessed at
4224 two- or four-byte boundaries.
4226 @item -Wwrite-strings
4227 @opindex Wwrite-strings
4228 @opindex Wno-write-strings
4229 When compiling C, give string constants the type @code{const
4230 char[@var{length}]} so that copying the address of one into a
4231 non-@code{const} @code{char *} pointer produces a warning.  These
4232 warnings help you find at compile time code that can try to write
4233 into a string constant, but only if you have been very careful about
4234 using @code{const} in declarations and prototypes.  Otherwise, it is
4235 just a nuisance. This is why we did not make @option{-Wall} request
4236 these warnings.
4238 When compiling C++, warn about the deprecated conversion from string
4239 literals to @code{char *}.  This warning is enabled by default for C++
4240 programs.
4242 @item -Wclobbered
4243 @opindex Wclobbered
4244 @opindex Wno-clobbered
4245 Warn for variables that might be changed by @samp{longjmp} or
4246 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4248 @item -Wconversion
4249 @opindex Wconversion
4250 @opindex Wno-conversion
4251 Warn for implicit conversions that may alter a value. This includes
4252 conversions between real and integer, like @code{abs (x)} when
4253 @code{x} is @code{double}; conversions between signed and unsigned,
4254 like @code{unsigned ui = -1}; and conversions to smaller types, like
4255 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4256 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4257 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4258 conversions between signed and unsigned integers can be disabled by
4259 using @option{-Wno-sign-conversion}.
4261 For C++, also warn for confusing overload resolution for user-defined
4262 conversions; and conversions that never use a type conversion
4263 operator: conversions to @code{void}, the same type, a base class or a
4264 reference to them. Warnings about conversions between signed and
4265 unsigned integers are disabled by default in C++ unless
4266 @option{-Wsign-conversion} is explicitly enabled.
4268 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4269 @opindex Wconversion-null
4270 @opindex Wno-conversion-null
4271 Do not warn for conversions between @code{NULL} and non-pointer
4272 types. @option{-Wconversion-null} is enabled by default.
4274 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4275 @opindex Wzero-as-null-pointer-constant
4276 @opindex Wno-zero-as-null-pointer-constant
4277 Warn when a literal '0' is used as null pointer constant.  This can
4278 be useful to facilitate the conversion to @code{nullptr} in C++11.
4280 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4281 @opindex Wuseless-cast
4282 @opindex Wno-useless-cast
4283 Warn when an expression is casted to its own type.
4285 @item -Wempty-body
4286 @opindex Wempty-body
4287 @opindex Wno-empty-body
4288 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4289 while} statement.  This warning is also enabled by @option{-Wextra}.
4291 @item -Wenum-compare
4292 @opindex Wenum-compare
4293 @opindex Wno-enum-compare
4294 Warn about a comparison between values of different enumerated types.
4295 In C++ enumeral mismatches in conditional expressions are also
4296 diagnosed and the warning is enabled by default.  In C this warning is 
4297 enabled by @option{-Wall}.
4299 @item -Wjump-misses-init @r{(C, Objective-C only)}
4300 @opindex Wjump-misses-init
4301 @opindex Wno-jump-misses-init
4302 Warn if a @code{goto} statement or a @code{switch} statement jumps
4303 forward across the initialization of a variable, or jumps backward to a
4304 label after the variable has been initialized.  This only warns about
4305 variables that are initialized when they are declared.  This warning is
4306 only supported for C and Objective-C; in C++ this sort of branch is an
4307 error in any case.
4309 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4310 can be disabled with the @option{-Wno-jump-misses-init} option.
4312 @item -Wsign-compare
4313 @opindex Wsign-compare
4314 @opindex Wno-sign-compare
4315 @cindex warning for comparison of signed and unsigned values
4316 @cindex comparison of signed and unsigned values, warning
4317 @cindex signed and unsigned values, comparison warning
4318 Warn when a comparison between signed and unsigned values could produce
4319 an incorrect result when the signed value is converted to unsigned.
4320 This warning is also enabled by @option{-Wextra}; to get the other warnings
4321 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4323 @item -Wsign-conversion
4324 @opindex Wsign-conversion
4325 @opindex Wno-sign-conversion
4326 Warn for implicit conversions that may change the sign of an integer
4327 value, like assigning a signed integer expression to an unsigned
4328 integer variable. An explicit cast silences the warning. In C, this
4329 option is enabled also by @option{-Wconversion}.
4331 @item -Waddress
4332 @opindex Waddress
4333 @opindex Wno-address
4334 Warn about suspicious uses of memory addresses. These include using
4335 the address of a function in a conditional expression, such as
4336 @code{void func(void); if (func)}, and comparisons against the memory
4337 address of a string literal, such as @code{if (x == "abc")}.  Such
4338 uses typically indicate a programmer error: the address of a function
4339 always evaluates to true, so their use in a conditional usually
4340 indicate that the programmer forgot the parentheses in a function
4341 call; and comparisons against string literals result in unspecified
4342 behavior and are not portable in C, so they usually indicate that the
4343 programmer intended to use @code{strcmp}.  This warning is enabled by
4344 @option{-Wall}.
4346 @item -Wlogical-op
4347 @opindex Wlogical-op
4348 @opindex Wno-logical-op
4349 Warn about suspicious uses of logical operators in expressions.
4350 This includes using logical operators in contexts where a
4351 bit-wise operator is likely to be expected.
4353 @item -Waggregate-return
4354 @opindex Waggregate-return
4355 @opindex Wno-aggregate-return
4356 Warn if any functions that return structures or unions are defined or
4357 called.  (In languages where you can return an array, this also elicits
4358 a warning.)
4360 @item -Wno-attributes
4361 @opindex Wno-attributes
4362 @opindex Wattributes
4363 Do not warn if an unexpected @code{__attribute__} is used, such as
4364 unrecognized attributes, function attributes applied to variables,
4365 etc.  This does not stop errors for incorrect use of supported
4366 attributes.
4368 @item -Wno-builtin-macro-redefined
4369 @opindex Wno-builtin-macro-redefined
4370 @opindex Wbuiltin-macro-redefined
4371 Do not warn if certain built-in macros are redefined.  This suppresses
4372 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4373 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4375 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4376 @opindex Wstrict-prototypes
4377 @opindex Wno-strict-prototypes
4378 Warn if a function is declared or defined without specifying the
4379 argument types.  (An old-style function definition is permitted without
4380 a warning if preceded by a declaration that specifies the argument
4381 types.)
4383 @item -Wold-style-declaration @r{(C and Objective-C only)}
4384 @opindex Wold-style-declaration
4385 @opindex Wno-old-style-declaration
4386 Warn for obsolescent usages, according to the C Standard, in a
4387 declaration. For example, warn if storage-class specifiers like
4388 @code{static} are not the first things in a declaration.  This warning
4389 is also enabled by @option{-Wextra}.
4391 @item -Wold-style-definition @r{(C and Objective-C only)}
4392 @opindex Wold-style-definition
4393 @opindex Wno-old-style-definition
4394 Warn if an old-style function definition is used.  A warning is given
4395 even if there is a previous prototype.
4397 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4398 @opindex Wmissing-parameter-type
4399 @opindex Wno-missing-parameter-type
4400 A function parameter is declared without a type specifier in K&R-style
4401 functions:
4403 @smallexample
4404 void foo(bar) @{ @}
4405 @end smallexample
4407 This warning is also enabled by @option{-Wextra}.
4409 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4410 @opindex Wmissing-prototypes
4411 @opindex Wno-missing-prototypes
4412 Warn if a global function is defined without a previous prototype
4413 declaration.  This warning is issued even if the definition itself
4414 provides a prototype.  Use this option to detect global functions
4415 that do not have a matching prototype declaration in a header file.
4416 This option is not valid for C++ because all function declarations
4417 provide prototypes and a non-matching declaration will declare an
4418 overload rather than conflict with an earlier declaration.
4419 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4421 @item -Wmissing-declarations
4422 @opindex Wmissing-declarations
4423 @opindex Wno-missing-declarations
4424 Warn if a global function is defined without a previous declaration.
4425 Do so even if the definition itself provides a prototype.
4426 Use this option to detect global functions that are not declared in
4427 header files.  In C, no warnings are issued for functions with previous
4428 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4429 missing prototypes.  In C++, no warnings are issued for function templates,
4430 or for inline functions, or for functions in anonymous namespaces.
4432 @item -Wmissing-field-initializers
4433 @opindex Wmissing-field-initializers
4434 @opindex Wno-missing-field-initializers
4435 @opindex W
4436 @opindex Wextra
4437 @opindex Wno-extra
4438 Warn if a structure's initializer has some fields missing.  For
4439 example, the following code causes such a warning, because
4440 @code{x.h} is implicitly zero:
4442 @smallexample
4443 struct s @{ int f, g, h; @};
4444 struct s x = @{ 3, 4 @};
4445 @end smallexample
4447 This option does not warn about designated initializers, so the following
4448 modification does not trigger a warning:
4450 @smallexample
4451 struct s @{ int f, g, h; @};
4452 struct s x = @{ .f = 3, .g = 4 @};
4453 @end smallexample
4455 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4456 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4458 @item -Wno-multichar
4459 @opindex Wno-multichar
4460 @opindex Wmultichar
4461 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4462 Usually they indicate a typo in the user's code, as they have
4463 implementation-defined values, and should not be used in portable code.
4465 @item -Wnormalized=<none|id|nfc|nfkc>
4466 @opindex Wnormalized=
4467 @cindex NFC
4468 @cindex NFKC
4469 @cindex character set, input normalization
4470 In ISO C and ISO C++, two identifiers are different if they are
4471 different sequences of characters.  However, sometimes when characters
4472 outside the basic ASCII character set are used, you can have two
4473 different character sequences that look the same.  To avoid confusion,
4474 the ISO 10646 standard sets out some @dfn{normalization rules} which
4475 when applied ensure that two sequences that look the same are turned into
4476 the same sequence.  GCC can warn you if you are using identifiers that
4477 have not been normalized; this option controls that warning.
4479 There are four levels of warning supported by GCC@.  The default is
4480 @option{-Wnormalized=nfc}, which warns about any identifier that is
4481 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4482 recommended form for most uses.
4484 Unfortunately, there are some characters allowed in identifiers by
4485 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4486 identifiers.  That is, there's no way to use these symbols in portable
4487 ISO C or C++ and have all your identifiers in NFC@.
4488 @option{-Wnormalized=id} suppresses the warning for these characters.
4489 It is hoped that future versions of the standards involved will correct
4490 this, which is why this option is not the default.
4492 You can switch the warning off for all characters by writing
4493 @option{-Wnormalized=none}.  You should only do this if you
4494 are using some other normalization scheme (like ``D''), because
4495 otherwise you can easily create bugs that are literally impossible to see.
4497 Some characters in ISO 10646 have distinct meanings but look identical
4498 in some fonts or display methodologies, especially once formatting has
4499 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4500 LETTER N'', displays just like a regular @code{n} that has been
4501 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4502 normalization scheme to convert all these into a standard form as
4503 well, and GCC warns if your code is not in NFKC if you use
4504 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4505 about every identifier that contains the letter O because it might be
4506 confused with the digit 0, and so is not the default, but may be
4507 useful as a local coding convention if the programming environment 
4508 cannot be fixed to display these characters distinctly.
4510 @item -Wno-deprecated
4511 @opindex Wno-deprecated
4512 @opindex Wdeprecated
4513 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4515 @item -Wno-deprecated-declarations
4516 @opindex Wno-deprecated-declarations
4517 @opindex Wdeprecated-declarations
4518 Do not warn about uses of functions (@pxref{Function Attributes}),
4519 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4520 Attributes}) marked as deprecated by using the @code{deprecated}
4521 attribute.
4523 @item -Wno-overflow
4524 @opindex Wno-overflow
4525 @opindex Woverflow
4526 Do not warn about compile-time overflow in constant expressions.
4528 @item -Woverride-init @r{(C and Objective-C only)}
4529 @opindex Woverride-init
4530 @opindex Wno-override-init
4531 @opindex W
4532 @opindex Wextra
4533 @opindex Wno-extra
4534 Warn if an initialized field without side effects is overridden when
4535 using designated initializers (@pxref{Designated Inits, , Designated
4536 Initializers}).
4538 This warning is included in @option{-Wextra}.  To get other
4539 @option{-Wextra} warnings without this one, use @option{-Wextra
4540 -Wno-override-init}.
4542 @item -Wpacked
4543 @opindex Wpacked
4544 @opindex Wno-packed
4545 Warn if a structure is given the packed attribute, but the packed
4546 attribute has no effect on the layout or size of the structure.
4547 Such structures may be mis-aligned for little benefit.  For
4548 instance, in this code, the variable @code{f.x} in @code{struct bar}
4549 is misaligned even though @code{struct bar} does not itself
4550 have the packed attribute:
4552 @smallexample
4553 @group
4554 struct foo @{
4555   int x;
4556   char a, b, c, d;
4557 @} __attribute__((packed));
4558 struct bar @{
4559   char z;
4560   struct foo f;
4562 @end group
4563 @end smallexample
4565 @item -Wpacked-bitfield-compat
4566 @opindex Wpacked-bitfield-compat
4567 @opindex Wno-packed-bitfield-compat
4568 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4569 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4570 the change can lead to differences in the structure layout.  GCC
4571 informs you when the offset of such a field has changed in GCC 4.4.
4572 For example there is no longer a 4-bit padding between field @code{a}
4573 and @code{b} in this structure:
4575 @smallexample
4576 struct foo
4578   char a:4;
4579   char b:8;
4580 @} __attribute__ ((packed));
4581 @end smallexample
4583 This warning is enabled by default.  Use
4584 @option{-Wno-packed-bitfield-compat} to disable this warning.
4586 @item -Wpadded
4587 @opindex Wpadded
4588 @opindex Wno-padded
4589 Warn if padding is included in a structure, either to align an element
4590 of the structure or to align the whole structure.  Sometimes when this
4591 happens it is possible to rearrange the fields of the structure to
4592 reduce the padding and so make the structure smaller.
4594 @item -Wredundant-decls
4595 @opindex Wredundant-decls
4596 @opindex Wno-redundant-decls
4597 Warn if anything is declared more than once in the same scope, even in
4598 cases where multiple declaration is valid and changes nothing.
4600 @item -Wnested-externs @r{(C and Objective-C only)}
4601 @opindex Wnested-externs
4602 @opindex Wno-nested-externs
4603 Warn if an @code{extern} declaration is encountered within a function.
4605 @item -Winline
4606 @opindex Winline
4607 @opindex Wno-inline
4608 Warn if a function that is declared as inline cannot be inlined.
4609 Even with this option, the compiler does not warn about failures to
4610 inline functions declared in system headers.
4612 The compiler uses a variety of heuristics to determine whether or not
4613 to inline a function.  For example, the compiler takes into account
4614 the size of the function being inlined and the amount of inlining
4615 that has already been done in the current function.  Therefore,
4616 seemingly insignificant changes in the source program can cause the
4617 warnings produced by @option{-Winline} to appear or disappear.
4619 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4620 @opindex Wno-invalid-offsetof
4621 @opindex Winvalid-offsetof
4622 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4623 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4624 to a non-POD type is undefined.  In existing C++ implementations,
4625 however, @samp{offsetof} typically gives meaningful results even when
4626 applied to certain kinds of non-POD types. (Such as a simple
4627 @samp{struct} that fails to be a POD type only by virtue of having a
4628 constructor.)  This flag is for users who are aware that they are
4629 writing nonportable code and who have deliberately chosen to ignore the
4630 warning about it.
4632 The restrictions on @samp{offsetof} may be relaxed in a future version
4633 of the C++ standard.
4635 @item -Wno-int-to-pointer-cast
4636 @opindex Wno-int-to-pointer-cast
4637 @opindex Wint-to-pointer-cast
4638 Suppress warnings from casts to pointer type of an integer of a
4639 different size. In C++, casting to a pointer type of smaller size is
4640 an error. @option{Wint-to-pointer-cast} is enabled by default.
4643 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4644 @opindex Wno-pointer-to-int-cast
4645 @opindex Wpointer-to-int-cast
4646 Suppress warnings from casts from a pointer to an integer type of a
4647 different size.
4649 @item -Winvalid-pch
4650 @opindex Winvalid-pch
4651 @opindex Wno-invalid-pch
4652 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4653 the search path but can't be used.
4655 @item -Wlong-long
4656 @opindex Wlong-long
4657 @opindex Wno-long-long
4658 Warn if @samp{long long} type is used.  This is enabled by either
4659 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4660 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4662 @item -Wvariadic-macros
4663 @opindex Wvariadic-macros
4664 @opindex Wno-variadic-macros
4665 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4666 alternate syntax when in pedantic ISO C99 mode.  This is default.
4667 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4669 @item -Wvarargs
4670 @opindex Wvarargs
4671 @opindex Wno-varargs
4672 Warn upon questionable usage of the macros used to handle variable
4673 arguments like @samp{va_start}.  This is default.  To inhibit the
4674 warning messages, use @option{-Wno-varargs}.
4676 @item -Wvector-operation-performance
4677 @opindex Wvector-operation-performance
4678 @opindex Wno-vector-operation-performance
4679 Warn if vector operation is not implemented via SIMD capabilities of the
4680 architecture.  Mainly useful for the performance tuning.
4681 Vector operation can be implemented @code{piecewise}, which means that the
4682 scalar operation is performed on every vector element; 
4683 @code{in parallel}, which means that the vector operation is implemented
4684 using scalars of wider type, which normally is more performance efficient;
4685 and @code{as a single scalar}, which means that vector fits into a
4686 scalar type.
4688 @item -Wvla
4689 @opindex Wvla
4690 @opindex Wno-vla
4691 Warn if variable length array is used in the code.
4692 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4693 the variable length array.
4695 @item -Wvolatile-register-var
4696 @opindex Wvolatile-register-var
4697 @opindex Wno-volatile-register-var
4698 Warn if a register variable is declared volatile.  The volatile
4699 modifier does not inhibit all optimizations that may eliminate reads
4700 and/or writes to register variables.  This warning is enabled by
4701 @option{-Wall}.
4703 @item -Wdisabled-optimization
4704 @opindex Wdisabled-optimization
4705 @opindex Wno-disabled-optimization
4706 Warn if a requested optimization pass is disabled.  This warning does
4707 not generally indicate that there is anything wrong with your code; it
4708 merely indicates that GCC's optimizers are unable to handle the code
4709 effectively.  Often, the problem is that your code is too big or too
4710 complex; GCC refuses to optimize programs when the optimization
4711 itself is likely to take inordinate amounts of time.
4713 @item -Wpointer-sign @r{(C and Objective-C only)}
4714 @opindex Wpointer-sign
4715 @opindex Wno-pointer-sign
4716 Warn for pointer argument passing or assignment with different signedness.
4717 This option is only supported for C and Objective-C@.  It is implied by
4718 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4719 @option{-Wno-pointer-sign}.
4721 @item -Wstack-protector
4722 @opindex Wstack-protector
4723 @opindex Wno-stack-protector
4724 This option is only active when @option{-fstack-protector} is active.  It
4725 warns about functions that are not protected against stack smashing.
4727 @item -Wno-mudflap
4728 @opindex Wno-mudflap
4729 Suppress warnings about constructs that cannot be instrumented by
4730 @option{-fmudflap}.
4732 @item -Woverlength-strings
4733 @opindex Woverlength-strings
4734 @opindex Wno-overlength-strings
4735 Warn about string constants that are longer than the ``minimum
4736 maximum'' length specified in the C standard.  Modern compilers
4737 generally allow string constants that are much longer than the
4738 standard's minimum limit, but very portable programs should avoid
4739 using longer strings.
4741 The limit applies @emph{after} string constant concatenation, and does
4742 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4743 C99, it was raised to 4095.  C++98 does not specify a normative
4744 minimum maximum, so we do not diagnose overlength strings in C++@.
4746 This option is implied by @option{-Wpedantic}, and can be disabled with
4747 @option{-Wno-overlength-strings}.
4749 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4750 @opindex Wunsuffixed-float-constants
4752 Issue a warning for any floating constant that does not have
4753 a suffix.  When used together with @option{-Wsystem-headers} it
4754 warns about such constants in system header files.  This can be useful
4755 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4756 from the decimal floating-point extension to C99.
4757 @end table
4759 @node Debugging Options
4760 @section Options for Debugging Your Program or GCC
4761 @cindex options, debugging
4762 @cindex debugging information options
4764 GCC has various special options that are used for debugging
4765 either your program or GCC:
4767 @table @gcctabopt
4768 @item -g
4769 @opindex g
4770 Produce debugging information in the operating system's native format
4771 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4772 information.
4774 On most systems that use stabs format, @option{-g} enables use of extra
4775 debugging information that only GDB can use; this extra information
4776 makes debugging work better in GDB but probably makes other debuggers
4777 crash or
4778 refuse to read the program.  If you want to control for certain whether
4779 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4780 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4782 GCC allows you to use @option{-g} with
4783 @option{-O}.  The shortcuts taken by optimized code may occasionally
4784 produce surprising results: some variables you declared may not exist
4785 at all; flow of control may briefly move where you did not expect it;
4786 some statements may not be executed because they compute constant
4787 results or their values are already at hand; some statements may
4788 execute in different places because they have been moved out of loops.
4790 Nevertheless it proves possible to debug optimized output.  This makes
4791 it reasonable to use the optimizer for programs that might have bugs.
4793 The following options are useful when GCC is generated with the
4794 capability for more than one debugging format.
4796 @item -ggdb
4797 @opindex ggdb
4798 Produce debugging information for use by GDB@.  This means to use the
4799 most expressive format available (DWARF 2, stabs, or the native format
4800 if neither of those are supported), including GDB extensions if at all
4801 possible.
4803 @item -gpubnames
4804 @opindex gpubnames
4805 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4807 @item -gstabs
4808 @opindex gstabs
4809 Produce debugging information in stabs format (if that is supported),
4810 without GDB extensions.  This is the format used by DBX on most BSD
4811 systems.  On MIPS, Alpha and System V Release 4 systems this option
4812 produces stabs debugging output that is not understood by DBX or SDB@.
4813 On System V Release 4 systems this option requires the GNU assembler.
4815 @item -feliminate-unused-debug-symbols
4816 @opindex feliminate-unused-debug-symbols
4817 Produce debugging information in stabs format (if that is supported),
4818 for only symbols that are actually used.
4820 @item -femit-class-debug-always
4821 Instead of emitting debugging information for a C++ class in only one
4822 object file, emit it in all object files using the class.  This option
4823 should be used only with debuggers that are unable to handle the way GCC
4824 normally emits debugging information for classes because using this
4825 option increases the size of debugging information by as much as a
4826 factor of two.
4828 @item -fdebug-types-section
4829 @opindex fdebug-types-section
4830 @opindex fno-debug-types-section
4831 When using DWARF Version 4 or higher, type DIEs can be put into
4832 their own @code{.debug_types} section instead of making them part of the
4833 @code{.debug_info} section.  It is more efficient to put them in a separate
4834 comdat sections since the linker can then remove duplicates.
4835 But not all DWARF consumers support @code{.debug_types} sections yet
4836 and on some objects @code{.debug_types} produces larger instead of smaller
4837 debugging information.
4839 @item -gstabs+
4840 @opindex gstabs+
4841 Produce debugging information in stabs format (if that is supported),
4842 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4843 use of these extensions is likely to make other debuggers crash or
4844 refuse to read the program.
4846 @item -gcoff
4847 @opindex gcoff
4848 Produce debugging information in COFF format (if that is supported).
4849 This is the format used by SDB on most System V systems prior to
4850 System V Release 4.
4852 @item -gxcoff
4853 @opindex gxcoff
4854 Produce debugging information in XCOFF format (if that is supported).
4855 This is the format used by the DBX debugger on IBM RS/6000 systems.
4857 @item -gxcoff+
4858 @opindex gxcoff+
4859 Produce debugging information in XCOFF format (if that is supported),
4860 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4861 use of these extensions is likely to make other debuggers crash or
4862 refuse to read the program, and may cause assemblers other than the GNU
4863 assembler (GAS) to fail with an error.
4865 @item -gdwarf-@var{version}
4866 @opindex gdwarf-@var{version}
4867 Produce debugging information in DWARF format (if that is supported).
4868 The value of @var{version} may be either 2, 3 or 4; the default version
4869 for most targets is 4.
4871 Note that with DWARF Version 2, some ports require and always
4872 use some non-conflicting DWARF 3 extensions in the unwind tables.
4874 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4875 for maximum benefit.
4877 @item -grecord-gcc-switches
4878 @opindex grecord-gcc-switches
4879 This switch causes the command-line options used to invoke the
4880 compiler that may affect code generation to be appended to the
4881 DW_AT_producer attribute in DWARF debugging information.  The options
4882 are concatenated with spaces separating them from each other and from
4883 the compiler version.  See also @option{-frecord-gcc-switches} for another
4884 way of storing compiler options into the object file.  This is the default.
4886 @item -gno-record-gcc-switches
4887 @opindex gno-record-gcc-switches
4888 Disallow appending command-line options to the DW_AT_producer attribute
4889 in DWARF debugging information.
4891 @item -gstrict-dwarf
4892 @opindex gstrict-dwarf
4893 Disallow using extensions of later DWARF standard version than selected
4894 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4895 DWARF extensions from later standard versions is allowed.
4897 @item -gno-strict-dwarf
4898 @opindex gno-strict-dwarf
4899 Allow using extensions of later DWARF standard version than selected with
4900 @option{-gdwarf-@var{version}}.
4902 @item -gvms
4903 @opindex gvms
4904 Produce debugging information in Alpha/VMS debug format (if that is
4905 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4907 @item -g@var{level}
4908 @itemx -ggdb@var{level}
4909 @itemx -gstabs@var{level}
4910 @itemx -gcoff@var{level}
4911 @itemx -gxcoff@var{level}
4912 @itemx -gvms@var{level}
4913 Request debugging information and also use @var{level} to specify how
4914 much information.  The default level is 2.
4916 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4917 @option{-g}.
4919 Level 1 produces minimal information, enough for making backtraces in
4920 parts of the program that you don't plan to debug.  This includes
4921 descriptions of functions and external variables, but no information
4922 about local variables and no line numbers.
4924 Level 3 includes extra information, such as all the macro definitions
4925 present in the program.  Some debuggers support macro expansion when
4926 you use @option{-g3}.
4928 @option{-gdwarf-2} does not accept a concatenated debug level, because
4929 GCC used to support an option @option{-gdwarf} that meant to generate
4930 debug information in version 1 of the DWARF format (which is very
4931 different from version 2), and it would have been too confusing.  That
4932 debug format is long obsolete, but the option cannot be changed now.
4933 Instead use an additional @option{-g@var{level}} option to change the
4934 debug level for DWARF.
4936 @item -gtoggle
4937 @opindex gtoggle
4938 Turn off generation of debug info, if leaving out this option
4939 generates it, or turn it on at level 2 otherwise.  The position of this
4940 argument in the command line does not matter; it takes effect after all
4941 other options are processed, and it does so only once, no matter how
4942 many times it is given.  This is mainly intended to be used with
4943 @option{-fcompare-debug}.
4945 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4946 @opindex fdump-final-insns
4947 Dump the final internal representation (RTL) to @var{file}.  If the
4948 optional argument is omitted (or if @var{file} is @code{.}), the name
4949 of the dump file is determined by appending @code{.gkd} to the
4950 compilation output file name.
4952 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4953 @opindex fcompare-debug
4954 @opindex fno-compare-debug
4955 If no error occurs during compilation, run the compiler a second time,
4956 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4957 passed to the second compilation.  Dump the final internal
4958 representation in both compilations, and print an error if they differ.
4960 If the equal sign is omitted, the default @option{-gtoggle} is used.
4962 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4963 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4964 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4965 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4966 is used.
4968 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4969 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4970 of the final representation and the second compilation, preventing even
4971 @env{GCC_COMPARE_DEBUG} from taking effect.
4973 To verify full coverage during @option{-fcompare-debug} testing, set
4974 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4975 which GCC rejects as an invalid option in any actual compilation
4976 (rather than preprocessing, assembly or linking).  To get just a
4977 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4978 not overridden} will do.
4980 @item -fcompare-debug-second
4981 @opindex fcompare-debug-second
4982 This option is implicitly passed to the compiler for the second
4983 compilation requested by @option{-fcompare-debug}, along with options to
4984 silence warnings, and omitting other options that would cause
4985 side-effect compiler outputs to files or to the standard output.  Dump
4986 files and preserved temporary files are renamed so as to contain the
4987 @code{.gk} additional extension during the second compilation, to avoid
4988 overwriting those generated by the first.
4990 When this option is passed to the compiler driver, it causes the
4991 @emph{first} compilation to be skipped, which makes it useful for little
4992 other than debugging the compiler proper.
4994 @item -feliminate-dwarf2-dups
4995 @opindex feliminate-dwarf2-dups
4996 Compress DWARF 2 debugging information by eliminating duplicated
4997 information about each symbol.  This option only makes sense when
4998 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5000 @item -femit-struct-debug-baseonly
5001 Emit debug information for struct-like types
5002 only when the base name of the compilation source file
5003 matches the base name of file in which the struct is defined.
5005 This option substantially reduces the size of debugging information,
5006 but at significant potential loss in type information to the debugger.
5007 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5008 See @option{-femit-struct-debug-detailed} for more detailed control.
5010 This option works only with DWARF 2.
5012 @item -femit-struct-debug-reduced
5013 Emit debug information for struct-like types
5014 only when the base name of the compilation source file
5015 matches the base name of file in which the type is defined,
5016 unless the struct is a template or defined in a system header.
5018 This option significantly reduces the size of debugging information,
5019 with some potential loss in type information to the debugger.
5020 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5021 See @option{-femit-struct-debug-detailed} for more detailed control.
5023 This option works only with DWARF 2.
5025 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5026 Specify the struct-like types
5027 for which the compiler generates debug information.
5028 The intent is to reduce duplicate struct debug information
5029 between different object files within the same program.
5031 This option is a detailed version of
5032 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5033 which serves for most needs.
5035 A specification has the syntax@*
5036 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5038 The optional first word limits the specification to
5039 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5040 A struct type is used directly when it is the type of a variable, member.
5041 Indirect uses arise through pointers to structs.
5042 That is, when use of an incomplete struct is valid, the use is indirect.
5043 An example is
5044 @samp{struct one direct; struct two * indirect;}.
5046 The optional second word limits the specification to
5047 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5048 Generic structs are a bit complicated to explain.
5049 For C++, these are non-explicit specializations of template classes,
5050 or non-template classes within the above.
5051 Other programming languages have generics,
5052 but @option{-femit-struct-debug-detailed} does not yet implement them.
5054 The third word specifies the source files for those
5055 structs for which the compiler should emit debug information.
5056 The values @samp{none} and @samp{any} have the normal meaning.
5057 The value @samp{base} means that
5058 the base of name of the file in which the type declaration appears
5059 must match the base of the name of the main compilation file.
5060 In practice, this means that when compiling @file{foo.c}, debug information
5061 is generated for types declared in that file and @file{foo.h},
5062 but not other header files.
5063 The value @samp{sys} means those types satisfying @samp{base}
5064 or declared in system or compiler headers.
5066 You may need to experiment to determine the best settings for your application.
5068 The default is @option{-femit-struct-debug-detailed=all}.
5070 This option works only with DWARF 2.
5072 @item -fno-merge-debug-strings
5073 @opindex fmerge-debug-strings
5074 @opindex fno-merge-debug-strings
5075 Direct the linker to not merge together strings in the debugging
5076 information that are identical in different object files.  Merging is
5077 not supported by all assemblers or linkers.  Merging decreases the size
5078 of the debug information in the output file at the cost of increasing
5079 link processing time.  Merging is enabled by default.
5081 @item -fdebug-prefix-map=@var{old}=@var{new}
5082 @opindex fdebug-prefix-map
5083 When compiling files in directory @file{@var{old}}, record debugging
5084 information describing them as in @file{@var{new}} instead.
5086 @item -fno-dwarf2-cfi-asm
5087 @opindex fdwarf2-cfi-asm
5088 @opindex fno-dwarf2-cfi-asm
5089 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5090 instead of using GAS @code{.cfi_*} directives.
5092 @cindex @command{prof}
5093 @item -p
5094 @opindex p
5095 Generate extra code to write profile information suitable for the
5096 analysis program @command{prof}.  You must use this option when compiling
5097 the source files you want data about, and you must also use it when
5098 linking.
5100 @cindex @command{gprof}
5101 @item -pg
5102 @opindex pg
5103 Generate extra code to write profile information suitable for the
5104 analysis program @command{gprof}.  You must use this option when compiling
5105 the source files you want data about, and you must also use it when
5106 linking.
5108 @item -Q
5109 @opindex Q
5110 Makes the compiler print out each function name as it is compiled, and
5111 print some statistics about each pass when it finishes.
5113 @item -ftime-report
5114 @opindex ftime-report
5115 Makes the compiler print some statistics about the time consumed by each
5116 pass when it finishes.
5118 @item -fmem-report
5119 @opindex fmem-report
5120 Makes the compiler print some statistics about permanent memory
5121 allocation when it finishes.
5123 @item -fpre-ipa-mem-report
5124 @opindex fpre-ipa-mem-report
5125 @item -fpost-ipa-mem-report
5126 @opindex fpost-ipa-mem-report
5127 Makes the compiler print some statistics about permanent memory
5128 allocation before or after interprocedural optimization.
5130 @item -fstack-usage
5131 @opindex fstack-usage
5132 Makes the compiler output stack usage information for the program, on a
5133 per-function basis.  The filename for the dump is made by appending
5134 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5135 the output file, if explicitly specified and it is not an executable,
5136 otherwise it is the basename of the source file.  An entry is made up
5137 of three fields:
5139 @itemize
5140 @item
5141 The name of the function.
5142 @item
5143 A number of bytes.
5144 @item
5145 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5146 @end itemize
5148 The qualifier @code{static} means that the function manipulates the stack
5149 statically: a fixed number of bytes are allocated for the frame on function
5150 entry and released on function exit; no stack adjustments are otherwise made
5151 in the function.  The second field is this fixed number of bytes.
5153 The qualifier @code{dynamic} means that the function manipulates the stack
5154 dynamically: in addition to the static allocation described above, stack
5155 adjustments are made in the body of the function, for example to push/pop
5156 arguments around function calls.  If the qualifier @code{bounded} is also
5157 present, the amount of these adjustments is bounded at compile time and
5158 the second field is an upper bound of the total amount of stack used by
5159 the function.  If it is not present, the amount of these adjustments is
5160 not bounded at compile time and the second field only represents the
5161 bounded part.
5163 @item -fprofile-arcs
5164 @opindex fprofile-arcs
5165 Add code so that program flow @dfn{arcs} are instrumented.  During
5166 execution the program records how many times each branch and call is
5167 executed and how many times it is taken or returns.  When the compiled
5168 program exits it saves this data to a file called
5169 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5170 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5171 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5172 @var{auxname} is generated from the name of the output file, if
5173 explicitly specified and it is not the final executable, otherwise it is
5174 the basename of the source file.  In both cases any suffix is removed
5175 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5176 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5177 @xref{Cross-profiling}.
5179 @cindex @command{gcov}
5180 @item --coverage
5181 @opindex coverage
5183 This option is used to compile and link code instrumented for coverage
5184 analysis.  The option is a synonym for @option{-fprofile-arcs}
5185 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5186 linking).  See the documentation for those options for more details.
5188 @itemize
5190 @item
5191 Compile the source files with @option{-fprofile-arcs} plus optimization
5192 and code generation options.  For test coverage analysis, use the
5193 additional @option{-ftest-coverage} option.  You do not need to profile
5194 every source file in a program.
5196 @item
5197 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5198 (the latter implies the former).
5200 @item
5201 Run the program on a representative workload to generate the arc profile
5202 information.  This may be repeated any number of times.  You can run
5203 concurrent instances of your program, and provided that the file system
5204 supports locking, the data files will be correctly updated.  Also
5205 @code{fork} calls are detected and correctly handled (double counting
5206 will not happen).
5208 @item
5209 For profile-directed optimizations, compile the source files again with
5210 the same optimization and code generation options plus
5211 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5212 Control Optimization}).
5214 @item
5215 For test coverage analysis, use @command{gcov} to produce human readable
5216 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5217 @command{gcov} documentation for further information.
5219 @end itemize
5221 With @option{-fprofile-arcs}, for each function of your program GCC
5222 creates a program flow graph, then finds a spanning tree for the graph.
5223 Only arcs that are not on the spanning tree have to be instrumented: the
5224 compiler adds code to count the number of times that these arcs are
5225 executed.  When an arc is the only exit or only entrance to a block, the
5226 instrumentation code can be added to the block; otherwise, a new basic
5227 block must be created to hold the instrumentation code.
5229 @need 2000
5230 @item -ftest-coverage
5231 @opindex ftest-coverage
5232 Produce a notes file that the @command{gcov} code-coverage utility
5233 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5234 show program coverage.  Each source file's note file is called
5235 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5236 above for a description of @var{auxname} and instructions on how to
5237 generate test coverage data.  Coverage data matches the source files
5238 more closely if you do not optimize.
5240 @item -fdbg-cnt-list
5241 @opindex fdbg-cnt-list
5242 Print the name and the counter upper bound for all debug counters.
5245 @item -fdbg-cnt=@var{counter-value-list}
5246 @opindex fdbg-cnt
5247 Set the internal debug counter upper bound.  @var{counter-value-list}
5248 is a comma-separated list of @var{name}:@var{value} pairs
5249 which sets the upper bound of each debug counter @var{name} to @var{value}.
5250 All debug counters have the initial upper bound of @code{UINT_MAX};
5251 thus @code{dbg_cnt()} returns true always unless the upper bound
5252 is set by this option.
5253 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5254 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5256 @itemx -fenable-@var{kind}-@var{pass}
5257 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5258 @opindex fdisable-
5259 @opindex fenable-
5261 This is a set of options that are used to explicitly disable/enable
5262 optimization passes.  These options are intended for use for debugging GCC.
5263 Compiler users should use regular options for enabling/disabling
5264 passes instead.
5266 @table @gcctabopt
5268 @item -fdisable-ipa-@var{pass}
5269 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5270 statically invoked in the compiler multiple times, the pass name should be
5271 appended with a sequential number starting from 1.
5273 @item -fdisable-rtl-@var{pass}
5274 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5275 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5276 statically invoked in the compiler multiple times, the pass name should be
5277 appended with a sequential number starting from 1.  @var{range-list} is a 
5278 comma-separated list of function ranges or assembler names.  Each range is a number
5279 pair separated by a colon.  The range is inclusive in both ends.  If the range
5280 is trivial, the number pair can be simplified as a single number.  If the
5281 function's cgraph node's @var{uid} falls within one of the specified ranges,
5282 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5283 function header of a dump file, and the pass names can be dumped by using
5284 option @option{-fdump-passes}.
5286 @item -fdisable-tree-@var{pass}
5287 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5288 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5289 option arguments.
5291 @item -fenable-ipa-@var{pass}
5292 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5293 statically invoked in the compiler multiple times, the pass name should be
5294 appended with a sequential number starting from 1.
5296 @item -fenable-rtl-@var{pass}
5297 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5298 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5299 description and examples.
5301 @item -fenable-tree-@var{pass}
5302 @itemx -fenable-tree-@var{pass}=@var{range-list}
5303 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5304 of option arguments.
5306 @end table
5308 Here are some examples showing uses of these options.
5310 @smallexample
5312 # disable ccp1 for all functions
5313    -fdisable-tree-ccp1
5314 # disable complete unroll for function whose cgraph node uid is 1
5315    -fenable-tree-cunroll=1
5316 # disable gcse2 for functions at the following ranges [1,1],
5317 # [300,400], and [400,1000]
5318 # disable gcse2 for functions foo and foo2
5319    -fdisable-rtl-gcse2=foo,foo2
5320 # disable early inlining
5321    -fdisable-tree-einline
5322 # disable ipa inlining
5323    -fdisable-ipa-inline
5324 # enable tree full unroll
5325    -fenable-tree-unroll
5327 @end smallexample
5329 @item -d@var{letters}
5330 @itemx -fdump-rtl-@var{pass}
5331 @opindex d
5332 Says to make debugging dumps during compilation at times specified by
5333 @var{letters}.  This is used for debugging the RTL-based passes of the
5334 compiler.  The file names for most of the dumps are made by appending
5335 a pass number and a word to the @var{dumpname}, and the files are
5336 created in the directory of the output file.  Note that the pass
5337 number is computed statically as passes get registered into the pass
5338 manager.  Thus the numbering is not related to the dynamic order of
5339 execution of passes.  In particular, a pass installed by a plugin
5340 could have a number over 200 even if it executed quite early.
5341 @var{dumpname} is generated from the name of the output file, if
5342 explicitly specified and it is not an executable, otherwise it is the
5343 basename of the source file. These switches may have different effects
5344 when @option{-E} is used for preprocessing.
5346 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5347 @option{-d} option @var{letters}.  Here are the possible
5348 letters for use in @var{pass} and @var{letters}, and their meanings:
5350 @table @gcctabopt
5352 @item -fdump-rtl-alignments
5353 @opindex fdump-rtl-alignments
5354 Dump after branch alignments have been computed.
5356 @item -fdump-rtl-asmcons
5357 @opindex fdump-rtl-asmcons
5358 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5360 @item -fdump-rtl-auto_inc_dec
5361 @opindex fdump-rtl-auto_inc_dec
5362 Dump after auto-inc-dec discovery.  This pass is only run on
5363 architectures that have auto inc or auto dec instructions.
5365 @item -fdump-rtl-barriers
5366 @opindex fdump-rtl-barriers
5367 Dump after cleaning up the barrier instructions.
5369 @item -fdump-rtl-bbpart
5370 @opindex fdump-rtl-bbpart
5371 Dump after partitioning hot and cold basic blocks.
5373 @item -fdump-rtl-bbro
5374 @opindex fdump-rtl-bbro
5375 Dump after block reordering.
5377 @item -fdump-rtl-btl1
5378 @itemx -fdump-rtl-btl2
5379 @opindex fdump-rtl-btl2
5380 @opindex fdump-rtl-btl2
5381 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5382 after the two branch
5383 target load optimization passes.
5385 @item -fdump-rtl-bypass
5386 @opindex fdump-rtl-bypass
5387 Dump after jump bypassing and control flow optimizations.
5389 @item -fdump-rtl-combine
5390 @opindex fdump-rtl-combine
5391 Dump after the RTL instruction combination pass.
5393 @item -fdump-rtl-compgotos
5394 @opindex fdump-rtl-compgotos
5395 Dump after duplicating the computed gotos.
5397 @item -fdump-rtl-ce1
5398 @itemx -fdump-rtl-ce2
5399 @itemx -fdump-rtl-ce3
5400 @opindex fdump-rtl-ce1
5401 @opindex fdump-rtl-ce2
5402 @opindex fdump-rtl-ce3
5403 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5404 @option{-fdump-rtl-ce3} enable dumping after the three
5405 if conversion passes.
5407 @itemx -fdump-rtl-cprop_hardreg
5408 @opindex fdump-rtl-cprop_hardreg
5409 Dump after hard register copy propagation.
5411 @itemx -fdump-rtl-csa
5412 @opindex fdump-rtl-csa
5413 Dump after combining stack adjustments.
5415 @item -fdump-rtl-cse1
5416 @itemx -fdump-rtl-cse2
5417 @opindex fdump-rtl-cse1
5418 @opindex fdump-rtl-cse2
5419 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5420 the two common sub-expression elimination passes.
5422 @itemx -fdump-rtl-dce
5423 @opindex fdump-rtl-dce
5424 Dump after the standalone dead code elimination passes.
5426 @itemx -fdump-rtl-dbr
5427 @opindex fdump-rtl-dbr
5428 Dump after delayed branch scheduling.
5430 @item -fdump-rtl-dce1
5431 @itemx -fdump-rtl-dce2
5432 @opindex fdump-rtl-dce1
5433 @opindex fdump-rtl-dce2
5434 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5435 the two dead store elimination passes.
5437 @item -fdump-rtl-eh
5438 @opindex fdump-rtl-eh
5439 Dump after finalization of EH handling code.
5441 @item -fdump-rtl-eh_ranges
5442 @opindex fdump-rtl-eh_ranges
5443 Dump after conversion of EH handling range regions.
5445 @item -fdump-rtl-expand
5446 @opindex fdump-rtl-expand
5447 Dump after RTL generation.
5449 @item -fdump-rtl-fwprop1
5450 @itemx -fdump-rtl-fwprop2
5451 @opindex fdump-rtl-fwprop1
5452 @opindex fdump-rtl-fwprop2
5453 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5454 dumping after the two forward propagation passes.
5456 @item -fdump-rtl-gcse1
5457 @itemx -fdump-rtl-gcse2
5458 @opindex fdump-rtl-gcse1
5459 @opindex fdump-rtl-gcse2
5460 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5461 after global common subexpression elimination.
5463 @item -fdump-rtl-init-regs
5464 @opindex fdump-rtl-init-regs
5465 Dump after the initialization of the registers.
5467 @item -fdump-rtl-initvals
5468 @opindex fdump-rtl-initvals
5469 Dump after the computation of the initial value sets.
5471 @itemx -fdump-rtl-into_cfglayout
5472 @opindex fdump-rtl-into_cfglayout
5473 Dump after converting to cfglayout mode.
5475 @item -fdump-rtl-ira
5476 @opindex fdump-rtl-ira
5477 Dump after iterated register allocation.
5479 @item -fdump-rtl-jump
5480 @opindex fdump-rtl-jump
5481 Dump after the second jump optimization.
5483 @item -fdump-rtl-loop2
5484 @opindex fdump-rtl-loop2
5485 @option{-fdump-rtl-loop2} enables dumping after the rtl
5486 loop optimization passes.
5488 @item -fdump-rtl-mach
5489 @opindex fdump-rtl-mach
5490 Dump after performing the machine dependent reorganization pass, if that
5491 pass exists.
5493 @item -fdump-rtl-mode_sw
5494 @opindex fdump-rtl-mode_sw
5495 Dump after removing redundant mode switches.
5497 @item -fdump-rtl-rnreg
5498 @opindex fdump-rtl-rnreg
5499 Dump after register renumbering.
5501 @itemx -fdump-rtl-outof_cfglayout
5502 @opindex fdump-rtl-outof_cfglayout
5503 Dump after converting from cfglayout mode.
5505 @item -fdump-rtl-peephole2
5506 @opindex fdump-rtl-peephole2
5507 Dump after the peephole pass.
5509 @item -fdump-rtl-postreload
5510 @opindex fdump-rtl-postreload
5511 Dump after post-reload optimizations.
5513 @itemx -fdump-rtl-pro_and_epilogue
5514 @opindex fdump-rtl-pro_and_epilogue
5515 Dump after generating the function prologues and epilogues.
5517 @item -fdump-rtl-regmove
5518 @opindex fdump-rtl-regmove
5519 Dump after the register move pass.
5521 @item -fdump-rtl-sched1
5522 @itemx -fdump-rtl-sched2
5523 @opindex fdump-rtl-sched1
5524 @opindex fdump-rtl-sched2
5525 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5526 after the basic block scheduling passes.
5528 @item -fdump-rtl-see
5529 @opindex fdump-rtl-see
5530 Dump after sign extension elimination.
5532 @item -fdump-rtl-seqabstr
5533 @opindex fdump-rtl-seqabstr
5534 Dump after common sequence discovery.
5536 @item -fdump-rtl-shorten
5537 @opindex fdump-rtl-shorten
5538 Dump after shortening branches.
5540 @item -fdump-rtl-sibling
5541 @opindex fdump-rtl-sibling
5542 Dump after sibling call optimizations.
5544 @item -fdump-rtl-split1
5545 @itemx -fdump-rtl-split2
5546 @itemx -fdump-rtl-split3
5547 @itemx -fdump-rtl-split4
5548 @itemx -fdump-rtl-split5
5549 @opindex fdump-rtl-split1
5550 @opindex fdump-rtl-split2
5551 @opindex fdump-rtl-split3
5552 @opindex fdump-rtl-split4
5553 @opindex fdump-rtl-split5
5554 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5555 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5556 @option{-fdump-rtl-split5} enable dumping after five rounds of
5557 instruction splitting.
5559 @item -fdump-rtl-sms
5560 @opindex fdump-rtl-sms
5561 Dump after modulo scheduling.  This pass is only run on some
5562 architectures.
5564 @item -fdump-rtl-stack
5565 @opindex fdump-rtl-stack
5566 Dump after conversion from GCC's ``flat register file'' registers to the
5567 x87's stack-like registers.  This pass is only run on x86 variants.
5569 @item -fdump-rtl-subreg1
5570 @itemx -fdump-rtl-subreg2
5571 @opindex fdump-rtl-subreg1
5572 @opindex fdump-rtl-subreg2
5573 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5574 the two subreg expansion passes.
5576 @item -fdump-rtl-unshare
5577 @opindex fdump-rtl-unshare
5578 Dump after all rtl has been unshared.
5580 @item -fdump-rtl-vartrack
5581 @opindex fdump-rtl-vartrack
5582 Dump after variable tracking.
5584 @item -fdump-rtl-vregs
5585 @opindex fdump-rtl-vregs
5586 Dump after converting virtual registers to hard registers.
5588 @item -fdump-rtl-web
5589 @opindex fdump-rtl-web
5590 Dump after live range splitting.
5592 @item -fdump-rtl-regclass
5593 @itemx -fdump-rtl-subregs_of_mode_init
5594 @itemx -fdump-rtl-subregs_of_mode_finish
5595 @itemx -fdump-rtl-dfinit
5596 @itemx -fdump-rtl-dfinish
5597 @opindex fdump-rtl-regclass
5598 @opindex fdump-rtl-subregs_of_mode_init
5599 @opindex fdump-rtl-subregs_of_mode_finish
5600 @opindex fdump-rtl-dfinit
5601 @opindex fdump-rtl-dfinish
5602 These dumps are defined but always produce empty files.
5604 @item -fdump-rtl-all
5605 @opindex fdump-rtl-all
5606 Produce all the dumps listed above.
5608 @item -dA
5609 @opindex dA
5610 Annotate the assembler output with miscellaneous debugging information.
5612 @item -dD
5613 @opindex dD
5614 Dump all macro definitions, at the end of preprocessing, in addition to
5615 normal output.
5617 @item -dH
5618 @opindex dH
5619 Produce a core dump whenever an error occurs.
5621 @item -dm
5622 @opindex dm
5623 Print statistics on memory usage, at the end of the run, to
5624 standard error.
5626 @item -dp
5627 @opindex dp
5628 Annotate the assembler output with a comment indicating which
5629 pattern and alternative is used.  The length of each instruction is
5630 also printed.
5632 @item -dP
5633 @opindex dP
5634 Dump the RTL in the assembler output as a comment before each instruction.
5635 Also turns on @option{-dp} annotation.
5637 @item -dv
5638 @opindex dv
5639 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5640 dump a representation of the control flow graph suitable for viewing with VCG
5641 to @file{@var{file}.@var{pass}.vcg}.
5643 @item -dx
5644 @opindex dx
5645 Just generate RTL for a function instead of compiling it.  Usually used
5646 with @option{-fdump-rtl-expand}.
5647 @end table
5649 @item -fdump-noaddr
5650 @opindex fdump-noaddr
5651 When doing debugging dumps, suppress address output.  This makes it more
5652 feasible to use diff on debugging dumps for compiler invocations with
5653 different compiler binaries and/or different
5654 text / bss / data / heap / stack / dso start locations.
5656 @item -fdump-unnumbered
5657 @opindex fdump-unnumbered
5658 When doing debugging dumps, suppress instruction numbers and address output.
5659 This makes it more feasible to use diff on debugging dumps for compiler
5660 invocations with different options, in particular with and without
5661 @option{-g}.
5663 @item -fdump-unnumbered-links
5664 @opindex fdump-unnumbered-links
5665 When doing debugging dumps (see @option{-d} option above), suppress
5666 instruction numbers for the links to the previous and next instructions
5667 in a sequence.
5669 @item -fdump-translation-unit @r{(C++ only)}
5670 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5671 @opindex fdump-translation-unit
5672 Dump a representation of the tree structure for the entire translation
5673 unit to a file.  The file name is made by appending @file{.tu} to the
5674 source file name, and the file is created in the same directory as the
5675 output file.  If the @samp{-@var{options}} form is used, @var{options}
5676 controls the details of the dump as described for the
5677 @option{-fdump-tree} options.
5679 @item -fdump-class-hierarchy @r{(C++ only)}
5680 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5681 @opindex fdump-class-hierarchy
5682 Dump a representation of each class's hierarchy and virtual function
5683 table layout to a file.  The file name is made by appending
5684 @file{.class} to the source file name, and the file is created in the
5685 same directory as the output file.  If the @samp{-@var{options}} form
5686 is used, @var{options} controls the details of the dump as described
5687 for the @option{-fdump-tree} options.
5689 @item -fdump-ipa-@var{switch}
5690 @opindex fdump-ipa
5691 Control the dumping at various stages of inter-procedural analysis
5692 language tree to a file.  The file name is generated by appending a
5693 switch specific suffix to the source file name, and the file is created
5694 in the same directory as the output file.  The following dumps are
5695 possible:
5697 @table @samp
5698 @item all
5699 Enables all inter-procedural analysis dumps.
5701 @item cgraph
5702 Dumps information about call-graph optimization, unused function removal,
5703 and inlining decisions.
5705 @item inline
5706 Dump after function inlining.
5708 @end table
5710 @item -fdump-passes
5711 @opindex fdump-passes
5712 Dump the list of optimization passes that are turned on and off by
5713 the current command-line options.
5715 @item -fdump-statistics-@var{option}
5716 @opindex fdump-statistics
5717 Enable and control dumping of pass statistics in a separate file.  The
5718 file name is generated by appending a suffix ending in
5719 @samp{.statistics} to the source file name, and the file is created in
5720 the same directory as the output file.  If the @samp{-@var{option}}
5721 form is used, @samp{-stats} causes counters to be summed over the
5722 whole compilation unit while @samp{-details} dumps every event as
5723 the passes generate them.  The default with no option is to sum
5724 counters for each function compiled.
5726 @item -fdump-tree-@var{switch}
5727 @itemx -fdump-tree-@var{switch}-@var{options}
5728 @opindex fdump-tree
5729 Control the dumping at various stages of processing the intermediate
5730 language tree to a file.  The file name is generated by appending a
5731 switch specific suffix to the source file name, and the file is
5732 created in the same directory as the output file.  If the
5733 @samp{-@var{options}} form is used, @var{options} is a list of
5734 @samp{-} separated options which control the details of the dump.  Not
5735 all options are applicable to all dumps; those that are not
5736 meaningful are ignored.  The following options are available
5738 @table @samp
5739 @item address
5740 Print the address of each node.  Usually this is not meaningful as it
5741 changes according to the environment and source file.  Its primary use
5742 is for tying up a dump file with a debug environment.
5743 @item asmname
5744 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5745 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5746 use working backward from mangled names in the assembly file.
5747 @item slim
5748 Inhibit dumping of members of a scope or body of a function merely
5749 because that scope has been reached.  Only dump such items when they
5750 are directly reachable by some other path.  When dumping pretty-printed
5751 trees, this option inhibits dumping the bodies of control structures.
5752 @item raw
5753 Print a raw representation of the tree.  By default, trees are
5754 pretty-printed into a C-like representation.
5755 @item details
5756 Enable more detailed dumps (not honored by every dump option).
5757 @item stats
5758 Enable dumping various statistics about the pass (not honored by every dump
5759 option).
5760 @item blocks
5761 Enable showing basic block boundaries (disabled in raw dumps).
5762 @item vops
5763 Enable showing virtual operands for every statement.
5764 @item lineno
5765 Enable showing line numbers for statements.
5766 @item uid
5767 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5768 @item verbose
5769 Enable showing the tree dump for each statement.
5770 @item eh
5771 Enable showing the EH region number holding each statement.
5772 @item scev
5773 Enable showing scalar evolution analysis details.
5774 @item all
5775 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5776 and @option{lineno}.
5777 @end table
5779 The following tree dumps are possible:
5780 @table @samp
5782 @item original
5783 @opindex fdump-tree-original
5784 Dump before any tree based optimization, to @file{@var{file}.original}.
5786 @item optimized
5787 @opindex fdump-tree-optimized
5788 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5790 @item gimple
5791 @opindex fdump-tree-gimple
5792 Dump each function before and after the gimplification pass to a file.  The
5793 file name is made by appending @file{.gimple} to the source file name.
5795 @item cfg
5796 @opindex fdump-tree-cfg
5797 Dump the control flow graph of each function to a file.  The file name is
5798 made by appending @file{.cfg} to the source file name.
5800 @item vcg
5801 @opindex fdump-tree-vcg
5802 Dump the control flow graph of each function to a file in VCG format.  The
5803 file name is made by appending @file{.vcg} to the source file name.  Note
5804 that if the file contains more than one function, the generated file cannot
5805 be used directly by VCG@.  You must cut and paste each function's
5806 graph into its own separate file first.
5808 @item ch
5809 @opindex fdump-tree-ch
5810 Dump each function after copying loop headers.  The file name is made by
5811 appending @file{.ch} to the source file name.
5813 @item ssa
5814 @opindex fdump-tree-ssa
5815 Dump SSA related information to a file.  The file name is made by appending
5816 @file{.ssa} to the source file name.
5818 @item alias
5819 @opindex fdump-tree-alias
5820 Dump aliasing information for each function.  The file name is made by
5821 appending @file{.alias} to the source file name.
5823 @item ccp
5824 @opindex fdump-tree-ccp
5825 Dump each function after CCP@.  The file name is made by appending
5826 @file{.ccp} to the source file name.
5828 @item storeccp
5829 @opindex fdump-tree-storeccp
5830 Dump each function after STORE-CCP@.  The file name is made by appending
5831 @file{.storeccp} to the source file name.
5833 @item pre
5834 @opindex fdump-tree-pre
5835 Dump trees after partial redundancy elimination.  The file name is made
5836 by appending @file{.pre} to the source file name.
5838 @item fre
5839 @opindex fdump-tree-fre
5840 Dump trees after full redundancy elimination.  The file name is made
5841 by appending @file{.fre} to the source file name.
5843 @item copyprop
5844 @opindex fdump-tree-copyprop
5845 Dump trees after copy propagation.  The file name is made
5846 by appending @file{.copyprop} to the source file name.
5848 @item store_copyprop
5849 @opindex fdump-tree-store_copyprop
5850 Dump trees after store copy-propagation.  The file name is made
5851 by appending @file{.store_copyprop} to the source file name.
5853 @item dce
5854 @opindex fdump-tree-dce
5855 Dump each function after dead code elimination.  The file name is made by
5856 appending @file{.dce} to the source file name.
5858 @item mudflap
5859 @opindex fdump-tree-mudflap
5860 Dump each function after adding mudflap instrumentation.  The file name is
5861 made by appending @file{.mudflap} to the source file name.
5863 @item sra
5864 @opindex fdump-tree-sra
5865 Dump each function after performing scalar replacement of aggregates.  The
5866 file name is made by appending @file{.sra} to the source file name.
5868 @item sink
5869 @opindex fdump-tree-sink
5870 Dump each function after performing code sinking.  The file name is made
5871 by appending @file{.sink} to the source file name.
5873 @item dom
5874 @opindex fdump-tree-dom
5875 Dump each function after applying dominator tree optimizations.  The file
5876 name is made by appending @file{.dom} to the source file name.
5878 @item dse
5879 @opindex fdump-tree-dse
5880 Dump each function after applying dead store elimination.  The file
5881 name is made by appending @file{.dse} to the source file name.
5883 @item phiopt
5884 @opindex fdump-tree-phiopt
5885 Dump each function after optimizing PHI nodes into straightline code.  The file
5886 name is made by appending @file{.phiopt} to the source file name.
5888 @item forwprop
5889 @opindex fdump-tree-forwprop
5890 Dump each function after forward propagating single use variables.  The file
5891 name is made by appending @file{.forwprop} to the source file name.
5893 @item copyrename
5894 @opindex fdump-tree-copyrename
5895 Dump each function after applying the copy rename optimization.  The file
5896 name is made by appending @file{.copyrename} to the source file name.
5898 @item nrv
5899 @opindex fdump-tree-nrv
5900 Dump each function after applying the named return value optimization on
5901 generic trees.  The file name is made by appending @file{.nrv} to the source
5902 file name.
5904 @item vect
5905 @opindex fdump-tree-vect
5906 Dump each function after applying vectorization of loops.  The file name is
5907 made by appending @file{.vect} to the source file name.
5909 @item slp
5910 @opindex fdump-tree-slp
5911 Dump each function after applying vectorization of basic blocks.  The file name
5912 is made by appending @file{.slp} to the source file name.
5914 @item vrp
5915 @opindex fdump-tree-vrp
5916 Dump each function after Value Range Propagation (VRP).  The file name
5917 is made by appending @file{.vrp} to the source file name.
5919 @item all
5920 @opindex fdump-tree-all
5921 Enable all the available tree dumps with the flags provided in this option.
5922 @end table
5924 @item -ftree-vectorizer-verbose=@var{n}
5925 @opindex ftree-vectorizer-verbose
5926 This option controls the amount of debugging output the vectorizer prints.
5927 This information is written to standard error, unless
5928 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5929 in which case it is output to the usual dump listing file, @file{.vect}.
5930 For @var{n}=0 no diagnostic information is reported.
5931 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5932 and the total number of loops that got vectorized.
5933 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5934 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5935 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5936 level that @option{-fdump-tree-vect-stats} uses.
5937 Higher verbosity levels mean either more information dumped for each
5938 reported loop, or same amount of information reported for more loops:
5939 if @var{n}=3, vectorizer cost model information is reported.
5940 If @var{n}=4, alignment related information is added to the reports.
5941 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5942 memory access-patterns) is added to the reports.
5943 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5944 that did not pass the first analysis phase (i.e., may not be countable, or
5945 may have complicated control-flow).
5946 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5947 If @var{n}=8, SLP related information is added to the reports.
5948 For @var{n}=9, all the information the vectorizer generates during its
5949 analysis and transformation is reported.  This is the same verbosity level
5950 that @option{-fdump-tree-vect-details} uses.
5952 @item -frandom-seed=@var{string}
5953 @opindex frandom-seed
5954 This option provides a seed that GCC uses in place of
5955 random numbers in generating certain symbol names
5956 that have to be different in every compiled file.  It is also used to
5957 place unique stamps in coverage data files and the object files that
5958 produce them.  You can use the @option{-frandom-seed} option to produce
5959 reproducibly identical object files.
5961 The @var{string} should be different for every file you compile.
5963 @item -fsched-verbose=@var{n}
5964 @opindex fsched-verbose
5965 On targets that use instruction scheduling, this option controls the
5966 amount of debugging output the scheduler prints.  This information is
5967 written to standard error, unless @option{-fdump-rtl-sched1} or
5968 @option{-fdump-rtl-sched2} is specified, in which case it is output
5969 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5970 respectively.  However for @var{n} greater than nine, the output is
5971 always printed to standard error.
5973 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5974 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5975 For @var{n} greater than one, it also output basic block probabilities,
5976 detailed ready list information and unit/insn info.  For @var{n} greater
5977 than two, it includes RTL at abort point, control-flow and regions info.
5978 And for @var{n} over four, @option{-fsched-verbose} also includes
5979 dependence info.
5981 @item -save-temps
5982 @itemx -save-temps=cwd
5983 @opindex save-temps
5984 Store the usual ``temporary'' intermediate files permanently; place them
5985 in the current directory and name them based on the source file.  Thus,
5986 compiling @file{foo.c} with @option{-c -save-temps} produces files
5987 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5988 preprocessed @file{foo.i} output file even though the compiler now
5989 normally uses an integrated preprocessor.
5991 When used in combination with the @option{-x} command-line option,
5992 @option{-save-temps} is sensible enough to avoid over writing an
5993 input source file with the same extension as an intermediate file.
5994 The corresponding intermediate file may be obtained by renaming the
5995 source file before using @option{-save-temps}.
5997 If you invoke GCC in parallel, compiling several different source
5998 files that share a common base name in different subdirectories or the
5999 same source file compiled for multiple output destinations, it is
6000 likely that the different parallel compilers will interfere with each
6001 other, and overwrite the temporary files.  For instance:
6003 @smallexample
6004 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6005 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6006 @end smallexample
6008 may result in @file{foo.i} and @file{foo.o} being written to
6009 simultaneously by both compilers.
6011 @item -save-temps=obj
6012 @opindex save-temps=obj
6013 Store the usual ``temporary'' intermediate files permanently.  If the
6014 @option{-o} option is used, the temporary files are based on the
6015 object file.  If the @option{-o} option is not used, the
6016 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6018 For example:
6020 @smallexample
6021 gcc -save-temps=obj -c foo.c
6022 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6023 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6024 @end smallexample
6026 @noindent
6027 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6028 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6029 @file{dir2/yfoobar.o}.
6031 @item -time@r{[}=@var{file}@r{]}
6032 @opindex time
6033 Report the CPU time taken by each subprocess in the compilation
6034 sequence.  For C source files, this is the compiler proper and assembler
6035 (plus the linker if linking is done).
6037 Without the specification of an output file, the output looks like this:
6039 @smallexample
6040 # cc1 0.12 0.01
6041 # as 0.00 0.01
6042 @end smallexample
6044 The first number on each line is the ``user time'', that is time spent
6045 executing the program itself.  The second number is ``system time'',
6046 time spent executing operating system routines on behalf of the program.
6047 Both numbers are in seconds.
6049 With the specification of an output file, the output is appended to the
6050 named file, and it looks like this:
6052 @smallexample
6053 0.12 0.01 cc1 @var{options}
6054 0.00 0.01 as @var{options}
6055 @end smallexample
6057 The ``user time'' and the ``system time'' are moved before the program
6058 name, and the options passed to the program are displayed, so that one
6059 can later tell what file was being compiled, and with which options.
6061 @item -fvar-tracking
6062 @opindex fvar-tracking
6063 Run variable tracking pass.  It computes where variables are stored at each
6064 position in code.  Better debugging information is then generated
6065 (if the debugging information format supports this information).
6067 It is enabled by default when compiling with optimization (@option{-Os},
6068 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6069 the debug info format supports it.
6071 @item -fvar-tracking-assignments
6072 @opindex fvar-tracking-assignments
6073 @opindex fno-var-tracking-assignments
6074 Annotate assignments to user variables early in the compilation and
6075 attempt to carry the annotations over throughout the compilation all the
6076 way to the end, in an attempt to improve debug information while
6077 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6079 It can be enabled even if var-tracking is disabled, in which case
6080 annotations are created and maintained, but discarded at the end.
6082 @item -fvar-tracking-assignments-toggle
6083 @opindex fvar-tracking-assignments-toggle
6084 @opindex fno-var-tracking-assignments-toggle
6085 Toggle @option{-fvar-tracking-assignments}, in the same way that
6086 @option{-gtoggle} toggles @option{-g}.
6088 @item -print-file-name=@var{library}
6089 @opindex print-file-name
6090 Print the full absolute name of the library file @var{library} that
6091 would be used when linking---and don't do anything else.  With this
6092 option, GCC does not compile or link anything; it just prints the
6093 file name.
6095 @item -print-multi-directory
6096 @opindex print-multi-directory
6097 Print the directory name corresponding to the multilib selected by any
6098 other switches present in the command line.  This directory is supposed
6099 to exist in @env{GCC_EXEC_PREFIX}.
6101 @item -print-multi-lib
6102 @opindex print-multi-lib
6103 Print the mapping from multilib directory names to compiler switches
6104 that enable them.  The directory name is separated from the switches by
6105 @samp{;}, and each switch starts with an @samp{@@} instead of the
6106 @samp{-}, without spaces between multiple switches.  This is supposed to
6107 ease shell-processing.
6109 @item -print-multi-os-directory
6110 @opindex print-multi-os-directory
6111 Print the path to OS libraries for the selected
6112 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6113 present in the @file{lib} subdirectory and no multilibs are used, this is
6114 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6115 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6116 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6117 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6119 @item -print-prog-name=@var{program}
6120 @opindex print-prog-name
6121 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6123 @item -print-libgcc-file-name
6124 @opindex print-libgcc-file-name
6125 Same as @option{-print-file-name=libgcc.a}.
6127 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6128 but you do want to link with @file{libgcc.a}.  You can do
6130 @smallexample
6131 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6132 @end smallexample
6134 @item -print-search-dirs
6135 @opindex print-search-dirs
6136 Print the name of the configured installation directory and a list of
6137 program and library directories @command{gcc} searches---and don't do anything else.
6139 This is useful when @command{gcc} prints the error message
6140 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6141 To resolve this you either need to put @file{cpp0} and the other compiler
6142 components where @command{gcc} expects to find them, or you can set the environment
6143 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6144 Don't forget the trailing @samp{/}.
6145 @xref{Environment Variables}.
6147 @item -print-sysroot
6148 @opindex print-sysroot
6149 Print the target sysroot directory that is used during
6150 compilation.  This is the target sysroot specified either at configure
6151 time or using the @option{--sysroot} option, possibly with an extra
6152 suffix that depends on compilation options.  If no target sysroot is
6153 specified, the option prints nothing.
6155 @item -print-sysroot-headers-suffix
6156 @opindex print-sysroot-headers-suffix
6157 Print the suffix added to the target sysroot when searching for
6158 headers, or give an error if the compiler is not configured with such
6159 a suffix---and don't do anything else.
6161 @item -dumpmachine
6162 @opindex dumpmachine
6163 Print the compiler's target machine (for example,
6164 @samp{i686-pc-linux-gnu})---and don't do anything else.
6166 @item -dumpversion
6167 @opindex dumpversion
6168 Print the compiler version (for example, @samp{3.0})---and don't do
6169 anything else.
6171 @item -dumpspecs
6172 @opindex dumpspecs
6173 Print the compiler's built-in specs---and don't do anything else.  (This
6174 is used when GCC itself is being built.)  @xref{Spec Files}.
6176 @item -feliminate-unused-debug-types
6177 @opindex feliminate-unused-debug-types
6178 Normally, when producing DWARF 2 output, GCC emits debugging
6179 information for all types declared in a compilation
6180 unit, regardless of whether or not they are actually used
6181 in that compilation unit.  Sometimes this is useful, such as
6182 if, in the debugger, you want to cast a value to a type that is
6183 not actually used in your program (but is declared).  More often,
6184 however, this results in a significant amount of wasted space.
6185 With this option, GCC avoids producing debug symbol output
6186 for types that are nowhere used in the source file being compiled.
6187 @end table
6189 @node Optimize Options
6190 @section Options That Control Optimization
6191 @cindex optimize options
6192 @cindex options, optimization
6194 These options control various sorts of optimizations.
6196 Without any optimization option, the compiler's goal is to reduce the
6197 cost of compilation and to make debugging produce the expected
6198 results.  Statements are independent: if you stop the program with a
6199 breakpoint between statements, you can then assign a new value to any
6200 variable or change the program counter to any other statement in the
6201 function and get exactly the results you expect from the source
6202 code.
6204 Turning on optimization flags makes the compiler attempt to improve
6205 the performance and/or code size at the expense of compilation time
6206 and possibly the ability to debug the program.
6208 The compiler performs optimization based on the knowledge it has of the
6209 program.  Compiling multiple files at once to a single output file mode allows
6210 the compiler to use information gained from all of the files when compiling
6211 each of them.
6213 Not all optimizations are controlled directly by a flag.  Only
6214 optimizations that have a flag are listed in this section.
6216 Most optimizations are only enabled if an @option{-O} level is set on
6217 the command line.  Otherwise they are disabled, even if individual
6218 optimization flags are specified.
6220 Depending on the target and how GCC was configured, a slightly different
6221 set of optimizations may be enabled at each @option{-O} level than
6222 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6223 to find out the exact set of optimizations that are enabled at each level.
6224 @xref{Overall Options}, for examples.
6226 @table @gcctabopt
6227 @item -O
6228 @itemx -O1
6229 @opindex O
6230 @opindex O1
6231 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6232 more memory for a large function.
6234 With @option{-O}, the compiler tries to reduce code size and execution
6235 time, without performing any optimizations that take a great deal of
6236 compilation time.
6238 @option{-O} turns on the following optimization flags:
6239 @gccoptlist{
6240 -fauto-inc-dec @gol
6241 -fcompare-elim @gol
6242 -fcprop-registers @gol
6243 -fdce @gol
6244 -fdefer-pop @gol
6245 -fdelayed-branch @gol
6246 -fdse @gol
6247 -fguess-branch-probability @gol
6248 -fif-conversion2 @gol
6249 -fif-conversion @gol
6250 -fipa-pure-const @gol
6251 -fipa-profile @gol
6252 -fipa-reference @gol
6253 -fmerge-constants
6254 -fsplit-wide-types @gol
6255 -ftree-bit-ccp @gol
6256 -ftree-builtin-call-dce @gol
6257 -ftree-ccp @gol
6258 -ftree-ch @gol
6259 -ftree-copyrename @gol
6260 -ftree-dce @gol
6261 -ftree-dominator-opts @gol
6262 -ftree-dse @gol
6263 -ftree-forwprop @gol
6264 -ftree-fre @gol
6265 -ftree-phiprop @gol
6266 -ftree-slsr @gol
6267 -ftree-sra @gol
6268 -ftree-pta @gol
6269 -ftree-ter @gol
6270 -funit-at-a-time}
6272 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6273 where doing so does not interfere with debugging.
6275 @item -O2
6276 @opindex O2
6277 Optimize even more.  GCC performs nearly all supported optimizations
6278 that do not involve a space-speed tradeoff.
6279 As compared to @option{-O}, this option increases both compilation time
6280 and the performance of the generated code.
6282 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6283 also turns on the following optimization flags:
6284 @gccoptlist{-fthread-jumps @gol
6285 -falign-functions  -falign-jumps @gol
6286 -falign-loops  -falign-labels @gol
6287 -fcaller-saves @gol
6288 -fcrossjumping @gol
6289 -fcse-follow-jumps  -fcse-skip-blocks @gol
6290 -fdelete-null-pointer-checks @gol
6291 -fdevirtualize @gol
6292 -fexpensive-optimizations @gol
6293 -fgcse  -fgcse-lm  @gol
6294 -fhoist-adjacent-loads @gol
6295 -finline-small-functions @gol
6296 -findirect-inlining @gol
6297 -fipa-sra @gol
6298 -foptimize-sibling-calls @gol
6299 -fpartial-inlining @gol
6300 -fpeephole2 @gol
6301 -fregmove @gol
6302 -freorder-blocks  -freorder-functions @gol
6303 -frerun-cse-after-loop  @gol
6304 -fsched-interblock  -fsched-spec @gol
6305 -fschedule-insns  -fschedule-insns2 @gol
6306 -fstrict-aliasing -fstrict-overflow @gol
6307 -ftree-switch-conversion -ftree-tail-merge @gol
6308 -ftree-pre @gol
6309 -ftree-vrp}
6311 Please note the warning under @option{-fgcse} about
6312 invoking @option{-O2} on programs that use computed gotos.
6314 @item -O3
6315 @opindex O3
6316 Optimize yet more.  @option{-O3} turns on all optimizations specified
6317 by @option{-O2} and also turns on the @option{-finline-functions},
6318 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6319 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6320 @option{-fvect-cost-model},
6321 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6323 @item -O0
6324 @opindex O0
6325 Reduce compilation time and make debugging produce the expected
6326 results.  This is the default.
6328 @item -Os
6329 @opindex Os
6330 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6331 do not typically increase code size.  It also performs further
6332 optimizations designed to reduce code size.
6334 @option{-Os} disables the following optimization flags:
6335 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6336 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6337 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6339 @item -Ofast
6340 @opindex Ofast
6341 Disregard strict standards compliance.  @option{-Ofast} enables all
6342 @option{-O3} optimizations.  It also enables optimizations that are not
6343 valid for all standard compliant programs.
6344 It turns on @option{-ffast-math} and the Fortran-specific
6345 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6347 If you use multiple @option{-O} options, with or without level numbers,
6348 the last such option is the one that is effective.
6349 @end table
6351 Options of the form @option{-f@var{flag}} specify machine-independent
6352 flags.  Most flags have both positive and negative forms; the negative
6353 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6354 below, only one of the forms is listed---the one you typically 
6355 use.  You can figure out the other form by either removing @samp{no-}
6356 or adding it.
6358 The following options control specific optimizations.  They are either
6359 activated by @option{-O} options or are related to ones that are.  You
6360 can use the following flags in the rare cases when ``fine-tuning'' of
6361 optimizations to be performed is desired.
6363 @table @gcctabopt
6364 @item -fno-default-inline
6365 @opindex fno-default-inline
6366 Do not make member functions inline by default merely because they are
6367 defined inside the class scope (C++ only).  Otherwise, when you specify
6368 @w{@option{-O}}, member functions defined inside class scope are compiled
6369 inline by default; i.e., you don't need to add @samp{inline} in front of
6370 the member function name.
6372 @item -fno-defer-pop
6373 @opindex fno-defer-pop
6374 Always pop the arguments to each function call as soon as that function
6375 returns.  For machines that must pop arguments after a function call,
6376 the compiler normally lets arguments accumulate on the stack for several
6377 function calls and pops them all at once.
6379 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6381 @item -fforward-propagate
6382 @opindex fforward-propagate
6383 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6384 instructions and checks if the result can be simplified.  If loop unrolling
6385 is active, two passes are performed and the second is scheduled after
6386 loop unrolling.
6388 This option is enabled by default at optimization levels @option{-O},
6389 @option{-O2}, @option{-O3}, @option{-Os}.
6391 @item -ffp-contract=@var{style}
6392 @opindex ffp-contract
6393 @option{-ffp-contract=off} disables floating-point expression contraction.
6394 @option{-ffp-contract=fast} enables floating-point expression contraction
6395 such as forming of fused multiply-add operations if the target has
6396 native support for them.
6397 @option{-ffp-contract=on} enables floating-point expression contraction
6398 if allowed by the language standard.  This is currently not implemented
6399 and treated equal to @option{-ffp-contract=off}.
6401 The default is @option{-ffp-contract=fast}.
6403 @item -fomit-frame-pointer
6404 @opindex fomit-frame-pointer
6405 Don't keep the frame pointer in a register for functions that
6406 don't need one.  This avoids the instructions to save, set up and
6407 restore frame pointers; it also makes an extra register available
6408 in many functions.  @strong{It also makes debugging impossible on
6409 some machines.}
6411 On some machines, such as the VAX, this flag has no effect, because
6412 the standard calling sequence automatically handles the frame pointer
6413 and nothing is saved by pretending it doesn't exist.  The
6414 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6415 whether a target machine supports this flag.  @xref{Registers,,Register
6416 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6418 Starting with GCC version 4.6, the default setting (when not optimizing for
6419 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6420 @option{-fomit-frame-pointer}.  The default can be reverted to
6421 @option{-fno-omit-frame-pointer} by configuring GCC with the
6422 @option{--enable-frame-pointer} configure option.
6424 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6426 @item -foptimize-sibling-calls
6427 @opindex foptimize-sibling-calls
6428 Optimize sibling and tail recursive calls.
6430 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6432 @item -fno-inline
6433 @opindex fno-inline
6434 Do not expand any functions inline apart from those marked with
6435 the @code{always_inline} attribute.  This is the default when not
6436 optimizing.
6438 Single functions can be exempted from inlining by marking them
6439 with the @code{noinline} attribute.
6441 @item -finline-small-functions
6442 @opindex finline-small-functions
6443 Integrate functions into their callers when their body is smaller than expected
6444 function call code (so overall size of program gets smaller).  The compiler
6445 heuristically decides which functions are simple enough to be worth integrating
6446 in this way.  This inlining applies to all functions, even those not declared
6447 inline.
6449 Enabled at level @option{-O2}.
6451 @item -findirect-inlining
6452 @opindex findirect-inlining
6453 Inline also indirect calls that are discovered to be known at compile
6454 time thanks to previous inlining.  This option has any effect only
6455 when inlining itself is turned on by the @option{-finline-functions}
6456 or @option{-finline-small-functions} options.
6458 Enabled at level @option{-O2}.
6460 @item -finline-functions
6461 @opindex finline-functions
6462 Consider all functions for inlining, even if they are not declared inline.
6463 The compiler heuristically decides which functions are worth integrating
6464 in this way.
6466 If all calls to a given function are integrated, and the function is
6467 declared @code{static}, then the function is normally not output as
6468 assembler code in its own right.
6470 Enabled at level @option{-O3}.
6472 @item -finline-functions-called-once
6473 @opindex finline-functions-called-once
6474 Consider all @code{static} functions called once for inlining into their
6475 caller even if they are not marked @code{inline}.  If a call to a given
6476 function is integrated, then the function is not output as assembler code
6477 in its own right.
6479 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6481 @item -fearly-inlining
6482 @opindex fearly-inlining
6483 Inline functions marked by @code{always_inline} and functions whose body seems
6484 smaller than the function call overhead early before doing
6485 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6486 makes profiling significantly cheaper and usually inlining faster on programs
6487 having large chains of nested wrapper functions.
6489 Enabled by default.
6491 @item -fipa-sra
6492 @opindex fipa-sra
6493 Perform interprocedural scalar replacement of aggregates, removal of
6494 unused parameters and replacement of parameters passed by reference
6495 by parameters passed by value.
6497 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6499 @item -finline-limit=@var{n}
6500 @opindex finline-limit
6501 By default, GCC limits the size of functions that can be inlined.  This flag
6502 allows coarse control of this limit.  @var{n} is the size of functions that
6503 can be inlined in number of pseudo instructions.
6505 Inlining is actually controlled by a number of parameters, which may be
6506 specified individually by using @option{--param @var{name}=@var{value}}.
6507 The @option{-finline-limit=@var{n}} option sets some of these parameters
6508 as follows:
6510 @table @gcctabopt
6511 @item max-inline-insns-single
6512 is set to @var{n}/2.
6513 @item max-inline-insns-auto
6514 is set to @var{n}/2.
6515 @end table
6517 See below for a documentation of the individual
6518 parameters controlling inlining and for the defaults of these parameters.
6520 @emph{Note:} there may be no value to @option{-finline-limit} that results
6521 in default behavior.
6523 @emph{Note:} pseudo instruction represents, in this particular context, an
6524 abstract measurement of function's size.  In no way does it represent a count
6525 of assembly instructions and as such its exact meaning might change from one
6526 release to an another.
6528 @item -fno-keep-inline-dllexport
6529 @opindex -fno-keep-inline-dllexport
6530 This is a more fine-grained version of @option{-fkeep-inline-functions},
6531 which applies only to functions that are declared using the @code{dllexport}
6532 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6533 Functions}.)
6535 @item -fkeep-inline-functions
6536 @opindex fkeep-inline-functions
6537 In C, emit @code{static} functions that are declared @code{inline}
6538 into the object file, even if the function has been inlined into all
6539 of its callers.  This switch does not affect functions using the
6540 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6541 inline functions into the object file.
6543 @item -fkeep-static-consts
6544 @opindex fkeep-static-consts
6545 Emit variables declared @code{static const} when optimization isn't turned
6546 on, even if the variables aren't referenced.
6548 GCC enables this option by default.  If you want to force the compiler to
6549 check if a variable is referenced, regardless of whether or not
6550 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6552 @item -fmerge-constants
6553 @opindex fmerge-constants
6554 Attempt to merge identical constants (string constants and floating-point
6555 constants) across compilation units.
6557 This option is the default for optimized compilation if the assembler and
6558 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6559 behavior.
6561 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6563 @item -fmerge-all-constants
6564 @opindex fmerge-all-constants
6565 Attempt to merge identical constants and identical variables.
6567 This option implies @option{-fmerge-constants}.  In addition to
6568 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6569 arrays or initialized constant variables with integral or floating-point
6570 types.  Languages like C or C++ require each variable, including multiple
6571 instances of the same variable in recursive calls, to have distinct locations,
6572 so using this option results in non-conforming
6573 behavior.
6575 @item -fmodulo-sched
6576 @opindex fmodulo-sched
6577 Perform swing modulo scheduling immediately before the first scheduling
6578 pass.  This pass looks at innermost loops and reorders their
6579 instructions by overlapping different iterations.
6581 @item -fmodulo-sched-allow-regmoves
6582 @opindex fmodulo-sched-allow-regmoves
6583 Perform more aggressive SMS-based modulo scheduling with register moves
6584 allowed.  By setting this flag certain anti-dependences edges are
6585 deleted, which triggers the generation of reg-moves based on the
6586 life-range analysis.  This option is effective only with
6587 @option{-fmodulo-sched} enabled.
6589 @item -fno-branch-count-reg
6590 @opindex fno-branch-count-reg
6591 Do not use ``decrement and branch'' instructions on a count register,
6592 but instead generate a sequence of instructions that decrement a
6593 register, compare it against zero, then branch based upon the result.
6594 This option is only meaningful on architectures that support such
6595 instructions, which include x86, PowerPC, IA-64 and S/390.
6597 The default is @option{-fbranch-count-reg}.
6599 @item -fno-function-cse
6600 @opindex fno-function-cse
6601 Do not put function addresses in registers; make each instruction that
6602 calls a constant function contain the function's address explicitly.
6604 This option results in less efficient code, but some strange hacks
6605 that alter the assembler output may be confused by the optimizations
6606 performed when this option is not used.
6608 The default is @option{-ffunction-cse}
6610 @item -fno-zero-initialized-in-bss
6611 @opindex fno-zero-initialized-in-bss
6612 If the target supports a BSS section, GCC by default puts variables that
6613 are initialized to zero into BSS@.  This can save space in the resulting
6614 code.
6616 This option turns off this behavior because some programs explicitly
6617 rely on variables going to the data section.  E.g., so that the
6618 resulting executable can find the beginning of that section and/or make
6619 assumptions based on that.
6621 The default is @option{-fzero-initialized-in-bss}.
6623 @item -fmudflap -fmudflapth -fmudflapir
6624 @opindex fmudflap
6625 @opindex fmudflapth
6626 @opindex fmudflapir
6627 @cindex bounds checking
6628 @cindex mudflap
6629 For front-ends that support it (C and C++), instrument all risky
6630 pointer/array dereferencing operations, some standard library
6631 string/heap functions, and some other associated constructs with
6632 range/validity tests.  Modules so instrumented should be immune to
6633 buffer overflows, invalid heap use, and some other classes of C/C++
6634 programming errors.  The instrumentation relies on a separate runtime
6635 library (@file{libmudflap}), which is linked into a program if
6636 @option{-fmudflap} is given at link time.  Run-time behavior of the
6637 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6638 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6639 for its options.
6641 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6642 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6643 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6644 instrumentation should ignore pointer reads.  This produces less
6645 instrumentation (and therefore faster execution) and still provides
6646 some protection against outright memory corrupting writes, but allows
6647 erroneously read data to propagate within a program.
6649 @item -fthread-jumps
6650 @opindex fthread-jumps
6651 Perform optimizations where we check to see if a jump branches to a
6652 location where another comparison subsumed by the first is found.  If
6653 so, the first branch is redirected to either the destination of the
6654 second branch or a point immediately following it, depending on whether
6655 the condition is known to be true or false.
6657 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6659 @item -fsplit-wide-types
6660 @opindex fsplit-wide-types
6661 When using a type that occupies multiple registers, such as @code{long
6662 long} on a 32-bit system, split the registers apart and allocate them
6663 independently.  This normally generates better code for those types,
6664 but may make debugging more difficult.
6666 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6667 @option{-Os}.
6669 @item -fcse-follow-jumps
6670 @opindex fcse-follow-jumps
6671 In common subexpression elimination (CSE), scan through jump instructions
6672 when the target of the jump is not reached by any other path.  For
6673 example, when CSE encounters an @code{if} statement with an
6674 @code{else} clause, CSE follows the jump when the condition
6675 tested is false.
6677 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6679 @item -fcse-skip-blocks
6680 @opindex fcse-skip-blocks
6681 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6682 follow jumps that conditionally skip over blocks.  When CSE
6683 encounters a simple @code{if} statement with no else clause,
6684 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6685 body of the @code{if}.
6687 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6689 @item -frerun-cse-after-loop
6690 @opindex frerun-cse-after-loop
6691 Re-run common subexpression elimination after loop optimizations are
6692 performed.
6694 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6696 @item -fgcse
6697 @opindex fgcse
6698 Perform a global common subexpression elimination pass.
6699 This pass also performs global constant and copy propagation.
6701 @emph{Note:} When compiling a program using computed gotos, a GCC
6702 extension, you may get better run-time performance if you disable
6703 the global common subexpression elimination pass by adding
6704 @option{-fno-gcse} to the command line.
6706 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6708 @item -fgcse-lm
6709 @opindex fgcse-lm
6710 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6711 attempts to move loads that are only killed by stores into themselves.  This
6712 allows a loop containing a load/store sequence to be changed to a load outside
6713 the loop, and a copy/store within the loop.
6715 Enabled by default when @option{-fgcse} is enabled.
6717 @item -fgcse-sm
6718 @opindex fgcse-sm
6719 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6720 global common subexpression elimination.  This pass attempts to move
6721 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6722 loops containing a load/store sequence can be changed to a load before
6723 the loop and a store after the loop.
6725 Not enabled at any optimization level.
6727 @item -fgcse-las
6728 @opindex fgcse-las
6729 When @option{-fgcse-las} is enabled, the global common subexpression
6730 elimination pass eliminates redundant loads that come after stores to the
6731 same memory location (both partial and full redundancies).
6733 Not enabled at any optimization level.
6735 @item -fgcse-after-reload
6736 @opindex fgcse-after-reload
6737 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6738 pass is performed after reload.  The purpose of this pass is to cleanup
6739 redundant spilling.
6741 @item -funsafe-loop-optimizations
6742 @opindex funsafe-loop-optimizations
6743 If given, the loop optimizer assumes that loop indices do not
6744 overflow, and that the loops with nontrivial exit condition are not
6745 infinite.  This enables a wider range of loop optimizations even if
6746 the loop optimizer itself cannot prove that these assumptions are valid.
6747 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6748 if it finds this kind of loop.
6750 @item -fcrossjumping
6751 @opindex fcrossjumping
6752 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6753 resulting code may or may not perform better than without cross-jumping.
6755 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6757 @item -fauto-inc-dec
6758 @opindex fauto-inc-dec
6759 Combine increments or decrements of addresses with memory accesses.
6760 This pass is always skipped on architectures that do not have
6761 instructions to support this.  Enabled by default at @option{-O} and
6762 higher on architectures that support this.
6764 @item -fdce
6765 @opindex fdce
6766 Perform dead code elimination (DCE) on RTL@.
6767 Enabled by default at @option{-O} and higher.
6769 @item -fdse
6770 @opindex fdse
6771 Perform dead store elimination (DSE) on RTL@.
6772 Enabled by default at @option{-O} and higher.
6774 @item -fif-conversion
6775 @opindex fif-conversion
6776 Attempt to transform conditional jumps into branch-less equivalents.  This
6777 include use of conditional moves, min, max, set flags and abs instructions, and
6778 some tricks doable by standard arithmetics.  The use of conditional execution
6779 on chips where it is available is controlled by @code{if-conversion2}.
6781 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6783 @item -fif-conversion2
6784 @opindex fif-conversion2
6785 Use conditional execution (where available) to transform conditional jumps into
6786 branch-less equivalents.
6788 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6790 @item -fdelete-null-pointer-checks
6791 @opindex fdelete-null-pointer-checks
6792 Assume that programs cannot safely dereference null pointers, and that
6793 no code or data element resides there.  This enables simple constant
6794 folding optimizations at all optimization levels.  In addition, other
6795 optimization passes in GCC use this flag to control global dataflow
6796 analyses that eliminate useless checks for null pointers; these assume
6797 that if a pointer is checked after it has already been dereferenced,
6798 it cannot be null.
6800 Note however that in some environments this assumption is not true.
6801 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6802 for programs that depend on that behavior.
6804 Some targets, especially embedded ones, disable this option at all levels.
6805 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6806 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6807 are enabled independently at different optimization levels.
6809 @item -fdevirtualize
6810 @opindex fdevirtualize
6811 Attempt to convert calls to virtual functions to direct calls.  This
6812 is done both within a procedure and interprocedurally as part of
6813 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6814 propagation (@option{-fipa-cp}).
6815 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6817 @item -fexpensive-optimizations
6818 @opindex fexpensive-optimizations
6819 Perform a number of minor optimizations that are relatively expensive.
6821 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6823 @item -free
6824 @opindex free
6825 Attempt to remove redundant extension instructions.  This is especially
6826 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6827 registers after writing to their lower 32-bit half.
6829 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6831 @item -foptimize-register-move
6832 @itemx -fregmove
6833 @opindex foptimize-register-move
6834 @opindex fregmove
6835 Attempt to reassign register numbers in move instructions and as
6836 operands of other simple instructions in order to maximize the amount of
6837 register tying.  This is especially helpful on machines with two-operand
6838 instructions.
6840 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6841 optimization.
6843 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6845 @item -fira-algorithm=@var{algorithm}
6846 Use the specified coloring algorithm for the integrated register
6847 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6848 specifies Chow's priority coloring, or @samp{CB}, which specifies
6849 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6850 for all architectures, but for those targets that do support it, it is
6851 the default because it generates better code.
6853 @item -fira-region=@var{region}
6854 Use specified regions for the integrated register allocator.  The
6855 @var{region} argument should be one of the following:
6857 @table @samp
6859 @item all
6860 Use all loops as register allocation regions.
6861 This can give the best results for machines with a small and/or
6862 irregular register set.
6864 @item mixed
6865 Use all loops except for loops with small register pressure 
6866 as the regions.  This value usually gives
6867 the best results in most cases and for most architectures,
6868 and is enabled by default when compiling with optimization for speed
6869 (@option{-O}, @option{-O2}, @dots{}).
6871 @item one
6872 Use all functions as a single region.  
6873 This typically results in the smallest code size, and is enabled by default for
6874 @option{-Os} or @option{-O0}.
6876 @end table
6878 @item -fira-loop-pressure
6879 @opindex fira-loop-pressure
6880 Use IRA to evaluate register pressure in loops for decisions to move
6881 loop invariants.  This option usually results in generation
6882 of faster and smaller code on machines with large register files (>= 32
6883 registers), but it can slow the compiler down.
6885 This option is enabled at level @option{-O3} for some targets.
6887 @item -fno-ira-share-save-slots
6888 @opindex fno-ira-share-save-slots
6889 Disable sharing of stack slots used for saving call-used hard
6890 registers living through a call.  Each hard register gets a
6891 separate stack slot, and as a result function stack frames are
6892 larger.
6894 @item -fno-ira-share-spill-slots
6895 @opindex fno-ira-share-spill-slots
6896 Disable sharing of stack slots allocated for pseudo-registers.  Each
6897 pseudo-register that does not get a hard register gets a separate
6898 stack slot, and as a result function stack frames are larger.
6900 @item -fira-verbose=@var{n}
6901 @opindex fira-verbose
6902 Control the verbosity of the dump file for the integrated register allocator.
6903 The default value is 5.  If the value @var{n} is greater or equal to 10,
6904 the dump output is sent to stderr using the same format as @var{n} minus 10.
6906 @item -fdelayed-branch
6907 @opindex fdelayed-branch
6908 If supported for the target machine, attempt to reorder instructions
6909 to exploit instruction slots available after delayed branch
6910 instructions.
6912 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6914 @item -fschedule-insns
6915 @opindex fschedule-insns
6916 If supported for the target machine, attempt to reorder instructions to
6917 eliminate execution stalls due to required data being unavailable.  This
6918 helps machines that have slow floating point or memory load instructions
6919 by allowing other instructions to be issued until the result of the load
6920 or floating-point instruction is required.
6922 Enabled at levels @option{-O2}, @option{-O3}.
6924 @item -fschedule-insns2
6925 @opindex fschedule-insns2
6926 Similar to @option{-fschedule-insns}, but requests an additional pass of
6927 instruction scheduling after register allocation has been done.  This is
6928 especially useful on machines with a relatively small number of
6929 registers and where memory load instructions take more than one cycle.
6931 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6933 @item -fno-sched-interblock
6934 @opindex fno-sched-interblock
6935 Don't schedule instructions across basic blocks.  This is normally
6936 enabled by default when scheduling before register allocation, i.e.@:
6937 with @option{-fschedule-insns} or at @option{-O2} or higher.
6939 @item -fno-sched-spec
6940 @opindex fno-sched-spec
6941 Don't allow speculative motion of non-load instructions.  This is normally
6942 enabled by default when scheduling before register allocation, i.e.@:
6943 with @option{-fschedule-insns} or at @option{-O2} or higher.
6945 @item -fsched-pressure
6946 @opindex fsched-pressure
6947 Enable register pressure sensitive insn scheduling before the register
6948 allocation.  This only makes sense when scheduling before register
6949 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6950 @option{-O2} or higher.  Usage of this option can improve the
6951 generated code and decrease its size by preventing register pressure
6952 increase above the number of available hard registers and as a
6953 consequence register spills in the register allocation.
6955 @item -fsched-spec-load
6956 @opindex fsched-spec-load
6957 Allow speculative motion of some load instructions.  This only makes
6958 sense when scheduling before register allocation, i.e.@: with
6959 @option{-fschedule-insns} or at @option{-O2} or higher.
6961 @item -fsched-spec-load-dangerous
6962 @opindex fsched-spec-load-dangerous
6963 Allow speculative motion of more load instructions.  This only makes
6964 sense when scheduling before register allocation, i.e.@: with
6965 @option{-fschedule-insns} or at @option{-O2} or higher.
6967 @item -fsched-stalled-insns
6968 @itemx -fsched-stalled-insns=@var{n}
6969 @opindex fsched-stalled-insns
6970 Define how many insns (if any) can be moved prematurely from the queue
6971 of stalled insns into the ready list during the second scheduling pass.
6972 @option{-fno-sched-stalled-insns} means that no insns are moved
6973 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6974 on how many queued insns can be moved prematurely.
6975 @option{-fsched-stalled-insns} without a value is equivalent to
6976 @option{-fsched-stalled-insns=1}.
6978 @item -fsched-stalled-insns-dep
6979 @itemx -fsched-stalled-insns-dep=@var{n}
6980 @opindex fsched-stalled-insns-dep
6981 Define how many insn groups (cycles) are examined for a dependency
6982 on a stalled insn that is a candidate for premature removal from the queue
6983 of stalled insns.  This has an effect only during the second scheduling pass,
6984 and only if @option{-fsched-stalled-insns} is used.
6985 @option{-fno-sched-stalled-insns-dep} is equivalent to
6986 @option{-fsched-stalled-insns-dep=0}.
6987 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6988 @option{-fsched-stalled-insns-dep=1}.
6990 @item -fsched2-use-superblocks
6991 @opindex fsched2-use-superblocks
6992 When scheduling after register allocation, do use superblock scheduling
6993 algorithm.  Superblock scheduling allows motion across basic block boundaries
6994 resulting on faster schedules.  This option is experimental, as not all machine
6995 descriptions used by GCC model the CPU closely enough to avoid unreliable
6996 results from the algorithm.
6998 This only makes sense when scheduling after register allocation, i.e.@: with
6999 @option{-fschedule-insns2} or at @option{-O2} or higher.
7001 @item -fsched-group-heuristic
7002 @opindex fsched-group-heuristic
7003 Enable the group heuristic in the scheduler.  This heuristic favors
7004 the instruction that belongs to a schedule group.  This is enabled
7005 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7006 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7008 @item -fsched-critical-path-heuristic
7009 @opindex fsched-critical-path-heuristic
7010 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7011 instructions on the critical path.  This is enabled by default when
7012 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7013 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7015 @item -fsched-spec-insn-heuristic
7016 @opindex fsched-spec-insn-heuristic
7017 Enable the speculative instruction heuristic in the scheduler.  This
7018 heuristic favors speculative instructions with greater dependency weakness.
7019 This is enabled by default when scheduling is enabled, i.e.@:
7020 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7021 or at @option{-O2} or higher.
7023 @item -fsched-rank-heuristic
7024 @opindex fsched-rank-heuristic
7025 Enable the rank heuristic in the scheduler.  This heuristic favors
7026 the instruction belonging to a basic block with greater size or frequency.
7027 This is enabled by default when scheduling is enabled, i.e.@:
7028 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7029 at @option{-O2} or higher.
7031 @item -fsched-last-insn-heuristic
7032 @opindex fsched-last-insn-heuristic
7033 Enable the last-instruction heuristic in the scheduler.  This heuristic
7034 favors the instruction that is less dependent on the last instruction
7035 scheduled.  This is enabled by default when scheduling is enabled,
7036 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7037 at @option{-O2} or higher.
7039 @item -fsched-dep-count-heuristic
7040 @opindex fsched-dep-count-heuristic
7041 Enable the dependent-count heuristic in the scheduler.  This heuristic
7042 favors the instruction that has more instructions depending on it.
7043 This is enabled by default when scheduling is enabled, i.e.@:
7044 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7045 at @option{-O2} or higher.
7047 @item -freschedule-modulo-scheduled-loops
7048 @opindex freschedule-modulo-scheduled-loops
7049 The modulo scheduling comes before the traditional scheduling.  If a loop
7050 is modulo scheduled you may want to prevent the later scheduling passes
7051 from changing its schedule; use this option to control that.
7053 @item -fselective-scheduling
7054 @opindex fselective-scheduling
7055 Schedule instructions using selective scheduling algorithm.  Selective
7056 scheduling runs instead of the first scheduler pass.
7058 @item -fselective-scheduling2
7059 @opindex fselective-scheduling2
7060 Schedule instructions using selective scheduling algorithm.  Selective
7061 scheduling runs instead of the second scheduler pass.
7063 @item -fsel-sched-pipelining
7064 @opindex fsel-sched-pipelining
7065 Enable software pipelining of innermost loops during selective scheduling.
7066 This option has no effect until one of @option{-fselective-scheduling} or
7067 @option{-fselective-scheduling2} is turned on.
7069 @item -fsel-sched-pipelining-outer-loops
7070 @opindex fsel-sched-pipelining-outer-loops
7071 When pipelining loops during selective scheduling, also pipeline outer loops.
7072 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
7074 @item -fshrink-wrap
7075 @opindex fshrink-wrap
7076 Emit function prologues only before parts of the function that need it,
7077 rather than at the top of the function.  This flag is enabled by default at
7078 @option{-O} and higher.
7080 @item -fcaller-saves
7081 @opindex fcaller-saves
7082 Enable allocation of values to registers that are clobbered by
7083 function calls, by emitting extra instructions to save and restore the
7084 registers around such calls.  Such allocation is done only when it
7085 seems to result in better code.
7087 This option is always enabled by default on certain machines, usually
7088 those which have no call-preserved registers to use instead.
7090 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7092 @item -fcombine-stack-adjustments
7093 @opindex fcombine-stack-adjustments
7094 Tracks stack adjustments (pushes and pops) and stack memory references
7095 and then tries to find ways to combine them.
7097 Enabled by default at @option{-O1} and higher.
7099 @item -fconserve-stack
7100 @opindex fconserve-stack
7101 Attempt to minimize stack usage.  The compiler attempts to use less
7102 stack space, even if that makes the program slower.  This option
7103 implies setting the @option{large-stack-frame} parameter to 100
7104 and the @option{large-stack-frame-growth} parameter to 400.
7106 @item -ftree-reassoc
7107 @opindex ftree-reassoc
7108 Perform reassociation on trees.  This flag is enabled by default
7109 at @option{-O} and higher.
7111 @item -ftree-pre
7112 @opindex ftree-pre
7113 Perform partial redundancy elimination (PRE) on trees.  This flag is
7114 enabled by default at @option{-O2} and @option{-O3}.
7116 @item -ftree-partial-pre
7117 @opindex ftree-partial-pre
7118 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7119 enabled by default at @option{-O3}.
7121 @item -ftree-forwprop
7122 @opindex ftree-forwprop
7123 Perform forward propagation on trees.  This flag is enabled by default
7124 at @option{-O} and higher.
7126 @item -ftree-fre
7127 @opindex ftree-fre
7128 Perform full redundancy elimination (FRE) on trees.  The difference
7129 between FRE and PRE is that FRE only considers expressions
7130 that are computed on all paths leading to the redundant computation.
7131 This analysis is faster than PRE, though it exposes fewer redundancies.
7132 This flag is enabled by default at @option{-O} and higher.
7134 @item -ftree-phiprop
7135 @opindex ftree-phiprop
7136 Perform hoisting of loads from conditional pointers on trees.  This
7137 pass is enabled by default at @option{-O} and higher.
7139 @item -fhoist-adjacent-loads
7140 @opindex hoist-adjacent-loads
7141 Speculatively hoist loads from both branches of an if-then-else if the
7142 loads are from adjacent locations in the same structure and the target
7143 architecture has a conditional move instruction.  This flag is enabled
7144 by default at @option{-O2} and higher.
7146 @item -ftree-copy-prop
7147 @opindex ftree-copy-prop
7148 Perform copy propagation on trees.  This pass eliminates unnecessary
7149 copy operations.  This flag is enabled by default at @option{-O} and
7150 higher.
7152 @item -fipa-pure-const
7153 @opindex fipa-pure-const
7154 Discover which functions are pure or constant.
7155 Enabled by default at @option{-O} and higher.
7157 @item -fipa-reference
7158 @opindex fipa-reference
7159 Discover which static variables do not escape cannot escape the
7160 compilation unit.
7161 Enabled by default at @option{-O} and higher.
7163 @item -fipa-pta
7164 @opindex fipa-pta
7165 Perform interprocedural pointer analysis and interprocedural modification
7166 and reference analysis.  This option can cause excessive memory and
7167 compile-time usage on large compilation units.  It is not enabled by
7168 default at any optimization level.
7170 @item -fipa-profile
7171 @opindex fipa-profile
7172 Perform interprocedural profile propagation.  The functions called only from
7173 cold functions are marked as cold. Also functions executed once (such as
7174 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7175 functions and loop less parts of functions executed once are then optimized for
7176 size.
7177 Enabled by default at @option{-O} and higher.
7179 @item -fipa-cp
7180 @opindex fipa-cp
7181 Perform interprocedural constant propagation.
7182 This optimization analyzes the program to determine when values passed
7183 to functions are constants and then optimizes accordingly.
7184 This optimization can substantially increase performance
7185 if the application has constants passed to functions.
7186 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7188 @item -fipa-cp-clone
7189 @opindex fipa-cp-clone
7190 Perform function cloning to make interprocedural constant propagation stronger.
7191 When enabled, interprocedural constant propagation performs function cloning
7192 when externally visible function can be called with constant arguments.
7193 Because this optimization can create multiple copies of functions,
7194 it may significantly increase code size
7195 (see @option{--param ipcp-unit-growth=@var{value}}).
7196 This flag is enabled by default at @option{-O3}.
7198 @item -ftree-sink
7199 @opindex ftree-sink
7200 Perform forward store motion  on trees.  This flag is
7201 enabled by default at @option{-O} and higher.
7203 @item -ftree-bit-ccp
7204 @opindex ftree-bit-ccp
7205 Perform sparse conditional bit constant propagation on trees and propagate
7206 pointer alignment information.
7207 This pass only operates on local scalar variables and is enabled by default
7208 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7210 @item -ftree-ccp
7211 @opindex ftree-ccp
7212 Perform sparse conditional constant propagation (CCP) on trees.  This
7213 pass only operates on local scalar variables and is enabled by default
7214 at @option{-O} and higher.
7216 @item -ftree-switch-conversion
7217 Perform conversion of simple initializations in a switch to
7218 initializations from a scalar array.  This flag is enabled by default
7219 at @option{-O2} and higher.
7221 @item -ftree-tail-merge
7222 Look for identical code sequences.  When found, replace one with a jump to the
7223 other.  This optimization is known as tail merging or cross jumping.  This flag
7224 is enabled by default at @option{-O2} and higher.  The compilation time
7225 in this pass can
7226 be limited using @option{max-tail-merge-comparisons} parameter and
7227 @option{max-tail-merge-iterations} parameter.
7229 @item -ftree-dce
7230 @opindex ftree-dce
7231 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7232 default at @option{-O} and higher.
7234 @item -ftree-builtin-call-dce
7235 @opindex ftree-builtin-call-dce
7236 Perform conditional dead code elimination (DCE) for calls to builtin functions
7237 that may set @code{errno} but are otherwise side-effect free.  This flag is
7238 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7239 specified.
7241 @item -ftree-dominator-opts
7242 @opindex ftree-dominator-opts
7243 Perform a variety of simple scalar cleanups (constant/copy
7244 propagation, redundancy elimination, range propagation and expression
7245 simplification) based on a dominator tree traversal.  This also
7246 performs jump threading (to reduce jumps to jumps). This flag is
7247 enabled by default at @option{-O} and higher.
7249 @item -ftree-dse
7250 @opindex ftree-dse
7251 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7252 a memory location that is later overwritten by another store without
7253 any intervening loads.  In this case the earlier store can be deleted.  This
7254 flag is enabled by default at @option{-O} and higher.
7256 @item -ftree-ch
7257 @opindex ftree-ch
7258 Perform loop header copying on trees.  This is beneficial since it increases
7259 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7260 is enabled by default at @option{-O} and higher.  It is not enabled
7261 for @option{-Os}, since it usually increases code size.
7263 @item -ftree-loop-optimize
7264 @opindex ftree-loop-optimize
7265 Perform loop optimizations on trees.  This flag is enabled by default
7266 at @option{-O} and higher.
7268 @item -ftree-loop-linear
7269 @opindex ftree-loop-linear
7270 Perform loop interchange transformations on tree.  Same as
7271 @option{-floop-interchange}.  To use this code transformation, GCC has
7272 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7273 enable the Graphite loop transformation infrastructure.
7275 @item -floop-interchange
7276 @opindex floop-interchange
7277 Perform loop interchange transformations on loops.  Interchanging two
7278 nested loops switches the inner and outer loops.  For example, given a
7279 loop like:
7280 @smallexample
7281 DO J = 1, M
7282   DO I = 1, N
7283     A(J, I) = A(J, I) * C
7284   ENDDO
7285 ENDDO
7286 @end smallexample
7287 loop interchange transforms the loop as if it were written:
7288 @smallexample
7289 DO I = 1, N
7290   DO J = 1, M
7291     A(J, I) = A(J, I) * C
7292   ENDDO
7293 ENDDO
7294 @end smallexample
7295 which can be beneficial when @code{N} is larger than the caches,
7296 because in Fortran, the elements of an array are stored in memory
7297 contiguously by column, and the original loop iterates over rows,
7298 potentially creating at each access a cache miss.  This optimization
7299 applies to all the languages supported by GCC and is not limited to
7300 Fortran.  To use this code transformation, GCC has to be configured
7301 with @option{--with-ppl} and @option{--with-cloog} to enable the
7302 Graphite loop transformation infrastructure.
7304 @item -floop-strip-mine
7305 @opindex floop-strip-mine
7306 Perform loop strip mining transformations on loops.  Strip mining
7307 splits a loop into two nested loops.  The outer loop has strides
7308 equal to the strip size and the inner loop has strides of the
7309 original loop within a strip.  The strip length can be changed
7310 using the @option{loop-block-tile-size} parameter.  For example,
7311 given a loop like:
7312 @smallexample
7313 DO I = 1, N
7314   A(I) = A(I) + C
7315 ENDDO
7316 @end smallexample
7317 loop strip mining transforms the loop as if it were written:
7318 @smallexample
7319 DO II = 1, N, 51
7320   DO I = II, min (II + 50, N)
7321     A(I) = A(I) + C
7322   ENDDO
7323 ENDDO
7324 @end smallexample
7325 This optimization applies to all the languages supported by GCC and is
7326 not limited to Fortran.  To use this code transformation, GCC has to
7327 be configured with @option{--with-ppl} and @option{--with-cloog} to
7328 enable the Graphite loop transformation infrastructure.
7330 @item -floop-block
7331 @opindex floop-block
7332 Perform loop blocking transformations on loops.  Blocking strip mines
7333 each loop in the loop nest such that the memory accesses of the
7334 element loops fit inside caches.  The strip length can be changed
7335 using the @option{loop-block-tile-size} parameter.  For example, given
7336 a loop like:
7337 @smallexample
7338 DO I = 1, N
7339   DO J = 1, M
7340     A(J, I) = B(I) + C(J)
7341   ENDDO
7342 ENDDO
7343 @end smallexample
7344 loop blocking transforms the loop as if it were written:
7345 @smallexample
7346 DO II = 1, N, 51
7347   DO JJ = 1, M, 51
7348     DO I = II, min (II + 50, N)
7349       DO J = JJ, min (JJ + 50, M)
7350         A(J, I) = B(I) + C(J)
7351       ENDDO
7352     ENDDO
7353   ENDDO
7354 ENDDO
7355 @end smallexample
7356 which can be beneficial when @code{M} is larger than the caches,
7357 because the innermost loop iterates over a smaller amount of data
7358 which can be kept in the caches.  This optimization applies to all the
7359 languages supported by GCC and is not limited to Fortran.  To use this
7360 code transformation, GCC has to be configured with @option{--with-ppl}
7361 and @option{--with-cloog} to enable the Graphite loop transformation
7362 infrastructure.
7364 @item -fgraphite-identity
7365 @opindex fgraphite-identity
7366 Enable the identity transformation for graphite.  For every SCoP we generate
7367 the polyhedral representation and transform it back to gimple.  Using
7368 @option{-fgraphite-identity} we can check the costs or benefits of the
7369 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7370 are also performed by the code generator CLooG, like index splitting and
7371 dead code elimination in loops.
7373 @item -floop-nest-optimize
7374 @opindex floop-nest-optimize
7375 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7376 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7377 structure optimized for data-locality and parallelism.  This option
7378 is experimental.
7380 @item -floop-parallelize-all
7381 @opindex floop-parallelize-all
7382 Use the Graphite data dependence analysis to identify loops that can
7383 be parallelized.  Parallelize all the loops that can be analyzed to
7384 not contain loop carried dependences without checking that it is
7385 profitable to parallelize the loops.
7387 @item -fcheck-data-deps
7388 @opindex fcheck-data-deps
7389 Compare the results of several data dependence analyzers.  This option
7390 is used for debugging the data dependence analyzers.
7392 @item -ftree-loop-if-convert
7393 Attempt to transform conditional jumps in the innermost loops to
7394 branch-less equivalents.  The intent is to remove control-flow from
7395 the innermost loops in order to improve the ability of the
7396 vectorization pass to handle these loops.  This is enabled by default
7397 if vectorization is enabled.
7399 @item -ftree-loop-if-convert-stores
7400 Attempt to also if-convert conditional jumps containing memory writes.
7401 This transformation can be unsafe for multi-threaded programs as it
7402 transforms conditional memory writes into unconditional memory writes.
7403 For example,
7404 @smallexample
7405 for (i = 0; i < N; i++)
7406   if (cond)
7407     A[i] = expr;
7408 @end smallexample
7409 is transformed to
7410 @smallexample
7411 for (i = 0; i < N; i++)
7412   A[i] = cond ? expr : A[i];
7413 @end smallexample
7414 potentially producing data races.
7416 @item -ftree-loop-distribution
7417 Perform loop distribution.  This flag can improve cache performance on
7418 big loop bodies and allow further loop optimizations, like
7419 parallelization or vectorization, to take place.  For example, the loop
7420 @smallexample
7421 DO I = 1, N
7422   A(I) = B(I) + C
7423   D(I) = E(I) * F
7424 ENDDO
7425 @end smallexample
7426 is transformed to
7427 @smallexample
7428 DO I = 1, N
7429    A(I) = B(I) + C
7430 ENDDO
7431 DO I = 1, N
7432    D(I) = E(I) * F
7433 ENDDO
7434 @end smallexample
7436 @item -ftree-loop-distribute-patterns
7437 Perform loop distribution of patterns that can be code generated with
7438 calls to a library.  This flag is enabled by default at @option{-O3}.
7440 This pass distributes the initialization loops and generates a call to
7441 memset zero.  For example, the loop
7442 @smallexample
7443 DO I = 1, N
7444   A(I) = 0
7445   B(I) = A(I) + I
7446 ENDDO
7447 @end smallexample
7448 is transformed to
7449 @smallexample
7450 DO I = 1, N
7451    A(I) = 0
7452 ENDDO
7453 DO I = 1, N
7454    B(I) = A(I) + I
7455 ENDDO
7456 @end smallexample
7457 and the initialization loop is transformed into a call to memset zero.
7459 @item -ftree-loop-im
7460 @opindex ftree-loop-im
7461 Perform loop invariant motion on trees.  This pass moves only invariants that
7462 are hard to handle at RTL level (function calls, operations that expand to
7463 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7464 operands of conditions that are invariant out of the loop, so that we can use
7465 just trivial invariantness analysis in loop unswitching.  The pass also includes
7466 store motion.
7468 @item -ftree-loop-ivcanon
7469 @opindex ftree-loop-ivcanon
7470 Create a canonical counter for number of iterations in loops for which
7471 determining number of iterations requires complicated analysis.  Later
7472 optimizations then may determine the number easily.  Useful especially
7473 in connection with unrolling.
7475 @item -fivopts
7476 @opindex fivopts
7477 Perform induction variable optimizations (strength reduction, induction
7478 variable merging and induction variable elimination) on trees.
7480 @item -ftree-parallelize-loops=n
7481 @opindex ftree-parallelize-loops
7482 Parallelize loops, i.e., split their iteration space to run in n threads.
7483 This is only possible for loops whose iterations are independent
7484 and can be arbitrarily reordered.  The optimization is only
7485 profitable on multiprocessor machines, for loops that are CPU-intensive,
7486 rather than constrained e.g.@: by memory bandwidth.  This option
7487 implies @option{-pthread}, and thus is only supported on targets
7488 that have support for @option{-pthread}.
7490 @item -ftree-pta
7491 @opindex ftree-pta
7492 Perform function-local points-to analysis on trees.  This flag is
7493 enabled by default at @option{-O} and higher.
7495 @item -ftree-sra
7496 @opindex ftree-sra
7497 Perform scalar replacement of aggregates.  This pass replaces structure
7498 references with scalars to prevent committing structures to memory too
7499 early.  This flag is enabled by default at @option{-O} and higher.
7501 @item -ftree-copyrename
7502 @opindex ftree-copyrename
7503 Perform copy renaming on trees.  This pass attempts to rename compiler
7504 temporaries to other variables at copy locations, usually resulting in
7505 variable names which more closely resemble the original variables.  This flag
7506 is enabled by default at @option{-O} and higher.
7508 @item -ftree-coalesce-inlined-vars
7509 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7510 combine small user-defined variables too, but only if they were inlined
7511 from other functions.  It is a more limited form of
7512 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7513 inlined variables, but it will keep variables of the inlined-into
7514 function apart from each other, such that they are more likely to
7515 contain the expected values in a debugging session.  This was the
7516 default in GCC versions older than 4.7.
7518 @item -ftree-coalesce-vars
7519 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7520 combine small user-defined variables too, instead of just compiler
7521 temporaries.  This may severely limit the ability to debug an optimized
7522 program compiled with @option{-fno-var-tracking-assignments}.  In the
7523 negated form, this flag prevents SSA coalescing of user variables,
7524 including inlined ones.  This option is enabled by default.
7526 @item -ftree-ter
7527 @opindex ftree-ter
7528 Perform temporary expression replacement during the SSA->normal phase.  Single
7529 use/single def temporaries are replaced at their use location with their
7530 defining expression.  This results in non-GIMPLE code, but gives the expanders
7531 much more complex trees to work on resulting in better RTL generation.  This is
7532 enabled by default at @option{-O} and higher.
7534 @item -ftree-slsr
7535 @opindex ftree-slsr
7536 Perform straight-line strength reduction on trees.  This recognizes related
7537 expressions involving multiplications and replaces them by less expensive
7538 calculations when possible.  This is enabled by default at @option{-O} and
7539 higher.
7541 @item -ftree-vectorize
7542 @opindex ftree-vectorize
7543 Perform loop vectorization on trees. This flag is enabled by default at
7544 @option{-O3}.
7546 @item -ftree-slp-vectorize
7547 @opindex ftree-slp-vectorize
7548 Perform basic block vectorization on trees. This flag is enabled by default at
7549 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7551 @item -ftree-vect-loop-version
7552 @opindex ftree-vect-loop-version
7553 Perform loop versioning when doing loop vectorization on trees.  When a loop
7554 appears to be vectorizable except that data alignment or data dependence cannot
7555 be determined at compile time, then vectorized and non-vectorized versions of
7556 the loop are generated along with run-time checks for alignment or dependence
7557 to control which version is executed.  This option is enabled by default
7558 except at level @option{-Os} where it is disabled.
7560 @item -fvect-cost-model
7561 @opindex fvect-cost-model
7562 Enable cost model for vectorization.  This option is enabled by default at
7563 @option{-O3}.
7565 @item -ftree-vrp
7566 @opindex ftree-vrp
7567 Perform Value Range Propagation on trees.  This is similar to the
7568 constant propagation pass, but instead of values, ranges of values are
7569 propagated.  This allows the optimizers to remove unnecessary range
7570 checks like array bound checks and null pointer checks.  This is
7571 enabled by default at @option{-O2} and higher.  Null pointer check
7572 elimination is only done if @option{-fdelete-null-pointer-checks} is
7573 enabled.
7575 @item -ftracer
7576 @opindex ftracer
7577 Perform tail duplication to enlarge superblock size.  This transformation
7578 simplifies the control flow of the function allowing other optimizations to do
7579 better job.
7581 @item -funroll-loops
7582 @opindex funroll-loops
7583 Unroll loops whose number of iterations can be determined at compile
7584 time or upon entry to the loop.  @option{-funroll-loops} implies
7585 @option{-frerun-cse-after-loop}.  This option makes code larger,
7586 and may or may not make it run faster.
7588 @item -funroll-all-loops
7589 @opindex funroll-all-loops
7590 Unroll all loops, even if their number of iterations is uncertain when
7591 the loop is entered.  This usually makes programs run more slowly.
7592 @option{-funroll-all-loops} implies the same options as
7593 @option{-funroll-loops},
7595 @item -fsplit-ivs-in-unroller
7596 @opindex fsplit-ivs-in-unroller
7597 Enables expressing of values of induction variables in later iterations
7598 of the unrolled loop using the value in the first iteration.  This breaks
7599 long dependency chains, thus improving efficiency of the scheduling passes.
7601 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7602 same effect.  However in cases the loop body is more complicated than
7603 a single basic block, this is not reliable.  It also does not work at all
7604 on some of the architectures due to restrictions in the CSE pass.
7606 This optimization is enabled by default.
7608 @item -fvariable-expansion-in-unroller
7609 @opindex fvariable-expansion-in-unroller
7610 With this option, the compiler creates multiple copies of some
7611 local variables when unrolling a loop, which can result in superior code.
7613 @item -fpartial-inlining
7614 @opindex fpartial-inlining
7615 Inline parts of functions.  This option has any effect only
7616 when inlining itself is turned on by the @option{-finline-functions}
7617 or @option{-finline-small-functions} options.
7619 Enabled at level @option{-O2}.
7621 @item -fpredictive-commoning
7622 @opindex fpredictive-commoning
7623 Perform predictive commoning optimization, i.e., reusing computations
7624 (especially memory loads and stores) performed in previous
7625 iterations of loops.
7627 This option is enabled at level @option{-O3}.
7629 @item -fprefetch-loop-arrays
7630 @opindex fprefetch-loop-arrays
7631 If supported by the target machine, generate instructions to prefetch
7632 memory to improve the performance of loops that access large arrays.
7634 This option may generate better or worse code; results are highly
7635 dependent on the structure of loops within the source code.
7637 Disabled at level @option{-Os}.
7639 @item -fno-peephole
7640 @itemx -fno-peephole2
7641 @opindex fno-peephole
7642 @opindex fno-peephole2
7643 Disable any machine-specific peephole optimizations.  The difference
7644 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7645 are implemented in the compiler; some targets use one, some use the
7646 other, a few use both.
7648 @option{-fpeephole} is enabled by default.
7649 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7651 @item -fno-guess-branch-probability
7652 @opindex fno-guess-branch-probability
7653 Do not guess branch probabilities using heuristics.
7655 GCC uses heuristics to guess branch probabilities if they are
7656 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7657 heuristics are based on the control flow graph.  If some branch probabilities
7658 are specified by @samp{__builtin_expect}, then the heuristics are
7659 used to guess branch probabilities for the rest of the control flow graph,
7660 taking the @samp{__builtin_expect} info into account.  The interactions
7661 between the heuristics and @samp{__builtin_expect} can be complex, and in
7662 some cases, it may be useful to disable the heuristics so that the effects
7663 of @samp{__builtin_expect} are easier to understand.
7665 The default is @option{-fguess-branch-probability} at levels
7666 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7668 @item -freorder-blocks
7669 @opindex freorder-blocks
7670 Reorder basic blocks in the compiled function in order to reduce number of
7671 taken branches and improve code locality.
7673 Enabled at levels @option{-O2}, @option{-O3}.
7675 @item -freorder-blocks-and-partition
7676 @opindex freorder-blocks-and-partition
7677 In addition to reordering basic blocks in the compiled function, in order
7678 to reduce number of taken branches, partitions hot and cold basic blocks
7679 into separate sections of the assembly and .o files, to improve
7680 paging and cache locality performance.
7682 This optimization is automatically turned off in the presence of
7683 exception handling, for linkonce sections, for functions with a user-defined
7684 section attribute and on any architecture that does not support named
7685 sections.
7687 @item -freorder-functions
7688 @opindex freorder-functions
7689 Reorder functions in the object file in order to
7690 improve code locality.  This is implemented by using special
7691 subsections @code{.text.hot} for most frequently executed functions and
7692 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7693 the linker so object file format must support named sections and linker must
7694 place them in a reasonable way.
7696 Also profile feedback must be available in to make this option effective.  See
7697 @option{-fprofile-arcs} for details.
7699 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7701 @item -fstrict-aliasing
7702 @opindex fstrict-aliasing
7703 Allow the compiler to assume the strictest aliasing rules applicable to
7704 the language being compiled.  For C (and C++), this activates
7705 optimizations based on the type of expressions.  In particular, an
7706 object of one type is assumed never to reside at the same address as an
7707 object of a different type, unless the types are almost the same.  For
7708 example, an @code{unsigned int} can alias an @code{int}, but not a
7709 @code{void*} or a @code{double}.  A character type may alias any other
7710 type.
7712 @anchor{Type-punning}Pay special attention to code like this:
7713 @smallexample
7714 union a_union @{
7715   int i;
7716   double d;
7719 int f() @{
7720   union a_union t;
7721   t.d = 3.0;
7722   return t.i;
7724 @end smallexample
7725 The practice of reading from a different union member than the one most
7726 recently written to (called ``type-punning'') is common.  Even with
7727 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7728 is accessed through the union type.  So, the code above works as
7729 expected.  @xref{Structures unions enumerations and bit-fields
7730 implementation}.  However, this code might not:
7731 @smallexample
7732 int f() @{
7733   union a_union t;
7734   int* ip;
7735   t.d = 3.0;
7736   ip = &t.i;
7737   return *ip;
7739 @end smallexample
7741 Similarly, access by taking the address, casting the resulting pointer
7742 and dereferencing the result has undefined behavior, even if the cast
7743 uses a union type, e.g.:
7744 @smallexample
7745 int f() @{
7746   double d = 3.0;
7747   return ((union a_union *) &d)->i;
7749 @end smallexample
7751 The @option{-fstrict-aliasing} option is enabled at levels
7752 @option{-O2}, @option{-O3}, @option{-Os}.
7754 @item -fstrict-overflow
7755 @opindex fstrict-overflow
7756 Allow the compiler to assume strict signed overflow rules, depending
7757 on the language being compiled.  For C (and C++) this means that
7758 overflow when doing arithmetic with signed numbers is undefined, which
7759 means that the compiler may assume that it does not happen.  This
7760 permits various optimizations.  For example, the compiler assumes
7761 that an expression like @code{i + 10 > i} is always true for
7762 signed @code{i}.  This assumption is only valid if signed overflow is
7763 undefined, as the expression is false if @code{i + 10} overflows when
7764 using twos complement arithmetic.  When this option is in effect any
7765 attempt to determine whether an operation on signed numbers 
7766 overflows must be written carefully to not actually involve overflow.
7768 This option also allows the compiler to assume strict pointer
7769 semantics: given a pointer to an object, if adding an offset to that
7770 pointer does not produce a pointer to the same object, the addition is
7771 undefined.  This permits the compiler to conclude that @code{p + u >
7772 p} is always true for a pointer @code{p} and unsigned integer
7773 @code{u}.  This assumption is only valid because pointer wraparound is
7774 undefined, as the expression is false if @code{p + u} overflows using
7775 twos complement arithmetic.
7777 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7778 that integer signed overflow is fully defined: it wraps.  When
7779 @option{-fwrapv} is used, there is no difference between
7780 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7781 integers.  With @option{-fwrapv} certain types of overflow are
7782 permitted.  For example, if the compiler gets an overflow when doing
7783 arithmetic on constants, the overflowed value can still be used with
7784 @option{-fwrapv}, but not otherwise.
7786 The @option{-fstrict-overflow} option is enabled at levels
7787 @option{-O2}, @option{-O3}, @option{-Os}.
7789 @item -falign-functions
7790 @itemx -falign-functions=@var{n}
7791 @opindex falign-functions
7792 Align the start of functions to the next power-of-two greater than
7793 @var{n}, skipping up to @var{n} bytes.  For instance,
7794 @option{-falign-functions=32} aligns functions to the next 32-byte
7795 boundary, but @option{-falign-functions=24} aligns to the next
7796 32-byte boundary only if this can be done by skipping 23 bytes or less.
7798 @option{-fno-align-functions} and @option{-falign-functions=1} are
7799 equivalent and mean that functions are not aligned.
7801 Some assemblers only support this flag when @var{n} is a power of two;
7802 in that case, it is rounded up.
7804 If @var{n} is not specified or is zero, use a machine-dependent default.
7806 Enabled at levels @option{-O2}, @option{-O3}.
7808 @item -falign-labels
7809 @itemx -falign-labels=@var{n}
7810 @opindex falign-labels
7811 Align all branch targets to a power-of-two boundary, skipping up to
7812 @var{n} bytes like @option{-falign-functions}.  This option can easily
7813 make code slower, because it must insert dummy operations for when the
7814 branch target is reached in the usual flow of the code.
7816 @option{-fno-align-labels} and @option{-falign-labels=1} are
7817 equivalent and mean that labels are not aligned.
7819 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7820 are greater than this value, then their values are used instead.
7822 If @var{n} is not specified or is zero, use a machine-dependent default
7823 which is very likely to be @samp{1}, meaning no alignment.
7825 Enabled at levels @option{-O2}, @option{-O3}.
7827 @item -falign-loops
7828 @itemx -falign-loops=@var{n}
7829 @opindex falign-loops
7830 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7831 like @option{-falign-functions}.  If the loops are
7832 executed many times, this makes up for any execution of the dummy
7833 operations.
7835 @option{-fno-align-loops} and @option{-falign-loops=1} are
7836 equivalent and mean that loops are not aligned.
7838 If @var{n} is not specified or is zero, use a machine-dependent default.
7840 Enabled at levels @option{-O2}, @option{-O3}.
7842 @item -falign-jumps
7843 @itemx -falign-jumps=@var{n}
7844 @opindex falign-jumps
7845 Align branch targets to a power-of-two boundary, for branch targets
7846 where the targets can only be reached by jumping, skipping up to @var{n}
7847 bytes like @option{-falign-functions}.  In this case, no dummy operations
7848 need be executed.
7850 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7851 equivalent and mean that loops are not aligned.
7853 If @var{n} is not specified or is zero, use a machine-dependent default.
7855 Enabled at levels @option{-O2}, @option{-O3}.
7857 @item -funit-at-a-time
7858 @opindex funit-at-a-time
7859 This option is left for compatibility reasons. @option{-funit-at-a-time}
7860 has no effect, while @option{-fno-unit-at-a-time} implies
7861 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7863 Enabled by default.
7865 @item -fno-toplevel-reorder
7866 @opindex fno-toplevel-reorder
7867 Do not reorder top-level functions, variables, and @code{asm}
7868 statements.  Output them in the same order that they appear in the
7869 input file.  When this option is used, unreferenced static variables
7870 are not removed.  This option is intended to support existing code
7871 that relies on a particular ordering.  For new code, it is better to
7872 use attributes.
7874 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
7875 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7876 targets.
7878 @item -fweb
7879 @opindex fweb
7880 Constructs webs as commonly used for register allocation purposes and assign
7881 each web individual pseudo register.  This allows the register allocation pass
7882 to operate on pseudos directly, but also strengthens several other optimization
7883 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7884 however, make debugging impossible, since variables no longer stay in a
7885 ``home register''.
7887 Enabled by default with @option{-funroll-loops}.
7889 @item -fwhole-program
7890 @opindex fwhole-program
7891 Assume that the current compilation unit represents the whole program being
7892 compiled.  All public functions and variables with the exception of @code{main}
7893 and those merged by attribute @code{externally_visible} become static functions
7894 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.
7895 While this option is equivalent to proper use of the @code{static} keyword for
7896 programs consisting of a single file, in combination with option
7897 @option{-flto} this flag can be used to
7898 compile many smaller scale programs since the functions and variables become
7899 local for the whole combined compilation unit, not for the single source file
7900 itself.
7902 This option implies @option{-fwhole-file} for Fortran programs.
7904 @item -flto[=@var{n}]
7905 @opindex flto
7906 This option runs the standard link-time optimizer.  When invoked
7907 with source code, it generates GIMPLE (one of GCC's internal
7908 representations) and writes it to special ELF sections in the object
7909 file.  When the object files are linked together, all the function
7910 bodies are read from these ELF sections and instantiated as if they
7911 had been part of the same translation unit.
7913 To use the link-time optimizer, @option{-flto} needs to be specified at
7914 compile time and during the final link.  For example:
7916 @smallexample
7917 gcc -c -O2 -flto foo.c
7918 gcc -c -O2 -flto bar.c
7919 gcc -o myprog -flto -O2 foo.o bar.o
7920 @end smallexample
7922 The first two invocations to GCC save a bytecode representation
7923 of GIMPLE into special ELF sections inside @file{foo.o} and
7924 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
7925 @file{foo.o} and @file{bar.o}, merges the two files into a single
7926 internal image, and compiles the result as usual.  Since both
7927 @file{foo.o} and @file{bar.o} are merged into a single image, this
7928 causes all the interprocedural analyses and optimizations in GCC to
7929 work across the two files as if they were a single one.  This means,
7930 for example, that the inliner is able to inline functions in
7931 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7933 Another (simpler) way to enable link-time optimization is:
7935 @smallexample
7936 gcc -o myprog -flto -O2 foo.c bar.c
7937 @end smallexample
7939 The above generates bytecode for @file{foo.c} and @file{bar.c},
7940 merges them together into a single GIMPLE representation and optimizes
7941 them as usual to produce @file{myprog}.
7943 The only important thing to keep in mind is that to enable link-time
7944 optimizations the @option{-flto} flag needs to be passed to both the
7945 compile and the link commands.
7947 To make whole program optimization effective, it is necessary to make
7948 certain whole program assumptions.  The compiler needs to know
7949 what functions and variables can be accessed by libraries and runtime
7950 outside of the link-time optimized unit.  When supported by the linker,
7951 the linker plugin (see @option{-fuse-linker-plugin}) passes information
7952 to the compiler about used and externally visible symbols.  When
7953 the linker plugin is not available, @option{-fwhole-program} should be
7954 used to allow the compiler to make these assumptions, which leads
7955 to more aggressive optimization decisions.
7957 Note that when a file is compiled with @option{-flto}, the generated
7958 object file is larger than a regular object file because it 
7959 contains GIMPLE bytecodes and the usual final code.  This means that
7960 object files with LTO information can be linked as normal object
7961 files; if @option{-flto} is not passed to the linker, no
7962 interprocedural optimizations are applied.
7964 Additionally, the optimization flags used to compile individual files
7965 are not necessarily related to those used at link time.  For instance,
7967 @smallexample
7968 gcc -c -O0 -flto foo.c
7969 gcc -c -O0 -flto bar.c
7970 gcc -o myprog -flto -O3 foo.o bar.o
7971 @end smallexample
7973 This produces individual object files with unoptimized assembler
7974 code, but the resulting binary @file{myprog} is optimized at
7975 @option{-O3}.  If, instead, the final binary is generated without
7976 @option{-flto}, then @file{myprog} is not optimized.
7978 When producing the final binary with @option{-flto}, GCC only
7979 applies link-time optimizations to those files that contain bytecode.
7980 Therefore, you can mix and match object files and libraries with
7981 GIMPLE bytecodes and final object code.  GCC automatically selects
7982 which files to optimize in LTO mode and which files to link without
7983 further processing.
7985 There are some code generation flags preserved by GCC when
7986 generating bytecodes, as they need to be used during the final link
7987 stage.  Currently, the following options are saved into the GIMPLE
7988 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7989 @option{-m} target flags.
7991 At link time, these options are read in and reapplied.  Note that the
7992 current implementation makes no attempt to recognize conflicting
7993 values for these options.  If different files have conflicting option
7994 values (e.g., one file is compiled with @option{-fPIC} and another
7995 isn't), the compiler simply uses the last value read from the
7996 bytecode files.  It is recommended, then, that you compile all the files
7997 participating in the same link with the same options.
7999 If LTO encounters objects with C linkage declared with incompatible
8000 types in separate translation units to be linked together (undefined
8001 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8002 issued.  The behavior is still undefined at run time.
8004 Another feature of LTO is that it is possible to apply interprocedural
8005 optimizations on files written in different languages.  This requires
8006 support in the language front end.  Currently, the C, C++ and
8007 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8008 something like this should work:
8010 @smallexample
8011 gcc -c -flto foo.c
8012 g++ -c -flto bar.cc
8013 gfortran -c -flto baz.f90
8014 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8015 @end smallexample
8017 Notice that the final link is done with @command{g++} to get the C++
8018 runtime libraries and @option{-lgfortran} is added to get the Fortran
8019 runtime libraries.  In general, when mixing languages in LTO mode, you
8020 should use the same link command options as when mixing languages in a
8021 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8022 all the compile and link commands.
8024 If object files containing GIMPLE bytecode are stored in a library archive, say
8025 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8026 are using a linker with plugin support.  To enable this feature, use
8027 the flag @option{-fuse-linker-plugin} at link time:
8029 @smallexample
8030 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8031 @end smallexample
8033 With the linker plugin enabled, the linker extracts the needed
8034 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8035 to make them part of the aggregated GIMPLE image to be optimized.
8037 If you are not using a linker with plugin support and/or do not
8038 enable the linker plugin, then the objects inside @file{libfoo.a}
8039 are extracted and linked as usual, but they do not participate
8040 in the LTO optimization process.
8042 Link-time optimizations do not require the presence of the whole program to
8043 operate.  If the program does not require any symbols to be exported, it is
8044 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8045 the interprocedural optimizers to use more aggressive assumptions which may
8046 lead to improved optimization opportunities.
8047 Use of @option{-fwhole-program} is not needed when linker plugin is
8048 active (see @option{-fuse-linker-plugin}).
8050 The current implementation of LTO makes no
8051 attempt to generate bytecode that is portable between different
8052 types of hosts.  The bytecode files are versioned and there is a
8053 strict version check, so bytecode files generated in one version of
8054 GCC will not work with an older/newer version of GCC@.
8056 Link-time optimization does not work well with generation of debugging
8057 information.  Combining @option{-flto} with
8058 @option{-g} is currently experimental and expected to produce wrong
8059 results.
8061 If you specify the optional @var{n}, the optimization and code
8062 generation done at link time is executed in parallel using @var{n}
8063 parallel jobs by utilizing an installed @command{make} program.  The
8064 environment variable @env{MAKE} may be used to override the program
8065 used.  The default value for @var{n} is 1.
8067 You can also specify @option{-flto=jobserver} to use GNU make's
8068 job server mode to determine the number of parallel jobs. This
8069 is useful when the Makefile calling GCC is already executing in parallel.
8070 You must prepend a @samp{+} to the command recipe in the parent Makefile
8071 for this to work.  This option likely only works if @env{MAKE} is
8072 GNU make.
8074 This option is disabled by default
8076 @item -flto-partition=@var{alg}
8077 @opindex flto-partition
8078 Specify the partitioning algorithm used by the link-time optimizer.
8079 The value is either @code{1to1} to specify a partitioning mirroring
8080 the original source files or @code{balanced} to specify partitioning
8081 into equally sized chunks (whenever possible).  Specifying @code{none}
8082 as an algorithm disables partitioning and streaming completely. The
8083 default value is @code{balanced}.
8085 @item -flto-compression-level=@var{n}
8086 This option specifies the level of compression used for intermediate
8087 language written to LTO object files, and is only meaningful in
8088 conjunction with LTO mode (@option{-flto}).  Valid
8089 values are 0 (no compression) to 9 (maximum compression).  Values
8090 outside this range are clamped to either 0 or 9.  If the option is not
8091 given, a default balanced compression setting is used.
8093 @item -flto-report
8094 Prints a report with internal details on the workings of the link-time
8095 optimizer.  The contents of this report vary from version to version.
8096 It is meant to be useful to GCC developers when processing object
8097 files in LTO mode (via @option{-flto}).
8099 Disabled by default.
8101 @item -fuse-linker-plugin
8102 Enables the use of a linker plugin during link-time optimization.  This
8103 option relies on plugin support in the linker, which is available in gold
8104 or in GNU ld 2.21 or newer.
8106 This option enables the extraction of object files with GIMPLE bytecode out
8107 of library archives. This improves the quality of optimization by exposing
8108 more code to the link-time optimizer.  This information specifies what
8109 symbols can be accessed externally (by non-LTO object or during dynamic
8110 linking).  Resulting code quality improvements on binaries (and shared
8111 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8112 See @option{-flto} for a description of the effect of this flag and how to
8113 use it.
8115 This option is enabled by default when LTO support in GCC is enabled
8116 and GCC was configured for use with
8117 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8119 @item -ffat-lto-objects
8120 @opindex ffat-lto-objects
8121 Fat LTO objects are object files that contain both the intermediate language
8122 and the object code. This makes them usable for both LTO linking and normal
8123 linking. This option is effective only when compiling with @option{-flto}
8124 and is ignored at link time.
8126 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8127 requires the complete toolchain to be aware of LTO. It requires a linker with
8128 linker plugin support for basic functionality.  Additionally,
8129 @command{nm}, @command{ar} and @command{ranlib}
8130 need to support linker plugins to allow a full-featured build environment
8131 (capable of building static libraries etc).
8133 The default is @option{-ffat-lto-objects} but this default is intended to
8134 change in future releases when linker plugin enabled environments become more
8135 common.
8137 @item -fcompare-elim
8138 @opindex fcompare-elim
8139 After register allocation and post-register allocation instruction splitting,
8140 identify arithmetic instructions that compute processor flags similar to a
8141 comparison operation based on that arithmetic.  If possible, eliminate the
8142 explicit comparison operation.
8144 This pass only applies to certain targets that cannot explicitly represent
8145 the comparison operation before register allocation is complete.
8147 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8149 @item -fcprop-registers
8150 @opindex fcprop-registers
8151 After register allocation and post-register allocation instruction splitting,
8152 we perform a copy-propagation pass to try to reduce scheduling dependencies
8153 and occasionally eliminate the copy.
8155 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8157 @item -fprofile-correction
8158 @opindex fprofile-correction
8159 Profiles collected using an instrumented binary for multi-threaded programs may
8160 be inconsistent due to missed counter updates. When this option is specified,
8161 GCC uses heuristics to correct or smooth out such inconsistencies. By
8162 default, GCC emits an error message when an inconsistent profile is detected.
8164 @item -fprofile-dir=@var{path}
8165 @opindex fprofile-dir
8167 Set the directory to search for the profile data files in to @var{path}.
8168 This option affects only the profile data generated by
8169 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8170 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8171 and its related options.  Both absolute and relative paths can be used.
8172 By default, GCC uses the current directory as @var{path}, thus the
8173 profile data file appears in the same directory as the object file.
8175 @item -fprofile-generate
8176 @itemx -fprofile-generate=@var{path}
8177 @opindex fprofile-generate
8179 Enable options usually used for instrumenting application to produce
8180 profile useful for later recompilation with profile feedback based
8181 optimization.  You must use @option{-fprofile-generate} both when
8182 compiling and when linking your program.
8184 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8186 If @var{path} is specified, GCC looks at the @var{path} to find
8187 the profile feedback data files. See @option{-fprofile-dir}.
8189 @item -fprofile-use
8190 @itemx -fprofile-use=@var{path}
8191 @opindex fprofile-use
8192 Enable profile feedback directed optimizations, and optimizations
8193 generally profitable only with profile feedback available.
8195 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8196 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8198 By default, GCC emits an error message if the feedback profiles do not
8199 match the source code.  This error can be turned into a warning by using
8200 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8201 code.
8203 If @var{path} is specified, GCC looks at the @var{path} to find
8204 the profile feedback data files. See @option{-fprofile-dir}.
8205 @end table
8207 The following options control compiler behavior regarding floating-point 
8208 arithmetic.  These options trade off between speed and
8209 correctness.  All must be specifically enabled.
8211 @table @gcctabopt
8212 @item -ffloat-store
8213 @opindex ffloat-store
8214 Do not store floating-point variables in registers, and inhibit other
8215 options that might change whether a floating-point value is taken from a
8216 register or memory.
8218 @cindex floating-point precision
8219 This option prevents undesirable excess precision on machines such as
8220 the 68000 where the floating registers (of the 68881) keep more
8221 precision than a @code{double} is supposed to have.  Similarly for the
8222 x86 architecture.  For most programs, the excess precision does only
8223 good, but a few programs rely on the precise definition of IEEE floating
8224 point.  Use @option{-ffloat-store} for such programs, after modifying
8225 them to store all pertinent intermediate computations into variables.
8227 @item -fexcess-precision=@var{style}
8228 @opindex fexcess-precision
8229 This option allows further control over excess precision on machines
8230 where floating-point registers have more precision than the IEEE
8231 @code{float} and @code{double} types and the processor does not
8232 support operations rounding to those types.  By default,
8233 @option{-fexcess-precision=fast} is in effect; this means that
8234 operations are carried out in the precision of the registers and that
8235 it is unpredictable when rounding to the types specified in the source
8236 code takes place.  When compiling C, if
8237 @option{-fexcess-precision=standard} is specified then excess
8238 precision follows the rules specified in ISO C99; in particular,
8239 both casts and assignments cause values to be rounded to their
8240 semantic types (whereas @option{-ffloat-store} only affects
8241 assignments).  This option is enabled by default for C if a strict
8242 conformance option such as @option{-std=c99} is used.
8244 @opindex mfpmath
8245 @option{-fexcess-precision=standard} is not implemented for languages
8246 other than C, and has no effect if
8247 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8248 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8249 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8250 semantics apply without excess precision, and in the latter, rounding
8251 is unpredictable.
8253 @item -ffast-math
8254 @opindex ffast-math
8255 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8256 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8257 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8259 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8261 This option is not turned on by any @option{-O} option besides
8262 @option{-Ofast} since it can result in incorrect output for programs
8263 that depend on an exact implementation of IEEE or ISO rules/specifications
8264 for math functions. It may, however, yield faster code for programs
8265 that do not require the guarantees of these specifications.
8267 @item -fno-math-errno
8268 @opindex fno-math-errno
8269 Do not set @code{errno} after calling math functions that are executed
8270 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8271 IEEE exceptions for math error handling may want to use this flag
8272 for speed while maintaining IEEE arithmetic compatibility.
8274 This option is not turned on by any @option{-O} option since
8275 it can result in incorrect output for programs that depend on
8276 an exact implementation of IEEE or ISO rules/specifications for
8277 math functions. It may, however, yield faster code for programs
8278 that do not require the guarantees of these specifications.
8280 The default is @option{-fmath-errno}.
8282 On Darwin systems, the math library never sets @code{errno}.  There is
8283 therefore no reason for the compiler to consider the possibility that
8284 it might, and @option{-fno-math-errno} is the default.
8286 @item -funsafe-math-optimizations
8287 @opindex funsafe-math-optimizations
8289 Allow optimizations for floating-point arithmetic that (a) assume
8290 that arguments and results are valid and (b) may violate IEEE or
8291 ANSI standards.  When used at link-time, it may include libraries
8292 or startup files that change the default FPU control word or other
8293 similar optimizations.
8295 This option is not turned on by any @option{-O} option since
8296 it can result in incorrect output for programs that depend on
8297 an exact implementation of IEEE or ISO rules/specifications for
8298 math functions. It may, however, yield faster code for programs
8299 that do not require the guarantees of these specifications.
8300 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8301 @option{-fassociative-math} and @option{-freciprocal-math}.
8303 The default is @option{-fno-unsafe-math-optimizations}.
8305 @item -fassociative-math
8306 @opindex fassociative-math
8308 Allow re-association of operands in series of floating-point operations.
8309 This violates the ISO C and C++ language standard by possibly changing
8310 computation result.  NOTE: re-ordering may change the sign of zero as
8311 well as ignore NaNs and inhibit or create underflow or overflow (and
8312 thus cannot be used on code that relies on rounding behavior like
8313 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8314 and thus may not be used when ordered comparisons are required.
8315 This option requires that both @option{-fno-signed-zeros} and
8316 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8317 much sense with @option{-frounding-math}. For Fortran the option
8318 is automatically enabled when both @option{-fno-signed-zeros} and
8319 @option{-fno-trapping-math} are in effect.
8321 The default is @option{-fno-associative-math}.
8323 @item -freciprocal-math
8324 @opindex freciprocal-math
8326 Allow the reciprocal of a value to be used instead of dividing by
8327 the value if this enables optimizations.  For example @code{x / y}
8328 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8329 is subject to common subexpression elimination.  Note that this loses
8330 precision and increases the number of flops operating on the value.
8332 The default is @option{-fno-reciprocal-math}.
8334 @item -ffinite-math-only
8335 @opindex ffinite-math-only
8336 Allow optimizations for floating-point arithmetic that assume
8337 that arguments and results are not NaNs or +-Infs.
8339 This option is not turned on by any @option{-O} option since
8340 it can result in incorrect output for programs that depend on
8341 an exact implementation of IEEE or ISO rules/specifications for
8342 math functions. It may, however, yield faster code for programs
8343 that do not require the guarantees of these specifications.
8345 The default is @option{-fno-finite-math-only}.
8347 @item -fno-signed-zeros
8348 @opindex fno-signed-zeros
8349 Allow optimizations for floating-point arithmetic that ignore the
8350 signedness of zero.  IEEE arithmetic specifies the behavior of
8351 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8352 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8353 This option implies that the sign of a zero result isn't significant.
8355 The default is @option{-fsigned-zeros}.
8357 @item -fno-trapping-math
8358 @opindex fno-trapping-math
8359 Compile code assuming that floating-point operations cannot generate
8360 user-visible traps.  These traps include division by zero, overflow,
8361 underflow, inexact result and invalid operation.  This option requires
8362 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8363 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8365 This option should never be turned on by any @option{-O} option since
8366 it can result in incorrect output for programs that depend on
8367 an exact implementation of IEEE or ISO rules/specifications for
8368 math functions.
8370 The default is @option{-ftrapping-math}.
8372 @item -frounding-math
8373 @opindex frounding-math
8374 Disable transformations and optimizations that assume default floating-point
8375 rounding behavior.  This is round-to-zero for all floating point
8376 to integer conversions, and round-to-nearest for all other arithmetic
8377 truncations.  This option should be specified for programs that change
8378 the FP rounding mode dynamically, or that may be executed with a
8379 non-default rounding mode.  This option disables constant folding of
8380 floating-point expressions at compile time (which may be affected by
8381 rounding mode) and arithmetic transformations that are unsafe in the
8382 presence of sign-dependent rounding modes.
8384 The default is @option{-fno-rounding-math}.
8386 This option is experimental and does not currently guarantee to
8387 disable all GCC optimizations that are affected by rounding mode.
8388 Future versions of GCC may provide finer control of this setting
8389 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8390 will be used to specify the default state for @code{FENV_ACCESS}.
8392 @item -fsignaling-nans
8393 @opindex fsignaling-nans
8394 Compile code assuming that IEEE signaling NaNs may generate user-visible
8395 traps during floating-point operations.  Setting this option disables
8396 optimizations that may change the number of exceptions visible with
8397 signaling NaNs.  This option implies @option{-ftrapping-math}.
8399 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8400 be defined.
8402 The default is @option{-fno-signaling-nans}.
8404 This option is experimental and does not currently guarantee to
8405 disable all GCC optimizations that affect signaling NaN behavior.
8407 @item -fsingle-precision-constant
8408 @opindex fsingle-precision-constant
8409 Treat floating-point constants as single precision instead of
8410 implicitly converting them to double-precision constants.
8412 @item -fcx-limited-range
8413 @opindex fcx-limited-range
8414 When enabled, this option states that a range reduction step is not
8415 needed when performing complex division.  Also, there is no checking
8416 whether the result of a complex multiplication or division is @code{NaN
8417 + I*NaN}, with an attempt to rescue the situation in that case.  The
8418 default is @option{-fno-cx-limited-range}, but is enabled by
8419 @option{-ffast-math}.
8421 This option controls the default setting of the ISO C99
8422 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8423 all languages.
8425 @item -fcx-fortran-rules
8426 @opindex fcx-fortran-rules
8427 Complex multiplication and division follow Fortran rules.  Range
8428 reduction is done as part of complex division, but there is no checking
8429 whether the result of a complex multiplication or division is @code{NaN
8430 + I*NaN}, with an attempt to rescue the situation in that case.
8432 The default is @option{-fno-cx-fortran-rules}.
8434 @end table
8436 The following options control optimizations that may improve
8437 performance, but are not enabled by any @option{-O} options.  This
8438 section includes experimental options that may produce broken code.
8440 @table @gcctabopt
8441 @item -fbranch-probabilities
8442 @opindex fbranch-probabilities
8443 After running a program compiled with @option{-fprofile-arcs}
8444 (@pxref{Debugging Options,, Options for Debugging Your Program or
8445 @command{gcc}}), you can compile it a second time using
8446 @option{-fbranch-probabilities}, to improve optimizations based on
8447 the number of times each branch was taken.  When the program
8448 compiled with @option{-fprofile-arcs} exits it saves arc execution
8449 counts to a file called @file{@var{sourcename}.gcda} for each source
8450 file.  The information in this data file is very dependent on the
8451 structure of the generated code, so you must use the same source code
8452 and the same optimization options for both compilations.
8454 With @option{-fbranch-probabilities}, GCC puts a
8455 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8456 These can be used to improve optimization.  Currently, they are only
8457 used in one place: in @file{reorg.c}, instead of guessing which path a
8458 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8459 exactly determine which path is taken more often.
8461 @item -fprofile-values
8462 @opindex fprofile-values
8463 If combined with @option{-fprofile-arcs}, it adds code so that some
8464 data about values of expressions in the program is gathered.
8466 With @option{-fbranch-probabilities}, it reads back the data gathered
8467 from profiling values of expressions for usage in optimizations.
8469 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8471 @item -fvpt
8472 @opindex fvpt
8473 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8474 a code to gather information about values of expressions.
8476 With @option{-fbranch-probabilities}, it reads back the data gathered
8477 and actually performs the optimizations based on them.
8478 Currently the optimizations include specialization of division operation
8479 using the knowledge about the value of the denominator.
8481 @item -frename-registers
8482 @opindex frename-registers
8483 Attempt to avoid false dependencies in scheduled code by making use
8484 of registers left over after register allocation.  This optimization
8485 most benefits processors with lots of registers.  Depending on the
8486 debug information format adopted by the target, however, it can
8487 make debugging impossible, since variables no longer stay in
8488 a ``home register''.
8490 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8492 @item -ftracer
8493 @opindex ftracer
8494 Perform tail duplication to enlarge superblock size.  This transformation
8495 simplifies the control flow of the function allowing other optimizations to do
8496 better job.
8498 Enabled with @option{-fprofile-use}.
8500 @item -funroll-loops
8501 @opindex funroll-loops
8502 Unroll loops whose number of iterations can be determined at compile time or
8503 upon entry to the loop.  @option{-funroll-loops} implies
8504 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8505 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8506 small constant number of iterations).  This option makes code larger, and may
8507 or may not make it run faster.
8509 Enabled with @option{-fprofile-use}.
8511 @item -funroll-all-loops
8512 @opindex funroll-all-loops
8513 Unroll all loops, even if their number of iterations is uncertain when
8514 the loop is entered.  This usually makes programs run more slowly.
8515 @option{-funroll-all-loops} implies the same options as
8516 @option{-funroll-loops}.
8518 @item -fpeel-loops
8519 @opindex fpeel-loops
8520 Peels loops for which there is enough information that they do not
8521 roll much (from profile feedback).  It also turns on complete loop peeling
8522 (i.e.@: complete removal of loops with small constant number of iterations).
8524 Enabled with @option{-fprofile-use}.
8526 @item -fmove-loop-invariants
8527 @opindex fmove-loop-invariants
8528 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8529 at level @option{-O1}
8531 @item -funswitch-loops
8532 @opindex funswitch-loops
8533 Move branches with loop invariant conditions out of the loop, with duplicates
8534 of the loop on both branches (modified according to result of the condition).
8536 @item -ffunction-sections
8537 @itemx -fdata-sections
8538 @opindex ffunction-sections
8539 @opindex fdata-sections
8540 Place each function or data item into its own section in the output
8541 file if the target supports arbitrary sections.  The name of the
8542 function or the name of the data item determines the section's name
8543 in the output file.
8545 Use these options on systems where the linker can perform optimizations
8546 to improve locality of reference in the instruction space.  Most systems
8547 using the ELF object format and SPARC processors running Solaris 2 have
8548 linkers with such optimizations.  AIX may have these optimizations in
8549 the future.
8551 Only use these options when there are significant benefits from doing
8552 so.  When you specify these options, the assembler and linker
8553 create larger object and executable files and are also slower.
8554 You cannot use @code{gprof} on all systems if you
8555 specify this option, and you may have problems with debugging if
8556 you specify both this option and @option{-g}.
8558 @item -fbranch-target-load-optimize
8559 @opindex fbranch-target-load-optimize
8560 Perform branch target register load optimization before prologue / epilogue
8561 threading.
8562 The use of target registers can typically be exposed only during reload,
8563 thus hoisting loads out of loops and doing inter-block scheduling needs
8564 a separate optimization pass.
8566 @item -fbranch-target-load-optimize2
8567 @opindex fbranch-target-load-optimize2
8568 Perform branch target register load optimization after prologue / epilogue
8569 threading.
8571 @item -fbtr-bb-exclusive
8572 @opindex fbtr-bb-exclusive
8573 When performing branch target register load optimization, don't reuse
8574 branch target registers in within any basic block.
8576 @item -fstack-protector
8577 @opindex fstack-protector
8578 Emit extra code to check for buffer overflows, such as stack smashing
8579 attacks.  This is done by adding a guard variable to functions with
8580 vulnerable objects.  This includes functions that call @code{alloca}, and
8581 functions with buffers larger than 8 bytes.  The guards are initialized
8582 when a function is entered and then checked when the function exits.
8583 If a guard check fails, an error message is printed and the program exits.
8585 @item -fstack-protector-all
8586 @opindex fstack-protector-all
8587 Like @option{-fstack-protector} except that all functions are protected.
8589 @item -fsection-anchors
8590 @opindex fsection-anchors
8591 Try to reduce the number of symbolic address calculations by using
8592 shared ``anchor'' symbols to address nearby objects.  This transformation
8593 can help to reduce the number of GOT entries and GOT accesses on some
8594 targets.
8596 For example, the implementation of the following function @code{foo}:
8598 @smallexample
8599 static int a, b, c;
8600 int foo (void) @{ return a + b + c; @}
8601 @end smallexample
8603 @noindent
8604 usually calculates the addresses of all three variables, but if you
8605 compile it with @option{-fsection-anchors}, it accesses the variables
8606 from a common anchor point instead.  The effect is similar to the
8607 following pseudocode (which isn't valid C):
8609 @smallexample
8610 int foo (void)
8612   register int *xr = &x;
8613   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8615 @end smallexample
8617 Not all targets support this option.
8619 @item --param @var{name}=@var{value}
8620 @opindex param
8621 In some places, GCC uses various constants to control the amount of
8622 optimization that is done.  For example, GCC does not inline functions
8623 that contain more than a certain number of instructions.  You can
8624 control some of these constants on the command line using the
8625 @option{--param} option.
8627 The names of specific parameters, and the meaning of the values, are
8628 tied to the internals of the compiler, and are subject to change
8629 without notice in future releases.
8631 In each case, the @var{value} is an integer.  The allowable choices for
8632 @var{name} are given in the following table:
8634 @table @gcctabopt
8635 @item predictable-branch-outcome
8636 When branch is predicted to be taken with probability lower than this threshold
8637 (in percent), then it is considered well predictable. The default is 10.
8639 @item max-crossjump-edges
8640 The maximum number of incoming edges to consider for crossjumping.
8641 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8642 the number of edges incoming to each block.  Increasing values mean
8643 more aggressive optimization, making the compilation time increase with
8644 probably small improvement in executable size.
8646 @item min-crossjump-insns
8647 The minimum number of instructions that must be matched at the end
8648 of two blocks before crossjumping is performed on them.  This
8649 value is ignored in the case where all instructions in the block being
8650 crossjumped from are matched.  The default value is 5.
8652 @item max-grow-copy-bb-insns
8653 The maximum code size expansion factor when copying basic blocks
8654 instead of jumping.  The expansion is relative to a jump instruction.
8655 The default value is 8.
8657 @item max-goto-duplication-insns
8658 The maximum number of instructions to duplicate to a block that jumps
8659 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8660 passes, GCC factors computed gotos early in the compilation process,
8661 and unfactors them as late as possible.  Only computed jumps at the
8662 end of a basic blocks with no more than max-goto-duplication-insns are
8663 unfactored.  The default value is 8.
8665 @item max-delay-slot-insn-search
8666 The maximum number of instructions to consider when looking for an
8667 instruction to fill a delay slot.  If more than this arbitrary number of
8668 instructions are searched, the time savings from filling the delay slot
8669 are minimal, so stop searching.  Increasing values mean more
8670 aggressive optimization, making the compilation time increase with probably
8671 small improvement in execution time.
8673 @item max-delay-slot-live-search
8674 When trying to fill delay slots, the maximum number of instructions to
8675 consider when searching for a block with valid live register
8676 information.  Increasing this arbitrarily chosen value means more
8677 aggressive optimization, increasing the compilation time.  This parameter
8678 should be removed when the delay slot code is rewritten to maintain the
8679 control-flow graph.
8681 @item max-gcse-memory
8682 The approximate maximum amount of memory that can be allocated in
8683 order to perform the global common subexpression elimination
8684 optimization.  If more memory than specified is required, the
8685 optimization is not done.
8687 @item max-gcse-insertion-ratio
8688 If the ratio of expression insertions to deletions is larger than this value
8689 for any expression, then RTL PRE inserts or removes the expression and thus
8690 leaves partially redundant computations in the instruction stream.  The default value is 20.
8692 @item max-pending-list-length
8693 The maximum number of pending dependencies scheduling allows
8694 before flushing the current state and starting over.  Large functions
8695 with few branches or calls can create excessively large lists which
8696 needlessly consume memory and resources.
8698 @item max-modulo-backtrack-attempts
8699 The maximum number of backtrack attempts the scheduler should make
8700 when modulo scheduling a loop.  Larger values can exponentially increase
8701 compilation time.
8703 @item max-inline-insns-single
8704 Several parameters control the tree inliner used in GCC@.
8705 This number sets the maximum number of instructions (counted in GCC's
8706 internal representation) in a single function that the tree inliner
8707 considers for inlining.  This only affects functions declared
8708 inline and methods implemented in a class declaration (C++).
8709 The default value is 400.
8711 @item max-inline-insns-auto
8712 When you use @option{-finline-functions} (included in @option{-O3}),
8713 a lot of functions that would otherwise not be considered for inlining
8714 by the compiler are investigated.  To those functions, a different
8715 (more restrictive) limit compared to functions declared inline can
8716 be applied.
8717 The default value is 40.
8719 @item large-function-insns
8720 The limit specifying really large functions.  For functions larger than this
8721 limit after inlining, inlining is constrained by
8722 @option{--param large-function-growth}.  This parameter is useful primarily
8723 to avoid extreme compilation time caused by non-linear algorithms used by the
8724 back end.
8725 The default value is 2700.
8727 @item large-function-growth
8728 Specifies maximal growth of large function caused by inlining in percents.
8729 The default value is 100 which limits large function growth to 2.0 times
8730 the original size.
8732 @item large-unit-insns
8733 The limit specifying large translation unit.  Growth caused by inlining of
8734 units larger than this limit is limited by @option{--param inline-unit-growth}.
8735 For small units this might be too tight (consider unit consisting of function A
8736 that is inline and B that just calls A three time.  If B is small relative to
8737 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8738 large units consisting of small inlineable functions however the overall unit
8739 growth limit is needed to avoid exponential explosion of code size.  Thus for
8740 smaller units, the size is increased to @option{--param large-unit-insns}
8741 before applying @option{--param inline-unit-growth}.  The default is 10000
8743 @item inline-unit-growth
8744 Specifies maximal overall growth of the compilation unit caused by inlining.
8745 The default value is 30 which limits unit growth to 1.3 times the original
8746 size.
8748 @item ipcp-unit-growth
8749 Specifies maximal overall growth of the compilation unit caused by
8750 interprocedural constant propagation.  The default value is 10 which limits
8751 unit growth to 1.1 times the original size.
8753 @item large-stack-frame
8754 The limit specifying large stack frames.  While inlining the algorithm is trying
8755 to not grow past this limit too much.  Default value is 256 bytes.
8757 @item large-stack-frame-growth
8758 Specifies maximal growth of large stack frames caused by inlining in percents.
8759 The default value is 1000 which limits large stack frame growth to 11 times
8760 the original size.
8762 @item max-inline-insns-recursive
8763 @itemx max-inline-insns-recursive-auto
8764 Specifies maximum number of instructions out-of-line copy of self recursive inline
8765 function can grow into by performing recursive inlining.
8767 For functions declared inline @option{--param max-inline-insns-recursive} is
8768 taken into account.  For function not declared inline, recursive inlining
8769 happens only when @option{-finline-functions} (included in @option{-O3}) is
8770 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8771 default value is 450.
8773 @item max-inline-recursive-depth
8774 @itemx max-inline-recursive-depth-auto
8775 Specifies maximum recursion depth used by the recursive inlining.
8777 For functions declared inline @option{--param max-inline-recursive-depth} is
8778 taken into account.  For function not declared inline, recursive inlining
8779 happens only when @option{-finline-functions} (included in @option{-O3}) is
8780 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8781 default value is 8.
8783 @item min-inline-recursive-probability
8784 Recursive inlining is profitable only for function having deep recursion
8785 in average and can hurt for function having little recursion depth by
8786 increasing the prologue size or complexity of function body to other
8787 optimizers.
8789 When profile feedback is available (see @option{-fprofile-generate}) the actual
8790 recursion depth can be guessed from probability that function will recurse via
8791 given call expression.  This parameter limits inlining only to call expression
8792 whose probability exceeds given threshold (in percents).  The default value is
8795 @item early-inlining-insns
8796 Specify growth that early inliner can make.  In effect it increases amount of
8797 inlining for code having large abstraction penalty.  The default value is 10.
8799 @item max-early-inliner-iterations
8800 @itemx max-early-inliner-iterations
8801 Limit of iterations of early inliner.  This basically bounds number of nested
8802 indirect calls early inliner can resolve.  Deeper chains are still handled by
8803 late inlining.
8805 @item comdat-sharing-probability
8806 @itemx comdat-sharing-probability
8807 Probability (in percent) that C++ inline function with comdat visibility
8808 are shared across multiple compilation units.  The default value is 20.
8810 @item min-vect-loop-bound
8811 The minimum number of iterations under which a loop is not vectorized
8812 when @option{-ftree-vectorize} is used.  The number of iterations after
8813 vectorization needs to be greater than the value specified by this option
8814 to allow vectorization.  The default value is 0.
8816 @item gcse-cost-distance-ratio
8817 Scaling factor in calculation of maximum distance an expression
8818 can be moved by GCSE optimizations.  This is currently supported only in the
8819 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8820 is with simple expressions, i.e., the expressions that have cost
8821 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
8822 hoisting of simple expressions.  The default value is 10.
8824 @item gcse-unrestricted-cost
8825 Cost, roughly measured as the cost of a single typical machine
8826 instruction, at which GCSE optimizations do not constrain
8827 the distance an expression can travel.  This is currently
8828 supported only in the code hoisting pass.  The lesser the cost,
8829 the more aggressive code hoisting is.  Specifying 0 
8830 allows all expressions to travel unrestricted distances.
8831 The default value is 3.
8833 @item max-hoist-depth
8834 The depth of search in the dominator tree for expressions to hoist.
8835 This is used to avoid quadratic behavior in hoisting algorithm.
8836 The value of 0 does not limit on the search, but may slow down compilation
8837 of huge functions.  The default value is 30.
8839 @item max-tail-merge-comparisons
8840 The maximum amount of similar bbs to compare a bb with.  This is used to
8841 avoid quadratic behavior in tree tail merging.  The default value is 10.
8843 @item max-tail-merge-iterations
8844 The maximum amount of iterations of the pass over the function.  This is used to
8845 limit compilation time in tree tail merging.  The default value is 2.
8847 @item max-unrolled-insns
8848 The maximum number of instructions that a loop should have if that loop
8849 is unrolled, and if the loop is unrolled, it determines how many times
8850 the loop code is unrolled.
8852 @item max-average-unrolled-insns
8853 The maximum number of instructions biased by probabilities of their execution
8854 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8855 it determines how many times the loop code is unrolled.
8857 @item max-unroll-times
8858 The maximum number of unrollings of a single loop.
8860 @item max-peeled-insns
8861 The maximum number of instructions that a loop should have if that loop
8862 is peeled, and if the loop is peeled, it determines how many times
8863 the loop code is peeled.
8865 @item max-peel-times
8866 The maximum number of peelings of a single loop.
8868 @item max-completely-peeled-insns
8869 The maximum number of insns of a completely peeled loop.
8871 @item max-completely-peel-times
8872 The maximum number of iterations of a loop to be suitable for complete peeling.
8874 @item max-completely-peel-loop-nest-depth
8875 The maximum depth of a loop nest suitable for complete peeling.
8877 @item max-unswitch-insns
8878 The maximum number of insns of an unswitched loop.
8880 @item max-unswitch-level
8881 The maximum number of branches unswitched in a single loop.
8883 @item lim-expensive
8884 The minimum cost of an expensive expression in the loop invariant motion.
8886 @item iv-consider-all-candidates-bound
8887 Bound on number of candidates for induction variables below that
8888 all candidates are considered for each use in induction variable
8889 optimizations.  Only the most relevant candidates are considered
8890 if there are more candidates, to avoid quadratic time complexity.
8892 @item iv-max-considered-uses
8893 The induction variable optimizations give up on loops that contain more
8894 induction variable uses.
8896 @item iv-always-prune-cand-set-bound
8897 If number of candidates in the set is smaller than this value,
8898 we always try to remove unnecessary ivs from the set during its
8899 optimization when a new iv is added to the set.
8901 @item scev-max-expr-size
8902 Bound on size of expressions used in the scalar evolutions analyzer.
8903 Large expressions slow the analyzer.
8905 @item scev-max-expr-complexity
8906 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8907 Complex expressions slow the analyzer.
8909 @item omega-max-vars
8910 The maximum number of variables in an Omega constraint system.
8911 The default value is 128.
8913 @item omega-max-geqs
8914 The maximum number of inequalities in an Omega constraint system.
8915 The default value is 256.
8917 @item omega-max-eqs
8918 The maximum number of equalities in an Omega constraint system.
8919 The default value is 128.
8921 @item omega-max-wild-cards
8922 The maximum number of wildcard variables that the Omega solver is
8923 able to insert.  The default value is 18.
8925 @item omega-hash-table-size
8926 The size of the hash table in the Omega solver.  The default value is
8927 550.
8929 @item omega-max-keys
8930 The maximal number of keys used by the Omega solver.  The default
8931 value is 500.
8933 @item omega-eliminate-redundant-constraints
8934 When set to 1, use expensive methods to eliminate all redundant
8935 constraints.  The default value is 0.
8937 @item vect-max-version-for-alignment-checks
8938 The maximum number of run-time checks that can be performed when
8939 doing loop versioning for alignment in the vectorizer.  See option
8940 @option{-ftree-vect-loop-version} for more information.
8942 @item vect-max-version-for-alias-checks
8943 The maximum number of run-time checks that can be performed when
8944 doing loop versioning for alias in the vectorizer.  See option
8945 @option{-ftree-vect-loop-version} for more information.
8947 @item max-iterations-to-track
8949 The maximum number of iterations of a loop the brute force algorithm
8950 for analysis of # of iterations of the loop tries to evaluate.
8952 @item hot-bb-count-fraction
8953 Select fraction of the maximal count of repetitions of basic block in program
8954 given basic block needs to have to be considered hot.
8956 @item hot-bb-frequency-fraction
8957 Select fraction of the entry block frequency of executions of basic block in
8958 function given basic block needs to have to be considered hot.
8960 @item max-predicted-iterations
8961 The maximum number of loop iterations we predict statically.  This is useful
8962 in cases where a function contains a single loop with known bound and
8963 another loop with unknown bound.
8964 The known number of iterations is predicted correctly, while
8965 the unknown number of iterations average to roughly 10.  This means that the
8966 loop without bounds appears artificially cold relative to the other one.
8968 @item align-threshold
8970 Select fraction of the maximal frequency of executions of a basic block in
8971 a function to align the basic block.
8973 @item align-loop-iterations
8975 A loop expected to iterate at least the selected number of iterations is
8976 aligned.
8978 @item tracer-dynamic-coverage
8979 @itemx tracer-dynamic-coverage-feedback
8981 This value is used to limit superblock formation once the given percentage of
8982 executed instructions is covered.  This limits unnecessary code size
8983 expansion.
8985 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8986 feedback is available.  The real profiles (as opposed to statically estimated
8987 ones) are much less balanced allowing the threshold to be larger value.
8989 @item tracer-max-code-growth
8990 Stop tail duplication once code growth has reached given percentage.  This is
8991 a rather artificial limit, as most of the duplicates are eliminated later in
8992 cross jumping, so it may be set to much higher values than is the desired code
8993 growth.
8995 @item tracer-min-branch-ratio
8997 Stop reverse growth when the reverse probability of best edge is less than this
8998 threshold (in percent).
9000 @item tracer-min-branch-ratio
9001 @itemx tracer-min-branch-ratio-feedback
9003 Stop forward growth if the best edge has probability lower than this
9004 threshold.
9006 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9007 compilation for profile feedback and one for compilation without.  The value
9008 for compilation with profile feedback needs to be more conservative (higher) in
9009 order to make tracer effective.
9011 @item max-cse-path-length
9013 Maximum number of basic blocks on path that cse considers.  The default is 10.
9015 @item max-cse-insns
9016 The maximum instructions CSE process before flushing. The default is 1000.
9018 @item ggc-min-expand
9020 GCC uses a garbage collector to manage its own memory allocation.  This
9021 parameter specifies the minimum percentage by which the garbage
9022 collector's heap should be allowed to expand between collections.
9023 Tuning this may improve compilation speed; it has no effect on code
9024 generation.
9026 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9027 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9028 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9029 GCC is not able to calculate RAM on a particular platform, the lower
9030 bound of 30% is used.  Setting this parameter and
9031 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9032 every opportunity.  This is extremely slow, but can be useful for
9033 debugging.
9035 @item ggc-min-heapsize
9037 Minimum size of the garbage collector's heap before it begins bothering
9038 to collect garbage.  The first collection occurs after the heap expands
9039 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9040 tuning this may improve compilation speed, and has no effect on code
9041 generation.
9043 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9044 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9045 with a lower bound of 4096 (four megabytes) and an upper bound of
9046 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9047 particular platform, the lower bound is used.  Setting this parameter
9048 very large effectively disables garbage collection.  Setting this
9049 parameter and @option{ggc-min-expand} to zero causes a full collection
9050 to occur at every opportunity.
9052 @item max-reload-search-insns
9053 The maximum number of instruction reload should look backward for equivalent
9054 register.  Increasing values mean more aggressive optimization, making the
9055 compilation time increase with probably slightly better performance.
9056 The default value is 100.
9058 @item max-cselib-memory-locations
9059 The maximum number of memory locations cselib should take into account.
9060 Increasing values mean more aggressive optimization, making the compilation time
9061 increase with probably slightly better performance.  The default value is 500.
9063 @item reorder-blocks-duplicate
9064 @itemx reorder-blocks-duplicate-feedback
9066 Used by basic block reordering pass to decide whether to use unconditional
9067 branch or duplicate the code on its destination.  Code is duplicated when its
9068 estimated size is smaller than this value multiplied by the estimated size of
9069 unconditional jump in the hot spots of the program.
9071 The @option{reorder-block-duplicate-feedback} is used only when profile
9072 feedback is available and may be set to higher values than
9073 @option{reorder-block-duplicate} since information about the hot spots is more
9074 accurate.
9076 @item max-sched-ready-insns
9077 The maximum number of instructions ready to be issued the scheduler should
9078 consider at any given time during the first scheduling pass.  Increasing
9079 values mean more thorough searches, making the compilation time increase
9080 with probably little benefit.  The default value is 100.
9082 @item max-sched-region-blocks
9083 The maximum number of blocks in a region to be considered for
9084 interblock scheduling.  The default value is 10.
9086 @item max-pipeline-region-blocks
9087 The maximum number of blocks in a region to be considered for
9088 pipelining in the selective scheduler.  The default value is 15.
9090 @item max-sched-region-insns
9091 The maximum number of insns in a region to be considered for
9092 interblock scheduling.  The default value is 100.
9094 @item max-pipeline-region-insns
9095 The maximum number of insns in a region to be considered for
9096 pipelining in the selective scheduler.  The default value is 200.
9098 @item min-spec-prob
9099 The minimum probability (in percents) of reaching a source block
9100 for interblock speculative scheduling.  The default value is 40.
9102 @item max-sched-extend-regions-iters
9103 The maximum number of iterations through CFG to extend regions.
9104 A value of 0 (the default) disables region extensions.
9106 @item max-sched-insn-conflict-delay
9107 The maximum conflict delay for an insn to be considered for speculative motion.
9108 The default value is 3.
9110 @item sched-spec-prob-cutoff
9111 The minimal probability of speculation success (in percents), so that
9112 speculative insns are scheduled.
9113 The default value is 40.
9115 @item sched-mem-true-dep-cost
9116 Minimal distance (in CPU cycles) between store and load targeting same
9117 memory locations.  The default value is 1.
9119 @item selsched-max-lookahead
9120 The maximum size of the lookahead window of selective scheduling.  It is a
9121 depth of search for available instructions.
9122 The default value is 50.
9124 @item selsched-max-sched-times
9125 The maximum number of times that an instruction is scheduled during
9126 selective scheduling.  This is the limit on the number of iterations
9127 through which the instruction may be pipelined.  The default value is 2.
9129 @item selsched-max-insns-to-rename
9130 The maximum number of best instructions in the ready list that are considered
9131 for renaming in the selective scheduler.  The default value is 2.
9133 @item sms-min-sc
9134 The minimum value of stage count that swing modulo scheduler
9135 generates.  The default value is 2.
9137 @item max-last-value-rtl
9138 The maximum size measured as number of RTLs that can be recorded in an expression
9139 in combiner for a pseudo register as last known value of that register.  The default
9140 is 10000.
9142 @item integer-share-limit
9143 Small integer constants can use a shared data structure, reducing the
9144 compiler's memory usage and increasing its speed.  This sets the maximum
9145 value of a shared integer constant.  The default value is 256.
9147 @item ssp-buffer-size
9148 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9149 protection when @option{-fstack-protection} is used.
9151 @item max-jump-thread-duplication-stmts
9152 Maximum number of statements allowed in a block that needs to be
9153 duplicated when threading jumps.
9155 @item max-fields-for-field-sensitive
9156 Maximum number of fields in a structure treated in
9157 a field sensitive manner during pointer analysis.  The default is zero
9158 for @option{-O0} and @option{-O1},
9159 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9161 @item prefetch-latency
9162 Estimate on average number of instructions that are executed before
9163 prefetch finishes.  The distance we prefetch ahead is proportional
9164 to this constant.  Increasing this number may also lead to less
9165 streams being prefetched (see @option{simultaneous-prefetches}).
9167 @item simultaneous-prefetches
9168 Maximum number of prefetches that can run at the same time.
9170 @item l1-cache-line-size
9171 The size of cache line in L1 cache, in bytes.
9173 @item l1-cache-size
9174 The size of L1 cache, in kilobytes.
9176 @item l2-cache-size
9177 The size of L2 cache, in kilobytes.
9179 @item min-insn-to-prefetch-ratio
9180 The minimum ratio between the number of instructions and the
9181 number of prefetches to enable prefetching in a loop.
9183 @item prefetch-min-insn-to-mem-ratio
9184 The minimum ratio between the number of instructions and the
9185 number of memory references to enable prefetching in a loop.
9187 @item use-canonical-types
9188 Whether the compiler should use the ``canonical'' type system.  By
9189 default, this should always be 1, which uses a more efficient internal
9190 mechanism for comparing types in C++ and Objective-C++.  However, if
9191 bugs in the canonical type system are causing compilation failures,
9192 set this value to 0 to disable canonical types.
9194 @item switch-conversion-max-branch-ratio
9195 Switch initialization conversion refuses to create arrays that are
9196 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9197 branches in the switch.
9199 @item max-partial-antic-length
9200 Maximum length of the partial antic set computed during the tree
9201 partial redundancy elimination optimization (@option{-ftree-pre}) when
9202 optimizing at @option{-O3} and above.  For some sorts of source code
9203 the enhanced partial redundancy elimination optimization can run away,
9204 consuming all of the memory available on the host machine.  This
9205 parameter sets a limit on the length of the sets that are computed,
9206 which prevents the runaway behavior.  Setting a value of 0 for
9207 this parameter allows an unlimited set length.
9209 @item sccvn-max-scc-size
9210 Maximum size of a strongly connected component (SCC) during SCCVN
9211 processing.  If this limit is hit, SCCVN processing for the whole
9212 function is not done and optimizations depending on it are
9213 disabled.  The default maximum SCC size is 10000.
9215 @item ira-max-loops-num
9216 IRA uses regional register allocation by default.  If a function
9217 contains more loops than the number given by this parameter, only at most
9218 the given number of the most frequently-executed loops form regions
9219 for regional register allocation.  The default value of the
9220 parameter is 100.
9222 @item ira-max-conflict-table-size 
9223 Although IRA uses a sophisticated algorithm to compress the conflict
9224 table, the table can still require excessive amounts of memory for
9225 huge functions.  If the conflict table for a function could be more
9226 than the size in MB given by this parameter, the register allocator
9227 instead uses a faster, simpler, and lower-quality
9228 algorithm that does not require building a pseudo-register conflict table.  
9229 The default value of the parameter is 2000.
9231 @item ira-loop-reserved-regs
9232 IRA can be used to evaluate more accurate register pressure in loops
9233 for decisions to move loop invariants (see @option{-O3}).  The number
9234 of available registers reserved for some other purposes is given
9235 by this parameter.  The default value of the parameter is 2, which is
9236 the minimal number of registers needed by typical instructions.
9237 This value is the best found from numerous experiments.
9239 @item loop-invariant-max-bbs-in-loop
9240 Loop invariant motion can be very expensive, both in compilation time and
9241 in amount of needed compile-time memory, with very large loops.  Loops
9242 with more basic blocks than this parameter won't have loop invariant
9243 motion optimization performed on them.  The default value of the
9244 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9246 @item loop-max-datarefs-for-datadeps
9247 Building data dapendencies is expensive for very large loops.  This
9248 parameter limits the number of data references in loops that are
9249 considered for data dependence analysis.  These large loops are no
9250 handled by the optimizations using loop data dependencies.
9251 The default value is 1000.
9253 @item max-vartrack-size
9254 Sets a maximum number of hash table slots to use during variable
9255 tracking dataflow analysis of any function.  If this limit is exceeded
9256 with variable tracking at assignments enabled, analysis for that
9257 function is retried without it, after removing all debug insns from
9258 the function.  If the limit is exceeded even without debug insns, var
9259 tracking analysis is completely disabled for the function.  Setting
9260 the parameter to zero makes it unlimited.
9262 @item max-vartrack-expr-depth
9263 Sets a maximum number of recursion levels when attempting to map
9264 variable names or debug temporaries to value expressions.  This trades
9265 compilation time for more complete debug information.  If this is set too
9266 low, value expressions that are available and could be represented in
9267 debug information may end up not being used; setting this higher may
9268 enable the compiler to find more complex debug expressions, but compile
9269 time and memory use may grow.  The default is 12.
9271 @item min-nondebug-insn-uid
9272 Use uids starting at this parameter for nondebug insns.  The range below
9273 the parameter is reserved exclusively for debug insns created by
9274 @option{-fvar-tracking-assignments}, but debug insns may get
9275 (non-overlapping) uids above it if the reserved range is exhausted.
9277 @item ipa-sra-ptr-growth-factor
9278 IPA-SRA replaces a pointer to an aggregate with one or more new
9279 parameters only when their cumulative size is less or equal to
9280 @option{ipa-sra-ptr-growth-factor} times the size of the original
9281 pointer parameter.
9283 @item tm-max-aggregate-size
9284 When making copies of thread-local variables in a transaction, this
9285 parameter specifies the size in bytes after which variables are
9286 saved with the logging functions as opposed to save/restore code
9287 sequence pairs.  This option only applies when using
9288 @option{-fgnu-tm}.
9290 @item graphite-max-nb-scop-params
9291 To avoid exponential effects in the Graphite loop transforms, the
9292 number of parameters in a Static Control Part (SCoP) is bounded.  The
9293 default value is 10 parameters.  A variable whose value is unknown at
9294 compilation time and defined outside a SCoP is a parameter of the SCoP.
9296 @item graphite-max-bbs-per-function
9297 To avoid exponential effects in the detection of SCoPs, the size of
9298 the functions analyzed by Graphite is bounded.  The default value is
9299 100 basic blocks.
9301 @item loop-block-tile-size
9302 Loop blocking or strip mining transforms, enabled with
9303 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9304 loop in the loop nest by a given number of iterations.  The strip
9305 length can be changed using the @option{loop-block-tile-size}
9306 parameter.  The default value is 51 iterations.
9308 @item ipa-cp-value-list-size
9309 IPA-CP attempts to track all possible values and types passed to a function's
9310 parameter in order to propagate them and perform devirtualization.
9311 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9312 stores per one formal parameter of a function.
9314 @item lto-partitions
9315 Specify desired number of partitions produced during WHOPR compilation.
9316 The number of partitions should exceed the number of CPUs used for compilation.
9317 The default value is 32.
9319 @item lto-minpartition
9320 Size of minimal partition for WHOPR (in estimated instructions).
9321 This prevents expenses of splitting very small programs into too many
9322 partitions.
9324 @item cxx-max-namespaces-for-diagnostic-help
9325 The maximum number of namespaces to consult for suggestions when C++
9326 name lookup fails for an identifier.  The default is 1000.
9328 @item sink-frequency-threshold
9329 The maximum relative execution frequency (in percents) of the target block
9330 relative to a statement's original block to allow statement sinking of a
9331 statement.  Larger numbers result in more aggressive statement sinking.
9332 The default value is 75.  A small positive adjustment is applied for
9333 statements with memory operands as those are even more profitable so sink.
9335 @item max-stores-to-sink
9336 The maximum number of conditional stores paires that can be sunk.  Set to 0
9337 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9338 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9340 @item allow-load-data-races
9341 Allow optimizers to introduce new data races on loads.
9342 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9343 unless implicitly set by the @option{-fmemory-model=} option.
9345 @item allow-store-data-races
9346 Allow optimizers to introduce new data races on stores.
9347 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9348 unless implicitly set by the @option{-fmemory-model=} option.
9350 @item allow-packed-load-data-races
9351 Allow optimizers to introduce new data races on packed data loads.
9352 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9353 unless implicitly set by the @option{-fmemory-model=} option.
9355 @item allow-packed-store-data-races
9356 Allow optimizers to introduce new data races on packed data stores.
9357 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9358 unless implicitly set by the @option{-fmemory-model=} option.
9360 @item case-values-threshold
9361 The smallest number of different values for which it is best to use a
9362 jump-table instead of a tree of conditional branches.  If the value is
9363 0, use the default for the machine.  The default is 0.
9365 @item tree-reassoc-width
9366 Set the maximum number of instructions executed in parallel in
9367 reassociated tree. This parameter overrides target dependent
9368 heuristics used by default if has non zero value.
9370 @item sched-pressure-algorithm
9371 Choose between the two available implementations of
9372 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9373 and is the more likely to prevent instructions from being reordered.
9374 Algorithm 2 was designed to be a compromise between the relatively
9375 conservative approach taken by algorithm 1 and the rather aggressive
9376 approach taken by the default scheduler.  It relies more heavily on
9377 having a regular register file and accurate register pressure classes.
9378 See @file{haifa-sched.c} in the GCC sources for more details.
9380 The default choice depends on the target.
9381 @end table
9382 @end table
9384 @node Preprocessor Options
9385 @section Options Controlling the Preprocessor
9386 @cindex preprocessor options
9387 @cindex options, preprocessor
9389 These options control the C preprocessor, which is run on each C source
9390 file before actual compilation.
9392 If you use the @option{-E} option, nothing is done except preprocessing.
9393 Some of these options make sense only together with @option{-E} because
9394 they cause the preprocessor output to be unsuitable for actual
9395 compilation.
9397 @table @gcctabopt
9398 @item -Wp,@var{option}
9399 @opindex Wp
9400 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9401 and pass @var{option} directly through to the preprocessor.  If
9402 @var{option} contains commas, it is split into multiple options at the
9403 commas.  However, many options are modified, translated or interpreted
9404 by the compiler driver before being passed to the preprocessor, and
9405 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9406 interface is undocumented and subject to change, so whenever possible
9407 you should avoid using @option{-Wp} and let the driver handle the
9408 options instead.
9410 @item -Xpreprocessor @var{option}
9411 @opindex Xpreprocessor
9412 Pass @var{option} as an option to the preprocessor.  You can use this to
9413 supply system-specific preprocessor options that GCC does not know how to
9414 recognize.
9416 If you want to pass an option that takes an argument, you must use
9417 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9419 @item -no-integrated-cpp
9420 @opindex no-integrated-cpp
9421 Perform preprocessing as a separate pass before compilation.
9422 By default, GCC performs preprocessing as an integrated part of
9423 input tokenization and parsing.
9424 If this option is provided, the appropriate language front end
9425 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9426 and Objective-C, respectively) is instead invoked twice,
9427 once for preprocessing only and once for actual compilation
9428 of the preprocessed input.
9429 This option may be useful in conjunction with the @option{-B} or
9430 @option{-wrapper} options to specify an alternate preprocessor or
9431 perform additional processing of the program source between
9432 normal preprocessing and compilation.
9433 @end table
9435 @include cppopts.texi
9437 @node Assembler Options
9438 @section Passing Options to the Assembler
9440 @c prevent bad page break with this line
9441 You can pass options to the assembler.
9443 @table @gcctabopt
9444 @item -Wa,@var{option}
9445 @opindex Wa
9446 Pass @var{option} as an option to the assembler.  If @var{option}
9447 contains commas, it is split into multiple options at the commas.
9449 @item -Xassembler @var{option}
9450 @opindex Xassembler
9451 Pass @var{option} as an option to the assembler.  You can use this to
9452 supply system-specific assembler options that GCC does not know how to
9453 recognize.
9455 If you want to pass an option that takes an argument, you must use
9456 @option{-Xassembler} twice, once for the option and once for the argument.
9458 @end table
9460 @node Link Options
9461 @section Options for Linking
9462 @cindex link options
9463 @cindex options, linking
9465 These options come into play when the compiler links object files into
9466 an executable output file.  They are meaningless if the compiler is
9467 not doing a link step.
9469 @table @gcctabopt
9470 @cindex file names
9471 @item @var{object-file-name}
9472 A file name that does not end in a special recognized suffix is
9473 considered to name an object file or library.  (Object files are
9474 distinguished from libraries by the linker according to the file
9475 contents.)  If linking is done, these object files are used as input
9476 to the linker.
9478 @item -c
9479 @itemx -S
9480 @itemx -E
9481 @opindex c
9482 @opindex S
9483 @opindex E
9484 If any of these options is used, then the linker is not run, and
9485 object file names should not be used as arguments.  @xref{Overall
9486 Options}.
9488 @cindex Libraries
9489 @item -l@var{library}
9490 @itemx -l @var{library}
9491 @opindex l
9492 Search the library named @var{library} when linking.  (The second
9493 alternative with the library as a separate argument is only for
9494 POSIX compliance and is not recommended.)
9496 It makes a difference where in the command you write this option; the
9497 linker searches and processes libraries and object files in the order they
9498 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9499 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9500 to functions in @samp{z}, those functions may not be loaded.
9502 The linker searches a standard list of directories for the library,
9503 which is actually a file named @file{lib@var{library}.a}.  The linker
9504 then uses this file as if it had been specified precisely by name.
9506 The directories searched include several standard system directories
9507 plus any that you specify with @option{-L}.
9509 Normally the files found this way are library files---archive files
9510 whose members are object files.  The linker handles an archive file by
9511 scanning through it for members which define symbols that have so far
9512 been referenced but not defined.  But if the file that is found is an
9513 ordinary object file, it is linked in the usual fashion.  The only
9514 difference between using an @option{-l} option and specifying a file name
9515 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9516 and searches several directories.
9518 @item -lobjc
9519 @opindex lobjc
9520 You need this special case of the @option{-l} option in order to
9521 link an Objective-C or Objective-C++ program.
9523 @item -nostartfiles
9524 @opindex nostartfiles
9525 Do not use the standard system startup files when linking.
9526 The standard system libraries are used normally, unless @option{-nostdlib}
9527 or @option{-nodefaultlibs} is used.
9529 @item -nodefaultlibs
9530 @opindex nodefaultlibs
9531 Do not use the standard system libraries when linking.
9532 Only the libraries you specify are passed to the linker, and options
9533 specifying linkage of the system libraries, such as @code{-static-libgcc}
9534 or @code{-shared-libgcc}, are ignored.  
9535 The standard startup files are used normally, unless @option{-nostartfiles}
9536 is used.  The compiler may generate calls to @code{memcmp},
9537 @code{memset}, @code{memcpy} and @code{memmove}.
9538 These entries are usually resolved by entries in
9539 libc.  These entry points should be supplied through some other
9540 mechanism when this option is specified.
9542 @item -nostdlib
9543 @opindex nostdlib
9544 Do not use the standard system startup files or libraries when linking.
9545 No startup files and only the libraries you specify are passed to
9546 the linker, and options specifying linkage of the system libraries, such as
9547 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9549 The compiler may generate calls to @code{memcmp}, @code{memset},
9550 @code{memcpy} and @code{memmove}.
9551 These entries are usually resolved by entries in
9552 libc.  These entry points should be supplied through some other
9553 mechanism when this option is specified.
9555 @cindex @option{-lgcc}, use with @option{-nostdlib}
9556 @cindex @option{-nostdlib} and unresolved references
9557 @cindex unresolved references and @option{-nostdlib}
9558 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9559 @cindex @option{-nodefaultlibs} and unresolved references
9560 @cindex unresolved references and @option{-nodefaultlibs}
9561 One of the standard libraries bypassed by @option{-nostdlib} and
9562 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9563 which GCC uses to overcome shortcomings of particular machines, or special
9564 needs for some languages.
9565 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9566 Collection (GCC) Internals},
9567 for more discussion of @file{libgcc.a}.)
9568 In most cases, you need @file{libgcc.a} even when you want to avoid
9569 other standard libraries.  In other words, when you specify @option{-nostdlib}
9570 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9571 This ensures that you have no unresolved references to internal GCC
9572 library subroutines.
9573 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9574 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9575 GNU Compiler Collection (GCC) Internals}.)
9577 @item -pie
9578 @opindex pie
9579 Produce a position independent executable on targets that support it.
9580 For predictable results, you must also specify the same set of options
9581 used for compilation (@option{-fpie}, @option{-fPIE},
9582 or model suboptions) when you specify this linker option.
9584 @item -rdynamic
9585 @opindex rdynamic
9586 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9587 that support it. This instructs the linker to add all symbols, not
9588 only used ones, to the dynamic symbol table. This option is needed
9589 for some uses of @code{dlopen} or to allow obtaining backtraces
9590 from within a program.
9592 @item -s
9593 @opindex s
9594 Remove all symbol table and relocation information from the executable.
9596 @item -static
9597 @opindex static
9598 On systems that support dynamic linking, this prevents linking with the shared
9599 libraries.  On other systems, this option has no effect.
9601 @item -shared
9602 @opindex shared
9603 Produce a shared object which can then be linked with other objects to
9604 form an executable.  Not all systems support this option.  For predictable
9605 results, you must also specify the same set of options used for compilation
9606 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9607 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9608 needs to build supplementary stub code for constructors to work.  On
9609 multi-libbed systems, @samp{gcc -shared} must select the correct support
9610 libraries to link against.  Failing to supply the correct flags may lead
9611 to subtle defects.  Supplying them in cases where they are not necessary
9612 is innocuous.}
9614 @item -shared-libgcc
9615 @itemx -static-libgcc
9616 @opindex shared-libgcc
9617 @opindex static-libgcc
9618 On systems that provide @file{libgcc} as a shared library, these options
9619 force the use of either the shared or static version respectively.
9620 If no shared version of @file{libgcc} was built when the compiler was
9621 configured, these options have no effect.
9623 There are several situations in which an application should use the
9624 shared @file{libgcc} instead of the static version.  The most common
9625 of these is when the application wishes to throw and catch exceptions
9626 across different shared libraries.  In that case, each of the libraries
9627 as well as the application itself should use the shared @file{libgcc}.
9629 Therefore, the G++ and GCJ drivers automatically add
9630 @option{-shared-libgcc} whenever you build a shared library or a main
9631 executable, because C++ and Java programs typically use exceptions, so
9632 this is the right thing to do.
9634 If, instead, you use the GCC driver to create shared libraries, you may
9635 find that they are not always linked with the shared @file{libgcc}.
9636 If GCC finds, at its configuration time, that you have a non-GNU linker
9637 or a GNU linker that does not support option @option{--eh-frame-hdr},
9638 it links the shared version of @file{libgcc} into shared libraries
9639 by default.  Otherwise, it takes advantage of the linker and optimizes
9640 away the linking with the shared version of @file{libgcc}, linking with
9641 the static version of libgcc by default.  This allows exceptions to
9642 propagate through such shared libraries, without incurring relocation
9643 costs at library load time.
9645 However, if a library or main executable is supposed to throw or catch
9646 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9647 for the languages used in the program, or using the option
9648 @option{-shared-libgcc}, such that it is linked with the shared
9649 @file{libgcc}.
9651 @item -static-libstdc++
9652 When the @command{g++} program is used to link a C++ program, it
9653 normally automatically links against @option{libstdc++}.  If
9654 @file{libstdc++} is available as a shared library, and the
9655 @option{-static} option is not used, then this links against the
9656 shared version of @file{libstdc++}.  That is normally fine.  However, it
9657 is sometimes useful to freeze the version of @file{libstdc++} used by
9658 the program without going all the way to a fully static link.  The
9659 @option{-static-libstdc++} option directs the @command{g++} driver to
9660 link @file{libstdc++} statically, without necessarily linking other
9661 libraries statically.
9663 @item -symbolic
9664 @opindex symbolic
9665 Bind references to global symbols when building a shared object.  Warn
9666 about any unresolved references (unless overridden by the link editor
9667 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
9668 this option.
9670 @item -T @var{script}
9671 @opindex T
9672 @cindex linker script
9673 Use @var{script} as the linker script.  This option is supported by most
9674 systems using the GNU linker.  On some targets, such as bare-board
9675 targets without an operating system, the @option{-T} option may be required
9676 when linking to avoid references to undefined symbols.
9678 @item -Xlinker @var{option}
9679 @opindex Xlinker
9680 Pass @var{option} as an option to the linker.  You can use this to
9681 supply system-specific linker options that GCC does not recognize.
9683 If you want to pass an option that takes a separate argument, you must use
9684 @option{-Xlinker} twice, once for the option and once for the argument.
9685 For example, to pass @option{-assert definitions}, you must write
9686 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9687 @option{-Xlinker "-assert definitions"}, because this passes the entire
9688 string as a single argument, which is not what the linker expects.
9690 When using the GNU linker, it is usually more convenient to pass
9691 arguments to linker options using the @option{@var{option}=@var{value}}
9692 syntax than as separate arguments.  For example, you can specify
9693 @option{-Xlinker -Map=output.map} rather than
9694 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9695 this syntax for command-line options.
9697 @item -Wl,@var{option}
9698 @opindex Wl
9699 Pass @var{option} as an option to the linker.  If @var{option} contains
9700 commas, it is split into multiple options at the commas.  You can use this
9701 syntax to pass an argument to the option.
9702 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9703 linker.  When using the GNU linker, you can also get the same effect with
9704 @option{-Wl,-Map=output.map}.
9706 @item -u @var{symbol}
9707 @opindex u
9708 Pretend the symbol @var{symbol} is undefined, to force linking of
9709 library modules to define it.  You can use @option{-u} multiple times with
9710 different symbols to force loading of additional library modules.
9711 @end table
9713 @node Directory Options
9714 @section Options for Directory Search
9715 @cindex directory options
9716 @cindex options, directory search
9717 @cindex search path
9719 These options specify directories to search for header files, for
9720 libraries and for parts of the compiler:
9722 @table @gcctabopt
9723 @item -I@var{dir}
9724 @opindex I
9725 Add the directory @var{dir} to the head of the list of directories to be
9726 searched for header files.  This can be used to override a system header
9727 file, substituting your own version, since these directories are
9728 searched before the system header file directories.  However, you should
9729 not use this option to add directories that contain vendor-supplied
9730 system header files (use @option{-isystem} for that).  If you use more than
9731 one @option{-I} option, the directories are scanned in left-to-right
9732 order; the standard system directories come after.
9734 If a standard system include directory, or a directory specified with
9735 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9736 option is ignored.  The directory is still searched but as a
9737 system directory at its normal position in the system include chain.
9738 This is to ensure that GCC's procedure to fix buggy system headers and
9739 the ordering for the @code{include_next} directive are not inadvertently changed.
9740 If you really need to change the search order for system directories,
9741 use the @option{-nostdinc} and/or @option{-isystem} options.
9743 @item -iplugindir=@var{dir}
9744 Set the directory to search for plugins that are passed
9745 by @option{-fplugin=@var{name}} instead of
9746 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9747 to be used by the user, but only passed by the driver.
9749 @item -iquote@var{dir}
9750 @opindex iquote
9751 Add the directory @var{dir} to the head of the list of directories to
9752 be searched for header files only for the case of @samp{#include
9753 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9754 otherwise just like @option{-I}.
9756 @item -L@var{dir}
9757 @opindex L
9758 Add directory @var{dir} to the list of directories to be searched
9759 for @option{-l}.
9761 @item -B@var{prefix}
9762 @opindex B
9763 This option specifies where to find the executables, libraries,
9764 include files, and data files of the compiler itself.
9766 The compiler driver program runs one or more of the subprograms
9767 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
9768 @var{prefix} as a prefix for each program it tries to run, both with and
9769 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9771 For each subprogram to be run, the compiler driver first tries the
9772 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9773 is not specified, the driver tries two standard prefixes, 
9774 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9775 those results in a file name that is found, the unmodified program
9776 name is searched for using the directories specified in your
9777 @env{PATH} environment variable.
9779 The compiler checks to see if the path provided by the @option{-B}
9780 refers to a directory, and if necessary it adds a directory
9781 separator character at the end of the path.
9783 @option{-B} prefixes that effectively specify directory names also apply
9784 to libraries in the linker, because the compiler translates these
9785 options into @option{-L} options for the linker.  They also apply to
9786 includes files in the preprocessor, because the compiler translates these
9787 options into @option{-isystem} options for the preprocessor.  In this case,
9788 the compiler appends @samp{include} to the prefix.
9790 The runtime support file @file{libgcc.a} can also be searched for using
9791 the @option{-B} prefix, if needed.  If it is not found there, the two
9792 standard prefixes above are tried, and that is all.  The file is left
9793 out of the link if it is not found by those means.
9795 Another way to specify a prefix much like the @option{-B} prefix is to use
9796 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9797 Variables}.
9799 As a special kludge, if the path provided by @option{-B} is
9800 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9801 9, then it is replaced by @file{[dir/]include}.  This is to help
9802 with boot-strapping the compiler.
9804 @item -specs=@var{file}
9805 @opindex specs
9806 Process @var{file} after the compiler reads in the standard @file{specs}
9807 file, in order to override the defaults which the @command{gcc} driver
9808 program uses when determining what switches to pass to @command{cc1},
9809 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
9810 @option{-specs=@var{file}} can be specified on the command line, and they
9811 are processed in order, from left to right.
9813 @item --sysroot=@var{dir}
9814 @opindex sysroot
9815 Use @var{dir} as the logical root directory for headers and libraries.
9816 For example, if the compiler normally searches for headers in
9817 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
9818 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9820 If you use both this option and the @option{-isysroot} option, then
9821 the @option{--sysroot} option applies to libraries, but the
9822 @option{-isysroot} option applies to header files.
9824 The GNU linker (beginning with version 2.16) has the necessary support
9825 for this option.  If your linker does not support this option, the
9826 header file aspect of @option{--sysroot} still works, but the
9827 library aspect does not.
9829 @item -I-
9830 @opindex I-
9831 This option has been deprecated.  Please use @option{-iquote} instead for
9832 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9833 Any directories you specify with @option{-I} options before the @option{-I-}
9834 option are searched only for the case of @samp{#include "@var{file}"};
9835 they are not searched for @samp{#include <@var{file}>}.
9837 If additional directories are specified with @option{-I} options after
9838 the @option{-I-}, these directories are searched for all @samp{#include}
9839 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9840 this way.)
9842 In addition, the @option{-I-} option inhibits the use of the current
9843 directory (where the current input file came from) as the first search
9844 directory for @samp{#include "@var{file}"}.  There is no way to
9845 override this effect of @option{-I-}.  With @option{-I.} you can specify
9846 searching the directory that is current when the compiler is
9847 invoked.  That is not exactly the same as what the preprocessor does
9848 by default, but it is often satisfactory.
9850 @option{-I-} does not inhibit the use of the standard system directories
9851 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9852 independent.
9853 @end table
9855 @c man end
9857 @node Spec Files
9858 @section Specifying subprocesses and the switches to pass to them
9859 @cindex Spec Files
9861 @command{gcc} is a driver program.  It performs its job by invoking a
9862 sequence of other programs to do the work of compiling, assembling and
9863 linking.  GCC interprets its command-line parameters and uses these to
9864 deduce which programs it should invoke, and which command-line options
9865 it ought to place on their command lines.  This behavior is controlled
9866 by @dfn{spec strings}.  In most cases there is one spec string for each
9867 program that GCC can invoke, but a few programs have multiple spec
9868 strings to control their behavior.  The spec strings built into GCC can
9869 be overridden by using the @option{-specs=} command-line switch to specify
9870 a spec file.
9872 @dfn{Spec files} are plaintext files that are used to construct spec
9873 strings.  They consist of a sequence of directives separated by blank
9874 lines.  The type of directive is determined by the first non-whitespace
9875 character on the line, which can be one of the following:
9877 @table @code
9878 @item %@var{command}
9879 Issues a @var{command} to the spec file processor.  The commands that can
9880 appear here are:
9882 @table @code
9883 @item %include <@var{file}>
9884 @cindex @code{%include}
9885 Search for @var{file} and insert its text at the current point in the
9886 specs file.
9888 @item %include_noerr <@var{file}>
9889 @cindex @code{%include_noerr}
9890 Just like @samp{%include}, but do not generate an error message if the include
9891 file cannot be found.
9893 @item %rename @var{old_name} @var{new_name}
9894 @cindex @code{%rename}
9895 Rename the spec string @var{old_name} to @var{new_name}.
9897 @end table
9899 @item *[@var{spec_name}]:
9900 This tells the compiler to create, override or delete the named spec
9901 string.  All lines after this directive up to the next directive or
9902 blank line are considered to be the text for the spec string.  If this
9903 results in an empty string then the spec is deleted.  (Or, if the
9904 spec did not exist, then nothing happens.)  Otherwise, if the spec
9905 does not currently exist a new spec is created.  If the spec does
9906 exist then its contents are overridden by the text of this
9907 directive, unless the first character of that text is the @samp{+}
9908 character, in which case the text is appended to the spec.
9910 @item [@var{suffix}]:
9911 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9912 and up to the next directive or blank line are considered to make up the
9913 spec string for the indicated suffix.  When the compiler encounters an
9914 input file with the named suffix, it processes the spec string in
9915 order to work out how to compile that file.  For example:
9917 @smallexample
9918 .ZZ:
9919 z-compile -input %i
9920 @end smallexample
9922 This says that any input file whose name ends in @samp{.ZZ} should be
9923 passed to the program @samp{z-compile}, which should be invoked with the
9924 command-line switch @option{-input} and with the result of performing the
9925 @samp{%i} substitution.  (See below.)
9927 As an alternative to providing a spec string, the text that follows a
9928 suffix directive can be one of the following:
9930 @table @code
9931 @item @@@var{language}
9932 This says that the suffix is an alias for a known @var{language}.  This is
9933 similar to using the @option{-x} command-line switch to GCC to specify a
9934 language explicitly.  For example:
9936 @smallexample
9937 .ZZ:
9938 @@c++
9939 @end smallexample
9941 Says that .ZZ files are, in fact, C++ source files.
9943 @item #@var{name}
9944 This causes an error messages saying:
9946 @smallexample
9947 @var{name} compiler not installed on this system.
9948 @end smallexample
9949 @end table
9951 GCC already has an extensive list of suffixes built into it.
9952 This directive adds an entry to the end of the list of suffixes, but
9953 since the list is searched from the end backwards, it is effectively
9954 possible to override earlier entries using this technique.
9956 @end table
9958 GCC has the following spec strings built into it.  Spec files can
9959 override these strings or create their own.  Note that individual
9960 targets can also add their own spec strings to this list.
9962 @smallexample
9963 asm          Options to pass to the assembler
9964 asm_final    Options to pass to the assembler post-processor
9965 cpp          Options to pass to the C preprocessor
9966 cc1          Options to pass to the C compiler
9967 cc1plus      Options to pass to the C++ compiler
9968 endfile      Object files to include at the end of the link
9969 link         Options to pass to the linker
9970 lib          Libraries to include on the command line to the linker
9971 libgcc       Decides which GCC support library to pass to the linker
9972 linker       Sets the name of the linker
9973 predefines   Defines to be passed to the C preprocessor
9974 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9975              by default
9976 startfile    Object files to include at the start of the link
9977 @end smallexample
9979 Here is a small example of a spec file:
9981 @smallexample
9982 %rename lib                 old_lib
9984 *lib:
9985 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9986 @end smallexample
9988 This example renames the spec called @samp{lib} to @samp{old_lib} and
9989 then overrides the previous definition of @samp{lib} with a new one.
9990 The new definition adds in some extra command-line options before
9991 including the text of the old definition.
9993 @dfn{Spec strings} are a list of command-line options to be passed to their
9994 corresponding program.  In addition, the spec strings can contain
9995 @samp{%}-prefixed sequences to substitute variable text or to
9996 conditionally insert text into the command line.  Using these constructs
9997 it is possible to generate quite complex command lines.
9999 Here is a table of all defined @samp{%}-sequences for spec
10000 strings.  Note that spaces are not generated automatically around the
10001 results of expanding these sequences.  Therefore you can concatenate them
10002 together or combine them with constant text in a single argument.
10004 @table @code
10005 @item %%
10006 Substitute one @samp{%} into the program name or argument.
10008 @item %i
10009 Substitute the name of the input file being processed.
10011 @item %b
10012 Substitute the basename of the input file being processed.
10013 This is the substring up to (and not including) the last period
10014 and not including the directory.
10016 @item %B
10017 This is the same as @samp{%b}, but include the file suffix (text after
10018 the last period).
10020 @item %d
10021 Marks the argument containing or following the @samp{%d} as a
10022 temporary file name, so that that file is deleted if GCC exits
10023 successfully.  Unlike @samp{%g}, this contributes no text to the
10024 argument.
10026 @item %g@var{suffix}
10027 Substitute a file name that has suffix @var{suffix} and is chosen
10028 once per compilation, and mark the argument in the same way as
10029 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10030 name is now chosen in a way that is hard to predict even when previously
10031 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10032 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10033 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10034 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10035 was simply substituted with a file name chosen once per compilation,
10036 without regard to any appended suffix (which was therefore treated
10037 just like ordinary text), making such attacks more likely to succeed.
10039 @item %u@var{suffix}
10040 Like @samp{%g}, but generates a new temporary file name
10041 each time it appears instead of once per compilation.
10043 @item %U@var{suffix}
10044 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10045 new one if there is no such last file name.  In the absence of any
10046 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10047 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10048 involves the generation of two distinct file names, one
10049 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10050 simply substituted with a file name chosen for the previous @samp{%u},
10051 without regard to any appended suffix.
10053 @item %j@var{suffix}
10054 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10055 writable, and if @option{-save-temps} is not used; 
10056 otherwise, substitute the name
10057 of a temporary file, just like @samp{%u}.  This temporary file is not
10058 meant for communication between processes, but rather as a junk
10059 disposal mechanism.
10061 @item %|@var{suffix}
10062 @itemx %m@var{suffix}
10063 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10064 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10065 all.  These are the two most common ways to instruct a program that it
10066 should read from standard input or write to standard output.  If you
10067 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10068 construct: see for example @file{f/lang-specs.h}.
10070 @item %.@var{SUFFIX}
10071 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10072 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10073 terminated by the next space or %.
10075 @item %w
10076 Marks the argument containing or following the @samp{%w} as the
10077 designated output file of this compilation.  This puts the argument
10078 into the sequence of arguments that @samp{%o} substitutes.
10080 @item %o
10081 Substitutes the names of all the output files, with spaces
10082 automatically placed around them.  You should write spaces
10083 around the @samp{%o} as well or the results are undefined.
10084 @samp{%o} is for use in the specs for running the linker.
10085 Input files whose names have no recognized suffix are not compiled
10086 at all, but they are included among the output files, so they are
10087 linked.
10089 @item %O
10090 Substitutes the suffix for object files.  Note that this is
10091 handled specially when it immediately follows @samp{%g, %u, or %U},
10092 because of the need for those to form complete file names.  The
10093 handling is such that @samp{%O} is treated exactly as if it had already
10094 been substituted, except that @samp{%g, %u, and %U} do not currently
10095 support additional @var{suffix} characters following @samp{%O} as they do
10096 following, for example, @samp{.o}.
10098 @item %p
10099 Substitutes the standard macro predefinitions for the
10100 current target machine.  Use this when running @code{cpp}.
10102 @item %P
10103 Like @samp{%p}, but puts @samp{__} before and after the name of each
10104 predefined macro, except for macros that start with @samp{__} or with
10105 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10108 @item %I
10109 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10110 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10111 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10112 and @option{-imultilib} as necessary.
10114 @item %s
10115 Current argument is the name of a library or startup file of some sort.
10116 Search for that file in a standard list of directories and substitute
10117 the full name found.  The current working directory is included in the
10118 list of directories scanned.
10120 @item %T
10121 Current argument is the name of a linker script.  Search for that file
10122 in the current list of directories to scan for libraries. If the file
10123 is located insert a @option{--script} option into the command line
10124 followed by the full path name found.  If the file is not found then
10125 generate an error message.  Note: the current working directory is not
10126 searched.
10128 @item %e@var{str}
10129 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10130 Use this when inconsistent options are detected.
10132 @item %(@var{name})
10133 Substitute the contents of spec string @var{name} at this point.
10135 @item %x@{@var{option}@}
10136 Accumulate an option for @samp{%X}.
10138 @item %X
10139 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10140 spec string.
10142 @item %Y
10143 Output the accumulated assembler options specified by @option{-Wa}.
10145 @item %Z
10146 Output the accumulated preprocessor options specified by @option{-Wp}.
10148 @item %a
10149 Process the @code{asm} spec.  This is used to compute the
10150 switches to be passed to the assembler.
10152 @item %A
10153 Process the @code{asm_final} spec.  This is a spec string for
10154 passing switches to an assembler post-processor, if such a program is
10155 needed.
10157 @item %l
10158 Process the @code{link} spec.  This is the spec for computing the
10159 command line passed to the linker.  Typically it makes use of the
10160 @samp{%L %G %S %D and %E} sequences.
10162 @item %D
10163 Dump out a @option{-L} option for each directory that GCC believes might
10164 contain startup files.  If the target supports multilibs then the
10165 current multilib directory is prepended to each of these paths.
10167 @item %L
10168 Process the @code{lib} spec.  This is a spec string for deciding which
10169 libraries are included on the command line to the linker.
10171 @item %G
10172 Process the @code{libgcc} spec.  This is a spec string for deciding
10173 which GCC support library is included on the command line to the linker.
10175 @item %S
10176 Process the @code{startfile} spec.  This is a spec for deciding which
10177 object files are the first ones passed to the linker.  Typically
10178 this might be a file named @file{crt0.o}.
10180 @item %E
10181 Process the @code{endfile} spec.  This is a spec string that specifies
10182 the last object files that are passed to the linker.
10184 @item %C
10185 Process the @code{cpp} spec.  This is used to construct the arguments
10186 to be passed to the C preprocessor.
10188 @item %1
10189 Process the @code{cc1} spec.  This is used to construct the options to be
10190 passed to the actual C compiler (@samp{cc1}).
10192 @item %2
10193 Process the @code{cc1plus} spec.  This is used to construct the options to be
10194 passed to the actual C++ compiler (@samp{cc1plus}).
10196 @item %*
10197 Substitute the variable part of a matched option.  See below.
10198 Note that each comma in the substituted string is replaced by
10199 a single space.
10201 @item %<@code{S}
10202 Remove all occurrences of @code{-S} from the command line.  Note---this
10203 command is position dependent.  @samp{%} commands in the spec string
10204 before this one see @code{-S}, @samp{%} commands in the spec string
10205 after this one do not.
10207 @item %:@var{function}(@var{args})
10208 Call the named function @var{function}, passing it @var{args}.
10209 @var{args} is first processed as a nested spec string, then split
10210 into an argument vector in the usual fashion.  The function returns
10211 a string which is processed as if it had appeared literally as part
10212 of the current spec.
10214 The following built-in spec functions are provided:
10216 @table @code
10217 @item @code{getenv}
10218 The @code{getenv} spec function takes two arguments: an environment
10219 variable name and a string.  If the environment variable is not
10220 defined, a fatal error is issued.  Otherwise, the return value is the
10221 value of the environment variable concatenated with the string.  For
10222 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10224 @smallexample
10225 %:getenv(TOPDIR /include)
10226 @end smallexample
10228 expands to @file{/path/to/top/include}.
10230 @item @code{if-exists}
10231 The @code{if-exists} spec function takes one argument, an absolute
10232 pathname to a file.  If the file exists, @code{if-exists} returns the
10233 pathname.  Here is a small example of its usage:
10235 @smallexample
10236 *startfile:
10237 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10238 @end smallexample
10240 @item @code{if-exists-else}
10241 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10242 spec function, except that it takes two arguments.  The first argument is
10243 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10244 returns the pathname.  If it does not exist, it returns the second argument.
10245 This way, @code{if-exists-else} can be used to select one file or another,
10246 based on the existence of the first.  Here is a small example of its usage:
10248 @smallexample
10249 *startfile:
10250 crt0%O%s %:if-exists(crti%O%s) \
10251 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10252 @end smallexample
10254 @item @code{replace-outfile}
10255 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10256 first argument in the outfiles array and replaces it with the second argument.  Here
10257 is a small example of its usage:
10259 @smallexample
10260 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10261 @end smallexample
10263 @item @code{remove-outfile}
10264 The @code{remove-outfile} spec function takes one argument.  It looks for the
10265 first argument in the outfiles array and removes it.  Here is a small example
10266 its usage:
10268 @smallexample
10269 %:remove-outfile(-lm)
10270 @end smallexample
10272 @item @code{pass-through-libs}
10273 The @code{pass-through-libs} spec function takes any number of arguments.  It
10274 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10275 assumes are the names of linker input library archive files) and returns a
10276 result containing all the found arguments each prepended by
10277 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10278 intended to be passed to the LTO linker plugin.
10280 @smallexample
10281 %:pass-through-libs(%G %L %G)
10282 @end smallexample
10284 @item @code{print-asm-header}
10285 The @code{print-asm-header} function takes no arguments and simply
10286 prints a banner like:
10288 @smallexample
10289 Assembler options
10290 =================
10292 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10293 @end smallexample
10295 It is used to separate compiler options from assembler options
10296 in the @option{--target-help} output.
10297 @end table
10299 @item %@{@code{S}@}
10300 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10301 If that switch is not specified, this substitutes nothing.  Note that
10302 the leading dash is omitted when specifying this option, and it is
10303 automatically inserted if the substitution is performed.  Thus the spec
10304 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10305 and outputs the command-line option @option{-foo}.
10307 @item %W@{@code{S}@}
10308 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10309 deleted on failure.
10311 @item %@{@code{S}*@}
10312 Substitutes all the switches specified to GCC whose names start
10313 with @code{-S}, but which also take an argument.  This is used for
10314 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10315 GCC considers @option{-o foo} as being
10316 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10317 text, including the space.  Thus two arguments are generated.
10319 @item %@{@code{S}*&@code{T}*@}
10320 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10321 (the order of @code{S} and @code{T} in the spec is not significant).
10322 There can be any number of ampersand-separated variables; for each the
10323 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10325 @item %@{@code{S}:@code{X}@}
10326 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10328 @item %@{!@code{S}:@code{X}@}
10329 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10331 @item %@{@code{S}*:@code{X}@}
10332 Substitutes @code{X} if one or more switches whose names start with
10333 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10334 once, no matter how many such switches appeared.  However, if @code{%*}
10335 appears somewhere in @code{X}, then @code{X} is substituted once
10336 for each matching switch, with the @code{%*} replaced by the part of
10337 that switch matching the @code{*}.
10339 @item %@{.@code{S}:@code{X}@}
10340 Substitutes @code{X}, if processing a file with suffix @code{S}.
10342 @item %@{!.@code{S}:@code{X}@}
10343 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10345 @item %@{,@code{S}:@code{X}@}
10346 Substitutes @code{X}, if processing a file for language @code{S}.
10348 @item %@{!,@code{S}:@code{X}@}
10349 Substitutes @code{X}, if not processing a file for language @code{S}.
10351 @item %@{@code{S}|@code{P}:@code{X}@}
10352 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10353 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10354 @code{*} sequences as well, although they have a stronger binding than
10355 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10356 alternatives must be starred, and only the first matching alternative
10357 is substituted.
10359 For example, a spec string like this:
10361 @smallexample
10362 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10363 @end smallexample
10365 @noindent
10366 outputs the following command-line options from the following input
10367 command-line options:
10369 @smallexample
10370 fred.c        -foo -baz
10371 jim.d         -bar -boggle
10372 -d fred.c     -foo -baz -boggle
10373 -d jim.d      -bar -baz -boggle
10374 @end smallexample
10376 @item %@{S:X; T:Y; :D@}
10378 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10379 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10380 be as many clauses as you need.  This may be combined with @code{.},
10381 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10384 @end table
10386 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10387 construct may contain other nested @samp{%} constructs or spaces, or
10388 even newlines.  They are processed as usual, as described above.
10389 Trailing white space in @code{X} is ignored.  White space may also
10390 appear anywhere on the left side of the colon in these constructs,
10391 except between @code{.} or @code{*} and the corresponding word.
10393 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10394 handled specifically in these constructs.  If another value of
10395 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10396 @option{-W} switch is found later in the command line, the earlier
10397 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10398 just one letter, which passes all matching options.
10400 The character @samp{|} at the beginning of the predicate text is used to
10401 indicate that a command should be piped to the following command, but
10402 only if @option{-pipe} is specified.
10404 It is built into GCC which switches take arguments and which do not.
10405 (You might think it would be useful to generalize this to allow each
10406 compiler's spec to say which switches take arguments.  But this cannot
10407 be done in a consistent fashion.  GCC cannot even decide which input
10408 files have been specified without knowing which switches take arguments,
10409 and it must know which input files to compile in order to tell which
10410 compilers to run).
10412 GCC also knows implicitly that arguments starting in @option{-l} are to be
10413 treated as compiler output files, and passed to the linker in their
10414 proper position among the other output files.
10416 @c man begin OPTIONS
10418 @node Target Options
10419 @section Specifying Target Machine and Compiler Version
10420 @cindex target options
10421 @cindex cross compiling
10422 @cindex specifying machine version
10423 @cindex specifying compiler version and target machine
10424 @cindex compiler version, specifying
10425 @cindex target machine, specifying
10427 The usual way to run GCC is to run the executable called @command{gcc}, or
10428 @command{@var{machine}-gcc} when cross-compiling, or
10429 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10430 one that was installed last.
10432 @node Submodel Options
10433 @section Hardware Models and Configurations
10434 @cindex submodel options
10435 @cindex specifying hardware config
10436 @cindex hardware models and configurations, specifying
10437 @cindex machine dependent options
10439 Each target machine types can have its own
10440 special options, starting with @samp{-m}, to choose among various
10441 hardware models or configurations---for example, 68010 vs 68020,
10442 floating coprocessor or none.  A single installed version of the
10443 compiler can compile for any model or configuration, according to the
10444 options specified.
10446 Some configurations of the compiler also support additional special
10447 options, usually for compatibility with other compilers on the same
10448 platform.
10450 @c This list is ordered alphanumerically by subsection name.
10451 @c It should be the same order and spelling as these options are listed
10452 @c in Machine Dependent Options
10454 @menu
10455 * Adapteva Epiphany Options::
10456 * ARM Options::
10457 * AVR Options::
10458 * Blackfin Options::
10459 * C6X Options::
10460 * CRIS Options::
10461 * CR16 Options::
10462 * Darwin Options::
10463 * DEC Alpha Options::
10464 * FR30 Options::
10465 * FRV Options::
10466 * GNU/Linux Options::
10467 * H8/300 Options::
10468 * HPPA Options::
10469 * i386 and x86-64 Options::
10470 * i386 and x86-64 Windows Options::
10471 * IA-64 Options::
10472 * LM32 Options::
10473 * M32C Options::
10474 * M32R/D Options::
10475 * M680x0 Options::
10476 * MCore Options::
10477 * MeP Options::
10478 * MicroBlaze Options::
10479 * MIPS Options::
10480 * MMIX Options::
10481 * MN10300 Options::
10482 * PDP-11 Options::
10483 * picoChip Options::
10484 * PowerPC Options::
10485 * RL78 Options::
10486 * RS/6000 and PowerPC Options::
10487 * RX Options::
10488 * S/390 and zSeries Options::
10489 * Score Options::
10490 * SH Options::
10491 * Solaris 2 Options::
10492 * SPARC Options::
10493 * SPU Options::
10494 * System V Options::
10495 * TILE-Gx Options::
10496 * TILEPro Options::
10497 * V850 Options::
10498 * VAX Options::
10499 * VMS Options::
10500 * VxWorks Options::
10501 * x86-64 Options::
10502 * Xstormy16 Options::
10503 * Xtensa Options::
10504 * zSeries Options::
10505 @end menu
10507 @node Adapteva Epiphany Options
10508 @subsection Adapteva Epiphany Options
10510 These @samp{-m} options are defined for Adapteva Epiphany:
10512 @table @gcctabopt
10513 @item -mhalf-reg-file
10514 @opindex mhalf-reg-file
10515 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10516 That allows code to run on hardware variants that lack these registers.
10518 @item -mprefer-short-insn-regs
10519 @opindex mprefer-short-insn-regs
10520 Preferrentially allocate registers that allow short instruction generation.
10521 This can result in increasesd instruction count, so if this reduces or
10522 increases code size might vary from case to case.
10524 @item -mbranch-cost=@var{num}
10525 @opindex mbranch-cost
10526 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10527 This cost is only a heuristic and is not guaranteed to produce
10528 consistent results across releases.
10530 @item -mcmove
10531 @opindex mcmove
10532 Enable the generation of conditional moves.
10534 @item -mnops=@var{num}
10535 @opindex mnops
10536 Emit @var{num} nops before every other generated instruction.
10538 @item -mno-soft-cmpsf
10539 @opindex mno-soft-cmpsf
10540 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10541 and test the flags.  This is faster than a software comparison, but can
10542 get incorrect results in the presence of NaNs, or when two different small
10543 numbers are compared such that their difference is calculated as zero.
10544 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10545 software comparisons.
10547 @item -mstack-offset=@var{num}
10548 @opindex mstack-offset
10549 Set the offset between the top of the stack and the stack pointer.
10550 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10551 can be used by leaf functions without stack allocation.
10552 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10553 Note also that this option changes the ABI, compiling a program with a
10554 different stack offset than the libraries have been compiled with
10555 generally does not work.
10556 This option can be useful if you want to evaluate if a different stack
10557 offset would give you better code, but to actually use a different stack
10558 offset to build working programs, it is recommended to configure the
10559 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10561 @item -mno-round-nearest
10562 @opindex mno-round-nearest
10563 Make the scheduler assume that the rounding mode has been set to
10564 truncating.  The default is @option{-mround-nearest}.
10566 @item -mlong-calls
10567 @opindex mlong-calls
10568 If not otherwise specified by an attribute, assume all calls might be beyond
10569 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10570 function address into a register before performing a (otherwise direct) call.
10571 This is the default.
10573 @item -mshort-calls
10574 @opindex short-calls
10575 If not otherwise specified by an attribute, assume all direct calls are
10576 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10577 for direct calls.  The default is @option{-mlong-calls}.
10579 @item -msmall16
10580 @opindex msmall16
10581 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10582 apply to function addresses for which @option{-mlong-calls} semantics
10583 are in effect.
10585 @item -mfp-mode=@var{mode}
10586 @opindex mfp-mode
10587 Set the prevailing mode of the floating-point unit.
10588 This determines the floating-point mode that is provided and expected
10589 at function call and return time.  Making this mode match the mode you
10590 predominantly need at function start can make your programs smaller and
10591 faster by avoiding unnecessary mode switches.
10593 @var{mode} can be set to one the following values:
10595 @table @samp
10596 @item caller
10597 Any mode at function entry is valid, and retained or restored when
10598 the function returns, and when it calls other functions.
10599 This mode is useful for compiling libraries or other compilation units
10600 you might want to incorporate into different programs with different
10601 prevailing FPU modes, and the convenience of being able to use a single
10602 object file outweighs the size and speed overhead for any extra
10603 mode switching that might be needed, compared with what would be needed
10604 with a more specific choice of prevailing FPU mode.
10606 @item truncate
10607 This is the mode used for floating-point calculations with
10608 truncating (i.e.@: round towards zero) rounding mode.  That includes
10609 conversion from floating point to integer.
10611 @item round-nearest
10612 This is the mode used for floating-point calculations with
10613 round-to-nearest-or-even rounding mode.
10615 @item int
10616 This is the mode used to perform integer calculations in the FPU, e.g.@:
10617 integer multiply, or integer multiply-and-accumulate.
10618 @end table
10620 The default is @option{-mfp-mode=caller}
10622 @item -mnosplit-lohi
10623 @opindex mnosplit-lohi
10624 @item -mno-postinc
10625 @opindex mno-postinc
10626 @item -mno-postmodify
10627 @opindex mno-postmodify
10628 Code generation tweaks that disable, respectively, splitting of 32-bit
10629 loads, generation of post-increment addresses, and generation of
10630 post-modify addresses.  The defaults are @option{msplit-lohi},
10631 @option{-mpost-inc}, and @option{-mpost-modify}.
10633 @item -mnovect-double
10634 @opindex mno-vect-double
10635 Change the preferred SIMD mode to SImode.  The default is
10636 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10638 @item -max-vect-align=@var{num}
10639 @opindex max-vect-align
10640 The maximum alignment for SIMD vector mode types.
10641 @var{num} may be 4 or 8.  The default is 8.
10642 Note that this is an ABI change, even though many library function
10643 interfaces are unaffected if they don't use SIMD vector modes
10644 in places that affect size and/or alignment of relevant types.
10646 @item -msplit-vecmove-early
10647 @opindex msplit-vecmove-early
10648 Split vector moves into single word moves before reload.  In theory this
10649 can give better register allocation, but so far the reverse seems to be
10650 generally the case.
10652 @item -m1reg-@var{reg}
10653 @opindex m1reg-
10654 Specify a register to hold the constant @minus{}1, which makes loading small negative
10655 constants and certain bitmasks faster.
10656 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10657 which specify use of that register as a fixed register,
10658 and @samp{none}, which means that no register is used for this
10659 purpose.  The default is @option{-m1reg-none}.
10661 @end table
10663 @node ARM Options
10664 @subsection ARM Options
10665 @cindex ARM options
10667 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10668 architectures:
10670 @table @gcctabopt
10671 @item -mabi=@var{name}
10672 @opindex mabi
10673 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10674 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10676 @item -mapcs-frame
10677 @opindex mapcs-frame
10678 Generate a stack frame that is compliant with the ARM Procedure Call
10679 Standard for all functions, even if this is not strictly necessary for
10680 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10681 with this option causes the stack frames not to be generated for
10682 leaf functions.  The default is @option{-mno-apcs-frame}.
10684 @item -mapcs
10685 @opindex mapcs
10686 This is a synonym for @option{-mapcs-frame}.
10688 @ignore
10689 @c not currently implemented
10690 @item -mapcs-stack-check
10691 @opindex mapcs-stack-check
10692 Generate code to check the amount of stack space available upon entry to
10693 every function (that actually uses some stack space).  If there is
10694 insufficient space available then either the function
10695 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
10696 called, depending upon the amount of stack space required.  The runtime
10697 system is required to provide these functions.  The default is
10698 @option{-mno-apcs-stack-check}, since this produces smaller code.
10700 @c not currently implemented
10701 @item -mapcs-float
10702 @opindex mapcs-float
10703 Pass floating-point arguments using the floating-point registers.  This is
10704 one of the variants of the APCS@.  This option is recommended if the
10705 target hardware has a floating-point unit or if a lot of floating-point
10706 arithmetic is going to be performed by the code.  The default is
10707 @option{-mno-apcs-float}, since integer only code is slightly increased in
10708 size if @option{-mapcs-float} is used.
10710 @c not currently implemented
10711 @item -mapcs-reentrant
10712 @opindex mapcs-reentrant
10713 Generate reentrant, position independent code.  The default is
10714 @option{-mno-apcs-reentrant}.
10715 @end ignore
10717 @item -mthumb-interwork
10718 @opindex mthumb-interwork
10719 Generate code that supports calling between the ARM and Thumb
10720 instruction sets.  Without this option, on pre-v5 architectures, the
10721 two instruction sets cannot be reliably used inside one program.  The
10722 default is @option{-mno-thumb-interwork}, since slightly larger code
10723 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10724 configurations this option is meaningless.
10726 @item -mno-sched-prolog
10727 @opindex mno-sched-prolog
10728 Prevent the reordering of instructions in the function prologue, or the
10729 merging of those instruction with the instructions in the function's
10730 body.  This means that all functions start with a recognizable set
10731 of instructions (or in fact one of a choice from a small set of
10732 different function prologues), and this information can be used to
10733 locate the start of functions inside an executable piece of code.  The
10734 default is @option{-msched-prolog}.
10736 @item -mfloat-abi=@var{name}
10737 @opindex mfloat-abi
10738 Specifies which floating-point ABI to use.  Permissible values
10739 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10741 Specifying @samp{soft} causes GCC to generate output containing
10742 library calls for floating-point operations.
10743 @samp{softfp} allows the generation of code using hardware floating-point
10744 instructions, but still uses the soft-float calling conventions.
10745 @samp{hard} allows generation of floating-point instructions
10746 and uses FPU-specific calling conventions.
10748 The default depends on the specific target configuration.  Note that
10749 the hard-float and soft-float ABIs are not link-compatible; you must
10750 compile your entire program with the same ABI, and link with a
10751 compatible set of libraries.
10753 @item -mlittle-endian
10754 @opindex mlittle-endian
10755 Generate code for a processor running in little-endian mode.  This is
10756 the default for all standard configurations.
10758 @item -mbig-endian
10759 @opindex mbig-endian
10760 Generate code for a processor running in big-endian mode; the default is
10761 to compile code for a little-endian processor.
10763 @item -mwords-little-endian
10764 @opindex mwords-little-endian
10765 This option only applies when generating code for big-endian processors.
10766 Generate code for a little-endian word order but a big-endian byte
10767 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10768 option should only be used if you require compatibility with code for
10769 big-endian ARM processors generated by versions of the compiler prior to
10770 2.8.  This option is now deprecated.
10772 @item -mcpu=@var{name}
10773 @opindex mcpu
10774 This specifies the name of the target ARM processor.  GCC uses this name
10775 to determine what kind of instructions it can emit when generating
10776 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10777 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10778 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10779 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10780 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10781 @samp{arm720},
10782 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10783 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10784 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10785 @samp{strongarm1110},
10786 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10787 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10788 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10789 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10790 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10791 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10792 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10793 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
10794 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10795 @samp{cortex-m4}, @samp{cortex-m3},
10796 @samp{cortex-m1},
10797 @samp{cortex-m0},
10798 @samp{cortex-m0plus},
10799 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10800 @samp{fa526}, @samp{fa626},
10801 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10804 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10805 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10806 See @option{-mtune} for more information.
10808 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10809 of the build computer.  At present, this feature is only supported on
10810 Linux, and not all architectures are recognized.  If the auto-detect is
10811 unsuccessful the option has no effect.
10813 @item -mtune=@var{name}
10814 @opindex mtune
10815 This option is very similar to the @option{-mcpu=} option, except that
10816 instead of specifying the actual target processor type, and hence
10817 restricting which instructions can be used, it specifies that GCC should
10818 tune the performance of the code as if the target were of the type
10819 specified in this option, but still choosing the instructions it
10820 generates based on the CPU specified by a @option{-mcpu=} option.
10821 For some ARM implementations better performance can be obtained by using
10822 this option.
10824 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10825 performance for a blend of processors within architecture @var{arch}.
10826 The aim is to generate code that run well on the current most popular
10827 processors, balancing between optimizations that benefit some CPUs in the
10828 range, and avoiding performance pitfalls of other CPUs.  The effects of
10829 this option may change in future GCC versions as CPU models come and go.
10831 @option{-mtune=native} causes the compiler to auto-detect the CPU
10832 of the build computer.  At present, this feature is only supported on
10833 Linux, and not all architectures are recognized.  If the auto-detect is
10834 unsuccessful the option has no effect.
10836 @item -march=@var{name}
10837 @opindex march
10838 This specifies the name of the target ARM architecture.  GCC uses this
10839 name to determine what kind of instructions it can emit when generating
10840 assembly code.  This option can be used in conjunction with or instead
10841 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10842 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10843 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10844 @samp{armv6}, @samp{armv6j},
10845 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10846 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10847 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10849 @option{-march=native} causes the compiler to auto-detect the architecture
10850 of the build computer.  At present, this feature is only supported on
10851 Linux, and not all architectures are recognized.  If the auto-detect is
10852 unsuccessful the option has no effect.
10854 @item -mfpu=@var{name}
10855 @opindex mfpu
10856 This specifies what floating-point hardware (or hardware emulation) is
10857 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
10858 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
10859 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
10860 @samp{vfpv4-d16}, @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10862 If @option{-msoft-float} is specified this specifies the format of
10863 floating-point values.
10865 If the selected floating-point hardware includes the NEON extension
10866 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10867 operations are not generated by GCC's auto-vectorization pass unless
10868 @option{-funsafe-math-optimizations} is also specified.  This is
10869 because NEON hardware does not fully implement the IEEE 754 standard for
10870 floating-point arithmetic (in particular denormal values are treated as
10871 zero), so the use of NEON instructions may lead to a loss of precision.
10873 @item -mfp16-format=@var{name}
10874 @opindex mfp16-format
10875 Specify the format of the @code{__fp16} half-precision floating-point type.
10876 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10877 the default is @samp{none}, in which case the @code{__fp16} type is not
10878 defined.  @xref{Half-Precision}, for more information.
10880 @item -mstructure-size-boundary=@var{n}
10881 @opindex mstructure-size-boundary
10882 The sizes of all structures and unions are rounded up to a multiple
10883 of the number of bits set by this option.  Permissible values are 8, 32
10884 and 64.  The default value varies for different toolchains.  For the COFF
10885 targeted toolchain the default value is 8.  A value of 64 is only allowed
10886 if the underlying ABI supports it.
10888 Specifying the larger number can produce faster, more efficient code, but
10889 can also increase the size of the program.  Different values are potentially
10890 incompatible.  Code compiled with one value cannot necessarily expect to
10891 work with code or libraries compiled with another value, if they exchange
10892 information using structures or unions.
10894 @item -mabort-on-noreturn
10895 @opindex mabort-on-noreturn
10896 Generate a call to the function @code{abort} at the end of a
10897 @code{noreturn} function.  It is executed if the function tries to
10898 return.
10900 @item -mlong-calls
10901 @itemx -mno-long-calls
10902 @opindex mlong-calls
10903 @opindex mno-long-calls
10904 Tells the compiler to perform function calls by first loading the
10905 address of the function into a register and then performing a subroutine
10906 call on this register.  This switch is needed if the target function
10907 lies outside of the 64-megabyte addressing range of the offset-based
10908 version of subroutine call instruction.
10910 Even if this switch is enabled, not all function calls are turned
10911 into long calls.  The heuristic is that static functions, functions
10912 that have the @samp{short-call} attribute, functions that are inside
10913 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
10914 definitions have already been compiled within the current compilation
10915 unit are not turned into long calls.  The exceptions to this rule are
10916 that weak function definitions, functions with the @samp{long-call}
10917 attribute or the @samp{section} attribute, and functions that are within
10918 the scope of a @samp{#pragma long_calls} directive are always
10919 turned into long calls.
10921 This feature is not enabled by default.  Specifying
10922 @option{-mno-long-calls} restores the default behavior, as does
10923 placing the function calls within the scope of a @samp{#pragma
10924 long_calls_off} directive.  Note these switches have no effect on how
10925 the compiler generates code to handle function calls via function
10926 pointers.
10928 @item -msingle-pic-base
10929 @opindex msingle-pic-base
10930 Treat the register used for PIC addressing as read-only, rather than
10931 loading it in the prologue for each function.  The runtime system is
10932 responsible for initializing this register with an appropriate value
10933 before execution begins.
10935 @item -mpic-register=@var{reg}
10936 @opindex mpic-register
10937 Specify the register to be used for PIC addressing.  The default is R10
10938 unless stack-checking is enabled, when R9 is used.
10940 @item -mcirrus-fix-invalid-insns
10941 @opindex mcirrus-fix-invalid-insns
10942 @opindex mno-cirrus-fix-invalid-insns
10943 Insert NOPs into the instruction stream to in order to work around
10944 problems with invalid Maverick instruction combinations.  This option
10945 is only valid if the @option{-mcpu=ep9312} option has been used to
10946 enable generation of instructions for the Cirrus Maverick floating-point
10947 co-processor.  This option is not enabled by default, since the
10948 problem is only present in older Maverick implementations.  The default
10949 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10950 switch.
10952 @item -mpoke-function-name
10953 @opindex mpoke-function-name
10954 Write the name of each function into the text section, directly
10955 preceding the function prologue.  The generated code is similar to this:
10957 @smallexample
10958      t0
10959          .ascii "arm_poke_function_name", 0
10960          .align
10961      t1
10962          .word 0xff000000 + (t1 - t0)
10963      arm_poke_function_name
10964          mov     ip, sp
10965          stmfd   sp!, @{fp, ip, lr, pc@}
10966          sub     fp, ip, #4
10967 @end smallexample
10969 When performing a stack backtrace, code can inspect the value of
10970 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10971 location @code{pc - 12} and the top 8 bits are set, then we know that
10972 there is a function name embedded immediately preceding this location
10973 and has length @code{((pc[-3]) & 0xff000000)}.
10975 @item -mthumb
10976 @itemx -marm
10977 @opindex marm
10978 @opindex mthumb
10980 Select between generating code that executes in ARM and Thumb
10981 states.  The default for most configurations is to generate code
10982 that executes in ARM state, but the default can be changed by
10983 configuring GCC with the @option{--with-mode=}@var{state}
10984 configure option.
10986 @item -mtpcs-frame
10987 @opindex mtpcs-frame
10988 Generate a stack frame that is compliant with the Thumb Procedure Call
10989 Standard for all non-leaf functions.  (A leaf function is one that does
10990 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10992 @item -mtpcs-leaf-frame
10993 @opindex mtpcs-leaf-frame
10994 Generate a stack frame that is compliant with the Thumb Procedure Call
10995 Standard for all leaf functions.  (A leaf function is one that does
10996 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10998 @item -mcallee-super-interworking
10999 @opindex mcallee-super-interworking
11000 Gives all externally visible functions in the file being compiled an ARM
11001 instruction set header which switches to Thumb mode before executing the
11002 rest of the function.  This allows these functions to be called from
11003 non-interworking code.  This option is not valid in AAPCS configurations
11004 because interworking is enabled by default.
11006 @item -mcaller-super-interworking
11007 @opindex mcaller-super-interworking
11008 Allows calls via function pointers (including virtual functions) to
11009 execute correctly regardless of whether the target code has been
11010 compiled for interworking or not.  There is a small overhead in the cost
11011 of executing a function pointer if this option is enabled.  This option
11012 is not valid in AAPCS configurations because interworking is enabled
11013 by default.
11015 @item -mtp=@var{name}
11016 @opindex mtp
11017 Specify the access model for the thread local storage pointer.  The valid
11018 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11019 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11020 (supported in the arm6k architecture), and @option{auto}, which uses the
11021 best available method for the selected processor.  The default setting is
11022 @option{auto}.
11024 @item -mtls-dialect=@var{dialect}
11025 @opindex mtls-dialect
11026 Specify the dialect to use for accessing thread local storage.  Two
11027 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11028 @samp{gnu} dialect selects the original GNU scheme for supporting
11029 local and global dynamic TLS models.  The @samp{gnu2} dialect
11030 selects the GNU descriptor scheme, which provides better performance
11031 for shared libraries.  The GNU descriptor scheme is compatible with
11032 the original scheme, but does require new assembler, linker and
11033 library support.  Initial and local exec TLS models are unaffected by
11034 this option and always use the original scheme.
11036 @item -mword-relocations
11037 @opindex mword-relocations
11038 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11039 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11040 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11041 is specified.
11043 @item -mfix-cortex-m3-ldrd
11044 @opindex mfix-cortex-m3-ldrd
11045 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11046 with overlapping destination and base registers are used.  This option avoids
11047 generating these instructions.  This option is enabled by default when
11048 @option{-mcpu=cortex-m3} is specified.
11050 @item -munaligned-access
11051 @itemx -mno-unaligned-access
11052 @opindex munaligned-access
11053 @opindex mno-unaligned-access
11054 Enables (or disables) reading and writing of 16- and 32- bit values
11055 from addresses that are not 16- or 32- bit aligned.  By default
11056 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11057 architectures, and enabled for all other architectures.  If unaligned
11058 access is not enabled then words in packed data structures will be
11059 accessed a byte at a time.
11061 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11062 generated object file to either true or false, depending upon the
11063 setting of this option.  If unaligned access is enabled then the
11064 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11065 defined.
11067 @end table
11069 @node AVR Options
11070 @subsection AVR Options
11071 @cindex AVR Options
11073 These options are defined for AVR implementations:
11075 @table @gcctabopt
11076 @item -mmcu=@var{mcu}
11077 @opindex mmcu
11078 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11080 For a complete list of @var{mcu} values that are supported by @command{avr-gcc},
11081 see the compiler output when called with the @option{--help=target}
11082 command line option.
11083 The default for this option is@tie{}@code{avr2}.
11085 GCC supports the following AVR devices and ISAs:
11087 @include avr-mmcu.texi
11089 @item -maccumulate-args
11090 @opindex maccumulate-args
11091 Accumulate outgoing function arguments and acquire/release the needed
11092 stack space for outgoing function arguments once in function
11093 prologue/epilogue.  Without this option, outgoing arguments are pushed
11094 before calling a function and popped afterwards.
11096 Popping the arguments after the function call can be expensive on
11097 AVR so that accumulating the stack space might lead to smaller
11098 executables because arguments need not to be removed from the
11099 stack after such a function call.
11101 This option can lead to reduced code size for functions that perform
11102 several calls to functions that get their arguments on the stack like
11103 calls to printf-like functions.
11105 @item -mbranch-cost=@var{cost}
11106 @opindex mbranch-cost
11107 Set the branch costs for conditional branch instructions to
11108 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11109 integers. The default branch cost is 0.
11111 @item -mcall-prologues
11112 @opindex mcall-prologues
11113 Functions prologues/epilogues are expanded as calls to appropriate
11114 subroutines.  Code size is smaller.
11116 @item -mint8
11117 @opindex mint8
11118 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11119 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11120 and @code{long long} is 4 bytes.  Please note that this option does not
11121 conform to the C standards, but it results in smaller code
11122 size.
11124 @item -mno-interrupts
11125 @opindex mno-interrupts
11126 Generated code is not compatible with hardware interrupts.
11127 Code size is smaller.
11129 @item -mrelax
11130 @opindex mrelax
11131 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11132 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11133 Setting @code{-mrelax} just adds the @code{--relax} option to the
11134 linker command line when the linker is called.
11136 Jump relaxing is performed by the linker because jump offsets are not
11137 known before code is located. Therefore, the assembler code generated by the
11138 compiler is the same, but the instructions in the executable may
11139 differ from instructions in the assembler code.
11141 Relaxing must be turned on if linker stubs are needed, see the
11142 section on @code{EIND} and linker stubs below.
11144 @item -mshort-calls
11145 @opindex mshort-calls
11146 Use @code{RCALL}/@code{RJMP} instructions even on devices with
11147 16@tie{}KiB or more of program memory, i.e.@: on devices that
11148 have the @code{CALL} and @code{JMP} instructions.
11149 See also the @code{-mrelax} command line option.
11151 @item -msp8
11152 @opindex msp8
11153 Treat the stack pointer register as an 8-bit register,
11154 i.e.@: assume the high byte of the stack pointer is zero.
11155 In general, you don't need to set this option by hand.
11157 This option is used internally by the compiler to select and
11158 build multilibs for architectures @code{avr2} and @code{avr25}.
11159 These architectures mix devices with and without @code{SPH}.
11160 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11161 the compiler driver will add or remove this option from the compiler
11162 proper's command line, because the compiler then knows if the device
11163 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11164 register or not.
11166 @item -mstrict-X
11167 @opindex mstrict-X
11168 Use address register @code{X} in a way proposed by the hardware.  This means
11169 that @code{X} is only used in indirect, post-increment or
11170 pre-decrement addressing.
11172 Without this option, the @code{X} register may be used in the same way
11173 as @code{Y} or @code{Z} which then is emulated by additional
11174 instructions.  
11175 For example, loading a value with @code{X+const} addressing with a
11176 small non-negative @code{const < 64} to a register @var{Rn} is
11177 performed as
11179 @example
11180 adiw r26, const   ; X += const
11181 ld   @var{Rn}, X        ; @var{Rn} = *X
11182 sbiw r26, const   ; X -= const
11183 @end example
11185 @item -mtiny-stack
11186 @opindex mtiny-stack
11187 Only change the lower 8@tie{}bits of the stack pointer.
11188 @end table
11190 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11191 @cindex @code{EIND}
11192 Pointers in the implementation are 16@tie{}bits wide.
11193 The address of a function or label is represented as word address so
11194 that indirect jumps and calls can target any code address in the
11195 range of 64@tie{}Ki words.
11197 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11198 bytes of program memory space, there is a special function register called
11199 @code{EIND} that serves as most significant part of the target address
11200 when @code{EICALL} or @code{EIJMP} instructions are used.
11202 Indirect jumps and calls on these devices are handled as follows by
11203 the compiler and are subject to some limitations:
11205 @itemize @bullet
11207 @item
11208 The compiler never sets @code{EIND}.
11210 @item
11211 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11212 instructions or might read @code{EIND} directly in order to emulate an
11213 indirect call/jump by means of a @code{RET} instruction.
11215 @item
11216 The compiler assumes that @code{EIND} never changes during the startup
11217 code or during the application. In particular, @code{EIND} is not
11218 saved/restored in function or interrupt service routine
11219 prologue/epilogue.
11221 @item
11222 For indirect calls to functions and computed goto, the linker
11223 generates @emph{stubs}. Stubs are jump pads sometimes also called
11224 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11225 The stub contains a direct jump to the desired address.
11227 @item
11228 Linker relaxation must be turned on so that the linker will generate
11229 the stubs correctly an all situaltion. See the compiler option
11230 @code{-mrelax} and the linler option @code{--relax}.
11231 There are corner cases where the linker is supposed to generate stubs
11232 but aborts without relaxation and without a helpful error message.
11234 @item
11235 The default linker script is arranged for code with @code{EIND = 0}.
11236 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11237 linker script has to be used in order to place the sections whose
11238 name start with @code{.trampolines} into the segment where @code{EIND}
11239 points to.
11241 @item
11242 The startup code from libgcc never sets @code{EIND}.
11243 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11244 For the impact of AVR-LibC on @code{EIND}, see the
11245 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11247 @item
11248 It is legitimate for user-specific startup code to set up @code{EIND}
11249 early, for example by means of initialization code located in
11250 section @code{.init3}. Such code runs prior to general startup code
11251 that initializes RAM and calls constructors, but after the bit
11252 of startup code from AVR-LibC that sets @code{EIND} to the segment
11253 where the vector table is located.
11254 @example
11255 #include <avr/io.h>
11257 static void
11258 __attribute__((section(".init3"),naked,used,no_instrument_function))
11259 init3_set_eind (void)
11261   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11262                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11264 @end example
11266 @noindent
11267 The @code{__trampolines_start} symbol is defined in the linker script.
11269 @item
11270 Stubs are generated automatically by the linker if
11271 the following two conditions are met:
11272 @itemize @minus
11274 @item The address of a label is taken by means of the @code{gs} modifier
11275 (short for @emph{generate stubs}) like so:
11276 @example
11277 LDI r24, lo8(gs(@var{func}))
11278 LDI r25, hi8(gs(@var{func}))
11279 @end example
11280 @item The final location of that label is in a code segment
11281 @emph{outside} the segment where the stubs are located.
11282 @end itemize
11284 @item
11285 The compiler emits such @code{gs} modifiers for code labels in the
11286 following situations:
11287 @itemize @minus
11288 @item Taking address of a function or code label.
11289 @item Computed goto.
11290 @item If prologue-save function is used, see @option{-mcall-prologues}
11291 command-line option.
11292 @item Switch/case dispatch tables. If you do not want such dispatch
11293 tables you can specify the @option{-fno-jump-tables} command-line option.
11294 @item C and C++ constructors/destructors called during startup/shutdown.
11295 @item If the tools hit a @code{gs()} modifier explained above.
11296 @end itemize
11298 @item
11299 Jumping to non-symbolic addresses like so is @emph{not} supported:
11301 @example
11302 int main (void)
11304     /* Call function at word address 0x2 */
11305     return ((int(*)(void)) 0x2)();
11307 @end example
11309 Instead, a stub has to be set up, i.e.@: the function has to be called
11310 through a symbol (@code{func_4} in the example):
11312 @example
11313 int main (void)
11315     extern int func_4 (void);
11317     /* Call function at byte address 0x4 */
11318     return func_4();
11320 @end example
11322 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11323 Alternatively, @code{func_4} can be defined in the linker script.
11324 @end itemize
11326 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11327 @cindex @code{RAMPD}
11328 @cindex @code{RAMPX}
11329 @cindex @code{RAMPY}
11330 @cindex @code{RAMPZ}
11331 Some AVR devices support memories larger than the 64@tie{}KiB range
11332 that can be accessed with 16-bit pointers.  To access memory locations
11333 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11334 register is used as high part of the address:
11335 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11336 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11337 register, respectively, to get a wide address. Similarly,
11338 @code{RAMPD} is used together with direct addressing.
11340 @itemize
11341 @item
11342 The startup code initializes the @code{RAMP} special function
11343 registers with zero.
11345 @item
11346 If a @ref{AVR Named Address Spaces,named address space} other than
11347 generic or @code{__flash} is used, then @code{RAMPZ} is set
11348 as needed before the operation.
11350 @item
11351 If the device supports RAM larger than 64@tie{KiB} and the compiler
11352 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11353 is reset to zero after the operation.
11355 @item
11356 If the device comes with a specific @code{RAMP} register, the ISR
11357 prologue/epilogue saves/restores that SFR and initializes it with
11358 zero in case the ISR code might (implicitly) use it.
11360 @item
11361 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11362 If you use inline assembler to read from locations outside the
11363 16-bit address range and change one of the @code{RAMP} registers,
11364 you must reset it to zero after the access.
11366 @end itemize
11368 @subsubsection AVR Built-in Macros
11370 GCC defines several built-in macros so that the user code can test
11371 for the presence or absence of features.  Almost any of the following
11372 built-in macros are deduced from device capabilities and thus
11373 triggered by the @code{-mmcu=} command-line option.
11375 For even more AVR-specific built-in macros see
11376 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11378 @table @code
11380 @item __AVR_@var{Device}__
11381 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11382 the device's name. For example, @code{-mmcu=atmega8} defines the
11383 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11384 @code{__AVR_ATtiny261A__}, etc.
11386 The built-in macros' names follow
11387 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11388 the device name as from the AVR user manual. The difference between
11389 @var{Device} in the built-in macro and @var{device} in
11390 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11392 @item __AVR_HAVE_ELPM__
11393 The device has the the @code{ELPM} instruction.
11395 @item __AVR_HAVE_ELPMX__
11396 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11397 R@var{n},Z+} instructions.
11399 @item __AVR_HAVE_MOVW__
11400 The device has the @code{MOVW} instruction to perform 16-bit
11401 register-register moves.
11403 @item __AVR_HAVE_LPMX__
11404 The device has the @code{LPM R@var{n},Z} and
11405 @code{LPM R@var{n},Z+} instructions.
11407 @item __AVR_HAVE_MUL__
11408 The device has a hardware multiplier. 
11410 @item __AVR_HAVE_JMP_CALL__
11411 The device has the @code{JMP} and @code{CALL} instructions.
11412 This is the case for devices with at least 16@tie{}KiB of program
11413 memory and if @code{-mshort-calls} is not set.
11415 @item __AVR_HAVE_EIJMP_EICALL__
11416 @item __AVR_3_BYTE_PC__
11417 The device has the @code{EIJMP} and @code{EICALL} instructions.
11418 This is the case for devices with more than 128@tie{}KiB of program memory.
11419 This also means that the program counter
11420 (PC) is 3@tie{}bytes wide.
11422 @item __AVR_2_BYTE_PC__
11423 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11424 with up to 128@tie{}KiB of program memory.
11426 @item __AVR_HAVE_8BIT_SP__
11427 @item __AVR_HAVE_16BIT_SP__
11428 The stack pointer (SP) register is treated as 8-bit respectively
11429 16-bit register by the compiler.
11430 The definition of these macros is affected by @code{-mtiny-stack}.
11432 @item __AVR_HAVE_SPH__
11433 @item __AVR_SP8__
11434 The device has the SPH (high part of stack pointer) special function
11435 register or has an 8-bit stack pointer, respectively.
11436 The definition of these macros is affected by @code{-mmcu=} and
11437 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11438 by @code{-msp8}.
11440 @item __AVR_HAVE_RAMPD__
11441 @item __AVR_HAVE_RAMPX__
11442 @item __AVR_HAVE_RAMPY__
11443 @item __AVR_HAVE_RAMPZ__
11444 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11445 @code{RAMPZ} special function register, respectively.
11447 @item __NO_INTERRUPTS__
11448 This macro reflects the @code{-mno-interrupts} command line option.
11450 @item __AVR_ERRATA_SKIP__
11451 @item __AVR_ERRATA_SKIP_JMP_CALL__
11452 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11453 instructions because of a hardware erratum.  Skip instructions are
11454 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11455 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11456 set.
11458 @item __AVR_SFR_OFFSET__=@var{offset}
11459 Instructions that can address I/O special function registers directly
11460 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11461 address as if addressed by an instruction to access RAM like @code{LD}
11462 or @code{STS}. This offset depends on the device architecture and has
11463 to be subtracted from the RAM address in order to get the
11464 respective I/O@tie{}address.
11466 @end table
11468 @node Blackfin Options
11469 @subsection Blackfin Options
11470 @cindex Blackfin Options
11472 @table @gcctabopt
11473 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11474 @opindex mcpu=
11475 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11476 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11477 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11478 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11479 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11480 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11481 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11482 @samp{bf561}, @samp{bf592}.
11483 The optional @var{sirevision} specifies the silicon revision of the target
11484 Blackfin processor.  Any workarounds available for the targeted silicon revision
11485 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11486 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11487 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11488 hexadecimal digits representing the major and minor numbers in the silicon
11489 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11490 is not defined.  If @var{sirevision} is @samp{any}, the
11491 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11492 If this optional @var{sirevision} is not used, GCC assumes the latest known
11493 silicon revision of the targeted Blackfin processor.
11495 Support for @samp{bf561} is incomplete.  For @samp{bf561},
11496 Only the processor macro is defined.
11497 Without this option, @samp{bf532} is used as the processor by default.
11498 The corresponding predefined processor macros for @var{cpu} is to
11499 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11500 provided by libgloss to be linked in if @option{-msim} is not given.
11502 @item -msim
11503 @opindex msim
11504 Specifies that the program will be run on the simulator.  This causes
11505 the simulator BSP provided by libgloss to be linked in.  This option
11506 has effect only for @samp{bfin-elf} toolchain.
11507 Certain other options, such as @option{-mid-shared-library} and
11508 @option{-mfdpic}, imply @option{-msim}.
11510 @item -momit-leaf-frame-pointer
11511 @opindex momit-leaf-frame-pointer
11512 Don't keep the frame pointer in a register for leaf functions.  This
11513 avoids the instructions to save, set up and restore frame pointers and
11514 makes an extra register available in leaf functions.  The option
11515 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11516 which might make debugging harder.
11518 @item -mspecld-anomaly
11519 @opindex mspecld-anomaly
11520 When enabled, the compiler ensures that the generated code does not
11521 contain speculative loads after jump instructions. If this option is used,
11522 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11524 @item -mno-specld-anomaly
11525 @opindex mno-specld-anomaly
11526 Don't generate extra code to prevent speculative loads from occurring.
11528 @item -mcsync-anomaly
11529 @opindex mcsync-anomaly
11530 When enabled, the compiler ensures that the generated code does not
11531 contain CSYNC or SSYNC instructions too soon after conditional branches.
11532 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11534 @item -mno-csync-anomaly
11535 @opindex mno-csync-anomaly
11536 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11537 occurring too soon after a conditional branch.
11539 @item -mlow-64k
11540 @opindex mlow-64k
11541 When enabled, the compiler is free to take advantage of the knowledge that
11542 the entire program fits into the low 64k of memory.
11544 @item -mno-low-64k
11545 @opindex mno-low-64k
11546 Assume that the program is arbitrarily large.  This is the default.
11548 @item -mstack-check-l1
11549 @opindex mstack-check-l1
11550 Do stack checking using information placed into L1 scratchpad memory by the
11551 uClinux kernel.
11553 @item -mid-shared-library
11554 @opindex mid-shared-library
11555 Generate code that supports shared libraries via the library ID method.
11556 This allows for execute in place and shared libraries in an environment
11557 without virtual memory management.  This option implies @option{-fPIC}.
11558 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11560 @item -mno-id-shared-library
11561 @opindex mno-id-shared-library
11562 Generate code that doesn't assume ID based shared libraries are being used.
11563 This is the default.
11565 @item -mleaf-id-shared-library
11566 @opindex mleaf-id-shared-library
11567 Generate code that supports shared libraries via the library ID method,
11568 but assumes that this library or executable won't link against any other
11569 ID shared libraries.  That allows the compiler to use faster code for jumps
11570 and calls.
11572 @item -mno-leaf-id-shared-library
11573 @opindex mno-leaf-id-shared-library
11574 Do not assume that the code being compiled won't link against any ID shared
11575 libraries.  Slower code is generated for jump and call insns.
11577 @item -mshared-library-id=n
11578 @opindex mshared-library-id
11579 Specifies the identification number of the ID-based shared library being
11580 compiled.  Specifying a value of 0 generates more compact code; specifying
11581 other values forces the allocation of that number to the current
11582 library but is no more space- or time-efficient than omitting this option.
11584 @item -msep-data
11585 @opindex msep-data
11586 Generate code that allows the data segment to be located in a different
11587 area of memory from the text segment.  This allows for execute in place in
11588 an environment without virtual memory management by eliminating relocations
11589 against the text section.
11591 @item -mno-sep-data
11592 @opindex mno-sep-data
11593 Generate code that assumes that the data segment follows the text segment.
11594 This is the default.
11596 @item -mlong-calls
11597 @itemx -mno-long-calls
11598 @opindex mlong-calls
11599 @opindex mno-long-calls
11600 Tells the compiler to perform function calls by first loading the
11601 address of the function into a register and then performing a subroutine
11602 call on this register.  This switch is needed if the target function
11603 lies outside of the 24-bit addressing range of the offset-based
11604 version of subroutine call instruction.
11606 This feature is not enabled by default.  Specifying
11607 @option{-mno-long-calls} restores the default behavior.  Note these
11608 switches have no effect on how the compiler generates code to handle
11609 function calls via function pointers.
11611 @item -mfast-fp
11612 @opindex mfast-fp
11613 Link with the fast floating-point library. This library relaxes some of
11614 the IEEE floating-point standard's rules for checking inputs against
11615 Not-a-Number (NAN), in the interest of performance.
11617 @item -minline-plt
11618 @opindex minline-plt
11619 Enable inlining of PLT entries in function calls to functions that are
11620 not known to bind locally.  It has no effect without @option{-mfdpic}.
11622 @item -mmulticore
11623 @opindex mmulticore
11624 Build standalone application for multicore Blackfin processor. Proper
11625 start files and link scripts are used to support multicore.
11626 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11627 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11628 @option{-mcorea} or @option{-mcoreb}. If it's used without
11629 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11630 programming model is used. In this model, the main function of Core B
11631 should be named as coreb_main. If it's used with @option{-mcorea} or
11632 @option{-mcoreb}, one application per core programming model is used.
11633 If this option is not used, single core application programming
11634 model is used.
11636 @item -mcorea
11637 @opindex mcorea
11638 Build standalone application for Core A of BF561 when using
11639 one application per core programming model. Proper start files
11640 and link scripts are used to support Core A. This option
11641 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11643 @item -mcoreb
11644 @opindex mcoreb
11645 Build standalone application for Core B of BF561 when using
11646 one application per core programming model. Proper start files
11647 and link scripts are used to support Core B. This option
11648 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11649 should be used instead of main. It must be used with
11650 @option{-mmulticore}.
11652 @item -msdram
11653 @opindex msdram
11654 Build standalone application for SDRAM. Proper start files and
11655 link scripts are used to put the application into SDRAM.
11656 Loader should initialize SDRAM before loading the application
11657 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11659 @item -micplb
11660 @opindex micplb
11661 Assume that ICPLBs are enabled at run time.  This has an effect on certain
11662 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11663 are enabled; for standalone applications the default is off.
11664 @end table
11666 @node C6X Options
11667 @subsection C6X Options
11668 @cindex C6X Options
11670 @table @gcctabopt
11671 @item -march=@var{name}
11672 @opindex march
11673 This specifies the name of the target architecture.  GCC uses this
11674 name to determine what kind of instructions it can emit when generating
11675 assembly code.  Permissible names are: @samp{c62x},
11676 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11678 @item -mbig-endian
11679 @opindex mbig-endian
11680 Generate code for a big-endian target.
11682 @item -mlittle-endian
11683 @opindex mlittle-endian
11684 Generate code for a little-endian target.  This is the default.
11686 @item -msim
11687 @opindex msim
11688 Choose startup files and linker script suitable for the simulator.
11690 @item -msdata=default
11691 @opindex msdata=default
11692 Put small global and static data in the @samp{.neardata} section,
11693 which is pointed to by register @code{B14}.  Put small uninitialized
11694 global and static data in the @samp{.bss} section, which is adjacent
11695 to the @samp{.neardata} section.  Put small read-only data into the
11696 @samp{.rodata} section.  The corresponding sections used for large
11697 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11699 @item -msdata=all
11700 @opindex msdata=all
11701 Put all data, not just small objets, into the sections reserved for
11702 small data, and use addressing relative to the @code{B14} register to
11703 access them.
11705 @item -msdata=none
11706 @opindex msdata=none
11707 Make no use of the sections reserved for small data, and use absolute
11708 addresses to access all data.  Put all initialized global and static
11709 data in the @samp{.fardata} section, and all uninitialized data in the
11710 @samp{.far} section.  Put all constant data into the @samp{.const}
11711 section.
11712 @end table
11714 @node CRIS Options
11715 @subsection CRIS Options
11716 @cindex CRIS Options
11718 These options are defined specifically for the CRIS ports.
11720 @table @gcctabopt
11721 @item -march=@var{architecture-type}
11722 @itemx -mcpu=@var{architecture-type}
11723 @opindex march
11724 @opindex mcpu
11725 Generate code for the specified architecture.  The choices for
11726 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11727 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11728 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11729 @samp{v10}.
11731 @item -mtune=@var{architecture-type}
11732 @opindex mtune
11733 Tune to @var{architecture-type} everything applicable about the generated
11734 code, except for the ABI and the set of available instructions.  The
11735 choices for @var{architecture-type} are the same as for
11736 @option{-march=@var{architecture-type}}.
11738 @item -mmax-stack-frame=@var{n}
11739 @opindex mmax-stack-frame
11740 Warn when the stack frame of a function exceeds @var{n} bytes.
11742 @item -metrax4
11743 @itemx -metrax100
11744 @opindex metrax4
11745 @opindex metrax100
11746 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11747 @option{-march=v3} and @option{-march=v8} respectively.
11749 @item -mmul-bug-workaround
11750 @itemx -mno-mul-bug-workaround
11751 @opindex mmul-bug-workaround
11752 @opindex mno-mul-bug-workaround
11753 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11754 models where it applies.  This option is active by default.
11756 @item -mpdebug
11757 @opindex mpdebug
11758 Enable CRIS-specific verbose debug-related information in the assembly
11759 code.  This option also has the effect to turn off the @samp{#NO_APP}
11760 formatted-code indicator to the assembler at the beginning of the
11761 assembly file.
11763 @item -mcc-init
11764 @opindex mcc-init
11765 Do not use condition-code results from previous instruction; always emit
11766 compare and test instructions before use of condition codes.
11768 @item -mno-side-effects
11769 @opindex mno-side-effects
11770 Do not emit instructions with side-effects in addressing modes other than
11771 post-increment.
11773 @item -mstack-align
11774 @itemx -mno-stack-align
11775 @itemx -mdata-align
11776 @itemx -mno-data-align
11777 @itemx -mconst-align
11778 @itemx -mno-const-align
11779 @opindex mstack-align
11780 @opindex mno-stack-align
11781 @opindex mdata-align
11782 @opindex mno-data-align
11783 @opindex mconst-align
11784 @opindex mno-const-align
11785 These options (no-options) arranges (eliminate arrangements) for the
11786 stack-frame, individual data and constants to be aligned for the maximum
11787 single data access size for the chosen CPU model.  The default is to
11788 arrange for 32-bit alignment.  ABI details such as structure layout are
11789 not affected by these options.
11791 @item -m32-bit
11792 @itemx -m16-bit
11793 @itemx -m8-bit
11794 @opindex m32-bit
11795 @opindex m16-bit
11796 @opindex m8-bit
11797 Similar to the stack- data- and const-align options above, these options
11798 arrange for stack-frame, writable data and constants to all be 32-bit,
11799 16-bit or 8-bit aligned.  The default is 32-bit alignment.
11801 @item -mno-prologue-epilogue
11802 @itemx -mprologue-epilogue
11803 @opindex mno-prologue-epilogue
11804 @opindex mprologue-epilogue
11805 With @option{-mno-prologue-epilogue}, the normal function prologue and
11806 epilogue which set up the stack frame are omitted and no return
11807 instructions or return sequences are generated in the code.  Use this
11808 option only together with visual inspection of the compiled code: no
11809 warnings or errors are generated when call-saved registers must be saved,
11810 or storage for local variable needs to be allocated.
11812 @item -mno-gotplt
11813 @itemx -mgotplt
11814 @opindex mno-gotplt
11815 @opindex mgotplt
11816 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11817 instruction sequences that load addresses for functions from the PLT part
11818 of the GOT rather than (traditional on other architectures) calls to the
11819 PLT@.  The default is @option{-mgotplt}.
11821 @item -melf
11822 @opindex melf
11823 Legacy no-op option only recognized with the cris-axis-elf and
11824 cris-axis-linux-gnu targets.
11826 @item -mlinux
11827 @opindex mlinux
11828 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11830 @item -sim
11831 @opindex sim
11832 This option, recognized for the cris-axis-elf arranges
11833 to link with input-output functions from a simulator library.  Code,
11834 initialized data and zero-initialized data are allocated consecutively.
11836 @item -sim2
11837 @opindex sim2
11838 Like @option{-sim}, but pass linker options to locate initialized data at
11839 0x40000000 and zero-initialized data at 0x80000000.
11840 @end table
11842 @node CR16 Options
11843 @subsection CR16 Options
11844 @cindex CR16 Options
11846 These options are defined specifically for the CR16 ports.
11848 @table @gcctabopt
11850 @item -mmac
11851 @opindex mmac
11852 Enable the use of multiply-accumulate instructions. Disabled by default.
11854 @item -mcr16cplus
11855 @itemx -mcr16c
11856 @opindex mcr16cplus
11857 @opindex mcr16c
11858 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
11859 is default.
11861 @item -msim
11862 @opindex msim
11863 Links the library libsim.a which is in compatible with simulator. Applicable
11864 to ELF compiler only.
11866 @item -mint32
11867 @opindex mint32
11868 Choose integer type as 32-bit wide.
11870 @item -mbit-ops
11871 @opindex mbit-ops
11872 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
11874 @item -mdata-model=@var{model}
11875 @opindex mdata-model
11876 Choose a data model. The choices for @var{model} are @samp{near},
11877 @samp{far} or @samp{medium}. @samp{medium} is default.
11878 However, @samp{far} is not valid with @option{-mcr16c}, as the
11879 CR16C architecture does not support the far data model.
11880 @end table
11882 @node Darwin Options
11883 @subsection Darwin Options
11884 @cindex Darwin options
11886 These options are defined for all architectures running the Darwin operating
11887 system.
11889 FSF GCC on Darwin does not create ``fat'' object files; it creates
11890 an object file for the single architecture that GCC was built to
11891 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
11892 @option{-arch} options are used; it does so by running the compiler or
11893 linker multiple times and joining the results together with
11894 @file{lipo}.
11896 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11897 @samp{i686}) is determined by the flags that specify the ISA
11898 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
11899 @option{-force_cpusubtype_ALL} option can be used to override this.
11901 The Darwin tools vary in their behavior when presented with an ISA
11902 mismatch.  The assembler, @file{as}, only permits instructions to
11903 be used that are valid for the subtype of the file it is generating,
11904 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11905 The linker for shared libraries, @file{/usr/bin/libtool}, fails
11906 and prints an error if asked to create a shared library with a less
11907 restrictive subtype than its input files (for instance, trying to put
11908 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
11909 for executables, @command{ld}, quietly gives the executable the most
11910 restrictive subtype of any of its input files.
11912 @table @gcctabopt
11913 @item -F@var{dir}
11914 @opindex F
11915 Add the framework directory @var{dir} to the head of the list of
11916 directories to be searched for header files.  These directories are
11917 interleaved with those specified by @option{-I} options and are
11918 scanned in a left-to-right order.
11920 A framework directory is a directory with frameworks in it.  A
11921 framework is a directory with a @file{Headers} and/or
11922 @file{PrivateHeaders} directory contained directly in it that ends
11923 in @file{.framework}.  The name of a framework is the name of this
11924 directory excluding the @file{.framework}.  Headers associated with
11925 the framework are found in one of those two directories, with
11926 @file{Headers} being searched first.  A subframework is a framework
11927 directory that is in a framework's @file{Frameworks} directory.
11928 Includes of subframework headers can only appear in a header of a
11929 framework that contains the subframework, or in a sibling subframework
11930 header.  Two subframeworks are siblings if they occur in the same
11931 framework.  A subframework should not have the same name as a
11932 framework; a warning is issued if this is violated.  Currently a
11933 subframework cannot have subframeworks; in the future, the mechanism
11934 may be extended to support this.  The standard frameworks can be found
11935 in @file{/System/Library/Frameworks} and
11936 @file{/Library/Frameworks}.  An example include looks like
11937 @code{#include <Framework/header.h>}, where @file{Framework} denotes
11938 the name of the framework and @file{header.h} is found in the
11939 @file{PrivateHeaders} or @file{Headers} directory.
11941 @item -iframework@var{dir}
11942 @opindex iframework
11943 Like @option{-F} except the directory is a treated as a system
11944 directory.  The main difference between this @option{-iframework} and
11945 @option{-F} is that with @option{-iframework} the compiler does not
11946 warn about constructs contained within header files found via
11947 @var{dir}.  This option is valid only for the C family of languages.
11949 @item -gused
11950 @opindex gused
11951 Emit debugging information for symbols that are used.  For stabs
11952 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11953 This is by default ON@.
11955 @item -gfull
11956 @opindex gfull
11957 Emit debugging information for all symbols and types.
11959 @item -mmacosx-version-min=@var{version}
11960 The earliest version of MacOS X that this executable will run on
11961 is @var{version}.  Typical values of @var{version} include @code{10.1},
11962 @code{10.2}, and @code{10.3.9}.
11964 If the compiler was built to use the system's headers by default,
11965 then the default for this option is the system version on which the
11966 compiler is running, otherwise the default is to make choices that
11967 are compatible with as many systems and code bases as possible.
11969 @item -mkernel
11970 @opindex mkernel
11971 Enable kernel development mode.  The @option{-mkernel} option sets
11972 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11973 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11974 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11975 applicable.  This mode also sets @option{-mno-altivec},
11976 @option{-msoft-float}, @option{-fno-builtin} and
11977 @option{-mlong-branch} for PowerPC targets.
11979 @item -mone-byte-bool
11980 @opindex mone-byte-bool
11981 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
11982 By default @samp{sizeof(bool)} is @samp{4} when compiling for
11983 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
11984 option has no effect on x86.
11986 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
11987 to generate code that is not binary compatible with code generated
11988 without that switch.  Using this switch may require recompiling all
11989 other modules in a program, including system libraries.  Use this
11990 switch to conform to a non-default data model.
11992 @item -mfix-and-continue
11993 @itemx -ffix-and-continue
11994 @itemx -findirect-data
11995 @opindex mfix-and-continue
11996 @opindex ffix-and-continue
11997 @opindex findirect-data
11998 Generate code suitable for fast turn around development.  Needed to
11999 enable GDB to dynamically load @code{.o} files into already running
12000 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12001 are provided for backwards compatibility.
12003 @item -all_load
12004 @opindex all_load
12005 Loads all members of static archive libraries.
12006 See man ld(1) for more information.
12008 @item -arch_errors_fatal
12009 @opindex arch_errors_fatal
12010 Cause the errors having to do with files that have the wrong architecture
12011 to be fatal.
12013 @item -bind_at_load
12014 @opindex bind_at_load
12015 Causes the output file to be marked such that the dynamic linker will
12016 bind all undefined references when the file is loaded or launched.
12018 @item -bundle
12019 @opindex bundle
12020 Produce a Mach-o bundle format file.
12021 See man ld(1) for more information.
12023 @item -bundle_loader @var{executable}
12024 @opindex bundle_loader
12025 This option specifies the @var{executable} that will load the build
12026 output file being linked.  See man ld(1) for more information.
12028 @item -dynamiclib
12029 @opindex dynamiclib
12030 When passed this option, GCC produces a dynamic library instead of
12031 an executable when linking, using the Darwin @file{libtool} command.
12033 @item -force_cpusubtype_ALL
12034 @opindex force_cpusubtype_ALL
12035 This causes GCC's output file to have the @var{ALL} subtype, instead of
12036 one controlled by the @option{-mcpu} or @option{-march} option.
12038 @item -allowable_client  @var{client_name}
12039 @itemx -client_name
12040 @itemx -compatibility_version
12041 @itemx -current_version
12042 @itemx -dead_strip
12043 @itemx -dependency-file
12044 @itemx -dylib_file
12045 @itemx -dylinker_install_name
12046 @itemx -dynamic
12047 @itemx -exported_symbols_list
12048 @itemx -filelist
12049 @need 800
12050 @itemx -flat_namespace
12051 @itemx -force_flat_namespace
12052 @itemx -headerpad_max_install_names
12053 @itemx -image_base
12054 @itemx -init
12055 @itemx -install_name
12056 @itemx -keep_private_externs
12057 @itemx -multi_module
12058 @itemx -multiply_defined
12059 @itemx -multiply_defined_unused
12060 @need 800
12061 @itemx -noall_load
12062 @itemx -no_dead_strip_inits_and_terms
12063 @itemx -nofixprebinding
12064 @itemx -nomultidefs
12065 @itemx -noprebind
12066 @itemx -noseglinkedit
12067 @itemx -pagezero_size
12068 @itemx -prebind
12069 @itemx -prebind_all_twolevel_modules
12070 @itemx -private_bundle
12071 @need 800
12072 @itemx -read_only_relocs
12073 @itemx -sectalign
12074 @itemx -sectobjectsymbols
12075 @itemx -whyload
12076 @itemx -seg1addr
12077 @itemx -sectcreate
12078 @itemx -sectobjectsymbols
12079 @itemx -sectorder
12080 @itemx -segaddr
12081 @itemx -segs_read_only_addr
12082 @need 800
12083 @itemx -segs_read_write_addr
12084 @itemx -seg_addr_table
12085 @itemx -seg_addr_table_filename
12086 @itemx -seglinkedit
12087 @itemx -segprot
12088 @itemx -segs_read_only_addr
12089 @itemx -segs_read_write_addr
12090 @itemx -single_module
12091 @itemx -static
12092 @itemx -sub_library
12093 @need 800
12094 @itemx -sub_umbrella
12095 @itemx -twolevel_namespace
12096 @itemx -umbrella
12097 @itemx -undefined
12098 @itemx -unexported_symbols_list
12099 @itemx -weak_reference_mismatches
12100 @itemx -whatsloaded
12101 @opindex allowable_client
12102 @opindex client_name
12103 @opindex compatibility_version
12104 @opindex current_version
12105 @opindex dead_strip
12106 @opindex dependency-file
12107 @opindex dylib_file
12108 @opindex dylinker_install_name
12109 @opindex dynamic
12110 @opindex exported_symbols_list
12111 @opindex filelist
12112 @opindex flat_namespace
12113 @opindex force_flat_namespace
12114 @opindex headerpad_max_install_names
12115 @opindex image_base
12116 @opindex init
12117 @opindex install_name
12118 @opindex keep_private_externs
12119 @opindex multi_module
12120 @opindex multiply_defined
12121 @opindex multiply_defined_unused
12122 @opindex noall_load
12123 @opindex no_dead_strip_inits_and_terms
12124 @opindex nofixprebinding
12125 @opindex nomultidefs
12126 @opindex noprebind
12127 @opindex noseglinkedit
12128 @opindex pagezero_size
12129 @opindex prebind
12130 @opindex prebind_all_twolevel_modules
12131 @opindex private_bundle
12132 @opindex read_only_relocs
12133 @opindex sectalign
12134 @opindex sectobjectsymbols
12135 @opindex whyload
12136 @opindex seg1addr
12137 @opindex sectcreate
12138 @opindex sectobjectsymbols
12139 @opindex sectorder
12140 @opindex segaddr
12141 @opindex segs_read_only_addr
12142 @opindex segs_read_write_addr
12143 @opindex seg_addr_table
12144 @opindex seg_addr_table_filename
12145 @opindex seglinkedit
12146 @opindex segprot
12147 @opindex segs_read_only_addr
12148 @opindex segs_read_write_addr
12149 @opindex single_module
12150 @opindex static
12151 @opindex sub_library
12152 @opindex sub_umbrella
12153 @opindex twolevel_namespace
12154 @opindex umbrella
12155 @opindex undefined
12156 @opindex unexported_symbols_list
12157 @opindex weak_reference_mismatches
12158 @opindex whatsloaded
12159 These options are passed to the Darwin linker.  The Darwin linker man page
12160 describes them in detail.
12161 @end table
12163 @node DEC Alpha Options
12164 @subsection DEC Alpha Options
12166 These @samp{-m} options are defined for the DEC Alpha implementations:
12168 @table @gcctabopt
12169 @item -mno-soft-float
12170 @itemx -msoft-float
12171 @opindex mno-soft-float
12172 @opindex msoft-float
12173 Use (do not use) the hardware floating-point instructions for
12174 floating-point operations.  When @option{-msoft-float} is specified,
12175 functions in @file{libgcc.a} are used to perform floating-point
12176 operations.  Unless they are replaced by routines that emulate the
12177 floating-point operations, or compiled in such a way as to call such
12178 emulations routines, these routines issue floating-point
12179 operations.   If you are compiling for an Alpha without floating-point
12180 operations, you must ensure that the library is built so as not to call
12181 them.
12183 Note that Alpha implementations without floating-point operations are
12184 required to have floating-point registers.
12186 @item -mfp-reg
12187 @itemx -mno-fp-regs
12188 @opindex mfp-reg
12189 @opindex mno-fp-regs
12190 Generate code that uses (does not use) the floating-point register set.
12191 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12192 register set is not used, floating-point operands are passed in integer
12193 registers as if they were integers and floating-point results are passed
12194 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12195 so any function with a floating-point argument or return value called by code
12196 compiled with @option{-mno-fp-regs} must also be compiled with that
12197 option.
12199 A typical use of this option is building a kernel that does not use,
12200 and hence need not save and restore, any floating-point registers.
12202 @item -mieee
12203 @opindex mieee
12204 The Alpha architecture implements floating-point hardware optimized for
12205 maximum performance.  It is mostly compliant with the IEEE floating-point
12206 standard.  However, for full compliance, software assistance is
12207 required.  This option generates code fully IEEE-compliant code
12208 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12209 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12210 defined during compilation.  The resulting code is less efficient but is
12211 able to correctly support denormalized numbers and exceptional IEEE
12212 values such as not-a-number and plus/minus infinity.  Other Alpha
12213 compilers call this option @option{-ieee_with_no_inexact}.
12215 @item -mieee-with-inexact
12216 @opindex mieee-with-inexact
12217 This is like @option{-mieee} except the generated code also maintains
12218 the IEEE @var{inexact-flag}.  Turning on this option causes the
12219 generated code to implement fully-compliant IEEE math.  In addition to
12220 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12221 macro.  On some Alpha implementations the resulting code may execute
12222 significantly slower than the code generated by default.  Since there is
12223 very little code that depends on the @var{inexact-flag}, you should
12224 normally not specify this option.  Other Alpha compilers call this
12225 option @option{-ieee_with_inexact}.
12227 @item -mfp-trap-mode=@var{trap-mode}
12228 @opindex mfp-trap-mode
12229 This option controls what floating-point related traps are enabled.
12230 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12231 The trap mode can be set to one of four values:
12233 @table @samp
12234 @item n
12235 This is the default (normal) setting.  The only traps that are enabled
12236 are the ones that cannot be disabled in software (e.g., division by zero
12237 trap).
12239 @item u
12240 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12241 as well.
12243 @item su
12244 Like @samp{u}, but the instructions are marked to be safe for software
12245 completion (see Alpha architecture manual for details).
12247 @item sui
12248 Like @samp{su}, but inexact traps are enabled as well.
12249 @end table
12251 @item -mfp-rounding-mode=@var{rounding-mode}
12252 @opindex mfp-rounding-mode
12253 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12254 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12257 @table @samp
12258 @item n
12259 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12260 the nearest machine number or towards the even machine number in case
12261 of a tie.
12263 @item m
12264 Round towards minus infinity.
12266 @item c
12267 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12269 @item d
12270 Dynamic rounding mode.  A field in the floating-point control register
12271 (@var{fpcr}, see Alpha architecture reference manual) controls the
12272 rounding mode in effect.  The C library initializes this register for
12273 rounding towards plus infinity.  Thus, unless your program modifies the
12274 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12275 @end table
12277 @item -mtrap-precision=@var{trap-precision}
12278 @opindex mtrap-precision
12279 In the Alpha architecture, floating-point traps are imprecise.  This
12280 means without software assistance it is impossible to recover from a
12281 floating trap and program execution normally needs to be terminated.
12282 GCC can generate code that can assist operating system trap handlers
12283 in determining the exact location that caused a floating-point trap.
12284 Depending on the requirements of an application, different levels of
12285 precisions can be selected:
12287 @table @samp
12288 @item p
12289 Program precision.  This option is the default and means a trap handler
12290 can only identify which program caused a floating-point exception.
12292 @item f
12293 Function precision.  The trap handler can determine the function that
12294 caused a floating-point exception.
12296 @item i
12297 Instruction precision.  The trap handler can determine the exact
12298 instruction that caused a floating-point exception.
12299 @end table
12301 Other Alpha compilers provide the equivalent options called
12302 @option{-scope_safe} and @option{-resumption_safe}.
12304 @item -mieee-conformant
12305 @opindex mieee-conformant
12306 This option marks the generated code as IEEE conformant.  You must not
12307 use this option unless you also specify @option{-mtrap-precision=i} and either
12308 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12309 is to emit the line @samp{.eflag 48} in the function prologue of the
12310 generated assembly file.
12312 @item -mbuild-constants
12313 @opindex mbuild-constants
12314 Normally GCC examines a 32- or 64-bit integer constant to
12315 see if it can construct it from smaller constants in two or three
12316 instructions.  If it cannot, it outputs the constant as a literal and
12317 generates code to load it from the data segment at run time.
12319 Use this option to require GCC to construct @emph{all} integer constants
12320 using code, even if it takes more instructions (the maximum is six).
12322 You typically use this option to build a shared library dynamic
12323 loader.  Itself a shared library, it must relocate itself in memory
12324 before it can find the variables and constants in its own data segment.
12326 @item -mbwx
12327 @itemx -mno-bwx
12328 @itemx -mcix
12329 @itemx -mno-cix
12330 @itemx -mfix
12331 @itemx -mno-fix
12332 @itemx -mmax
12333 @itemx -mno-max
12334 @opindex mbwx
12335 @opindex mno-bwx
12336 @opindex mcix
12337 @opindex mno-cix
12338 @opindex mfix
12339 @opindex mno-fix
12340 @opindex mmax
12341 @opindex mno-max
12342 Indicate whether GCC should generate code to use the optional BWX,
12343 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12344 sets supported by the CPU type specified via @option{-mcpu=} option or that
12345 of the CPU on which GCC was built if none is specified.
12347 @item -mfloat-vax
12348 @itemx -mfloat-ieee
12349 @opindex mfloat-vax
12350 @opindex mfloat-ieee
12351 Generate code that uses (does not use) VAX F and G floating-point
12352 arithmetic instead of IEEE single and double precision.
12354 @item -mexplicit-relocs
12355 @itemx -mno-explicit-relocs
12356 @opindex mexplicit-relocs
12357 @opindex mno-explicit-relocs
12358 Older Alpha assemblers provided no way to generate symbol relocations
12359 except via assembler macros.  Use of these macros does not allow
12360 optimal instruction scheduling.  GNU binutils as of version 2.12
12361 supports a new syntax that allows the compiler to explicitly mark
12362 which relocations should apply to which instructions.  This option
12363 is mostly useful for debugging, as GCC detects the capabilities of
12364 the assembler when it is built and sets the default accordingly.
12366 @item -msmall-data
12367 @itemx -mlarge-data
12368 @opindex msmall-data
12369 @opindex mlarge-data
12370 When @option{-mexplicit-relocs} is in effect, static data is
12371 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12372 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12373 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12374 16-bit relocations off of the @code{$gp} register.  This limits the
12375 size of the small data area to 64KB, but allows the variables to be
12376 directly accessed via a single instruction.
12378 The default is @option{-mlarge-data}.  With this option the data area
12379 is limited to just below 2GB@.  Programs that require more than 2GB of
12380 data must use @code{malloc} or @code{mmap} to allocate the data in the
12381 heap instead of in the program's data segment.
12383 When generating code for shared libraries, @option{-fpic} implies
12384 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12386 @item -msmall-text
12387 @itemx -mlarge-text
12388 @opindex msmall-text
12389 @opindex mlarge-text
12390 When @option{-msmall-text} is used, the compiler assumes that the
12391 code of the entire program (or shared library) fits in 4MB, and is
12392 thus reachable with a branch instruction.  When @option{-msmall-data}
12393 is used, the compiler can assume that all local symbols share the
12394 same @code{$gp} value, and thus reduce the number of instructions
12395 required for a function call from 4 to 1.
12397 The default is @option{-mlarge-text}.
12399 @item -mcpu=@var{cpu_type}
12400 @opindex mcpu
12401 Set the instruction set and instruction scheduling parameters for
12402 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12403 style name or the corresponding chip number.  GCC supports scheduling
12404 parameters for the EV4, EV5 and EV6 family of processors and
12405 chooses the default values for the instruction set from the processor
12406 you specify.  If you do not specify a processor type, GCC defaults
12407 to the processor on which the compiler was built.
12409 Supported values for @var{cpu_type} are
12411 @table @samp
12412 @item ev4
12413 @itemx ev45
12414 @itemx 21064
12415 Schedules as an EV4 and has no instruction set extensions.
12417 @item ev5
12418 @itemx 21164
12419 Schedules as an EV5 and has no instruction set extensions.
12421 @item ev56
12422 @itemx 21164a
12423 Schedules as an EV5 and supports the BWX extension.
12425 @item pca56
12426 @itemx 21164pc
12427 @itemx 21164PC
12428 Schedules as an EV5 and supports the BWX and MAX extensions.
12430 @item ev6
12431 @itemx 21264
12432 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12434 @item ev67
12435 @itemx 21264a
12436 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12437 @end table
12439 Native toolchains also support the value @samp{native},
12440 which selects the best architecture option for the host processor.
12441 @option{-mcpu=native} has no effect if GCC does not recognize
12442 the processor.
12444 @item -mtune=@var{cpu_type}
12445 @opindex mtune
12446 Set only the instruction scheduling parameters for machine type
12447 @var{cpu_type}.  The instruction set is not changed.
12449 Native toolchains also support the value @samp{native},
12450 which selects the best architecture option for the host processor.
12451 @option{-mtune=native} has no effect if GCC does not recognize
12452 the processor.
12454 @item -mmemory-latency=@var{time}
12455 @opindex mmemory-latency
12456 Sets the latency the scheduler should assume for typical memory
12457 references as seen by the application.  This number is highly
12458 dependent on the memory access patterns used by the application
12459 and the size of the external cache on the machine.
12461 Valid options for @var{time} are
12463 @table @samp
12464 @item @var{number}
12465 A decimal number representing clock cycles.
12467 @item L1
12468 @itemx L2
12469 @itemx L3
12470 @itemx main
12471 The compiler contains estimates of the number of clock cycles for
12472 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12473 (also called Dcache, Scache, and Bcache), as well as to main memory.
12474 Note that L3 is only valid for EV5.
12476 @end table
12477 @end table
12479 @node FR30 Options
12480 @subsection FR30 Options
12481 @cindex FR30 Options
12483 These options are defined specifically for the FR30 port.
12485 @table @gcctabopt
12487 @item -msmall-model
12488 @opindex msmall-model
12489 Use the small address space model.  This can produce smaller code, but
12490 it does assume that all symbolic values and addresses fit into a
12491 20-bit range.
12493 @item -mno-lsim
12494 @opindex mno-lsim
12495 Assume that runtime support has been provided and so there is no need
12496 to include the simulator library (@file{libsim.a}) on the linker
12497 command line.
12499 @end table
12501 @node FRV Options
12502 @subsection FRV Options
12503 @cindex FRV Options
12505 @table @gcctabopt
12506 @item -mgpr-32
12507 @opindex mgpr-32
12509 Only use the first 32 general-purpose registers.
12511 @item -mgpr-64
12512 @opindex mgpr-64
12514 Use all 64 general-purpose registers.
12516 @item -mfpr-32
12517 @opindex mfpr-32
12519 Use only the first 32 floating-point registers.
12521 @item -mfpr-64
12522 @opindex mfpr-64
12524 Use all 64 floating-point registers.
12526 @item -mhard-float
12527 @opindex mhard-float
12529 Use hardware instructions for floating-point operations.
12531 @item -msoft-float
12532 @opindex msoft-float
12534 Use library routines for floating-point operations.
12536 @item -malloc-cc
12537 @opindex malloc-cc
12539 Dynamically allocate condition code registers.
12541 @item -mfixed-cc
12542 @opindex mfixed-cc
12544 Do not try to dynamically allocate condition code registers, only
12545 use @code{icc0} and @code{fcc0}.
12547 @item -mdword
12548 @opindex mdword
12550 Change ABI to use double word insns.
12552 @item -mno-dword
12553 @opindex mno-dword
12555 Do not use double word instructions.
12557 @item -mdouble
12558 @opindex mdouble
12560 Use floating-point double instructions.
12562 @item -mno-double
12563 @opindex mno-double
12565 Do not use floating-point double instructions.
12567 @item -mmedia
12568 @opindex mmedia
12570 Use media instructions.
12572 @item -mno-media
12573 @opindex mno-media
12575 Do not use media instructions.
12577 @item -mmuladd
12578 @opindex mmuladd
12580 Use multiply and add/subtract instructions.
12582 @item -mno-muladd
12583 @opindex mno-muladd
12585 Do not use multiply and add/subtract instructions.
12587 @item -mfdpic
12588 @opindex mfdpic
12590 Select the FDPIC ABI, which uses function descriptors to represent
12591 pointers to functions.  Without any PIC/PIE-related options, it
12592 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12593 assumes GOT entries and small data are within a 12-bit range from the
12594 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12595 are computed with 32 bits.
12596 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12598 @item -minline-plt
12599 @opindex minline-plt
12601 Enable inlining of PLT entries in function calls to functions that are
12602 not known to bind locally.  It has no effect without @option{-mfdpic}.
12603 It's enabled by default if optimizing for speed and compiling for
12604 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12605 optimization option such as @option{-O3} or above is present in the
12606 command line.
12608 @item -mTLS
12609 @opindex mTLS
12611 Assume a large TLS segment when generating thread-local code.
12613 @item -mtls
12614 @opindex mtls
12616 Do not assume a large TLS segment when generating thread-local code.
12618 @item -mgprel-ro
12619 @opindex mgprel-ro
12621 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12622 that is known to be in read-only sections.  It's enabled by default,
12623 except for @option{-fpic} or @option{-fpie}: even though it may help
12624 make the global offset table smaller, it trades 1 instruction for 4.
12625 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12626 one of which may be shared by multiple symbols, and it avoids the need
12627 for a GOT entry for the referenced symbol, so it's more likely to be a
12628 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12630 @item -multilib-library-pic
12631 @opindex multilib-library-pic
12633 Link with the (library, not FD) pic libraries.  It's implied by
12634 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12635 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12636 it explicitly.
12638 @item -mlinked-fp
12639 @opindex mlinked-fp
12641 Follow the EABI requirement of always creating a frame pointer whenever
12642 a stack frame is allocated.  This option is enabled by default and can
12643 be disabled with @option{-mno-linked-fp}.
12645 @item -mlong-calls
12646 @opindex mlong-calls
12648 Use indirect addressing to call functions outside the current
12649 compilation unit.  This allows the functions to be placed anywhere
12650 within the 32-bit address space.
12652 @item -malign-labels
12653 @opindex malign-labels
12655 Try to align labels to an 8-byte boundary by inserting nops into the
12656 previous packet.  This option only has an effect when VLIW packing
12657 is enabled.  It doesn't create new packets; it merely adds nops to
12658 existing ones.
12660 @item -mlibrary-pic
12661 @opindex mlibrary-pic
12663 Generate position-independent EABI code.
12665 @item -macc-4
12666 @opindex macc-4
12668 Use only the first four media accumulator registers.
12670 @item -macc-8
12671 @opindex macc-8
12673 Use all eight media accumulator registers.
12675 @item -mpack
12676 @opindex mpack
12678 Pack VLIW instructions.
12680 @item -mno-pack
12681 @opindex mno-pack
12683 Do not pack VLIW instructions.
12685 @item -mno-eflags
12686 @opindex mno-eflags
12688 Do not mark ABI switches in e_flags.
12690 @item -mcond-move
12691 @opindex mcond-move
12693 Enable the use of conditional-move instructions (default).
12695 This switch is mainly for debugging the compiler and will likely be removed
12696 in a future version.
12698 @item -mno-cond-move
12699 @opindex mno-cond-move
12701 Disable the use of conditional-move instructions.
12703 This switch is mainly for debugging the compiler and will likely be removed
12704 in a future version.
12706 @item -mscc
12707 @opindex mscc
12709 Enable the use of conditional set instructions (default).
12711 This switch is mainly for debugging the compiler and will likely be removed
12712 in a future version.
12714 @item -mno-scc
12715 @opindex mno-scc
12717 Disable the use of conditional set instructions.
12719 This switch is mainly for debugging the compiler and will likely be removed
12720 in a future version.
12722 @item -mcond-exec
12723 @opindex mcond-exec
12725 Enable the use of conditional execution (default).
12727 This switch is mainly for debugging the compiler and will likely be removed
12728 in a future version.
12730 @item -mno-cond-exec
12731 @opindex mno-cond-exec
12733 Disable the use of conditional execution.
12735 This switch is mainly for debugging the compiler and will likely be removed
12736 in a future version.
12738 @item -mvliw-branch
12739 @opindex mvliw-branch
12741 Run a pass to pack branches into VLIW instructions (default).
12743 This switch is mainly for debugging the compiler and will likely be removed
12744 in a future version.
12746 @item -mno-vliw-branch
12747 @opindex mno-vliw-branch
12749 Do not run a pass to pack branches into VLIW instructions.
12751 This switch is mainly for debugging the compiler and will likely be removed
12752 in a future version.
12754 @item -mmulti-cond-exec
12755 @opindex mmulti-cond-exec
12757 Enable optimization of @code{&&} and @code{||} in conditional execution
12758 (default).
12760 This switch is mainly for debugging the compiler and will likely be removed
12761 in a future version.
12763 @item -mno-multi-cond-exec
12764 @opindex mno-multi-cond-exec
12766 Disable optimization of @code{&&} and @code{||} in conditional execution.
12768 This switch is mainly for debugging the compiler and will likely be removed
12769 in a future version.
12771 @item -mnested-cond-exec
12772 @opindex mnested-cond-exec
12774 Enable nested conditional execution optimizations (default).
12776 This switch is mainly for debugging the compiler and will likely be removed
12777 in a future version.
12779 @item -mno-nested-cond-exec
12780 @opindex mno-nested-cond-exec
12782 Disable nested conditional execution optimizations.
12784 This switch is mainly for debugging the compiler and will likely be removed
12785 in a future version.
12787 @item -moptimize-membar
12788 @opindex moptimize-membar
12790 This switch removes redundant @code{membar} instructions from the
12791 compiler generated code.  It is enabled by default.
12793 @item -mno-optimize-membar
12794 @opindex mno-optimize-membar
12796 This switch disables the automatic removal of redundant @code{membar}
12797 instructions from the generated code.
12799 @item -mtomcat-stats
12800 @opindex mtomcat-stats
12802 Cause gas to print out tomcat statistics.
12804 @item -mcpu=@var{cpu}
12805 @opindex mcpu
12807 Select the processor type for which to generate code.  Possible values are
12808 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12809 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12811 @end table
12813 @node GNU/Linux Options
12814 @subsection GNU/Linux Options
12816 These @samp{-m} options are defined for GNU/Linux targets:
12818 @table @gcctabopt
12819 @item -mglibc
12820 @opindex mglibc
12821 Use the GNU C library.  This is the default except
12822 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12824 @item -muclibc
12825 @opindex muclibc
12826 Use uClibc C library.  This is the default on
12827 @samp{*-*-linux-*uclibc*} targets.
12829 @item -mbionic
12830 @opindex mbionic
12831 Use Bionic C library.  This is the default on
12832 @samp{*-*-linux-*android*} targets.
12834 @item -mandroid
12835 @opindex mandroid
12836 Compile code compatible with Android platform.  This is the default on
12837 @samp{*-*-linux-*android*} targets.
12839 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12840 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
12841 this option makes the GCC driver pass Android-specific options to the linker.
12842 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12843 to be defined.
12845 @item -tno-android-cc
12846 @opindex tno-android-cc
12847 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12848 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12849 @option{-fno-rtti} by default.
12851 @item -tno-android-ld
12852 @opindex tno-android-ld
12853 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12854 linking options to the linker.
12856 @end table
12858 @node H8/300 Options
12859 @subsection H8/300 Options
12861 These @samp{-m} options are defined for the H8/300 implementations:
12863 @table @gcctabopt
12864 @item -mrelax
12865 @opindex mrelax
12866 Shorten some address references at link time, when possible; uses the
12867 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
12868 ld, Using ld}, for a fuller description.
12870 @item -mh
12871 @opindex mh
12872 Generate code for the H8/300H@.
12874 @item -ms
12875 @opindex ms
12876 Generate code for the H8S@.
12878 @item -mn
12879 @opindex mn
12880 Generate code for the H8S and H8/300H in the normal mode.  This switch
12881 must be used either with @option{-mh} or @option{-ms}.
12883 @item -ms2600
12884 @opindex ms2600
12885 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
12887 @item -mexr
12888 @opindex mexr
12889 Extended registers are stored on stack before execution of function
12890 with monitor attribute. Default option is @option{-mexr}.
12891 This option is valid only for H8S targets.
12893 @item -mno-exr
12894 @opindex mno-exr
12895 Extended registers are not stored on stack before execution of function 
12896 with monitor attribute. Default option is @option{-mno-exr}. 
12897 This option is valid only for H8S targets.
12899 @item -mint32
12900 @opindex mint32
12901 Make @code{int} data 32 bits by default.
12903 @item -malign-300
12904 @opindex malign-300
12905 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12906 The default for the H8/300H and H8S is to align longs and floats on
12907 4-byte boundaries.
12908 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
12909 This option has no effect on the H8/300.
12910 @end table
12912 @node HPPA Options
12913 @subsection HPPA Options
12914 @cindex HPPA Options
12916 These @samp{-m} options are defined for the HPPA family of computers:
12918 @table @gcctabopt
12919 @item -march=@var{architecture-type}
12920 @opindex march
12921 Generate code for the specified architecture.  The choices for
12922 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12923 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
12924 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12925 architecture option for your machine.  Code compiled for lower numbered
12926 architectures runs on higher numbered architectures, but not the
12927 other way around.
12929 @item -mpa-risc-1-0
12930 @itemx -mpa-risc-1-1
12931 @itemx -mpa-risc-2-0
12932 @opindex mpa-risc-1-0
12933 @opindex mpa-risc-1-1
12934 @opindex mpa-risc-2-0
12935 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12937 @item -mbig-switch
12938 @opindex mbig-switch
12939 Generate code suitable for big switch tables.  Use this option only if
12940 the assembler/linker complain about out of range branches within a switch
12941 table.
12943 @item -mjump-in-delay
12944 @opindex mjump-in-delay
12945 Fill delay slots of function calls with unconditional jump instructions
12946 by modifying the return pointer for the function call to be the target
12947 of the conditional jump.
12949 @item -mdisable-fpregs
12950 @opindex mdisable-fpregs
12951 Prevent floating-point registers from being used in any manner.  This is
12952 necessary for compiling kernels that perform lazy context switching of
12953 floating-point registers.  If you use this option and attempt to perform
12954 floating-point operations, the compiler aborts.
12956 @item -mdisable-indexing
12957 @opindex mdisable-indexing
12958 Prevent the compiler from using indexing address modes.  This avoids some
12959 rather obscure problems when compiling MIG generated code under MACH@.
12961 @item -mno-space-regs
12962 @opindex mno-space-regs
12963 Generate code that assumes the target has no space registers.  This allows
12964 GCC to generate faster indirect calls and use unscaled index address modes.
12966 Such code is suitable for level 0 PA systems and kernels.
12968 @item -mfast-indirect-calls
12969 @opindex mfast-indirect-calls
12970 Generate code that assumes calls never cross space boundaries.  This
12971 allows GCC to emit code that performs faster indirect calls.
12973 This option does not work in the presence of shared libraries or nested
12974 functions.
12976 @item -mfixed-range=@var{register-range}
12977 @opindex mfixed-range
12978 Generate code treating the given register range as fixed registers.
12979 A fixed register is one that the register allocator can not use.  This is
12980 useful when compiling kernel code.  A register range is specified as
12981 two registers separated by a dash.  Multiple register ranges can be
12982 specified separated by a comma.
12984 @item -mlong-load-store
12985 @opindex mlong-load-store
12986 Generate 3-instruction load and store sequences as sometimes required by
12987 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
12988 the HP compilers.
12990 @item -mportable-runtime
12991 @opindex mportable-runtime
12992 Use the portable calling conventions proposed by HP for ELF systems.
12994 @item -mgas
12995 @opindex mgas
12996 Enable the use of assembler directives only GAS understands.
12998 @item -mschedule=@var{cpu-type}
12999 @opindex mschedule
13000 Schedule code according to the constraints for the machine type
13001 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13002 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13003 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13004 proper scheduling option for your machine.  The default scheduling is
13005 @samp{8000}.
13007 @item -mlinker-opt
13008 @opindex mlinker-opt
13009 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13010 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13011 linkers in which they give bogus error messages when linking some programs.
13013 @item -msoft-float
13014 @opindex msoft-float
13015 Generate output containing library calls for floating point.
13016 @strong{Warning:} the requisite libraries are not available for all HPPA
13017 targets.  Normally the facilities of the machine's usual C compiler are
13018 used, but this cannot be done directly in cross-compilation.  You must make
13019 your own arrangements to provide suitable library functions for
13020 cross-compilation.
13022 @option{-msoft-float} changes the calling convention in the output file;
13023 therefore, it is only useful if you compile @emph{all} of a program with
13024 this option.  In particular, you need to compile @file{libgcc.a}, the
13025 library that comes with GCC, with @option{-msoft-float} in order for
13026 this to work.
13028 @item -msio
13029 @opindex msio
13030 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13031 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13032 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13033 options are available under HP-UX and HI-UX@.
13035 @item -mgnu-ld
13036 @opindex mgnu-ld
13037 Use options specific to GNU @command{ld}.
13038 This passes @option{-shared} to @command{ld} when
13039 building a shared library.  It is the default when GCC is configured,
13040 explicitly or implicitly, with the GNU linker.  This option does not
13041 affect which @command{ld} is called; it only changes what parameters
13042 are passed to that @command{ld}.
13043 The @command{ld} that is called is determined by the
13044 @option{--with-ld} configure option, GCC's program search path, and
13045 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13046 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13047 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13049 @item -mhp-ld
13050 @opindex mhp-ld
13051 Use options specific to HP @command{ld}.
13052 This passes @option{-b} to @command{ld} when building
13053 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13054 links.  It is the default when GCC is configured, explicitly or
13055 implicitly, with the HP linker.  This option does not affect
13056 which @command{ld} is called; it only changes what parameters are passed to that
13057 @command{ld}.
13058 The @command{ld} that is called is determined by the @option{--with-ld}
13059 configure option, GCC's program search path, and finally by the user's
13060 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13061 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13062 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13064 @item -mlong-calls
13065 @opindex mno-long-calls
13066 Generate code that uses long call sequences.  This ensures that a call
13067 is always able to reach linker generated stubs.  The default is to generate
13068 long calls only when the distance from the call site to the beginning
13069 of the function or translation unit, as the case may be, exceeds a
13070 predefined limit set by the branch type being used.  The limits for
13071 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13072 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13073 240,000 bytes.
13075 Distances are measured from the beginning of functions when using the
13076 @option{-ffunction-sections} option, or when using the @option{-mgas}
13077 and @option{-mno-portable-runtime} options together under HP-UX with
13078 the SOM linker.
13080 It is normally not desirable to use this option as it degrades
13081 performance.  However, it may be useful in large applications,
13082 particularly when partial linking is used to build the application.
13084 The types of long calls used depends on the capabilities of the
13085 assembler and linker, and the type of code being generated.  The
13086 impact on systems that support long absolute calls, and long pic
13087 symbol-difference or pc-relative calls should be relatively small.
13088 However, an indirect call is used on 32-bit ELF systems in pic code
13089 and it is quite long.
13091 @item -munix=@var{unix-std}
13092 @opindex march
13093 Generate compiler predefines and select a startfile for the specified
13094 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13095 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13096 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13097 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13098 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13099 and later.
13101 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13102 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13103 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13104 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13105 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13106 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13108 It is @emph{important} to note that this option changes the interfaces
13109 for various library routines.  It also affects the operational behavior
13110 of the C library.  Thus, @emph{extreme} care is needed in using this
13111 option.
13113 Library code that is intended to operate with more than one UNIX
13114 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13115 as appropriate.  Most GNU software doesn't provide this capability.
13117 @item -nolibdld
13118 @opindex nolibdld
13119 Suppress the generation of link options to search libdld.sl when the
13120 @option{-static} option is specified on HP-UX 10 and later.
13122 @item -static
13123 @opindex static
13124 The HP-UX implementation of setlocale in libc has a dependency on
13125 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13126 when the @option{-static} option is specified, special link options
13127 are needed to resolve this dependency.
13129 On HP-UX 10 and later, the GCC driver adds the necessary options to
13130 link with libdld.sl when the @option{-static} option is specified.
13131 This causes the resulting binary to be dynamic.  On the 64-bit port,
13132 the linkers generate dynamic binaries by default in any case.  The
13133 @option{-nolibdld} option can be used to prevent the GCC driver from
13134 adding these link options.
13136 @item -threads
13137 @opindex threads
13138 Add support for multithreading with the @dfn{dce thread} library
13139 under HP-UX@.  This option sets flags for both the preprocessor and
13140 linker.
13141 @end table
13143 @node i386 and x86-64 Options
13144 @subsection Intel 386 and AMD x86-64 Options
13145 @cindex i386 Options
13146 @cindex x86-64 Options
13147 @cindex Intel 386 Options
13148 @cindex AMD x86-64 Options
13150 These @samp{-m} options are defined for the i386 and x86-64 family of
13151 computers:
13153 @table @gcctabopt
13155 @item -march=@var{cpu-type}
13156 @opindex march
13157 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13158 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13159 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13160 to generate code that may not run at all on processors other than the one
13161 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13162 @option{-mtune=@var{cpu-type}}.
13164 The choices for @var{cpu-type} are:
13166 @table @samp
13167 @item native
13168 This selects the CPU to generate code for at compilation time by determining
13169 the processor type of the compiling machine.  Using @option{-march=native}
13170 enables all instruction subsets supported by the local machine (hence
13171 the result might not run on different machines).  Using @option{-mtune=native}
13172 produces code optimized for the local machine under the constraints
13173 of the selected instruction set.  
13175 @item i386
13176 Original Intel i386 CPU@.
13178 @item i486
13179 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13181 @item i586
13182 @itemx pentium
13183 Intel Pentium CPU with no MMX support.
13185 @item pentium-mmx
13186 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13188 @item pentiumpro
13189 Intel Pentium Pro CPU@.
13191 @item i686
13192 When used with @option{-march}, the Pentium Pro
13193 instruction set is used, so the code runs on all i686 family chips.
13194 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13196 @item pentium2
13197 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13198 support.
13200 @item pentium3
13201 @itemx pentium3m
13202 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13203 set support.
13205 @item pentium-m
13206 Intel Pentium M; low-power version of Intel Pentium III CPU
13207 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13209 @item pentium4
13210 @itemx pentium4m
13211 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13213 @item prescott
13214 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13215 set support.
13217 @item nocona
13218 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13219 SSE2 and SSE3 instruction set support.
13221 @item core2
13222 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13223 instruction set support.
13225 @item corei7
13226 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13227 and SSE4.2 instruction set support.
13229 @item corei7-avx
13230 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13231 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13233 @item core-avx-i
13234 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13235 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13236 set support.
13238 @item atom
13239 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13240 instruction set support.
13242 @item k6
13243 AMD K6 CPU with MMX instruction set support.
13245 @item k6-2
13246 @itemx k6-3
13247 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13249 @item athlon
13250 @itemx athlon-tbird
13251 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13252 support.
13254 @item athlon-4
13255 @itemx athlon-xp
13256 @itemx athlon-mp
13257 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13258 instruction set support.
13260 @item k8
13261 @itemx opteron
13262 @itemx athlon64
13263 @itemx athlon-fx
13264 Processors based on the AMD K8 core with x86-64 instruction set support,
13265 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13266 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13267 instruction set extensions.)
13269 @item k8-sse3
13270 @itemx opteron-sse3
13271 @itemx athlon64-sse3
13272 Improved versions of AMD K8 cores with SSE3 instruction set support.
13274 @item amdfam10
13275 @itemx barcelona
13276 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13277 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13278 instruction set extensions.)
13280 @item bdver1
13281 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13282 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13283 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13284 @item bdver2
13285 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13286 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13287 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13288 extensions.)
13290 @item btver1
13291 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13292 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13293 instruction set extensions.)
13295 @item btver2
13296 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13297 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13298 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13300 @item winchip-c6
13301 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13302 set support.
13304 @item winchip2
13305 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13306 instruction set support.
13308 @item c3
13309 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13310 implemented for this chip.)
13312 @item c3-2
13313 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13314 (No scheduling is
13315 implemented for this chip.)
13317 @item geode
13318 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13319 @end table
13321 @item -mtune=@var{cpu-type}
13322 @opindex mtune
13323 Tune to @var{cpu-type} everything applicable about the generated code, except
13324 for the ABI and the set of available instructions.  
13325 While picking a specific @var{cpu-type} schedules things appropriately
13326 for that particular chip, the compiler does not generate any code that
13327 cannot run on the default machine type unless you use a
13328 @option{-march=@var{cpu-type}} option.
13329 For example, if GCC is configured for i686-pc-linux-gnu
13330 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13331 but still runs on i686 machines.
13333 The choices for @var{cpu-type} are the same as for @option{-march}.
13334 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13336 @table @samp
13337 @item generic
13338 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13339 If you know the CPU on which your code will run, then you should use
13340 the corresponding @option{-mtune} or @option{-march} option instead of
13341 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13342 of your application will have, then you should use this option.
13344 As new processors are deployed in the marketplace, the behavior of this
13345 option will change.  Therefore, if you upgrade to a newer version of
13346 GCC, code generation controlled by this option will change to reflect
13347 the processors
13348 that are most common at the time that version of GCC is released.
13350 There is no @option{-march=generic} option because @option{-march}
13351 indicates the instruction set the compiler can use, and there is no
13352 generic instruction set applicable to all processors.  In contrast,
13353 @option{-mtune} indicates the processor (or, in this case, collection of
13354 processors) for which the code is optimized.
13355 @end table
13357 @item -mcpu=@var{cpu-type}
13358 @opindex mcpu
13359 A deprecated synonym for @option{-mtune}.
13361 @item -mfpmath=@var{unit}
13362 @opindex mfpmath
13363 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13364 for @var{unit} are:
13366 @table @samp
13367 @item 387
13368 Use the standard 387 floating-point coprocessor present on the majority of chips and
13369 emulated otherwise.  Code compiled with this option runs almost everywhere.
13370 The temporary results are computed in 80-bit precision instead of the precision
13371 specified by the type, resulting in slightly different results compared to most
13372 of other chips.  See @option{-ffloat-store} for more detailed description.
13374 This is the default choice for i386 compiler.
13376 @item sse
13377 Use scalar floating-point instructions present in the SSE instruction set.
13378 This instruction set is supported by Pentium III and newer chips,
13379 and in the AMD line
13380 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13381 instruction set supports only single-precision arithmetic, thus the double and
13382 extended-precision arithmetic are still done using 387.  A later version, present
13383 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13384 arithmetic too.
13386 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13387 or @option{-msse2} switches to enable SSE extensions and make this option
13388 effective.  For the x86-64 compiler, these extensions are enabled by default.
13390 The resulting code should be considerably faster in the majority of cases and avoid
13391 the numerical instability problems of 387 code, but may break some existing
13392 code that expects temporaries to be 80 bits.
13394 This is the default choice for the x86-64 compiler.
13396 @item sse,387
13397 @itemx sse+387
13398 @itemx both
13399 Attempt to utilize both instruction sets at once.  This effectively doubles the
13400 amount of available registers, and on chips with separate execution units for
13401 387 and SSE the execution resources too.  Use this option with care, as it is
13402 still experimental, because the GCC register allocator does not model separate
13403 functional units well, resulting in unstable performance.
13404 @end table
13406 @item -masm=@var{dialect}
13407 @opindex masm=@var{dialect}
13408 Output assembly instructions using selected @var{dialect}.  Supported
13409 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13410 not support @samp{intel}.
13412 @item -mieee-fp
13413 @itemx -mno-ieee-fp
13414 @opindex mieee-fp
13415 @opindex mno-ieee-fp
13416 Control whether or not the compiler uses IEEE floating-point
13417 comparisons.  These correctly handle the case where the result of a
13418 comparison is unordered.
13420 @item -msoft-float
13421 @opindex msoft-float
13422 Generate output containing library calls for floating point.
13424 @strong{Warning:} the requisite libraries are not part of GCC@.
13425 Normally the facilities of the machine's usual C compiler are used, but
13426 this can't be done directly in cross-compilation.  You must make your
13427 own arrangements to provide suitable library functions for
13428 cross-compilation.
13430 On machines where a function returns floating-point results in the 80387
13431 register stack, some floating-point opcodes may be emitted even if
13432 @option{-msoft-float} is used.
13434 @item -mno-fp-ret-in-387
13435 @opindex mno-fp-ret-in-387
13436 Do not use the FPU registers for return values of functions.
13438 The usual calling convention has functions return values of types
13439 @code{float} and @code{double} in an FPU register, even if there
13440 is no FPU@.  The idea is that the operating system should emulate
13441 an FPU@.
13443 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13444 in ordinary CPU registers instead.
13446 @item -mno-fancy-math-387
13447 @opindex mno-fancy-math-387
13448 Some 387 emulators do not support the @code{sin}, @code{cos} and
13449 @code{sqrt} instructions for the 387.  Specify this option to avoid
13450 generating those instructions.  This option is the default on FreeBSD,
13451 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13452 indicates that the target CPU always has an FPU and so the
13453 instruction does not need emulation.  These
13454 instructions are not generated unless you also use the
13455 @option{-funsafe-math-optimizations} switch.
13457 @item -malign-double
13458 @itemx -mno-align-double
13459 @opindex malign-double
13460 @opindex mno-align-double
13461 Control whether GCC aligns @code{double}, @code{long double}, and
13462 @code{long long} variables on a two-word boundary or a one-word
13463 boundary.  Aligning @code{double} variables on a two-word boundary
13464 produces code that runs somewhat faster on a Pentium at the
13465 expense of more memory.
13467 On x86-64, @option{-malign-double} is enabled by default.
13469 @strong{Warning:} if you use the @option{-malign-double} switch,
13470 structures containing the above types are aligned differently than
13471 the published application binary interface specifications for the 386
13472 and are not binary compatible with structures in code compiled
13473 without that switch.
13475 @item -m96bit-long-double
13476 @itemx -m128bit-long-double
13477 @opindex m96bit-long-double
13478 @opindex m128bit-long-double
13479 These switches control the size of @code{long double} type.  The i386
13480 application binary interface specifies the size to be 96 bits,
13481 so @option{-m96bit-long-double} is the default in 32-bit mode.
13483 Modern architectures (Pentium and newer) prefer @code{long double}
13484 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13485 conforming to the ABI, this is not possible.  So specifying
13486 @option{-m128bit-long-double} aligns @code{long double}
13487 to a 16-byte boundary by padding the @code{long double} with an additional
13488 32-bit zero.
13490 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13491 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13493 Notice that neither of these options enable any extra precision over the x87
13494 standard of 80 bits for a @code{long double}.
13496 @strong{Warning:} if you override the default value for your target ABI, this
13497 changes the size of 
13498 structures and arrays containing @code{long double} variables,
13499 as well as modifying the function calling convention for functions taking
13500 @code{long double}.  Hence they are not binary-compatible
13501 with code compiled without that switch.
13503 @item -mlarge-data-threshold=@var{threshold}
13504 @opindex mlarge-data-threshold
13505 When @option{-mcmodel=medium} is specified, data objects larger than
13506 @var{threshold} are placed in the large data section.  This value must be the
13507 same across all objects linked into the binary, and defaults to 65535.
13509 @item -mrtd
13510 @opindex mrtd
13511 Use a different function-calling convention, in which functions that
13512 take a fixed number of arguments return with the @code{ret @var{num}}
13513 instruction, which pops their arguments while returning.  This saves one
13514 instruction in the caller since there is no need to pop the arguments
13515 there.
13517 You can specify that an individual function is called with this calling
13518 sequence with the function attribute @samp{stdcall}.  You can also
13519 override the @option{-mrtd} option by using the function attribute
13520 @samp{cdecl}.  @xref{Function Attributes}.
13522 @strong{Warning:} this calling convention is incompatible with the one
13523 normally used on Unix, so you cannot use it if you need to call
13524 libraries compiled with the Unix compiler.
13526 Also, you must provide function prototypes for all functions that
13527 take variable numbers of arguments (including @code{printf});
13528 otherwise incorrect code is generated for calls to those
13529 functions.
13531 In addition, seriously incorrect code results if you call a
13532 function with too many arguments.  (Normally, extra arguments are
13533 harmlessly ignored.)
13535 @item -mregparm=@var{num}
13536 @opindex mregparm
13537 Control how many registers are used to pass integer arguments.  By
13538 default, no registers are used to pass arguments, and at most 3
13539 registers can be used.  You can control this behavior for a specific
13540 function by using the function attribute @samp{regparm}.
13541 @xref{Function Attributes}.
13543 @strong{Warning:} if you use this switch, and
13544 @var{num} is nonzero, then you must build all modules with the same
13545 value, including any libraries.  This includes the system libraries and
13546 startup modules.
13548 @item -msseregparm
13549 @opindex msseregparm
13550 Use SSE register passing conventions for float and double arguments
13551 and return values.  You can control this behavior for a specific
13552 function by using the function attribute @samp{sseregparm}.
13553 @xref{Function Attributes}.
13555 @strong{Warning:} if you use this switch then you must build all
13556 modules with the same value, including any libraries.  This includes
13557 the system libraries and startup modules.
13559 @item -mvect8-ret-in-mem
13560 @opindex mvect8-ret-in-mem
13561 Return 8-byte vectors in memory instead of MMX registers.  This is the
13562 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13563 Studio compilers until version 12.  Later compiler versions (starting
13564 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13565 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13566 you need to remain compatible with existing code produced by those
13567 previous compiler versions or older versions of GCC@.
13569 @item -mpc32
13570 @itemx -mpc64
13571 @itemx -mpc80
13572 @opindex mpc32
13573 @opindex mpc64
13574 @opindex mpc80
13576 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13577 is specified, the significands of results of floating-point operations are
13578 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13579 significands of results of floating-point operations to 53 bits (double
13580 precision) and @option{-mpc80} rounds the significands of results of
13581 floating-point operations to 64 bits (extended double precision), which is
13582 the default.  When this option is used, floating-point operations in higher
13583 precisions are not available to the programmer without setting the FPU
13584 control word explicitly.
13586 Setting the rounding of floating-point operations to less than the default
13587 80 bits can speed some programs by 2% or more.  Note that some mathematical
13588 libraries assume that extended-precision (80-bit) floating-point operations
13589 are enabled by default; routines in such libraries could suffer significant
13590 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13591 when this option is used to set the precision to less than extended precision.
13593 @item -mstackrealign
13594 @opindex mstackrealign
13595 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13596 option generates an alternate prologue and epilogue that realigns the
13597 run-time stack if necessary.  This supports mixing legacy codes that keep
13598 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13599 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13600 applicable to individual functions.
13602 @item -mpreferred-stack-boundary=@var{num}
13603 @opindex mpreferred-stack-boundary
13604 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13605 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13606 the default is 4 (16 bytes or 128 bits).
13608 @strong{Warning:} When generating code for the x86-64 architecture with
13609 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
13610 used to keep the stack boundary aligned to 8 byte boundary.  Since
13611 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
13612 intended to be used in controlled environment where stack space is
13613 important limitation.  This option will lead to wrong code when functions
13614 compiled with 16 byte stack alignment (such as functions from a standard
13615 library) are called with misaligned stack.  In this case, SSE
13616 instructions may lead to misaligned memory access traps.  In addition,
13617 variable arguments will be handled incorrectly for 16 byte aligned
13618 objects (including x87 long double and __int128), leading to wrong
13619 results.  You must build all modules with
13620 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
13621 includes the system libraries and startup modules.
13623 @item -mincoming-stack-boundary=@var{num}
13624 @opindex mincoming-stack-boundary
13625 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13626 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13627 the one specified by @option{-mpreferred-stack-boundary} is used.
13629 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13630 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13631 suffer significant run time performance penalties.  On Pentium III, the
13632 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13633 properly if it is not 16-byte aligned.
13635 To ensure proper alignment of this values on the stack, the stack boundary
13636 must be as aligned as that required by any value stored on the stack.
13637 Further, every function must be generated such that it keeps the stack
13638 aligned.  Thus calling a function compiled with a higher preferred
13639 stack boundary from a function compiled with a lower preferred stack
13640 boundary most likely misaligns the stack.  It is recommended that
13641 libraries that use callbacks always use the default setting.
13643 This extra alignment does consume extra stack space, and generally
13644 increases code size.  Code that is sensitive to stack space usage, such
13645 as embedded systems and operating system kernels, may want to reduce the
13646 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13648 @item -mmmx
13649 @itemx -mno-mmx
13650 @itemx -msse
13651 @itemx -mno-sse
13652 @itemx -msse2
13653 @itemx -mno-sse2
13654 @itemx -msse3
13655 @itemx -mno-sse3
13656 @itemx -mssse3
13657 @itemx -mno-ssse3
13658 @itemx -msse4.1
13659 @need 800
13660 @itemx -mno-sse4.1
13661 @itemx -msse4.2
13662 @itemx -mno-sse4.2
13663 @itemx -msse4
13664 @itemx -mno-sse4
13665 @itemx -mavx
13666 @itemx -mno-avx
13667 @itemx -mavx2
13668 @itemx -mno-avx2
13669 @itemx -maes
13670 @itemx -mno-aes
13671 @itemx -mpclmul
13672 @need 800
13673 @itemx -mno-pclmul
13674 @itemx -mfsgsbase
13675 @itemx -mno-fsgsbase
13676 @itemx -mrdrnd
13677 @itemx -mno-rdrnd
13678 @itemx -mf16c
13679 @itemx -mno-f16c
13680 @itemx -mfma
13681 @itemx -mno-fma
13682 @itemx -msse4a
13683 @itemx -mno-sse4a
13684 @itemx -mfma4
13685 @need 800
13686 @itemx -mno-fma4
13687 @itemx -mxop
13688 @itemx -mno-xop
13689 @itemx -mlwp
13690 @itemx -mno-lwp
13691 @itemx -m3dnow
13692 @itemx -mno-3dnow
13693 @itemx -mpopcnt
13694 @itemx -mno-popcnt
13695 @itemx -mabm
13696 @itemx -mno-abm
13697 @itemx -mbmi
13698 @itemx -mbmi2
13699 @itemx -mno-bmi
13700 @itemx -mno-bmi2
13701 @itemx -mlzcnt
13702 @itemx -mno-lzcnt
13703 @itemx -mrtm
13704 @itemx -mtbm
13705 @itemx -mno-tbm
13706 @opindex mmmx
13707 @opindex mno-mmx
13708 @opindex msse
13709 @opindex mno-sse
13710 @opindex m3dnow
13711 @opindex mno-3dnow
13712 These switches enable or disable the use of instructions in the MMX, SSE,
13713 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13714 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
13715 extended instruction sets.
13716 These extensions are also available as built-in functions: see
13717 @ref{X86 Built-in Functions}, for details of the functions enabled and
13718 disabled by these switches.
13720 To generate SSE/SSE2 instructions automatically from floating-point
13721 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13723 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13724 generates new AVX instructions or AVX equivalence for all SSEx instructions
13725 when needed.
13727 These options enable GCC to use these extended instructions in
13728 generated code, even without @option{-mfpmath=sse}.  Applications that
13729 perform run-time CPU detection must compile separate files for each
13730 supported architecture, using the appropriate flags.  In particular,
13731 the file containing the CPU detection code should be compiled without
13732 these options.
13734 @item -mcld
13735 @opindex mcld
13736 This option instructs GCC to emit a @code{cld} instruction in the prologue
13737 of functions that use string instructions.  String instructions depend on
13738 the DF flag to select between autoincrement or autodecrement mode.  While the
13739 ABI specifies the DF flag to be cleared on function entry, some operating
13740 systems violate this specification by not clearing the DF flag in their
13741 exception dispatchers.  The exception handler can be invoked with the DF flag
13742 set, which leads to wrong direction mode when string instructions are used.
13743 This option can be enabled by default on 32-bit x86 targets by configuring
13744 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
13745 instructions can be suppressed with the @option{-mno-cld} compiler option
13746 in this case.
13748 @item -mvzeroupper
13749 @opindex mvzeroupper
13750 This option instructs GCC to emit a @code{vzeroupper} instruction
13751 before a transfer of control flow out of the function to minimize
13752 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
13753 intrinsics.
13755 @item -mcx16
13756 @opindex mcx16
13757 This option enables GCC to generate @code{CMPXCHG16B} instructions.
13758 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
13759 (or oword) data types.  
13760 This is useful for high-resolution counters that can be updated
13761 by multiple processors (or cores).  This instruction is generated as part of
13762 atomic built-in functions: see @ref{__sync Builtins} or
13763 @ref{__atomic Builtins} for details.
13765 @item -msahf
13766 @opindex msahf
13767 This option enables generation of @code{SAHF} instructions in 64-bit code.
13768 Early Intel Pentium 4 CPUs with Intel 64 support,
13769 prior to the introduction of Pentium 4 G1 step in December 2005,
13770 lacked the @code{LAHF} and @code{SAHF} instructions
13771 which were supported by AMD64.
13772 These are load and store instructions, respectively, for certain status flags.
13773 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
13774 @code{drem}, and @code{remainder} built-in functions;
13775 see @ref{Other Builtins} for details.
13777 @item -mmovbe
13778 @opindex mmovbe
13779 This option enables use of the @code{movbe} instruction to implement
13780 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13782 @item -mcrc32
13783 @opindex mcrc32
13784 This option enables built-in functions @code{__builtin_ia32_crc32qi},
13785 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
13786 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
13788 @item -mrecip
13789 @opindex mrecip
13790 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
13791 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
13792 with an additional Newton-Raphson step
13793 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
13794 (and their vectorized
13795 variants) for single-precision floating-point arguments.  These instructions
13796 are generated only when @option{-funsafe-math-optimizations} is enabled
13797 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13798 Note that while the throughput of the sequence is higher than the throughput
13799 of the non-reciprocal instruction, the precision of the sequence can be
13800 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13802 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
13803 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
13804 combination), and doesn't need @option{-mrecip}.
13806 Also note that GCC emits the above sequence with additional Newton-Raphson step
13807 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
13808 already with @option{-ffast-math} (or the above option combination), and
13809 doesn't need @option{-mrecip}.
13811 @item -mrecip=@var{opt}
13812 @opindex mrecip=opt
13813 This option controls which reciprocal estimate instructions
13814 may be used.  @var{opt} is a comma-separated list of options, which may
13815 be preceded by a @samp{!} to invert the option:
13817 @table @samp
13818 @item all
13819 Enable all estimate instructions.
13821 @item default
13822 Enable the default instructions, equivalent to @option{-mrecip}.
13824 @item none
13825 Disable all estimate instructions, equivalent to @option{-mno-recip}.
13827 @item div
13828 Enable the approximation for scalar division.
13830 @item vec-div
13831 Enable the approximation for vectorized division.
13833 @item sqrt
13834 Enable the approximation for scalar square root.
13836 @item vec-sqrt
13837 Enable the approximation for vectorized square root.
13838 @end table
13840 So, for example, @option{-mrecip=all,!sqrt} enables
13841 all of the reciprocal approximations, except for square root.
13843 @item -mveclibabi=@var{type}
13844 @opindex mveclibabi
13845 Specifies the ABI type to use for vectorizing intrinsics using an
13846 external library.  Supported values for @var{type} are @samp{svml} 
13847 for the Intel short
13848 vector math library and @samp{acml} for the AMD math core library.
13849 To use this option, both @option{-ftree-vectorize} and
13850 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
13851 ABI-compatible library must be specified at link time.
13853 GCC currently emits calls to @code{vmldExp2},
13854 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13855 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13856 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13857 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13858 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13859 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13860 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13861 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13862 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13863 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
13864 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13865 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13866 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13867 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
13868 when @option{-mveclibabi=acml} is used.  
13870 @item -mabi=@var{name}
13871 @opindex mabi
13872 Generate code for the specified calling convention.  Permissible values
13873 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
13874 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
13875 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
13876 You can control this behavior for a specific function by
13877 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13878 @xref{Function Attributes}.
13880 @item -mtls-dialect=@var{type}
13881 @opindex mtls-dialect
13882 Generate code to access thread-local storage using the @samp{gnu} or
13883 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
13884 @samp{gnu2} is more efficient, but it may add compile- and run-time
13885 requirements that cannot be satisfied on all systems.
13887 @item -mpush-args
13888 @itemx -mno-push-args
13889 @opindex mpush-args
13890 @opindex mno-push-args
13891 Use PUSH operations to store outgoing parameters.  This method is shorter
13892 and usually equally fast as method using SUB/MOV operations and is enabled
13893 by default.  In some cases disabling it may improve performance because of
13894 improved scheduling and reduced dependencies.
13896 @item -maccumulate-outgoing-args
13897 @opindex maccumulate-outgoing-args
13898 If enabled, the maximum amount of space required for outgoing arguments is
13899 computed in the function prologue.  This is faster on most modern CPUs
13900 because of reduced dependencies, improved scheduling and reduced stack usage
13901 when the preferred stack boundary is not equal to 2.  The drawback is a notable
13902 increase in code size.  This switch implies @option{-mno-push-args}.
13904 @item -mthreads
13905 @opindex mthreads
13906 Support thread-safe exception handling on MinGW.  Programs that rely
13907 on thread-safe exception handling must compile and link all code with the
13908 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
13909 @code{-D_MT}; when linking, it links in a special thread helper library
13910 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
13912 @item -mno-align-stringops
13913 @opindex mno-align-stringops
13914 Do not align the destination of inlined string operations.  This switch reduces
13915 code size and improves performance in case the destination is already aligned,
13916 but GCC doesn't know about it.
13918 @item -minline-all-stringops
13919 @opindex minline-all-stringops
13920 By default GCC inlines string operations only when the destination is 
13921 known to be aligned to least a 4-byte boundary.  
13922 This enables more inlining and increases code
13923 size, but may improve performance of code that depends on fast
13924 @code{memcpy}, @code{strlen},
13925 and @code{memset} for short lengths.
13927 @item -minline-stringops-dynamically
13928 @opindex minline-stringops-dynamically
13929 For string operations of unknown size, use run-time checks with
13930 inline code for small blocks and a library call for large blocks.
13932 @item -mstringop-strategy=@var{alg}
13933 @opindex mstringop-strategy=@var{alg}
13934 Override the internal decision heuristic for the particular algorithm to use
13935 for inlining string operations.  The allowed values for @var{alg} are:
13937 @table @samp
13938 @item rep_byte
13939 @itemx rep_4byte
13940 @itemx rep_8byte
13941 Expand using i386 @code{rep} prefix of the specified size.
13943 @item byte_loop
13944 @itemx loop
13945 @itemx unrolled_loop
13946 Expand into an inline loop.
13948 @item libcall
13949 Always use a library call.
13950 @end table
13952 @item -momit-leaf-frame-pointer
13953 @opindex momit-leaf-frame-pointer
13954 Don't keep the frame pointer in a register for leaf functions.  This
13955 avoids the instructions to save, set up, and restore frame pointers and
13956 makes an extra register available in leaf functions.  The option
13957 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
13958 which might make debugging harder.
13960 @item -mtls-direct-seg-refs
13961 @itemx -mno-tls-direct-seg-refs
13962 @opindex mtls-direct-seg-refs
13963 Controls whether TLS variables may be accessed with offsets from the
13964 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13965 or whether the thread base pointer must be added.  Whether or not this
13966 is valid depends on the operating system, and whether it maps the
13967 segment to cover the entire TLS area.
13969 For systems that use the GNU C Library, the default is on.
13971 @item -msse2avx
13972 @itemx -mno-sse2avx
13973 @opindex msse2avx
13974 Specify that the assembler should encode SSE instructions with VEX
13975 prefix.  The option @option{-mavx} turns this on by default.
13977 @item -mfentry
13978 @itemx -mno-fentry
13979 @opindex mfentry
13980 If profiling is active (@option{-pg}), put the profiling
13981 counter call before the prologue.
13982 Note: On x86 architectures the attribute @code{ms_hook_prologue}
13983 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
13985 @item -m8bit-idiv
13986 @itemx -mno-8bit-idiv
13987 @opindex 8bit-idiv
13988 On some processors, like Intel Atom, 8-bit unsigned integer divide is
13989 much faster than 32-bit/64-bit integer divide.  This option generates a
13990 run-time check.  If both dividend and divisor are within range of 0
13991 to 255, 8-bit unsigned integer divide is used instead of
13992 32-bit/64-bit integer divide.
13994 @item -mavx256-split-unaligned-load
13995 @itemx -mavx256-split-unaligned-store
13996 @opindex avx256-split-unaligned-load
13997 @opindex avx256-split-unaligned-store
13998 Split 32-byte AVX unaligned load and store.
14000 @end table
14002 These @samp{-m} switches are supported in addition to the above
14003 on x86-64 processors in 64-bit environments.
14005 @table @gcctabopt
14006 @item -m32
14007 @itemx -m64
14008 @itemx -mx32
14009 @opindex m32
14010 @opindex m64
14011 @opindex mx32
14012 Generate code for a 32-bit or 64-bit environment.
14013 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14014 to 32 bits, and
14015 generates code that runs on any i386 system.
14017 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14018 types to 64 bits, and generates code for the x86-64 architecture.
14019 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14020 and @option{-mdynamic-no-pic} options.
14022 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14023 to 32 bits, and
14024 generates code for the x86-64 architecture.
14026 @item -mno-red-zone
14027 @opindex mno-red-zone
14028 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14029 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14030 stack pointer that is not modified by signal or interrupt handlers
14031 and therefore can be used for temporary data without adjusting the stack
14032 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14034 @item -mcmodel=small
14035 @opindex mcmodel=small
14036 Generate code for the small code model: the program and its symbols must
14037 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14038 Programs can be statically or dynamically linked.  This is the default
14039 code model.
14041 @item -mcmodel=kernel
14042 @opindex mcmodel=kernel
14043 Generate code for the kernel code model.  The kernel runs in the
14044 negative 2 GB of the address space.
14045 This model has to be used for Linux kernel code.
14047 @item -mcmodel=medium
14048 @opindex mcmodel=medium
14049 Generate code for the medium model: the program is linked in the lower 2
14050 GB of the address space.  Small symbols are also placed there.  Symbols
14051 with sizes larger than @option{-mlarge-data-threshold} are put into
14052 large data or BSS sections and can be located above 2GB.  Programs can
14053 be statically or dynamically linked.
14055 @item -mcmodel=large
14056 @opindex mcmodel=large
14057 Generate code for the large model.  This model makes no assumptions
14058 about addresses and sizes of sections.
14060 @item -maddress-mode=long
14061 @opindex maddress-mode=long
14062 Generate code for long address mode.  This is only supported for 64-bit
14063 and x32 environments.  It is the default address mode for 64-bit
14064 environments.
14066 @item -maddress-mode=short
14067 @opindex maddress-mode=short
14068 Generate code for short address mode.  This is only supported for 32-bit
14069 and x32 environments.  It is the default address mode for 32-bit and
14070 x32 environments.
14071 @end table
14073 @node i386 and x86-64 Windows Options
14074 @subsection i386 and x86-64 Windows Options
14075 @cindex i386 and x86-64 Windows Options
14077 These additional options are available for Microsoft Windows targets:
14079 @table @gcctabopt
14080 @item -mconsole
14081 @opindex mconsole
14082 This option
14083 specifies that a console application is to be generated, by
14084 instructing the linker to set the PE header subsystem type
14085 required for console applications.
14086 This option is available for Cygwin and MinGW targets and is
14087 enabled by default on those targets.
14089 @item -mdll
14090 @opindex mdll
14091 This option is available for Cygwin and MinGW targets.  It
14092 specifies that a DLL---a dynamic link library---is to be
14093 generated, enabling the selection of the required runtime
14094 startup object and entry point.
14096 @item -mnop-fun-dllimport
14097 @opindex mnop-fun-dllimport
14098 This option is available for Cygwin and MinGW targets.  It
14099 specifies that the @code{dllimport} attribute should be ignored.
14101 @item -mthread
14102 @opindex mthread
14103 This option is available for MinGW targets. It specifies
14104 that MinGW-specific thread support is to be used.
14106 @item -municode
14107 @opindex municode
14108 This option is available for MinGW-w64 targets.  It causes
14109 the @code{UNICODE} preprocessor macro to be predefined, and
14110 chooses Unicode-capable runtime startup code.
14112 @item -mwin32
14113 @opindex mwin32
14114 This option is available for Cygwin and MinGW targets.  It
14115 specifies that the typical Microsoft Windows predefined macros are to
14116 be set in the pre-processor, but does not influence the choice
14117 of runtime library/startup code.
14119 @item -mwindows
14120 @opindex mwindows
14121 This option is available for Cygwin and MinGW targets.  It
14122 specifies that a GUI application is to be generated by
14123 instructing the linker to set the PE header subsystem type
14124 appropriately.
14126 @item -fno-set-stack-executable
14127 @opindex fno-set-stack-executable
14128 This option is available for MinGW targets. It specifies that
14129 the executable flag for the stack used by nested functions isn't
14130 set. This is necessary for binaries running in kernel mode of
14131 Microsoft Windows, as there the User32 API, which is used to set executable
14132 privileges, isn't available.
14134 @item -fwritable-relocated-rdata
14135 @opindex fno-writable-relocated-rdata
14136 This option is available for MinGW and Cygwin targets.  It specifies
14137 that relocated-data in read-only section is put into .data
14138 section.  This is a necessary for older runtimes not supporting
14139 modification of .rdata sections for pseudo-relocation.
14141 @item -mpe-aligned-commons
14142 @opindex mpe-aligned-commons
14143 This option is available for Cygwin and MinGW targets.  It
14144 specifies that the GNU extension to the PE file format that
14145 permits the correct alignment of COMMON variables should be
14146 used when generating code.  It is enabled by default if
14147 GCC detects that the target assembler found during configuration
14148 supports the feature.
14149 @end table
14151 See also under @ref{i386 and x86-64 Options} for standard options.
14153 @node IA-64 Options
14154 @subsection IA-64 Options
14155 @cindex IA-64 Options
14157 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14159 @table @gcctabopt
14160 @item -mbig-endian
14161 @opindex mbig-endian
14162 Generate code for a big-endian target.  This is the default for HP-UX@.
14164 @item -mlittle-endian
14165 @opindex mlittle-endian
14166 Generate code for a little-endian target.  This is the default for AIX5
14167 and GNU/Linux.
14169 @item -mgnu-as
14170 @itemx -mno-gnu-as
14171 @opindex mgnu-as
14172 @opindex mno-gnu-as
14173 Generate (or don't) code for the GNU assembler.  This is the default.
14174 @c Also, this is the default if the configure option @option{--with-gnu-as}
14175 @c is used.
14177 @item -mgnu-ld
14178 @itemx -mno-gnu-ld
14179 @opindex mgnu-ld
14180 @opindex mno-gnu-ld
14181 Generate (or don't) code for the GNU linker.  This is the default.
14182 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14183 @c is used.
14185 @item -mno-pic
14186 @opindex mno-pic
14187 Generate code that does not use a global pointer register.  The result
14188 is not position independent code, and violates the IA-64 ABI@.
14190 @item -mvolatile-asm-stop
14191 @itemx -mno-volatile-asm-stop
14192 @opindex mvolatile-asm-stop
14193 @opindex mno-volatile-asm-stop
14194 Generate (or don't) a stop bit immediately before and after volatile asm
14195 statements.
14197 @item -mregister-names
14198 @itemx -mno-register-names
14199 @opindex mregister-names
14200 @opindex mno-register-names
14201 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14202 the stacked registers.  This may make assembler output more readable.
14204 @item -mno-sdata
14205 @itemx -msdata
14206 @opindex mno-sdata
14207 @opindex msdata
14208 Disable (or enable) optimizations that use the small data section.  This may
14209 be useful for working around optimizer bugs.
14211 @item -mconstant-gp
14212 @opindex mconstant-gp
14213 Generate code that uses a single constant global pointer value.  This is
14214 useful when compiling kernel code.
14216 @item -mauto-pic
14217 @opindex mauto-pic
14218 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14219 This is useful when compiling firmware code.
14221 @item -minline-float-divide-min-latency
14222 @opindex minline-float-divide-min-latency
14223 Generate code for inline divides of floating-point values
14224 using the minimum latency algorithm.
14226 @item -minline-float-divide-max-throughput
14227 @opindex minline-float-divide-max-throughput
14228 Generate code for inline divides of floating-point values
14229 using the maximum throughput algorithm.
14231 @item -mno-inline-float-divide
14232 @opindex mno-inline-float-divide
14233 Do not generate inline code for divides of floating-point values.
14235 @item -minline-int-divide-min-latency
14236 @opindex minline-int-divide-min-latency
14237 Generate code for inline divides of integer values
14238 using the minimum latency algorithm.
14240 @item -minline-int-divide-max-throughput
14241 @opindex minline-int-divide-max-throughput
14242 Generate code for inline divides of integer values
14243 using the maximum throughput algorithm.
14245 @item -mno-inline-int-divide
14246 @opindex mno-inline-int-divide
14247 Do not generate inline code for divides of integer values.
14249 @item -minline-sqrt-min-latency
14250 @opindex minline-sqrt-min-latency
14251 Generate code for inline square roots
14252 using the minimum latency algorithm.
14254 @item -minline-sqrt-max-throughput
14255 @opindex minline-sqrt-max-throughput
14256 Generate code for inline square roots
14257 using the maximum throughput algorithm.
14259 @item -mno-inline-sqrt
14260 @opindex mno-inline-sqrt
14261 Do not generate inline code for @code{sqrt}.
14263 @item -mfused-madd
14264 @itemx -mno-fused-madd
14265 @opindex mfused-madd
14266 @opindex mno-fused-madd
14267 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14268 instructions.  The default is to use these instructions.
14270 @item -mno-dwarf2-asm
14271 @itemx -mdwarf2-asm
14272 @opindex mno-dwarf2-asm
14273 @opindex mdwarf2-asm
14274 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14275 info.  This may be useful when not using the GNU assembler.
14277 @item -mearly-stop-bits
14278 @itemx -mno-early-stop-bits
14279 @opindex mearly-stop-bits
14280 @opindex mno-early-stop-bits
14281 Allow stop bits to be placed earlier than immediately preceding the
14282 instruction that triggered the stop bit.  This can improve instruction
14283 scheduling, but does not always do so.
14285 @item -mfixed-range=@var{register-range}
14286 @opindex mfixed-range
14287 Generate code treating the given register range as fixed registers.
14288 A fixed register is one that the register allocator cannot use.  This is
14289 useful when compiling kernel code.  A register range is specified as
14290 two registers separated by a dash.  Multiple register ranges can be
14291 specified separated by a comma.
14293 @item -mtls-size=@var{tls-size}
14294 @opindex mtls-size
14295 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14298 @item -mtune=@var{cpu-type}
14299 @opindex mtune
14300 Tune the instruction scheduling for a particular CPU, Valid values are
14301 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14302 and @samp{mckinley}.
14304 @item -milp32
14305 @itemx -mlp64
14306 @opindex milp32
14307 @opindex mlp64
14308 Generate code for a 32-bit or 64-bit environment.
14309 The 32-bit environment sets int, long and pointer to 32 bits.
14310 The 64-bit environment sets int to 32 bits and long and pointer
14311 to 64 bits.  These are HP-UX specific flags.
14313 @item -mno-sched-br-data-spec
14314 @itemx -msched-br-data-spec
14315 @opindex mno-sched-br-data-spec
14316 @opindex msched-br-data-spec
14317 (Dis/En)able data speculative scheduling before reload.
14318 This results in generation of @code{ld.a} instructions and
14319 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14320 The default is 'disable'.
14322 @item -msched-ar-data-spec
14323 @itemx -mno-sched-ar-data-spec
14324 @opindex msched-ar-data-spec
14325 @opindex mno-sched-ar-data-spec
14326 (En/Dis)able data speculative scheduling after reload.
14327 This results in generation of @code{ld.a} instructions and
14328 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14329 The default is 'enable'.
14331 @item -mno-sched-control-spec
14332 @itemx -msched-control-spec
14333 @opindex mno-sched-control-spec
14334 @opindex msched-control-spec
14335 (Dis/En)able control speculative scheduling.  This feature is
14336 available only during region scheduling (i.e.@: before reload).
14337 This results in generation of the @code{ld.s} instructions and
14338 the corresponding check instructions @code{chk.s}.
14339 The default is 'disable'.
14341 @item -msched-br-in-data-spec
14342 @itemx -mno-sched-br-in-data-spec
14343 @opindex msched-br-in-data-spec
14344 @opindex mno-sched-br-in-data-spec
14345 (En/Dis)able speculative scheduling of the instructions that
14346 are dependent on the data speculative loads before reload.
14347 This is effective only with @option{-msched-br-data-spec} enabled.
14348 The default is 'enable'.
14350 @item -msched-ar-in-data-spec
14351 @itemx -mno-sched-ar-in-data-spec
14352 @opindex msched-ar-in-data-spec
14353 @opindex mno-sched-ar-in-data-spec
14354 (En/Dis)able speculative scheduling of the instructions that
14355 are dependent on the data speculative loads after reload.
14356 This is effective only with @option{-msched-ar-data-spec} enabled.
14357 The default is 'enable'.
14359 @item -msched-in-control-spec
14360 @itemx -mno-sched-in-control-spec
14361 @opindex msched-in-control-spec
14362 @opindex mno-sched-in-control-spec
14363 (En/Dis)able speculative scheduling of the instructions that
14364 are dependent on the control speculative loads.
14365 This is effective only with @option{-msched-control-spec} enabled.
14366 The default is 'enable'.
14368 @item -mno-sched-prefer-non-data-spec-insns
14369 @itemx -msched-prefer-non-data-spec-insns
14370 @opindex mno-sched-prefer-non-data-spec-insns
14371 @opindex msched-prefer-non-data-spec-insns
14372 If enabled, data-speculative instructions are chosen for schedule
14373 only if there are no other choices at the moment.  This makes
14374 the use of the data speculation much more conservative.
14375 The default is 'disable'.
14377 @item -mno-sched-prefer-non-control-spec-insns
14378 @itemx -msched-prefer-non-control-spec-insns
14379 @opindex mno-sched-prefer-non-control-spec-insns
14380 @opindex msched-prefer-non-control-spec-insns
14381 If enabled, control-speculative instructions are chosen for schedule
14382 only if there are no other choices at the moment.  This makes
14383 the use of the control speculation much more conservative.
14384 The default is 'disable'.
14386 @item -mno-sched-count-spec-in-critical-path
14387 @itemx -msched-count-spec-in-critical-path
14388 @opindex mno-sched-count-spec-in-critical-path
14389 @opindex msched-count-spec-in-critical-path
14390 If enabled, speculative dependencies are considered during
14391 computation of the instructions priorities.  This makes the use of the
14392 speculation a bit more conservative.
14393 The default is 'disable'.
14395 @item -msched-spec-ldc
14396 @opindex msched-spec-ldc
14397 Use a simple data speculation check.  This option is on by default.
14399 @item -msched-control-spec-ldc
14400 @opindex msched-spec-ldc
14401 Use a simple check for control speculation.  This option is on by default.
14403 @item -msched-stop-bits-after-every-cycle
14404 @opindex msched-stop-bits-after-every-cycle
14405 Place a stop bit after every cycle when scheduling.  This option is on
14406 by default.
14408 @item -msched-fp-mem-deps-zero-cost
14409 @opindex msched-fp-mem-deps-zero-cost
14410 Assume that floating-point stores and loads are not likely to cause a conflict
14411 when placed into the same instruction group.  This option is disabled by
14412 default.
14414 @item -msel-sched-dont-check-control-spec
14415 @opindex msel-sched-dont-check-control-spec
14416 Generate checks for control speculation in selective scheduling.
14417 This flag is disabled by default.
14419 @item -msched-max-memory-insns=@var{max-insns}
14420 @opindex msched-max-memory-insns
14421 Limit on the number of memory insns per instruction group, giving lower
14422 priority to subsequent memory insns attempting to schedule in the same
14423 instruction group. Frequently useful to prevent cache bank conflicts.
14424 The default value is 1.
14426 @item -msched-max-memory-insns-hard-limit
14427 @opindex msched-max-memory-insns-hard-limit
14428 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14429 disallowing more than that number in an instruction group.
14430 Otherwise, the limit is ``soft'', meaning that non-memory operations
14431 are preferred when the limit is reached, but memory operations may still
14432 be scheduled.
14434 @end table
14436 @node LM32 Options
14437 @subsection LM32 Options
14438 @cindex LM32 options
14440 These @option{-m} options are defined for the Lattice Mico32 architecture:
14442 @table @gcctabopt
14443 @item -mbarrel-shift-enabled
14444 @opindex mbarrel-shift-enabled
14445 Enable barrel-shift instructions.
14447 @item -mdivide-enabled
14448 @opindex mdivide-enabled
14449 Enable divide and modulus instructions.
14451 @item -mmultiply-enabled
14452 @opindex multiply-enabled
14453 Enable multiply instructions.
14455 @item -msign-extend-enabled
14456 @opindex msign-extend-enabled
14457 Enable sign extend instructions.
14459 @item -muser-enabled
14460 @opindex muser-enabled
14461 Enable user-defined instructions.
14463 @end table
14465 @node M32C Options
14466 @subsection M32C Options
14467 @cindex M32C options
14469 @table @gcctabopt
14470 @item -mcpu=@var{name}
14471 @opindex mcpu=
14472 Select the CPU for which code is generated.  @var{name} may be one of
14473 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14474 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14475 the M32C/80 series.
14477 @item -msim
14478 @opindex msim
14479 Specifies that the program will be run on the simulator.  This causes
14480 an alternate runtime library to be linked in which supports, for
14481 example, file I/O@.  You must not use this option when generating
14482 programs that will run on real hardware; you must provide your own
14483 runtime library for whatever I/O functions are needed.
14485 @item -memregs=@var{number}
14486 @opindex memregs=
14487 Specifies the number of memory-based pseudo-registers GCC uses
14488 during code generation.  These pseudo-registers are used like real
14489 registers, so there is a tradeoff between GCC's ability to fit the
14490 code into available registers, and the performance penalty of using
14491 memory instead of registers.  Note that all modules in a program must
14492 be compiled with the same value for this option.  Because of that, you
14493 must not use this option with the default runtime libraries gcc
14494 builds.
14496 @end table
14498 @node M32R/D Options
14499 @subsection M32R/D Options
14500 @cindex M32R/D options
14502 These @option{-m} options are defined for Renesas M32R/D architectures:
14504 @table @gcctabopt
14505 @item -m32r2
14506 @opindex m32r2
14507 Generate code for the M32R/2@.
14509 @item -m32rx
14510 @opindex m32rx
14511 Generate code for the M32R/X@.
14513 @item -m32r
14514 @opindex m32r
14515 Generate code for the M32R@.  This is the default.
14517 @item -mmodel=small
14518 @opindex mmodel=small
14519 Assume all objects live in the lower 16MB of memory (so that their addresses
14520 can be loaded with the @code{ld24} instruction), and assume all subroutines
14521 are reachable with the @code{bl} instruction.
14522 This is the default.
14524 The addressability of a particular object can be set with the
14525 @code{model} attribute.
14527 @item -mmodel=medium
14528 @opindex mmodel=medium
14529 Assume objects may be anywhere in the 32-bit address space (the compiler
14530 generates @code{seth/add3} instructions to load their addresses), and
14531 assume all subroutines are reachable with the @code{bl} instruction.
14533 @item -mmodel=large
14534 @opindex mmodel=large
14535 Assume objects may be anywhere in the 32-bit address space (the compiler
14536 generates @code{seth/add3} instructions to load their addresses), and
14537 assume subroutines may not be reachable with the @code{bl} instruction
14538 (the compiler generates the much slower @code{seth/add3/jl}
14539 instruction sequence).
14541 @item -msdata=none
14542 @opindex msdata=none
14543 Disable use of the small data area.  Variables are put into
14544 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
14545 @code{section} attribute has been specified).
14546 This is the default.
14548 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14549 Objects may be explicitly put in the small data area with the
14550 @code{section} attribute using one of these sections.
14552 @item -msdata=sdata
14553 @opindex msdata=sdata
14554 Put small global and static data in the small data area, but do not
14555 generate special code to reference them.
14557 @item -msdata=use
14558 @opindex msdata=use
14559 Put small global and static data in the small data area, and generate
14560 special instructions to reference them.
14562 @item -G @var{num}
14563 @opindex G
14564 @cindex smaller data references
14565 Put global and static objects less than or equal to @var{num} bytes
14566 into the small data or bss sections instead of the normal data or bss
14567 sections.  The default value of @var{num} is 8.
14568 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14569 for this option to have any effect.
14571 All modules should be compiled with the same @option{-G @var{num}} value.
14572 Compiling with different values of @var{num} may or may not work; if it
14573 doesn't the linker gives an error message---incorrect code is not
14574 generated.
14576 @item -mdebug
14577 @opindex mdebug
14578 Makes the M32R specific code in the compiler display some statistics
14579 that might help in debugging programs.
14581 @item -malign-loops
14582 @opindex malign-loops
14583 Align all loops to a 32-byte boundary.
14585 @item -mno-align-loops
14586 @opindex mno-align-loops
14587 Do not enforce a 32-byte alignment for loops.  This is the default.
14589 @item -missue-rate=@var{number}
14590 @opindex missue-rate=@var{number}
14591 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14592 or 2.
14594 @item -mbranch-cost=@var{number}
14595 @opindex mbranch-cost=@var{number}
14596 @var{number} can only be 1 or 2.  If it is 1 then branches are
14597 preferred over conditional code, if it is 2, then the opposite applies.
14599 @item -mflush-trap=@var{number}
14600 @opindex mflush-trap=@var{number}
14601 Specifies the trap number to use to flush the cache.  The default is
14602 12.  Valid numbers are between 0 and 15 inclusive.
14604 @item -mno-flush-trap
14605 @opindex mno-flush-trap
14606 Specifies that the cache cannot be flushed by using a trap.
14608 @item -mflush-func=@var{name}
14609 @opindex mflush-func=@var{name}
14610 Specifies the name of the operating system function to call to flush
14611 the cache.  The default is @emph{_flush_cache}, but a function call
14612 is only used if a trap is not available.
14614 @item -mno-flush-func
14615 @opindex mno-flush-func
14616 Indicates that there is no OS function for flushing the cache.
14618 @end table
14620 @node M680x0 Options
14621 @subsection M680x0 Options
14622 @cindex M680x0 options
14624 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14625 The default settings depend on which architecture was selected when
14626 the compiler was configured; the defaults for the most common choices
14627 are given below.
14629 @table @gcctabopt
14630 @item -march=@var{arch}
14631 @opindex march
14632 Generate code for a specific M680x0 or ColdFire instruction set
14633 architecture.  Permissible values of @var{arch} for M680x0
14634 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14635 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14636 architectures are selected according to Freescale's ISA classification
14637 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14638 @samp{isab} and @samp{isac}.
14640 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14641 code for a ColdFire target.  The @var{arch} in this macro is one of the
14642 @option{-march} arguments given above.
14644 When used together, @option{-march} and @option{-mtune} select code
14645 that runs on a family of similar processors but that is optimized
14646 for a particular microarchitecture.
14648 @item -mcpu=@var{cpu}
14649 @opindex mcpu
14650 Generate code for a specific M680x0 or ColdFire processor.
14651 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14652 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14653 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14654 below, which also classifies the CPUs into families:
14656 @multitable @columnfractions 0.20 0.80
14657 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14658 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51ag} @samp{51cn} @samp{51em} @samp{51je} @samp{51jf} @samp{51jg} @samp{51jm} @samp{51mm} @samp{51qe} @samp{51qm}
14659 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14660 @item @samp{5206e} @tab @samp{5206e}
14661 @item @samp{5208} @tab @samp{5207} @samp{5208}
14662 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14663 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14664 @item @samp{5216} @tab @samp{5214} @samp{5216}
14665 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14666 @item @samp{5225} @tab @samp{5224} @samp{5225}
14667 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14668 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14669 @item @samp{5249} @tab @samp{5249}
14670 @item @samp{5250} @tab @samp{5250}
14671 @item @samp{5271} @tab @samp{5270} @samp{5271}
14672 @item @samp{5272} @tab @samp{5272}
14673 @item @samp{5275} @tab @samp{5274} @samp{5275}
14674 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14675 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14676 @item @samp{5307} @tab @samp{5307}
14677 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14678 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14679 @item @samp{5407} @tab @samp{5407}
14680 @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}
14681 @end multitable
14683 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14684 @var{arch} is compatible with @var{cpu}.  Other combinations of
14685 @option{-mcpu} and @option{-march} are rejected.
14687 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14688 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
14689 where the value of @var{family} is given by the table above.
14691 @item -mtune=@var{tune}
14692 @opindex mtune
14693 Tune the code for a particular microarchitecture, within the
14694 constraints set by @option{-march} and @option{-mcpu}.
14695 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14696 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14697 and @samp{cpu32}.  The ColdFire microarchitectures
14698 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14700 You can also use @option{-mtune=68020-40} for code that needs
14701 to run relatively well on 68020, 68030 and 68040 targets.
14702 @option{-mtune=68020-60} is similar but includes 68060 targets
14703 as well.  These two options select the same tuning decisions as
14704 @option{-m68020-40} and @option{-m68020-60} respectively.
14706 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14707 when tuning for 680x0 architecture @var{arch}.  It also defines
14708 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14709 option is used.  If GCC is tuning for a range of architectures,
14710 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14711 it defines the macros for every architecture in the range.
14713 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
14714 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14715 of the arguments given above.
14717 @item -m68000
14718 @itemx -mc68000
14719 @opindex m68000
14720 @opindex mc68000
14721 Generate output for a 68000.  This is the default
14722 when the compiler is configured for 68000-based systems.
14723 It is equivalent to @option{-march=68000}.
14725 Use this option for microcontrollers with a 68000 or EC000 core,
14726 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14728 @item -m68010
14729 @opindex m68010
14730 Generate output for a 68010.  This is the default
14731 when the compiler is configured for 68010-based systems.
14732 It is equivalent to @option{-march=68010}.
14734 @item -m68020
14735 @itemx -mc68020
14736 @opindex m68020
14737 @opindex mc68020
14738 Generate output for a 68020.  This is the default
14739 when the compiler is configured for 68020-based systems.
14740 It is equivalent to @option{-march=68020}.
14742 @item -m68030
14743 @opindex m68030
14744 Generate output for a 68030.  This is the default when the compiler is
14745 configured for 68030-based systems.  It is equivalent to
14746 @option{-march=68030}.
14748 @item -m68040
14749 @opindex m68040
14750 Generate output for a 68040.  This is the default when the compiler is
14751 configured for 68040-based systems.  It is equivalent to
14752 @option{-march=68040}.
14754 This option inhibits the use of 68881/68882 instructions that have to be
14755 emulated by software on the 68040.  Use this option if your 68040 does not
14756 have code to emulate those instructions.
14758 @item -m68060
14759 @opindex m68060
14760 Generate output for a 68060.  This is the default when the compiler is
14761 configured for 68060-based systems.  It is equivalent to
14762 @option{-march=68060}.
14764 This option inhibits the use of 68020 and 68881/68882 instructions that
14765 have to be emulated by software on the 68060.  Use this option if your 68060
14766 does not have code to emulate those instructions.
14768 @item -mcpu32
14769 @opindex mcpu32
14770 Generate output for a CPU32.  This is the default
14771 when the compiler is configured for CPU32-based systems.
14772 It is equivalent to @option{-march=cpu32}.
14774 Use this option for microcontrollers with a
14775 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14776 68336, 68340, 68341, 68349 and 68360.
14778 @item -m5200
14779 @opindex m5200
14780 Generate output for a 520X ColdFire CPU@.  This is the default
14781 when the compiler is configured for 520X-based systems.
14782 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14783 in favor of that option.
14785 Use this option for microcontroller with a 5200 core, including
14786 the MCF5202, MCF5203, MCF5204 and MCF5206.
14788 @item -m5206e
14789 @opindex m5206e
14790 Generate output for a 5206e ColdFire CPU@.  The option is now
14791 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14793 @item -m528x
14794 @opindex m528x
14795 Generate output for a member of the ColdFire 528X family.
14796 The option is now deprecated in favor of the equivalent
14797 @option{-mcpu=528x}.
14799 @item -m5307
14800 @opindex m5307
14801 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
14802 in favor of the equivalent @option{-mcpu=5307}.
14804 @item -m5407
14805 @opindex m5407
14806 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
14807 in favor of the equivalent @option{-mcpu=5407}.
14809 @item -mcfv4e
14810 @opindex mcfv4e
14811 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14812 This includes use of hardware floating-point instructions.
14813 The option is equivalent to @option{-mcpu=547x}, and is now
14814 deprecated in favor of that option.
14816 @item -m68020-40
14817 @opindex m68020-40
14818 Generate output for a 68040, without using any of the new instructions.
14819 This results in code that can run relatively efficiently on either a
14820 68020/68881 or a 68030 or a 68040.  The generated code does use the
14821 68881 instructions that are emulated on the 68040.
14823 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14825 @item -m68020-60
14826 @opindex m68020-60
14827 Generate output for a 68060, without using any of the new instructions.
14828 This results in code that can run relatively efficiently on either a
14829 68020/68881 or a 68030 or a 68040.  The generated code does use the
14830 68881 instructions that are emulated on the 68060.
14832 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14834 @item -mhard-float
14835 @itemx -m68881
14836 @opindex mhard-float
14837 @opindex m68881
14838 Generate floating-point instructions.  This is the default for 68020
14839 and above, and for ColdFire devices that have an FPU@.  It defines the
14840 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14841 on ColdFire targets.
14843 @item -msoft-float
14844 @opindex msoft-float
14845 Do not generate floating-point instructions; use library calls instead.
14846 This is the default for 68000, 68010, and 68832 targets.  It is also
14847 the default for ColdFire devices that have no FPU.
14849 @item -mdiv
14850 @itemx -mno-div
14851 @opindex mdiv
14852 @opindex mno-div
14853 Generate (do not generate) ColdFire hardware divide and remainder
14854 instructions.  If @option{-march} is used without @option{-mcpu},
14855 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14856 architectures.  Otherwise, the default is taken from the target CPU
14857 (either the default CPU, or the one specified by @option{-mcpu}).  For
14858 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14859 @option{-mcpu=5206e}.
14861 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14863 @item -mshort
14864 @opindex mshort
14865 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14866 Additionally, parameters passed on the stack are also aligned to a
14867 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14869 @item -mno-short
14870 @opindex mno-short
14871 Do not consider type @code{int} to be 16 bits wide.  This is the default.
14873 @item -mnobitfield
14874 @itemx -mno-bitfield
14875 @opindex mnobitfield
14876 @opindex mno-bitfield
14877 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
14878 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14880 @item -mbitfield
14881 @opindex mbitfield
14882 Do use the bit-field instructions.  The @option{-m68020} option implies
14883 @option{-mbitfield}.  This is the default if you use a configuration
14884 designed for a 68020.
14886 @item -mrtd
14887 @opindex mrtd
14888 Use a different function-calling convention, in which functions
14889 that take a fixed number of arguments return with the @code{rtd}
14890 instruction, which pops their arguments while returning.  This
14891 saves one instruction in the caller since there is no need to pop
14892 the arguments there.
14894 This calling convention is incompatible with the one normally
14895 used on Unix, so you cannot use it if you need to call libraries
14896 compiled with the Unix compiler.
14898 Also, you must provide function prototypes for all functions that
14899 take variable numbers of arguments (including @code{printf});
14900 otherwise incorrect code is generated for calls to those
14901 functions.
14903 In addition, seriously incorrect code results if you call a
14904 function with too many arguments.  (Normally, extra arguments are
14905 harmlessly ignored.)
14907 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14908 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14910 @item -mno-rtd
14911 @opindex mno-rtd
14912 Do not use the calling conventions selected by @option{-mrtd}.
14913 This is the default.
14915 @item -malign-int
14916 @itemx -mno-align-int
14917 @opindex malign-int
14918 @opindex mno-align-int
14919 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14920 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14921 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14922 Aligning variables on 32-bit boundaries produces code that runs somewhat
14923 faster on processors with 32-bit busses at the expense of more memory.
14925 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
14926 aligns structures containing the above types differently than
14927 most published application binary interface specifications for the m68k.
14929 @item -mpcrel
14930 @opindex mpcrel
14931 Use the pc-relative addressing mode of the 68000 directly, instead of
14932 using a global offset table.  At present, this option implies @option{-fpic},
14933 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
14934 not presently supported with @option{-mpcrel}, though this could be supported for
14935 68020 and higher processors.
14937 @item -mno-strict-align
14938 @itemx -mstrict-align
14939 @opindex mno-strict-align
14940 @opindex mstrict-align
14941 Do not (do) assume that unaligned memory references are handled by
14942 the system.
14944 @item -msep-data
14945 Generate code that allows the data segment to be located in a different
14946 area of memory from the text segment.  This allows for execute in place in
14947 an environment without virtual memory management.  This option implies
14948 @option{-fPIC}.
14950 @item -mno-sep-data
14951 Generate code that assumes that the data segment follows the text segment.
14952 This is the default.
14954 @item -mid-shared-library
14955 Generate code that supports shared libraries via the library ID method.
14956 This allows for execute in place and shared libraries in an environment
14957 without virtual memory management.  This option implies @option{-fPIC}.
14959 @item -mno-id-shared-library
14960 Generate code that doesn't assume ID based shared libraries are being used.
14961 This is the default.
14963 @item -mshared-library-id=n
14964 Specifies the identification number of the ID-based shared library being
14965 compiled.  Specifying a value of 0 generates more compact code; specifying
14966 other values forces the allocation of that number to the current
14967 library, but is no more space- or time-efficient than omitting this option.
14969 @item -mxgot
14970 @itemx -mno-xgot
14971 @opindex mxgot
14972 @opindex mno-xgot
14973 When generating position-independent code for ColdFire, generate code
14974 that works if the GOT has more than 8192 entries.  This code is
14975 larger and slower than code generated without this option.  On M680x0
14976 processors, this option is not needed; @option{-fPIC} suffices.
14978 GCC normally uses a single instruction to load values from the GOT@.
14979 While this is relatively efficient, it only works if the GOT
14980 is smaller than about 64k.  Anything larger causes the linker
14981 to report an error such as:
14983 @cindex relocation truncated to fit (ColdFire)
14984 @smallexample
14985 relocation truncated to fit: R_68K_GOT16O foobar
14986 @end smallexample
14988 If this happens, you should recompile your code with @option{-mxgot}.
14989 It should then work with very large GOTs.  However, code generated with
14990 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
14991 the value of a global symbol.
14993 Note that some linkers, including newer versions of the GNU linker,
14994 can create multiple GOTs and sort GOT entries.  If you have such a linker,
14995 you should only need to use @option{-mxgot} when compiling a single
14996 object file that accesses more than 8192 GOT entries.  Very few do.
14998 These options have no effect unless GCC is generating
14999 position-independent code.
15001 @end table
15003 @node MCore Options
15004 @subsection MCore Options
15005 @cindex MCore options
15007 These are the @samp{-m} options defined for the Motorola M*Core
15008 processors.
15010 @table @gcctabopt
15012 @item -mhardlit
15013 @itemx -mno-hardlit
15014 @opindex mhardlit
15015 @opindex mno-hardlit
15016 Inline constants into the code stream if it can be done in two
15017 instructions or less.
15019 @item -mdiv
15020 @itemx -mno-div
15021 @opindex mdiv
15022 @opindex mno-div
15023 Use the divide instruction.  (Enabled by default).
15025 @item -mrelax-immediate
15026 @itemx -mno-relax-immediate
15027 @opindex mrelax-immediate
15028 @opindex mno-relax-immediate
15029 Allow arbitrary sized immediates in bit operations.
15031 @item -mwide-bitfields
15032 @itemx -mno-wide-bitfields
15033 @opindex mwide-bitfields
15034 @opindex mno-wide-bitfields
15035 Always treat bit-fields as int-sized.
15037 @item -m4byte-functions
15038 @itemx -mno-4byte-functions
15039 @opindex m4byte-functions
15040 @opindex mno-4byte-functions
15041 Force all functions to be aligned to a 4-byte boundary.
15043 @item -mcallgraph-data
15044 @itemx -mno-callgraph-data
15045 @opindex mcallgraph-data
15046 @opindex mno-callgraph-data
15047 Emit callgraph information.
15049 @item -mslow-bytes
15050 @itemx -mno-slow-bytes
15051 @opindex mslow-bytes
15052 @opindex mno-slow-bytes
15053 Prefer word access when reading byte quantities.
15055 @item -mlittle-endian
15056 @itemx -mbig-endian
15057 @opindex mlittle-endian
15058 @opindex mbig-endian
15059 Generate code for a little-endian target.
15061 @item -m210
15062 @itemx -m340
15063 @opindex m210
15064 @opindex m340
15065 Generate code for the 210 processor.
15067 @item -mno-lsim
15068 @opindex mno-lsim
15069 Assume that runtime support has been provided and so omit the
15070 simulator library (@file{libsim.a)} from the linker command line.
15072 @item -mstack-increment=@var{size}
15073 @opindex mstack-increment
15074 Set the maximum amount for a single stack increment operation.  Large
15075 values can increase the speed of programs that contain functions
15076 that need a large amount of stack space, but they can also trigger a
15077 segmentation fault if the stack is extended too much.  The default
15078 value is 0x1000.
15080 @end table
15082 @node MeP Options
15083 @subsection MeP Options
15084 @cindex MeP options
15086 @table @gcctabopt
15088 @item -mabsdiff
15089 @opindex mabsdiff
15090 Enables the @code{abs} instruction, which is the absolute difference
15091 between two registers.
15093 @item -mall-opts
15094 @opindex mall-opts
15095 Enables all the optional instructions---average, multiply, divide, bit
15096 operations, leading zero, absolute difference, min/max, clip, and
15097 saturation.
15100 @item -maverage
15101 @opindex maverage
15102 Enables the @code{ave} instruction, which computes the average of two
15103 registers.
15105 @item -mbased=@var{n}
15106 @opindex mbased=
15107 Variables of size @var{n} bytes or smaller are placed in the
15108 @code{.based} section by default.  Based variables use the @code{$tp}
15109 register as a base register, and there is a 128-byte limit to the
15110 @code{.based} section.
15112 @item -mbitops
15113 @opindex mbitops
15114 Enables the bit operation instructions---bit test (@code{btstm}), set
15115 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15116 test-and-set (@code{tas}).
15118 @item -mc=@var{name}
15119 @opindex mc=
15120 Selects which section constant data is placed in.  @var{name} may
15121 be @code{tiny}, @code{near}, or @code{far}.
15123 @item -mclip
15124 @opindex mclip
15125 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15126 useful unless you also provide @code{-mminmax}.
15128 @item -mconfig=@var{name}
15129 @opindex mconfig=
15130 Selects one of the build-in core configurations.  Each MeP chip has
15131 one or more modules in it; each module has a core CPU and a variety of
15132 coprocessors, optional instructions, and peripherals.  The
15133 @code{MeP-Integrator} tool, not part of GCC, provides these
15134 configurations through this option; using this option is the same as
15135 using all the corresponding command-line options.  The default
15136 configuration is @code{default}.
15138 @item -mcop
15139 @opindex mcop
15140 Enables the coprocessor instructions.  By default, this is a 32-bit
15141 coprocessor.  Note that the coprocessor is normally enabled via the
15142 @code{-mconfig=} option.
15144 @item -mcop32
15145 @opindex mcop32
15146 Enables the 32-bit coprocessor's instructions.
15148 @item -mcop64
15149 @opindex mcop64
15150 Enables the 64-bit coprocessor's instructions.
15152 @item -mivc2
15153 @opindex mivc2
15154 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15156 @item -mdc
15157 @opindex mdc
15158 Causes constant variables to be placed in the @code{.near} section.
15160 @item -mdiv
15161 @opindex mdiv
15162 Enables the @code{div} and @code{divu} instructions.
15164 @item -meb
15165 @opindex meb
15166 Generate big-endian code.
15168 @item -mel
15169 @opindex mel
15170 Generate little-endian code.
15172 @item -mio-volatile
15173 @opindex mio-volatile
15174 Tells the compiler that any variable marked with the @code{io}
15175 attribute is to be considered volatile.
15177 @item -ml
15178 @opindex ml
15179 Causes variables to be assigned to the @code{.far} section by default.
15181 @item -mleadz
15182 @opindex mleadz
15183 Enables the @code{leadz} (leading zero) instruction.
15185 @item -mm
15186 @opindex mm
15187 Causes variables to be assigned to the @code{.near} section by default.
15189 @item -mminmax
15190 @opindex mminmax
15191 Enables the @code{min} and @code{max} instructions.
15193 @item -mmult
15194 @opindex mmult
15195 Enables the multiplication and multiply-accumulate instructions.
15197 @item -mno-opts
15198 @opindex mno-opts
15199 Disables all the optional instructions enabled by @code{-mall-opts}.
15201 @item -mrepeat
15202 @opindex mrepeat
15203 Enables the @code{repeat} and @code{erepeat} instructions, used for
15204 low-overhead looping.
15206 @item -ms
15207 @opindex ms
15208 Causes all variables to default to the @code{.tiny} section.  Note
15209 that there is a 65536-byte limit to this section.  Accesses to these
15210 variables use the @code{%gp} base register.
15212 @item -msatur
15213 @opindex msatur
15214 Enables the saturation instructions.  Note that the compiler does not
15215 currently generate these itself, but this option is included for
15216 compatibility with other tools, like @code{as}.
15218 @item -msdram
15219 @opindex msdram
15220 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15222 @item -msim
15223 @opindex msim
15224 Link the simulator runtime libraries.
15226 @item -msimnovec
15227 @opindex msimnovec
15228 Link the simulator runtime libraries, excluding built-in support
15229 for reset and exception vectors and tables.
15231 @item -mtf
15232 @opindex mtf
15233 Causes all functions to default to the @code{.far} section.  Without
15234 this option, functions default to the @code{.near} section.
15236 @item -mtiny=@var{n}
15237 @opindex mtiny=
15238 Variables that are @var{n} bytes or smaller are allocated to the
15239 @code{.tiny} section.  These variables use the @code{$gp} base
15240 register.  The default for this option is 4, but note that there's a
15241 65536-byte limit to the @code{.tiny} section.
15243 @end table
15245 @node MicroBlaze Options
15246 @subsection MicroBlaze Options
15247 @cindex MicroBlaze Options
15249 @table @gcctabopt
15251 @item -msoft-float
15252 @opindex msoft-float
15253 Use software emulation for floating point (default).
15255 @item -mhard-float
15256 @opindex mhard-float
15257 Use hardware floating-point instructions.
15259 @item -mmemcpy
15260 @opindex mmemcpy
15261 Do not optimize block moves, use @code{memcpy}.
15263 @item -mno-clearbss
15264 @opindex mno-clearbss
15265 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15267 @item -mcpu=@var{cpu-type}
15268 @opindex mcpu=
15269 Use features of and schedule code for given CPU.
15270 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15271 where @var{X} is a major version, @var{YY} is the minor version, and
15272 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15273 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15275 @item -mxl-soft-mul
15276 @opindex mxl-soft-mul
15277 Use software multiply emulation (default).
15279 @item -mxl-soft-div
15280 @opindex mxl-soft-div
15281 Use software emulation for divides (default).
15283 @item -mxl-barrel-shift
15284 @opindex mxl-barrel-shift
15285 Use the hardware barrel shifter.
15287 @item -mxl-pattern-compare
15288 @opindex mxl-pattern-compare
15289 Use pattern compare instructions.
15291 @item -msmall-divides
15292 @opindex msmall-divides
15293 Use table lookup optimization for small signed integer divisions.
15295 @item -mxl-stack-check
15296 @opindex mxl-stack-check
15297 This option is deprecated.  Use @option{-fstack-check} instead.
15299 @item -mxl-gp-opt
15300 @opindex mxl-gp-opt
15301 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15303 @item -mxl-multiply-high
15304 @opindex mxl-multiply-high
15305 Use multiply high instructions for high part of 32x32 multiply.
15307 @item -mxl-float-convert
15308 @opindex mxl-float-convert
15309 Use hardware floating-point conversion instructions.
15311 @item -mxl-float-sqrt
15312 @opindex mxl-float-sqrt
15313 Use hardware floating-point square root instruction.
15315 @item -mxl-mode-@var{app-model}
15316 Select application model @var{app-model}.  Valid models are
15317 @table @samp
15318 @item executable
15319 normal executable (default), uses startup code @file{crt0.o}.
15321 @item xmdstub
15322 for use with Xilinx Microprocessor Debugger (XMD) based
15323 software intrusive debug agent called xmdstub. This uses startup file
15324 @file{crt1.o} and sets the start address of the program to be 0x800.
15326 @item bootstrap
15327 for applications that are loaded using a bootloader.
15328 This model uses startup file @file{crt2.o} which does not contain a processor
15329 reset vector handler. This is suitable for transferring control on a
15330 processor reset to the bootloader rather than the application.
15332 @item novectors
15333 for applications that do not require any of the
15334 MicroBlaze vectors. This option may be useful for applications running
15335 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15336 @end table
15338 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15339 @option{-mxl-mode-@var{app-model}}.
15341 @end table
15343 @node MIPS Options
15344 @subsection MIPS Options
15345 @cindex MIPS options
15347 @table @gcctabopt
15349 @item -EB
15350 @opindex EB
15351 Generate big-endian code.
15353 @item -EL
15354 @opindex EL
15355 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15356 configurations.
15358 @item -march=@var{arch}
15359 @opindex march
15360 Generate code that runs on @var{arch}, which can be the name of a
15361 generic MIPS ISA, or the name of a particular processor.
15362 The ISA names are:
15363 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15364 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15365 The processor names are:
15366 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15367 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15368 @samp{5kc}, @samp{5kf},
15369 @samp{20kc},
15370 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15371 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15372 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15373 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15374 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15375 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15376 @samp{m4k},
15377 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15378 @samp{orion},
15379 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15380 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15381 @samp{rm7000}, @samp{rm9000},
15382 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15383 @samp{sb1},
15384 @samp{sr71000},
15385 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15386 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15387 @samp{xlr} and @samp{xlp}.
15388 The special value @samp{from-abi} selects the
15389 most compatible architecture for the selected ABI (that is,
15390 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15392 The native Linux/GNU toolchain also supports the value @samp{native},
15393 which selects the best architecture option for the host processor.
15394 @option{-march=native} has no effect if GCC does not recognize
15395 the processor.
15397 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15398 (for example, @option{-march=r2k}).  Prefixes are optional, and
15399 @samp{vr} may be written @samp{r}.
15401 Names of the form @samp{@var{n}f2_1} refer to processors with
15402 FPUs clocked at half the rate of the core, names of the form
15403 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15404 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15405 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15406 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15407 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15408 accepted as synonyms for @samp{@var{n}f1_1}.
15410 GCC defines two macros based on the value of this option.  The first
15411 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15412 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15413 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15414 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15415 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15417 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15418 above.  In other words, it has the full prefix and does not
15419 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15420 the macro names the resolved architecture (either @samp{"mips1"} or
15421 @samp{"mips3"}).  It names the default architecture when no
15422 @option{-march} option is given.
15424 @item -mtune=@var{arch}
15425 @opindex mtune
15426 Optimize for @var{arch}.  Among other things, this option controls
15427 the way instructions are scheduled, and the perceived cost of arithmetic
15428 operations.  The list of @var{arch} values is the same as for
15429 @option{-march}.
15431 When this option is not used, GCC optimizes for the processor
15432 specified by @option{-march}.  By using @option{-march} and
15433 @option{-mtune} together, it is possible to generate code that
15434 runs on a family of processors, but optimize the code for one
15435 particular member of that family.
15437 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15438 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15439 @option{-march} ones described above.
15441 @item -mips1
15442 @opindex mips1
15443 Equivalent to @option{-march=mips1}.
15445 @item -mips2
15446 @opindex mips2
15447 Equivalent to @option{-march=mips2}.
15449 @item -mips3
15450 @opindex mips3
15451 Equivalent to @option{-march=mips3}.
15453 @item -mips4
15454 @opindex mips4
15455 Equivalent to @option{-march=mips4}.
15457 @item -mips32
15458 @opindex mips32
15459 Equivalent to @option{-march=mips32}.
15461 @item -mips32r2
15462 @opindex mips32r2
15463 Equivalent to @option{-march=mips32r2}.
15465 @item -mips64
15466 @opindex mips64
15467 Equivalent to @option{-march=mips64}.
15469 @item -mips64r2
15470 @opindex mips64r2
15471 Equivalent to @option{-march=mips64r2}.
15473 @item -mips16
15474 @itemx -mno-mips16
15475 @opindex mips16
15476 @opindex mno-mips16
15477 Generate (do not generate) MIPS16 code.  If GCC is targeting a
15478 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15480 MIPS16 code generation can also be controlled on a per-function basis
15481 by means of @code{mips16} and @code{nomips16} attributes.
15482 @xref{Function Attributes}, for more information.
15484 @item -mflip-mips16
15485 @opindex mflip-mips16
15486 Generate MIPS16 code on alternating functions.  This option is provided
15487 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15488 not intended for ordinary use in compiling user code.
15490 @item -minterlink-mips16
15491 @itemx -mno-interlink-mips16
15492 @opindex minterlink-mips16
15493 @opindex mno-interlink-mips16
15494 Require (do not require) that non-MIPS16 code be link-compatible with
15495 MIPS16 code.
15497 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15498 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15499 therefore disables direct jumps unless GCC knows that the target of the
15500 jump is not MIPS16.
15502 @item -mabi=32
15503 @itemx -mabi=o64
15504 @itemx -mabi=n32
15505 @itemx -mabi=64
15506 @itemx -mabi=eabi
15507 @opindex mabi=32
15508 @opindex mabi=o64
15509 @opindex mabi=n32
15510 @opindex mabi=64
15511 @opindex mabi=eabi
15512 Generate code for the given ABI@.
15514 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15515 generates 64-bit code when you select a 64-bit architecture, but you
15516 can use @option{-mgp32} to get 32-bit code instead.
15518 For information about the O64 ABI, see
15519 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15521 GCC supports a variant of the o32 ABI in which floating-point registers
15522 are 64 rather than 32 bits wide.  You can select this combination with
15523 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
15524 and @code{mfhc1} instructions and is therefore only supported for
15525 MIPS32R2 processors.
15527 The register assignments for arguments and return values remain the
15528 same, but each scalar value is passed in a single 64-bit register
15529 rather than a pair of 32-bit registers.  For example, scalar
15530 floating-point values are returned in @samp{$f0} only, not a
15531 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15532 remains the same, but all 64 bits are saved.
15534 @item -mabicalls
15535 @itemx -mno-abicalls
15536 @opindex mabicalls
15537 @opindex mno-abicalls
15538 Generate (do not generate) code that is suitable for SVR4-style
15539 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15540 systems.
15542 @item -mshared
15543 @itemx -mno-shared
15544 Generate (do not generate) code that is fully position-independent,
15545 and that can therefore be linked into shared libraries.  This option
15546 only affects @option{-mabicalls}.
15548 All @option{-mabicalls} code has traditionally been position-independent,
15549 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
15550 as an extension, the GNU toolchain allows executables to use absolute
15551 accesses for locally-binding symbols.  It can also use shorter GP
15552 initialization sequences and generate direct calls to locally-defined
15553 functions.  This mode is selected by @option{-mno-shared}.
15555 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15556 objects that can only be linked by the GNU linker.  However, the option
15557 does not affect the ABI of the final executable; it only affects the ABI
15558 of relocatable objects.  Using @option{-mno-shared} generally makes
15559 executables both smaller and quicker.
15561 @option{-mshared} is the default.
15563 @item -mplt
15564 @itemx -mno-plt
15565 @opindex mplt
15566 @opindex mno-plt
15567 Assume (do not assume) that the static and dynamic linkers
15568 support PLTs and copy relocations.  This option only affects
15569 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
15570 has no effect without @option{-msym32}.
15572 You can make @option{-mplt} the default by configuring
15573 GCC with @option{--with-mips-plt}.  The default is
15574 @option{-mno-plt} otherwise.
15576 @item -mxgot
15577 @itemx -mno-xgot
15578 @opindex mxgot
15579 @opindex mno-xgot
15580 Lift (do not lift) the usual restrictions on the size of the global
15581 offset table.
15583 GCC normally uses a single instruction to load values from the GOT@.
15584 While this is relatively efficient, it only works if the GOT
15585 is smaller than about 64k.  Anything larger causes the linker
15586 to report an error such as:
15588 @cindex relocation truncated to fit (MIPS)
15589 @smallexample
15590 relocation truncated to fit: R_MIPS_GOT16 foobar
15591 @end smallexample
15593 If this happens, you should recompile your code with @option{-mxgot}.
15594 This works with very large GOTs, although the code is also
15595 less efficient, since it takes three instructions to fetch the
15596 value of a global symbol.
15598 Note that some linkers can create multiple GOTs.  If you have such a
15599 linker, you should only need to use @option{-mxgot} when a single object
15600 file accesses more than 64k's worth of GOT entries.  Very few do.
15602 These options have no effect unless GCC is generating position
15603 independent code.
15605 @item -mgp32
15606 @opindex mgp32
15607 Assume that general-purpose registers are 32 bits wide.
15609 @item -mgp64
15610 @opindex mgp64
15611 Assume that general-purpose registers are 64 bits wide.
15613 @item -mfp32
15614 @opindex mfp32
15615 Assume that floating-point registers are 32 bits wide.
15617 @item -mfp64
15618 @opindex mfp64
15619 Assume that floating-point registers are 64 bits wide.
15621 @item -mhard-float
15622 @opindex mhard-float
15623 Use floating-point coprocessor instructions.
15625 @item -msoft-float
15626 @opindex msoft-float
15627 Do not use floating-point coprocessor instructions.  Implement
15628 floating-point calculations using library calls instead.
15630 @item -mno-float
15631 @opindex mno-float
15632 Equivalent to @option{-msoft-float}, but additionally asserts that the
15633 program being compiled does not perform any floating-point operations.
15634 This option is presently supported only by some bare-metal MIPS
15635 configurations, where it may select a special set of libraries
15636 that lack all floating-point support (including, for example, the
15637 floating-point @code{printf} formats).  
15638 If code compiled with @code{-mno-float} accidentally contains
15639 floating-point operations, it is likely to suffer a link-time
15640 or run-time failure.
15642 @item -msingle-float
15643 @opindex msingle-float
15644 Assume that the floating-point coprocessor only supports single-precision
15645 operations.
15647 @item -mdouble-float
15648 @opindex mdouble-float
15649 Assume that the floating-point coprocessor supports double-precision
15650 operations.  This is the default.
15652 @item -mllsc
15653 @itemx -mno-llsc
15654 @opindex mllsc
15655 @opindex mno-llsc
15656 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15657 implement atomic memory built-in functions.  When neither option is
15658 specified, GCC uses the instructions if the target architecture
15659 supports them.
15661 @option{-mllsc} is useful if the runtime environment can emulate the
15662 instructions and @option{-mno-llsc} can be useful when compiling for
15663 nonstandard ISAs.  You can make either option the default by
15664 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15665 respectively.  @option{--with-llsc} is the default for some
15666 configurations; see the installation documentation for details.
15668 @item -mdsp
15669 @itemx -mno-dsp
15670 @opindex mdsp
15671 @opindex mno-dsp
15672 Use (do not use) revision 1 of the MIPS DSP ASE@.
15673 @xref{MIPS DSP Built-in Functions}.  This option defines the
15674 preprocessor macro @samp{__mips_dsp}.  It also defines
15675 @samp{__mips_dsp_rev} to 1.
15677 @item -mdspr2
15678 @itemx -mno-dspr2
15679 @opindex mdspr2
15680 @opindex mno-dspr2
15681 Use (do not use) revision 2 of the MIPS DSP ASE@.
15682 @xref{MIPS DSP Built-in Functions}.  This option defines the
15683 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15684 It also defines @samp{__mips_dsp_rev} to 2.
15686 @item -msmartmips
15687 @itemx -mno-smartmips
15688 @opindex msmartmips
15689 @opindex mno-smartmips
15690 Use (do not use) the MIPS SmartMIPS ASE.
15692 @item -mpaired-single
15693 @itemx -mno-paired-single
15694 @opindex mpaired-single
15695 @opindex mno-paired-single
15696 Use (do not use) paired-single floating-point instructions.
15697 @xref{MIPS Paired-Single Support}.  This option requires
15698 hardware floating-point support to be enabled.
15700 @item -mdmx
15701 @itemx -mno-mdmx
15702 @opindex mdmx
15703 @opindex mno-mdmx
15704 Use (do not use) MIPS Digital Media Extension instructions.
15705 This option can only be used when generating 64-bit code and requires
15706 hardware floating-point support to be enabled.
15708 @item -mips3d
15709 @itemx -mno-mips3d
15710 @opindex mips3d
15711 @opindex mno-mips3d
15712 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
15713 The option @option{-mips3d} implies @option{-mpaired-single}.
15715 @item -mmt
15716 @itemx -mno-mt
15717 @opindex mmt
15718 @opindex mno-mt
15719 Use (do not use) MT Multithreading instructions.
15721 @item -mmcu
15722 @itemx -mno-mcu
15723 @opindex mmcu
15724 @opindex mno-mcu
15725 Use (do not use) the MIPS MCU ASE instructions.
15727 @item -mlong64
15728 @opindex mlong64
15729 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
15730 an explanation of the default and the way that the pointer size is
15731 determined.
15733 @item -mlong32
15734 @opindex mlong32
15735 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15737 The default size of @code{int}s, @code{long}s and pointers depends on
15738 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
15739 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15740 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
15741 or the same size as integer registers, whichever is smaller.
15743 @item -msym32
15744 @itemx -mno-sym32
15745 @opindex msym32
15746 @opindex mno-sym32
15747 Assume (do not assume) that all symbols have 32-bit values, regardless
15748 of the selected ABI@.  This option is useful in combination with
15749 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15750 to generate shorter and faster references to symbolic addresses.
15752 @item -G @var{num}
15753 @opindex G
15754 Put definitions of externally-visible data in a small data section
15755 if that data is no bigger than @var{num} bytes.  GCC can then access
15756 the data more efficiently; see @option{-mgpopt} for details.
15758 The default @option{-G} option depends on the configuration.
15760 @item -mlocal-sdata
15761 @itemx -mno-local-sdata
15762 @opindex mlocal-sdata
15763 @opindex mno-local-sdata
15764 Extend (do not extend) the @option{-G} behavior to local data too,
15765 such as to static variables in C@.  @option{-mlocal-sdata} is the
15766 default for all configurations.
15768 If the linker complains that an application is using too much small data,
15769 you might want to try rebuilding the less performance-critical parts with
15770 @option{-mno-local-sdata}.  You might also want to build large
15771 libraries with @option{-mno-local-sdata}, so that the libraries leave
15772 more room for the main program.
15774 @item -mextern-sdata
15775 @itemx -mno-extern-sdata
15776 @opindex mextern-sdata
15777 @opindex mno-extern-sdata
15778 Assume (do not assume) that externally-defined data is in
15779 a small data section if the size of that data is within the @option{-G} limit.
15780 @option{-mextern-sdata} is the default for all configurations.
15782 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15783 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15784 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15785 is placed in a small data section.  If @var{Var} is defined by another
15786 module, you must either compile that module with a high-enough
15787 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15788 definition.  If @var{Var} is common, you must link the application
15789 with a high-enough @option{-G} setting.
15791 The easiest way of satisfying these restrictions is to compile
15792 and link every module with the same @option{-G} option.  However,
15793 you may wish to build a library that supports several different
15794 small data limits.  You can do this by compiling the library with
15795 the highest supported @option{-G} setting and additionally using
15796 @option{-mno-extern-sdata} to stop the library from making assumptions
15797 about externally-defined data.
15799 @item -mgpopt
15800 @itemx -mno-gpopt
15801 @opindex mgpopt
15802 @opindex mno-gpopt
15803 Use (do not use) GP-relative accesses for symbols that are known to be
15804 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15805 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
15806 configurations.
15808 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15809 might not hold the value of @code{_gp}.  For example, if the code is
15810 part of a library that might be used in a boot monitor, programs that
15811 call boot monitor routines pass an unknown value in @code{$gp}.
15812 (In such situations, the boot monitor itself is usually compiled
15813 with @option{-G0}.)
15815 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15816 @option{-mno-extern-sdata}.
15818 @item -membedded-data
15819 @itemx -mno-embedded-data
15820 @opindex membedded-data
15821 @opindex mno-embedded-data
15822 Allocate variables to the read-only data section first if possible, then
15823 next in the small data section if possible, otherwise in data.  This gives
15824 slightly slower code than the default, but reduces the amount of RAM required
15825 when executing, and thus may be preferred for some embedded systems.
15827 @item -muninit-const-in-rodata
15828 @itemx -mno-uninit-const-in-rodata
15829 @opindex muninit-const-in-rodata
15830 @opindex mno-uninit-const-in-rodata
15831 Put uninitialized @code{const} variables in the read-only data section.
15832 This option is only meaningful in conjunction with @option{-membedded-data}.
15834 @item -mcode-readable=@var{setting}
15835 @opindex mcode-readable
15836 Specify whether GCC may generate code that reads from executable sections.
15837 There are three possible settings:
15839 @table @gcctabopt
15840 @item -mcode-readable=yes
15841 Instructions may freely access executable sections.  This is the
15842 default setting.
15844 @item -mcode-readable=pcrel
15845 MIPS16 PC-relative load instructions can access executable sections,
15846 but other instructions must not do so.  This option is useful on 4KSc
15847 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15848 It is also useful on processors that can be configured to have a dual
15849 instruction/data SRAM interface and that, like the M4K, automatically
15850 redirect PC-relative loads to the instruction RAM.
15852 @item -mcode-readable=no
15853 Instructions must not access executable sections.  This option can be
15854 useful on targets that are configured to have a dual instruction/data
15855 SRAM interface but that (unlike the M4K) do not automatically redirect
15856 PC-relative loads to the instruction RAM.
15857 @end table
15859 @item -msplit-addresses
15860 @itemx -mno-split-addresses
15861 @opindex msplit-addresses
15862 @opindex mno-split-addresses
15863 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15864 relocation operators.  This option has been superseded by
15865 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15867 @item -mexplicit-relocs
15868 @itemx -mno-explicit-relocs
15869 @opindex mexplicit-relocs
15870 @opindex mno-explicit-relocs
15871 Use (do not use) assembler relocation operators when dealing with symbolic
15872 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
15873 is to use assembler macros instead.
15875 @option{-mexplicit-relocs} is the default if GCC was configured
15876 to use an assembler that supports relocation operators.
15878 @item -mcheck-zero-division
15879 @itemx -mno-check-zero-division
15880 @opindex mcheck-zero-division
15881 @opindex mno-check-zero-division
15882 Trap (do not trap) on integer division by zero.
15884 The default is @option{-mcheck-zero-division}.
15886 @item -mdivide-traps
15887 @itemx -mdivide-breaks
15888 @opindex mdivide-traps
15889 @opindex mdivide-breaks
15890 MIPS systems check for division by zero by generating either a
15891 conditional trap or a break instruction.  Using traps results in
15892 smaller code, but is only supported on MIPS II and later.  Also, some
15893 versions of the Linux kernel have a bug that prevents trap from
15894 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
15895 allow conditional traps on architectures that support them and
15896 @option{-mdivide-breaks} to force the use of breaks.
15898 The default is usually @option{-mdivide-traps}, but this can be
15899 overridden at configure time using @option{--with-divide=breaks}.
15900 Divide-by-zero checks can be completely disabled using
15901 @option{-mno-check-zero-division}.
15903 @item -mmemcpy
15904 @itemx -mno-memcpy
15905 @opindex mmemcpy
15906 @opindex mno-memcpy
15907 Force (do not force) the use of @code{memcpy()} for non-trivial block
15908 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
15909 most constant-sized copies.
15911 @item -mlong-calls
15912 @itemx -mno-long-calls
15913 @opindex mlong-calls
15914 @opindex mno-long-calls
15915 Disable (do not disable) use of the @code{jal} instruction.  Calling
15916 functions using @code{jal} is more efficient but requires the caller
15917 and callee to be in the same 256 megabyte segment.
15919 This option has no effect on abicalls code.  The default is
15920 @option{-mno-long-calls}.
15922 @item -mmad
15923 @itemx -mno-mad
15924 @opindex mmad
15925 @opindex mno-mad
15926 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15927 instructions, as provided by the R4650 ISA@.
15929 @item -mfused-madd
15930 @itemx -mno-fused-madd
15931 @opindex mfused-madd
15932 @opindex mno-fused-madd
15933 Enable (disable) use of the floating-point multiply-accumulate
15934 instructions, when they are available.  The default is
15935 @option{-mfused-madd}.
15937 When multiply-accumulate instructions are used, the intermediate
15938 product is calculated to infinite precision and is not subject to
15939 the FCSR Flush to Zero bit.  This may be undesirable in some
15940 circumstances.
15942 @item -nocpp
15943 @opindex nocpp
15944 Tell the MIPS assembler to not run its preprocessor over user
15945 assembler files (with a @samp{.s} suffix) when assembling them.
15947 @item -mfix-24k
15948 @item -mno-fix-24k
15949 @opindex mfix-24k
15950 @opindex mno-fix-24k
15951 Work around the 24K E48 (lost data on stores during refill) errata.
15952 The workarounds are implemented by the assembler rather than by GCC@.
15954 @item -mfix-r4000
15955 @itemx -mno-fix-r4000
15956 @opindex mfix-r4000
15957 @opindex mno-fix-r4000
15958 Work around certain R4000 CPU errata:
15959 @itemize @minus
15960 @item
15961 A double-word or a variable shift may give an incorrect result if executed
15962 immediately after starting an integer division.
15963 @item
15964 A double-word or a variable shift may give an incorrect result if executed
15965 while an integer multiplication is in progress.
15966 @item
15967 An integer division may give an incorrect result if started in a delay slot
15968 of a taken branch or a jump.
15969 @end itemize
15971 @item -mfix-r4400
15972 @itemx -mno-fix-r4400
15973 @opindex mfix-r4400
15974 @opindex mno-fix-r4400
15975 Work around certain R4400 CPU errata:
15976 @itemize @minus
15977 @item
15978 A double-word or a variable shift may give an incorrect result if executed
15979 immediately after starting an integer division.
15980 @end itemize
15982 @item -mfix-r10000
15983 @itemx -mno-fix-r10000
15984 @opindex mfix-r10000
15985 @opindex mno-fix-r10000
15986 Work around certain R10000 errata:
15987 @itemize @minus
15988 @item
15989 @code{ll}/@code{sc} sequences may not behave atomically on revisions
15990 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
15991 @end itemize
15993 This option can only be used if the target architecture supports
15994 branch-likely instructions.  @option{-mfix-r10000} is the default when
15995 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
15996 otherwise.
15998 @item -mfix-vr4120
15999 @itemx -mno-fix-vr4120
16000 @opindex mfix-vr4120
16001 Work around certain VR4120 errata:
16002 @itemize @minus
16003 @item
16004 @code{dmultu} does not always produce the correct result.
16005 @item
16006 @code{div} and @code{ddiv} do not always produce the correct result if one
16007 of the operands is negative.
16008 @end itemize
16009 The workarounds for the division errata rely on special functions in
16010 @file{libgcc.a}.  At present, these functions are only provided by
16011 the @code{mips64vr*-elf} configurations.
16013 Other VR4120 errata require a nop to be inserted between certain pairs of
16014 instructions.  These errata are handled by the assembler, not by GCC itself.
16016 @item -mfix-vr4130
16017 @opindex mfix-vr4130
16018 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16019 workarounds are implemented by the assembler rather than by GCC,
16020 although GCC avoids using @code{mflo} and @code{mfhi} if the
16021 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16022 instructions are available instead.
16024 @item -mfix-sb1
16025 @itemx -mno-fix-sb1
16026 @opindex mfix-sb1
16027 Work around certain SB-1 CPU core errata.
16028 (This flag currently works around the SB-1 revision 2
16029 ``F1'' and ``F2'' floating-point errata.)
16031 @item -mr10k-cache-barrier=@var{setting}
16032 @opindex mr10k-cache-barrier
16033 Specify whether GCC should insert cache barriers to avoid the
16034 side-effects of speculation on R10K processors.
16036 In common with many processors, the R10K tries to predict the outcome
16037 of a conditional branch and speculatively executes instructions from
16038 the ``taken'' branch.  It later aborts these instructions if the
16039 predicted outcome is wrong.  However, on the R10K, even aborted
16040 instructions can have side effects.
16042 This problem only affects kernel stores and, depending on the system,
16043 kernel loads.  As an example, a speculatively-executed store may load
16044 the target memory into cache and mark the cache line as dirty, even if
16045 the store itself is later aborted.  If a DMA operation writes to the
16046 same area of memory before the ``dirty'' line is flushed, the cached
16047 data overwrites the DMA-ed data.  See the R10K processor manual
16048 for a full description, including other potential problems.
16050 One workaround is to insert cache barrier instructions before every memory
16051 access that might be speculatively executed and that might have side
16052 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16053 controls GCC's implementation of this workaround.  It assumes that
16054 aborted accesses to any byte in the following regions does not have
16055 side effects:
16057 @enumerate
16058 @item
16059 the memory occupied by the current function's stack frame;
16061 @item
16062 the memory occupied by an incoming stack argument;
16064 @item
16065 the memory occupied by an object with a link-time-constant address.
16066 @end enumerate
16068 It is the kernel's responsibility to ensure that speculative
16069 accesses to these regions are indeed safe.
16071 If the input program contains a function declaration such as:
16073 @smallexample
16074 void foo (void);
16075 @end smallexample
16077 then the implementation of @code{foo} must allow @code{j foo} and
16078 @code{jal foo} to be executed speculatively.  GCC honors this
16079 restriction for functions it compiles itself.  It expects non-GCC
16080 functions (such as hand-written assembly code) to do the same.
16082 The option has three forms:
16084 @table @gcctabopt
16085 @item -mr10k-cache-barrier=load-store
16086 Insert a cache barrier before a load or store that might be
16087 speculatively executed and that might have side effects even
16088 if aborted.
16090 @item -mr10k-cache-barrier=store
16091 Insert a cache barrier before a store that might be speculatively
16092 executed and that might have side effects even if aborted.
16094 @item -mr10k-cache-barrier=none
16095 Disable the insertion of cache barriers.  This is the default setting.
16096 @end table
16098 @item -mflush-func=@var{func}
16099 @itemx -mno-flush-func
16100 @opindex mflush-func
16101 Specifies the function to call to flush the I and D caches, or to not
16102 call any such function.  If called, the function must take the same
16103 arguments as the common @code{_flush_func()}, that is, the address of the
16104 memory range for which the cache is being flushed, the size of the
16105 memory range, and the number 3 (to flush both caches).  The default
16106 depends on the target GCC was configured for, but commonly is either
16107 @samp{_flush_func} or @samp{__cpu_flush}.
16109 @item mbranch-cost=@var{num}
16110 @opindex mbranch-cost
16111 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16112 This cost is only a heuristic and is not guaranteed to produce
16113 consistent results across releases.  A zero cost redundantly selects
16114 the default, which is based on the @option{-mtune} setting.
16116 @item -mbranch-likely
16117 @itemx -mno-branch-likely
16118 @opindex mbranch-likely
16119 @opindex mno-branch-likely
16120 Enable or disable use of Branch Likely instructions, regardless of the
16121 default for the selected architecture.  By default, Branch Likely
16122 instructions may be generated if they are supported by the selected
16123 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16124 and processors that implement those architectures; for those, Branch
16125 Likely instructions are not be generated by default because the MIPS32
16126 and MIPS64 architectures specifically deprecate their use.
16128 @item -mfp-exceptions
16129 @itemx -mno-fp-exceptions
16130 @opindex mfp-exceptions
16131 Specifies whether FP exceptions are enabled.  This affects how
16132 FP instructions are scheduled for some processors.
16133 The default is that FP exceptions are
16134 enabled.
16136 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16137 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16138 FP pipe.
16140 @item -mvr4130-align
16141 @itemx -mno-vr4130-align
16142 @opindex mvr4130-align
16143 The VR4130 pipeline is two-way superscalar, but can only issue two
16144 instructions together if the first one is 8-byte aligned.  When this
16145 option is enabled, GCC aligns pairs of instructions that it
16146 thinks should execute in parallel.
16148 This option only has an effect when optimizing for the VR4130.
16149 It normally makes code faster, but at the expense of making it bigger.
16150 It is enabled by default at optimization level @option{-O3}.
16152 @item -msynci
16153 @itemx -mno-synci
16154 @opindex msynci
16155 Enable (disable) generation of @code{synci} instructions on
16156 architectures that support it.  The @code{synci} instructions (if
16157 enabled) are generated when @code{__builtin___clear_cache()} is
16158 compiled.
16160 This option defaults to @code{-mno-synci}, but the default can be
16161 overridden by configuring with @code{--with-synci}.
16163 When compiling code for single processor systems, it is generally safe
16164 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16165 does not invalidate the instruction caches on all cores and may lead
16166 to undefined behavior.
16168 @item -mrelax-pic-calls
16169 @itemx -mno-relax-pic-calls
16170 @opindex mrelax-pic-calls
16171 Try to turn PIC calls that are normally dispatched via register
16172 @code{$25} into direct calls.  This is only possible if the linker can
16173 resolve the destination at link-time and if the destination is within
16174 range for a direct call.
16176 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16177 an assembler and a linker that supports the @code{.reloc} assembly
16178 directive and @code{-mexplicit-relocs} is in effect.  With
16179 @code{-mno-explicit-relocs}, this optimization can be performed by the
16180 assembler and the linker alone without help from the compiler.
16182 @item -mmcount-ra-address
16183 @itemx -mno-mcount-ra-address
16184 @opindex mmcount-ra-address
16185 @opindex mno-mcount-ra-address
16186 Emit (do not emit) code that allows @code{_mcount} to modify the
16187 calling function's return address.  When enabled, this option extends
16188 the usual @code{_mcount} interface with a new @var{ra-address}
16189 parameter, which has type @code{intptr_t *} and is passed in register
16190 @code{$12}.  @code{_mcount} can then modify the return address by
16191 doing both of the following:
16192 @itemize
16193 @item
16194 Returning the new address in register @code{$31}.
16195 @item
16196 Storing the new address in @code{*@var{ra-address}},
16197 if @var{ra-address} is nonnull.
16198 @end itemize
16200 The default is @option{-mno-mcount-ra-address}.
16202 @end table
16204 @node MMIX Options
16205 @subsection MMIX Options
16206 @cindex MMIX Options
16208 These options are defined for the MMIX:
16210 @table @gcctabopt
16211 @item -mlibfuncs
16212 @itemx -mno-libfuncs
16213 @opindex mlibfuncs
16214 @opindex mno-libfuncs
16215 Specify that intrinsic library functions are being compiled, passing all
16216 values in registers, no matter the size.
16218 @item -mepsilon
16219 @itemx -mno-epsilon
16220 @opindex mepsilon
16221 @opindex mno-epsilon
16222 Generate floating-point comparison instructions that compare with respect
16223 to the @code{rE} epsilon register.
16225 @item -mabi=mmixware
16226 @itemx -mabi=gnu
16227 @opindex mabi=mmixware
16228 @opindex mabi=gnu
16229 Generate code that passes function parameters and return values that (in
16230 the called function) are seen as registers @code{$0} and up, as opposed to
16231 the GNU ABI which uses global registers @code{$231} and up.
16233 @item -mzero-extend
16234 @itemx -mno-zero-extend
16235 @opindex mzero-extend
16236 @opindex mno-zero-extend
16237 When reading data from memory in sizes shorter than 64 bits, use (do not
16238 use) zero-extending load instructions by default, rather than
16239 sign-extending ones.
16241 @item -mknuthdiv
16242 @itemx -mno-knuthdiv
16243 @opindex mknuthdiv
16244 @opindex mno-knuthdiv
16245 Make the result of a division yielding a remainder have the same sign as
16246 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16247 remainder follows the sign of the dividend.  Both methods are
16248 arithmetically valid, the latter being almost exclusively used.
16250 @item -mtoplevel-symbols
16251 @itemx -mno-toplevel-symbols
16252 @opindex mtoplevel-symbols
16253 @opindex mno-toplevel-symbols
16254 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16255 code can be used with the @code{PREFIX} assembly directive.
16257 @item -melf
16258 @opindex melf
16259 Generate an executable in the ELF format, rather than the default
16260 @samp{mmo} format used by the @command{mmix} simulator.
16262 @item -mbranch-predict
16263 @itemx -mno-branch-predict
16264 @opindex mbranch-predict
16265 @opindex mno-branch-predict
16266 Use (do not use) the probable-branch instructions, when static branch
16267 prediction indicates a probable branch.
16269 @item -mbase-addresses
16270 @itemx -mno-base-addresses
16271 @opindex mbase-addresses
16272 @opindex mno-base-addresses
16273 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16274 base address automatically generates a request (handled by the assembler
16275 and the linker) for a constant to be set up in a global register.  The
16276 register is used for one or more base address requests within the range 0
16277 to 255 from the value held in the register.  The generally leads to short
16278 and fast code, but the number of different data items that can be
16279 addressed is limited.  This means that a program that uses lots of static
16280 data may require @option{-mno-base-addresses}.
16282 @item -msingle-exit
16283 @itemx -mno-single-exit
16284 @opindex msingle-exit
16285 @opindex mno-single-exit
16286 Force (do not force) generated code to have a single exit point in each
16287 function.
16288 @end table
16290 @node MN10300 Options
16291 @subsection MN10300 Options
16292 @cindex MN10300 options
16294 These @option{-m} options are defined for Matsushita MN10300 architectures:
16296 @table @gcctabopt
16297 @item -mmult-bug
16298 @opindex mmult-bug
16299 Generate code to avoid bugs in the multiply instructions for the MN10300
16300 processors.  This is the default.
16302 @item -mno-mult-bug
16303 @opindex mno-mult-bug
16304 Do not generate code to avoid bugs in the multiply instructions for the
16305 MN10300 processors.
16307 @item -mam33
16308 @opindex mam33
16309 Generate code using features specific to the AM33 processor.
16311 @item -mno-am33
16312 @opindex mno-am33
16313 Do not generate code using features specific to the AM33 processor.  This
16314 is the default.
16316 @item -mam33-2
16317 @opindex mam33-2
16318 Generate code using features specific to the AM33/2.0 processor.
16320 @item -mam34
16321 @opindex mam34
16322 Generate code using features specific to the AM34 processor.
16324 @item -mtune=@var{cpu-type}
16325 @opindex mtune
16326 Use the timing characteristics of the indicated CPU type when
16327 scheduling instructions.  This does not change the targeted processor
16328 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16329 @samp{am33-2} or @samp{am34}.
16331 @item -mreturn-pointer-on-d0
16332 @opindex mreturn-pointer-on-d0
16333 When generating a function that returns a pointer, return the pointer
16334 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16335 only in @code{a0}, and attempts to call such functions without a prototype
16336 result in errors.  Note that this option is on by default; use
16337 @option{-mno-return-pointer-on-d0} to disable it.
16339 @item -mno-crt0
16340 @opindex mno-crt0
16341 Do not link in the C run-time initialization object file.
16343 @item -mrelax
16344 @opindex mrelax
16345 Indicate to the linker that it should perform a relaxation optimization pass
16346 to shorten branches, calls and absolute memory addresses.  This option only
16347 has an effect when used on the command line for the final link step.
16349 This option makes symbolic debugging impossible.
16351 @item -mliw
16352 @opindex mliw
16353 Allow the compiler to generate @emph{Long Instruction Word}
16354 instructions if the target is the @samp{AM33} or later.  This is the
16355 default.  This option defines the preprocessor macro @samp{__LIW__}.
16357 @item -mnoliw
16358 @opindex mnoliw
16359 Do not allow the compiler to generate @emph{Long Instruction Word}
16360 instructions.  This option defines the preprocessor macro
16361 @samp{__NO_LIW__}.
16363 @item -msetlb
16364 @opindex msetlb
16365 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16366 instructions if the target is the @samp{AM33} or later.  This is the
16367 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16369 @item -mnosetlb
16370 @opindex mnosetlb
16371 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16372 instructions.  This option defines the preprocessor macro
16373 @samp{__NO_SETLB__}.
16375 @end table
16377 @node PDP-11 Options
16378 @subsection PDP-11 Options
16379 @cindex PDP-11 Options
16381 These options are defined for the PDP-11:
16383 @table @gcctabopt
16384 @item -mfpu
16385 @opindex mfpu
16386 Use hardware FPP floating point.  This is the default.  (FIS floating
16387 point on the PDP-11/40 is not supported.)
16389 @item -msoft-float
16390 @opindex msoft-float
16391 Do not use hardware floating point.
16393 @item -mac0
16394 @opindex mac0
16395 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16397 @item -mno-ac0
16398 @opindex mno-ac0
16399 Return floating-point results in memory.  This is the default.
16401 @item -m40
16402 @opindex m40
16403 Generate code for a PDP-11/40.
16405 @item -m45
16406 @opindex m45
16407 Generate code for a PDP-11/45.  This is the default.
16409 @item -m10
16410 @opindex m10
16411 Generate code for a PDP-11/10.
16413 @item -mbcopy-builtin
16414 @opindex mbcopy-builtin
16415 Use inline @code{movmemhi} patterns for copying memory.  This is the
16416 default.
16418 @item -mbcopy
16419 @opindex mbcopy
16420 Do not use inline @code{movmemhi} patterns for copying memory.
16422 @item -mint16
16423 @itemx -mno-int32
16424 @opindex mint16
16425 @opindex mno-int32
16426 Use 16-bit @code{int}.  This is the default.
16428 @item -mint32
16429 @itemx -mno-int16
16430 @opindex mint32
16431 @opindex mno-int16
16432 Use 32-bit @code{int}.
16434 @item -mfloat64
16435 @itemx -mno-float32
16436 @opindex mfloat64
16437 @opindex mno-float32
16438 Use 64-bit @code{float}.  This is the default.
16440 @item -mfloat32
16441 @itemx -mno-float64
16442 @opindex mfloat32
16443 @opindex mno-float64
16444 Use 32-bit @code{float}.
16446 @item -mabshi
16447 @opindex mabshi
16448 Use @code{abshi2} pattern.  This is the default.
16450 @item -mno-abshi
16451 @opindex mno-abshi
16452 Do not use @code{abshi2} pattern.
16454 @item -mbranch-expensive
16455 @opindex mbranch-expensive
16456 Pretend that branches are expensive.  This is for experimenting with
16457 code generation only.
16459 @item -mbranch-cheap
16460 @opindex mbranch-cheap
16461 Do not pretend that branches are expensive.  This is the default.
16463 @item -munix-asm
16464 @opindex munix-asm
16465 Use Unix assembler syntax.  This is the default when configured for
16466 @samp{pdp11-*-bsd}.
16468 @item -mdec-asm
16469 @opindex mdec-asm
16470 Use DEC assembler syntax.  This is the default when configured for any
16471 PDP-11 target other than @samp{pdp11-*-bsd}.
16472 @end table
16474 @node picoChip Options
16475 @subsection picoChip Options
16476 @cindex picoChip options
16478 These @samp{-m} options are defined for picoChip implementations:
16480 @table @gcctabopt
16482 @item -mae=@var{ae_type}
16483 @opindex mcpu
16484 Set the instruction set, register set, and instruction scheduling
16485 parameters for array element type @var{ae_type}.  Supported values
16486 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16488 @option{-mae=ANY} selects a completely generic AE type.  Code
16489 generated with this option runs on any of the other AE types.  The
16490 code is not as efficient as it would be if compiled for a specific
16491 AE type, and some types of operation (e.g., multiplication) do not
16492 work properly on all types of AE.
16494 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16495 for compiled code, and is the default.
16497 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16498 option may suffer from poor performance of byte (char) manipulation,
16499 since the DSP AE does not provide hardware support for byte load/stores.
16501 @item -msymbol-as-address
16502 Enable the compiler to directly use a symbol name as an address in a
16503 load/store instruction, without first loading it into a
16504 register.  Typically, the use of this option generates larger
16505 programs, which run faster than when the option isn't used.  However, the
16506 results vary from program to program, so it is left as a user option,
16507 rather than being permanently enabled.
16509 @item -mno-inefficient-warnings
16510 Disables warnings about the generation of inefficient code.  These
16511 warnings can be generated, for example, when compiling code that
16512 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16513 no hardware support for byte-level memory operations, so all byte
16514 load/stores must be synthesized from word load/store operations.  This is
16515 inefficient and a warning is generated to indicate
16516 that you should rewrite the code to avoid byte operations, or to target
16517 an AE type that has the necessary hardware support.  This option disables
16518 these warnings.
16520 @end table
16522 @node PowerPC Options
16523 @subsection PowerPC Options
16524 @cindex PowerPC options
16526 These are listed under @xref{RS/6000 and PowerPC Options}.
16528 @node RL78 Options
16529 @subsection RL78 Options
16530 @cindex RL78 Options
16532 @table @gcctabopt
16534 @item -msim
16535 @opindex msim
16536 Links in additional target libraries to support operation within a
16537 simulator.
16539 @item -mmul=none
16540 @itemx -mmul=g13
16541 @itemx -mmul=rl78
16542 @opindex mmul
16543 Specifies the type of hardware multiplication support to be used.  The
16544 default is @code{none}, which uses software multiplication functions.
16545 The @code{g13} option is for the hardware multiply/divide peripheral
16546 only on the RL78/G13 targets.  The @code{rl78} option is for the
16547 standard hardware multiplication defined in the RL78 software manual.
16549 @end table
16551 @node RS/6000 and PowerPC Options
16552 @subsection IBM RS/6000 and PowerPC Options
16553 @cindex RS/6000 and PowerPC Options
16554 @cindex IBM RS/6000 and PowerPC Options
16556 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16557 @table @gcctabopt
16558 @item -mpowerpc-gpopt
16559 @itemx -mno-powerpc-gpopt
16560 @itemx -mpowerpc-gfxopt
16561 @itemx -mno-powerpc-gfxopt
16562 @need 800
16563 @itemx -mpowerpc64
16564 @itemx -mno-powerpc64
16565 @itemx -mmfcrf
16566 @itemx -mno-mfcrf
16567 @itemx -mpopcntb
16568 @itemx -mno-popcntb
16569 @itemx -mpopcntd
16570 @itemx -mno-popcntd
16571 @itemx -mfprnd
16572 @itemx -mno-fprnd
16573 @need 800
16574 @itemx -mcmpb
16575 @itemx -mno-cmpb
16576 @itemx -mmfpgpr
16577 @itemx -mno-mfpgpr
16578 @itemx -mhard-dfp
16579 @itemx -mno-hard-dfp
16580 @opindex mpowerpc-gpopt
16581 @opindex mno-powerpc-gpopt
16582 @opindex mpowerpc-gfxopt
16583 @opindex mno-powerpc-gfxopt
16584 @opindex mpowerpc64
16585 @opindex mno-powerpc64
16586 @opindex mmfcrf
16587 @opindex mno-mfcrf
16588 @opindex mpopcntb
16589 @opindex mno-popcntb
16590 @opindex mpopcntd
16591 @opindex mno-popcntd
16592 @opindex mfprnd
16593 @opindex mno-fprnd
16594 @opindex mcmpb
16595 @opindex mno-cmpb
16596 @opindex mmfpgpr
16597 @opindex mno-mfpgpr
16598 @opindex mhard-dfp
16599 @opindex mno-hard-dfp
16600 You use these options to specify which instructions are available on the
16601 processor you are using.  The default value of these options is
16602 determined when configuring GCC@.  Specifying the
16603 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16604 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16605 rather than the options listed above.
16607 Specifying @option{-mpowerpc-gpopt} allows
16608 GCC to use the optional PowerPC architecture instructions in the
16609 General Purpose group, including floating-point square root.  Specifying
16610 @option{-mpowerpc-gfxopt} allows GCC to
16611 use the optional PowerPC architecture instructions in the Graphics
16612 group, including floating-point select.
16614 The @option{-mmfcrf} option allows GCC to generate the move from
16615 condition register field instruction implemented on the POWER4
16616 processor and other processors that support the PowerPC V2.01
16617 architecture.
16618 The @option{-mpopcntb} option allows GCC to generate the popcount and
16619 double-precision FP reciprocal estimate instruction implemented on the
16620 POWER5 processor and other processors that support the PowerPC V2.02
16621 architecture.
16622 The @option{-mpopcntd} option allows GCC to generate the popcount
16623 instruction implemented on the POWER7 processor and other processors
16624 that support the PowerPC V2.06 architecture.
16625 The @option{-mfprnd} option allows GCC to generate the FP round to
16626 integer instructions implemented on the POWER5+ processor and other
16627 processors that support the PowerPC V2.03 architecture.
16628 The @option{-mcmpb} option allows GCC to generate the compare bytes
16629 instruction implemented on the POWER6 processor and other processors
16630 that support the PowerPC V2.05 architecture.
16631 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16632 general-purpose register instructions implemented on the POWER6X
16633 processor and other processors that support the extended PowerPC V2.05
16634 architecture.
16635 The @option{-mhard-dfp} option allows GCC to generate the decimal
16636 floating-point instructions implemented on some POWER processors.
16638 The @option{-mpowerpc64} option allows GCC to generate the additional
16639 64-bit instructions that are found in the full PowerPC64 architecture
16640 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
16641 @option{-mno-powerpc64}.
16643 @item -mnew-mnemonics
16644 @itemx -mold-mnemonics
16645 @opindex mnew-mnemonics
16646 @opindex mold-mnemonics
16647 Select which mnemonics to use in the generated assembler code.  With
16648 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
16649 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
16650 assembler mnemonics defined for the POWER architecture.  Instructions
16651 defined in only one architecture have only one mnemonic; GCC uses that
16652 mnemonic irrespective of which of these options is specified.
16654 GCC defaults to the mnemonics appropriate for the architecture in
16655 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
16656 value of these option.  Unless you are building a cross-compiler, you
16657 should normally not specify either @option{-mnew-mnemonics} or
16658 @option{-mold-mnemonics}, but should instead accept the default.
16660 @item -mcpu=@var{cpu_type}
16661 @opindex mcpu
16662 Set architecture type, register usage, choice of mnemonics, and
16663 instruction scheduling parameters for machine type @var{cpu_type}.
16664 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16665 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16666 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16667 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16668 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16669 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16670 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
16671 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
16672 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
16673 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{powerpc},
16674 @samp{powerpc64}, and @samp{rs64}.
16676 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
16677 PowerPC and 64-bit PowerPC architecture machine
16678 types, with an appropriate, generic processor model assumed for
16679 scheduling purposes.
16681 The other options specify a specific processor.  Code generated under
16682 those options runs best on that processor, and may not run at all on
16683 others.
16685 The @option{-mcpu} options automatically enable or disable the
16686 following options:
16688 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
16689 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpowerpc64 @gol
16690 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
16691 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
16693 The particular options set for any particular CPU varies between
16694 compiler versions, depending on what setting seems to produce optimal
16695 code for that CPU; it doesn't necessarily reflect the actual hardware's
16696 capabilities.  If you wish to set an individual option to a particular
16697 value, you may specify it after the @option{-mcpu} option, like
16698 @option{-mcpu=970 -mno-altivec}.
16700 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16701 not enabled or disabled by the @option{-mcpu} option at present because
16702 AIX does not have full support for these options.  You may still
16703 enable or disable them individually if you're sure it'll work in your
16704 environment.
16706 @item -mtune=@var{cpu_type}
16707 @opindex mtune
16708 Set the instruction scheduling parameters for machine type
16709 @var{cpu_type}, but do not set the architecture type, register usage, or
16710 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} does.  The same
16711 values for @var{cpu_type} are used for @option{-mtune} as for
16712 @option{-mcpu}.  If both are specified, the code generated uses the
16713 architecture, registers, and mnemonics set by @option{-mcpu}, but the
16714 scheduling parameters set by @option{-mtune}.
16716 @item -mcmodel=small
16717 @opindex mcmodel=small
16718 Generate PowerPC64 code for the small model: The TOC is limited to
16719 64k.
16721 @item -mcmodel=medium
16722 @opindex mcmodel=medium
16723 Generate PowerPC64 code for the medium model: The TOC and other static
16724 data may be up to a total of 4G in size.
16726 @item -mcmodel=large
16727 @opindex mcmodel=large
16728 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16729 in size.  Other data and code is only limited by the 64-bit address
16730 space.
16732 @item -maltivec
16733 @itemx -mno-altivec
16734 @opindex maltivec
16735 @opindex mno-altivec
16736 Generate code that uses (does not use) AltiVec instructions, and also
16737 enable the use of built-in functions that allow more direct access to
16738 the AltiVec instruction set.  You may also need to set
16739 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16740 enhancements.
16742 @item -mvrsave
16743 @itemx -mno-vrsave
16744 @opindex mvrsave
16745 @opindex mno-vrsave
16746 Generate VRSAVE instructions when generating AltiVec code.
16748 @item -mgen-cell-microcode
16749 @opindex mgen-cell-microcode
16750 Generate Cell microcode instructions
16752 @item -mwarn-cell-microcode
16753 @opindex mwarn-cell-microcode
16754 Warning when a Cell microcode instruction is going to emitted.  An example
16755 of a Cell microcode instruction is a variable shift.
16757 @item -msecure-plt
16758 @opindex msecure-plt
16759 Generate code that allows @command{ld} and @command{ld.so}
16760 to build executables and shared
16761 libraries with non-executable @code{.plt} and @code{.got} sections.
16762 This is a PowerPC
16763 32-bit SYSV ABI option.
16765 @item -mbss-plt
16766 @opindex mbss-plt
16767 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
16768 fills in, and
16769 requires @code{.plt} and @code{.got}
16770 sections that are both writable and executable.
16771 This is a PowerPC 32-bit SYSV ABI option.
16773 @item -misel
16774 @itemx -mno-isel
16775 @opindex misel
16776 @opindex mno-isel
16777 This switch enables or disables the generation of ISEL instructions.
16779 @item -misel=@var{yes/no}
16780 This switch has been deprecated.  Use @option{-misel} and
16781 @option{-mno-isel} instead.
16783 @item -mspe
16784 @itemx -mno-spe
16785 @opindex mspe
16786 @opindex mno-spe
16787 This switch enables or disables the generation of SPE simd
16788 instructions.
16790 @item -mpaired
16791 @itemx -mno-paired
16792 @opindex mpaired
16793 @opindex mno-paired
16794 This switch enables or disables the generation of PAIRED simd
16795 instructions.
16797 @item -mspe=@var{yes/no}
16798 This option has been deprecated.  Use @option{-mspe} and
16799 @option{-mno-spe} instead.
16801 @item -mvsx
16802 @itemx -mno-vsx
16803 @opindex mvsx
16804 @opindex mno-vsx
16805 Generate code that uses (does not use) vector/scalar (VSX)
16806 instructions, and also enable the use of built-in functions that allow
16807 more direct access to the VSX instruction set.
16809 @item -mfloat-gprs=@var{yes/single/double/no}
16810 @itemx -mfloat-gprs
16811 @opindex mfloat-gprs
16812 This switch enables or disables the generation of floating-point
16813 operations on the general-purpose registers for architectures that
16814 support it.
16816 The argument @var{yes} or @var{single} enables the use of
16817 single-precision floating-point operations.
16819 The argument @var{double} enables the use of single and
16820 double-precision floating-point operations.
16822 The argument @var{no} disables floating-point operations on the
16823 general-purpose registers.
16825 This option is currently only available on the MPC854x.
16827 @item -m32
16828 @itemx -m64
16829 @opindex m32
16830 @opindex m64
16831 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16832 targets (including GNU/Linux).  The 32-bit environment sets int, long
16833 and pointer to 32 bits and generates code that runs on any PowerPC
16834 variant.  The 64-bit environment sets int to 32 bits and long and
16835 pointer to 64 bits, and generates code for PowerPC64, as for
16836 @option{-mpowerpc64}.
16838 @item -mfull-toc
16839 @itemx -mno-fp-in-toc
16840 @itemx -mno-sum-in-toc
16841 @itemx -mminimal-toc
16842 @opindex mfull-toc
16843 @opindex mno-fp-in-toc
16844 @opindex mno-sum-in-toc
16845 @opindex mminimal-toc
16846 Modify generation of the TOC (Table Of Contents), which is created for
16847 every executable file.  The @option{-mfull-toc} option is selected by
16848 default.  In that case, GCC allocates at least one TOC entry for
16849 each unique non-automatic variable reference in your program.  GCC
16850 also places floating-point constants in the TOC@.  However, only
16851 16,384 entries are available in the TOC@.
16853 If you receive a linker error message that saying you have overflowed
16854 the available TOC space, you can reduce the amount of TOC space used
16855 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16856 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16857 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16858 generate code to calculate the sum of an address and a constant at
16859 run time instead of putting that sum into the TOC@.  You may specify one
16860 or both of these options.  Each causes GCC to produce very slightly
16861 slower and larger code at the expense of conserving TOC space.
16863 If you still run out of space in the TOC even when you specify both of
16864 these options, specify @option{-mminimal-toc} instead.  This option causes
16865 GCC to make only one TOC entry for every file.  When you specify this
16866 option, GCC produces code that is slower and larger but which
16867 uses extremely little TOC space.  You may wish to use this option
16868 only on files that contain less frequently-executed code.
16870 @item -maix64
16871 @itemx -maix32
16872 @opindex maix64
16873 @opindex maix32
16874 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16875 @code{long} type, and the infrastructure needed to support them.
16876 Specifying @option{-maix64} implies @option{-mpowerpc64},
16877 while @option{-maix32} disables the 64-bit ABI and
16878 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
16880 @item -mxl-compat
16881 @itemx -mno-xl-compat
16882 @opindex mxl-compat
16883 @opindex mno-xl-compat
16884 Produce code that conforms more closely to IBM XL compiler semantics
16885 when using AIX-compatible ABI@.  Pass floating-point arguments to
16886 prototyped functions beyond the register save area (RSA) on the stack
16887 in addition to argument FPRs.  Do not assume that most significant
16888 double in 128-bit long double value is properly rounded when comparing
16889 values and converting to double.  Use XL symbol names for long double
16890 support routines.
16892 The AIX calling convention was extended but not initially documented to
16893 handle an obscure K&R C case of calling a function that takes the
16894 address of its arguments with fewer arguments than declared.  IBM XL
16895 compilers access floating-point arguments that do not fit in the
16896 RSA from the stack when a subroutine is compiled without
16897 optimization.  Because always storing floating-point arguments on the
16898 stack is inefficient and rarely needed, this option is not enabled by
16899 default and only is necessary when calling subroutines compiled by IBM
16900 XL compilers without optimization.
16902 @item -mpe
16903 @opindex mpe
16904 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
16905 application written to use message passing with special startup code to
16906 enable the application to run.  The system must have PE installed in the
16907 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16908 must be overridden with the @option{-specs=} option to specify the
16909 appropriate directory location.  The Parallel Environment does not
16910 support threads, so the @option{-mpe} option and the @option{-pthread}
16911 option are incompatible.
16913 @item -malign-natural
16914 @itemx -malign-power
16915 @opindex malign-natural
16916 @opindex malign-power
16917 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16918 @option{-malign-natural} overrides the ABI-defined alignment of larger
16919 types, such as floating-point doubles, on their natural size-based boundary.
16920 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16921 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
16923 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16924 is not supported.
16926 @item -msoft-float
16927 @itemx -mhard-float
16928 @opindex msoft-float
16929 @opindex mhard-float
16930 Generate code that does not use (uses) the floating-point register set.
16931 Software floating-point emulation is provided if you use the
16932 @option{-msoft-float} option, and pass the option to GCC when linking.
16934 @item -msingle-float
16935 @itemx -mdouble-float
16936 @opindex msingle-float
16937 @opindex mdouble-float
16938 Generate code for single- or double-precision floating-point operations.
16939 @option{-mdouble-float} implies @option{-msingle-float}.
16941 @item -msimple-fpu
16942 @opindex msimple-fpu
16943 Do not generate @code{sqrt} and @code{div} instructions for hardware
16944 floating-point unit.
16946 @item -mfpu=@var{name}
16947 @opindex mfpu
16948 Specify type of floating-point unit.  Valid values for @var{name} are
16949 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
16950 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
16951 @samp{sp_full} (equivalent to @option{-msingle-float}),
16952 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
16954 @item -mxilinx-fpu
16955 @opindex mxilinx-fpu
16956 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
16958 @item -mmultiple
16959 @itemx -mno-multiple
16960 @opindex mmultiple
16961 @opindex mno-multiple
16962 Generate code that uses (does not use) the load multiple word
16963 instructions and the store multiple word instructions.  These
16964 instructions are generated by default on POWER systems, and not
16965 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
16966 PowerPC systems, since those instructions do not work when the
16967 processor is in little-endian mode.  The exceptions are PPC740 and
16968 PPC750 which permit these instructions in little-endian mode.
16970 @item -mstring
16971 @itemx -mno-string
16972 @opindex mstring
16973 @opindex mno-string
16974 Generate code that uses (does not use) the load string instructions
16975 and the store string word instructions to save multiple registers and
16976 do small block moves.  These instructions are generated by default on
16977 POWER systems, and not generated on PowerPC systems.  Do not use
16978 @option{-mstring} on little-endian PowerPC systems, since those
16979 instructions do not work when the processor is in little-endian mode.
16980 The exceptions are PPC740 and PPC750 which permit these instructions
16981 in little-endian mode.
16983 @item -mupdate
16984 @itemx -mno-update
16985 @opindex mupdate
16986 @opindex mno-update
16987 Generate code that uses (does not use) the load or store instructions
16988 that update the base register to the address of the calculated memory
16989 location.  These instructions are generated by default.  If you use
16990 @option{-mno-update}, there is a small window between the time that the
16991 stack pointer is updated and the address of the previous frame is
16992 stored, which means code that walks the stack frame across interrupts or
16993 signals may get corrupted data.
16995 @item -mavoid-indexed-addresses
16996 @itemx -mno-avoid-indexed-addresses
16997 @opindex mavoid-indexed-addresses
16998 @opindex mno-avoid-indexed-addresses
16999 Generate code that tries to avoid (not avoid) the use of indexed load
17000 or store instructions. These instructions can incur a performance
17001 penalty on Power6 processors in certain situations, such as when
17002 stepping through large arrays that cross a 16M boundary.  This option
17003 is enabled by default when targeting Power6 and disabled otherwise.
17005 @item -mfused-madd
17006 @itemx -mno-fused-madd
17007 @opindex mfused-madd
17008 @opindex mno-fused-madd
17009 Generate code that uses (does not use) the floating-point multiply and
17010 accumulate instructions.  These instructions are generated by default
17011 if hardware floating point is used.  The machine-dependent
17012 @option{-mfused-madd} option is now mapped to the machine-independent
17013 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17014 mapped to @option{-ffp-contract=off}.
17016 @item -mmulhw
17017 @itemx -mno-mulhw
17018 @opindex mmulhw
17019 @opindex mno-mulhw
17020 Generate code that uses (does not use) the half-word multiply and
17021 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17022 These instructions are generated by default when targeting those
17023 processors.
17025 @item -mdlmzb
17026 @itemx -mno-dlmzb
17027 @opindex mdlmzb
17028 @opindex mno-dlmzb
17029 Generate code that uses (does not use) the string-search @samp{dlmzb}
17030 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17031 generated by default when targeting those processors.
17033 @item -mno-bit-align
17034 @itemx -mbit-align
17035 @opindex mno-bit-align
17036 @opindex mbit-align
17037 On System V.4 and embedded PowerPC systems do not (do) force structures
17038 and unions that contain bit-fields to be aligned to the base type of the
17039 bit-field.
17041 For example, by default a structure containing nothing but 8
17042 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17043 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17044 the structure is aligned to a 1-byte boundary and is 1 byte in
17045 size.
17047 @item -mno-strict-align
17048 @itemx -mstrict-align
17049 @opindex mno-strict-align
17050 @opindex mstrict-align
17051 On System V.4 and embedded PowerPC systems do not (do) assume that
17052 unaligned memory references are handled by the system.
17054 @item -mrelocatable
17055 @itemx -mno-relocatable
17056 @opindex mrelocatable
17057 @opindex mno-relocatable
17058 Generate code that allows (does not allow) a static executable to be
17059 relocated to a different address at run time.  A simple embedded
17060 PowerPC system loader should relocate the entire contents of
17061 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17062 a table of 32-bit addresses generated by this option.  For this to
17063 work, all objects linked together must be compiled with
17064 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17065 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17067 @item -mrelocatable-lib
17068 @itemx -mno-relocatable-lib
17069 @opindex mrelocatable-lib
17070 @opindex mno-relocatable-lib
17071 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17072 @code{.fixup} section to allow static executables to be relocated at
17073 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17074 alignment of @option{-mrelocatable}.  Objects compiled with
17075 @option{-mrelocatable-lib} may be linked with objects compiled with
17076 any combination of the @option{-mrelocatable} options.
17078 @item -mno-toc
17079 @itemx -mtoc
17080 @opindex mno-toc
17081 @opindex mtoc
17082 On System V.4 and embedded PowerPC systems do not (do) assume that
17083 register 2 contains a pointer to a global area pointing to the addresses
17084 used in the program.
17086 @item -mlittle
17087 @itemx -mlittle-endian
17088 @opindex mlittle
17089 @opindex mlittle-endian
17090 On System V.4 and embedded PowerPC systems compile code for the
17091 processor in little-endian mode.  The @option{-mlittle-endian} option is
17092 the same as @option{-mlittle}.
17094 @item -mbig
17095 @itemx -mbig-endian
17096 @opindex mbig
17097 @opindex mbig-endian
17098 On System V.4 and embedded PowerPC systems compile code for the
17099 processor in big-endian mode.  The @option{-mbig-endian} option is
17100 the same as @option{-mbig}.
17102 @item -mdynamic-no-pic
17103 @opindex mdynamic-no-pic
17104 On Darwin and Mac OS X systems, compile code so that it is not
17105 relocatable, but that its external references are relocatable.  The
17106 resulting code is suitable for applications, but not shared
17107 libraries.
17109 @item -msingle-pic-base
17110 @opindex msingle-pic-base
17111 Treat the register used for PIC addressing as read-only, rather than
17112 loading it in the prologue for each function.  The runtime system is
17113 responsible for initializing this register with an appropriate value
17114 before execution begins.
17116 @item -mprioritize-restricted-insns=@var{priority}
17117 @opindex mprioritize-restricted-insns
17118 This option controls the priority that is assigned to
17119 dispatch-slot restricted instructions during the second scheduling
17120 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17121 or @samp{2} to assign no, highest, or second-highest (respectively) 
17122 priority to dispatch-slot restricted
17123 instructions.
17125 @item -msched-costly-dep=@var{dependence_type}
17126 @opindex msched-costly-dep
17127 This option controls which dependences are considered costly
17128 by the target during instruction scheduling.  The argument
17129 @var{dependence_type} takes one of the following values:
17131 @table @asis
17132 @item @samp{no}
17133 No dependence is costly.
17135 @item @samp{all}
17136 All dependences are costly.
17138 @item @samp{true_store_to_load}
17139 A true dependence from store to load is costly.
17141 @item @samp{store_to_load}
17142 Any dependence from store to load is costly.
17144 @item @var{number}
17145 Any dependence for which the latency is greater than or equal to 
17146 @var{number} is costly.
17147 @end table
17149 @item -minsert-sched-nops=@var{scheme}
17150 @opindex minsert-sched-nops
17151 This option controls which NOP insertion scheme is used during
17152 the second scheduling pass.  The argument @var{scheme} takes one of the
17153 following values:
17155 @table @asis
17156 @item @samp{no}
17157 Don't insert NOPs.
17159 @item @samp{pad}
17160 Pad with NOPs any dispatch group that has vacant issue slots,
17161 according to the scheduler's grouping.
17163 @item @samp{regroup_exact}
17164 Insert NOPs to force costly dependent insns into
17165 separate groups.  Insert exactly as many NOPs as needed to force an insn
17166 to a new group, according to the estimated processor grouping.
17168 @item @var{number}
17169 Insert NOPs to force costly dependent insns into
17170 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17171 @end table
17173 @item -mcall-sysv
17174 @opindex mcall-sysv
17175 On System V.4 and embedded PowerPC systems compile code using calling
17176 conventions that adheres to the March 1995 draft of the System V
17177 Application Binary Interface, PowerPC processor supplement.  This is the
17178 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17180 @item -mcall-sysv-eabi
17181 @itemx -mcall-eabi
17182 @opindex mcall-sysv-eabi
17183 @opindex mcall-eabi
17184 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17186 @item -mcall-sysv-noeabi
17187 @opindex mcall-sysv-noeabi
17188 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17190 @item -mcall-aixdesc
17191 @opindex m
17192 On System V.4 and embedded PowerPC systems compile code for the AIX
17193 operating system.
17195 @item -mcall-linux
17196 @opindex mcall-linux
17197 On System V.4 and embedded PowerPC systems compile code for the
17198 Linux-based GNU system.
17200 @item -mcall-freebsd
17201 @opindex mcall-freebsd
17202 On System V.4 and embedded PowerPC systems compile code for the
17203 FreeBSD operating system.
17205 @item -mcall-netbsd
17206 @opindex mcall-netbsd
17207 On System V.4 and embedded PowerPC systems compile code for the
17208 NetBSD operating system.
17210 @item -mcall-openbsd
17211 @opindex mcall-netbsd
17212 On System V.4 and embedded PowerPC systems compile code for the
17213 OpenBSD operating system.
17215 @item -maix-struct-return
17216 @opindex maix-struct-return
17217 Return all structures in memory (as specified by the AIX ABI)@.
17219 @item -msvr4-struct-return
17220 @opindex msvr4-struct-return
17221 Return structures smaller than 8 bytes in registers (as specified by the
17222 SVR4 ABI)@.
17224 @item -mabi=@var{abi-type}
17225 @opindex mabi
17226 Extend the current ABI with a particular extension, or remove such extension.
17227 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17228 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17230 @item -mabi=spe
17231 @opindex mabi=spe
17232 Extend the current ABI with SPE ABI extensions.  This does not change
17233 the default ABI, instead it adds the SPE ABI extensions to the current
17234 ABI@.
17236 @item -mabi=no-spe
17237 @opindex mabi=no-spe
17238 Disable Booke SPE ABI extensions for the current ABI@.
17240 @item -mabi=ibmlongdouble
17241 @opindex mabi=ibmlongdouble
17242 Change the current ABI to use IBM extended-precision long double.
17243 This is a PowerPC 32-bit SYSV ABI option.
17245 @item -mabi=ieeelongdouble
17246 @opindex mabi=ieeelongdouble
17247 Change the current ABI to use IEEE extended-precision long double.
17248 This is a PowerPC 32-bit Linux ABI option.
17250 @item -mprototype
17251 @itemx -mno-prototype
17252 @opindex mprototype
17253 @opindex mno-prototype
17254 On System V.4 and embedded PowerPC systems assume that all calls to
17255 variable argument functions are properly prototyped.  Otherwise, the
17256 compiler must insert an instruction before every non prototyped call to
17257 set or clear bit 6 of the condition code register (@var{CR}) to
17258 indicate whether floating-point values are passed in the floating-point
17259 registers in case the function takes variable arguments.  With
17260 @option{-mprototype}, only calls to prototyped variable argument functions
17261 set or clear the bit.
17263 @item -msim
17264 @opindex msim
17265 On embedded PowerPC systems, assume that the startup module is called
17266 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17267 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17268 configurations.
17270 @item -mmvme
17271 @opindex mmvme
17272 On embedded PowerPC systems, assume that the startup module is called
17273 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17274 @file{libc.a}.
17276 @item -mads
17277 @opindex mads
17278 On embedded PowerPC systems, assume that the startup module is called
17279 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17280 @file{libc.a}.
17282 @item -myellowknife
17283 @opindex myellowknife
17284 On embedded PowerPC systems, assume that the startup module is called
17285 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17286 @file{libc.a}.
17288 @item -mvxworks
17289 @opindex mvxworks
17290 On System V.4 and embedded PowerPC systems, specify that you are
17291 compiling for a VxWorks system.
17293 @item -memb
17294 @opindex memb
17295 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17296 header to indicate that @samp{eabi} extended relocations are used.
17298 @item -meabi
17299 @itemx -mno-eabi
17300 @opindex meabi
17301 @opindex mno-eabi
17302 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17303 Embedded Applications Binary Interface (eabi) which is a set of
17304 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17305 means that the stack is aligned to an 8-byte boundary, a function
17306 @code{__eabi} is called to from @code{main} to set up the eabi
17307 environment, and the @option{-msdata} option can use both @code{r2} and
17308 @code{r13} to point to two separate small data areas.  Selecting
17309 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17310 do not call an initialization function from @code{main}, and the
17311 @option{-msdata} option only uses @code{r13} to point to a single
17312 small data area.  The @option{-meabi} option is on by default if you
17313 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17315 @item -msdata=eabi
17316 @opindex msdata=eabi
17317 On System V.4 and embedded PowerPC systems, put small initialized
17318 @code{const} global and static data in the @samp{.sdata2} section, which
17319 is pointed to by register @code{r2}.  Put small initialized
17320 non-@code{const} global and static data in the @samp{.sdata} section,
17321 which is pointed to by register @code{r13}.  Put small uninitialized
17322 global and static data in the @samp{.sbss} section, which is adjacent to
17323 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17324 incompatible with the @option{-mrelocatable} option.  The
17325 @option{-msdata=eabi} option also sets the @option{-memb} option.
17327 @item -msdata=sysv
17328 @opindex msdata=sysv
17329 On System V.4 and embedded PowerPC systems, put small global and static
17330 data in the @samp{.sdata} section, which is pointed to by register
17331 @code{r13}.  Put small uninitialized global and static data in the
17332 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17333 The @option{-msdata=sysv} option is incompatible with the
17334 @option{-mrelocatable} option.
17336 @item -msdata=default
17337 @itemx -msdata
17338 @opindex msdata=default
17339 @opindex msdata
17340 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17341 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17342 same as @option{-msdata=sysv}.
17344 @item -msdata=data
17345 @opindex msdata=data
17346 On System V.4 and embedded PowerPC systems, put small global
17347 data in the @samp{.sdata} section.  Put small uninitialized global
17348 data in the @samp{.sbss} section.  Do not use register @code{r13}
17349 to address small data however.  This is the default behavior unless
17350 other @option{-msdata} options are used.
17352 @item -msdata=none
17353 @itemx -mno-sdata
17354 @opindex msdata=none
17355 @opindex mno-sdata
17356 On embedded PowerPC systems, put all initialized global and static data
17357 in the @samp{.data} section, and all uninitialized data in the
17358 @samp{.bss} section.
17360 @item -mblock-move-inline-limit=@var{num}
17361 @opindex mblock-move-inline-limit
17362 Inline all block moves (such as calls to @code{memcpy} or structure
17363 copies) less than or equal to @var{num} bytes.  The minimum value for
17364 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17365 targets.  The default value is target-specific.
17367 @item -G @var{num}
17368 @opindex G
17369 @cindex smaller data references (PowerPC)
17370 @cindex .sdata/.sdata2 references (PowerPC)
17371 On embedded PowerPC systems, put global and static items less than or
17372 equal to @var{num} bytes into the small data or bss sections instead of
17373 the normal data or bss section.  By default, @var{num} is 8.  The
17374 @option{-G @var{num}} switch is also passed to the linker.
17375 All modules should be compiled with the same @option{-G @var{num}} value.
17377 @item -mregnames
17378 @itemx -mno-regnames
17379 @opindex mregnames
17380 @opindex mno-regnames
17381 On System V.4 and embedded PowerPC systems do (do not) emit register
17382 names in the assembly language output using symbolic forms.
17384 @item -mlongcall
17385 @itemx -mno-longcall
17386 @opindex mlongcall
17387 @opindex mno-longcall
17388 By default assume that all calls are far away so that a longer more
17389 expensive calling sequence is required.  This is required for calls
17390 further than 32 megabytes (33,554,432 bytes) from the current location.
17391 A short call is generated if the compiler knows
17392 the call cannot be that far away.  This setting can be overridden by
17393 the @code{shortcall} function attribute, or by @code{#pragma
17394 longcall(0)}.
17396 Some linkers are capable of detecting out-of-range calls and generating
17397 glue code on the fly.  On these systems, long calls are unnecessary and
17398 generate slower code.  As of this writing, the AIX linker can do this,
17399 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17400 to the GNU linker for 32-bit PowerPC systems as well.
17402 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17403 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17404 addresses represent the callee and the branch island.  The
17405 Darwin/PPC linker prefers the first address and generates a @code{bl
17406 callee} if the PPC @code{bl} instruction reaches the callee directly;
17407 otherwise, the linker generates @code{bl L42} to call the branch
17408 island.  The branch island is appended to the body of the
17409 calling function; it computes the full 32-bit address of the callee
17410 and jumps to it.
17412 On Mach-O (Darwin) systems, this option directs the compiler emit to
17413 the glue for every direct call, and the Darwin linker decides whether
17414 to use or discard it.
17416 In the future, GCC may ignore all longcall specifications
17417 when the linker is known to generate glue.
17419 @item -mtls-markers
17420 @itemx -mno-tls-markers
17421 @opindex mtls-markers
17422 @opindex mno-tls-markers
17423 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17424 specifying the function argument.  The relocation allows the linker to
17425 reliably associate function call with argument setup instructions for
17426 TLS optimization, which in turn allows GCC to better schedule the
17427 sequence.
17429 @item -pthread
17430 @opindex pthread
17431 Adds support for multithreading with the @dfn{pthreads} library.
17432 This option sets flags for both the preprocessor and linker.
17434 @item -mrecip
17435 @itemx -mno-recip
17436 @opindex mrecip
17437 This option enables use of the reciprocal estimate and
17438 reciprocal square root estimate instructions with additional
17439 Newton-Raphson steps to increase precision instead of doing a divide or
17440 square root and divide for floating-point arguments.  You should use
17441 the @option{-ffast-math} option when using @option{-mrecip} (or at
17442 least @option{-funsafe-math-optimizations},
17443 @option{-finite-math-only}, @option{-freciprocal-math} and
17444 @option{-fno-trapping-math}).  Note that while the throughput of the
17445 sequence is generally higher than the throughput of the non-reciprocal
17446 instruction, the precision of the sequence can be decreased by up to 2
17447 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
17448 roots.
17450 @item -mrecip=@var{opt}
17451 @opindex mrecip=opt
17452 This option allows to control which reciprocal estimate instructions
17453 may be used.  @var{opt} is a comma separated list of options, which may
17454 be preceded by a @code{!} to invert the option:
17455 @code{all}: enable all estimate instructions,
17456 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17457 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17458 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17459 @code{divf}: enable the single-precision reciprocal approximation instructions;
17460 @code{divd}: enable the double-precision reciprocal approximation instructions;
17461 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17462 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17463 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17465 So, for example, @option{-mrecip=all,!rsqrtd} enables
17466 all of the reciprocal estimate instructions, except for the
17467 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17468 which handle the double-precision reciprocal square root calculations.
17470 @item -mrecip-precision
17471 @itemx -mno-recip-precision
17472 @opindex mrecip-precision
17473 Assume (do not assume) that the reciprocal estimate instructions
17474 provide higher-precision estimates than is mandated by the PowerPC
17475 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17476 automatically selects @option{-mrecip-precision}.  The double-precision 
17477 square root estimate instructions are not generated by
17478 default on low-precision machines, since they do not provide an
17479 estimate that converges after three steps.
17481 @item -mveclibabi=@var{type}
17482 @opindex mveclibabi
17483 Specifies the ABI type to use for vectorizing intrinsics using an
17484 external library.  The only type supported at present is @code{mass},
17485 which specifies to use IBM's Mathematical Acceleration Subsystem
17486 (MASS) libraries for vectorizing intrinsics using external libraries.
17487 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17488 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17489 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17490 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17491 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17492 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17493 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17494 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17495 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17496 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17497 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17498 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17499 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17500 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17501 for power7.  Both @option{-ftree-vectorize} and
17502 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
17503 libraries must be specified at link time.
17505 @item -mfriz
17506 @itemx -mno-friz
17507 @opindex mfriz
17508 Generate (do not generate) the @code{friz} instruction when the
17509 @option{-funsafe-math-optimizations} option is used to optimize
17510 rounding of floating-point values to 64-bit integer and back to floating
17511 point.  The @code{friz} instruction does not return the same value if
17512 the floating-point number is too large to fit in an integer.
17514 @item -mpointers-to-nested-functions
17515 @itemx -mno-pointers-to-nested-functions
17516 @opindex mpointers-to-nested-functions
17517 Generate (do not generate) code to load up the static chain register
17518 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17519 systems where a function pointer points to a 3-word descriptor giving
17520 the function address, TOC value to be loaded in register @var{r2}, and
17521 static chain value to be loaded in register @var{r11}.  The
17522 @option{-mpointers-to-nested-functions} is on by default.  You cannot
17523 call through pointers to nested functions or pointers
17524 to functions compiled in other languages that use the static chain if
17525 you use the @option{-mno-pointers-to-nested-functions}.
17527 @item -msave-toc-indirect
17528 @itemx -mno-save-toc-indirect
17529 @opindex msave-toc-indirect
17530 Generate (do not generate) code to save the TOC value in the reserved
17531 stack location in the function prologue if the function calls through
17532 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17533 saved in the prologue, it is saved just before the call through the
17534 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17535 @end table
17537 @node RX Options
17538 @subsection RX Options
17539 @cindex RX Options
17541 These command-line options are defined for RX targets:
17543 @table @gcctabopt
17544 @item -m64bit-doubles
17545 @itemx -m32bit-doubles
17546 @opindex m64bit-doubles
17547 @opindex m32bit-doubles
17548 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17549 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
17550 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
17551 works on 32-bit values, which is why the default is
17552 @option{-m32bit-doubles}.
17554 @item -fpu
17555 @itemx -nofpu
17556 @opindex fpu
17557 @opindex nofpu
17558 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17559 floating-point hardware.  The default is enabled for the @var{RX600}
17560 series and disabled for the @var{RX200} series.
17562 Floating-point instructions are only generated for 32-bit floating-point 
17563 values, however, so the FPU hardware is not used for doubles if the
17564 @option{-m64bit-doubles} option is used.
17566 @emph{Note} If the @option{-fpu} option is enabled then
17567 @option{-funsafe-math-optimizations} is also enabled automatically.
17568 This is because the RX FPU instructions are themselves unsafe.
17570 @item -mcpu=@var{name}
17571 @opindex -mcpu
17572 Selects the type of RX CPU to be targeted.  Currently three types are
17573 supported, the generic @var{RX600} and @var{RX200} series hardware and
17574 the specific @var{RX610} CPU.  The default is @var{RX600}.
17576 The only difference between @var{RX600} and @var{RX610} is that the
17577 @var{RX610} does not support the @code{MVTIPL} instruction.
17579 The @var{RX200} series does not have a hardware floating-point unit
17580 and so @option{-nofpu} is enabled by default when this type is
17581 selected.
17583 @item -mbig-endian-data
17584 @itemx -mlittle-endian-data
17585 @opindex mbig-endian-data
17586 @opindex mlittle-endian-data
17587 Store data (but not code) in the big-endian format.  The default is
17588 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17589 format.
17591 @item -msmall-data-limit=@var{N}
17592 @opindex msmall-data-limit
17593 Specifies the maximum size in bytes of global and static variables
17594 which can be placed into the small data area.  Using the small data
17595 area can lead to smaller and faster code, but the size of area is
17596 limited and it is up to the programmer to ensure that the area does
17597 not overflow.  Also when the small data area is used one of the RX's
17598 registers (usually @code{r13}) is reserved for use pointing to this
17599 area, so it is no longer available for use by the compiler.  This
17600 could result in slower and/or larger code if variables are pushed onto
17601 the stack instead of being held in this register.
17603 Note, common variables (variables that have not been initialized) and
17604 constants are not placed into the small data area as they are assigned
17605 to other sections in the output executable.
17607 The default value is zero, which disables this feature.  Note, this
17608 feature is not enabled by default with higher optimization levels
17609 (@option{-O2} etc) because of the potentially detrimental effects of
17610 reserving a register.  It is up to the programmer to experiment and
17611 discover whether this feature is of benefit to their program.  See the
17612 description of the @option{-mpid} option for a description of how the
17613 actual register to hold the small data area pointer is chosen.
17615 @item -msim
17616 @itemx -mno-sim
17617 @opindex msim
17618 @opindex mno-sim
17619 Use the simulator runtime.  The default is to use the libgloss board
17620 specific runtime.
17622 @item -mas100-syntax
17623 @itemx -mno-as100-syntax
17624 @opindex mas100-syntax
17625 @opindex mno-as100-syntax
17626 When generating assembler output use a syntax that is compatible with
17627 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17628 assembler but it has some restrictions so generating it is not the
17629 default option.
17631 @item -mmax-constant-size=@var{N}
17632 @opindex mmax-constant-size
17633 Specifies the maximum size, in bytes, of a constant that can be used as
17634 an operand in a RX instruction.  Although the RX instruction set does
17635 allow constants of up to 4 bytes in length to be used in instructions,
17636 a longer value equates to a longer instruction.  Thus in some
17637 circumstances it can be beneficial to restrict the size of constants
17638 that are used in instructions.  Constants that are too big are instead
17639 placed into a constant pool and referenced via register indirection.
17641 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17642 or 4 means that constants of any size are allowed.
17644 @item -mrelax
17645 @opindex mrelax
17646 Enable linker relaxation.  Linker relaxation is a process whereby the
17647 linker attempts to reduce the size of a program by finding shorter
17648 versions of various instructions.  Disabled by default.
17650 @item -mint-register=@var{N}
17651 @opindex mint-register
17652 Specify the number of registers to reserve for fast interrupt handler
17653 functions.  The value @var{N} can be between 0 and 4.  A value of 1
17654 means that register @code{r13} is reserved for the exclusive use
17655 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
17656 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
17657 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17658 A value of 0, the default, does not reserve any registers.
17660 @item -msave-acc-in-interrupts
17661 @opindex msave-acc-in-interrupts
17662 Specifies that interrupt handler functions should preserve the
17663 accumulator register.  This is only necessary if normal code might use
17664 the accumulator register, for example because it performs 64-bit
17665 multiplications.  The default is to ignore the accumulator as this
17666 makes the interrupt handlers faster.
17668 @item -mpid
17669 @itemx -mno-pid
17670 @opindex mpid
17671 @opindex mno-pid
17672 Enables the generation of position independent data.  When enabled any
17673 access to constant data is done via an offset from a base address
17674 held in a register.  This allows the location of constant data to be
17675 determined at run time without requiring the executable to be
17676 relocated, which is a benefit to embedded applications with tight
17677 memory constraints.  Data that can be modified is not affected by this
17678 option.
17680 Note, using this feature reserves a register, usually @code{r13}, for
17681 the constant data base address.  This can result in slower and/or
17682 larger code, especially in complicated functions.
17684 The actual register chosen to hold the constant data base address
17685 depends upon whether the @option{-msmall-data-limit} and/or the
17686 @option{-mint-register} command-line options are enabled.  Starting
17687 with register @code{r13} and proceeding downwards, registers are
17688 allocated first to satisfy the requirements of @option{-mint-register},
17689 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
17690 is possible for the small data area register to be @code{r8} if both
17691 @option{-mint-register=4} and @option{-mpid} are specified on the
17692 command line.
17694 By default this feature is not enabled.  The default can be restored
17695 via the @option{-mno-pid} command-line option.
17697 @end table
17699 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
17700 has special significance to the RX port when used with the
17701 @code{interrupt} function attribute.  This attribute indicates a
17702 function intended to process fast interrupts.  GCC ensures
17703 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17704 and/or @code{r13} and only provided that the normal use of the
17705 corresponding registers have been restricted via the
17706 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
17707 options.
17709 @node S/390 and zSeries Options
17710 @subsection S/390 and zSeries Options
17711 @cindex S/390 and zSeries Options
17713 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17715 @table @gcctabopt
17716 @item -mhard-float
17717 @itemx -msoft-float
17718 @opindex mhard-float
17719 @opindex msoft-float
17720 Use (do not use) the hardware floating-point instructions and registers
17721 for floating-point operations.  When @option{-msoft-float} is specified,
17722 functions in @file{libgcc.a} are used to perform floating-point
17723 operations.  When @option{-mhard-float} is specified, the compiler
17724 generates IEEE floating-point instructions.  This is the default.
17726 @item -mhard-dfp
17727 @itemx -mno-hard-dfp
17728 @opindex mhard-dfp
17729 @opindex mno-hard-dfp
17730 Use (do not use) the hardware decimal-floating-point instructions for
17731 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
17732 specified, functions in @file{libgcc.a} are used to perform
17733 decimal-floating-point operations.  When @option{-mhard-dfp} is
17734 specified, the compiler generates decimal-floating-point hardware
17735 instructions.  This is the default for @option{-march=z9-ec} or higher.
17737 @item -mlong-double-64
17738 @itemx -mlong-double-128
17739 @opindex mlong-double-64
17740 @opindex mlong-double-128
17741 These switches control the size of @code{long double} type. A size
17742 of 64 bits makes the @code{long double} type equivalent to the @code{double}
17743 type. This is the default.
17745 @item -mbackchain
17746 @itemx -mno-backchain
17747 @opindex mbackchain
17748 @opindex mno-backchain
17749 Store (do not store) the address of the caller's frame as backchain pointer
17750 into the callee's stack frame.
17751 A backchain may be needed to allow debugging using tools that do not understand
17752 DWARF 2 call frame information.
17753 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17754 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17755 the backchain is placed into the topmost word of the 96/160 byte register
17756 save area.
17758 In general, code compiled with @option{-mbackchain} is call-compatible with
17759 code compiled with @option{-mmo-backchain}; however, use of the backchain
17760 for debugging purposes usually requires that the whole binary is built with
17761 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
17762 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17763 to build a linux kernel use @option{-msoft-float}.
17765 The default is to not maintain the backchain.
17767 @item -mpacked-stack
17768 @itemx -mno-packed-stack
17769 @opindex mpacked-stack
17770 @opindex mno-packed-stack
17771 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
17772 specified, the compiler uses the all fields of the 96/160 byte register save
17773 area only for their default purpose; unused fields still take up stack space.
17774 When @option{-mpacked-stack} is specified, register save slots are densely
17775 packed at the top of the register save area; unused space is reused for other
17776 purposes, allowing for more efficient use of the available stack space.
17777 However, when @option{-mbackchain} is also in effect, the topmost word of
17778 the save area is always used to store the backchain, and the return address
17779 register is always saved two words below the backchain.
17781 As long as the stack frame backchain is not used, code generated with
17782 @option{-mpacked-stack} is call-compatible with code generated with
17783 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
17784 S/390 or zSeries generated code that uses the stack frame backchain at run
17785 time, not just for debugging purposes.  Such code is not call-compatible
17786 with code compiled with @option{-mpacked-stack}.  Also, note that the
17787 combination of @option{-mbackchain},
17788 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17789 to build a linux kernel use @option{-msoft-float}.
17791 The default is to not use the packed stack layout.
17793 @item -msmall-exec
17794 @itemx -mno-small-exec
17795 @opindex msmall-exec
17796 @opindex mno-small-exec
17797 Generate (or do not generate) code using the @code{bras} instruction
17798 to do subroutine calls.
17799 This only works reliably if the total executable size does not
17800 exceed 64k.  The default is to use the @code{basr} instruction instead,
17801 which does not have this limitation.
17803 @item -m64
17804 @itemx -m31
17805 @opindex m64
17806 @opindex m31
17807 When @option{-m31} is specified, generate code compliant to the
17808 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
17809 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
17810 particular to generate 64-bit instructions.  For the @samp{s390}
17811 targets, the default is @option{-m31}, while the @samp{s390x}
17812 targets default to @option{-m64}.
17814 @item -mzarch
17815 @itemx -mesa
17816 @opindex mzarch
17817 @opindex mesa
17818 When @option{-mzarch} is specified, generate code using the
17819 instructions available on z/Architecture.
17820 When @option{-mesa} is specified, generate code using the
17821 instructions available on ESA/390.  Note that @option{-mesa} is
17822 not possible with @option{-m64}.
17823 When generating code compliant to the GNU/Linux for S/390 ABI,
17824 the default is @option{-mesa}.  When generating code compliant
17825 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17827 @item -mmvcle
17828 @itemx -mno-mvcle
17829 @opindex mmvcle
17830 @opindex mno-mvcle
17831 Generate (or do not generate) code using the @code{mvcle} instruction
17832 to perform block moves.  When @option{-mno-mvcle} is specified,
17833 use a @code{mvc} loop instead.  This is the default unless optimizing for
17834 size.
17836 @item -mdebug
17837 @itemx -mno-debug
17838 @opindex mdebug
17839 @opindex mno-debug
17840 Print (or do not print) additional debug information when compiling.
17841 The default is to not print debug information.
17843 @item -march=@var{cpu-type}
17844 @opindex march
17845 Generate code that runs on @var{cpu-type}, which is the name of a system
17846 representing a certain processor type.  Possible values for
17847 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17848 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17849 When generating code using the instructions available on z/Architecture,
17850 the default is @option{-march=z900}.  Otherwise, the default is
17851 @option{-march=g5}.
17853 @item -mtune=@var{cpu-type}
17854 @opindex mtune
17855 Tune to @var{cpu-type} everything applicable about the generated code,
17856 except for the ABI and the set of available instructions.
17857 The list of @var{cpu-type} values is the same as for @option{-march}.
17858 The default is the value used for @option{-march}.
17860 @item -mtpf-trace
17861 @itemx -mno-tpf-trace
17862 @opindex mtpf-trace
17863 @opindex mno-tpf-trace
17864 Generate code that adds (does not add) in TPF OS specific branches to trace
17865 routines in the operating system.  This option is off by default, even
17866 when compiling for the TPF OS@.
17868 @item -mfused-madd
17869 @itemx -mno-fused-madd
17870 @opindex mfused-madd
17871 @opindex mno-fused-madd
17872 Generate code that uses (does not use) the floating-point multiply and
17873 accumulate instructions.  These instructions are generated by default if
17874 hardware floating point is used.
17876 @item -mwarn-framesize=@var{framesize}
17877 @opindex mwarn-framesize
17878 Emit a warning if the current function exceeds the given frame size.  Because
17879 this is a compile-time check it doesn't need to be a real problem when the program
17880 runs.  It is intended to identify functions that most probably cause
17881 a stack overflow.  It is useful to be used in an environment with limited stack
17882 size e.g.@: the linux kernel.
17884 @item -mwarn-dynamicstack
17885 @opindex mwarn-dynamicstack
17886 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
17887 arrays.  This is generally a bad idea with a limited stack size.
17889 @item -mstack-guard=@var{stack-guard}
17890 @itemx -mstack-size=@var{stack-size}
17891 @opindex mstack-guard
17892 @opindex mstack-size
17893 If these options are provided the s390 back end emits additional instructions in
17894 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17895 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17896 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17897 the frame size of the compiled function is chosen.
17898 These options are intended to be used to help debugging stack overflow problems.
17899 The additionally emitted code causes only little overhead and hence can also be
17900 used in production like systems without greater performance degradation.  The given
17901 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17902 @var{stack-guard} without exceeding 64k.
17903 In order to be efficient the extra code makes the assumption that the stack starts
17904 at an address aligned to the value given by @var{stack-size}.
17905 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17906 @end table
17908 @node Score Options
17909 @subsection Score Options
17910 @cindex Score Options
17912 These options are defined for Score implementations:
17914 @table @gcctabopt
17915 @item -meb
17916 @opindex meb
17917 Compile code for big-endian mode.  This is the default.
17919 @item -mel
17920 @opindex mel
17921 Compile code for little-endian mode.
17923 @item -mnhwloop
17924 @opindex mnhwloop
17925 Disable generate bcnz instruction.
17927 @item -muls
17928 @opindex muls
17929 Enable generate unaligned load and store instruction.
17931 @item -mmac
17932 @opindex mmac
17933 Enable the use of multiply-accumulate instructions. Disabled by default.
17935 @item -mscore5
17936 @opindex mscore5
17937 Specify the SCORE5 as the target architecture.
17939 @item -mscore5u
17940 @opindex mscore5u
17941 Specify the SCORE5U of the target architecture.
17943 @item -mscore7
17944 @opindex mscore7
17945 Specify the SCORE7 as the target architecture. This is the default.
17947 @item -mscore7d
17948 @opindex mscore7d
17949 Specify the SCORE7D as the target architecture.
17950 @end table
17952 @node SH Options
17953 @subsection SH Options
17955 These @samp{-m} options are defined for the SH implementations:
17957 @table @gcctabopt
17958 @item -m1
17959 @opindex m1
17960 Generate code for the SH1.
17962 @item -m2
17963 @opindex m2
17964 Generate code for the SH2.
17966 @item -m2e
17967 Generate code for the SH2e.
17969 @item -m2a-nofpu
17970 @opindex m2a-nofpu
17971 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
17972 that the floating-point unit is not used.
17974 @item -m2a-single-only
17975 @opindex m2a-single-only
17976 Generate code for the SH2a-FPU, in such a way that no double-precision
17977 floating-point operations are used.
17979 @item -m2a-single
17980 @opindex m2a-single
17981 Generate code for the SH2a-FPU assuming the floating-point unit is in
17982 single-precision mode by default.
17984 @item -m2a
17985 @opindex m2a
17986 Generate code for the SH2a-FPU assuming the floating-point unit is in
17987 double-precision mode by default.
17989 @item -m3
17990 @opindex m3
17991 Generate code for the SH3.
17993 @item -m3e
17994 @opindex m3e
17995 Generate code for the SH3e.
17997 @item -m4-nofpu
17998 @opindex m4-nofpu
17999 Generate code for the SH4 without a floating-point unit.
18001 @item -m4-single-only
18002 @opindex m4-single-only
18003 Generate code for the SH4 with a floating-point unit that only
18004 supports single-precision arithmetic.
18006 @item -m4-single
18007 @opindex m4-single
18008 Generate code for the SH4 assuming the floating-point unit is in
18009 single-precision mode by default.
18011 @item -m4
18012 @opindex m4
18013 Generate code for the SH4.
18015 @item -m4a-nofpu
18016 @opindex m4a-nofpu
18017 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18018 floating-point unit is not used.
18020 @item -m4a-single-only
18021 @opindex m4a-single-only
18022 Generate code for the SH4a, in such a way that no double-precision
18023 floating-point operations are used.
18025 @item -m4a-single
18026 @opindex m4a-single
18027 Generate code for the SH4a assuming the floating-point unit is in
18028 single-precision mode by default.
18030 @item -m4a
18031 @opindex m4a
18032 Generate code for the SH4a.
18034 @item -m4al
18035 @opindex m4al
18036 Same as @option{-m4a-nofpu}, except that it implicitly passes
18037 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18038 instructions at the moment.
18040 @item -mb
18041 @opindex mb
18042 Compile code for the processor in big-endian mode.
18044 @item -ml
18045 @opindex ml
18046 Compile code for the processor in little-endian mode.
18048 @item -mdalign
18049 @opindex mdalign
18050 Align doubles at 64-bit boundaries.  Note that this changes the calling
18051 conventions, and thus some functions from the standard C library do
18052 not work unless you recompile it first with @option{-mdalign}.
18054 @item -mrelax
18055 @opindex mrelax
18056 Shorten some address references at link time, when possible; uses the
18057 linker option @option{-relax}.
18059 @item -mbigtable
18060 @opindex mbigtable
18061 Use 32-bit offsets in @code{switch} tables.  The default is to use
18062 16-bit offsets.
18064 @item -mbitops
18065 @opindex mbitops
18066 Enable the use of bit manipulation instructions on SH2A.
18068 @item -mfmovd
18069 @opindex mfmovd
18070 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18071 alignment constraints.
18073 @item -mhitachi
18074 @opindex mhitachi
18075 Comply with the calling conventions defined by Renesas.
18077 @item -mrenesas
18078 @opindex mhitachi
18079 Comply with the calling conventions defined by Renesas.
18081 @item -mno-renesas
18082 @opindex mhitachi
18083 Comply with the calling conventions defined for GCC before the Renesas
18084 conventions were available.  This option is the default for all
18085 targets of the SH toolchain.
18087 @item -mnomacsave
18088 @opindex mnomacsave
18089 Mark the @code{MAC} register as call-clobbered, even if
18090 @option{-mhitachi} is given.
18092 @item -mieee
18093 @item -mno-ieee
18094 @opindex mieee
18095 @opindex mnoieee
18096 Control the IEEE compliance of floating-point comparisons, which affects the
18097 handling of cases where the result of a comparison is unordered.  By default
18098 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18099 enabled @option{-mno-ieee} is implicitly set, which results in faster
18100 floating-point greater-equal and less-equal comparisons.  The implcit settings
18101 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18103 @item -minline-ic_invalidate
18104 @opindex minline-ic_invalidate
18105 Inline code to invalidate instruction cache entries after setting up
18106 nested function trampolines.
18107 This option has no effect if @option{-musermode} is in effect and the selected
18108 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18109 instruction.
18110 If the selected code generation option does not allow the use of the @code{icbi}
18111 instruction, and @option{-musermode} is not in effect, the inlined code
18112 manipulates the instruction cache address array directly with an associative
18113 write.  This not only requires privileged mode at run time, but it also
18114 fails if the cache line had been mapped via the TLB and has become unmapped.
18116 @item -misize
18117 @opindex misize
18118 Dump instruction size and location in the assembly code.
18120 @item -mpadstruct
18121 @opindex mpadstruct
18122 This option is deprecated.  It pads structures to multiple of 4 bytes,
18123 which is incompatible with the SH ABI@.
18125 @item -msoft-atomic
18126 @opindex msoft-atomic
18127 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18128 built-in functions.  The generated atomic sequences require support from the 
18129 interrupt / exception handling code of the system and are only suitable for
18130 single-core systems.  They will not operate correctly on multi-core systems.
18131 This option is enabled by default when the target is @code{sh-*-linux*}.
18132 When the target is SH4A, this option will also partially utilize the hardware
18133 atomic instructions @code{movli.l} and @code{movco.l} to create more
18134 efficient code.
18135 For details on the atomic built-in functions see @ref{__atomic Builtins}.
18137 @item -mhard-atomic
18138 @opindex hard-atomic
18139 Generate hardware atomic sequences for the atomic built-in functions.  This
18140 is only available on SH4A and is suitable for multi-core systems.  Code
18141 compiled with this option will also be compatible with gUSA aware
18142 interrupt / exception handling systems.  In contrast to the
18143 @option{-msoft-atomic} option this will only use the instructions
18144 @code{movli.l} and @code{movco.l} to create atomic sequences.
18146 @item -menable-tas
18147 @opindex menable-tas
18148 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18149 Notice that depending on the particular hardware and software configuration
18150 this can degrade overall performance due to the operand cache line flushes
18151 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18152 processors the @code{tas.b} instruction must be used with caution since it
18153 can result in data corruption for certain cache configurations.
18155 @item -mspace
18156 @opindex mspace
18157 Optimize for space instead of speed.  Implied by @option{-Os}.
18159 @item -mprefergot
18160 @opindex mprefergot
18161 When generating position-independent code, emit function calls using
18162 the Global Offset Table instead of the Procedure Linkage Table.
18164 @item -musermode
18165 @opindex musermode
18166 Don't generate privileged mode only code.  This option
18167 implies @option{-mno-inline-ic_invalidate}
18168 if the inlined code would not work in user mode.
18169 This is the default when the target is @code{sh-*-linux*}.
18171 @item -multcost=@var{number}
18172 @opindex multcost=@var{number}
18173 Set the cost to assume for a multiply insn.
18175 @item -mdiv=@var{strategy}
18176 @opindex mdiv=@var{strategy}
18177 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18178 one of: 
18180 @table @samp
18182 @item fp 
18183 Performs the operation in floating point.  This has a very high latency,
18184 but needs only a few instructions, so it might be a good choice if
18185 your code has enough easily-exploitable ILP to allow the compiler to
18186 schedule the floating-point instructions together with other instructions.
18187 Division by zero causes a floating-point exception.
18189 @item inv
18190 Uses integer operations to calculate the inverse of the divisor,
18191 and then multiplies the dividend with the inverse.  This strategy allows
18192 CSE and hoisting of the inverse calculation.  Division by zero calculates
18193 an unspecified result, but does not trap.
18195 @item inv:minlat
18196 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18197 have been found, or if the entire operation has been hoisted to the same
18198 place, the last stages of the inverse calculation are intertwined with the
18199 final multiply to reduce the overall latency, at the expense of using a few
18200 more instructions, and thus offering fewer scheduling opportunities with
18201 other code.
18203 @item call
18204 Calls a library function that usually implements the @samp{inv:minlat}
18205 strategy.
18206 This gives high code density for @code{m5-*media-nofpu} compilations.
18208 @item call2
18209 Uses a different entry point of the same library function, where it
18210 assumes that a pointer to a lookup table has already been set up, which
18211 exposes the pointer load to CSE and code hoisting optimizations.
18213 @item inv:call
18214 @itemx inv:call2
18215 @itemx inv:fp
18216 Use the @samp{inv} algorithm for initial
18217 code generation, but if the code stays unoptimized, revert to the @samp{call},
18218 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18219 potentially-trapping side effect of division by zero is carried by a
18220 separate instruction, so it is possible that all the integer instructions
18221 are hoisted out, but the marker for the side effect stays where it is.
18222 A recombination to floating-point operations or a call is not possible
18223 in that case.
18225 @item inv20u
18226 @itemx inv20l
18227 Variants of the @samp{inv:minlat} strategy.  In the case
18228 that the inverse calculation is not separated from the multiply, they speed
18229 up division where the dividend fits into 20 bits (plus sign where applicable)
18230 by inserting a test to skip a number of operations in this case; this test
18231 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18232 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18234 @end table
18236 @item -maccumulate-outgoing-args
18237 @opindex maccumulate-outgoing-args
18238 Reserve space once for outgoing arguments in the function prologue rather
18239 than around each call.  Generally beneficial for performance and size.  Also
18240 needed for unwinding to avoid changing the stack frame around conditional code.
18242 @item -mdivsi3_libfunc=@var{name}
18243 @opindex mdivsi3_libfunc=@var{name}
18244 Set the name of the library function used for 32-bit signed division to
18245 @var{name}.
18246 This only affects the name used in the @samp{call} and @samp{inv:call}
18247 division strategies, and the compiler still expects the same
18248 sets of input/output/clobbered registers as if this option were not present.
18250 @item -mfixed-range=@var{register-range}
18251 @opindex mfixed-range
18252 Generate code treating the given register range as fixed registers.
18253 A fixed register is one that the register allocator can not use.  This is
18254 useful when compiling kernel code.  A register range is specified as
18255 two registers separated by a dash.  Multiple register ranges can be
18256 specified separated by a comma.
18258 @item -mindexed-addressing
18259 @opindex mindexed-addressing
18260 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18261 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18262 semantics for the indexed addressing mode.  The architecture allows the
18263 implementation of processors with 64-bit MMU, which the OS could use to
18264 get 32-bit addressing, but since no current hardware implementation supports
18265 this or any other way to make the indexed addressing mode safe to use in
18266 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18268 @item -mgettrcost=@var{number}
18269 @opindex mgettrcost=@var{number}
18270 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18271 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18273 @item -mpt-fixed
18274 @opindex mpt-fixed
18275 Assume @code{pt*} instructions won't trap.  This generally generates
18276 better-scheduled code, but is unsafe on current hardware.
18277 The current architecture
18278 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18279 anded with 3 is 3.
18280 This has the unintentional effect of making it unsafe to schedule these
18281 instructions before a branch, or hoist them out of a loop.  For example,
18282 @code{__do_global_ctors}, a part of @file{libgcc}
18283 that runs constructors at program
18284 startup, calls functions in a list which is delimited by @minus{}1.  With the
18285 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18286 That means that all the constructors run a bit more quickly, but when
18287 the loop comes to the end of the list, the program crashes because @code{ptabs}
18288 loads @minus{}1 into a target register.  
18290 Since this option is unsafe for any
18291 hardware implementing the current architecture specification, the default
18292 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18293 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18294 this deters register allocation from using target registers for storing
18295 ordinary integers.
18297 @item -minvalid-symbols
18298 @opindex minvalid-symbols
18299 Assume symbols might be invalid.  Ordinary function symbols generated by
18300 the compiler are always valid to load with
18301 @code{movi}/@code{shori}/@code{ptabs} or
18302 @code{movi}/@code{shori}/@code{ptrel},
18303 but with assembler and/or linker tricks it is possible
18304 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18305 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18306 It prevents cross-basic-block CSE, hoisting and most scheduling
18307 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18309 @item -mbranch-cost=@var{num}
18310 @opindex mbranch-cost=@var{num}
18311 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18312 make the compiler try to generate more branch-free code if possible.  
18313 If not specified the value is selected depending on the processor type that
18314 is being compiled for.
18316 @item -mzdcbranch
18317 @itemx -mno-zdcbranch
18318 @opindex mzdcbranch
18319 @opindex mno-zdcbranch
18320 Assume (do not assume) that zero displacement conditional branch instructions
18321 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
18322 compiler will try to prefer zero displacement branch code sequences.  This is
18323 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
18324 disabled by specifying @option{-mno-zdcbranch}.
18326 @item -mcbranchdi
18327 @opindex mcbranchdi
18328 Enable the @code{cbranchdi4} instruction pattern.
18330 @item -mcmpeqdi
18331 @opindex mcmpeqdi
18332 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18333 is in effect.
18335 @item -mfused-madd
18336 @itemx -mno-fused-madd
18337 @opindex mfused-madd
18338 @opindex mno-fused-madd
18339 Generate code that uses (does not use) the floating-point multiply and
18340 accumulate instructions.  These instructions are generated by default
18341 if hardware floating point is used.  The machine-dependent
18342 @option{-mfused-madd} option is now mapped to the machine-independent
18343 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18344 mapped to @option{-ffp-contract=off}.
18346 @item -mfsca
18347 @itemx -mno-fsca
18348 @opindex mfsca
18349 @opindex mno-fsca
18350 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18351 and cosine approximations.  The option @code{-mfsca} must be used in
18352 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
18353 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
18354 approximations even if @code{-funsafe-math-optimizations} is in effect.
18356 @item -mfsrra
18357 @itemx -mno-fsrra
18358 @opindex mfsrra
18359 @opindex mno-fsrra
18360 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18361 reciprocal square root approximations.  The option @code{-mfsrra} must be used
18362 in combination with @code{-funsafe-math-optimizations} and
18363 @code{-ffinite-math-only}.  It is enabled by default when generating code for
18364 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
18365 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18366 in effect.
18368 @item -mpretend-cmove
18369 @opindex mpretend-cmove
18370 Prefer zero-displacement conditional branches for conditional move instruction
18371 patterns.  This can result in faster code on the SH4 processor.
18373 @end table
18375 @node Solaris 2 Options
18376 @subsection Solaris 2 Options
18377 @cindex Solaris 2 options
18379 These @samp{-m} options are supported on Solaris 2:
18381 @table @gcctabopt
18382 @item -mimpure-text
18383 @opindex mimpure-text
18384 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18385 the compiler to not pass @option{-z text} to the linker when linking a
18386 shared object.  Using this option, you can link position-dependent
18387 code into a shared object.
18389 @option{-mimpure-text} suppresses the ``relocations remain against
18390 allocatable but non-writable sections'' linker error message.
18391 However, the necessary relocations trigger copy-on-write, and the
18392 shared object is not actually shared across processes.  Instead of
18393 using @option{-mimpure-text}, you should compile all source code with
18394 @option{-fpic} or @option{-fPIC}.
18396 @end table
18398 These switches are supported in addition to the above on Solaris 2:
18400 @table @gcctabopt
18401 @item -pthreads
18402 @opindex pthreads
18403 Add support for multithreading using the POSIX threads library.  This
18404 option sets flags for both the preprocessor and linker.  This option does
18405 not affect the thread safety of object code produced  by the compiler or
18406 that of libraries supplied with it.
18408 @item -pthread
18409 @opindex pthread
18410 This is a synonym for @option{-pthreads}.
18411 @end table
18413 @node SPARC Options
18414 @subsection SPARC Options
18415 @cindex SPARC options
18417 These @samp{-m} options are supported on the SPARC:
18419 @table @gcctabopt
18420 @item -mno-app-regs
18421 @itemx -mapp-regs
18422 @opindex mno-app-regs
18423 @opindex mapp-regs
18424 Specify @option{-mapp-regs} to generate output using the global registers
18425 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18426 is the default.
18428 To be fully SVR4 ABI compliant at the cost of some performance loss,
18429 specify @option{-mno-app-regs}.  You should compile libraries and system
18430 software with this option.
18432 @item -mflat
18433 @itemx -mno-flat
18434 @opindex mflat
18435 @opindex mno-flat
18436 With @option{-mflat}, the compiler does not generate save/restore instructions
18437 and uses a ``flat'' or single register window model.  This model is compatible
18438 with the regular register window model.  The local registers and the input
18439 registers (0--5) are still treated as ``call-saved'' registers and are
18440 saved on the stack as needed.
18442 With @option{-mno-flat} (the default), the compiler generates save/restore
18443 instructions (except for leaf functions).  This is the normal operating mode.
18445 @item -mfpu
18446 @itemx -mhard-float
18447 @opindex mfpu
18448 @opindex mhard-float
18449 Generate output containing floating-point instructions.  This is the
18450 default.
18452 @item -mno-fpu
18453 @itemx -msoft-float
18454 @opindex mno-fpu
18455 @opindex msoft-float
18456 Generate output containing library calls for floating point.
18457 @strong{Warning:} the requisite libraries are not available for all SPARC
18458 targets.  Normally the facilities of the machine's usual C compiler are
18459 used, but this cannot be done directly in cross-compilation.  You must make
18460 your own arrangements to provide suitable library functions for
18461 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18462 @samp{sparclite-*-*} do provide software floating-point support.
18464 @option{-msoft-float} changes the calling convention in the output file;
18465 therefore, it is only useful if you compile @emph{all} of a program with
18466 this option.  In particular, you need to compile @file{libgcc.a}, the
18467 library that comes with GCC, with @option{-msoft-float} in order for
18468 this to work.
18470 @item -mhard-quad-float
18471 @opindex mhard-quad-float
18472 Generate output containing quad-word (long double) floating-point
18473 instructions.
18475 @item -msoft-quad-float
18476 @opindex msoft-quad-float
18477 Generate output containing library calls for quad-word (long double)
18478 floating-point instructions.  The functions called are those specified
18479 in the SPARC ABI@.  This is the default.
18481 As of this writing, there are no SPARC implementations that have hardware
18482 support for the quad-word floating-point instructions.  They all invoke
18483 a trap handler for one of these instructions, and then the trap handler
18484 emulates the effect of the instruction.  Because of the trap handler overhead,
18485 this is much slower than calling the ABI library routines.  Thus the
18486 @option{-msoft-quad-float} option is the default.
18488 @item -mno-unaligned-doubles
18489 @itemx -munaligned-doubles
18490 @opindex mno-unaligned-doubles
18491 @opindex munaligned-doubles
18492 Assume that doubles have 8-byte alignment.  This is the default.
18494 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18495 alignment only if they are contained in another type, or if they have an
18496 absolute address.  Otherwise, it assumes they have 4-byte alignment.
18497 Specifying this option avoids some rare compatibility problems with code
18498 generated by other compilers.  It is not the default because it results
18499 in a performance loss, especially for floating-point code.
18501 @item -mno-faster-structs
18502 @itemx -mfaster-structs
18503 @opindex mno-faster-structs
18504 @opindex mfaster-structs
18505 With @option{-mfaster-structs}, the compiler assumes that structures
18506 should have 8-byte alignment.  This enables the use of pairs of
18507 @code{ldd} and @code{std} instructions for copies in structure
18508 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18509 However, the use of this changed alignment directly violates the SPARC
18510 ABI@.  Thus, it's intended only for use on targets where the developer
18511 acknowledges that their resulting code is not directly in line with
18512 the rules of the ABI@.
18514 @item -mcpu=@var{cpu_type}
18515 @opindex mcpu
18516 Set the instruction set, register set, and instruction scheduling parameters
18517 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
18518 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18519 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18520 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18521 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18522 and @samp{niagara4}.
18524 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18525 which selects the best architecture option for the host processor.
18526 @option{-mcpu=native} has no effect if GCC does not recognize
18527 the processor.
18529 Default instruction scheduling parameters are used for values that select
18530 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
18531 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18533 Here is a list of each supported architecture and their supported
18534 implementations.
18536 @table @asis
18537 @item v7
18538 cypress
18540 @item v8
18541 supersparc, hypersparc, leon
18543 @item sparclite
18544 f930, f934, sparclite86x
18546 @item sparclet
18547 tsc701
18549 @item v9
18550 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18551 @end table
18553 By default (unless configured otherwise), GCC generates code for the V7
18554 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
18555 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18556 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
18557 SPARCStation 1, 2, IPX etc.
18559 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18560 architecture.  The only difference from V7 code is that the compiler emits
18561 the integer multiply and integer divide instructions which exist in SPARC-V8
18562 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
18563 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18564 2000 series.
18566 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18567 the SPARC architecture.  This adds the integer multiply, integer divide step
18568 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18569 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18570 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
18571 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18572 MB86934 chip, which is the more recent SPARClite with FPU@.
18574 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18575 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
18576 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18577 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
18578 optimizes it for the TEMIC SPARClet chip.
18580 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18581 architecture.  This adds 64-bit integer and floating-point move instructions,
18582 3 additional floating-point condition code registers and conditional move
18583 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
18584 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
18585 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18586 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
18587 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18588 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
18589 additionally optimizes it for Sun UltraSPARC T2 chips. With
18590 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18591 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
18592 additionally optimizes it for Sun UltraSPARC T4 chips.
18594 @item -mtune=@var{cpu_type}
18595 @opindex mtune
18596 Set the instruction scheduling parameters for machine type
18597 @var{cpu_type}, but do not set the instruction set or register set that the
18598 option @option{-mcpu=@var{cpu_type}} does.
18600 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18601 @option{-mtune=@var{cpu_type}}, but the only useful values are those
18602 that select a particular CPU implementation.  Those are @samp{cypress},
18603 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
18604 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
18605 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
18606 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
18608 @item -mv8plus
18609 @itemx -mno-v8plus
18610 @opindex mv8plus
18611 @opindex mno-v8plus
18612 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
18613 difference from the V8 ABI is that the global and out registers are
18614 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
18615 mode for all SPARC-V9 processors.
18617 @item -mvis
18618 @itemx -mno-vis
18619 @opindex mvis
18620 @opindex mno-vis
18621 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
18622 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
18624 @item -mvis2
18625 @itemx -mno-vis2
18626 @opindex mvis2
18627 @opindex mno-vis2
18628 With @option{-mvis2}, GCC generates code that takes advantage of
18629 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
18630 default is @option{-mvis2} when targeting a cpu that supports such
18631 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
18632 also sets @option{-mvis}.
18634 @item -mvis3
18635 @itemx -mno-vis3
18636 @opindex mvis3
18637 @opindex mno-vis3
18638 With @option{-mvis3}, GCC generates code that takes advantage of
18639 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
18640 default is @option{-mvis3} when targeting a cpu that supports such
18641 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
18642 also sets @option{-mvis2} and @option{-mvis}.
18644 @item -mpopc
18645 @itemx -mno-popc
18646 @opindex mpopc
18647 @opindex mno-popc
18648 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
18649 population count instruction.  The default is @option{-mpopc}
18650 when targeting a cpu that supports such instructions, such as Niagara-2 and
18651 later.
18653 @item -mfmaf
18654 @itemx -mno-fmaf
18655 @opindex mfmaf
18656 @opindex mno-fmaf
18657 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
18658 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
18659 when targeting a cpu that supports such instructions, such as Niagara-3 and
18660 later.
18662 @item -mfix-at697f
18663 @opindex mfix-at697f
18664 Enable the documented workaround for the single erratum of the Atmel AT697F
18665 processor (which corresponds to erratum #13 of the AT697E processor).
18666 @end table
18668 These @samp{-m} options are supported in addition to the above
18669 on SPARC-V9 processors in 64-bit environments:
18671 @table @gcctabopt
18672 @item -mlittle-endian
18673 @opindex mlittle-endian
18674 Generate code for a processor running in little-endian mode.  It is only
18675 available for a few configurations and most notably not on Solaris and Linux.
18677 @item -m32
18678 @itemx -m64
18679 @opindex m32
18680 @opindex m64
18681 Generate code for a 32-bit or 64-bit environment.
18682 The 32-bit environment sets int, long and pointer to 32 bits.
18683 The 64-bit environment sets int to 32 bits and long and pointer
18684 to 64 bits.
18686 @item -mcmodel=@var{which}
18687 @opindex mcmodel
18688 Set the code model to one of
18690 @table @samp
18691 @item medlow
18692 The Medium/Low code model: 64-bit addresses, programs
18693 must be linked in the low 32 bits of memory.  Programs can be statically
18694 or dynamically linked.
18696 @item medmid
18697 The Medium/Middle code model: 64-bit addresses, programs
18698 must be linked in the low 44 bits of memory, the text and data segments must
18699 be less than 2GB in size and the data segment must be located within 2GB of
18700 the text segment.
18702 @item medany
18703 The Medium/Anywhere code model: 64-bit addresses, programs
18704 may be linked anywhere in memory, the text and data segments must be less
18705 than 2GB in size and the data segment must be located within 2GB of the
18706 text segment.
18708 @item embmedany
18709 The Medium/Anywhere code model for embedded systems:
18710 64-bit addresses, the text and data segments must be less than 2GB in
18711 size, both starting anywhere in memory (determined at link time).  The
18712 global register %g4 points to the base of the data segment.  Programs
18713 are statically linked and PIC is not supported.
18714 @end table
18716 @item -mmemory-model=@var{mem-model}
18717 @opindex mmemory-model
18718 Set the memory model in force on the processor to one of
18720 @table @samp
18721 @item default
18722 The default memory model for the processor and operating system.
18724 @item rmo
18725 Relaxed Memory Order
18727 @item pso
18728 Partial Store Order
18730 @item tso
18731 Total Store Order
18733 @item sc
18734 Sequential Consistency
18735 @end table
18737 These memory models are formally defined in Appendix D of the Sparc V9
18738 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18740 @item -mstack-bias
18741 @itemx -mno-stack-bias
18742 @opindex mstack-bias
18743 @opindex mno-stack-bias
18744 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18745 frame pointer if present, are offset by @minus{}2047 which must be added back
18746 when making stack frame references.  This is the default in 64-bit mode.
18747 Otherwise, assume no such offset is present.
18748 @end table
18750 @node SPU Options
18751 @subsection SPU Options
18752 @cindex SPU options
18754 These @samp{-m} options are supported on the SPU:
18756 @table @gcctabopt
18757 @item -mwarn-reloc
18758 @itemx -merror-reloc
18759 @opindex mwarn-reloc
18760 @opindex merror-reloc
18762 The loader for SPU does not handle dynamic relocations.  By default, GCC
18763 gives an error when it generates code that requires a dynamic
18764 relocation.  @option{-mno-error-reloc} disables the error,
18765 @option{-mwarn-reloc} generates a warning instead.
18767 @item -msafe-dma
18768 @itemx -munsafe-dma
18769 @opindex msafe-dma
18770 @opindex munsafe-dma
18772 Instructions that initiate or test completion of DMA must not be
18773 reordered with respect to loads and stores of the memory that is being
18774 accessed.
18775 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
18776 memory accesses, but that can lead to inefficient code in places where the
18777 memory is known to not change.  Rather than mark the memory as volatile,
18778 you can use @option{-msafe-dma} to tell the compiler to treat
18779 the DMA instructions as potentially affecting all memory.  
18781 @item -mbranch-hints
18782 @opindex mbranch-hints
18784 By default, GCC generates a branch hint instruction to avoid
18785 pipeline stalls for always-taken or probably-taken branches.  A hint
18786 is not generated closer than 8 instructions away from its branch.
18787 There is little reason to disable them, except for debugging purposes,
18788 or to make an object a little bit smaller.
18790 @item -msmall-mem
18791 @itemx -mlarge-mem
18792 @opindex msmall-mem
18793 @opindex mlarge-mem
18795 By default, GCC generates code assuming that addresses are never larger
18796 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
18797 a full 32-bit address.
18799 @item -mstdmain
18800 @opindex mstdmain
18802 By default, GCC links against startup code that assumes the SPU-style
18803 main function interface (which has an unconventional parameter list).
18804 With @option{-mstdmain}, GCC links your program against startup
18805 code that assumes a C99-style interface to @code{main}, including a
18806 local copy of @code{argv} strings.
18808 @item -mfixed-range=@var{register-range}
18809 @opindex mfixed-range
18810 Generate code treating the given register range as fixed registers.
18811 A fixed register is one that the register allocator can not use.  This is
18812 useful when compiling kernel code.  A register range is specified as
18813 two registers separated by a dash.  Multiple register ranges can be
18814 specified separated by a comma.
18816 @item -mea32
18817 @itemx -mea64
18818 @opindex mea32
18819 @opindex mea64
18820 Compile code assuming that pointers to the PPU address space accessed
18821 via the @code{__ea} named address space qualifier are either 32 or 64
18822 bits wide.  The default is 32 bits.  As this is an ABI changing option,
18823 all object code in an executable must be compiled with the same setting.
18825 @item -maddress-space-conversion
18826 @itemx -mno-address-space-conversion
18827 @opindex maddress-space-conversion
18828 @opindex mno-address-space-conversion
18829 Allow/disallow treating the @code{__ea} address space as superset
18830 of the generic address space.  This enables explicit type casts
18831 between @code{__ea} and generic pointer as well as implicit
18832 conversions of generic pointers to @code{__ea} pointers.  The
18833 default is to allow address space pointer conversions.
18835 @item -mcache-size=@var{cache-size}
18836 @opindex mcache-size
18837 This option controls the version of libgcc that the compiler links to an
18838 executable and selects a software-managed cache for accessing variables
18839 in the @code{__ea} address space with a particular cache size.  Possible
18840 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18841 and @samp{128}.  The default cache size is 64KB.
18843 @item -matomic-updates
18844 @itemx -mno-atomic-updates
18845 @opindex matomic-updates
18846 @opindex mno-atomic-updates
18847 This option controls the version of libgcc that the compiler links to an
18848 executable and selects whether atomic updates to the software-managed
18849 cache of PPU-side variables are used.  If you use atomic updates, changes
18850 to a PPU variable from SPU code using the @code{__ea} named address space
18851 qualifier do not interfere with changes to other PPU variables residing
18852 in the same cache line from PPU code.  If you do not use atomic updates,
18853 such interference may occur; however, writing back cache lines is
18854 more efficient.  The default behavior is to use atomic updates.
18856 @item -mdual-nops
18857 @itemx -mdual-nops=@var{n}
18858 @opindex mdual-nops
18859 By default, GCC inserts nops to increase dual issue when it expects
18860 it to increase performance.  @var{n} can be a value from 0 to 10.  A
18861 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
18862 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
18864 @item -mhint-max-nops=@var{n}
18865 @opindex mhint-max-nops
18866 Maximum number of nops to insert for a branch hint.  A branch hint must
18867 be at least 8 instructions away from the branch it is affecting.  GCC
18868 inserts up to @var{n} nops to enforce this, otherwise it does not
18869 generate the branch hint.
18871 @item -mhint-max-distance=@var{n}
18872 @opindex mhint-max-distance
18873 The encoding of the branch hint instruction limits the hint to be within
18874 256 instructions of the branch it is affecting.  By default, GCC makes
18875 sure it is within 125.
18877 @item -msafe-hints
18878 @opindex msafe-hints
18879 Work around a hardware bug that causes the SPU to stall indefinitely.
18880 By default, GCC inserts the @code{hbrp} instruction to make sure
18881 this stall won't happen.
18883 @end table
18885 @node System V Options
18886 @subsection Options for System V
18888 These additional options are available on System V Release 4 for
18889 compatibility with other compilers on those systems:
18891 @table @gcctabopt
18892 @item -G
18893 @opindex G
18894 Create a shared object.
18895 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18897 @item -Qy
18898 @opindex Qy
18899 Identify the versions of each tool used by the compiler, in a
18900 @code{.ident} assembler directive in the output.
18902 @item -Qn
18903 @opindex Qn
18904 Refrain from adding @code{.ident} directives to the output file (this is
18905 the default).
18907 @item -YP,@var{dirs}
18908 @opindex YP
18909 Search the directories @var{dirs}, and no others, for libraries
18910 specified with @option{-l}.
18912 @item -Ym,@var{dir}
18913 @opindex Ym
18914 Look in the directory @var{dir} to find the M4 preprocessor.
18915 The assembler uses this option.
18916 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18917 @c the generic assembler that comes with Solaris takes just -Ym.
18918 @end table
18920 @node TILE-Gx Options
18921 @subsection TILE-Gx Options
18922 @cindex TILE-Gx options
18924 These @samp{-m} options are supported on the TILE-Gx:
18926 @table @gcctabopt
18927 @item -mcpu=@var{name}
18928 @opindex mcpu
18929 Selects the type of CPU to be targeted.  Currently the only supported
18930 type is @samp{tilegx}.
18932 @item -m32
18933 @itemx -m64
18934 @opindex m32
18935 @opindex m64
18936 Generate code for a 32-bit or 64-bit environment.  The 32-bit
18937 environment sets int, long, and pointer to 32 bits.  The 64-bit
18938 environment sets int to 32 bits and long and pointer to 64 bits.
18939 @end table
18941 @node TILEPro Options
18942 @subsection TILEPro Options
18943 @cindex TILEPro options
18945 These @samp{-m} options are supported on the TILEPro:
18947 @table @gcctabopt
18948 @item -mcpu=@var{name}
18949 @opindex mcpu
18950 Selects the type of CPU to be targeted.  Currently the only supported
18951 type is @samp{tilepro}.
18953 @item -m32
18954 @opindex m32
18955 Generate code for a 32-bit environment, which sets int, long, and
18956 pointer to 32 bits.  This is the only supported behavior so the flag
18957 is essentially ignored.
18958 @end table
18960 @node V850 Options
18961 @subsection V850 Options
18962 @cindex V850 Options
18964 These @samp{-m} options are defined for V850 implementations:
18966 @table @gcctabopt
18967 @item -mlong-calls
18968 @itemx -mno-long-calls
18969 @opindex mlong-calls
18970 @opindex mno-long-calls
18971 Treat all calls as being far away (near).  If calls are assumed to be
18972 far away, the compiler always loads the function's address into a
18973 register, and calls indirect through the pointer.
18975 @item -mno-ep
18976 @itemx -mep
18977 @opindex mno-ep
18978 @opindex mep
18979 Do not optimize (do optimize) basic blocks that use the same index
18980 pointer 4 or more times to copy pointer into the @code{ep} register, and
18981 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
18982 option is on by default if you optimize.
18984 @item -mno-prolog-function
18985 @itemx -mprolog-function
18986 @opindex mno-prolog-function
18987 @opindex mprolog-function
18988 Do not use (do use) external functions to save and restore registers
18989 at the prologue and epilogue of a function.  The external functions
18990 are slower, but use less code space if more than one function saves
18991 the same number of registers.  The @option{-mprolog-function} option
18992 is on by default if you optimize.
18994 @item -mspace
18995 @opindex mspace
18996 Try to make the code as small as possible.  At present, this just turns
18997 on the @option{-mep} and @option{-mprolog-function} options.
18999 @item -mtda=@var{n}
19000 @opindex mtda
19001 Put static or global variables whose size is @var{n} bytes or less into
19002 the tiny data area that register @code{ep} points to.  The tiny data
19003 area can hold up to 256 bytes in total (128 bytes for byte references).
19005 @item -msda=@var{n}
19006 @opindex msda
19007 Put static or global variables whose size is @var{n} bytes or less into
19008 the small data area that register @code{gp} points to.  The small data
19009 area can hold up to 64 kilobytes.
19011 @item -mzda=@var{n}
19012 @opindex mzda
19013 Put static or global variables whose size is @var{n} bytes or less into
19014 the first 32 kilobytes of memory.
19016 @item -mv850
19017 @opindex mv850
19018 Specify that the target processor is the V850.
19020 @item -mbig-switch
19021 @opindex mbig-switch
19022 Generate code suitable for big switch tables.  Use this option only if
19023 the assembler/linker complain about out of range branches within a switch
19024 table.
19026 @item -mapp-regs
19027 @opindex mapp-regs
19028 This option causes r2 and r5 to be used in the code generated by
19029 the compiler.  This setting is the default.
19031 @item -mno-app-regs
19032 @opindex mno-app-regs
19033 This option causes r2 and r5 to be treated as fixed registers.
19035 @item -mv850e2v3
19036 @opindex mv850e2v3
19037 Specify that the target processor is the V850E2V3.  The preprocessor
19038 constant @samp{__v850e2v3__} is defined if
19039 this option is used.
19041 @item -mv850e2
19042 @opindex mv850e2
19043 Specify that the target processor is the V850E2.  The preprocessor
19044 constant @samp{__v850e2__} is defined if this option is used.
19046 @item -mv850e1
19047 @opindex mv850e1
19048 Specify that the target processor is the V850E1.  The preprocessor
19049 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19050 this option is used.
19052 @item -mv850es
19053 @opindex mv850es
19054 Specify that the target processor is the V850ES.  This is an alias for
19055 the @option{-mv850e1} option.
19057 @item -mv850e
19058 @opindex mv850e
19059 Specify that the target processor is the V850E@.  The preprocessor
19060 constant @samp{__v850e__} is defined if this option is used.
19062 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19063 nor @option{-mv850e2} nor @option{-mv850e2v3}
19064 are defined then a default target processor is chosen and the
19065 relevant @samp{__v850*__} preprocessor constant is defined.
19067 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19068 defined, regardless of which processor variant is the target.
19070 @item -mdisable-callt
19071 @opindex mdisable-callt
19072 This option suppresses generation of the @code{CALLT} instruction for the
19073 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
19074 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19076 @end table
19078 @node VAX Options
19079 @subsection VAX Options
19080 @cindex VAX options
19082 These @samp{-m} options are defined for the VAX:
19084 @table @gcctabopt
19085 @item -munix
19086 @opindex munix
19087 Do not output certain jump instructions (@code{aobleq} and so on)
19088 that the Unix assembler for the VAX cannot handle across long
19089 ranges.
19091 @item -mgnu
19092 @opindex mgnu
19093 Do output those jump instructions, on the assumption that the
19094 GNU assembler is being used.
19096 @item -mg
19097 @opindex mg
19098 Output code for G-format floating-point numbers instead of D-format.
19099 @end table
19101 @node VMS Options
19102 @subsection VMS Options
19104 These @samp{-m} options are defined for the VMS implementations:
19106 @table @gcctabopt
19107 @item -mvms-return-codes
19108 @opindex mvms-return-codes
19109 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19110 condition (e.g.@ error) codes.
19112 @item -mdebug-main=@var{prefix}
19113 @opindex mdebug-main=@var{prefix}
19114 Flag the first routine whose name starts with @var{prefix} as the main
19115 routine for the debugger.
19117 @item -mmalloc64
19118 @opindex mmalloc64
19119 Default to 64-bit memory allocation routines.
19121 @item -mpointer-size=@var{size}
19122 @opindex -mpointer-size=@var{size}
19123 Set the default size of pointers. Possible options for @var{size} are
19124 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19125 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19126 The later option disables @code{pragma pointer_size}.
19127 @end table
19129 @node VxWorks Options
19130 @subsection VxWorks Options
19131 @cindex VxWorks Options
19133 The options in this section are defined for all VxWorks targets.
19134 Options specific to the target hardware are listed with the other
19135 options for that target.
19137 @table @gcctabopt
19138 @item -mrtp
19139 @opindex mrtp
19140 GCC can generate code for both VxWorks kernels and real time processes
19141 (RTPs).  This option switches from the former to the latter.  It also
19142 defines the preprocessor macro @code{__RTP__}.
19144 @item -non-static
19145 @opindex non-static
19146 Link an RTP executable against shared libraries rather than static
19147 libraries.  The options @option{-static} and @option{-shared} can
19148 also be used for RTPs (@pxref{Link Options}); @option{-static}
19149 is the default.
19151 @item -Bstatic
19152 @itemx -Bdynamic
19153 @opindex Bstatic
19154 @opindex Bdynamic
19155 These options are passed down to the linker.  They are defined for
19156 compatibility with Diab.
19158 @item -Xbind-lazy
19159 @opindex Xbind-lazy
19160 Enable lazy binding of function calls.  This option is equivalent to
19161 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19163 @item -Xbind-now
19164 @opindex Xbind-now
19165 Disable lazy binding of function calls.  This option is the default and
19166 is defined for compatibility with Diab.
19167 @end table
19169 @node x86-64 Options
19170 @subsection x86-64 Options
19171 @cindex x86-64 options
19173 These are listed under @xref{i386 and x86-64 Options}.
19175 @node Xstormy16 Options
19176 @subsection Xstormy16 Options
19177 @cindex Xstormy16 Options
19179 These options are defined for Xstormy16:
19181 @table @gcctabopt
19182 @item -msim
19183 @opindex msim
19184 Choose startup files and linker script suitable for the simulator.
19185 @end table
19187 @node Xtensa Options
19188 @subsection Xtensa Options
19189 @cindex Xtensa Options
19191 These options are supported for Xtensa targets:
19193 @table @gcctabopt
19194 @item -mconst16
19195 @itemx -mno-const16
19196 @opindex mconst16
19197 @opindex mno-const16
19198 Enable or disable use of @code{CONST16} instructions for loading
19199 constant values.  The @code{CONST16} instruction is currently not a
19200 standard option from Tensilica.  When enabled, @code{CONST16}
19201 instructions are always used in place of the standard @code{L32R}
19202 instructions.  The use of @code{CONST16} is enabled by default only if
19203 the @code{L32R} instruction is not available.
19205 @item -mfused-madd
19206 @itemx -mno-fused-madd
19207 @opindex mfused-madd
19208 @opindex mno-fused-madd
19209 Enable or disable use of fused multiply/add and multiply/subtract
19210 instructions in the floating-point option.  This has no effect if the
19211 floating-point option is not also enabled.  Disabling fused multiply/add
19212 and multiply/subtract instructions forces the compiler to use separate
19213 instructions for the multiply and add/subtract operations.  This may be
19214 desirable in some cases where strict IEEE 754-compliant results are
19215 required: the fused multiply add/subtract instructions do not round the
19216 intermediate result, thereby producing results with @emph{more} bits of
19217 precision than specified by the IEEE standard.  Disabling fused multiply
19218 add/subtract instructions also ensures that the program output is not
19219 sensitive to the compiler's ability to combine multiply and add/subtract
19220 operations.
19222 @item -mserialize-volatile
19223 @itemx -mno-serialize-volatile
19224 @opindex mserialize-volatile
19225 @opindex mno-serialize-volatile
19226 When this option is enabled, GCC inserts @code{MEMW} instructions before
19227 @code{volatile} memory references to guarantee sequential consistency.
19228 The default is @option{-mserialize-volatile}.  Use
19229 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19231 @item -mforce-no-pic
19232 @opindex mforce-no-pic
19233 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19234 position-independent code (PIC), this option disables PIC for compiling
19235 kernel code.
19237 @item -mtext-section-literals
19238 @itemx -mno-text-section-literals
19239 @opindex mtext-section-literals
19240 @opindex mno-text-section-literals
19241 Control the treatment of literal pools.  The default is
19242 @option{-mno-text-section-literals}, which places literals in a separate
19243 section in the output file.  This allows the literal pool to be placed
19244 in a data RAM/ROM, and it also allows the linker to combine literal
19245 pools from separate object files to remove redundant literals and
19246 improve code size.  With @option{-mtext-section-literals}, the literals
19247 are interspersed in the text section in order to keep them as close as
19248 possible to their references.  This may be necessary for large assembly
19249 files.
19251 @item -mtarget-align
19252 @itemx -mno-target-align
19253 @opindex mtarget-align
19254 @opindex mno-target-align
19255 When this option is enabled, GCC instructs the assembler to
19256 automatically align instructions to reduce branch penalties at the
19257 expense of some code density.  The assembler attempts to widen density
19258 instructions to align branch targets and the instructions following call
19259 instructions.  If there are not enough preceding safe density
19260 instructions to align a target, no widening is performed.  The
19261 default is @option{-mtarget-align}.  These options do not affect the
19262 treatment of auto-aligned instructions like @code{LOOP}, which the
19263 assembler always aligns, either by widening density instructions or
19264 by inserting NOP instructions.
19266 @item -mlongcalls
19267 @itemx -mno-longcalls
19268 @opindex mlongcalls
19269 @opindex mno-longcalls
19270 When this option is enabled, GCC instructs the assembler to translate
19271 direct calls to indirect calls unless it can determine that the target
19272 of a direct call is in the range allowed by the call instruction.  This
19273 translation typically occurs for calls to functions in other source
19274 files.  Specifically, the assembler translates a direct @code{CALL}
19275 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19276 The default is @option{-mno-longcalls}.  This option should be used in
19277 programs where the call target can potentially be out of range.  This
19278 option is implemented in the assembler, not the compiler, so the
19279 assembly code generated by GCC still shows direct call
19280 instructions---look at the disassembled object code to see the actual
19281 instructions.  Note that the assembler uses an indirect call for
19282 every cross-file call, not just those that really are out of range.
19283 @end table
19285 @node zSeries Options
19286 @subsection zSeries Options
19287 @cindex zSeries options
19289 These are listed under @xref{S/390 and zSeries Options}.
19291 @node Code Gen Options
19292 @section Options for Code Generation Conventions
19293 @cindex code generation conventions
19294 @cindex options, code generation
19295 @cindex run-time options
19297 These machine-independent options control the interface conventions
19298 used in code generation.
19300 Most of them have both positive and negative forms; the negative form
19301 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
19302 one of the forms is listed---the one that is not the default.  You
19303 can figure out the other form by either removing @samp{no-} or adding
19306 @table @gcctabopt
19307 @item -fbounds-check
19308 @opindex fbounds-check
19309 For front ends that support it, generate additional code to check that
19310 indices used to access arrays are within the declared range.  This is
19311 currently only supported by the Java and Fortran front ends, where
19312 this option defaults to true and false respectively.
19314 @item -fstack-reuse=@var{reuse-level}
19315 @opindex fstack_reuse
19316 This option controls stack space reuse for user declared local/auto variables
19317 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
19318 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
19319 local variables and temporaries, @samp{named_vars} enables the reuse only for
19320 user defined local variables with names, and @samp{none} disables stack reuse
19321 completely. The default value is @samp{all}. The option is needed when the
19322 program extends the lifetime of a scoped local variable or a compiler generated
19323 temporary beyond the end point defined by the language.  When a lifetime of
19324 a variable ends, and if the variable lives in memory, the optimizing compiler
19325 has the freedom to reuse its stack space with other temporaries or scoped
19326 local variables whose live range does not overlap with it. Legacy code extending
19327 local lifetime will likely to break with the stack reuse optimization.
19329 For example,
19331 @smallexample
19332    int *p;
19333    @{
19334      int local1;
19336      p = &local1;
19337      local1 = 10;
19338      ....
19339    @}
19340    @{
19341       int local2;
19342       local2 = 20;
19343       ...
19344    @}
19346    if (*p == 10)  // out of scope use of local1
19347      @{
19349      @}
19350 @end smallexample
19352 Another example:
19353 @smallexample
19355    struct A
19356    @{
19357        A(int k) : i(k), j(k) @{ @}
19358        int i;
19359        int j;
19360    @};
19362    A *ap;
19364    void foo(const A& ar)
19365    @{
19366       ap = &ar;
19367    @}
19369    void bar()
19370    @{
19371       foo(A(10)); // temp object's lifetime ends when foo returns
19373       @{
19374         A a(20);
19375         ....
19376       @}
19377       ap->i+= 10;  // ap references out of scope temp whose space
19378                    // is reused with a. What is the value of ap->i?
19379    @}
19381 @end smallexample
19383 The lifetime of a compiler generated temporary is well defined by the C++
19384 standard. When a lifetime of a temporary ends, and if the temporary lives
19385 in memory, the optimizing compiler has the freedom to reuse its stack
19386 space with other temporaries or scoped local variables whose live range
19387 does not overlap with it. However some of the legacy code relies on
19388 the behavior of older compilers in which temporaries' stack space is
19389 not reused, the aggressive stack reuse can lead to runtime errors. This
19390 option is used to control the temporary stack reuse optimization.
19392 @item -ftrapv
19393 @opindex ftrapv
19394 This option generates traps for signed overflow on addition, subtraction,
19395 multiplication operations.
19397 @item -fwrapv
19398 @opindex fwrapv
19399 This option instructs the compiler to assume that signed arithmetic
19400 overflow of addition, subtraction and multiplication wraps around
19401 using twos-complement representation.  This flag enables some optimizations
19402 and disables others.  This option is enabled by default for the Java
19403 front end, as required by the Java language specification.
19405 @item -fexceptions
19406 @opindex fexceptions
19407 Enable exception handling.  Generates extra code needed to propagate
19408 exceptions.  For some targets, this implies GCC generates frame
19409 unwind information for all functions, which can produce significant data
19410 size overhead, although it does not affect execution.  If you do not
19411 specify this option, GCC enables it by default for languages like
19412 C++ that normally require exception handling, and disables it for
19413 languages like C that do not normally require it.  However, you may need
19414 to enable this option when compiling C code that needs to interoperate
19415 properly with exception handlers written in C++.  You may also wish to
19416 disable this option if you are compiling older C++ programs that don't
19417 use exception handling.
19419 @item -fnon-call-exceptions
19420 @opindex fnon-call-exceptions
19421 Generate code that allows trapping instructions to throw exceptions.
19422 Note that this requires platform-specific runtime support that does
19423 not exist everywhere.  Moreover, it only allows @emph{trapping}
19424 instructions to throw exceptions, i.e.@: memory references or floating-point
19425 instructions.  It does not allow exceptions to be thrown from
19426 arbitrary signal handlers such as @code{SIGALRM}.
19428 @item -fdelete-dead-exceptions
19429 @opindex fdelete-dead-exceptions
19430 Consider that instructions that may throw exceptions but don't otherwise
19431 contribute to the execution of the program can be optimized away.
19432 This option is enabled by default for the Ada front end, as permitted by
19433 the Ada language specification.
19434 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19436 @item -funwind-tables
19437 @opindex funwind-tables
19438 Similar to @option{-fexceptions}, except that it just generates any needed
19439 static data, but does not affect the generated code in any other way.
19440 You normally do not need to enable this option; instead, a language processor
19441 that needs this handling enables it on your behalf.
19443 @item -fasynchronous-unwind-tables
19444 @opindex fasynchronous-unwind-tables
19445 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19446 table is exact at each instruction boundary, so it can be used for stack
19447 unwinding from asynchronous events (such as debugger or garbage collector).
19449 @item -fpcc-struct-return
19450 @opindex fpcc-struct-return
19451 Return ``short'' @code{struct} and @code{union} values in memory like
19452 longer ones, rather than in registers.  This convention is less
19453 efficient, but it has the advantage of allowing intercallability between
19454 GCC-compiled files and files compiled with other compilers, particularly
19455 the Portable C Compiler (pcc).
19457 The precise convention for returning structures in memory depends
19458 on the target configuration macros.
19460 Short structures and unions are those whose size and alignment match
19461 that of some integer type.
19463 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19464 switch is not binary compatible with code compiled with the
19465 @option{-freg-struct-return} switch.
19466 Use it to conform to a non-default application binary interface.
19468 @item -freg-struct-return
19469 @opindex freg-struct-return
19470 Return @code{struct} and @code{union} values in registers when possible.
19471 This is more efficient for small structures than
19472 @option{-fpcc-struct-return}.
19474 If you specify neither @option{-fpcc-struct-return} nor
19475 @option{-freg-struct-return}, GCC defaults to whichever convention is
19476 standard for the target.  If there is no standard convention, GCC
19477 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19478 the principal compiler.  In those cases, we can choose the standard, and
19479 we chose the more efficient register return alternative.
19481 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19482 switch is not binary compatible with code compiled with the
19483 @option{-fpcc-struct-return} switch.
19484 Use it to conform to a non-default application binary interface.
19486 @item -fshort-enums
19487 @opindex fshort-enums
19488 Allocate to an @code{enum} type only as many bytes as it needs for the
19489 declared range of possible values.  Specifically, the @code{enum} type
19490 is equivalent to the smallest integer type that has enough room.
19492 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19493 code that is not binary compatible with code generated without that switch.
19494 Use it to conform to a non-default application binary interface.
19496 @item -fshort-double
19497 @opindex fshort-double
19498 Use the same size for @code{double} as for @code{float}.
19500 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19501 code that is not binary compatible with code generated without that switch.
19502 Use it to conform to a non-default application binary interface.
19504 @item -fshort-wchar
19505 @opindex fshort-wchar
19506 Override the underlying type for @samp{wchar_t} to be @samp{short
19507 unsigned int} instead of the default for the target.  This option is
19508 useful for building programs to run under WINE@.
19510 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19511 code that is not binary compatible with code generated without that switch.
19512 Use it to conform to a non-default application binary interface.
19514 @item -fno-common
19515 @opindex fno-common
19516 In C code, controls the placement of uninitialized global variables.
19517 Unix C compilers have traditionally permitted multiple definitions of
19518 such variables in different compilation units by placing the variables
19519 in a common block.
19520 This is the behavior specified by @option{-fcommon}, and is the default
19521 for GCC on most targets.
19522 On the other hand, this behavior is not required by ISO C, and on some
19523 targets may carry a speed or code size penalty on variable references.
19524 The @option{-fno-common} option specifies that the compiler should place
19525 uninitialized global variables in the data section of the object file,
19526 rather than generating them as common blocks.
19527 This has the effect that if the same variable is declared
19528 (without @code{extern}) in two different compilations,
19529 you get a multiple-definition error when you link them.
19530 In this case, you must compile with @option{-fcommon} instead.
19531 Compiling with @option{-fno-common} is useful on targets for which
19532 it provides better performance, or if you wish to verify that the
19533 program will work on other systems that always treat uninitialized
19534 variable declarations this way.
19536 @item -fno-ident
19537 @opindex fno-ident
19538 Ignore the @samp{#ident} directive.
19540 @item -finhibit-size-directive
19541 @opindex finhibit-size-directive
19542 Don't output a @code{.size} assembler directive, or anything else that
19543 would cause trouble if the function is split in the middle, and the
19544 two halves are placed at locations far apart in memory.  This option is
19545 used when compiling @file{crtstuff.c}; you should not need to use it
19546 for anything else.
19548 @item -fverbose-asm
19549 @opindex fverbose-asm
19550 Put extra commentary information in the generated assembly code to
19551 make it more readable.  This option is generally only of use to those
19552 who actually need to read the generated assembly code (perhaps while
19553 debugging the compiler itself).
19555 @option{-fno-verbose-asm}, the default, causes the
19556 extra information to be omitted and is useful when comparing two assembler
19557 files.
19559 @item -frecord-gcc-switches
19560 @opindex frecord-gcc-switches
19561 This switch causes the command line used to invoke the
19562 compiler to be recorded into the object file that is being created.
19563 This switch is only implemented on some targets and the exact format
19564 of the recording is target and binary file format dependent, but it
19565 usually takes the form of a section containing ASCII text.  This
19566 switch is related to the @option{-fverbose-asm} switch, but that
19567 switch only records information in the assembler output file as
19568 comments, so it never reaches the object file.
19569 See also @option{-grecord-gcc-switches} for another
19570 way of storing compiler options into the object file.
19572 @item -fpic
19573 @opindex fpic
19574 @cindex global offset table
19575 @cindex PIC
19576 Generate position-independent code (PIC) suitable for use in a shared
19577 library, if supported for the target machine.  Such code accesses all
19578 constant addresses through a global offset table (GOT)@.  The dynamic
19579 loader resolves the GOT entries when the program starts (the dynamic
19580 loader is not part of GCC; it is part of the operating system).  If
19581 the GOT size for the linked executable exceeds a machine-specific
19582 maximum size, you get an error message from the linker indicating that
19583 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19584 instead.  (These maximums are 8k on the SPARC and 32k
19585 on the m68k and RS/6000.  The 386 has no such limit.)
19587 Position-independent code requires special support, and therefore works
19588 only on certain machines.  For the 386, GCC supports PIC for System V
19589 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
19590 position-independent.
19592 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19593 are defined to 1.
19595 @item -fPIC
19596 @opindex fPIC
19597 If supported for the target machine, emit position-independent code,
19598 suitable for dynamic linking and avoiding any limit on the size of the
19599 global offset table.  This option makes a difference on the m68k,
19600 PowerPC and SPARC@.
19602 Position-independent code requires special support, and therefore works
19603 only on certain machines.
19605 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19606 are defined to 2.
19608 @item -fpie
19609 @itemx -fPIE
19610 @opindex fpie
19611 @opindex fPIE
19612 These options are similar to @option{-fpic} and @option{-fPIC}, but
19613 generated position independent code can be only linked into executables.
19614 Usually these options are used when @option{-pie} GCC option is
19615 used during linking.
19617 @option{-fpie} and @option{-fPIE} both define the macros
19618 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
19619 for @option{-fpie} and 2 for @option{-fPIE}.
19621 @item -fno-jump-tables
19622 @opindex fno-jump-tables
19623 Do not use jump tables for switch statements even where it would be
19624 more efficient than other code generation strategies.  This option is
19625 of use in conjunction with @option{-fpic} or @option{-fPIC} for
19626 building code that forms part of a dynamic linker and cannot
19627 reference the address of a jump table.  On some targets, jump tables
19628 do not require a GOT and this option is not needed.
19630 @item -ffixed-@var{reg}
19631 @opindex ffixed
19632 Treat the register named @var{reg} as a fixed register; generated code
19633 should never refer to it (except perhaps as a stack pointer, frame
19634 pointer or in some other fixed role).
19636 @var{reg} must be the name of a register.  The register names accepted
19637 are machine-specific and are defined in the @code{REGISTER_NAMES}
19638 macro in the machine description macro file.
19640 This flag does not have a negative form, because it specifies a
19641 three-way choice.
19643 @item -fcall-used-@var{reg}
19644 @opindex fcall-used
19645 Treat the register named @var{reg} as an allocable register that is
19646 clobbered by function calls.  It may be allocated for temporaries or
19647 variables that do not live across a call.  Functions compiled this way
19648 do not save and restore the register @var{reg}.
19650 It is an error to use this flag with the frame pointer or stack pointer.
19651 Use of this flag for other registers that have fixed pervasive roles in
19652 the machine's execution model produces disastrous results.
19654 This flag does not have a negative form, because it specifies a
19655 three-way choice.
19657 @item -fcall-saved-@var{reg}
19658 @opindex fcall-saved
19659 Treat the register named @var{reg} as an allocable register saved by
19660 functions.  It may be allocated even for temporaries or variables that
19661 live across a call.  Functions compiled this way save and restore
19662 the register @var{reg} if they use it.
19664 It is an error to use this flag with the frame pointer or stack pointer.
19665 Use of this flag for other registers that have fixed pervasive roles in
19666 the machine's execution model produces disastrous results.
19668 A different sort of disaster results from the use of this flag for
19669 a register in which function values may be returned.
19671 This flag does not have a negative form, because it specifies a
19672 three-way choice.
19674 @item -fpack-struct[=@var{n}]
19675 @opindex fpack-struct
19676 Without a value specified, pack all structure members together without
19677 holes.  When a value is specified (which must be a small power of two), pack
19678 structure members according to this value, representing the maximum
19679 alignment (that is, objects with default alignment requirements larger than
19680 this are output potentially unaligned at the next fitting location.
19682 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
19683 code that is not binary compatible with code generated without that switch.
19684 Additionally, it makes the code suboptimal.
19685 Use it to conform to a non-default application binary interface.
19687 @item -finstrument-functions
19688 @opindex finstrument-functions
19689 Generate instrumentation calls for entry and exit to functions.  Just
19690 after function entry and just before function exit, the following
19691 profiling functions are called with the address of the current
19692 function and its call site.  (On some platforms,
19693 @code{__builtin_return_address} does not work beyond the current
19694 function, so the call site information may not be available to the
19695 profiling functions otherwise.)
19697 @smallexample
19698 void __cyg_profile_func_enter (void *this_fn,
19699                                void *call_site);
19700 void __cyg_profile_func_exit  (void *this_fn,
19701                                void *call_site);
19702 @end smallexample
19704 The first argument is the address of the start of the current function,
19705 which may be looked up exactly in the symbol table.
19707 This instrumentation is also done for functions expanded inline in other
19708 functions.  The profiling calls indicate where, conceptually, the
19709 inline function is entered and exited.  This means that addressable
19710 versions of such functions must be available.  If all your uses of a
19711 function are expanded inline, this may mean an additional expansion of
19712 code size.  If you use @samp{extern inline} in your C code, an
19713 addressable version of such functions must be provided.  (This is
19714 normally the case anyway, but if you get lucky and the optimizer always
19715 expands the functions inline, you might have gotten away without
19716 providing static copies.)
19718 A function may be given the attribute @code{no_instrument_function}, in
19719 which case this instrumentation is not done.  This can be used, for
19720 example, for the profiling functions listed above, high-priority
19721 interrupt routines, and any functions from which the profiling functions
19722 cannot safely be called (perhaps signal handlers, if the profiling
19723 routines generate output or allocate memory).
19725 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
19726 @opindex finstrument-functions-exclude-file-list
19728 Set the list of functions that are excluded from instrumentation (see
19729 the description of @code{-finstrument-functions}).  If the file that
19730 contains a function definition matches with one of @var{file}, then
19731 that function is not instrumented.  The match is done on substrings:
19732 if the @var{file} parameter is a substring of the file name, it is
19733 considered to be a match.
19735 For example:
19737 @smallexample
19738 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
19739 @end smallexample
19741 @noindent
19742 excludes any inline function defined in files whose pathnames
19743 contain @code{/bits/stl} or @code{include/sys}.
19745 If, for some reason, you want to include letter @code{','} in one of
19746 @var{sym}, write @code{'\,'}. For example,
19747 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
19748 (note the single quote surrounding the option).
19750 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
19751 @opindex finstrument-functions-exclude-function-list
19753 This is similar to @code{-finstrument-functions-exclude-file-list},
19754 but this option sets the list of function names to be excluded from
19755 instrumentation.  The function name to be matched is its user-visible
19756 name, such as @code{vector<int> blah(const vector<int> &)}, not the
19757 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
19758 match is done on substrings: if the @var{sym} parameter is a substring
19759 of the function name, it is considered to be a match.  For C99 and C++
19760 extended identifiers, the function name must be given in UTF-8, not
19761 using universal character names.
19763 @item -fstack-check
19764 @opindex fstack-check
19765 Generate code to verify that you do not go beyond the boundary of the
19766 stack.  You should specify this flag if you are running in an
19767 environment with multiple threads, but only rarely need to specify it in
19768 a single-threaded environment since stack overflow is automatically
19769 detected on nearly all systems if there is only one stack.
19771 Note that this switch does not actually cause checking to be done; the
19772 operating system or the language runtime must do that.  The switch causes
19773 generation of code to ensure that they see the stack being extended.
19775 You can additionally specify a string parameter: @code{no} means no
19776 checking, @code{generic} means force the use of old-style checking,
19777 @code{specific} means use the best checking method and is equivalent
19778 to bare @option{-fstack-check}.
19780 Old-style checking is a generic mechanism that requires no specific
19781 target support in the compiler but comes with the following drawbacks:
19783 @enumerate
19784 @item
19785 Modified allocation strategy for large objects: they are always
19786 allocated dynamically if their size exceeds a fixed threshold.
19788 @item
19789 Fixed limit on the size of the static frame of functions: when it is
19790 topped by a particular function, stack checking is not reliable and
19791 a warning is issued by the compiler.
19793 @item
19794 Inefficiency: because of both the modified allocation strategy and the
19795 generic implementation, the performances of the code are hampered.
19796 @end enumerate
19798 Note that old-style stack checking is also the fallback method for
19799 @code{specific} if no target support has been added in the compiler.
19801 @item -fstack-limit-register=@var{reg}
19802 @itemx -fstack-limit-symbol=@var{sym}
19803 @itemx -fno-stack-limit
19804 @opindex fstack-limit-register
19805 @opindex fstack-limit-symbol
19806 @opindex fno-stack-limit
19807 Generate code to ensure that the stack does not grow beyond a certain value,
19808 either the value of a register or the address of a symbol.  If a larger
19809 stack is required, a signal is raised at run time.  For most targets,
19810 the signal is raised before the stack overruns the boundary, so
19811 it is possible to catch the signal without taking special precautions.
19813 For instance, if the stack starts at absolute address @samp{0x80000000}
19814 and grows downwards, you can use the flags
19815 @option{-fstack-limit-symbol=__stack_limit} and
19816 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
19817 of 128KB@.  Note that this may only work with the GNU linker.
19819 @item -fsplit-stack
19820 @opindex fsplit-stack
19821 Generate code to automatically split the stack before it overflows.
19822 The resulting program has a discontiguous stack which can only
19823 overflow if the program is unable to allocate any more memory.  This
19824 is most useful when running threaded programs, as it is no longer
19825 necessary to calculate a good stack size to use for each thread.  This
19826 is currently only implemented for the i386 and x86_64 back ends running
19827 GNU/Linux.
19829 When code compiled with @option{-fsplit-stack} calls code compiled
19830 without @option{-fsplit-stack}, there may not be much stack space
19831 available for the latter code to run.  If compiling all code,
19832 including library code, with @option{-fsplit-stack} is not an option,
19833 then the linker can fix up these calls so that the code compiled
19834 without @option{-fsplit-stack} always has a large stack.  Support for
19835 this is implemented in the gold linker in GNU binutils release 2.21
19836 and later.
19838 @item -fleading-underscore
19839 @opindex fleading-underscore
19840 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19841 change the way C symbols are represented in the object file.  One use
19842 is to help link with legacy assembly code.
19844 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19845 generate code that is not binary compatible with code generated without that
19846 switch.  Use it to conform to a non-default application binary interface.
19847 Not all targets provide complete support for this switch.
19849 @item -ftls-model=@var{model}
19850 @opindex ftls-model
19851 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19852 The @var{model} argument should be one of @code{global-dynamic},
19853 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19855 The default without @option{-fpic} is @code{initial-exec}; with
19856 @option{-fpic} the default is @code{global-dynamic}.
19858 @item -fvisibility=@var{default|internal|hidden|protected}
19859 @opindex fvisibility
19860 Set the default ELF image symbol visibility to the specified option---all
19861 symbols are marked with this unless overridden within the code.
19862 Using this feature can very substantially improve linking and
19863 load times of shared object libraries, produce more optimized
19864 code, provide near-perfect API export and prevent symbol clashes.
19865 It is @strong{strongly} recommended that you use this in any shared objects
19866 you distribute.
19868 Despite the nomenclature, @code{default} always means public; i.e.,
19869 available to be linked against from outside the shared object.
19870 @code{protected} and @code{internal} are pretty useless in real-world
19871 usage so the only other commonly used option is @code{hidden}.
19872 The default if @option{-fvisibility} isn't specified is
19873 @code{default}, i.e., make every
19874 symbol public---this causes the same behavior as previous versions of
19875 GCC@.
19877 A good explanation of the benefits offered by ensuring ELF
19878 symbols have the correct visibility is given by ``How To Write
19879 Shared Libraries'' by Ulrich Drepper (which can be found at
19880 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19881 solution made possible by this option to marking things hidden when
19882 the default is public is to make the default hidden and mark things
19883 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19884 and @code{__attribute__ ((visibility("default")))} instead of
19885 @code{__declspec(dllexport)} you get almost identical semantics with
19886 identical syntax.  This is a great boon to those working with
19887 cross-platform projects.
19889 For those adding visibility support to existing code, you may find
19890 @samp{#pragma GCC visibility} of use.  This works by you enclosing
19891 the declarations you wish to set visibility for with (for example)
19892 @samp{#pragma GCC visibility push(hidden)} and
19893 @samp{#pragma GCC visibility pop}.
19894 Bear in mind that symbol visibility should be viewed @strong{as
19895 part of the API interface contract} and thus all new code should
19896 always specify visibility when it is not the default; i.e., declarations
19897 only for use within the local DSO should @strong{always} be marked explicitly
19898 as hidden as so to avoid PLT indirection overheads---making this
19899 abundantly clear also aids readability and self-documentation of the code.
19900 Note that due to ISO C++ specification requirements, @code{operator new} and
19901 @code{operator delete} must always be of default visibility.
19903 Be aware that headers from outside your project, in particular system
19904 headers and headers from any other library you use, may not be
19905 expecting to be compiled with visibility other than the default.  You
19906 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19907 before including any such headers.
19909 @samp{extern} declarations are not affected by @option{-fvisibility}, so
19910 a lot of code can be recompiled with @option{-fvisibility=hidden} with
19911 no modifications.  However, this means that calls to @code{extern}
19912 functions with no explicit visibility use the PLT, so it is more
19913 effective to use @code{__attribute ((visibility))} and/or
19914 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
19915 declarations should be treated as hidden.
19917 Note that @option{-fvisibility} does affect C++ vague linkage
19918 entities. This means that, for instance, an exception class that is
19919 be thrown between DSOs must be explicitly marked with default
19920 visibility so that the @samp{type_info} nodes are unified between
19921 the DSOs.
19923 An overview of these techniques, their benefits and how to use them
19924 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19926 @item -fstrict-volatile-bitfields
19927 @opindex fstrict-volatile-bitfields
19928 This option should be used if accesses to volatile bit-fields (or other
19929 structure fields, although the compiler usually honors those types
19930 anyway) should use a single access of the width of the
19931 field's type, aligned to a natural alignment if possible.  For
19932 example, targets with memory-mapped peripheral registers might require
19933 all such accesses to be 16 bits wide; with this flag the user could
19934 declare all peripheral bit-fields as @code{unsigned short} (assuming short
19935 is 16 bits on these targets) to force GCC to use 16-bit accesses
19936 instead of, perhaps, a more efficient 32-bit access.
19938 If this option is disabled, the compiler uses the most efficient
19939 instruction.  In the previous example, that might be a 32-bit load
19940 instruction, even though that accesses bytes that do not contain
19941 any portion of the bit-field, or memory-mapped registers unrelated to
19942 the one being updated.
19944 If the target requires strict alignment, and honoring the field
19945 type would require violating this alignment, a warning is issued.
19946 If the field has @code{packed} attribute, the access is done without
19947 honoring the field type.  If the field doesn't have @code{packed}
19948 attribute, the access is done honoring the field type.  In both cases,
19949 GCC assumes that the user knows something about the target hardware
19950 that it is unaware of.
19952 The default value of this option is determined by the application binary
19953 interface for the target processor.
19955 @item -fsync-libcalls
19956 @opindex fsync-libcalls
19957 This option controls whether any out-of-line instance of the @code{__sync}
19958 family of functions may be used to implement the C++11 @code{__atomic}
19959 family of functions.
19961 The default value of this option is enabled, thus the only useful form
19962 of the option is @option{-fno-sync-libcalls}.  This option is used in
19963 the implementation of the @file{libatomic} runtime library.
19965 @end table
19967 @c man end
19969 @node Environment Variables
19970 @section Environment Variables Affecting GCC
19971 @cindex environment variables
19973 @c man begin ENVIRONMENT
19974 This section describes several environment variables that affect how GCC
19975 operates.  Some of them work by specifying directories or prefixes to use
19976 when searching for various kinds of files.  Some are used to specify other
19977 aspects of the compilation environment.
19979 Note that you can also specify places to search using options such as
19980 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
19981 take precedence over places specified using environment variables, which
19982 in turn take precedence over those specified by the configuration of GCC@.
19983 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
19984 GNU Compiler Collection (GCC) Internals}.
19986 @table @env
19987 @item LANG
19988 @itemx LC_CTYPE
19989 @c @itemx LC_COLLATE
19990 @itemx LC_MESSAGES
19991 @c @itemx LC_MONETARY
19992 @c @itemx LC_NUMERIC
19993 @c @itemx LC_TIME
19994 @itemx LC_ALL
19995 @findex LANG
19996 @findex LC_CTYPE
19997 @c @findex LC_COLLATE
19998 @findex LC_MESSAGES
19999 @c @findex LC_MONETARY
20000 @c @findex LC_NUMERIC
20001 @c @findex LC_TIME
20002 @findex LC_ALL
20003 @cindex locale
20004 These environment variables control the way that GCC uses
20005 localization information which allows GCC to work with different
20006 national conventions.  GCC inspects the locale categories
20007 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20008 so.  These locale categories can be set to any value supported by your
20009 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
20010 Kingdom encoded in UTF-8.
20012 The @env{LC_CTYPE} environment variable specifies character
20013 classification.  GCC uses it to determine the character boundaries in
20014 a string; this is needed for some multibyte encodings that contain quote
20015 and escape characters that are otherwise interpreted as a string
20016 end or escape.
20018 The @env{LC_MESSAGES} environment variable specifies the language to
20019 use in diagnostic messages.
20021 If the @env{LC_ALL} environment variable is set, it overrides the value
20022 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20023 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20024 environment variable.  If none of these variables are set, GCC
20025 defaults to traditional C English behavior.
20027 @item TMPDIR
20028 @findex TMPDIR
20029 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20030 files.  GCC uses temporary files to hold the output of one stage of
20031 compilation which is to be used as input to the next stage: for example,
20032 the output of the preprocessor, which is the input to the compiler
20033 proper.
20035 @item GCC_COMPARE_DEBUG
20036 @findex GCC_COMPARE_DEBUG
20037 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20038 @option{-fcompare-debug} to the compiler driver.  See the documentation
20039 of this option for more details.
20041 @item GCC_EXEC_PREFIX
20042 @findex GCC_EXEC_PREFIX
20043 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20044 names of the subprograms executed by the compiler.  No slash is added
20045 when this prefix is combined with the name of a subprogram, but you can
20046 specify a prefix that ends with a slash if you wish.
20048 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20049 an appropriate prefix to use based on the pathname it is invoked with.
20051 If GCC cannot find the subprogram using the specified prefix, it
20052 tries looking in the usual places for the subprogram.
20054 The default value of @env{GCC_EXEC_PREFIX} is
20055 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20056 the installed compiler. In many cases @var{prefix} is the value
20057 of @code{prefix} when you ran the @file{configure} script.
20059 Other prefixes specified with @option{-B} take precedence over this prefix.
20061 This prefix is also used for finding files such as @file{crt0.o} that are
20062 used for linking.
20064 In addition, the prefix is used in an unusual way in finding the
20065 directories to search for header files.  For each of the standard
20066 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20067 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20068 replacing that beginning with the specified prefix to produce an
20069 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
20070 @file{foo/bar} just before it searches the standard directory 
20071 @file{/usr/local/lib/bar}.
20072 If a standard directory begins with the configured
20073 @var{prefix} then the value of @var{prefix} is replaced by
20074 @env{GCC_EXEC_PREFIX} when looking for header files.
20076 @item COMPILER_PATH
20077 @findex COMPILER_PATH
20078 The value of @env{COMPILER_PATH} is a colon-separated list of
20079 directories, much like @env{PATH}.  GCC tries the directories thus
20080 specified when searching for subprograms, if it can't find the
20081 subprograms using @env{GCC_EXEC_PREFIX}.
20083 @item LIBRARY_PATH
20084 @findex LIBRARY_PATH
20085 The value of @env{LIBRARY_PATH} is a colon-separated list of
20086 directories, much like @env{PATH}.  When configured as a native compiler,
20087 GCC tries the directories thus specified when searching for special
20088 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20089 using GCC also uses these directories when searching for ordinary
20090 libraries for the @option{-l} option (but directories specified with
20091 @option{-L} come first).
20093 @item LANG
20094 @findex LANG
20095 @cindex locale definition
20096 This variable is used to pass locale information to the compiler.  One way in
20097 which this information is used is to determine the character set to be used
20098 when character literals, string literals and comments are parsed in C and C++.
20099 When the compiler is configured to allow multibyte characters,
20100 the following values for @env{LANG} are recognized:
20102 @table @samp
20103 @item C-JIS
20104 Recognize JIS characters.
20105 @item C-SJIS
20106 Recognize SJIS characters.
20107 @item C-EUCJP
20108 Recognize EUCJP characters.
20109 @end table
20111 If @env{LANG} is not defined, or if it has some other value, then the
20112 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20113 recognize and translate multibyte characters.
20114 @end table
20116 @noindent
20117 Some additional environment variables affect the behavior of the
20118 preprocessor.
20120 @include cppenv.texi
20122 @c man end
20124 @node Precompiled Headers
20125 @section Using Precompiled Headers
20126 @cindex precompiled headers
20127 @cindex speed of compilation
20129 Often large projects have many header files that are included in every
20130 source file.  The time the compiler takes to process these header files
20131 over and over again can account for nearly all of the time required to
20132 build the project.  To make builds faster, GCC allows you to
20133 @dfn{precompile} a header file.
20135 To create a precompiled header file, simply compile it as you would any
20136 other file, if necessary using the @option{-x} option to make the driver
20137 treat it as a C or C++ header file.  You may want to use a
20138 tool like @command{make} to keep the precompiled header up-to-date when
20139 the headers it contains change.
20141 A precompiled header file is searched for when @code{#include} is
20142 seen in the compilation.  As it searches for the included file
20143 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20144 compiler looks for a precompiled header in each directory just before it
20145 looks for the include file in that directory.  The name searched for is
20146 the name specified in the @code{#include} with @samp{.gch} appended.  If
20147 the precompiled header file can't be used, it is ignored.
20149 For instance, if you have @code{#include "all.h"}, and you have
20150 @file{all.h.gch} in the same directory as @file{all.h}, then the
20151 precompiled header file is used if possible, and the original
20152 header is used otherwise.
20154 Alternatively, you might decide to put the precompiled header file in a
20155 directory and use @option{-I} to ensure that directory is searched
20156 before (or instead of) the directory containing the original header.
20157 Then, if you want to check that the precompiled header file is always
20158 used, you can put a file of the same name as the original header in this
20159 directory containing an @code{#error} command.
20161 This also works with @option{-include}.  So yet another way to use
20162 precompiled headers, good for projects not designed with precompiled
20163 header files in mind, is to simply take most of the header files used by
20164 a project, include them from another header file, precompile that header
20165 file, and @option{-include} the precompiled header.  If the header files
20166 have guards against multiple inclusion, they are skipped because
20167 they've already been included (in the precompiled header).
20169 If you need to precompile the same header file for different
20170 languages, targets, or compiler options, you can instead make a
20171 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20172 header in the directory, perhaps using @option{-o}.  It doesn't matter
20173 what you call the files in the directory; every precompiled header in
20174 the directory is considered.  The first precompiled header
20175 encountered in the directory that is valid for this compilation is
20176 used; they're searched in no particular order.
20178 There are many other possibilities, limited only by your imagination,
20179 good sense, and the constraints of your build system.
20181 A precompiled header file can be used only when these conditions apply:
20183 @itemize
20184 @item
20185 Only one precompiled header can be used in a particular compilation.
20187 @item
20188 A precompiled header can't be used once the first C token is seen.  You
20189 can have preprocessor directives before a precompiled header; you cannot
20190 include a precompiled header from inside another header.
20192 @item
20193 The precompiled header file must be produced for the same language as
20194 the current compilation.  You can't use a C precompiled header for a C++
20195 compilation.
20197 @item
20198 The precompiled header file must have been produced by the same compiler
20199 binary as the current compilation is using.
20201 @item
20202 Any macros defined before the precompiled header is included must
20203 either be defined in the same way as when the precompiled header was
20204 generated, or must not affect the precompiled header, which usually
20205 means that they don't appear in the precompiled header at all.
20207 The @option{-D} option is one way to define a macro before a
20208 precompiled header is included; using a @code{#define} can also do it.
20209 There are also some options that define macros implicitly, like
20210 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20211 defined this way.
20213 @item If debugging information is output when using the precompiled
20214 header, using @option{-g} or similar, the same kind of debugging information
20215 must have been output when building the precompiled header.  However,
20216 a precompiled header built using @option{-g} can be used in a compilation
20217 when no debugging information is being output.
20219 @item The same @option{-m} options must generally be used when building
20220 and using the precompiled header.  @xref{Submodel Options},
20221 for any cases where this rule is relaxed.
20223 @item Each of the following options must be the same when building and using
20224 the precompiled header:
20226 @gccoptlist{-fexceptions}
20228 @item
20229 Some other command-line options starting with @option{-f},
20230 @option{-p}, or @option{-O} must be defined in the same way as when
20231 the precompiled header was generated.  At present, it's not clear
20232 which options are safe to change and which are not; the safest choice
20233 is to use exactly the same options when generating and using the
20234 precompiled header.  The following are known to be safe:
20236 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
20237 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
20238 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
20239 -pedantic-errors}
20241 @end itemize
20243 For all of these except the last, the compiler automatically
20244 ignores the precompiled header if the conditions aren't met.  If you
20245 find an option combination that doesn't work and doesn't cause the
20246 precompiled header to be ignored, please consider filing a bug report,
20247 see @ref{Bugs}.
20249 If you do use differing options when generating and using the
20250 precompiled header, the actual behavior is a mixture of the
20251 behavior for the options.  For instance, if you use @option{-g} to
20252 generate the precompiled header but not when using it, you may or may
20253 not get debugging information for routines in the precompiled header.