S/390: Add support for arch<n> arch/tune options.
[official-gcc.git] / gcc / doc / invoke.texi
blob4d0124f4b7b365b18ebd066394def5d33a685b4a
1 @c Copyright (C) 1988-2016 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2016 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
182 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
183 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
184 -fms-extensions -fplan9-extensions -fsso-struct=@var{endianness}
185 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
186 -fsigned-bitfields  -fsigned-char @gol
187 -funsigned-bitfields  -funsigned-char @gol
188 -trigraphs -traditional -traditional-cpp}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n} -fargs-in-order=@var{n} -fcheck-new @gol
194 -fconstexpr-depth=@var{n} -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
203 -fno-optional-diags  -fpermissive @gol
204 -fno-pretty-templates @gol
205 -frepo  -fno-rtti -fsized-deallocation @gol
206 -ftemplate-backtrace-limit=@var{n} @gol
207 -ftemplate-depth=@var{n} @gol
208 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
209 -fno-weak  -nostdinc++ @gol
210 -fvisibility-inlines-hidden @gol
211 -fvisibility-ms-compat @gol
212 -fext-numeric-literals @gol
213 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
214 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wmultiple-inheritance @gol
215 -Wnamespaces -Wnarrowing @gol
216 -Wnoexcept -Wnon-virtual-dtor  -Wreorder -Wregister @gol
217 -Weffc++  -Wstrict-null-sentinel -Wtemplates @gol
218 -Wno-non-template-friend  -Wold-style-cast @gol
219 -Woverloaded-virtual  -Wno-pmf-conversions @gol
220 -Wsign-promo -Wvirtual-inheritance}
222 @item Objective-C and Objective-C++ Language Options
223 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
224 Objective-C and Objective-C++ Dialects}.
225 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
226 -fgnu-runtime  -fnext-runtime @gol
227 -fno-nil-receivers @gol
228 -fobjc-abi-version=@var{n} @gol
229 -fobjc-call-cxx-cdtors @gol
230 -fobjc-direct-dispatch @gol
231 -fobjc-exceptions @gol
232 -fobjc-gc @gol
233 -fobjc-nilcheck @gol
234 -fobjc-std=objc1 @gol
235 -fno-local-ivars @gol
236 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
237 -freplace-objc-classes @gol
238 -fzero-link @gol
239 -gen-decls @gol
240 -Wassign-intercept @gol
241 -Wno-protocol  -Wselector @gol
242 -Wstrict-selector-match @gol
243 -Wundeclared-selector}
245 @item Diagnostic Message Formatting Options
246 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
247 @gccoptlist{-fmessage-length=@var{n}  @gol
248 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
249 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
250 -fno-diagnostics-show-option -fno-diagnostics-show-caret @gol
251 -fdiagnostics-parseable-fixits -fdiagnostics-generate-patch}
253 @item Warning Options
254 @xref{Warning Options,,Options to Request or Suppress Warnings}.
255 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
256 -pedantic-errors @gol
257 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
258 -Walloca -Walloca-larger-than=@var{n} @gol
259 -Wno-aggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
260 -Wno-attributes -Wbool-compare -Wbool-operation @gol
261 -Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat @gol
262 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
263 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
264 -Wconversion -Wcoverage-mismatch -Wno-cpp -Wdangling-else -Wdate-time @gol
265 -Wdelete-incomplete @gol
266 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
267 -Wdisabled-optimization @gol
268 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
269 -Wno-div-by-zero -Wdouble-promotion -Wduplicated-cond @gol
270 -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
271 -Werror  -Werror=* -Wfatal-errors -Wfloat-equal  -Wformat  -Wformat=2 @gol
272 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-length=@var{n} @gol
273 -Wformat-nonliteral @gol
274 -Wformat-security  -Wformat-signedness  -Wformat-y2k -Wframe-address @gol
275 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
276 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
277 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
278 -Wimplicit-function-declaration  -Wimplicit-int @gol
279 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
280 -Wno-int-to-pointer-cast -Winvalid-memory-model -Wno-invalid-offsetof @gol
281 -Winvalid-pch -Wlarger-than=@var{len} @gol
282 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
283 -Wmain -Wmaybe-uninitialized -Wmemset-elt-size -Wmemset-transposed-args @gol
284 -Wmisleading-indentation -Wmissing-braces @gol
285 -Wmissing-field-initializers -Wmissing-include-dirs @gol
286 -Wno-multichar -Wnonnull -Wnonnull-compare @gol
287 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
288 -Wnull-dereference -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
289 -Woverride-init-side-effects -Woverlength-strings @gol
290 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
291 -Wparentheses -Wno-pedantic-ms-format @gol
292 -Wplacement-new -Wplacement-new=@var{n} @gol
293 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
294 -Wno-pragmas -Wredundant-decls  -Wno-return-local-addr @gol
295 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
296 -Wshift-overflow -Wshift-overflow=@var{n} @gol
297 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
298 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
299 -Wno-scalar-storage-order @gol
300 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
301 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
302 -Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
303 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
304 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
305 -Wmissing-format-attribute -Wsubobject-linkage @gol
306 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
307 -Wswitch-unreachable  -Wsync-nand @gol
308 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
309 -Wtype-limits  -Wundef @gol
310 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
311 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
312 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
313 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
314 -Wunused-const-variable -Wunused-const-variable=@var{n} @gol
315 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
316 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
317 -Wvla -Wvla-larger-than=@var{n} -Wvolatile-register-var  -Wwrite-strings @gol
318 -Wzero-as-null-pointer-constant -Whsa}
320 @item C and Objective-C-only Warning Options
321 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
322 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
323 -Wold-style-declaration  -Wold-style-definition @gol
324 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
325 -Wdeclaration-after-statement -Wpointer-sign}
327 @item Debugging Options
328 @xref{Debugging Options,,Options for Debugging Your Program}.
329 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf -gdwarf-@var{version} @gol
330 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
331 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
332 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
333 -fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section @gol
334 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
335 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
336 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
337 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
338 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
339 -fvar-tracking -fvar-tracking-assignments}
341 @item Optimization Options
342 @xref{Optimize Options,,Options that Control Optimization}.
343 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
344 -falign-jumps[=@var{n}] @gol
345 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
346 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
347 -fauto-inc-dec -fbranch-probabilities @gol
348 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
349 -fbtr-bb-exclusive -fcaller-saves @gol
350 -fcombine-stack-adjustments -fconserve-stack @gol
351 -fcompare-elim -fcprop-registers -fcrossjumping @gol
352 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
353 -fcx-limited-range @gol
354 -fdata-sections -fdce -fdelayed-branch @gol
355 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
356 -fdevirtualize-at-ltrans -fdse @gol
357 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
358 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
359 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
360 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
361 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
362 -fif-conversion2 -findirect-inlining @gol
363 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
364 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment -fipa-bit-cp @gol
365 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
366 -fira-algorithm=@var{algorithm} @gol
367 -fira-region=@var{region} -fira-hoist-pressure @gol
368 -fira-loop-pressure -fno-ira-share-save-slots @gol
369 -fno-ira-share-spill-slots @gol
370 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
371 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
372 -fkeep-static-consts -flive-range-shrinkage @gol
373 -floop-block -floop-interchange -floop-strip-mine @gol
374 -floop-unroll-and-jam -floop-nest-optimize @gol
375 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
376 -flto-partition=@var{alg} -fmerge-all-constants @gol
377 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
378 -fmove-loop-invariants -fno-branch-count-reg @gol
379 -fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse @gol
380 -fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole @gol
381 -fno-peephole2 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
382 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
383 -fomit-frame-pointer -foptimize-sibling-calls @gol
384 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
385 -fprefetch-loop-arrays -fprintf-return-value @gol
386 -fprofile-correction @gol
387 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
388 -fprofile-reorder-functions @gol
389 -freciprocal-math -free -frename-registers -freorder-blocks @gol
390 -freorder-blocks-algorithm=@var{algorithm} @gol
391 -freorder-blocks-and-partition -freorder-functions @gol
392 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
393 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
394 -fsched-spec-load -fsched-spec-load-dangerous @gol
395 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
396 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
397 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
398 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
399 -fschedule-fusion @gol
400 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
401 -fselective-scheduling -fselective-scheduling2 @gol
402 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
403 -fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate @gol
404 -fsignaling-nans @gol
405 -fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops@gol
406 -fsplit-paths @gol
407 -fsplit-wide-types -fssa-backprop -fssa-phiopt @gol
408 -fstdarg-opt -fstrict-aliasing @gol
409 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
410 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
411 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
412 -ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting -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-loop-vectorize @gol
417 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
418 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
419 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
420 -ftree-vectorize -ftree-vrp -funconstrained-commons @gol
421 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
422 -funsafe-math-optimizations -funswitch-loops @gol
423 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
424 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
425 --param @var{name}=@var{value}
426 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
428 @item Program Instrumentation Options
429 @xref{Instrumentation Options,,Program Instrumentation Options}.
430 @gccoptlist{-p  -pg  -fprofile-arcs --coverage -ftest-coverage @gol
431 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
432 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
433 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
434 -fsanitize-undefined-trap-on-error -fbounds-check @gol
435 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
436 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
437 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
438 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
439 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
440 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
441 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
442 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
443 -fchkp-use-wrappers @gol
444 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
445 -fstack-protector-explicit -fstack-check @gol
446 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
447 -fno-stack-limit -fsplit-stack @gol
448 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
449 -fvtv-counts -fvtv-debug @gol
450 -finstrument-functions @gol
451 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
452 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
454 @item Preprocessor Options
455 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
456 @gccoptlist{-A@var{question}=@var{answer} @gol
457 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
458 -C  -dD  -dI  -dM  -dN @gol
459 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
460 -idirafter @var{dir} @gol
461 -include @var{file}  -imacros @var{file} @gol
462 -iprefix @var{file}  -iwithprefix @var{dir} @gol
463 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
464 -imultilib @var{dir} -isysroot @var{dir} @gol
465 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
466 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
467 -remap -trigraphs  -undef  -U@var{macro}  @gol
468 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
470 @item Assembler Option
471 @xref{Assembler Options,,Passing Options to the Assembler}.
472 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
474 @item Linker Options
475 @xref{Link Options,,Options for Linking}.
476 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
477 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
478 -s  -static -static-libgcc -static-libstdc++ @gol
479 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
480 -static-libmpx -static-libmpxwrappers @gol
481 -shared -shared-libgcc  -symbolic @gol
482 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
483 -u @var{symbol} -z @var{keyword}}
485 @item Directory Options
486 @xref{Directory Options,,Options for Directory Search}.
487 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
488 -iquote@var{dir} -L@var{dir} -no-canonical-prefixes -I- @gol
489 --sysroot=@var{dir} --no-sysroot-suffix}
491 @item Code Generation Options
492 @xref{Code Gen Options,,Options for Code Generation Conventions}.
493 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
494 -ffixed-@var{reg}  -fexceptions @gol
495 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
496 -fasynchronous-unwind-tables @gol
497 -fno-gnu-unique @gol
498 -finhibit-size-directive  -fno-common  -fno-ident @gol
499 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
500 -fno-jump-tables @gol
501 -frecord-gcc-switches @gol
502 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
503 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
504 -fleading-underscore  -ftls-model=@var{model} @gol
505 -fstack-reuse=@var{reuse_level} @gol
506 -ftrampolines  -ftrapv  -fwrapv @gol
507 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
508 -fstrict-volatile-bitfields -fsync-libcalls}
510 @item Developer Options
511 @xref{Developer Options,,GCC Developer Options}.
512 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
513 -fchecking -fchecking=@var{n} -fdbg-cnt-list @gol
514 -fdbg-cnt=@var{counter-value-list} @gol
515 -fdisable-ipa-@var{pass_name} @gol
516 -fdisable-rtl-@var{pass_name} @gol
517 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
518 -fdisable-tree-@var{pass_name} @gol
519 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
520 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
521 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
522 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
523 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
524 -fdump-passes @gol
525 -fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} @gol
526 -fdump-statistics @gol
527 -fdump-tree-all @gol
528 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
529 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
530 -fdump-tree-cfg -fdump-tree-alias @gol
531 -fdump-tree-ch @gol
532 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
533 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
534 -fdump-tree-gimple@r{[}-raw@r{]} @gol
535 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
536 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
537 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
538 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
539 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
540 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
541 -fdump-tree-nrv -fdump-tree-vect @gol
542 -fdump-tree-sink @gol
543 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
544 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
545 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
546 -fdump-tree-vtable-verify @gol
547 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
548 -fdump-tree-split-paths@r{[}-@var{n}@r{]} @gol
549 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
550 -fdump-final-insns=@var{file} @gol
551 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
552 -fenable-@var{kind}-@var{pass} @gol
553 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
554 -fira-verbose=@var{n} @gol
555 -flto-report -flto-report-wpa -fmem-report-wpa @gol
556 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report @gol
557 -fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
558 -fprofile-report @gol
559 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
560 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
561 -fstats  -fstack-usage  -ftime-report -ftime-report-details @gol
562 -fvar-tracking-assignments-toggle -gtoggle @gol
563 -print-file-name=@var{library}  -print-libgcc-file-name @gol
564 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
565 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
566 -print-sysroot -print-sysroot-headers-suffix @gol
567 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
569 @item Machine-Dependent Options
570 @xref{Submodel Options,,Machine-Dependent Options}.
571 @c This list is ordered alphanumerically by subsection name.
572 @c Try and put the significant identifier (CPU or system) first,
573 @c so users have a clue at guessing where the ones they want will be.
575 @emph{AArch64 Options}
576 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
577 -mgeneral-regs-only @gol
578 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
579 -mstrict-align @gol
580 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
581 -mtls-dialect=desc  -mtls-dialect=traditional @gol
582 -mtls-size=@var{size} @gol
583 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
584 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
585 -mlow-precision-recip-sqrt -mno-low-precision-recip-sqrt@gol
586 -mlow-precision-sqrt -mno-low-precision-sqrt@gol
587 -mlow-precision-div -mno-low-precision-div @gol
588 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
590 @emph{Adapteva Epiphany Options}
591 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
592 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
593 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
594 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
595 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
596 -msplit-vecmove-early -m1reg-@var{reg}}
598 @emph{ARC Options}
599 @gccoptlist{-mbarrel-shifter @gol
600 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
601 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
602 -mea -mno-mpy -mmul32x16 -mmul64 -matomic @gol
603 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
604 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
605 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
606 -mlong-calls -mmedium-calls -msdata @gol
607 -mucb-mcount -mvolatile-cache -mtp-regno=@var{regno} @gol
608 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
609 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
610 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
611 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
612 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
613 -mtune=@var{cpu} -mmultcost=@var{num} @gol
614 -munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
615 -mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu}}
617 @emph{ARM Options}
618 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
619 -mabi=@var{name} @gol
620 -mapcs-stack-check  -mno-apcs-stack-check @gol
621 -mapcs-float  -mno-apcs-float @gol
622 -mapcs-reentrant  -mno-apcs-reentrant @gol
623 -msched-prolog  -mno-sched-prolog @gol
624 -mlittle-endian  -mbig-endian @gol
625 -mfloat-abi=@var{name} @gol
626 -mfp16-format=@var{name}
627 -mthumb-interwork  -mno-thumb-interwork @gol
628 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
629 -mtune=@var{name} -mprint-tune-info @gol
630 -mstructure-size-boundary=@var{n} @gol
631 -mabort-on-noreturn @gol
632 -mlong-calls  -mno-long-calls @gol
633 -msingle-pic-base  -mno-single-pic-base @gol
634 -mpic-register=@var{reg} @gol
635 -mnop-fun-dllimport @gol
636 -mpoke-function-name @gol
637 -mthumb  -marm @gol
638 -mtpcs-frame  -mtpcs-leaf-frame @gol
639 -mcaller-super-interworking  -mcallee-super-interworking @gol
640 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
641 -mword-relocations @gol
642 -mfix-cortex-m3-ldrd @gol
643 -munaligned-access @gol
644 -mneon-for-64bits @gol
645 -mslow-flash-data @gol
646 -masm-syntax-unified @gol
647 -mrestrict-it @gol
648 -mpure-code}
650 @emph{AVR Options}
651 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
652 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
653 -mrelax -mrmw -mstrict-X -mtiny-stack -mfract-convert-truncate -nodevicelib @gol
654 -Waddr-space-convert -Wmisspelled-isr}
656 @emph{Blackfin Options}
657 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
658 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
659 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
660 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
661 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
662 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
663 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
664 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
665 -micplb}
667 @emph{C6X Options}
668 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
669 -msim -msdata=@var{sdata-type}}
671 @emph{CRIS Options}
672 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
673 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
674 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
675 -mstack-align  -mdata-align  -mconst-align @gol
676 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
677 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
678 -mmul-bug-workaround  -mno-mul-bug-workaround}
680 @emph{CR16 Options}
681 @gccoptlist{-mmac @gol
682 -mcr16cplus -mcr16c @gol
683 -msim -mint32 -mbit-ops
684 -mdata-model=@var{model}}
686 @emph{Darwin Options}
687 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
688 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
689 -client_name  -compatibility_version  -current_version @gol
690 -dead_strip @gol
691 -dependency-file  -dylib_file  -dylinker_install_name @gol
692 -dynamic  -dynamiclib  -exported_symbols_list @gol
693 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
694 -force_flat_namespace  -headerpad_max_install_names @gol
695 -iframework @gol
696 -image_base  -init  -install_name  -keep_private_externs @gol
697 -multi_module  -multiply_defined  -multiply_defined_unused @gol
698 -noall_load   -no_dead_strip_inits_and_terms @gol
699 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
700 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
701 -private_bundle  -read_only_relocs  -sectalign @gol
702 -sectobjectsymbols  -whyload  -seg1addr @gol
703 -sectcreate  -sectobjectsymbols  -sectorder @gol
704 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
705 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
706 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
707 -single_module  -static  -sub_library  -sub_umbrella @gol
708 -twolevel_namespace  -umbrella  -undefined @gol
709 -unexported_symbols_list  -weak_reference_mismatches @gol
710 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
711 -mkernel -mone-byte-bool}
713 @emph{DEC Alpha Options}
714 @gccoptlist{-mno-fp-regs  -msoft-float @gol
715 -mieee  -mieee-with-inexact  -mieee-conformant @gol
716 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
717 -mtrap-precision=@var{mode}  -mbuild-constants @gol
718 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
719 -mbwx  -mmax  -mfix  -mcix @gol
720 -mfloat-vax  -mfloat-ieee @gol
721 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
722 -msmall-text  -mlarge-text @gol
723 -mmemory-latency=@var{time}}
725 @emph{FR30 Options}
726 @gccoptlist{-msmall-model -mno-lsim}
728 @emph{FT32 Options}
729 @gccoptlist{-msim -mlra -mnodiv}
731 @emph{FRV Options}
732 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
733 -mhard-float  -msoft-float @gol
734 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
735 -mdouble  -mno-double @gol
736 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
737 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
738 -mlinked-fp  -mlong-calls  -malign-labels @gol
739 -mlibrary-pic  -macc-4  -macc-8 @gol
740 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
741 -moptimize-membar -mno-optimize-membar @gol
742 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
743 -mvliw-branch  -mno-vliw-branch @gol
744 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
745 -mno-nested-cond-exec  -mtomcat-stats @gol
746 -mTLS -mtls @gol
747 -mcpu=@var{cpu}}
749 @emph{GNU/Linux Options}
750 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
751 -tno-android-cc -tno-android-ld}
753 @emph{H8/300 Options}
754 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
756 @emph{HPPA Options}
757 @gccoptlist{-march=@var{architecture-type} @gol
758 -mdisable-fpregs  -mdisable-indexing @gol
759 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
760 -mfixed-range=@var{register-range} @gol
761 -mjump-in-delay -mlinker-opt -mlong-calls @gol
762 -mlong-load-store  -mno-disable-fpregs @gol
763 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
764 -mno-jump-in-delay  -mno-long-load-store @gol
765 -mno-portable-runtime  -mno-soft-float @gol
766 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
767 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
768 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
769 -munix=@var{unix-std}  -nolibdld  -static  -threads}
771 @emph{IA-64 Options}
772 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
773 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
774 -mconstant-gp  -mauto-pic  -mfused-madd @gol
775 -minline-float-divide-min-latency @gol
776 -minline-float-divide-max-throughput @gol
777 -mno-inline-float-divide @gol
778 -minline-int-divide-min-latency @gol
779 -minline-int-divide-max-throughput  @gol
780 -mno-inline-int-divide @gol
781 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
782 -mno-inline-sqrt @gol
783 -mdwarf2-asm -mearly-stop-bits @gol
784 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
785 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
786 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
787 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
788 -msched-spec-ldc -msched-spec-control-ldc @gol
789 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
790 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
791 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
792 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
794 @emph{LM32 Options}
795 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
796 -msign-extend-enabled -muser-enabled}
798 @emph{M32R/D Options}
799 @gccoptlist{-m32r2 -m32rx -m32r @gol
800 -mdebug @gol
801 -malign-loops -mno-align-loops @gol
802 -missue-rate=@var{number} @gol
803 -mbranch-cost=@var{number} @gol
804 -mmodel=@var{code-size-model-type} @gol
805 -msdata=@var{sdata-type} @gol
806 -mno-flush-func -mflush-func=@var{name} @gol
807 -mno-flush-trap -mflush-trap=@var{number} @gol
808 -G @var{num}}
810 @emph{M32C Options}
811 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
813 @emph{M680x0 Options}
814 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
815 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
816 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
817 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
818 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
819 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
820 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
821 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
822 -mxgot -mno-xgot}
824 @emph{MCore Options}
825 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
826 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
827 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
828 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
829 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
831 @emph{MeP Options}
832 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
833 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
834 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
835 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
836 -mtiny=@var{n}}
838 @emph{MicroBlaze Options}
839 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
840 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
841 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
842 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
843 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
845 @emph{MIPS Options}
846 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
847 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
848 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
849 -mips16  -mno-mips16  -mflip-mips16 @gol
850 -minterlink-compressed -mno-interlink-compressed @gol
851 -minterlink-mips16  -mno-interlink-mips16 @gol
852 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
853 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
854 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
855 -mno-float  -msingle-float  -mdouble-float @gol
856 -modd-spreg -mno-odd-spreg @gol
857 -mabs=@var{mode}  -mnan=@var{encoding} @gol
858 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
859 -mmcu -mmno-mcu @gol
860 -meva -mno-eva @gol
861 -mvirt -mno-virt @gol
862 -mxpa -mno-xpa @gol
863 -mmicromips -mno-micromips @gol
864 -mmsa -mno-msa @gol
865 -mfpu=@var{fpu-type} @gol
866 -msmartmips  -mno-smartmips @gol
867 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
868 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
869 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
870 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
871 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
872 -membedded-data  -mno-embedded-data @gol
873 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
874 -mcode-readable=@var{setting} @gol
875 -msplit-addresses  -mno-split-addresses @gol
876 -mexplicit-relocs  -mno-explicit-relocs @gol
877 -mcheck-zero-division  -mno-check-zero-division @gol
878 -mdivide-traps  -mdivide-breaks @gol
879 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
880 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
881 -mfix-24k -mno-fix-24k @gol
882 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
883 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
884 -mfix-vr4120  -mno-fix-vr4120 @gol
885 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
886 -mflush-func=@var{func}  -mno-flush-func @gol
887 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
888 -mcompact-branches=@var{policy} @gol
889 -mfp-exceptions -mno-fp-exceptions @gol
890 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
891 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
892 -mframe-header-opt -mno-frame-header-opt}
894 @emph{MMIX Options}
895 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
896 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
897 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
898 -mno-base-addresses  -msingle-exit  -mno-single-exit}
900 @emph{MN10300 Options}
901 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
902 -mno-am33 -mam33 -mam33-2 -mam34 @gol
903 -mtune=@var{cpu-type} @gol
904 -mreturn-pointer-on-d0 @gol
905 -mno-crt0  -mrelax -mliw -msetlb}
907 @emph{Moxie Options}
908 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
910 @emph{MSP430 Options}
911 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
912 -mwarn-mcu @gol
913 -mcode-region= -mdata-region= @gol
914 -msilicon-errata= -msilicon-errata-warn= @gol
915 -mhwmult= -minrt}
917 @emph{NDS32 Options}
918 @gccoptlist{-mbig-endian -mlittle-endian @gol
919 -mreduced-regs -mfull-regs @gol
920 -mcmov -mno-cmov @gol
921 -mperf-ext -mno-perf-ext @gol
922 -mv3push -mno-v3push @gol
923 -m16bit -mno-16bit @gol
924 -misr-vector-size=@var{num} @gol
925 -mcache-block-size=@var{num} @gol
926 -march=@var{arch} @gol
927 -mcmodel=@var{code-model} @gol
928 -mctor-dtor -mrelax}
930 @emph{Nios II Options}
931 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
932 -mel -meb @gol
933 -mno-bypass-cache -mbypass-cache @gol
934 -mno-cache-volatile -mcache-volatile @gol
935 -mno-fast-sw-div -mfast-sw-div @gol
936 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
937 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
938 -mcustom-fpu-cfg=@var{name} @gol
939 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
940 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
942 @emph{Nvidia PTX Options}
943 @gccoptlist{-m32 -m64 -mmainkernel -moptimize}
945 @emph{PDP-11 Options}
946 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
947 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
948 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
949 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
950 -mbranch-expensive  -mbranch-cheap @gol
951 -munix-asm  -mdec-asm}
953 @emph{picoChip Options}
954 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
955 -msymbol-as-address -mno-inefficient-warnings}
957 @emph{PowerPC Options}
958 See RS/6000 and PowerPC Options.
960 @emph{RL78 Options}
961 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
962 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
963 -m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts}
965 @emph{RS/6000 and PowerPC Options}
966 @gccoptlist{-mcpu=@var{cpu-type} @gol
967 -mtune=@var{cpu-type} @gol
968 -mcmodel=@var{code-model} @gol
969 -mpowerpc64 @gol
970 -maltivec  -mno-altivec @gol
971 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
972 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
973 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
974 -mfprnd  -mno-fprnd @gol
975 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
976 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
977 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
978 -malign-power  -malign-natural @gol
979 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
980 -msingle-float -mdouble-float -msimple-fpu @gol
981 -mstring  -mno-string  -mupdate  -mno-update @gol
982 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
983 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
984 -mstrict-align  -mno-strict-align  -mrelocatable @gol
985 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
986 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
987 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
988 -mprioritize-restricted-insns=@var{priority} @gol
989 -msched-costly-dep=@var{dependence_type} @gol
990 -minsert-sched-nops=@var{scheme} @gol
991 -mcall-sysv  -mcall-netbsd @gol
992 -maix-struct-return  -msvr4-struct-return @gol
993 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
994 -mblock-move-inline-limit=@var{num} @gol
995 -misel -mno-isel @gol
996 -misel=yes  -misel=no @gol
997 -mspe -mno-spe @gol
998 -mspe=yes  -mspe=no @gol
999 -mpaired @gol
1000 -mgen-cell-microcode -mwarn-cell-microcode @gol
1001 -mvrsave -mno-vrsave @gol
1002 -mmulhw -mno-mulhw @gol
1003 -mdlmzb -mno-dlmzb @gol
1004 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
1005 -mprototype  -mno-prototype @gol
1006 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1007 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
1008 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
1009 -mno-recip-precision @gol
1010 -mveclibabi=@var{type} -mfriz -mno-friz @gol
1011 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
1012 -msave-toc-indirect -mno-save-toc-indirect @gol
1013 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
1014 -mcrypto -mno-crypto -mhtm -mno-htm -mdirect-move -mno-direct-move @gol
1015 -mquad-memory -mno-quad-memory @gol
1016 -mquad-memory-atomic -mno-quad-memory-atomic @gol
1017 -mcompat-align-parm -mno-compat-align-parm @gol
1018 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
1019 -mupper-regs-di -mno-upper-regs-di @gol
1020 -mupper-regs -mno-upper-regs @gol
1021 -mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
1022 -mgnu-attribute -mno-gnu-attribute @gol
1023 -mlra -mno-lra}
1025 @emph{RX Options}
1026 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1027 -mcpu=@gol
1028 -mbig-endian-data -mlittle-endian-data @gol
1029 -msmall-data @gol
1030 -msim  -mno-sim@gol
1031 -mas100-syntax -mno-as100-syntax@gol
1032 -mrelax@gol
1033 -mmax-constant-size=@gol
1034 -mint-register=@gol
1035 -mpid@gol
1036 -mallow-string-insns -mno-allow-string-insns@gol
1037 -mjsr@gol
1038 -mno-warn-multiple-fast-interrupts@gol
1039 -msave-acc-in-interrupts}
1041 @emph{S/390 and zSeries Options}
1042 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1043 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
1044 -mlong-double-64 -mlong-double-128 @gol
1045 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
1046 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
1047 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1048 -mhtm -mvx -mzvector @gol
1049 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1050 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
1051 -mhotpatch=@var{halfwords},@var{halfwords}}
1053 @emph{Score Options}
1054 @gccoptlist{-meb -mel @gol
1055 -mnhwloop @gol
1056 -muls @gol
1057 -mmac @gol
1058 -mscore5 -mscore5u -mscore7 -mscore7d}
1060 @emph{SH Options}
1061 @gccoptlist{-m1  -m2  -m2e @gol
1062 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
1063 -m3  -m3e @gol
1064 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1065 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
1066 -mb  -ml  -mdalign  -mrelax @gol
1067 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
1068 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
1069 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
1070 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
1071 -maccumulate-outgoing-args @gol
1072 -matomic-model=@var{atomic-model} @gol
1073 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1074 -mcbranch-force-delay-slot @gol
1075 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1076 -mpretend-cmove -mtas}
1078 @emph{Solaris 2 Options}
1079 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1080 -pthreads -pthread}
1082 @emph{SPARC Options}
1083 @gccoptlist{-mcpu=@var{cpu-type} @gol
1084 -mtune=@var{cpu-type} @gol
1085 -mcmodel=@var{code-model} @gol
1086 -mmemory-model=@var{mem-model} @gol
1087 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1088 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1089 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1090 -mhard-quad-float  -msoft-quad-float @gol
1091 -mstack-bias  -mno-stack-bias @gol
1092 -mstd-struct-return  -mno-std-struct-return @gol
1093 -munaligned-doubles  -mno-unaligned-doubles @gol
1094 -muser-mode  -mno-user-mode @gol
1095 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1096 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1097 -mcbcond -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1098 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1099 -mfix-at697f -mfix-ut699}
1101 @emph{SPU Options}
1102 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1103 -msafe-dma -munsafe-dma @gol
1104 -mbranch-hints @gol
1105 -msmall-mem -mlarge-mem -mstdmain @gol
1106 -mfixed-range=@var{register-range} @gol
1107 -mea32 -mea64 @gol
1108 -maddress-space-conversion -mno-address-space-conversion @gol
1109 -mcache-size=@var{cache-size} @gol
1110 -matomic-updates -mno-atomic-updates}
1112 @emph{System V Options}
1113 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1115 @emph{TILE-Gx Options}
1116 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1117 -mcmodel=@var{code-model}}
1119 @emph{TILEPro Options}
1120 @gccoptlist{-mcpu=@var{cpu} -m32}
1122 @emph{V850 Options}
1123 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1124 -mprolog-function  -mno-prolog-function  -mspace @gol
1125 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1126 -mapp-regs  -mno-app-regs @gol
1127 -mdisable-callt  -mno-disable-callt @gol
1128 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1129 -mv850e -mv850 -mv850e3v5 @gol
1130 -mloop @gol
1131 -mrelax @gol
1132 -mlong-jumps @gol
1133 -msoft-float @gol
1134 -mhard-float @gol
1135 -mgcc-abi @gol
1136 -mrh850-abi @gol
1137 -mbig-switch}
1139 @emph{VAX Options}
1140 @gccoptlist{-mg  -mgnu  -munix}
1142 @emph{Visium Options}
1143 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1144 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1146 @emph{VMS Options}
1147 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1148 -mpointer-size=@var{size}}
1150 @emph{VxWorks Options}
1151 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1152 -Xbind-lazy  -Xbind-now}
1154 @emph{x86 Options}
1155 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1156 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1157 -mfpmath=@var{unit} @gol
1158 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1159 -mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float @gol
1160 -mno-wide-multiply  -mrtd  -malign-double @gol
1161 -mpreferred-stack-boundary=@var{num} @gol
1162 -mincoming-stack-boundary=@var{num} @gol
1163 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1164 -mrecip -mrecip=@var{opt} @gol
1165 -mvzeroupper -mprefer-avx128 @gol
1166 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1167 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1168 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1169 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
1170 -mprefetchwt1 -mclflushopt -mxsavec -mxsaves @gol
1171 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1172 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mclzero
1173 -mpku -mthreads @gol
1174 -mms-bitfields -mno-align-stringops  -minline-all-stringops @gol
1175 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1176 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1177 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1178 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1179 -mregparm=@var{num}  -msseregparm @gol
1180 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1181 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1182 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1183 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1184 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1185 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1186 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1187 -malign-data=@var{type} -mstack-protector-guard=@var{guard} @gol
1188 -mmitigate-rop -mgeneral-regs-only}
1190 @emph{x86 Windows Options}
1191 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1192 -mnop-fun-dllimport -mthread @gol
1193 -municode -mwin32 -mwindows -fno-set-stack-executable}
1195 @emph{Xstormy16 Options}
1196 @gccoptlist{-msim}
1198 @emph{Xtensa Options}
1199 @gccoptlist{-mconst16 -mno-const16 @gol
1200 -mfused-madd  -mno-fused-madd @gol
1201 -mforce-no-pic @gol
1202 -mserialize-volatile  -mno-serialize-volatile @gol
1203 -mtext-section-literals  -mno-text-section-literals @gol
1204 -mauto-litpools  -mno-auto-litpools @gol
1205 -mtarget-align  -mno-target-align @gol
1206 -mlongcalls  -mno-longcalls}
1208 @emph{zSeries Options}
1209 See S/390 and zSeries Options.
1210 @end table
1213 @node Overall Options
1214 @section Options Controlling the Kind of Output
1216 Compilation can involve up to four stages: preprocessing, compilation
1217 proper, assembly and linking, always in that order.  GCC is capable of
1218 preprocessing and compiling several files either into several
1219 assembler input files, or into one assembler input file; then each
1220 assembler input file produces an object file, and linking combines all
1221 the object files (those newly compiled, and those specified as input)
1222 into an executable file.
1224 @cindex file name suffix
1225 For any given input file, the file name suffix determines what kind of
1226 compilation is done:
1228 @table @gcctabopt
1229 @item @var{file}.c
1230 C source code that must be preprocessed.
1232 @item @var{file}.i
1233 C source code that should not be preprocessed.
1235 @item @var{file}.ii
1236 C++ source code that should not be preprocessed.
1238 @item @var{file}.m
1239 Objective-C source code.  Note that you must link with the @file{libobjc}
1240 library to make an Objective-C program work.
1242 @item @var{file}.mi
1243 Objective-C source code that should not be preprocessed.
1245 @item @var{file}.mm
1246 @itemx @var{file}.M
1247 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1248 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1249 to a literal capital M@.
1251 @item @var{file}.mii
1252 Objective-C++ source code that should not be preprocessed.
1254 @item @var{file}.h
1255 C, C++, Objective-C or Objective-C++ header file to be turned into a
1256 precompiled header (default), or C, C++ header file to be turned into an
1257 Ada spec (via the @option{-fdump-ada-spec} switch).
1259 @item @var{file}.cc
1260 @itemx @var{file}.cp
1261 @itemx @var{file}.cxx
1262 @itemx @var{file}.cpp
1263 @itemx @var{file}.CPP
1264 @itemx @var{file}.c++
1265 @itemx @var{file}.C
1266 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1267 the last two letters must both be literally @samp{x}.  Likewise,
1268 @samp{.C} refers to a literal capital C@.
1270 @item @var{file}.mm
1271 @itemx @var{file}.M
1272 Objective-C++ source code that must be preprocessed.
1274 @item @var{file}.mii
1275 Objective-C++ source code that should not be preprocessed.
1277 @item @var{file}.hh
1278 @itemx @var{file}.H
1279 @itemx @var{file}.hp
1280 @itemx @var{file}.hxx
1281 @itemx @var{file}.hpp
1282 @itemx @var{file}.HPP
1283 @itemx @var{file}.h++
1284 @itemx @var{file}.tcc
1285 C++ header file to be turned into a precompiled header or Ada spec.
1287 @item @var{file}.f
1288 @itemx @var{file}.for
1289 @itemx @var{file}.ftn
1290 Fixed form Fortran source code that should not be preprocessed.
1292 @item @var{file}.F
1293 @itemx @var{file}.FOR
1294 @itemx @var{file}.fpp
1295 @itemx @var{file}.FPP
1296 @itemx @var{file}.FTN
1297 Fixed form Fortran source code that must be preprocessed (with the traditional
1298 preprocessor).
1300 @item @var{file}.f90
1301 @itemx @var{file}.f95
1302 @itemx @var{file}.f03
1303 @itemx @var{file}.f08
1304 Free form Fortran source code that should not be preprocessed.
1306 @item @var{file}.F90
1307 @itemx @var{file}.F95
1308 @itemx @var{file}.F03
1309 @itemx @var{file}.F08
1310 Free form Fortran source code that must be preprocessed (with the
1311 traditional preprocessor).
1313 @item @var{file}.go
1314 Go source code.
1316 @c FIXME: Descriptions of Java file types.
1317 @c @var{file}.java
1318 @c @var{file}.class
1319 @c @var{file}.zip
1320 @c @var{file}.jar
1322 @item @var{file}.ads
1323 Ada source code file that contains a library unit declaration (a
1324 declaration of a package, subprogram, or generic, or a generic
1325 instantiation), or a library unit renaming declaration (a package,
1326 generic, or subprogram renaming declaration).  Such files are also
1327 called @dfn{specs}.
1329 @item @var{file}.adb
1330 Ada source code file containing a library unit body (a subprogram or
1331 package body).  Such files are also called @dfn{bodies}.
1333 @c GCC also knows about some suffixes for languages not yet included:
1334 @c Pascal:
1335 @c @var{file}.p
1336 @c @var{file}.pas
1337 @c Ratfor:
1338 @c @var{file}.r
1340 @item @var{file}.s
1341 Assembler code.
1343 @item @var{file}.S
1344 @itemx @var{file}.sx
1345 Assembler code that must be preprocessed.
1347 @item @var{other}
1348 An object file to be fed straight into linking.
1349 Any file name with no recognized suffix is treated this way.
1350 @end table
1352 @opindex x
1353 You can specify the input language explicitly with the @option{-x} option:
1355 @table @gcctabopt
1356 @item -x @var{language}
1357 Specify explicitly the @var{language} for the following input files
1358 (rather than letting the compiler choose a default based on the file
1359 name suffix).  This option applies to all following input files until
1360 the next @option{-x} option.  Possible values for @var{language} are:
1361 @smallexample
1362 c  c-header  cpp-output
1363 c++  c++-header  c++-cpp-output
1364 objective-c  objective-c-header  objective-c-cpp-output
1365 objective-c++ objective-c++-header objective-c++-cpp-output
1366 assembler  assembler-with-cpp
1368 f77  f77-cpp-input f95  f95-cpp-input
1370 java
1371 @end smallexample
1373 @item -x none
1374 Turn off any specification of a language, so that subsequent files are
1375 handled according to their file name suffixes (as they are if @option{-x}
1376 has not been used at all).
1377 @end table
1379 If you only want some of the stages of compilation, you can use
1380 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1381 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1382 @command{gcc} is to stop.  Note that some combinations (for example,
1383 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1385 @table @gcctabopt
1386 @item -c
1387 @opindex c
1388 Compile or assemble the source files, but do not link.  The linking
1389 stage simply is not done.  The ultimate output is in the form of an
1390 object file for each source file.
1392 By default, the object file name for a source file is made by replacing
1393 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1395 Unrecognized input files, not requiring compilation or assembly, are
1396 ignored.
1398 @item -S
1399 @opindex S
1400 Stop after the stage of compilation proper; do not assemble.  The output
1401 is in the form of an assembler code file for each non-assembler input
1402 file specified.
1404 By default, the assembler file name for a source file is made by
1405 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1407 Input files that don't require compilation are ignored.
1409 @item -E
1410 @opindex E
1411 Stop after the preprocessing stage; do not run the compiler proper.  The
1412 output is in the form of preprocessed source code, which is sent to the
1413 standard output.
1415 Input files that don't require preprocessing are ignored.
1417 @cindex output file option
1418 @item -o @var{file}
1419 @opindex o
1420 Place output in file @var{file}.  This applies to whatever
1421 sort of output is being produced, whether it be an executable file,
1422 an object file, an assembler file or preprocessed C code.
1424 If @option{-o} is not specified, the default is to put an executable
1425 file in @file{a.out}, the object file for
1426 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1427 assembler file in @file{@var{source}.s}, a precompiled header file in
1428 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1429 standard output.
1431 @item -v
1432 @opindex v
1433 Print (on standard error output) the commands executed to run the stages
1434 of compilation.  Also print the version number of the compiler driver
1435 program and of the preprocessor and the compiler proper.
1437 @item -###
1438 @opindex ###
1439 Like @option{-v} except the commands are not executed and arguments
1440 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1441 This is useful for shell scripts to capture the driver-generated command lines.
1443 @item --help
1444 @opindex help
1445 Print (on the standard output) a description of the command-line options
1446 understood by @command{gcc}.  If the @option{-v} option is also specified
1447 then @option{--help} is also passed on to the various processes
1448 invoked by @command{gcc}, so that they can display the command-line options
1449 they accept.  If the @option{-Wextra} option has also been specified
1450 (prior to the @option{--help} option), then command-line options that
1451 have no documentation associated with them are also displayed.
1453 @item --target-help
1454 @opindex target-help
1455 Print (on the standard output) a description of target-specific command-line
1456 options for each tool.  For some targets extra target-specific
1457 information may also be printed.
1459 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1460 Print (on the standard output) a description of the command-line
1461 options understood by the compiler that fit into all specified classes
1462 and qualifiers.  These are the supported classes:
1464 @table @asis
1465 @item @samp{optimizers}
1466 Display all of the optimization options supported by the
1467 compiler.
1469 @item @samp{warnings}
1470 Display all of the options controlling warning messages
1471 produced by the compiler.
1473 @item @samp{target}
1474 Display target-specific options.  Unlike the
1475 @option{--target-help} option however, target-specific options of the
1476 linker and assembler are not displayed.  This is because those
1477 tools do not currently support the extended @option{--help=} syntax.
1479 @item @samp{params}
1480 Display the values recognized by the @option{--param}
1481 option.
1483 @item @var{language}
1484 Display the options supported for @var{language}, where
1485 @var{language} is the name of one of the languages supported in this
1486 version of GCC@.
1488 @item @samp{common}
1489 Display the options that are common to all languages.
1490 @end table
1492 These are the supported qualifiers:
1494 @table @asis
1495 @item @samp{undocumented}
1496 Display only those options that are undocumented.
1498 @item @samp{joined}
1499 Display options taking an argument that appears after an equal
1500 sign in the same continuous piece of text, such as:
1501 @samp{--help=target}.
1503 @item @samp{separate}
1504 Display options taking an argument that appears as a separate word
1505 following the original option, such as: @samp{-o output-file}.
1506 @end table
1508 Thus for example to display all the undocumented target-specific
1509 switches supported by the compiler, use:
1511 @smallexample
1512 --help=target,undocumented
1513 @end smallexample
1515 The sense of a qualifier can be inverted by prefixing it with the
1516 @samp{^} character, so for example to display all binary warning
1517 options (i.e., ones that are either on or off and that do not take an
1518 argument) that have a description, use:
1520 @smallexample
1521 --help=warnings,^joined,^undocumented
1522 @end smallexample
1524 The argument to @option{--help=} should not consist solely of inverted
1525 qualifiers.
1527 Combining several classes is possible, although this usually
1528 restricts the output so much that there is nothing to display.  One
1529 case where it does work, however, is when one of the classes is
1530 @var{target}.  For example, to display all the target-specific
1531 optimization options, use:
1533 @smallexample
1534 --help=target,optimizers
1535 @end smallexample
1537 The @option{--help=} option can be repeated on the command line.  Each
1538 successive use displays its requested class of options, skipping
1539 those that have already been displayed.
1541 If the @option{-Q} option appears on the command line before the
1542 @option{--help=} option, then the descriptive text displayed by
1543 @option{--help=} is changed.  Instead of describing the displayed
1544 options, an indication is given as to whether the option is enabled,
1545 disabled or set to a specific value (assuming that the compiler
1546 knows this at the point where the @option{--help=} option is used).
1548 Here is a truncated example from the ARM port of @command{gcc}:
1550 @smallexample
1551   % gcc -Q -mabi=2 --help=target -c
1552   The following options are target specific:
1553   -mabi=                                2
1554   -mabort-on-noreturn                   [disabled]
1555   -mapcs                                [disabled]
1556 @end smallexample
1558 The output is sensitive to the effects of previous command-line
1559 options, so for example it is possible to find out which optimizations
1560 are enabled at @option{-O2} by using:
1562 @smallexample
1563 -Q -O2 --help=optimizers
1564 @end smallexample
1566 Alternatively you can discover which binary optimizations are enabled
1567 by @option{-O3} by using:
1569 @smallexample
1570 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1571 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1572 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1573 @end smallexample
1575 @item --version
1576 @opindex version
1577 Display the version number and copyrights of the invoked GCC@.
1579 @item -pass-exit-codes
1580 @opindex pass-exit-codes
1581 Normally the @command{gcc} program exits with the code of 1 if any
1582 phase of the compiler returns a non-success return code.  If you specify
1583 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1584 the numerically highest error produced by any phase returning an error
1585 indication.  The C, C++, and Fortran front ends return 4 if an internal
1586 compiler error is encountered.
1588 @item -pipe
1589 @opindex pipe
1590 Use pipes rather than temporary files for communication between the
1591 various stages of compilation.  This fails to work on some systems where
1592 the assembler is unable to read from a pipe; but the GNU assembler has
1593 no trouble.
1595 @item -specs=@var{file}
1596 @opindex specs
1597 Process @var{file} after the compiler reads in the standard @file{specs}
1598 file, in order to override the defaults which the @command{gcc} driver
1599 program uses when determining what switches to pass to @command{cc1},
1600 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1601 @option{-specs=@var{file}} can be specified on the command line, and they
1602 are processed in order, from left to right.  @xref{Spec Files}, for
1603 information about the format of the @var{file}.
1605 @item -wrapper
1606 @opindex wrapper
1607 Invoke all subcommands under a wrapper program.  The name of the
1608 wrapper program and its parameters are passed as a comma separated
1609 list.
1611 @smallexample
1612 gcc -c t.c -wrapper gdb,--args
1613 @end smallexample
1615 @noindent
1616 This invokes all subprograms of @command{gcc} under
1617 @samp{gdb --args}, thus the invocation of @command{cc1} is
1618 @samp{gdb --args cc1 @dots{}}.
1620 @item -fplugin=@var{name}.so
1621 @opindex fplugin
1622 Load the plugin code in file @var{name}.so, assumed to be a
1623 shared object to be dlopen'd by the compiler.  The base name of
1624 the shared object file is used to identify the plugin for the
1625 purposes of argument parsing (See
1626 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1627 Each plugin should define the callback functions specified in the
1628 Plugins API.
1630 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1631 @opindex fplugin-arg
1632 Define an argument called @var{key} with a value of @var{value}
1633 for the plugin called @var{name}.
1635 @item -fdump-ada-spec@r{[}-slim@r{]}
1636 @opindex fdump-ada-spec
1637 For C and C++ source and include files, generate corresponding Ada specs.
1638 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1639 GNAT User's Guide}, which provides detailed documentation on this feature.
1641 @item -fada-spec-parent=@var{unit}
1642 @opindex fada-spec-parent
1643 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1644 Ada specs as child units of parent @var{unit}.
1646 @item -fdump-go-spec=@var{file}
1647 @opindex fdump-go-spec
1648 For input files in any language, generate corresponding Go
1649 declarations in @var{file}.  This generates Go @code{const},
1650 @code{type}, @code{var}, and @code{func} declarations which may be a
1651 useful way to start writing a Go interface to code written in some
1652 other language.
1654 @include @value{srcdir}/../libiberty/at-file.texi
1655 @end table
1657 @node Invoking G++
1658 @section Compiling C++ Programs
1660 @cindex suffixes for C++ source
1661 @cindex C++ source file suffixes
1662 C++ source files conventionally use one of the suffixes @samp{.C},
1663 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1664 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1665 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1666 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1667 files with these names and compiles them as C++ programs even if you
1668 call the compiler the same way as for compiling C programs (usually
1669 with the name @command{gcc}).
1671 @findex g++
1672 @findex c++
1673 However, the use of @command{gcc} does not add the C++ library.
1674 @command{g++} is a program that calls GCC and automatically specifies linking
1675 against the C++ library.  It treats @samp{.c},
1676 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1677 files unless @option{-x} is used.  This program is also useful when
1678 precompiling a C header file with a @samp{.h} extension for use in C++
1679 compilations.  On many systems, @command{g++} is also installed with
1680 the name @command{c++}.
1682 @cindex invoking @command{g++}
1683 When you compile C++ programs, you may specify many of the same
1684 command-line options that you use for compiling programs in any
1685 language; or command-line options meaningful for C and related
1686 languages; or options that are meaningful only for C++ programs.
1687 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1688 explanations of options for languages related to C@.
1689 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1690 explanations of options that are meaningful only for C++ programs.
1692 @node C Dialect Options
1693 @section Options Controlling C Dialect
1694 @cindex dialect options
1695 @cindex language dialect options
1696 @cindex options, dialect
1698 The following options control the dialect of C (or languages derived
1699 from C, such as C++, Objective-C and Objective-C++) that the compiler
1700 accepts:
1702 @table @gcctabopt
1703 @cindex ANSI support
1704 @cindex ISO support
1705 @item -ansi
1706 @opindex ansi
1707 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1708 equivalent to @option{-std=c++98}.
1710 This turns off certain features of GCC that are incompatible with ISO
1711 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1712 such as the @code{asm} and @code{typeof} keywords, and
1713 predefined macros such as @code{unix} and @code{vax} that identify the
1714 type of system you are using.  It also enables the undesirable and
1715 rarely used ISO trigraph feature.  For the C compiler,
1716 it disables recognition of C++ style @samp{//} comments as well as
1717 the @code{inline} keyword.
1719 The alternate keywords @code{__asm__}, @code{__extension__},
1720 @code{__inline__} and @code{__typeof__} continue to work despite
1721 @option{-ansi}.  You would not want to use them in an ISO C program, of
1722 course, but it is useful to put them in header files that might be included
1723 in compilations done with @option{-ansi}.  Alternate predefined macros
1724 such as @code{__unix__} and @code{__vax__} are also available, with or
1725 without @option{-ansi}.
1727 The @option{-ansi} option does not cause non-ISO programs to be
1728 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1729 addition to @option{-ansi}.  @xref{Warning Options}.
1731 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1732 option is used.  Some header files may notice this macro and refrain
1733 from declaring certain functions or defining certain macros that the
1734 ISO standard doesn't call for; this is to avoid interfering with any
1735 programs that might use these names for other things.
1737 Functions that are normally built in but do not have semantics
1738 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1739 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1740 built-in functions provided by GCC}, for details of the functions
1741 affected.
1743 @item -std=
1744 @opindex std
1745 Determine the language standard. @xref{Standards,,Language Standards
1746 Supported by GCC}, for details of these standard versions.  This option
1747 is currently only supported when compiling C or C++.
1749 The compiler can accept several base standards, such as @samp{c90} or
1750 @samp{c++98}, and GNU dialects of those standards, such as
1751 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1752 compiler accepts all programs following that standard plus those
1753 using GNU extensions that do not contradict it.  For example,
1754 @option{-std=c90} turns off certain features of GCC that are
1755 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1756 keywords, but not other GNU extensions that do not have a meaning in
1757 ISO C90, such as omitting the middle term of a @code{?:}
1758 expression. On the other hand, when a GNU dialect of a standard is
1759 specified, all features supported by the compiler are enabled, even when
1760 those features change the meaning of the base standard.  As a result, some
1761 strict-conforming programs may be rejected.  The particular standard
1762 is used by @option{-Wpedantic} to identify which features are GNU
1763 extensions given that version of the standard. For example
1764 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1765 comments, while @option{-std=gnu99 -Wpedantic} does not.
1767 A value for this option must be provided; possible values are
1769 @table @samp
1770 @item c90
1771 @itemx c89
1772 @itemx iso9899:1990
1773 Support all ISO C90 programs (certain GNU extensions that conflict
1774 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1776 @item iso9899:199409
1777 ISO C90 as modified in amendment 1.
1779 @item c99
1780 @itemx c9x
1781 @itemx iso9899:1999
1782 @itemx iso9899:199x
1783 ISO C99.  This standard is substantially completely supported, modulo
1784 bugs and floating-point issues
1785 (mainly but not entirely relating to optional C99 features from
1786 Annexes F and G).  See
1787 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1788 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1790 @item c11
1791 @itemx c1x
1792 @itemx iso9899:2011
1793 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1794 substantially completely supported, modulo bugs, floating-point issues
1795 (mainly but not entirely relating to optional C11 features from
1796 Annexes F and G) and the optional Annexes K (Bounds-checking
1797 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1799 @item gnu90
1800 @itemx gnu89
1801 GNU dialect of ISO C90 (including some C99 features).
1803 @item gnu99
1804 @itemx gnu9x
1805 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1807 @item gnu11
1808 @itemx gnu1x
1809 GNU dialect of ISO C11.  This is the default for C code.
1810 The name @samp{gnu1x} is deprecated.
1812 @item c++98
1813 @itemx c++03
1814 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1815 additional defect reports. Same as @option{-ansi} for C++ code.
1817 @item gnu++98
1818 @itemx gnu++03
1819 GNU dialect of @option{-std=c++98}.
1821 @item c++11
1822 @itemx c++0x
1823 The 2011 ISO C++ standard plus amendments.
1824 The name @samp{c++0x} is deprecated.
1826 @item gnu++11
1827 @itemx gnu++0x
1828 GNU dialect of @option{-std=c++11}.
1829 The name @samp{gnu++0x} is deprecated.
1831 @item c++14
1832 @itemx c++1y
1833 The 2014 ISO C++ standard plus amendments.
1834 The name @samp{c++1y} is deprecated.
1836 @item gnu++14
1837 @itemx gnu++1y
1838 GNU dialect of @option{-std=c++14}.
1839 This is the default for C++ code.
1840 The name @samp{gnu++1y} is deprecated.
1842 @item c++1z
1843 The next revision of the ISO C++ standard, tentatively planned for
1844 2017.  Support is highly experimental, and will almost certainly
1845 change in incompatible ways in future releases.
1847 @item gnu++1z
1848 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1849 and will almost certainly change in incompatible ways in future
1850 releases.
1851 @end table
1853 @item -fgnu89-inline
1854 @opindex fgnu89-inline
1855 The option @option{-fgnu89-inline} tells GCC to use the traditional
1856 GNU semantics for @code{inline} functions when in C99 mode.
1857 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1858 Using this option is roughly equivalent to adding the
1859 @code{gnu_inline} function attribute to all inline functions
1860 (@pxref{Function Attributes}).
1862 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1863 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1864 specifies the default behavior).
1865 This option is not supported in @option{-std=c90} or
1866 @option{-std=gnu90} mode.
1868 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1869 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1870 in effect for @code{inline} functions.  @xref{Common Predefined
1871 Macros,,,cpp,The C Preprocessor}.
1873 @item -aux-info @var{filename}
1874 @opindex aux-info
1875 Output to the given filename prototyped declarations for all functions
1876 declared and/or defined in a translation unit, including those in header
1877 files.  This option is silently ignored in any language other than C@.
1879 Besides declarations, the file indicates, in comments, the origin of
1880 each declaration (source file and line), whether the declaration was
1881 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1882 @samp{O} for old, respectively, in the first character after the line
1883 number and the colon), and whether it came from a declaration or a
1884 definition (@samp{C} or @samp{F}, respectively, in the following
1885 character).  In the case of function definitions, a K&R-style list of
1886 arguments followed by their declarations is also provided, inside
1887 comments, after the declaration.
1889 @item -fallow-parameterless-variadic-functions
1890 @opindex fallow-parameterless-variadic-functions
1891 Accept variadic functions without named parameters.
1893 Although it is possible to define such a function, this is not very
1894 useful as it is not possible to read the arguments.  This is only
1895 supported for C as this construct is allowed by C++.
1897 @item -fno-asm
1898 @opindex fno-asm
1899 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1900 keyword, so that code can use these words as identifiers.  You can use
1901 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1902 instead.  @option{-ansi} implies @option{-fno-asm}.
1904 In C++, this switch only affects the @code{typeof} keyword, since
1905 @code{asm} and @code{inline} are standard keywords.  You may want to
1906 use the @option{-fno-gnu-keywords} flag instead, which has the same
1907 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1908 switch only affects the @code{asm} and @code{typeof} keywords, since
1909 @code{inline} is a standard keyword in ISO C99.
1911 @item -fno-builtin
1912 @itemx -fno-builtin-@var{function}
1913 @opindex fno-builtin
1914 @cindex built-in functions
1915 Don't recognize built-in functions that do not begin with
1916 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1917 functions provided by GCC}, for details of the functions affected,
1918 including those which are not built-in functions when @option{-ansi} or
1919 @option{-std} options for strict ISO C conformance are used because they
1920 do not have an ISO standard meaning.
1922 GCC normally generates special code to handle certain built-in functions
1923 more efficiently; for instance, calls to @code{alloca} may become single
1924 instructions which adjust the stack directly, and calls to @code{memcpy}
1925 may become inline copy loops.  The resulting code is often both smaller
1926 and faster, but since the function calls no longer appear as such, you
1927 cannot set a breakpoint on those calls, nor can you change the behavior
1928 of the functions by linking with a different library.  In addition,
1929 when a function is recognized as a built-in function, GCC may use
1930 information about that function to warn about problems with calls to
1931 that function, or to generate more efficient code, even if the
1932 resulting code still contains calls to that function.  For example,
1933 warnings are given with @option{-Wformat} for bad calls to
1934 @code{printf} when @code{printf} is built in and @code{strlen} is
1935 known not to modify global memory.
1937 With the @option{-fno-builtin-@var{function}} option
1938 only the built-in function @var{function} is
1939 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1940 function is named that is not built-in in this version of GCC, this
1941 option is ignored.  There is no corresponding
1942 @option{-fbuiltin-@var{function}} option; if you wish to enable
1943 built-in functions selectively when using @option{-fno-builtin} or
1944 @option{-ffreestanding}, you may define macros such as:
1946 @smallexample
1947 #define abs(n)          __builtin_abs ((n))
1948 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1949 @end smallexample
1951 @item -fhosted
1952 @opindex fhosted
1953 @cindex hosted environment
1955 Assert that compilation targets a hosted environment.  This implies
1956 @option{-fbuiltin}.  A hosted environment is one in which the
1957 entire standard library is available, and in which @code{main} has a return
1958 type of @code{int}.  Examples are nearly everything except a kernel.
1959 This is equivalent to @option{-fno-freestanding}.
1961 @item -ffreestanding
1962 @opindex ffreestanding
1963 @cindex hosted environment
1965 Assert that compilation targets a freestanding environment.  This
1966 implies @option{-fno-builtin}.  A freestanding environment
1967 is one in which the standard library may not exist, and program startup may
1968 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1969 This is equivalent to @option{-fno-hosted}.
1971 @xref{Standards,,Language Standards Supported by GCC}, for details of
1972 freestanding and hosted environments.
1974 @item -fopenacc
1975 @opindex fopenacc
1976 @cindex OpenACC accelerator programming
1977 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1978 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1979 compiler generates accelerated code according to the OpenACC Application
1980 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1981 implies @option{-pthread}, and thus is only supported on targets that
1982 have support for @option{-pthread}.
1984 @item -fopenacc-dim=@var{geom}
1985 @opindex fopenacc-dim
1986 @cindex OpenACC accelerator programming
1987 Specify default compute dimensions for parallel offload regions that do
1988 not explicitly specify.  The @var{geom} value is a triple of
1989 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
1990 can be omitted, to use a target-specific default value.
1992 @item -fopenmp
1993 @opindex fopenmp
1994 @cindex OpenMP parallel
1995 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1996 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1997 compiler generates parallel code according to the OpenMP Application
1998 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1999 implies @option{-pthread}, and thus is only supported on targets that
2000 have support for @option{-pthread}. @option{-fopenmp} implies
2001 @option{-fopenmp-simd}.
2003 @item -fopenmp-simd
2004 @opindex fopenmp-simd
2005 @cindex OpenMP SIMD
2006 @cindex SIMD
2007 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2008 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2009 are ignored.
2011 @item -fcilkplus
2012 @opindex fcilkplus
2013 @cindex Enable Cilk Plus
2014 Enable the usage of Cilk Plus language extension features for C/C++.
2015 When the option @option{-fcilkplus} is specified, enable the usage of
2016 the Cilk Plus Language extension features for C/C++.  The present
2017 implementation follows ABI version 1.2.  This is an experimental
2018 feature that is only partially complete, and whose interface may
2019 change in future versions of GCC as the official specification
2020 changes.  Currently, all features but @code{_Cilk_for} have been
2021 implemented.
2023 @item -fgnu-tm
2024 @opindex fgnu-tm
2025 When the option @option{-fgnu-tm} is specified, the compiler
2026 generates code for the Linux variant of Intel's current Transactional
2027 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2028 an experimental feature whose interface may change in future versions
2029 of GCC, as the official specification changes.  Please note that not
2030 all architectures are supported for this feature.
2032 For more information on GCC's support for transactional memory,
2033 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2034 Transactional Memory Library}.
2036 Note that the transactional memory feature is not supported with
2037 non-call exceptions (@option{-fnon-call-exceptions}).
2039 @item -fms-extensions
2040 @opindex fms-extensions
2041 Accept some non-standard constructs used in Microsoft header files.
2043 In C++ code, this allows member names in structures to be similar
2044 to previous types declarations.
2046 @smallexample
2047 typedef int UOW;
2048 struct ABC @{
2049   UOW UOW;
2051 @end smallexample
2053 Some cases of unnamed fields in structures and unions are only
2054 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2055 fields within structs/unions}, for details.
2057 Note that this option is off for all targets but x86 
2058 targets using ms-abi.
2060 @item -fplan9-extensions
2061 @opindex fplan9-extensions
2062 Accept some non-standard constructs used in Plan 9 code.
2064 This enables @option{-fms-extensions}, permits passing pointers to
2065 structures with anonymous fields to functions that expect pointers to
2066 elements of the type of the field, and permits referring to anonymous
2067 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2068 struct/union fields within structs/unions}, for details.  This is only
2069 supported for C, not C++.
2071 @item -trigraphs
2072 @opindex trigraphs
2073 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2074 options for strict ISO C conformance) implies @option{-trigraphs}.
2076 @cindex traditional C language
2077 @cindex C language, traditional
2078 @item -traditional
2079 @itemx -traditional-cpp
2080 @opindex traditional-cpp
2081 @opindex traditional
2082 Formerly, these options caused GCC to attempt to emulate a pre-standard
2083 C compiler.  They are now only supported with the @option{-E} switch.
2084 The preprocessor continues to support a pre-standard mode.  See the GNU
2085 CPP manual for details.
2087 @item -fcond-mismatch
2088 @opindex fcond-mismatch
2089 Allow conditional expressions with mismatched types in the second and
2090 third arguments.  The value of such an expression is void.  This option
2091 is not supported for C++.
2093 @item -flax-vector-conversions
2094 @opindex flax-vector-conversions
2095 Allow implicit conversions between vectors with differing numbers of
2096 elements and/or incompatible element types.  This option should not be
2097 used for new code.
2099 @item -funsigned-char
2100 @opindex funsigned-char
2101 Let the type @code{char} be unsigned, like @code{unsigned char}.
2103 Each kind of machine has a default for what @code{char} should
2104 be.  It is either like @code{unsigned char} by default or like
2105 @code{signed char} by default.
2107 Ideally, a portable program should always use @code{signed char} or
2108 @code{unsigned char} when it depends on the signedness of an object.
2109 But many programs have been written to use plain @code{char} and
2110 expect it to be signed, or expect it to be unsigned, depending on the
2111 machines they were written for.  This option, and its inverse, let you
2112 make such a program work with the opposite default.
2114 The type @code{char} is always a distinct type from each of
2115 @code{signed char} or @code{unsigned char}, even though its behavior
2116 is always just like one of those two.
2118 @item -fsigned-char
2119 @opindex fsigned-char
2120 Let the type @code{char} be signed, like @code{signed char}.
2122 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2123 the negative form of @option{-funsigned-char}.  Likewise, the option
2124 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2126 @item -fsigned-bitfields
2127 @itemx -funsigned-bitfields
2128 @itemx -fno-signed-bitfields
2129 @itemx -fno-unsigned-bitfields
2130 @opindex fsigned-bitfields
2131 @opindex funsigned-bitfields
2132 @opindex fno-signed-bitfields
2133 @opindex fno-unsigned-bitfields
2134 These options control whether a bit-field is signed or unsigned, when the
2135 declaration does not use either @code{signed} or @code{unsigned}.  By
2136 default, such a bit-field is signed, because this is consistent: the
2137 basic integer types such as @code{int} are signed types.
2139 @item -fsso-struct=@var{endianness}
2140 @opindex fsso-struct
2141 Set the default scalar storage order of structures and unions to the
2142 specified endianness.  The accepted values are @samp{big-endian} and
2143 @samp{little-endian}.  If the option is not passed, the compiler uses
2144 the native endianness of the target.  This option is not supported for C++.
2146 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2147 code that is not binary compatible with code generated without it if the
2148 specified endianness is not the native endianness of the target.
2149 @end table
2151 @node C++ Dialect Options
2152 @section Options Controlling C++ Dialect
2154 @cindex compiler options, C++
2155 @cindex C++ options, command-line
2156 @cindex options, C++
2157 This section describes the command-line options that are only meaningful
2158 for C++ programs.  You can also use most of the GNU compiler options
2159 regardless of what language your program is in.  For example, you
2160 might compile a file @file{firstClass.C} like this:
2162 @smallexample
2163 g++ -g -fstrict-enums -O -c firstClass.C
2164 @end smallexample
2166 @noindent
2167 In this example, only @option{-fstrict-enums} is an option meant
2168 only for C++ programs; you can use the other options with any
2169 language supported by GCC@.
2171 Some options for compiling C programs, such as @option{-std}, are also
2172 relevant for C++ programs.
2173 @xref{C Dialect Options,,Options Controlling C Dialect}.
2175 Here is a list of options that are @emph{only} for compiling C++ programs:
2177 @table @gcctabopt
2179 @item -fabi-version=@var{n}
2180 @opindex fabi-version
2181 Use version @var{n} of the C++ ABI@.  The default is version 0.
2183 Version 0 refers to the version conforming most closely to
2184 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2185 will change in different versions of G++ as ABI bugs are fixed.
2187 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2189 Version 2 is the version of the C++ ABI that first appeared in G++
2190 3.4, and was the default through G++ 4.9.
2192 Version 3 corrects an error in mangling a constant address as a
2193 template argument.
2195 Version 4, which first appeared in G++ 4.5, implements a standard
2196 mangling for vector types.
2198 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2199 attribute const/volatile on function pointer types, decltype of a
2200 plain decl, and use of a function parameter in the declaration of
2201 another parameter.
2203 Version 6, which first appeared in G++ 4.7, corrects the promotion
2204 behavior of C++11 scoped enums and the mangling of template argument
2205 packs, const/static_cast, prefix ++ and --, and a class scope function
2206 used as a template argument.
2208 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2209 builtin type and corrects the mangling of lambdas in default argument
2210 scope.
2212 Version 8, which first appeared in G++ 4.9, corrects the substitution
2213 behavior of function types with function-cv-qualifiers.
2215 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2216 @code{nullptr_t}.
2218 Version 10, which first appeared in G++ 6.1, adds mangling of
2219 attributes that affect type identity, such as ia32 calling convention
2220 attributes (e.g. @samp{stdcall}).
2222 See also @option{-Wabi}.
2224 @item -fabi-compat-version=@var{n}
2225 @opindex fabi-compat-version
2226 On targets that support strong aliases, G++
2227 works around mangling changes by creating an alias with the correct
2228 mangled name when defining a symbol with an incorrect mangled name.
2229 This switch specifies which ABI version to use for the alias.
2231 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2232 compatibility).  If another ABI version is explicitly selected, this
2233 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2234 use @option{-fabi-compat-version=2}.
2236 If this option is not provided but @option{-Wabi=@var{n}} is, that
2237 version is used for compatibility aliases.  If this option is provided
2238 along with @option{-Wabi} (without the version), the version from this
2239 option is used for the warning.
2241 @item -fno-access-control
2242 @opindex fno-access-control
2243 Turn off all access checking.  This switch is mainly useful for working
2244 around bugs in the access control code.
2246 @item -faligned-new
2247 @opindex faligned-new
2248 Enable support for C++17 @code{new} of types that require more
2249 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2250 numeric argument such as @code{-faligned-new=32} can be used to
2251 specify how much alignment (in bytes) is provided by that function,
2252 but few users will need to override the default of
2253 @code{alignof(std::max_align_t)}.
2255 @item -fcheck-new
2256 @opindex fcheck-new
2257 Check that the pointer returned by @code{operator new} is non-null
2258 before attempting to modify the storage allocated.  This check is
2259 normally unnecessary because the C++ standard specifies that
2260 @code{operator new} only returns @code{0} if it is declared
2261 @code{throw()}, in which case the compiler always checks the
2262 return value even without this option.  In all other cases, when
2263 @code{operator new} has a non-empty exception specification, memory
2264 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2265 @samp{new (nothrow)}.
2267 @item -fconcepts
2268 @opindex fconcepts
2269 Enable support for the C++ Extensions for Concepts Technical
2270 Specification, ISO 19217 (2015), which allows code like
2272 @smallexample
2273 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2274 template <Addable T> T add (T a, T b) @{ return a + b; @}
2275 @end smallexample
2277 @item -fconstexpr-depth=@var{n}
2278 @opindex fconstexpr-depth
2279 Set the maximum nested evaluation depth for C++11 constexpr functions
2280 to @var{n}.  A limit is needed to detect endless recursion during
2281 constant expression evaluation.  The minimum specified by the standard
2282 is 512.
2284 @item -fconstexpr-loop-limit=@var{n}
2285 @opindex fconstexpr-loop-limit
2286 Set the maximum number of iterations for a loop in C++14 constexpr functions
2287 to @var{n}.  A limit is needed to detect infinite loops during
2288 constant expression evaluation.  The default is 262144 (1<<18).
2290 @item -fdeduce-init-list
2291 @opindex fdeduce-init-list
2292 Enable deduction of a template type parameter as
2293 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2295 @smallexample
2296 template <class T> auto forward(T t) -> decltype (realfn (t))
2298   return realfn (t);
2301 void f()
2303   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2305 @end smallexample
2307 This deduction was implemented as a possible extension to the
2308 originally proposed semantics for the C++11 standard, but was not part
2309 of the final standard, so it is disabled by default.  This option is
2310 deprecated, and may be removed in a future version of G++.
2312 @item -ffriend-injection
2313 @opindex ffriend-injection
2314 Inject friend functions into the enclosing namespace, so that they are
2315 visible outside the scope of the class in which they are declared.
2316 Friend functions were documented to work this way in the old Annotated
2317 C++ Reference Manual.  
2318 However, in ISO C++ a friend function that is not declared
2319 in an enclosing scope can only be found using argument dependent
2320 lookup.  GCC defaults to the standard behavior.
2322 This option is for compatibility, and may be removed in a future
2323 release of G++.
2325 @item -fno-elide-constructors
2326 @opindex fno-elide-constructors
2327 The C++ standard allows an implementation to omit creating a temporary
2328 that is only used to initialize another object of the same type.
2329 Specifying this option disables that optimization, and forces G++ to
2330 call the copy constructor in all cases.  This option also causes G++
2331 to call trivial member functions which otherwise would be expanded inline.
2333 In C++17, the compiler is required to omit these temporaries, but this
2334 option still affects trivial member functions.
2336 @item -fno-enforce-eh-specs
2337 @opindex fno-enforce-eh-specs
2338 Don't generate code to check for violation of exception specifications
2339 at run time.  This option violates the C++ standard, but may be useful
2340 for reducing code size in production builds, much like defining
2341 @code{NDEBUG}.  This does not give user code permission to throw
2342 exceptions in violation of the exception specifications; the compiler
2343 still optimizes based on the specifications, so throwing an
2344 unexpected exception results in undefined behavior at run time.
2346 @item -fextern-tls-init
2347 @itemx -fno-extern-tls-init
2348 @opindex fextern-tls-init
2349 @opindex fno-extern-tls-init
2350 The C++11 and OpenMP standards allow @code{thread_local} and
2351 @code{threadprivate} variables to have dynamic (runtime)
2352 initialization.  To support this, any use of such a variable goes
2353 through a wrapper function that performs any necessary initialization.
2354 When the use and definition of the variable are in the same
2355 translation unit, this overhead can be optimized away, but when the
2356 use is in a different translation unit there is significant overhead
2357 even if the variable doesn't actually need dynamic initialization.  If
2358 the programmer can be sure that no use of the variable in a
2359 non-defining TU needs to trigger dynamic initialization (either
2360 because the variable is statically initialized, or a use of the
2361 variable in the defining TU will be executed before any uses in
2362 another TU), they can avoid this overhead with the
2363 @option{-fno-extern-tls-init} option.
2365 On targets that support symbol aliases, the default is
2366 @option{-fextern-tls-init}.  On targets that do not support symbol
2367 aliases, the default is @option{-fno-extern-tls-init}.
2369 @item -ffor-scope
2370 @itemx -fno-for-scope
2371 @opindex ffor-scope
2372 @opindex fno-for-scope
2373 If @option{-ffor-scope} is specified, the scope of variables declared in
2374 a @i{for-init-statement} is limited to the @code{for} loop itself,
2375 as specified by the C++ standard.
2376 If @option{-fno-for-scope} is specified, the scope of variables declared in
2377 a @i{for-init-statement} extends to the end of the enclosing scope,
2378 as was the case in old versions of G++, and other (traditional)
2379 implementations of C++.
2381 If neither flag is given, the default is to follow the standard,
2382 but to allow and give a warning for old-style code that would
2383 otherwise be invalid, or have different behavior.
2385 @item -fno-gnu-keywords
2386 @opindex fno-gnu-keywords
2387 Do not recognize @code{typeof} as a keyword, so that code can use this
2388 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2389 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2390 @option{-std=c++98}, @option{-std=c++11}, etc.
2392 @item -fno-implicit-templates
2393 @opindex fno-implicit-templates
2394 Never emit code for non-inline templates that are instantiated
2395 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2396 @xref{Template Instantiation}, for more information.
2398 @item -fno-implicit-inline-templates
2399 @opindex fno-implicit-inline-templates
2400 Don't emit code for implicit instantiations of inline templates, either.
2401 The default is to handle inlines differently so that compiles with and
2402 without optimization need the same set of explicit instantiations.
2404 @item -fno-implement-inlines
2405 @opindex fno-implement-inlines
2406 To save space, do not emit out-of-line copies of inline functions
2407 controlled by @code{#pragma implementation}.  This causes linker
2408 errors if these functions are not inlined everywhere they are called.
2410 @item -fms-extensions
2411 @opindex fms-extensions
2412 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2413 int and getting a pointer to member function via non-standard syntax.
2415 @item -fno-nonansi-builtins
2416 @opindex fno-nonansi-builtins
2417 Disable built-in declarations of functions that are not mandated by
2418 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2419 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2421 @item -fnothrow-opt
2422 @opindex fnothrow-opt
2423 Treat a @code{throw()} exception specification as if it were a
2424 @code{noexcept} specification to reduce or eliminate the text size
2425 overhead relative to a function with no exception specification.  If
2426 the function has local variables of types with non-trivial
2427 destructors, the exception specification actually makes the
2428 function smaller because the EH cleanups for those variables can be
2429 optimized away.  The semantic effect is that an exception thrown out of
2430 a function with such an exception specification results in a call
2431 to @code{terminate} rather than @code{unexpected}.
2433 @item -fno-operator-names
2434 @opindex fno-operator-names
2435 Do not treat the operator name keywords @code{and}, @code{bitand},
2436 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2437 synonyms as keywords.
2439 @item -fno-optional-diags
2440 @opindex fno-optional-diags
2441 Disable diagnostics that the standard says a compiler does not need to
2442 issue.  Currently, the only such diagnostic issued by G++ is the one for
2443 a name having multiple meanings within a class.
2445 @item -fpermissive
2446 @opindex fpermissive
2447 Downgrade some diagnostics about nonconformant code from errors to
2448 warnings.  Thus, using @option{-fpermissive} allows some
2449 nonconforming code to compile.
2451 @item -fno-pretty-templates
2452 @opindex fno-pretty-templates
2453 When an error message refers to a specialization of a function
2454 template, the compiler normally prints the signature of the
2455 template followed by the template arguments and any typedefs or
2456 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2457 rather than @code{void f(int)}) so that it's clear which template is
2458 involved.  When an error message refers to a specialization of a class
2459 template, the compiler omits any template arguments that match
2460 the default template arguments for that template.  If either of these
2461 behaviors make it harder to understand the error message rather than
2462 easier, you can use @option{-fno-pretty-templates} to disable them.
2464 @item -frepo
2465 @opindex frepo
2466 Enable automatic template instantiation at link time.  This option also
2467 implies @option{-fno-implicit-templates}.  @xref{Template
2468 Instantiation}, for more information.
2470 @item -fno-rtti
2471 @opindex fno-rtti
2472 Disable generation of information about every class with virtual
2473 functions for use by the C++ run-time type identification features
2474 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2475 of the language, you can save some space by using this flag.  Note that
2476 exception handling uses the same information, but G++ generates it as
2477 needed. The @code{dynamic_cast} operator can still be used for casts that
2478 do not require run-time type information, i.e.@: casts to @code{void *} or to
2479 unambiguous base classes.
2481 @item -fsized-deallocation
2482 @opindex fsized-deallocation
2483 Enable the built-in global declarations
2484 @smallexample
2485 void operator delete (void *, std::size_t) noexcept;
2486 void operator delete[] (void *, std::size_t) noexcept;
2487 @end smallexample
2488 as introduced in C++14.  This is useful for user-defined replacement
2489 deallocation functions that, for example, use the size of the object
2490 to make deallocation faster.  Enabled by default under
2491 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2492 warns about places that might want to add a definition.
2494 @item -fstrict-enums
2495 @opindex fstrict-enums
2496 Allow the compiler to optimize using the assumption that a value of
2497 enumerated type can only be one of the values of the enumeration (as
2498 defined in the C++ standard; basically, a value that can be
2499 represented in the minimum number of bits needed to represent all the
2500 enumerators).  This assumption may not be valid if the program uses a
2501 cast to convert an arbitrary integer value to the enumerated type.
2503 @item -fstrong-eval-order
2504 @opindex fstrong-eval-order
2505 Evaluate member access, array subscripting, and shift expressions in
2506 left-to-right order, and evaluate assignment in right-to-left order,
2507 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2508 @option{-fstrong-eval-order=some} enables just the ordering of member
2509 access and shift expressions, and is the default without
2510 @option{-std=c++1z}.
2512 @item -ftemplate-backtrace-limit=@var{n}
2513 @opindex ftemplate-backtrace-limit
2514 Set the maximum number of template instantiation notes for a single
2515 warning or error to @var{n}.  The default value is 10.
2517 @item -ftemplate-depth=@var{n}
2518 @opindex ftemplate-depth
2519 Set the maximum instantiation depth for template classes to @var{n}.
2520 A limit on the template instantiation depth is needed to detect
2521 endless recursions during template class instantiation.  ANSI/ISO C++
2522 conforming programs must not rely on a maximum depth greater than 17
2523 (changed to 1024 in C++11).  The default value is 900, as the compiler
2524 can run out of stack space before hitting 1024 in some situations.
2526 @item -fno-threadsafe-statics
2527 @opindex fno-threadsafe-statics
2528 Do not emit the extra code to use the routines specified in the C++
2529 ABI for thread-safe initialization of local statics.  You can use this
2530 option to reduce code size slightly in code that doesn't need to be
2531 thread-safe.
2533 @item -fuse-cxa-atexit
2534 @opindex fuse-cxa-atexit
2535 Register destructors for objects with static storage duration with the
2536 @code{__cxa_atexit} function rather than the @code{atexit} function.
2537 This option is required for fully standards-compliant handling of static
2538 destructors, but only works if your C library supports
2539 @code{__cxa_atexit}.
2541 @item -fno-use-cxa-get-exception-ptr
2542 @opindex fno-use-cxa-get-exception-ptr
2543 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2544 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2545 if the runtime routine is not available.
2547 @item -fvisibility-inlines-hidden
2548 @opindex fvisibility-inlines-hidden
2549 This switch declares that the user does not attempt to compare
2550 pointers to inline functions or methods where the addresses of the two functions
2551 are taken in different shared objects.
2553 The effect of this is that GCC may, effectively, mark inline methods with
2554 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2555 appear in the export table of a DSO and do not require a PLT indirection
2556 when used within the DSO@.  Enabling this option can have a dramatic effect
2557 on load and link times of a DSO as it massively reduces the size of the
2558 dynamic export table when the library makes heavy use of templates.
2560 The behavior of this switch is not quite the same as marking the
2561 methods as hidden directly, because it does not affect static variables
2562 local to the function or cause the compiler to deduce that
2563 the function is defined in only one shared object.
2565 You may mark a method as having a visibility explicitly to negate the
2566 effect of the switch for that method.  For example, if you do want to
2567 compare pointers to a particular inline method, you might mark it as
2568 having default visibility.  Marking the enclosing class with explicit
2569 visibility has no effect.
2571 Explicitly instantiated inline methods are unaffected by this option
2572 as their linkage might otherwise cross a shared library boundary.
2573 @xref{Template Instantiation}.
2575 @item -fvisibility-ms-compat
2576 @opindex fvisibility-ms-compat
2577 This flag attempts to use visibility settings to make GCC's C++
2578 linkage model compatible with that of Microsoft Visual Studio.
2580 The flag makes these changes to GCC's linkage model:
2582 @enumerate
2583 @item
2584 It sets the default visibility to @code{hidden}, like
2585 @option{-fvisibility=hidden}.
2587 @item
2588 Types, but not their members, are not hidden by default.
2590 @item
2591 The One Definition Rule is relaxed for types without explicit
2592 visibility specifications that are defined in more than one
2593 shared object: those declarations are permitted if they are
2594 permitted when this option is not used.
2595 @end enumerate
2597 In new code it is better to use @option{-fvisibility=hidden} and
2598 export those classes that are intended to be externally visible.
2599 Unfortunately it is possible for code to rely, perhaps accidentally,
2600 on the Visual Studio behavior.
2602 Among the consequences of these changes are that static data members
2603 of the same type with the same name but defined in different shared
2604 objects are different, so changing one does not change the other;
2605 and that pointers to function members defined in different shared
2606 objects may not compare equal.  When this flag is given, it is a
2607 violation of the ODR to define types with the same name differently.
2609 @item -fno-weak
2610 @opindex fno-weak
2611 Do not use weak symbol support, even if it is provided by the linker.
2612 By default, G++ uses weak symbols if they are available.  This
2613 option exists only for testing, and should not be used by end-users;
2614 it results in inferior code and has no benefits.  This option may
2615 be removed in a future release of G++.
2617 @item -nostdinc++
2618 @opindex nostdinc++
2619 Do not search for header files in the standard directories specific to
2620 C++, but do still search the other standard directories.  (This option
2621 is used when building the C++ library.)
2622 @end table
2624 In addition, these optimization, warning, and code generation options
2625 have meanings only for C++ programs:
2627 @table @gcctabopt
2628 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2629 @opindex Wabi
2630 @opindex Wno-abi
2631 Warn when G++ it generates code that is probably not compatible with
2632 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2633 ABI with each major release, normally @option{-Wabi} will warn only if
2634 there is a check added later in a release series for an ABI issue
2635 discovered since the initial release.  @option{-Wabi} will warn about
2636 more things if an older ABI version is selected (with
2637 @option{-fabi-version=@var{n}}).
2639 @option{-Wabi} can also be used with an explicit version number to
2640 warn about compatibility with a particular @option{-fabi-version}
2641 level, e.g. @option{-Wabi=2} to warn about changes relative to
2642 @option{-fabi-version=2}.
2644 If an explicit version number is provided and
2645 @option{-fabi-compat-version} is not specified, the version number
2646 from this option is used for compatibility aliases.  If no explicit
2647 version number is provided with this option, but
2648 @option{-fabi-compat-version} is specified, that version number is
2649 used for ABI warnings.
2651 Although an effort has been made to warn about
2652 all such cases, there are probably some cases that are not warned about,
2653 even though G++ is generating incompatible code.  There may also be
2654 cases where warnings are emitted even though the code that is generated
2655 is compatible.
2657 You should rewrite your code to avoid these warnings if you are
2658 concerned about the fact that code generated by G++ may not be binary
2659 compatible with code generated by other compilers.
2661 Known incompatibilities in @option{-fabi-version=2} (which was the
2662 default from GCC 3.4 to 4.9) include:
2664 @itemize @bullet
2666 @item
2667 A template with a non-type template parameter of reference type was
2668 mangled incorrectly:
2669 @smallexample
2670 extern int N;
2671 template <int &> struct S @{@};
2672 void n (S<N>) @{2@}
2673 @end smallexample
2675 This was fixed in @option{-fabi-version=3}.
2677 @item
2678 SIMD vector types declared using @code{__attribute ((vector_size))} were
2679 mangled in a non-standard way that does not allow for overloading of
2680 functions taking vectors of different sizes.
2682 The mangling was changed in @option{-fabi-version=4}.
2684 @item
2685 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2686 qualifiers, and @code{decltype} of a plain declaration was folded away.
2688 These mangling issues were fixed in @option{-fabi-version=5}.
2690 @item
2691 Scoped enumerators passed as arguments to a variadic function are
2692 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2693 On most targets this does not actually affect the parameter passing
2694 ABI, as there is no way to pass an argument smaller than @code{int}.
2696 Also, the ABI changed the mangling of template argument packs,
2697 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2698 a class scope function used as a template argument.
2700 These issues were corrected in @option{-fabi-version=6}.
2702 @item
2703 Lambdas in default argument scope were mangled incorrectly, and the
2704 ABI changed the mangling of @code{nullptr_t}.
2706 These issues were corrected in @option{-fabi-version=7}.
2708 @item
2709 When mangling a function type with function-cv-qualifiers, the
2710 un-qualified function type was incorrectly treated as a substitution
2711 candidate.
2713 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2715 @item
2716 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2717 unaligned accesses.  Note that this did not affect the ABI of a
2718 function with a @code{nullptr_t} parameter, as parameters have a
2719 minimum alignment.
2721 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2723 @item
2724 Target-specific attributes that affect the identity of a type, such as
2725 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2726 did not affect the mangled name, leading to name collisions when
2727 function pointers were used as template arguments.
2729 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2731 @end itemize
2733 It also warns about psABI-related changes.  The known psABI changes at this
2734 point include:
2736 @itemize @bullet
2738 @item
2739 For SysV/x86-64, unions with @code{long double} members are 
2740 passed in memory as specified in psABI.  For example:
2742 @smallexample
2743 union U @{
2744   long double ld;
2745   int i;
2747 @end smallexample
2749 @noindent
2750 @code{union U} is always passed in memory.
2752 @end itemize
2754 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2755 @opindex Wabi-tag
2756 @opindex -Wabi-tag
2757 Warn when a type with an ABI tag is used in a context that does not
2758 have that ABI tag.  See @ref{C++ Attributes} for more information
2759 about ABI tags.
2761 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2762 @opindex Wctor-dtor-privacy
2763 @opindex Wno-ctor-dtor-privacy
2764 Warn when a class seems unusable because all the constructors or
2765 destructors in that class are private, and it has neither friends nor
2766 public static member functions.  Also warn if there are no non-private
2767 methods, and there's at least one private member function that isn't
2768 a constructor or destructor.
2770 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2771 @opindex Wdelete-non-virtual-dtor
2772 @opindex Wno-delete-non-virtual-dtor
2773 Warn when @code{delete} is used to destroy an instance of a class that
2774 has virtual functions and non-virtual destructor. It is unsafe to delete
2775 an instance of a derived class through a pointer to a base class if the
2776 base class does not have a virtual destructor.  This warning is enabled
2777 by @option{-Wall}.
2779 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2780 @opindex Wliteral-suffix
2781 @opindex Wno-literal-suffix
2782 Warn when a string or character literal is followed by a ud-suffix which does
2783 not begin with an underscore.  As a conforming extension, GCC treats such
2784 suffixes as separate preprocessing tokens in order to maintain backwards
2785 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2786 For example:
2788 @smallexample
2789 #define __STDC_FORMAT_MACROS
2790 #include <inttypes.h>
2791 #include <stdio.h>
2793 int main() @{
2794   int64_t i64 = 123;
2795   printf("My int64: %" PRId64"\n", i64);
2797 @end smallexample
2799 In this case, @code{PRId64} is treated as a separate preprocessing token.
2801 This warning is enabled by default.
2803 @item -Wlto-type-mismatch
2804 @opindex Wlto-type-mismatch
2805 @opindex Wno-lto-type-mismatch
2807 During the link-time optimization warn about type mismatches in
2808 global declarations from different compilation units.
2809 Requires @option{-flto} to be enabled.  Enabled by default.
2811 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2812 @opindex Wnarrowing
2813 @opindex Wno-narrowing
2814 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2815 conversion prohibited by C++11 occurs within
2816 @samp{@{ @}}, e.g.
2818 @smallexample
2819 int i = @{ 2.2 @}; // error: narrowing from double to int
2820 @end smallexample
2822 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2824 When a later standard is in effect, e.g. when using @option{-std=c++11},
2825 narrowing conversions are diagnosed by default, as required by the standard.
2826 A narrowing conversion from a constant produces an error,
2827 and a narrowing conversion from a non-constant produces a warning,
2828 but @option{-Wno-narrowing} suppresses the diagnostic.
2829 Note that this does not affect the meaning of well-formed code;
2830 narrowing conversions are still considered ill-formed in SFINAE contexts.
2832 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2833 @opindex Wnoexcept
2834 @opindex Wno-noexcept
2835 Warn when a noexcept-expression evaluates to false because of a call
2836 to a function that does not have a non-throwing exception
2837 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2838 the compiler to never throw an exception.
2840 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2841 @opindex Wnon-virtual-dtor
2842 @opindex Wno-non-virtual-dtor
2843 Warn when a class has virtual functions and an accessible non-virtual
2844 destructor itself or in an accessible polymorphic base class, in which
2845 case it is possible but unsafe to delete an instance of a derived
2846 class through a pointer to the class itself or base class.  This
2847 warning is automatically enabled if @option{-Weffc++} is specified.
2849 @item -Wregister @r{(C++ and Objective-C++ only)}
2850 @opindex Wregister
2851 @opindex Wno-register
2852 Warn on uses of the @code{register} storage class specifier, except
2853 when it is part of the GNU @ref{Explicit Register Variables} extension.
2854 The use of the @code{register} keyword as storage class specifier has
2855 been deprecated in C++11 and removed in C++17.
2856 Enabled by default with @option{-std=c++1z}.
2858 @item -Wreorder @r{(C++ and Objective-C++ only)}
2859 @opindex Wreorder
2860 @opindex Wno-reorder
2861 @cindex reordering, warning
2862 @cindex warning for reordering of member initializers
2863 Warn when the order of member initializers given in the code does not
2864 match the order in which they must be executed.  For instance:
2866 @smallexample
2867 struct A @{
2868   int i;
2869   int j;
2870   A(): j (0), i (1) @{ @}
2872 @end smallexample
2874 @noindent
2875 The compiler rearranges the member initializers for @code{i}
2876 and @code{j} to match the declaration order of the members, emitting
2877 a warning to that effect.  This warning is enabled by @option{-Wall}.
2879 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2880 @opindex fext-numeric-literals
2881 @opindex fno-ext-numeric-literals
2882 Accept imaginary, fixed-point, or machine-defined
2883 literal number suffixes as GNU extensions.
2884 When this option is turned off these suffixes are treated
2885 as C++11 user-defined literal numeric suffixes.
2886 This is on by default for all pre-C++11 dialects and all GNU dialects:
2887 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2888 @option{-std=gnu++14}.
2889 This option is off by default
2890 for ISO C++11 onwards (@option{-std=c++11}, ...).
2891 @end table
2893 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2895 @table @gcctabopt
2896 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2897 @opindex Weffc++
2898 @opindex Wno-effc++
2899 Warn about violations of the following style guidelines from Scott Meyers'
2900 @cite{Effective C++} series of books:
2902 @itemize @bullet
2903 @item
2904 Define a copy constructor and an assignment operator for classes
2905 with dynamically-allocated memory.
2907 @item
2908 Prefer initialization to assignment in constructors.
2910 @item
2911 Have @code{operator=} return a reference to @code{*this}.
2913 @item
2914 Don't try to return a reference when you must return an object.
2916 @item
2917 Distinguish between prefix and postfix forms of increment and
2918 decrement operators.
2920 @item
2921 Never overload @code{&&}, @code{||}, or @code{,}.
2923 @end itemize
2925 This option also enables @option{-Wnon-virtual-dtor}, which is also
2926 one of the effective C++ recommendations.  However, the check is
2927 extended to warn about the lack of virtual destructor in accessible
2928 non-polymorphic bases classes too.
2930 When selecting this option, be aware that the standard library
2931 headers do not obey all of these guidelines; use @samp{grep -v}
2932 to filter out those warnings.
2934 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2935 @opindex Wstrict-null-sentinel
2936 @opindex Wno-strict-null-sentinel
2937 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2938 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2939 to @code{__null}.  Although it is a null pointer constant rather than a
2940 null pointer, it is guaranteed to be of the same size as a pointer.
2941 But this use is not portable across different compilers.
2943 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2944 @opindex Wno-non-template-friend
2945 @opindex Wnon-template-friend
2946 Disable warnings when non-templatized friend functions are declared
2947 within a template.  Since the advent of explicit template specification
2948 support in G++, if the name of the friend is an unqualified-id (i.e.,
2949 @samp{friend foo(int)}), the C++ language specification demands that the
2950 friend declare or define an ordinary, nontemplate function.  (Section
2951 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2952 could be interpreted as a particular specialization of a templatized
2953 function.  Because this non-conforming behavior is no longer the default
2954 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2955 check existing code for potential trouble spots and is on by default.
2956 This new compiler behavior can be turned off with
2957 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2958 but disables the helpful warning.
2960 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2961 @opindex Wold-style-cast
2962 @opindex Wno-old-style-cast
2963 Warn if an old-style (C-style) cast to a non-void type is used within
2964 a C++ program.  The new-style casts (@code{dynamic_cast},
2965 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2966 less vulnerable to unintended effects and much easier to search for.
2968 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2969 @opindex Woverloaded-virtual
2970 @opindex Wno-overloaded-virtual
2971 @cindex overloaded virtual function, warning
2972 @cindex warning for overloaded virtual function
2973 Warn when a function declaration hides virtual functions from a
2974 base class.  For example, in:
2976 @smallexample
2977 struct A @{
2978   virtual void f();
2981 struct B: public A @{
2982   void f(int);
2984 @end smallexample
2986 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2987 like:
2989 @smallexample
2990 B* b;
2991 b->f();
2992 @end smallexample
2994 @noindent
2995 fails to compile.
2997 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2998 @opindex Wno-pmf-conversions
2999 @opindex Wpmf-conversions
3000 Disable the diagnostic for converting a bound pointer to member function
3001 to a plain pointer.
3003 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3004 @opindex Wsign-promo
3005 @opindex Wno-sign-promo
3006 Warn when overload resolution chooses a promotion from unsigned or
3007 enumerated type to a signed type, over a conversion to an unsigned type of
3008 the same size.  Previous versions of G++ tried to preserve
3009 unsignedness, but the standard mandates the current behavior.
3011 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3012 @opindex Wtemplates
3013 Warn when a primary template declaration is encountered.  Some coding
3014 rules disallow templates, and this may be used to enforce that rule.
3015 The warning is inactive inside a system header file, such as the STL, so
3016 one can still use the STL.  One may also instantiate or specialize
3017 templates.
3019 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3020 @opindex Wmultiple-inheritance
3021 Warn when a class is defined with multiple direct base classes.  Some
3022 coding rules disallow multiple inheritance, and this may be used to
3023 enforce that rule.  The warning is inactive inside a system header file,
3024 such as the STL, so one can still use the STL.  One may also define
3025 classes that indirectly use multiple inheritance.
3027 @item -Wvirtual-inheritance
3028 @opindex Wvirtual-inheritance
3029 Warn when a class is defined with a virtual direct base classe.  Some
3030 coding rules disallow multiple inheritance, and this may be used to
3031 enforce that rule.  The warning is inactive inside a system header file,
3032 such as the STL, so one can still use the STL.  One may also define
3033 classes that indirectly use virtual inheritance.
3035 @item -Wnamespaces
3036 @opindex Wnamespaces
3037 Warn when a namespace definition is opened.  Some coding rules disallow
3038 namespaces, and this may be used to enforce that rule.  The warning is
3039 inactive inside a system header file, such as the STL, so one can still
3040 use the STL.  One may also use using directives and qualified names.
3042 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3043 @opindex Wterminate
3044 @opindex Wno-terminate
3045 Disable the warning about a throw-expression that will immediately
3046 result in a call to @code{terminate}.
3047 @end table
3049 @node Objective-C and Objective-C++ Dialect Options
3050 @section Options Controlling Objective-C and Objective-C++ Dialects
3052 @cindex compiler options, Objective-C and Objective-C++
3053 @cindex Objective-C and Objective-C++ options, command-line
3054 @cindex options, Objective-C and Objective-C++
3055 (NOTE: This manual does not describe the Objective-C and Objective-C++
3056 languages themselves.  @xref{Standards,,Language Standards
3057 Supported by GCC}, for references.)
3059 This section describes the command-line options that are only meaningful
3060 for Objective-C and Objective-C++ programs.  You can also use most of
3061 the language-independent GNU compiler options.
3062 For example, you might compile a file @file{some_class.m} like this:
3064 @smallexample
3065 gcc -g -fgnu-runtime -O -c some_class.m
3066 @end smallexample
3068 @noindent
3069 In this example, @option{-fgnu-runtime} is an option meant only for
3070 Objective-C and Objective-C++ programs; you can use the other options with
3071 any language supported by GCC@.
3073 Note that since Objective-C is an extension of the C language, Objective-C
3074 compilations may also use options specific to the C front-end (e.g.,
3075 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3076 C++-specific options (e.g., @option{-Wabi}).
3078 Here is a list of options that are @emph{only} for compiling Objective-C
3079 and Objective-C++ programs:
3081 @table @gcctabopt
3082 @item -fconstant-string-class=@var{class-name}
3083 @opindex fconstant-string-class
3084 Use @var{class-name} as the name of the class to instantiate for each
3085 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3086 class name is @code{NXConstantString} if the GNU runtime is being used, and
3087 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3088 @option{-fconstant-cfstrings} option, if also present, overrides the
3089 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3090 to be laid out as constant CoreFoundation strings.
3092 @item -fgnu-runtime
3093 @opindex fgnu-runtime
3094 Generate object code compatible with the standard GNU Objective-C
3095 runtime.  This is the default for most types of systems.
3097 @item -fnext-runtime
3098 @opindex fnext-runtime
3099 Generate output compatible with the NeXT runtime.  This is the default
3100 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3101 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3102 used.
3104 @item -fno-nil-receivers
3105 @opindex fno-nil-receivers
3106 Assume that all Objective-C message dispatches (@code{[receiver
3107 message:arg]}) in this translation unit ensure that the receiver is
3108 not @code{nil}.  This allows for more efficient entry points in the
3109 runtime to be used.  This option is only available in conjunction with
3110 the NeXT runtime and ABI version 0 or 1.
3112 @item -fobjc-abi-version=@var{n}
3113 @opindex fobjc-abi-version
3114 Use version @var{n} of the Objective-C ABI for the selected runtime.
3115 This option is currently supported only for the NeXT runtime.  In that
3116 case, Version 0 is the traditional (32-bit) ABI without support for
3117 properties and other Objective-C 2.0 additions.  Version 1 is the
3118 traditional (32-bit) ABI with support for properties and other
3119 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3120 nothing is specified, the default is Version 0 on 32-bit target
3121 machines, and Version 2 on 64-bit target machines.
3123 @item -fobjc-call-cxx-cdtors
3124 @opindex fobjc-call-cxx-cdtors
3125 For each Objective-C class, check if any of its instance variables is a
3126 C++ object with a non-trivial default constructor.  If so, synthesize a
3127 special @code{- (id) .cxx_construct} instance method which runs
3128 non-trivial default constructors on any such instance variables, in order,
3129 and then return @code{self}.  Similarly, check if any instance variable
3130 is a C++ object with a non-trivial destructor, and if so, synthesize a
3131 special @code{- (void) .cxx_destruct} method which runs
3132 all such default destructors, in reverse order.
3134 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3135 methods thusly generated only operate on instance variables
3136 declared in the current Objective-C class, and not those inherited
3137 from superclasses.  It is the responsibility of the Objective-C
3138 runtime to invoke all such methods in an object's inheritance
3139 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3140 by the runtime immediately after a new object instance is allocated;
3141 the @code{- (void) .cxx_destruct} methods are invoked immediately
3142 before the runtime deallocates an object instance.
3144 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3145 support for invoking the @code{- (id) .cxx_construct} and
3146 @code{- (void) .cxx_destruct} methods.
3148 @item -fobjc-direct-dispatch
3149 @opindex fobjc-direct-dispatch
3150 Allow fast jumps to the message dispatcher.  On Darwin this is
3151 accomplished via the comm page.
3153 @item -fobjc-exceptions
3154 @opindex fobjc-exceptions
3155 Enable syntactic support for structured exception handling in
3156 Objective-C, similar to what is offered by C++ and Java.  This option
3157 is required to use the Objective-C keywords @code{@@try},
3158 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3159 @code{@@synchronized}.  This option is available with both the GNU
3160 runtime and the NeXT runtime (but not available in conjunction with
3161 the NeXT runtime on Mac OS X 10.2 and earlier).
3163 @item -fobjc-gc
3164 @opindex fobjc-gc
3165 Enable garbage collection (GC) in Objective-C and Objective-C++
3166 programs.  This option is only available with the NeXT runtime; the
3167 GNU runtime has a different garbage collection implementation that
3168 does not require special compiler flags.
3170 @item -fobjc-nilcheck
3171 @opindex fobjc-nilcheck
3172 For the NeXT runtime with version 2 of the ABI, check for a nil
3173 receiver in method invocations before doing the actual method call.
3174 This is the default and can be disabled using
3175 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3176 checked for nil in this way no matter what this flag is set to.
3177 Currently this flag does nothing when the GNU runtime, or an older
3178 version of the NeXT runtime ABI, is used.
3180 @item -fobjc-std=objc1
3181 @opindex fobjc-std
3182 Conform to the language syntax of Objective-C 1.0, the language
3183 recognized by GCC 4.0.  This only affects the Objective-C additions to
3184 the C/C++ language; it does not affect conformance to C/C++ standards,
3185 which is controlled by the separate C/C++ dialect option flags.  When
3186 this option is used with the Objective-C or Objective-C++ compiler,
3187 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3188 This is useful if you need to make sure that your Objective-C code can
3189 be compiled with older versions of GCC@.
3191 @item -freplace-objc-classes
3192 @opindex freplace-objc-classes
3193 Emit a special marker instructing @command{ld(1)} not to statically link in
3194 the resulting object file, and allow @command{dyld(1)} to load it in at
3195 run time instead.  This is used in conjunction with the Fix-and-Continue
3196 debugging mode, where the object file in question may be recompiled and
3197 dynamically reloaded in the course of program execution, without the need
3198 to restart the program itself.  Currently, Fix-and-Continue functionality
3199 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3200 and later.
3202 @item -fzero-link
3203 @opindex fzero-link
3204 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3205 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3206 compile time) with static class references that get initialized at load time,
3207 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3208 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3209 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3210 for individual class implementations to be modified during program execution.
3211 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3212 regardless of command-line options.
3214 @item -fno-local-ivars
3215 @opindex fno-local-ivars
3216 @opindex flocal-ivars
3217 By default instance variables in Objective-C can be accessed as if
3218 they were local variables from within the methods of the class they're
3219 declared in.  This can lead to shadowing between instance variables
3220 and other variables declared either locally inside a class method or
3221 globally with the same name.  Specifying the @option{-fno-local-ivars}
3222 flag disables this behavior thus avoiding variable shadowing issues.
3224 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3225 @opindex fivar-visibility
3226 Set the default instance variable visibility to the specified option
3227 so that instance variables declared outside the scope of any access
3228 modifier directives default to the specified visibility.
3230 @item -gen-decls
3231 @opindex gen-decls
3232 Dump interface declarations for all classes seen in the source file to a
3233 file named @file{@var{sourcename}.decl}.
3235 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3236 @opindex Wassign-intercept
3237 @opindex Wno-assign-intercept
3238 Warn whenever an Objective-C assignment is being intercepted by the
3239 garbage collector.
3241 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3242 @opindex Wno-protocol
3243 @opindex Wprotocol
3244 If a class is declared to implement a protocol, a warning is issued for
3245 every method in the protocol that is not implemented by the class.  The
3246 default behavior is to issue a warning for every method not explicitly
3247 implemented in the class, even if a method implementation is inherited
3248 from the superclass.  If you use the @option{-Wno-protocol} option, then
3249 methods inherited from the superclass are considered to be implemented,
3250 and no warning is issued for them.
3252 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3253 @opindex Wselector
3254 @opindex Wno-selector
3255 Warn if multiple methods of different types for the same selector are
3256 found during compilation.  The check is performed on the list of methods
3257 in the final stage of compilation.  Additionally, a check is performed
3258 for each selector appearing in a @code{@@selector(@dots{})}
3259 expression, and a corresponding method for that selector has been found
3260 during compilation.  Because these checks scan the method table only at
3261 the end of compilation, these warnings are not produced if the final
3262 stage of compilation is not reached, for example because an error is
3263 found during compilation, or because the @option{-fsyntax-only} option is
3264 being used.
3266 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3267 @opindex Wstrict-selector-match
3268 @opindex Wno-strict-selector-match
3269 Warn if multiple methods with differing argument and/or return types are
3270 found for a given selector when attempting to send a message using this
3271 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3272 is off (which is the default behavior), the compiler omits such warnings
3273 if any differences found are confined to types that share the same size
3274 and alignment.
3276 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3277 @opindex Wundeclared-selector
3278 @opindex Wno-undeclared-selector
3279 Warn if a @code{@@selector(@dots{})} expression referring to an
3280 undeclared selector is found.  A selector is considered undeclared if no
3281 method with that name has been declared before the
3282 @code{@@selector(@dots{})} expression, either explicitly in an
3283 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3284 an @code{@@implementation} section.  This option always performs its
3285 checks as soon as a @code{@@selector(@dots{})} expression is found,
3286 while @option{-Wselector} only performs its checks in the final stage of
3287 compilation.  This also enforces the coding style convention
3288 that methods and selectors must be declared before being used.
3290 @item -print-objc-runtime-info
3291 @opindex print-objc-runtime-info
3292 Generate C header describing the largest structure that is passed by
3293 value, if any.
3295 @end table
3297 @node Diagnostic Message Formatting Options
3298 @section Options to Control Diagnostic Messages Formatting
3299 @cindex options to control diagnostics formatting
3300 @cindex diagnostic messages
3301 @cindex message formatting
3303 Traditionally, diagnostic messages have been formatted irrespective of
3304 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3305 options described below
3306 to control the formatting algorithm for diagnostic messages, 
3307 e.g.@: how many characters per line, how often source location
3308 information should be reported.  Note that some language front ends may not
3309 honor these options.
3311 @table @gcctabopt
3312 @item -fmessage-length=@var{n}
3313 @opindex fmessage-length
3314 Try to format error messages so that they fit on lines of about
3315 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3316 done; each error message appears on a single line.  This is the
3317 default for all front ends.
3319 @item -fdiagnostics-show-location=once
3320 @opindex fdiagnostics-show-location
3321 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3322 reporter to emit source location information @emph{once}; that is, in
3323 case the message is too long to fit on a single physical line and has to
3324 be wrapped, the source location won't be emitted (as prefix) again,
3325 over and over, in subsequent continuation lines.  This is the default
3326 behavior.
3328 @item -fdiagnostics-show-location=every-line
3329 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3330 messages reporter to emit the same source location information (as
3331 prefix) for physical lines that result from the process of breaking
3332 a message which is too long to fit on a single line.
3334 @item -fdiagnostics-color[=@var{WHEN}]
3335 @itemx -fno-diagnostics-color
3336 @opindex fdiagnostics-color
3337 @cindex highlight, color
3338 @vindex GCC_COLORS @r{environment variable}
3339 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3340 or @samp{auto}.  The default depends on how the compiler has been configured,
3341 it can be any of the above @var{WHEN} options or also @samp{never}
3342 if @env{GCC_COLORS} environment variable isn't present in the environment,
3343 and @samp{auto} otherwise.
3344 @samp{auto} means to use color only when the standard error is a terminal.
3345 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3346 aliases for @option{-fdiagnostics-color=always} and
3347 @option{-fdiagnostics-color=never}, respectively.
3349 The colors are defined by the environment variable @env{GCC_COLORS}.
3350 Its value is a colon-separated list of capabilities and Select Graphic
3351 Rendition (SGR) substrings. SGR commands are interpreted by the
3352 terminal or terminal emulator.  (See the section in the documentation
3353 of your text terminal for permitted values and their meanings as
3354 character attributes.)  These substring values are integers in decimal
3355 representation and can be concatenated with semicolons.
3356 Common values to concatenate include
3357 @samp{1} for bold,
3358 @samp{4} for underline,
3359 @samp{5} for blink,
3360 @samp{7} for inverse,
3361 @samp{39} for default foreground color,
3362 @samp{30} to @samp{37} for foreground colors,
3363 @samp{90} to @samp{97} for 16-color mode foreground colors,
3364 @samp{38;5;0} to @samp{38;5;255}
3365 for 88-color and 256-color modes foreground colors,
3366 @samp{49} for default background color,
3367 @samp{40} to @samp{47} for background colors,
3368 @samp{100} to @samp{107} for 16-color mode background colors,
3369 and @samp{48;5;0} to @samp{48;5;255}
3370 for 88-color and 256-color modes background colors.
3372 The default @env{GCC_COLORS} is
3373 @smallexample
3374 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:quote=01:\
3375 fixit-insert=32:fixit-delete=31:\
3376 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3377 @end smallexample
3378 @noindent
3379 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3380 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3381 @samp{01} is bold, and @samp{31} is red.
3382 Setting @env{GCC_COLORS} to the empty string disables colors.
3383 Supported capabilities are as follows.
3385 @table @code
3386 @item error=
3387 @vindex error GCC_COLORS @r{capability}
3388 SGR substring for error: markers.
3390 @item warning=
3391 @vindex warning GCC_COLORS @r{capability}
3392 SGR substring for warning: markers.
3394 @item note=
3395 @vindex note GCC_COLORS @r{capability}
3396 SGR substring for note: markers.
3398 @item range1=
3399 @vindex range1 GCC_COLORS @r{capability}
3400 SGR substring for first additional range.
3402 @item range2=
3403 @vindex range2 GCC_COLORS @r{capability}
3404 SGR substring for second additional range.
3406 @item locus=
3407 @vindex locus GCC_COLORS @r{capability}
3408 SGR substring for location information, @samp{file:line} or
3409 @samp{file:line:column} etc.
3411 @item quote=
3412 @vindex quote GCC_COLORS @r{capability}
3413 SGR substring for information printed within quotes.
3415 @item fixit-insert=
3416 @vindex fixit-insert GCC_COLORS @r{capability}
3417 SGR substring for fix-it hints suggesting text to
3418 be inserted or replaced.
3420 @item fixit-delete=
3421 @vindex fixit-delete GCC_COLORS @r{capability}
3422 SGR substring for fix-it hints suggesting text to
3423 be deleted.
3425 @item diff-filename=
3426 @vindex diff-filename GCC_COLORS @r{capability}
3427 SGR substring for filename headers within generated patches.
3429 @item diff-hunk=
3430 @vindex diff-hunk GCC_COLORS @r{capability}
3431 SGR substring for the starts of hunks within generated patches.
3433 @item diff-delete=
3434 @vindex diff-delete GCC_COLORS @r{capability}
3435 SGR substring for deleted lines within generated patches.
3437 @item diff-insert=
3438 @vindex diff-insert GCC_COLORS @r{capability}
3439 SGR substring for inserted lines within generated patches.
3440 @end table
3442 @item -fno-diagnostics-show-option
3443 @opindex fno-diagnostics-show-option
3444 @opindex fdiagnostics-show-option
3445 By default, each diagnostic emitted includes text indicating the
3446 command-line option that directly controls the diagnostic (if such an
3447 option is known to the diagnostic machinery).  Specifying the
3448 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3450 @item -fno-diagnostics-show-caret
3451 @opindex fno-diagnostics-show-caret
3452 @opindex fdiagnostics-show-caret
3453 By default, each diagnostic emitted includes the original source line
3454 and a caret @samp{^} indicating the column.  This option suppresses this
3455 information.  The source line is truncated to @var{n} characters, if
3456 the @option{-fmessage-length=n} option is given.  When the output is done
3457 to the terminal, the width is limited to the width given by the
3458 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3460 @item -fdiagnostics-parseable-fixits
3461 @opindex fdiagnostics-parseable-fixits
3462 Emit fix-it hints in a machine-parseable format, suitable for consumption
3463 by IDEs.  For each fix-it, a line will be printed after the relevant
3464 diagnostic, starting with the string ``fix-it:''.  For example:
3466 @smallexample
3467 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3468 @end smallexample
3470 The location is expressed as a half-open range, expressed as a count of
3471 bytes, starting at byte 1 for the initial column.  In the above example,
3472 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3473 given string:
3475 @smallexample
3476 00000000011111111112222222222
3477 12345678901234567890123456789
3478   gtk_widget_showall (dlg);
3479   ^^^^^^^^^^^^^^^^^^
3480   gtk_widget_show_all
3481 @end smallexample
3483 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3484 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3485 (e.g. vertical tab as ``\013'').
3487 An empty replacement string indicates that the given range is to be removed.
3488 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3489 be inserted at the given position.
3491 @item -fdiagnostics-generate-patch
3492 @opindex fdiagnostics-generate-patch
3493 Print fix-it hints to stderr in unified diff format, after any diagnostics
3494 are printed.  For example:
3496 @smallexample
3497 --- test.c
3498 +++ test.c
3499 @@ -42,5 +42,5 @@
3501  void show_cb(GtkDialog *dlg)
3502  @{
3503 -  gtk_widget_showall(dlg);
3504 +  gtk_widget_show_all(dlg);
3505  @}
3507 @end smallexample
3509 The diff may or may not be colorized, following the same rules
3510 as for diagnostics (see @option{-fdiagnostics-color}).
3512 @end table
3514 @node Warning Options
3515 @section Options to Request or Suppress Warnings
3516 @cindex options to control warnings
3517 @cindex warning messages
3518 @cindex messages, warning
3519 @cindex suppressing warnings
3521 Warnings are diagnostic messages that report constructions that
3522 are not inherently erroneous but that are risky or suggest there
3523 may have been an error.
3525 The following language-independent options do not enable specific
3526 warnings but control the kinds of diagnostics produced by GCC@.
3528 @table @gcctabopt
3529 @cindex syntax checking
3530 @item -fsyntax-only
3531 @opindex fsyntax-only
3532 Check the code for syntax errors, but don't do anything beyond that.
3534 @item -fmax-errors=@var{n}
3535 @opindex fmax-errors
3536 Limits the maximum number of error messages to @var{n}, at which point
3537 GCC bails out rather than attempting to continue processing the source
3538 code.  If @var{n} is 0 (the default), there is no limit on the number
3539 of error messages produced.  If @option{-Wfatal-errors} is also
3540 specified, then @option{-Wfatal-errors} takes precedence over this
3541 option.
3543 @item -w
3544 @opindex w
3545 Inhibit all warning messages.
3547 @item -Werror
3548 @opindex Werror
3549 @opindex Wno-error
3550 Make all warnings into errors.
3552 @item -Werror=
3553 @opindex Werror=
3554 @opindex Wno-error=
3555 Make the specified warning into an error.  The specifier for a warning
3556 is appended; for example @option{-Werror=switch} turns the warnings
3557 controlled by @option{-Wswitch} into errors.  This switch takes a
3558 negative form, to be used to negate @option{-Werror} for specific
3559 warnings; for example @option{-Wno-error=switch} makes
3560 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3561 is in effect.
3563 The warning message for each controllable warning includes the
3564 option that controls the warning.  That option can then be used with
3565 @option{-Werror=} and @option{-Wno-error=} as described above.
3566 (Printing of the option in the warning message can be disabled using the
3567 @option{-fno-diagnostics-show-option} flag.)
3569 Note that specifying @option{-Werror=}@var{foo} automatically implies
3570 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3571 imply anything.
3573 @item -Wfatal-errors
3574 @opindex Wfatal-errors
3575 @opindex Wno-fatal-errors
3576 This option causes the compiler to abort compilation on the first error
3577 occurred rather than trying to keep going and printing further error
3578 messages.
3580 @end table
3582 You can request many specific warnings with options beginning with
3583 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3584 implicit declarations.  Each of these specific warning options also
3585 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3586 example, @option{-Wno-implicit}.  This manual lists only one of the
3587 two forms, whichever is not the default.  For further
3588 language-specific options also refer to @ref{C++ Dialect Options} and
3589 @ref{Objective-C and Objective-C++ Dialect Options}.
3591 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3592 options, such as @option{-Wunused}, which may turn on further options,
3593 such as @option{-Wunused-value}. The combined effect of positive and
3594 negative forms is that more specific options have priority over less
3595 specific ones, independently of their position in the command-line. For
3596 options of the same specificity, the last one takes effect. Options
3597 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3598 as if they appeared at the end of the command-line.
3600 When an unrecognized warning option is requested (e.g.,
3601 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3602 that the option is not recognized.  However, if the @option{-Wno-} form
3603 is used, the behavior is slightly different: no diagnostic is
3604 produced for @option{-Wno-unknown-warning} unless other diagnostics
3605 are being produced.  This allows the use of new @option{-Wno-} options
3606 with old compilers, but if something goes wrong, the compiler
3607 warns that an unrecognized option is present.
3609 @table @gcctabopt
3610 @item -Wpedantic
3611 @itemx -pedantic
3612 @opindex pedantic
3613 @opindex Wpedantic
3614 Issue all the warnings demanded by strict ISO C and ISO C++;
3615 reject all programs that use forbidden extensions, and some other
3616 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3617 version of the ISO C standard specified by any @option{-std} option used.
3619 Valid ISO C and ISO C++ programs should compile properly with or without
3620 this option (though a rare few require @option{-ansi} or a
3621 @option{-std} option specifying the required version of ISO C)@.  However,
3622 without this option, certain GNU extensions and traditional C and C++
3623 features are supported as well.  With this option, they are rejected.
3625 @option{-Wpedantic} does not cause warning messages for use of the
3626 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3627 warnings are also disabled in the expression that follows
3628 @code{__extension__}.  However, only system header files should use
3629 these escape routes; application programs should avoid them.
3630 @xref{Alternate Keywords}.
3632 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3633 C conformance.  They soon find that it does not do quite what they want:
3634 it finds some non-ISO practices, but not all---only those for which
3635 ISO C @emph{requires} a diagnostic, and some others for which
3636 diagnostics have been added.
3638 A feature to report any failure to conform to ISO C might be useful in
3639 some instances, but would require considerable additional work and would
3640 be quite different from @option{-Wpedantic}.  We don't have plans to
3641 support such a feature in the near future.
3643 Where the standard specified with @option{-std} represents a GNU
3644 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3645 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3646 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3647 where they are required by the base standard.  (It does not make sense
3648 for such warnings to be given only for features not in the specified GNU
3649 C dialect, since by definition the GNU dialects of C include all
3650 features the compiler supports with the given option, and there would be
3651 nothing to warn about.)
3653 @item -pedantic-errors
3654 @opindex pedantic-errors
3655 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3656 requires a diagnostic, in some cases where there is undefined behavior
3657 at compile-time and in some other cases that do not prevent compilation
3658 of programs that are valid according to the standard. This is not
3659 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3660 by this option and not enabled by the latter and vice versa.
3662 @item -Wall
3663 @opindex Wall
3664 @opindex Wno-all
3665 This enables all the warnings about constructions that some users
3666 consider questionable, and that are easy to avoid (or modify to
3667 prevent the warning), even in conjunction with macros.  This also
3668 enables some language-specific warnings described in @ref{C++ Dialect
3669 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3671 @option{-Wall} turns on the following warning flags:
3673 @gccoptlist{-Waddress   @gol
3674 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3675 -Wbool-compare  @gol
3676 -Wbool-operation  @gol
3677 -Wc++11-compat  -Wc++14-compat@gol
3678 -Wchar-subscripts  @gol
3679 -Wcomment  @gol
3680 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3681 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3682 -Wformat   @gol
3683 -Wint-in-bool-context  @gol
3684 -Wimplicit @r{(C and Objective-C only)} @gol
3685 -Wimplicit-int @r{(C and Objective-C only)} @gol
3686 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3687 -Winit-self @r{(only for C++)} @gol
3688 -Wlogical-not-parentheses
3689 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3690 -Wmaybe-uninitialized @gol
3691 -Wmemset-elt-size @gol
3692 -Wmemset-transposed-args @gol
3693 -Wmisleading-indentation @r{(only for C/C++)} @gol
3694 -Wmissing-braces @r{(only for C/ObjC)} @gol
3695 -Wnarrowing @r{(only for C++)}  @gol
3696 -Wnonnull  @gol
3697 -Wnonnull-compare  @gol
3698 -Wopenmp-simd @gol
3699 -Wparentheses  @gol
3700 -Wpointer-sign  @gol
3701 -Wreorder   @gol
3702 -Wreturn-type  @gol
3703 -Wsequence-point  @gol
3704 -Wsign-compare @r{(only in C++)}  @gol
3705 -Wsizeof-pointer-memaccess @gol
3706 -Wstrict-aliasing  @gol
3707 -Wstrict-overflow=1  @gol
3708 -Wswitch  @gol
3709 -Wtautological-compare  @gol
3710 -Wtrigraphs  @gol
3711 -Wuninitialized  @gol
3712 -Wunknown-pragmas  @gol
3713 -Wunused-function  @gol
3714 -Wunused-label     @gol
3715 -Wunused-value     @gol
3716 -Wunused-variable  @gol
3717 -Wvolatile-register-var @gol
3720 Note that some warning flags are not implied by @option{-Wall}.  Some of
3721 them warn about constructions that users generally do not consider
3722 questionable, but which occasionally you might wish to check for;
3723 others warn about constructions that are necessary or hard to avoid in
3724 some cases, and there is no simple way to modify the code to suppress
3725 the warning. Some of them are enabled by @option{-Wextra} but many of
3726 them must be enabled individually.
3728 @item -Wextra
3729 @opindex W
3730 @opindex Wextra
3731 @opindex Wno-extra
3732 This enables some extra warning flags that are not enabled by
3733 @option{-Wall}. (This option used to be called @option{-W}.  The older
3734 name is still supported, but the newer name is more descriptive.)
3736 @gccoptlist{-Wclobbered  @gol
3737 -Wempty-body  @gol
3738 -Wignored-qualifiers @gol
3739 -Wimplicit-fallthrough=3 @gol
3740 -Wmissing-field-initializers  @gol
3741 -Wmissing-parameter-type @r{(C only)}  @gol
3742 -Wold-style-declaration @r{(C only)}  @gol
3743 -Woverride-init  @gol
3744 -Wsign-compare @r{(C only)} @gol
3745 -Wtype-limits  @gol
3746 -Wuninitialized  @gol
3747 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3748 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3749 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3752 The option @option{-Wextra} also prints warning messages for the
3753 following cases:
3755 @itemize @bullet
3757 @item
3758 A pointer is compared against integer zero with @code{<}, @code{<=},
3759 @code{>}, or @code{>=}.
3761 @item
3762 (C++ only) An enumerator and a non-enumerator both appear in a
3763 conditional expression.
3765 @item
3766 (C++ only) Ambiguous virtual bases.
3768 @item
3769 (C++ only) Subscripting an array that has been declared @code{register}.
3771 @item
3772 (C++ only) Taking the address of a variable that has been declared
3773 @code{register}.
3775 @item
3776 (C++ only) A base class is not initialized in the copy constructor
3777 of a derived class.
3779 @end itemize
3781 @item -Wchar-subscripts
3782 @opindex Wchar-subscripts
3783 @opindex Wno-char-subscripts
3784 Warn if an array subscript has type @code{char}.  This is a common cause
3785 of error, as programmers often forget that this type is signed on some
3786 machines.
3787 This warning is enabled by @option{-Wall}.
3789 @item -Wcomment
3790 @opindex Wcomment
3791 @opindex Wno-comment
3792 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3793 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3794 This warning is enabled by @option{-Wall}.
3796 @item -Wno-coverage-mismatch
3797 @opindex Wno-coverage-mismatch
3798 Warn if feedback profiles do not match when using the
3799 @option{-fprofile-use} option.
3800 If a source file is changed between compiling with @option{-fprofile-gen} and
3801 with @option{-fprofile-use}, the files with the profile feedback can fail
3802 to match the source file and GCC cannot use the profile feedback
3803 information.  By default, this warning is enabled and is treated as an
3804 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3805 warning or @option{-Wno-error=coverage-mismatch} can be used to
3806 disable the error.  Disabling the error for this warning can result in
3807 poorly optimized code and is useful only in the
3808 case of very minor changes such as bug fixes to an existing code-base.
3809 Completely disabling the warning is not recommended.
3811 @item -Wno-cpp
3812 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3814 Suppress warning messages emitted by @code{#warning} directives.
3816 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3817 @opindex Wdouble-promotion
3818 @opindex Wno-double-promotion
3819 Give a warning when a value of type @code{float} is implicitly
3820 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3821 floating-point unit implement @code{float} in hardware, but emulate
3822 @code{double} in software.  On such a machine, doing computations
3823 using @code{double} values is much more expensive because of the
3824 overhead required for software emulation.
3826 It is easy to accidentally do computations with @code{double} because
3827 floating-point literals are implicitly of type @code{double}.  For
3828 example, in:
3829 @smallexample
3830 @group
3831 float area(float radius)
3833    return 3.14159 * radius * radius;
3835 @end group
3836 @end smallexample
3837 the compiler performs the entire computation with @code{double}
3838 because the floating-point literal is a @code{double}.
3840 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3841 @opindex Wduplicate-decl-specifier
3842 @opindex Wno-duplicate-decl-specifier
3843 Warn if a declaration has duplicate @code{const}, @code{volatile},
3844 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3845 @option{-Wall}.
3847 @item -Wformat
3848 @itemx -Wformat=@var{n}
3849 @opindex Wformat
3850 @opindex Wno-format
3851 @opindex ffreestanding
3852 @opindex fno-builtin
3853 @opindex Wformat=
3854 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3855 the arguments supplied have types appropriate to the format string
3856 specified, and that the conversions specified in the format string make
3857 sense.  This includes standard functions, and others specified by format
3858 attributes (@pxref{Function Attributes}), in the @code{printf},
3859 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3860 not in the C standard) families (or other target-specific families).
3861 Which functions are checked without format attributes having been
3862 specified depends on the standard version selected, and such checks of
3863 functions without the attribute specified are disabled by
3864 @option{-ffreestanding} or @option{-fno-builtin}.
3866 The formats are checked against the format features supported by GNU
3867 libc version 2.2.  These include all ISO C90 and C99 features, as well
3868 as features from the Single Unix Specification and some BSD and GNU
3869 extensions.  Other library implementations may not support all these
3870 features; GCC does not support warning about features that go beyond a
3871 particular library's limitations.  However, if @option{-Wpedantic} is used
3872 with @option{-Wformat}, warnings are given about format features not
3873 in the selected standard version (but not for @code{strfmon} formats,
3874 since those are not in any version of the C standard).  @xref{C Dialect
3875 Options,,Options Controlling C Dialect}.
3877 @table @gcctabopt
3878 @item -Wformat=1
3879 @itemx -Wformat
3880 @opindex Wformat
3881 @opindex Wformat=1
3882 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3883 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3884 @option{-Wformat} also checks for null format arguments for several
3885 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3886 aspects of this level of format checking can be disabled by the
3887 options: @option{-Wno-format-contains-nul},
3888 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3889 @option{-Wformat} is enabled by @option{-Wall}.
3891 @item -Wno-format-contains-nul
3892 @opindex Wno-format-contains-nul
3893 @opindex Wformat-contains-nul
3894 If @option{-Wformat} is specified, do not warn about format strings that
3895 contain NUL bytes.
3897 @item -Wno-format-extra-args
3898 @opindex Wno-format-extra-args
3899 @opindex Wformat-extra-args
3900 If @option{-Wformat} is specified, do not warn about excess arguments to a
3901 @code{printf} or @code{scanf} format function.  The C standard specifies
3902 that such arguments are ignored.
3904 Where the unused arguments lie between used arguments that are
3905 specified with @samp{$} operand number specifications, normally
3906 warnings are still given, since the implementation could not know what
3907 type to pass to @code{va_arg} to skip the unused arguments.  However,
3908 in the case of @code{scanf} formats, this option suppresses the
3909 warning if the unused arguments are all pointers, since the Single
3910 Unix Specification says that such unused arguments are allowed.
3912 @item -Wformat-length
3913 @itemx -Wformat-length=@var{level}
3914 @opindex Wformat-length
3915 @opindex Wno-format-length
3916 Warn about calls to formatted input/output functions such as @code{sprintf}
3917 that might overflow the destination buffer, or about bounded functions such
3918 as @code{snprintf} that might result in output truncation.  When the exact
3919 number of bytes written by a format directive cannot be determined at
3920 compile-time it is estimated based on heuristics that depend on the
3921 @var{level} argument and on optimization.  While enabling optimization
3922 will in most cases improve the accuracy of the warning, it may also
3923 result in false positives.
3925 @table @gcctabopt
3926 @item -Wformat-length
3927 @item -Wformat-length=1
3928 @opindex Wformat-length
3929 @opindex Wno-format-length
3930 Level @var{1} of @option{-Wformat-length} enabled by @option{-Wformat}
3931 employs a conservative approach that warns only about calls that most
3932 likely overflow the buffer or result in output truncation.  At this
3933 level, numeric arguments to format directives with unknown values are
3934 assumed to have the value of one, and strings of unknown length to be
3935 empty.  Numeric arguments that are known to be bounded to a subrange
3936 of their type, or string arguments whose output is bounded either by
3937 their directive's precision or by a finite set of string literals, are
3938 assumed to take on the value within the range that results in the most
3939 bytes on output.  For example, the call to @code{sprintf} below is
3940 diagnosed because even with both @var{a} and @var{b} equal to zero,
3941 the terminating NUL character (@code{'\0'}) appended by the function
3942 to the destination buffer will be written past its end.  Increasing
3943 the size of the buffer by a single byte is sufficient to avoid the
3944 warning, though it may not be sufficient to avoid the overflow.
3946 @smallexample
3947 void f (int a, int b)
3949   char buf [12];
3950   sprintf (buf, "a = %i, b = %i\n", a, b);
3952 @end smallexample
3954 @item -Wformat-length=2
3955 Level @var{2} warns also about calls that might overflow the destination
3956 buffer or result in truncation given an argument of sufficient length
3957 or magnitude.  At level @var{2}, unknown numeric arguments are assumed
3958 to have the minimum representable value for signed types with a precision
3959 greater than 1, and the maximum representable value otherwise.  Unknown
3960 string arguments whose length cannot be assumed to be bounded either by
3961 the directive's precision, or by a finite set of string literals they
3962 may evaluate to, or the character array they may point to, are assumed
3963 to be 1 character long.
3965 At level @var{2}, the call in the example above is again diagnosed, but
3966 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
3967 @code{%i} directive will write some of its digits beyond the end of
3968 the destination buffer.  To make the call safe regardless of the values
3969 of the two variables, the size of the destination buffer must be increased
3970 to at least 34 bytes.  GCC includes the minimum size of the buffer in
3971 an informational note following the warning.
3973 An alternative to increasing the size of the destination buffer is to
3974 constrain the range of formatted values.  The maximum length of string
3975 arguments can be bounded by specifying the precision in the format
3976 directive.  When numeric arguments of format directives can be assumed
3977 to be bounded by less than the precision of their type, choosing
3978 an appropriate length modifier to the format specifier will reduce
3979 the required buffer size.  For example, if @var{a} and @var{b} in the
3980 example above can be assumed to be within the precision of
3981 the @code{short int} type then using either the @code{%hi} format
3982 directive or casting the argument to @code{short} reduces the maximum
3983 required size of the buffer to 24 bytes.
3985 @smallexample
3986 void f (int a, int b)
3988   char buf [23];
3989   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
3991 @end smallexample
3992 @end table
3994 @item -Wno-format-zero-length
3995 @opindex Wno-format-zero-length
3996 @opindex Wformat-zero-length
3997 If @option{-Wformat} is specified, do not warn about zero-length formats.
3998 The C standard specifies that zero-length formats are allowed.
4001 @item -Wformat=2
4002 @opindex Wformat=2
4003 Enable @option{-Wformat} plus additional format checks.  Currently
4004 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4005 -Wformat-y2k}.
4007 @item -Wformat-nonliteral
4008 @opindex Wformat-nonliteral
4009 @opindex Wno-format-nonliteral
4010 If @option{-Wformat} is specified, also warn if the format string is not a
4011 string literal and so cannot be checked, unless the format function
4012 takes its format arguments as a @code{va_list}.
4014 @item -Wformat-security
4015 @opindex Wformat-security
4016 @opindex Wno-format-security
4017 If @option{-Wformat} is specified, also warn about uses of format
4018 functions that represent possible security problems.  At present, this
4019 warns about calls to @code{printf} and @code{scanf} functions where the
4020 format string is not a string literal and there are no format arguments,
4021 as in @code{printf (foo);}.  This may be a security hole if the format
4022 string came from untrusted input and contains @samp{%n}.  (This is
4023 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4024 in future warnings may be added to @option{-Wformat-security} that are not
4025 included in @option{-Wformat-nonliteral}.)
4027 @item -Wformat-signedness
4028 @opindex Wformat-signedness
4029 @opindex Wno-format-signedness
4030 If @option{-Wformat} is specified, also warn if the format string
4031 requires an unsigned argument and the argument is signed and vice versa.
4033 @item -Wformat-y2k
4034 @opindex Wformat-y2k
4035 @opindex Wno-format-y2k
4036 If @option{-Wformat} is specified, also warn about @code{strftime}
4037 formats that may yield only a two-digit year.
4038 @end table
4040 @item -Wnonnull
4041 @opindex Wnonnull
4042 @opindex Wno-nonnull
4043 Warn about passing a null pointer for arguments marked as
4044 requiring a non-null value by the @code{nonnull} function attribute.
4046 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4047 can be disabled with the @option{-Wno-nonnull} option.
4049 @item -Wnonnull-compare
4050 @opindex Wnonnull-compare
4051 @opindex Wno-nonnull-compare
4052 Warn when comparing an argument marked with the @code{nonnull}
4053 function attribute against null inside the function.
4055 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4056 can be disabled with the @option{-Wno-nonnull-compare} option.
4058 @item -Wnull-dereference
4059 @opindex Wnull-dereference
4060 @opindex Wno-null-dereference
4061 Warn if the compiler detects paths that trigger erroneous or
4062 undefined behavior due to dereferencing a null pointer.  This option
4063 is only active when @option{-fdelete-null-pointer-checks} is active,
4064 which is enabled by optimizations in most targets.  The precision of
4065 the warnings depends on the optimization options used.
4067 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4068 @opindex Winit-self
4069 @opindex Wno-init-self
4070 Warn about uninitialized variables that are initialized with themselves.
4071 Note this option can only be used with the @option{-Wuninitialized} option.
4073 For example, GCC warns about @code{i} being uninitialized in the
4074 following snippet only when @option{-Winit-self} has been specified:
4075 @smallexample
4076 @group
4077 int f()
4079   int i = i;
4080   return i;
4082 @end group
4083 @end smallexample
4085 This warning is enabled by @option{-Wall} in C++.
4087 @item -Wimplicit-int @r{(C and Objective-C only)}
4088 @opindex Wimplicit-int
4089 @opindex Wno-implicit-int
4090 Warn when a declaration does not specify a type.
4091 This warning is enabled by @option{-Wall}.
4093 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4094 @opindex Wimplicit-function-declaration
4095 @opindex Wno-implicit-function-declaration
4096 Give a warning whenever a function is used before being declared. In
4097 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4098 enabled by default and it is made into an error by
4099 @option{-pedantic-errors}. This warning is also enabled by
4100 @option{-Wall}.
4102 @item -Wimplicit @r{(C and Objective-C only)}
4103 @opindex Wimplicit
4104 @opindex Wno-implicit
4105 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4106 This warning is enabled by @option{-Wall}.
4108 @item -Wimplicit-fallthrough
4109 @opindex Wimplicit-fallthrough
4110 @opindex Wno-implicit-fallthrough
4111 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4112 and @option{-Wno-implicit-fallthrough} is the same as
4113 @option{-Wimplicit-fallthrough=0}.
4115 @item -Wimplicit-fallthrough=@var{n}
4116 @opindex Wimplicit-fallthrough=
4117 Warn when a switch case falls through.  For example:
4119 @smallexample
4120 @group
4121 switch (cond)
4122   @{
4123   case 1:
4124     a = 1;
4125     break;
4126   case 2:
4127     a = 2;
4128   case 3:
4129     a = 3;
4130     break;
4131   @}
4132 @end group
4133 @end smallexample
4135 This warning does not warn when the last statement of a case cannot
4136 fall through, e.g. when there is a return statement or a call to function
4137 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4138 also takes into account control flow statements, such as ifs, and only
4139 warns when appropriate.  E.g.@:
4141 @smallexample
4142 @group
4143 switch (cond)
4144   @{
4145   case 1:
4146     if (i > 3) @{
4147       bar (5);
4148       break;
4149     @} else if (i < 1) @{
4150       bar (0);
4151     @} else
4152       return;
4153   default:
4154     @dots{}
4155   @}
4156 @end group
4157 @end smallexample
4159 Since there are occasions where a switch case fall through is desirable,
4160 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4161 to be used along with a null statement to suppress this warning that
4162 would normally occur:
4164 @smallexample
4165 @group
4166 switch (cond)
4167   @{
4168   case 1:
4169     bar (0);
4170     __attribute__ ((fallthrough));
4171   default:
4172     @dots{}
4173   @}
4174 @end group
4175 @end smallexample
4177 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4178 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4179 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4180 Instead of the these attributes, it is also possible to add a fallthrough
4181 comment to silence the warning.  The whole body of the C or C++ style comment
4182 should match the given regular expressions listed below.  The option argument
4183 @var{n} specifies what kind of comments are accepted:
4185 @itemize @bullet
4187 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4189 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4190 expression, any comment is used as fallthrough comment.
4192 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4193 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4195 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4196 following regular expressions:
4198 @itemize @bullet
4200 @item @code{-fallthrough}
4202 @item @code{@@fallthrough@@}
4204 @item @code{lint -fallthrough[ \t]*}
4206 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4208 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4210 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4212 @end itemize
4214 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4215 following regular expressions:
4217 @itemize @bullet
4219 @item @code{-fallthrough}
4221 @item @code{@@fallthrough@@}
4223 @item @code{lint -fallthrough[ \t]*}
4225 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4227 @end itemize
4229 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4230 fallthrough comments, only attributes disable the warning.
4232 @end itemize
4234 The comment needs to be followed after optional whitespace and other comments
4235 by @code{case} or @code{default} keywords or by a user label that preceeds some
4236 @code{case} or @code{default} label.
4238 @smallexample
4239 @group
4240 switch (cond)
4241   @{
4242   case 1:
4243     bar (0);
4244     /* FALLTHRU */
4245   default:
4246     @dots{}
4247   @}
4248 @end group
4249 @end smallexample
4251 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4253 @item -Wignored-qualifiers @r{(C and C++ only)}
4254 @opindex Wignored-qualifiers
4255 @opindex Wno-ignored-qualifiers
4256 Warn if the return type of a function has a type qualifier
4257 such as @code{const}.  For ISO C such a type qualifier has no effect,
4258 since the value returned by a function is not an lvalue.
4259 For C++, the warning is only emitted for scalar types or @code{void}.
4260 ISO C prohibits qualified @code{void} return types on function
4261 definitions, so such return types always receive a warning
4262 even without this option.
4264 This warning is also enabled by @option{-Wextra}.
4266 @item -Wignored-attributes @r{(C and C++ only)}
4267 @opindex Wignored-attributes
4268 @opindex Wno-ignored-attributes
4269 Warn when an attribute is ignored.  This is different from the
4270 @option{-Wattributes} option in that it warns whenever the compiler decides
4271 to drop an attribute, not that the attribute is either unknown, used in a
4272 wrong place, etc.  This warning is enabled by default.
4274 @item -Wmain
4275 @opindex Wmain
4276 @opindex Wno-main
4277 Warn if the type of @code{main} is suspicious.  @code{main} should be
4278 a function with external linkage, returning int, taking either zero
4279 arguments, two, or three arguments of appropriate types.  This warning
4280 is enabled by default in C++ and is enabled by either @option{-Wall}
4281 or @option{-Wpedantic}.
4283 @item -Wmisleading-indentation @r{(C and C++ only)}
4284 @opindex Wmisleading-indentation
4285 @opindex Wno-misleading-indentation
4286 Warn when the indentation of the code does not reflect the block structure.
4287 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4288 @code{for} clauses with a guarded statement that does not use braces,
4289 followed by an unguarded statement with the same indentation.
4291 In the following example, the call to ``bar'' is misleadingly indented as
4292 if it were guarded by the ``if'' conditional.
4294 @smallexample
4295   if (some_condition ())
4296     foo ();
4297     bar ();  /* Gotcha: this is not guarded by the "if".  */
4298 @end smallexample
4300 In the case of mixed tabs and spaces, the warning uses the
4301 @option{-ftabstop=} option to determine if the statements line up
4302 (defaulting to 8).
4304 The warning is not issued for code involving multiline preprocessor logic
4305 such as the following example.
4307 @smallexample
4308   if (flagA)
4309     foo (0);
4310 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4311   if (flagB)
4312 #endif
4313     foo (1);
4314 @end smallexample
4316 The warning is not issued after a @code{#line} directive, since this
4317 typically indicates autogenerated code, and no assumptions can be made
4318 about the layout of the file that the directive references.
4320 This warning is enabled by @option{-Wall} in C and C++.
4322 @item -Wmissing-braces
4323 @opindex Wmissing-braces
4324 @opindex Wno-missing-braces
4325 Warn if an aggregate or union initializer is not fully bracketed.  In
4326 the following example, the initializer for @code{a} is not fully
4327 bracketed, but that for @code{b} is fully bracketed.  This warning is
4328 enabled by @option{-Wall} in C.
4330 @smallexample
4331 int a[2][2] = @{ 0, 1, 2, 3 @};
4332 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4333 @end smallexample
4335 This warning is enabled by @option{-Wall}.
4337 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4338 @opindex Wmissing-include-dirs
4339 @opindex Wno-missing-include-dirs
4340 Warn if a user-supplied include directory does not exist.
4342 @item -Wparentheses
4343 @opindex Wparentheses
4344 @opindex Wno-parentheses
4345 Warn if parentheses are omitted in certain contexts, such
4346 as when there is an assignment in a context where a truth value
4347 is expected, or when operators are nested whose precedence people
4348 often get confused about.
4350 Also warn if a comparison like @code{x<=y<=z} appears; this is
4351 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4352 interpretation from that of ordinary mathematical notation.
4354 Also warn for dangerous uses of the GNU extension to
4355 @code{?:} with omitted middle operand. When the condition
4356 in the @code{?}: operator is a boolean expression, the omitted value is
4357 always 1.  Often programmers expect it to be a value computed
4358 inside the conditional expression instead.
4360 This warning is enabled by @option{-Wall}.
4362 @item -Wsequence-point
4363 @opindex Wsequence-point
4364 @opindex Wno-sequence-point
4365 Warn about code that may have undefined semantics because of violations
4366 of sequence point rules in the C and C++ standards.
4368 The C and C++ standards define the order in which expressions in a C/C++
4369 program are evaluated in terms of @dfn{sequence points}, which represent
4370 a partial ordering between the execution of parts of the program: those
4371 executed before the sequence point, and those executed after it.  These
4372 occur after the evaluation of a full expression (one which is not part
4373 of a larger expression), after the evaluation of the first operand of a
4374 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4375 function is called (but after the evaluation of its arguments and the
4376 expression denoting the called function), and in certain other places.
4377 Other than as expressed by the sequence point rules, the order of
4378 evaluation of subexpressions of an expression is not specified.  All
4379 these rules describe only a partial order rather than a total order,
4380 since, for example, if two functions are called within one expression
4381 with no sequence point between them, the order in which the functions
4382 are called is not specified.  However, the standards committee have
4383 ruled that function calls do not overlap.
4385 It is not specified when between sequence points modifications to the
4386 values of objects take effect.  Programs whose behavior depends on this
4387 have undefined behavior; the C and C++ standards specify that ``Between
4388 the previous and next sequence point an object shall have its stored
4389 value modified at most once by the evaluation of an expression.
4390 Furthermore, the prior value shall be read only to determine the value
4391 to be stored.''.  If a program breaks these rules, the results on any
4392 particular implementation are entirely unpredictable.
4394 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4395 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4396 diagnosed by this option, and it may give an occasional false positive
4397 result, but in general it has been found fairly effective at detecting
4398 this sort of problem in programs.
4400 The C++17 standard will define the order of evaluation of operands in
4401 more cases: in particular it requires that the right-hand side of an
4402 assignment be evaluated before the left-hand side, so the above
4403 examples are no longer undefined.  But this warning will still warn
4404 about them, to help people avoid writing code that is undefined in C
4405 and earlier revisions of C++.
4407 The standard is worded confusingly, therefore there is some debate
4408 over the precise meaning of the sequence point rules in subtle cases.
4409 Links to discussions of the problem, including proposed formal
4410 definitions, may be found on the GCC readings page, at
4411 @uref{http://gcc.gnu.org/@/readings.html}.
4413 This warning is enabled by @option{-Wall} for C and C++.
4415 @item -Wno-return-local-addr
4416 @opindex Wno-return-local-addr
4417 @opindex Wreturn-local-addr
4418 Do not warn about returning a pointer (or in C++, a reference) to a
4419 variable that goes out of scope after the function returns.
4421 @item -Wreturn-type
4422 @opindex Wreturn-type
4423 @opindex Wno-return-type
4424 Warn whenever a function is defined with a return type that defaults
4425 to @code{int}.  Also warn about any @code{return} statement with no
4426 return value in a function whose return type is not @code{void}
4427 (falling off the end of the function body is considered returning
4428 without a value).
4430 For C only, warn about a @code{return} statement with an expression in a
4431 function whose return type is @code{void}, unless the expression type is
4432 also @code{void}.  As a GNU extension, the latter case is accepted
4433 without a warning unless @option{-Wpedantic} is used.
4435 For C++, a function without return type always produces a diagnostic
4436 message, even when @option{-Wno-return-type} is specified.  The only
4437 exceptions are @code{main} and functions defined in system headers.
4439 This warning is enabled by @option{-Wall}.
4441 @item -Wshift-count-negative
4442 @opindex Wshift-count-negative
4443 @opindex Wno-shift-count-negative
4444 Warn if shift count is negative. This warning is enabled by default.
4446 @item -Wshift-count-overflow
4447 @opindex Wshift-count-overflow
4448 @opindex Wno-shift-count-overflow
4449 Warn if shift count >= width of type. This warning is enabled by default.
4451 @item -Wshift-negative-value
4452 @opindex Wshift-negative-value
4453 @opindex Wno-shift-negative-value
4454 Warn if left shifting a negative value.  This warning is enabled by
4455 @option{-Wextra} in C99 and C++11 modes (and newer).
4457 @item -Wshift-overflow
4458 @itemx -Wshift-overflow=@var{n}
4459 @opindex Wshift-overflow
4460 @opindex Wno-shift-overflow
4461 Warn about left shift overflows.  This warning is enabled by
4462 default in C99 and C++11 modes (and newer).
4464 @table @gcctabopt
4465 @item -Wshift-overflow=1
4466 This is the warning level of @option{-Wshift-overflow} and is enabled
4467 by default in C99 and C++11 modes (and newer).  This warning level does
4468 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4469 an overflow is still rejected in contexts where an integer constant expression
4470 is required.)
4472 @item -Wshift-overflow=2
4473 This warning level also warns about left-shifting 1 into the sign bit,
4474 unless C++14 mode is active.
4475 @end table
4477 @item -Wswitch
4478 @opindex Wswitch
4479 @opindex Wno-switch
4480 Warn whenever a @code{switch} statement has an index of enumerated type
4481 and lacks a @code{case} for one or more of the named codes of that
4482 enumeration.  (The presence of a @code{default} label prevents this
4483 warning.)  @code{case} labels outside the enumeration range also
4484 provoke warnings when this option is used (even if there is a
4485 @code{default} label).
4486 This warning is enabled by @option{-Wall}.
4488 @item -Wswitch-default
4489 @opindex Wswitch-default
4490 @opindex Wno-switch-default
4491 Warn whenever a @code{switch} statement does not have a @code{default}
4492 case.
4494 @item -Wswitch-enum
4495 @opindex Wswitch-enum
4496 @opindex Wno-switch-enum
4497 Warn whenever a @code{switch} statement has an index of enumerated type
4498 and lacks a @code{case} for one or more of the named codes of that
4499 enumeration.  @code{case} labels outside the enumeration range also
4500 provoke warnings when this option is used.  The only difference
4501 between @option{-Wswitch} and this option is that this option gives a
4502 warning about an omitted enumeration code even if there is a
4503 @code{default} label.
4505 @item -Wswitch-bool
4506 @opindex Wswitch-bool
4507 @opindex Wno-switch-bool
4508 Warn whenever a @code{switch} statement has an index of boolean type
4509 and the case values are outside the range of a boolean type.
4510 It is possible to suppress this warning by casting the controlling
4511 expression to a type other than @code{bool}.  For example:
4512 @smallexample
4513 @group
4514 switch ((int) (a == 4))
4515   @{
4516   @dots{}
4517   @}
4518 @end group
4519 @end smallexample
4520 This warning is enabled by default for C and C++ programs.
4522 @item -Wswitch-unreachable
4523 @opindex Wswitch-unreachable
4524 @opindex Wno-switch-unreachable
4525 Warn whenever a @code{switch} statement contains statements between the
4526 controlling expression and the first case label, which will never be
4527 executed.  For example:
4528 @smallexample
4529 @group
4530 switch (cond)
4531   @{
4532    i = 15;
4533   @dots{}
4534    case 5:
4535   @dots{}
4536   @}
4537 @end group
4538 @end smallexample
4539 @option{-Wswitch-unreachable} does not warn if the statement between the
4540 controlling expression and the first case label is just a declaration:
4541 @smallexample
4542 @group
4543 switch (cond)
4544   @{
4545    int i;
4546   @dots{}
4547    case 5:
4548    i = 5;
4549   @dots{}
4550   @}
4551 @end group
4552 @end smallexample
4553 This warning is enabled by default for C and C++ programs.
4555 @item -Wsync-nand @r{(C and C++ only)}
4556 @opindex Wsync-nand
4557 @opindex Wno-sync-nand
4558 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4559 built-in functions are used.  These functions changed semantics in GCC 4.4.
4561 @item -Wtrigraphs
4562 @opindex Wtrigraphs
4563 @opindex Wno-trigraphs
4564 Warn if any trigraphs are encountered that might change the meaning of
4565 the program (trigraphs within comments are not warned about).
4566 This warning is enabled by @option{-Wall}.
4568 @item -Wunused-but-set-parameter
4569 @opindex Wunused-but-set-parameter
4570 @opindex Wno-unused-but-set-parameter
4571 Warn whenever a function parameter is assigned to, but otherwise unused
4572 (aside from its declaration).
4574 To suppress this warning use the @code{unused} attribute
4575 (@pxref{Variable Attributes}).
4577 This warning is also enabled by @option{-Wunused} together with
4578 @option{-Wextra}.
4580 @item -Wunused-but-set-variable
4581 @opindex Wunused-but-set-variable
4582 @opindex Wno-unused-but-set-variable
4583 Warn whenever a local variable is assigned to, but otherwise unused
4584 (aside from its declaration).
4585 This warning is enabled by @option{-Wall}.
4587 To suppress this warning use the @code{unused} attribute
4588 (@pxref{Variable Attributes}).
4590 This warning is also enabled by @option{-Wunused}, which is enabled
4591 by @option{-Wall}.
4593 @item -Wunused-function
4594 @opindex Wunused-function
4595 @opindex Wno-unused-function
4596 Warn whenever a static function is declared but not defined or a
4597 non-inline static function is unused.
4598 This warning is enabled by @option{-Wall}.
4600 @item -Wunused-label
4601 @opindex Wunused-label
4602 @opindex Wno-unused-label
4603 Warn whenever a label is declared but not used.
4604 This warning is enabled by @option{-Wall}.
4606 To suppress this warning use the @code{unused} attribute
4607 (@pxref{Variable Attributes}).
4609 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4610 @opindex Wunused-local-typedefs
4611 Warn when a typedef locally defined in a function is not used.
4612 This warning is enabled by @option{-Wall}.
4614 @item -Wunused-parameter
4615 @opindex Wunused-parameter
4616 @opindex Wno-unused-parameter
4617 Warn whenever a function parameter is unused aside from its declaration.
4619 To suppress this warning use the @code{unused} attribute
4620 (@pxref{Variable Attributes}).
4622 @item -Wno-unused-result
4623 @opindex Wunused-result
4624 @opindex Wno-unused-result
4625 Do not warn if a caller of a function marked with attribute
4626 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4627 its return value. The default is @option{-Wunused-result}.
4629 @item -Wunused-variable
4630 @opindex Wunused-variable
4631 @opindex Wno-unused-variable
4632 Warn whenever a local or static variable is unused aside from its
4633 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4634 but not for C++. This warning is enabled by @option{-Wall}.
4636 To suppress this warning use the @code{unused} attribute
4637 (@pxref{Variable Attributes}).
4639 @item -Wunused-const-variable
4640 @itemx -Wunused-const-variable=@var{n}
4641 @opindex Wunused-const-variable
4642 @opindex Wno-unused-const-variable
4643 Warn whenever a constant static variable is unused aside from its declaration.
4644 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4645 for C, but not for C++. In C this declares variable storage, but in C++ this
4646 is not an error since const variables take the place of @code{#define}s.
4648 To suppress this warning use the @code{unused} attribute
4649 (@pxref{Variable Attributes}).
4651 @table @gcctabopt
4652 @item -Wunused-const-variable=1
4653 This is the warning level that is enabled by @option{-Wunused-variable} for
4654 C.  It warns only about unused static const variables defined in the main
4655 compilation unit, but not about static const variables declared in any
4656 header included.
4658 @item -Wunused-const-variable=2
4659 This warning level also warns for unused constant static variables in
4660 headers (excluding system headers).  This is the warning level of
4661 @option{-Wunused-const-variable} and must be explicitly requested since
4662 in C++ this isn't an error and in C it might be harder to clean up all
4663 headers included.
4664 @end table
4666 @item -Wunused-value
4667 @opindex Wunused-value
4668 @opindex Wno-unused-value
4669 Warn whenever a statement computes a result that is explicitly not
4670 used. To suppress this warning cast the unused expression to
4671 @code{void}. This includes an expression-statement or the left-hand
4672 side of a comma expression that contains no side effects. For example,
4673 an expression such as @code{x[i,j]} causes a warning, while
4674 @code{x[(void)i,j]} does not.
4676 This warning is enabled by @option{-Wall}.
4678 @item -Wunused
4679 @opindex Wunused
4680 @opindex Wno-unused
4681 All the above @option{-Wunused} options combined.
4683 In order to get a warning about an unused function parameter, you must
4684 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4685 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4687 @item -Wuninitialized
4688 @opindex Wuninitialized
4689 @opindex Wno-uninitialized
4690 Warn if an automatic variable is used without first being initialized
4691 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4692 warn if a non-static reference or non-static @code{const} member
4693 appears in a class without constructors.
4695 If you want to warn about code that uses the uninitialized value of the
4696 variable in its own initializer, use the @option{-Winit-self} option.
4698 These warnings occur for individual uninitialized or clobbered
4699 elements of structure, union or array variables as well as for
4700 variables that are uninitialized or clobbered as a whole.  They do
4701 not occur for variables or elements declared @code{volatile}.  Because
4702 these warnings depend on optimization, the exact variables or elements
4703 for which there are warnings depends on the precise optimization
4704 options and version of GCC used.
4706 Note that there may be no warning about a variable that is used only
4707 to compute a value that itself is never used, because such
4708 computations may be deleted by data flow analysis before the warnings
4709 are printed.
4711 @item -Winvalid-memory-model
4712 @opindex Winvalid-memory-model
4713 @opindex Wno-invalid-memory-model
4714 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4715 and the C11 atomic generic functions with a memory consistency argument
4716 that is either invalid for the operation or outside the range of values
4717 of the @code{memory_order} enumeration.  For example, since the
4718 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4719 defined for the relaxed, release, and sequentially consistent memory
4720 orders the following code is diagnosed:
4722 @smallexample
4723 void store (int *i)
4725   __atomic_store_n (i, 0, memory_order_consume);
4727 @end smallexample
4729 @option{-Winvalid-memory-model} is enabled by default.
4731 @item -Wmaybe-uninitialized
4732 @opindex Wmaybe-uninitialized
4733 @opindex Wno-maybe-uninitialized
4734 For an automatic variable, if there exists a path from the function
4735 entry to a use of the variable that is initialized, but there exist
4736 some other paths for which the variable is not initialized, the compiler
4737 emits a warning if it cannot prove the uninitialized paths are not
4738 executed at run time. These warnings are made optional because GCC is
4739 not smart enough to see all the reasons why the code might be correct
4740 in spite of appearing to have an error.  Here is one example of how
4741 this can happen:
4743 @smallexample
4744 @group
4746   int x;
4747   switch (y)
4748     @{
4749     case 1: x = 1;
4750       break;
4751     case 2: x = 4;
4752       break;
4753     case 3: x = 5;
4754     @}
4755   foo (x);
4757 @end group
4758 @end smallexample
4760 @noindent
4761 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4762 always initialized, but GCC doesn't know this. To suppress the
4763 warning, you need to provide a default case with assert(0) or
4764 similar code.
4766 @cindex @code{longjmp} warnings
4767 This option also warns when a non-volatile automatic variable might be
4768 changed by a call to @code{longjmp}.  These warnings as well are possible
4769 only in optimizing compilation.
4771 The compiler sees only the calls to @code{setjmp}.  It cannot know
4772 where @code{longjmp} will be called; in fact, a signal handler could
4773 call it at any point in the code.  As a result, you may get a warning
4774 even when there is in fact no problem because @code{longjmp} cannot
4775 in fact be called at the place that would cause a problem.
4777 Some spurious warnings can be avoided if you declare all the functions
4778 you use that never return as @code{noreturn}.  @xref{Function
4779 Attributes}.
4781 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4783 @item -Wunknown-pragmas
4784 @opindex Wunknown-pragmas
4785 @opindex Wno-unknown-pragmas
4786 @cindex warning for unknown pragmas
4787 @cindex unknown pragmas, warning
4788 @cindex pragmas, warning of unknown
4789 Warn when a @code{#pragma} directive is encountered that is not understood by 
4790 GCC@.  If this command-line option is used, warnings are even issued
4791 for unknown pragmas in system header files.  This is not the case if
4792 the warnings are only enabled by the @option{-Wall} command-line option.
4794 @item -Wno-pragmas
4795 @opindex Wno-pragmas
4796 @opindex Wpragmas
4797 Do not warn about misuses of pragmas, such as incorrect parameters,
4798 invalid syntax, or conflicts between pragmas.  See also
4799 @option{-Wunknown-pragmas}.
4801 @item -Wstrict-aliasing
4802 @opindex Wstrict-aliasing
4803 @opindex Wno-strict-aliasing
4804 This option is only active when @option{-fstrict-aliasing} is active.
4805 It warns about code that might break the strict aliasing rules that the
4806 compiler is using for optimization.  The warning does not catch all
4807 cases, but does attempt to catch the more common pitfalls.  It is
4808 included in @option{-Wall}.
4809 It is equivalent to @option{-Wstrict-aliasing=3}
4811 @item -Wstrict-aliasing=n
4812 @opindex Wstrict-aliasing=n
4813 This option is only active when @option{-fstrict-aliasing} is active.
4814 It warns about code that might break the strict aliasing rules that the
4815 compiler is using for optimization.
4816 Higher levels correspond to higher accuracy (fewer false positives).
4817 Higher levels also correspond to more effort, similar to the way @option{-O} 
4818 works.
4819 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4821 Level 1: Most aggressive, quick, least accurate.
4822 Possibly useful when higher levels
4823 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4824 false negatives.  However, it has many false positives.
4825 Warns for all pointer conversions between possibly incompatible types,
4826 even if never dereferenced.  Runs in the front end only.
4828 Level 2: Aggressive, quick, not too precise.
4829 May still have many false positives (not as many as level 1 though),
4830 and few false negatives (but possibly more than level 1).
4831 Unlike level 1, it only warns when an address is taken.  Warns about
4832 incomplete types.  Runs in the front end only.
4834 Level 3 (default for @option{-Wstrict-aliasing}):
4835 Should have very few false positives and few false
4836 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4837 Takes care of the common pun+dereference pattern in the front end:
4838 @code{*(int*)&some_float}.
4839 If optimization is enabled, it also runs in the back end, where it deals
4840 with multiple statement cases using flow-sensitive points-to information.
4841 Only warns when the converted pointer is dereferenced.
4842 Does not warn about incomplete types.
4844 @item -Wstrict-overflow
4845 @itemx -Wstrict-overflow=@var{n}
4846 @opindex Wstrict-overflow
4847 @opindex Wno-strict-overflow
4848 This option is only active when @option{-fstrict-overflow} is active.
4849 It warns about cases where the compiler optimizes based on the
4850 assumption that signed overflow does not occur.  Note that it does not
4851 warn about all cases where the code might overflow: it only warns
4852 about cases where the compiler implements some optimization.  Thus
4853 this warning depends on the optimization level.
4855 An optimization that assumes that signed overflow does not occur is
4856 perfectly safe if the values of the variables involved are such that
4857 overflow never does, in fact, occur.  Therefore this warning can
4858 easily give a false positive: a warning about code that is not
4859 actually a problem.  To help focus on important issues, several
4860 warning levels are defined.  No warnings are issued for the use of
4861 undefined signed overflow when estimating how many iterations a loop
4862 requires, in particular when determining whether a loop will be
4863 executed at all.
4865 @table @gcctabopt
4866 @item -Wstrict-overflow=1
4867 Warn about cases that are both questionable and easy to avoid.  For
4868 example,  with @option{-fstrict-overflow}, the compiler simplifies
4869 @code{x + 1 > x} to @code{1}.  This level of
4870 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4871 are not, and must be explicitly requested.
4873 @item -Wstrict-overflow=2
4874 Also warn about other cases where a comparison is simplified to a
4875 constant.  For example: @code{abs (x) >= 0}.  This can only be
4876 simplified when @option{-fstrict-overflow} is in effect, because
4877 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4878 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4879 @option{-Wstrict-overflow=2}.
4881 @item -Wstrict-overflow=3
4882 Also warn about other cases where a comparison is simplified.  For
4883 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4885 @item -Wstrict-overflow=4
4886 Also warn about other simplifications not covered by the above cases.
4887 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4889 @item -Wstrict-overflow=5
4890 Also warn about cases where the compiler reduces the magnitude of a
4891 constant involved in a comparison.  For example: @code{x + 2 > y} is
4892 simplified to @code{x + 1 >= y}.  This is reported only at the
4893 highest warning level because this simplification applies to many
4894 comparisons, so this warning level gives a very large number of
4895 false positives.
4896 @end table
4898 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4899 @opindex Wsuggest-attribute=
4900 @opindex Wno-suggest-attribute=
4901 Warn for cases where adding an attribute may be beneficial. The
4902 attributes currently supported are listed below.
4904 @table @gcctabopt
4905 @item -Wsuggest-attribute=pure
4906 @itemx -Wsuggest-attribute=const
4907 @itemx -Wsuggest-attribute=noreturn
4908 @opindex Wsuggest-attribute=pure
4909 @opindex Wno-suggest-attribute=pure
4910 @opindex Wsuggest-attribute=const
4911 @opindex Wno-suggest-attribute=const
4912 @opindex Wsuggest-attribute=noreturn
4913 @opindex Wno-suggest-attribute=noreturn
4915 Warn about functions that might be candidates for attributes
4916 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4917 functions visible in other compilation units or (in the case of @code{pure} and
4918 @code{const}) if it cannot prove that the function returns normally. A function
4919 returns normally if it doesn't contain an infinite loop or return abnormally
4920 by throwing, calling @code{abort} or trapping.  This analysis requires option
4921 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4922 higher.  Higher optimization levels improve the accuracy of the analysis.
4924 @item -Wsuggest-attribute=format
4925 @itemx -Wmissing-format-attribute
4926 @opindex Wsuggest-attribute=format
4927 @opindex Wmissing-format-attribute
4928 @opindex Wno-suggest-attribute=format
4929 @opindex Wno-missing-format-attribute
4930 @opindex Wformat
4931 @opindex Wno-format
4933 Warn about function pointers that might be candidates for @code{format}
4934 attributes.  Note these are only possible candidates, not absolute ones.
4935 GCC guesses that function pointers with @code{format} attributes that
4936 are used in assignment, initialization, parameter passing or return
4937 statements should have a corresponding @code{format} attribute in the
4938 resulting type.  I.e.@: the left-hand side of the assignment or
4939 initialization, the type of the parameter variable, or the return type
4940 of the containing function respectively should also have a @code{format}
4941 attribute to avoid the warning.
4943 GCC also warns about function definitions that might be
4944 candidates for @code{format} attributes.  Again, these are only
4945 possible candidates.  GCC guesses that @code{format} attributes
4946 might be appropriate for any function that calls a function like
4947 @code{vprintf} or @code{vscanf}, but this might not always be the
4948 case, and some functions for which @code{format} attributes are
4949 appropriate may not be detected.
4950 @end table
4952 @item -Wsuggest-final-types
4953 @opindex Wno-suggest-final-types
4954 @opindex Wsuggest-final-types
4955 Warn about types with virtual methods where code quality would be improved
4956 if the type were declared with the C++11 @code{final} specifier, 
4957 or, if possible,
4958 declared in an anonymous namespace. This allows GCC to more aggressively
4959 devirtualize the polymorphic calls. This warning is more effective with link
4960 time optimization, where the information about the class hierarchy graph is
4961 more complete.
4963 @item -Wsuggest-final-methods
4964 @opindex Wno-suggest-final-methods
4965 @opindex Wsuggest-final-methods
4966 Warn about virtual methods where code quality would be improved if the method
4967 were declared with the C++11 @code{final} specifier, 
4968 or, if possible, its type were
4969 declared in an anonymous namespace or with the @code{final} specifier.
4970 This warning is
4971 more effective with link time optimization, where the information about the
4972 class hierarchy graph is more complete. It is recommended to first consider
4973 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4974 annotations.
4976 @item -Wsuggest-override
4977 Warn about overriding virtual functions that are not marked with the override
4978 keyword.
4980 @item -Walloca
4981 @opindex Wno-alloca
4982 @opindex Walloca
4983 This option warns on all uses of @code{alloca} in the source.
4985 @item -Walloca-larger-than=@var{n}
4986 This option warns on calls to @code{alloca} that are not bounded by a
4987 controlling predicate limiting its size to @var{n} bytes, or calls to
4988 @code{alloca} where the bound is unknown.
4990 For example, a bounded case of @code{alloca} could be:
4992 @smallexample
4993 void func (size_t n)
4995   void *p;
4996   if (n <= 1000)
4997     p = alloca (n);
4998   else
4999     p = malloc (n);
5000   f (p);
5002 @end smallexample
5004 In the above example, passing @code{-Walloca=1000} would not issue a
5005 warning because the call to @code{alloca} is known to be at most 1000
5006 bytes.  However, if @code{-Walloca=500} was passed, the compiler would
5007 have emitted a warning.
5009 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5010 controlling predicate verifying its size.  For example:
5012 @smallexample
5013 void func ()
5015   void *p = alloca (n);
5016   f (p);
5018 @end smallexample
5020 If @code{-Walloca=500} was passed, the above would trigger a warning,
5021 but this time because of the lack of bounds checking.
5023 Note, that even seemingly correct code involving signed integers could
5024 cause a warning:
5026 @smallexample
5027 void func (signed int n)
5029   if (n < 500)
5030     @{
5031       p = alloca (n);
5032       f (p);
5033     @}
5035 @end smallexample
5037 In the above example, @var{n} could be negative, causing a larger than
5038 expected argument to be implicitly casted into the @code{alloca} call.
5040 This option also warns when @code{alloca} is used in a loop.
5042 This warning is not enabled by @option{-Wall}, and is only active when
5043 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5045 See also @option{-Wvla-larger-than=@var{n}}.
5047 @item -Warray-bounds
5048 @itemx -Warray-bounds=@var{n}
5049 @opindex Wno-array-bounds
5050 @opindex Warray-bounds
5051 This option is only active when @option{-ftree-vrp} is active
5052 (default for @option{-O2} and above). It warns about subscripts to arrays
5053 that are always out of bounds. This warning is enabled by @option{-Wall}.
5055 @table @gcctabopt
5056 @item -Warray-bounds=1
5057 This is the warning level of @option{-Warray-bounds} and is enabled
5058 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5060 @item -Warray-bounds=2
5061 This warning level also warns about out of bounds access for
5062 arrays at the end of a struct and for arrays accessed through
5063 pointers. This warning level may give a larger number of
5064 false positives and is deactivated by default.
5065 @end table
5067 @item -Wbool-compare
5068 @opindex Wno-bool-compare
5069 @opindex Wbool-compare
5070 Warn about boolean expression compared with an integer value different from
5071 @code{true}/@code{false}.  For instance, the following comparison is
5072 always false:
5073 @smallexample
5074 int n = 5;
5075 @dots{}
5076 if ((n > 1) == 2) @{ @dots{} @}
5077 @end smallexample
5078 This warning is enabled by @option{-Wall}.
5080 @item -Wbool-operation
5081 @opindex Wno-bool-operation
5082 @opindex Wbool-operation
5083 Warn about suspicious operations on expressions of a boolean type.  For
5084 instance, bitwise negation of a boolean is very likely a bug in the program.
5085 For C, this warning also warns about incrementing or decrementing a boolean,
5086 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5087 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5089 This warning is enabled by @option{-Wall}.
5091 @item -Wduplicated-cond
5092 @opindex Wno-duplicated-cond
5093 @opindex Wduplicated-cond
5094 Warn about duplicated conditions in an if-else-if chain.  For instance,
5095 warn for the following code:
5096 @smallexample
5097 if (p->q != NULL) @{ @dots{} @}
5098 else if (p->q != NULL) @{ @dots{} @}
5099 @end smallexample
5101 @item -Wframe-address
5102 @opindex Wno-frame-address
5103 @opindex Wframe-address
5104 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5105 is called with an argument greater than 0.  Such calls may return indeterminate
5106 values or crash the program.  The warning is included in @option{-Wall}.
5108 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5109 @opindex Wno-discarded-qualifiers
5110 @opindex Wdiscarded-qualifiers
5111 Do not warn if type qualifiers on pointers are being discarded.
5112 Typically, the compiler warns if a @code{const char *} variable is
5113 passed to a function that takes a @code{char *} parameter.  This option
5114 can be used to suppress such a warning.
5116 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5117 @opindex Wno-discarded-array-qualifiers
5118 @opindex Wdiscarded-array-qualifiers
5119 Do not warn if type qualifiers on arrays which are pointer targets
5120 are being discarded. Typically, the compiler warns if a
5121 @code{const int (*)[]} variable is passed to a function that
5122 takes a @code{int (*)[]} parameter.  This option can be used to
5123 suppress such a warning.
5125 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5126 @opindex Wno-incompatible-pointer-types
5127 @opindex Wincompatible-pointer-types
5128 Do not warn when there is a conversion between pointers that have incompatible
5129 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5130 which warns for pointer argument passing or assignment with different
5131 signedness.
5133 @item -Wno-int-conversion @r{(C and Objective-C only)}
5134 @opindex Wno-int-conversion
5135 @opindex Wint-conversion
5136 Do not warn about incompatible integer to pointer and pointer to integer
5137 conversions.  This warning is about implicit conversions; for explicit
5138 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5139 @option{-Wno-pointer-to-int-cast} may be used.
5141 @item -Wno-div-by-zero
5142 @opindex Wno-div-by-zero
5143 @opindex Wdiv-by-zero
5144 Do not warn about compile-time integer division by zero.  Floating-point
5145 division by zero is not warned about, as it can be a legitimate way of
5146 obtaining infinities and NaNs.
5148 @item -Wsystem-headers
5149 @opindex Wsystem-headers
5150 @opindex Wno-system-headers
5151 @cindex warnings from system headers
5152 @cindex system headers, warnings from
5153 Print warning messages for constructs found in system header files.
5154 Warnings from system headers are normally suppressed, on the assumption
5155 that they usually do not indicate real problems and would only make the
5156 compiler output harder to read.  Using this command-line option tells
5157 GCC to emit warnings from system headers as if they occurred in user
5158 code.  However, note that using @option{-Wall} in conjunction with this
5159 option does @emph{not} warn about unknown pragmas in system
5160 headers---for that, @option{-Wunknown-pragmas} must also be used.
5162 @item -Wtautological-compare
5163 @opindex Wtautological-compare
5164 @opindex Wno-tautological-compare
5165 Warn if a self-comparison always evaluates to true or false.  This
5166 warning detects various mistakes such as:
5167 @smallexample
5168 int i = 1;
5169 @dots{}
5170 if (i > i) @{ @dots{} @}
5171 @end smallexample
5172 This warning is enabled by @option{-Wall}.
5174 @item -Wtrampolines
5175 @opindex Wtrampolines
5176 @opindex Wno-trampolines
5177 Warn about trampolines generated for pointers to nested functions.
5178 A trampoline is a small piece of data or code that is created at run
5179 time on the stack when the address of a nested function is taken, and is
5180 used to call the nested function indirectly.  For some targets, it is
5181 made up of data only and thus requires no special treatment.  But, for
5182 most targets, it is made up of code and thus requires the stack to be
5183 made executable in order for the program to work properly.
5185 @item -Wfloat-equal
5186 @opindex Wfloat-equal
5187 @opindex Wno-float-equal
5188 Warn if floating-point values are used in equality comparisons.
5190 The idea behind this is that sometimes it is convenient (for the
5191 programmer) to consider floating-point values as approximations to
5192 infinitely precise real numbers.  If you are doing this, then you need
5193 to compute (by analyzing the code, or in some other way) the maximum or
5194 likely maximum error that the computation introduces, and allow for it
5195 when performing comparisons (and when producing output, but that's a
5196 different problem).  In particular, instead of testing for equality, you
5197 should check to see whether the two values have ranges that overlap; and
5198 this is done with the relational operators, so equality comparisons are
5199 probably mistaken.
5201 @item -Wtraditional @r{(C and Objective-C only)}
5202 @opindex Wtraditional
5203 @opindex Wno-traditional
5204 Warn about certain constructs that behave differently in traditional and
5205 ISO C@.  Also warn about ISO C constructs that have no traditional C
5206 equivalent, and/or problematic constructs that should be avoided.
5208 @itemize @bullet
5209 @item
5210 Macro parameters that appear within string literals in the macro body.
5211 In traditional C macro replacement takes place within string literals,
5212 but in ISO C it does not.
5214 @item
5215 In traditional C, some preprocessor directives did not exist.
5216 Traditional preprocessors only considered a line to be a directive
5217 if the @samp{#} appeared in column 1 on the line.  Therefore
5218 @option{-Wtraditional} warns about directives that traditional C
5219 understands but ignores because the @samp{#} does not appear as the
5220 first character on the line.  It also suggests you hide directives like
5221 @code{#pragma} not understood by traditional C by indenting them.  Some
5222 traditional implementations do not recognize @code{#elif}, so this option
5223 suggests avoiding it altogether.
5225 @item
5226 A function-like macro that appears without arguments.
5228 @item
5229 The unary plus operator.
5231 @item
5232 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5233 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5234 constants.)  Note, these suffixes appear in macros defined in the system
5235 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5236 Use of these macros in user code might normally lead to spurious
5237 warnings, however GCC's integrated preprocessor has enough context to
5238 avoid warning in these cases.
5240 @item
5241 A function declared external in one block and then used after the end of
5242 the block.
5244 @item
5245 A @code{switch} statement has an operand of type @code{long}.
5247 @item
5248 A non-@code{static} function declaration follows a @code{static} one.
5249 This construct is not accepted by some traditional C compilers.
5251 @item
5252 The ISO type of an integer constant has a different width or
5253 signedness from its traditional type.  This warning is only issued if
5254 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5255 typically represent bit patterns, are not warned about.
5257 @item
5258 Usage of ISO string concatenation is detected.
5260 @item
5261 Initialization of automatic aggregates.
5263 @item
5264 Identifier conflicts with labels.  Traditional C lacks a separate
5265 namespace for labels.
5267 @item
5268 Initialization of unions.  If the initializer is zero, the warning is
5269 omitted.  This is done under the assumption that the zero initializer in
5270 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5271 initializer warnings and relies on default initialization to zero in the
5272 traditional C case.
5274 @item
5275 Conversions by prototypes between fixed/floating-point values and vice
5276 versa.  The absence of these prototypes when compiling with traditional
5277 C causes serious problems.  This is a subset of the possible
5278 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5280 @item
5281 Use of ISO C style function definitions.  This warning intentionally is
5282 @emph{not} issued for prototype declarations or variadic functions
5283 because these ISO C features appear in your code when using
5284 libiberty's traditional C compatibility macros, @code{PARAMS} and
5285 @code{VPARAMS}.  This warning is also bypassed for nested functions
5286 because that feature is already a GCC extension and thus not relevant to
5287 traditional C compatibility.
5288 @end itemize
5290 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5291 @opindex Wtraditional-conversion
5292 @opindex Wno-traditional-conversion
5293 Warn if a prototype causes a type conversion that is different from what
5294 would happen to the same argument in the absence of a prototype.  This
5295 includes conversions of fixed point to floating and vice versa, and
5296 conversions changing the width or signedness of a fixed-point argument
5297 except when the same as the default promotion.
5299 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5300 @opindex Wdeclaration-after-statement
5301 @opindex Wno-declaration-after-statement
5302 Warn when a declaration is found after a statement in a block.  This
5303 construct, known from C++, was introduced with ISO C99 and is by default
5304 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5306 @item -Wundef
5307 @opindex Wundef
5308 @opindex Wno-undef
5309 Warn if an undefined identifier is evaluated in an @code{#if} directive.
5311 @item -Wno-endif-labels
5312 @opindex Wno-endif-labels
5313 @opindex Wendif-labels
5314 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
5316 @item -Wshadow
5317 @opindex Wshadow
5318 @opindex Wno-shadow
5319 Warn whenever a local variable or type declaration shadows another
5320 variable, parameter, type, class member (in C++), or instance variable
5321 (in Objective-C) or whenever a built-in function is shadowed. Note
5322 that in C++, the compiler warns if a local variable shadows an
5323 explicit typedef, but not if it shadows a struct/class/enum.
5325 @item -Wno-shadow-ivar @r{(Objective-C only)}
5326 @opindex Wno-shadow-ivar
5327 @opindex Wshadow-ivar
5328 Do not warn whenever a local variable shadows an instance variable in an
5329 Objective-C method.
5331 @item -Wlarger-than=@var{len}
5332 @opindex Wlarger-than=@var{len}
5333 @opindex Wlarger-than-@var{len}
5334 Warn whenever an object of larger than @var{len} bytes is defined.
5336 @item -Wframe-larger-than=@var{len}
5337 @opindex Wframe-larger-than
5338 Warn if the size of a function frame is larger than @var{len} bytes.
5339 The computation done to determine the stack frame size is approximate
5340 and not conservative.
5341 The actual requirements may be somewhat greater than @var{len}
5342 even if you do not get a warning.  In addition, any space allocated
5343 via @code{alloca}, variable-length arrays, or related constructs
5344 is not included by the compiler when determining
5345 whether or not to issue a warning.
5347 @item -Wno-free-nonheap-object
5348 @opindex Wno-free-nonheap-object
5349 @opindex Wfree-nonheap-object
5350 Do not warn when attempting to free an object that was not allocated
5351 on the heap.
5353 @item -Wstack-usage=@var{len}
5354 @opindex Wstack-usage
5355 Warn if the stack usage of a function might be larger than @var{len} bytes.
5356 The computation done to determine the stack usage is conservative.
5357 Any space allocated via @code{alloca}, variable-length arrays, or related
5358 constructs is included by the compiler when determining whether or not to
5359 issue a warning.
5361 The message is in keeping with the output of @option{-fstack-usage}.
5363 @itemize
5364 @item
5365 If the stack usage is fully static but exceeds the specified amount, it's:
5367 @smallexample
5368   warning: stack usage is 1120 bytes
5369 @end smallexample
5370 @item
5371 If the stack usage is (partly) dynamic but bounded, it's:
5373 @smallexample
5374   warning: stack usage might be 1648 bytes
5375 @end smallexample
5376 @item
5377 If the stack usage is (partly) dynamic and not bounded, it's:
5379 @smallexample
5380   warning: stack usage might be unbounded
5381 @end smallexample
5382 @end itemize
5384 @item -Wunsafe-loop-optimizations
5385 @opindex Wunsafe-loop-optimizations
5386 @opindex Wno-unsafe-loop-optimizations
5387 Warn if the loop cannot be optimized because the compiler cannot
5388 assume anything on the bounds of the loop indices.  With
5389 @option{-funsafe-loop-optimizations} warn if the compiler makes
5390 such assumptions.
5392 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5393 @opindex Wno-pedantic-ms-format
5394 @opindex Wpedantic-ms-format
5395 When used in combination with @option{-Wformat}
5396 and @option{-pedantic} without GNU extensions, this option
5397 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5398 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5399 which depend on the MS runtime.
5401 @item -Waligned-new
5402 @opindex Waligned-new
5403 @opindex Wno-aligned-new
5404 Warn about a new-expression of a type that requires greater alignment
5405 than the @code{alignof(std::max_align_t)} but uses an allocation
5406 function without an explicit alignment parameter. This option is
5407 enabled by @option{-Wall}.
5409 Normally this only warns about global allocation functions, but
5410 @option{-Waligned-new=all} also warns about class member allocation
5411 functions.
5413 @item -Wplacement-new
5414 @itemx -Wplacement-new=@var{n}
5415 @opindex Wplacement-new
5416 @opindex Wno-placement-new
5417 Warn about placement new expressions with undefined behavior, such as
5418 constructing an object in a buffer that is smaller than the type of
5419 the object.  For example, the placement new expression below is diagnosed
5420 because it attempts to construct an array of 64 integers in a buffer only
5421 64 bytes large.
5422 @smallexample
5423 char buf [64];
5424 new (buf) int[64];
5425 @end smallexample
5426 This warning is enabled by default.
5428 @table @gcctabopt
5429 @item -Wplacement-new=1
5430 This is the default warning level of @option{-Wplacement-new}.  At this
5431 level the warning is not issued for some strictly undefined constructs that
5432 GCC allows as extensions for compatibility with legacy code.  For example,
5433 the following @code{new} expression is not diagnosed at this level even
5434 though it has undefined behavior according to the C++ standard because
5435 it writes past the end of the one-element array.
5436 @smallexample
5437 struct S @{ int n, a[1]; @};
5438 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5439 new (s->a)int [32]();
5440 @end smallexample
5442 @item -Wplacement-new=2
5443 At this level, in addition to diagnosing all the same constructs as at level
5444 1, a diagnostic is also issued for placement new expressions that construct
5445 an object in the last member of structure whose type is an array of a single
5446 element and whose size is less than the size of the object being constructed.
5447 While the previous example would be diagnosed, the following construct makes
5448 use of the flexible member array extension to avoid the warning at level 2.
5449 @smallexample
5450 struct S @{ int n, a[]; @};
5451 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5452 new (s->a)int [32]();
5453 @end smallexample
5455 @end table
5457 @item -Wpointer-arith
5458 @opindex Wpointer-arith
5459 @opindex Wno-pointer-arith
5460 Warn about anything that depends on the ``size of'' a function type or
5461 of @code{void}.  GNU C assigns these types a size of 1, for
5462 convenience in calculations with @code{void *} pointers and pointers
5463 to functions.  In C++, warn also when an arithmetic operation involves
5464 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5466 @item -Wtype-limits
5467 @opindex Wtype-limits
5468 @opindex Wno-type-limits
5469 Warn if a comparison is always true or always false due to the limited
5470 range of the data type, but do not warn for constant expressions.  For
5471 example, warn if an unsigned variable is compared against zero with
5472 @code{<} or @code{>=}.  This warning is also enabled by
5473 @option{-Wextra}.
5475 @item -Wbad-function-cast @r{(C and Objective-C only)}
5476 @opindex Wbad-function-cast
5477 @opindex Wno-bad-function-cast
5478 Warn when a function call is cast to a non-matching type.
5479 For example, warn if a call to a function returning an integer type 
5480 is cast to a pointer type.
5482 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5483 @opindex Wc90-c99-compat
5484 @opindex Wno-c90-c99-compat
5485 Warn about features not present in ISO C90, but present in ISO C99.
5486 For instance, warn about use of variable length arrays, @code{long long}
5487 type, @code{bool} type, compound literals, designated initializers, and so
5488 on.  This option is independent of the standards mode.  Warnings are disabled
5489 in the expression that follows @code{__extension__}.
5491 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5492 @opindex Wc99-c11-compat
5493 @opindex Wno-c99-c11-compat
5494 Warn about features not present in ISO C99, but present in ISO C11.
5495 For instance, warn about use of anonymous structures and unions,
5496 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5497 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5498 and so on.  This option is independent of the standards mode.  Warnings are
5499 disabled in the expression that follows @code{__extension__}.
5501 @item -Wc++-compat @r{(C and Objective-C only)}
5502 @opindex Wc++-compat
5503 Warn about ISO C constructs that are outside of the common subset of
5504 ISO C and ISO C++, e.g.@: request for implicit conversion from
5505 @code{void *} to a pointer to non-@code{void} type.
5507 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5508 @opindex Wc++11-compat
5509 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5510 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5511 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5512 enabled by @option{-Wall}.
5514 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5515 @opindex Wc++14-compat
5516 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5517 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5519 @item -Wcast-qual
5520 @opindex Wcast-qual
5521 @opindex Wno-cast-qual
5522 Warn whenever a pointer is cast so as to remove a type qualifier from
5523 the target type.  For example, warn if a @code{const char *} is cast
5524 to an ordinary @code{char *}.
5526 Also warn when making a cast that introduces a type qualifier in an
5527 unsafe way.  For example, casting @code{char **} to @code{const char **}
5528 is unsafe, as in this example:
5530 @smallexample
5531   /* p is char ** value.  */
5532   const char **q = (const char **) p;
5533   /* Assignment of readonly string to const char * is OK.  */
5534   *q = "string";
5535   /* Now char** pointer points to read-only memory.  */
5536   **p = 'b';
5537 @end smallexample
5539 @item -Wcast-align
5540 @opindex Wcast-align
5541 @opindex Wno-cast-align
5542 Warn whenever a pointer is cast such that the required alignment of the
5543 target is increased.  For example, warn if a @code{char *} is cast to
5544 an @code{int *} on machines where integers can only be accessed at
5545 two- or four-byte boundaries.
5547 @item -Wwrite-strings
5548 @opindex Wwrite-strings
5549 @opindex Wno-write-strings
5550 When compiling C, give string constants the type @code{const
5551 char[@var{length}]} so that copying the address of one into a
5552 non-@code{const} @code{char *} pointer produces a warning.  These
5553 warnings help you find at compile time code that can try to write
5554 into a string constant, but only if you have been very careful about
5555 using @code{const} in declarations and prototypes.  Otherwise, it is
5556 just a nuisance. This is why we did not make @option{-Wall} request
5557 these warnings.
5559 When compiling C++, warn about the deprecated conversion from string
5560 literals to @code{char *}.  This warning is enabled by default for C++
5561 programs.
5563 @item -Wclobbered
5564 @opindex Wclobbered
5565 @opindex Wno-clobbered
5566 Warn for variables that might be changed by @code{longjmp} or
5567 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5569 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5570 @opindex Wconditionally-supported
5571 @opindex Wno-conditionally-supported
5572 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5574 @item -Wconversion
5575 @opindex Wconversion
5576 @opindex Wno-conversion
5577 Warn for implicit conversions that may alter a value. This includes
5578 conversions between real and integer, like @code{abs (x)} when
5579 @code{x} is @code{double}; conversions between signed and unsigned,
5580 like @code{unsigned ui = -1}; and conversions to smaller types, like
5581 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5582 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5583 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5584 conversions between signed and unsigned integers can be disabled by
5585 using @option{-Wno-sign-conversion}.
5587 For C++, also warn for confusing overload resolution for user-defined
5588 conversions; and conversions that never use a type conversion
5589 operator: conversions to @code{void}, the same type, a base class or a
5590 reference to them. Warnings about conversions between signed and
5591 unsigned integers are disabled by default in C++ unless
5592 @option{-Wsign-conversion} is explicitly enabled.
5594 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5595 @opindex Wconversion-null
5596 @opindex Wno-conversion-null
5597 Do not warn for conversions between @code{NULL} and non-pointer
5598 types. @option{-Wconversion-null} is enabled by default.
5600 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5601 @opindex Wzero-as-null-pointer-constant
5602 @opindex Wno-zero-as-null-pointer-constant
5603 Warn when a literal @samp{0} is used as null pointer constant.  This can
5604 be useful to facilitate the conversion to @code{nullptr} in C++11.
5606 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5607 @opindex Wsubobject-linkage
5608 @opindex Wno-subobject-linkage
5609 Warn if a class type has a base or a field whose type uses the anonymous
5610 namespace or depends on a type with no linkage.  If a type A depends on
5611 a type B with no or internal linkage, defining it in multiple
5612 translation units would be an ODR violation because the meaning of B
5613 is different in each translation unit.  If A only appears in a single
5614 translation unit, the best way to silence the warning is to give it
5615 internal linkage by putting it in an anonymous namespace as well.  The
5616 compiler doesn't give this warning for types defined in the main .C
5617 file, as those are unlikely to have multiple definitions.
5618 @option{-Wsubobject-linkage} is enabled by default.
5620 @item -Wdangling-else
5621 @opindex Wdangling-else
5622 @opindex Wno-dangling-else
5623 Warn about constructions where there may be confusion to which
5624 @code{if} statement an @code{else} branch belongs.  Here is an example of
5625 such a case:
5627 @smallexample
5628 @group
5630   if (a)
5631     if (b)
5632       foo ();
5633   else
5634     bar ();
5636 @end group
5637 @end smallexample
5639 In C/C++, every @code{else} branch belongs to the innermost possible
5640 @code{if} statement, which in this example is @code{if (b)}.  This is
5641 often not what the programmer expected, as illustrated in the above
5642 example by indentation the programmer chose.  When there is the
5643 potential for this confusion, GCC issues a warning when this flag
5644 is specified.  To eliminate the warning, add explicit braces around
5645 the innermost @code{if} statement so there is no way the @code{else}
5646 can belong to the enclosing @code{if}.  The resulting code
5647 looks like this:
5649 @smallexample
5650 @group
5652   if (a)
5653     @{
5654       if (b)
5655         foo ();
5656       else
5657         bar ();
5658     @}
5660 @end group
5661 @end smallexample
5663 This warning is enabled by @option{-Wparentheses}.
5665 @item -Wdate-time
5666 @opindex Wdate-time
5667 @opindex Wno-date-time
5668 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5669 are encountered as they might prevent bit-wise-identical reproducible
5670 compilations.
5672 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5673 @opindex Wdelete-incomplete
5674 @opindex Wno-delete-incomplete
5675 Warn when deleting a pointer to incomplete type, which may cause
5676 undefined behavior at runtime.  This warning is enabled by default.
5678 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5679 @opindex Wuseless-cast
5680 @opindex Wno-useless-cast
5681 Warn when an expression is casted to its own type.
5683 @item -Wempty-body
5684 @opindex Wempty-body
5685 @opindex Wno-empty-body
5686 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5687 while} statement.  This warning is also enabled by @option{-Wextra}.
5689 @item -Wenum-compare
5690 @opindex Wenum-compare
5691 @opindex Wno-enum-compare
5692 Warn about a comparison between values of different enumerated types.
5693 In C++ enumeral mismatches in conditional expressions are also
5694 diagnosed and the warning is enabled by default.  In C this warning is 
5695 enabled by @option{-Wall}.
5697 @item -Wjump-misses-init @r{(C, Objective-C only)}
5698 @opindex Wjump-misses-init
5699 @opindex Wno-jump-misses-init
5700 Warn if a @code{goto} statement or a @code{switch} statement jumps
5701 forward across the initialization of a variable, or jumps backward to a
5702 label after the variable has been initialized.  This only warns about
5703 variables that are initialized when they are declared.  This warning is
5704 only supported for C and Objective-C; in C++ this sort of branch is an
5705 error in any case.
5707 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5708 can be disabled with the @option{-Wno-jump-misses-init} option.
5710 @item -Wsign-compare
5711 @opindex Wsign-compare
5712 @opindex Wno-sign-compare
5713 @cindex warning for comparison of signed and unsigned values
5714 @cindex comparison of signed and unsigned values, warning
5715 @cindex signed and unsigned values, comparison warning
5716 Warn when a comparison between signed and unsigned values could produce
5717 an incorrect result when the signed value is converted to unsigned.
5718 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5719 also enabled by @option{-Wextra}.
5721 @item -Wsign-conversion
5722 @opindex Wsign-conversion
5723 @opindex Wno-sign-conversion
5724 Warn for implicit conversions that may change the sign of an integer
5725 value, like assigning a signed integer expression to an unsigned
5726 integer variable. An explicit cast silences the warning. In C, this
5727 option is enabled also by @option{-Wconversion}.
5729 @item -Wfloat-conversion
5730 @opindex Wfloat-conversion
5731 @opindex Wno-float-conversion
5732 Warn for implicit conversions that reduce the precision of a real value.
5733 This includes conversions from real to integer, and from higher precision
5734 real to lower precision real values.  This option is also enabled by
5735 @option{-Wconversion}.
5737 @item -Wno-scalar-storage-order
5738 @opindex -Wno-scalar-storage-order
5739 @opindex -Wscalar-storage-order
5740 Do not warn on suspicious constructs involving reverse scalar storage order.
5742 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5743 @opindex Wsized-deallocation
5744 @opindex Wno-sized-deallocation
5745 Warn about a definition of an unsized deallocation function
5746 @smallexample
5747 void operator delete (void *) noexcept;
5748 void operator delete[] (void *) noexcept;
5749 @end smallexample
5750 without a definition of the corresponding sized deallocation function
5751 @smallexample
5752 void operator delete (void *, std::size_t) noexcept;
5753 void operator delete[] (void *, std::size_t) noexcept;
5754 @end smallexample
5755 or vice versa.  Enabled by @option{-Wextra} along with
5756 @option{-fsized-deallocation}.
5758 @item -Wsizeof-pointer-memaccess
5759 @opindex Wsizeof-pointer-memaccess
5760 @opindex Wno-sizeof-pointer-memaccess
5761 Warn for suspicious length parameters to certain string and memory built-in
5762 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5763 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5764 but a pointer, and suggests a possible fix, or about
5765 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5766 @option{-Wall}.
5768 @item -Wsizeof-array-argument
5769 @opindex Wsizeof-array-argument
5770 @opindex Wno-sizeof-array-argument
5771 Warn when the @code{sizeof} operator is applied to a parameter that is
5772 declared as an array in a function definition.  This warning is enabled by
5773 default for C and C++ programs.
5775 @item -Wmemset-elt-size
5776 @opindex Wmemset-elt-size
5777 @opindex Wno-memset-elt-size
5778 Warn for suspicious calls to the @code{memset} built-in function, if the
5779 first argument references an array, and the third argument is a number
5780 equal to the number of elements, but not equal to the size of the array
5781 in memory.  This indicates that the user has omitted a multiplication by
5782 the element size.  This warning is enabled by @option{-Wall}.
5784 @item -Wmemset-transposed-args
5785 @opindex Wmemset-transposed-args
5786 @opindex Wno-memset-transposed-args
5787 Warn for suspicious calls to the @code{memset} built-in function, if the
5788 second argument is not zero and the third argument is zero.  This warns e.g.@
5789 about @code{memset (buf, sizeof buf, 0)} where most probably
5790 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5791 is only emitted if the third argument is literal zero.  If it is some
5792 expression that is folded to zero, a cast of zero to some type, etc., 
5793 it is far less likely that the user has mistakenly exchanged the arguments 
5794 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5796 @item -Waddress
5797 @opindex Waddress
5798 @opindex Wno-address
5799 Warn about suspicious uses of memory addresses. These include using
5800 the address of a function in a conditional expression, such as
5801 @code{void func(void); if (func)}, and comparisons against the memory
5802 address of a string literal, such as @code{if (x == "abc")}.  Such
5803 uses typically indicate a programmer error: the address of a function
5804 always evaluates to true, so their use in a conditional usually
5805 indicate that the programmer forgot the parentheses in a function
5806 call; and comparisons against string literals result in unspecified
5807 behavior and are not portable in C, so they usually indicate that the
5808 programmer intended to use @code{strcmp}.  This warning is enabled by
5809 @option{-Wall}.
5811 @item -Wlogical-op
5812 @opindex Wlogical-op
5813 @opindex Wno-logical-op
5814 Warn about suspicious uses of logical operators in expressions.
5815 This includes using logical operators in contexts where a
5816 bit-wise operator is likely to be expected.  Also warns when
5817 the operands of a logical operator are the same:
5818 @smallexample
5819 extern int a;
5820 if (a < 0 && a < 0) @{ @dots{} @}
5821 @end smallexample
5823 @item -Wlogical-not-parentheses
5824 @opindex Wlogical-not-parentheses
5825 @opindex Wno-logical-not-parentheses
5826 Warn about logical not used on the left hand side operand of a comparison.
5827 This option does not warn if the right operand is considered to be a boolean
5828 expression.  Its purpose is to detect suspicious code like the following:
5829 @smallexample
5830 int a;
5831 @dots{}
5832 if (!a > 1) @{ @dots{} @}
5833 @end smallexample
5835 It is possible to suppress the warning by wrapping the LHS into
5836 parentheses:
5837 @smallexample
5838 if ((!a) > 1) @{ @dots{} @}
5839 @end smallexample
5841 This warning is enabled by @option{-Wall}.
5843 @item -Waggregate-return
5844 @opindex Waggregate-return
5845 @opindex Wno-aggregate-return
5846 Warn if any functions that return structures or unions are defined or
5847 called.  (In languages where you can return an array, this also elicits
5848 a warning.)
5850 @item -Wno-aggressive-loop-optimizations
5851 @opindex Wno-aggressive-loop-optimizations
5852 @opindex Waggressive-loop-optimizations
5853 Warn if in a loop with constant number of iterations the compiler detects
5854 undefined behavior in some statement during one or more of the iterations.
5856 @item -Wno-attributes
5857 @opindex Wno-attributes
5858 @opindex Wattributes
5859 Do not warn if an unexpected @code{__attribute__} is used, such as
5860 unrecognized attributes, function attributes applied to variables,
5861 etc.  This does not stop errors for incorrect use of supported
5862 attributes.
5864 @item -Wno-builtin-macro-redefined
5865 @opindex Wno-builtin-macro-redefined
5866 @opindex Wbuiltin-macro-redefined
5867 Do not warn if certain built-in macros are redefined.  This suppresses
5868 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5869 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5871 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5872 @opindex Wstrict-prototypes
5873 @opindex Wno-strict-prototypes
5874 Warn if a function is declared or defined without specifying the
5875 argument types.  (An old-style function definition is permitted without
5876 a warning if preceded by a declaration that specifies the argument
5877 types.)
5879 @item -Wold-style-declaration @r{(C and Objective-C only)}
5880 @opindex Wold-style-declaration
5881 @opindex Wno-old-style-declaration
5882 Warn for obsolescent usages, according to the C Standard, in a
5883 declaration. For example, warn if storage-class specifiers like
5884 @code{static} are not the first things in a declaration.  This warning
5885 is also enabled by @option{-Wextra}.
5887 @item -Wold-style-definition @r{(C and Objective-C only)}
5888 @opindex Wold-style-definition
5889 @opindex Wno-old-style-definition
5890 Warn if an old-style function definition is used.  A warning is given
5891 even if there is a previous prototype.
5893 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5894 @opindex Wmissing-parameter-type
5895 @opindex Wno-missing-parameter-type
5896 A function parameter is declared without a type specifier in K&R-style
5897 functions:
5899 @smallexample
5900 void foo(bar) @{ @}
5901 @end smallexample
5903 This warning is also enabled by @option{-Wextra}.
5905 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5906 @opindex Wmissing-prototypes
5907 @opindex Wno-missing-prototypes
5908 Warn if a global function is defined without a previous prototype
5909 declaration.  This warning is issued even if the definition itself
5910 provides a prototype.  Use this option to detect global functions
5911 that do not have a matching prototype declaration in a header file.
5912 This option is not valid for C++ because all function declarations
5913 provide prototypes and a non-matching declaration declares an
5914 overload rather than conflict with an earlier declaration.
5915 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5917 @item -Wmissing-declarations
5918 @opindex Wmissing-declarations
5919 @opindex Wno-missing-declarations
5920 Warn if a global function is defined without a previous declaration.
5921 Do so even if the definition itself provides a prototype.
5922 Use this option to detect global functions that are not declared in
5923 header files.  In C, no warnings are issued for functions with previous
5924 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5925 missing prototypes.  In C++, no warnings are issued for function templates,
5926 or for inline functions, or for functions in anonymous namespaces.
5928 @item -Wmissing-field-initializers
5929 @opindex Wmissing-field-initializers
5930 @opindex Wno-missing-field-initializers
5931 @opindex W
5932 @opindex Wextra
5933 @opindex Wno-extra
5934 Warn if a structure's initializer has some fields missing.  For
5935 example, the following code causes such a warning, because
5936 @code{x.h} is implicitly zero:
5938 @smallexample
5939 struct s @{ int f, g, h; @};
5940 struct s x = @{ 3, 4 @};
5941 @end smallexample
5943 This option does not warn about designated initializers, so the following
5944 modification does not trigger a warning:
5946 @smallexample
5947 struct s @{ int f, g, h; @};
5948 struct s x = @{ .f = 3, .g = 4 @};
5949 @end smallexample
5951 In C++ this option does not warn either about the empty @{ @}
5952 initializer, for example:
5954 @smallexample
5955 struct s @{ int f, g, h; @};
5956 s x = @{ @};
5957 @end smallexample
5959 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5960 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5962 @item -Wno-multichar
5963 @opindex Wno-multichar
5964 @opindex Wmultichar
5965 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5966 Usually they indicate a typo in the user's code, as they have
5967 implementation-defined values, and should not be used in portable code.
5969 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5970 @opindex Wnormalized=
5971 @opindex Wnormalized
5972 @opindex Wno-normalized
5973 @cindex NFC
5974 @cindex NFKC
5975 @cindex character set, input normalization
5976 In ISO C and ISO C++, two identifiers are different if they are
5977 different sequences of characters.  However, sometimes when characters
5978 outside the basic ASCII character set are used, you can have two
5979 different character sequences that look the same.  To avoid confusion,
5980 the ISO 10646 standard sets out some @dfn{normalization rules} which
5981 when applied ensure that two sequences that look the same are turned into
5982 the same sequence.  GCC can warn you if you are using identifiers that
5983 have not been normalized; this option controls that warning.
5985 There are four levels of warning supported by GCC@.  The default is
5986 @option{-Wnormalized=nfc}, which warns about any identifier that is
5987 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5988 recommended form for most uses.  It is equivalent to
5989 @option{-Wnormalized}.
5991 Unfortunately, there are some characters allowed in identifiers by
5992 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5993 identifiers.  That is, there's no way to use these symbols in portable
5994 ISO C or C++ and have all your identifiers in NFC@.
5995 @option{-Wnormalized=id} suppresses the warning for these characters.
5996 It is hoped that future versions of the standards involved will correct
5997 this, which is why this option is not the default.
5999 You can switch the warning off for all characters by writing
6000 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6001 only do this if you are using some other normalization scheme (like
6002 ``D''), because otherwise you can easily create bugs that are
6003 literally impossible to see.
6005 Some characters in ISO 10646 have distinct meanings but look identical
6006 in some fonts or display methodologies, especially once formatting has
6007 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6008 LETTER N'', displays just like a regular @code{n} that has been
6009 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6010 normalization scheme to convert all these into a standard form as
6011 well, and GCC warns if your code is not in NFKC if you use
6012 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6013 about every identifier that contains the letter O because it might be
6014 confused with the digit 0, and so is not the default, but may be
6015 useful as a local coding convention if the programming environment 
6016 cannot be fixed to display these characters distinctly.
6018 @item -Wno-deprecated
6019 @opindex Wno-deprecated
6020 @opindex Wdeprecated
6021 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6023 @item -Wno-deprecated-declarations
6024 @opindex Wno-deprecated-declarations
6025 @opindex Wdeprecated-declarations
6026 Do not warn about uses of functions (@pxref{Function Attributes}),
6027 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6028 Attributes}) marked as deprecated by using the @code{deprecated}
6029 attribute.
6031 @item -Wno-overflow
6032 @opindex Wno-overflow
6033 @opindex Woverflow
6034 Do not warn about compile-time overflow in constant expressions.
6036 @item -Wno-odr
6037 @opindex Wno-odr
6038 @opindex Wodr
6039 Warn about One Definition Rule violations during link-time optimization.
6040 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6042 @item -Wopenmp-simd
6043 @opindex Wopenm-simd
6044 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6045 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6046 option can be used to relax the cost model.
6048 @item -Woverride-init @r{(C and Objective-C only)}
6049 @opindex Woverride-init
6050 @opindex Wno-override-init
6051 @opindex W
6052 @opindex Wextra
6053 @opindex Wno-extra
6054 Warn if an initialized field without side effects is overridden when
6055 using designated initializers (@pxref{Designated Inits, , Designated
6056 Initializers}).
6058 This warning is included in @option{-Wextra}.  To get other
6059 @option{-Wextra} warnings without this one, use @option{-Wextra
6060 -Wno-override-init}.
6062 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6063 @opindex Woverride-init-side-effects
6064 @opindex Wno-override-init-side-effects
6065 Warn if an initialized field with side effects is overridden when
6066 using designated initializers (@pxref{Designated Inits, , Designated
6067 Initializers}).  This warning is enabled by default.
6069 @item -Wpacked
6070 @opindex Wpacked
6071 @opindex Wno-packed
6072 Warn if a structure is given the packed attribute, but the packed
6073 attribute has no effect on the layout or size of the structure.
6074 Such structures may be mis-aligned for little benefit.  For
6075 instance, in this code, the variable @code{f.x} in @code{struct bar}
6076 is misaligned even though @code{struct bar} does not itself
6077 have the packed attribute:
6079 @smallexample
6080 @group
6081 struct foo @{
6082   int x;
6083   char a, b, c, d;
6084 @} __attribute__((packed));
6085 struct bar @{
6086   char z;
6087   struct foo f;
6089 @end group
6090 @end smallexample
6092 @item -Wpacked-bitfield-compat
6093 @opindex Wpacked-bitfield-compat
6094 @opindex Wno-packed-bitfield-compat
6095 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6096 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6097 the change can lead to differences in the structure layout.  GCC
6098 informs you when the offset of such a field has changed in GCC 4.4.
6099 For example there is no longer a 4-bit padding between field @code{a}
6100 and @code{b} in this structure:
6102 @smallexample
6103 struct foo
6105   char a:4;
6106   char b:8;
6107 @} __attribute__ ((packed));
6108 @end smallexample
6110 This warning is enabled by default.  Use
6111 @option{-Wno-packed-bitfield-compat} to disable this warning.
6113 @item -Wpadded
6114 @opindex Wpadded
6115 @opindex Wno-padded
6116 Warn if padding is included in a structure, either to align an element
6117 of the structure or to align the whole structure.  Sometimes when this
6118 happens it is possible to rearrange the fields of the structure to
6119 reduce the padding and so make the structure smaller.
6121 @item -Wredundant-decls
6122 @opindex Wredundant-decls
6123 @opindex Wno-redundant-decls
6124 Warn if anything is declared more than once in the same scope, even in
6125 cases where multiple declaration is valid and changes nothing.
6127 @item -Wnested-externs @r{(C and Objective-C only)}
6128 @opindex Wnested-externs
6129 @opindex Wno-nested-externs
6130 Warn if an @code{extern} declaration is encountered within a function.
6132 @item -Wno-inherited-variadic-ctor
6133 @opindex Winherited-variadic-ctor
6134 @opindex Wno-inherited-variadic-ctor
6135 Suppress warnings about use of C++11 inheriting constructors when the
6136 base class inherited from has a C variadic constructor; the warning is
6137 on by default because the ellipsis is not inherited.
6139 @item -Winline
6140 @opindex Winline
6141 @opindex Wno-inline
6142 Warn if a function that is declared as inline cannot be inlined.
6143 Even with this option, the compiler does not warn about failures to
6144 inline functions declared in system headers.
6146 The compiler uses a variety of heuristics to determine whether or not
6147 to inline a function.  For example, the compiler takes into account
6148 the size of the function being inlined and the amount of inlining
6149 that has already been done in the current function.  Therefore,
6150 seemingly insignificant changes in the source program can cause the
6151 warnings produced by @option{-Winline} to appear or disappear.
6153 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6154 @opindex Wno-invalid-offsetof
6155 @opindex Winvalid-offsetof
6156 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6157 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6158 to a non-standard-layout type is undefined.  In existing C++ implementations,
6159 however, @code{offsetof} typically gives meaningful results.
6160 This flag is for users who are aware that they are
6161 writing nonportable code and who have deliberately chosen to ignore the
6162 warning about it.
6164 The restrictions on @code{offsetof} may be relaxed in a future version
6165 of the C++ standard.
6167 @item -Wint-in-bool-context
6168 @opindex Wint-in-bool-context
6169 @opindex Wno-int-in-bool-context
6170 Warn for suspicious use of integer values where boolean values are expected,
6171 such as conditional expressions (?:) using non-boolean integer constants in
6172 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6173 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6174 for all kinds of multiplications regardless of the data type.
6175 This warning is enabled by @option{-Wall}.
6177 @item -Wno-int-to-pointer-cast
6178 @opindex Wno-int-to-pointer-cast
6179 @opindex Wint-to-pointer-cast
6180 Suppress warnings from casts to pointer type of an integer of a
6181 different size. In C++, casting to a pointer type of smaller size is
6182 an error. @option{Wint-to-pointer-cast} is enabled by default.
6185 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6186 @opindex Wno-pointer-to-int-cast
6187 @opindex Wpointer-to-int-cast
6188 Suppress warnings from casts from a pointer to an integer type of a
6189 different size.
6191 @item -Winvalid-pch
6192 @opindex Winvalid-pch
6193 @opindex Wno-invalid-pch
6194 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6195 the search path but can't be used.
6197 @item -Wlong-long
6198 @opindex Wlong-long
6199 @opindex Wno-long-long
6200 Warn if @code{long long} type is used.  This is enabled by either
6201 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6202 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6204 @item -Wvariadic-macros
6205 @opindex Wvariadic-macros
6206 @opindex Wno-variadic-macros
6207 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6208 alternate syntax is used in ISO C99 mode.  This is enabled by either
6209 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6210 messages, use @option{-Wno-variadic-macros}.
6212 @item -Wvarargs
6213 @opindex Wvarargs
6214 @opindex Wno-varargs
6215 Warn upon questionable usage of the macros used to handle variable
6216 arguments like @code{va_start}.  This is default.  To inhibit the
6217 warning messages, use @option{-Wno-varargs}.
6219 @item -Wvector-operation-performance
6220 @opindex Wvector-operation-performance
6221 @opindex Wno-vector-operation-performance
6222 Warn if vector operation is not implemented via SIMD capabilities of the
6223 architecture.  Mainly useful for the performance tuning.
6224 Vector operation can be implemented @code{piecewise}, which means that the
6225 scalar operation is performed on every vector element; 
6226 @code{in parallel}, which means that the vector operation is implemented
6227 using scalars of wider type, which normally is more performance efficient;
6228 and @code{as a single scalar}, which means that vector fits into a
6229 scalar type.
6231 @item -Wno-virtual-move-assign
6232 @opindex Wvirtual-move-assign
6233 @opindex Wno-virtual-move-assign
6234 Suppress warnings about inheriting from a virtual base with a
6235 non-trivial C++11 move assignment operator.  This is dangerous because
6236 if the virtual base is reachable along more than one path, it is
6237 moved multiple times, which can mean both objects end up in the
6238 moved-from state.  If the move assignment operator is written to avoid
6239 moving from a moved-from object, this warning can be disabled.
6241 @item -Wvla
6242 @opindex Wvla
6243 @opindex Wno-vla
6244 Warn if a variable-length array is used in the code.
6245 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6246 the variable-length array.
6248 @item -Wvla-larger-than=@var{n}
6249 If this option is used, the compiler will warn on uses of
6250 variable-length arrays where the size is either unbounded, or bounded
6251 by an argument that can be larger than @var{n} bytes.  This is similar
6252 to how @option{-Walloca-larger-than=@var{n}} works, but with
6253 variable-length arrays.
6255 Note that GCC may optimize small variable-length arrays of a known
6256 value into plain arrays, so this warning may not get triggered for
6257 such arrays.
6259 This warning is not enabled by @option{-Wall}, and is only active when
6260 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6262 See also @option{-Walloca-larger-than=@var{n}}.
6264 @item -Wvolatile-register-var
6265 @opindex Wvolatile-register-var
6266 @opindex Wno-volatile-register-var
6267 Warn if a register variable is declared volatile.  The volatile
6268 modifier does not inhibit all optimizations that may eliminate reads
6269 and/or writes to register variables.  This warning is enabled by
6270 @option{-Wall}.
6272 @item -Wdisabled-optimization
6273 @opindex Wdisabled-optimization
6274 @opindex Wno-disabled-optimization
6275 Warn if a requested optimization pass is disabled.  This warning does
6276 not generally indicate that there is anything wrong with your code; it
6277 merely indicates that GCC's optimizers are unable to handle the code
6278 effectively.  Often, the problem is that your code is too big or too
6279 complex; GCC refuses to optimize programs when the optimization
6280 itself is likely to take inordinate amounts of time.
6282 @item -Wpointer-sign @r{(C and Objective-C only)}
6283 @opindex Wpointer-sign
6284 @opindex Wno-pointer-sign
6285 Warn for pointer argument passing or assignment with different signedness.
6286 This option is only supported for C and Objective-C@.  It is implied by
6287 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6288 @option{-Wno-pointer-sign}.
6290 @item -Wstack-protector
6291 @opindex Wstack-protector
6292 @opindex Wno-stack-protector
6293 This option is only active when @option{-fstack-protector} is active.  It
6294 warns about functions that are not protected against stack smashing.
6296 @item -Woverlength-strings
6297 @opindex Woverlength-strings
6298 @opindex Wno-overlength-strings
6299 Warn about string constants that are longer than the ``minimum
6300 maximum'' length specified in the C standard.  Modern compilers
6301 generally allow string constants that are much longer than the
6302 standard's minimum limit, but very portable programs should avoid
6303 using longer strings.
6305 The limit applies @emph{after} string constant concatenation, and does
6306 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6307 C99, it was raised to 4095.  C++98 does not specify a normative
6308 minimum maximum, so we do not diagnose overlength strings in C++@.
6310 This option is implied by @option{-Wpedantic}, and can be disabled with
6311 @option{-Wno-overlength-strings}.
6313 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6314 @opindex Wunsuffixed-float-constants
6316 Issue a warning for any floating constant that does not have
6317 a suffix.  When used together with @option{-Wsystem-headers} it
6318 warns about such constants in system header files.  This can be useful
6319 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6320 from the decimal floating-point extension to C99.
6322 @item -Wno-designated-init @r{(C and Objective-C only)}
6323 Suppress warnings when a positional initializer is used to initialize
6324 a structure that has been marked with the @code{designated_init}
6325 attribute.
6327 @item -Whsa
6328 Issue a warning when HSAIL cannot be emitted for the compiled function or
6329 OpenMP construct.
6331 @end table
6333 @node Debugging Options
6334 @section Options for Debugging Your Program
6335 @cindex options, debugging
6336 @cindex debugging information options
6338 To tell GCC to emit extra information for use by a debugger, in almost 
6339 all cases you need only to add @option{-g} to your other options.
6341 GCC allows you to use @option{-g} with
6342 @option{-O}.  The shortcuts taken by optimized code may occasionally
6343 be surprising: some variables you declared may not exist
6344 at all; flow of control may briefly move where you did not expect it;
6345 some statements may not be executed because they compute constant
6346 results or their values are already at hand; some statements may
6347 execute in different places because they have been moved out of loops.
6348 Nevertheless it is possible to debug optimized output.  This makes
6349 it reasonable to use the optimizer for programs that might have bugs.
6351 If you are not using some other optimization option, consider
6352 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6353 With no @option{-O} option at all, some compiler passes that collect
6354 information useful for debugging do not run at all, so that
6355 @option{-Og} may result in a better debugging experience.
6357 @table @gcctabopt
6358 @item -g
6359 @opindex g
6360 Produce debugging information in the operating system's native format
6361 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6362 information.
6364 On most systems that use stabs format, @option{-g} enables use of extra
6365 debugging information that only GDB can use; this extra information
6366 makes debugging work better in GDB but probably makes other debuggers
6367 crash or
6368 refuse to read the program.  If you want to control for certain whether
6369 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6370 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6372 @item -ggdb
6373 @opindex ggdb
6374 Produce debugging information for use by GDB@.  This means to use the
6375 most expressive format available (DWARF, stabs, or the native format
6376 if neither of those are supported), including GDB extensions if at all
6377 possible.
6379 @item -gdwarf
6380 @itemx -gdwarf-@var{version}
6381 @opindex gdwarf
6382 Produce debugging information in DWARF format (if that is supported).
6383 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6384 for most targets is 4.  DWARF Version 5 is only experimental.
6386 Note that with DWARF Version 2, some ports require and always
6387 use some non-conflicting DWARF 3 extensions in the unwind tables.
6389 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6390 for maximum benefit.
6392 GCC no longer supports DWARF Version 1, which is substantially
6393 different than Version 2 and later.  For historical reasons, some
6394 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6395 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6396 in their names, but apply to all currently-supported versions of DWARF.
6398 @item -gstabs
6399 @opindex gstabs
6400 Produce debugging information in stabs format (if that is supported),
6401 without GDB extensions.  This is the format used by DBX on most BSD
6402 systems.  On MIPS, Alpha and System V Release 4 systems this option
6403 produces stabs debugging output that is not understood by DBX or SDB@.
6404 On System V Release 4 systems this option requires the GNU assembler.
6406 @item -gstabs+
6407 @opindex gstabs+
6408 Produce debugging information in stabs format (if that is supported),
6409 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6410 use of these extensions is likely to make other debuggers crash or
6411 refuse to read the program.
6413 @item -gcoff
6414 @opindex gcoff
6415 Produce debugging information in COFF format (if that is supported).
6416 This is the format used by SDB on most System V systems prior to
6417 System V Release 4.
6419 @item -gxcoff
6420 @opindex gxcoff
6421 Produce debugging information in XCOFF format (if that is supported).
6422 This is the format used by the DBX debugger on IBM RS/6000 systems.
6424 @item -gxcoff+
6425 @opindex gxcoff+
6426 Produce debugging information in XCOFF format (if that is supported),
6427 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6428 use of these extensions is likely to make other debuggers crash or
6429 refuse to read the program, and may cause assemblers other than the GNU
6430 assembler (GAS) to fail with an error.
6432 @item -gvms
6433 @opindex gvms
6434 Produce debugging information in Alpha/VMS debug format (if that is
6435 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6437 @item -g@var{level}
6438 @itemx -ggdb@var{level}
6439 @itemx -gstabs@var{level}
6440 @itemx -gcoff@var{level}
6441 @itemx -gxcoff@var{level}
6442 @itemx -gvms@var{level}
6443 Request debugging information and also use @var{level} to specify how
6444 much information.  The default level is 2.
6446 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6447 @option{-g}.
6449 Level 1 produces minimal information, enough for making backtraces in
6450 parts of the program that you don't plan to debug.  This includes
6451 descriptions of functions and external variables, and line number
6452 tables, but no information about local variables.
6454 Level 3 includes extra information, such as all the macro definitions
6455 present in the program.  Some debuggers support macro expansion when
6456 you use @option{-g3}.
6458 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6459 confusion with @option{-gdwarf-@var{level}}.
6460 Instead use an additional @option{-g@var{level}} option to change the
6461 debug level for DWARF.
6463 @item -feliminate-unused-debug-symbols
6464 @opindex feliminate-unused-debug-symbols
6465 Produce debugging information in stabs format (if that is supported),
6466 for only symbols that are actually used.
6468 @item -femit-class-debug-always
6469 @opindex femit-class-debug-always
6470 Instead of emitting debugging information for a C++ class in only one
6471 object file, emit it in all object files using the class.  This option
6472 should be used only with debuggers that are unable to handle the way GCC
6473 normally emits debugging information for classes because using this
6474 option increases the size of debugging information by as much as a
6475 factor of two.
6477 @item -fno-merge-debug-strings
6478 @opindex fmerge-debug-strings
6479 @opindex fno-merge-debug-strings
6480 Direct the linker to not merge together strings in the debugging
6481 information that are identical in different object files.  Merging is
6482 not supported by all assemblers or linkers.  Merging decreases the size
6483 of the debug information in the output file at the cost of increasing
6484 link processing time.  Merging is enabled by default.
6486 @item -fdebug-prefix-map=@var{old}=@var{new}
6487 @opindex fdebug-prefix-map
6488 When compiling files in directory @file{@var{old}}, record debugging
6489 information describing them as in @file{@var{new}} instead.
6491 @item -fvar-tracking
6492 @opindex fvar-tracking
6493 Run variable tracking pass.  It computes where variables are stored at each
6494 position in code.  Better debugging information is then generated
6495 (if the debugging information format supports this information).
6497 It is enabled by default when compiling with optimization (@option{-Os},
6498 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6499 the debug info format supports it.
6501 @item -fvar-tracking-assignments
6502 @opindex fvar-tracking-assignments
6503 @opindex fno-var-tracking-assignments
6504 Annotate assignments to user variables early in the compilation and
6505 attempt to carry the annotations over throughout the compilation all the
6506 way to the end, in an attempt to improve debug information while
6507 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6509 It can be enabled even if var-tracking is disabled, in which case
6510 annotations are created and maintained, but discarded at the end.
6511 By default, this flag is enabled together with @option{-fvar-tracking},
6512 except when selective scheduling is enabled.
6514 @item -gsplit-dwarf
6515 @opindex gsplit-dwarf
6516 Separate as much DWARF debugging information as possible into a
6517 separate output file with the extension @file{.dwo}.  This option allows
6518 the build system to avoid linking files with debug information.  To
6519 be useful, this option requires a debugger capable of reading @file{.dwo}
6520 files.
6522 @item -gpubnames
6523 @opindex gpubnames
6524 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6526 @item -ggnu-pubnames
6527 @opindex ggnu-pubnames
6528 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6529 suitable for conversion into a GDB@ index.  This option is only useful
6530 with a linker that can produce GDB@ index version 7.
6532 @item -fdebug-types-section
6533 @opindex fdebug-types-section
6534 @opindex fno-debug-types-section
6535 When using DWARF Version 4 or higher, type DIEs can be put into
6536 their own @code{.debug_types} section instead of making them part of the
6537 @code{.debug_info} section.  It is more efficient to put them in a separate
6538 comdat sections since the linker can then remove duplicates.
6539 But not all DWARF consumers support @code{.debug_types} sections yet
6540 and on some objects @code{.debug_types} produces larger instead of smaller
6541 debugging information.
6543 @item -grecord-gcc-switches
6544 @item -gno-record-gcc-switches
6545 @opindex grecord-gcc-switches
6546 @opindex gno-record-gcc-switches
6547 This switch causes the command-line options used to invoke the
6548 compiler that may affect code generation to be appended to the
6549 DW_AT_producer attribute in DWARF debugging information.  The options
6550 are concatenated with spaces separating them from each other and from
6551 the compiler version.  
6552 It is enabled by default.
6553 See also @option{-frecord-gcc-switches} for another
6554 way of storing compiler options into the object file.  
6556 @item -gstrict-dwarf
6557 @opindex gstrict-dwarf
6558 Disallow using extensions of later DWARF standard version than selected
6559 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6560 DWARF extensions from later standard versions is allowed.
6562 @item -gno-strict-dwarf
6563 @opindex gno-strict-dwarf
6564 Allow using extensions of later DWARF standard version than selected with
6565 @option{-gdwarf-@var{version}}.
6567 @item -gz@r{[}=@var{type}@r{]}
6568 @opindex gz
6569 Produce compressed debug sections in DWARF format, if that is supported.
6570 If @var{type} is not given, the default type depends on the capabilities
6571 of the assembler and linker used.  @var{type} may be one of
6572 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6573 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6574 compression in traditional GNU format).  If the linker doesn't support
6575 writing compressed debug sections, the option is rejected.  Otherwise,
6576 if the assembler does not support them, @option{-gz} is silently ignored
6577 when producing object files.
6579 @item -feliminate-dwarf2-dups
6580 @opindex feliminate-dwarf2-dups
6581 Compress DWARF debugging information by eliminating duplicated
6582 information about each symbol.  This option only makes sense when
6583 generating DWARF debugging information.
6585 @item -femit-struct-debug-baseonly
6586 @opindex femit-struct-debug-baseonly
6587 Emit debug information for struct-like types
6588 only when the base name of the compilation source file
6589 matches the base name of file in which the struct is defined.
6591 This option substantially reduces the size of debugging information,
6592 but at significant potential loss in type information to the debugger.
6593 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6594 See @option{-femit-struct-debug-detailed} for more detailed control.
6596 This option works only with DWARF debug output.
6598 @item -femit-struct-debug-reduced
6599 @opindex femit-struct-debug-reduced
6600 Emit debug information for struct-like types
6601 only when the base name of the compilation source file
6602 matches the base name of file in which the type is defined,
6603 unless the struct is a template or defined in a system header.
6605 This option significantly reduces the size of debugging information,
6606 with some potential loss in type information to the debugger.
6607 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6608 See @option{-femit-struct-debug-detailed} for more detailed control.
6610 This option works only with DWARF debug output.
6612 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6613 @opindex femit-struct-debug-detailed
6614 Specify the struct-like types
6615 for which the compiler generates debug information.
6616 The intent is to reduce duplicate struct debug information
6617 between different object files within the same program.
6619 This option is a detailed version of
6620 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6621 which serves for most needs.
6623 A specification has the syntax@*
6624 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6626 The optional first word limits the specification to
6627 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6628 A struct type is used directly when it is the type of a variable, member.
6629 Indirect uses arise through pointers to structs.
6630 That is, when use of an incomplete struct is valid, the use is indirect.
6631 An example is
6632 @samp{struct one direct; struct two * indirect;}.
6634 The optional second word limits the specification to
6635 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6636 Generic structs are a bit complicated to explain.
6637 For C++, these are non-explicit specializations of template classes,
6638 or non-template classes within the above.
6639 Other programming languages have generics,
6640 but @option{-femit-struct-debug-detailed} does not yet implement them.
6642 The third word specifies the source files for those
6643 structs for which the compiler should emit debug information.
6644 The values @samp{none} and @samp{any} have the normal meaning.
6645 The value @samp{base} means that
6646 the base of name of the file in which the type declaration appears
6647 must match the base of the name of the main compilation file.
6648 In practice, this means that when compiling @file{foo.c}, debug information
6649 is generated for types declared in that file and @file{foo.h},
6650 but not other header files.
6651 The value @samp{sys} means those types satisfying @samp{base}
6652 or declared in system or compiler headers.
6654 You may need to experiment to determine the best settings for your application.
6656 The default is @option{-femit-struct-debug-detailed=all}.
6658 This option works only with DWARF debug output.
6660 @item -fno-dwarf2-cfi-asm
6661 @opindex fdwarf2-cfi-asm
6662 @opindex fno-dwarf2-cfi-asm
6663 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6664 instead of using GAS @code{.cfi_*} directives.
6666 @item -fno-eliminate-unused-debug-types
6667 @opindex feliminate-unused-debug-types
6668 @opindex fno-eliminate-unused-debug-types
6669 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6670 output for types that are nowhere used in the source file being compiled.
6671 Sometimes it is useful to have GCC emit debugging
6672 information for all types declared in a compilation
6673 unit, regardless of whether or not they are actually used
6674 in that compilation unit, for example 
6675 if, in the debugger, you want to cast a value to a type that is
6676 not actually used in your program (but is declared).  More often,
6677 however, this results in a significant amount of wasted space.
6678 @end table
6680 @node Optimize Options
6681 @section Options That Control Optimization
6682 @cindex optimize options
6683 @cindex options, optimization
6685 These options control various sorts of optimizations.
6687 Without any optimization option, the compiler's goal is to reduce the
6688 cost of compilation and to make debugging produce the expected
6689 results.  Statements are independent: if you stop the program with a
6690 breakpoint between statements, you can then assign a new value to any
6691 variable or change the program counter to any other statement in the
6692 function and get exactly the results you expect from the source
6693 code.
6695 Turning on optimization flags makes the compiler attempt to improve
6696 the performance and/or code size at the expense of compilation time
6697 and possibly the ability to debug the program.
6699 The compiler performs optimization based on the knowledge it has of the
6700 program.  Compiling multiple files at once to a single output file mode allows
6701 the compiler to use information gained from all of the files when compiling
6702 each of them.
6704 Not all optimizations are controlled directly by a flag.  Only
6705 optimizations that have a flag are listed in this section.
6707 Most optimizations are only enabled if an @option{-O} level is set on
6708 the command line.  Otherwise they are disabled, even if individual
6709 optimization flags are specified.
6711 Depending on the target and how GCC was configured, a slightly different
6712 set of optimizations may be enabled at each @option{-O} level than
6713 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6714 to find out the exact set of optimizations that are enabled at each level.
6715 @xref{Overall Options}, for examples.
6717 @table @gcctabopt
6718 @item -O
6719 @itemx -O1
6720 @opindex O
6721 @opindex O1
6722 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6723 more memory for a large function.
6725 With @option{-O}, the compiler tries to reduce code size and execution
6726 time, without performing any optimizations that take a great deal of
6727 compilation time.
6729 @option{-O} turns on the following optimization flags:
6730 @gccoptlist{
6731 -fauto-inc-dec @gol
6732 -fbranch-count-reg @gol
6733 -fcombine-stack-adjustments @gol
6734 -fcompare-elim @gol
6735 -fcprop-registers @gol
6736 -fdce @gol
6737 -fdefer-pop @gol
6738 -fdelayed-branch @gol
6739 -fdse @gol
6740 -fforward-propagate @gol
6741 -fguess-branch-probability @gol
6742 -fif-conversion2 @gol
6743 -fif-conversion @gol
6744 -finline-functions-called-once @gol
6745 -fipa-pure-const @gol
6746 -fipa-profile @gol
6747 -fipa-reference @gol
6748 -fmerge-constants @gol
6749 -fmove-loop-invariants @gol
6750 -freorder-blocks @gol
6751 -fshrink-wrap @gol
6752 -fshrink-wrap-separate @gol
6753 -fsplit-wide-types @gol
6754 -fssa-backprop @gol
6755 -fssa-phiopt @gol
6756 -ftree-bit-ccp @gol
6757 -ftree-ccp @gol
6758 -ftree-ch @gol
6759 -ftree-coalesce-vars @gol
6760 -ftree-copy-prop @gol
6761 -ftree-dce @gol
6762 -ftree-dominator-opts @gol
6763 -ftree-dse @gol
6764 -ftree-forwprop @gol
6765 -ftree-fre @gol
6766 -ftree-phiprop @gol
6767 -ftree-sink @gol
6768 -ftree-slsr @gol
6769 -ftree-sra @gol
6770 -ftree-pta @gol
6771 -ftree-ter @gol
6772 -funit-at-a-time}
6774 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6775 where doing so does not interfere with debugging.
6777 @item -O2
6778 @opindex O2
6779 Optimize even more.  GCC performs nearly all supported optimizations
6780 that do not involve a space-speed tradeoff.
6781 As compared to @option{-O}, this option increases both compilation time
6782 and the performance of the generated code.
6784 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6785 also turns on the following optimization flags:
6786 @gccoptlist{-fthread-jumps @gol
6787 -falign-functions  -falign-jumps @gol
6788 -falign-loops  -falign-labels @gol
6789 -fcaller-saves @gol
6790 -fcrossjumping @gol
6791 -fcse-follow-jumps  -fcse-skip-blocks @gol
6792 -fdelete-null-pointer-checks @gol
6793 -fdevirtualize -fdevirtualize-speculatively @gol
6794 -fexpensive-optimizations @gol
6795 -fgcse  -fgcse-lm  @gol
6796 -fhoist-adjacent-loads @gol
6797 -finline-small-functions @gol
6798 -findirect-inlining @gol
6799 -fipa-cp @gol
6800 -fipa-cp-alignment @gol
6801 -fipa-bit-cp @gol
6802 -fipa-sra @gol
6803 -fipa-icf @gol
6804 -fisolate-erroneous-paths-dereference @gol
6805 -flra-remat @gol
6806 -foptimize-sibling-calls @gol
6807 -foptimize-strlen @gol
6808 -fpartial-inlining @gol
6809 -fpeephole2 @gol
6810 -freorder-blocks-algorithm=stc @gol
6811 -freorder-blocks-and-partition -freorder-functions @gol
6812 -frerun-cse-after-loop  @gol
6813 -fsched-interblock  -fsched-spec @gol
6814 -fschedule-insns  -fschedule-insns2 @gol
6815 -fstrict-aliasing -fstrict-overflow @gol
6816 -ftree-builtin-call-dce @gol
6817 -ftree-switch-conversion -ftree-tail-merge @gol
6818 -fcode-hoisting @gol
6819 -ftree-pre @gol
6820 -ftree-vrp @gol
6821 -fipa-ra}
6823 Please note the warning under @option{-fgcse} about
6824 invoking @option{-O2} on programs that use computed gotos.
6826 @item -O3
6827 @opindex O3
6828 Optimize yet more.  @option{-O3} turns on all optimizations specified
6829 by @option{-O2} and also turns on the @option{-finline-functions},
6830 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6831 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6832 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
6833 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6834 @option{-ftree-partial-pre}, @option{-fpeel-loops}
6835 and @option{-fipa-cp-clone} options.
6837 @item -O0
6838 @opindex O0
6839 Reduce compilation time and make debugging produce the expected
6840 results.  This is the default.
6842 @item -Os
6843 @opindex Os
6844 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6845 do not typically increase code size.  It also performs further
6846 optimizations designed to reduce code size.
6848 @option{-Os} disables the following optimization flags:
6849 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6850 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
6851 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
6853 @item -Ofast
6854 @opindex Ofast
6855 Disregard strict standards compliance.  @option{-Ofast} enables all
6856 @option{-O3} optimizations.  It also enables optimizations that are not
6857 valid for all standard-compliant programs.
6858 It turns on @option{-ffast-math} and the Fortran-specific
6859 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6861 @item -Og
6862 @opindex Og
6863 Optimize debugging experience.  @option{-Og} enables optimizations
6864 that do not interfere with debugging. It should be the optimization
6865 level of choice for the standard edit-compile-debug cycle, offering
6866 a reasonable level of optimization while maintaining fast compilation
6867 and a good debugging experience.
6868 @end table
6870 If you use multiple @option{-O} options, with or without level numbers,
6871 the last such option is the one that is effective.
6873 Options of the form @option{-f@var{flag}} specify machine-independent
6874 flags.  Most flags have both positive and negative forms; the negative
6875 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6876 below, only one of the forms is listed---the one you typically 
6877 use.  You can figure out the other form by either removing @samp{no-}
6878 or adding it.
6880 The following options control specific optimizations.  They are either
6881 activated by @option{-O} options or are related to ones that are.  You
6882 can use the following flags in the rare cases when ``fine-tuning'' of
6883 optimizations to be performed is desired.
6885 @table @gcctabopt
6886 @item -fno-defer-pop
6887 @opindex fno-defer-pop
6888 Always pop the arguments to each function call as soon as that function
6889 returns.  For machines that must pop arguments after a function call,
6890 the compiler normally lets arguments accumulate on the stack for several
6891 function calls and pops them all at once.
6893 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6895 @item -fforward-propagate
6896 @opindex fforward-propagate
6897 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6898 instructions and checks if the result can be simplified.  If loop unrolling
6899 is active, two passes are performed and the second is scheduled after
6900 loop unrolling.
6902 This option is enabled by default at optimization levels @option{-O},
6903 @option{-O2}, @option{-O3}, @option{-Os}.
6905 @item -ffp-contract=@var{style}
6906 @opindex ffp-contract
6907 @option{-ffp-contract=off} disables floating-point expression contraction.
6908 @option{-ffp-contract=fast} enables floating-point expression contraction
6909 such as forming of fused multiply-add operations if the target has
6910 native support for them.
6911 @option{-ffp-contract=on} enables floating-point expression contraction
6912 if allowed by the language standard.  This is currently not implemented
6913 and treated equal to @option{-ffp-contract=off}.
6915 The default is @option{-ffp-contract=fast}.
6917 @item -fomit-frame-pointer
6918 @opindex fomit-frame-pointer
6919 Don't keep the frame pointer in a register for functions that
6920 don't need one.  This avoids the instructions to save, set up and
6921 restore frame pointers; it also makes an extra register available
6922 in many functions.  @strong{It also makes debugging impossible on
6923 some machines.}
6925 On some machines, such as the VAX, this flag has no effect, because
6926 the standard calling sequence automatically handles the frame pointer
6927 and nothing is saved by pretending it doesn't exist.  The
6928 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6929 whether a target machine supports this flag.  @xref{Registers,,Register
6930 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6932 The default setting (when not optimizing for
6933 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
6934 @option{-fomit-frame-pointer}.  You can configure GCC with the
6935 @option{--enable-frame-pointer} configure option to change the default.
6937 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6939 @item -foptimize-sibling-calls
6940 @opindex foptimize-sibling-calls
6941 Optimize sibling and tail recursive calls.
6943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6945 @item -foptimize-strlen
6946 @opindex foptimize-strlen
6947 Optimize various standard C string functions (e.g. @code{strlen},
6948 @code{strchr} or @code{strcpy}) and
6949 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
6951 Enabled at levels @option{-O2}, @option{-O3}.
6953 @item -fno-inline
6954 @opindex fno-inline
6955 Do not expand any functions inline apart from those marked with
6956 the @code{always_inline} attribute.  This is the default when not
6957 optimizing.
6959 Single functions can be exempted from inlining by marking them
6960 with the @code{noinline} attribute.
6962 @item -finline-small-functions
6963 @opindex finline-small-functions
6964 Integrate functions into their callers when their body is smaller than expected
6965 function call code (so overall size of program gets smaller).  The compiler
6966 heuristically decides which functions are simple enough to be worth integrating
6967 in this way.  This inlining applies to all functions, even those not declared
6968 inline.
6970 Enabled at level @option{-O2}.
6972 @item -findirect-inlining
6973 @opindex findirect-inlining
6974 Inline also indirect calls that are discovered to be known at compile
6975 time thanks to previous inlining.  This option has any effect only
6976 when inlining itself is turned on by the @option{-finline-functions}
6977 or @option{-finline-small-functions} options.
6979 Enabled at level @option{-O2}.
6981 @item -finline-functions
6982 @opindex finline-functions
6983 Consider all functions for inlining, even if they are not declared inline.
6984 The compiler heuristically decides which functions are worth integrating
6985 in this way.
6987 If all calls to a given function are integrated, and the function is
6988 declared @code{static}, then the function is normally not output as
6989 assembler code in its own right.
6991 Enabled at level @option{-O3}.
6993 @item -finline-functions-called-once
6994 @opindex finline-functions-called-once
6995 Consider all @code{static} functions called once for inlining into their
6996 caller even if they are not marked @code{inline}.  If a call to a given
6997 function is integrated, then the function is not output as assembler code
6998 in its own right.
7000 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7002 @item -fearly-inlining
7003 @opindex fearly-inlining
7004 Inline functions marked by @code{always_inline} and functions whose body seems
7005 smaller than the function call overhead early before doing
7006 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7007 makes profiling significantly cheaper and usually inlining faster on programs
7008 having large chains of nested wrapper functions.
7010 Enabled by default.
7012 @item -fipa-sra
7013 @opindex fipa-sra
7014 Perform interprocedural scalar replacement of aggregates, removal of
7015 unused parameters and replacement of parameters passed by reference
7016 by parameters passed by value.
7018 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7020 @item -finline-limit=@var{n}
7021 @opindex finline-limit
7022 By default, GCC limits the size of functions that can be inlined.  This flag
7023 allows coarse control of this limit.  @var{n} is the size of functions that
7024 can be inlined in number of pseudo instructions.
7026 Inlining is actually controlled by a number of parameters, which may be
7027 specified individually by using @option{--param @var{name}=@var{value}}.
7028 The @option{-finline-limit=@var{n}} option sets some of these parameters
7029 as follows:
7031 @table @gcctabopt
7032 @item max-inline-insns-single
7033 is set to @var{n}/2.
7034 @item max-inline-insns-auto
7035 is set to @var{n}/2.
7036 @end table
7038 See below for a documentation of the individual
7039 parameters controlling inlining and for the defaults of these parameters.
7041 @emph{Note:} there may be no value to @option{-finline-limit} that results
7042 in default behavior.
7044 @emph{Note:} pseudo instruction represents, in this particular context, an
7045 abstract measurement of function's size.  In no way does it represent a count
7046 of assembly instructions and as such its exact meaning might change from one
7047 release to an another.
7049 @item -fno-keep-inline-dllexport
7050 @opindex fno-keep-inline-dllexport
7051 This is a more fine-grained version of @option{-fkeep-inline-functions},
7052 which applies only to functions that are declared using the @code{dllexport}
7053 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7054 Functions}.)
7056 @item -fkeep-inline-functions
7057 @opindex fkeep-inline-functions
7058 In C, emit @code{static} functions that are declared @code{inline}
7059 into the object file, even if the function has been inlined into all
7060 of its callers.  This switch does not affect functions using the
7061 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7062 inline functions into the object file.
7064 @item -fkeep-static-functions
7065 @opindex fkeep-static-functions
7066 Emit @code{static} functions into the object file, even if the function
7067 is never used.
7069 @item -fkeep-static-consts
7070 @opindex fkeep-static-consts
7071 Emit variables declared @code{static const} when optimization isn't turned
7072 on, even if the variables aren't referenced.
7074 GCC enables this option by default.  If you want to force the compiler to
7075 check if a variable is referenced, regardless of whether or not
7076 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7078 @item -fmerge-constants
7079 @opindex fmerge-constants
7080 Attempt to merge identical constants (string constants and floating-point
7081 constants) across compilation units.
7083 This option is the default for optimized compilation if the assembler and
7084 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7085 behavior.
7087 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7089 @item -fmerge-all-constants
7090 @opindex fmerge-all-constants
7091 Attempt to merge identical constants and identical variables.
7093 This option implies @option{-fmerge-constants}.  In addition to
7094 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7095 arrays or initialized constant variables with integral or floating-point
7096 types.  Languages like C or C++ require each variable, including multiple
7097 instances of the same variable in recursive calls, to have distinct locations,
7098 so using this option results in non-conforming
7099 behavior.
7101 @item -fmodulo-sched
7102 @opindex fmodulo-sched
7103 Perform swing modulo scheduling immediately before the first scheduling
7104 pass.  This pass looks at innermost loops and reorders their
7105 instructions by overlapping different iterations.
7107 @item -fmodulo-sched-allow-regmoves
7108 @opindex fmodulo-sched-allow-regmoves
7109 Perform more aggressive SMS-based modulo scheduling with register moves
7110 allowed.  By setting this flag certain anti-dependences edges are
7111 deleted, which triggers the generation of reg-moves based on the
7112 life-range analysis.  This option is effective only with
7113 @option{-fmodulo-sched} enabled.
7115 @item -fno-branch-count-reg
7116 @opindex fno-branch-count-reg
7117 Avoid running a pass scanning for opportunities to use ``decrement and
7118 branch'' instructions on a count register instead of generating sequences
7119 of instructions that decrement a register, compare it against zero, and
7120 then branch based upon the result.  This option is only meaningful on
7121 architectures that support such instructions, which include x86, PowerPC,
7122 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7123 doesn't remove the decrement and branch instructions from the generated
7124 instruction stream introduced by other optimization passes.
7126 Enabled by default at @option{-O1} and higher.
7128 The default is @option{-fbranch-count-reg}.
7130 @item -fno-function-cse
7131 @opindex fno-function-cse
7132 Do not put function addresses in registers; make each instruction that
7133 calls a constant function contain the function's address explicitly.
7135 This option results in less efficient code, but some strange hacks
7136 that alter the assembler output may be confused by the optimizations
7137 performed when this option is not used.
7139 The default is @option{-ffunction-cse}
7141 @item -fno-zero-initialized-in-bss
7142 @opindex fno-zero-initialized-in-bss
7143 If the target supports a BSS section, GCC by default puts variables that
7144 are initialized to zero into BSS@.  This can save space in the resulting
7145 code.
7147 This option turns off this behavior because some programs explicitly
7148 rely on variables going to the data section---e.g., so that the
7149 resulting executable can find the beginning of that section and/or make
7150 assumptions based on that.
7152 The default is @option{-fzero-initialized-in-bss}.
7154 @item -fthread-jumps
7155 @opindex fthread-jumps
7156 Perform optimizations that check to see if a jump branches to a
7157 location where another comparison subsumed by the first is found.  If
7158 so, the first branch is redirected to either the destination of the
7159 second branch or a point immediately following it, depending on whether
7160 the condition is known to be true or false.
7162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7164 @item -fsplit-wide-types
7165 @opindex fsplit-wide-types
7166 When using a type that occupies multiple registers, such as @code{long
7167 long} on a 32-bit system, split the registers apart and allocate them
7168 independently.  This normally generates better code for those types,
7169 but may make debugging more difficult.
7171 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7172 @option{-Os}.
7174 @item -fcse-follow-jumps
7175 @opindex fcse-follow-jumps
7176 In common subexpression elimination (CSE), scan through jump instructions
7177 when the target of the jump is not reached by any other path.  For
7178 example, when CSE encounters an @code{if} statement with an
7179 @code{else} clause, CSE follows the jump when the condition
7180 tested is false.
7182 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7184 @item -fcse-skip-blocks
7185 @opindex fcse-skip-blocks
7186 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7187 follow jumps that conditionally skip over blocks.  When CSE
7188 encounters a simple @code{if} statement with no else clause,
7189 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7190 body of the @code{if}.
7192 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7194 @item -frerun-cse-after-loop
7195 @opindex frerun-cse-after-loop
7196 Re-run common subexpression elimination after loop optimizations are
7197 performed.
7199 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7201 @item -fgcse
7202 @opindex fgcse
7203 Perform a global common subexpression elimination pass.
7204 This pass also performs global constant and copy propagation.
7206 @emph{Note:} When compiling a program using computed gotos, a GCC
7207 extension, you may get better run-time performance if you disable
7208 the global common subexpression elimination pass by adding
7209 @option{-fno-gcse} to the command line.
7211 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7213 @item -fgcse-lm
7214 @opindex fgcse-lm
7215 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7216 attempts to move loads that are only killed by stores into themselves.  This
7217 allows a loop containing a load/store sequence to be changed to a load outside
7218 the loop, and a copy/store within the loop.
7220 Enabled by default when @option{-fgcse} is enabled.
7222 @item -fgcse-sm
7223 @opindex fgcse-sm
7224 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7225 global common subexpression elimination.  This pass attempts to move
7226 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7227 loops containing a load/store sequence can be changed to a load before
7228 the loop and a store after the loop.
7230 Not enabled at any optimization level.
7232 @item -fgcse-las
7233 @opindex fgcse-las
7234 When @option{-fgcse-las} is enabled, the global common subexpression
7235 elimination pass eliminates redundant loads that come after stores to the
7236 same memory location (both partial and full redundancies).
7238 Not enabled at any optimization level.
7240 @item -fgcse-after-reload
7241 @opindex fgcse-after-reload
7242 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7243 pass is performed after reload.  The purpose of this pass is to clean up
7244 redundant spilling.
7246 @item -faggressive-loop-optimizations
7247 @opindex faggressive-loop-optimizations
7248 This option tells the loop optimizer to use language constraints to
7249 derive bounds for the number of iterations of a loop.  This assumes that
7250 loop code does not invoke undefined behavior by for example causing signed
7251 integer overflows or out-of-bound array accesses.  The bounds for the
7252 number of iterations of a loop are used to guide loop unrolling and peeling
7253 and loop exit test optimizations.
7254 This option is enabled by default.
7256 @item -funconstrained-commons
7257 @opindex funconstrained-commons
7258 This option tells the compiler that variables declared in common blocks
7259 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7260 prevents certain optimizations that depend on knowing the array bounds.
7262 @item -fcrossjumping
7263 @opindex fcrossjumping
7264 Perform cross-jumping transformation.
7265 This transformation unifies equivalent code and saves code size.  The
7266 resulting code may or may not perform better than without cross-jumping.
7268 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7270 @item -fauto-inc-dec
7271 @opindex fauto-inc-dec
7272 Combine increments or decrements of addresses with memory accesses.
7273 This pass is always skipped on architectures that do not have
7274 instructions to support this.  Enabled by default at @option{-O} and
7275 higher on architectures that support this.
7277 @item -fdce
7278 @opindex fdce
7279 Perform dead code elimination (DCE) on RTL@.
7280 Enabled by default at @option{-O} and higher.
7282 @item -fdse
7283 @opindex fdse
7284 Perform dead store elimination (DSE) on RTL@.
7285 Enabled by default at @option{-O} and higher.
7287 @item -fif-conversion
7288 @opindex fif-conversion
7289 Attempt to transform conditional jumps into branch-less equivalents.  This
7290 includes use of conditional moves, min, max, set flags and abs instructions, and
7291 some tricks doable by standard arithmetics.  The use of conditional execution
7292 on chips where it is available is controlled by @option{-fif-conversion2}.
7294 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7296 @item -fif-conversion2
7297 @opindex fif-conversion2
7298 Use conditional execution (where available) to transform conditional jumps into
7299 branch-less equivalents.
7301 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7303 @item -fdeclone-ctor-dtor
7304 @opindex fdeclone-ctor-dtor
7305 The C++ ABI requires multiple entry points for constructors and
7306 destructors: one for a base subobject, one for a complete object, and
7307 one for a virtual destructor that calls operator delete afterwards.
7308 For a hierarchy with virtual bases, the base and complete variants are
7309 clones, which means two copies of the function.  With this option, the
7310 base and complete variants are changed to be thunks that call a common
7311 implementation.
7313 Enabled by @option{-Os}.
7315 @item -fdelete-null-pointer-checks
7316 @opindex fdelete-null-pointer-checks
7317 Assume that programs cannot safely dereference null pointers, and that
7318 no code or data element resides at address zero.
7319 This option enables simple constant
7320 folding optimizations at all optimization levels.  In addition, other
7321 optimization passes in GCC use this flag to control global dataflow
7322 analyses that eliminate useless checks for null pointers; these assume
7323 that a memory access to address zero always results in a trap, so
7324 that if a pointer is checked after it has already been dereferenced,
7325 it cannot be null.
7327 Note however that in some environments this assumption is not true.
7328 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7329 for programs that depend on that behavior.
7331 This option is enabled by default on most targets.  On Nios II ELF, it
7332 defaults to off.  On AVR and CR16, this option is completely disabled.  
7334 Passes that use the dataflow information
7335 are enabled independently at different optimization levels.
7337 @item -fdevirtualize
7338 @opindex fdevirtualize
7339 Attempt to convert calls to virtual functions to direct calls.  This
7340 is done both within a procedure and interprocedurally as part of
7341 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7342 propagation (@option{-fipa-cp}).
7343 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7345 @item -fdevirtualize-speculatively
7346 @opindex fdevirtualize-speculatively
7347 Attempt to convert calls to virtual functions to speculative direct calls.
7348 Based on the analysis of the type inheritance graph, determine for a given call
7349 the set of likely targets. If the set is small, preferably of size 1, change
7350 the call into a conditional deciding between direct and indirect calls.  The
7351 speculative calls enable more optimizations, such as inlining.  When they seem
7352 useless after further optimization, they are converted back into original form.
7354 @item -fdevirtualize-at-ltrans
7355 @opindex fdevirtualize-at-ltrans
7356 Stream extra information needed for aggressive devirtualization when running
7357 the link-time optimizer in local transformation mode.  
7358 This option enables more devirtualization but
7359 significantly increases the size of streamed data. For this reason it is
7360 disabled by default.
7362 @item -fexpensive-optimizations
7363 @opindex fexpensive-optimizations
7364 Perform a number of minor optimizations that are relatively expensive.
7366 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7368 @item -free
7369 @opindex free
7370 Attempt to remove redundant extension instructions.  This is especially
7371 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7372 registers after writing to their lower 32-bit half.
7374 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7375 @option{-O3}, @option{-Os}.
7377 @item -fno-lifetime-dse
7378 @opindex fno-lifetime-dse
7379 In C++ the value of an object is only affected by changes within its
7380 lifetime: when the constructor begins, the object has an indeterminate
7381 value, and any changes during the lifetime of the object are dead when
7382 the object is destroyed.  Normally dead store elimination will take
7383 advantage of this; if your code relies on the value of the object
7384 storage persisting beyond the lifetime of the object, you can use this
7385 flag to disable this optimization.  To preserve stores before the
7386 constructor starts (e.g. because your operator new clears the object
7387 storage) but still treat the object as dead after the destructor you,
7388 can use @option{-flifetime-dse=1}.  The default behavior can be
7389 explicitly selected with @option{-flifetime-dse=2}.
7390 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7392 @item -flive-range-shrinkage
7393 @opindex flive-range-shrinkage
7394 Attempt to decrease register pressure through register live range
7395 shrinkage.  This is helpful for fast processors with small or moderate
7396 size register sets.
7398 @item -fira-algorithm=@var{algorithm}
7399 @opindex fira-algorithm
7400 Use the specified coloring algorithm for the integrated register
7401 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7402 specifies Chow's priority coloring, or @samp{CB}, which specifies
7403 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7404 for all architectures, but for those targets that do support it, it is
7405 the default because it generates better code.
7407 @item -fira-region=@var{region}
7408 @opindex fira-region
7409 Use specified regions for the integrated register allocator.  The
7410 @var{region} argument should be one of the following:
7412 @table @samp
7414 @item all
7415 Use all loops as register allocation regions.
7416 This can give the best results for machines with a small and/or
7417 irregular register set.
7419 @item mixed
7420 Use all loops except for loops with small register pressure 
7421 as the regions.  This value usually gives
7422 the best results in most cases and for most architectures,
7423 and is enabled by default when compiling with optimization for speed
7424 (@option{-O}, @option{-O2}, @dots{}).
7426 @item one
7427 Use all functions as a single region.  
7428 This typically results in the smallest code size, and is enabled by default for
7429 @option{-Os} or @option{-O0}.
7431 @end table
7433 @item -fira-hoist-pressure
7434 @opindex fira-hoist-pressure
7435 Use IRA to evaluate register pressure in the code hoisting pass for
7436 decisions to hoist expressions.  This option usually results in smaller
7437 code, but it can slow the compiler down.
7439 This option is enabled at level @option{-Os} for all targets.
7441 @item -fira-loop-pressure
7442 @opindex fira-loop-pressure
7443 Use IRA to evaluate register pressure in loops for decisions to move
7444 loop invariants.  This option usually results in generation
7445 of faster and smaller code on machines with large register files (>= 32
7446 registers), but it can slow the compiler down.
7448 This option is enabled at level @option{-O3} for some targets.
7450 @item -fno-ira-share-save-slots
7451 @opindex fno-ira-share-save-slots
7452 Disable sharing of stack slots used for saving call-used hard
7453 registers living through a call.  Each hard register gets a
7454 separate stack slot, and as a result function stack frames are
7455 larger.
7457 @item -fno-ira-share-spill-slots
7458 @opindex fno-ira-share-spill-slots
7459 Disable sharing of stack slots allocated for pseudo-registers.  Each
7460 pseudo-register that does not get a hard register gets a separate
7461 stack slot, and as a result function stack frames are larger.
7463 @item -flra-remat
7464 @opindex flra-remat
7465 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7466 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7467 values if it is profitable.
7469 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7471 @item -fdelayed-branch
7472 @opindex fdelayed-branch
7473 If supported for the target machine, attempt to reorder instructions
7474 to exploit instruction slots available after delayed branch
7475 instructions.
7477 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7479 @item -fschedule-insns
7480 @opindex fschedule-insns
7481 If supported for the target machine, attempt to reorder instructions to
7482 eliminate execution stalls due to required data being unavailable.  This
7483 helps machines that have slow floating point or memory load instructions
7484 by allowing other instructions to be issued until the result of the load
7485 or floating-point instruction is required.
7487 Enabled at levels @option{-O2}, @option{-O3}.
7489 @item -fschedule-insns2
7490 @opindex fschedule-insns2
7491 Similar to @option{-fschedule-insns}, but requests an additional pass of
7492 instruction scheduling after register allocation has been done.  This is
7493 especially useful on machines with a relatively small number of
7494 registers and where memory load instructions take more than one cycle.
7496 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7498 @item -fno-sched-interblock
7499 @opindex fno-sched-interblock
7500 Don't schedule instructions across basic blocks.  This is normally
7501 enabled by default when scheduling before register allocation, i.e.@:
7502 with @option{-fschedule-insns} or at @option{-O2} or higher.
7504 @item -fno-sched-spec
7505 @opindex fno-sched-spec
7506 Don't allow speculative motion of non-load instructions.  This is normally
7507 enabled by default when scheduling before register allocation, i.e.@:
7508 with @option{-fschedule-insns} or at @option{-O2} or higher.
7510 @item -fsched-pressure
7511 @opindex fsched-pressure
7512 Enable register pressure sensitive insn scheduling before register
7513 allocation.  This only makes sense when scheduling before register
7514 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7515 @option{-O2} or higher.  Usage of this option can improve the
7516 generated code and decrease its size by preventing register pressure
7517 increase above the number of available hard registers and subsequent
7518 spills in register allocation.
7520 @item -fsched-spec-load
7521 @opindex fsched-spec-load
7522 Allow speculative motion of some load instructions.  This only makes
7523 sense when scheduling before register allocation, i.e.@: with
7524 @option{-fschedule-insns} or at @option{-O2} or higher.
7526 @item -fsched-spec-load-dangerous
7527 @opindex fsched-spec-load-dangerous
7528 Allow speculative motion of more load instructions.  This only makes
7529 sense when scheduling before register allocation, i.e.@: with
7530 @option{-fschedule-insns} or at @option{-O2} or higher.
7532 @item -fsched-stalled-insns
7533 @itemx -fsched-stalled-insns=@var{n}
7534 @opindex fsched-stalled-insns
7535 Define how many insns (if any) can be moved prematurely from the queue
7536 of stalled insns into the ready list during the second scheduling pass.
7537 @option{-fno-sched-stalled-insns} means that no insns are moved
7538 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7539 on how many queued insns can be moved prematurely.
7540 @option{-fsched-stalled-insns} without a value is equivalent to
7541 @option{-fsched-stalled-insns=1}.
7543 @item -fsched-stalled-insns-dep
7544 @itemx -fsched-stalled-insns-dep=@var{n}
7545 @opindex fsched-stalled-insns-dep
7546 Define how many insn groups (cycles) are examined for a dependency
7547 on a stalled insn that is a candidate for premature removal from the queue
7548 of stalled insns.  This has an effect only during the second scheduling pass,
7549 and only if @option{-fsched-stalled-insns} is used.
7550 @option{-fno-sched-stalled-insns-dep} is equivalent to
7551 @option{-fsched-stalled-insns-dep=0}.
7552 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7553 @option{-fsched-stalled-insns-dep=1}.
7555 @item -fsched2-use-superblocks
7556 @opindex fsched2-use-superblocks
7557 When scheduling after register allocation, use superblock scheduling.
7558 This allows motion across basic block boundaries,
7559 resulting in faster schedules.  This option is experimental, as not all machine
7560 descriptions used by GCC model the CPU closely enough to avoid unreliable
7561 results from the algorithm.
7563 This only makes sense when scheduling after register allocation, i.e.@: with
7564 @option{-fschedule-insns2} or at @option{-O2} or higher.
7566 @item -fsched-group-heuristic
7567 @opindex fsched-group-heuristic
7568 Enable the group heuristic in the scheduler.  This heuristic favors
7569 the instruction that belongs to a schedule group.  This is enabled
7570 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7571 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7573 @item -fsched-critical-path-heuristic
7574 @opindex fsched-critical-path-heuristic
7575 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7576 instructions on the critical path.  This is enabled by default when
7577 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7578 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7580 @item -fsched-spec-insn-heuristic
7581 @opindex fsched-spec-insn-heuristic
7582 Enable the speculative instruction heuristic in the scheduler.  This
7583 heuristic favors speculative instructions with greater dependency weakness.
7584 This is enabled by default when scheduling is enabled, i.e.@:
7585 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7586 or at @option{-O2} or higher.
7588 @item -fsched-rank-heuristic
7589 @opindex fsched-rank-heuristic
7590 Enable the rank heuristic in the scheduler.  This heuristic favors
7591 the instruction belonging to a basic block with greater size or frequency.
7592 This is enabled by default when scheduling is enabled, i.e.@:
7593 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7594 at @option{-O2} or higher.
7596 @item -fsched-last-insn-heuristic
7597 @opindex fsched-last-insn-heuristic
7598 Enable the last-instruction heuristic in the scheduler.  This heuristic
7599 favors the instruction that is less dependent on the last instruction
7600 scheduled.  This is enabled by default when scheduling is enabled,
7601 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7602 at @option{-O2} or higher.
7604 @item -fsched-dep-count-heuristic
7605 @opindex fsched-dep-count-heuristic
7606 Enable the dependent-count heuristic in the scheduler.  This heuristic
7607 favors the instruction that has more instructions depending on it.
7608 This is enabled by default when scheduling is enabled, i.e.@:
7609 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7610 at @option{-O2} or higher.
7612 @item -freschedule-modulo-scheduled-loops
7613 @opindex freschedule-modulo-scheduled-loops
7614 Modulo scheduling is performed before traditional scheduling.  If a loop
7615 is modulo scheduled, later scheduling passes may change its schedule.  
7616 Use this option to control that behavior.
7618 @item -fselective-scheduling
7619 @opindex fselective-scheduling
7620 Schedule instructions using selective scheduling algorithm.  Selective
7621 scheduling runs instead of the first scheduler pass.
7623 @item -fselective-scheduling2
7624 @opindex fselective-scheduling2
7625 Schedule instructions using selective scheduling algorithm.  Selective
7626 scheduling runs instead of the second scheduler pass.
7628 @item -fsel-sched-pipelining
7629 @opindex fsel-sched-pipelining
7630 Enable software pipelining of innermost loops during selective scheduling.
7631 This option has no effect unless one of @option{-fselective-scheduling} or
7632 @option{-fselective-scheduling2} is turned on.
7634 @item -fsel-sched-pipelining-outer-loops
7635 @opindex fsel-sched-pipelining-outer-loops
7636 When pipelining loops during selective scheduling, also pipeline outer loops.
7637 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7639 @item -fsemantic-interposition
7640 @opindex fsemantic-interposition
7641 Some object formats, like ELF, allow interposing of symbols by the 
7642 dynamic linker.
7643 This means that for symbols exported from the DSO, the compiler cannot perform
7644 interprocedural propagation, inlining and other optimizations in anticipation
7645 that the function or variable in question may change. While this feature is
7646 useful, for example, to rewrite memory allocation functions by a debugging
7647 implementation, it is expensive in the terms of code quality.
7648 With @option{-fno-semantic-interposition} the compiler assumes that 
7649 if interposition happens for functions the overwriting function will have 
7650 precisely the same semantics (and side effects). 
7651 Similarly if interposition happens
7652 for variables, the constructor of the variable will be the same. The flag
7653 has no effect for functions explicitly declared inline 
7654 (where it is never allowed for interposition to change semantics) 
7655 and for symbols explicitly declared weak.
7657 @item -fshrink-wrap
7658 @opindex fshrink-wrap
7659 Emit function prologues only before parts of the function that need it,
7660 rather than at the top of the function.  This flag is enabled by default at
7661 @option{-O} and higher.
7663 @item -fshrink-wrap-separate
7664 @opindex fshrink-wrap-separate
7665 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7666 those parts are only executed when needed.
7667 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7668 is also turned on and the target supports this.
7670 @item -fcaller-saves
7671 @opindex fcaller-saves
7672 Enable allocation of values to registers that are clobbered by
7673 function calls, by emitting extra instructions to save and restore the
7674 registers around such calls.  Such allocation is done only when it
7675 seems to result in better code.
7677 This option is always enabled by default on certain machines, usually
7678 those which have no call-preserved registers to use instead.
7680 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7682 @item -fcombine-stack-adjustments
7683 @opindex fcombine-stack-adjustments
7684 Tracks stack adjustments (pushes and pops) and stack memory references
7685 and then tries to find ways to combine them.
7687 Enabled by default at @option{-O1} and higher.
7689 @item -fipa-ra
7690 @opindex fipa-ra
7691 Use caller save registers for allocation if those registers are not used by
7692 any called function.  In that case it is not necessary to save and restore
7693 them around calls.  This is only possible if called functions are part of
7694 same compilation unit as current function and they are compiled before it.
7696 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7697 is disabled if generated code will be instrumented for profiling
7698 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
7699 exactly (this happens on targets that do not expose prologues
7700 and epilogues in RTL).
7702 @item -fconserve-stack
7703 @opindex fconserve-stack
7704 Attempt to minimize stack usage.  The compiler attempts to use less
7705 stack space, even if that makes the program slower.  This option
7706 implies setting the @option{large-stack-frame} parameter to 100
7707 and the @option{large-stack-frame-growth} parameter to 400.
7709 @item -ftree-reassoc
7710 @opindex ftree-reassoc
7711 Perform reassociation on trees.  This flag is enabled by default
7712 at @option{-O} and higher.
7714 @item -fcode-hoisting
7715 @opindex fcode-hoisting
7716 Perform code hoisting.  Code hoisting tries to move the
7717 evaluation of expressions executed on all paths to the function exit
7718 as early as possible.  This is especially useful as a code size
7719 optimization, but it often helps for code speed as well.
7720 This flag is enabled by default at @option{-O2} and higher.
7722 @item -ftree-pre
7723 @opindex ftree-pre
7724 Perform partial redundancy elimination (PRE) on trees.  This flag is
7725 enabled by default at @option{-O2} and @option{-O3}.
7727 @item -ftree-partial-pre
7728 @opindex ftree-partial-pre
7729 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7730 enabled by default at @option{-O3}.
7732 @item -ftree-forwprop
7733 @opindex ftree-forwprop
7734 Perform forward propagation on trees.  This flag is enabled by default
7735 at @option{-O} and higher.
7737 @item -ftree-fre
7738 @opindex ftree-fre
7739 Perform full redundancy elimination (FRE) on trees.  The difference
7740 between FRE and PRE is that FRE only considers expressions
7741 that are computed on all paths leading to the redundant computation.
7742 This analysis is faster than PRE, though it exposes fewer redundancies.
7743 This flag is enabled by default at @option{-O} and higher.
7745 @item -ftree-phiprop
7746 @opindex ftree-phiprop
7747 Perform hoisting of loads from conditional pointers on trees.  This
7748 pass is enabled by default at @option{-O} and higher.
7750 @item -fhoist-adjacent-loads
7751 @opindex fhoist-adjacent-loads
7752 Speculatively hoist loads from both branches of an if-then-else if the
7753 loads are from adjacent locations in the same structure and the target
7754 architecture has a conditional move instruction.  This flag is enabled
7755 by default at @option{-O2} and higher.
7757 @item -ftree-copy-prop
7758 @opindex ftree-copy-prop
7759 Perform copy propagation on trees.  This pass eliminates unnecessary
7760 copy operations.  This flag is enabled by default at @option{-O} and
7761 higher.
7763 @item -fipa-pure-const
7764 @opindex fipa-pure-const
7765 Discover which functions are pure or constant.
7766 Enabled by default at @option{-O} and higher.
7768 @item -fipa-reference
7769 @opindex fipa-reference
7770 Discover which static variables do not escape the
7771 compilation unit.
7772 Enabled by default at @option{-O} and higher.
7774 @item -fipa-pta
7775 @opindex fipa-pta
7776 Perform interprocedural pointer analysis and interprocedural modification
7777 and reference analysis.  This option can cause excessive memory and
7778 compile-time usage on large compilation units.  It is not enabled by
7779 default at any optimization level.
7781 @item -fipa-profile
7782 @opindex fipa-profile
7783 Perform interprocedural profile propagation.  The functions called only from
7784 cold functions are marked as cold. Also functions executed once (such as
7785 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7786 functions and loop less parts of functions executed once are then optimized for
7787 size.
7788 Enabled by default at @option{-O} and higher.
7790 @item -fipa-cp
7791 @opindex fipa-cp
7792 Perform interprocedural constant propagation.
7793 This optimization analyzes the program to determine when values passed
7794 to functions are constants and then optimizes accordingly.
7795 This optimization can substantially increase performance
7796 if the application has constants passed to functions.
7797 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7799 @item -fipa-cp-clone
7800 @opindex fipa-cp-clone
7801 Perform function cloning to make interprocedural constant propagation stronger.
7802 When enabled, interprocedural constant propagation performs function cloning
7803 when externally visible function can be called with constant arguments.
7804 Because this optimization can create multiple copies of functions,
7805 it may significantly increase code size
7806 (see @option{--param ipcp-unit-growth=@var{value}}).
7807 This flag is enabled by default at @option{-O3}.
7809 @item -fipa-cp-alignment
7810 @opindex -fipa-cp-alignment
7811 When enabled, this optimization propagates alignment of function
7812 parameters to support better vectorization and string operations.
7814 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
7815 requires that @option{-fipa-cp} is enabled.
7816 @option{-fipa-cp-alignment} is obsolete, use @option{-fipa-bit-cp} instead.
7818 @item -fipa-bit-cp
7819 @opindex -fipa-bit-cp
7820 When enabled, perform ipa bitwise constant propagation. This flag is
7821 enabled by default at @option{-O2}. It requires that @option{-fipa-cp}
7822 is enabled.
7824 @item -fipa-icf
7825 @opindex fipa-icf
7826 Perform Identical Code Folding for functions and read-only variables.
7827 The optimization reduces code size and may disturb unwind stacks by replacing
7828 a function by equivalent one with a different name. The optimization works
7829 more effectively with link time optimization enabled.
7831 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
7832 works on different levels and thus the optimizations are not same - there are
7833 equivalences that are found only by GCC and equivalences found only by Gold.
7835 This flag is enabled by default at @option{-O2} and @option{-Os}.
7837 @item -fisolate-erroneous-paths-dereference
7838 @opindex fisolate-erroneous-paths-dereference
7839 Detect paths that trigger erroneous or undefined behavior due to
7840 dereferencing a null pointer.  Isolate those paths from the main control
7841 flow and turn the statement with erroneous or undefined behavior into a trap.
7842 This flag is enabled by default at @option{-O2} and higher and depends on
7843 @option{-fdelete-null-pointer-checks} also being enabled.
7845 @item -fisolate-erroneous-paths-attribute
7846 @opindex fisolate-erroneous-paths-attribute
7847 Detect paths that trigger erroneous or undefined behavior due a null value
7848 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
7849 attribute.  Isolate those paths from the main control flow and turn the
7850 statement with erroneous or undefined behavior into a trap.  This is not
7851 currently enabled, but may be enabled by @option{-O2} in the future.
7853 @item -ftree-sink
7854 @opindex ftree-sink
7855 Perform forward store motion on trees.  This flag is
7856 enabled by default at @option{-O} and higher.
7858 @item -ftree-bit-ccp
7859 @opindex ftree-bit-ccp
7860 Perform sparse conditional bit constant propagation on trees and propagate
7861 pointer alignment information.
7862 This pass only operates on local scalar variables and is enabled by default
7863 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7865 @item -ftree-ccp
7866 @opindex ftree-ccp
7867 Perform sparse conditional constant propagation (CCP) on trees.  This
7868 pass only operates on local scalar variables and is enabled by default
7869 at @option{-O} and higher.
7871 @item -fssa-backprop
7872 @opindex fssa-backprop
7873 Propagate information about uses of a value up the definition chain
7874 in order to simplify the definitions.  For example, this pass strips
7875 sign operations if the sign of a value never matters.  The flag is
7876 enabled by default at @option{-O} and higher.
7878 @item -fssa-phiopt
7879 @opindex fssa-phiopt
7880 Perform pattern matching on SSA PHI nodes to optimize conditional
7881 code.  This pass is enabled by default at @option{-O} and higher.
7883 @item -ftree-switch-conversion
7884 @opindex ftree-switch-conversion
7885 Perform conversion of simple initializations in a switch to
7886 initializations from a scalar array.  This flag is enabled by default
7887 at @option{-O2} and higher.
7889 @item -ftree-tail-merge
7890 @opindex ftree-tail-merge
7891 Look for identical code sequences.  When found, replace one with a jump to the
7892 other.  This optimization is known as tail merging or cross jumping.  This flag
7893 is enabled by default at @option{-O2} and higher.  The compilation time
7894 in this pass can
7895 be limited using @option{max-tail-merge-comparisons} parameter and
7896 @option{max-tail-merge-iterations} parameter.
7898 @item -ftree-dce
7899 @opindex ftree-dce
7900 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7901 default at @option{-O} and higher.
7903 @item -ftree-builtin-call-dce
7904 @opindex ftree-builtin-call-dce
7905 Perform conditional dead code elimination (DCE) for calls to built-in functions
7906 that may set @code{errno} but are otherwise side-effect free.  This flag is
7907 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7908 specified.
7910 @item -ftree-dominator-opts
7911 @opindex ftree-dominator-opts
7912 Perform a variety of simple scalar cleanups (constant/copy
7913 propagation, redundancy elimination, range propagation and expression
7914 simplification) based on a dominator tree traversal.  This also
7915 performs jump threading (to reduce jumps to jumps). This flag is
7916 enabled by default at @option{-O} and higher.
7918 @item -ftree-dse
7919 @opindex ftree-dse
7920 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7921 a memory location that is later overwritten by another store without
7922 any intervening loads.  In this case the earlier store can be deleted.  This
7923 flag is enabled by default at @option{-O} and higher.
7925 @item -ftree-ch
7926 @opindex ftree-ch
7927 Perform loop header copying on trees.  This is beneficial since it increases
7928 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7929 is enabled by default at @option{-O} and higher.  It is not enabled
7930 for @option{-Os}, since it usually increases code size.
7932 @item -ftree-loop-optimize
7933 @opindex ftree-loop-optimize
7934 Perform loop optimizations on trees.  This flag is enabled by default
7935 at @option{-O} and higher.
7937 @item -ftree-loop-linear
7938 @itemx -floop-interchange
7939 @itemx -floop-strip-mine
7940 @itemx -floop-block
7941 @itemx -floop-unroll-and-jam
7942 @opindex ftree-loop-linear
7943 @opindex floop-interchange
7944 @opindex floop-strip-mine
7945 @opindex floop-block
7946 @opindex floop-unroll-and-jam
7947 Perform loop nest optimizations.  Same as
7948 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
7949 to be configured with @option{--with-isl} to enable the Graphite loop
7950 transformation infrastructure.
7952 @item -fgraphite-identity
7953 @opindex fgraphite-identity
7954 Enable the identity transformation for graphite.  For every SCoP we generate
7955 the polyhedral representation and transform it back to gimple.  Using
7956 @option{-fgraphite-identity} we can check the costs or benefits of the
7957 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7958 are also performed by the code generator isl, like index splitting and
7959 dead code elimination in loops.
7961 @item -floop-nest-optimize
7962 @opindex floop-nest-optimize
7963 Enable the isl based loop nest optimizer.  This is a generic loop nest
7964 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7965 structure optimized for data-locality and parallelism.  This option
7966 is experimental.
7968 @item -floop-parallelize-all
7969 @opindex floop-parallelize-all
7970 Use the Graphite data dependence analysis to identify loops that can
7971 be parallelized.  Parallelize all the loops that can be analyzed to
7972 not contain loop carried dependences without checking that it is
7973 profitable to parallelize the loops.
7975 @item -ftree-coalesce-vars
7976 @opindex ftree-coalesce-vars
7977 While transforming the program out of the SSA representation, attempt to
7978 reduce copying by coalescing versions of different user-defined
7979 variables, instead of just compiler temporaries.  This may severely
7980 limit the ability to debug an optimized program compiled with
7981 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
7982 prevents SSA coalescing of user variables.  This option is enabled by
7983 default if optimization is enabled, and it does very little otherwise.
7985 @item -ftree-loop-if-convert
7986 @opindex ftree-loop-if-convert
7987 Attempt to transform conditional jumps in the innermost loops to
7988 branch-less equivalents.  The intent is to remove control-flow from
7989 the innermost loops in order to improve the ability of the
7990 vectorization pass to handle these loops.  This is enabled by default
7991 if vectorization is enabled.
7993 @item -ftree-loop-if-convert-stores
7994 @opindex ftree-loop-if-convert-stores
7995 Attempt to also if-convert conditional jumps containing memory writes.
7996 This transformation can be unsafe for multi-threaded programs as it
7997 transforms conditional memory writes into unconditional memory writes.
7998 For example,
7999 @smallexample
8000 for (i = 0; i < N; i++)
8001   if (cond)
8002     A[i] = expr;
8003 @end smallexample
8004 is transformed to
8005 @smallexample
8006 for (i = 0; i < N; i++)
8007   A[i] = cond ? expr : A[i];
8008 @end smallexample
8009 potentially producing data races.
8011 @item -ftree-loop-distribution
8012 @opindex ftree-loop-distribution
8013 Perform loop distribution.  This flag can improve cache performance on
8014 big loop bodies and allow further loop optimizations, like
8015 parallelization or vectorization, to take place.  For example, the loop
8016 @smallexample
8017 DO I = 1, N
8018   A(I) = B(I) + C
8019   D(I) = E(I) * F
8020 ENDDO
8021 @end smallexample
8022 is transformed to
8023 @smallexample
8024 DO I = 1, N
8025    A(I) = B(I) + C
8026 ENDDO
8027 DO I = 1, N
8028    D(I) = E(I) * F
8029 ENDDO
8030 @end smallexample
8032 @item -ftree-loop-distribute-patterns
8033 @opindex ftree-loop-distribute-patterns
8034 Perform loop distribution of patterns that can be code generated with
8035 calls to a library.  This flag is enabled by default at @option{-O3}.
8037 This pass distributes the initialization loops and generates a call to
8038 memset zero.  For example, the loop
8039 @smallexample
8040 DO I = 1, N
8041   A(I) = 0
8042   B(I) = A(I) + I
8043 ENDDO
8044 @end smallexample
8045 is transformed to
8046 @smallexample
8047 DO I = 1, N
8048    A(I) = 0
8049 ENDDO
8050 DO I = 1, N
8051    B(I) = A(I) + I
8052 ENDDO
8053 @end smallexample
8054 and the initialization loop is transformed into a call to memset zero.
8056 @item -ftree-loop-im
8057 @opindex ftree-loop-im
8058 Perform loop invariant motion on trees.  This pass moves only invariants that
8059 are hard to handle at RTL level (function calls, operations that expand to
8060 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8061 operands of conditions that are invariant out of the loop, so that we can use
8062 just trivial invariantness analysis in loop unswitching.  The pass also includes
8063 store motion.
8065 @item -ftree-loop-ivcanon
8066 @opindex ftree-loop-ivcanon
8067 Create a canonical counter for number of iterations in loops for which
8068 determining number of iterations requires complicated analysis.  Later
8069 optimizations then may determine the number easily.  Useful especially
8070 in connection with unrolling.
8072 @item -fivopts
8073 @opindex fivopts
8074 Perform induction variable optimizations (strength reduction, induction
8075 variable merging and induction variable elimination) on trees.
8077 @item -ftree-parallelize-loops=n
8078 @opindex ftree-parallelize-loops
8079 Parallelize loops, i.e., split their iteration space to run in n threads.
8080 This is only possible for loops whose iterations are independent
8081 and can be arbitrarily reordered.  The optimization is only
8082 profitable on multiprocessor machines, for loops that are CPU-intensive,
8083 rather than constrained e.g.@: by memory bandwidth.  This option
8084 implies @option{-pthread}, and thus is only supported on targets
8085 that have support for @option{-pthread}.
8087 @item -ftree-pta
8088 @opindex ftree-pta
8089 Perform function-local points-to analysis on trees.  This flag is
8090 enabled by default at @option{-O} and higher.
8092 @item -ftree-sra
8093 @opindex ftree-sra
8094 Perform scalar replacement of aggregates.  This pass replaces structure
8095 references with scalars to prevent committing structures to memory too
8096 early.  This flag is enabled by default at @option{-O} and higher.
8098 @item -ftree-ter
8099 @opindex ftree-ter
8100 Perform temporary expression replacement during the SSA->normal phase.  Single
8101 use/single def temporaries are replaced at their use location with their
8102 defining expression.  This results in non-GIMPLE code, but gives the expanders
8103 much more complex trees to work on resulting in better RTL generation.  This is
8104 enabled by default at @option{-O} and higher.
8106 @item -ftree-slsr
8107 @opindex ftree-slsr
8108 Perform straight-line strength reduction on trees.  This recognizes related
8109 expressions involving multiplications and replaces them by less expensive
8110 calculations when possible.  This is enabled by default at @option{-O} and
8111 higher.
8113 @item -ftree-vectorize
8114 @opindex ftree-vectorize
8115 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8116 and @option{-ftree-slp-vectorize} if not explicitly specified.
8118 @item -ftree-loop-vectorize
8119 @opindex ftree-loop-vectorize
8120 Perform loop vectorization on trees. This flag is enabled by default at
8121 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8123 @item -ftree-slp-vectorize
8124 @opindex ftree-slp-vectorize
8125 Perform basic block vectorization on trees. This flag is enabled by default at
8126 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8128 @item -fvect-cost-model=@var{model}
8129 @opindex fvect-cost-model
8130 Alter the cost model used for vectorization.  The @var{model} argument
8131 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8132 With the @samp{unlimited} model the vectorized code-path is assumed
8133 to be profitable while with the @samp{dynamic} model a runtime check
8134 guards the vectorized code-path to enable it only for iteration
8135 counts that will likely execute faster than when executing the original
8136 scalar loop.  The @samp{cheap} model disables vectorization of
8137 loops where doing so would be cost prohibitive for example due to
8138 required runtime checks for data dependence or alignment but otherwise
8139 is equal to the @samp{dynamic} model.
8140 The default cost model depends on other optimization flags and is
8141 either @samp{dynamic} or @samp{cheap}.
8143 @item -fsimd-cost-model=@var{model}
8144 @opindex fsimd-cost-model
8145 Alter the cost model used for vectorization of loops marked with the OpenMP
8146 or Cilk Plus simd directive.  The @var{model} argument should be one of
8147 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8148 have the same meaning as described in @option{-fvect-cost-model} and by
8149 default a cost model defined with @option{-fvect-cost-model} is used.
8151 @item -ftree-vrp
8152 @opindex ftree-vrp
8153 Perform Value Range Propagation on trees.  This is similar to the
8154 constant propagation pass, but instead of values, ranges of values are
8155 propagated.  This allows the optimizers to remove unnecessary range
8156 checks like array bound checks and null pointer checks.  This is
8157 enabled by default at @option{-O2} and higher.  Null pointer check
8158 elimination is only done if @option{-fdelete-null-pointer-checks} is
8159 enabled.
8161 @item -fsplit-paths
8162 @opindex fsplit-paths
8163 Split paths leading to loop backedges.  This can improve dead code
8164 elimination and common subexpression elimination.  This is enabled by
8165 default at @option{-O2} and above.
8167 @item -fsplit-ivs-in-unroller
8168 @opindex fsplit-ivs-in-unroller
8169 Enables expression of values of induction variables in later iterations
8170 of the unrolled loop using the value in the first iteration.  This breaks
8171 long dependency chains, thus improving efficiency of the scheduling passes.
8173 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8174 same effect.  However, that is not reliable in cases where the loop body
8175 is more complicated than a single basic block.  It also does not work at all
8176 on some architectures due to restrictions in the CSE pass.
8178 This optimization is enabled by default.
8180 @item -fvariable-expansion-in-unroller
8181 @opindex fvariable-expansion-in-unroller
8182 With this option, the compiler creates multiple copies of some
8183 local variables when unrolling a loop, which can result in superior code.
8185 @item -fpartial-inlining
8186 @opindex fpartial-inlining
8187 Inline parts of functions.  This option has any effect only
8188 when inlining itself is turned on by the @option{-finline-functions}
8189 or @option{-finline-small-functions} options.
8191 Enabled at level @option{-O2}.
8193 @item -fpredictive-commoning
8194 @opindex fpredictive-commoning
8195 Perform predictive commoning optimization, i.e., reusing computations
8196 (especially memory loads and stores) performed in previous
8197 iterations of loops.
8199 This option is enabled at level @option{-O3}.
8201 @item -fprefetch-loop-arrays
8202 @opindex fprefetch-loop-arrays
8203 If supported by the target machine, generate instructions to prefetch
8204 memory to improve the performance of loops that access large arrays.
8206 This option may generate better or worse code; results are highly
8207 dependent on the structure of loops within the source code.
8209 Disabled at level @option{-Os}.
8211 @item -fprintf-return-value
8212 @opindex fprintf-return-value
8213 Substitute constants for known return value of formatted output functions
8214 such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and @code{vsnprintf}
8215 (but not @code{printf} of @code{fprintf}).  This transformation allows GCC
8216 to optimize or even eliminate branches based on the known return value of
8217 these functions called with arguments that are either constant, or whose
8218 values are known to be in a range that makes determining the exact return
8219 value possible.  For example, both the branch and the body of the @code{if}
8220 statement (but not the call to @code{snprint}) can be optimized away when
8221 @code{i} is a 32-bit or smaller integer because the return value is guaranteed
8222 to be at most 8.
8224 @smallexample
8225 char buf[9];
8226 if (snprintf (buf, "%08x", i) >= sizeof buf)
8227   @dots{}
8228 @end smallexample
8230 The @option{-fprintf-return-value} option relies on other optimizations
8231 and yields best results with @option{-O2}.  It works in tandem with the
8232 @option{-Wformat-length} option.  The @option{-fprintf-return-value}
8233 option is disabled by default.
8235 @item -fno-peephole
8236 @itemx -fno-peephole2
8237 @opindex fno-peephole
8238 @opindex fno-peephole2
8239 Disable any machine-specific peephole optimizations.  The difference
8240 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8241 are implemented in the compiler; some targets use one, some use the
8242 other, a few use both.
8244 @option{-fpeephole} is enabled by default.
8245 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8247 @item -fno-guess-branch-probability
8248 @opindex fno-guess-branch-probability
8249 Do not guess branch probabilities using heuristics.
8251 GCC uses heuristics to guess branch probabilities if they are
8252 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8253 heuristics are based on the control flow graph.  If some branch probabilities
8254 are specified by @code{__builtin_expect}, then the heuristics are
8255 used to guess branch probabilities for the rest of the control flow graph,
8256 taking the @code{__builtin_expect} info into account.  The interactions
8257 between the heuristics and @code{__builtin_expect} can be complex, and in
8258 some cases, it may be useful to disable the heuristics so that the effects
8259 of @code{__builtin_expect} are easier to understand.
8261 The default is @option{-fguess-branch-probability} at levels
8262 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8264 @item -freorder-blocks
8265 @opindex freorder-blocks
8266 Reorder basic blocks in the compiled function in order to reduce number of
8267 taken branches and improve code locality.
8269 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8271 @item -freorder-blocks-algorithm=@var{algorithm}
8272 @opindex freorder-blocks-algorithm
8273 Use the specified algorithm for basic block reordering.  The
8274 @var{algorithm} argument can be @samp{simple}, which does not increase
8275 code size (except sometimes due to secondary effects like alignment),
8276 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8277 put all often executed code together, minimizing the number of branches
8278 executed by making extra copies of code.
8280 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8281 @samp{stc} at levels @option{-O2}, @option{-O3}.
8283 @item -freorder-blocks-and-partition
8284 @opindex freorder-blocks-and-partition
8285 In addition to reordering basic blocks in the compiled function, in order
8286 to reduce number of taken branches, partitions hot and cold basic blocks
8287 into separate sections of the assembly and @file{.o} files, to improve
8288 paging and cache locality performance.
8290 This optimization is automatically turned off in the presence of
8291 exception handling, for linkonce sections, for functions with a user-defined
8292 section attribute and on any architecture that does not support named
8293 sections.
8295 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8297 @item -freorder-functions
8298 @opindex freorder-functions
8299 Reorder functions in the object file in order to
8300 improve code locality.  This is implemented by using special
8301 subsections @code{.text.hot} for most frequently executed functions and
8302 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8303 the linker so object file format must support named sections and linker must
8304 place them in a reasonable way.
8306 Also profile feedback must be available to make this option effective.  See
8307 @option{-fprofile-arcs} for details.
8309 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8311 @item -fstrict-aliasing
8312 @opindex fstrict-aliasing
8313 Allow the compiler to assume the strictest aliasing rules applicable to
8314 the language being compiled.  For C (and C++), this activates
8315 optimizations based on the type of expressions.  In particular, an
8316 object of one type is assumed never to reside at the same address as an
8317 object of a different type, unless the types are almost the same.  For
8318 example, an @code{unsigned int} can alias an @code{int}, but not a
8319 @code{void*} or a @code{double}.  A character type may alias any other
8320 type.
8322 @anchor{Type-punning}Pay special attention to code like this:
8323 @smallexample
8324 union a_union @{
8325   int i;
8326   double d;
8329 int f() @{
8330   union a_union t;
8331   t.d = 3.0;
8332   return t.i;
8334 @end smallexample
8335 The practice of reading from a different union member than the one most
8336 recently written to (called ``type-punning'') is common.  Even with
8337 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8338 is accessed through the union type.  So, the code above works as
8339 expected.  @xref{Structures unions enumerations and bit-fields
8340 implementation}.  However, this code might not:
8341 @smallexample
8342 int f() @{
8343   union a_union t;
8344   int* ip;
8345   t.d = 3.0;
8346   ip = &t.i;
8347   return *ip;
8349 @end smallexample
8351 Similarly, access by taking the address, casting the resulting pointer
8352 and dereferencing the result has undefined behavior, even if the cast
8353 uses a union type, e.g.:
8354 @smallexample
8355 int f() @{
8356   double d = 3.0;
8357   return ((union a_union *) &d)->i;
8359 @end smallexample
8361 The @option{-fstrict-aliasing} option is enabled at levels
8362 @option{-O2}, @option{-O3}, @option{-Os}.
8364 @item -fstrict-overflow
8365 @opindex fstrict-overflow
8366 Allow the compiler to assume strict signed overflow rules, depending
8367 on the language being compiled.  For C (and C++) this means that
8368 overflow when doing arithmetic with signed numbers is undefined, which
8369 means that the compiler may assume that it does not happen.  This
8370 permits various optimizations.  For example, the compiler assumes
8371 that an expression like @code{i + 10 > i} is always true for
8372 signed @code{i}.  This assumption is only valid if signed overflow is
8373 undefined, as the expression is false if @code{i + 10} overflows when
8374 using twos complement arithmetic.  When this option is in effect any
8375 attempt to determine whether an operation on signed numbers 
8376 overflows must be written carefully to not actually involve overflow.
8378 This option also allows the compiler to assume strict pointer
8379 semantics: given a pointer to an object, if adding an offset to that
8380 pointer does not produce a pointer to the same object, the addition is
8381 undefined.  This permits the compiler to conclude that @code{p + u >
8382 p} is always true for a pointer @code{p} and unsigned integer
8383 @code{u}.  This assumption is only valid because pointer wraparound is
8384 undefined, as the expression is false if @code{p + u} overflows using
8385 twos complement arithmetic.
8387 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8388 that integer signed overflow is fully defined: it wraps.  When
8389 @option{-fwrapv} is used, there is no difference between
8390 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8391 integers.  With @option{-fwrapv} certain types of overflow are
8392 permitted.  For example, if the compiler gets an overflow when doing
8393 arithmetic on constants, the overflowed value can still be used with
8394 @option{-fwrapv}, but not otherwise.
8396 The @option{-fstrict-overflow} option is enabled at levels
8397 @option{-O2}, @option{-O3}, @option{-Os}.
8399 @item -falign-functions
8400 @itemx -falign-functions=@var{n}
8401 @opindex falign-functions
8402 Align the start of functions to the next power-of-two greater than
8403 @var{n}, skipping up to @var{n} bytes.  For instance,
8404 @option{-falign-functions=32} aligns functions to the next 32-byte
8405 boundary, but @option{-falign-functions=24} aligns to the next
8406 32-byte boundary only if this can be done by skipping 23 bytes or less.
8408 @option{-fno-align-functions} and @option{-falign-functions=1} are
8409 equivalent and mean that functions are not aligned.
8411 Some assemblers only support this flag when @var{n} is a power of two;
8412 in that case, it is rounded up.
8414 If @var{n} is not specified or is zero, use a machine-dependent default.
8416 Enabled at levels @option{-O2}, @option{-O3}.
8418 @item -falign-labels
8419 @itemx -falign-labels=@var{n}
8420 @opindex falign-labels
8421 Align all branch targets to a power-of-two boundary, skipping up to
8422 @var{n} bytes like @option{-falign-functions}.  This option can easily
8423 make code slower, because it must insert dummy operations for when the
8424 branch target is reached in the usual flow of the code.
8426 @option{-fno-align-labels} and @option{-falign-labels=1} are
8427 equivalent and mean that labels are not aligned.
8429 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8430 are greater than this value, then their values are used instead.
8432 If @var{n} is not specified or is zero, use a machine-dependent default
8433 which is very likely to be @samp{1}, meaning no alignment.
8435 Enabled at levels @option{-O2}, @option{-O3}.
8437 @item -falign-loops
8438 @itemx -falign-loops=@var{n}
8439 @opindex falign-loops
8440 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8441 like @option{-falign-functions}.  If the loops are
8442 executed many times, this makes up for any execution of the dummy
8443 operations.
8445 @option{-fno-align-loops} and @option{-falign-loops=1} are
8446 equivalent and mean that loops are not aligned.
8448 If @var{n} is not specified or is zero, use a machine-dependent default.
8450 Enabled at levels @option{-O2}, @option{-O3}.
8452 @item -falign-jumps
8453 @itemx -falign-jumps=@var{n}
8454 @opindex falign-jumps
8455 Align branch targets to a power-of-two boundary, for branch targets
8456 where the targets can only be reached by jumping, skipping up to @var{n}
8457 bytes like @option{-falign-functions}.  In this case, no dummy operations
8458 need be executed.
8460 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8461 equivalent and mean that loops are not aligned.
8463 If @var{n} is not specified or is zero, use a machine-dependent default.
8465 Enabled at levels @option{-O2}, @option{-O3}.
8467 @item -funit-at-a-time
8468 @opindex funit-at-a-time
8469 This option is left for compatibility reasons. @option{-funit-at-a-time}
8470 has no effect, while @option{-fno-unit-at-a-time} implies
8471 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8473 Enabled by default.
8475 @item -fno-toplevel-reorder
8476 @opindex fno-toplevel-reorder
8477 Do not reorder top-level functions, variables, and @code{asm}
8478 statements.  Output them in the same order that they appear in the
8479 input file.  When this option is used, unreferenced static variables
8480 are not removed.  This option is intended to support existing code
8481 that relies on a particular ordering.  For new code, it is better to
8482 use attributes when possible.
8484 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8485 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8486 targets.
8488 @item -fweb
8489 @opindex fweb
8490 Constructs webs as commonly used for register allocation purposes and assign
8491 each web individual pseudo register.  This allows the register allocation pass
8492 to operate on pseudos directly, but also strengthens several other optimization
8493 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8494 however, make debugging impossible, since variables no longer stay in a
8495 ``home register''.
8497 Enabled by default with @option{-funroll-loops}.
8499 @item -fwhole-program
8500 @opindex fwhole-program
8501 Assume that the current compilation unit represents the whole program being
8502 compiled.  All public functions and variables with the exception of @code{main}
8503 and those merged by attribute @code{externally_visible} become static functions
8504 and in effect are optimized more aggressively by interprocedural optimizers.
8506 This option should not be used in combination with @option{-flto}.
8507 Instead relying on a linker plugin should provide safer and more precise
8508 information.
8510 @item -flto[=@var{n}]
8511 @opindex flto
8512 This option runs the standard link-time optimizer.  When invoked
8513 with source code, it generates GIMPLE (one of GCC's internal
8514 representations) and writes it to special ELF sections in the object
8515 file.  When the object files are linked together, all the function
8516 bodies are read from these ELF sections and instantiated as if they
8517 had been part of the same translation unit.
8519 To use the link-time optimizer, @option{-flto} and optimization
8520 options should be specified at compile time and during the final link.
8521 It is recommended that you compile all the files participating in the
8522 same link with the same options and also specify those options at
8523 link time.  
8524 For example:
8526 @smallexample
8527 gcc -c -O2 -flto foo.c
8528 gcc -c -O2 -flto bar.c
8529 gcc -o myprog -flto -O2 foo.o bar.o
8530 @end smallexample
8532 The first two invocations to GCC save a bytecode representation
8533 of GIMPLE into special ELF sections inside @file{foo.o} and
8534 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8535 @file{foo.o} and @file{bar.o}, merges the two files into a single
8536 internal image, and compiles the result as usual.  Since both
8537 @file{foo.o} and @file{bar.o} are merged into a single image, this
8538 causes all the interprocedural analyses and optimizations in GCC to
8539 work across the two files as if they were a single one.  This means,
8540 for example, that the inliner is able to inline functions in
8541 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8543 Another (simpler) way to enable link-time optimization is:
8545 @smallexample
8546 gcc -o myprog -flto -O2 foo.c bar.c
8547 @end smallexample
8549 The above generates bytecode for @file{foo.c} and @file{bar.c},
8550 merges them together into a single GIMPLE representation and optimizes
8551 them as usual to produce @file{myprog}.
8553 The only important thing to keep in mind is that to enable link-time
8554 optimizations you need to use the GCC driver to perform the link step.
8555 GCC then automatically performs link-time optimization if any of the
8556 objects involved were compiled with the @option{-flto} command-line option.  
8557 You generally
8558 should specify the optimization options to be used for link-time
8559 optimization though GCC tries to be clever at guessing an
8560 optimization level to use from the options used at compile time
8561 if you fail to specify one at link time.  You can always override
8562 the automatic decision to do link-time optimization at link time
8563 by passing @option{-fno-lto} to the link command.
8565 To make whole program optimization effective, it is necessary to make
8566 certain whole program assumptions.  The compiler needs to know
8567 what functions and variables can be accessed by libraries and runtime
8568 outside of the link-time optimized unit.  When supported by the linker,
8569 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8570 to the compiler about used and externally visible symbols.  When
8571 the linker plugin is not available, @option{-fwhole-program} should be
8572 used to allow the compiler to make these assumptions, which leads
8573 to more aggressive optimization decisions.
8575 When @option{-fuse-linker-plugin} is not enabled, when a file is
8576 compiled with @option{-flto}, the generated object file is larger than
8577 a regular object file because it contains GIMPLE bytecodes and the usual
8578 final code (see @option{-ffat-lto-objects}.  This means that
8579 object files with LTO information can be linked as normal object
8580 files; if @option{-fno-lto} is passed to the linker, no
8581 interprocedural optimizations are applied.  Note that when
8582 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8583 but you cannot perform a regular, non-LTO link on them.
8585 Additionally, the optimization flags used to compile individual files
8586 are not necessarily related to those used at link time.  For instance,
8588 @smallexample
8589 gcc -c -O0 -ffat-lto-objects -flto foo.c
8590 gcc -c -O0 -ffat-lto-objects -flto bar.c
8591 gcc -o myprog -O3 foo.o bar.o
8592 @end smallexample
8594 This produces individual object files with unoptimized assembler
8595 code, but the resulting binary @file{myprog} is optimized at
8596 @option{-O3}.  If, instead, the final binary is generated with
8597 @option{-fno-lto}, then @file{myprog} is not optimized.
8599 When producing the final binary, GCC only
8600 applies link-time optimizations to those files that contain bytecode.
8601 Therefore, you can mix and match object files and libraries with
8602 GIMPLE bytecodes and final object code.  GCC automatically selects
8603 which files to optimize in LTO mode and which files to link without
8604 further processing.
8606 There are some code generation flags preserved by GCC when
8607 generating bytecodes, as they need to be used during the final link
8608 stage.  Generally options specified at link time override those
8609 specified at compile time.
8611 If you do not specify an optimization level option @option{-O} at
8612 link time, then GCC uses the highest optimization level 
8613 used when compiling the object files.
8615 Currently, the following options and their settings are taken from
8616 the first object file that explicitly specifies them: 
8617 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8618 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8619 and all the @option{-m} target flags.
8621 Certain ABI-changing flags are required to match in all compilation units,
8622 and trying to override this at link time with a conflicting value
8623 is ignored.  This includes options such as @option{-freg-struct-return}
8624 and @option{-fpcc-struct-return}. 
8626 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8627 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8628 are passed through to the link stage and merged conservatively for
8629 conflicting translation units.  Specifically
8630 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8631 precedence; and for example @option{-ffp-contract=off} takes precedence
8632 over @option{-ffp-contract=fast}.  You can override them at link time.
8634 If LTO encounters objects with C linkage declared with incompatible
8635 types in separate translation units to be linked together (undefined
8636 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8637 issued.  The behavior is still undefined at run time.  Similar
8638 diagnostics may be raised for other languages.
8640 Another feature of LTO is that it is possible to apply interprocedural
8641 optimizations on files written in different languages:
8643 @smallexample
8644 gcc -c -flto foo.c
8645 g++ -c -flto bar.cc
8646 gfortran -c -flto baz.f90
8647 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8648 @end smallexample
8650 Notice that the final link is done with @command{g++} to get the C++
8651 runtime libraries and @option{-lgfortran} is added to get the Fortran
8652 runtime libraries.  In general, when mixing languages in LTO mode, you
8653 should use the same link command options as when mixing languages in a
8654 regular (non-LTO) compilation.
8656 If object files containing GIMPLE bytecode are stored in a library archive, say
8657 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8658 are using a linker with plugin support.  To create static libraries suitable
8659 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8660 and @command{ranlib}; 
8661 to show the symbols of object files with GIMPLE bytecode, use
8662 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8663 and @command{nm} have been compiled with plugin support.  At link time, use the the
8664 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8665 the LTO optimization process:
8667 @smallexample
8668 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8669 @end smallexample
8671 With the linker plugin enabled, the linker extracts the needed
8672 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8673 to make them part of the aggregated GIMPLE image to be optimized.
8675 If you are not using a linker with plugin support and/or do not
8676 enable the linker plugin, then the objects inside @file{libfoo.a}
8677 are extracted and linked as usual, but they do not participate
8678 in the LTO optimization process.  In order to make a static library suitable
8679 for both LTO optimization and usual linkage, compile its object files with
8680 @option{-flto} @option{-ffat-lto-objects}.
8682 Link-time optimizations do not require the presence of the whole program to
8683 operate.  If the program does not require any symbols to be exported, it is
8684 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8685 the interprocedural optimizers to use more aggressive assumptions which may
8686 lead to improved optimization opportunities.
8687 Use of @option{-fwhole-program} is not needed when linker plugin is
8688 active (see @option{-fuse-linker-plugin}).
8690 The current implementation of LTO makes no
8691 attempt to generate bytecode that is portable between different
8692 types of hosts.  The bytecode files are versioned and there is a
8693 strict version check, so bytecode files generated in one version of
8694 GCC do not work with an older or newer version of GCC.
8696 Link-time optimization does not work well with generation of debugging
8697 information.  Combining @option{-flto} with
8698 @option{-g} is currently experimental and expected to produce unexpected
8699 results.
8701 If you specify the optional @var{n}, the optimization and code
8702 generation done at link time is executed in parallel using @var{n}
8703 parallel jobs by utilizing an installed @command{make} program.  The
8704 environment variable @env{MAKE} may be used to override the program
8705 used.  The default value for @var{n} is 1.
8707 You can also specify @option{-flto=jobserver} to use GNU make's
8708 job server mode to determine the number of parallel jobs. This
8709 is useful when the Makefile calling GCC is already executing in parallel.
8710 You must prepend a @samp{+} to the command recipe in the parent Makefile
8711 for this to work.  This option likely only works if @env{MAKE} is
8712 GNU make.
8714 @item -flto-partition=@var{alg}
8715 @opindex flto-partition
8716 Specify the partitioning algorithm used by the link-time optimizer.
8717 The value is either @samp{1to1} to specify a partitioning mirroring
8718 the original source files or @samp{balanced} to specify partitioning
8719 into equally sized chunks (whenever possible) or @samp{max} to create
8720 new partition for every symbol where possible.  Specifying @samp{none}
8721 as an algorithm disables partitioning and streaming completely. 
8722 The default value is @samp{balanced}. While @samp{1to1} can be used
8723 as an workaround for various code ordering issues, the @samp{max}
8724 partitioning is intended for internal testing only.
8725 The value @samp{one} specifies that exactly one partition should be
8726 used while the value @samp{none} bypasses partitioning and executes
8727 the link-time optimization step directly from the WPA phase.
8729 @item -flto-odr-type-merging
8730 @opindex flto-odr-type-merging
8731 Enable streaming of mangled types names of C++ types and their unification
8732 at link time.  This increases size of LTO object files, but enables
8733 diagnostics about One Definition Rule violations.
8735 @item -flto-compression-level=@var{n}
8736 @opindex flto-compression-level
8737 This option specifies the level of compression used for intermediate
8738 language written to LTO object files, and is only meaningful in
8739 conjunction with LTO mode (@option{-flto}).  Valid
8740 values are 0 (no compression) to 9 (maximum compression).  Values
8741 outside this range are clamped to either 0 or 9.  If the option is not
8742 given, a default balanced compression setting is used.
8744 @item -fuse-linker-plugin
8745 @opindex fuse-linker-plugin
8746 Enables the use of a linker plugin during link-time optimization.  This
8747 option relies on plugin support in the linker, which is available in gold
8748 or in GNU ld 2.21 or newer.
8750 This option enables the extraction of object files with GIMPLE bytecode out
8751 of library archives. This improves the quality of optimization by exposing
8752 more code to the link-time optimizer.  This information specifies what
8753 symbols can be accessed externally (by non-LTO object or during dynamic
8754 linking).  Resulting code quality improvements on binaries (and shared
8755 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
8756 See @option{-flto} for a description of the effect of this flag and how to
8757 use it.
8759 This option is enabled by default when LTO support in GCC is enabled
8760 and GCC was configured for use with
8761 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8763 @item -ffat-lto-objects
8764 @opindex ffat-lto-objects
8765 Fat LTO objects are object files that contain both the intermediate language
8766 and the object code. This makes them usable for both LTO linking and normal
8767 linking. This option is effective only when compiling with @option{-flto}
8768 and is ignored at link time.
8770 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8771 requires the complete toolchain to be aware of LTO. It requires a linker with
8772 linker plugin support for basic functionality.  Additionally,
8773 @command{nm}, @command{ar} and @command{ranlib}
8774 need to support linker plugins to allow a full-featured build environment
8775 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8776 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8777 to these tools. With non fat LTO makefiles need to be modified to use them.
8779 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8780 support.
8782 @item -fcompare-elim
8783 @opindex fcompare-elim
8784 After register allocation and post-register allocation instruction splitting,
8785 identify arithmetic instructions that compute processor flags similar to a
8786 comparison operation based on that arithmetic.  If possible, eliminate the
8787 explicit comparison operation.
8789 This pass only applies to certain targets that cannot explicitly represent
8790 the comparison operation before register allocation is complete.
8792 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8794 @item -fcprop-registers
8795 @opindex fcprop-registers
8796 After register allocation and post-register allocation instruction splitting,
8797 perform a copy-propagation pass to try to reduce scheduling dependencies
8798 and occasionally eliminate the copy.
8800 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8802 @item -fprofile-correction
8803 @opindex fprofile-correction
8804 Profiles collected using an instrumented binary for multi-threaded programs may
8805 be inconsistent due to missed counter updates. When this option is specified,
8806 GCC uses heuristics to correct or smooth out such inconsistencies. By
8807 default, GCC emits an error message when an inconsistent profile is detected.
8809 @item -fprofile-use
8810 @itemx -fprofile-use=@var{path}
8811 @opindex fprofile-use
8812 Enable profile feedback-directed optimizations, 
8813 and the following optimizations
8814 which are generally profitable only with profile feedback available:
8815 @option{-fbranch-probabilities}, @option{-fvpt},
8816 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
8817 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
8819 Before you can use this option, you must first generate profiling information.
8820 @xref{Optimize Options}, for information about the @option{-fprofile-generate}
8821 option.
8823 By default, GCC emits an error message if the feedback profiles do not
8824 match the source code.  This error can be turned into a warning by using
8825 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8826 code.
8828 If @var{path} is specified, GCC looks at the @var{path} to find
8829 the profile feedback data files. See @option{-fprofile-dir}.
8831 @item -fauto-profile
8832 @itemx -fauto-profile=@var{path}
8833 @opindex fauto-profile
8834 Enable sampling-based feedback-directed optimizations, 
8835 and the following optimizations
8836 which are generally profitable only with profile feedback available:
8837 @option{-fbranch-probabilities}, @option{-fvpt},
8838 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
8839 @option{-ftree-vectorize},
8840 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
8841 @option{-fpredictive-commoning}, @option{-funswitch-loops},
8842 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
8844 @var{path} is the name of a file containing AutoFDO profile information.
8845 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
8847 Producing an AutoFDO profile data file requires running your program
8848 with the @command{perf} utility on a supported GNU/Linux target system.
8849 For more information, see @uref{https://perf.wiki.kernel.org/}.
8851 E.g.
8852 @smallexample
8853 perf record -e br_inst_retired:near_taken -b -o perf.data \
8854     -- your_program
8855 @end smallexample
8857 Then use the @command{create_gcov} tool to convert the raw profile data
8858 to a format that can be used by GCC.@  You must also supply the 
8859 unstripped binary for your program to this tool.  
8860 See @uref{https://github.com/google/autofdo}.
8862 E.g.
8863 @smallexample
8864 create_gcov --binary=your_program.unstripped --profile=perf.data \
8865     --gcov=profile.afdo
8866 @end smallexample
8867 @end table
8869 The following options control compiler behavior regarding floating-point 
8870 arithmetic.  These options trade off between speed and
8871 correctness.  All must be specifically enabled.
8873 @table @gcctabopt
8874 @item -ffloat-store
8875 @opindex ffloat-store
8876 Do not store floating-point variables in registers, and inhibit other
8877 options that might change whether a floating-point value is taken from a
8878 register or memory.
8880 @cindex floating-point precision
8881 This option prevents undesirable excess precision on machines such as
8882 the 68000 where the floating registers (of the 68881) keep more
8883 precision than a @code{double} is supposed to have.  Similarly for the
8884 x86 architecture.  For most programs, the excess precision does only
8885 good, but a few programs rely on the precise definition of IEEE floating
8886 point.  Use @option{-ffloat-store} for such programs, after modifying
8887 them to store all pertinent intermediate computations into variables.
8889 @item -fexcess-precision=@var{style}
8890 @opindex fexcess-precision
8891 This option allows further control over excess precision on machines
8892 where floating-point registers have more precision than the IEEE
8893 @code{float} and @code{double} types and the processor does not
8894 support operations rounding to those types.  By default,
8895 @option{-fexcess-precision=fast} is in effect; this means that
8896 operations are carried out in the precision of the registers and that
8897 it is unpredictable when rounding to the types specified in the source
8898 code takes place.  When compiling C, if
8899 @option{-fexcess-precision=standard} is specified then excess
8900 precision follows the rules specified in ISO C99; in particular,
8901 both casts and assignments cause values to be rounded to their
8902 semantic types (whereas @option{-ffloat-store} only affects
8903 assignments).  This option is enabled by default for C if a strict
8904 conformance option such as @option{-std=c99} is used.
8906 @opindex mfpmath
8907 @option{-fexcess-precision=standard} is not implemented for languages
8908 other than C, and has no effect if
8909 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8910 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8911 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8912 semantics apply without excess precision, and in the latter, rounding
8913 is unpredictable.
8915 @item -ffast-math
8916 @opindex ffast-math
8917 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8918 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8919 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8921 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8923 This option is not turned on by any @option{-O} option besides
8924 @option{-Ofast} since it can result in incorrect output for programs
8925 that depend on an exact implementation of IEEE or ISO rules/specifications
8926 for math functions. It may, however, yield faster code for programs
8927 that do not require the guarantees of these specifications.
8929 @item -fno-math-errno
8930 @opindex fno-math-errno
8931 Do not set @code{errno} after calling math functions that are executed
8932 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8933 IEEE exceptions for math error handling may want to use this flag
8934 for speed while maintaining IEEE arithmetic compatibility.
8936 This option is not turned on by any @option{-O} option since
8937 it can result in incorrect output for programs that depend on
8938 an exact implementation of IEEE or ISO rules/specifications for
8939 math functions. It may, however, yield faster code for programs
8940 that do not require the guarantees of these specifications.
8942 The default is @option{-fmath-errno}.
8944 On Darwin systems, the math library never sets @code{errno}.  There is
8945 therefore no reason for the compiler to consider the possibility that
8946 it might, and @option{-fno-math-errno} is the default.
8948 @item -funsafe-math-optimizations
8949 @opindex funsafe-math-optimizations
8951 Allow optimizations for floating-point arithmetic that (a) assume
8952 that arguments and results are valid and (b) may violate IEEE or
8953 ANSI standards.  When used at link time, it may include libraries
8954 or startup files that change the default FPU control word or other
8955 similar optimizations.
8957 This option is not turned on by any @option{-O} option since
8958 it can result in incorrect output for programs that depend on
8959 an exact implementation of IEEE or ISO rules/specifications for
8960 math functions. It may, however, yield faster code for programs
8961 that do not require the guarantees of these specifications.
8962 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8963 @option{-fassociative-math} and @option{-freciprocal-math}.
8965 The default is @option{-fno-unsafe-math-optimizations}.
8967 @item -fassociative-math
8968 @opindex fassociative-math
8970 Allow re-association of operands in series of floating-point operations.
8971 This violates the ISO C and C++ language standard by possibly changing
8972 computation result.  NOTE: re-ordering may change the sign of zero as
8973 well as ignore NaNs and inhibit or create underflow or overflow (and
8974 thus cannot be used on code that relies on rounding behavior like
8975 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8976 and thus may not be used when ordered comparisons are required.
8977 This option requires that both @option{-fno-signed-zeros} and
8978 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8979 much sense with @option{-frounding-math}. For Fortran the option
8980 is automatically enabled when both @option{-fno-signed-zeros} and
8981 @option{-fno-trapping-math} are in effect.
8983 The default is @option{-fno-associative-math}.
8985 @item -freciprocal-math
8986 @opindex freciprocal-math
8988 Allow the reciprocal of a value to be used instead of dividing by
8989 the value if this enables optimizations.  For example @code{x / y}
8990 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8991 is subject to common subexpression elimination.  Note that this loses
8992 precision and increases the number of flops operating on the value.
8994 The default is @option{-fno-reciprocal-math}.
8996 @item -ffinite-math-only
8997 @opindex ffinite-math-only
8998 Allow optimizations for floating-point arithmetic that assume
8999 that arguments and results are not NaNs or +-Infs.
9001 This option is not turned on by any @option{-O} option since
9002 it can result in incorrect output for programs that depend on
9003 an exact implementation of IEEE or ISO rules/specifications for
9004 math functions. It may, however, yield faster code for programs
9005 that do not require the guarantees of these specifications.
9007 The default is @option{-fno-finite-math-only}.
9009 @item -fno-signed-zeros
9010 @opindex fno-signed-zeros
9011 Allow optimizations for floating-point arithmetic that ignore the
9012 signedness of zero.  IEEE arithmetic specifies the behavior of
9013 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9014 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9015 This option implies that the sign of a zero result isn't significant.
9017 The default is @option{-fsigned-zeros}.
9019 @item -fno-trapping-math
9020 @opindex fno-trapping-math
9021 Compile code assuming that floating-point operations cannot generate
9022 user-visible traps.  These traps include division by zero, overflow,
9023 underflow, inexact result and invalid operation.  This option requires
9024 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9025 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9027 This option should never be turned on by any @option{-O} option since
9028 it can result in incorrect output for programs that depend on
9029 an exact implementation of IEEE or ISO rules/specifications for
9030 math functions.
9032 The default is @option{-ftrapping-math}.
9034 @item -frounding-math
9035 @opindex frounding-math
9036 Disable transformations and optimizations that assume default floating-point
9037 rounding behavior.  This is round-to-zero for all floating point
9038 to integer conversions, and round-to-nearest for all other arithmetic
9039 truncations.  This option should be specified for programs that change
9040 the FP rounding mode dynamically, or that may be executed with a
9041 non-default rounding mode.  This option disables constant folding of
9042 floating-point expressions at compile time (which may be affected by
9043 rounding mode) and arithmetic transformations that are unsafe in the
9044 presence of sign-dependent rounding modes.
9046 The default is @option{-fno-rounding-math}.
9048 This option is experimental and does not currently guarantee to
9049 disable all GCC optimizations that are affected by rounding mode.
9050 Future versions of GCC may provide finer control of this setting
9051 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9052 will be used to specify the default state for @code{FENV_ACCESS}.
9054 @item -fsignaling-nans
9055 @opindex fsignaling-nans
9056 Compile code assuming that IEEE signaling NaNs may generate user-visible
9057 traps during floating-point operations.  Setting this option disables
9058 optimizations that may change the number of exceptions visible with
9059 signaling NaNs.  This option implies @option{-ftrapping-math}.
9061 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9062 be defined.
9064 The default is @option{-fno-signaling-nans}.
9066 This option is experimental and does not currently guarantee to
9067 disable all GCC optimizations that affect signaling NaN behavior.
9069 @item -fno-fp-int-builtin-inexact
9070 @opindex fno-fp-int-builtin-inexact
9071 Do not allow the built-in functions @code{ceil}, @code{floor},
9072 @code{round} and @code{trunc}, and their @code{float} and @code{long
9073 double} variants, to generate code that raises the ``inexact''
9074 floating-point exception for noninteger arguments.  ISO C99 and C11
9075 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9076 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9077 functions to do so.
9079 The default is @option{-ffp-int-builtin-inexact}, allowing the
9080 exception to be raised.  This option does nothing unless
9081 @option{-ftrapping-math} is in effect.
9083 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9084 generate a call to a library function then the ``inexact'' exception
9085 may be raised if the library implementation does not follow TS 18661.
9087 @item -fsingle-precision-constant
9088 @opindex fsingle-precision-constant
9089 Treat floating-point constants as single precision instead of
9090 implicitly converting them to double-precision constants.
9092 @item -fcx-limited-range
9093 @opindex fcx-limited-range
9094 When enabled, this option states that a range reduction step is not
9095 needed when performing complex division.  Also, there is no checking
9096 whether the result of a complex multiplication or division is @code{NaN
9097 + I*NaN}, with an attempt to rescue the situation in that case.  The
9098 default is @option{-fno-cx-limited-range}, but is enabled by
9099 @option{-ffast-math}.
9101 This option controls the default setting of the ISO C99
9102 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9103 all languages.
9105 @item -fcx-fortran-rules
9106 @opindex fcx-fortran-rules
9107 Complex multiplication and division follow Fortran rules.  Range
9108 reduction is done as part of complex division, but there is no checking
9109 whether the result of a complex multiplication or division is @code{NaN
9110 + I*NaN}, with an attempt to rescue the situation in that case.
9112 The default is @option{-fno-cx-fortran-rules}.
9114 @end table
9116 The following options control optimizations that may improve
9117 performance, but are not enabled by any @option{-O} options.  This
9118 section includes experimental options that may produce broken code.
9120 @table @gcctabopt
9121 @item -fbranch-probabilities
9122 @opindex fbranch-probabilities
9123 After running a program compiled with @option{-fprofile-arcs}
9124 (@pxref{Instrumentation Options}),
9125 you can compile it a second time using
9126 @option{-fbranch-probabilities}, to improve optimizations based on
9127 the number of times each branch was taken.  When a program
9128 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9129 counts to a file called @file{@var{sourcename}.gcda} for each source
9130 file.  The information in this data file is very dependent on the
9131 structure of the generated code, so you must use the same source code
9132 and the same optimization options for both compilations.
9134 With @option{-fbranch-probabilities}, GCC puts a
9135 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9136 These can be used to improve optimization.  Currently, they are only
9137 used in one place: in @file{reorg.c}, instead of guessing which path a
9138 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9139 exactly determine which path is taken more often.
9141 @item -fprofile-values
9142 @opindex fprofile-values
9143 If combined with @option{-fprofile-arcs}, it adds code so that some
9144 data about values of expressions in the program is gathered.
9146 With @option{-fbranch-probabilities}, it reads back the data gathered
9147 from profiling values of expressions for usage in optimizations.
9149 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9151 @item -fprofile-reorder-functions
9152 @opindex fprofile-reorder-functions
9153 Function reordering based on profile instrumentation collects
9154 first time of execution of a function and orders these functions
9155 in ascending order.
9157 Enabled with @option{-fprofile-use}.
9159 @item -fvpt
9160 @opindex fvpt
9161 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9162 to add code to gather information about values of expressions.
9164 With @option{-fbranch-probabilities}, it reads back the data gathered
9165 and actually performs the optimizations based on them.
9166 Currently the optimizations include specialization of division operations
9167 using the knowledge about the value of the denominator.
9169 @item -frename-registers
9170 @opindex frename-registers
9171 Attempt to avoid false dependencies in scheduled code by making use
9172 of registers left over after register allocation.  This optimization
9173 most benefits processors with lots of registers.  Depending on the
9174 debug information format adopted by the target, however, it can
9175 make debugging impossible, since variables no longer stay in
9176 a ``home register''.
9178 Enabled by default with @option{-funroll-loops}.
9180 @item -fschedule-fusion
9181 @opindex fschedule-fusion
9182 Performs a target dependent pass over the instruction stream to schedule
9183 instructions of same type together because target machine can execute them
9184 more efficiently if they are adjacent to each other in the instruction flow.
9186 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9188 @item -ftracer
9189 @opindex ftracer
9190 Perform tail duplication to enlarge superblock size.  This transformation
9191 simplifies the control flow of the function allowing other optimizations to do
9192 a better job.
9194 Enabled with @option{-fprofile-use}.
9196 @item -funroll-loops
9197 @opindex funroll-loops
9198 Unroll loops whose number of iterations can be determined at compile time or
9199 upon entry to the loop.  @option{-funroll-loops} implies
9200 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9201 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9202 a small constant number of iterations).  This option makes code larger, and may
9203 or may not make it run faster.
9205 Enabled with @option{-fprofile-use}.
9207 @item -funroll-all-loops
9208 @opindex funroll-all-loops
9209 Unroll all loops, even if their number of iterations is uncertain when
9210 the loop is entered.  This usually makes programs run more slowly.
9211 @option{-funroll-all-loops} implies the same options as
9212 @option{-funroll-loops}.
9214 @item -fpeel-loops
9215 @opindex fpeel-loops
9216 Peels loops for which there is enough information that they do not
9217 roll much (from profile feedback or static analysis).  It also turns on
9218 complete loop peeling (i.e.@: complete removal of loops with small constant
9219 number of iterations).
9221 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9223 @item -fmove-loop-invariants
9224 @opindex fmove-loop-invariants
9225 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9226 at level @option{-O1}
9228 @item -fsplit-loops
9229 @opindex fsplit-loops
9230 Split a loop into two if it contains a condition that's always true
9231 for one side of the iteration space and false for the other.
9233 @item -funswitch-loops
9234 @opindex funswitch-loops
9235 Move branches with loop invariant conditions out of the loop, with duplicates
9236 of the loop on both branches (modified according to result of the condition).
9238 @item -ffunction-sections
9239 @itemx -fdata-sections
9240 @opindex ffunction-sections
9241 @opindex fdata-sections
9242 Place each function or data item into its own section in the output
9243 file if the target supports arbitrary sections.  The name of the
9244 function or the name of the data item determines the section's name
9245 in the output file.
9247 Use these options on systems where the linker can perform optimizations
9248 to improve locality of reference in the instruction space.  Most systems
9249 using the ELF object format and SPARC processors running Solaris 2 have
9250 linkers with such optimizations.  AIX may have these optimizations in
9251 the future.
9253 Only use these options when there are significant benefits from doing
9254 so.  When you specify these options, the assembler and linker
9255 create larger object and executable files and are also slower.
9256 You cannot use @command{gprof} on all systems if you
9257 specify this option, and you may have problems with debugging if
9258 you specify both this option and @option{-g}.
9260 @item -fbranch-target-load-optimize
9261 @opindex fbranch-target-load-optimize
9262 Perform branch target register load optimization before prologue / epilogue
9263 threading.
9264 The use of target registers can typically be exposed only during reload,
9265 thus hoisting loads out of loops and doing inter-block scheduling needs
9266 a separate optimization pass.
9268 @item -fbranch-target-load-optimize2
9269 @opindex fbranch-target-load-optimize2
9270 Perform branch target register load optimization after prologue / epilogue
9271 threading.
9273 @item -fbtr-bb-exclusive
9274 @opindex fbtr-bb-exclusive
9275 When performing branch target register load optimization, don't reuse
9276 branch target registers within any basic block.
9278 @item -fstdarg-opt
9279 @opindex fstdarg-opt
9280 Optimize the prologue of variadic argument functions with respect to usage of
9281 those arguments.
9283 @item -fsection-anchors
9284 @opindex fsection-anchors
9285 Try to reduce the number of symbolic address calculations by using
9286 shared ``anchor'' symbols to address nearby objects.  This transformation
9287 can help to reduce the number of GOT entries and GOT accesses on some
9288 targets.
9290 For example, the implementation of the following function @code{foo}:
9292 @smallexample
9293 static int a, b, c;
9294 int foo (void) @{ return a + b + c; @}
9295 @end smallexample
9297 @noindent
9298 usually calculates the addresses of all three variables, but if you
9299 compile it with @option{-fsection-anchors}, it accesses the variables
9300 from a common anchor point instead.  The effect is similar to the
9301 following pseudocode (which isn't valid C):
9303 @smallexample
9304 int foo (void)
9306   register int *xr = &x;
9307   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9309 @end smallexample
9311 Not all targets support this option.
9313 @item --param @var{name}=@var{value}
9314 @opindex param
9315 In some places, GCC uses various constants to control the amount of
9316 optimization that is done.  For example, GCC does not inline functions
9317 that contain more than a certain number of instructions.  You can
9318 control some of these constants on the command line using the
9319 @option{--param} option.
9321 The names of specific parameters, and the meaning of the values, are
9322 tied to the internals of the compiler, and are subject to change
9323 without notice in future releases.
9325 In each case, the @var{value} is an integer.  The allowable choices for
9326 @var{name} are:
9328 @table @gcctabopt
9329 @item predictable-branch-outcome
9330 When branch is predicted to be taken with probability lower than this threshold
9331 (in percent), then it is considered well predictable. The default is 10.
9333 @item max-rtl-if-conversion-insns
9334 RTL if-conversion tries to remove conditional branches around a block and
9335 replace them with conditionally executed instructions.  This parameter
9336 gives the maximum number of instructions in a block which should be
9337 considered for if-conversion.  The default is 10, though the compiler will
9338 also use other heuristics to decide whether if-conversion is likely to be
9339 profitable.
9341 @item max-rtl-if-conversion-predictable-cost
9342 @item max-rtl-if-conversion-unpredictable-cost
9343 RTL if-conversion will try to remove conditional branches around a block
9344 and replace them with conditionally executed instructions.  These parameters
9345 give the maximum permissible cost for the sequence that would be generated
9346 by if-conversion depending on whether the branch is statically determined
9347 to be predictable or not.  The units for this parameter are the same as
9348 those for the GCC internal seq_cost metric.  The compiler will try to
9349 provide a reasonable default for this parameter using the BRANCH_COST
9350 target macro.
9352 @item max-crossjump-edges
9353 The maximum number of incoming edges to consider for cross-jumping.
9354 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9355 the number of edges incoming to each block.  Increasing values mean
9356 more aggressive optimization, making the compilation time increase with
9357 probably small improvement in executable size.
9359 @item min-crossjump-insns
9360 The minimum number of instructions that must be matched at the end
9361 of two blocks before cross-jumping is performed on them.  This
9362 value is ignored in the case where all instructions in the block being
9363 cross-jumped from are matched.  The default value is 5.
9365 @item max-grow-copy-bb-insns
9366 The maximum code size expansion factor when copying basic blocks
9367 instead of jumping.  The expansion is relative to a jump instruction.
9368 The default value is 8.
9370 @item max-goto-duplication-insns
9371 The maximum number of instructions to duplicate to a block that jumps
9372 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9373 passes, GCC factors computed gotos early in the compilation process,
9374 and unfactors them as late as possible.  Only computed jumps at the
9375 end of a basic blocks with no more than max-goto-duplication-insns are
9376 unfactored.  The default value is 8.
9378 @item max-delay-slot-insn-search
9379 The maximum number of instructions to consider when looking for an
9380 instruction to fill a delay slot.  If more than this arbitrary number of
9381 instructions are searched, the time savings from filling the delay slot
9382 are minimal, so stop searching.  Increasing values mean more
9383 aggressive optimization, making the compilation time increase with probably
9384 small improvement in execution time.
9386 @item max-delay-slot-live-search
9387 When trying to fill delay slots, the maximum number of instructions to
9388 consider when searching for a block with valid live register
9389 information.  Increasing this arbitrarily chosen value means more
9390 aggressive optimization, increasing the compilation time.  This parameter
9391 should be removed when the delay slot code is rewritten to maintain the
9392 control-flow graph.
9394 @item max-gcse-memory
9395 The approximate maximum amount of memory that can be allocated in
9396 order to perform the global common subexpression elimination
9397 optimization.  If more memory than specified is required, the
9398 optimization is not done.
9400 @item max-gcse-insertion-ratio
9401 If the ratio of expression insertions to deletions is larger than this value
9402 for any expression, then RTL PRE inserts or removes the expression and thus
9403 leaves partially redundant computations in the instruction stream.  The default value is 20.
9405 @item max-pending-list-length
9406 The maximum number of pending dependencies scheduling allows
9407 before flushing the current state and starting over.  Large functions
9408 with few branches or calls can create excessively large lists which
9409 needlessly consume memory and resources.
9411 @item max-modulo-backtrack-attempts
9412 The maximum number of backtrack attempts the scheduler should make
9413 when modulo scheduling a loop.  Larger values can exponentially increase
9414 compilation time.
9416 @item max-inline-insns-single
9417 Several parameters control the tree inliner used in GCC@.
9418 This number sets the maximum number of instructions (counted in GCC's
9419 internal representation) in a single function that the tree inliner
9420 considers for inlining.  This only affects functions declared
9421 inline and methods implemented in a class declaration (C++).
9422 The default value is 400.
9424 @item max-inline-insns-auto
9425 When you use @option{-finline-functions} (included in @option{-O3}),
9426 a lot of functions that would otherwise not be considered for inlining
9427 by the compiler are investigated.  To those functions, a different
9428 (more restrictive) limit compared to functions declared inline can
9429 be applied.
9430 The default value is 40.
9432 @item inline-min-speedup
9433 When estimated performance improvement of caller + callee runtime exceeds this
9434 threshold (in precent), the function can be inlined regardless the limit on
9435 @option{--param max-inline-insns-single} and @option{--param
9436 max-inline-insns-auto}.
9438 @item large-function-insns
9439 The limit specifying really large functions.  For functions larger than this
9440 limit after inlining, inlining is constrained by
9441 @option{--param large-function-growth}.  This parameter is useful primarily
9442 to avoid extreme compilation time caused by non-linear algorithms used by the
9443 back end.
9444 The default value is 2700.
9446 @item large-function-growth
9447 Specifies maximal growth of large function caused by inlining in percents.
9448 The default value is 100 which limits large function growth to 2.0 times
9449 the original size.
9451 @item large-unit-insns
9452 The limit specifying large translation unit.  Growth caused by inlining of
9453 units larger than this limit is limited by @option{--param inline-unit-growth}.
9454 For small units this might be too tight.
9455 For example, consider a unit consisting of function A
9456 that is inline and B that just calls A three times.  If B is small relative to
9457 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9458 large units consisting of small inlineable functions, however, the overall unit
9459 growth limit is needed to avoid exponential explosion of code size.  Thus for
9460 smaller units, the size is increased to @option{--param large-unit-insns}
9461 before applying @option{--param inline-unit-growth}.  The default is 10000.
9463 @item inline-unit-growth
9464 Specifies maximal overall growth of the compilation unit caused by inlining.
9465 The default value is 20 which limits unit growth to 1.2 times the original
9466 size. Cold functions (either marked cold via an attribute or by profile
9467 feedback) are not accounted into the unit size.
9469 @item ipcp-unit-growth
9470 Specifies maximal overall growth of the compilation unit caused by
9471 interprocedural constant propagation.  The default value is 10 which limits
9472 unit growth to 1.1 times the original size.
9474 @item large-stack-frame
9475 The limit specifying large stack frames.  While inlining the algorithm is trying
9476 to not grow past this limit too much.  The default value is 256 bytes.
9478 @item large-stack-frame-growth
9479 Specifies maximal growth of large stack frames caused by inlining in percents.
9480 The default value is 1000 which limits large stack frame growth to 11 times
9481 the original size.
9483 @item max-inline-insns-recursive
9484 @itemx max-inline-insns-recursive-auto
9485 Specifies the maximum number of instructions an out-of-line copy of a
9486 self-recursive inline
9487 function can grow into by performing recursive inlining.
9489 @option{--param max-inline-insns-recursive} applies to functions
9490 declared inline.
9491 For functions not declared inline, recursive inlining
9492 happens only when @option{-finline-functions} (included in @option{-O3}) is
9493 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9494 default value is 450.
9496 @item max-inline-recursive-depth
9497 @itemx max-inline-recursive-depth-auto
9498 Specifies the maximum recursion depth used for recursive inlining.
9500 @option{--param max-inline-recursive-depth} applies to functions
9501 declared inline.  For functions not declared inline, recursive inlining
9502 happens only when @option{-finline-functions} (included in @option{-O3}) is
9503 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9504 default value is 8.
9506 @item min-inline-recursive-probability
9507 Recursive inlining is profitable only for function having deep recursion
9508 in average and can hurt for function having little recursion depth by
9509 increasing the prologue size or complexity of function body to other
9510 optimizers.
9512 When profile feedback is available (see @option{-fprofile-generate}) the actual
9513 recursion depth can be guessed from the probability that function recurses
9514 via a given call expression.  This parameter limits inlining only to call
9515 expressions whose probability exceeds the given threshold (in percents).
9516 The default value is 10.
9518 @item early-inlining-insns
9519 Specify growth that the early inliner can make.  In effect it increases
9520 the amount of inlining for code having a large abstraction penalty.
9521 The default value is 14.
9523 @item max-early-inliner-iterations
9524 Limit of iterations of the early inliner.  This basically bounds
9525 the number of nested indirect calls the early inliner can resolve.
9526 Deeper chains are still handled by late inlining.
9528 @item comdat-sharing-probability
9529 Probability (in percent) that C++ inline function with comdat visibility
9530 are shared across multiple compilation units.  The default value is 20.
9532 @item profile-func-internal-id
9533 A parameter to control whether to use function internal id in profile
9534 database lookup. If the value is 0, the compiler uses an id that
9535 is based on function assembler name and filename, which makes old profile
9536 data more tolerant to source changes such as function reordering etc.
9537 The default value is 0.
9539 @item min-vect-loop-bound
9540 The minimum number of iterations under which loops are not vectorized
9541 when @option{-ftree-vectorize} is used.  The number of iterations after
9542 vectorization needs to be greater than the value specified by this option
9543 to allow vectorization.  The default value is 0.
9545 @item gcse-cost-distance-ratio
9546 Scaling factor in calculation of maximum distance an expression
9547 can be moved by GCSE optimizations.  This is currently supported only in the
9548 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9549 is with simple expressions, i.e., the expressions that have cost
9550 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9551 hoisting of simple expressions.  The default value is 10.
9553 @item gcse-unrestricted-cost
9554 Cost, roughly measured as the cost of a single typical machine
9555 instruction, at which GCSE optimizations do not constrain
9556 the distance an expression can travel.  This is currently
9557 supported only in the code hoisting pass.  The lesser the cost,
9558 the more aggressive code hoisting is.  Specifying 0 
9559 allows all expressions to travel unrestricted distances.
9560 The default value is 3.
9562 @item max-hoist-depth
9563 The depth of search in the dominator tree for expressions to hoist.
9564 This is used to avoid quadratic behavior in hoisting algorithm.
9565 The value of 0 does not limit on the search, but may slow down compilation
9566 of huge functions.  The default value is 30.
9568 @item max-tail-merge-comparisons
9569 The maximum amount of similar bbs to compare a bb with.  This is used to
9570 avoid quadratic behavior in tree tail merging.  The default value is 10.
9572 @item max-tail-merge-iterations
9573 The maximum amount of iterations of the pass over the function.  This is used to
9574 limit compilation time in tree tail merging.  The default value is 2.
9576 @item max-unrolled-insns
9577 The maximum number of instructions that a loop may have to be unrolled.
9578 If a loop is unrolled, this parameter also determines how many times
9579 the loop code is unrolled.
9581 @item max-average-unrolled-insns
9582 The maximum number of instructions biased by probabilities of their execution
9583 that a loop may have to be unrolled.  If a loop is unrolled,
9584 this parameter also determines how many times the loop code is unrolled.
9586 @item max-unroll-times
9587 The maximum number of unrollings of a single loop.
9589 @item max-peeled-insns
9590 The maximum number of instructions that a loop may have to be peeled.
9591 If a loop is peeled, this parameter also determines how many times
9592 the loop code is peeled.
9594 @item max-peel-times
9595 The maximum number of peelings of a single loop.
9597 @item max-peel-branches
9598 The maximum number of branches on the hot path through the peeled sequence.
9600 @item max-completely-peeled-insns
9601 The maximum number of insns of a completely peeled loop.
9603 @item max-completely-peel-times
9604 The maximum number of iterations of a loop to be suitable for complete peeling.
9606 @item max-completely-peel-loop-nest-depth
9607 The maximum depth of a loop nest suitable for complete peeling.
9609 @item max-unswitch-insns
9610 The maximum number of insns of an unswitched loop.
9612 @item max-unswitch-level
9613 The maximum number of branches unswitched in a single loop.
9615 @item max-loop-headers-insns
9616 The maximum number of insns in loop header duplicated by he copy loop headers
9617 pass.
9619 @item lim-expensive
9620 The minimum cost of an expensive expression in the loop invariant motion.
9622 @item iv-consider-all-candidates-bound
9623 Bound on number of candidates for induction variables, below which
9624 all candidates are considered for each use in induction variable
9625 optimizations.  If there are more candidates than this,
9626 only the most relevant ones are considered to avoid quadratic time complexity.
9628 @item iv-max-considered-uses
9629 The induction variable optimizations give up on loops that contain more
9630 induction variable uses.
9632 @item iv-always-prune-cand-set-bound
9633 If the number of candidates in the set is smaller than this value,
9634 always try to remove unnecessary ivs from the set
9635 when adding a new one.
9637 @item avg-loop-niter
9638 Average number of iterations of a loop.
9640 @item scev-max-expr-size
9641 Bound on size of expressions used in the scalar evolutions analyzer.
9642 Large expressions slow the analyzer.
9644 @item scev-max-expr-complexity
9645 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9646 Complex expressions slow the analyzer.
9648 @item max-tree-if-conversion-phi-args
9649 Maximum number of arguments in a PHI supported by TREE if conversion
9650 unless the loop is marked with simd pragma.
9652 @item vect-max-version-for-alignment-checks
9653 The maximum number of run-time checks that can be performed when
9654 doing loop versioning for alignment in the vectorizer.
9656 @item vect-max-version-for-alias-checks
9657 The maximum number of run-time checks that can be performed when
9658 doing loop versioning for alias in the vectorizer.
9660 @item vect-max-peeling-for-alignment
9661 The maximum number of loop peels to enhance access alignment
9662 for vectorizer. Value -1 means no limit.
9664 @item max-iterations-to-track
9665 The maximum number of iterations of a loop the brute-force algorithm
9666 for analysis of the number of iterations of the loop tries to evaluate.
9668 @item hot-bb-count-ws-permille
9669 A basic block profile count is considered hot if it contributes to 
9670 the given permillage (i.e. 0...1000) of the entire profiled execution.
9672 @item hot-bb-frequency-fraction
9673 Select fraction of the entry block frequency of executions of basic block in
9674 function given basic block needs to have to be considered hot.
9676 @item max-predicted-iterations
9677 The maximum number of loop iterations we predict statically.  This is useful
9678 in cases where a function contains a single loop with known bound and
9679 another loop with unknown bound.
9680 The known number of iterations is predicted correctly, while
9681 the unknown number of iterations average to roughly 10.  This means that the
9682 loop without bounds appears artificially cold relative to the other one.
9684 @item builtin-expect-probability
9685 Control the probability of the expression having the specified value. This
9686 parameter takes a percentage (i.e. 0 ... 100) as input.
9687 The default probability of 90 is obtained empirically.
9689 @item align-threshold
9691 Select fraction of the maximal frequency of executions of a basic block in
9692 a function to align the basic block.
9694 @item align-loop-iterations
9696 A loop expected to iterate at least the selected number of iterations is
9697 aligned.
9699 @item tracer-dynamic-coverage
9700 @itemx tracer-dynamic-coverage-feedback
9702 This value is used to limit superblock formation once the given percentage of
9703 executed instructions is covered.  This limits unnecessary code size
9704 expansion.
9706 The @option{tracer-dynamic-coverage-feedback} parameter
9707 is used only when profile
9708 feedback is available.  The real profiles (as opposed to statically estimated
9709 ones) are much less balanced allowing the threshold to be larger value.
9711 @item tracer-max-code-growth
9712 Stop tail duplication once code growth has reached given percentage.  This is
9713 a rather artificial limit, as most of the duplicates are eliminated later in
9714 cross jumping, so it may be set to much higher values than is the desired code
9715 growth.
9717 @item tracer-min-branch-ratio
9719 Stop reverse growth when the reverse probability of best edge is less than this
9720 threshold (in percent).
9722 @item tracer-min-branch-probability
9723 @itemx tracer-min-branch-probability-feedback
9725 Stop forward growth if the best edge has probability lower than this
9726 threshold.
9728 Similarly to @option{tracer-dynamic-coverage} two parameters are
9729 provided.  @option{tracer-min-branch-probability-feedback} is used for
9730 compilation with profile feedback and @option{tracer-min-branch-probability}
9731 compilation without.  The value for compilation with profile feedback
9732 needs to be more conservative (higher) in order to make tracer
9733 effective.
9735 @item max-cse-path-length
9737 The maximum number of basic blocks on path that CSE considers.
9738 The default is 10.
9740 @item max-cse-insns
9741 The maximum number of instructions CSE processes before flushing.
9742 The default is 1000.
9744 @item ggc-min-expand
9746 GCC uses a garbage collector to manage its own memory allocation.  This
9747 parameter specifies the minimum percentage by which the garbage
9748 collector's heap should be allowed to expand between collections.
9749 Tuning this may improve compilation speed; it has no effect on code
9750 generation.
9752 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9753 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9754 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9755 GCC is not able to calculate RAM on a particular platform, the lower
9756 bound of 30% is used.  Setting this parameter and
9757 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9758 every opportunity.  This is extremely slow, but can be useful for
9759 debugging.
9761 @item ggc-min-heapsize
9763 Minimum size of the garbage collector's heap before it begins bothering
9764 to collect garbage.  The first collection occurs after the heap expands
9765 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9766 tuning this may improve compilation speed, and has no effect on code
9767 generation.
9769 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9770 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9771 with a lower bound of 4096 (four megabytes) and an upper bound of
9772 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9773 particular platform, the lower bound is used.  Setting this parameter
9774 very large effectively disables garbage collection.  Setting this
9775 parameter and @option{ggc-min-expand} to zero causes a full collection
9776 to occur at every opportunity.
9778 @item max-reload-search-insns
9779 The maximum number of instruction reload should look backward for equivalent
9780 register.  Increasing values mean more aggressive optimization, making the
9781 compilation time increase with probably slightly better performance.
9782 The default value is 100.
9784 @item max-cselib-memory-locations
9785 The maximum number of memory locations cselib should take into account.
9786 Increasing values mean more aggressive optimization, making the compilation time
9787 increase with probably slightly better performance.  The default value is 500.
9789 @item max-sched-ready-insns
9790 The maximum number of instructions ready to be issued the scheduler should
9791 consider at any given time during the first scheduling pass.  Increasing
9792 values mean more thorough searches, making the compilation time increase
9793 with probably little benefit.  The default value is 100.
9795 @item max-sched-region-blocks
9796 The maximum number of blocks in a region to be considered for
9797 interblock scheduling.  The default value is 10.
9799 @item max-pipeline-region-blocks
9800 The maximum number of blocks in a region to be considered for
9801 pipelining in the selective scheduler.  The default value is 15.
9803 @item max-sched-region-insns
9804 The maximum number of insns in a region to be considered for
9805 interblock scheduling.  The default value is 100.
9807 @item max-pipeline-region-insns
9808 The maximum number of insns in a region to be considered for
9809 pipelining in the selective scheduler.  The default value is 200.
9811 @item min-spec-prob
9812 The minimum probability (in percents) of reaching a source block
9813 for interblock speculative scheduling.  The default value is 40.
9815 @item max-sched-extend-regions-iters
9816 The maximum number of iterations through CFG to extend regions.
9817 A value of 0 (the default) disables region extensions.
9819 @item max-sched-insn-conflict-delay
9820 The maximum conflict delay for an insn to be considered for speculative motion.
9821 The default value is 3.
9823 @item sched-spec-prob-cutoff
9824 The minimal probability of speculation success (in percents), so that
9825 speculative insns are scheduled.
9826 The default value is 40.
9828 @item sched-state-edge-prob-cutoff
9829 The minimum probability an edge must have for the scheduler to save its
9830 state across it.
9831 The default value is 10.
9833 @item sched-mem-true-dep-cost
9834 Minimal distance (in CPU cycles) between store and load targeting same
9835 memory locations.  The default value is 1.
9837 @item selsched-max-lookahead
9838 The maximum size of the lookahead window of selective scheduling.  It is a
9839 depth of search for available instructions.
9840 The default value is 50.
9842 @item selsched-max-sched-times
9843 The maximum number of times that an instruction is scheduled during
9844 selective scheduling.  This is the limit on the number of iterations
9845 through which the instruction may be pipelined.  The default value is 2.
9847 @item selsched-insns-to-rename
9848 The maximum number of best instructions in the ready list that are considered
9849 for renaming in the selective scheduler.  The default value is 2.
9851 @item sms-min-sc
9852 The minimum value of stage count that swing modulo scheduler
9853 generates.  The default value is 2.
9855 @item max-last-value-rtl
9856 The maximum size measured as number of RTLs that can be recorded in an expression
9857 in combiner for a pseudo register as last known value of that register.  The default
9858 is 10000.
9860 @item max-combine-insns
9861 The maximum number of instructions the RTL combiner tries to combine.
9862 The default value is 2 at @option{-Og} and 4 otherwise.
9864 @item integer-share-limit
9865 Small integer constants can use a shared data structure, reducing the
9866 compiler's memory usage and increasing its speed.  This sets the maximum
9867 value of a shared integer constant.  The default value is 256.
9869 @item ssp-buffer-size
9870 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9871 protection when @option{-fstack-protection} is used.
9873 @item min-size-for-stack-sharing
9874 The minimum size of variables taking part in stack slot sharing when not
9875 optimizing. The default value is 32.
9877 @item max-jump-thread-duplication-stmts
9878 Maximum number of statements allowed in a block that needs to be
9879 duplicated when threading jumps.
9881 @item max-fields-for-field-sensitive
9882 Maximum number of fields in a structure treated in
9883 a field sensitive manner during pointer analysis.  The default is zero
9884 for @option{-O0} and @option{-O1},
9885 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9887 @item prefetch-latency
9888 Estimate on average number of instructions that are executed before
9889 prefetch finishes.  The distance prefetched ahead is proportional
9890 to this constant.  Increasing this number may also lead to less
9891 streams being prefetched (see @option{simultaneous-prefetches}).
9893 @item simultaneous-prefetches
9894 Maximum number of prefetches that can run at the same time.
9896 @item l1-cache-line-size
9897 The size of cache line in L1 cache, in bytes.
9899 @item l1-cache-size
9900 The size of L1 cache, in kilobytes.
9902 @item l2-cache-size
9903 The size of L2 cache, in kilobytes.
9905 @item min-insn-to-prefetch-ratio
9906 The minimum ratio between the number of instructions and the
9907 number of prefetches to enable prefetching in a loop.
9909 @item prefetch-min-insn-to-mem-ratio
9910 The minimum ratio between the number of instructions and the
9911 number of memory references to enable prefetching in a loop.
9913 @item use-canonical-types
9914 Whether the compiler should use the ``canonical'' type system.  By
9915 default, this should always be 1, which uses a more efficient internal
9916 mechanism for comparing types in C++ and Objective-C++.  However, if
9917 bugs in the canonical type system are causing compilation failures,
9918 set this value to 0 to disable canonical types.
9920 @item switch-conversion-max-branch-ratio
9921 Switch initialization conversion refuses to create arrays that are
9922 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9923 branches in the switch.
9925 @item max-partial-antic-length
9926 Maximum length of the partial antic set computed during the tree
9927 partial redundancy elimination optimization (@option{-ftree-pre}) when
9928 optimizing at @option{-O3} and above.  For some sorts of source code
9929 the enhanced partial redundancy elimination optimization can run away,
9930 consuming all of the memory available on the host machine.  This
9931 parameter sets a limit on the length of the sets that are computed,
9932 which prevents the runaway behavior.  Setting a value of 0 for
9933 this parameter allows an unlimited set length.
9935 @item sccvn-max-scc-size
9936 Maximum size of a strongly connected component (SCC) during SCCVN
9937 processing.  If this limit is hit, SCCVN processing for the whole
9938 function is not done and optimizations depending on it are
9939 disabled.  The default maximum SCC size is 10000.
9941 @item sccvn-max-alias-queries-per-access
9942 Maximum number of alias-oracle queries we perform when looking for
9943 redundancies for loads and stores.  If this limit is hit the search
9944 is aborted and the load or store is not considered redundant.  The
9945 number of queries is algorithmically limited to the number of
9946 stores on all paths from the load to the function entry.
9947 The default maximum number of queries is 1000.
9949 @item ira-max-loops-num
9950 IRA uses regional register allocation by default.  If a function
9951 contains more loops than the number given by this parameter, only at most
9952 the given number of the most frequently-executed loops form regions
9953 for regional register allocation.  The default value of the
9954 parameter is 100.
9956 @item ira-max-conflict-table-size 
9957 Although IRA uses a sophisticated algorithm to compress the conflict
9958 table, the table can still require excessive amounts of memory for
9959 huge functions.  If the conflict table for a function could be more
9960 than the size in MB given by this parameter, the register allocator
9961 instead uses a faster, simpler, and lower-quality
9962 algorithm that does not require building a pseudo-register conflict table.  
9963 The default value of the parameter is 2000.
9965 @item ira-loop-reserved-regs
9966 IRA can be used to evaluate more accurate register pressure in loops
9967 for decisions to move loop invariants (see @option{-O3}).  The number
9968 of available registers reserved for some other purposes is given
9969 by this parameter.  The default value of the parameter is 2, which is
9970 the minimal number of registers needed by typical instructions.
9971 This value is the best found from numerous experiments.
9973 @item lra-inheritance-ebb-probability-cutoff
9974 LRA tries to reuse values reloaded in registers in subsequent insns.
9975 This optimization is called inheritance.  EBB is used as a region to
9976 do this optimization.  The parameter defines a minimal fall-through
9977 edge probability in percentage used to add BB to inheritance EBB in
9978 LRA.  The default value of the parameter is 40.  The value was chosen
9979 from numerous runs of SPEC2000 on x86-64.
9981 @item loop-invariant-max-bbs-in-loop
9982 Loop invariant motion can be very expensive, both in compilation time and
9983 in amount of needed compile-time memory, with very large loops.  Loops
9984 with more basic blocks than this parameter won't have loop invariant
9985 motion optimization performed on them.  The default value of the
9986 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9988 @item loop-max-datarefs-for-datadeps
9989 Building data dependencies is expensive for very large loops.  This
9990 parameter limits the number of data references in loops that are
9991 considered for data dependence analysis.  These large loops are no
9992 handled by the optimizations using loop data dependencies.
9993 The default value is 1000.
9995 @item max-vartrack-size
9996 Sets a maximum number of hash table slots to use during variable
9997 tracking dataflow analysis of any function.  If this limit is exceeded
9998 with variable tracking at assignments enabled, analysis for that
9999 function is retried without it, after removing all debug insns from
10000 the function.  If the limit is exceeded even without debug insns, var
10001 tracking analysis is completely disabled for the function.  Setting
10002 the parameter to zero makes it unlimited.
10004 @item max-vartrack-expr-depth
10005 Sets a maximum number of recursion levels when attempting to map
10006 variable names or debug temporaries to value expressions.  This trades
10007 compilation time for more complete debug information.  If this is set too
10008 low, value expressions that are available and could be represented in
10009 debug information may end up not being used; setting this higher may
10010 enable the compiler to find more complex debug expressions, but compile
10011 time and memory use may grow.  The default is 12.
10013 @item min-nondebug-insn-uid
10014 Use uids starting at this parameter for nondebug insns.  The range below
10015 the parameter is reserved exclusively for debug insns created by
10016 @option{-fvar-tracking-assignments}, but debug insns may get
10017 (non-overlapping) uids above it if the reserved range is exhausted.
10019 @item ipa-sra-ptr-growth-factor
10020 IPA-SRA replaces a pointer to an aggregate with one or more new
10021 parameters only when their cumulative size is less or equal to
10022 @option{ipa-sra-ptr-growth-factor} times the size of the original
10023 pointer parameter.
10025 @item sra-max-scalarization-size-Ospeed
10026 @item sra-max-scalarization-size-Osize
10027 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10028 replace scalar parts of aggregates with uses of independent scalar
10029 variables.  These parameters control the maximum size, in storage units,
10030 of aggregate which is considered for replacement when compiling for
10031 speed
10032 (@option{sra-max-scalarization-size-Ospeed}) or size
10033 (@option{sra-max-scalarization-size-Osize}) respectively.
10035 @item tm-max-aggregate-size
10036 When making copies of thread-local variables in a transaction, this
10037 parameter specifies the size in bytes after which variables are
10038 saved with the logging functions as opposed to save/restore code
10039 sequence pairs.  This option only applies when using
10040 @option{-fgnu-tm}.
10042 @item graphite-max-nb-scop-params
10043 To avoid exponential effects in the Graphite loop transforms, the
10044 number of parameters in a Static Control Part (SCoP) is bounded.  The
10045 default value is 10 parameters.  A variable whose value is unknown at
10046 compilation time and defined outside a SCoP is a parameter of the SCoP.
10048 @item graphite-max-bbs-per-function
10049 To avoid exponential effects in the detection of SCoPs, the size of
10050 the functions analyzed by Graphite is bounded.  The default value is
10051 100 basic blocks.
10053 @item loop-block-tile-size
10054 Loop blocking or strip mining transforms, enabled with
10055 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10056 loop in the loop nest by a given number of iterations.  The strip
10057 length can be changed using the @option{loop-block-tile-size}
10058 parameter.  The default value is 51 iterations.
10060 @item loop-unroll-jam-size
10061 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10062 default value is 4.
10064 @item loop-unroll-jam-depth
10065 Specify the dimension to be unrolled (counting from the most inner loop)
10066 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10068 @item ipa-cp-value-list-size
10069 IPA-CP attempts to track all possible values and types passed to a function's
10070 parameter in order to propagate them and perform devirtualization.
10071 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10072 stores per one formal parameter of a function.
10074 @item ipa-cp-eval-threshold
10075 IPA-CP calculates its own score of cloning profitability heuristics
10076 and performs those cloning opportunities with scores that exceed
10077 @option{ipa-cp-eval-threshold}.
10079 @item ipa-cp-recursion-penalty
10080 Percentage penalty the recursive functions will receive when they
10081 are evaluated for cloning.
10083 @item ipa-cp-single-call-penalty
10084 Percentage penalty functions containg a single call to another
10085 function will receive when they are evaluated for cloning.
10088 @item ipa-max-agg-items
10089 IPA-CP is also capable to propagate a number of scalar values passed
10090 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10091 number of such values per one parameter.
10093 @item ipa-cp-loop-hint-bonus
10094 When IPA-CP determines that a cloning candidate would make the number
10095 of iterations of a loop known, it adds a bonus of
10096 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10097 the candidate.
10099 @item ipa-cp-array-index-hint-bonus
10100 When IPA-CP determines that a cloning candidate would make the index of
10101 an array access known, it adds a bonus of
10102 @option{ipa-cp-array-index-hint-bonus} to the profitability
10103 score of the candidate.
10105 @item ipa-max-aa-steps
10106 During its analysis of function bodies, IPA-CP employs alias analysis
10107 in order to track values pointed to by function parameters.  In order
10108 not spend too much time analyzing huge functions, it gives up and
10109 consider all memory clobbered after examining
10110 @option{ipa-max-aa-steps} statements modifying memory.
10112 @item lto-partitions
10113 Specify desired number of partitions produced during WHOPR compilation.
10114 The number of partitions should exceed the number of CPUs used for compilation.
10115 The default value is 32.
10117 @item lto-min-partition
10118 Size of minimal partition for WHOPR (in estimated instructions).
10119 This prevents expenses of splitting very small programs into too many
10120 partitions.
10122 @item lto-max-partition
10123 Size of max partition for WHOPR (in estimated instructions).
10124 to provide an upper bound for individual size of partition.
10125 Meant to be used only with balanced partitioning.
10127 @item cxx-max-namespaces-for-diagnostic-help
10128 The maximum number of namespaces to consult for suggestions when C++
10129 name lookup fails for an identifier.  The default is 1000.
10131 @item sink-frequency-threshold
10132 The maximum relative execution frequency (in percents) of the target block
10133 relative to a statement's original block to allow statement sinking of a
10134 statement.  Larger numbers result in more aggressive statement sinking.
10135 The default value is 75.  A small positive adjustment is applied for
10136 statements with memory operands as those are even more profitable so sink.
10138 @item max-stores-to-sink
10139 The maximum number of conditional store pairs that can be sunk.  Set to 0
10140 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10141 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10143 @item allow-store-data-races
10144 Allow optimizers to introduce new data races on stores.
10145 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10146 at optimization level @option{-Ofast}.
10148 @item case-values-threshold
10149 The smallest number of different values for which it is best to use a
10150 jump-table instead of a tree of conditional branches.  If the value is
10151 0, use the default for the machine.  The default is 0.
10153 @item tree-reassoc-width
10154 Set the maximum number of instructions executed in parallel in
10155 reassociated tree. This parameter overrides target dependent
10156 heuristics used by default if has non zero value.
10158 @item sched-pressure-algorithm
10159 Choose between the two available implementations of
10160 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10161 and is the more likely to prevent instructions from being reordered.
10162 Algorithm 2 was designed to be a compromise between the relatively
10163 conservative approach taken by algorithm 1 and the rather aggressive
10164 approach taken by the default scheduler.  It relies more heavily on
10165 having a regular register file and accurate register pressure classes.
10166 See @file{haifa-sched.c} in the GCC sources for more details.
10168 The default choice depends on the target.
10170 @item max-slsr-cand-scan
10171 Set the maximum number of existing candidates that are considered when
10172 seeking a basis for a new straight-line strength reduction candidate.
10174 @item asan-globals
10175 Enable buffer overflow detection for global objects.  This kind
10176 of protection is enabled by default if you are using
10177 @option{-fsanitize=address} option.
10178 To disable global objects protection use @option{--param asan-globals=0}.
10180 @item asan-stack
10181 Enable buffer overflow detection for stack objects.  This kind of
10182 protection is enabled by default when using @option{-fsanitize=address}.
10183 To disable stack protection use @option{--param asan-stack=0} option.
10185 @item asan-instrument-reads
10186 Enable buffer overflow detection for memory reads.  This kind of
10187 protection is enabled by default when using @option{-fsanitize=address}.
10188 To disable memory reads protection use
10189 @option{--param asan-instrument-reads=0}.
10191 @item asan-instrument-writes
10192 Enable buffer overflow detection for memory writes.  This kind of
10193 protection is enabled by default when using @option{-fsanitize=address}.
10194 To disable memory writes protection use
10195 @option{--param asan-instrument-writes=0} option.
10197 @item asan-memintrin
10198 Enable detection for built-in functions.  This kind of protection
10199 is enabled by default when using @option{-fsanitize=address}.
10200 To disable built-in functions protection use
10201 @option{--param asan-memintrin=0}.
10203 @item asan-use-after-return
10204 Enable detection of use-after-return.  This kind of protection
10205 is enabled by default when using @option{-fsanitize=address} option.
10206 To disable use-after-return detection use 
10207 @option{--param asan-use-after-return=0}.
10209 Note: The check is disabled by default at runtime.  To enable the check,
10210 you should set environment variable @env{ASAN_OPTIONS} to
10211 @code{detect_stack_use_after_return=1}.
10213 @item asan-instrumentation-with-call-threshold
10214 If number of memory accesses in function being instrumented
10215 is greater or equal to this number, use callbacks instead of inline checks.
10216 E.g. to disable inline code use
10217 @option{--param asan-instrumentation-with-call-threshold=0}.
10219 @item chkp-max-ctor-size
10220 Static constructors generated by Pointer Bounds Checker may become very
10221 large and significantly increase compile time at optimization level
10222 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10223 in a single generated constructor.  Default value is 5000.
10225 @item max-fsm-thread-path-insns
10226 Maximum number of instructions to copy when duplicating blocks on a
10227 finite state automaton jump thread path.  The default is 100.
10229 @item max-fsm-thread-length
10230 Maximum number of basic blocks on a finite state automaton jump thread
10231 path.  The default is 10.
10233 @item max-fsm-thread-paths
10234 Maximum number of new jump thread paths to create for a finite state
10235 automaton.  The default is 50.
10237 @item parloops-chunk-size
10238 Chunk size of omp schedule for loops parallelized by parloops.  The default
10239 is 0.
10241 @item parloops-schedule
10242 Schedule type of omp schedule for loops parallelized by parloops (static,
10243 dynamic, guided, auto, runtime).  The default is static.
10245 @item max-ssa-name-query-depth
10246 Maximum depth of recursion when querying properties of SSA names in things
10247 like fold routines.  One level of recursion corresponds to following a
10248 use-def chain.
10250 @item hsa-gen-debug-stores
10251 Enable emission of special debug stores within HSA kernels which are
10252 then read and reported by libgomp plugin.  Generation of these stores
10253 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10254 enable it.
10256 @item max-speculative-devirt-maydefs
10257 The maximum number of may-defs we analyze when looking for a must-def
10258 specifying the dynamic type of an object that invokes a virtual call
10259 we may be able to devirtualize speculatively.
10261 @item max-vrp-switch-assertions
10262 The maximum number of assertions to add along the default edge of a switch
10263 statement during VRP.  The default is 10.
10264 @end table
10265 @end table
10267 @node Instrumentation Options
10268 @section Program Instrumentation Options
10269 @cindex instrumentation options
10270 @cindex program instrumentation options
10271 @cindex run-time error checking options
10272 @cindex profiling options
10273 @cindex options, program instrumentation
10274 @cindex options, run-time error checking
10275 @cindex options, profiling
10277 GCC supports a number of command-line options that control adding
10278 run-time instrumentation to the code it normally generates.  
10279 For example, one purpose of instrumentation is collect profiling
10280 statistics for use in finding program hot spots, code coverage
10281 analysis, or profile-guided optimizations.
10282 Another class of program instrumentation is adding run-time checking 
10283 to detect programming errors like invalid pointer
10284 dereferences or out-of-bounds array accesses, as well as deliberately
10285 hostile attacks such as stack smashing or C++ vtable hijacking.
10286 There is also a general hook which can be used to implement other
10287 forms of tracing or function-level instrumentation for debug or
10288 program analysis purposes.
10290 @table @gcctabopt
10291 @cindex @command{prof}
10292 @item -p
10293 @opindex p
10294 Generate extra code to write profile information suitable for the
10295 analysis program @command{prof}.  You must use this option when compiling
10296 the source files you want data about, and you must also use it when
10297 linking.
10299 @cindex @command{gprof}
10300 @item -pg
10301 @opindex pg
10302 Generate extra code to write profile information suitable for the
10303 analysis program @command{gprof}.  You must use this option when compiling
10304 the source files you want data about, and you must also use it when
10305 linking.
10307 @item -fprofile-arcs
10308 @opindex fprofile-arcs
10309 Add code so that program flow @dfn{arcs} are instrumented.  During
10310 execution the program records how many times each branch and call is
10311 executed and how many times it is taken or returns.  When the compiled
10312 program exits it saves this data to a file called
10313 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10314 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10315 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10316 @var{auxname} is generated from the name of the output file, if
10317 explicitly specified and it is not the final executable, otherwise it is
10318 the basename of the source file.  In both cases any suffix is removed
10319 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10320 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10321 @xref{Cross-profiling}.
10323 @cindex @command{gcov}
10324 @item --coverage
10325 @opindex coverage
10327 This option is used to compile and link code instrumented for coverage
10328 analysis.  The option is a synonym for @option{-fprofile-arcs}
10329 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10330 linking).  See the documentation for those options for more details.
10332 @itemize
10334 @item
10335 Compile the source files with @option{-fprofile-arcs} plus optimization
10336 and code generation options.  For test coverage analysis, use the
10337 additional @option{-ftest-coverage} option.  You do not need to profile
10338 every source file in a program.
10340 @item
10341 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10342 (the latter implies the former).
10344 @item
10345 Run the program on a representative workload to generate the arc profile
10346 information.  This may be repeated any number of times.  You can run
10347 concurrent instances of your program, and provided that the file system
10348 supports locking, the data files will be correctly updated.  Also
10349 @code{fork} calls are detected and correctly handled (double counting
10350 will not happen).
10352 @item
10353 For profile-directed optimizations, compile the source files again with
10354 the same optimization and code generation options plus
10355 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10356 Control Optimization}).
10358 @item
10359 For test coverage analysis, use @command{gcov} to produce human readable
10360 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10361 @command{gcov} documentation for further information.
10363 @end itemize
10365 With @option{-fprofile-arcs}, for each function of your program GCC
10366 creates a program flow graph, then finds a spanning tree for the graph.
10367 Only arcs that are not on the spanning tree have to be instrumented: the
10368 compiler adds code to count the number of times that these arcs are
10369 executed.  When an arc is the only exit or only entrance to a block, the
10370 instrumentation code can be added to the block; otherwise, a new basic
10371 block must be created to hold the instrumentation code.
10373 @need 2000
10374 @item -ftest-coverage
10375 @opindex ftest-coverage
10376 Produce a notes file that the @command{gcov} code-coverage utility
10377 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10378 show program coverage.  Each source file's note file is called
10379 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10380 above for a description of @var{auxname} and instructions on how to
10381 generate test coverage data.  Coverage data matches the source files
10382 more closely if you do not optimize.
10384 @item -fprofile-dir=@var{path}
10385 @opindex fprofile-dir
10387 Set the directory to search for the profile data files in to @var{path}.
10388 This option affects only the profile data generated by
10389 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10390 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10391 and its related options.  Both absolute and relative paths can be used.
10392 By default, GCC uses the current directory as @var{path}, thus the
10393 profile data file appears in the same directory as the object file.
10395 @item -fprofile-generate
10396 @itemx -fprofile-generate=@var{path}
10397 @opindex fprofile-generate
10399 Enable options usually used for instrumenting application to produce
10400 profile useful for later recompilation with profile feedback based
10401 optimization.  You must use @option{-fprofile-generate} both when
10402 compiling and when linking your program.
10404 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10406 If @var{path} is specified, GCC looks at the @var{path} to find
10407 the profile feedback data files. See @option{-fprofile-dir}.
10409 To optimize the program based on the collected profile information, use
10410 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10412 @item -fprofile-update=@var{method}
10413 @opindex fprofile-update
10415 Alter the update method for an application instrumented for profile
10416 feedback based optimization.  The @var{method} argument should be one of
10417 @samp{single} or @samp{atomic}.  The first one is useful for single-threaded
10418 applications, while the second one prevents profile corruption by emitting
10419 thread-safe code.
10421 @strong{Warning:} When an application does not properly join all threads
10422 (or creates an detached thread), a profile file can be still corrupted.
10424 @item -fsanitize=address
10425 @opindex fsanitize=address
10426 Enable AddressSanitizer, a fast memory error detector.
10427 Memory access instructions are instrumented to detect
10428 out-of-bounds and use-after-free bugs.
10429 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10430 more details.  The run-time behavior can be influenced using the
10431 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10432 the available options are shown at startup of the instrumented program.  See
10433 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10434 for a list of supported options.
10435 The option can't be combined with @option{-fsanitize=thread}.
10437 @item -fsanitize=kernel-address
10438 @opindex fsanitize=kernel-address
10439 Enable AddressSanitizer for Linux kernel.
10440 See @uref{https://github.com/google/kasan/wiki} for more details.
10442 @item -fsanitize=thread
10443 @opindex fsanitize=thread
10444 Enable ThreadSanitizer, a fast data race detector.
10445 Memory access instructions are instrumented to detect
10446 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10447 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10448 environment variable; see
10449 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10450 supported options.
10451 The option can't be combined with @option{-fsanitize=address}
10452 and/or @option{-fsanitize=leak}.
10454 @item -fsanitize=leak
10455 @opindex fsanitize=leak
10456 Enable LeakSanitizer, a memory leak detector.
10457 This option only matters for linking of executables and
10458 the executable is linked against a library that overrides @code{malloc}
10459 and other allocator functions.  See
10460 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10461 details.  The run-time behavior can be influenced using the
10462 @env{LSAN_OPTIONS} environment variable.
10463 The option can't be combined with @option{-fsanitize=thread}.
10465 @item -fsanitize=undefined
10466 @opindex fsanitize=undefined
10467 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10468 Various computations are instrumented to detect undefined behavior
10469 at runtime.  Current suboptions are:
10471 @table @gcctabopt
10473 @item -fsanitize=shift
10474 @opindex fsanitize=shift
10475 This option enables checking that the result of a shift operation is
10476 not undefined.  Note that what exactly is considered undefined differs
10477 slightly between C and C++, as well as between ISO C90 and C99, etc.
10479 @item -fsanitize=integer-divide-by-zero
10480 @opindex fsanitize=integer-divide-by-zero
10481 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10483 @item -fsanitize=unreachable
10484 @opindex fsanitize=unreachable
10485 With this option, the compiler turns the @code{__builtin_unreachable}
10486 call into a diagnostics message call instead.  When reaching the
10487 @code{__builtin_unreachable} call, the behavior is undefined.
10489 @item -fsanitize=vla-bound
10490 @opindex fsanitize=vla-bound
10491 This option instructs the compiler to check that the size of a variable
10492 length array is positive.
10494 @item -fsanitize=null
10495 @opindex fsanitize=null
10496 This option enables pointer checking.  Particularly, the application
10497 built with this option turned on will issue an error message when it
10498 tries to dereference a NULL pointer, or if a reference (possibly an
10499 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10500 on an object pointed by a NULL pointer.
10502 @item -fsanitize=return
10503 @opindex fsanitize=return
10504 This option enables return statement checking.  Programs
10505 built with this option turned on will issue an error message
10506 when the end of a non-void function is reached without actually
10507 returning a value.  This option works in C++ only.
10509 @item -fsanitize=signed-integer-overflow
10510 @opindex fsanitize=signed-integer-overflow
10511 This option enables signed integer overflow checking.  We check that
10512 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10513 does not overflow in the signed arithmetics.  Note, integer promotion
10514 rules must be taken into account.  That is, the following is not an
10515 overflow:
10516 @smallexample
10517 signed char a = SCHAR_MAX;
10518 a++;
10519 @end smallexample
10521 @item -fsanitize=bounds
10522 @opindex fsanitize=bounds
10523 This option enables instrumentation of array bounds.  Various out of bounds
10524 accesses are detected.  Flexible array members, flexible array member-like
10525 arrays, and initializers of variables with static storage are not instrumented.
10527 @item -fsanitize=bounds-strict
10528 @opindex fsanitize=bounds-strict
10529 This option enables strict instrumentation of array bounds.  Most out of bounds
10530 accesses are detected, including flexible array members and flexible array
10531 member-like arrays.  Initializers of variables with static storage are not
10532 instrumented.
10534 @item -fsanitize=alignment
10535 @opindex fsanitize=alignment
10537 This option enables checking of alignment of pointers when they are
10538 dereferenced, or when a reference is bound to insufficiently aligned target,
10539 or when a method or constructor is invoked on insufficiently aligned object.
10541 @item -fsanitize=object-size
10542 @opindex fsanitize=object-size
10543 This option enables instrumentation of memory references using the
10544 @code{__builtin_object_size} function.  Various out of bounds pointer
10545 accesses are detected.
10547 @item -fsanitize=float-divide-by-zero
10548 @opindex fsanitize=float-divide-by-zero
10549 Detect floating-point division by zero.  Unlike other similar options,
10550 @option{-fsanitize=float-divide-by-zero} is not enabled by
10551 @option{-fsanitize=undefined}, since floating-point division by zero can
10552 be a legitimate way of obtaining infinities and NaNs.
10554 @item -fsanitize=float-cast-overflow
10555 @opindex fsanitize=float-cast-overflow
10556 This option enables floating-point type to integer conversion checking.
10557 We check that the result of the conversion does not overflow.
10558 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10559 not enabled by @option{-fsanitize=undefined}.
10560 This option does not work well with @code{FE_INVALID} exceptions enabled.
10562 @item -fsanitize=nonnull-attribute
10563 @opindex fsanitize=nonnull-attribute
10565 This option enables instrumentation of calls, checking whether null values
10566 are not passed to arguments marked as requiring a non-null value by the
10567 @code{nonnull} function attribute.
10569 @item -fsanitize=returns-nonnull-attribute
10570 @opindex fsanitize=returns-nonnull-attribute
10572 This option enables instrumentation of return statements in functions
10573 marked with @code{returns_nonnull} function attribute, to detect returning
10574 of null values from such functions.
10576 @item -fsanitize=bool
10577 @opindex fsanitize=bool
10579 This option enables instrumentation of loads from bool.  If a value other
10580 than 0/1 is loaded, a run-time error is issued.
10582 @item -fsanitize=enum
10583 @opindex fsanitize=enum
10585 This option enables instrumentation of loads from an enum type.  If
10586 a value outside the range of values for the enum type is loaded,
10587 a run-time error is issued.
10589 @item -fsanitize=vptr
10590 @opindex fsanitize=vptr
10592 This option enables instrumentation of C++ member function calls, member
10593 accesses and some conversions between pointers to base and derived classes,
10594 to verify the referenced object has the correct dynamic type.
10596 @end table
10598 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10599 @option{-fsanitize=undefined} gives a diagnostic message.
10600 This currently works only for the C family of languages.
10602 @item -fno-sanitize=all
10603 @opindex fno-sanitize=all
10605 This option disables all previously enabled sanitizers.
10606 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10607 together.
10609 @item -fasan-shadow-offset=@var{number}
10610 @opindex fasan-shadow-offset
10611 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10612 It is useful for experimenting with different shadow memory layouts in
10613 Kernel AddressSanitizer.
10615 @item -fsanitize-sections=@var{s1},@var{s2},...
10616 @opindex fsanitize-sections
10617 Sanitize global variables in selected user-defined sections.  @var{si} may
10618 contain wildcards.
10620 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10621 @opindex fsanitize-recover
10622 @opindex fno-sanitize-recover
10623 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10624 mentioned in comma-separated list of @var{opts}.  Enabling this option
10625 for a sanitizer component causes it to attempt to continue
10626 running the program as if no error happened.  This means multiple
10627 runtime errors can be reported in a single program run, and the exit
10628 code of the program may indicate success even when errors
10629 have been reported.  The @option{-fno-sanitize-recover=} option
10630 can be used to alter
10631 this behavior: only the first detected error is reported
10632 and program then exits with a non-zero exit code.
10634 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10635 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10636 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10637 @option{-fsanitize=bounds-strict},
10638 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10639 For these sanitizers error recovery is turned on by default, except @option{-fsanitize=address},
10640 for which this feature is experimental.
10641 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10642 accepted, the former enables recovery for all sanitizers that support it,
10643 the latter disables recovery for all sanitizers that support it.
10645 Even if a recovery mode is turned on the compiler side, it needs to be also
10646 enabled on the runtime library side, otherwise the failures are still fatal.
10647 The runtime library defaults to @code{halt_on_error=0} for
10648 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10649 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10650 setting the @code{halt_on_error} flag in the corresponding environment variable.
10652 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
10653 @smallexample
10654 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10655 @end smallexample
10656 @noindent
10657 Similarly @option{-fno-sanitize-recover} is equivalent to
10658 @smallexample
10659 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10660 @end smallexample
10662 @item -fsanitize-undefined-trap-on-error
10663 @opindex fsanitize-undefined-trap-on-error
10664 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10665 report undefined behavior using @code{__builtin_trap} rather than
10666 a @code{libubsan} library routine.  The advantage of this is that the
10667 @code{libubsan} library is not needed and is not linked in, so this
10668 is usable even in freestanding environments.
10670 @item -fsanitize-coverage=trace-pc
10671 @opindex fsanitize-coverage=trace-pc
10672 Enable coverage-guided fuzzing code instrumentation.
10673 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10675 @item -fbounds-check
10676 @opindex fbounds-check
10677 For front ends that support it, generate additional code to check that
10678 indices used to access arrays are within the declared range.  This is
10679 currently only supported by the Java and Fortran front ends, where
10680 this option defaults to true and false respectively.
10682 @item -fcheck-pointer-bounds
10683 @opindex fcheck-pointer-bounds
10684 @opindex fno-check-pointer-bounds
10685 @cindex Pointer Bounds Checker options
10686 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10687 is instrumented with checks of the pointer used for memory access against
10688 bounds associated with that pointer.  
10690 Currently there
10691 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
10692 and @option{-mmpx} are required to enable this feature.  
10693 MPX-based instrumentation requires
10694 a runtime library to enable MPX in hardware and handle bounds
10695 violation signals.  By default when @option{-fcheck-pointer-bounds}
10696 and @option{-mmpx} options are used to link a program, the GCC driver
10697 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
10698 Bounds checking on calls to dynamic libraries requires a linker
10699 with @option{-z bndplt} support; if GCC was configured with a linker
10700 without support for this option (including the Gold linker and older
10701 versions of ld), a warning is given if you link with @option{-mmpx}
10702 without also specifying @option{-static}, since the overall effectiveness
10703 of the bounds checking protection is reduced.
10704 See also @option{-static-libmpxwrappers}.
10706 MPX-based instrumentation
10707 may be used for debugging and also may be included in production code
10708 to increase program security.  Depending on usage, you may
10709 have different requirements for the runtime library.  The current version
10710 of the MPX runtime library is more oriented for use as a debugging
10711 tool.  MPX runtime library usage implies @option{-lpthread}.  See
10712 also @option{-static-libmpx}.  The runtime library  behavior can be
10713 influenced using various @env{CHKP_RT_*} environment variables.  See
10714 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
10715 for more details.
10717 Generated instrumentation may be controlled by various
10718 @option{-fchkp-*} options and by the @code{bnd_variable_size}
10719 structure field attribute (@pxref{Type Attributes}) and
10720 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
10721 (@pxref{Function Attributes}).  GCC also provides a number of built-in
10722 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
10723 Bounds Checker builtins}, for more information.
10725 @item -fchkp-check-incomplete-type
10726 @opindex fchkp-check-incomplete-type
10727 @opindex fno-chkp-check-incomplete-type
10728 Generate pointer bounds checks for variables with incomplete type.
10729 Enabled by default.
10731 @item -fchkp-narrow-bounds
10732 @opindex fchkp-narrow-bounds
10733 @opindex fno-chkp-narrow-bounds
10734 Controls bounds used by Pointer Bounds Checker for pointers to object
10735 fields.  If narrowing is enabled then field bounds are used.  Otherwise
10736 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
10737 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
10739 @item -fchkp-first-field-has-own-bounds
10740 @opindex fchkp-first-field-has-own-bounds
10741 @opindex fno-chkp-first-field-has-own-bounds
10742 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
10743 first field in the structure.  By default a pointer to the first field has
10744 the same bounds as a pointer to the whole structure.
10746 @item -fchkp-narrow-to-innermost-array
10747 @opindex fchkp-narrow-to-innermost-array
10748 @opindex fno-chkp-narrow-to-innermost-array
10749 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
10750 case of nested static array access.  By default this option is disabled and
10751 bounds of the outermost array are used.
10753 @item -fchkp-optimize
10754 @opindex fchkp-optimize
10755 @opindex fno-chkp-optimize
10756 Enables Pointer Bounds Checker optimizations.  Enabled by default at
10757 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
10759 @item -fchkp-use-fast-string-functions
10760 @opindex fchkp-use-fast-string-functions
10761 @opindex fno-chkp-use-fast-string-functions
10762 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
10763 by Pointer Bounds Checker.  Disabled by default.
10765 @item -fchkp-use-nochk-string-functions
10766 @opindex fchkp-use-nochk-string-functions
10767 @opindex fno-chkp-use-nochk-string-functions
10768 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
10769 by Pointer Bounds Checker.  Disabled by default.
10771 @item -fchkp-use-static-bounds
10772 @opindex fchkp-use-static-bounds
10773 @opindex fno-chkp-use-static-bounds
10774 Allow Pointer Bounds Checker to generate static bounds holding
10775 bounds of static variables.  Enabled by default.
10777 @item -fchkp-use-static-const-bounds
10778 @opindex fchkp-use-static-const-bounds
10779 @opindex fno-chkp-use-static-const-bounds
10780 Use statically-initialized bounds for constant bounds instead of
10781 generating them each time they are required.  By default enabled when
10782 @option{-fchkp-use-static-bounds} is enabled.
10784 @item -fchkp-treat-zero-dynamic-size-as-infinite
10785 @opindex fchkp-treat-zero-dynamic-size-as-infinite
10786 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
10787 With this option, objects with incomplete type whose
10788 dynamically-obtained size is zero are treated as having infinite size
10789 instead by Pointer Bounds
10790 Checker.  This option may be helpful if a program is linked with a library
10791 missing size information for some symbols.  Disabled by default.
10793 @item -fchkp-check-read
10794 @opindex fchkp-check-read
10795 @opindex fno-chkp-check-read
10796 Instructs Pointer Bounds Checker to generate checks for all read
10797 accesses to memory.  Enabled by default.
10799 @item -fchkp-check-write
10800 @opindex fchkp-check-write
10801 @opindex fno-chkp-check-write
10802 Instructs Pointer Bounds Checker to generate checks for all write
10803 accesses to memory.  Enabled by default.
10805 @item -fchkp-store-bounds
10806 @opindex fchkp-store-bounds
10807 @opindex fno-chkp-store-bounds
10808 Instructs Pointer Bounds Checker to generate bounds stores for
10809 pointer writes.  Enabled by default.
10811 @item -fchkp-instrument-calls
10812 @opindex fchkp-instrument-calls
10813 @opindex fno-chkp-instrument-calls
10814 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
10815 Enabled by default.
10817 @item -fchkp-instrument-marked-only
10818 @opindex fchkp-instrument-marked-only
10819 @opindex fno-chkp-instrument-marked-only
10820 Instructs Pointer Bounds Checker to instrument only functions
10821 marked with the @code{bnd_instrument} attribute
10822 (@pxref{Function Attributes}).  Disabled by default.
10824 @item -fchkp-use-wrappers
10825 @opindex fchkp-use-wrappers
10826 @opindex fno-chkp-use-wrappers
10827 Allows Pointer Bounds Checker to replace calls to built-in functions
10828 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
10829 is used to link a program, the GCC driver automatically links
10830 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
10831 Enabled by default.
10833 @item -fstack-protector
10834 @opindex fstack-protector
10835 Emit extra code to check for buffer overflows, such as stack smashing
10836 attacks.  This is done by adding a guard variable to functions with
10837 vulnerable objects.  This includes functions that call @code{alloca}, and
10838 functions with buffers larger than 8 bytes.  The guards are initialized
10839 when a function is entered and then checked when the function exits.
10840 If a guard check fails, an error message is printed and the program exits.
10842 @item -fstack-protector-all
10843 @opindex fstack-protector-all
10844 Like @option{-fstack-protector} except that all functions are protected.
10846 @item -fstack-protector-strong
10847 @opindex fstack-protector-strong
10848 Like @option{-fstack-protector} but includes additional functions to
10849 be protected --- those that have local array definitions, or have
10850 references to local frame addresses.
10852 @item -fstack-protector-explicit
10853 @opindex fstack-protector-explicit
10854 Like @option{-fstack-protector} but only protects those functions which
10855 have the @code{stack_protect} attribute.
10857 @item -fstack-check
10858 @opindex fstack-check
10859 Generate code to verify that you do not go beyond the boundary of the
10860 stack.  You should specify this flag if you are running in an
10861 environment with multiple threads, but you only rarely need to specify it in
10862 a single-threaded environment since stack overflow is automatically
10863 detected on nearly all systems if there is only one stack.
10865 Note that this switch does not actually cause checking to be done; the
10866 operating system or the language runtime must do that.  The switch causes
10867 generation of code to ensure that they see the stack being extended.
10869 You can additionally specify a string parameter: @samp{no} means no
10870 checking, @samp{generic} means force the use of old-style checking,
10871 @samp{specific} means use the best checking method and is equivalent
10872 to bare @option{-fstack-check}.
10874 Old-style checking is a generic mechanism that requires no specific
10875 target support in the compiler but comes with the following drawbacks:
10877 @enumerate
10878 @item
10879 Modified allocation strategy for large objects: they are always
10880 allocated dynamically if their size exceeds a fixed threshold.
10882 @item
10883 Fixed limit on the size of the static frame of functions: when it is
10884 topped by a particular function, stack checking is not reliable and
10885 a warning is issued by the compiler.
10887 @item
10888 Inefficiency: because of both the modified allocation strategy and the
10889 generic implementation, code performance is hampered.
10890 @end enumerate
10892 Note that old-style stack checking is also the fallback method for
10893 @samp{specific} if no target support has been added in the compiler.
10895 @item -fstack-limit-register=@var{reg}
10896 @itemx -fstack-limit-symbol=@var{sym}
10897 @itemx -fno-stack-limit
10898 @opindex fstack-limit-register
10899 @opindex fstack-limit-symbol
10900 @opindex fno-stack-limit
10901 Generate code to ensure that the stack does not grow beyond a certain value,
10902 either the value of a register or the address of a symbol.  If a larger
10903 stack is required, a signal is raised at run time.  For most targets,
10904 the signal is raised before the stack overruns the boundary, so
10905 it is possible to catch the signal without taking special precautions.
10907 For instance, if the stack starts at absolute address @samp{0x80000000}
10908 and grows downwards, you can use the flags
10909 @option{-fstack-limit-symbol=__stack_limit} and
10910 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10911 of 128KB@.  Note that this may only work with the GNU linker.
10913 You can locally override stack limit checking by using the
10914 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
10916 @item -fsplit-stack
10917 @opindex fsplit-stack
10918 Generate code to automatically split the stack before it overflows.
10919 The resulting program has a discontiguous stack which can only
10920 overflow if the program is unable to allocate any more memory.  This
10921 is most useful when running threaded programs, as it is no longer
10922 necessary to calculate a good stack size to use for each thread.  This
10923 is currently only implemented for the x86 targets running
10924 GNU/Linux.
10926 When code compiled with @option{-fsplit-stack} calls code compiled
10927 without @option{-fsplit-stack}, there may not be much stack space
10928 available for the latter code to run.  If compiling all code,
10929 including library code, with @option{-fsplit-stack} is not an option,
10930 then the linker can fix up these calls so that the code compiled
10931 without @option{-fsplit-stack} always has a large stack.  Support for
10932 this is implemented in the gold linker in GNU binutils release 2.21
10933 and later.
10935 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
10936 @opindex fvtable-verify
10937 This option is only available when compiling C++ code.
10938 It turns on (or off, if using @option{-fvtable-verify=none}) the security
10939 feature that verifies at run time, for every virtual call, that
10940 the vtable pointer through which the call is made is valid for the type of
10941 the object, and has not been corrupted or overwritten.  If an invalid vtable
10942 pointer is detected at run time, an error is reported and execution of the
10943 program is immediately halted.
10945 This option causes run-time data structures to be built at program startup,
10946 which are used for verifying the vtable pointers.  
10947 The options @samp{std} and @samp{preinit}
10948 control the timing of when these data structures are built.  In both cases the
10949 data structures are built before execution reaches @code{main}.  Using
10950 @option{-fvtable-verify=std} causes the data structures to be built after
10951 shared libraries have been loaded and initialized.
10952 @option{-fvtable-verify=preinit} causes them to be built before shared
10953 libraries have been loaded and initialized.
10955 If this option appears multiple times in the command line with different
10956 values specified, @samp{none} takes highest priority over both @samp{std} and
10957 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
10959 @item -fvtv-debug
10960 @opindex fvtv-debug
10961 When used in conjunction with @option{-fvtable-verify=std} or 
10962 @option{-fvtable-verify=preinit}, causes debug versions of the 
10963 runtime functions for the vtable verification feature to be called.  
10964 This flag also causes the compiler to log information about which 
10965 vtable pointers it finds for each class.
10966 This information is written to a file named @file{vtv_set_ptr_data.log} 
10967 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
10968 if that is defined or the current working directory otherwise.
10970 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
10971 file, be sure to delete any existing one.
10973 @item -fvtv-counts
10974 @opindex fvtv-counts
10975 This is a debugging flag.  When used in conjunction with
10976 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
10977 causes the compiler to keep track of the total number of virtual calls
10978 it encounters and the number of verifications it inserts.  It also
10979 counts the number of calls to certain run-time library functions
10980 that it inserts and logs this information for each compilation unit.
10981 The compiler writes this information to a file named
10982 @file{vtv_count_data.log} in the directory named by the environment
10983 variable @env{VTV_LOGS_DIR} if that is defined or the current working
10984 directory otherwise.  It also counts the size of the vtable pointer sets
10985 for each class, and writes this information to @file{vtv_class_set_sizes.log}
10986 in the same directory.
10988 Note:  This feature @emph{appends} data to the log files.  To get fresh log
10989 files, be sure to delete any existing ones.
10991 @item -finstrument-functions
10992 @opindex finstrument-functions
10993 Generate instrumentation calls for entry and exit to functions.  Just
10994 after function entry and just before function exit, the following
10995 profiling functions are called with the address of the current
10996 function and its call site.  (On some platforms,
10997 @code{__builtin_return_address} does not work beyond the current
10998 function, so the call site information may not be available to the
10999 profiling functions otherwise.)
11001 @smallexample
11002 void __cyg_profile_func_enter (void *this_fn,
11003                                void *call_site);
11004 void __cyg_profile_func_exit  (void *this_fn,
11005                                void *call_site);
11006 @end smallexample
11008 The first argument is the address of the start of the current function,
11009 which may be looked up exactly in the symbol table.
11011 This instrumentation is also done for functions expanded inline in other
11012 functions.  The profiling calls indicate where, conceptually, the
11013 inline function is entered and exited.  This means that addressable
11014 versions of such functions must be available.  If all your uses of a
11015 function are expanded inline, this may mean an additional expansion of
11016 code size.  If you use @code{extern inline} in your C code, an
11017 addressable version of such functions must be provided.  (This is
11018 normally the case anyway, but if you get lucky and the optimizer always
11019 expands the functions inline, you might have gotten away without
11020 providing static copies.)
11022 A function may be given the attribute @code{no_instrument_function}, in
11023 which case this instrumentation is not done.  This can be used, for
11024 example, for the profiling functions listed above, high-priority
11025 interrupt routines, and any functions from which the profiling functions
11026 cannot safely be called (perhaps signal handlers, if the profiling
11027 routines generate output or allocate memory).
11029 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11030 @opindex finstrument-functions-exclude-file-list
11032 Set the list of functions that are excluded from instrumentation (see
11033 the description of @option{-finstrument-functions}).  If the file that
11034 contains a function definition matches with one of @var{file}, then
11035 that function is not instrumented.  The match is done on substrings:
11036 if the @var{file} parameter is a substring of the file name, it is
11037 considered to be a match.
11039 For example:
11041 @smallexample
11042 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11043 @end smallexample
11045 @noindent
11046 excludes any inline function defined in files whose pathnames
11047 contain @file{/bits/stl} or @file{include/sys}.
11049 If, for some reason, you want to include letter @samp{,} in one of
11050 @var{sym}, write @samp{\,}. For example,
11051 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11052 (note the single quote surrounding the option).
11054 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11055 @opindex finstrument-functions-exclude-function-list
11057 This is similar to @option{-finstrument-functions-exclude-file-list},
11058 but this option sets the list of function names to be excluded from
11059 instrumentation.  The function name to be matched is its user-visible
11060 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11061 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11062 match is done on substrings: if the @var{sym} parameter is a substring
11063 of the function name, it is considered to be a match.  For C99 and C++
11064 extended identifiers, the function name must be given in UTF-8, not
11065 using universal character names.
11067 @end table
11070 @node Preprocessor Options
11071 @section Options Controlling the Preprocessor
11072 @cindex preprocessor options
11073 @cindex options, preprocessor
11075 These options control the C preprocessor, which is run on each C source
11076 file before actual compilation.
11078 If you use the @option{-E} option, nothing is done except preprocessing.
11079 Some of these options make sense only together with @option{-E} because
11080 they cause the preprocessor output to be unsuitable for actual
11081 compilation.
11083 @table @gcctabopt
11084 @item -Wp,@var{option}
11085 @opindex Wp
11086 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11087 and pass @var{option} directly through to the preprocessor.  If
11088 @var{option} contains commas, it is split into multiple options at the
11089 commas.  However, many options are modified, translated or interpreted
11090 by the compiler driver before being passed to the preprocessor, and
11091 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11092 interface is undocumented and subject to change, so whenever possible
11093 you should avoid using @option{-Wp} and let the driver handle the
11094 options instead.
11096 @item -Xpreprocessor @var{option}
11097 @opindex Xpreprocessor
11098 Pass @var{option} as an option to the preprocessor.  You can use this to
11099 supply system-specific preprocessor options that GCC does not 
11100 recognize.
11102 If you want to pass an option that takes an argument, you must use
11103 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11105 @item -no-integrated-cpp
11106 @opindex no-integrated-cpp
11107 Perform preprocessing as a separate pass before compilation.
11108 By default, GCC performs preprocessing as an integrated part of
11109 input tokenization and parsing.
11110 If this option is provided, the appropriate language front end
11111 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11112 and Objective-C, respectively) is instead invoked twice,
11113 once for preprocessing only and once for actual compilation
11114 of the preprocessed input.
11115 This option may be useful in conjunction with the @option{-B} or
11116 @option{-wrapper} options to specify an alternate preprocessor or
11117 perform additional processing of the program source between
11118 normal preprocessing and compilation.
11119 @end table
11121 @include cppopts.texi
11123 @node Assembler Options
11124 @section Passing Options to the Assembler
11126 @c prevent bad page break with this line
11127 You can pass options to the assembler.
11129 @table @gcctabopt
11130 @item -Wa,@var{option}
11131 @opindex Wa
11132 Pass @var{option} as an option to the assembler.  If @var{option}
11133 contains commas, it is split into multiple options at the commas.
11135 @item -Xassembler @var{option}
11136 @opindex Xassembler
11137 Pass @var{option} as an option to the assembler.  You can use this to
11138 supply system-specific assembler options that GCC does not
11139 recognize.
11141 If you want to pass an option that takes an argument, you must use
11142 @option{-Xassembler} twice, once for the option and once for the argument.
11144 @end table
11146 @node Link Options
11147 @section Options for Linking
11148 @cindex link options
11149 @cindex options, linking
11151 These options come into play when the compiler links object files into
11152 an executable output file.  They are meaningless if the compiler is
11153 not doing a link step.
11155 @table @gcctabopt
11156 @cindex file names
11157 @item @var{object-file-name}
11158 A file name that does not end in a special recognized suffix is
11159 considered to name an object file or library.  (Object files are
11160 distinguished from libraries by the linker according to the file
11161 contents.)  If linking is done, these object files are used as input
11162 to the linker.
11164 @item -c
11165 @itemx -S
11166 @itemx -E
11167 @opindex c
11168 @opindex S
11169 @opindex E
11170 If any of these options is used, then the linker is not run, and
11171 object file names should not be used as arguments.  @xref{Overall
11172 Options}.
11174 @item -fuse-ld=bfd
11175 @opindex fuse-ld=bfd
11176 Use the @command{bfd} linker instead of the default linker.
11178 @item -fuse-ld=gold
11179 @opindex fuse-ld=gold
11180 Use the @command{gold} linker instead of the default linker.
11182 @cindex Libraries
11183 @item -l@var{library}
11184 @itemx -l @var{library}
11185 @opindex l
11186 Search the library named @var{library} when linking.  (The second
11187 alternative with the library as a separate argument is only for
11188 POSIX compliance and is not recommended.)
11190 It makes a difference where in the command you write this option; the
11191 linker searches and processes libraries and object files in the order they
11192 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11193 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11194 to functions in @samp{z}, those functions may not be loaded.
11196 The linker searches a standard list of directories for the library,
11197 which is actually a file named @file{lib@var{library}.a}.  The linker
11198 then uses this file as if it had been specified precisely by name.
11200 The directories searched include several standard system directories
11201 plus any that you specify with @option{-L}.
11203 Normally the files found this way are library files---archive files
11204 whose members are object files.  The linker handles an archive file by
11205 scanning through it for members which define symbols that have so far
11206 been referenced but not defined.  But if the file that is found is an
11207 ordinary object file, it is linked in the usual fashion.  The only
11208 difference between using an @option{-l} option and specifying a file name
11209 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11210 and searches several directories.
11212 @item -lobjc
11213 @opindex lobjc
11214 You need this special case of the @option{-l} option in order to
11215 link an Objective-C or Objective-C++ program.
11217 @item -nostartfiles
11218 @opindex nostartfiles
11219 Do not use the standard system startup files when linking.
11220 The standard system libraries are used normally, unless @option{-nostdlib}
11221 or @option{-nodefaultlibs} is used.
11223 @item -nodefaultlibs
11224 @opindex nodefaultlibs
11225 Do not use the standard system libraries when linking.
11226 Only the libraries you specify are passed to the linker, and options
11227 specifying linkage of the system libraries, such as @option{-static-libgcc}
11228 or @option{-shared-libgcc}, are ignored.  
11229 The standard startup files are used normally, unless @option{-nostartfiles}
11230 is used.  
11232 The compiler may generate calls to @code{memcmp},
11233 @code{memset}, @code{memcpy} and @code{memmove}.
11234 These entries are usually resolved by entries in
11235 libc.  These entry points should be supplied through some other
11236 mechanism when this option is specified.
11238 @item -nostdlib
11239 @opindex nostdlib
11240 Do not use the standard system startup files or libraries when linking.
11241 No startup files and only the libraries you specify are passed to
11242 the linker, and options specifying linkage of the system libraries, such as
11243 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11245 The compiler may generate calls to @code{memcmp}, @code{memset},
11246 @code{memcpy} and @code{memmove}.
11247 These entries are usually resolved by entries in
11248 libc.  These entry points should be supplied through some other
11249 mechanism when this option is specified.
11251 @cindex @option{-lgcc}, use with @option{-nostdlib}
11252 @cindex @option{-nostdlib} and unresolved references
11253 @cindex unresolved references and @option{-nostdlib}
11254 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11255 @cindex @option{-nodefaultlibs} and unresolved references
11256 @cindex unresolved references and @option{-nodefaultlibs}
11257 One of the standard libraries bypassed by @option{-nostdlib} and
11258 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11259 which GCC uses to overcome shortcomings of particular machines, or special
11260 needs for some languages.
11261 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11262 Collection (GCC) Internals},
11263 for more discussion of @file{libgcc.a}.)
11264 In most cases, you need @file{libgcc.a} even when you want to avoid
11265 other standard libraries.  In other words, when you specify @option{-nostdlib}
11266 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11267 This ensures that you have no unresolved references to internal GCC
11268 library subroutines.
11269 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11270 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11271 GNU Compiler Collection (GCC) Internals}.)
11273 @item -pie
11274 @opindex pie
11275 Produce a position independent executable on targets that support it.
11276 For predictable results, you must also specify the same set of options
11277 used for compilation (@option{-fpie}, @option{-fPIE},
11278 or model suboptions) when you specify this linker option.
11280 @item -no-pie
11281 @opindex no-pie
11282 Don't produce a position independent executable.
11284 @item -rdynamic
11285 @opindex rdynamic
11286 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11287 that support it. This instructs the linker to add all symbols, not
11288 only used ones, to the dynamic symbol table. This option is needed
11289 for some uses of @code{dlopen} or to allow obtaining backtraces
11290 from within a program.
11292 @item -s
11293 @opindex s
11294 Remove all symbol table and relocation information from the executable.
11296 @item -static
11297 @opindex static
11298 On systems that support dynamic linking, this prevents linking with the shared
11299 libraries.  On other systems, this option has no effect.
11301 @item -shared
11302 @opindex shared
11303 Produce a shared object which can then be linked with other objects to
11304 form an executable.  Not all systems support this option.  For predictable
11305 results, you must also specify the same set of options used for compilation
11306 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11307 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11308 needs to build supplementary stub code for constructors to work.  On
11309 multi-libbed systems, @samp{gcc -shared} must select the correct support
11310 libraries to link against.  Failing to supply the correct flags may lead
11311 to subtle defects.  Supplying them in cases where they are not necessary
11312 is innocuous.}
11314 @item -shared-libgcc
11315 @itemx -static-libgcc
11316 @opindex shared-libgcc
11317 @opindex static-libgcc
11318 On systems that provide @file{libgcc} as a shared library, these options
11319 force the use of either the shared or static version, respectively.
11320 If no shared version of @file{libgcc} was built when the compiler was
11321 configured, these options have no effect.
11323 There are several situations in which an application should use the
11324 shared @file{libgcc} instead of the static version.  The most common
11325 of these is when the application wishes to throw and catch exceptions
11326 across different shared libraries.  In that case, each of the libraries
11327 as well as the application itself should use the shared @file{libgcc}.
11329 Therefore, the G++ and GCJ drivers automatically add
11330 @option{-shared-libgcc} whenever you build a shared library or a main
11331 executable, because C++ and Java programs typically use exceptions, so
11332 this is the right thing to do.
11334 If, instead, you use the GCC driver to create shared libraries, you may
11335 find that they are not always linked with the shared @file{libgcc}.
11336 If GCC finds, at its configuration time, that you have a non-GNU linker
11337 or a GNU linker that does not support option @option{--eh-frame-hdr},
11338 it links the shared version of @file{libgcc} into shared libraries
11339 by default.  Otherwise, it takes advantage of the linker and optimizes
11340 away the linking with the shared version of @file{libgcc}, linking with
11341 the static version of libgcc by default.  This allows exceptions to
11342 propagate through such shared libraries, without incurring relocation
11343 costs at library load time.
11345 However, if a library or main executable is supposed to throw or catch
11346 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11347 for the languages used in the program, or using the option
11348 @option{-shared-libgcc}, such that it is linked with the shared
11349 @file{libgcc}.
11351 @item -static-libasan
11352 @opindex static-libasan
11353 When the @option{-fsanitize=address} option is used to link a program,
11354 the GCC driver automatically links against @option{libasan}.  If
11355 @file{libasan} is available as a shared library, and the @option{-static}
11356 option is not used, then this links against the shared version of
11357 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11358 driver to link @file{libasan} statically, without necessarily linking
11359 other libraries statically.
11361 @item -static-libtsan
11362 @opindex static-libtsan
11363 When the @option{-fsanitize=thread} option is used to link a program,
11364 the GCC driver automatically links against @option{libtsan}.  If
11365 @file{libtsan} is available as a shared library, and the @option{-static}
11366 option is not used, then this links against the shared version of
11367 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11368 driver to link @file{libtsan} statically, without necessarily linking
11369 other libraries statically.
11371 @item -static-liblsan
11372 @opindex static-liblsan
11373 When the @option{-fsanitize=leak} option is used to link a program,
11374 the GCC driver automatically links against @option{liblsan}.  If
11375 @file{liblsan} is available as a shared library, and the @option{-static}
11376 option is not used, then this links against the shared version of
11377 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11378 driver to link @file{liblsan} statically, without necessarily linking
11379 other libraries statically.
11381 @item -static-libubsan
11382 @opindex static-libubsan
11383 When the @option{-fsanitize=undefined} option is used to link a program,
11384 the GCC driver automatically links against @option{libubsan}.  If
11385 @file{libubsan} is available as a shared library, and the @option{-static}
11386 option is not used, then this links against the shared version of
11387 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11388 driver to link @file{libubsan} statically, without necessarily linking
11389 other libraries statically.
11391 @item -static-libmpx
11392 @opindex static-libmpx
11393 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11394 used to link a program, the GCC driver automatically links against
11395 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11396 and the @option{-static} option is not used, then this links against
11397 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11398 option directs the GCC driver to link @file{libmpx} statically,
11399 without necessarily linking other libraries statically.
11401 @item -static-libmpxwrappers
11402 @opindex static-libmpxwrappers
11403 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11404 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11405 GCC driver automatically links against @file{libmpxwrappers}.  If
11406 @file{libmpxwrappers} is available as a shared library, and the
11407 @option{-static} option is not used, then this links against the shared
11408 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11409 option directs the GCC driver to link @file{libmpxwrappers} statically,
11410 without necessarily linking other libraries statically.
11412 @item -static-libstdc++
11413 @opindex static-libstdc++
11414 When the @command{g++} program is used to link a C++ program, it
11415 normally automatically links against @option{libstdc++}.  If
11416 @file{libstdc++} is available as a shared library, and the
11417 @option{-static} option is not used, then this links against the
11418 shared version of @file{libstdc++}.  That is normally fine.  However, it
11419 is sometimes useful to freeze the version of @file{libstdc++} used by
11420 the program without going all the way to a fully static link.  The
11421 @option{-static-libstdc++} option directs the @command{g++} driver to
11422 link @file{libstdc++} statically, without necessarily linking other
11423 libraries statically.
11425 @item -symbolic
11426 @opindex symbolic
11427 Bind references to global symbols when building a shared object.  Warn
11428 about any unresolved references (unless overridden by the link editor
11429 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11430 this option.
11432 @item -T @var{script}
11433 @opindex T
11434 @cindex linker script
11435 Use @var{script} as the linker script.  This option is supported by most
11436 systems using the GNU linker.  On some targets, such as bare-board
11437 targets without an operating system, the @option{-T} option may be required
11438 when linking to avoid references to undefined symbols.
11440 @item -Xlinker @var{option}
11441 @opindex Xlinker
11442 Pass @var{option} as an option to the linker.  You can use this to
11443 supply system-specific linker options that GCC does not recognize.
11445 If you want to pass an option that takes a separate argument, you must use
11446 @option{-Xlinker} twice, once for the option and once for the argument.
11447 For example, to pass @option{-assert definitions}, you must write
11448 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11449 @option{-Xlinker "-assert definitions"}, because this passes the entire
11450 string as a single argument, which is not what the linker expects.
11452 When using the GNU linker, it is usually more convenient to pass
11453 arguments to linker options using the @option{@var{option}=@var{value}}
11454 syntax than as separate arguments.  For example, you can specify
11455 @option{-Xlinker -Map=output.map} rather than
11456 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11457 this syntax for command-line options.
11459 @item -Wl,@var{option}
11460 @opindex Wl
11461 Pass @var{option} as an option to the linker.  If @var{option} contains
11462 commas, it is split into multiple options at the commas.  You can use this
11463 syntax to pass an argument to the option.
11464 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11465 linker.  When using the GNU linker, you can also get the same effect with
11466 @option{-Wl,-Map=output.map}.
11468 @item -u @var{symbol}
11469 @opindex u
11470 Pretend the symbol @var{symbol} is undefined, to force linking of
11471 library modules to define it.  You can use @option{-u} multiple times with
11472 different symbols to force loading of additional library modules.
11474 @item -z @var{keyword}
11475 @opindex z
11476 @option{-z} is passed directly on to the linker along with the keyword
11477 @var{keyword}. See the section in the documentation of your linker for
11478 permitted values and their meanings.
11479 @end table
11481 @node Directory Options
11482 @section Options for Directory Search
11483 @cindex directory options
11484 @cindex options, directory search
11485 @cindex search path
11487 These options specify directories to search for header files, for
11488 libraries and for parts of the compiler:
11490 @table @gcctabopt
11491 @item -I@var{dir}
11492 @opindex I
11493 Add the directory @var{dir} to the head of the list of directories to be
11494 searched for header files.  This can be used to override a system header
11495 file, substituting your own version, since these directories are
11496 searched before the system header file directories.  However, you should
11497 not use this option to add directories that contain vendor-supplied
11498 system header files (use @option{-isystem} for that).  If you use more than
11499 one @option{-I} option, the directories are scanned in left-to-right
11500 order; the standard system directories come after.
11502 If a standard system include directory, or a directory specified with
11503 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11504 option is ignored.  The directory is still searched but as a
11505 system directory at its normal position in the system include chain.
11506 This is to ensure that GCC's procedure to fix buggy system headers and
11507 the ordering for the @code{include_next} directive are not inadvertently changed.
11508 If you really need to change the search order for system directories,
11509 use the @option{-nostdinc} and/or @option{-isystem} options.
11511 @item -iplugindir=@var{dir}
11512 @opindex iplugindir=
11513 Set the directory to search for plugins that are passed
11514 by @option{-fplugin=@var{name}} instead of
11515 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11516 to be used by the user, but only passed by the driver.
11518 @item -iquote@var{dir}
11519 @opindex iquote
11520 Add the directory @var{dir} to the head of the list of directories to
11521 be searched for header files only for the case of @code{#include
11522 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11523 otherwise just like @option{-I}.
11525 @item -L@var{dir}
11526 @opindex L
11527 Add directory @var{dir} to the list of directories to be searched
11528 for @option{-l}.
11530 @item -B@var{prefix}
11531 @opindex B
11532 This option specifies where to find the executables, libraries,
11533 include files, and data files of the compiler itself.
11535 The compiler driver program runs one or more of the subprograms
11536 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11537 @var{prefix} as a prefix for each program it tries to run, both with and
11538 without @samp{@var{machine}/@var{version}/} for the corresponding target
11539 machine and compiler version.
11541 For each subprogram to be run, the compiler driver first tries the
11542 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11543 is not specified, the driver tries two standard prefixes, 
11544 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11545 those results in a file name that is found, the unmodified program
11546 name is searched for using the directories specified in your
11547 @env{PATH} environment variable.
11549 The compiler checks to see if the path provided by @option{-B}
11550 refers to a directory, and if necessary it adds a directory
11551 separator character at the end of the path.
11553 @option{-B} prefixes that effectively specify directory names also apply
11554 to libraries in the linker, because the compiler translates these
11555 options into @option{-L} options for the linker.  They also apply to
11556 include files in the preprocessor, because the compiler translates these
11557 options into @option{-isystem} options for the preprocessor.  In this case,
11558 the compiler appends @samp{include} to the prefix.
11560 The runtime support file @file{libgcc.a} can also be searched for using
11561 the @option{-B} prefix, if needed.  If it is not found there, the two
11562 standard prefixes above are tried, and that is all.  The file is left
11563 out of the link if it is not found by those means.
11565 Another way to specify a prefix much like the @option{-B} prefix is to use
11566 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11567 Variables}.
11569 As a special kludge, if the path provided by @option{-B} is
11570 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11571 9, then it is replaced by @file{[dir/]include}.  This is to help
11572 with boot-strapping the compiler.
11574 @item -no-canonical-prefixes
11575 @opindex no-canonical-prefixes
11576 Do not expand any symbolic links, resolve references to @samp{/../}
11577 or @samp{/./}, or make the path absolute when generating a relative
11578 prefix.
11580 @item --sysroot=@var{dir}
11581 @opindex sysroot
11582 Use @var{dir} as the logical root directory for headers and libraries.
11583 For example, if the compiler normally searches for headers in
11584 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11585 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11587 If you use both this option and the @option{-isysroot} option, then
11588 the @option{--sysroot} option applies to libraries, but the
11589 @option{-isysroot} option applies to header files.
11591 The GNU linker (beginning with version 2.16) has the necessary support
11592 for this option.  If your linker does not support this option, the
11593 header file aspect of @option{--sysroot} still works, but the
11594 library aspect does not.
11596 @item --no-sysroot-suffix
11597 @opindex no-sysroot-suffix
11598 For some targets, a suffix is added to the root directory specified
11599 with @option{--sysroot}, depending on the other options used, so that
11600 headers may for example be found in
11601 @file{@var{dir}/@var{suffix}/usr/include} instead of
11602 @file{@var{dir}/usr/include}.  This option disables the addition of
11603 such a suffix.
11605 @item -I-
11606 @opindex I-
11607 This option has been deprecated.  Please use @option{-iquote} instead for
11608 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11609 option.
11610 Any directories you specify with @option{-I} options before the @option{-I-}
11611 option are searched only for the case of @code{#include "@var{file}"};
11612 they are not searched for @code{#include <@var{file}>}.
11614 If additional directories are specified with @option{-I} options after
11615 the @option{-I-} option, these directories are searched for all @code{#include}
11616 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11617 this way.)
11619 In addition, the @option{-I-} option inhibits the use of the current
11620 directory (where the current input file came from) as the first search
11621 directory for @code{#include "@var{file}"}.  There is no way to
11622 override this effect of @option{-I-}.  With @option{-I.} you can specify
11623 searching the directory that is current when the compiler is
11624 invoked.  That is not exactly the same as what the preprocessor does
11625 by default, but it is often satisfactory.
11627 @option{-I-} does not inhibit the use of the standard system directories
11628 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11629 independent.
11630 @end table
11632 @node Code Gen Options
11633 @section Options for Code Generation Conventions
11634 @cindex code generation conventions
11635 @cindex options, code generation
11636 @cindex run-time options
11638 These machine-independent options control the interface conventions
11639 used in code generation.
11641 Most of them have both positive and negative forms; the negative form
11642 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11643 one of the forms is listed---the one that is not the default.  You
11644 can figure out the other form by either removing @samp{no-} or adding
11647 @table @gcctabopt
11648 @item -fstack-reuse=@var{reuse-level}
11649 @opindex fstack_reuse
11650 This option controls stack space reuse for user declared local/auto variables
11651 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11652 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11653 local variables and temporaries, @samp{named_vars} enables the reuse only for
11654 user defined local variables with names, and @samp{none} disables stack reuse
11655 completely. The default value is @samp{all}. The option is needed when the
11656 program extends the lifetime of a scoped local variable or a compiler generated
11657 temporary beyond the end point defined by the language.  When a lifetime of
11658 a variable ends, and if the variable lives in memory, the optimizing compiler
11659 has the freedom to reuse its stack space with other temporaries or scoped
11660 local variables whose live range does not overlap with it. Legacy code extending
11661 local lifetime is likely to break with the stack reuse optimization.
11663 For example,
11665 @smallexample
11666    int *p;
11667    @{
11668      int local1;
11670      p = &local1;
11671      local1 = 10;
11672      ....
11673    @}
11674    @{
11675       int local2;
11676       local2 = 20;
11677       ...
11678    @}
11680    if (*p == 10)  // out of scope use of local1
11681      @{
11683      @}
11684 @end smallexample
11686 Another example:
11687 @smallexample
11689    struct A
11690    @{
11691        A(int k) : i(k), j(k) @{ @}
11692        int i;
11693        int j;
11694    @};
11696    A *ap;
11698    void foo(const A& ar)
11699    @{
11700       ap = &ar;
11701    @}
11703    void bar()
11704    @{
11705       foo(A(10)); // temp object's lifetime ends when foo returns
11707       @{
11708         A a(20);
11709         ....
11710       @}
11711       ap->i+= 10;  // ap references out of scope temp whose space
11712                    // is reused with a. What is the value of ap->i?
11713    @}
11715 @end smallexample
11717 The lifetime of a compiler generated temporary is well defined by the C++
11718 standard. When a lifetime of a temporary ends, and if the temporary lives
11719 in memory, the optimizing compiler has the freedom to reuse its stack
11720 space with other temporaries or scoped local variables whose live range
11721 does not overlap with it. However some of the legacy code relies on
11722 the behavior of older compilers in which temporaries' stack space is
11723 not reused, the aggressive stack reuse can lead to runtime errors. This
11724 option is used to control the temporary stack reuse optimization.
11726 @item -ftrapv
11727 @opindex ftrapv
11728 This option generates traps for signed overflow on addition, subtraction,
11729 multiplication operations.
11730 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11731 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11732 @option{-fwrapv} being effective.  Note that only active options override, so
11733 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11734 results in @option{-ftrapv} being effective.
11736 @item -fwrapv
11737 @opindex fwrapv
11738 This option instructs the compiler to assume that signed arithmetic
11739 overflow of addition, subtraction and multiplication wraps around
11740 using twos-complement representation.  This flag enables some optimizations
11741 and disables others.  This option is enabled by default for the Java
11742 front end, as required by the Java language specification.
11743 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11744 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11745 @option{-fwrapv} being effective.  Note that only active options override, so
11746 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11747 results in @option{-ftrapv} being effective.
11749 @item -fexceptions
11750 @opindex fexceptions
11751 Enable exception handling.  Generates extra code needed to propagate
11752 exceptions.  For some targets, this implies GCC generates frame
11753 unwind information for all functions, which can produce significant data
11754 size overhead, although it does not affect execution.  If you do not
11755 specify this option, GCC enables it by default for languages like
11756 C++ that normally require exception handling, and disables it for
11757 languages like C that do not normally require it.  However, you may need
11758 to enable this option when compiling C code that needs to interoperate
11759 properly with exception handlers written in C++.  You may also wish to
11760 disable this option if you are compiling older C++ programs that don't
11761 use exception handling.
11763 @item -fnon-call-exceptions
11764 @opindex fnon-call-exceptions
11765 Generate code that allows trapping instructions to throw exceptions.
11766 Note that this requires platform-specific runtime support that does
11767 not exist everywhere.  Moreover, it only allows @emph{trapping}
11768 instructions to throw exceptions, i.e.@: memory references or floating-point
11769 instructions.  It does not allow exceptions to be thrown from
11770 arbitrary signal handlers such as @code{SIGALRM}.
11772 @item -fdelete-dead-exceptions
11773 @opindex fdelete-dead-exceptions
11774 Consider that instructions that may throw exceptions but don't otherwise
11775 contribute to the execution of the program can be optimized away.
11776 This option is enabled by default for the Ada front end, as permitted by
11777 the Ada language specification.
11778 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
11780 @item -funwind-tables
11781 @opindex funwind-tables
11782 Similar to @option{-fexceptions}, except that it just generates any needed
11783 static data, but does not affect the generated code in any other way.
11784 You normally do not need to enable this option; instead, a language processor
11785 that needs this handling enables it on your behalf.
11787 @item -fasynchronous-unwind-tables
11788 @opindex fasynchronous-unwind-tables
11789 Generate unwind table in DWARF format, if supported by target machine.  The
11790 table is exact at each instruction boundary, so it can be used for stack
11791 unwinding from asynchronous events (such as debugger or garbage collector).
11793 @item -fno-gnu-unique
11794 @opindex fno-gnu-unique
11795 On systems with recent GNU assembler and C library, the C++ compiler
11796 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
11797 of template static data members and static local variables in inline
11798 functions are unique even in the presence of @code{RTLD_LOCAL}; this
11799 is necessary to avoid problems with a library used by two different
11800 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
11801 therefore disagreeing with the other one about the binding of the
11802 symbol.  But this causes @code{dlclose} to be ignored for affected
11803 DSOs; if your program relies on reinitialization of a DSO via
11804 @code{dlclose} and @code{dlopen}, you can use
11805 @option{-fno-gnu-unique}.
11807 @item -fpcc-struct-return
11808 @opindex fpcc-struct-return
11809 Return ``short'' @code{struct} and @code{union} values in memory like
11810 longer ones, rather than in registers.  This convention is less
11811 efficient, but it has the advantage of allowing intercallability between
11812 GCC-compiled files and files compiled with other compilers, particularly
11813 the Portable C Compiler (pcc).
11815 The precise convention for returning structures in memory depends
11816 on the target configuration macros.
11818 Short structures and unions are those whose size and alignment match
11819 that of some integer type.
11821 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11822 switch is not binary compatible with code compiled with the
11823 @option{-freg-struct-return} switch.
11824 Use it to conform to a non-default application binary interface.
11826 @item -freg-struct-return
11827 @opindex freg-struct-return
11828 Return @code{struct} and @code{union} values in registers when possible.
11829 This is more efficient for small structures than
11830 @option{-fpcc-struct-return}.
11832 If you specify neither @option{-fpcc-struct-return} nor
11833 @option{-freg-struct-return}, GCC defaults to whichever convention is
11834 standard for the target.  If there is no standard convention, GCC
11835 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11836 the principal compiler.  In those cases, we can choose the standard, and
11837 we chose the more efficient register return alternative.
11839 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11840 switch is not binary compatible with code compiled with the
11841 @option{-fpcc-struct-return} switch.
11842 Use it to conform to a non-default application binary interface.
11844 @item -fshort-enums
11845 @opindex fshort-enums
11846 Allocate to an @code{enum} type only as many bytes as it needs for the
11847 declared range of possible values.  Specifically, the @code{enum} type
11848 is equivalent to the smallest integer type that has enough room.
11850 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11851 code that is not binary compatible with code generated without that switch.
11852 Use it to conform to a non-default application binary interface.
11854 @item -fshort-wchar
11855 @opindex fshort-wchar
11856 Override the underlying type for @code{wchar_t} to be @code{short
11857 unsigned int} instead of the default for the target.  This option is
11858 useful for building programs to run under WINE@.
11860 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11861 code that is not binary compatible with code generated without that switch.
11862 Use it to conform to a non-default application binary interface.
11864 @item -fno-common
11865 @opindex fno-common
11866 In C code, controls the placement of uninitialized global variables.
11867 Unix C compilers have traditionally permitted multiple definitions of
11868 such variables in different compilation units by placing the variables
11869 in a common block.
11870 This is the behavior specified by @option{-fcommon}, and is the default
11871 for GCC on most targets.
11872 On the other hand, this behavior is not required by ISO C, and on some
11873 targets may carry a speed or code size penalty on variable references.
11874 The @option{-fno-common} option specifies that the compiler should place
11875 uninitialized global variables in the data section of the object file,
11876 rather than generating them as common blocks.
11877 This has the effect that if the same variable is declared
11878 (without @code{extern}) in two different compilations,
11879 you get a multiple-definition error when you link them.
11880 In this case, you must compile with @option{-fcommon} instead.
11881 Compiling with @option{-fno-common} is useful on targets for which
11882 it provides better performance, or if you wish to verify that the
11883 program will work on other systems that always treat uninitialized
11884 variable declarations this way.
11886 @item -fno-ident
11887 @opindex fno-ident
11888 Ignore the @code{#ident} directive.
11890 @item -finhibit-size-directive
11891 @opindex finhibit-size-directive
11892 Don't output a @code{.size} assembler directive, or anything else that
11893 would cause trouble if the function is split in the middle, and the
11894 two halves are placed at locations far apart in memory.  This option is
11895 used when compiling @file{crtstuff.c}; you should not need to use it
11896 for anything else.
11898 @item -fverbose-asm
11899 @opindex fverbose-asm
11900 Put extra commentary information in the generated assembly code to
11901 make it more readable.  This option is generally only of use to those
11902 who actually need to read the generated assembly code (perhaps while
11903 debugging the compiler itself).
11905 @option{-fno-verbose-asm}, the default, causes the
11906 extra information to be omitted and is useful when comparing two assembler
11907 files.
11909 The added comments include:
11911 @itemize @bullet
11913 @item
11914 information on the compiler version and command-line options,
11916 @item
11917 the source code lines associated with the assembly instructions,
11918 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
11920 @item
11921 hints on which high-level expressions correspond to
11922 the various assembly instruction operands.
11924 @end itemize
11926 For example, given this C source file:
11928 @smallexample
11929 int test (int n)
11931   int i;
11932   int total = 0;
11934   for (i = 0; i < n; i++)
11935     total += i * i;
11937   return total;
11939 @end smallexample
11941 compiling to (x86_64) assembly via @option{-S} and emitting the result
11942 direct to stdout via @option{-o} @option{-}
11944 @smallexample
11945 gcc -S test.c -fverbose-asm -Os -o -
11946 @end smallexample
11948 gives output similar to this:
11950 @smallexample
11951         .file   "test.c"
11952 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
11953   [...snip...]
11954 # options passed:
11955   [...snip...]
11957         .text
11958         .globl  test
11959         .type   test, @@function
11960 test:
11961 .LFB0:
11962         .cfi_startproc
11963 # test.c:4:   int total = 0;
11964         xorl    %eax, %eax      # <retval>
11965 # test.c:6:   for (i = 0; i < n; i++)
11966         xorl    %edx, %edx      # i
11967 .L2:
11968 # test.c:6:   for (i = 0; i < n; i++)
11969         cmpl    %edi, %edx      # n, i
11970         jge     .L5     #,
11971 # test.c:7:     total += i * i;
11972         movl    %edx, %ecx      # i, tmp92
11973         imull   %edx, %ecx      # i, tmp92
11974 # test.c:6:   for (i = 0; i < n; i++)
11975         incl    %edx    # i
11976 # test.c:7:     total += i * i;
11977         addl    %ecx, %eax      # tmp92, <retval>
11978         jmp     .L2     #
11979 .L5:
11980 # test.c:10: @}
11981         ret
11982         .cfi_endproc
11983 .LFE0:
11984         .size   test, .-test
11985         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
11986         .section        .note.GNU-stack,"",@@progbits
11987 @end smallexample
11989 The comments are intended for humans rather than machines and hence the
11990 precise format of the comments is subject to change.
11992 @item -frecord-gcc-switches
11993 @opindex frecord-gcc-switches
11994 This switch causes the command line used to invoke the
11995 compiler to be recorded into the object file that is being created.
11996 This switch is only implemented on some targets and the exact format
11997 of the recording is target and binary file format dependent, but it
11998 usually takes the form of a section containing ASCII text.  This
11999 switch is related to the @option{-fverbose-asm} switch, but that
12000 switch only records information in the assembler output file as
12001 comments, so it never reaches the object file.
12002 See also @option{-grecord-gcc-switches} for another
12003 way of storing compiler options into the object file.
12005 @item -fpic
12006 @opindex fpic
12007 @cindex global offset table
12008 @cindex PIC
12009 Generate position-independent code (PIC) suitable for use in a shared
12010 library, if supported for the target machine.  Such code accesses all
12011 constant addresses through a global offset table (GOT)@.  The dynamic
12012 loader resolves the GOT entries when the program starts (the dynamic
12013 loader is not part of GCC; it is part of the operating system).  If
12014 the GOT size for the linked executable exceeds a machine-specific
12015 maximum size, you get an error message from the linker indicating that
12016 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12017 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12018 on the m68k and RS/6000.  The x86 has no such limit.)
12020 Position-independent code requires special support, and therefore works
12021 only on certain machines.  For the x86, GCC supports PIC for System V
12022 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12023 position-independent.
12025 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12026 are defined to 1.
12028 @item -fPIC
12029 @opindex fPIC
12030 If supported for the target machine, emit position-independent code,
12031 suitable for dynamic linking and avoiding any limit on the size of the
12032 global offset table.  This option makes a difference on AArch64, m68k,
12033 PowerPC and SPARC@.
12035 Position-independent code requires special support, and therefore works
12036 only on certain machines.
12038 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12039 are defined to 2.
12041 @item -fpie
12042 @itemx -fPIE
12043 @opindex fpie
12044 @opindex fPIE
12045 These options are similar to @option{-fpic} and @option{-fPIC}, but
12046 generated position independent code can be only linked into executables.
12047 Usually these options are used when @option{-pie} GCC option is
12048 used during linking.
12050 @option{-fpie} and @option{-fPIE} both define the macros
12051 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12052 for @option{-fpie} and 2 for @option{-fPIE}.
12054 @item -fno-plt
12055 @opindex fno-plt
12056 Do not use the PLT for external function calls in position-independent code.
12057 Instead, load the callee address at call sites from the GOT and branch to it.
12058 This leads to more efficient code by eliminating PLT stubs and exposing
12059 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12060 PLT stubs expect the GOT pointer in a specific register, this gives more
12061 register allocation freedom to the compiler.
12062 Lazy binding requires use of the PLT; 
12063 with @option{-fno-plt} all external symbols are resolved at load time.
12065 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12066 through the PLT for specific external functions.
12068 In position-dependent code, a few targets also convert calls to
12069 functions that are marked to not use the PLT to use the GOT instead.
12071 @item -fno-jump-tables
12072 @opindex fno-jump-tables
12073 Do not use jump tables for switch statements even where it would be
12074 more efficient than other code generation strategies.  This option is
12075 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12076 building code that forms part of a dynamic linker and cannot
12077 reference the address of a jump table.  On some targets, jump tables
12078 do not require a GOT and this option is not needed.
12080 @item -ffixed-@var{reg}
12081 @opindex ffixed
12082 Treat the register named @var{reg} as a fixed register; generated code
12083 should never refer to it (except perhaps as a stack pointer, frame
12084 pointer or in some other fixed role).
12086 @var{reg} must be the name of a register.  The register names accepted
12087 are machine-specific and are defined in the @code{REGISTER_NAMES}
12088 macro in the machine description macro file.
12090 This flag does not have a negative form, because it specifies a
12091 three-way choice.
12093 @item -fcall-used-@var{reg}
12094 @opindex fcall-used
12095 Treat the register named @var{reg} as an allocable register that is
12096 clobbered by function calls.  It may be allocated for temporaries or
12097 variables that do not live across a call.  Functions compiled this way
12098 do not save and restore the register @var{reg}.
12100 It is an error to use this flag with the frame pointer or stack pointer.
12101 Use of this flag for other registers that have fixed pervasive roles in
12102 the machine's execution model produces disastrous results.
12104 This flag does not have a negative form, because it specifies a
12105 three-way choice.
12107 @item -fcall-saved-@var{reg}
12108 @opindex fcall-saved
12109 Treat the register named @var{reg} as an allocable register saved by
12110 functions.  It may be allocated even for temporaries or variables that
12111 live across a call.  Functions compiled this way save and restore
12112 the register @var{reg} if they use it.
12114 It is an error to use this flag with the frame pointer or stack pointer.
12115 Use of this flag for other registers that have fixed pervasive roles in
12116 the machine's execution model produces disastrous results.
12118 A different sort of disaster results from the use of this flag for
12119 a register in which function values may be returned.
12121 This flag does not have a negative form, because it specifies a
12122 three-way choice.
12124 @item -fpack-struct[=@var{n}]
12125 @opindex fpack-struct
12126 Without a value specified, pack all structure members together without
12127 holes.  When a value is specified (which must be a small power of two), pack
12128 structure members according to this value, representing the maximum
12129 alignment (that is, objects with default alignment requirements larger than
12130 this are output potentially unaligned at the next fitting location.
12132 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12133 code that is not binary compatible with code generated without that switch.
12134 Additionally, it makes the code suboptimal.
12135 Use it to conform to a non-default application binary interface.
12137 @item -fleading-underscore
12138 @opindex fleading-underscore
12139 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12140 change the way C symbols are represented in the object file.  One use
12141 is to help link with legacy assembly code.
12143 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12144 generate code that is not binary compatible with code generated without that
12145 switch.  Use it to conform to a non-default application binary interface.
12146 Not all targets provide complete support for this switch.
12148 @item -ftls-model=@var{model}
12149 @opindex ftls-model
12150 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12151 The @var{model} argument should be one of @samp{global-dynamic},
12152 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12153 Note that the choice is subject to optimization: the compiler may use
12154 a more efficient model for symbols not visible outside of the translation
12155 unit, or if @option{-fpic} is not given on the command line.
12157 The default without @option{-fpic} is @samp{initial-exec}; with
12158 @option{-fpic} the default is @samp{global-dynamic}.
12160 @item -ftrampolines
12161 @opindex ftrampolines
12162 For targets that normally need trampolines for nested functions, always
12163 generate them instead of using descriptors.  Otherwise, for targets that
12164 do not need them, like for example HP-PA or IA-64, do nothing.
12166 A trampoline is a small piece of code that is created at run time on the
12167 stack when the address of a nested function is taken, and is used to call
12168 the nested function indirectly.  Therefore, it requires the stack to be
12169 made executable in order for the program to work properly.
12171 @option{-fno-trampolines} is enabled by default on a language by language
12172 basis to let the compiler avoid generating them, if it computes that this
12173 is safe, and replace them with descriptors.  Descriptors are made up of data
12174 only, but the generated code must be prepared to deal with them.  As of this
12175 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12177 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12178 @option{-fno-trampolines} are not binary compatible if nested functions are
12179 present.  This option must therefore be used on a program-wide basis and be
12180 manipulated with extreme care.
12182 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12183 @opindex fvisibility
12184 Set the default ELF image symbol visibility to the specified option---all
12185 symbols are marked with this unless overridden within the code.
12186 Using this feature can very substantially improve linking and
12187 load times of shared object libraries, produce more optimized
12188 code, provide near-perfect API export and prevent symbol clashes.
12189 It is @strong{strongly} recommended that you use this in any shared objects
12190 you distribute.
12192 Despite the nomenclature, @samp{default} always means public; i.e.,
12193 available to be linked against from outside the shared object.
12194 @samp{protected} and @samp{internal} are pretty useless in real-world
12195 usage so the only other commonly used option is @samp{hidden}.
12196 The default if @option{-fvisibility} isn't specified is
12197 @samp{default}, i.e., make every symbol public.
12199 A good explanation of the benefits offered by ensuring ELF
12200 symbols have the correct visibility is given by ``How To Write
12201 Shared Libraries'' by Ulrich Drepper (which can be found at
12202 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
12203 solution made possible by this option to marking things hidden when
12204 the default is public is to make the default hidden and mark things
12205 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12206 and @code{__attribute__ ((visibility("default")))} instead of
12207 @code{__declspec(dllexport)} you get almost identical semantics with
12208 identical syntax.  This is a great boon to those working with
12209 cross-platform projects.
12211 For those adding visibility support to existing code, you may find
12212 @code{#pragma GCC visibility} of use.  This works by you enclosing
12213 the declarations you wish to set visibility for with (for example)
12214 @code{#pragma GCC visibility push(hidden)} and
12215 @code{#pragma GCC visibility pop}.
12216 Bear in mind that symbol visibility should be viewed @strong{as
12217 part of the API interface contract} and thus all new code should
12218 always specify visibility when it is not the default; i.e., declarations
12219 only for use within the local DSO should @strong{always} be marked explicitly
12220 as hidden as so to avoid PLT indirection overheads---making this
12221 abundantly clear also aids readability and self-documentation of the code.
12222 Note that due to ISO C++ specification requirements, @code{operator new} and
12223 @code{operator delete} must always be of default visibility.
12225 Be aware that headers from outside your project, in particular system
12226 headers and headers from any other library you use, may not be
12227 expecting to be compiled with visibility other than the default.  You
12228 may need to explicitly say @code{#pragma GCC visibility push(default)}
12229 before including any such headers.
12231 @code{extern} declarations are not affected by @option{-fvisibility}, so
12232 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12233 no modifications.  However, this means that calls to @code{extern}
12234 functions with no explicit visibility use the PLT, so it is more
12235 effective to use @code{__attribute ((visibility))} and/or
12236 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12237 declarations should be treated as hidden.
12239 Note that @option{-fvisibility} does affect C++ vague linkage
12240 entities. This means that, for instance, an exception class that is
12241 be thrown between DSOs must be explicitly marked with default
12242 visibility so that the @samp{type_info} nodes are unified between
12243 the DSOs.
12245 An overview of these techniques, their benefits and how to use them
12246 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12248 @item -fstrict-volatile-bitfields
12249 @opindex fstrict-volatile-bitfields
12250 This option should be used if accesses to volatile bit-fields (or other
12251 structure fields, although the compiler usually honors those types
12252 anyway) should use a single access of the width of the
12253 field's type, aligned to a natural alignment if possible.  For
12254 example, targets with memory-mapped peripheral registers might require
12255 all such accesses to be 16 bits wide; with this flag you can
12256 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12257 is 16 bits on these targets) to force GCC to use 16-bit accesses
12258 instead of, perhaps, a more efficient 32-bit access.
12260 If this option is disabled, the compiler uses the most efficient
12261 instruction.  In the previous example, that might be a 32-bit load
12262 instruction, even though that accesses bytes that do not contain
12263 any portion of the bit-field, or memory-mapped registers unrelated to
12264 the one being updated.
12266 In some cases, such as when the @code{packed} attribute is applied to a 
12267 structure field, it may not be possible to access the field with a single
12268 read or write that is correctly aligned for the target machine.  In this
12269 case GCC falls back to generating multiple accesses rather than code that 
12270 will fault or truncate the result at run time.
12272 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12273 not allowed to touch non bit-field members.  It is therefore recommended
12274 to define all bits of the field's type as bit-field members.
12276 The default value of this option is determined by the application binary
12277 interface for the target processor.
12279 @item -fsync-libcalls
12280 @opindex fsync-libcalls
12281 This option controls whether any out-of-line instance of the @code{__sync}
12282 family of functions may be used to implement the C++11 @code{__atomic}
12283 family of functions.
12285 The default value of this option is enabled, thus the only useful form
12286 of the option is @option{-fno-sync-libcalls}.  This option is used in
12287 the implementation of the @file{libatomic} runtime library.
12289 @end table
12291 @node Developer Options
12292 @section GCC Developer Options
12293 @cindex developer options
12294 @cindex debugging GCC
12295 @cindex debug dump options
12296 @cindex dump options
12297 @cindex compilation statistics
12299 This section describes command-line options that are primarily of
12300 interest to GCC developers, including options to support compiler
12301 testing and investigation of compiler bugs and compile-time
12302 performance problems.  This includes options that produce debug dumps
12303 at various points in the compilation; that print statistics such as
12304 memory use and execution time; and that print information about GCC's
12305 configuration, such as where it searches for libraries.  You should
12306 rarely need to use any of these options for ordinary compilation and
12307 linking tasks.
12309 @table @gcctabopt
12311 @item -d@var{letters}
12312 @itemx -fdump-rtl-@var{pass}
12313 @itemx -fdump-rtl-@var{pass}=@var{filename}
12314 @opindex d
12315 @opindex fdump-rtl-@var{pass}
12316 Says to make debugging dumps during compilation at times specified by
12317 @var{letters}.  This is used for debugging the RTL-based passes of the
12318 compiler.  The file names for most of the dumps are made by appending
12319 a pass number and a word to the @var{dumpname}, and the files are
12320 created in the directory of the output file.  In case of
12321 @option{=@var{filename}} option, the dump is output on the given file
12322 instead of the pass numbered dump files.  Note that the pass number is
12323 assigned as passes are registered into the pass manager.  Most passes
12324 are registered in the order that they will execute and for these passes
12325 the number corresponds to the pass execution order.  However, passes
12326 registered by plugins, passes specific to compilation targets, or
12327 passes that are otherwise registered after all the other passes are
12328 numbered higher than a pass named "final", even if they are executed
12329 earlier.  @var{dumpname} is generated from the name of the output
12330 file if explicitly specified and not an executable, otherwise it is
12331 the basename of the source file.  These switches may have different
12332 effects when @option{-E} is used for preprocessing.
12334 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12335 @option{-d} option @var{letters}.  Here are the possible
12336 letters for use in @var{pass} and @var{letters}, and their meanings:
12338 @table @gcctabopt
12340 @item -fdump-rtl-alignments
12341 @opindex fdump-rtl-alignments
12342 Dump after branch alignments have been computed.
12344 @item -fdump-rtl-asmcons
12345 @opindex fdump-rtl-asmcons
12346 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12348 @item -fdump-rtl-auto_inc_dec
12349 @opindex fdump-rtl-auto_inc_dec
12350 Dump after auto-inc-dec discovery.  This pass is only run on
12351 architectures that have auto inc or auto dec instructions.
12353 @item -fdump-rtl-barriers
12354 @opindex fdump-rtl-barriers
12355 Dump after cleaning up the barrier instructions.
12357 @item -fdump-rtl-bbpart
12358 @opindex fdump-rtl-bbpart
12359 Dump after partitioning hot and cold basic blocks.
12361 @item -fdump-rtl-bbro
12362 @opindex fdump-rtl-bbro
12363 Dump after block reordering.
12365 @item -fdump-rtl-btl1
12366 @itemx -fdump-rtl-btl2
12367 @opindex fdump-rtl-btl2
12368 @opindex fdump-rtl-btl2
12369 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12370 after the two branch
12371 target load optimization passes.
12373 @item -fdump-rtl-bypass
12374 @opindex fdump-rtl-bypass
12375 Dump after jump bypassing and control flow optimizations.
12377 @item -fdump-rtl-combine
12378 @opindex fdump-rtl-combine
12379 Dump after the RTL instruction combination pass.
12381 @item -fdump-rtl-compgotos
12382 @opindex fdump-rtl-compgotos
12383 Dump after duplicating the computed gotos.
12385 @item -fdump-rtl-ce1
12386 @itemx -fdump-rtl-ce2
12387 @itemx -fdump-rtl-ce3
12388 @opindex fdump-rtl-ce1
12389 @opindex fdump-rtl-ce2
12390 @opindex fdump-rtl-ce3
12391 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12392 @option{-fdump-rtl-ce3} enable dumping after the three
12393 if conversion passes.
12395 @item -fdump-rtl-cprop_hardreg
12396 @opindex fdump-rtl-cprop_hardreg
12397 Dump after hard register copy propagation.
12399 @item -fdump-rtl-csa
12400 @opindex fdump-rtl-csa
12401 Dump after combining stack adjustments.
12403 @item -fdump-rtl-cse1
12404 @itemx -fdump-rtl-cse2
12405 @opindex fdump-rtl-cse1
12406 @opindex fdump-rtl-cse2
12407 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12408 the two common subexpression elimination passes.
12410 @item -fdump-rtl-dce
12411 @opindex fdump-rtl-dce
12412 Dump after the standalone dead code elimination passes.
12414 @item -fdump-rtl-dbr
12415 @opindex fdump-rtl-dbr
12416 Dump after delayed branch scheduling.
12418 @item -fdump-rtl-dce1
12419 @itemx -fdump-rtl-dce2
12420 @opindex fdump-rtl-dce1
12421 @opindex fdump-rtl-dce2
12422 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12423 the two dead store elimination passes.
12425 @item -fdump-rtl-eh
12426 @opindex fdump-rtl-eh
12427 Dump after finalization of EH handling code.
12429 @item -fdump-rtl-eh_ranges
12430 @opindex fdump-rtl-eh_ranges
12431 Dump after conversion of EH handling range regions.
12433 @item -fdump-rtl-expand
12434 @opindex fdump-rtl-expand
12435 Dump after RTL generation.
12437 @item -fdump-rtl-fwprop1
12438 @itemx -fdump-rtl-fwprop2
12439 @opindex fdump-rtl-fwprop1
12440 @opindex fdump-rtl-fwprop2
12441 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12442 dumping after the two forward propagation passes.
12444 @item -fdump-rtl-gcse1
12445 @itemx -fdump-rtl-gcse2
12446 @opindex fdump-rtl-gcse1
12447 @opindex fdump-rtl-gcse2
12448 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12449 after global common subexpression elimination.
12451 @item -fdump-rtl-init-regs
12452 @opindex fdump-rtl-init-regs
12453 Dump after the initialization of the registers.
12455 @item -fdump-rtl-initvals
12456 @opindex fdump-rtl-initvals
12457 Dump after the computation of the initial value sets.
12459 @item -fdump-rtl-into_cfglayout
12460 @opindex fdump-rtl-into_cfglayout
12461 Dump after converting to cfglayout mode.
12463 @item -fdump-rtl-ira
12464 @opindex fdump-rtl-ira
12465 Dump after iterated register allocation.
12467 @item -fdump-rtl-jump
12468 @opindex fdump-rtl-jump
12469 Dump after the second jump optimization.
12471 @item -fdump-rtl-loop2
12472 @opindex fdump-rtl-loop2
12473 @option{-fdump-rtl-loop2} enables dumping after the rtl
12474 loop optimization passes.
12476 @item -fdump-rtl-mach
12477 @opindex fdump-rtl-mach
12478 Dump after performing the machine dependent reorganization pass, if that
12479 pass exists.
12481 @item -fdump-rtl-mode_sw
12482 @opindex fdump-rtl-mode_sw
12483 Dump after removing redundant mode switches.
12485 @item -fdump-rtl-rnreg
12486 @opindex fdump-rtl-rnreg
12487 Dump after register renumbering.
12489 @item -fdump-rtl-outof_cfglayout
12490 @opindex fdump-rtl-outof_cfglayout
12491 Dump after converting from cfglayout mode.
12493 @item -fdump-rtl-peephole2
12494 @opindex fdump-rtl-peephole2
12495 Dump after the peephole pass.
12497 @item -fdump-rtl-postreload
12498 @opindex fdump-rtl-postreload
12499 Dump after post-reload optimizations.
12501 @item -fdump-rtl-pro_and_epilogue
12502 @opindex fdump-rtl-pro_and_epilogue
12503 Dump after generating the function prologues and epilogues.
12505 @item -fdump-rtl-sched1
12506 @itemx -fdump-rtl-sched2
12507 @opindex fdump-rtl-sched1
12508 @opindex fdump-rtl-sched2
12509 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12510 after the basic block scheduling passes.
12512 @item -fdump-rtl-ree
12513 @opindex fdump-rtl-ree
12514 Dump after sign/zero extension elimination.
12516 @item -fdump-rtl-seqabstr
12517 @opindex fdump-rtl-seqabstr
12518 Dump after common sequence discovery.
12520 @item -fdump-rtl-shorten
12521 @opindex fdump-rtl-shorten
12522 Dump after shortening branches.
12524 @item -fdump-rtl-sibling
12525 @opindex fdump-rtl-sibling
12526 Dump after sibling call optimizations.
12528 @item -fdump-rtl-split1
12529 @itemx -fdump-rtl-split2
12530 @itemx -fdump-rtl-split3
12531 @itemx -fdump-rtl-split4
12532 @itemx -fdump-rtl-split5
12533 @opindex fdump-rtl-split1
12534 @opindex fdump-rtl-split2
12535 @opindex fdump-rtl-split3
12536 @opindex fdump-rtl-split4
12537 @opindex fdump-rtl-split5
12538 These options enable dumping after five rounds of
12539 instruction splitting.
12541 @item -fdump-rtl-sms
12542 @opindex fdump-rtl-sms
12543 Dump after modulo scheduling.  This pass is only run on some
12544 architectures.
12546 @item -fdump-rtl-stack
12547 @opindex fdump-rtl-stack
12548 Dump after conversion from GCC's ``flat register file'' registers to the
12549 x87's stack-like registers.  This pass is only run on x86 variants.
12551 @item -fdump-rtl-subreg1
12552 @itemx -fdump-rtl-subreg2
12553 @opindex fdump-rtl-subreg1
12554 @opindex fdump-rtl-subreg2
12555 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12556 the two subreg expansion passes.
12558 @item -fdump-rtl-unshare
12559 @opindex fdump-rtl-unshare
12560 Dump after all rtl has been unshared.
12562 @item -fdump-rtl-vartrack
12563 @opindex fdump-rtl-vartrack
12564 Dump after variable tracking.
12566 @item -fdump-rtl-vregs
12567 @opindex fdump-rtl-vregs
12568 Dump after converting virtual registers to hard registers.
12570 @item -fdump-rtl-web
12571 @opindex fdump-rtl-web
12572 Dump after live range splitting.
12574 @item -fdump-rtl-regclass
12575 @itemx -fdump-rtl-subregs_of_mode_init
12576 @itemx -fdump-rtl-subregs_of_mode_finish
12577 @itemx -fdump-rtl-dfinit
12578 @itemx -fdump-rtl-dfinish
12579 @opindex fdump-rtl-regclass
12580 @opindex fdump-rtl-subregs_of_mode_init
12581 @opindex fdump-rtl-subregs_of_mode_finish
12582 @opindex fdump-rtl-dfinit
12583 @opindex fdump-rtl-dfinish
12584 These dumps are defined but always produce empty files.
12586 @item -da
12587 @itemx -fdump-rtl-all
12588 @opindex da
12589 @opindex fdump-rtl-all
12590 Produce all the dumps listed above.
12592 @item -dA
12593 @opindex dA
12594 Annotate the assembler output with miscellaneous debugging information.
12596 @item -dD
12597 @opindex dD
12598 Dump all macro definitions, at the end of preprocessing, in addition to
12599 normal output.
12601 @item -dH
12602 @opindex dH
12603 Produce a core dump whenever an error occurs.
12605 @item -dp
12606 @opindex dp
12607 Annotate the assembler output with a comment indicating which
12608 pattern and alternative is used.  The length of each instruction is
12609 also printed.
12611 @item -dP
12612 @opindex dP
12613 Dump the RTL in the assembler output as a comment before each instruction.
12614 Also turns on @option{-dp} annotation.
12616 @item -dx
12617 @opindex dx
12618 Just generate RTL for a function instead of compiling it.  Usually used
12619 with @option{-fdump-rtl-expand}.
12620 @end table
12622 @item -fdump-noaddr
12623 @opindex fdump-noaddr
12624 When doing debugging dumps, suppress address output.  This makes it more
12625 feasible to use diff on debugging dumps for compiler invocations with
12626 different compiler binaries and/or different
12627 text / bss / data / heap / stack / dso start locations.
12629 @item -freport-bug
12630 @opindex freport-bug
12631 Collect and dump debug information into a temporary file if an
12632 internal compiler error (ICE) occurs.
12634 @item -fdump-unnumbered
12635 @opindex fdump-unnumbered
12636 When doing debugging dumps, suppress instruction numbers and address output.
12637 This makes it more feasible to use diff on debugging dumps for compiler
12638 invocations with different options, in particular with and without
12639 @option{-g}.
12641 @item -fdump-unnumbered-links
12642 @opindex fdump-unnumbered-links
12643 When doing debugging dumps (see @option{-d} option above), suppress
12644 instruction numbers for the links to the previous and next instructions
12645 in a sequence.
12647 @item -fdump-translation-unit @r{(C++ only)}
12648 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12649 @opindex fdump-translation-unit
12650 Dump a representation of the tree structure for the entire translation
12651 unit to a file.  The file name is made by appending @file{.tu} to the
12652 source file name, and the file is created in the same directory as the
12653 output file.  If the @samp{-@var{options}} form is used, @var{options}
12654 controls the details of the dump as described for the
12655 @option{-fdump-tree} options.
12657 @item -fdump-class-hierarchy @r{(C++ only)}
12658 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12659 @opindex fdump-class-hierarchy
12660 Dump a representation of each class's hierarchy and virtual function
12661 table layout to a file.  The file name is made by appending
12662 @file{.class} to the source file name, and the file is created in the
12663 same directory as the output file.  If the @samp{-@var{options}} form
12664 is used, @var{options} controls the details of the dump as described
12665 for the @option{-fdump-tree} options.
12667 @item -fdump-ipa-@var{switch}
12668 @opindex fdump-ipa
12669 Control the dumping at various stages of inter-procedural analysis
12670 language tree to a file.  The file name is generated by appending a
12671 switch specific suffix to the source file name, and the file is created
12672 in the same directory as the output file.  The following dumps are
12673 possible:
12675 @table @samp
12676 @item all
12677 Enables all inter-procedural analysis dumps.
12679 @item cgraph
12680 Dumps information about call-graph optimization, unused function removal,
12681 and inlining decisions.
12683 @item inline
12684 Dump after function inlining.
12686 @end table
12688 @item -fdump-passes
12689 @opindex fdump-passes
12690 Dump the list of optimization passes that are turned on and off by
12691 the current command-line options.
12693 @item -fdump-statistics-@var{option}
12694 @opindex fdump-statistics
12695 Enable and control dumping of pass statistics in a separate file.  The
12696 file name is generated by appending a suffix ending in
12697 @samp{.statistics} to the source file name, and the file is created in
12698 the same directory as the output file.  If the @samp{-@var{option}}
12699 form is used, @samp{-stats} causes counters to be summed over the
12700 whole compilation unit while @samp{-details} dumps every event as
12701 the passes generate them.  The default with no option is to sum
12702 counters for each function compiled.
12704 @item -fdump-tree-@var{switch}
12705 @itemx -fdump-tree-@var{switch}-@var{options}
12706 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
12707 @opindex fdump-tree
12708 Control the dumping at various stages of processing the intermediate
12709 language tree to a file.  The file name is generated by appending a
12710 switch-specific suffix to the source file name, and the file is
12711 created in the same directory as the output file. In case of
12712 @option{=@var{filename}} option, the dump is output on the given file
12713 instead of the auto named dump files.  If the @samp{-@var{options}}
12714 form is used, @var{options} is a list of @samp{-} separated options
12715 which control the details of the dump.  Not all options are applicable
12716 to all dumps; those that are not meaningful are ignored.  The
12717 following options are available
12719 @table @samp
12720 @item address
12721 Print the address of each node.  Usually this is not meaningful as it
12722 changes according to the environment and source file.  Its primary use
12723 is for tying up a dump file with a debug environment.
12724 @item asmname
12725 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
12726 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
12727 use working backward from mangled names in the assembly file.
12728 @item slim
12729 When dumping front-end intermediate representations, inhibit dumping
12730 of members of a scope or body of a function merely because that scope
12731 has been reached.  Only dump such items when they are directly reachable
12732 by some other path.
12734 When dumping pretty-printed trees, this option inhibits dumping the
12735 bodies of control structures.
12737 When dumping RTL, print the RTL in slim (condensed) form instead of
12738 the default LISP-like representation.
12739 @item raw
12740 Print a raw representation of the tree.  By default, trees are
12741 pretty-printed into a C-like representation.
12742 @item details
12743 Enable more detailed dumps (not honored by every dump option). Also
12744 include information from the optimization passes.
12745 @item stats
12746 Enable dumping various statistics about the pass (not honored by every dump
12747 option).
12748 @item blocks
12749 Enable showing basic block boundaries (disabled in raw dumps).
12750 @item graph
12751 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
12752 dump a representation of the control flow graph suitable for viewing with
12753 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
12754 the file is pretty-printed as a subgraph, so that GraphViz can render them
12755 all in a single plot.
12757 This option currently only works for RTL dumps, and the RTL is always
12758 dumped in slim form.
12759 @item vops
12760 Enable showing virtual operands for every statement.
12761 @item lineno
12762 Enable showing line numbers for statements.
12763 @item uid
12764 Enable showing the unique ID (@code{DECL_UID}) for each variable.
12765 @item verbose
12766 Enable showing the tree dump for each statement.
12767 @item eh
12768 Enable showing the EH region number holding each statement.
12769 @item scev
12770 Enable showing scalar evolution analysis details.
12771 @item optimized
12772 Enable showing optimization information (only available in certain
12773 passes).
12774 @item missed
12775 Enable showing missed optimization information (only available in certain
12776 passes).
12777 @item note
12778 Enable other detailed optimization information (only available in
12779 certain passes).
12780 @item =@var{filename}
12781 Instead of an auto named dump file, output into the given file
12782 name. The file names @file{stdout} and @file{stderr} are treated
12783 specially and are considered already open standard streams. For
12784 example,
12786 @smallexample
12787 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
12788      -fdump-tree-pre=stderr file.c
12789 @end smallexample
12791 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
12792 output on to @file{stderr}. If two conflicting dump filenames are
12793 given for the same pass, then the latter option overrides the earlier
12794 one.
12796 @item split-paths
12797 @opindex fdump-tree-split-paths
12798 Dump each function after splitting paths to loop backedges.  The file
12799 name is made by appending @file{.split-paths} to the source file name.
12801 @item all
12802 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
12803 and @option{lineno}.
12805 @item optall
12806 Turn on all optimization options, i.e., @option{optimized},
12807 @option{missed}, and @option{note}.
12808 @end table
12810 The following tree dumps are possible:
12811 @table @samp
12813 @item original
12814 @opindex fdump-tree-original
12815 Dump before any tree based optimization, to @file{@var{file}.original}.
12817 @item optimized
12818 @opindex fdump-tree-optimized
12819 Dump after all tree based optimization, to @file{@var{file}.optimized}.
12821 @item gimple
12822 @opindex fdump-tree-gimple
12823 Dump each function before and after the gimplification pass to a file.  The
12824 file name is made by appending @file{.gimple} to the source file name.
12826 @item cfg
12827 @opindex fdump-tree-cfg
12828 Dump the control flow graph of each function to a file.  The file name is
12829 made by appending @file{.cfg} to the source file name.
12831 @item ch
12832 @opindex fdump-tree-ch
12833 Dump each function after copying loop headers.  The file name is made by
12834 appending @file{.ch} to the source file name.
12836 @item ssa
12837 @opindex fdump-tree-ssa
12838 Dump SSA related information to a file.  The file name is made by appending
12839 @file{.ssa} to the source file name.
12841 @item alias
12842 @opindex fdump-tree-alias
12843 Dump aliasing information for each function.  The file name is made by
12844 appending @file{.alias} to the source file name.
12846 @item ccp
12847 @opindex fdump-tree-ccp
12848 Dump each function after CCP@.  The file name is made by appending
12849 @file{.ccp} to the source file name.
12851 @item storeccp
12852 @opindex fdump-tree-storeccp
12853 Dump each function after STORE-CCP@.  The file name is made by appending
12854 @file{.storeccp} to the source file name.
12856 @item pre
12857 @opindex fdump-tree-pre
12858 Dump trees after partial redundancy elimination and/or code hoisting.
12859 The file name is made by appending @file{.pre} to the source file name.
12861 @item fre
12862 @opindex fdump-tree-fre
12863 Dump trees after full redundancy elimination.  The file name is made
12864 by appending @file{.fre} to the source file name.
12866 @item copyprop
12867 @opindex fdump-tree-copyprop
12868 Dump trees after copy propagation.  The file name is made
12869 by appending @file{.copyprop} to the source file name.
12871 @item store_copyprop
12872 @opindex fdump-tree-store_copyprop
12873 Dump trees after store copy-propagation.  The file name is made
12874 by appending @file{.store_copyprop} to the source file name.
12876 @item dce
12877 @opindex fdump-tree-dce
12878 Dump each function after dead code elimination.  The file name is made by
12879 appending @file{.dce} to the source file name.
12881 @item sra
12882 @opindex fdump-tree-sra
12883 Dump each function after performing scalar replacement of aggregates.  The
12884 file name is made by appending @file{.sra} to the source file name.
12886 @item sink
12887 @opindex fdump-tree-sink
12888 Dump each function after performing code sinking.  The file name is made
12889 by appending @file{.sink} to the source file name.
12891 @item dom
12892 @opindex fdump-tree-dom
12893 Dump each function after applying dominator tree optimizations.  The file
12894 name is made by appending @file{.dom} to the source file name.
12896 @item dse
12897 @opindex fdump-tree-dse
12898 Dump each function after applying dead store elimination.  The file
12899 name is made by appending @file{.dse} to the source file name.
12901 @item phiopt
12902 @opindex fdump-tree-phiopt
12903 Dump each function after optimizing PHI nodes into straightline code.  The file
12904 name is made by appending @file{.phiopt} to the source file name.
12906 @item backprop
12907 @opindex fdump-tree-backprop
12908 Dump each function after back-propagating use information up the definition
12909 chain.  The file name is made by appending @file{.backprop} to the
12910 source file name.
12912 @item forwprop
12913 @opindex fdump-tree-forwprop
12914 Dump each function after forward propagating single use variables.  The file
12915 name is made by appending @file{.forwprop} to the source file name.
12917 @item nrv
12918 @opindex fdump-tree-nrv
12919 Dump each function after applying the named return value optimization on
12920 generic trees.  The file name is made by appending @file{.nrv} to the source
12921 file name.
12923 @item vect
12924 @opindex fdump-tree-vect
12925 Dump each function after applying vectorization of loops.  The file name is
12926 made by appending @file{.vect} to the source file name.
12928 @item slp
12929 @opindex fdump-tree-slp
12930 Dump each function after applying vectorization of basic blocks.  The file name
12931 is made by appending @file{.slp} to the source file name.
12933 @item vrp
12934 @opindex fdump-tree-vrp
12935 Dump each function after Value Range Propagation (VRP).  The file name
12936 is made by appending @file{.vrp} to the source file name.
12938 @item early vrp
12939 @opindex fdump-tree-evrp
12940 Dump each function after Early Value Range Propagation (EVRP).  The file name
12941 is made by appending @file{.evrp} to the source file name.
12943 @item oaccdevlow
12944 @opindex fdump-tree-oaccdevlow
12945 Dump each function after applying device-specific OpenACC transformations.
12946 The file name is made by appending @file{.oaccdevlow} to the source file name.
12948 @item all
12949 @opindex fdump-tree-all
12950 Enable all the available tree dumps with the flags provided in this option.
12951 @end table
12953 @item -fopt-info
12954 @itemx -fopt-info-@var{options}
12955 @itemx -fopt-info-@var{options}=@var{filename}
12956 @opindex fopt-info
12957 Controls optimization dumps from various optimization passes. If the
12958 @samp{-@var{options}} form is used, @var{options} is a list of
12959 @samp{-} separated option keywords to select the dump details and
12960 optimizations.  
12962 The @var{options} can be divided into two groups: options describing the
12963 verbosity of the dump, and options describing which optimizations
12964 should be included. The options from both the groups can be freely
12965 mixed as they are non-overlapping. However, in case of any conflicts,
12966 the later options override the earlier options on the command
12967 line. 
12969 The following options control the dump verbosity:
12971 @table @samp
12972 @item optimized
12973 Print information when an optimization is successfully applied. It is
12974 up to a pass to decide which information is relevant. For example, the
12975 vectorizer passes print the source location of loops which are
12976 successfully vectorized.
12977 @item missed
12978 Print information about missed optimizations. Individual passes
12979 control which information to include in the output. 
12980 @item note
12981 Print verbose information about optimizations, such as certain
12982 transformations, more detailed messages about decisions etc.
12983 @item all
12984 Print detailed optimization information. This includes
12985 @samp{optimized}, @samp{missed}, and @samp{note}.
12986 @end table
12988 One or more of the following option keywords can be used to describe a
12989 group of optimizations:
12991 @table @samp
12992 @item ipa
12993 Enable dumps from all interprocedural optimizations.
12994 @item loop
12995 Enable dumps from all loop optimizations.
12996 @item inline
12997 Enable dumps from all inlining optimizations.
12998 @item vec
12999 Enable dumps from all vectorization optimizations.
13000 @item optall
13001 Enable dumps from all optimizations. This is a superset of
13002 the optimization groups listed above.
13003 @end table
13005 If @var{options} is
13006 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13007 info about successful optimizations from all the passes.  
13009 If the @var{filename} is provided, then the dumps from all the
13010 applicable optimizations are concatenated into the @var{filename}.
13011 Otherwise the dump is output onto @file{stderr}. Though multiple
13012 @option{-fopt-info} options are accepted, only one of them can include
13013 a @var{filename}. If other filenames are provided then all but the
13014 first such option are ignored.
13016 Note that the output @var{filename} is overwritten
13017 in case of multiple translation units. If a combined output from
13018 multiple translation units is desired, @file{stderr} should be used
13019 instead.
13021 In the following example, the optimization info is output to
13022 @file{stderr}:
13024 @smallexample
13025 gcc -O3 -fopt-info
13026 @end smallexample
13028 This example:
13029 @smallexample
13030 gcc -O3 -fopt-info-missed=missed.all
13031 @end smallexample
13033 @noindent
13034 outputs missed optimization report from all the passes into
13035 @file{missed.all}, and this one:
13037 @smallexample
13038 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13039 @end smallexample
13041 @noindent
13042 prints information about missed optimization opportunities from
13043 vectorization passes on @file{stderr}.  
13044 Note that @option{-fopt-info-vec-missed} is equivalent to 
13045 @option{-fopt-info-missed-vec}.
13047 As another example,
13048 @smallexample
13049 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13050 @end smallexample
13052 @noindent
13053 outputs information about missed optimizations as well as
13054 optimized locations from all the inlining passes into
13055 @file{inline.txt}.
13057 Finally, consider:
13059 @smallexample
13060 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13061 @end smallexample
13063 @noindent
13064 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13065 in conflict since only one output file is allowed. In this case, only
13066 the first option takes effect and the subsequent options are
13067 ignored. Thus only @file{vec.miss} is produced which contains
13068 dumps from the vectorizer about missed opportunities.
13070 @item -fsched-verbose=@var{n}
13071 @opindex fsched-verbose
13072 On targets that use instruction scheduling, this option controls the
13073 amount of debugging output the scheduler prints to the dump files.
13075 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13076 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13077 For @var{n} greater than one, it also output basic block probabilities,
13078 detailed ready list information and unit/insn info.  For @var{n} greater
13079 than two, it includes RTL at abort point, control-flow and regions info.
13080 And for @var{n} over four, @option{-fsched-verbose} also includes
13081 dependence info.
13085 @item -fenable-@var{kind}-@var{pass}
13086 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13087 @opindex fdisable-
13088 @opindex fenable-
13090 This is a set of options that are used to explicitly disable/enable
13091 optimization passes.  These options are intended for use for debugging GCC.
13092 Compiler users should use regular options for enabling/disabling
13093 passes instead.
13095 @table @gcctabopt
13097 @item -fdisable-ipa-@var{pass}
13098 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13099 statically invoked in the compiler multiple times, the pass name should be
13100 appended with a sequential number starting from 1.
13102 @item -fdisable-rtl-@var{pass}
13103 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13104 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13105 statically invoked in the compiler multiple times, the pass name should be
13106 appended with a sequential number starting from 1.  @var{range-list} is a 
13107 comma-separated list of function ranges or assembler names.  Each range is a number
13108 pair separated by a colon.  The range is inclusive in both ends.  If the range
13109 is trivial, the number pair can be simplified as a single number.  If the
13110 function's call graph node's @var{uid} falls within one of the specified ranges,
13111 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13112 function header of a dump file, and the pass names can be dumped by using
13113 option @option{-fdump-passes}.
13115 @item -fdisable-tree-@var{pass}
13116 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13117 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13118 option arguments.
13120 @item -fenable-ipa-@var{pass}
13121 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13122 statically invoked in the compiler multiple times, the pass name should be
13123 appended with a sequential number starting from 1.
13125 @item -fenable-rtl-@var{pass}
13126 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13127 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13128 description and examples.
13130 @item -fenable-tree-@var{pass}
13131 @itemx -fenable-tree-@var{pass}=@var{range-list}
13132 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13133 of option arguments.
13135 @end table
13137 Here are some examples showing uses of these options.
13139 @smallexample
13141 # disable ccp1 for all functions
13142    -fdisable-tree-ccp1
13143 # disable complete unroll for function whose cgraph node uid is 1
13144    -fenable-tree-cunroll=1
13145 # disable gcse2 for functions at the following ranges [1,1],
13146 # [300,400], and [400,1000]
13147 # disable gcse2 for functions foo and foo2
13148    -fdisable-rtl-gcse2=foo,foo2
13149 # disable early inlining
13150    -fdisable-tree-einline
13151 # disable ipa inlining
13152    -fdisable-ipa-inline
13153 # enable tree full unroll
13154    -fenable-tree-unroll
13156 @end smallexample
13158 @item -fchecking
13159 @itemx -fchecking=@var{n}
13160 @opindex fchecking
13161 @opindex fno-checking
13162 Enable internal consistency checking.  The default depends on
13163 the compiler configuration.  @option{-fchecking=2} enables further
13164 internal consistency checking that might affect code generation.
13166 @item -frandom-seed=@var{string}
13167 @opindex frandom-seed
13168 This option provides a seed that GCC uses in place of
13169 random numbers in generating certain symbol names
13170 that have to be different in every compiled file.  It is also used to
13171 place unique stamps in coverage data files and the object files that
13172 produce them.  You can use the @option{-frandom-seed} option to produce
13173 reproducibly identical object files.
13175 The @var{string} can either be a number (decimal, octal or hex) or an
13176 arbitrary string (in which case it's converted to a number by
13177 computing CRC32).
13179 The @var{string} should be different for every file you compile.
13181 @item -save-temps
13182 @itemx -save-temps=cwd
13183 @opindex save-temps
13184 Store the usual ``temporary'' intermediate files permanently; place them
13185 in the current directory and name them based on the source file.  Thus,
13186 compiling @file{foo.c} with @option{-c -save-temps} produces files
13187 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13188 preprocessed @file{foo.i} output file even though the compiler now
13189 normally uses an integrated preprocessor.
13191 When used in combination with the @option{-x} command-line option,
13192 @option{-save-temps} is sensible enough to avoid over writing an
13193 input source file with the same extension as an intermediate file.
13194 The corresponding intermediate file may be obtained by renaming the
13195 source file before using @option{-save-temps}.
13197 If you invoke GCC in parallel, compiling several different source
13198 files that share a common base name in different subdirectories or the
13199 same source file compiled for multiple output destinations, it is
13200 likely that the different parallel compilers will interfere with each
13201 other, and overwrite the temporary files.  For instance:
13203 @smallexample
13204 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13205 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13206 @end smallexample
13208 may result in @file{foo.i} and @file{foo.o} being written to
13209 simultaneously by both compilers.
13211 @item -save-temps=obj
13212 @opindex save-temps=obj
13213 Store the usual ``temporary'' intermediate files permanently.  If the
13214 @option{-o} option is used, the temporary files are based on the
13215 object file.  If the @option{-o} option is not used, the
13216 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13218 For example:
13220 @smallexample
13221 gcc -save-temps=obj -c foo.c
13222 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13223 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13224 @end smallexample
13226 @noindent
13227 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13228 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13229 @file{dir2/yfoobar.o}.
13231 @item -time@r{[}=@var{file}@r{]}
13232 @opindex time
13233 Report the CPU time taken by each subprocess in the compilation
13234 sequence.  For C source files, this is the compiler proper and assembler
13235 (plus the linker if linking is done).
13237 Without the specification of an output file, the output looks like this:
13239 @smallexample
13240 # cc1 0.12 0.01
13241 # as 0.00 0.01
13242 @end smallexample
13244 The first number on each line is the ``user time'', that is time spent
13245 executing the program itself.  The second number is ``system time'',
13246 time spent executing operating system routines on behalf of the program.
13247 Both numbers are in seconds.
13249 With the specification of an output file, the output is appended to the
13250 named file, and it looks like this:
13252 @smallexample
13253 0.12 0.01 cc1 @var{options}
13254 0.00 0.01 as @var{options}
13255 @end smallexample
13257 The ``user time'' and the ``system time'' are moved before the program
13258 name, and the options passed to the program are displayed, so that one
13259 can later tell what file was being compiled, and with which options.
13261 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13262 @opindex fdump-final-insns
13263 Dump the final internal representation (RTL) to @var{file}.  If the
13264 optional argument is omitted (or if @var{file} is @code{.}), the name
13265 of the dump file is determined by appending @code{.gkd} to the
13266 compilation output file name.
13268 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13269 @opindex fcompare-debug
13270 @opindex fno-compare-debug
13271 If no error occurs during compilation, run the compiler a second time,
13272 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13273 passed to the second compilation.  Dump the final internal
13274 representation in both compilations, and print an error if they differ.
13276 If the equal sign is omitted, the default @option{-gtoggle} is used.
13278 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13279 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13280 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13281 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13282 is used.
13284 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13285 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13286 of the final representation and the second compilation, preventing even
13287 @env{GCC_COMPARE_DEBUG} from taking effect.
13289 To verify full coverage during @option{-fcompare-debug} testing, set
13290 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13291 which GCC rejects as an invalid option in any actual compilation
13292 (rather than preprocessing, assembly or linking).  To get just a
13293 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13294 not overridden} will do.
13296 @item -fcompare-debug-second
13297 @opindex fcompare-debug-second
13298 This option is implicitly passed to the compiler for the second
13299 compilation requested by @option{-fcompare-debug}, along with options to
13300 silence warnings, and omitting other options that would cause
13301 side-effect compiler outputs to files or to the standard output.  Dump
13302 files and preserved temporary files are renamed so as to contain the
13303 @code{.gk} additional extension during the second compilation, to avoid
13304 overwriting those generated by the first.
13306 When this option is passed to the compiler driver, it causes the
13307 @emph{first} compilation to be skipped, which makes it useful for little
13308 other than debugging the compiler proper.
13310 @item -gtoggle
13311 @opindex gtoggle
13312 Turn off generation of debug info, if leaving out this option
13313 generates it, or turn it on at level 2 otherwise.  The position of this
13314 argument in the command line does not matter; it takes effect after all
13315 other options are processed, and it does so only once, no matter how
13316 many times it is given.  This is mainly intended to be used with
13317 @option{-fcompare-debug}.
13319 @item -fvar-tracking-assignments-toggle
13320 @opindex fvar-tracking-assignments-toggle
13321 @opindex fno-var-tracking-assignments-toggle
13322 Toggle @option{-fvar-tracking-assignments}, in the same way that
13323 @option{-gtoggle} toggles @option{-g}.
13325 @item -Q
13326 @opindex Q
13327 Makes the compiler print out each function name as it is compiled, and
13328 print some statistics about each pass when it finishes.
13330 @item -ftime-report
13331 @opindex ftime-report
13332 Makes the compiler print some statistics about the time consumed by each
13333 pass when it finishes.
13335 @item -ftime-report-details
13336 @opindex ftime-report-details
13337 Record the time consumed by infrastructure parts separately for each pass.
13339 @item -fira-verbose=@var{n}
13340 @opindex fira-verbose
13341 Control the verbosity of the dump file for the integrated register allocator.
13342 The default value is 5.  If the value @var{n} is greater or equal to 10,
13343 the dump output is sent to stderr using the same format as @var{n} minus 10.
13345 @item -flto-report
13346 @opindex flto-report
13347 Prints a report with internal details on the workings of the link-time
13348 optimizer.  The contents of this report vary from version to version.
13349 It is meant to be useful to GCC developers when processing object
13350 files in LTO mode (via @option{-flto}).
13352 Disabled by default.
13354 @item -flto-report-wpa
13355 @opindex flto-report-wpa
13356 Like @option{-flto-report}, but only print for the WPA phase of Link
13357 Time Optimization.
13359 @item -fmem-report
13360 @opindex fmem-report
13361 Makes the compiler print some statistics about permanent memory
13362 allocation when it finishes.
13364 @item -fmem-report-wpa
13365 @opindex fmem-report-wpa
13366 Makes the compiler print some statistics about permanent memory
13367 allocation for the WPA phase only.
13369 @item -fpre-ipa-mem-report
13370 @opindex fpre-ipa-mem-report
13371 @item -fpost-ipa-mem-report
13372 @opindex fpost-ipa-mem-report
13373 Makes the compiler print some statistics about permanent memory
13374 allocation before or after interprocedural optimization.
13376 @item -fprofile-report
13377 @opindex fprofile-report
13378 Makes the compiler print some statistics about consistency of the
13379 (estimated) profile and effect of individual passes.
13381 @item -fstack-usage
13382 @opindex fstack-usage
13383 Makes the compiler output stack usage information for the program, on a
13384 per-function basis.  The filename for the dump is made by appending
13385 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13386 the output file, if explicitly specified and it is not an executable,
13387 otherwise it is the basename of the source file.  An entry is made up
13388 of three fields:
13390 @itemize
13391 @item
13392 The name of the function.
13393 @item
13394 A number of bytes.
13395 @item
13396 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13397 @end itemize
13399 The qualifier @code{static} means that the function manipulates the stack
13400 statically: a fixed number of bytes are allocated for the frame on function
13401 entry and released on function exit; no stack adjustments are otherwise made
13402 in the function.  The second field is this fixed number of bytes.
13404 The qualifier @code{dynamic} means that the function manipulates the stack
13405 dynamically: in addition to the static allocation described above, stack
13406 adjustments are made in the body of the function, for example to push/pop
13407 arguments around function calls.  If the qualifier @code{bounded} is also
13408 present, the amount of these adjustments is bounded at compile time and
13409 the second field is an upper bound of the total amount of stack used by
13410 the function.  If it is not present, the amount of these adjustments is
13411 not bounded at compile time and the second field only represents the
13412 bounded part.
13414 @item -fstats
13415 @opindex fstats
13416 Emit statistics about front-end processing at the end of the compilation.
13417 This option is supported only by the C++ front end, and
13418 the information is generally only useful to the G++ development team.
13420 @item -fdbg-cnt-list
13421 @opindex fdbg-cnt-list
13422 Print the name and the counter upper bound for all debug counters.
13425 @item -fdbg-cnt=@var{counter-value-list}
13426 @opindex fdbg-cnt
13427 Set the internal debug counter upper bound.  @var{counter-value-list}
13428 is a comma-separated list of @var{name}:@var{value} pairs
13429 which sets the upper bound of each debug counter @var{name} to @var{value}.
13430 All debug counters have the initial upper bound of @code{UINT_MAX};
13431 thus @code{dbg_cnt} returns true always unless the upper bound
13432 is set by this option.
13433 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13434 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13436 @item -print-file-name=@var{library}
13437 @opindex print-file-name
13438 Print the full absolute name of the library file @var{library} that
13439 would be used when linking---and don't do anything else.  With this
13440 option, GCC does not compile or link anything; it just prints the
13441 file name.
13443 @item -print-multi-directory
13444 @opindex print-multi-directory
13445 Print the directory name corresponding to the multilib selected by any
13446 other switches present in the command line.  This directory is supposed
13447 to exist in @env{GCC_EXEC_PREFIX}.
13449 @item -print-multi-lib
13450 @opindex print-multi-lib
13451 Print the mapping from multilib directory names to compiler switches
13452 that enable them.  The directory name is separated from the switches by
13453 @samp{;}, and each switch starts with an @samp{@@} instead of the
13454 @samp{-}, without spaces between multiple switches.  This is supposed to
13455 ease shell processing.
13457 @item -print-multi-os-directory
13458 @opindex print-multi-os-directory
13459 Print the path to OS libraries for the selected
13460 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13461 present in the @file{lib} subdirectory and no multilibs are used, this is
13462 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13463 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13464 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13465 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13467 @item -print-multiarch
13468 @opindex print-multiarch
13469 Print the path to OS libraries for the selected multiarch,
13470 relative to some @file{lib} subdirectory.
13472 @item -print-prog-name=@var{program}
13473 @opindex print-prog-name
13474 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13476 @item -print-libgcc-file-name
13477 @opindex print-libgcc-file-name
13478 Same as @option{-print-file-name=libgcc.a}.
13480 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13481 but you do want to link with @file{libgcc.a}.  You can do:
13483 @smallexample
13484 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13485 @end smallexample
13487 @item -print-search-dirs
13488 @opindex print-search-dirs
13489 Print the name of the configured installation directory and a list of
13490 program and library directories @command{gcc} searches---and don't do anything else.
13492 This is useful when @command{gcc} prints the error message
13493 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13494 To resolve this you either need to put @file{cpp0} and the other compiler
13495 components where @command{gcc} expects to find them, or you can set the environment
13496 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13497 Don't forget the trailing @samp{/}.
13498 @xref{Environment Variables}.
13500 @item -print-sysroot
13501 @opindex print-sysroot
13502 Print the target sysroot directory that is used during
13503 compilation.  This is the target sysroot specified either at configure
13504 time or using the @option{--sysroot} option, possibly with an extra
13505 suffix that depends on compilation options.  If no target sysroot is
13506 specified, the option prints nothing.
13508 @item -print-sysroot-headers-suffix
13509 @opindex print-sysroot-headers-suffix
13510 Print the suffix added to the target sysroot when searching for
13511 headers, or give an error if the compiler is not configured with such
13512 a suffix---and don't do anything else.
13514 @item -dumpmachine
13515 @opindex dumpmachine
13516 Print the compiler's target machine (for example,
13517 @samp{i686-pc-linux-gnu})---and don't do anything else.
13519 @item -dumpversion
13520 @opindex dumpversion
13521 Print the compiler version (for example, @code{3.0})---and don't do
13522 anything else.
13524 @item -dumpspecs
13525 @opindex dumpspecs
13526 Print the compiler's built-in specs---and don't do anything else.  (This
13527 is used when GCC itself is being built.)  @xref{Spec Files}.
13528 @end table
13530 @node Submodel Options
13531 @section Machine-Dependent Options
13532 @cindex submodel options
13533 @cindex specifying hardware config
13534 @cindex hardware models and configurations, specifying
13535 @cindex target-dependent options
13536 @cindex machine-dependent options
13538 Each target machine supported by GCC can have its own options---for
13539 example, to allow you to compile for a particular processor variant or
13540 ABI, or to control optimizations specific to that machine.  By
13541 convention, the names of machine-specific options start with
13542 @samp{-m}.
13544 Some configurations of the compiler also support additional target-specific
13545 options, usually for compatibility with other compilers on the same
13546 platform.
13548 @c This list is ordered alphanumerically by subsection name.
13549 @c It should be the same order and spelling as these options are listed
13550 @c in Machine Dependent Options
13552 @menu
13553 * AArch64 Options::
13554 * Adapteva Epiphany Options::
13555 * ARC Options::
13556 * ARM Options::
13557 * AVR Options::
13558 * Blackfin Options::
13559 * C6X Options::
13560 * CRIS Options::
13561 * CR16 Options::
13562 * Darwin Options::
13563 * DEC Alpha Options::
13564 * FR30 Options::
13565 * FT32 Options::
13566 * FRV Options::
13567 * GNU/Linux Options::
13568 * H8/300 Options::
13569 * HPPA Options::
13570 * IA-64 Options::
13571 * LM32 Options::
13572 * M32C Options::
13573 * M32R/D Options::
13574 * M680x0 Options::
13575 * MCore Options::
13576 * MeP Options::
13577 * MicroBlaze Options::
13578 * MIPS Options::
13579 * MMIX Options::
13580 * MN10300 Options::
13581 * Moxie Options::
13582 * MSP430 Options::
13583 * NDS32 Options::
13584 * Nios II Options::
13585 * Nvidia PTX Options::
13586 * PDP-11 Options::
13587 * picoChip Options::
13588 * PowerPC Options::
13589 * RL78 Options::
13590 * RS/6000 and PowerPC Options::
13591 * RX Options::
13592 * S/390 and zSeries Options::
13593 * Score Options::
13594 * SH Options::
13595 * Solaris 2 Options::
13596 * SPARC Options::
13597 * SPU Options::
13598 * System V Options::
13599 * TILE-Gx Options::
13600 * TILEPro Options::
13601 * V850 Options::
13602 * VAX Options::
13603 * Visium Options::
13604 * VMS Options::
13605 * VxWorks Options::
13606 * x86 Options::
13607 * x86 Windows Options::
13608 * Xstormy16 Options::
13609 * Xtensa Options::
13610 * zSeries Options::
13611 @end menu
13613 @node AArch64 Options
13614 @subsection AArch64 Options
13615 @cindex AArch64 Options
13617 These options are defined for AArch64 implementations:
13619 @table @gcctabopt
13621 @item -mabi=@var{name}
13622 @opindex mabi
13623 Generate code for the specified data model.  Permissible values
13624 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13625 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13626 but long int and pointers are 64 bits.
13628 The default depends on the specific target configuration.  Note that
13629 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13630 entire program with the same ABI, and link with a compatible set of libraries.
13632 @item -mbig-endian
13633 @opindex mbig-endian
13634 Generate big-endian code.  This is the default when GCC is configured for an
13635 @samp{aarch64_be-*-*} target.
13637 @item -mgeneral-regs-only
13638 @opindex mgeneral-regs-only
13639 Generate code which uses only the general-purpose registers.  This will prevent
13640 the compiler from using floating-point and Advanced SIMD registers but will not
13641 impose any restrictions on the assembler.
13643 @item -mlittle-endian
13644 @opindex mlittle-endian
13645 Generate little-endian code.  This is the default when GCC is configured for an
13646 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13648 @item -mcmodel=tiny
13649 @opindex mcmodel=tiny
13650 Generate code for the tiny code model.  The program and its statically defined
13651 symbols must be within 1MB of each other.  Programs can be statically or
13652 dynamically linked.
13654 @item -mcmodel=small
13655 @opindex mcmodel=small
13656 Generate code for the small code model.  The program and its statically defined
13657 symbols must be within 4GB of each other.  Programs can be statically or
13658 dynamically linked.  This is the default code model.
13660 @item -mcmodel=large
13661 @opindex mcmodel=large
13662 Generate code for the large code model.  This makes no assumptions about
13663 addresses and sizes of sections.  Programs can be statically linked only.
13665 @item -mstrict-align
13666 @opindex mstrict-align
13667 Avoid generating memory accesses that may not be aligned on a natural object
13668 boundary as described in the architecture specification.
13670 @item -momit-leaf-frame-pointer
13671 @itemx -mno-omit-leaf-frame-pointer
13672 @opindex momit-leaf-frame-pointer
13673 @opindex mno-omit-leaf-frame-pointer
13674 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13675 default.
13677 @item -mtls-dialect=desc
13678 @opindex mtls-dialect=desc
13679 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13680 of TLS variables.  This is the default.
13682 @item -mtls-dialect=traditional
13683 @opindex mtls-dialect=traditional
13684 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13685 of TLS variables.
13687 @item -mtls-size=@var{size}
13688 @opindex mtls-size
13689 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13690 This option requires binutils 2.26 or newer.
13692 @item -mfix-cortex-a53-835769
13693 @itemx -mno-fix-cortex-a53-835769
13694 @opindex mfix-cortex-a53-835769
13695 @opindex mno-fix-cortex-a53-835769
13696 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13697 This involves inserting a NOP instruction between memory instructions and
13698 64-bit integer multiply-accumulate instructions.
13700 @item -mfix-cortex-a53-843419
13701 @itemx -mno-fix-cortex-a53-843419
13702 @opindex mfix-cortex-a53-843419
13703 @opindex mno-fix-cortex-a53-843419
13704 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13705 This erratum workaround is made at link time and this will only pass the
13706 corresponding flag to the linker.
13708 @item -mlow-precision-recip-sqrt
13709 @item -mno-low-precision-recip-sqrt
13710 @opindex mlow-precision-recip-sqrt
13711 @opindex mno-low-precision-recip-sqrt
13712 Enable or disable the reciprocal square root approximation.
13713 This option only has an effect if @option{-ffast-math} or
13714 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13715 precision of reciprocal square root results to about 16 bits for
13716 single precision and to 32 bits for double precision.
13718 @item -mlow-precision-sqrt
13719 @item -mno-low-precision-sqrt
13720 @opindex -mlow-precision-sqrt
13721 @opindex -mno-low-precision-sqrt
13722 Enable or disable the square root approximation.
13723 This option only has an effect if @option{-ffast-math} or
13724 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13725 precision of square root results to about 16 bits for
13726 single precision and to 32 bits for double precision.
13727 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
13729 @item -mlow-precision-div
13730 @item -mno-low-precision-div
13731 @opindex -mlow-precision-div
13732 @opindex -mno-low-precision-div
13733 Enable or disable the division approximation.
13734 This option only has an effect if @option{-ffast-math} or
13735 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13736 precision of division results to about 16 bits for
13737 single precision and to 32 bits for double precision.
13739 @item -march=@var{name}
13740 @opindex march
13741 Specify the name of the target architecture and, optionally, one or
13742 more feature modifiers.  This option has the form
13743 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13745 The permissible values for @var{arch} are @samp{armv8-a},
13746 @samp{armv8.1-a}, @samp{armv8.2-a} or @var{native}.
13748 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
13749 support for the ARMv8.2-A architecture extensions.
13751 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13752 support for the ARMv8.1-A architecture extension.  In particular, it
13753 enables the @samp{+crc} and @samp{+lse} features.
13755 The value @samp{native} is available on native AArch64 GNU/Linux and
13756 causes the compiler to pick the architecture of the host system.  This
13757 option has no effect if the compiler is unable to recognize the
13758 architecture of the host system,
13760 The permissible values for @var{feature} are listed in the sub-section
13761 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13762 Feature Modifiers}.  Where conflicting feature modifiers are
13763 specified, the right-most feature is used.
13765 GCC uses @var{name} to determine what kind of instructions it can emit
13766 when generating assembly code.  If @option{-march} is specified
13767 without either of @option{-mtune} or @option{-mcpu} also being
13768 specified, the code is tuned to perform well across a range of target
13769 processors implementing the target architecture.
13771 @item -mtune=@var{name}
13772 @opindex mtune
13773 Specify the name of the target processor for which GCC should tune the
13774 performance of the code.  Permissible values for this option are:
13775 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13776 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{qdf24xx},
13777 @samp{thunderx}, @samp{xgene1}, @samp{vulcan}, @samp{cortex-a57.cortex-a53},
13778 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
13779 @samp{cortex-a73.cortex-a53}, @samp{native}.
13781 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13782 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
13783 specify that GCC should tune for a big.LITTLE system.
13785 Additionally on native AArch64 GNU/Linux systems the value
13786 @samp{native} tunes performance to the host system.  This option has no effect
13787 if the compiler is unable to recognize the processor of the host system.
13789 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
13790 are specified, the code is tuned to perform well across a range
13791 of target processors.
13793 This option cannot be suffixed by feature modifiers.
13795 @item -mcpu=@var{name}
13796 @opindex mcpu
13797 Specify the name of the target processor, optionally suffixed by one
13798 or more feature modifiers.  This option has the form
13799 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
13800 the permissible values for @var{cpu} are the same as those available
13801 for @option{-mtune}.  The permissible values for @var{feature} are
13802 documented in the sub-section on
13803 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13804 Feature Modifiers}.  Where conflicting feature modifiers are
13805 specified, the right-most feature is used.
13807 GCC uses @var{name} to determine what kind of instructions it can emit when
13808 generating assembly code (as if by @option{-march}) and to determine
13809 the target processor for which to tune for performance (as if
13810 by @option{-mtune}).  Where this option is used in conjunction
13811 with @option{-march} or @option{-mtune}, those options take precedence
13812 over the appropriate part of this option.
13814 @item -moverride=@var{string}
13815 @opindex moverride
13816 Override tuning decisions made by the back-end in response to a
13817 @option{-mtune=} switch.  The syntax, semantics, and accepted values
13818 for @var{string} in this option are not guaranteed to be consistent
13819 across releases.
13821 This option is only intended to be useful when developing GCC.
13823 @item -mpc-relative-literal-loads
13824 @opindex mpc-relative-literal-loads
13825 Enable PC-relative literal loads.  With this option literal pools are
13826 accessed using a single instruction and emitted after each function.  This
13827 limits the maximum size of functions to 1MB.  This is enabled by default for
13828 @option{-mcmodel=tiny}.
13830 @end table
13832 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
13833 @anchor{aarch64-feature-modifiers}
13834 @cindex @option{-march} feature modifiers
13835 @cindex @option{-mcpu} feature modifiers
13836 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
13837 the following and their inverses @option{no@var{feature}}:
13839 @table @samp
13840 @item crc
13841 Enable CRC extension.  This is on by default for
13842 @option{-march=armv8.1-a}.
13843 @item crypto
13844 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
13845 instructions.
13846 @item fp
13847 Enable floating-point instructions.  This is on by default for all possible
13848 values for options @option{-march} and @option{-mcpu}.
13849 @item simd
13850 Enable Advanced SIMD instructions.  This also enables floating-point
13851 instructions.  This is on by default for all possible values for options
13852 @option{-march} and @option{-mcpu}.
13853 @item lse
13854 Enable Large System Extension instructions.  This is on by default for
13855 @option{-march=armv8.1-a}.
13856 @item fp16
13857 Enable FP16 extension.  This also enables floating-point instructions.
13859 @end table
13861 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
13862 Conversely, @option{nofp} implies @option{nosimd}, which implies
13863 @option{nocrypto}.
13865 @node Adapteva Epiphany Options
13866 @subsection Adapteva Epiphany Options
13868 These @samp{-m} options are defined for Adapteva Epiphany:
13870 @table @gcctabopt
13871 @item -mhalf-reg-file
13872 @opindex mhalf-reg-file
13873 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
13874 That allows code to run on hardware variants that lack these registers.
13876 @item -mprefer-short-insn-regs
13877 @opindex mprefer-short-insn-regs
13878 Preferentially allocate registers that allow short instruction generation.
13879 This can result in increased instruction count, so this may either reduce or
13880 increase overall code size.
13882 @item -mbranch-cost=@var{num}
13883 @opindex mbranch-cost
13884 Set the cost of branches to roughly @var{num} ``simple'' instructions.
13885 This cost is only a heuristic and is not guaranteed to produce
13886 consistent results across releases.
13888 @item -mcmove
13889 @opindex mcmove
13890 Enable the generation of conditional moves.
13892 @item -mnops=@var{num}
13893 @opindex mnops
13894 Emit @var{num} NOPs before every other generated instruction.
13896 @item -mno-soft-cmpsf
13897 @opindex mno-soft-cmpsf
13898 For single-precision floating-point comparisons, emit an @code{fsub} instruction
13899 and test the flags.  This is faster than a software comparison, but can
13900 get incorrect results in the presence of NaNs, or when two different small
13901 numbers are compared such that their difference is calculated as zero.
13902 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
13903 software comparisons.
13905 @item -mstack-offset=@var{num}
13906 @opindex mstack-offset
13907 Set the offset between the top of the stack and the stack pointer.
13908 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
13909 can be used by leaf functions without stack allocation.
13910 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
13911 Note also that this option changes the ABI; compiling a program with a
13912 different stack offset than the libraries have been compiled with
13913 generally does not work.
13914 This option can be useful if you want to evaluate if a different stack
13915 offset would give you better code, but to actually use a different stack
13916 offset to build working programs, it is recommended to configure the
13917 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
13919 @item -mno-round-nearest
13920 @opindex mno-round-nearest
13921 Make the scheduler assume that the rounding mode has been set to
13922 truncating.  The default is @option{-mround-nearest}.
13924 @item -mlong-calls
13925 @opindex mlong-calls
13926 If not otherwise specified by an attribute, assume all calls might be beyond
13927 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
13928 function address into a register before performing a (otherwise direct) call.
13929 This is the default.
13931 @item -mshort-calls
13932 @opindex short-calls
13933 If not otherwise specified by an attribute, assume all direct calls are
13934 in the range of the @code{b} / @code{bl} instructions, so use these instructions
13935 for direct calls.  The default is @option{-mlong-calls}.
13937 @item -msmall16
13938 @opindex msmall16
13939 Assume addresses can be loaded as 16-bit unsigned values.  This does not
13940 apply to function addresses for which @option{-mlong-calls} semantics
13941 are in effect.
13943 @item -mfp-mode=@var{mode}
13944 @opindex mfp-mode
13945 Set the prevailing mode of the floating-point unit.
13946 This determines the floating-point mode that is provided and expected
13947 at function call and return time.  Making this mode match the mode you
13948 predominantly need at function start can make your programs smaller and
13949 faster by avoiding unnecessary mode switches.
13951 @var{mode} can be set to one the following values:
13953 @table @samp
13954 @item caller
13955 Any mode at function entry is valid, and retained or restored when
13956 the function returns, and when it calls other functions.
13957 This mode is useful for compiling libraries or other compilation units
13958 you might want to incorporate into different programs with different
13959 prevailing FPU modes, and the convenience of being able to use a single
13960 object file outweighs the size and speed overhead for any extra
13961 mode switching that might be needed, compared with what would be needed
13962 with a more specific choice of prevailing FPU mode.
13964 @item truncate
13965 This is the mode used for floating-point calculations with
13966 truncating (i.e.@: round towards zero) rounding mode.  That includes
13967 conversion from floating point to integer.
13969 @item round-nearest
13970 This is the mode used for floating-point calculations with
13971 round-to-nearest-or-even rounding mode.
13973 @item int
13974 This is the mode used to perform integer calculations in the FPU, e.g.@:
13975 integer multiply, or integer multiply-and-accumulate.
13976 @end table
13978 The default is @option{-mfp-mode=caller}
13980 @item -mnosplit-lohi
13981 @itemx -mno-postinc
13982 @itemx -mno-postmodify
13983 @opindex mnosplit-lohi
13984 @opindex mno-postinc
13985 @opindex mno-postmodify
13986 Code generation tweaks that disable, respectively, splitting of 32-bit
13987 loads, generation of post-increment addresses, and generation of
13988 post-modify addresses.  The defaults are @option{msplit-lohi},
13989 @option{-mpost-inc}, and @option{-mpost-modify}.
13991 @item -mnovect-double
13992 @opindex mno-vect-double
13993 Change the preferred SIMD mode to SImode.  The default is
13994 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
13996 @item -max-vect-align=@var{num}
13997 @opindex max-vect-align
13998 The maximum alignment for SIMD vector mode types.
13999 @var{num} may be 4 or 8.  The default is 8.
14000 Note that this is an ABI change, even though many library function
14001 interfaces are unaffected if they don't use SIMD vector modes
14002 in places that affect size and/or alignment of relevant types.
14004 @item -msplit-vecmove-early
14005 @opindex msplit-vecmove-early
14006 Split vector moves into single word moves before reload.  In theory this
14007 can give better register allocation, but so far the reverse seems to be
14008 generally the case.
14010 @item -m1reg-@var{reg}
14011 @opindex m1reg-
14012 Specify a register to hold the constant @minus{}1, which makes loading small negative
14013 constants and certain bitmasks faster.
14014 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14015 which specify use of that register as a fixed register,
14016 and @samp{none}, which means that no register is used for this
14017 purpose.  The default is @option{-m1reg-none}.
14019 @end table
14021 @node ARC Options
14022 @subsection ARC Options
14023 @cindex ARC options
14025 The following options control the architecture variant for which code
14026 is being compiled:
14028 @c architecture variants
14029 @table @gcctabopt
14031 @item -mbarrel-shifter
14032 @opindex mbarrel-shifter
14033 Generate instructions supported by barrel shifter.  This is the default
14034 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14036 @item -mcpu=@var{cpu}
14037 @opindex mcpu
14038 Set architecture type, register usage, and instruction scheduling
14039 parameters for @var{cpu}.  There are also shortcut alias options
14040 available for backward compatibility and convenience.  Supported
14041 values for @var{cpu} are
14043 @table @samp
14044 @opindex mA6
14045 @opindex mARC600
14046 @item ARC600
14047 @item arc600
14048 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14050 @item ARC601
14051 @item arc601
14052 @opindex mARC601
14053 Compile for ARC601.  Alias: @option{-mARC601}.
14055 @item ARC700
14056 @item arc700
14057 @opindex mA7
14058 @opindex mARC700
14059 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14060 This is the default when configured with @option{--with-cpu=arc700}@.
14062 @item ARCEM
14063 @item arcem
14064 Compile for ARC EM.
14066 @item ARCHS
14067 @item archs
14068 Compile for ARC HS.
14069 @end table
14071 @item -mdpfp
14072 @opindex mdpfp
14073 @itemx -mdpfp-compact
14074 @opindex mdpfp-compact
14075 FPX: Generate Double Precision FPX instructions, tuned for the compact
14076 implementation.
14078 @item -mdpfp-fast
14079 @opindex mdpfp-fast
14080 FPX: Generate Double Precision FPX instructions, tuned for the fast
14081 implementation.
14083 @item -mno-dpfp-lrsr
14084 @opindex mno-dpfp-lrsr
14085 Disable LR and SR instructions from using FPX extension aux registers.
14087 @item -mea
14088 @opindex mea
14089 Generate Extended arithmetic instructions.  Currently only
14090 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14091 supported.  This is always enabled for @option{-mcpu=ARC700}.
14093 @item -mno-mpy
14094 @opindex mno-mpy
14095 Do not generate mpy instructions for ARC700.
14097 @item -mmul32x16
14098 @opindex mmul32x16
14099 Generate 32x16 bit multiply and mac instructions.
14101 @item -mmul64
14102 @opindex mmul64
14103 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
14105 @item -mnorm
14106 @opindex mnorm
14107 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
14108 is in effect.
14110 @item -mspfp
14111 @opindex mspfp
14112 @itemx -mspfp-compact
14113 @opindex mspfp-compact
14114 FPX: Generate Single Precision FPX instructions, tuned for the compact
14115 implementation.
14117 @item -mspfp-fast
14118 @opindex mspfp-fast
14119 FPX: Generate Single Precision FPX instructions, tuned for the fast
14120 implementation.
14122 @item -msimd
14123 @opindex msimd
14124 Enable generation of ARC SIMD instructions via target-specific
14125 builtins.  Only valid for @option{-mcpu=ARC700}.
14127 @item -msoft-float
14128 @opindex msoft-float
14129 This option ignored; it is provided for compatibility purposes only.
14130 Software floating point code is emitted by default, and this default
14131 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
14132 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
14133 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
14135 @item -mswap
14136 @opindex mswap
14137 Generate swap instructions.
14139 @item -matomic
14140 @opindex matomic
14141 This enables Locked Load/Store Conditional extension to implement
14142 atomic memopry built-in functions.  Not available for ARC 6xx or ARC
14143 EM cores.
14145 @item -mdiv-rem
14146 @opindex mdiv-rem
14147 Enable DIV/REM instructions for ARCv2 cores.
14149 @item -mcode-density
14150 @opindex mcode-density
14151 Enable code density instructions for ARC EM, default on for ARC HS.
14153 @item -mll64
14154 @opindex mll64
14155 Enable double load/store operations for ARC HS cores.
14157 @item -mtp-regno=@var{regno}
14158 @opindex mtp-regno
14159 Specify thread pointer register number.
14161 @item -mmpy-option=@var{multo}
14162 @opindex mmpy-option
14163 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
14164 the default value.  The recognized values for @var{multo} are:
14166 @table @samp
14167 @item 0
14168 No multiplier available.
14170 @item 1
14171 @opindex w
14172 The multiply option is set to w: 16x16 multiplier, fully pipelined.
14173 The following instructions are enabled: MPYW, and MPYUW.
14175 @item 2
14176 @opindex wlh1
14177 The multiply option is set to wlh1: 32x32 multiplier, fully
14178 pipelined (1 stage).  The following instructions are additionally
14179 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
14181 @item 3
14182 @opindex wlh2
14183 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
14184 (2 stages).  The following instructions are additionally enabled: MPY,
14185 MPYU, MPYM, MPYMU, and MPY_S.
14187 @item 4
14188 @opindex wlh3
14189 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
14190 sequential.  The following instructions are additionally enabled: MPY,
14191 MPYU, MPYM, MPYMU, and MPY_S.
14193 @item 5
14194 @opindex wlh4
14195 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
14196 sequential.  The following instructions are additionally enabled: MPY,
14197 MPYU, MPYM, MPYMU, and MPY_S.
14199 @item 6
14200 @opindex wlh5
14201 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
14202 sequential.  The following instructions are additionally enabled: MPY,
14203 MPYU, MPYM, MPYMU, and MPY_S.
14205 @end table
14207 This option is only available for ARCv2 cores@.
14209 @item -mfpu=@var{fpu}
14210 @opindex mfpu
14211 Enables specific floating-point hardware extension for ARCv2
14212 core.  Supported values for @var{fpu} are:
14214 @table @samp
14216 @item fpus
14217 @opindex fpus
14218 Enables support for single precision floating point hardware
14219 extensions@.
14221 @item fpud
14222 @opindex fpud
14223 Enables support for double precision floating point hardware
14224 extensions.  The single precision floating point extension is also
14225 enabled.  Not available for ARC EM@.
14227 @item fpuda
14228 @opindex fpuda
14229 Enables support for double precision floating point hardware
14230 extensions using double precision assist instructions.  The single
14231 precision floating point extension is also enabled.  This option is
14232 only available for ARC EM@.
14234 @item fpuda_div
14235 @opindex fpuda_div
14236 Enables support for double precision floating point hardware
14237 extensions using double precision assist instructions, and simple
14238 precision square-root and divide hardware extensions.  The single
14239 precision floating point extension is also enabled.  This option is
14240 only available for ARC EM@.
14242 @item fpuda_fma
14243 @opindex fpuda_fma
14244 Enables support for double precision floating point hardware
14245 extensions using double precision assist instructions, and simple
14246 precision fused multiple and add hardware extension.  The single
14247 precision floating point extension is also enabled.  This option is
14248 only available for ARC EM@.
14250 @item fpuda_all
14251 @opindex fpuda_all
14252 Enables support for double precision floating point hardware
14253 extensions using double precision assist instructions, and all simple
14254 precision hardware extensions.  The single precision floating point
14255 extension is also enabled.  This option is only available for ARC EM@.
14257 @item fpus_div
14258 @opindex fpus_div
14259 Enables support for single precision floating point, and single
14260 precision square-root and divide hardware extensions@.
14262 @item fpud_div
14263 @opindex fpud_div
14264 Enables support for double precision floating point, and double
14265 precision square-root and divide hardware extensions.  This option
14266 includes option @samp{fpus_div}. Not available for ARC EM@.
14268 @item fpus_fma
14269 @opindex fpus_fma
14270 Enables support for single precision floating point, and single
14271 precision fused multiple and add hardware extensions@.
14273 @item fpud_fma
14274 @opindex fpud_fma
14275 Enables support for double precision floating point, and double
14276 precision fused multiple and add hardware extensions.  This option
14277 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14279 @item fpus_all
14280 @opindex fpus_all
14281 Enables support for all single precision floating point hardware
14282 extensions@.
14284 @item fpud_all
14285 @opindex fpud_all
14286 Enables support for all single and double precision floating point
14287 hardware extensions.  Not available for ARC EM@.
14289 @end table
14291 @end table
14293 The following options are passed through to the assembler, and also
14294 define preprocessor macro symbols.
14296 @c Flags used by the assembler, but for which we define preprocessor
14297 @c macro symbols as well.
14298 @table @gcctabopt
14299 @item -mdsp-packa
14300 @opindex mdsp-packa
14301 Passed down to the assembler to enable the DSP Pack A extensions.
14302 Also sets the preprocessor symbol @code{__Xdsp_packa}.
14304 @item -mdvbf
14305 @opindex mdvbf
14306 Passed down to the assembler to enable the dual viterbi butterfly
14307 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
14309 @c ARC700 4.10 extension instruction
14310 @item -mlock
14311 @opindex mlock
14312 Passed down to the assembler to enable the Locked Load/Store
14313 Conditional extension.  Also sets the preprocessor symbol
14314 @code{__Xlock}.
14316 @item -mmac-d16
14317 @opindex mmac-d16
14318 Passed down to the assembler.  Also sets the preprocessor symbol
14319 @code{__Xxmac_d16}.
14321 @item -mmac-24
14322 @opindex mmac-24
14323 Passed down to the assembler.  Also sets the preprocessor symbol
14324 @code{__Xxmac_24}.
14326 @c ARC700 4.10 extension instruction
14327 @item -mrtsc
14328 @opindex mrtsc
14329 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
14330 extension instruction.  Also sets the preprocessor symbol
14331 @code{__Xrtsc}.
14333 @c ARC700 4.10 extension instruction
14334 @item -mswape
14335 @opindex mswape
14336 Passed down to the assembler to enable the swap byte ordering
14337 extension instruction.  Also sets the preprocessor symbol
14338 @code{__Xswape}.
14340 @item -mtelephony
14341 @opindex mtelephony
14342 Passed down to the assembler to enable dual and single operand
14343 instructions for telephony.  Also sets the preprocessor symbol
14344 @code{__Xtelephony}.
14346 @item -mxy
14347 @opindex mxy
14348 Passed down to the assembler to enable the XY Memory extension.  Also
14349 sets the preprocessor symbol @code{__Xxy}.
14351 @end table
14353 The following options control how the assembly code is annotated:
14355 @c Assembly annotation options
14356 @table @gcctabopt
14357 @item -misize
14358 @opindex misize
14359 Annotate assembler instructions with estimated addresses.
14361 @item -mannotate-align
14362 @opindex mannotate-align
14363 Explain what alignment considerations lead to the decision to make an
14364 instruction short or long.
14366 @end table
14368 The following options are passed through to the linker:
14370 @c options passed through to the linker
14371 @table @gcctabopt
14372 @item -marclinux
14373 @opindex marclinux
14374 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14375 This option is enabled by default in tool chains built for
14376 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14377 when profiling is not requested.
14379 @item -marclinux_prof
14380 @opindex marclinux_prof
14381 Passed through to the linker, to specify use of the
14382 @code{arclinux_prof} emulation.  This option is enabled by default in
14383 tool chains built for @w{@code{arc-linux-uclibc}} and
14384 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14386 @end table
14388 The following options control the semantics of generated code:
14390 @c semantically relevant code generation options
14391 @table @gcctabopt
14392 @item -mlong-calls
14393 @opindex mlong-calls
14394 Generate call insns as register indirect calls, thus providing access
14395 to the full 32-bit address range.
14397 @item -mmedium-calls
14398 @opindex mmedium-calls
14399 Don't use less than 25 bit addressing range for calls, which is the
14400 offset available for an unconditional branch-and-link
14401 instruction.  Conditional execution of function calls is suppressed, to
14402 allow use of the 25-bit range, rather than the 21-bit range with
14403 conditional branch-and-link.  This is the default for tool chains built
14404 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14406 @item -mno-sdata
14407 @opindex mno-sdata
14408 Do not generate sdata references.  This is the default for tool chains
14409 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14410 targets.
14412 @item -mucb-mcount
14413 @opindex mucb-mcount
14414 Instrument with mcount calls as used in UCB code.  I.e. do the
14415 counting in the callee, not the caller.  By default ARC instrumentation
14416 counts in the caller.
14418 @item -mvolatile-cache
14419 @opindex mvolatile-cache
14420 Use ordinarily cached memory accesses for volatile references.  This is the
14421 default.
14423 @item -mno-volatile-cache
14424 @opindex mno-volatile-cache
14425 Enable cache bypass for volatile references.
14427 @end table
14429 The following options fine tune code generation:
14430 @c code generation tuning options
14431 @table @gcctabopt
14432 @item -malign-call
14433 @opindex malign-call
14434 Do alignment optimizations for call instructions.
14436 @item -mauto-modify-reg
14437 @opindex mauto-modify-reg
14438 Enable the use of pre/post modify with register displacement.
14440 @item -mbbit-peephole
14441 @opindex mbbit-peephole
14442 Enable bbit peephole2.
14444 @item -mno-brcc
14445 @opindex mno-brcc
14446 This option disables a target-specific pass in @file{arc_reorg} to
14447 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
14448 generation driven by the combiner pass.
14450 @item -mcase-vector-pcrel
14451 @opindex mcase-vector-pcrel
14452 Use pc-relative switch case tables - this enables case table shortening.
14453 This is the default for @option{-Os}.
14455 @item -mcompact-casesi
14456 @opindex mcompact-casesi
14457 Enable compact casesi pattern.  This is the default for @option{-Os},
14458 and only available for ARCv1 cores.
14460 @item -mno-cond-exec
14461 @opindex mno-cond-exec
14462 Disable ARCompact specific pass to generate conditional execution instructions.
14463 Due to delay slot scheduling and interactions between operand numbers,
14464 literal sizes, instruction lengths, and the support for conditional execution,
14465 the target-independent pass to generate conditional execution is often lacking,
14466 so the ARC port has kept a special pass around that tries to find more
14467 conditional execution generating opportunities after register allocation,
14468 branch shortening, and delay slot scheduling have been done.  This pass
14469 generally, but not always, improves performance and code size, at the cost of
14470 extra compilation time, which is why there is an option to switch it off.
14471 If you have a problem with call instructions exceeding their allowable
14472 offset range because they are conditionalized, you should consider using
14473 @option{-mmedium-calls} instead.
14475 @item -mearly-cbranchsi
14476 @opindex mearly-cbranchsi
14477 Enable pre-reload use of the cbranchsi pattern.
14479 @item -mexpand-adddi
14480 @opindex mexpand-adddi
14481 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
14482 @code{add.f}, @code{adc} etc.
14484 @item -mindexed-loads
14485 @opindex mindexed-loads
14486 Enable the use of indexed loads.  This can be problematic because some
14487 optimizers then assume that indexed stores exist, which is not
14488 the case.
14490 @opindex mlra
14491 Enable Local Register Allocation.  This is still experimental for ARC,
14492 so by default the compiler uses standard reload
14493 (i.e. @option{-mno-lra}).
14495 @item -mlra-priority-none
14496 @opindex mlra-priority-none
14497 Don't indicate any priority for target registers.
14499 @item -mlra-priority-compact
14500 @opindex mlra-priority-compact
14501 Indicate target register priority for r0..r3 / r12..r15.
14503 @item -mlra-priority-noncompact
14504 @opindex mlra-priority-noncompact
14505 Reduce target register priority for r0..r3 / r12..r15.
14507 @item -mno-millicode
14508 @opindex mno-millicode
14509 When optimizing for size (using @option{-Os}), prologues and epilogues
14510 that have to save or restore a large number of registers are often
14511 shortened by using call to a special function in libgcc; this is
14512 referred to as a @emph{millicode} call.  As these calls can pose
14513 performance issues, and/or cause linking issues when linking in a
14514 nonstandard way, this option is provided to turn off millicode call
14515 generation.
14517 @item -mmixed-code
14518 @opindex mmixed-code
14519 Tweak register allocation to help 16-bit instruction generation.
14520 This generally has the effect of decreasing the average instruction size
14521 while increasing the instruction count.
14523 @item -mq-class
14524 @opindex mq-class
14525 Enable 'q' instruction alternatives.
14526 This is the default for @option{-Os}.
14528 @item -mRcq
14529 @opindex mRcq
14530 Enable Rcq constraint handling - most short code generation depends on this.
14531 This is the default.
14533 @item -mRcw
14534 @opindex mRcw
14535 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
14536 This is the default.
14538 @item -msize-level=@var{level}
14539 @opindex msize-level
14540 Fine-tune size optimization with regards to instruction lengths and alignment.
14541 The recognized values for @var{level} are:
14542 @table @samp
14543 @item 0
14544 No size optimization.  This level is deprecated and treated like @samp{1}.
14546 @item 1
14547 Short instructions are used opportunistically.
14549 @item 2
14550 In addition, alignment of loops and of code after barriers are dropped.
14552 @item 3
14553 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14555 @end table
14557 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14558 the behavior when this is not set is equivalent to level @samp{1}.
14560 @item -mtune=@var{cpu}
14561 @opindex mtune
14562 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14563 by @option{-mcpu=}.
14565 Supported values for @var{cpu} are
14567 @table @samp
14568 @item ARC600
14569 Tune for ARC600 cpu.
14571 @item ARC601
14572 Tune for ARC601 cpu.
14574 @item ARC700
14575 Tune for ARC700 cpu with standard multiplier block.
14577 @item ARC700-xmac
14578 Tune for ARC700 cpu with XMAC block.
14580 @item ARC725D
14581 Tune for ARC725D cpu.
14583 @item ARC750D
14584 Tune for ARC750D cpu.
14586 @end table
14588 @item -mmultcost=@var{num}
14589 @opindex mmultcost
14590 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14591 normal instruction.
14593 @item -munalign-prob-threshold=@var{probability}
14594 @opindex munalign-prob-threshold
14595 Set probability threshold for unaligning branches.
14596 When tuning for @samp{ARC700} and optimizing for speed, branches without
14597 filled delay slot are preferably emitted unaligned and long, unless
14598 profiling indicates that the probability for the branch to be taken
14599 is below @var{probability}.  @xref{Cross-profiling}.
14600 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14602 @end table
14604 The following options are maintained for backward compatibility, but
14605 are now deprecated and will be removed in a future release:
14607 @c Deprecated options
14608 @table @gcctabopt
14610 @item -margonaut
14611 @opindex margonaut
14612 Obsolete FPX.
14614 @item -mbig-endian
14615 @opindex mbig-endian
14616 @itemx -EB
14617 @opindex EB
14618 Compile code for big endian targets.  Use of these options is now
14619 deprecated.  Users wanting big-endian code, should use the
14620 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
14621 building the tool chain, for which big-endian is the default.
14623 @item -mlittle-endian
14624 @opindex mlittle-endian
14625 @itemx -EL
14626 @opindex EL
14627 Compile code for little endian targets.  Use of these options is now
14628 deprecated.  Users wanting little-endian code should use the
14629 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
14630 building the tool chain, for which little-endian is the default.
14632 @item -mbarrel_shifter
14633 @opindex mbarrel_shifter
14634 Replaced by @option{-mbarrel-shifter}.
14636 @item -mdpfp_compact
14637 @opindex mdpfp_compact
14638 Replaced by @option{-mdpfp-compact}.
14640 @item -mdpfp_fast
14641 @opindex mdpfp_fast
14642 Replaced by @option{-mdpfp-fast}.
14644 @item -mdsp_packa
14645 @opindex mdsp_packa
14646 Replaced by @option{-mdsp-packa}.
14648 @item -mEA
14649 @opindex mEA
14650 Replaced by @option{-mea}.
14652 @item -mmac_24
14653 @opindex mmac_24
14654 Replaced by @option{-mmac-24}.
14656 @item -mmac_d16
14657 @opindex mmac_d16
14658 Replaced by @option{-mmac-d16}.
14660 @item -mspfp_compact
14661 @opindex mspfp_compact
14662 Replaced by @option{-mspfp-compact}.
14664 @item -mspfp_fast
14665 @opindex mspfp_fast
14666 Replaced by @option{-mspfp-fast}.
14668 @item -mtune=@var{cpu}
14669 @opindex mtune
14670 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
14671 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
14672 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
14674 @item -multcost=@var{num}
14675 @opindex multcost
14676 Replaced by @option{-mmultcost}.
14678 @end table
14680 @node ARM Options
14681 @subsection ARM Options
14682 @cindex ARM options
14684 These @samp{-m} options are defined for the ARM port:
14686 @table @gcctabopt
14687 @item -mabi=@var{name}
14688 @opindex mabi
14689 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
14690 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
14692 @item -mapcs-frame
14693 @opindex mapcs-frame
14694 Generate a stack frame that is compliant with the ARM Procedure Call
14695 Standard for all functions, even if this is not strictly necessary for
14696 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
14697 with this option causes the stack frames not to be generated for
14698 leaf functions.  The default is @option{-mno-apcs-frame}.
14699 This option is deprecated.
14701 @item -mapcs
14702 @opindex mapcs
14703 This is a synonym for @option{-mapcs-frame} and is deprecated.
14705 @ignore
14706 @c not currently implemented
14707 @item -mapcs-stack-check
14708 @opindex mapcs-stack-check
14709 Generate code to check the amount of stack space available upon entry to
14710 every function (that actually uses some stack space).  If there is
14711 insufficient space available then either the function
14712 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
14713 called, depending upon the amount of stack space required.  The runtime
14714 system is required to provide these functions.  The default is
14715 @option{-mno-apcs-stack-check}, since this produces smaller code.
14717 @c not currently implemented
14718 @item -mapcs-float
14719 @opindex mapcs-float
14720 Pass floating-point arguments using the floating-point registers.  This is
14721 one of the variants of the APCS@.  This option is recommended if the
14722 target hardware has a floating-point unit or if a lot of floating-point
14723 arithmetic is going to be performed by the code.  The default is
14724 @option{-mno-apcs-float}, since the size of integer-only code is 
14725 slightly increased if @option{-mapcs-float} is used.
14727 @c not currently implemented
14728 @item -mapcs-reentrant
14729 @opindex mapcs-reentrant
14730 Generate reentrant, position-independent code.  The default is
14731 @option{-mno-apcs-reentrant}.
14732 @end ignore
14734 @item -mthumb-interwork
14735 @opindex mthumb-interwork
14736 Generate code that supports calling between the ARM and Thumb
14737 instruction sets.  Without this option, on pre-v5 architectures, the
14738 two instruction sets cannot be reliably used inside one program.  The
14739 default is @option{-mno-thumb-interwork}, since slightly larger code
14740 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
14741 configurations this option is meaningless.
14743 @item -mno-sched-prolog
14744 @opindex mno-sched-prolog
14745 Prevent the reordering of instructions in the function prologue, or the
14746 merging of those instruction with the instructions in the function's
14747 body.  This means that all functions start with a recognizable set
14748 of instructions (or in fact one of a choice from a small set of
14749 different function prologues), and this information can be used to
14750 locate the start of functions inside an executable piece of code.  The
14751 default is @option{-msched-prolog}.
14753 @item -mfloat-abi=@var{name}
14754 @opindex mfloat-abi
14755 Specifies which floating-point ABI to use.  Permissible values
14756 are: @samp{soft}, @samp{softfp} and @samp{hard}.
14758 Specifying @samp{soft} causes GCC to generate output containing
14759 library calls for floating-point operations.
14760 @samp{softfp} allows the generation of code using hardware floating-point
14761 instructions, but still uses the soft-float calling conventions.
14762 @samp{hard} allows generation of floating-point instructions
14763 and uses FPU-specific calling conventions.
14765 The default depends on the specific target configuration.  Note that
14766 the hard-float and soft-float ABIs are not link-compatible; you must
14767 compile your entire program with the same ABI, and link with a
14768 compatible set of libraries.
14770 @item -mlittle-endian
14771 @opindex mlittle-endian
14772 Generate code for a processor running in little-endian mode.  This is
14773 the default for all standard configurations.
14775 @item -mbig-endian
14776 @opindex mbig-endian
14777 Generate code for a processor running in big-endian mode; the default is
14778 to compile code for a little-endian processor.
14780 @item -march=@var{name}
14781 @opindex march
14782 This specifies the name of the target ARM architecture.  GCC uses this
14783 name to determine what kind of instructions it can emit when generating
14784 assembly code.  This option can be used in conjunction with or instead
14785 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
14786 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
14787 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
14788 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
14789 @samp{armv6kz}, @samp{armv6s-m},
14790 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
14791 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
14792 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
14793 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
14794 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
14796 Architecture revisions older than @samp{armv4t} are deprecated.
14798 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
14799 the (now mandatory) SVC instruction.
14801 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
14802 compatibility.
14804 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
14805 extensions.
14807 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
14808 architecture together with the optional CRC32 extensions.
14810 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
14811 architecture.  This also enables the features provided by
14812 @option{-march=armv8-a+crc}.
14814 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
14815 architecture.  This also enables the features provided by
14816 @option{-march=armv8.1-a}.
14818 @option{-march=armv8.2-a+fp16} enables compiler support for the
14819 ARMv8.2-A architecture with the optional FP16 instructions extension.
14820 This also enables the features provided by @option{-march=armv8.1-a}
14821 and implies @option{-mfp16-format=ieee}.
14823 @option{-march=native} causes the compiler to auto-detect the architecture
14824 of the build computer.  At present, this feature is only supported on
14825 GNU/Linux, and not all architectures are recognized.  If the auto-detect
14826 is unsuccessful the option has no effect.
14828 @item -mtune=@var{name}
14829 @opindex mtune
14830 This option specifies the name of the target ARM processor for
14831 which GCC should tune the performance of the code.
14832 For some ARM implementations better performance can be obtained by using
14833 this option.
14834 Permissible names are: @samp{arm2}, @samp{arm250},
14835 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
14836 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
14837 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
14838 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
14839 @samp{arm720},
14840 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
14841 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
14842 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
14843 @samp{strongarm1110},
14844 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
14845 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
14846 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
14847 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
14848 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
14849 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
14850 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
14851 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
14852 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
14853 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
14854 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
14855 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
14856 @samp{cortex-m7},
14857 @samp{cortex-m4},
14858 @samp{cortex-m3},
14859 @samp{cortex-m1},
14860 @samp{cortex-m0},
14861 @samp{cortex-m0plus},
14862 @samp{cortex-m1.small-multiply},
14863 @samp{cortex-m0.small-multiply},
14864 @samp{cortex-m0plus.small-multiply},
14865 @samp{exynos-m1},
14866 @samp{qdf24xx},
14867 @samp{marvell-pj4},
14868 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
14869 @samp{fa526}, @samp{fa626},
14870 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
14871 @samp{xgene1}.
14873 Additionally, this option can specify that GCC should tune the performance
14874 of the code for a big.LITTLE system.  Permissible names are:
14875 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
14876 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14877 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
14879 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
14880 performance for a blend of processors within architecture @var{arch}.
14881 The aim is to generate code that run well on the current most popular
14882 processors, balancing between optimizations that benefit some CPUs in the
14883 range, and avoiding performance pitfalls of other CPUs.  The effects of
14884 this option may change in future GCC versions as CPU models come and go.
14886 @option{-mtune=native} causes the compiler to auto-detect the CPU
14887 of the build computer.  At present, this feature is only supported on
14888 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
14889 unsuccessful the option has no effect.
14891 @item -mcpu=@var{name}
14892 @opindex mcpu
14893 This specifies the name of the target ARM processor.  GCC uses this name
14894 to derive the name of the target ARM architecture (as if specified
14895 by @option{-march}) and the ARM processor type for which to tune for
14896 performance (as if specified by @option{-mtune}).  Where this option
14897 is used in conjunction with @option{-march} or @option{-mtune},
14898 those options take precedence over the appropriate part of this option.
14900 Permissible names for this option are the same as those for
14901 @option{-mtune}.
14903 @option{-mcpu=generic-@var{arch}} is also permissible, and is
14904 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
14905 See @option{-mtune} for more information.
14907 @option{-mcpu=native} causes the compiler to auto-detect the CPU
14908 of the build computer.  At present, this feature is only supported on
14909 GNU/Linux, and not all architectures are recognized.  If the auto-detect
14910 is unsuccessful the option has no effect.
14912 @item -mfpu=@var{name}
14913 @opindex mfpu
14914 This specifies what floating-point hardware (or hardware emulation) is
14915 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
14916 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
14917 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
14918 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
14919 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
14920 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
14922 If @option{-msoft-float} is specified this specifies the format of
14923 floating-point values.
14925 If the selected floating-point hardware includes the NEON extension
14926 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
14927 operations are not generated by GCC's auto-vectorization pass unless
14928 @option{-funsafe-math-optimizations} is also specified.  This is
14929 because NEON hardware does not fully implement the IEEE 754 standard for
14930 floating-point arithmetic (in particular denormal values are treated as
14931 zero), so the use of NEON instructions may lead to a loss of precision.
14933 You can also set the fpu name at function level by using the @code{target("fpu=")} function attributes (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
14935 @item -mfp16-format=@var{name}
14936 @opindex mfp16-format
14937 Specify the format of the @code{__fp16} half-precision floating-point type.
14938 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
14939 the default is @samp{none}, in which case the @code{__fp16} type is not
14940 defined.  @xref{Half-Precision}, for more information.
14942 @item -mstructure-size-boundary=@var{n}
14943 @opindex mstructure-size-boundary
14944 The sizes of all structures and unions are rounded up to a multiple
14945 of the number of bits set by this option.  Permissible values are 8, 32
14946 and 64.  The default value varies for different toolchains.  For the COFF
14947 targeted toolchain the default value is 8.  A value of 64 is only allowed
14948 if the underlying ABI supports it.
14950 Specifying a larger number can produce faster, more efficient code, but
14951 can also increase the size of the program.  Different values are potentially
14952 incompatible.  Code compiled with one value cannot necessarily expect to
14953 work with code or libraries compiled with another value, if they exchange
14954 information using structures or unions.
14956 @item -mabort-on-noreturn
14957 @opindex mabort-on-noreturn
14958 Generate a call to the function @code{abort} at the end of a
14959 @code{noreturn} function.  It is executed if the function tries to
14960 return.
14962 @item -mlong-calls
14963 @itemx -mno-long-calls
14964 @opindex mlong-calls
14965 @opindex mno-long-calls
14966 Tells the compiler to perform function calls by first loading the
14967 address of the function into a register and then performing a subroutine
14968 call on this register.  This switch is needed if the target function
14969 lies outside of the 64-megabyte addressing range of the offset-based
14970 version of subroutine call instruction.
14972 Even if this switch is enabled, not all function calls are turned
14973 into long calls.  The heuristic is that static functions, functions
14974 that have the @code{short_call} attribute, functions that are inside
14975 the scope of a @code{#pragma no_long_calls} directive, and functions whose
14976 definitions have already been compiled within the current compilation
14977 unit are not turned into long calls.  The exceptions to this rule are
14978 that weak function definitions, functions with the @code{long_call}
14979 attribute or the @code{section} attribute, and functions that are within
14980 the scope of a @code{#pragma long_calls} directive are always
14981 turned into long calls.
14983 This feature is not enabled by default.  Specifying
14984 @option{-mno-long-calls} restores the default behavior, as does
14985 placing the function calls within the scope of a @code{#pragma
14986 long_calls_off} directive.  Note these switches have no effect on how
14987 the compiler generates code to handle function calls via function
14988 pointers.
14990 @item -msingle-pic-base
14991 @opindex msingle-pic-base
14992 Treat the register used for PIC addressing as read-only, rather than
14993 loading it in the prologue for each function.  The runtime system is
14994 responsible for initializing this register with an appropriate value
14995 before execution begins.
14997 @item -mpic-register=@var{reg}
14998 @opindex mpic-register
14999 Specify the register to be used for PIC addressing.
15000 For standard PIC base case, the default is any suitable register
15001 determined by compiler.  For single PIC base case, the default is
15002 @samp{R9} if target is EABI based or stack-checking is enabled,
15003 otherwise the default is @samp{R10}.
15005 @item -mpic-data-is-text-relative
15006 @opindex mpic-data-is-text-relative
15007 Assume that the displacement between the text and data segments is fixed
15008 at static link time.  This permits using PC-relative addressing
15009 operations to access data known to be in the data segment.  For
15010 non-VxWorks RTP targets, this option is enabled by default.  When
15011 disabled on such targets, it will enable @option{-msingle-pic-base} by
15012 default.
15014 @item -mpoke-function-name
15015 @opindex mpoke-function-name
15016 Write the name of each function into the text section, directly
15017 preceding the function prologue.  The generated code is similar to this:
15019 @smallexample
15020      t0
15021          .ascii "arm_poke_function_name", 0
15022          .align
15023      t1
15024          .word 0xff000000 + (t1 - t0)
15025      arm_poke_function_name
15026          mov     ip, sp
15027          stmfd   sp!, @{fp, ip, lr, pc@}
15028          sub     fp, ip, #4
15029 @end smallexample
15031 When performing a stack backtrace, code can inspect the value of
15032 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15033 location @code{pc - 12} and the top 8 bits are set, then we know that
15034 there is a function name embedded immediately preceding this location
15035 and has length @code{((pc[-3]) & 0xff000000)}.
15037 @item -mthumb
15038 @itemx -marm
15039 @opindex marm
15040 @opindex mthumb
15042 Select between generating code that executes in ARM and Thumb
15043 states.  The default for most configurations is to generate code
15044 that executes in ARM state, but the default can be changed by
15045 configuring GCC with the @option{--with-mode=}@var{state}
15046 configure option.
15048 You can also override the ARM and Thumb mode for each function
15049 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15050 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15052 @item -mtpcs-frame
15053 @opindex mtpcs-frame
15054 Generate a stack frame that is compliant with the Thumb Procedure Call
15055 Standard for all non-leaf functions.  (A leaf function is one that does
15056 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15058 @item -mtpcs-leaf-frame
15059 @opindex mtpcs-leaf-frame
15060 Generate a stack frame that is compliant with the Thumb Procedure Call
15061 Standard for all leaf functions.  (A leaf function is one that does
15062 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15064 @item -mcallee-super-interworking
15065 @opindex mcallee-super-interworking
15066 Gives all externally visible functions in the file being compiled an ARM
15067 instruction set header which switches to Thumb mode before executing the
15068 rest of the function.  This allows these functions to be called from
15069 non-interworking code.  This option is not valid in AAPCS configurations
15070 because interworking is enabled by default.
15072 @item -mcaller-super-interworking
15073 @opindex mcaller-super-interworking
15074 Allows calls via function pointers (including virtual functions) to
15075 execute correctly regardless of whether the target code has been
15076 compiled for interworking or not.  There is a small overhead in the cost
15077 of executing a function pointer if this option is enabled.  This option
15078 is not valid in AAPCS configurations because interworking is enabled
15079 by default.
15081 @item -mtp=@var{name}
15082 @opindex mtp
15083 Specify the access model for the thread local storage pointer.  The valid
15084 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15085 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15086 (supported in the arm6k architecture), and @samp{auto}, which uses the
15087 best available method for the selected processor.  The default setting is
15088 @samp{auto}.
15090 @item -mtls-dialect=@var{dialect}
15091 @opindex mtls-dialect
15092 Specify the dialect to use for accessing thread local storage.  Two
15093 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15094 @samp{gnu} dialect selects the original GNU scheme for supporting
15095 local and global dynamic TLS models.  The @samp{gnu2} dialect
15096 selects the GNU descriptor scheme, which provides better performance
15097 for shared libraries.  The GNU descriptor scheme is compatible with
15098 the original scheme, but does require new assembler, linker and
15099 library support.  Initial and local exec TLS models are unaffected by
15100 this option and always use the original scheme.
15102 @item -mword-relocations
15103 @opindex mword-relocations
15104 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15105 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15106 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15107 is specified.
15109 @item -mfix-cortex-m3-ldrd
15110 @opindex mfix-cortex-m3-ldrd
15111 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15112 with overlapping destination and base registers are used.  This option avoids
15113 generating these instructions.  This option is enabled by default when
15114 @option{-mcpu=cortex-m3} is specified.
15116 @item -munaligned-access
15117 @itemx -mno-unaligned-access
15118 @opindex munaligned-access
15119 @opindex mno-unaligned-access
15120 Enables (or disables) reading and writing of 16- and 32- bit values
15121 from addresses that are not 16- or 32- bit aligned.  By default
15122 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15123 ARMv8-M Baseline architectures, and enabled for all other
15124 architectures.  If unaligned access is not enabled then words in packed
15125 data structures are accessed a byte at a time.
15127 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15128 generated object file to either true or false, depending upon the
15129 setting of this option.  If unaligned access is enabled then the
15130 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15131 defined.
15133 @item -mneon-for-64bits
15134 @opindex mneon-for-64bits
15135 Enables using Neon to handle scalar 64-bits operations. This is
15136 disabled by default since the cost of moving data from core registers
15137 to Neon is high.
15139 @item -mslow-flash-data
15140 @opindex mslow-flash-data
15141 Assume loading data from flash is slower than fetching instruction.
15142 Therefore literal load is minimized for better performance.
15143 This option is only supported when compiling for ARMv7 M-profile and
15144 off by default.
15146 @item -masm-syntax-unified
15147 @opindex masm-syntax-unified
15148 Assume inline assembler is using unified asm syntax.  The default is
15149 currently off which implies divided syntax.  This option has no impact
15150 on Thumb2. However, this may change in future releases of GCC.
15151 Divided syntax should be considered deprecated.
15153 @item -mrestrict-it
15154 @opindex mrestrict-it
15155 Restricts generation of IT blocks to conform to the rules of ARMv8.
15156 IT blocks can only contain a single 16-bit instruction from a select
15157 set of instructions. This option is on by default for ARMv8 Thumb mode.
15159 @item -mprint-tune-info
15160 @opindex mprint-tune-info
15161 Print CPU tuning information as comment in assembler file.  This is
15162 an option used only for regression testing of the compiler and not
15163 intended for ordinary use in compiling code.  This option is disabled
15164 by default.
15166 @item -mpure-code
15167 @opindex mpure-code
15168 Do not allow constant data to be placed in code sections.
15169 Additionally, when compiling for ELF object format give all text sections the
15170 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15171 is only available when generating non-pic code for ARMv7-M targets.
15173 @end table
15175 @node AVR Options
15176 @subsection AVR Options
15177 @cindex AVR Options
15179 These options are defined for AVR implementations:
15181 @table @gcctabopt
15182 @item -mmcu=@var{mcu}
15183 @opindex mmcu
15184 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15186 The default for this option is@tie{}@samp{avr2}.
15188 GCC supports the following AVR devices and ISAs:
15190 @include avr-mmcu.texi
15192 @item -maccumulate-args
15193 @opindex maccumulate-args
15194 Accumulate outgoing function arguments and acquire/release the needed
15195 stack space for outgoing function arguments once in function
15196 prologue/epilogue.  Without this option, outgoing arguments are pushed
15197 before calling a function and popped afterwards.
15199 Popping the arguments after the function call can be expensive on
15200 AVR so that accumulating the stack space might lead to smaller
15201 executables because arguments need not to be removed from the
15202 stack after such a function call.
15204 This option can lead to reduced code size for functions that perform
15205 several calls to functions that get their arguments on the stack like
15206 calls to printf-like functions.
15208 @item -mbranch-cost=@var{cost}
15209 @opindex mbranch-cost
15210 Set the branch costs for conditional branch instructions to
15211 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15212 integers. The default branch cost is 0.
15214 @item -mcall-prologues
15215 @opindex mcall-prologues
15216 Functions prologues/epilogues are expanded as calls to appropriate
15217 subroutines.  Code size is smaller.
15219 @item -mint8
15220 @opindex mint8
15221 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15222 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15223 and @code{long long} is 4 bytes.  Please note that this option does not
15224 conform to the C standards, but it results in smaller code
15225 size.
15227 @item -mn-flash=@var{num}
15228 @opindex mn-flash
15229 Assume that the flash memory has a size of 
15230 @var{num} times 64@tie{}KiB.
15232 @item -mno-interrupts
15233 @opindex mno-interrupts
15234 Generated code is not compatible with hardware interrupts.
15235 Code size is smaller.
15237 @item -mrelax
15238 @opindex mrelax
15239 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15240 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15241 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15242 the assembler's command line and the @option{--relax} option to the
15243 linker's command line.
15245 Jump relaxing is performed by the linker because jump offsets are not
15246 known before code is located. Therefore, the assembler code generated by the
15247 compiler is the same, but the instructions in the executable may
15248 differ from instructions in the assembler code.
15250 Relaxing must be turned on if linker stubs are needed, see the
15251 section on @code{EIND} and linker stubs below.
15253 @item -mrmw
15254 @opindex mrmw
15255 Assume that the device supports the Read-Modify-Write
15256 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15258 @item -msp8
15259 @opindex msp8
15260 Treat the stack pointer register as an 8-bit register,
15261 i.e.@: assume the high byte of the stack pointer is zero.
15262 In general, you don't need to set this option by hand.
15264 This option is used internally by the compiler to select and
15265 build multilibs for architectures @code{avr2} and @code{avr25}.
15266 These architectures mix devices with and without @code{SPH}.
15267 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15268 the compiler driver adds or removes this option from the compiler
15269 proper's command line, because the compiler then knows if the device
15270 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15271 register or not.
15273 @item -mstrict-X
15274 @opindex mstrict-X
15275 Use address register @code{X} in a way proposed by the hardware.  This means
15276 that @code{X} is only used in indirect, post-increment or
15277 pre-decrement addressing.
15279 Without this option, the @code{X} register may be used in the same way
15280 as @code{Y} or @code{Z} which then is emulated by additional
15281 instructions.  
15282 For example, loading a value with @code{X+const} addressing with a
15283 small non-negative @code{const < 64} to a register @var{Rn} is
15284 performed as
15286 @example
15287 adiw r26, const   ; X += const
15288 ld   @var{Rn}, X        ; @var{Rn} = *X
15289 sbiw r26, const   ; X -= const
15290 @end example
15292 @item -mtiny-stack
15293 @opindex mtiny-stack
15294 Only change the lower 8@tie{}bits of the stack pointer.
15296 @item -mfract-convert-truncate
15297 @opindex mfract-convert-truncate
15298 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15300 @item -nodevicelib
15301 @opindex nodevicelib
15302 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15304 @item -Waddr-space-convert
15305 @opindex Waddr-space-convert
15306 Warn about conversions between address spaces in the case where the
15307 resulting address space is not contained in the incoming address space.
15309 @item -Wmisspelled-isr
15310 @opindex Wmisspelled-isr
15311 Warn if the ISR is misspelled, i.e. without __vector prefix.
15312 Enabled by default.
15313 @end table
15315 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15316 @cindex @code{EIND}
15317 Pointers in the implementation are 16@tie{}bits wide.
15318 The address of a function or label is represented as word address so
15319 that indirect jumps and calls can target any code address in the
15320 range of 64@tie{}Ki words.
15322 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15323 bytes of program memory space, there is a special function register called
15324 @code{EIND} that serves as most significant part of the target address
15325 when @code{EICALL} or @code{EIJMP} instructions are used.
15327 Indirect jumps and calls on these devices are handled as follows by
15328 the compiler and are subject to some limitations:
15330 @itemize @bullet
15332 @item
15333 The compiler never sets @code{EIND}.
15335 @item
15336 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15337 instructions or might read @code{EIND} directly in order to emulate an
15338 indirect call/jump by means of a @code{RET} instruction.
15340 @item
15341 The compiler assumes that @code{EIND} never changes during the startup
15342 code or during the application. In particular, @code{EIND} is not
15343 saved/restored in function or interrupt service routine
15344 prologue/epilogue.
15346 @item
15347 For indirect calls to functions and computed goto, the linker
15348 generates @emph{stubs}. Stubs are jump pads sometimes also called
15349 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15350 The stub contains a direct jump to the desired address.
15352 @item
15353 Linker relaxation must be turned on so that the linker generates
15354 the stubs correctly in all situations. See the compiler option
15355 @option{-mrelax} and the linker option @option{--relax}.
15356 There are corner cases where the linker is supposed to generate stubs
15357 but aborts without relaxation and without a helpful error message.
15359 @item
15360 The default linker script is arranged for code with @code{EIND = 0}.
15361 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15362 linker script has to be used in order to place the sections whose
15363 name start with @code{.trampolines} into the segment where @code{EIND}
15364 points to.
15366 @item
15367 The startup code from libgcc never sets @code{EIND}.
15368 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15369 For the impact of AVR-LibC on @code{EIND}, see the
15370 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15372 @item
15373 It is legitimate for user-specific startup code to set up @code{EIND}
15374 early, for example by means of initialization code located in
15375 section @code{.init3}. Such code runs prior to general startup code
15376 that initializes RAM and calls constructors, but after the bit
15377 of startup code from AVR-LibC that sets @code{EIND} to the segment
15378 where the vector table is located.
15379 @example
15380 #include <avr/io.h>
15382 static void
15383 __attribute__((section(".init3"),naked,used,no_instrument_function))
15384 init3_set_eind (void)
15386   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15387                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15389 @end example
15391 @noindent
15392 The @code{__trampolines_start} symbol is defined in the linker script.
15394 @item
15395 Stubs are generated automatically by the linker if
15396 the following two conditions are met:
15397 @itemize @minus
15399 @item The address of a label is taken by means of the @code{gs} modifier
15400 (short for @emph{generate stubs}) like so:
15401 @example
15402 LDI r24, lo8(gs(@var{func}))
15403 LDI r25, hi8(gs(@var{func}))
15404 @end example
15405 @item The final location of that label is in a code segment
15406 @emph{outside} the segment where the stubs are located.
15407 @end itemize
15409 @item
15410 The compiler emits such @code{gs} modifiers for code labels in the
15411 following situations:
15412 @itemize @minus
15413 @item Taking address of a function or code label.
15414 @item Computed goto.
15415 @item If prologue-save function is used, see @option{-mcall-prologues}
15416 command-line option.
15417 @item Switch/case dispatch tables. If you do not want such dispatch
15418 tables you can specify the @option{-fno-jump-tables} command-line option.
15419 @item C and C++ constructors/destructors called during startup/shutdown.
15420 @item If the tools hit a @code{gs()} modifier explained above.
15421 @end itemize
15423 @item
15424 Jumping to non-symbolic addresses like so is @emph{not} supported:
15426 @example
15427 int main (void)
15429     /* Call function at word address 0x2 */
15430     return ((int(*)(void)) 0x2)();
15432 @end example
15434 Instead, a stub has to be set up, i.e.@: the function has to be called
15435 through a symbol (@code{func_4} in the example):
15437 @example
15438 int main (void)
15440     extern int func_4 (void);
15442     /* Call function at byte address 0x4 */
15443     return func_4();
15445 @end example
15447 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15448 Alternatively, @code{func_4} can be defined in the linker script.
15449 @end itemize
15451 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15452 @cindex @code{RAMPD}
15453 @cindex @code{RAMPX}
15454 @cindex @code{RAMPY}
15455 @cindex @code{RAMPZ}
15456 Some AVR devices support memories larger than the 64@tie{}KiB range
15457 that can be accessed with 16-bit pointers.  To access memory locations
15458 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
15459 register is used as high part of the address:
15460 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15461 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15462 register, respectively, to get a wide address. Similarly,
15463 @code{RAMPD} is used together with direct addressing.
15465 @itemize
15466 @item
15467 The startup code initializes the @code{RAMP} special function
15468 registers with zero.
15470 @item
15471 If a @ref{AVR Named Address Spaces,named address space} other than
15472 generic or @code{__flash} is used, then @code{RAMPZ} is set
15473 as needed before the operation.
15475 @item
15476 If the device supports RAM larger than 64@tie{}KiB and the compiler
15477 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15478 is reset to zero after the operation.
15480 @item
15481 If the device comes with a specific @code{RAMP} register, the ISR
15482 prologue/epilogue saves/restores that SFR and initializes it with
15483 zero in case the ISR code might (implicitly) use it.
15485 @item
15486 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15487 If you use inline assembler to read from locations outside the
15488 16-bit address range and change one of the @code{RAMP} registers,
15489 you must reset it to zero after the access.
15491 @end itemize
15493 @subsubsection AVR Built-in Macros
15495 GCC defines several built-in macros so that the user code can test
15496 for the presence or absence of features.  Almost any of the following
15497 built-in macros are deduced from device capabilities and thus
15498 triggered by the @option{-mmcu=} command-line option.
15500 For even more AVR-specific built-in macros see
15501 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15503 @table @code
15505 @item __AVR_ARCH__
15506 Build-in macro that resolves to a decimal number that identifies the
15507 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15508 Possible values are:
15510 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15511 @code{4}, @code{5}, @code{51}, @code{6}
15513 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15514 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15516 respectively and
15518 @code{100}, @code{102}, @code{104},
15519 @code{105}, @code{106}, @code{107}
15521 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15522 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15523 If @var{mcu} specifies a device, this built-in macro is set
15524 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15525 defined to @code{4}.
15527 @item __AVR_@var{Device}__
15528 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15529 the device's name. For example, @option{-mmcu=atmega8} defines the
15530 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15531 @code{__AVR_ATtiny261A__}, etc.
15533 The built-in macros' names follow
15534 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15535 the device name as from the AVR user manual. The difference between
15536 @var{Device} in the built-in macro and @var{device} in
15537 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15539 If @var{device} is not a device but only a core architecture like
15540 @samp{avr51}, this macro is not defined.
15542 @item __AVR_DEVICE_NAME__
15543 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15544 the device's name. For example, with @option{-mmcu=atmega8} the macro
15545 is defined to @code{atmega8}.
15547 If @var{device} is not a device but only a core architecture like
15548 @samp{avr51}, this macro is not defined.
15550 @item __AVR_XMEGA__
15551 The device / architecture belongs to the XMEGA family of devices.
15553 @item __AVR_HAVE_ELPM__
15554 The device has the @code{ELPM} instruction.
15556 @item __AVR_HAVE_ELPMX__
15557 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15558 R@var{n},Z+} instructions.
15560 @item __AVR_HAVE_MOVW__
15561 The device has the @code{MOVW} instruction to perform 16-bit
15562 register-register moves.
15564 @item __AVR_HAVE_LPMX__
15565 The device has the @code{LPM R@var{n},Z} and
15566 @code{LPM R@var{n},Z+} instructions.
15568 @item __AVR_HAVE_MUL__
15569 The device has a hardware multiplier. 
15571 @item __AVR_HAVE_JMP_CALL__
15572 The device has the @code{JMP} and @code{CALL} instructions.
15573 This is the case for devices with at least 16@tie{}KiB of program
15574 memory.
15576 @item __AVR_HAVE_EIJMP_EICALL__
15577 @itemx __AVR_3_BYTE_PC__
15578 The device has the @code{EIJMP} and @code{EICALL} instructions.
15579 This is the case for devices with more than 128@tie{}KiB of program memory.
15580 This also means that the program counter
15581 (PC) is 3@tie{}bytes wide.
15583 @item __AVR_2_BYTE_PC__
15584 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15585 with up to 128@tie{}KiB of program memory.
15587 @item __AVR_HAVE_8BIT_SP__
15588 @itemx __AVR_HAVE_16BIT_SP__
15589 The stack pointer (SP) register is treated as 8-bit respectively
15590 16-bit register by the compiler.
15591 The definition of these macros is affected by @option{-mtiny-stack}.
15593 @item __AVR_HAVE_SPH__
15594 @itemx __AVR_SP8__
15595 The device has the SPH (high part of stack pointer) special function
15596 register or has an 8-bit stack pointer, respectively.
15597 The definition of these macros is affected by @option{-mmcu=} and
15598 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15599 by @option{-msp8}.
15601 @item __AVR_HAVE_RAMPD__
15602 @itemx __AVR_HAVE_RAMPX__
15603 @itemx __AVR_HAVE_RAMPY__
15604 @itemx __AVR_HAVE_RAMPZ__
15605 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15606 @code{RAMPZ} special function register, respectively.
15608 @item __NO_INTERRUPTS__
15609 This macro reflects the @option{-mno-interrupts} command-line option.
15611 @item __AVR_ERRATA_SKIP__
15612 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15613 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15614 instructions because of a hardware erratum.  Skip instructions are
15615 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15616 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15617 set.
15619 @item __AVR_ISA_RMW__
15620 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15622 @item __AVR_SFR_OFFSET__=@var{offset}
15623 Instructions that can address I/O special function registers directly
15624 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15625 address as if addressed by an instruction to access RAM like @code{LD}
15626 or @code{STS}. This offset depends on the device architecture and has
15627 to be subtracted from the RAM address in order to get the
15628 respective I/O@tie{}address.
15630 @item __WITH_AVRLIBC__
15631 The compiler is configured to be used together with AVR-Libc.
15632 See the @option{--with-avrlibc} configure option.
15634 @end table
15636 @node Blackfin Options
15637 @subsection Blackfin Options
15638 @cindex Blackfin Options
15640 @table @gcctabopt
15641 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
15642 @opindex mcpu=
15643 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
15644 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
15645 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
15646 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
15647 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
15648 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
15649 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
15650 @samp{bf561}, @samp{bf592}.
15652 The optional @var{sirevision} specifies the silicon revision of the target
15653 Blackfin processor.  Any workarounds available for the targeted silicon revision
15654 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
15655 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
15656 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
15657 hexadecimal digits representing the major and minor numbers in the silicon
15658 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
15659 is not defined.  If @var{sirevision} is @samp{any}, the
15660 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
15661 If this optional @var{sirevision} is not used, GCC assumes the latest known
15662 silicon revision of the targeted Blackfin processor.
15664 GCC defines a preprocessor macro for the specified @var{cpu}.
15665 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
15666 provided by libgloss to be linked in if @option{-msim} is not given.
15668 Without this option, @samp{bf532} is used as the processor by default.
15670 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
15671 only the preprocessor macro is defined.
15673 @item -msim
15674 @opindex msim
15675 Specifies that the program will be run on the simulator.  This causes
15676 the simulator BSP provided by libgloss to be linked in.  This option
15677 has effect only for @samp{bfin-elf} toolchain.
15678 Certain other options, such as @option{-mid-shared-library} and
15679 @option{-mfdpic}, imply @option{-msim}.
15681 @item -momit-leaf-frame-pointer
15682 @opindex momit-leaf-frame-pointer
15683 Don't keep the frame pointer in a register for leaf functions.  This
15684 avoids the instructions to save, set up and restore frame pointers and
15685 makes an extra register available in leaf functions.  The option
15686 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
15687 which might make debugging harder.
15689 @item -mspecld-anomaly
15690 @opindex mspecld-anomaly
15691 When enabled, the compiler ensures that the generated code does not
15692 contain speculative loads after jump instructions. If this option is used,
15693 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
15695 @item -mno-specld-anomaly
15696 @opindex mno-specld-anomaly
15697 Don't generate extra code to prevent speculative loads from occurring.
15699 @item -mcsync-anomaly
15700 @opindex mcsync-anomaly
15701 When enabled, the compiler ensures that the generated code does not
15702 contain CSYNC or SSYNC instructions too soon after conditional branches.
15703 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
15705 @item -mno-csync-anomaly
15706 @opindex mno-csync-anomaly
15707 Don't generate extra code to prevent CSYNC or SSYNC instructions from
15708 occurring too soon after a conditional branch.
15710 @item -mlow-64k
15711 @opindex mlow-64k
15712 When enabled, the compiler is free to take advantage of the knowledge that
15713 the entire program fits into the low 64k of memory.
15715 @item -mno-low-64k
15716 @opindex mno-low-64k
15717 Assume that the program is arbitrarily large.  This is the default.
15719 @item -mstack-check-l1
15720 @opindex mstack-check-l1
15721 Do stack checking using information placed into L1 scratchpad memory by the
15722 uClinux kernel.
15724 @item -mid-shared-library
15725 @opindex mid-shared-library
15726 Generate code that supports shared libraries via the library ID method.
15727 This allows for execute in place and shared libraries in an environment
15728 without virtual memory management.  This option implies @option{-fPIC}.
15729 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15731 @item -mno-id-shared-library
15732 @opindex mno-id-shared-library
15733 Generate code that doesn't assume ID-based shared libraries are being used.
15734 This is the default.
15736 @item -mleaf-id-shared-library
15737 @opindex mleaf-id-shared-library
15738 Generate code that supports shared libraries via the library ID method,
15739 but assumes that this library or executable won't link against any other
15740 ID shared libraries.  That allows the compiler to use faster code for jumps
15741 and calls.
15743 @item -mno-leaf-id-shared-library
15744 @opindex mno-leaf-id-shared-library
15745 Do not assume that the code being compiled won't link against any ID shared
15746 libraries.  Slower code is generated for jump and call insns.
15748 @item -mshared-library-id=n
15749 @opindex mshared-library-id
15750 Specifies the identification number of the ID-based shared library being
15751 compiled.  Specifying a value of 0 generates more compact code; specifying
15752 other values forces the allocation of that number to the current
15753 library but is no more space- or time-efficient than omitting this option.
15755 @item -msep-data
15756 @opindex msep-data
15757 Generate code that allows the data segment to be located in a different
15758 area of memory from the text segment.  This allows for execute in place in
15759 an environment without virtual memory management by eliminating relocations
15760 against the text section.
15762 @item -mno-sep-data
15763 @opindex mno-sep-data
15764 Generate code that assumes that the data segment follows the text segment.
15765 This is the default.
15767 @item -mlong-calls
15768 @itemx -mno-long-calls
15769 @opindex mlong-calls
15770 @opindex mno-long-calls
15771 Tells the compiler to perform function calls by first loading the
15772 address of the function into a register and then performing a subroutine
15773 call on this register.  This switch is needed if the target function
15774 lies outside of the 24-bit addressing range of the offset-based
15775 version of subroutine call instruction.
15777 This feature is not enabled by default.  Specifying
15778 @option{-mno-long-calls} restores the default behavior.  Note these
15779 switches have no effect on how the compiler generates code to handle
15780 function calls via function pointers.
15782 @item -mfast-fp
15783 @opindex mfast-fp
15784 Link with the fast floating-point library. This library relaxes some of
15785 the IEEE floating-point standard's rules for checking inputs against
15786 Not-a-Number (NAN), in the interest of performance.
15788 @item -minline-plt
15789 @opindex minline-plt
15790 Enable inlining of PLT entries in function calls to functions that are
15791 not known to bind locally.  It has no effect without @option{-mfdpic}.
15793 @item -mmulticore
15794 @opindex mmulticore
15795 Build a standalone application for multicore Blackfin processors. 
15796 This option causes proper start files and link scripts supporting 
15797 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
15798 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
15800 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
15801 selects the one-application-per-core programming model.  Without
15802 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
15803 programming model is used. In this model, the main function of Core B
15804 should be named as @code{coreb_main}.
15806 If this option is not used, the single-core application programming
15807 model is used.
15809 @item -mcorea
15810 @opindex mcorea
15811 Build a standalone application for Core A of BF561 when using
15812 the one-application-per-core programming model. Proper start files
15813 and link scripts are used to support Core A, and the macro
15814 @code{__BFIN_COREA} is defined.
15815 This option can only be used in conjunction with @option{-mmulticore}.
15817 @item -mcoreb
15818 @opindex mcoreb
15819 Build a standalone application for Core B of BF561 when using
15820 the one-application-per-core programming model. Proper start files
15821 and link scripts are used to support Core B, and the macro
15822 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
15823 should be used instead of @code{main}. 
15824 This option can only be used in conjunction with @option{-mmulticore}.
15826 @item -msdram
15827 @opindex msdram
15828 Build a standalone application for SDRAM. Proper start files and
15829 link scripts are used to put the application into SDRAM, and the macro
15830 @code{__BFIN_SDRAM} is defined.
15831 The loader should initialize SDRAM before loading the application.
15833 @item -micplb
15834 @opindex micplb
15835 Assume that ICPLBs are enabled at run time.  This has an effect on certain
15836 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
15837 are enabled; for standalone applications the default is off.
15838 @end table
15840 @node C6X Options
15841 @subsection C6X Options
15842 @cindex C6X Options
15844 @table @gcctabopt
15845 @item -march=@var{name}
15846 @opindex march
15847 This specifies the name of the target architecture.  GCC uses this
15848 name to determine what kind of instructions it can emit when generating
15849 assembly code.  Permissible names are: @samp{c62x},
15850 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
15852 @item -mbig-endian
15853 @opindex mbig-endian
15854 Generate code for a big-endian target.
15856 @item -mlittle-endian
15857 @opindex mlittle-endian
15858 Generate code for a little-endian target.  This is the default.
15860 @item -msim
15861 @opindex msim
15862 Choose startup files and linker script suitable for the simulator.
15864 @item -msdata=default
15865 @opindex msdata=default
15866 Put small global and static data in the @code{.neardata} section,
15867 which is pointed to by register @code{B14}.  Put small uninitialized
15868 global and static data in the @code{.bss} section, which is adjacent
15869 to the @code{.neardata} section.  Put small read-only data into the
15870 @code{.rodata} section.  The corresponding sections used for large
15871 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
15873 @item -msdata=all
15874 @opindex msdata=all
15875 Put all data, not just small objects, into the sections reserved for
15876 small data, and use addressing relative to the @code{B14} register to
15877 access them.
15879 @item -msdata=none
15880 @opindex msdata=none
15881 Make no use of the sections reserved for small data, and use absolute
15882 addresses to access all data.  Put all initialized global and static
15883 data in the @code{.fardata} section, and all uninitialized data in the
15884 @code{.far} section.  Put all constant data into the @code{.const}
15885 section.
15886 @end table
15888 @node CRIS Options
15889 @subsection CRIS Options
15890 @cindex CRIS Options
15892 These options are defined specifically for the CRIS ports.
15894 @table @gcctabopt
15895 @item -march=@var{architecture-type}
15896 @itemx -mcpu=@var{architecture-type}
15897 @opindex march
15898 @opindex mcpu
15899 Generate code for the specified architecture.  The choices for
15900 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
15901 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
15902 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
15903 @samp{v10}.
15905 @item -mtune=@var{architecture-type}
15906 @opindex mtune
15907 Tune to @var{architecture-type} everything applicable about the generated
15908 code, except for the ABI and the set of available instructions.  The
15909 choices for @var{architecture-type} are the same as for
15910 @option{-march=@var{architecture-type}}.
15912 @item -mmax-stack-frame=@var{n}
15913 @opindex mmax-stack-frame
15914 Warn when the stack frame of a function exceeds @var{n} bytes.
15916 @item -metrax4
15917 @itemx -metrax100
15918 @opindex metrax4
15919 @opindex metrax100
15920 The options @option{-metrax4} and @option{-metrax100} are synonyms for
15921 @option{-march=v3} and @option{-march=v8} respectively.
15923 @item -mmul-bug-workaround
15924 @itemx -mno-mul-bug-workaround
15925 @opindex mmul-bug-workaround
15926 @opindex mno-mul-bug-workaround
15927 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
15928 models where it applies.  This option is active by default.
15930 @item -mpdebug
15931 @opindex mpdebug
15932 Enable CRIS-specific verbose debug-related information in the assembly
15933 code.  This option also has the effect of turning off the @samp{#NO_APP}
15934 formatted-code indicator to the assembler at the beginning of the
15935 assembly file.
15937 @item -mcc-init
15938 @opindex mcc-init
15939 Do not use condition-code results from previous instruction; always emit
15940 compare and test instructions before use of condition codes.
15942 @item -mno-side-effects
15943 @opindex mno-side-effects
15944 Do not emit instructions with side effects in addressing modes other than
15945 post-increment.
15947 @item -mstack-align
15948 @itemx -mno-stack-align
15949 @itemx -mdata-align
15950 @itemx -mno-data-align
15951 @itemx -mconst-align
15952 @itemx -mno-const-align
15953 @opindex mstack-align
15954 @opindex mno-stack-align
15955 @opindex mdata-align
15956 @opindex mno-data-align
15957 @opindex mconst-align
15958 @opindex mno-const-align
15959 These options (@samp{no-} options) arrange (eliminate arrangements) for the
15960 stack frame, individual data and constants to be aligned for the maximum
15961 single data access size for the chosen CPU model.  The default is to
15962 arrange for 32-bit alignment.  ABI details such as structure layout are
15963 not affected by these options.
15965 @item -m32-bit
15966 @itemx -m16-bit
15967 @itemx -m8-bit
15968 @opindex m32-bit
15969 @opindex m16-bit
15970 @opindex m8-bit
15971 Similar to the stack- data- and const-align options above, these options
15972 arrange for stack frame, writable data and constants to all be 32-bit,
15973 16-bit or 8-bit aligned.  The default is 32-bit alignment.
15975 @item -mno-prologue-epilogue
15976 @itemx -mprologue-epilogue
15977 @opindex mno-prologue-epilogue
15978 @opindex mprologue-epilogue
15979 With @option{-mno-prologue-epilogue}, the normal function prologue and
15980 epilogue which set up the stack frame are omitted and no return
15981 instructions or return sequences are generated in the code.  Use this
15982 option only together with visual inspection of the compiled code: no
15983 warnings or errors are generated when call-saved registers must be saved,
15984 or storage for local variables needs to be allocated.
15986 @item -mno-gotplt
15987 @itemx -mgotplt
15988 @opindex mno-gotplt
15989 @opindex mgotplt
15990 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
15991 instruction sequences that load addresses for functions from the PLT part
15992 of the GOT rather than (traditional on other architectures) calls to the
15993 PLT@.  The default is @option{-mgotplt}.
15995 @item -melf
15996 @opindex melf
15997 Legacy no-op option only recognized with the cris-axis-elf and
15998 cris-axis-linux-gnu targets.
16000 @item -mlinux
16001 @opindex mlinux
16002 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16004 @item -sim
16005 @opindex sim
16006 This option, recognized for the cris-axis-elf, arranges
16007 to link with input-output functions from a simulator library.  Code,
16008 initialized data and zero-initialized data are allocated consecutively.
16010 @item -sim2
16011 @opindex sim2
16012 Like @option{-sim}, but pass linker options to locate initialized data at
16013 0x40000000 and zero-initialized data at 0x80000000.
16014 @end table
16016 @node CR16 Options
16017 @subsection CR16 Options
16018 @cindex CR16 Options
16020 These options are defined specifically for the CR16 ports.
16022 @table @gcctabopt
16024 @item -mmac
16025 @opindex mmac
16026 Enable the use of multiply-accumulate instructions. Disabled by default.
16028 @item -mcr16cplus
16029 @itemx -mcr16c
16030 @opindex mcr16cplus
16031 @opindex mcr16c
16032 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16033 is default.
16035 @item -msim
16036 @opindex msim
16037 Links the library libsim.a which is in compatible with simulator. Applicable
16038 to ELF compiler only.
16040 @item -mint32
16041 @opindex mint32
16042 Choose integer type as 32-bit wide.
16044 @item -mbit-ops
16045 @opindex mbit-ops
16046 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16048 @item -mdata-model=@var{model}
16049 @opindex mdata-model
16050 Choose a data model. The choices for @var{model} are @samp{near},
16051 @samp{far} or @samp{medium}. @samp{medium} is default.
16052 However, @samp{far} is not valid with @option{-mcr16c}, as the
16053 CR16C architecture does not support the far data model.
16054 @end table
16056 @node Darwin Options
16057 @subsection Darwin Options
16058 @cindex Darwin options
16060 These options are defined for all architectures running the Darwin operating
16061 system.
16063 FSF GCC on Darwin does not create ``fat'' object files; it creates
16064 an object file for the single architecture that GCC was built to
16065 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16066 @option{-arch} options are used; it does so by running the compiler or
16067 linker multiple times and joining the results together with
16068 @file{lipo}.
16070 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16071 @samp{i686}) is determined by the flags that specify the ISA
16072 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16073 @option{-force_cpusubtype_ALL} option can be used to override this.
16075 The Darwin tools vary in their behavior when presented with an ISA
16076 mismatch.  The assembler, @file{as}, only permits instructions to
16077 be used that are valid for the subtype of the file it is generating,
16078 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16079 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16080 and prints an error if asked to create a shared library with a less
16081 restrictive subtype than its input files (for instance, trying to put
16082 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16083 for executables, @command{ld}, quietly gives the executable the most
16084 restrictive subtype of any of its input files.
16086 @table @gcctabopt
16087 @item -F@var{dir}
16088 @opindex F
16089 Add the framework directory @var{dir} to the head of the list of
16090 directories to be searched for header files.  These directories are
16091 interleaved with those specified by @option{-I} options and are
16092 scanned in a left-to-right order.
16094 A framework directory is a directory with frameworks in it.  A
16095 framework is a directory with a @file{Headers} and/or
16096 @file{PrivateHeaders} directory contained directly in it that ends
16097 in @file{.framework}.  The name of a framework is the name of this
16098 directory excluding the @file{.framework}.  Headers associated with
16099 the framework are found in one of those two directories, with
16100 @file{Headers} being searched first.  A subframework is a framework
16101 directory that is in a framework's @file{Frameworks} directory.
16102 Includes of subframework headers can only appear in a header of a
16103 framework that contains the subframework, or in a sibling subframework
16104 header.  Two subframeworks are siblings if they occur in the same
16105 framework.  A subframework should not have the same name as a
16106 framework; a warning is issued if this is violated.  Currently a
16107 subframework cannot have subframeworks; in the future, the mechanism
16108 may be extended to support this.  The standard frameworks can be found
16109 in @file{/System/Library/Frameworks} and
16110 @file{/Library/Frameworks}.  An example include looks like
16111 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16112 the name of the framework and @file{header.h} is found in the
16113 @file{PrivateHeaders} or @file{Headers} directory.
16115 @item -iframework@var{dir}
16116 @opindex iframework
16117 Like @option{-F} except the directory is a treated as a system
16118 directory.  The main difference between this @option{-iframework} and
16119 @option{-F} is that with @option{-iframework} the compiler does not
16120 warn about constructs contained within header files found via
16121 @var{dir}.  This option is valid only for the C family of languages.
16123 @item -gused
16124 @opindex gused
16125 Emit debugging information for symbols that are used.  For stabs
16126 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16127 This is by default ON@.
16129 @item -gfull
16130 @opindex gfull
16131 Emit debugging information for all symbols and types.
16133 @item -mmacosx-version-min=@var{version}
16134 The earliest version of MacOS X that this executable will run on
16135 is @var{version}.  Typical values of @var{version} include @code{10.1},
16136 @code{10.2}, and @code{10.3.9}.
16138 If the compiler was built to use the system's headers by default,
16139 then the default for this option is the system version on which the
16140 compiler is running, otherwise the default is to make choices that
16141 are compatible with as many systems and code bases as possible.
16143 @item -mkernel
16144 @opindex mkernel
16145 Enable kernel development mode.  The @option{-mkernel} option sets
16146 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16147 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16148 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16149 applicable.  This mode also sets @option{-mno-altivec},
16150 @option{-msoft-float}, @option{-fno-builtin} and
16151 @option{-mlong-branch} for PowerPC targets.
16153 @item -mone-byte-bool
16154 @opindex mone-byte-bool
16155 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16156 By default @code{sizeof(bool)} is @code{4} when compiling for
16157 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16158 option has no effect on x86.
16160 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16161 to generate code that is not binary compatible with code generated
16162 without that switch.  Using this switch may require recompiling all
16163 other modules in a program, including system libraries.  Use this
16164 switch to conform to a non-default data model.
16166 @item -mfix-and-continue
16167 @itemx -ffix-and-continue
16168 @itemx -findirect-data
16169 @opindex mfix-and-continue
16170 @opindex ffix-and-continue
16171 @opindex findirect-data
16172 Generate code suitable for fast turnaround development, such as to
16173 allow GDB to dynamically load @file{.o} files into already-running
16174 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16175 are provided for backwards compatibility.
16177 @item -all_load
16178 @opindex all_load
16179 Loads all members of static archive libraries.
16180 See man ld(1) for more information.
16182 @item -arch_errors_fatal
16183 @opindex arch_errors_fatal
16184 Cause the errors having to do with files that have the wrong architecture
16185 to be fatal.
16187 @item -bind_at_load
16188 @opindex bind_at_load
16189 Causes the output file to be marked such that the dynamic linker will
16190 bind all undefined references when the file is loaded or launched.
16192 @item -bundle
16193 @opindex bundle
16194 Produce a Mach-o bundle format file.
16195 See man ld(1) for more information.
16197 @item -bundle_loader @var{executable}
16198 @opindex bundle_loader
16199 This option specifies the @var{executable} that will load the build
16200 output file being linked.  See man ld(1) for more information.
16202 @item -dynamiclib
16203 @opindex dynamiclib
16204 When passed this option, GCC produces a dynamic library instead of
16205 an executable when linking, using the Darwin @file{libtool} command.
16207 @item -force_cpusubtype_ALL
16208 @opindex force_cpusubtype_ALL
16209 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16210 one controlled by the @option{-mcpu} or @option{-march} option.
16212 @item -allowable_client  @var{client_name}
16213 @itemx -client_name
16214 @itemx -compatibility_version
16215 @itemx -current_version
16216 @itemx -dead_strip
16217 @itemx -dependency-file
16218 @itemx -dylib_file
16219 @itemx -dylinker_install_name
16220 @itemx -dynamic
16221 @itemx -exported_symbols_list
16222 @itemx -filelist
16223 @need 800
16224 @itemx -flat_namespace
16225 @itemx -force_flat_namespace
16226 @itemx -headerpad_max_install_names
16227 @itemx -image_base
16228 @itemx -init
16229 @itemx -install_name
16230 @itemx -keep_private_externs
16231 @itemx -multi_module
16232 @itemx -multiply_defined
16233 @itemx -multiply_defined_unused
16234 @need 800
16235 @itemx -noall_load
16236 @itemx -no_dead_strip_inits_and_terms
16237 @itemx -nofixprebinding
16238 @itemx -nomultidefs
16239 @itemx -noprebind
16240 @itemx -noseglinkedit
16241 @itemx -pagezero_size
16242 @itemx -prebind
16243 @itemx -prebind_all_twolevel_modules
16244 @itemx -private_bundle
16245 @need 800
16246 @itemx -read_only_relocs
16247 @itemx -sectalign
16248 @itemx -sectobjectsymbols
16249 @itemx -whyload
16250 @itemx -seg1addr
16251 @itemx -sectcreate
16252 @itemx -sectobjectsymbols
16253 @itemx -sectorder
16254 @itemx -segaddr
16255 @itemx -segs_read_only_addr
16256 @need 800
16257 @itemx -segs_read_write_addr
16258 @itemx -seg_addr_table
16259 @itemx -seg_addr_table_filename
16260 @itemx -seglinkedit
16261 @itemx -segprot
16262 @itemx -segs_read_only_addr
16263 @itemx -segs_read_write_addr
16264 @itemx -single_module
16265 @itemx -static
16266 @itemx -sub_library
16267 @need 800
16268 @itemx -sub_umbrella
16269 @itemx -twolevel_namespace
16270 @itemx -umbrella
16271 @itemx -undefined
16272 @itemx -unexported_symbols_list
16273 @itemx -weak_reference_mismatches
16274 @itemx -whatsloaded
16275 @opindex allowable_client
16276 @opindex client_name
16277 @opindex compatibility_version
16278 @opindex current_version
16279 @opindex dead_strip
16280 @opindex dependency-file
16281 @opindex dylib_file
16282 @opindex dylinker_install_name
16283 @opindex dynamic
16284 @opindex exported_symbols_list
16285 @opindex filelist
16286 @opindex flat_namespace
16287 @opindex force_flat_namespace
16288 @opindex headerpad_max_install_names
16289 @opindex image_base
16290 @opindex init
16291 @opindex install_name
16292 @opindex keep_private_externs
16293 @opindex multi_module
16294 @opindex multiply_defined
16295 @opindex multiply_defined_unused
16296 @opindex noall_load
16297 @opindex no_dead_strip_inits_and_terms
16298 @opindex nofixprebinding
16299 @opindex nomultidefs
16300 @opindex noprebind
16301 @opindex noseglinkedit
16302 @opindex pagezero_size
16303 @opindex prebind
16304 @opindex prebind_all_twolevel_modules
16305 @opindex private_bundle
16306 @opindex read_only_relocs
16307 @opindex sectalign
16308 @opindex sectobjectsymbols
16309 @opindex whyload
16310 @opindex seg1addr
16311 @opindex sectcreate
16312 @opindex sectobjectsymbols
16313 @opindex sectorder
16314 @opindex segaddr
16315 @opindex segs_read_only_addr
16316 @opindex segs_read_write_addr
16317 @opindex seg_addr_table
16318 @opindex seg_addr_table_filename
16319 @opindex seglinkedit
16320 @opindex segprot
16321 @opindex segs_read_only_addr
16322 @opindex segs_read_write_addr
16323 @opindex single_module
16324 @opindex static
16325 @opindex sub_library
16326 @opindex sub_umbrella
16327 @opindex twolevel_namespace
16328 @opindex umbrella
16329 @opindex undefined
16330 @opindex unexported_symbols_list
16331 @opindex weak_reference_mismatches
16332 @opindex whatsloaded
16333 These options are passed to the Darwin linker.  The Darwin linker man page
16334 describes them in detail.
16335 @end table
16337 @node DEC Alpha Options
16338 @subsection DEC Alpha Options
16340 These @samp{-m} options are defined for the DEC Alpha implementations:
16342 @table @gcctabopt
16343 @item -mno-soft-float
16344 @itemx -msoft-float
16345 @opindex mno-soft-float
16346 @opindex msoft-float
16347 Use (do not use) the hardware floating-point instructions for
16348 floating-point operations.  When @option{-msoft-float} is specified,
16349 functions in @file{libgcc.a} are used to perform floating-point
16350 operations.  Unless they are replaced by routines that emulate the
16351 floating-point operations, or compiled in such a way as to call such
16352 emulations routines, these routines issue floating-point
16353 operations.   If you are compiling for an Alpha without floating-point
16354 operations, you must ensure that the library is built so as not to call
16355 them.
16357 Note that Alpha implementations without floating-point operations are
16358 required to have floating-point registers.
16360 @item -mfp-reg
16361 @itemx -mno-fp-regs
16362 @opindex mfp-reg
16363 @opindex mno-fp-regs
16364 Generate code that uses (does not use) the floating-point register set.
16365 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16366 register set is not used, floating-point operands are passed in integer
16367 registers as if they were integers and floating-point results are passed
16368 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16369 so any function with a floating-point argument or return value called by code
16370 compiled with @option{-mno-fp-regs} must also be compiled with that
16371 option.
16373 A typical use of this option is building a kernel that does not use,
16374 and hence need not save and restore, any floating-point registers.
16376 @item -mieee
16377 @opindex mieee
16378 The Alpha architecture implements floating-point hardware optimized for
16379 maximum performance.  It is mostly compliant with the IEEE floating-point
16380 standard.  However, for full compliance, software assistance is
16381 required.  This option generates code fully IEEE-compliant code
16382 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16383 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16384 defined during compilation.  The resulting code is less efficient but is
16385 able to correctly support denormalized numbers and exceptional IEEE
16386 values such as not-a-number and plus/minus infinity.  Other Alpha
16387 compilers call this option @option{-ieee_with_no_inexact}.
16389 @item -mieee-with-inexact
16390 @opindex mieee-with-inexact
16391 This is like @option{-mieee} except the generated code also maintains
16392 the IEEE @var{inexact-flag}.  Turning on this option causes the
16393 generated code to implement fully-compliant IEEE math.  In addition to
16394 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16395 macro.  On some Alpha implementations the resulting code may execute
16396 significantly slower than the code generated by default.  Since there is
16397 very little code that depends on the @var{inexact-flag}, you should
16398 normally not specify this option.  Other Alpha compilers call this
16399 option @option{-ieee_with_inexact}.
16401 @item -mfp-trap-mode=@var{trap-mode}
16402 @opindex mfp-trap-mode
16403 This option controls what floating-point related traps are enabled.
16404 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16405 The trap mode can be set to one of four values:
16407 @table @samp
16408 @item n
16409 This is the default (normal) setting.  The only traps that are enabled
16410 are the ones that cannot be disabled in software (e.g., division by zero
16411 trap).
16413 @item u
16414 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16415 as well.
16417 @item su
16418 Like @samp{u}, but the instructions are marked to be safe for software
16419 completion (see Alpha architecture manual for details).
16421 @item sui
16422 Like @samp{su}, but inexact traps are enabled as well.
16423 @end table
16425 @item -mfp-rounding-mode=@var{rounding-mode}
16426 @opindex mfp-rounding-mode
16427 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16428 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16431 @table @samp
16432 @item n
16433 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16434 the nearest machine number or towards the even machine number in case
16435 of a tie.
16437 @item m
16438 Round towards minus infinity.
16440 @item c
16441 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16443 @item d
16444 Dynamic rounding mode.  A field in the floating-point control register
16445 (@var{fpcr}, see Alpha architecture reference manual) controls the
16446 rounding mode in effect.  The C library initializes this register for
16447 rounding towards plus infinity.  Thus, unless your program modifies the
16448 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16449 @end table
16451 @item -mtrap-precision=@var{trap-precision}
16452 @opindex mtrap-precision
16453 In the Alpha architecture, floating-point traps are imprecise.  This
16454 means without software assistance it is impossible to recover from a
16455 floating trap and program execution normally needs to be terminated.
16456 GCC can generate code that can assist operating system trap handlers
16457 in determining the exact location that caused a floating-point trap.
16458 Depending on the requirements of an application, different levels of
16459 precisions can be selected:
16461 @table @samp
16462 @item p
16463 Program precision.  This option is the default and means a trap handler
16464 can only identify which program caused a floating-point exception.
16466 @item f
16467 Function precision.  The trap handler can determine the function that
16468 caused a floating-point exception.
16470 @item i
16471 Instruction precision.  The trap handler can determine the exact
16472 instruction that caused a floating-point exception.
16473 @end table
16475 Other Alpha compilers provide the equivalent options called
16476 @option{-scope_safe} and @option{-resumption_safe}.
16478 @item -mieee-conformant
16479 @opindex mieee-conformant
16480 This option marks the generated code as IEEE conformant.  You must not
16481 use this option unless you also specify @option{-mtrap-precision=i} and either
16482 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16483 is to emit the line @samp{.eflag 48} in the function prologue of the
16484 generated assembly file.
16486 @item -mbuild-constants
16487 @opindex mbuild-constants
16488 Normally GCC examines a 32- or 64-bit integer constant to
16489 see if it can construct it from smaller constants in two or three
16490 instructions.  If it cannot, it outputs the constant as a literal and
16491 generates code to load it from the data segment at run time.
16493 Use this option to require GCC to construct @emph{all} integer constants
16494 using code, even if it takes more instructions (the maximum is six).
16496 You typically use this option to build a shared library dynamic
16497 loader.  Itself a shared library, it must relocate itself in memory
16498 before it can find the variables and constants in its own data segment.
16500 @item -mbwx
16501 @itemx -mno-bwx
16502 @itemx -mcix
16503 @itemx -mno-cix
16504 @itemx -mfix
16505 @itemx -mno-fix
16506 @itemx -mmax
16507 @itemx -mno-max
16508 @opindex mbwx
16509 @opindex mno-bwx
16510 @opindex mcix
16511 @opindex mno-cix
16512 @opindex mfix
16513 @opindex mno-fix
16514 @opindex mmax
16515 @opindex mno-max
16516 Indicate whether GCC should generate code to use the optional BWX,
16517 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16518 sets supported by the CPU type specified via @option{-mcpu=} option or that
16519 of the CPU on which GCC was built if none is specified.
16521 @item -mfloat-vax
16522 @itemx -mfloat-ieee
16523 @opindex mfloat-vax
16524 @opindex mfloat-ieee
16525 Generate code that uses (does not use) VAX F and G floating-point
16526 arithmetic instead of IEEE single and double precision.
16528 @item -mexplicit-relocs
16529 @itemx -mno-explicit-relocs
16530 @opindex mexplicit-relocs
16531 @opindex mno-explicit-relocs
16532 Older Alpha assemblers provided no way to generate symbol relocations
16533 except via assembler macros.  Use of these macros does not allow
16534 optimal instruction scheduling.  GNU binutils as of version 2.12
16535 supports a new syntax that allows the compiler to explicitly mark
16536 which relocations should apply to which instructions.  This option
16537 is mostly useful for debugging, as GCC detects the capabilities of
16538 the assembler when it is built and sets the default accordingly.
16540 @item -msmall-data
16541 @itemx -mlarge-data
16542 @opindex msmall-data
16543 @opindex mlarge-data
16544 When @option{-mexplicit-relocs} is in effect, static data is
16545 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16546 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16547 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16548 16-bit relocations off of the @code{$gp} register.  This limits the
16549 size of the small data area to 64KB, but allows the variables to be
16550 directly accessed via a single instruction.
16552 The default is @option{-mlarge-data}.  With this option the data area
16553 is limited to just below 2GB@.  Programs that require more than 2GB of
16554 data must use @code{malloc} or @code{mmap} to allocate the data in the
16555 heap instead of in the program's data segment.
16557 When generating code for shared libraries, @option{-fpic} implies
16558 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16560 @item -msmall-text
16561 @itemx -mlarge-text
16562 @opindex msmall-text
16563 @opindex mlarge-text
16564 When @option{-msmall-text} is used, the compiler assumes that the
16565 code of the entire program (or shared library) fits in 4MB, and is
16566 thus reachable with a branch instruction.  When @option{-msmall-data}
16567 is used, the compiler can assume that all local symbols share the
16568 same @code{$gp} value, and thus reduce the number of instructions
16569 required for a function call from 4 to 1.
16571 The default is @option{-mlarge-text}.
16573 @item -mcpu=@var{cpu_type}
16574 @opindex mcpu
16575 Set the instruction set and instruction scheduling parameters for
16576 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16577 style name or the corresponding chip number.  GCC supports scheduling
16578 parameters for the EV4, EV5 and EV6 family of processors and
16579 chooses the default values for the instruction set from the processor
16580 you specify.  If you do not specify a processor type, GCC defaults
16581 to the processor on which the compiler was built.
16583 Supported values for @var{cpu_type} are
16585 @table @samp
16586 @item ev4
16587 @itemx ev45
16588 @itemx 21064
16589 Schedules as an EV4 and has no instruction set extensions.
16591 @item ev5
16592 @itemx 21164
16593 Schedules as an EV5 and has no instruction set extensions.
16595 @item ev56
16596 @itemx 21164a
16597 Schedules as an EV5 and supports the BWX extension.
16599 @item pca56
16600 @itemx 21164pc
16601 @itemx 21164PC
16602 Schedules as an EV5 and supports the BWX and MAX extensions.
16604 @item ev6
16605 @itemx 21264
16606 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16608 @item ev67
16609 @itemx 21264a
16610 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16611 @end table
16613 Native toolchains also support the value @samp{native},
16614 which selects the best architecture option for the host processor.
16615 @option{-mcpu=native} has no effect if GCC does not recognize
16616 the processor.
16618 @item -mtune=@var{cpu_type}
16619 @opindex mtune
16620 Set only the instruction scheduling parameters for machine type
16621 @var{cpu_type}.  The instruction set is not changed.
16623 Native toolchains also support the value @samp{native},
16624 which selects the best architecture option for the host processor.
16625 @option{-mtune=native} has no effect if GCC does not recognize
16626 the processor.
16628 @item -mmemory-latency=@var{time}
16629 @opindex mmemory-latency
16630 Sets the latency the scheduler should assume for typical memory
16631 references as seen by the application.  This number is highly
16632 dependent on the memory access patterns used by the application
16633 and the size of the external cache on the machine.
16635 Valid options for @var{time} are
16637 @table @samp
16638 @item @var{number}
16639 A decimal number representing clock cycles.
16641 @item L1
16642 @itemx L2
16643 @itemx L3
16644 @itemx main
16645 The compiler contains estimates of the number of clock cycles for
16646 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
16647 (also called Dcache, Scache, and Bcache), as well as to main memory.
16648 Note that L3 is only valid for EV5.
16650 @end table
16651 @end table
16653 @node FR30 Options
16654 @subsection FR30 Options
16655 @cindex FR30 Options
16657 These options are defined specifically for the FR30 port.
16659 @table @gcctabopt
16661 @item -msmall-model
16662 @opindex msmall-model
16663 Use the small address space model.  This can produce smaller code, but
16664 it does assume that all symbolic values and addresses fit into a
16665 20-bit range.
16667 @item -mno-lsim
16668 @opindex mno-lsim
16669 Assume that runtime support has been provided and so there is no need
16670 to include the simulator library (@file{libsim.a}) on the linker
16671 command line.
16673 @end table
16675 @node FT32 Options
16676 @subsection FT32 Options
16677 @cindex FT32 Options
16679 These options are defined specifically for the FT32 port.
16681 @table @gcctabopt
16683 @item -msim
16684 @opindex msim
16685 Specifies that the program will be run on the simulator.  This causes
16686 an alternate runtime startup and library to be linked.
16687 You must not use this option when generating programs that will run on
16688 real hardware; you must provide your own runtime library for whatever
16689 I/O functions are needed.
16691 @item -mlra
16692 @opindex mlra
16693 Enable Local Register Allocation.  This is still experimental for FT32,
16694 so by default the compiler uses standard reload.
16696 @item -mnodiv
16697 @opindex mnodiv
16698 Do not use div and mod instructions.
16700 @end table
16702 @node FRV Options
16703 @subsection FRV Options
16704 @cindex FRV Options
16706 @table @gcctabopt
16707 @item -mgpr-32
16708 @opindex mgpr-32
16710 Only use the first 32 general-purpose registers.
16712 @item -mgpr-64
16713 @opindex mgpr-64
16715 Use all 64 general-purpose registers.
16717 @item -mfpr-32
16718 @opindex mfpr-32
16720 Use only the first 32 floating-point registers.
16722 @item -mfpr-64
16723 @opindex mfpr-64
16725 Use all 64 floating-point registers.
16727 @item -mhard-float
16728 @opindex mhard-float
16730 Use hardware instructions for floating-point operations.
16732 @item -msoft-float
16733 @opindex msoft-float
16735 Use library routines for floating-point operations.
16737 @item -malloc-cc
16738 @opindex malloc-cc
16740 Dynamically allocate condition code registers.
16742 @item -mfixed-cc
16743 @opindex mfixed-cc
16745 Do not try to dynamically allocate condition code registers, only
16746 use @code{icc0} and @code{fcc0}.
16748 @item -mdword
16749 @opindex mdword
16751 Change ABI to use double word insns.
16753 @item -mno-dword
16754 @opindex mno-dword
16756 Do not use double word instructions.
16758 @item -mdouble
16759 @opindex mdouble
16761 Use floating-point double instructions.
16763 @item -mno-double
16764 @opindex mno-double
16766 Do not use floating-point double instructions.
16768 @item -mmedia
16769 @opindex mmedia
16771 Use media instructions.
16773 @item -mno-media
16774 @opindex mno-media
16776 Do not use media instructions.
16778 @item -mmuladd
16779 @opindex mmuladd
16781 Use multiply and add/subtract instructions.
16783 @item -mno-muladd
16784 @opindex mno-muladd
16786 Do not use multiply and add/subtract instructions.
16788 @item -mfdpic
16789 @opindex mfdpic
16791 Select the FDPIC ABI, which uses function descriptors to represent
16792 pointers to functions.  Without any PIC/PIE-related options, it
16793 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
16794 assumes GOT entries and small data are within a 12-bit range from the
16795 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
16796 are computed with 32 bits.
16797 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16799 @item -minline-plt
16800 @opindex minline-plt
16802 Enable inlining of PLT entries in function calls to functions that are
16803 not known to bind locally.  It has no effect without @option{-mfdpic}.
16804 It's enabled by default if optimizing for speed and compiling for
16805 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
16806 optimization option such as @option{-O3} or above is present in the
16807 command line.
16809 @item -mTLS
16810 @opindex mTLS
16812 Assume a large TLS segment when generating thread-local code.
16814 @item -mtls
16815 @opindex mtls
16817 Do not assume a large TLS segment when generating thread-local code.
16819 @item -mgprel-ro
16820 @opindex mgprel-ro
16822 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
16823 that is known to be in read-only sections.  It's enabled by default,
16824 except for @option{-fpic} or @option{-fpie}: even though it may help
16825 make the global offset table smaller, it trades 1 instruction for 4.
16826 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
16827 one of which may be shared by multiple symbols, and it avoids the need
16828 for a GOT entry for the referenced symbol, so it's more likely to be a
16829 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
16831 @item -multilib-library-pic
16832 @opindex multilib-library-pic
16834 Link with the (library, not FD) pic libraries.  It's implied by
16835 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
16836 @option{-fpic} without @option{-mfdpic}.  You should never have to use
16837 it explicitly.
16839 @item -mlinked-fp
16840 @opindex mlinked-fp
16842 Follow the EABI requirement of always creating a frame pointer whenever
16843 a stack frame is allocated.  This option is enabled by default and can
16844 be disabled with @option{-mno-linked-fp}.
16846 @item -mlong-calls
16847 @opindex mlong-calls
16849 Use indirect addressing to call functions outside the current
16850 compilation unit.  This allows the functions to be placed anywhere
16851 within the 32-bit address space.
16853 @item -malign-labels
16854 @opindex malign-labels
16856 Try to align labels to an 8-byte boundary by inserting NOPs into the
16857 previous packet.  This option only has an effect when VLIW packing
16858 is enabled.  It doesn't create new packets; it merely adds NOPs to
16859 existing ones.
16861 @item -mlibrary-pic
16862 @opindex mlibrary-pic
16864 Generate position-independent EABI code.
16866 @item -macc-4
16867 @opindex macc-4
16869 Use only the first four media accumulator registers.
16871 @item -macc-8
16872 @opindex macc-8
16874 Use all eight media accumulator registers.
16876 @item -mpack
16877 @opindex mpack
16879 Pack VLIW instructions.
16881 @item -mno-pack
16882 @opindex mno-pack
16884 Do not pack VLIW instructions.
16886 @item -mno-eflags
16887 @opindex mno-eflags
16889 Do not mark ABI switches in e_flags.
16891 @item -mcond-move
16892 @opindex mcond-move
16894 Enable the use of conditional-move instructions (default).
16896 This switch is mainly for debugging the compiler and will likely be removed
16897 in a future version.
16899 @item -mno-cond-move
16900 @opindex mno-cond-move
16902 Disable the use of conditional-move instructions.
16904 This switch is mainly for debugging the compiler and will likely be removed
16905 in a future version.
16907 @item -mscc
16908 @opindex mscc
16910 Enable the use of conditional set instructions (default).
16912 This switch is mainly for debugging the compiler and will likely be removed
16913 in a future version.
16915 @item -mno-scc
16916 @opindex mno-scc
16918 Disable the use of conditional set instructions.
16920 This switch is mainly for debugging the compiler and will likely be removed
16921 in a future version.
16923 @item -mcond-exec
16924 @opindex mcond-exec
16926 Enable the use of conditional execution (default).
16928 This switch is mainly for debugging the compiler and will likely be removed
16929 in a future version.
16931 @item -mno-cond-exec
16932 @opindex mno-cond-exec
16934 Disable the use of conditional execution.
16936 This switch is mainly for debugging the compiler and will likely be removed
16937 in a future version.
16939 @item -mvliw-branch
16940 @opindex mvliw-branch
16942 Run a pass to pack branches into VLIW instructions (default).
16944 This switch is mainly for debugging the compiler and will likely be removed
16945 in a future version.
16947 @item -mno-vliw-branch
16948 @opindex mno-vliw-branch
16950 Do not run a pass to pack branches into VLIW instructions.
16952 This switch is mainly for debugging the compiler and will likely be removed
16953 in a future version.
16955 @item -mmulti-cond-exec
16956 @opindex mmulti-cond-exec
16958 Enable optimization of @code{&&} and @code{||} in conditional execution
16959 (default).
16961 This switch is mainly for debugging the compiler and will likely be removed
16962 in a future version.
16964 @item -mno-multi-cond-exec
16965 @opindex mno-multi-cond-exec
16967 Disable optimization of @code{&&} and @code{||} in conditional execution.
16969 This switch is mainly for debugging the compiler and will likely be removed
16970 in a future version.
16972 @item -mnested-cond-exec
16973 @opindex mnested-cond-exec
16975 Enable nested conditional execution optimizations (default).
16977 This switch is mainly for debugging the compiler and will likely be removed
16978 in a future version.
16980 @item -mno-nested-cond-exec
16981 @opindex mno-nested-cond-exec
16983 Disable nested conditional execution optimizations.
16985 This switch is mainly for debugging the compiler and will likely be removed
16986 in a future version.
16988 @item -moptimize-membar
16989 @opindex moptimize-membar
16991 This switch removes redundant @code{membar} instructions from the
16992 compiler-generated code.  It is enabled by default.
16994 @item -mno-optimize-membar
16995 @opindex mno-optimize-membar
16997 This switch disables the automatic removal of redundant @code{membar}
16998 instructions from the generated code.
17000 @item -mtomcat-stats
17001 @opindex mtomcat-stats
17003 Cause gas to print out tomcat statistics.
17005 @item -mcpu=@var{cpu}
17006 @opindex mcpu
17008 Select the processor type for which to generate code.  Possible values are
17009 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17010 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17012 @end table
17014 @node GNU/Linux Options
17015 @subsection GNU/Linux Options
17017 These @samp{-m} options are defined for GNU/Linux targets:
17019 @table @gcctabopt
17020 @item -mglibc
17021 @opindex mglibc
17022 Use the GNU C library.  This is the default except
17023 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17024 @samp{*-*-linux-*android*} targets.
17026 @item -muclibc
17027 @opindex muclibc
17028 Use uClibc C library.  This is the default on
17029 @samp{*-*-linux-*uclibc*} targets.
17031 @item -mmusl
17032 @opindex mmusl
17033 Use the musl C library.  This is the default on
17034 @samp{*-*-linux-*musl*} targets.
17036 @item -mbionic
17037 @opindex mbionic
17038 Use Bionic C library.  This is the default on
17039 @samp{*-*-linux-*android*} targets.
17041 @item -mandroid
17042 @opindex mandroid
17043 Compile code compatible with Android platform.  This is the default on
17044 @samp{*-*-linux-*android*} targets.
17046 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17047 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17048 this option makes the GCC driver pass Android-specific options to the linker.
17049 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17050 to be defined.
17052 @item -tno-android-cc
17053 @opindex tno-android-cc
17054 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17055 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17056 @option{-fno-rtti} by default.
17058 @item -tno-android-ld
17059 @opindex tno-android-ld
17060 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17061 linking options to the linker.
17063 @end table
17065 @node H8/300 Options
17066 @subsection H8/300 Options
17068 These @samp{-m} options are defined for the H8/300 implementations:
17070 @table @gcctabopt
17071 @item -mrelax
17072 @opindex mrelax
17073 Shorten some address references at link time, when possible; uses the
17074 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17075 ld, Using ld}, for a fuller description.
17077 @item -mh
17078 @opindex mh
17079 Generate code for the H8/300H@.
17081 @item -ms
17082 @opindex ms
17083 Generate code for the H8S@.
17085 @item -mn
17086 @opindex mn
17087 Generate code for the H8S and H8/300H in the normal mode.  This switch
17088 must be used either with @option{-mh} or @option{-ms}.
17090 @item -ms2600
17091 @opindex ms2600
17092 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17094 @item -mexr
17095 @opindex mexr
17096 Extended registers are stored on stack before execution of function
17097 with monitor attribute. Default option is @option{-mexr}.
17098 This option is valid only for H8S targets.
17100 @item -mno-exr
17101 @opindex mno-exr
17102 Extended registers are not stored on stack before execution of function 
17103 with monitor attribute. Default option is @option{-mno-exr}. 
17104 This option is valid only for H8S targets.
17106 @item -mint32
17107 @opindex mint32
17108 Make @code{int} data 32 bits by default.
17110 @item -malign-300
17111 @opindex malign-300
17112 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17113 The default for the H8/300H and H8S is to align longs and floats on
17114 4-byte boundaries.
17115 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17116 This option has no effect on the H8/300.
17117 @end table
17119 @node HPPA Options
17120 @subsection HPPA Options
17121 @cindex HPPA Options
17123 These @samp{-m} options are defined for the HPPA family of computers:
17125 @table @gcctabopt
17126 @item -march=@var{architecture-type}
17127 @opindex march
17128 Generate code for the specified architecture.  The choices for
17129 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17130 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17131 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17132 architecture option for your machine.  Code compiled for lower numbered
17133 architectures runs on higher numbered architectures, but not the
17134 other way around.
17136 @item -mpa-risc-1-0
17137 @itemx -mpa-risc-1-1
17138 @itemx -mpa-risc-2-0
17139 @opindex mpa-risc-1-0
17140 @opindex mpa-risc-1-1
17141 @opindex mpa-risc-2-0
17142 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17144 @item -mjump-in-delay
17145 @opindex mjump-in-delay
17146 This option is ignored and provided for compatibility purposes only.
17148 @item -mdisable-fpregs
17149 @opindex mdisable-fpregs
17150 Prevent floating-point registers from being used in any manner.  This is
17151 necessary for compiling kernels that perform lazy context switching of
17152 floating-point registers.  If you use this option and attempt to perform
17153 floating-point operations, the compiler aborts.
17155 @item -mdisable-indexing
17156 @opindex mdisable-indexing
17157 Prevent the compiler from using indexing address modes.  This avoids some
17158 rather obscure problems when compiling MIG generated code under MACH@.
17160 @item -mno-space-regs
17161 @opindex mno-space-regs
17162 Generate code that assumes the target has no space registers.  This allows
17163 GCC to generate faster indirect calls and use unscaled index address modes.
17165 Such code is suitable for level 0 PA systems and kernels.
17167 @item -mfast-indirect-calls
17168 @opindex mfast-indirect-calls
17169 Generate code that assumes calls never cross space boundaries.  This
17170 allows GCC to emit code that performs faster indirect calls.
17172 This option does not work in the presence of shared libraries or nested
17173 functions.
17175 @item -mfixed-range=@var{register-range}
17176 @opindex mfixed-range
17177 Generate code treating the given register range as fixed registers.
17178 A fixed register is one that the register allocator cannot use.  This is
17179 useful when compiling kernel code.  A register range is specified as
17180 two registers separated by a dash.  Multiple register ranges can be
17181 specified separated by a comma.
17183 @item -mlong-load-store
17184 @opindex mlong-load-store
17185 Generate 3-instruction load and store sequences as sometimes required by
17186 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17187 the HP compilers.
17189 @item -mportable-runtime
17190 @opindex mportable-runtime
17191 Use the portable calling conventions proposed by HP for ELF systems.
17193 @item -mgas
17194 @opindex mgas
17195 Enable the use of assembler directives only GAS understands.
17197 @item -mschedule=@var{cpu-type}
17198 @opindex mschedule
17199 Schedule code according to the constraints for the machine type
17200 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17201 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17202 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17203 proper scheduling option for your machine.  The default scheduling is
17204 @samp{8000}.
17206 @item -mlinker-opt
17207 @opindex mlinker-opt
17208 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17209 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17210 linkers in which they give bogus error messages when linking some programs.
17212 @item -msoft-float
17213 @opindex msoft-float
17214 Generate output containing library calls for floating point.
17215 @strong{Warning:} the requisite libraries are not available for all HPPA
17216 targets.  Normally the facilities of the machine's usual C compiler are
17217 used, but this cannot be done directly in cross-compilation.  You must make
17218 your own arrangements to provide suitable library functions for
17219 cross-compilation.
17221 @option{-msoft-float} changes the calling convention in the output file;
17222 therefore, it is only useful if you compile @emph{all} of a program with
17223 this option.  In particular, you need to compile @file{libgcc.a}, the
17224 library that comes with GCC, with @option{-msoft-float} in order for
17225 this to work.
17227 @item -msio
17228 @opindex msio
17229 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17230 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17231 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17232 options are available under HP-UX and HI-UX@.
17234 @item -mgnu-ld
17235 @opindex mgnu-ld
17236 Use options specific to GNU @command{ld}.
17237 This passes @option{-shared} to @command{ld} when
17238 building a shared library.  It is the default when GCC is configured,
17239 explicitly or implicitly, with the GNU linker.  This option does not
17240 affect which @command{ld} is called; it only changes what parameters
17241 are passed to that @command{ld}.
17242 The @command{ld} that is called is determined by the
17243 @option{--with-ld} configure option, GCC's program search path, and
17244 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17245 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17246 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17248 @item -mhp-ld
17249 @opindex mhp-ld
17250 Use options specific to HP @command{ld}.
17251 This passes @option{-b} to @command{ld} when building
17252 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17253 links.  It is the default when GCC is configured, explicitly or
17254 implicitly, with the HP linker.  This option does not affect
17255 which @command{ld} is called; it only changes what parameters are passed to that
17256 @command{ld}.
17257 The @command{ld} that is called is determined by the @option{--with-ld}
17258 configure option, GCC's program search path, and finally by the user's
17259 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17260 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17261 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17263 @item -mlong-calls
17264 @opindex mno-long-calls
17265 Generate code that uses long call sequences.  This ensures that a call
17266 is always able to reach linker generated stubs.  The default is to generate
17267 long calls only when the distance from the call site to the beginning
17268 of the function or translation unit, as the case may be, exceeds a
17269 predefined limit set by the branch type being used.  The limits for
17270 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17271 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17272 240,000 bytes.
17274 Distances are measured from the beginning of functions when using the
17275 @option{-ffunction-sections} option, or when using the @option{-mgas}
17276 and @option{-mno-portable-runtime} options together under HP-UX with
17277 the SOM linker.
17279 It is normally not desirable to use this option as it degrades
17280 performance.  However, it may be useful in large applications,
17281 particularly when partial linking is used to build the application.
17283 The types of long calls used depends on the capabilities of the
17284 assembler and linker, and the type of code being generated.  The
17285 impact on systems that support long absolute calls, and long pic
17286 symbol-difference or pc-relative calls should be relatively small.
17287 However, an indirect call is used on 32-bit ELF systems in pic code
17288 and it is quite long.
17290 @item -munix=@var{unix-std}
17291 @opindex march
17292 Generate compiler predefines and select a startfile for the specified
17293 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17294 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17295 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17296 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17297 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17298 and later.
17300 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17301 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17302 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17303 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17304 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17305 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17307 It is @emph{important} to note that this option changes the interfaces
17308 for various library routines.  It also affects the operational behavior
17309 of the C library.  Thus, @emph{extreme} care is needed in using this
17310 option.
17312 Library code that is intended to operate with more than one UNIX
17313 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17314 as appropriate.  Most GNU software doesn't provide this capability.
17316 @item -nolibdld
17317 @opindex nolibdld
17318 Suppress the generation of link options to search libdld.sl when the
17319 @option{-static} option is specified on HP-UX 10 and later.
17321 @item -static
17322 @opindex static
17323 The HP-UX implementation of setlocale in libc has a dependency on
17324 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17325 when the @option{-static} option is specified, special link options
17326 are needed to resolve this dependency.
17328 On HP-UX 10 and later, the GCC driver adds the necessary options to
17329 link with libdld.sl when the @option{-static} option is specified.
17330 This causes the resulting binary to be dynamic.  On the 64-bit port,
17331 the linkers generate dynamic binaries by default in any case.  The
17332 @option{-nolibdld} option can be used to prevent the GCC driver from
17333 adding these link options.
17335 @item -threads
17336 @opindex threads
17337 Add support for multithreading with the @dfn{dce thread} library
17338 under HP-UX@.  This option sets flags for both the preprocessor and
17339 linker.
17340 @end table
17342 @node IA-64 Options
17343 @subsection IA-64 Options
17344 @cindex IA-64 Options
17346 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17348 @table @gcctabopt
17349 @item -mbig-endian
17350 @opindex mbig-endian
17351 Generate code for a big-endian target.  This is the default for HP-UX@.
17353 @item -mlittle-endian
17354 @opindex mlittle-endian
17355 Generate code for a little-endian target.  This is the default for AIX5
17356 and GNU/Linux.
17358 @item -mgnu-as
17359 @itemx -mno-gnu-as
17360 @opindex mgnu-as
17361 @opindex mno-gnu-as
17362 Generate (or don't) code for the GNU assembler.  This is the default.
17363 @c Also, this is the default if the configure option @option{--with-gnu-as}
17364 @c is used.
17366 @item -mgnu-ld
17367 @itemx -mno-gnu-ld
17368 @opindex mgnu-ld
17369 @opindex mno-gnu-ld
17370 Generate (or don't) code for the GNU linker.  This is the default.
17371 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17372 @c is used.
17374 @item -mno-pic
17375 @opindex mno-pic
17376 Generate code that does not use a global pointer register.  The result
17377 is not position independent code, and violates the IA-64 ABI@.
17379 @item -mvolatile-asm-stop
17380 @itemx -mno-volatile-asm-stop
17381 @opindex mvolatile-asm-stop
17382 @opindex mno-volatile-asm-stop
17383 Generate (or don't) a stop bit immediately before and after volatile asm
17384 statements.
17386 @item -mregister-names
17387 @itemx -mno-register-names
17388 @opindex mregister-names
17389 @opindex mno-register-names
17390 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17391 the stacked registers.  This may make assembler output more readable.
17393 @item -mno-sdata
17394 @itemx -msdata
17395 @opindex mno-sdata
17396 @opindex msdata
17397 Disable (or enable) optimizations that use the small data section.  This may
17398 be useful for working around optimizer bugs.
17400 @item -mconstant-gp
17401 @opindex mconstant-gp
17402 Generate code that uses a single constant global pointer value.  This is
17403 useful when compiling kernel code.
17405 @item -mauto-pic
17406 @opindex mauto-pic
17407 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17408 This is useful when compiling firmware code.
17410 @item -minline-float-divide-min-latency
17411 @opindex minline-float-divide-min-latency
17412 Generate code for inline divides of floating-point values
17413 using the minimum latency algorithm.
17415 @item -minline-float-divide-max-throughput
17416 @opindex minline-float-divide-max-throughput
17417 Generate code for inline divides of floating-point values
17418 using the maximum throughput algorithm.
17420 @item -mno-inline-float-divide
17421 @opindex mno-inline-float-divide
17422 Do not generate inline code for divides of floating-point values.
17424 @item -minline-int-divide-min-latency
17425 @opindex minline-int-divide-min-latency
17426 Generate code for inline divides of integer values
17427 using the minimum latency algorithm.
17429 @item -minline-int-divide-max-throughput
17430 @opindex minline-int-divide-max-throughput
17431 Generate code for inline divides of integer values
17432 using the maximum throughput algorithm.
17434 @item -mno-inline-int-divide
17435 @opindex mno-inline-int-divide
17436 Do not generate inline code for divides of integer values.
17438 @item -minline-sqrt-min-latency
17439 @opindex minline-sqrt-min-latency
17440 Generate code for inline square roots
17441 using the minimum latency algorithm.
17443 @item -minline-sqrt-max-throughput
17444 @opindex minline-sqrt-max-throughput
17445 Generate code for inline square roots
17446 using the maximum throughput algorithm.
17448 @item -mno-inline-sqrt
17449 @opindex mno-inline-sqrt
17450 Do not generate inline code for @code{sqrt}.
17452 @item -mfused-madd
17453 @itemx -mno-fused-madd
17454 @opindex mfused-madd
17455 @opindex mno-fused-madd
17456 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17457 instructions.  The default is to use these instructions.
17459 @item -mno-dwarf2-asm
17460 @itemx -mdwarf2-asm
17461 @opindex mno-dwarf2-asm
17462 @opindex mdwarf2-asm
17463 Don't (or do) generate assembler code for the DWARF line number debugging
17464 info.  This may be useful when not using the GNU assembler.
17466 @item -mearly-stop-bits
17467 @itemx -mno-early-stop-bits
17468 @opindex mearly-stop-bits
17469 @opindex mno-early-stop-bits
17470 Allow stop bits to be placed earlier than immediately preceding the
17471 instruction that triggered the stop bit.  This can improve instruction
17472 scheduling, but does not always do so.
17474 @item -mfixed-range=@var{register-range}
17475 @opindex mfixed-range
17476 Generate code treating the given register range as fixed registers.
17477 A fixed register is one that the register allocator cannot use.  This is
17478 useful when compiling kernel code.  A register range is specified as
17479 two registers separated by a dash.  Multiple register ranges can be
17480 specified separated by a comma.
17482 @item -mtls-size=@var{tls-size}
17483 @opindex mtls-size
17484 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17487 @item -mtune=@var{cpu-type}
17488 @opindex mtune
17489 Tune the instruction scheduling for a particular CPU, Valid values are
17490 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17491 and @samp{mckinley}.
17493 @item -milp32
17494 @itemx -mlp64
17495 @opindex milp32
17496 @opindex mlp64
17497 Generate code for a 32-bit or 64-bit environment.
17498 The 32-bit environment sets int, long and pointer to 32 bits.
17499 The 64-bit environment sets int to 32 bits and long and pointer
17500 to 64 bits.  These are HP-UX specific flags.
17502 @item -mno-sched-br-data-spec
17503 @itemx -msched-br-data-spec
17504 @opindex mno-sched-br-data-spec
17505 @opindex msched-br-data-spec
17506 (Dis/En)able data speculative scheduling before reload.
17507 This results in generation of @code{ld.a} instructions and
17508 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17509 The default setting is disabled.
17511 @item -msched-ar-data-spec
17512 @itemx -mno-sched-ar-data-spec
17513 @opindex msched-ar-data-spec
17514 @opindex mno-sched-ar-data-spec
17515 (En/Dis)able data speculative scheduling after reload.
17516 This results in generation of @code{ld.a} instructions and
17517 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17518 The default setting is enabled.
17520 @item -mno-sched-control-spec
17521 @itemx -msched-control-spec
17522 @opindex mno-sched-control-spec
17523 @opindex msched-control-spec
17524 (Dis/En)able control speculative scheduling.  This feature is
17525 available only during region scheduling (i.e.@: before reload).
17526 This results in generation of the @code{ld.s} instructions and
17527 the corresponding check instructions @code{chk.s}.
17528 The default setting is disabled.
17530 @item -msched-br-in-data-spec
17531 @itemx -mno-sched-br-in-data-spec
17532 @opindex msched-br-in-data-spec
17533 @opindex mno-sched-br-in-data-spec
17534 (En/Dis)able speculative scheduling of the instructions that
17535 are dependent on the data speculative loads before reload.
17536 This is effective only with @option{-msched-br-data-spec} enabled.
17537 The default setting is enabled.
17539 @item -msched-ar-in-data-spec
17540 @itemx -mno-sched-ar-in-data-spec
17541 @opindex msched-ar-in-data-spec
17542 @opindex mno-sched-ar-in-data-spec
17543 (En/Dis)able speculative scheduling of the instructions that
17544 are dependent on the data speculative loads after reload.
17545 This is effective only with @option{-msched-ar-data-spec} enabled.
17546 The default setting is enabled.
17548 @item -msched-in-control-spec
17549 @itemx -mno-sched-in-control-spec
17550 @opindex msched-in-control-spec
17551 @opindex mno-sched-in-control-spec
17552 (En/Dis)able speculative scheduling of the instructions that
17553 are dependent on the control speculative loads.
17554 This is effective only with @option{-msched-control-spec} enabled.
17555 The default setting is enabled.
17557 @item -mno-sched-prefer-non-data-spec-insns
17558 @itemx -msched-prefer-non-data-spec-insns
17559 @opindex mno-sched-prefer-non-data-spec-insns
17560 @opindex msched-prefer-non-data-spec-insns
17561 If enabled, data-speculative instructions are chosen for schedule
17562 only if there are no other choices at the moment.  This makes
17563 the use of the data speculation much more conservative.
17564 The default setting is disabled.
17566 @item -mno-sched-prefer-non-control-spec-insns
17567 @itemx -msched-prefer-non-control-spec-insns
17568 @opindex mno-sched-prefer-non-control-spec-insns
17569 @opindex msched-prefer-non-control-spec-insns
17570 If enabled, control-speculative instructions are chosen for schedule
17571 only if there are no other choices at the moment.  This makes
17572 the use of the control speculation much more conservative.
17573 The default setting is disabled.
17575 @item -mno-sched-count-spec-in-critical-path
17576 @itemx -msched-count-spec-in-critical-path
17577 @opindex mno-sched-count-spec-in-critical-path
17578 @opindex msched-count-spec-in-critical-path
17579 If enabled, speculative dependencies are considered during
17580 computation of the instructions priorities.  This makes the use of the
17581 speculation a bit more conservative.
17582 The default setting is disabled.
17584 @item -msched-spec-ldc
17585 @opindex msched-spec-ldc
17586 Use a simple data speculation check.  This option is on by default.
17588 @item -msched-control-spec-ldc
17589 @opindex msched-spec-ldc
17590 Use a simple check for control speculation.  This option is on by default.
17592 @item -msched-stop-bits-after-every-cycle
17593 @opindex msched-stop-bits-after-every-cycle
17594 Place a stop bit after every cycle when scheduling.  This option is on
17595 by default.
17597 @item -msched-fp-mem-deps-zero-cost
17598 @opindex msched-fp-mem-deps-zero-cost
17599 Assume that floating-point stores and loads are not likely to cause a conflict
17600 when placed into the same instruction group.  This option is disabled by
17601 default.
17603 @item -msel-sched-dont-check-control-spec
17604 @opindex msel-sched-dont-check-control-spec
17605 Generate checks for control speculation in selective scheduling.
17606 This flag is disabled by default.
17608 @item -msched-max-memory-insns=@var{max-insns}
17609 @opindex msched-max-memory-insns
17610 Limit on the number of memory insns per instruction group, giving lower
17611 priority to subsequent memory insns attempting to schedule in the same
17612 instruction group. Frequently useful to prevent cache bank conflicts.
17613 The default value is 1.
17615 @item -msched-max-memory-insns-hard-limit
17616 @opindex msched-max-memory-insns-hard-limit
17617 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
17618 disallowing more than that number in an instruction group.
17619 Otherwise, the limit is ``soft'', meaning that non-memory operations
17620 are preferred when the limit is reached, but memory operations may still
17621 be scheduled.
17623 @end table
17625 @node LM32 Options
17626 @subsection LM32 Options
17627 @cindex LM32 options
17629 These @option{-m} options are defined for the LatticeMico32 architecture:
17631 @table @gcctabopt
17632 @item -mbarrel-shift-enabled
17633 @opindex mbarrel-shift-enabled
17634 Enable barrel-shift instructions.
17636 @item -mdivide-enabled
17637 @opindex mdivide-enabled
17638 Enable divide and modulus instructions.
17640 @item -mmultiply-enabled
17641 @opindex multiply-enabled
17642 Enable multiply instructions.
17644 @item -msign-extend-enabled
17645 @opindex msign-extend-enabled
17646 Enable sign extend instructions.
17648 @item -muser-enabled
17649 @opindex muser-enabled
17650 Enable user-defined instructions.
17652 @end table
17654 @node M32C Options
17655 @subsection M32C Options
17656 @cindex M32C options
17658 @table @gcctabopt
17659 @item -mcpu=@var{name}
17660 @opindex mcpu=
17661 Select the CPU for which code is generated.  @var{name} may be one of
17662 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
17663 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
17664 the M32C/80 series.
17666 @item -msim
17667 @opindex msim
17668 Specifies that the program will be run on the simulator.  This causes
17669 an alternate runtime library to be linked in which supports, for
17670 example, file I/O@.  You must not use this option when generating
17671 programs that will run on real hardware; you must provide your own
17672 runtime library for whatever I/O functions are needed.
17674 @item -memregs=@var{number}
17675 @opindex memregs=
17676 Specifies the number of memory-based pseudo-registers GCC uses
17677 during code generation.  These pseudo-registers are used like real
17678 registers, so there is a tradeoff between GCC's ability to fit the
17679 code into available registers, and the performance penalty of using
17680 memory instead of registers.  Note that all modules in a program must
17681 be compiled with the same value for this option.  Because of that, you
17682 must not use this option with GCC's default runtime libraries.
17684 @end table
17686 @node M32R/D Options
17687 @subsection M32R/D Options
17688 @cindex M32R/D options
17690 These @option{-m} options are defined for Renesas M32R/D architectures:
17692 @table @gcctabopt
17693 @item -m32r2
17694 @opindex m32r2
17695 Generate code for the M32R/2@.
17697 @item -m32rx
17698 @opindex m32rx
17699 Generate code for the M32R/X@.
17701 @item -m32r
17702 @opindex m32r
17703 Generate code for the M32R@.  This is the default.
17705 @item -mmodel=small
17706 @opindex mmodel=small
17707 Assume all objects live in the lower 16MB of memory (so that their addresses
17708 can be loaded with the @code{ld24} instruction), and assume all subroutines
17709 are reachable with the @code{bl} instruction.
17710 This is the default.
17712 The addressability of a particular object can be set with the
17713 @code{model} attribute.
17715 @item -mmodel=medium
17716 @opindex mmodel=medium
17717 Assume objects may be anywhere in the 32-bit address space (the compiler
17718 generates @code{seth/add3} instructions to load their addresses), and
17719 assume all subroutines are reachable with the @code{bl} instruction.
17721 @item -mmodel=large
17722 @opindex mmodel=large
17723 Assume objects may be anywhere in the 32-bit address space (the compiler
17724 generates @code{seth/add3} instructions to load their addresses), and
17725 assume subroutines may not be reachable with the @code{bl} instruction
17726 (the compiler generates the much slower @code{seth/add3/jl}
17727 instruction sequence).
17729 @item -msdata=none
17730 @opindex msdata=none
17731 Disable use of the small data area.  Variables are put into
17732 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
17733 @code{section} attribute has been specified).
17734 This is the default.
17736 The small data area consists of sections @code{.sdata} and @code{.sbss}.
17737 Objects may be explicitly put in the small data area with the
17738 @code{section} attribute using one of these sections.
17740 @item -msdata=sdata
17741 @opindex msdata=sdata
17742 Put small global and static data in the small data area, but do not
17743 generate special code to reference them.
17745 @item -msdata=use
17746 @opindex msdata=use
17747 Put small global and static data in the small data area, and generate
17748 special instructions to reference them.
17750 @item -G @var{num}
17751 @opindex G
17752 @cindex smaller data references
17753 Put global and static objects less than or equal to @var{num} bytes
17754 into the small data or BSS sections instead of the normal data or BSS
17755 sections.  The default value of @var{num} is 8.
17756 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
17757 for this option to have any effect.
17759 All modules should be compiled with the same @option{-G @var{num}} value.
17760 Compiling with different values of @var{num} may or may not work; if it
17761 doesn't the linker gives an error message---incorrect code is not
17762 generated.
17764 @item -mdebug
17765 @opindex mdebug
17766 Makes the M32R-specific code in the compiler display some statistics
17767 that might help in debugging programs.
17769 @item -malign-loops
17770 @opindex malign-loops
17771 Align all loops to a 32-byte boundary.
17773 @item -mno-align-loops
17774 @opindex mno-align-loops
17775 Do not enforce a 32-byte alignment for loops.  This is the default.
17777 @item -missue-rate=@var{number}
17778 @opindex missue-rate=@var{number}
17779 Issue @var{number} instructions per cycle.  @var{number} can only be 1
17780 or 2.
17782 @item -mbranch-cost=@var{number}
17783 @opindex mbranch-cost=@var{number}
17784 @var{number} can only be 1 or 2.  If it is 1 then branches are
17785 preferred over conditional code, if it is 2, then the opposite applies.
17787 @item -mflush-trap=@var{number}
17788 @opindex mflush-trap=@var{number}
17789 Specifies the trap number to use to flush the cache.  The default is
17790 12.  Valid numbers are between 0 and 15 inclusive.
17792 @item -mno-flush-trap
17793 @opindex mno-flush-trap
17794 Specifies that the cache cannot be flushed by using a trap.
17796 @item -mflush-func=@var{name}
17797 @opindex mflush-func=@var{name}
17798 Specifies the name of the operating system function to call to flush
17799 the cache.  The default is @samp{_flush_cache}, but a function call
17800 is only used if a trap is not available.
17802 @item -mno-flush-func
17803 @opindex mno-flush-func
17804 Indicates that there is no OS function for flushing the cache.
17806 @end table
17808 @node M680x0 Options
17809 @subsection M680x0 Options
17810 @cindex M680x0 options
17812 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
17813 The default settings depend on which architecture was selected when
17814 the compiler was configured; the defaults for the most common choices
17815 are given below.
17817 @table @gcctabopt
17818 @item -march=@var{arch}
17819 @opindex march
17820 Generate code for a specific M680x0 or ColdFire instruction set
17821 architecture.  Permissible values of @var{arch} for M680x0
17822 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
17823 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
17824 architectures are selected according to Freescale's ISA classification
17825 and the permissible values are: @samp{isaa}, @samp{isaaplus},
17826 @samp{isab} and @samp{isac}.
17828 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
17829 code for a ColdFire target.  The @var{arch} in this macro is one of the
17830 @option{-march} arguments given above.
17832 When used together, @option{-march} and @option{-mtune} select code
17833 that runs on a family of similar processors but that is optimized
17834 for a particular microarchitecture.
17836 @item -mcpu=@var{cpu}
17837 @opindex mcpu
17838 Generate code for a specific M680x0 or ColdFire processor.
17839 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
17840 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
17841 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
17842 below, which also classifies the CPUs into families:
17844 @multitable @columnfractions 0.20 0.80
17845 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
17846 @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}
17847 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
17848 @item @samp{5206e} @tab @samp{5206e}
17849 @item @samp{5208} @tab @samp{5207} @samp{5208}
17850 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
17851 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
17852 @item @samp{5216} @tab @samp{5214} @samp{5216}
17853 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
17854 @item @samp{5225} @tab @samp{5224} @samp{5225}
17855 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
17856 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
17857 @item @samp{5249} @tab @samp{5249}
17858 @item @samp{5250} @tab @samp{5250}
17859 @item @samp{5271} @tab @samp{5270} @samp{5271}
17860 @item @samp{5272} @tab @samp{5272}
17861 @item @samp{5275} @tab @samp{5274} @samp{5275}
17862 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
17863 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
17864 @item @samp{5307} @tab @samp{5307}
17865 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
17866 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
17867 @item @samp{5407} @tab @samp{5407}
17868 @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}
17869 @end multitable
17871 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
17872 @var{arch} is compatible with @var{cpu}.  Other combinations of
17873 @option{-mcpu} and @option{-march} are rejected.
17875 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
17876 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
17877 where the value of @var{family} is given by the table above.
17879 @item -mtune=@var{tune}
17880 @opindex mtune
17881 Tune the code for a particular microarchitecture within the
17882 constraints set by @option{-march} and @option{-mcpu}.
17883 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
17884 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
17885 and @samp{cpu32}.  The ColdFire microarchitectures
17886 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
17888 You can also use @option{-mtune=68020-40} for code that needs
17889 to run relatively well on 68020, 68030 and 68040 targets.
17890 @option{-mtune=68020-60} is similar but includes 68060 targets
17891 as well.  These two options select the same tuning decisions as
17892 @option{-m68020-40} and @option{-m68020-60} respectively.
17894 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
17895 when tuning for 680x0 architecture @var{arch}.  It also defines
17896 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
17897 option is used.  If GCC is tuning for a range of architectures,
17898 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
17899 it defines the macros for every architecture in the range.
17901 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
17902 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
17903 of the arguments given above.
17905 @item -m68000
17906 @itemx -mc68000
17907 @opindex m68000
17908 @opindex mc68000
17909 Generate output for a 68000.  This is the default
17910 when the compiler is configured for 68000-based systems.
17911 It is equivalent to @option{-march=68000}.
17913 Use this option for microcontrollers with a 68000 or EC000 core,
17914 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
17916 @item -m68010
17917 @opindex m68010
17918 Generate output for a 68010.  This is the default
17919 when the compiler is configured for 68010-based systems.
17920 It is equivalent to @option{-march=68010}.
17922 @item -m68020
17923 @itemx -mc68020
17924 @opindex m68020
17925 @opindex mc68020
17926 Generate output for a 68020.  This is the default
17927 when the compiler is configured for 68020-based systems.
17928 It is equivalent to @option{-march=68020}.
17930 @item -m68030
17931 @opindex m68030
17932 Generate output for a 68030.  This is the default when the compiler is
17933 configured for 68030-based systems.  It is equivalent to
17934 @option{-march=68030}.
17936 @item -m68040
17937 @opindex m68040
17938 Generate output for a 68040.  This is the default when the compiler is
17939 configured for 68040-based systems.  It is equivalent to
17940 @option{-march=68040}.
17942 This option inhibits the use of 68881/68882 instructions that have to be
17943 emulated by software on the 68040.  Use this option if your 68040 does not
17944 have code to emulate those instructions.
17946 @item -m68060
17947 @opindex m68060
17948 Generate output for a 68060.  This is the default when the compiler is
17949 configured for 68060-based systems.  It is equivalent to
17950 @option{-march=68060}.
17952 This option inhibits the use of 68020 and 68881/68882 instructions that
17953 have to be emulated by software on the 68060.  Use this option if your 68060
17954 does not have code to emulate those instructions.
17956 @item -mcpu32
17957 @opindex mcpu32
17958 Generate output for a CPU32.  This is the default
17959 when the compiler is configured for CPU32-based systems.
17960 It is equivalent to @option{-march=cpu32}.
17962 Use this option for microcontrollers with a
17963 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17964 68336, 68340, 68341, 68349 and 68360.
17966 @item -m5200
17967 @opindex m5200
17968 Generate output for a 520X ColdFire CPU@.  This is the default
17969 when the compiler is configured for 520X-based systems.
17970 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17971 in favor of that option.
17973 Use this option for microcontroller with a 5200 core, including
17974 the MCF5202, MCF5203, MCF5204 and MCF5206.
17976 @item -m5206e
17977 @opindex m5206e
17978 Generate output for a 5206e ColdFire CPU@.  The option is now
17979 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17981 @item -m528x
17982 @opindex m528x
17983 Generate output for a member of the ColdFire 528X family.
17984 The option is now deprecated in favor of the equivalent
17985 @option{-mcpu=528x}.
17987 @item -m5307
17988 @opindex m5307
17989 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17990 in favor of the equivalent @option{-mcpu=5307}.
17992 @item -m5407
17993 @opindex m5407
17994 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17995 in favor of the equivalent @option{-mcpu=5407}.
17997 @item -mcfv4e
17998 @opindex mcfv4e
17999 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18000 This includes use of hardware floating-point instructions.
18001 The option is equivalent to @option{-mcpu=547x}, and is now
18002 deprecated in favor of that option.
18004 @item -m68020-40
18005 @opindex m68020-40
18006 Generate output for a 68040, without using any of the new instructions.
18007 This results in code that can run relatively efficiently on either a
18008 68020/68881 or a 68030 or a 68040.  The generated code does use the
18009 68881 instructions that are emulated on the 68040.
18011 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18013 @item -m68020-60
18014 @opindex m68020-60
18015 Generate output for a 68060, without using any of the new instructions.
18016 This results in code that can run relatively efficiently on either a
18017 68020/68881 or a 68030 or a 68040.  The generated code does use the
18018 68881 instructions that are emulated on the 68060.
18020 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18022 @item -mhard-float
18023 @itemx -m68881
18024 @opindex mhard-float
18025 @opindex m68881
18026 Generate floating-point instructions.  This is the default for 68020
18027 and above, and for ColdFire devices that have an FPU@.  It defines the
18028 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18029 on ColdFire targets.
18031 @item -msoft-float
18032 @opindex msoft-float
18033 Do not generate floating-point instructions; use library calls instead.
18034 This is the default for 68000, 68010, and 68832 targets.  It is also
18035 the default for ColdFire devices that have no FPU.
18037 @item -mdiv
18038 @itemx -mno-div
18039 @opindex mdiv
18040 @opindex mno-div
18041 Generate (do not generate) ColdFire hardware divide and remainder
18042 instructions.  If @option{-march} is used without @option{-mcpu},
18043 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18044 architectures.  Otherwise, the default is taken from the target CPU
18045 (either the default CPU, or the one specified by @option{-mcpu}).  For
18046 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18047 @option{-mcpu=5206e}.
18049 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18051 @item -mshort
18052 @opindex mshort
18053 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18054 Additionally, parameters passed on the stack are also aligned to a
18055 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18057 @item -mno-short
18058 @opindex mno-short
18059 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18061 @item -mnobitfield
18062 @itemx -mno-bitfield
18063 @opindex mnobitfield
18064 @opindex mno-bitfield
18065 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18066 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18068 @item -mbitfield
18069 @opindex mbitfield
18070 Do use the bit-field instructions.  The @option{-m68020} option implies
18071 @option{-mbitfield}.  This is the default if you use a configuration
18072 designed for a 68020.
18074 @item -mrtd
18075 @opindex mrtd
18076 Use a different function-calling convention, in which functions
18077 that take a fixed number of arguments return with the @code{rtd}
18078 instruction, which pops their arguments while returning.  This
18079 saves one instruction in the caller since there is no need to pop
18080 the arguments there.
18082 This calling convention is incompatible with the one normally
18083 used on Unix, so you cannot use it if you need to call libraries
18084 compiled with the Unix compiler.
18086 Also, you must provide function prototypes for all functions that
18087 take variable numbers of arguments (including @code{printf});
18088 otherwise incorrect code is generated for calls to those
18089 functions.
18091 In addition, seriously incorrect code results if you call a
18092 function with too many arguments.  (Normally, extra arguments are
18093 harmlessly ignored.)
18095 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18096 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18098 @item -mno-rtd
18099 @opindex mno-rtd
18100 Do not use the calling conventions selected by @option{-mrtd}.
18101 This is the default.
18103 @item -malign-int
18104 @itemx -mno-align-int
18105 @opindex malign-int
18106 @opindex mno-align-int
18107 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18108 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18109 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18110 Aligning variables on 32-bit boundaries produces code that runs somewhat
18111 faster on processors with 32-bit busses at the expense of more memory.
18113 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18114 aligns structures containing the above types differently than
18115 most published application binary interface specifications for the m68k.
18117 @item -mpcrel
18118 @opindex mpcrel
18119 Use the pc-relative addressing mode of the 68000 directly, instead of
18120 using a global offset table.  At present, this option implies @option{-fpic},
18121 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18122 not presently supported with @option{-mpcrel}, though this could be supported for
18123 68020 and higher processors.
18125 @item -mno-strict-align
18126 @itemx -mstrict-align
18127 @opindex mno-strict-align
18128 @opindex mstrict-align
18129 Do not (do) assume that unaligned memory references are handled by
18130 the system.
18132 @item -msep-data
18133 Generate code that allows the data segment to be located in a different
18134 area of memory from the text segment.  This allows for execute-in-place in
18135 an environment without virtual memory management.  This option implies
18136 @option{-fPIC}.
18138 @item -mno-sep-data
18139 Generate code that assumes that the data segment follows the text segment.
18140 This is the default.
18142 @item -mid-shared-library
18143 Generate code that supports shared libraries via the library ID method.
18144 This allows for execute-in-place and shared libraries in an environment
18145 without virtual memory management.  This option implies @option{-fPIC}.
18147 @item -mno-id-shared-library
18148 Generate code that doesn't assume ID-based shared libraries are being used.
18149 This is the default.
18151 @item -mshared-library-id=n
18152 Specifies the identification number of the ID-based shared library being
18153 compiled.  Specifying a value of 0 generates more compact code; specifying
18154 other values forces the allocation of that number to the current
18155 library, but is no more space- or time-efficient than omitting this option.
18157 @item -mxgot
18158 @itemx -mno-xgot
18159 @opindex mxgot
18160 @opindex mno-xgot
18161 When generating position-independent code for ColdFire, generate code
18162 that works if the GOT has more than 8192 entries.  This code is
18163 larger and slower than code generated without this option.  On M680x0
18164 processors, this option is not needed; @option{-fPIC} suffices.
18166 GCC normally uses a single instruction to load values from the GOT@.
18167 While this is relatively efficient, it only works if the GOT
18168 is smaller than about 64k.  Anything larger causes the linker
18169 to report an error such as:
18171 @cindex relocation truncated to fit (ColdFire)
18172 @smallexample
18173 relocation truncated to fit: R_68K_GOT16O foobar
18174 @end smallexample
18176 If this happens, you should recompile your code with @option{-mxgot}.
18177 It should then work with very large GOTs.  However, code generated with
18178 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18179 the value of a global symbol.
18181 Note that some linkers, including newer versions of the GNU linker,
18182 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18183 you should only need to use @option{-mxgot} when compiling a single
18184 object file that accesses more than 8192 GOT entries.  Very few do.
18186 These options have no effect unless GCC is generating
18187 position-independent code.
18189 @end table
18191 @node MCore Options
18192 @subsection MCore Options
18193 @cindex MCore options
18195 These are the @samp{-m} options defined for the Motorola M*Core
18196 processors.
18198 @table @gcctabopt
18200 @item -mhardlit
18201 @itemx -mno-hardlit
18202 @opindex mhardlit
18203 @opindex mno-hardlit
18204 Inline constants into the code stream if it can be done in two
18205 instructions or less.
18207 @item -mdiv
18208 @itemx -mno-div
18209 @opindex mdiv
18210 @opindex mno-div
18211 Use the divide instruction.  (Enabled by default).
18213 @item -mrelax-immediate
18214 @itemx -mno-relax-immediate
18215 @opindex mrelax-immediate
18216 @opindex mno-relax-immediate
18217 Allow arbitrary-sized immediates in bit operations.
18219 @item -mwide-bitfields
18220 @itemx -mno-wide-bitfields
18221 @opindex mwide-bitfields
18222 @opindex mno-wide-bitfields
18223 Always treat bit-fields as @code{int}-sized.
18225 @item -m4byte-functions
18226 @itemx -mno-4byte-functions
18227 @opindex m4byte-functions
18228 @opindex mno-4byte-functions
18229 Force all functions to be aligned to a 4-byte boundary.
18231 @item -mcallgraph-data
18232 @itemx -mno-callgraph-data
18233 @opindex mcallgraph-data
18234 @opindex mno-callgraph-data
18235 Emit callgraph information.
18237 @item -mslow-bytes
18238 @itemx -mno-slow-bytes
18239 @opindex mslow-bytes
18240 @opindex mno-slow-bytes
18241 Prefer word access when reading byte quantities.
18243 @item -mlittle-endian
18244 @itemx -mbig-endian
18245 @opindex mlittle-endian
18246 @opindex mbig-endian
18247 Generate code for a little-endian target.
18249 @item -m210
18250 @itemx -m340
18251 @opindex m210
18252 @opindex m340
18253 Generate code for the 210 processor.
18255 @item -mno-lsim
18256 @opindex mno-lsim
18257 Assume that runtime support has been provided and so omit the
18258 simulator library (@file{libsim.a)} from the linker command line.
18260 @item -mstack-increment=@var{size}
18261 @opindex mstack-increment
18262 Set the maximum amount for a single stack increment operation.  Large
18263 values can increase the speed of programs that contain functions
18264 that need a large amount of stack space, but they can also trigger a
18265 segmentation fault if the stack is extended too much.  The default
18266 value is 0x1000.
18268 @end table
18270 @node MeP Options
18271 @subsection MeP Options
18272 @cindex MeP options
18274 @table @gcctabopt
18276 @item -mabsdiff
18277 @opindex mabsdiff
18278 Enables the @code{abs} instruction, which is the absolute difference
18279 between two registers.
18281 @item -mall-opts
18282 @opindex mall-opts
18283 Enables all the optional instructions---average, multiply, divide, bit
18284 operations, leading zero, absolute difference, min/max, clip, and
18285 saturation.
18288 @item -maverage
18289 @opindex maverage
18290 Enables the @code{ave} instruction, which computes the average of two
18291 registers.
18293 @item -mbased=@var{n}
18294 @opindex mbased=
18295 Variables of size @var{n} bytes or smaller are placed in the
18296 @code{.based} section by default.  Based variables use the @code{$tp}
18297 register as a base register, and there is a 128-byte limit to the
18298 @code{.based} section.
18300 @item -mbitops
18301 @opindex mbitops
18302 Enables the bit operation instructions---bit test (@code{btstm}), set
18303 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18304 test-and-set (@code{tas}).
18306 @item -mc=@var{name}
18307 @opindex mc=
18308 Selects which section constant data is placed in.  @var{name} may
18309 be @samp{tiny}, @samp{near}, or @samp{far}.
18311 @item -mclip
18312 @opindex mclip
18313 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18314 useful unless you also provide @option{-mminmax}.
18316 @item -mconfig=@var{name}
18317 @opindex mconfig=
18318 Selects one of the built-in core configurations.  Each MeP chip has
18319 one or more modules in it; each module has a core CPU and a variety of
18320 coprocessors, optional instructions, and peripherals.  The
18321 @code{MeP-Integrator} tool, not part of GCC, provides these
18322 configurations through this option; using this option is the same as
18323 using all the corresponding command-line options.  The default
18324 configuration is @samp{default}.
18326 @item -mcop
18327 @opindex mcop
18328 Enables the coprocessor instructions.  By default, this is a 32-bit
18329 coprocessor.  Note that the coprocessor is normally enabled via the
18330 @option{-mconfig=} option.
18332 @item -mcop32
18333 @opindex mcop32
18334 Enables the 32-bit coprocessor's instructions.
18336 @item -mcop64
18337 @opindex mcop64
18338 Enables the 64-bit coprocessor's instructions.
18340 @item -mivc2
18341 @opindex mivc2
18342 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18344 @item -mdc
18345 @opindex mdc
18346 Causes constant variables to be placed in the @code{.near} section.
18348 @item -mdiv
18349 @opindex mdiv
18350 Enables the @code{div} and @code{divu} instructions.
18352 @item -meb
18353 @opindex meb
18354 Generate big-endian code.
18356 @item -mel
18357 @opindex mel
18358 Generate little-endian code.
18360 @item -mio-volatile
18361 @opindex mio-volatile
18362 Tells the compiler that any variable marked with the @code{io}
18363 attribute is to be considered volatile.
18365 @item -ml
18366 @opindex ml
18367 Causes variables to be assigned to the @code{.far} section by default.
18369 @item -mleadz
18370 @opindex mleadz
18371 Enables the @code{leadz} (leading zero) instruction.
18373 @item -mm
18374 @opindex mm
18375 Causes variables to be assigned to the @code{.near} section by default.
18377 @item -mminmax
18378 @opindex mminmax
18379 Enables the @code{min} and @code{max} instructions.
18381 @item -mmult
18382 @opindex mmult
18383 Enables the multiplication and multiply-accumulate instructions.
18385 @item -mno-opts
18386 @opindex mno-opts
18387 Disables all the optional instructions enabled by @option{-mall-opts}.
18389 @item -mrepeat
18390 @opindex mrepeat
18391 Enables the @code{repeat} and @code{erepeat} instructions, used for
18392 low-overhead looping.
18394 @item -ms
18395 @opindex ms
18396 Causes all variables to default to the @code{.tiny} section.  Note
18397 that there is a 65536-byte limit to this section.  Accesses to these
18398 variables use the @code{%gp} base register.
18400 @item -msatur
18401 @opindex msatur
18402 Enables the saturation instructions.  Note that the compiler does not
18403 currently generate these itself, but this option is included for
18404 compatibility with other tools, like @code{as}.
18406 @item -msdram
18407 @opindex msdram
18408 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18410 @item -msim
18411 @opindex msim
18412 Link the simulator run-time libraries.
18414 @item -msimnovec
18415 @opindex msimnovec
18416 Link the simulator runtime libraries, excluding built-in support
18417 for reset and exception vectors and tables.
18419 @item -mtf
18420 @opindex mtf
18421 Causes all functions to default to the @code{.far} section.  Without
18422 this option, functions default to the @code{.near} section.
18424 @item -mtiny=@var{n}
18425 @opindex mtiny=
18426 Variables that are @var{n} bytes or smaller are allocated to the
18427 @code{.tiny} section.  These variables use the @code{$gp} base
18428 register.  The default for this option is 4, but note that there's a
18429 65536-byte limit to the @code{.tiny} section.
18431 @end table
18433 @node MicroBlaze Options
18434 @subsection MicroBlaze Options
18435 @cindex MicroBlaze Options
18437 @table @gcctabopt
18439 @item -msoft-float
18440 @opindex msoft-float
18441 Use software emulation for floating point (default).
18443 @item -mhard-float
18444 @opindex mhard-float
18445 Use hardware floating-point instructions.
18447 @item -mmemcpy
18448 @opindex mmemcpy
18449 Do not optimize block moves, use @code{memcpy}.
18451 @item -mno-clearbss
18452 @opindex mno-clearbss
18453 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18455 @item -mcpu=@var{cpu-type}
18456 @opindex mcpu=
18457 Use features of, and schedule code for, the given CPU.
18458 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18459 where @var{X} is a major version, @var{YY} is the minor version, and
18460 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18461 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18463 @item -mxl-soft-mul
18464 @opindex mxl-soft-mul
18465 Use software multiply emulation (default).
18467 @item -mxl-soft-div
18468 @opindex mxl-soft-div
18469 Use software emulation for divides (default).
18471 @item -mxl-barrel-shift
18472 @opindex mxl-barrel-shift
18473 Use the hardware barrel shifter.
18475 @item -mxl-pattern-compare
18476 @opindex mxl-pattern-compare
18477 Use pattern compare instructions.
18479 @item -msmall-divides
18480 @opindex msmall-divides
18481 Use table lookup optimization for small signed integer divisions.
18483 @item -mxl-stack-check
18484 @opindex mxl-stack-check
18485 This option is deprecated.  Use @option{-fstack-check} instead.
18487 @item -mxl-gp-opt
18488 @opindex mxl-gp-opt
18489 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18491 @item -mxl-multiply-high
18492 @opindex mxl-multiply-high
18493 Use multiply high instructions for high part of 32x32 multiply.
18495 @item -mxl-float-convert
18496 @opindex mxl-float-convert
18497 Use hardware floating-point conversion instructions.
18499 @item -mxl-float-sqrt
18500 @opindex mxl-float-sqrt
18501 Use hardware floating-point square root instruction.
18503 @item -mbig-endian
18504 @opindex mbig-endian
18505 Generate code for a big-endian target.
18507 @item -mlittle-endian
18508 @opindex mlittle-endian
18509 Generate code for a little-endian target.
18511 @item -mxl-reorder
18512 @opindex mxl-reorder
18513 Use reorder instructions (swap and byte reversed load/store).
18515 @item -mxl-mode-@var{app-model}
18516 Select application model @var{app-model}.  Valid models are
18517 @table @samp
18518 @item executable
18519 normal executable (default), uses startup code @file{crt0.o}.
18521 @item xmdstub
18522 for use with Xilinx Microprocessor Debugger (XMD) based
18523 software intrusive debug agent called xmdstub. This uses startup file
18524 @file{crt1.o} and sets the start address of the program to 0x800.
18526 @item bootstrap
18527 for applications that are loaded using a bootloader.
18528 This model uses startup file @file{crt2.o} which does not contain a processor
18529 reset vector handler. This is suitable for transferring control on a
18530 processor reset to the bootloader rather than the application.
18532 @item novectors
18533 for applications that do not require any of the
18534 MicroBlaze vectors. This option may be useful for applications running
18535 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18536 @end table
18538 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18539 @option{-mxl-mode-@var{app-model}}.
18541 @end table
18543 @node MIPS Options
18544 @subsection MIPS Options
18545 @cindex MIPS options
18547 @table @gcctabopt
18549 @item -EB
18550 @opindex EB
18551 Generate big-endian code.
18553 @item -EL
18554 @opindex EL
18555 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18556 configurations.
18558 @item -march=@var{arch}
18559 @opindex march
18560 Generate code that runs on @var{arch}, which can be the name of a
18561 generic MIPS ISA, or the name of a particular processor.
18562 The ISA names are:
18563 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18564 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18565 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18566 @samp{mips64r5} and @samp{mips64r6}.
18567 The processor names are:
18568 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18569 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18570 @samp{5kc}, @samp{5kf},
18571 @samp{20kc},
18572 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18573 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18574 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18575 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18576 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18577 @samp{i6400},
18578 @samp{interaptiv},
18579 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18580 @samp{m4k},
18581 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18582 @samp{m5100}, @samp{m5101},
18583 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18584 @samp{orion},
18585 @samp{p5600},
18586 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18587 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18588 @samp{rm7000}, @samp{rm9000},
18589 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18590 @samp{sb1},
18591 @samp{sr71000},
18592 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18593 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18594 @samp{xlr} and @samp{xlp}.
18595 The special value @samp{from-abi} selects the
18596 most compatible architecture for the selected ABI (that is,
18597 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18599 The native Linux/GNU toolchain also supports the value @samp{native},
18600 which selects the best architecture option for the host processor.
18601 @option{-march=native} has no effect if GCC does not recognize
18602 the processor.
18604 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18605 (for example, @option{-march=r2k}).  Prefixes are optional, and
18606 @samp{vr} may be written @samp{r}.
18608 Names of the form @samp{@var{n}f2_1} refer to processors with
18609 FPUs clocked at half the rate of the core, names of the form
18610 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18611 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18612 processors with FPUs clocked a ratio of 3:2 with respect to the core.
18613 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
18614 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
18615 accepted as synonyms for @samp{@var{n}f1_1}.
18617 GCC defines two macros based on the value of this option.  The first
18618 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
18619 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
18620 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
18621 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
18622 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
18624 Note that the @code{_MIPS_ARCH} macro uses the processor names given
18625 above.  In other words, it has the full prefix and does not
18626 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
18627 the macro names the resolved architecture (either @code{"mips1"} or
18628 @code{"mips3"}).  It names the default architecture when no
18629 @option{-march} option is given.
18631 @item -mtune=@var{arch}
18632 @opindex mtune
18633 Optimize for @var{arch}.  Among other things, this option controls
18634 the way instructions are scheduled, and the perceived cost of arithmetic
18635 operations.  The list of @var{arch} values is the same as for
18636 @option{-march}.
18638 When this option is not used, GCC optimizes for the processor
18639 specified by @option{-march}.  By using @option{-march} and
18640 @option{-mtune} together, it is possible to generate code that
18641 runs on a family of processors, but optimize the code for one
18642 particular member of that family.
18644 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
18645 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
18646 @option{-march} ones described above.
18648 @item -mips1
18649 @opindex mips1
18650 Equivalent to @option{-march=mips1}.
18652 @item -mips2
18653 @opindex mips2
18654 Equivalent to @option{-march=mips2}.
18656 @item -mips3
18657 @opindex mips3
18658 Equivalent to @option{-march=mips3}.
18660 @item -mips4
18661 @opindex mips4
18662 Equivalent to @option{-march=mips4}.
18664 @item -mips32
18665 @opindex mips32
18666 Equivalent to @option{-march=mips32}.
18668 @item -mips32r3
18669 @opindex mips32r3
18670 Equivalent to @option{-march=mips32r3}.
18672 @item -mips32r5
18673 @opindex mips32r5
18674 Equivalent to @option{-march=mips32r5}.
18676 @item -mips32r6
18677 @opindex mips32r6
18678 Equivalent to @option{-march=mips32r6}.
18680 @item -mips64
18681 @opindex mips64
18682 Equivalent to @option{-march=mips64}.
18684 @item -mips64r2
18685 @opindex mips64r2
18686 Equivalent to @option{-march=mips64r2}.
18688 @item -mips64r3
18689 @opindex mips64r3
18690 Equivalent to @option{-march=mips64r3}.
18692 @item -mips64r5
18693 @opindex mips64r5
18694 Equivalent to @option{-march=mips64r5}.
18696 @item -mips64r6
18697 @opindex mips64r6
18698 Equivalent to @option{-march=mips64r6}.
18700 @item -mips16
18701 @itemx -mno-mips16
18702 @opindex mips16
18703 @opindex mno-mips16
18704 Generate (do not generate) MIPS16 code.  If GCC is targeting a
18705 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
18707 MIPS16 code generation can also be controlled on a per-function basis
18708 by means of @code{mips16} and @code{nomips16} attributes.
18709 @xref{Function Attributes}, for more information.
18711 @item -mflip-mips16
18712 @opindex mflip-mips16
18713 Generate MIPS16 code on alternating functions.  This option is provided
18714 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
18715 not intended for ordinary use in compiling user code.
18717 @item -minterlink-compressed
18718 @item -mno-interlink-compressed
18719 @opindex minterlink-compressed
18720 @opindex mno-interlink-compressed
18721 Require (do not require) that code using the standard (uncompressed) MIPS ISA
18722 be link-compatible with MIPS16 and microMIPS code, and vice versa.
18724 For example, code using the standard ISA encoding cannot jump directly
18725 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
18726 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
18727 knows that the target of the jump is not compressed.
18729 @item -minterlink-mips16
18730 @itemx -mno-interlink-mips16
18731 @opindex minterlink-mips16
18732 @opindex mno-interlink-mips16
18733 Aliases of @option{-minterlink-compressed} and
18734 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
18735 and are retained for backwards compatibility.
18737 @item -mabi=32
18738 @itemx -mabi=o64
18739 @itemx -mabi=n32
18740 @itemx -mabi=64
18741 @itemx -mabi=eabi
18742 @opindex mabi=32
18743 @opindex mabi=o64
18744 @opindex mabi=n32
18745 @opindex mabi=64
18746 @opindex mabi=eabi
18747 Generate code for the given ABI@.
18749 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
18750 generates 64-bit code when you select a 64-bit architecture, but you
18751 can use @option{-mgp32} to get 32-bit code instead.
18753 For information about the O64 ABI, see
18754 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
18756 GCC supports a variant of the o32 ABI in which floating-point registers
18757 are 64 rather than 32 bits wide.  You can select this combination with
18758 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
18759 and @code{mfhc1} instructions and is therefore only supported for
18760 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
18762 The register assignments for arguments and return values remain the
18763 same, but each scalar value is passed in a single 64-bit register
18764 rather than a pair of 32-bit registers.  For example, scalar
18765 floating-point values are returned in @samp{$f0} only, not a
18766 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
18767 remains the same in that the even-numbered double-precision registers
18768 are saved.
18770 Two additional variants of the o32 ABI are supported to enable
18771 a transition from 32-bit to 64-bit registers.  These are FPXX
18772 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
18773 The FPXX extension mandates that all code must execute correctly
18774 when run using 32-bit or 64-bit registers.  The code can be interlinked
18775 with either FP32 or FP64, but not both.
18776 The FP64A extension is similar to the FP64 extension but forbids the
18777 use of odd-numbered single-precision registers.  This can be used
18778 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
18779 processors and allows both FP32 and FP64A code to interlink and
18780 run in the same process without changing FPU modes.
18782 @item -mabicalls
18783 @itemx -mno-abicalls
18784 @opindex mabicalls
18785 @opindex mno-abicalls
18786 Generate (do not generate) code that is suitable for SVR4-style
18787 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
18788 systems.
18790 @item -mshared
18791 @itemx -mno-shared
18792 Generate (do not generate) code that is fully position-independent,
18793 and that can therefore be linked into shared libraries.  This option
18794 only affects @option{-mabicalls}.
18796 All @option{-mabicalls} code has traditionally been position-independent,
18797 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
18798 as an extension, the GNU toolchain allows executables to use absolute
18799 accesses for locally-binding symbols.  It can also use shorter GP
18800 initialization sequences and generate direct calls to locally-defined
18801 functions.  This mode is selected by @option{-mno-shared}.
18803 @option{-mno-shared} depends on binutils 2.16 or higher and generates
18804 objects that can only be linked by the GNU linker.  However, the option
18805 does not affect the ABI of the final executable; it only affects the ABI
18806 of relocatable objects.  Using @option{-mno-shared} generally makes
18807 executables both smaller and quicker.
18809 @option{-mshared} is the default.
18811 @item -mplt
18812 @itemx -mno-plt
18813 @opindex mplt
18814 @opindex mno-plt
18815 Assume (do not assume) that the static and dynamic linkers
18816 support PLTs and copy relocations.  This option only affects
18817 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
18818 has no effect without @option{-msym32}.
18820 You can make @option{-mplt} the default by configuring
18821 GCC with @option{--with-mips-plt}.  The default is
18822 @option{-mno-plt} otherwise.
18824 @item -mxgot
18825 @itemx -mno-xgot
18826 @opindex mxgot
18827 @opindex mno-xgot
18828 Lift (do not lift) the usual restrictions on the size of the global
18829 offset table.
18831 GCC normally uses a single instruction to load values from the GOT@.
18832 While this is relatively efficient, it only works if the GOT
18833 is smaller than about 64k.  Anything larger causes the linker
18834 to report an error such as:
18836 @cindex relocation truncated to fit (MIPS)
18837 @smallexample
18838 relocation truncated to fit: R_MIPS_GOT16 foobar
18839 @end smallexample
18841 If this happens, you should recompile your code with @option{-mxgot}.
18842 This works with very large GOTs, although the code is also
18843 less efficient, since it takes three instructions to fetch the
18844 value of a global symbol.
18846 Note that some linkers can create multiple GOTs.  If you have such a
18847 linker, you should only need to use @option{-mxgot} when a single object
18848 file accesses more than 64k's worth of GOT entries.  Very few do.
18850 These options have no effect unless GCC is generating position
18851 independent code.
18853 @item -mgp32
18854 @opindex mgp32
18855 Assume that general-purpose registers are 32 bits wide.
18857 @item -mgp64
18858 @opindex mgp64
18859 Assume that general-purpose registers are 64 bits wide.
18861 @item -mfp32
18862 @opindex mfp32
18863 Assume that floating-point registers are 32 bits wide.
18865 @item -mfp64
18866 @opindex mfp64
18867 Assume that floating-point registers are 64 bits wide.
18869 @item -mfpxx
18870 @opindex mfpxx
18871 Do not assume the width of floating-point registers.
18873 @item -mhard-float
18874 @opindex mhard-float
18875 Use floating-point coprocessor instructions.
18877 @item -msoft-float
18878 @opindex msoft-float
18879 Do not use floating-point coprocessor instructions.  Implement
18880 floating-point calculations using library calls instead.
18882 @item -mno-float
18883 @opindex mno-float
18884 Equivalent to @option{-msoft-float}, but additionally asserts that the
18885 program being compiled does not perform any floating-point operations.
18886 This option is presently supported only by some bare-metal MIPS
18887 configurations, where it may select a special set of libraries
18888 that lack all floating-point support (including, for example, the
18889 floating-point @code{printf} formats).  
18890 If code compiled with @option{-mno-float} accidentally contains
18891 floating-point operations, it is likely to suffer a link-time
18892 or run-time failure.
18894 @item -msingle-float
18895 @opindex msingle-float
18896 Assume that the floating-point coprocessor only supports single-precision
18897 operations.
18899 @item -mdouble-float
18900 @opindex mdouble-float
18901 Assume that the floating-point coprocessor supports double-precision
18902 operations.  This is the default.
18904 @item -modd-spreg
18905 @itemx -mno-odd-spreg
18906 @opindex modd-spreg
18907 @opindex mno-odd-spreg
18908 Enable the use of odd-numbered single-precision floating-point registers
18909 for the o32 ABI.  This is the default for processors that are known to
18910 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
18911 is set by default.
18913 @item -mabs=2008
18914 @itemx -mabs=legacy
18915 @opindex mabs=2008
18916 @opindex mabs=legacy
18917 These options control the treatment of the special not-a-number (NaN)
18918 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
18919 @code{neg.@i{fmt}} machine instructions.
18921 By default or when @option{-mabs=legacy} is used the legacy
18922 treatment is selected.  In this case these instructions are considered
18923 arithmetic and avoided where correct operation is required and the
18924 input operand might be a NaN.  A longer sequence of instructions that
18925 manipulate the sign bit of floating-point datum manually is used
18926 instead unless the @option{-ffinite-math-only} option has also been
18927 specified.
18929 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
18930 this case these instructions are considered non-arithmetic and therefore
18931 operating correctly in all cases, including in particular where the
18932 input operand is a NaN.  These instructions are therefore always used
18933 for the respective operations.
18935 @item -mnan=2008
18936 @itemx -mnan=legacy
18937 @opindex mnan=2008
18938 @opindex mnan=legacy
18939 These options control the encoding of the special not-a-number (NaN)
18940 IEEE 754 floating-point data.
18942 The @option{-mnan=legacy} option selects the legacy encoding.  In this
18943 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
18944 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
18945 by the first bit of their trailing significand field being 1.
18947 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18948 this case qNaNs are denoted by the first bit of their trailing
18949 significand field being 1, whereas sNaNs are denoted by the first bit of
18950 their trailing significand field being 0.
18952 The default is @option{-mnan=legacy} unless GCC has been configured with
18953 @option{--with-nan=2008}.
18955 @item -mllsc
18956 @itemx -mno-llsc
18957 @opindex mllsc
18958 @opindex mno-llsc
18959 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18960 implement atomic memory built-in functions.  When neither option is
18961 specified, GCC uses the instructions if the target architecture
18962 supports them.
18964 @option{-mllsc} is useful if the runtime environment can emulate the
18965 instructions and @option{-mno-llsc} can be useful when compiling for
18966 nonstandard ISAs.  You can make either option the default by
18967 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18968 respectively.  @option{--with-llsc} is the default for some
18969 configurations; see the installation documentation for details.
18971 @item -mdsp
18972 @itemx -mno-dsp
18973 @opindex mdsp
18974 @opindex mno-dsp
18975 Use (do not use) revision 1 of the MIPS DSP ASE@.
18976 @xref{MIPS DSP Built-in Functions}.  This option defines the
18977 preprocessor macro @code{__mips_dsp}.  It also defines
18978 @code{__mips_dsp_rev} to 1.
18980 @item -mdspr2
18981 @itemx -mno-dspr2
18982 @opindex mdspr2
18983 @opindex mno-dspr2
18984 Use (do not use) revision 2 of the MIPS DSP ASE@.
18985 @xref{MIPS DSP Built-in Functions}.  This option defines the
18986 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
18987 It also defines @code{__mips_dsp_rev} to 2.
18989 @item -msmartmips
18990 @itemx -mno-smartmips
18991 @opindex msmartmips
18992 @opindex mno-smartmips
18993 Use (do not use) the MIPS SmartMIPS ASE.
18995 @item -mpaired-single
18996 @itemx -mno-paired-single
18997 @opindex mpaired-single
18998 @opindex mno-paired-single
18999 Use (do not use) paired-single floating-point instructions.
19000 @xref{MIPS Paired-Single Support}.  This option requires
19001 hardware floating-point support to be enabled.
19003 @item -mdmx
19004 @itemx -mno-mdmx
19005 @opindex mdmx
19006 @opindex mno-mdmx
19007 Use (do not use) MIPS Digital Media Extension instructions.
19008 This option can only be used when generating 64-bit code and requires
19009 hardware floating-point support to be enabled.
19011 @item -mips3d
19012 @itemx -mno-mips3d
19013 @opindex mips3d
19014 @opindex mno-mips3d
19015 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19016 The option @option{-mips3d} implies @option{-mpaired-single}.
19018 @item -mmicromips
19019 @itemx -mno-micromips
19020 @opindex mmicromips
19021 @opindex mno-mmicromips
19022 Generate (do not generate) microMIPS code.
19024 MicroMIPS code generation can also be controlled on a per-function basis
19025 by means of @code{micromips} and @code{nomicromips} attributes.
19026 @xref{Function Attributes}, for more information.
19028 @item -mmt
19029 @itemx -mno-mt
19030 @opindex mmt
19031 @opindex mno-mt
19032 Use (do not use) MT Multithreading instructions.
19034 @item -mmcu
19035 @itemx -mno-mcu
19036 @opindex mmcu
19037 @opindex mno-mcu
19038 Use (do not use) the MIPS MCU ASE instructions.
19040 @item -meva
19041 @itemx -mno-eva
19042 @opindex meva
19043 @opindex mno-eva
19044 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19046 @item -mvirt
19047 @itemx -mno-virt
19048 @opindex mvirt
19049 @opindex mno-virt
19050 Use (do not use) the MIPS Virtualization Application Specific instructions.
19052 @item -mxpa
19053 @itemx -mno-xpa
19054 @opindex mxpa
19055 @opindex mno-xpa
19056 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19058 @item -mlong64
19059 @opindex mlong64
19060 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19061 an explanation of the default and the way that the pointer size is
19062 determined.
19064 @item -mlong32
19065 @opindex mlong32
19066 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19068 The default size of @code{int}s, @code{long}s and pointers depends on
19069 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19070 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19071 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19072 or the same size as integer registers, whichever is smaller.
19074 @item -msym32
19075 @itemx -mno-sym32
19076 @opindex msym32
19077 @opindex mno-sym32
19078 Assume (do not assume) that all symbols have 32-bit values, regardless
19079 of the selected ABI@.  This option is useful in combination with
19080 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19081 to generate shorter and faster references to symbolic addresses.
19083 @item -G @var{num}
19084 @opindex G
19085 Put definitions of externally-visible data in a small data section
19086 if that data is no bigger than @var{num} bytes.  GCC can then generate
19087 more efficient accesses to the data; see @option{-mgpopt} for details.
19089 The default @option{-G} option depends on the configuration.
19091 @item -mlocal-sdata
19092 @itemx -mno-local-sdata
19093 @opindex mlocal-sdata
19094 @opindex mno-local-sdata
19095 Extend (do not extend) the @option{-G} behavior to local data too,
19096 such as to static variables in C@.  @option{-mlocal-sdata} is the
19097 default for all configurations.
19099 If the linker complains that an application is using too much small data,
19100 you might want to try rebuilding the less performance-critical parts with
19101 @option{-mno-local-sdata}.  You might also want to build large
19102 libraries with @option{-mno-local-sdata}, so that the libraries leave
19103 more room for the main program.
19105 @item -mextern-sdata
19106 @itemx -mno-extern-sdata
19107 @opindex mextern-sdata
19108 @opindex mno-extern-sdata
19109 Assume (do not assume) that externally-defined data is in
19110 a small data section if the size of that data is within the @option{-G} limit.
19111 @option{-mextern-sdata} is the default for all configurations.
19113 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19114 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19115 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19116 is placed in a small data section.  If @var{Var} is defined by another
19117 module, you must either compile that module with a high-enough
19118 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19119 definition.  If @var{Var} is common, you must link the application
19120 with a high-enough @option{-G} setting.
19122 The easiest way of satisfying these restrictions is to compile
19123 and link every module with the same @option{-G} option.  However,
19124 you may wish to build a library that supports several different
19125 small data limits.  You can do this by compiling the library with
19126 the highest supported @option{-G} setting and additionally using
19127 @option{-mno-extern-sdata} to stop the library from making assumptions
19128 about externally-defined data.
19130 @item -mgpopt
19131 @itemx -mno-gpopt
19132 @opindex mgpopt
19133 @opindex mno-gpopt
19134 Use (do not use) GP-relative accesses for symbols that are known to be
19135 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19136 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19137 configurations.
19139 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19140 might not hold the value of @code{_gp}.  For example, if the code is
19141 part of a library that might be used in a boot monitor, programs that
19142 call boot monitor routines pass an unknown value in @code{$gp}.
19143 (In such situations, the boot monitor itself is usually compiled
19144 with @option{-G0}.)
19146 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19147 @option{-mno-extern-sdata}.
19149 @item -membedded-data
19150 @itemx -mno-embedded-data
19151 @opindex membedded-data
19152 @opindex mno-embedded-data
19153 Allocate variables to the read-only data section first if possible, then
19154 next in the small data section if possible, otherwise in data.  This gives
19155 slightly slower code than the default, but reduces the amount of RAM required
19156 when executing, and thus may be preferred for some embedded systems.
19158 @item -muninit-const-in-rodata
19159 @itemx -mno-uninit-const-in-rodata
19160 @opindex muninit-const-in-rodata
19161 @opindex mno-uninit-const-in-rodata
19162 Put uninitialized @code{const} variables in the read-only data section.
19163 This option is only meaningful in conjunction with @option{-membedded-data}.
19165 @item -mcode-readable=@var{setting}
19166 @opindex mcode-readable
19167 Specify whether GCC may generate code that reads from executable sections.
19168 There are three possible settings:
19170 @table @gcctabopt
19171 @item -mcode-readable=yes
19172 Instructions may freely access executable sections.  This is the
19173 default setting.
19175 @item -mcode-readable=pcrel
19176 MIPS16 PC-relative load instructions can access executable sections,
19177 but other instructions must not do so.  This option is useful on 4KSc
19178 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19179 It is also useful on processors that can be configured to have a dual
19180 instruction/data SRAM interface and that, like the M4K, automatically
19181 redirect PC-relative loads to the instruction RAM.
19183 @item -mcode-readable=no
19184 Instructions must not access executable sections.  This option can be
19185 useful on targets that are configured to have a dual instruction/data
19186 SRAM interface but that (unlike the M4K) do not automatically redirect
19187 PC-relative loads to the instruction RAM.
19188 @end table
19190 @item -msplit-addresses
19191 @itemx -mno-split-addresses
19192 @opindex msplit-addresses
19193 @opindex mno-split-addresses
19194 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19195 relocation operators.  This option has been superseded by
19196 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19198 @item -mexplicit-relocs
19199 @itemx -mno-explicit-relocs
19200 @opindex mexplicit-relocs
19201 @opindex mno-explicit-relocs
19202 Use (do not use) assembler relocation operators when dealing with symbolic
19203 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19204 is to use assembler macros instead.
19206 @option{-mexplicit-relocs} is the default if GCC was configured
19207 to use an assembler that supports relocation operators.
19209 @item -mcheck-zero-division
19210 @itemx -mno-check-zero-division
19211 @opindex mcheck-zero-division
19212 @opindex mno-check-zero-division
19213 Trap (do not trap) on integer division by zero.
19215 The default is @option{-mcheck-zero-division}.
19217 @item -mdivide-traps
19218 @itemx -mdivide-breaks
19219 @opindex mdivide-traps
19220 @opindex mdivide-breaks
19221 MIPS systems check for division by zero by generating either a
19222 conditional trap or a break instruction.  Using traps results in
19223 smaller code, but is only supported on MIPS II and later.  Also, some
19224 versions of the Linux kernel have a bug that prevents trap from
19225 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19226 allow conditional traps on architectures that support them and
19227 @option{-mdivide-breaks} to force the use of breaks.
19229 The default is usually @option{-mdivide-traps}, but this can be
19230 overridden at configure time using @option{--with-divide=breaks}.
19231 Divide-by-zero checks can be completely disabled using
19232 @option{-mno-check-zero-division}.
19234 @item -mmemcpy
19235 @itemx -mno-memcpy
19236 @opindex mmemcpy
19237 @opindex mno-memcpy
19238 Force (do not force) the use of @code{memcpy} for non-trivial block
19239 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19240 most constant-sized copies.
19242 @item -mlong-calls
19243 @itemx -mno-long-calls
19244 @opindex mlong-calls
19245 @opindex mno-long-calls
19246 Disable (do not disable) use of the @code{jal} instruction.  Calling
19247 functions using @code{jal} is more efficient but requires the caller
19248 and callee to be in the same 256 megabyte segment.
19250 This option has no effect on abicalls code.  The default is
19251 @option{-mno-long-calls}.
19253 @item -mmad
19254 @itemx -mno-mad
19255 @opindex mmad
19256 @opindex mno-mad
19257 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19258 instructions, as provided by the R4650 ISA@.
19260 @item -mimadd
19261 @itemx -mno-imadd
19262 @opindex mimadd
19263 @opindex mno-imadd
19264 Enable (disable) use of the @code{madd} and @code{msub} integer
19265 instructions.  The default is @option{-mimadd} on architectures
19266 that support @code{madd} and @code{msub} except for the 74k 
19267 architecture where it was found to generate slower code.
19269 @item -mfused-madd
19270 @itemx -mno-fused-madd
19271 @opindex mfused-madd
19272 @opindex mno-fused-madd
19273 Enable (disable) use of the floating-point multiply-accumulate
19274 instructions, when they are available.  The default is
19275 @option{-mfused-madd}.
19277 On the R8000 CPU when multiply-accumulate instructions are used,
19278 the intermediate product is calculated to infinite precision
19279 and is not subject to the FCSR Flush to Zero bit.  This may be
19280 undesirable in some circumstances.  On other processors the result
19281 is numerically identical to the equivalent computation using
19282 separate multiply, add, subtract and negate instructions.
19284 @item -nocpp
19285 @opindex nocpp
19286 Tell the MIPS assembler to not run its preprocessor over user
19287 assembler files (with a @samp{.s} suffix) when assembling them.
19289 @item -mfix-24k
19290 @item -mno-fix-24k
19291 @opindex mfix-24k
19292 @opindex mno-fix-24k
19293 Work around the 24K E48 (lost data on stores during refill) errata.
19294 The workarounds are implemented by the assembler rather than by GCC@.
19296 @item -mfix-r4000
19297 @itemx -mno-fix-r4000
19298 @opindex mfix-r4000
19299 @opindex mno-fix-r4000
19300 Work around certain R4000 CPU errata:
19301 @itemize @minus
19302 @item
19303 A double-word or a variable shift may give an incorrect result if executed
19304 immediately after starting an integer division.
19305 @item
19306 A double-word or a variable shift may give an incorrect result if executed
19307 while an integer multiplication is in progress.
19308 @item
19309 An integer division may give an incorrect result if started in a delay slot
19310 of a taken branch or a jump.
19311 @end itemize
19313 @item -mfix-r4400
19314 @itemx -mno-fix-r4400
19315 @opindex mfix-r4400
19316 @opindex mno-fix-r4400
19317 Work around certain R4400 CPU errata:
19318 @itemize @minus
19319 @item
19320 A double-word or a variable shift may give an incorrect result if executed
19321 immediately after starting an integer division.
19322 @end itemize
19324 @item -mfix-r10000
19325 @itemx -mno-fix-r10000
19326 @opindex mfix-r10000
19327 @opindex mno-fix-r10000
19328 Work around certain R10000 errata:
19329 @itemize @minus
19330 @item
19331 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19332 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19333 @end itemize
19335 This option can only be used if the target architecture supports
19336 branch-likely instructions.  @option{-mfix-r10000} is the default when
19337 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19338 otherwise.
19340 @item -mfix-rm7000
19341 @itemx -mno-fix-rm7000
19342 @opindex mfix-rm7000
19343 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19344 workarounds are implemented by the assembler rather than by GCC@.
19346 @item -mfix-vr4120
19347 @itemx -mno-fix-vr4120
19348 @opindex mfix-vr4120
19349 Work around certain VR4120 errata:
19350 @itemize @minus
19351 @item
19352 @code{dmultu} does not always produce the correct result.
19353 @item
19354 @code{div} and @code{ddiv} do not always produce the correct result if one
19355 of the operands is negative.
19356 @end itemize
19357 The workarounds for the division errata rely on special functions in
19358 @file{libgcc.a}.  At present, these functions are only provided by
19359 the @code{mips64vr*-elf} configurations.
19361 Other VR4120 errata require a NOP to be inserted between certain pairs of
19362 instructions.  These errata are handled by the assembler, not by GCC itself.
19364 @item -mfix-vr4130
19365 @opindex mfix-vr4130
19366 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19367 workarounds are implemented by the assembler rather than by GCC,
19368 although GCC avoids using @code{mflo} and @code{mfhi} if the
19369 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19370 instructions are available instead.
19372 @item -mfix-sb1
19373 @itemx -mno-fix-sb1
19374 @opindex mfix-sb1
19375 Work around certain SB-1 CPU core errata.
19376 (This flag currently works around the SB-1 revision 2
19377 ``F1'' and ``F2'' floating-point errata.)
19379 @item -mr10k-cache-barrier=@var{setting}
19380 @opindex mr10k-cache-barrier
19381 Specify whether GCC should insert cache barriers to avoid the
19382 side-effects of speculation on R10K processors.
19384 In common with many processors, the R10K tries to predict the outcome
19385 of a conditional branch and speculatively executes instructions from
19386 the ``taken'' branch.  It later aborts these instructions if the
19387 predicted outcome is wrong.  However, on the R10K, even aborted
19388 instructions can have side effects.
19390 This problem only affects kernel stores and, depending on the system,
19391 kernel loads.  As an example, a speculatively-executed store may load
19392 the target memory into cache and mark the cache line as dirty, even if
19393 the store itself is later aborted.  If a DMA operation writes to the
19394 same area of memory before the ``dirty'' line is flushed, the cached
19395 data overwrites the DMA-ed data.  See the R10K processor manual
19396 for a full description, including other potential problems.
19398 One workaround is to insert cache barrier instructions before every memory
19399 access that might be speculatively executed and that might have side
19400 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19401 controls GCC's implementation of this workaround.  It assumes that
19402 aborted accesses to any byte in the following regions does not have
19403 side effects:
19405 @enumerate
19406 @item
19407 the memory occupied by the current function's stack frame;
19409 @item
19410 the memory occupied by an incoming stack argument;
19412 @item
19413 the memory occupied by an object with a link-time-constant address.
19414 @end enumerate
19416 It is the kernel's responsibility to ensure that speculative
19417 accesses to these regions are indeed safe.
19419 If the input program contains a function declaration such as:
19421 @smallexample
19422 void foo (void);
19423 @end smallexample
19425 then the implementation of @code{foo} must allow @code{j foo} and
19426 @code{jal foo} to be executed speculatively.  GCC honors this
19427 restriction for functions it compiles itself.  It expects non-GCC
19428 functions (such as hand-written assembly code) to do the same.
19430 The option has three forms:
19432 @table @gcctabopt
19433 @item -mr10k-cache-barrier=load-store
19434 Insert a cache barrier before a load or store that might be
19435 speculatively executed and that might have side effects even
19436 if aborted.
19438 @item -mr10k-cache-barrier=store
19439 Insert a cache barrier before a store that might be speculatively
19440 executed and that might have side effects even if aborted.
19442 @item -mr10k-cache-barrier=none
19443 Disable the insertion of cache barriers.  This is the default setting.
19444 @end table
19446 @item -mflush-func=@var{func}
19447 @itemx -mno-flush-func
19448 @opindex mflush-func
19449 Specifies the function to call to flush the I and D caches, or to not
19450 call any such function.  If called, the function must take the same
19451 arguments as the common @code{_flush_func}, that is, the address of the
19452 memory range for which the cache is being flushed, the size of the
19453 memory range, and the number 3 (to flush both caches).  The default
19454 depends on the target GCC was configured for, but commonly is either
19455 @code{_flush_func} or @code{__cpu_flush}.
19457 @item mbranch-cost=@var{num}
19458 @opindex mbranch-cost
19459 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19460 This cost is only a heuristic and is not guaranteed to produce
19461 consistent results across releases.  A zero cost redundantly selects
19462 the default, which is based on the @option{-mtune} setting.
19464 @item -mbranch-likely
19465 @itemx -mno-branch-likely
19466 @opindex mbranch-likely
19467 @opindex mno-branch-likely
19468 Enable or disable use of Branch Likely instructions, regardless of the
19469 default for the selected architecture.  By default, Branch Likely
19470 instructions may be generated if they are supported by the selected
19471 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19472 and processors that implement those architectures; for those, Branch
19473 Likely instructions are not be generated by default because the MIPS32
19474 and MIPS64 architectures specifically deprecate their use.
19476 @item -mcompact-branches=never
19477 @itemx -mcompact-branches=optimal
19478 @itemx -mcompact-branches=always
19479 @opindex mcompact-branches=never
19480 @opindex mcompact-branches=optimal
19481 @opindex mcompact-branches=always
19482 These options control which form of branches will be generated.  The
19483 default is @option{-mcompact-branches=optimal}.
19485 The @option{-mcompact-branches=never} option ensures that compact branch
19486 instructions will never be generated.
19488 The @option{-mcompact-branches=always} option ensures that a compact
19489 branch instruction will be generated if available.  If a compact branch
19490 instruction is not available, a delay slot form of the branch will be
19491 used instead.
19493 This option is supported from MIPS Release 6 onwards.
19495 The @option{-mcompact-branches=optimal} option will cause a delay slot
19496 branch to be used if one is available in the current ISA and the delay
19497 slot is successfully filled.  If the delay slot is not filled, a compact
19498 branch will be chosen if one is available.
19500 @item -mfp-exceptions
19501 @itemx -mno-fp-exceptions
19502 @opindex mfp-exceptions
19503 Specifies whether FP exceptions are enabled.  This affects how
19504 FP instructions are scheduled for some processors.
19505 The default is that FP exceptions are
19506 enabled.
19508 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19509 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19510 FP pipe.
19512 @item -mvr4130-align
19513 @itemx -mno-vr4130-align
19514 @opindex mvr4130-align
19515 The VR4130 pipeline is two-way superscalar, but can only issue two
19516 instructions together if the first one is 8-byte aligned.  When this
19517 option is enabled, GCC aligns pairs of instructions that it
19518 thinks should execute in parallel.
19520 This option only has an effect when optimizing for the VR4130.
19521 It normally makes code faster, but at the expense of making it bigger.
19522 It is enabled by default at optimization level @option{-O3}.
19524 @item -msynci
19525 @itemx -mno-synci
19526 @opindex msynci
19527 Enable (disable) generation of @code{synci} instructions on
19528 architectures that support it.  The @code{synci} instructions (if
19529 enabled) are generated when @code{__builtin___clear_cache} is
19530 compiled.
19532 This option defaults to @option{-mno-synci}, but the default can be
19533 overridden by configuring GCC with @option{--with-synci}.
19535 When compiling code for single processor systems, it is generally safe
19536 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19537 does not invalidate the instruction caches on all cores and may lead
19538 to undefined behavior.
19540 @item -mrelax-pic-calls
19541 @itemx -mno-relax-pic-calls
19542 @opindex mrelax-pic-calls
19543 Try to turn PIC calls that are normally dispatched via register
19544 @code{$25} into direct calls.  This is only possible if the linker can
19545 resolve the destination at link time and if the destination is within
19546 range for a direct call.
19548 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19549 an assembler and a linker that support the @code{.reloc} assembly
19550 directive and @option{-mexplicit-relocs} is in effect.  With
19551 @option{-mno-explicit-relocs}, this optimization can be performed by the
19552 assembler and the linker alone without help from the compiler.
19554 @item -mmcount-ra-address
19555 @itemx -mno-mcount-ra-address
19556 @opindex mmcount-ra-address
19557 @opindex mno-mcount-ra-address
19558 Emit (do not emit) code that allows @code{_mcount} to modify the
19559 calling function's return address.  When enabled, this option extends
19560 the usual @code{_mcount} interface with a new @var{ra-address}
19561 parameter, which has type @code{intptr_t *} and is passed in register
19562 @code{$12}.  @code{_mcount} can then modify the return address by
19563 doing both of the following:
19564 @itemize
19565 @item
19566 Returning the new address in register @code{$31}.
19567 @item
19568 Storing the new address in @code{*@var{ra-address}},
19569 if @var{ra-address} is nonnull.
19570 @end itemize
19572 The default is @option{-mno-mcount-ra-address}.
19574 @item -mframe-header-opt
19575 @itemx -mno-frame-header-opt
19576 @opindex mframe-header-opt
19577 Enable (disable) frame header optimization in the o32 ABI.  When using the
19578 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19579 function to write out register arguments.  When enabled, this optimization
19580 will suppress the allocation of the frame header if it can be determined that
19581 it is unused.
19583 This optimization is off by default at all optimization levels.
19585 @end table
19587 @node MMIX Options
19588 @subsection MMIX Options
19589 @cindex MMIX Options
19591 These options are defined for the MMIX:
19593 @table @gcctabopt
19594 @item -mlibfuncs
19595 @itemx -mno-libfuncs
19596 @opindex mlibfuncs
19597 @opindex mno-libfuncs
19598 Specify that intrinsic library functions are being compiled, passing all
19599 values in registers, no matter the size.
19601 @item -mepsilon
19602 @itemx -mno-epsilon
19603 @opindex mepsilon
19604 @opindex mno-epsilon
19605 Generate floating-point comparison instructions that compare with respect
19606 to the @code{rE} epsilon register.
19608 @item -mabi=mmixware
19609 @itemx -mabi=gnu
19610 @opindex mabi=mmixware
19611 @opindex mabi=gnu
19612 Generate code that passes function parameters and return values that (in
19613 the called function) are seen as registers @code{$0} and up, as opposed to
19614 the GNU ABI which uses global registers @code{$231} and up.
19616 @item -mzero-extend
19617 @itemx -mno-zero-extend
19618 @opindex mzero-extend
19619 @opindex mno-zero-extend
19620 When reading data from memory in sizes shorter than 64 bits, use (do not
19621 use) zero-extending load instructions by default, rather than
19622 sign-extending ones.
19624 @item -mknuthdiv
19625 @itemx -mno-knuthdiv
19626 @opindex mknuthdiv
19627 @opindex mno-knuthdiv
19628 Make the result of a division yielding a remainder have the same sign as
19629 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
19630 remainder follows the sign of the dividend.  Both methods are
19631 arithmetically valid, the latter being almost exclusively used.
19633 @item -mtoplevel-symbols
19634 @itemx -mno-toplevel-symbols
19635 @opindex mtoplevel-symbols
19636 @opindex mno-toplevel-symbols
19637 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
19638 code can be used with the @code{PREFIX} assembly directive.
19640 @item -melf
19641 @opindex melf
19642 Generate an executable in the ELF format, rather than the default
19643 @samp{mmo} format used by the @command{mmix} simulator.
19645 @item -mbranch-predict
19646 @itemx -mno-branch-predict
19647 @opindex mbranch-predict
19648 @opindex mno-branch-predict
19649 Use (do not use) the probable-branch instructions, when static branch
19650 prediction indicates a probable branch.
19652 @item -mbase-addresses
19653 @itemx -mno-base-addresses
19654 @opindex mbase-addresses
19655 @opindex mno-base-addresses
19656 Generate (do not generate) code that uses @emph{base addresses}.  Using a
19657 base address automatically generates a request (handled by the assembler
19658 and the linker) for a constant to be set up in a global register.  The
19659 register is used for one or more base address requests within the range 0
19660 to 255 from the value held in the register.  The generally leads to short
19661 and fast code, but the number of different data items that can be
19662 addressed is limited.  This means that a program that uses lots of static
19663 data may require @option{-mno-base-addresses}.
19665 @item -msingle-exit
19666 @itemx -mno-single-exit
19667 @opindex msingle-exit
19668 @opindex mno-single-exit
19669 Force (do not force) generated code to have a single exit point in each
19670 function.
19671 @end table
19673 @node MN10300 Options
19674 @subsection MN10300 Options
19675 @cindex MN10300 options
19677 These @option{-m} options are defined for Matsushita MN10300 architectures:
19679 @table @gcctabopt
19680 @item -mmult-bug
19681 @opindex mmult-bug
19682 Generate code to avoid bugs in the multiply instructions for the MN10300
19683 processors.  This is the default.
19685 @item -mno-mult-bug
19686 @opindex mno-mult-bug
19687 Do not generate code to avoid bugs in the multiply instructions for the
19688 MN10300 processors.
19690 @item -mam33
19691 @opindex mam33
19692 Generate code using features specific to the AM33 processor.
19694 @item -mno-am33
19695 @opindex mno-am33
19696 Do not generate code using features specific to the AM33 processor.  This
19697 is the default.
19699 @item -mam33-2
19700 @opindex mam33-2
19701 Generate code using features specific to the AM33/2.0 processor.
19703 @item -mam34
19704 @opindex mam34
19705 Generate code using features specific to the AM34 processor.
19707 @item -mtune=@var{cpu-type}
19708 @opindex mtune
19709 Use the timing characteristics of the indicated CPU type when
19710 scheduling instructions.  This does not change the targeted processor
19711 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
19712 @samp{am33-2} or @samp{am34}.
19714 @item -mreturn-pointer-on-d0
19715 @opindex mreturn-pointer-on-d0
19716 When generating a function that returns a pointer, return the pointer
19717 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
19718 only in @code{a0}, and attempts to call such functions without a prototype
19719 result in errors.  Note that this option is on by default; use
19720 @option{-mno-return-pointer-on-d0} to disable it.
19722 @item -mno-crt0
19723 @opindex mno-crt0
19724 Do not link in the C run-time initialization object file.
19726 @item -mrelax
19727 @opindex mrelax
19728 Indicate to the linker that it should perform a relaxation optimization pass
19729 to shorten branches, calls and absolute memory addresses.  This option only
19730 has an effect when used on the command line for the final link step.
19732 This option makes symbolic debugging impossible.
19734 @item -mliw
19735 @opindex mliw
19736 Allow the compiler to generate @emph{Long Instruction Word}
19737 instructions if the target is the @samp{AM33} or later.  This is the
19738 default.  This option defines the preprocessor macro @code{__LIW__}.
19740 @item -mnoliw
19741 @opindex mnoliw
19742 Do not allow the compiler to generate @emph{Long Instruction Word}
19743 instructions.  This option defines the preprocessor macro
19744 @code{__NO_LIW__}.
19746 @item -msetlb
19747 @opindex msetlb
19748 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
19749 instructions if the target is the @samp{AM33} or later.  This is the
19750 default.  This option defines the preprocessor macro @code{__SETLB__}.
19752 @item -mnosetlb
19753 @opindex mnosetlb
19754 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
19755 instructions.  This option defines the preprocessor macro
19756 @code{__NO_SETLB__}.
19758 @end table
19760 @node Moxie Options
19761 @subsection Moxie Options
19762 @cindex Moxie Options
19764 @table @gcctabopt
19766 @item -meb
19767 @opindex meb
19768 Generate big-endian code.  This is the default for @samp{moxie-*-*}
19769 configurations.
19771 @item -mel
19772 @opindex mel
19773 Generate little-endian code.
19775 @item -mmul.x
19776 @opindex mmul.x
19777 Generate mul.x and umul.x instructions.  This is the default for
19778 @samp{moxiebox-*-*} configurations.
19780 @item -mno-crt0
19781 @opindex mno-crt0
19782 Do not link in the C run-time initialization object file.
19784 @end table
19786 @node MSP430 Options
19787 @subsection MSP430 Options
19788 @cindex MSP430 Options
19790 These options are defined for the MSP430:
19792 @table @gcctabopt
19794 @item -masm-hex
19795 @opindex masm-hex
19796 Force assembly output to always use hex constants.  Normally such
19797 constants are signed decimals, but this option is available for
19798 testsuite and/or aesthetic purposes.
19800 @item -mmcu=
19801 @opindex mmcu=
19802 Select the MCU to target.  This is used to create a C preprocessor
19803 symbol based upon the MCU name, converted to upper case and pre- and
19804 post-fixed with @samp{__}.  This in turn is used by the
19805 @file{msp430.h} header file to select an MCU-specific supplementary
19806 header file.
19808 The option also sets the ISA to use.  If the MCU name is one that is
19809 known to only support the 430 ISA then that is selected, otherwise the
19810 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
19811 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
19812 name selects the 430X ISA.
19814 In addition an MCU-specific linker script is added to the linker
19815 command line.  The script's name is the name of the MCU with
19816 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
19817 command line defines the C preprocessor symbol @code{__XXX__} and
19818 cause the linker to search for a script called @file{xxx.ld}.
19820 This option is also passed on to the assembler.
19822 @item -mwarn-mcu
19823 @itemx -mno-warn-mcu
19824 @opindex mwarn-mcu
19825 @opindex mno-warn-mcu
19826 This option enables or disables warnings about conflicts between the
19827 MCU name specified by the @option{-mmcu} option and the ISA set by the
19828 @option{-mcpu} option and/or the hardware multiply support set by the
19829 @option{-mhwmult} option.  It also toggles warnings about unrecognized
19830 MCU names.  This option is on by default.
19832 @item -mcpu=
19833 @opindex mcpu=
19834 Specifies the ISA to use.  Accepted values are @samp{msp430},
19835 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
19836 @option{-mmcu=} option should be used to select the ISA.
19838 @item -msim
19839 @opindex msim
19840 Link to the simulator runtime libraries and linker script.  Overrides
19841 any scripts that would be selected by the @option{-mmcu=} option.
19843 @item -mlarge
19844 @opindex mlarge
19845 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
19847 @item -msmall
19848 @opindex msmall
19849 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
19851 @item -mrelax
19852 @opindex mrelax
19853 This option is passed to the assembler and linker, and allows the
19854 linker to perform certain optimizations that cannot be done until
19855 the final link.
19857 @item mhwmult=
19858 @opindex mhwmult=
19859 Describes the type of hardware multiply supported by the target.
19860 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
19861 for the original 16-bit-only multiply supported by early MCUs.
19862 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
19863 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
19864 A value of @samp{auto} can also be given.  This tells GCC to deduce
19865 the hardware multiply support based upon the MCU name provided by the
19866 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
19867 the MCU name is not recognized then no hardware multiply support is
19868 assumed.  @code{auto} is the default setting.
19870 Hardware multiplies are normally performed by calling a library
19871 routine.  This saves space in the generated code.  When compiling at
19872 @option{-O3} or higher however the hardware multiplier is invoked
19873 inline.  This makes for bigger, but faster code.
19875 The hardware multiply routines disable interrupts whilst running and
19876 restore the previous interrupt state when they finish.  This makes
19877 them safe to use inside interrupt handlers as well as in normal code.
19879 @item -minrt
19880 @opindex minrt
19881 Enable the use of a minimum runtime environment - no static
19882 initializers or constructors.  This is intended for memory-constrained
19883 devices.  The compiler includes special symbols in some objects
19884 that tell the linker and runtime which code fragments are required.
19886 @item -mcode-region=
19887 @itemx -mdata-region=
19888 @opindex mcode-region
19889 @opindex mdata-region
19890 These options tell the compiler where to place functions and data that
19891 do not have one of the @code{lower}, @code{upper}, @code{either} or
19892 @code{section} attributes.  Possible values are @code{lower},
19893 @code{upper}, @code{either} or @code{any}.  The first three behave
19894 like the corresponding attribute.  The fourth possible value -
19895 @code{any} - is the default.  It leaves placement entirely up to the
19896 linker script and how it assigns the standard sections
19897 (@code{.text}, @code{.data}, etc) to the memory regions.
19899 @item -msilicon-errata=
19900 @opindex msilicon-errata
19901 This option passes on a request to assembler to enable the fixes for
19902 the named silicon errata.
19904 @item -msilicon-errata-warn=
19905 @opindex msilicon-errata-warn
19906 This option passes on a request to the assembler to enable warning
19907 messages when a silicon errata might need to be applied.
19909 @end table
19911 @node NDS32 Options
19912 @subsection NDS32 Options
19913 @cindex NDS32 Options
19915 These options are defined for NDS32 implementations:
19917 @table @gcctabopt
19919 @item -mbig-endian
19920 @opindex mbig-endian
19921 Generate code in big-endian mode.
19923 @item -mlittle-endian
19924 @opindex mlittle-endian
19925 Generate code in little-endian mode.
19927 @item -mreduced-regs
19928 @opindex mreduced-regs
19929 Use reduced-set registers for register allocation.
19931 @item -mfull-regs
19932 @opindex mfull-regs
19933 Use full-set registers for register allocation.
19935 @item -mcmov
19936 @opindex mcmov
19937 Generate conditional move instructions.
19939 @item -mno-cmov
19940 @opindex mno-cmov
19941 Do not generate conditional move instructions.
19943 @item -mperf-ext
19944 @opindex mperf-ext
19945 Generate performance extension instructions.
19947 @item -mno-perf-ext
19948 @opindex mno-perf-ext
19949 Do not generate performance extension instructions.
19951 @item -mv3push
19952 @opindex mv3push
19953 Generate v3 push25/pop25 instructions.
19955 @item -mno-v3push
19956 @opindex mno-v3push
19957 Do not generate v3 push25/pop25 instructions.
19959 @item -m16-bit
19960 @opindex m16-bit
19961 Generate 16-bit instructions.
19963 @item -mno-16-bit
19964 @opindex mno-16-bit
19965 Do not generate 16-bit instructions.
19967 @item -misr-vector-size=@var{num}
19968 @opindex misr-vector-size
19969 Specify the size of each interrupt vector, which must be 4 or 16.
19971 @item -mcache-block-size=@var{num}
19972 @opindex mcache-block-size
19973 Specify the size of each cache block,
19974 which must be a power of 2 between 4 and 512.
19976 @item -march=@var{arch}
19977 @opindex march
19978 Specify the name of the target architecture.
19980 @item -mcmodel=@var{code-model}
19981 @opindex mcmodel
19982 Set the code model to one of
19983 @table @asis
19984 @item @samp{small}
19985 All the data and read-only data segments must be within 512KB addressing space.
19986 The text segment must be within 16MB addressing space.
19987 @item @samp{medium}
19988 The data segment must be within 512KB while the read-only data segment can be
19989 within 4GB addressing space.  The text segment should be still within 16MB
19990 addressing space.
19991 @item @samp{large}
19992 All the text and data segments can be within 4GB addressing space.
19993 @end table
19995 @item -mctor-dtor
19996 @opindex mctor-dtor
19997 Enable constructor/destructor feature.
19999 @item -mrelax
20000 @opindex mrelax
20001 Guide linker to relax instructions.
20003 @end table
20005 @node Nios II Options
20006 @subsection Nios II Options
20007 @cindex Nios II options
20008 @cindex Altera Nios II options
20010 These are the options defined for the Altera Nios II processor.
20012 @table @gcctabopt
20014 @item -G @var{num}
20015 @opindex G
20016 @cindex smaller data references
20017 Put global and static objects less than or equal to @var{num} bytes
20018 into the small data or BSS sections instead of the normal data or BSS
20019 sections.  The default value of @var{num} is 8.
20021 @item -mgpopt=@var{option}
20022 @item -mgpopt
20023 @itemx -mno-gpopt
20024 @opindex mgpopt
20025 @opindex mno-gpopt
20026 Generate (do not generate) GP-relative accesses.  The following 
20027 @var{option} names are recognized:
20029 @table @samp
20031 @item none
20032 Do not generate GP-relative accesses.
20034 @item local
20035 Generate GP-relative accesses for small data objects that are not 
20036 external, weak, or uninitialized common symbols.  
20037 Also use GP-relative addressing for objects that
20038 have been explicitly placed in a small data section via a @code{section}
20039 attribute.
20041 @item global
20042 As for @samp{local}, but also generate GP-relative accesses for
20043 small data objects that are external, weak, or common.  If you use this option,
20044 you must ensure that all parts of your program (including libraries) are
20045 compiled with the same @option{-G} setting.
20047 @item data
20048 Generate GP-relative accesses for all data objects in the program.  If you
20049 use this option, the entire data and BSS segments
20050 of your program must fit in 64K of memory and you must use an appropriate
20051 linker script to allocate them within the addressable range of the
20052 global pointer.
20054 @item all
20055 Generate GP-relative addresses for function pointers as well as data
20056 pointers.  If you use this option, the entire text, data, and BSS segments
20057 of your program must fit in 64K of memory and you must use an appropriate
20058 linker script to allocate them within the addressable range of the
20059 global pointer.
20061 @end table
20063 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20064 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20066 The default is @option{-mgpopt} except when @option{-fpic} or
20067 @option{-fPIC} is specified to generate position-independent code.
20068 Note that the Nios II ABI does not permit GP-relative accesses from
20069 shared libraries.
20071 You may need to specify @option{-mno-gpopt} explicitly when building
20072 programs that include large amounts of small data, including large
20073 GOT data sections.  In this case, the 16-bit offset for GP-relative
20074 addressing may not be large enough to allow access to the entire 
20075 small data section.
20077 @item -mel
20078 @itemx -meb
20079 @opindex mel
20080 @opindex meb
20081 Generate little-endian (default) or big-endian (experimental) code,
20082 respectively.
20084 @item -march=@var{arch}
20085 @opindex march
20086 This specifies the name of the target Nios II architecture.  GCC uses this
20087 name to determine what kind of instructions it can emit when generating
20088 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20090 The preprocessor macro @code{__nios2_arch__} is available to programs,
20091 with value 1 or 2, indicating the targeted ISA level.
20093 @item -mbypass-cache
20094 @itemx -mno-bypass-cache
20095 @opindex mno-bypass-cache
20096 @opindex mbypass-cache
20097 Force all load and store instructions to always bypass cache by 
20098 using I/O variants of the instructions. The default is not to
20099 bypass the cache.
20101 @item -mno-cache-volatile 
20102 @itemx -mcache-volatile       
20103 @opindex mcache-volatile 
20104 @opindex mno-cache-volatile
20105 Volatile memory access bypass the cache using the I/O variants of 
20106 the load and store instructions. The default is not to bypass the cache.
20108 @item -mno-fast-sw-div
20109 @itemx -mfast-sw-div
20110 @opindex mno-fast-sw-div
20111 @opindex mfast-sw-div
20112 Do not use table-based fast divide for small numbers. The default 
20113 is to use the fast divide at @option{-O3} and above.
20115 @item -mno-hw-mul
20116 @itemx -mhw-mul
20117 @itemx -mno-hw-mulx
20118 @itemx -mhw-mulx
20119 @itemx -mno-hw-div
20120 @itemx -mhw-div
20121 @opindex mno-hw-mul
20122 @opindex mhw-mul
20123 @opindex mno-hw-mulx
20124 @opindex mhw-mulx
20125 @opindex mno-hw-div
20126 @opindex mhw-div
20127 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20128 instructions by the compiler. The default is to emit @code{mul}
20129 and not emit @code{div} and @code{mulx}.
20131 @item -mbmx
20132 @itemx -mno-bmx
20133 @itemx -mcdx
20134 @itemx -mno-cdx
20135 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20136 CDX (code density) instructions.  Enabling these instructions also
20137 requires @option{-march=r2}.  Since these instructions are optional
20138 extensions to the R2 architecture, the default is not to emit them.
20140 @item -mcustom-@var{insn}=@var{N}
20141 @itemx -mno-custom-@var{insn}
20142 @opindex mcustom-@var{insn}
20143 @opindex mno-custom-@var{insn}
20144 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20145 custom instruction with encoding @var{N} when generating code that uses 
20146 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20147 instruction 253 for single-precision floating-point add operations instead
20148 of the default behavior of using a library call.
20150 The following values of @var{insn} are supported.  Except as otherwise
20151 noted, floating-point operations are expected to be implemented with
20152 normal IEEE 754 semantics and correspond directly to the C operators or the
20153 equivalent GCC built-in functions (@pxref{Other Builtins}).
20155 Single-precision floating point:
20156 @table @asis
20158 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20159 Binary arithmetic operations.
20161 @item @samp{fnegs}
20162 Unary negation.
20164 @item @samp{fabss}
20165 Unary absolute value.
20167 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20168 Comparison operations.
20170 @item @samp{fmins}, @samp{fmaxs}
20171 Floating-point minimum and maximum.  These instructions are only
20172 generated if @option{-ffinite-math-only} is specified.
20174 @item @samp{fsqrts}
20175 Unary square root operation.
20177 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20178 Floating-point trigonometric and exponential functions.  These instructions
20179 are only generated if @option{-funsafe-math-optimizations} is also specified.
20181 @end table
20183 Double-precision floating point:
20184 @table @asis
20186 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20187 Binary arithmetic operations.
20189 @item @samp{fnegd}
20190 Unary negation.
20192 @item @samp{fabsd}
20193 Unary absolute value.
20195 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20196 Comparison operations.
20198 @item @samp{fmind}, @samp{fmaxd}
20199 Double-precision minimum and maximum.  These instructions are only
20200 generated if @option{-ffinite-math-only} is specified.
20202 @item @samp{fsqrtd}
20203 Unary square root operation.
20205 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20206 Double-precision trigonometric and exponential functions.  These instructions
20207 are only generated if @option{-funsafe-math-optimizations} is also specified.
20209 @end table
20211 Conversions:
20212 @table @asis
20213 @item @samp{fextsd}
20214 Conversion from single precision to double precision.
20216 @item @samp{ftruncds}
20217 Conversion from double precision to single precision.
20219 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20220 Conversion from floating point to signed or unsigned integer types, with
20221 truncation towards zero.
20223 @item @samp{round}
20224 Conversion from single-precision floating point to signed integer,
20225 rounding to the nearest integer and ties away from zero.
20226 This corresponds to the @code{__builtin_lroundf} function when
20227 @option{-fno-math-errno} is used.
20229 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20230 Conversion from signed or unsigned integer types to floating-point types.
20232 @end table
20234 In addition, all of the following transfer instructions for internal
20235 registers X and Y must be provided to use any of the double-precision
20236 floating-point instructions.  Custom instructions taking two
20237 double-precision source operands expect the first operand in the
20238 64-bit register X.  The other operand (or only operand of a unary
20239 operation) is given to the custom arithmetic instruction with the
20240 least significant half in source register @var{src1} and the most
20241 significant half in @var{src2}.  A custom instruction that returns a
20242 double-precision result returns the most significant 32 bits in the
20243 destination register and the other half in 32-bit register Y.  
20244 GCC automatically generates the necessary code sequences to write
20245 register X and/or read register Y when double-precision floating-point
20246 instructions are used.
20248 @table @asis
20250 @item @samp{fwrx}
20251 Write @var{src1} into the least significant half of X and @var{src2} into
20252 the most significant half of X.
20254 @item @samp{fwry}
20255 Write @var{src1} into Y.
20257 @item @samp{frdxhi}, @samp{frdxlo}
20258 Read the most or least (respectively) significant half of X and store it in
20259 @var{dest}.
20261 @item @samp{frdy}
20262 Read the value of Y and store it into @var{dest}.
20263 @end table
20265 Note that you can gain more local control over generation of Nios II custom
20266 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20267 and @code{target("no-custom-@var{insn}")} function attributes
20268 (@pxref{Function Attributes})
20269 or pragmas (@pxref{Function Specific Option Pragmas}).
20271 @item -mcustom-fpu-cfg=@var{name}
20272 @opindex mcustom-fpu-cfg
20274 This option enables a predefined, named set of custom instruction encodings
20275 (see @option{-mcustom-@var{insn}} above).  
20276 Currently, the following sets are defined:
20278 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20279 @gccoptlist{-mcustom-fmuls=252 @gol
20280 -mcustom-fadds=253 @gol
20281 -mcustom-fsubs=254 @gol
20282 -fsingle-precision-constant}
20284 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20285 @gccoptlist{-mcustom-fmuls=252 @gol
20286 -mcustom-fadds=253 @gol
20287 -mcustom-fsubs=254 @gol
20288 -mcustom-fdivs=255 @gol
20289 -fsingle-precision-constant}
20291 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20292 @gccoptlist{-mcustom-floatus=243 @gol
20293 -mcustom-fixsi=244 @gol
20294 -mcustom-floatis=245 @gol
20295 -mcustom-fcmpgts=246 @gol
20296 -mcustom-fcmples=249 @gol
20297 -mcustom-fcmpeqs=250 @gol
20298 -mcustom-fcmpnes=251 @gol
20299 -mcustom-fmuls=252 @gol
20300 -mcustom-fadds=253 @gol
20301 -mcustom-fsubs=254 @gol
20302 -mcustom-fdivs=255 @gol
20303 -fsingle-precision-constant}
20305 Custom instruction assignments given by individual
20306 @option{-mcustom-@var{insn}=} options override those given by
20307 @option{-mcustom-fpu-cfg=}, regardless of the
20308 order of the options on the command line.
20310 Note that you can gain more local control over selection of a FPU
20311 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20312 function attribute (@pxref{Function Attributes})
20313 or pragma (@pxref{Function Specific Option Pragmas}).
20315 @end table
20317 These additional @samp{-m} options are available for the Altera Nios II
20318 ELF (bare-metal) target:
20320 @table @gcctabopt
20322 @item -mhal
20323 @opindex mhal
20324 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20325 startup and termination code, and is typically used in conjunction with
20326 @option{-msys-crt0=} to specify the location of the alternate startup code
20327 provided by the HAL BSP.
20329 @item -msmallc
20330 @opindex msmallc
20331 Link with a limited version of the C library, @option{-lsmallc}, rather than
20332 Newlib.
20334 @item -msys-crt0=@var{startfile}
20335 @opindex msys-crt0
20336 @var{startfile} is the file name of the startfile (crt0) to use 
20337 when linking.  This option is only useful in conjunction with @option{-mhal}.
20339 @item -msys-lib=@var{systemlib}
20340 @opindex msys-lib
20341 @var{systemlib} is the library name of the library that provides
20342 low-level system calls required by the C library,
20343 e.g. @code{read} and @code{write}.
20344 This option is typically used to link with a library provided by a HAL BSP.
20346 @end table
20348 @node Nvidia PTX Options
20349 @subsection Nvidia PTX Options
20350 @cindex Nvidia PTX options
20351 @cindex nvptx options
20353 These options are defined for Nvidia PTX:
20355 @table @gcctabopt
20357 @item -m32
20358 @itemx -m64
20359 @opindex m32
20360 @opindex m64
20361 Generate code for 32-bit or 64-bit ABI.
20363 @item -mmainkernel
20364 @opindex mmainkernel
20365 Link in code for a __main kernel.  This is for stand-alone instead of
20366 offloading execution.
20368 @item -moptimize
20369 @opindex moptimize
20370 Apply partitioned execution optimizations.  This is the default when any
20371 level of optimization is selected.
20373 @end table
20375 @node PDP-11 Options
20376 @subsection PDP-11 Options
20377 @cindex PDP-11 Options
20379 These options are defined for the PDP-11:
20381 @table @gcctabopt
20382 @item -mfpu
20383 @opindex mfpu
20384 Use hardware FPP floating point.  This is the default.  (FIS floating
20385 point on the PDP-11/40 is not supported.)
20387 @item -msoft-float
20388 @opindex msoft-float
20389 Do not use hardware floating point.
20391 @item -mac0
20392 @opindex mac0
20393 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20395 @item -mno-ac0
20396 @opindex mno-ac0
20397 Return floating-point results in memory.  This is the default.
20399 @item -m40
20400 @opindex m40
20401 Generate code for a PDP-11/40.
20403 @item -m45
20404 @opindex m45
20405 Generate code for a PDP-11/45.  This is the default.
20407 @item -m10
20408 @opindex m10
20409 Generate code for a PDP-11/10.
20411 @item -mbcopy-builtin
20412 @opindex mbcopy-builtin
20413 Use inline @code{movmemhi} patterns for copying memory.  This is the
20414 default.
20416 @item -mbcopy
20417 @opindex mbcopy
20418 Do not use inline @code{movmemhi} patterns for copying memory.
20420 @item -mint16
20421 @itemx -mno-int32
20422 @opindex mint16
20423 @opindex mno-int32
20424 Use 16-bit @code{int}.  This is the default.
20426 @item -mint32
20427 @itemx -mno-int16
20428 @opindex mint32
20429 @opindex mno-int16
20430 Use 32-bit @code{int}.
20432 @item -mfloat64
20433 @itemx -mno-float32
20434 @opindex mfloat64
20435 @opindex mno-float32
20436 Use 64-bit @code{float}.  This is the default.
20438 @item -mfloat32
20439 @itemx -mno-float64
20440 @opindex mfloat32
20441 @opindex mno-float64
20442 Use 32-bit @code{float}.
20444 @item -mabshi
20445 @opindex mabshi
20446 Use @code{abshi2} pattern.  This is the default.
20448 @item -mno-abshi
20449 @opindex mno-abshi
20450 Do not use @code{abshi2} pattern.
20452 @item -mbranch-expensive
20453 @opindex mbranch-expensive
20454 Pretend that branches are expensive.  This is for experimenting with
20455 code generation only.
20457 @item -mbranch-cheap
20458 @opindex mbranch-cheap
20459 Do not pretend that branches are expensive.  This is the default.
20461 @item -munix-asm
20462 @opindex munix-asm
20463 Use Unix assembler syntax.  This is the default when configured for
20464 @samp{pdp11-*-bsd}.
20466 @item -mdec-asm
20467 @opindex mdec-asm
20468 Use DEC assembler syntax.  This is the default when configured for any
20469 PDP-11 target other than @samp{pdp11-*-bsd}.
20470 @end table
20472 @node picoChip Options
20473 @subsection picoChip Options
20474 @cindex picoChip options
20476 These @samp{-m} options are defined for picoChip implementations:
20478 @table @gcctabopt
20480 @item -mae=@var{ae_type}
20481 @opindex mcpu
20482 Set the instruction set, register set, and instruction scheduling
20483 parameters for array element type @var{ae_type}.  Supported values
20484 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20486 @option{-mae=ANY} selects a completely generic AE type.  Code
20487 generated with this option runs on any of the other AE types.  The
20488 code is not as efficient as it would be if compiled for a specific
20489 AE type, and some types of operation (e.g., multiplication) do not
20490 work properly on all types of AE.
20492 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20493 for compiled code, and is the default.
20495 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20496 option may suffer from poor performance of byte (char) manipulation,
20497 since the DSP AE does not provide hardware support for byte load/stores.
20499 @item -msymbol-as-address
20500 Enable the compiler to directly use a symbol name as an address in a
20501 load/store instruction, without first loading it into a
20502 register.  Typically, the use of this option generates larger
20503 programs, which run faster than when the option isn't used.  However, the
20504 results vary from program to program, so it is left as a user option,
20505 rather than being permanently enabled.
20507 @item -mno-inefficient-warnings
20508 Disables warnings about the generation of inefficient code.  These
20509 warnings can be generated, for example, when compiling code that
20510 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20511 no hardware support for byte-level memory operations, so all byte
20512 load/stores must be synthesized from word load/store operations.  This is
20513 inefficient and a warning is generated to indicate
20514 that you should rewrite the code to avoid byte operations, or to target
20515 an AE type that has the necessary hardware support.  This option disables
20516 these warnings.
20518 @end table
20520 @node PowerPC Options
20521 @subsection PowerPC Options
20522 @cindex PowerPC options
20524 These are listed under @xref{RS/6000 and PowerPC Options}.
20526 @node RL78 Options
20527 @subsection RL78 Options
20528 @cindex RL78 Options
20530 @table @gcctabopt
20532 @item -msim
20533 @opindex msim
20534 Links in additional target libraries to support operation within a
20535 simulator.
20537 @item -mmul=none
20538 @itemx -mmul=g10
20539 @itemx -mmul=g13
20540 @itemx -mmul=g14
20541 @itemx -mmul=rl78
20542 @opindex mmul
20543 Specifies the type of hardware multiplication and division support to
20544 be used.  The simplest is @code{none}, which uses software for both
20545 multiplication and division.  This is the default.  The @code{g13}
20546 value is for the hardware multiply/divide peripheral found on the
20547 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20548 the multiplication and division instructions supported by the RL78/G14
20549 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20550 the value @code{mg10} is an alias for @code{none}.
20552 In addition a C preprocessor macro is defined, based upon the setting
20553 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20554 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20556 @item -mcpu=g10
20557 @itemx -mcpu=g13
20558 @itemx -mcpu=g14
20559 @itemx -mcpu=rl78
20560 @opindex mcpu
20561 Specifies the RL78 core to target.  The default is the G14 core, also
20562 known as an S3 core or just RL78.  The G13 or S2 core does not have
20563 multiply or divide instructions, instead it uses a hardware peripheral
20564 for these operations.  The G10 or S1 core does not have register
20565 banks, so it uses a different calling convention.
20567 If this option is set it also selects the type of hardware multiply
20568 support to use, unless this is overridden by an explicit
20569 @option{-mmul=none} option on the command line.  Thus specifying
20570 @option{-mcpu=g13} enables the use of the G13 hardware multiply
20571 peripheral and specifying @option{-mcpu=g10} disables the use of
20572 hardware multiplications altogether.
20574 Note, although the RL78/G14 core is the default target, specifying
20575 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
20576 change the behavior of the toolchain since it also enables G14
20577 hardware multiply support.  If these options are not specified on the
20578 command line then software multiplication routines will be used even
20579 though the code targets the RL78 core.  This is for backwards
20580 compatibility with older toolchains which did not have hardware
20581 multiply and divide support.
20583 In addition a C preprocessor macro is defined, based upon the setting
20584 of this option.  Possible values are: @code{__RL78_G10__},
20585 @code{__RL78_G13__} or @code{__RL78_G14__}.
20587 @item -mg10
20588 @itemx -mg13
20589 @itemx -mg14
20590 @itemx -mrl78
20591 @opindex mg10
20592 @opindex mg13
20593 @opindex mg14
20594 @opindex mrl78
20595 These are aliases for the corresponding @option{-mcpu=} option.  They
20596 are provided for backwards compatibility.
20598 @item -mallregs
20599 @opindex mallregs
20600 Allow the compiler to use all of the available registers.  By default
20601 registers @code{r24..r31} are reserved for use in interrupt handlers.
20602 With this option enabled these registers can be used in ordinary
20603 functions as well.
20605 @item -m64bit-doubles
20606 @itemx -m32bit-doubles
20607 @opindex m64bit-doubles
20608 @opindex m32bit-doubles
20609 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20610 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20611 @option{-m32bit-doubles}.
20613 @item -msave-mduc-in-interrupts
20614 @item -mno-save-mduc-in-interrupts
20615 @opindex msave-mduc-in-interrupts
20616 @opindex mno-save-mduc-in-interrupts
20617 Specifies that interrupt handler functions should preserve the
20618 MDUC registers.  This is only necessary if normal code might use
20619 the MDUC registers, for example because it performs multiplication
20620 and division operations.  The default is to ignore the MDUC registers
20621 as this makes the interrupt handlers faster.  The target option -mg13
20622 needs to be passed for this to work as this feature is only available
20623 on the G13 target (S2 core).  The MDUC registers will only be saved
20624 if the interrupt handler performs a multiplication or division
20625 operation or it calls another function.
20627 @end table
20629 @node RS/6000 and PowerPC Options
20630 @subsection IBM RS/6000 and PowerPC Options
20631 @cindex RS/6000 and PowerPC Options
20632 @cindex IBM RS/6000 and PowerPC Options
20634 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
20635 @table @gcctabopt
20636 @item -mpowerpc-gpopt
20637 @itemx -mno-powerpc-gpopt
20638 @itemx -mpowerpc-gfxopt
20639 @itemx -mno-powerpc-gfxopt
20640 @need 800
20641 @itemx -mpowerpc64
20642 @itemx -mno-powerpc64
20643 @itemx -mmfcrf
20644 @itemx -mno-mfcrf
20645 @itemx -mpopcntb
20646 @itemx -mno-popcntb
20647 @itemx -mpopcntd
20648 @itemx -mno-popcntd
20649 @itemx -mfprnd
20650 @itemx -mno-fprnd
20651 @need 800
20652 @itemx -mcmpb
20653 @itemx -mno-cmpb
20654 @itemx -mmfpgpr
20655 @itemx -mno-mfpgpr
20656 @itemx -mhard-dfp
20657 @itemx -mno-hard-dfp
20658 @opindex mpowerpc-gpopt
20659 @opindex mno-powerpc-gpopt
20660 @opindex mpowerpc-gfxopt
20661 @opindex mno-powerpc-gfxopt
20662 @opindex mpowerpc64
20663 @opindex mno-powerpc64
20664 @opindex mmfcrf
20665 @opindex mno-mfcrf
20666 @opindex mpopcntb
20667 @opindex mno-popcntb
20668 @opindex mpopcntd
20669 @opindex mno-popcntd
20670 @opindex mfprnd
20671 @opindex mno-fprnd
20672 @opindex mcmpb
20673 @opindex mno-cmpb
20674 @opindex mmfpgpr
20675 @opindex mno-mfpgpr
20676 @opindex mhard-dfp
20677 @opindex mno-hard-dfp
20678 You use these options to specify which instructions are available on the
20679 processor you are using.  The default value of these options is
20680 determined when configuring GCC@.  Specifying the
20681 @option{-mcpu=@var{cpu_type}} overrides the specification of these
20682 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
20683 rather than the options listed above.
20685 Specifying @option{-mpowerpc-gpopt} allows
20686 GCC to use the optional PowerPC architecture instructions in the
20687 General Purpose group, including floating-point square root.  Specifying
20688 @option{-mpowerpc-gfxopt} allows GCC to
20689 use the optional PowerPC architecture instructions in the Graphics
20690 group, including floating-point select.
20692 The @option{-mmfcrf} option allows GCC to generate the move from
20693 condition register field instruction implemented on the POWER4
20694 processor and other processors that support the PowerPC V2.01
20695 architecture.
20696 The @option{-mpopcntb} option allows GCC to generate the popcount and
20697 double-precision FP reciprocal estimate instruction implemented on the
20698 POWER5 processor and other processors that support the PowerPC V2.02
20699 architecture.
20700 The @option{-mpopcntd} option allows GCC to generate the popcount
20701 instruction implemented on the POWER7 processor and other processors
20702 that support the PowerPC V2.06 architecture.
20703 The @option{-mfprnd} option allows GCC to generate the FP round to
20704 integer instructions implemented on the POWER5+ processor and other
20705 processors that support the PowerPC V2.03 architecture.
20706 The @option{-mcmpb} option allows GCC to generate the compare bytes
20707 instruction implemented on the POWER6 processor and other processors
20708 that support the PowerPC V2.05 architecture.
20709 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
20710 general-purpose register instructions implemented on the POWER6X
20711 processor and other processors that support the extended PowerPC V2.05
20712 architecture.
20713 The @option{-mhard-dfp} option allows GCC to generate the decimal
20714 floating-point instructions implemented on some POWER processors.
20716 The @option{-mpowerpc64} option allows GCC to generate the additional
20717 64-bit instructions that are found in the full PowerPC64 architecture
20718 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
20719 @option{-mno-powerpc64}.
20721 @item -mcpu=@var{cpu_type}
20722 @opindex mcpu
20723 Set architecture type, register usage, and
20724 instruction scheduling parameters for machine type @var{cpu_type}.
20725 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
20726 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
20727 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
20728 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
20729 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
20730 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
20731 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
20732 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
20733 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
20734 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
20735 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
20736 and @samp{rs64}.
20738 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
20739 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
20740 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
20741 architecture machine types, with an appropriate, generic processor
20742 model assumed for scheduling purposes.
20744 The other options specify a specific processor.  Code generated under
20745 those options runs best on that processor, and may not run at all on
20746 others.
20748 The @option{-mcpu} options automatically enable or disable the
20749 following options:
20751 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
20752 -mpopcntb -mpopcntd  -mpowerpc64 @gol
20753 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
20754 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
20755 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
20756 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
20758 The particular options set for any particular CPU varies between
20759 compiler versions, depending on what setting seems to produce optimal
20760 code for that CPU; it doesn't necessarily reflect the actual hardware's
20761 capabilities.  If you wish to set an individual option to a particular
20762 value, you may specify it after the @option{-mcpu} option, like
20763 @option{-mcpu=970 -mno-altivec}.
20765 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
20766 not enabled or disabled by the @option{-mcpu} option at present because
20767 AIX does not have full support for these options.  You may still
20768 enable or disable them individually if you're sure it'll work in your
20769 environment.
20771 @item -mtune=@var{cpu_type}
20772 @opindex mtune
20773 Set the instruction scheduling parameters for machine type
20774 @var{cpu_type}, but do not set the architecture type or register usage,
20775 as @option{-mcpu=@var{cpu_type}} does.  The same
20776 values for @var{cpu_type} are used for @option{-mtune} as for
20777 @option{-mcpu}.  If both are specified, the code generated uses the
20778 architecture and registers set by @option{-mcpu}, but the
20779 scheduling parameters set by @option{-mtune}.
20781 @item -mcmodel=small
20782 @opindex mcmodel=small
20783 Generate PowerPC64 code for the small model: The TOC is limited to
20784 64k.
20786 @item -mcmodel=medium
20787 @opindex mcmodel=medium
20788 Generate PowerPC64 code for the medium model: The TOC and other static
20789 data may be up to a total of 4G in size.
20791 @item -mcmodel=large
20792 @opindex mcmodel=large
20793 Generate PowerPC64 code for the large model: The TOC may be up to 4G
20794 in size.  Other data and code is only limited by the 64-bit address
20795 space.
20797 @item -maltivec
20798 @itemx -mno-altivec
20799 @opindex maltivec
20800 @opindex mno-altivec
20801 Generate code that uses (does not use) AltiVec instructions, and also
20802 enable the use of built-in functions that allow more direct access to
20803 the AltiVec instruction set.  You may also need to set
20804 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
20805 enhancements.
20807 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
20808 @option{-maltivec=be}, the element order for AltiVec intrinsics such
20809 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
20810 match array element order corresponding to the endianness of the
20811 target.  That is, element zero identifies the leftmost element in a
20812 vector register when targeting a big-endian platform, and identifies
20813 the rightmost element in a vector register when targeting a
20814 little-endian platform.
20816 @item -maltivec=be
20817 @opindex maltivec=be
20818 Generate AltiVec instructions using big-endian element order,
20819 regardless of whether the target is big- or little-endian.  This is
20820 the default when targeting a big-endian platform.
20822 The element order is used to interpret element numbers in AltiVec
20823 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
20824 @code{vec_insert}.  By default, these match array element order
20825 corresponding to the endianness for the target.
20827 @item -maltivec=le
20828 @opindex maltivec=le
20829 Generate AltiVec instructions using little-endian element order,
20830 regardless of whether the target is big- or little-endian.  This is
20831 the default when targeting a little-endian platform.  This option is
20832 currently ignored when targeting a big-endian platform.
20834 The element order is used to interpret element numbers in AltiVec
20835 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
20836 @code{vec_insert}.  By default, these match array element order
20837 corresponding to the endianness for the target.
20839 @item -mvrsave
20840 @itemx -mno-vrsave
20841 @opindex mvrsave
20842 @opindex mno-vrsave
20843 Generate VRSAVE instructions when generating AltiVec code.
20845 @item -mgen-cell-microcode
20846 @opindex mgen-cell-microcode
20847 Generate Cell microcode instructions.
20849 @item -mwarn-cell-microcode
20850 @opindex mwarn-cell-microcode
20851 Warn when a Cell microcode instruction is emitted.  An example
20852 of a Cell microcode instruction is a variable shift.
20854 @item -msecure-plt
20855 @opindex msecure-plt
20856 Generate code that allows @command{ld} and @command{ld.so}
20857 to build executables and shared
20858 libraries with non-executable @code{.plt} and @code{.got} sections.
20859 This is a PowerPC
20860 32-bit SYSV ABI option.
20862 @item -mbss-plt
20863 @opindex mbss-plt
20864 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
20865 fills in, and
20866 requires @code{.plt} and @code{.got}
20867 sections that are both writable and executable.
20868 This is a PowerPC 32-bit SYSV ABI option.
20870 @item -misel
20871 @itemx -mno-isel
20872 @opindex misel
20873 @opindex mno-isel
20874 This switch enables or disables the generation of ISEL instructions.
20876 @item -misel=@var{yes/no}
20877 This switch has been deprecated.  Use @option{-misel} and
20878 @option{-mno-isel} instead.
20880 @item -mlra
20881 @opindex mlra
20882 Enable Local Register Allocation.  This is still experimental for PowerPC,
20883 so by default the compiler uses standard reload
20884 (i.e. @option{-mno-lra}).
20886 @item -mspe
20887 @itemx -mno-spe
20888 @opindex mspe
20889 @opindex mno-spe
20890 This switch enables or disables the generation of SPE simd
20891 instructions.
20893 @item -mpaired
20894 @itemx -mno-paired
20895 @opindex mpaired
20896 @opindex mno-paired
20897 This switch enables or disables the generation of PAIRED simd
20898 instructions.
20900 @item -mspe=@var{yes/no}
20901 This option has been deprecated.  Use @option{-mspe} and
20902 @option{-mno-spe} instead.
20904 @item -mvsx
20905 @itemx -mno-vsx
20906 @opindex mvsx
20907 @opindex mno-vsx
20908 Generate code that uses (does not use) vector/scalar (VSX)
20909 instructions, and also enable the use of built-in functions that allow
20910 more direct access to the VSX instruction set.
20912 @item -mcrypto
20913 @itemx -mno-crypto
20914 @opindex mcrypto
20915 @opindex mno-crypto
20916 Enable the use (disable) of the built-in functions that allow direct
20917 access to the cryptographic instructions that were added in version
20918 2.07 of the PowerPC ISA.
20920 @item -mdirect-move
20921 @itemx -mno-direct-move
20922 @opindex mdirect-move
20923 @opindex mno-direct-move
20924 Generate code that uses (does not use) the instructions to move data
20925 between the general purpose registers and the vector/scalar (VSX)
20926 registers that were added in version 2.07 of the PowerPC ISA.
20928 @item -mhtm
20929 @itemx -mno-htm
20930 @opindex mhtm
20931 @opindex mno-htm
20932 Enable (disable) the use of the built-in functions that allow direct
20933 access to the Hardware Transactional Memory (HTM) instructions that
20934 were added in version 2.07 of the PowerPC ISA.
20936 @item -mpower8-fusion
20937 @itemx -mno-power8-fusion
20938 @opindex mpower8-fusion
20939 @opindex mno-power8-fusion
20940 Generate code that keeps (does not keeps) some integer operations
20941 adjacent so that the instructions can be fused together on power8 and
20942 later processors.
20944 @item -mpower8-vector
20945 @itemx -mno-power8-vector
20946 @opindex mpower8-vector
20947 @opindex mno-power8-vector
20948 Generate code that uses (does not use) the vector and scalar
20949 instructions that were added in version 2.07 of the PowerPC ISA.  Also
20950 enable the use of built-in functions that allow more direct access to
20951 the vector instructions.
20953 @item -mquad-memory
20954 @itemx -mno-quad-memory
20955 @opindex mquad-memory
20956 @opindex mno-quad-memory
20957 Generate code that uses (does not use) the non-atomic quad word memory
20958 instructions.  The @option{-mquad-memory} option requires use of
20959 64-bit mode.
20961 @item -mquad-memory-atomic
20962 @itemx -mno-quad-memory-atomic
20963 @opindex mquad-memory-atomic
20964 @opindex mno-quad-memory-atomic
20965 Generate code that uses (does not use) the atomic quad word memory
20966 instructions.  The @option{-mquad-memory-atomic} option requires use of
20967 64-bit mode.
20969 @item -mupper-regs-di
20970 @itemx -mno-upper-regs-di
20971 @opindex mupper-regs-di
20972 @opindex mno-upper-regs-di
20973 Generate code that uses (does not use) the scalar instructions that
20974 target all 64 registers in the vector/scalar floating point register
20975 set that were added in version 2.06 of the PowerPC ISA when processing
20976 integers.  @option{-mupper-regs-di} is turned on by default if you use
20977 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
20978 @option{-mcpu=power9}, or @option{-mvsx} options.
20980 @item -mupper-regs-df
20981 @itemx -mno-upper-regs-df
20982 @opindex mupper-regs-df
20983 @opindex mno-upper-regs-df
20984 Generate code that uses (does not use) the scalar double precision
20985 instructions that target all 64 registers in the vector/scalar
20986 floating point register set that were added in version 2.06 of the
20987 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
20988 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
20989 @option{-mcpu=power9}, or @option{-mvsx} options.
20991 @item -mupper-regs-sf
20992 @itemx -mno-upper-regs-sf
20993 @opindex mupper-regs-sf
20994 @opindex mno-upper-regs-sf
20995 Generate code that uses (does not use) the scalar single precision
20996 instructions that target all 64 registers in the vector/scalar
20997 floating point register set that were added in version 2.07 of the
20998 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
20999 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21000 @option{-mcpu=power9} options.
21002 @item -mupper-regs
21003 @itemx -mno-upper-regs
21004 @opindex mupper-regs
21005 @opindex mno-upper-regs
21006 Generate code that uses (does not use) the scalar
21007 instructions that target all 64 registers in the vector/scalar
21008 floating point register set, depending on the model of the machine.
21010 If the @option{-mno-upper-regs} option is used, it turns off both
21011 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21013 @item -mfloat128
21014 @itemx -mno-float128
21015 @opindex mfloat128
21016 @opindex mno-float128
21017 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21018 and use either software emulation for IEEE 128-bit floating point or
21019 hardware instructions.
21021 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21022 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21023 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21024 Linux systems.
21026 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21027 @option{-mfloat128} option will also enable the generation of ISA 3.0
21028 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21029 floating point will be done with software emulation.
21031 @item -mfloat128-hardware
21032 @itemx -mno-float128-hardware
21033 @opindex mfloat128-hardware
21034 @opindex mno-float128-hardware
21035 Enable/disable using ISA 3.0 hardware instructions to support the
21036 @var{__float128} data type.
21038 If you use @option{-mfloat128-hardware}, it will enable the option
21039 @option{-mfloat128} as well.
21041 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21042 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21043 the IEEE 128-bit floating point support will not be enabled.
21045 @item -mfloat-gprs=@var{yes/single/double/no}
21046 @itemx -mfloat-gprs
21047 @opindex mfloat-gprs
21048 This switch enables or disables the generation of floating-point
21049 operations on the general-purpose registers for architectures that
21050 support it.
21052 The argument @samp{yes} or @samp{single} enables the use of
21053 single-precision floating-point operations.
21055 The argument @samp{double} enables the use of single and
21056 double-precision floating-point operations.
21058 The argument @samp{no} disables floating-point operations on the
21059 general-purpose registers.
21061 This option is currently only available on the MPC854x.
21063 @item -m32
21064 @itemx -m64
21065 @opindex m32
21066 @opindex m64
21067 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21068 targets (including GNU/Linux).  The 32-bit environment sets int, long
21069 and pointer to 32 bits and generates code that runs on any PowerPC
21070 variant.  The 64-bit environment sets int to 32 bits and long and
21071 pointer to 64 bits, and generates code for PowerPC64, as for
21072 @option{-mpowerpc64}.
21074 @item -mfull-toc
21075 @itemx -mno-fp-in-toc
21076 @itemx -mno-sum-in-toc
21077 @itemx -mminimal-toc
21078 @opindex mfull-toc
21079 @opindex mno-fp-in-toc
21080 @opindex mno-sum-in-toc
21081 @opindex mminimal-toc
21082 Modify generation of the TOC (Table Of Contents), which is created for
21083 every executable file.  The @option{-mfull-toc} option is selected by
21084 default.  In that case, GCC allocates at least one TOC entry for
21085 each unique non-automatic variable reference in your program.  GCC
21086 also places floating-point constants in the TOC@.  However, only
21087 16,384 entries are available in the TOC@.
21089 If you receive a linker error message that saying you have overflowed
21090 the available TOC space, you can reduce the amount of TOC space used
21091 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21092 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21093 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21094 generate code to calculate the sum of an address and a constant at
21095 run time instead of putting that sum into the TOC@.  You may specify one
21096 or both of these options.  Each causes GCC to produce very slightly
21097 slower and larger code at the expense of conserving TOC space.
21099 If you still run out of space in the TOC even when you specify both of
21100 these options, specify @option{-mminimal-toc} instead.  This option causes
21101 GCC to make only one TOC entry for every file.  When you specify this
21102 option, GCC produces code that is slower and larger but which
21103 uses extremely little TOC space.  You may wish to use this option
21104 only on files that contain less frequently-executed code.
21106 @item -maix64
21107 @itemx -maix32
21108 @opindex maix64
21109 @opindex maix32
21110 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21111 @code{long} type, and the infrastructure needed to support them.
21112 Specifying @option{-maix64} implies @option{-mpowerpc64},
21113 while @option{-maix32} disables the 64-bit ABI and
21114 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21116 @item -mxl-compat
21117 @itemx -mno-xl-compat
21118 @opindex mxl-compat
21119 @opindex mno-xl-compat
21120 Produce code that conforms more closely to IBM XL compiler semantics
21121 when using AIX-compatible ABI@.  Pass floating-point arguments to
21122 prototyped functions beyond the register save area (RSA) on the stack
21123 in addition to argument FPRs.  Do not assume that most significant
21124 double in 128-bit long double value is properly rounded when comparing
21125 values and converting to double.  Use XL symbol names for long double
21126 support routines.
21128 The AIX calling convention was extended but not initially documented to
21129 handle an obscure K&R C case of calling a function that takes the
21130 address of its arguments with fewer arguments than declared.  IBM XL
21131 compilers access floating-point arguments that do not fit in the
21132 RSA from the stack when a subroutine is compiled without
21133 optimization.  Because always storing floating-point arguments on the
21134 stack is inefficient and rarely needed, this option is not enabled by
21135 default and only is necessary when calling subroutines compiled by IBM
21136 XL compilers without optimization.
21138 @item -mpe
21139 @opindex mpe
21140 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21141 application written to use message passing with special startup code to
21142 enable the application to run.  The system must have PE installed in the
21143 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21144 must be overridden with the @option{-specs=} option to specify the
21145 appropriate directory location.  The Parallel Environment does not
21146 support threads, so the @option{-mpe} option and the @option{-pthread}
21147 option are incompatible.
21149 @item -malign-natural
21150 @itemx -malign-power
21151 @opindex malign-natural
21152 @opindex malign-power
21153 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21154 @option{-malign-natural} overrides the ABI-defined alignment of larger
21155 types, such as floating-point doubles, on their natural size-based boundary.
21156 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21157 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21159 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21160 is not supported.
21162 @item -msoft-float
21163 @itemx -mhard-float
21164 @opindex msoft-float
21165 @opindex mhard-float
21166 Generate code that does not use (uses) the floating-point register set.
21167 Software floating-point emulation is provided if you use the
21168 @option{-msoft-float} option, and pass the option to GCC when linking.
21170 @item -msingle-float
21171 @itemx -mdouble-float
21172 @opindex msingle-float
21173 @opindex mdouble-float
21174 Generate code for single- or double-precision floating-point operations.
21175 @option{-mdouble-float} implies @option{-msingle-float}.
21177 @item -msimple-fpu
21178 @opindex msimple-fpu
21179 Do not generate @code{sqrt} and @code{div} instructions for hardware
21180 floating-point unit.
21182 @item -mfpu=@var{name}
21183 @opindex mfpu
21184 Specify type of floating-point unit.  Valid values for @var{name} are
21185 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21186 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21187 @samp{sp_full} (equivalent to @option{-msingle-float}),
21188 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21190 @item -mxilinx-fpu
21191 @opindex mxilinx-fpu
21192 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21194 @item -mmultiple
21195 @itemx -mno-multiple
21196 @opindex mmultiple
21197 @opindex mno-multiple
21198 Generate code that uses (does not use) the load multiple word
21199 instructions and the store multiple word instructions.  These
21200 instructions are generated by default on POWER systems, and not
21201 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21202 PowerPC systems, since those instructions do not work when the
21203 processor is in little-endian mode.  The exceptions are PPC740 and
21204 PPC750 which permit these instructions in little-endian mode.
21206 @item -mstring
21207 @itemx -mno-string
21208 @opindex mstring
21209 @opindex mno-string
21210 Generate code that uses (does not use) the load string instructions
21211 and the store string word instructions to save multiple registers and
21212 do small block moves.  These instructions are generated by default on
21213 POWER systems, and not generated on PowerPC systems.  Do not use
21214 @option{-mstring} on little-endian PowerPC systems, since those
21215 instructions do not work when the processor is in little-endian mode.
21216 The exceptions are PPC740 and PPC750 which permit these instructions
21217 in little-endian mode.
21219 @item -mupdate
21220 @itemx -mno-update
21221 @opindex mupdate
21222 @opindex mno-update
21223 Generate code that uses (does not use) the load or store instructions
21224 that update the base register to the address of the calculated memory
21225 location.  These instructions are generated by default.  If you use
21226 @option{-mno-update}, there is a small window between the time that the
21227 stack pointer is updated and the address of the previous frame is
21228 stored, which means code that walks the stack frame across interrupts or
21229 signals may get corrupted data.
21231 @item -mavoid-indexed-addresses
21232 @itemx -mno-avoid-indexed-addresses
21233 @opindex mavoid-indexed-addresses
21234 @opindex mno-avoid-indexed-addresses
21235 Generate code that tries to avoid (not avoid) the use of indexed load
21236 or store instructions. These instructions can incur a performance
21237 penalty on Power6 processors in certain situations, such as when
21238 stepping through large arrays that cross a 16M boundary.  This option
21239 is enabled by default when targeting Power6 and disabled otherwise.
21241 @item -mfused-madd
21242 @itemx -mno-fused-madd
21243 @opindex mfused-madd
21244 @opindex mno-fused-madd
21245 Generate code that uses (does not use) the floating-point multiply and
21246 accumulate instructions.  These instructions are generated by default
21247 if hardware floating point is used.  The machine-dependent
21248 @option{-mfused-madd} option is now mapped to the machine-independent
21249 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21250 mapped to @option{-ffp-contract=off}.
21252 @item -mmulhw
21253 @itemx -mno-mulhw
21254 @opindex mmulhw
21255 @opindex mno-mulhw
21256 Generate code that uses (does not use) the half-word multiply and
21257 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21258 These instructions are generated by default when targeting those
21259 processors.
21261 @item -mdlmzb
21262 @itemx -mno-dlmzb
21263 @opindex mdlmzb
21264 @opindex mno-dlmzb
21265 Generate code that uses (does not use) the string-search @samp{dlmzb}
21266 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21267 generated by default when targeting those processors.
21269 @item -mno-bit-align
21270 @itemx -mbit-align
21271 @opindex mno-bit-align
21272 @opindex mbit-align
21273 On System V.4 and embedded PowerPC systems do not (do) force structures
21274 and unions that contain bit-fields to be aligned to the base type of the
21275 bit-field.
21277 For example, by default a structure containing nothing but 8
21278 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21279 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21280 the structure is aligned to a 1-byte boundary and is 1 byte in
21281 size.
21283 @item -mno-strict-align
21284 @itemx -mstrict-align
21285 @opindex mno-strict-align
21286 @opindex mstrict-align
21287 On System V.4 and embedded PowerPC systems do not (do) assume that
21288 unaligned memory references are handled by the system.
21290 @item -mrelocatable
21291 @itemx -mno-relocatable
21292 @opindex mrelocatable
21293 @opindex mno-relocatable
21294 Generate code that allows (does not allow) a static executable to be
21295 relocated to a different address at run time.  A simple embedded
21296 PowerPC system loader should relocate the entire contents of
21297 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21298 a table of 32-bit addresses generated by this option.  For this to
21299 work, all objects linked together must be compiled with
21300 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21301 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21303 @item -mrelocatable-lib
21304 @itemx -mno-relocatable-lib
21305 @opindex mrelocatable-lib
21306 @opindex mno-relocatable-lib
21307 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21308 @code{.fixup} section to allow static executables to be relocated at
21309 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21310 alignment of @option{-mrelocatable}.  Objects compiled with
21311 @option{-mrelocatable-lib} may be linked with objects compiled with
21312 any combination of the @option{-mrelocatable} options.
21314 @item -mno-toc
21315 @itemx -mtoc
21316 @opindex mno-toc
21317 @opindex mtoc
21318 On System V.4 and embedded PowerPC systems do not (do) assume that
21319 register 2 contains a pointer to a global area pointing to the addresses
21320 used in the program.
21322 @item -mlittle
21323 @itemx -mlittle-endian
21324 @opindex mlittle
21325 @opindex mlittle-endian
21326 On System V.4 and embedded PowerPC systems compile code for the
21327 processor in little-endian mode.  The @option{-mlittle-endian} option is
21328 the same as @option{-mlittle}.
21330 @item -mbig
21331 @itemx -mbig-endian
21332 @opindex mbig
21333 @opindex mbig-endian
21334 On System V.4 and embedded PowerPC systems compile code for the
21335 processor in big-endian mode.  The @option{-mbig-endian} option is
21336 the same as @option{-mbig}.
21338 @item -mdynamic-no-pic
21339 @opindex mdynamic-no-pic
21340 On Darwin and Mac OS X systems, compile code so that it is not
21341 relocatable, but that its external references are relocatable.  The
21342 resulting code is suitable for applications, but not shared
21343 libraries.
21345 @item -msingle-pic-base
21346 @opindex msingle-pic-base
21347 Treat the register used for PIC addressing as read-only, rather than
21348 loading it in the prologue for each function.  The runtime system is
21349 responsible for initializing this register with an appropriate value
21350 before execution begins.
21352 @item -mprioritize-restricted-insns=@var{priority}
21353 @opindex mprioritize-restricted-insns
21354 This option controls the priority that is assigned to
21355 dispatch-slot restricted instructions during the second scheduling
21356 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21357 or @samp{2} to assign no, highest, or second-highest (respectively) 
21358 priority to dispatch-slot restricted
21359 instructions.
21361 @item -msched-costly-dep=@var{dependence_type}
21362 @opindex msched-costly-dep
21363 This option controls which dependences are considered costly
21364 by the target during instruction scheduling.  The argument
21365 @var{dependence_type} takes one of the following values:
21367 @table @asis
21368 @item @samp{no}
21369 No dependence is costly.
21371 @item @samp{all}
21372 All dependences are costly.
21374 @item @samp{true_store_to_load}
21375 A true dependence from store to load is costly.
21377 @item @samp{store_to_load}
21378 Any dependence from store to load is costly.
21380 @item @var{number}
21381 Any dependence for which the latency is greater than or equal to 
21382 @var{number} is costly.
21383 @end table
21385 @item -minsert-sched-nops=@var{scheme}
21386 @opindex minsert-sched-nops
21387 This option controls which NOP insertion scheme is used during
21388 the second scheduling pass.  The argument @var{scheme} takes one of the
21389 following values:
21391 @table @asis
21392 @item @samp{no}
21393 Don't insert NOPs.
21395 @item @samp{pad}
21396 Pad with NOPs any dispatch group that has vacant issue slots,
21397 according to the scheduler's grouping.
21399 @item @samp{regroup_exact}
21400 Insert NOPs to force costly dependent insns into
21401 separate groups.  Insert exactly as many NOPs as needed to force an insn
21402 to a new group, according to the estimated processor grouping.
21404 @item @var{number}
21405 Insert NOPs to force costly dependent insns into
21406 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21407 @end table
21409 @item -mcall-sysv
21410 @opindex mcall-sysv
21411 On System V.4 and embedded PowerPC systems compile code using calling
21412 conventions that adhere to the March 1995 draft of the System V
21413 Application Binary Interface, PowerPC processor supplement.  This is the
21414 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21416 @item -mcall-sysv-eabi
21417 @itemx -mcall-eabi
21418 @opindex mcall-sysv-eabi
21419 @opindex mcall-eabi
21420 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21422 @item -mcall-sysv-noeabi
21423 @opindex mcall-sysv-noeabi
21424 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21426 @item -mcall-aixdesc
21427 @opindex m
21428 On System V.4 and embedded PowerPC systems compile code for the AIX
21429 operating system.
21431 @item -mcall-linux
21432 @opindex mcall-linux
21433 On System V.4 and embedded PowerPC systems compile code for the
21434 Linux-based GNU system.
21436 @item -mcall-freebsd
21437 @opindex mcall-freebsd
21438 On System V.4 and embedded PowerPC systems compile code for the
21439 FreeBSD operating system.
21441 @item -mcall-netbsd
21442 @opindex mcall-netbsd
21443 On System V.4 and embedded PowerPC systems compile code for the
21444 NetBSD operating system.
21446 @item -mcall-openbsd
21447 @opindex mcall-netbsd
21448 On System V.4 and embedded PowerPC systems compile code for the
21449 OpenBSD operating system.
21451 @item -maix-struct-return
21452 @opindex maix-struct-return
21453 Return all structures in memory (as specified by the AIX ABI)@.
21455 @item -msvr4-struct-return
21456 @opindex msvr4-struct-return
21457 Return structures smaller than 8 bytes in registers (as specified by the
21458 SVR4 ABI)@.
21460 @item -mabi=@var{abi-type}
21461 @opindex mabi
21462 Extend the current ABI with a particular extension, or remove such extension.
21463 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21464 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21465 @samp{elfv1}, @samp{elfv2}@.
21467 @item -mabi=spe
21468 @opindex mabi=spe
21469 Extend the current ABI with SPE ABI extensions.  This does not change
21470 the default ABI, instead it adds the SPE ABI extensions to the current
21471 ABI@.
21473 @item -mabi=no-spe
21474 @opindex mabi=no-spe
21475 Disable Book-E SPE ABI extensions for the current ABI@.
21477 @item -mabi=ibmlongdouble
21478 @opindex mabi=ibmlongdouble
21479 Change the current ABI to use IBM extended-precision long double.
21480 This is a PowerPC 32-bit SYSV ABI option.
21482 @item -mabi=ieeelongdouble
21483 @opindex mabi=ieeelongdouble
21484 Change the current ABI to use IEEE extended-precision long double.
21485 This is a PowerPC 32-bit Linux ABI option.
21487 @item -mabi=elfv1
21488 @opindex mabi=elfv1
21489 Change the current ABI to use the ELFv1 ABI.
21490 This is the default ABI for big-endian PowerPC 64-bit Linux.
21491 Overriding the default ABI requires special system support and is
21492 likely to fail in spectacular ways.
21494 @item -mabi=elfv2
21495 @opindex mabi=elfv2
21496 Change the current ABI to use the ELFv2 ABI.
21497 This is the default ABI for little-endian PowerPC 64-bit Linux.
21498 Overriding the default ABI requires special system support and is
21499 likely to fail in spectacular ways.
21501 @item -mgnu-attribute
21502 @itemx -mno-gnu-attribute
21503 @opindex mgnu-attribute
21504 @opindex mno-gnu-attribute
21505 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21506 .gnu.attributes section that specify ABI variations in function
21507 parameters or return values.
21509 @item -mprototype
21510 @itemx -mno-prototype
21511 @opindex mprototype
21512 @opindex mno-prototype
21513 On System V.4 and embedded PowerPC systems assume that all calls to
21514 variable argument functions are properly prototyped.  Otherwise, the
21515 compiler must insert an instruction before every non-prototyped call to
21516 set or clear bit 6 of the condition code register (@code{CR}) to
21517 indicate whether floating-point values are passed in the floating-point
21518 registers in case the function takes variable arguments.  With
21519 @option{-mprototype}, only calls to prototyped variable argument functions
21520 set or clear the bit.
21522 @item -msim
21523 @opindex msim
21524 On embedded PowerPC systems, assume that the startup module is called
21525 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21526 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21527 configurations.
21529 @item -mmvme
21530 @opindex mmvme
21531 On embedded PowerPC systems, assume that the startup module is called
21532 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21533 @file{libc.a}.
21535 @item -mads
21536 @opindex mads
21537 On embedded PowerPC systems, assume that the startup module is called
21538 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21539 @file{libc.a}.
21541 @item -myellowknife
21542 @opindex myellowknife
21543 On embedded PowerPC systems, assume that the startup module is called
21544 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21545 @file{libc.a}.
21547 @item -mvxworks
21548 @opindex mvxworks
21549 On System V.4 and embedded PowerPC systems, specify that you are
21550 compiling for a VxWorks system.
21552 @item -memb
21553 @opindex memb
21554 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21555 header to indicate that @samp{eabi} extended relocations are used.
21557 @item -meabi
21558 @itemx -mno-eabi
21559 @opindex meabi
21560 @opindex mno-eabi
21561 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21562 Embedded Applications Binary Interface (EABI), which is a set of
21563 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21564 means that the stack is aligned to an 8-byte boundary, a function
21565 @code{__eabi} is called from @code{main} to set up the EABI
21566 environment, and the @option{-msdata} option can use both @code{r2} and
21567 @code{r13} to point to two separate small data areas.  Selecting
21568 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21569 no EABI initialization function is called from @code{main}, and the
21570 @option{-msdata} option only uses @code{r13} to point to a single
21571 small data area.  The @option{-meabi} option is on by default if you
21572 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
21574 @item -msdata=eabi
21575 @opindex msdata=eabi
21576 On System V.4 and embedded PowerPC systems, put small initialized
21577 @code{const} global and static data in the @code{.sdata2} section, which
21578 is pointed to by register @code{r2}.  Put small initialized
21579 non-@code{const} global and static data in the @code{.sdata} section,
21580 which is pointed to by register @code{r13}.  Put small uninitialized
21581 global and static data in the @code{.sbss} section, which is adjacent to
21582 the @code{.sdata} section.  The @option{-msdata=eabi} option is
21583 incompatible with the @option{-mrelocatable} option.  The
21584 @option{-msdata=eabi} option also sets the @option{-memb} option.
21586 @item -msdata=sysv
21587 @opindex msdata=sysv
21588 On System V.4 and embedded PowerPC systems, put small global and static
21589 data in the @code{.sdata} section, which is pointed to by register
21590 @code{r13}.  Put small uninitialized global and static data in the
21591 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
21592 The @option{-msdata=sysv} option is incompatible with the
21593 @option{-mrelocatable} option.
21595 @item -msdata=default
21596 @itemx -msdata
21597 @opindex msdata=default
21598 @opindex msdata
21599 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
21600 compile code the same as @option{-msdata=eabi}, otherwise compile code the
21601 same as @option{-msdata=sysv}.
21603 @item -msdata=data
21604 @opindex msdata=data
21605 On System V.4 and embedded PowerPC systems, put small global
21606 data in the @code{.sdata} section.  Put small uninitialized global
21607 data in the @code{.sbss} section.  Do not use register @code{r13}
21608 to address small data however.  This is the default behavior unless
21609 other @option{-msdata} options are used.
21611 @item -msdata=none
21612 @itemx -mno-sdata
21613 @opindex msdata=none
21614 @opindex mno-sdata
21615 On embedded PowerPC systems, put all initialized global and static data
21616 in the @code{.data} section, and all uninitialized data in the
21617 @code{.bss} section.
21619 @item -mblock-move-inline-limit=@var{num}
21620 @opindex mblock-move-inline-limit
21621 Inline all block moves (such as calls to @code{memcpy} or structure
21622 copies) less than or equal to @var{num} bytes.  The minimum value for
21623 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
21624 targets.  The default value is target-specific.
21626 @item -G @var{num}
21627 @opindex G
21628 @cindex smaller data references (PowerPC)
21629 @cindex .sdata/.sdata2 references (PowerPC)
21630 On embedded PowerPC systems, put global and static items less than or
21631 equal to @var{num} bytes into the small data or BSS sections instead of
21632 the normal data or BSS section.  By default, @var{num} is 8.  The
21633 @option{-G @var{num}} switch is also passed to the linker.
21634 All modules should be compiled with the same @option{-G @var{num}} value.
21636 @item -mregnames
21637 @itemx -mno-regnames
21638 @opindex mregnames
21639 @opindex mno-regnames
21640 On System V.4 and embedded PowerPC systems do (do not) emit register
21641 names in the assembly language output using symbolic forms.
21643 @item -mlongcall
21644 @itemx -mno-longcall
21645 @opindex mlongcall
21646 @opindex mno-longcall
21647 By default assume that all calls are far away so that a longer and more
21648 expensive calling sequence is required.  This is required for calls
21649 farther than 32 megabytes (33,554,432 bytes) from the current location.
21650 A short call is generated if the compiler knows
21651 the call cannot be that far away.  This setting can be overridden by
21652 the @code{shortcall} function attribute, or by @code{#pragma
21653 longcall(0)}.
21655 Some linkers are capable of detecting out-of-range calls and generating
21656 glue code on the fly.  On these systems, long calls are unnecessary and
21657 generate slower code.  As of this writing, the AIX linker can do this,
21658 as can the GNU linker for PowerPC/64.  It is planned to add this feature
21659 to the GNU linker for 32-bit PowerPC systems as well.
21661 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
21662 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
21663 addresses represent the callee and the branch island.  The
21664 Darwin/PPC linker prefers the first address and generates a @code{bl
21665 callee} if the PPC @code{bl} instruction reaches the callee directly;
21666 otherwise, the linker generates @code{bl L42} to call the branch
21667 island.  The branch island is appended to the body of the
21668 calling function; it computes the full 32-bit address of the callee
21669 and jumps to it.
21671 On Mach-O (Darwin) systems, this option directs the compiler emit to
21672 the glue for every direct call, and the Darwin linker decides whether
21673 to use or discard it.
21675 In the future, GCC may ignore all longcall specifications
21676 when the linker is known to generate glue.
21678 @item -mtls-markers
21679 @itemx -mno-tls-markers
21680 @opindex mtls-markers
21681 @opindex mno-tls-markers
21682 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
21683 specifying the function argument.  The relocation allows the linker to
21684 reliably associate function call with argument setup instructions for
21685 TLS optimization, which in turn allows GCC to better schedule the
21686 sequence.
21688 @item -pthread
21689 @opindex pthread
21690 Adds support for multithreading with the @dfn{pthreads} library.
21691 This option sets flags for both the preprocessor and linker.
21693 @item -mrecip
21694 @itemx -mno-recip
21695 @opindex mrecip
21696 This option enables use of the reciprocal estimate and
21697 reciprocal square root estimate instructions with additional
21698 Newton-Raphson steps to increase precision instead of doing a divide or
21699 square root and divide for floating-point arguments.  You should use
21700 the @option{-ffast-math} option when using @option{-mrecip} (or at
21701 least @option{-funsafe-math-optimizations},
21702 @option{-ffinite-math-only}, @option{-freciprocal-math} and
21703 @option{-fno-trapping-math}).  Note that while the throughput of the
21704 sequence is generally higher than the throughput of the non-reciprocal
21705 instruction, the precision of the sequence can be decreased by up to 2
21706 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
21707 roots.
21709 @item -mrecip=@var{opt}
21710 @opindex mrecip=opt
21711 This option controls which reciprocal estimate instructions
21712 may be used.  @var{opt} is a comma-separated list of options, which may
21713 be preceded by a @code{!} to invert the option:
21715 @table @samp
21717 @item all
21718 Enable all estimate instructions.
21720 @item default 
21721 Enable the default instructions, equivalent to @option{-mrecip}.
21723 @item none 
21724 Disable all estimate instructions, equivalent to @option{-mno-recip}.
21726 @item div 
21727 Enable the reciprocal approximation instructions for both 
21728 single and double precision.
21730 @item divf 
21731 Enable the single-precision reciprocal approximation instructions.
21733 @item divd 
21734 Enable the double-precision reciprocal approximation instructions.
21736 @item rsqrt 
21737 Enable the reciprocal square root approximation instructions for both
21738 single and double precision.
21740 @item rsqrtf 
21741 Enable the single-precision reciprocal square root approximation instructions.
21743 @item rsqrtd 
21744 Enable the double-precision reciprocal square root approximation instructions.
21746 @end table
21748 So, for example, @option{-mrecip=all,!rsqrtd} enables
21749 all of the reciprocal estimate instructions, except for the
21750 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
21751 which handle the double-precision reciprocal square root calculations.
21753 @item -mrecip-precision
21754 @itemx -mno-recip-precision
21755 @opindex mrecip-precision
21756 Assume (do not assume) that the reciprocal estimate instructions
21757 provide higher-precision estimates than is mandated by the PowerPC
21758 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
21759 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
21760 The double-precision square root estimate instructions are not generated by
21761 default on low-precision machines, since they do not provide an
21762 estimate that converges after three steps.
21764 @item -mveclibabi=@var{type}
21765 @opindex mveclibabi
21766 Specifies the ABI type to use for vectorizing intrinsics using an
21767 external library.  The only type supported at present is @samp{mass},
21768 which specifies to use IBM's Mathematical Acceleration Subsystem
21769 (MASS) libraries for vectorizing intrinsics using external libraries.
21770 GCC currently emits calls to @code{acosd2}, @code{acosf4},
21771 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
21772 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
21773 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
21774 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
21775 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
21776 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
21777 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
21778 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
21779 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
21780 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
21781 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
21782 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
21783 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
21784 for power7.  Both @option{-ftree-vectorize} and
21785 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
21786 libraries must be specified at link time.
21788 @item -mfriz
21789 @itemx -mno-friz
21790 @opindex mfriz
21791 Generate (do not generate) the @code{friz} instruction when the
21792 @option{-funsafe-math-optimizations} option is used to optimize
21793 rounding of floating-point values to 64-bit integer and back to floating
21794 point.  The @code{friz} instruction does not return the same value if
21795 the floating-point number is too large to fit in an integer.
21797 @item -mpointers-to-nested-functions
21798 @itemx -mno-pointers-to-nested-functions
21799 @opindex mpointers-to-nested-functions
21800 Generate (do not generate) code to load up the static chain register
21801 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
21802 systems where a function pointer points to a 3-word descriptor giving
21803 the function address, TOC value to be loaded in register @code{r2}, and
21804 static chain value to be loaded in register @code{r11}.  The
21805 @option{-mpointers-to-nested-functions} is on by default.  You cannot
21806 call through pointers to nested functions or pointers
21807 to functions compiled in other languages that use the static chain if
21808 you use @option{-mno-pointers-to-nested-functions}.
21810 @item -msave-toc-indirect
21811 @itemx -mno-save-toc-indirect
21812 @opindex msave-toc-indirect
21813 Generate (do not generate) code to save the TOC value in the reserved
21814 stack location in the function prologue if the function calls through
21815 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
21816 saved in the prologue, it is saved just before the call through the
21817 pointer.  The @option{-mno-save-toc-indirect} option is the default.
21819 @item -mcompat-align-parm
21820 @itemx -mno-compat-align-parm
21821 @opindex mcompat-align-parm
21822 Generate (do not generate) code to pass structure parameters with a
21823 maximum alignment of 64 bits, for compatibility with older versions
21824 of GCC.
21826 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
21827 structure parameter on a 128-bit boundary when that structure contained
21828 a member requiring 128-bit alignment.  This is corrected in more
21829 recent versions of GCC.  This option may be used to generate code
21830 that is compatible with functions compiled with older versions of
21831 GCC.
21833 The @option{-mno-compat-align-parm} option is the default.
21834 @end table
21836 @node RX Options
21837 @subsection RX Options
21838 @cindex RX Options
21840 These command-line options are defined for RX targets:
21842 @table @gcctabopt
21843 @item -m64bit-doubles
21844 @itemx -m32bit-doubles
21845 @opindex m64bit-doubles
21846 @opindex m32bit-doubles
21847 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21848 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21849 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
21850 works on 32-bit values, which is why the default is
21851 @option{-m32bit-doubles}.
21853 @item -fpu
21854 @itemx -nofpu
21855 @opindex fpu
21856 @opindex nofpu
21857 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
21858 floating-point hardware.  The default is enabled for the RX600
21859 series and disabled for the RX200 series.
21861 Floating-point instructions are only generated for 32-bit floating-point 
21862 values, however, so the FPU hardware is not used for doubles if the
21863 @option{-m64bit-doubles} option is used.
21865 @emph{Note} If the @option{-fpu} option is enabled then
21866 @option{-funsafe-math-optimizations} is also enabled automatically.
21867 This is because the RX FPU instructions are themselves unsafe.
21869 @item -mcpu=@var{name}
21870 @opindex mcpu
21871 Selects the type of RX CPU to be targeted.  Currently three types are
21872 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
21873 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
21875 The only difference between @samp{RX600} and @samp{RX610} is that the
21876 @samp{RX610} does not support the @code{MVTIPL} instruction.
21878 The @samp{RX200} series does not have a hardware floating-point unit
21879 and so @option{-nofpu} is enabled by default when this type is
21880 selected.
21882 @item -mbig-endian-data
21883 @itemx -mlittle-endian-data
21884 @opindex mbig-endian-data
21885 @opindex mlittle-endian-data
21886 Store data (but not code) in the big-endian format.  The default is
21887 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
21888 format.
21890 @item -msmall-data-limit=@var{N}
21891 @opindex msmall-data-limit
21892 Specifies the maximum size in bytes of global and static variables
21893 which can be placed into the small data area.  Using the small data
21894 area can lead to smaller and faster code, but the size of area is
21895 limited and it is up to the programmer to ensure that the area does
21896 not overflow.  Also when the small data area is used one of the RX's
21897 registers (usually @code{r13}) is reserved for use pointing to this
21898 area, so it is no longer available for use by the compiler.  This
21899 could result in slower and/or larger code if variables are pushed onto
21900 the stack instead of being held in this register.
21902 Note, common variables (variables that have not been initialized) and
21903 constants are not placed into the small data area as they are assigned
21904 to other sections in the output executable.
21906 The default value is zero, which disables this feature.  Note, this
21907 feature is not enabled by default with higher optimization levels
21908 (@option{-O2} etc) because of the potentially detrimental effects of
21909 reserving a register.  It is up to the programmer to experiment and
21910 discover whether this feature is of benefit to their program.  See the
21911 description of the @option{-mpid} option for a description of how the
21912 actual register to hold the small data area pointer is chosen.
21914 @item -msim
21915 @itemx -mno-sim
21916 @opindex msim
21917 @opindex mno-sim
21918 Use the simulator runtime.  The default is to use the libgloss
21919 board-specific runtime.
21921 @item -mas100-syntax
21922 @itemx -mno-as100-syntax
21923 @opindex mas100-syntax
21924 @opindex mno-as100-syntax
21925 When generating assembler output use a syntax that is compatible with
21926 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
21927 assembler, but it has some restrictions so it is not generated by default.
21929 @item -mmax-constant-size=@var{N}
21930 @opindex mmax-constant-size
21931 Specifies the maximum size, in bytes, of a constant that can be used as
21932 an operand in a RX instruction.  Although the RX instruction set does
21933 allow constants of up to 4 bytes in length to be used in instructions,
21934 a longer value equates to a longer instruction.  Thus in some
21935 circumstances it can be beneficial to restrict the size of constants
21936 that are used in instructions.  Constants that are too big are instead
21937 placed into a constant pool and referenced via register indirection.
21939 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
21940 or 4 means that constants of any size are allowed.
21942 @item -mrelax
21943 @opindex mrelax
21944 Enable linker relaxation.  Linker relaxation is a process whereby the
21945 linker attempts to reduce the size of a program by finding shorter
21946 versions of various instructions.  Disabled by default.
21948 @item -mint-register=@var{N}
21949 @opindex mint-register
21950 Specify the number of registers to reserve for fast interrupt handler
21951 functions.  The value @var{N} can be between 0 and 4.  A value of 1
21952 means that register @code{r13} is reserved for the exclusive use
21953 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
21954 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
21955 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
21956 A value of 0, the default, does not reserve any registers.
21958 @item -msave-acc-in-interrupts
21959 @opindex msave-acc-in-interrupts
21960 Specifies that interrupt handler functions should preserve the
21961 accumulator register.  This is only necessary if normal code might use
21962 the accumulator register, for example because it performs 64-bit
21963 multiplications.  The default is to ignore the accumulator as this
21964 makes the interrupt handlers faster.
21966 @item -mpid
21967 @itemx -mno-pid
21968 @opindex mpid
21969 @opindex mno-pid
21970 Enables the generation of position independent data.  When enabled any
21971 access to constant data is done via an offset from a base address
21972 held in a register.  This allows the location of constant data to be
21973 determined at run time without requiring the executable to be
21974 relocated, which is a benefit to embedded applications with tight
21975 memory constraints.  Data that can be modified is not affected by this
21976 option.
21978 Note, using this feature reserves a register, usually @code{r13}, for
21979 the constant data base address.  This can result in slower and/or
21980 larger code, especially in complicated functions.
21982 The actual register chosen to hold the constant data base address
21983 depends upon whether the @option{-msmall-data-limit} and/or the
21984 @option{-mint-register} command-line options are enabled.  Starting
21985 with register @code{r13} and proceeding downwards, registers are
21986 allocated first to satisfy the requirements of @option{-mint-register},
21987 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
21988 is possible for the small data area register to be @code{r8} if both
21989 @option{-mint-register=4} and @option{-mpid} are specified on the
21990 command line.
21992 By default this feature is not enabled.  The default can be restored
21993 via the @option{-mno-pid} command-line option.
21995 @item -mno-warn-multiple-fast-interrupts
21996 @itemx -mwarn-multiple-fast-interrupts
21997 @opindex mno-warn-multiple-fast-interrupts
21998 @opindex mwarn-multiple-fast-interrupts
21999 Prevents GCC from issuing a warning message if it finds more than one
22000 fast interrupt handler when it is compiling a file.  The default is to
22001 issue a warning for each extra fast interrupt handler found, as the RX
22002 only supports one such interrupt.
22004 @item -mallow-string-insns
22005 @itemx -mno-allow-string-insns
22006 @opindex mallow-string-insns
22007 @opindex mno-allow-string-insns
22008 Enables or disables the use of the string manipulation instructions
22009 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22010 @code{SWHILE} and also the @code{RMPA} instruction.  These
22011 instructions may prefetch data, which is not safe to do if accessing
22012 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22013 for more information).
22015 The default is to allow these instructions, but it is not possible for
22016 GCC to reliably detect all circumstances where a string instruction
22017 might be used to access an I/O register, so their use cannot be
22018 disabled automatically.  Instead it is reliant upon the programmer to
22019 use the @option{-mno-allow-string-insns} option if their program
22020 accesses I/O space.
22022 When the instructions are enabled GCC defines the C preprocessor
22023 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22024 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22026 @item -mjsr
22027 @itemx -mno-jsr
22028 @opindex mjsr
22029 @opindex mno-jsr
22030 Use only (or not only) @code{JSR} instructions to access functions.
22031 This option can be used when code size exceeds the range of @code{BSR}
22032 instructions.  Note that @option{-mno-jsr} does not mean to not use
22033 @code{JSR} but instead means that any type of branch may be used.
22034 @end table
22036 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22037 has special significance to the RX port when used with the
22038 @code{interrupt} function attribute.  This attribute indicates a
22039 function intended to process fast interrupts.  GCC ensures
22040 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22041 and/or @code{r13} and only provided that the normal use of the
22042 corresponding registers have been restricted via the
22043 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22044 options.
22046 @node S/390 and zSeries Options
22047 @subsection S/390 and zSeries Options
22048 @cindex S/390 and zSeries Options
22050 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22052 @table @gcctabopt
22053 @item -mhard-float
22054 @itemx -msoft-float
22055 @opindex mhard-float
22056 @opindex msoft-float
22057 Use (do not use) the hardware floating-point instructions and registers
22058 for floating-point operations.  When @option{-msoft-float} is specified,
22059 functions in @file{libgcc.a} are used to perform floating-point
22060 operations.  When @option{-mhard-float} is specified, the compiler
22061 generates IEEE floating-point instructions.  This is the default.
22063 @item -mhard-dfp
22064 @itemx -mno-hard-dfp
22065 @opindex mhard-dfp
22066 @opindex mno-hard-dfp
22067 Use (do not use) the hardware decimal-floating-point instructions for
22068 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22069 specified, functions in @file{libgcc.a} are used to perform
22070 decimal-floating-point operations.  When @option{-mhard-dfp} is
22071 specified, the compiler generates decimal-floating-point hardware
22072 instructions.  This is the default for @option{-march=z9-ec} or higher.
22074 @item -mlong-double-64
22075 @itemx -mlong-double-128
22076 @opindex mlong-double-64
22077 @opindex mlong-double-128
22078 These switches control the size of @code{long double} type. A size
22079 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22080 type. This is the default.
22082 @item -mbackchain
22083 @itemx -mno-backchain
22084 @opindex mbackchain
22085 @opindex mno-backchain
22086 Store (do not store) the address of the caller's frame as backchain pointer
22087 into the callee's stack frame.
22088 A backchain may be needed to allow debugging using tools that do not understand
22089 DWARF call frame information.
22090 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22091 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22092 the backchain is placed into the topmost word of the 96/160 byte register
22093 save area.
22095 In general, code compiled with @option{-mbackchain} is call-compatible with
22096 code compiled with @option{-mmo-backchain}; however, use of the backchain
22097 for debugging purposes usually requires that the whole binary is built with
22098 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22099 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22100 to build a linux kernel use @option{-msoft-float}.
22102 The default is to not maintain the backchain.
22104 @item -mpacked-stack
22105 @itemx -mno-packed-stack
22106 @opindex mpacked-stack
22107 @opindex mno-packed-stack
22108 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22109 specified, the compiler uses the all fields of the 96/160 byte register save
22110 area only for their default purpose; unused fields still take up stack space.
22111 When @option{-mpacked-stack} is specified, register save slots are densely
22112 packed at the top of the register save area; unused space is reused for other
22113 purposes, allowing for more efficient use of the available stack space.
22114 However, when @option{-mbackchain} is also in effect, the topmost word of
22115 the save area is always used to store the backchain, and the return address
22116 register is always saved two words below the backchain.
22118 As long as the stack frame backchain is not used, code generated with
22119 @option{-mpacked-stack} is call-compatible with code generated with
22120 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22121 S/390 or zSeries generated code that uses the stack frame backchain at run
22122 time, not just for debugging purposes.  Such code is not call-compatible
22123 with code compiled with @option{-mpacked-stack}.  Also, note that the
22124 combination of @option{-mbackchain},
22125 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22126 to build a linux kernel use @option{-msoft-float}.
22128 The default is to not use the packed stack layout.
22130 @item -msmall-exec
22131 @itemx -mno-small-exec
22132 @opindex msmall-exec
22133 @opindex mno-small-exec
22134 Generate (or do not generate) code using the @code{bras} instruction
22135 to do subroutine calls.
22136 This only works reliably if the total executable size does not
22137 exceed 64k.  The default is to use the @code{basr} instruction instead,
22138 which does not have this limitation.
22140 @item -m64
22141 @itemx -m31
22142 @opindex m64
22143 @opindex m31
22144 When @option{-m31} is specified, generate code compliant to the
22145 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22146 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22147 particular to generate 64-bit instructions.  For the @samp{s390}
22148 targets, the default is @option{-m31}, while the @samp{s390x}
22149 targets default to @option{-m64}.
22151 @item -mzarch
22152 @itemx -mesa
22153 @opindex mzarch
22154 @opindex mesa
22155 When @option{-mzarch} is specified, generate code using the
22156 instructions available on z/Architecture.
22157 When @option{-mesa} is specified, generate code using the
22158 instructions available on ESA/390.  Note that @option{-mesa} is
22159 not possible with @option{-m64}.
22160 When generating code compliant to the GNU/Linux for S/390 ABI,
22161 the default is @option{-mesa}.  When generating code compliant
22162 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22164 @item -mhtm
22165 @itemx -mno-htm
22166 @opindex mhtm
22167 @opindex mno-htm
22168 The @option{-mhtm} option enables a set of builtins making use of
22169 instructions available with the transactional execution facility
22170 introduced with the IBM zEnterprise EC12 machine generation
22171 @ref{S/390 System z Built-in Functions}.
22172 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22174 @item -mvx
22175 @itemx -mno-vx
22176 @opindex mvx
22177 @opindex mno-vx
22178 When @option{-mvx} is specified, generate code using the instructions
22179 available with the vector extension facility introduced with the IBM
22180 z13 machine generation.
22181 This option changes the ABI for some vector type values with regard to
22182 alignment and calling conventions.  In case vector type values are
22183 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22184 command will be added to mark the resulting binary with the ABI used.
22185 @option{-mvx} is enabled by default when using @option{-march=z13}.
22187 @item -mzvector
22188 @itemx -mno-zvector
22189 @opindex mzvector
22190 @opindex mno-zvector
22191 The @option{-mzvector} option enables vector language extensions and
22192 builtins using instructions available with the vector extension
22193 facility introduced with the IBM z13 machine generation.
22194 This option adds support for @samp{vector} to be used as a keyword to
22195 define vector type variables and arguments.  @samp{vector} is only
22196 available when GNU extensions are enabled.  It will not be expanded
22197 when requesting strict standard compliance e.g. with @option{-std=c99}.
22198 In addition to the GCC low-level builtins @option{-mzvector} enables
22199 a set of builtins added for compatibility with AltiVec-style
22200 implementations like Power and Cell.  In order to make use of these
22201 builtins the header file @file{vecintrin.h} needs to be included.
22202 @option{-mzvector} is disabled by default.
22204 @item -mmvcle
22205 @itemx -mno-mvcle
22206 @opindex mmvcle
22207 @opindex mno-mvcle
22208 Generate (or do not generate) code using the @code{mvcle} instruction
22209 to perform block moves.  When @option{-mno-mvcle} is specified,
22210 use a @code{mvc} loop instead.  This is the default unless optimizing for
22211 size.
22213 @item -mdebug
22214 @itemx -mno-debug
22215 @opindex mdebug
22216 @opindex mno-debug
22217 Print (or do not print) additional debug information when compiling.
22218 The default is to not print debug information.
22220 @item -march=@var{cpu-type}
22221 @opindex march
22222 Generate code that runs on @var{cpu-type}, which is the name of a
22223 system representing a certain processor type.  Possible values for
22224 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22225 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22226 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22227 @samp{native}.
22229 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22230 @samp{g6} are deprecated and will be removed with future releases.
22232 Specifying @samp{native} as cpu type can be used to select the best
22233 architecture option for the host processor.
22234 @option{-march=native} has no effect if GCC does not recognize the
22235 processor.
22237 @item -mtune=@var{cpu-type}
22238 @opindex mtune
22239 Tune to @var{cpu-type} everything applicable about the generated code,
22240 except for the ABI and the set of available instructions.
22241 The list of @var{cpu-type} values is the same as for @option{-march}.
22242 The default is the value used for @option{-march}.
22244 @item -mtpf-trace
22245 @itemx -mno-tpf-trace
22246 @opindex mtpf-trace
22247 @opindex mno-tpf-trace
22248 Generate code that adds (does not add) in TPF OS specific branches to trace
22249 routines in the operating system.  This option is off by default, even
22250 when compiling for the TPF OS@.
22252 @item -mfused-madd
22253 @itemx -mno-fused-madd
22254 @opindex mfused-madd
22255 @opindex mno-fused-madd
22256 Generate code that uses (does not use) the floating-point multiply and
22257 accumulate instructions.  These instructions are generated by default if
22258 hardware floating point is used.
22260 @item -mwarn-framesize=@var{framesize}
22261 @opindex mwarn-framesize
22262 Emit a warning if the current function exceeds the given frame size.  Because
22263 this is a compile-time check it doesn't need to be a real problem when the program
22264 runs.  It is intended to identify functions that most probably cause
22265 a stack overflow.  It is useful to be used in an environment with limited stack
22266 size e.g.@: the linux kernel.
22268 @item -mwarn-dynamicstack
22269 @opindex mwarn-dynamicstack
22270 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22271 arrays.  This is generally a bad idea with a limited stack size.
22273 @item -mstack-guard=@var{stack-guard}
22274 @itemx -mstack-size=@var{stack-size}
22275 @opindex mstack-guard
22276 @opindex mstack-size
22277 If these options are provided the S/390 back end emits additional instructions in
22278 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22279 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22280 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22281 the frame size of the compiled function is chosen.
22282 These options are intended to be used to help debugging stack overflow problems.
22283 The additionally emitted code causes only little overhead and hence can also be
22284 used in production-like systems without greater performance degradation.  The given
22285 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22286 @var{stack-guard} without exceeding 64k.
22287 In order to be efficient the extra code makes the assumption that the stack starts
22288 at an address aligned to the value given by @var{stack-size}.
22289 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22291 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22292 @opindex mhotpatch
22293 If the hotpatch option is enabled, a ``hot-patching'' function
22294 prologue is generated for all functions in the compilation unit.
22295 The funtion label is prepended with the given number of two-byte
22296 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22297 the label, 2 * @var{post-halfwords} bytes are appended, using the
22298 largest NOP like instructions the architecture allows (maximum
22299 1000000).
22301 If both arguments are zero, hotpatching is disabled.
22303 This option can be overridden for individual functions with the
22304 @code{hotpatch} attribute.
22305 @end table
22307 @node Score Options
22308 @subsection Score Options
22309 @cindex Score Options
22311 These options are defined for Score implementations:
22313 @table @gcctabopt
22314 @item -meb
22315 @opindex meb
22316 Compile code for big-endian mode.  This is the default.
22318 @item -mel
22319 @opindex mel
22320 Compile code for little-endian mode.
22322 @item -mnhwloop
22323 @opindex mnhwloop
22324 Disable generation of @code{bcnz} instructions.
22326 @item -muls
22327 @opindex muls
22328 Enable generation of unaligned load and store instructions.
22330 @item -mmac
22331 @opindex mmac
22332 Enable the use of multiply-accumulate instructions. Disabled by default.
22334 @item -mscore5
22335 @opindex mscore5
22336 Specify the SCORE5 as the target architecture.
22338 @item -mscore5u
22339 @opindex mscore5u
22340 Specify the SCORE5U of the target architecture.
22342 @item -mscore7
22343 @opindex mscore7
22344 Specify the SCORE7 as the target architecture. This is the default.
22346 @item -mscore7d
22347 @opindex mscore7d
22348 Specify the SCORE7D as the target architecture.
22349 @end table
22351 @node SH Options
22352 @subsection SH Options
22354 These @samp{-m} options are defined for the SH implementations:
22356 @table @gcctabopt
22357 @item -m1
22358 @opindex m1
22359 Generate code for the SH1.
22361 @item -m2
22362 @opindex m2
22363 Generate code for the SH2.
22365 @item -m2e
22366 Generate code for the SH2e.
22368 @item -m2a-nofpu
22369 @opindex m2a-nofpu
22370 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22371 that the floating-point unit is not used.
22373 @item -m2a-single-only
22374 @opindex m2a-single-only
22375 Generate code for the SH2a-FPU, in such a way that no double-precision
22376 floating-point operations are used.
22378 @item -m2a-single
22379 @opindex m2a-single
22380 Generate code for the SH2a-FPU assuming the floating-point unit is in
22381 single-precision mode by default.
22383 @item -m2a
22384 @opindex m2a
22385 Generate code for the SH2a-FPU assuming the floating-point unit is in
22386 double-precision mode by default.
22388 @item -m3
22389 @opindex m3
22390 Generate code for the SH3.
22392 @item -m3e
22393 @opindex m3e
22394 Generate code for the SH3e.
22396 @item -m4-nofpu
22397 @opindex m4-nofpu
22398 Generate code for the SH4 without a floating-point unit.
22400 @item -m4-single-only
22401 @opindex m4-single-only
22402 Generate code for the SH4 with a floating-point unit that only
22403 supports single-precision arithmetic.
22405 @item -m4-single
22406 @opindex m4-single
22407 Generate code for the SH4 assuming the floating-point unit is in
22408 single-precision mode by default.
22410 @item -m4
22411 @opindex m4
22412 Generate code for the SH4.
22414 @item -m4-100
22415 @opindex m4-100
22416 Generate code for SH4-100.
22418 @item -m4-100-nofpu
22419 @opindex m4-100-nofpu
22420 Generate code for SH4-100 in such a way that the
22421 floating-point unit is not used.
22423 @item -m4-100-single
22424 @opindex m4-100-single
22425 Generate code for SH4-100 assuming the floating-point unit is in
22426 single-precision mode by default.
22428 @item -m4-100-single-only
22429 @opindex m4-100-single-only
22430 Generate code for SH4-100 in such a way that no double-precision
22431 floating-point operations are used.
22433 @item -m4-200
22434 @opindex m4-200
22435 Generate code for SH4-200.
22437 @item -m4-200-nofpu
22438 @opindex m4-200-nofpu
22439 Generate code for SH4-200 without in such a way that the
22440 floating-point unit is not used.
22442 @item -m4-200-single
22443 @opindex m4-200-single
22444 Generate code for SH4-200 assuming the floating-point unit is in
22445 single-precision mode by default.
22447 @item -m4-200-single-only
22448 @opindex m4-200-single-only
22449 Generate code for SH4-200 in such a way that no double-precision
22450 floating-point operations are used.
22452 @item -m4-300
22453 @opindex m4-300
22454 Generate code for SH4-300.
22456 @item -m4-300-nofpu
22457 @opindex m4-300-nofpu
22458 Generate code for SH4-300 without in such a way that the
22459 floating-point unit is not used.
22461 @item -m4-300-single
22462 @opindex m4-300-single
22463 Generate code for SH4-300 in such a way that no double-precision
22464 floating-point operations are used.
22466 @item -m4-300-single-only
22467 @opindex m4-300-single-only
22468 Generate code for SH4-300 in such a way that no double-precision
22469 floating-point operations are used.
22471 @item -m4-340
22472 @opindex m4-340
22473 Generate code for SH4-340 (no MMU, no FPU).
22475 @item -m4-500
22476 @opindex m4-500
22477 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22478 assembler.
22480 @item -m4a-nofpu
22481 @opindex m4a-nofpu
22482 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22483 floating-point unit is not used.
22485 @item -m4a-single-only
22486 @opindex m4a-single-only
22487 Generate code for the SH4a, in such a way that no double-precision
22488 floating-point operations are used.
22490 @item -m4a-single
22491 @opindex m4a-single
22492 Generate code for the SH4a assuming the floating-point unit is in
22493 single-precision mode by default.
22495 @item -m4a
22496 @opindex m4a
22497 Generate code for the SH4a.
22499 @item -m4al
22500 @opindex m4al
22501 Same as @option{-m4a-nofpu}, except that it implicitly passes
22502 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22503 instructions at the moment.
22505 @item -mb
22506 @opindex mb
22507 Compile code for the processor in big-endian mode.
22509 @item -ml
22510 @opindex ml
22511 Compile code for the processor in little-endian mode.
22513 @item -mdalign
22514 @opindex mdalign
22515 Align doubles at 64-bit boundaries.  Note that this changes the calling
22516 conventions, and thus some functions from the standard C library do
22517 not work unless you recompile it first with @option{-mdalign}.
22519 @item -mrelax
22520 @opindex mrelax
22521 Shorten some address references at link time, when possible; uses the
22522 linker option @option{-relax}.
22524 @item -mbigtable
22525 @opindex mbigtable
22526 Use 32-bit offsets in @code{switch} tables.  The default is to use
22527 16-bit offsets.
22529 @item -mbitops
22530 @opindex mbitops
22531 Enable the use of bit manipulation instructions on SH2A.
22533 @item -mfmovd
22534 @opindex mfmovd
22535 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22536 alignment constraints.
22538 @item -mrenesas
22539 @opindex mrenesas
22540 Comply with the calling conventions defined by Renesas.
22542 @item -mno-renesas
22543 @opindex mno-renesas
22544 Comply with the calling conventions defined for GCC before the Renesas
22545 conventions were available.  This option is the default for all
22546 targets of the SH toolchain.
22548 @item -mnomacsave
22549 @opindex mnomacsave
22550 Mark the @code{MAC} register as call-clobbered, even if
22551 @option{-mrenesas} is given.
22553 @item -mieee
22554 @itemx -mno-ieee
22555 @opindex mieee
22556 @opindex mno-ieee
22557 Control the IEEE compliance of floating-point comparisons, which affects the
22558 handling of cases where the result of a comparison is unordered.  By default
22559 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
22560 enabled @option{-mno-ieee} is implicitly set, which results in faster
22561 floating-point greater-equal and less-equal comparisons.  The implicit settings
22562 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
22564 @item -minline-ic_invalidate
22565 @opindex minline-ic_invalidate
22566 Inline code to invalidate instruction cache entries after setting up
22567 nested function trampolines.
22568 This option has no effect if @option{-musermode} is in effect and the selected
22569 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
22570 instruction.
22571 If the selected code generation option does not allow the use of the @code{icbi}
22572 instruction, and @option{-musermode} is not in effect, the inlined code
22573 manipulates the instruction cache address array directly with an associative
22574 write.  This not only requires privileged mode at run time, but it also
22575 fails if the cache line had been mapped via the TLB and has become unmapped.
22577 @item -misize
22578 @opindex misize
22579 Dump instruction size and location in the assembly code.
22581 @item -mpadstruct
22582 @opindex mpadstruct
22583 This option is deprecated.  It pads structures to multiple of 4 bytes,
22584 which is incompatible with the SH ABI@.
22586 @item -matomic-model=@var{model}
22587 @opindex matomic-model=@var{model}
22588 Sets the model of atomic operations and additional parameters as a comma
22589 separated list.  For details on the atomic built-in functions see
22590 @ref{__atomic Builtins}.  The following models and parameters are supported:
22592 @table @samp
22594 @item none
22595 Disable compiler generated atomic sequences and emit library calls for atomic
22596 operations.  This is the default if the target is not @code{sh*-*-linux*}.
22598 @item soft-gusa
22599 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
22600 built-in functions.  The generated atomic sequences require additional support
22601 from the interrupt/exception handling code of the system and are only suitable
22602 for SH3* and SH4* single-core systems.  This option is enabled by default when
22603 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
22604 this option also partially utilizes the hardware atomic instructions
22605 @code{movli.l} and @code{movco.l} to create more efficient code, unless
22606 @samp{strict} is specified.  
22608 @item soft-tcb
22609 Generate software atomic sequences that use a variable in the thread control
22610 block.  This is a variation of the gUSA sequences which can also be used on
22611 SH1* and SH2* targets.  The generated atomic sequences require additional
22612 support from the interrupt/exception handling code of the system and are only
22613 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
22614 parameter has to be specified as well.
22616 @item soft-imask
22617 Generate software atomic sequences that temporarily disable interrupts by
22618 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
22619 in privileged mode and is only suitable for single-core systems.  Additional
22620 support from the interrupt/exception handling code of the system is not
22621 required.  This model is enabled by default when the target is
22622 @code{sh*-*-linux*} and SH1* or SH2*.
22624 @item hard-llcs
22625 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
22626 instructions only.  This is only available on SH4A and is suitable for
22627 multi-core systems.  Since the hardware instructions support only 32 bit atomic
22628 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
22629 Code compiled with this option is also compatible with other software
22630 atomic model interrupt/exception handling systems if executed on an SH4A
22631 system.  Additional support from the interrupt/exception handling code of the
22632 system is not required for this model.
22634 @item gbr-offset=
22635 This parameter specifies the offset in bytes of the variable in the thread
22636 control block structure that should be used by the generated atomic sequences
22637 when the @samp{soft-tcb} model has been selected.  For other models this
22638 parameter is ignored.  The specified value must be an integer multiple of four
22639 and in the range 0-1020.
22641 @item strict
22642 This parameter prevents mixed usage of multiple atomic models, even if they
22643 are compatible, and makes the compiler generate atomic sequences of the
22644 specified model only.
22646 @end table
22648 @item -mtas
22649 @opindex mtas
22650 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
22651 Notice that depending on the particular hardware and software configuration
22652 this can degrade overall performance due to the operand cache line flushes
22653 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
22654 processors the @code{tas.b} instruction must be used with caution since it
22655 can result in data corruption for certain cache configurations.
22657 @item -mprefergot
22658 @opindex mprefergot
22659 When generating position-independent code, emit function calls using
22660 the Global Offset Table instead of the Procedure Linkage Table.
22662 @item -musermode
22663 @itemx -mno-usermode
22664 @opindex musermode
22665 @opindex mno-usermode
22666 Don't allow (allow) the compiler generating privileged mode code.  Specifying
22667 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
22668 inlined code would not work in user mode.  @option{-musermode} is the default
22669 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
22670 @option{-musermode} has no effect, since there is no user mode.
22672 @item -multcost=@var{number}
22673 @opindex multcost=@var{number}
22674 Set the cost to assume for a multiply insn.
22676 @item -mdiv=@var{strategy}
22677 @opindex mdiv=@var{strategy}
22678 Set the division strategy to be used for integer division operations.
22679 @var{strategy} can be one of: 
22681 @table @samp
22683 @item call-div1
22684 Calls a library function that uses the single-step division instruction
22685 @code{div1} to perform the operation.  Division by zero calculates an
22686 unspecified result and does not trap.  This is the default except for SH4,
22687 SH2A and SHcompact.
22689 @item call-fp
22690 Calls a library function that performs the operation in double precision
22691 floating point.  Division by zero causes a floating-point exception.  This is
22692 the default for SHcompact with FPU.  Specifying this for targets that do not
22693 have a double precision FPU defaults to @code{call-div1}.
22695 @item call-table
22696 Calls a library function that uses a lookup table for small divisors and
22697 the @code{div1} instruction with case distinction for larger divisors.  Division
22698 by zero calculates an unspecified result and does not trap.  This is the default
22699 for SH4.  Specifying this for targets that do not have dynamic shift
22700 instructions defaults to @code{call-div1}.
22702 @end table
22704 When a division strategy has not been specified the default strategy is
22705 selected based on the current target.  For SH2A the default strategy is to
22706 use the @code{divs} and @code{divu} instructions instead of library function
22707 calls.
22709 @item -maccumulate-outgoing-args
22710 @opindex maccumulate-outgoing-args
22711 Reserve space once for outgoing arguments in the function prologue rather
22712 than around each call.  Generally beneficial for performance and size.  Also
22713 needed for unwinding to avoid changing the stack frame around conditional code.
22715 @item -mdivsi3_libfunc=@var{name}
22716 @opindex mdivsi3_libfunc=@var{name}
22717 Set the name of the library function used for 32-bit signed division to
22718 @var{name}.
22719 This only affects the name used in the @samp{call} division strategies, and
22720 the compiler still expects the same sets of input/output/clobbered registers as
22721 if this option were not present.
22723 @item -mfixed-range=@var{register-range}
22724 @opindex mfixed-range
22725 Generate code treating the given register range as fixed registers.
22726 A fixed register is one that the register allocator can not use.  This is
22727 useful when compiling kernel code.  A register range is specified as
22728 two registers separated by a dash.  Multiple register ranges can be
22729 specified separated by a comma.
22731 @item -mbranch-cost=@var{num}
22732 @opindex mbranch-cost=@var{num}
22733 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
22734 make the compiler try to generate more branch-free code if possible.  
22735 If not specified the value is selected depending on the processor type that
22736 is being compiled for.
22738 @item -mzdcbranch
22739 @itemx -mno-zdcbranch
22740 @opindex mzdcbranch
22741 @opindex mno-zdcbranch
22742 Assume (do not assume) that zero displacement conditional branch instructions
22743 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
22744 compiler prefers zero displacement branch code sequences.  This is
22745 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
22746 disabled by specifying @option{-mno-zdcbranch}.
22748 @item -mcbranch-force-delay-slot
22749 @opindex mcbranch-force-delay-slot
22750 Force the usage of delay slots for conditional branches, which stuffs the delay
22751 slot with a @code{nop} if a suitable instruction can't be found.  By default
22752 this option is disabled.  It can be enabled to work around hardware bugs as
22753 found in the original SH7055.
22755 @item -mfused-madd
22756 @itemx -mno-fused-madd
22757 @opindex mfused-madd
22758 @opindex mno-fused-madd
22759 Generate code that uses (does not use) the floating-point multiply and
22760 accumulate instructions.  These instructions are generated by default
22761 if hardware floating point is used.  The machine-dependent
22762 @option{-mfused-madd} option is now mapped to the machine-independent
22763 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22764 mapped to @option{-ffp-contract=off}.
22766 @item -mfsca
22767 @itemx -mno-fsca
22768 @opindex mfsca
22769 @opindex mno-fsca
22770 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
22771 and cosine approximations.  The option @option{-mfsca} must be used in
22772 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
22773 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
22774 approximations even if @option{-funsafe-math-optimizations} is in effect.
22776 @item -mfsrra
22777 @itemx -mno-fsrra
22778 @opindex mfsrra
22779 @opindex mno-fsrra
22780 Allow or disallow the compiler to emit the @code{fsrra} instruction for
22781 reciprocal square root approximations.  The option @option{-mfsrra} must be used
22782 in combination with @option{-funsafe-math-optimizations} and
22783 @option{-ffinite-math-only}.  It is enabled by default when generating code for
22784 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
22785 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
22786 in effect.
22788 @item -mpretend-cmove
22789 @opindex mpretend-cmove
22790 Prefer zero-displacement conditional branches for conditional move instruction
22791 patterns.  This can result in faster code on the SH4 processor.
22793 @item -mfdpic
22794 @opindex fdpic
22795 Generate code using the FDPIC ABI.
22797 @end table
22799 @node Solaris 2 Options
22800 @subsection Solaris 2 Options
22801 @cindex Solaris 2 options
22803 These @samp{-m} options are supported on Solaris 2:
22805 @table @gcctabopt
22806 @item -mclear-hwcap
22807 @opindex mclear-hwcap
22808 @option{-mclear-hwcap} tells the compiler to remove the hardware
22809 capabilities generated by the Solaris assembler.  This is only necessary
22810 when object files use ISA extensions not supported by the current
22811 machine, but check at runtime whether or not to use them.
22813 @item -mimpure-text
22814 @opindex mimpure-text
22815 @option{-mimpure-text}, used in addition to @option{-shared}, tells
22816 the compiler to not pass @option{-z text} to the linker when linking a
22817 shared object.  Using this option, you can link position-dependent
22818 code into a shared object.
22820 @option{-mimpure-text} suppresses the ``relocations remain against
22821 allocatable but non-writable sections'' linker error message.
22822 However, the necessary relocations trigger copy-on-write, and the
22823 shared object is not actually shared across processes.  Instead of
22824 using @option{-mimpure-text}, you should compile all source code with
22825 @option{-fpic} or @option{-fPIC}.
22827 @end table
22829 These switches are supported in addition to the above on Solaris 2:
22831 @table @gcctabopt
22832 @item -pthreads
22833 @opindex pthreads
22834 Add support for multithreading using the POSIX threads library.  This
22835 option sets flags for both the preprocessor and linker.  This option does
22836 not affect the thread safety of object code produced  by the compiler or
22837 that of libraries supplied with it.
22839 @item -pthread
22840 @opindex pthread
22841 This is a synonym for @option{-pthreads}.
22842 @end table
22844 @node SPARC Options
22845 @subsection SPARC Options
22846 @cindex SPARC options
22848 These @samp{-m} options are supported on the SPARC:
22850 @table @gcctabopt
22851 @item -mno-app-regs
22852 @itemx -mapp-regs
22853 @opindex mno-app-regs
22854 @opindex mapp-regs
22855 Specify @option{-mapp-regs} to generate output using the global registers
22856 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
22857 global register 1, each global register 2 through 4 is then treated as an
22858 allocable register that is clobbered by function calls.  This is the default.
22860 To be fully SVR4 ABI-compliant at the cost of some performance loss,
22861 specify @option{-mno-app-regs}.  You should compile libraries and system
22862 software with this option.
22864 @item -mflat
22865 @itemx -mno-flat
22866 @opindex mflat
22867 @opindex mno-flat
22868 With @option{-mflat}, the compiler does not generate save/restore instructions
22869 and uses a ``flat'' or single register window model.  This model is compatible
22870 with the regular register window model.  The local registers and the input
22871 registers (0--5) are still treated as ``call-saved'' registers and are
22872 saved on the stack as needed.
22874 With @option{-mno-flat} (the default), the compiler generates save/restore
22875 instructions (except for leaf functions).  This is the normal operating mode.
22877 @item -mfpu
22878 @itemx -mhard-float
22879 @opindex mfpu
22880 @opindex mhard-float
22881 Generate output containing floating-point instructions.  This is the
22882 default.
22884 @item -mno-fpu
22885 @itemx -msoft-float
22886 @opindex mno-fpu
22887 @opindex msoft-float
22888 Generate output containing library calls for floating point.
22889 @strong{Warning:} the requisite libraries are not available for all SPARC
22890 targets.  Normally the facilities of the machine's usual C compiler are
22891 used, but this cannot be done directly in cross-compilation.  You must make
22892 your own arrangements to provide suitable library functions for
22893 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
22894 @samp{sparclite-*-*} do provide software floating-point support.
22896 @option{-msoft-float} changes the calling convention in the output file;
22897 therefore, it is only useful if you compile @emph{all} of a program with
22898 this option.  In particular, you need to compile @file{libgcc.a}, the
22899 library that comes with GCC, with @option{-msoft-float} in order for
22900 this to work.
22902 @item -mhard-quad-float
22903 @opindex mhard-quad-float
22904 Generate output containing quad-word (long double) floating-point
22905 instructions.
22907 @item -msoft-quad-float
22908 @opindex msoft-quad-float
22909 Generate output containing library calls for quad-word (long double)
22910 floating-point instructions.  The functions called are those specified
22911 in the SPARC ABI@.  This is the default.
22913 As of this writing, there are no SPARC implementations that have hardware
22914 support for the quad-word floating-point instructions.  They all invoke
22915 a trap handler for one of these instructions, and then the trap handler
22916 emulates the effect of the instruction.  Because of the trap handler overhead,
22917 this is much slower than calling the ABI library routines.  Thus the
22918 @option{-msoft-quad-float} option is the default.
22920 @item -mno-unaligned-doubles
22921 @itemx -munaligned-doubles
22922 @opindex mno-unaligned-doubles
22923 @opindex munaligned-doubles
22924 Assume that doubles have 8-byte alignment.  This is the default.
22926 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
22927 alignment only if they are contained in another type, or if they have an
22928 absolute address.  Otherwise, it assumes they have 4-byte alignment.
22929 Specifying this option avoids some rare compatibility problems with code
22930 generated by other compilers.  It is not the default because it results
22931 in a performance loss, especially for floating-point code.
22933 @item -muser-mode
22934 @itemx -mno-user-mode
22935 @opindex muser-mode
22936 @opindex mno-user-mode
22937 Do not generate code that can only run in supervisor mode.  This is relevant
22938 only for the @code{casa} instruction emitted for the LEON3 processor.  This
22939 is the default.
22941 @item -mfaster-structs
22942 @itemx -mno-faster-structs
22943 @opindex mfaster-structs
22944 @opindex mno-faster-structs
22945 With @option{-mfaster-structs}, the compiler assumes that structures
22946 should have 8-byte alignment.  This enables the use of pairs of
22947 @code{ldd} and @code{std} instructions for copies in structure
22948 assignment, in place of twice as many @code{ld} and @code{st} pairs.
22949 However, the use of this changed alignment directly violates the SPARC
22950 ABI@.  Thus, it's intended only for use on targets where the developer
22951 acknowledges that their resulting code is not directly in line with
22952 the rules of the ABI@.
22954 @item -mstd-struct-return
22955 @itemx -mno-std-struct-return
22956 @opindex mstd-struct-return
22957 @opindex mno-std-struct-return
22958 With @option{-mstd-struct-return}, the compiler generates checking code
22959 in functions returning structures or unions to detect size mismatches
22960 between the two sides of function calls, as per the 32-bit ABI@.
22962 The default is @option{-mno-std-struct-return}.  This option has no effect
22963 in 64-bit mode.
22965 @item -mcpu=@var{cpu_type}
22966 @opindex mcpu
22967 Set the instruction set, register set, and instruction scheduling parameters
22968 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22969 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
22970 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
22971 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
22972 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
22973 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
22975 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
22976 which selects the best architecture option for the host processor.
22977 @option{-mcpu=native} has no effect if GCC does not recognize
22978 the processor.
22980 Default instruction scheduling parameters are used for values that select
22981 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
22982 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
22984 Here is a list of each supported architecture and their supported
22985 implementations.
22987 @table @asis
22988 @item v7
22989 cypress, leon3v7
22991 @item v8
22992 supersparc, hypersparc, leon, leon3
22994 @item sparclite
22995 f930, f934, sparclite86x
22997 @item sparclet
22998 tsc701
23000 @item v9
23001 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23002 @end table
23004 By default (unless configured otherwise), GCC generates code for the V7
23005 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23006 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23007 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23008 SPARCStation 1, 2, IPX etc.
23010 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23011 architecture.  The only difference from V7 code is that the compiler emits
23012 the integer multiply and integer divide instructions which exist in SPARC-V8
23013 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23014 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23015 2000 series.
23017 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23018 the SPARC architecture.  This adds the integer multiply, integer divide step
23019 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23020 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23021 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23022 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23023 MB86934 chip, which is the more recent SPARClite with FPU@.
23025 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23026 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23027 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23028 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23029 optimizes it for the TEMIC SPARClet chip.
23031 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23032 architecture.  This adds 64-bit integer and floating-point move instructions,
23033 3 additional floating-point condition code registers and conditional move
23034 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23035 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23036 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23037 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23038 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23039 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23040 additionally optimizes it for Sun UltraSPARC T2 chips. With
23041 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23042 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23043 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23044 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23045 Oracle SPARC M7 chips.
23047 @item -mtune=@var{cpu_type}
23048 @opindex mtune
23049 Set the instruction scheduling parameters for machine type
23050 @var{cpu_type}, but do not set the instruction set or register set that the
23051 option @option{-mcpu=@var{cpu_type}} does.
23053 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23054 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23055 that select a particular CPU implementation.  Those are
23056 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23057 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23058 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23059 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23060 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23061 GNU/Linux toolchains, @samp{native} can also be used.
23063 @item -mv8plus
23064 @itemx -mno-v8plus
23065 @opindex mv8plus
23066 @opindex mno-v8plus
23067 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23068 difference from the V8 ABI is that the global and out registers are
23069 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23070 mode for all SPARC-V9 processors.
23072 @item -mvis
23073 @itemx -mno-vis
23074 @opindex mvis
23075 @opindex mno-vis
23076 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23077 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23079 @item -mvis2
23080 @itemx -mno-vis2
23081 @opindex mvis2
23082 @opindex mno-vis2
23083 With @option{-mvis2}, GCC generates code that takes advantage of
23084 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23085 default is @option{-mvis2} when targeting a cpu that supports such
23086 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23087 also sets @option{-mvis}.
23089 @item -mvis3
23090 @itemx -mno-vis3
23091 @opindex mvis3
23092 @opindex mno-vis3
23093 With @option{-mvis3}, GCC generates code that takes advantage of
23094 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23095 default is @option{-mvis3} when targeting a cpu that supports such
23096 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23097 also sets @option{-mvis2} and @option{-mvis}.
23099 @item -mvis4
23100 @itemx -mno-vis4
23101 @opindex mvis4
23102 @opindex mno-vis4
23103 With @option{-mvis4}, GCC generates code that takes advantage of
23104 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23105 default is @option{-mvis4} when targeting a cpu that supports such
23106 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23107 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23109 @item -mcbcond
23110 @itemx -mno-cbcond
23111 @opindex mcbcond
23112 @opindex mno-cbcond
23113 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23114 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23115 when targeting a CPU that supports such instructions, such as Niagara-4 and
23116 later.
23118 @item -mfmaf
23119 @itemx -mno-fmaf
23120 @opindex mfmaf
23121 @opindex mno-fmaf
23122 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23123 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23124 when targeting a CPU that supports such instructions, such as Niagara-3 and
23125 later.
23127 @item -mpopc
23128 @itemx -mno-popc
23129 @opindex mpopc
23130 @opindex mno-popc
23131 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23132 Population Count instruction.  The default is @option{-mpopc}
23133 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23134 later.
23136 @item -msubxc
23137 @itemx -mno-subxc
23138 @opindex msubxc
23139 @opindex mno-subxc
23140 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23141 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23142 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23143 later.
23145 @item -mfix-at697f
23146 @opindex mfix-at697f
23147 Enable the documented workaround for the single erratum of the Atmel AT697F
23148 processor (which corresponds to erratum #13 of the AT697E processor).
23150 @item -mfix-ut699
23151 @opindex mfix-ut699
23152 Enable the documented workarounds for the floating-point errata and the data
23153 cache nullify errata of the UT699 processor.
23154 @end table
23156 These @samp{-m} options are supported in addition to the above
23157 on SPARC-V9 processors in 64-bit environments:
23159 @table @gcctabopt
23160 @item -m32
23161 @itemx -m64
23162 @opindex m32
23163 @opindex m64
23164 Generate code for a 32-bit or 64-bit environment.
23165 The 32-bit environment sets int, long and pointer to 32 bits.
23166 The 64-bit environment sets int to 32 bits and long and pointer
23167 to 64 bits.
23169 @item -mcmodel=@var{which}
23170 @opindex mcmodel
23171 Set the code model to one of
23173 @table @samp
23174 @item medlow
23175 The Medium/Low code model: 64-bit addresses, programs
23176 must be linked in the low 32 bits of memory.  Programs can be statically
23177 or dynamically linked.
23179 @item medmid
23180 The Medium/Middle code model: 64-bit addresses, programs
23181 must be linked in the low 44 bits of memory, the text and data segments must
23182 be less than 2GB in size and the data segment must be located within 2GB of
23183 the text segment.
23185 @item medany
23186 The Medium/Anywhere code model: 64-bit addresses, programs
23187 may be linked anywhere in memory, the text and data segments must be less
23188 than 2GB in size and the data segment must be located within 2GB of the
23189 text segment.
23191 @item embmedany
23192 The Medium/Anywhere code model for embedded systems:
23193 64-bit addresses, the text and data segments must be less than 2GB in
23194 size, both starting anywhere in memory (determined at link time).  The
23195 global register %g4 points to the base of the data segment.  Programs
23196 are statically linked and PIC is not supported.
23197 @end table
23199 @item -mmemory-model=@var{mem-model}
23200 @opindex mmemory-model
23201 Set the memory model in force on the processor to one of
23203 @table @samp
23204 @item default
23205 The default memory model for the processor and operating system.
23207 @item rmo
23208 Relaxed Memory Order
23210 @item pso
23211 Partial Store Order
23213 @item tso
23214 Total Store Order
23216 @item sc
23217 Sequential Consistency
23218 @end table
23220 These memory models are formally defined in Appendix D of the Sparc V9
23221 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23223 @item -mstack-bias
23224 @itemx -mno-stack-bias
23225 @opindex mstack-bias
23226 @opindex mno-stack-bias
23227 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23228 frame pointer if present, are offset by @minus{}2047 which must be added back
23229 when making stack frame references.  This is the default in 64-bit mode.
23230 Otherwise, assume no such offset is present.
23231 @end table
23233 @node SPU Options
23234 @subsection SPU Options
23235 @cindex SPU options
23237 These @samp{-m} options are supported on the SPU:
23239 @table @gcctabopt
23240 @item -mwarn-reloc
23241 @itemx -merror-reloc
23242 @opindex mwarn-reloc
23243 @opindex merror-reloc
23245 The loader for SPU does not handle dynamic relocations.  By default, GCC
23246 gives an error when it generates code that requires a dynamic
23247 relocation.  @option{-mno-error-reloc} disables the error,
23248 @option{-mwarn-reloc} generates a warning instead.
23250 @item -msafe-dma
23251 @itemx -munsafe-dma
23252 @opindex msafe-dma
23253 @opindex munsafe-dma
23255 Instructions that initiate or test completion of DMA must not be
23256 reordered with respect to loads and stores of the memory that is being
23257 accessed.
23258 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23259 memory accesses, but that can lead to inefficient code in places where the
23260 memory is known to not change.  Rather than mark the memory as volatile,
23261 you can use @option{-msafe-dma} to tell the compiler to treat
23262 the DMA instructions as potentially affecting all memory.  
23264 @item -mbranch-hints
23265 @opindex mbranch-hints
23267 By default, GCC generates a branch hint instruction to avoid
23268 pipeline stalls for always-taken or probably-taken branches.  A hint
23269 is not generated closer than 8 instructions away from its branch.
23270 There is little reason to disable them, except for debugging purposes,
23271 or to make an object a little bit smaller.
23273 @item -msmall-mem
23274 @itemx -mlarge-mem
23275 @opindex msmall-mem
23276 @opindex mlarge-mem
23278 By default, GCC generates code assuming that addresses are never larger
23279 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23280 a full 32-bit address.
23282 @item -mstdmain
23283 @opindex mstdmain
23285 By default, GCC links against startup code that assumes the SPU-style
23286 main function interface (which has an unconventional parameter list).
23287 With @option{-mstdmain}, GCC links your program against startup
23288 code that assumes a C99-style interface to @code{main}, including a
23289 local copy of @code{argv} strings.
23291 @item -mfixed-range=@var{register-range}
23292 @opindex mfixed-range
23293 Generate code treating the given register range as fixed registers.
23294 A fixed register is one that the register allocator cannot use.  This is
23295 useful when compiling kernel code.  A register range is specified as
23296 two registers separated by a dash.  Multiple register ranges can be
23297 specified separated by a comma.
23299 @item -mea32
23300 @itemx -mea64
23301 @opindex mea32
23302 @opindex mea64
23303 Compile code assuming that pointers to the PPU address space accessed
23304 via the @code{__ea} named address space qualifier are either 32 or 64
23305 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23306 all object code in an executable must be compiled with the same setting.
23308 @item -maddress-space-conversion
23309 @itemx -mno-address-space-conversion
23310 @opindex maddress-space-conversion
23311 @opindex mno-address-space-conversion
23312 Allow/disallow treating the @code{__ea} address space as superset
23313 of the generic address space.  This enables explicit type casts
23314 between @code{__ea} and generic pointer as well as implicit
23315 conversions of generic pointers to @code{__ea} pointers.  The
23316 default is to allow address space pointer conversions.
23318 @item -mcache-size=@var{cache-size}
23319 @opindex mcache-size
23320 This option controls the version of libgcc that the compiler links to an
23321 executable and selects a software-managed cache for accessing variables
23322 in the @code{__ea} address space with a particular cache size.  Possible
23323 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23324 and @samp{128}.  The default cache size is 64KB.
23326 @item -matomic-updates
23327 @itemx -mno-atomic-updates
23328 @opindex matomic-updates
23329 @opindex mno-atomic-updates
23330 This option controls the version of libgcc that the compiler links to an
23331 executable and selects whether atomic updates to the software-managed
23332 cache of PPU-side variables are used.  If you use atomic updates, changes
23333 to a PPU variable from SPU code using the @code{__ea} named address space
23334 qualifier do not interfere with changes to other PPU variables residing
23335 in the same cache line from PPU code.  If you do not use atomic updates,
23336 such interference may occur; however, writing back cache lines is
23337 more efficient.  The default behavior is to use atomic updates.
23339 @item -mdual-nops
23340 @itemx -mdual-nops=@var{n}
23341 @opindex mdual-nops
23342 By default, GCC inserts NOPs to increase dual issue when it expects
23343 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23344 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23345 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23347 @item -mhint-max-nops=@var{n}
23348 @opindex mhint-max-nops
23349 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23350 be at least 8 instructions away from the branch it is affecting.  GCC
23351 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23352 generate the branch hint.
23354 @item -mhint-max-distance=@var{n}
23355 @opindex mhint-max-distance
23356 The encoding of the branch hint instruction limits the hint to be within
23357 256 instructions of the branch it is affecting.  By default, GCC makes
23358 sure it is within 125.
23360 @item -msafe-hints
23361 @opindex msafe-hints
23362 Work around a hardware bug that causes the SPU to stall indefinitely.
23363 By default, GCC inserts the @code{hbrp} instruction to make sure
23364 this stall won't happen.
23366 @end table
23368 @node System V Options
23369 @subsection Options for System V
23371 These additional options are available on System V Release 4 for
23372 compatibility with other compilers on those systems:
23374 @table @gcctabopt
23375 @item -G
23376 @opindex G
23377 Create a shared object.
23378 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23380 @item -Qy
23381 @opindex Qy
23382 Identify the versions of each tool used by the compiler, in a
23383 @code{.ident} assembler directive in the output.
23385 @item -Qn
23386 @opindex Qn
23387 Refrain from adding @code{.ident} directives to the output file (this is
23388 the default).
23390 @item -YP,@var{dirs}
23391 @opindex YP
23392 Search the directories @var{dirs}, and no others, for libraries
23393 specified with @option{-l}.
23395 @item -Ym,@var{dir}
23396 @opindex Ym
23397 Look in the directory @var{dir} to find the M4 preprocessor.
23398 The assembler uses this option.
23399 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23400 @c the generic assembler that comes with Solaris takes just -Ym.
23401 @end table
23403 @node TILE-Gx Options
23404 @subsection TILE-Gx Options
23405 @cindex TILE-Gx options
23407 These @samp{-m} options are supported on the TILE-Gx:
23409 @table @gcctabopt
23410 @item -mcmodel=small
23411 @opindex mcmodel=small
23412 Generate code for the small model.  The distance for direct calls is
23413 limited to 500M in either direction.  PC-relative addresses are 32
23414 bits.  Absolute addresses support the full address range.
23416 @item -mcmodel=large
23417 @opindex mcmodel=large
23418 Generate code for the large model.  There is no limitation on call
23419 distance, pc-relative addresses, or absolute addresses.
23421 @item -mcpu=@var{name}
23422 @opindex mcpu
23423 Selects the type of CPU to be targeted.  Currently the only supported
23424 type is @samp{tilegx}.
23426 @item -m32
23427 @itemx -m64
23428 @opindex m32
23429 @opindex m64
23430 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23431 environment sets int, long, and pointer to 32 bits.  The 64-bit
23432 environment sets int to 32 bits and long and pointer to 64 bits.
23434 @item -mbig-endian
23435 @itemx -mlittle-endian
23436 @opindex mbig-endian
23437 @opindex mlittle-endian
23438 Generate code in big/little endian mode, respectively.
23439 @end table
23441 @node TILEPro Options
23442 @subsection TILEPro Options
23443 @cindex TILEPro options
23445 These @samp{-m} options are supported on the TILEPro:
23447 @table @gcctabopt
23448 @item -mcpu=@var{name}
23449 @opindex mcpu
23450 Selects the type of CPU to be targeted.  Currently the only supported
23451 type is @samp{tilepro}.
23453 @item -m32
23454 @opindex m32
23455 Generate code for a 32-bit environment, which sets int, long, and
23456 pointer to 32 bits.  This is the only supported behavior so the flag
23457 is essentially ignored.
23458 @end table
23460 @node V850 Options
23461 @subsection V850 Options
23462 @cindex V850 Options
23464 These @samp{-m} options are defined for V850 implementations:
23466 @table @gcctabopt
23467 @item -mlong-calls
23468 @itemx -mno-long-calls
23469 @opindex mlong-calls
23470 @opindex mno-long-calls
23471 Treat all calls as being far away (near).  If calls are assumed to be
23472 far away, the compiler always loads the function's address into a
23473 register, and calls indirect through the pointer.
23475 @item -mno-ep
23476 @itemx -mep
23477 @opindex mno-ep
23478 @opindex mep
23479 Do not optimize (do optimize) basic blocks that use the same index
23480 pointer 4 or more times to copy pointer into the @code{ep} register, and
23481 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23482 option is on by default if you optimize.
23484 @item -mno-prolog-function
23485 @itemx -mprolog-function
23486 @opindex mno-prolog-function
23487 @opindex mprolog-function
23488 Do not use (do use) external functions to save and restore registers
23489 at the prologue and epilogue of a function.  The external functions
23490 are slower, but use less code space if more than one function saves
23491 the same number of registers.  The @option{-mprolog-function} option
23492 is on by default if you optimize.
23494 @item -mspace
23495 @opindex mspace
23496 Try to make the code as small as possible.  At present, this just turns
23497 on the @option{-mep} and @option{-mprolog-function} options.
23499 @item -mtda=@var{n}
23500 @opindex mtda
23501 Put static or global variables whose size is @var{n} bytes or less into
23502 the tiny data area that register @code{ep} points to.  The tiny data
23503 area can hold up to 256 bytes in total (128 bytes for byte references).
23505 @item -msda=@var{n}
23506 @opindex msda
23507 Put static or global variables whose size is @var{n} bytes or less into
23508 the small data area that register @code{gp} points to.  The small data
23509 area can hold up to 64 kilobytes.
23511 @item -mzda=@var{n}
23512 @opindex mzda
23513 Put static or global variables whose size is @var{n} bytes or less into
23514 the first 32 kilobytes of memory.
23516 @item -mv850
23517 @opindex mv850
23518 Specify that the target processor is the V850.
23520 @item -mv850e3v5
23521 @opindex mv850e3v5
23522 Specify that the target processor is the V850E3V5.  The preprocessor
23523 constant @code{__v850e3v5__} is defined if this option is used.
23525 @item -mv850e2v4
23526 @opindex mv850e2v4
23527 Specify that the target processor is the V850E3V5.  This is an alias for
23528 the @option{-mv850e3v5} option.
23530 @item -mv850e2v3
23531 @opindex mv850e2v3
23532 Specify that the target processor is the V850E2V3.  The preprocessor
23533 constant @code{__v850e2v3__} is defined if this option is used.
23535 @item -mv850e2
23536 @opindex mv850e2
23537 Specify that the target processor is the V850E2.  The preprocessor
23538 constant @code{__v850e2__} is defined if this option is used.
23540 @item -mv850e1
23541 @opindex mv850e1
23542 Specify that the target processor is the V850E1.  The preprocessor
23543 constants @code{__v850e1__} and @code{__v850e__} are defined if
23544 this option is used.
23546 @item -mv850es
23547 @opindex mv850es
23548 Specify that the target processor is the V850ES.  This is an alias for
23549 the @option{-mv850e1} option.
23551 @item -mv850e
23552 @opindex mv850e
23553 Specify that the target processor is the V850E@.  The preprocessor
23554 constant @code{__v850e__} is defined if this option is used.
23556 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23557 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23558 are defined then a default target processor is chosen and the
23559 relevant @samp{__v850*__} preprocessor constant is defined.
23561 The preprocessor constants @code{__v850} and @code{__v851__} are always
23562 defined, regardless of which processor variant is the target.
23564 @item -mdisable-callt
23565 @itemx -mno-disable-callt
23566 @opindex mdisable-callt
23567 @opindex mno-disable-callt
23568 This option suppresses generation of the @code{CALLT} instruction for the
23569 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
23570 architecture.
23572 This option is enabled by default when the RH850 ABI is
23573 in use (see @option{-mrh850-abi}), and disabled by default when the
23574 GCC ABI is in use.  If @code{CALLT} instructions are being generated
23575 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
23577 @item -mrelax
23578 @itemx -mno-relax
23579 @opindex mrelax
23580 @opindex mno-relax
23581 Pass on (or do not pass on) the @option{-mrelax} command-line option
23582 to the assembler.
23584 @item -mlong-jumps
23585 @itemx -mno-long-jumps
23586 @opindex mlong-jumps
23587 @opindex mno-long-jumps
23588 Disable (or re-enable) the generation of PC-relative jump instructions.
23590 @item -msoft-float
23591 @itemx -mhard-float
23592 @opindex msoft-float
23593 @opindex mhard-float
23594 Disable (or re-enable) the generation of hardware floating point
23595 instructions.  This option is only significant when the target
23596 architecture is @samp{V850E2V3} or higher.  If hardware floating point
23597 instructions are being generated then the C preprocessor symbol
23598 @code{__FPU_OK__} is defined, otherwise the symbol
23599 @code{__NO_FPU__} is defined.
23601 @item -mloop
23602 @opindex mloop
23603 Enables the use of the e3v5 LOOP instruction.  The use of this
23604 instruction is not enabled by default when the e3v5 architecture is
23605 selected because its use is still experimental.
23607 @item -mrh850-abi
23608 @itemx -mghs
23609 @opindex mrh850-abi
23610 @opindex mghs
23611 Enables support for the RH850 version of the V850 ABI.  This is the
23612 default.  With this version of the ABI the following rules apply:
23614 @itemize
23615 @item
23616 Integer sized structures and unions are returned via a memory pointer
23617 rather than a register.
23619 @item
23620 Large structures and unions (more than 8 bytes in size) are passed by
23621 value.
23623 @item
23624 Functions are aligned to 16-bit boundaries.
23626 @item
23627 The @option{-m8byte-align} command-line option is supported.
23629 @item
23630 The @option{-mdisable-callt} command-line option is enabled by
23631 default.  The @option{-mno-disable-callt} command-line option is not
23632 supported.
23633 @end itemize
23635 When this version of the ABI is enabled the C preprocessor symbol
23636 @code{__V850_RH850_ABI__} is defined.
23638 @item -mgcc-abi
23639 @opindex mgcc-abi
23640 Enables support for the old GCC version of the V850 ABI.  With this
23641 version of the ABI the following rules apply:
23643 @itemize
23644 @item
23645 Integer sized structures and unions are returned in register @code{r10}.
23647 @item
23648 Large structures and unions (more than 8 bytes in size) are passed by
23649 reference.
23651 @item
23652 Functions are aligned to 32-bit boundaries, unless optimizing for
23653 size.
23655 @item
23656 The @option{-m8byte-align} command-line option is not supported.
23658 @item
23659 The @option{-mdisable-callt} command-line option is supported but not
23660 enabled by default.
23661 @end itemize
23663 When this version of the ABI is enabled the C preprocessor symbol
23664 @code{__V850_GCC_ABI__} is defined.
23666 @item -m8byte-align
23667 @itemx -mno-8byte-align
23668 @opindex m8byte-align
23669 @opindex mno-8byte-align
23670 Enables support for @code{double} and @code{long long} types to be
23671 aligned on 8-byte boundaries.  The default is to restrict the
23672 alignment of all objects to at most 4-bytes.  When
23673 @option{-m8byte-align} is in effect the C preprocessor symbol
23674 @code{__V850_8BYTE_ALIGN__} is defined.
23676 @item -mbig-switch
23677 @opindex mbig-switch
23678 Generate code suitable for big switch tables.  Use this option only if
23679 the assembler/linker complain about out of range branches within a switch
23680 table.
23682 @item -mapp-regs
23683 @opindex mapp-regs
23684 This option causes r2 and r5 to be used in the code generated by
23685 the compiler.  This setting is the default.
23687 @item -mno-app-regs
23688 @opindex mno-app-regs
23689 This option causes r2 and r5 to be treated as fixed registers.
23691 @end table
23693 @node VAX Options
23694 @subsection VAX Options
23695 @cindex VAX options
23697 These @samp{-m} options are defined for the VAX:
23699 @table @gcctabopt
23700 @item -munix
23701 @opindex munix
23702 Do not output certain jump instructions (@code{aobleq} and so on)
23703 that the Unix assembler for the VAX cannot handle across long
23704 ranges.
23706 @item -mgnu
23707 @opindex mgnu
23708 Do output those jump instructions, on the assumption that the
23709 GNU assembler is being used.
23711 @item -mg
23712 @opindex mg
23713 Output code for G-format floating-point numbers instead of D-format.
23714 @end table
23716 @node Visium Options
23717 @subsection Visium Options
23718 @cindex Visium options
23720 @table @gcctabopt
23722 @item -mdebug
23723 @opindex mdebug
23724 A program which performs file I/O and is destined to run on an MCM target
23725 should be linked with this option.  It causes the libraries libc.a and
23726 libdebug.a to be linked.  The program should be run on the target under
23727 the control of the GDB remote debugging stub.
23729 @item -msim
23730 @opindex msim
23731 A program which performs file I/O and is destined to run on the simulator
23732 should be linked with option.  This causes libraries libc.a and libsim.a to
23733 be linked.
23735 @item -mfpu
23736 @itemx -mhard-float
23737 @opindex mfpu
23738 @opindex mhard-float
23739 Generate code containing floating-point instructions.  This is the
23740 default.
23742 @item -mno-fpu
23743 @itemx -msoft-float
23744 @opindex mno-fpu
23745 @opindex msoft-float
23746 Generate code containing library calls for floating-point.
23748 @option{-msoft-float} changes the calling convention in the output file;
23749 therefore, it is only useful if you compile @emph{all} of a program with
23750 this option.  In particular, you need to compile @file{libgcc.a}, the
23751 library that comes with GCC, with @option{-msoft-float} in order for
23752 this to work.
23754 @item -mcpu=@var{cpu_type}
23755 @opindex mcpu
23756 Set the instruction set, register set, and instruction scheduling parameters
23757 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23758 @samp{mcm}, @samp{gr5} and @samp{gr6}.
23760 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
23762 By default (unless configured otherwise), GCC generates code for the GR5
23763 variant of the Visium architecture.  
23765 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
23766 architecture.  The only difference from GR5 code is that the compiler will
23767 generate block move instructions.
23769 @item -mtune=@var{cpu_type}
23770 @opindex mtune
23771 Set the instruction scheduling parameters for machine type @var{cpu_type},
23772 but do not set the instruction set or register set that the option
23773 @option{-mcpu=@var{cpu_type}} would.
23775 @item -msv-mode
23776 @opindex msv-mode
23777 Generate code for the supervisor mode, where there are no restrictions on
23778 the access to general registers.  This is the default.
23780 @item -muser-mode
23781 @opindex muser-mode
23782 Generate code for the user mode, where the access to some general registers
23783 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
23784 mode; on the GR6, only registers r29 to r31 are affected.
23785 @end table
23787 @node VMS Options
23788 @subsection VMS Options
23790 These @samp{-m} options are defined for the VMS implementations:
23792 @table @gcctabopt
23793 @item -mvms-return-codes
23794 @opindex mvms-return-codes
23795 Return VMS condition codes from @code{main}. The default is to return POSIX-style
23796 condition (e.g.@ error) codes.
23798 @item -mdebug-main=@var{prefix}
23799 @opindex mdebug-main=@var{prefix}
23800 Flag the first routine whose name starts with @var{prefix} as the main
23801 routine for the debugger.
23803 @item -mmalloc64
23804 @opindex mmalloc64
23805 Default to 64-bit memory allocation routines.
23807 @item -mpointer-size=@var{size}
23808 @opindex mpointer-size=@var{size}
23809 Set the default size of pointers. Possible options for @var{size} are
23810 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
23811 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
23812 The later option disables @code{pragma pointer_size}.
23813 @end table
23815 @node VxWorks Options
23816 @subsection VxWorks Options
23817 @cindex VxWorks Options
23819 The options in this section are defined for all VxWorks targets.
23820 Options specific to the target hardware are listed with the other
23821 options for that target.
23823 @table @gcctabopt
23824 @item -mrtp
23825 @opindex mrtp
23826 GCC can generate code for both VxWorks kernels and real time processes
23827 (RTPs).  This option switches from the former to the latter.  It also
23828 defines the preprocessor macro @code{__RTP__}.
23830 @item -non-static
23831 @opindex non-static
23832 Link an RTP executable against shared libraries rather than static
23833 libraries.  The options @option{-static} and @option{-shared} can
23834 also be used for RTPs (@pxref{Link Options}); @option{-static}
23835 is the default.
23837 @item -Bstatic
23838 @itemx -Bdynamic
23839 @opindex Bstatic
23840 @opindex Bdynamic
23841 These options are passed down to the linker.  They are defined for
23842 compatibility with Diab.
23844 @item -Xbind-lazy
23845 @opindex Xbind-lazy
23846 Enable lazy binding of function calls.  This option is equivalent to
23847 @option{-Wl,-z,now} and is defined for compatibility with Diab.
23849 @item -Xbind-now
23850 @opindex Xbind-now
23851 Disable lazy binding of function calls.  This option is the default and
23852 is defined for compatibility with Diab.
23853 @end table
23855 @node x86 Options
23856 @subsection x86 Options
23857 @cindex x86 Options
23859 These @samp{-m} options are defined for the x86 family of computers.
23861 @table @gcctabopt
23863 @item -march=@var{cpu-type}
23864 @opindex march
23865 Generate instructions for the machine type @var{cpu-type}.  In contrast to
23866 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
23867 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
23868 to generate code that may not run at all on processors other than the one
23869 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
23870 @option{-mtune=@var{cpu-type}}.
23872 The choices for @var{cpu-type} are:
23874 @table @samp
23875 @item native
23876 This selects the CPU to generate code for at compilation time by determining
23877 the processor type of the compiling machine.  Using @option{-march=native}
23878 enables all instruction subsets supported by the local machine (hence
23879 the result might not run on different machines).  Using @option{-mtune=native}
23880 produces code optimized for the local machine under the constraints
23881 of the selected instruction set.  
23883 @item i386
23884 Original Intel i386 CPU@.
23886 @item i486
23887 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
23889 @item i586
23890 @itemx pentium
23891 Intel Pentium CPU with no MMX support.
23893 @item lakemont
23894 Intel Lakemont MCU, based on Intel Pentium CPU.
23896 @item pentium-mmx
23897 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
23899 @item pentiumpro
23900 Intel Pentium Pro CPU@.
23902 @item i686
23903 When used with @option{-march}, the Pentium Pro
23904 instruction set is used, so the code runs on all i686 family chips.
23905 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
23907 @item pentium2
23908 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
23909 support.
23911 @item pentium3
23912 @itemx pentium3m
23913 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
23914 set support.
23916 @item pentium-m
23917 Intel Pentium M; low-power version of Intel Pentium III CPU
23918 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
23920 @item pentium4
23921 @itemx pentium4m
23922 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
23924 @item prescott
23925 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
23926 set support.
23928 @item nocona
23929 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
23930 SSE2 and SSE3 instruction set support.
23932 @item core2
23933 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
23934 instruction set support.
23936 @item nehalem
23937 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23938 SSE4.1, SSE4.2 and POPCNT instruction set support.
23940 @item westmere
23941 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23942 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
23944 @item sandybridge
23945 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23946 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
23948 @item ivybridge
23949 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23950 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
23951 instruction set support.
23953 @item haswell
23954 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23955 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23956 BMI, BMI2 and F16C instruction set support.
23958 @item broadwell
23959 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23960 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23961 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
23963 @item skylake
23964 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23965 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23966 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
23967 XSAVES instruction set support.
23969 @item bonnell
23970 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
23971 instruction set support.
23973 @item silvermont
23974 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23975 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
23977 @item knl
23978 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
23979 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23980 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
23981 AVX512CD instruction set support.
23983 @item skylake-avx512
23984 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
23985 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23986 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
23987 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
23989 @item k6
23990 AMD K6 CPU with MMX instruction set support.
23992 @item k6-2
23993 @itemx k6-3
23994 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
23996 @item athlon
23997 @itemx athlon-tbird
23998 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
23999 support.
24001 @item athlon-4
24002 @itemx athlon-xp
24003 @itemx athlon-mp
24004 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24005 instruction set support.
24007 @item k8
24008 @itemx opteron
24009 @itemx athlon64
24010 @itemx athlon-fx
24011 Processors based on the AMD K8 core with x86-64 instruction set support,
24012 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24013 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24014 instruction set extensions.)
24016 @item k8-sse3
24017 @itemx opteron-sse3
24018 @itemx athlon64-sse3
24019 Improved versions of AMD K8 cores with SSE3 instruction set support.
24021 @item amdfam10
24022 @itemx barcelona
24023 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24024 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24025 instruction set extensions.)
24027 @item bdver1
24028 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24029 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24030 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24031 @item bdver2
24032 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24033 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24034 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24035 extensions.)
24036 @item bdver3
24037 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24038 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24039 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24040 64-bit instruction set extensions.
24041 @item bdver4
24042 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24043 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24044 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24045 SSE4.2, ABM and 64-bit instruction set extensions.
24047 @item znver1
24048 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24049 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24050 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24051 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24052 instruction set extensions.
24054 @item btver1
24055 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24056 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24057 instruction set extensions.)
24059 @item btver2
24060 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24061 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24062 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24064 @item winchip-c6
24065 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24066 set support.
24068 @item winchip2
24069 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24070 instruction set support.
24072 @item c3
24073 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24074 (No scheduling is implemented for this chip.)
24076 @item c3-2
24077 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24078 (No scheduling is implemented for this chip.)
24080 @item c7
24081 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24082 (No scheduling is implemented for this chip.)
24084 @item samuel-2
24085 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24086 (No scheduling is implemented for this chip.)
24088 @item nehemiah
24089 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24090 (No scheduling is implemented for this chip.)
24092 @item esther
24093 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24094 (No scheduling is implemented for this chip.)
24096 @item eden-x2
24097 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24098 (No scheduling is implemented for this chip.)
24100 @item eden-x4
24101 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24102 AVX and AVX2 instruction set support.
24103 (No scheduling is implemented for this chip.)
24105 @item nano
24106 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24107 instruction set support.
24108 (No scheduling is implemented for this chip.)
24110 @item nano-1000
24111 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24112 instruction set support.
24113 (No scheduling is implemented for this chip.)
24115 @item nano-2000
24116 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24117 instruction set support.
24118 (No scheduling is implemented for this chip.)
24120 @item nano-3000
24121 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24122 instruction set support.
24123 (No scheduling is implemented for this chip.)
24125 @item nano-x2
24126 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24127 instruction set support.
24128 (No scheduling is implemented for this chip.)
24130 @item nano-x4
24131 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24132 instruction set support.
24133 (No scheduling is implemented for this chip.)
24135 @item geode
24136 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24137 @end table
24139 @item -mtune=@var{cpu-type}
24140 @opindex mtune
24141 Tune to @var{cpu-type} everything applicable about the generated code, except
24142 for the ABI and the set of available instructions.  
24143 While picking a specific @var{cpu-type} schedules things appropriately
24144 for that particular chip, the compiler does not generate any code that
24145 cannot run on the default machine type unless you use a
24146 @option{-march=@var{cpu-type}} option.
24147 For example, if GCC is configured for i686-pc-linux-gnu
24148 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24149 but still runs on i686 machines.
24151 The choices for @var{cpu-type} are the same as for @option{-march}.
24152 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24154 @table @samp
24155 @item generic
24156 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24157 If you know the CPU on which your code will run, then you should use
24158 the corresponding @option{-mtune} or @option{-march} option instead of
24159 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24160 of your application will have, then you should use this option.
24162 As new processors are deployed in the marketplace, the behavior of this
24163 option will change.  Therefore, if you upgrade to a newer version of
24164 GCC, code generation controlled by this option will change to reflect
24165 the processors
24166 that are most common at the time that version of GCC is released.
24168 There is no @option{-march=generic} option because @option{-march}
24169 indicates the instruction set the compiler can use, and there is no
24170 generic instruction set applicable to all processors.  In contrast,
24171 @option{-mtune} indicates the processor (or, in this case, collection of
24172 processors) for which the code is optimized.
24174 @item intel
24175 Produce code optimized for the most current Intel processors, which are
24176 Haswell and Silvermont for this version of GCC.  If you know the CPU
24177 on which your code will run, then you should use the corresponding
24178 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24179 But, if you want your application performs better on both Haswell and
24180 Silvermont, then you should use this option.
24182 As new Intel processors are deployed in the marketplace, the behavior of
24183 this option will change.  Therefore, if you upgrade to a newer version of
24184 GCC, code generation controlled by this option will change to reflect
24185 the most current Intel processors at the time that version of GCC is
24186 released.
24188 There is no @option{-march=intel} option because @option{-march} indicates
24189 the instruction set the compiler can use, and there is no common
24190 instruction set applicable to all processors.  In contrast,
24191 @option{-mtune} indicates the processor (or, in this case, collection of
24192 processors) for which the code is optimized.
24193 @end table
24195 @item -mcpu=@var{cpu-type}
24196 @opindex mcpu
24197 A deprecated synonym for @option{-mtune}.
24199 @item -mfpmath=@var{unit}
24200 @opindex mfpmath
24201 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24202 for @var{unit} are:
24204 @table @samp
24205 @item 387
24206 Use the standard 387 floating-point coprocessor present on the majority of chips and
24207 emulated otherwise.  Code compiled with this option runs almost everywhere.
24208 The temporary results are computed in 80-bit precision instead of the precision
24209 specified by the type, resulting in slightly different results compared to most
24210 of other chips.  See @option{-ffloat-store} for more detailed description.
24212 This is the default choice for x86-32 targets.
24214 @item sse
24215 Use scalar floating-point instructions present in the SSE instruction set.
24216 This instruction set is supported by Pentium III and newer chips,
24217 and in the AMD line
24218 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24219 instruction set supports only single-precision arithmetic, thus the double and
24220 extended-precision arithmetic are still done using 387.  A later version, present
24221 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24222 arithmetic too.
24224 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24225 or @option{-msse2} switches to enable SSE extensions and make this option
24226 effective.  For the x86-64 compiler, these extensions are enabled by default.
24228 The resulting code should be considerably faster in the majority of cases and avoid
24229 the numerical instability problems of 387 code, but may break some existing
24230 code that expects temporaries to be 80 bits.
24232 This is the default choice for the x86-64 compiler.
24234 @item sse,387
24235 @itemx sse+387
24236 @itemx both
24237 Attempt to utilize both instruction sets at once.  This effectively doubles the
24238 amount of available registers, and on chips with separate execution units for
24239 387 and SSE the execution resources too.  Use this option with care, as it is
24240 still experimental, because the GCC register allocator does not model separate
24241 functional units well, resulting in unstable performance.
24242 @end table
24244 @item -masm=@var{dialect}
24245 @opindex masm=@var{dialect}
24246 Output assembly instructions using selected @var{dialect}.  Also affects
24247 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24248 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24249 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24250 not support @samp{intel}.
24252 @item -mieee-fp
24253 @itemx -mno-ieee-fp
24254 @opindex mieee-fp
24255 @opindex mno-ieee-fp
24256 Control whether or not the compiler uses IEEE floating-point
24257 comparisons.  These correctly handle the case where the result of a
24258 comparison is unordered.
24260 @item -m80387
24261 @item -mhard-float
24262 @opindex 80387
24263 @opindex mhard-float
24264 Generate output containing 80387 instructions for floating point.
24266 @item -mno-80387
24267 @item -msoft-float
24268 @opindex no-80387
24269 @opindex msoft-float
24270 Generate output containing library calls for floating point.
24272 @strong{Warning:} the requisite libraries are not part of GCC@.
24273 Normally the facilities of the machine's usual C compiler are used, but
24274 this can't be done directly in cross-compilation.  You must make your
24275 own arrangements to provide suitable library functions for
24276 cross-compilation.
24278 On machines where a function returns floating-point results in the 80387
24279 register stack, some floating-point opcodes may be emitted even if
24280 @option{-msoft-float} is used.
24282 @item -mno-fp-ret-in-387
24283 @opindex mno-fp-ret-in-387
24284 Do not use the FPU registers for return values of functions.
24286 The usual calling convention has functions return values of types
24287 @code{float} and @code{double} in an FPU register, even if there
24288 is no FPU@.  The idea is that the operating system should emulate
24289 an FPU@.
24291 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24292 in ordinary CPU registers instead.
24294 @item -mno-fancy-math-387
24295 @opindex mno-fancy-math-387
24296 Some 387 emulators do not support the @code{sin}, @code{cos} and
24297 @code{sqrt} instructions for the 387.  Specify this option to avoid
24298 generating those instructions.  This option is the default on
24299 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24300 indicates that the target CPU always has an FPU and so the
24301 instruction does not need emulation.  These
24302 instructions are not generated unless you also use the
24303 @option{-funsafe-math-optimizations} switch.
24305 @item -malign-double
24306 @itemx -mno-align-double
24307 @opindex malign-double
24308 @opindex mno-align-double
24309 Control whether GCC aligns @code{double}, @code{long double}, and
24310 @code{long long} variables on a two-word boundary or a one-word
24311 boundary.  Aligning @code{double} variables on a two-word boundary
24312 produces code that runs somewhat faster on a Pentium at the
24313 expense of more memory.
24315 On x86-64, @option{-malign-double} is enabled by default.
24317 @strong{Warning:} if you use the @option{-malign-double} switch,
24318 structures containing the above types are aligned differently than
24319 the published application binary interface specifications for the x86-32
24320 and are not binary compatible with structures in code compiled
24321 without that switch.
24323 @item -m96bit-long-double
24324 @itemx -m128bit-long-double
24325 @opindex m96bit-long-double
24326 @opindex m128bit-long-double
24327 These switches control the size of @code{long double} type.  The x86-32
24328 application binary interface specifies the size to be 96 bits,
24329 so @option{-m96bit-long-double} is the default in 32-bit mode.
24331 Modern architectures (Pentium and newer) prefer @code{long double}
24332 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24333 conforming to the ABI, this is not possible.  So specifying
24334 @option{-m128bit-long-double} aligns @code{long double}
24335 to a 16-byte boundary by padding the @code{long double} with an additional
24336 32-bit zero.
24338 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24339 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24341 Notice that neither of these options enable any extra precision over the x87
24342 standard of 80 bits for a @code{long double}.
24344 @strong{Warning:} if you override the default value for your target ABI, this
24345 changes the size of 
24346 structures and arrays containing @code{long double} variables,
24347 as well as modifying the function calling convention for functions taking
24348 @code{long double}.  Hence they are not binary-compatible
24349 with code compiled without that switch.
24351 @item -mlong-double-64
24352 @itemx -mlong-double-80
24353 @itemx -mlong-double-128
24354 @opindex mlong-double-64
24355 @opindex mlong-double-80
24356 @opindex mlong-double-128
24357 These switches control the size of @code{long double} type. A size
24358 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24359 type. This is the default for 32-bit Bionic C library.  A size
24360 of 128 bits makes the @code{long double} type equivalent to the
24361 @code{__float128} type. This is the default for 64-bit Bionic C library.
24363 @strong{Warning:} if you override the default value for your target ABI, this
24364 changes the size of
24365 structures and arrays containing @code{long double} variables,
24366 as well as modifying the function calling convention for functions taking
24367 @code{long double}.  Hence they are not binary-compatible
24368 with code compiled without that switch.
24370 @item -malign-data=@var{type}
24371 @opindex malign-data
24372 Control how GCC aligns variables.  Supported values for @var{type} are
24373 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24374 and earlier, @samp{abi} uses alignment value as specified by the
24375 psABI, and @samp{cacheline} uses increased alignment value to match
24376 the cache line size.  @samp{compat} is the default.
24378 @item -mlarge-data-threshold=@var{threshold}
24379 @opindex mlarge-data-threshold
24380 When @option{-mcmodel=medium} is specified, data objects larger than
24381 @var{threshold} are placed in the large data section.  This value must be the
24382 same across all objects linked into the binary, and defaults to 65535.
24384 @item -mrtd
24385 @opindex mrtd
24386 Use a different function-calling convention, in which functions that
24387 take a fixed number of arguments return with the @code{ret @var{num}}
24388 instruction, which pops their arguments while returning.  This saves one
24389 instruction in the caller since there is no need to pop the arguments
24390 there.
24392 You can specify that an individual function is called with this calling
24393 sequence with the function attribute @code{stdcall}.  You can also
24394 override the @option{-mrtd} option by using the function attribute
24395 @code{cdecl}.  @xref{Function Attributes}.
24397 @strong{Warning:} this calling convention is incompatible with the one
24398 normally used on Unix, so you cannot use it if you need to call
24399 libraries compiled with the Unix compiler.
24401 Also, you must provide function prototypes for all functions that
24402 take variable numbers of arguments (including @code{printf});
24403 otherwise incorrect code is generated for calls to those
24404 functions.
24406 In addition, seriously incorrect code results if you call a
24407 function with too many arguments.  (Normally, extra arguments are
24408 harmlessly ignored.)
24410 @item -mregparm=@var{num}
24411 @opindex mregparm
24412 Control how many registers are used to pass integer arguments.  By
24413 default, no registers are used to pass arguments, and at most 3
24414 registers can be used.  You can control this behavior for a specific
24415 function by using the function attribute @code{regparm}.
24416 @xref{Function Attributes}.
24418 @strong{Warning:} if you use this switch, and
24419 @var{num} is nonzero, then you must build all modules with the same
24420 value, including any libraries.  This includes the system libraries and
24421 startup modules.
24423 @item -msseregparm
24424 @opindex msseregparm
24425 Use SSE register passing conventions for float and double arguments
24426 and return values.  You can control this behavior for a specific
24427 function by using the function attribute @code{sseregparm}.
24428 @xref{Function Attributes}.
24430 @strong{Warning:} if you use this switch then you must build all
24431 modules with the same value, including any libraries.  This includes
24432 the system libraries and startup modules.
24434 @item -mvect8-ret-in-mem
24435 @opindex mvect8-ret-in-mem
24436 Return 8-byte vectors in memory instead of MMX registers.  This is the
24437 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24438 Studio compilers until version 12.  Later compiler versions (starting
24439 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24440 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24441 you need to remain compatible with existing code produced by those
24442 previous compiler versions or older versions of GCC@.
24444 @item -mpc32
24445 @itemx -mpc64
24446 @itemx -mpc80
24447 @opindex mpc32
24448 @opindex mpc64
24449 @opindex mpc80
24451 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24452 is specified, the significands of results of floating-point operations are
24453 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24454 significands of results of floating-point operations to 53 bits (double
24455 precision) and @option{-mpc80} rounds the significands of results of
24456 floating-point operations to 64 bits (extended double precision), which is
24457 the default.  When this option is used, floating-point operations in higher
24458 precisions are not available to the programmer without setting the FPU
24459 control word explicitly.
24461 Setting the rounding of floating-point operations to less than the default
24462 80 bits can speed some programs by 2% or more.  Note that some mathematical
24463 libraries assume that extended-precision (80-bit) floating-point operations
24464 are enabled by default; routines in such libraries could suffer significant
24465 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24466 when this option is used to set the precision to less than extended precision.
24468 @item -mstackrealign
24469 @opindex mstackrealign
24470 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24471 option generates an alternate prologue and epilogue that realigns the
24472 run-time stack if necessary.  This supports mixing legacy codes that keep
24473 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24474 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24475 applicable to individual functions.
24477 @item -mpreferred-stack-boundary=@var{num}
24478 @opindex mpreferred-stack-boundary
24479 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24480 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24481 the default is 4 (16 bytes or 128 bits).
24483 @strong{Warning:} When generating code for the x86-64 architecture with
24484 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24485 used to keep the stack boundary aligned to 8 byte boundary.  Since
24486 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24487 intended to be used in controlled environment where stack space is
24488 important limitation.  This option leads to wrong code when functions
24489 compiled with 16 byte stack alignment (such as functions from a standard
24490 library) are called with misaligned stack.  In this case, SSE
24491 instructions may lead to misaligned memory access traps.  In addition,
24492 variable arguments are handled incorrectly for 16 byte aligned
24493 objects (including x87 long double and __int128), leading to wrong
24494 results.  You must build all modules with
24495 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24496 includes the system libraries and startup modules.
24498 @item -mincoming-stack-boundary=@var{num}
24499 @opindex mincoming-stack-boundary
24500 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24501 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24502 the one specified by @option{-mpreferred-stack-boundary} is used.
24504 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24505 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24506 suffer significant run time performance penalties.  On Pentium III, the
24507 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24508 properly if it is not 16-byte aligned.
24510 To ensure proper alignment of this values on the stack, the stack boundary
24511 must be as aligned as that required by any value stored on the stack.
24512 Further, every function must be generated such that it keeps the stack
24513 aligned.  Thus calling a function compiled with a higher preferred
24514 stack boundary from a function compiled with a lower preferred stack
24515 boundary most likely misaligns the stack.  It is recommended that
24516 libraries that use callbacks always use the default setting.
24518 This extra alignment does consume extra stack space, and generally
24519 increases code size.  Code that is sensitive to stack space usage, such
24520 as embedded systems and operating system kernels, may want to reduce the
24521 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24523 @need 200
24524 @item -mmmx
24525 @opindex mmmx
24526 @need 200
24527 @itemx -msse
24528 @opindex msse
24529 @need 200
24530 @itemx -msse2
24531 @opindex msse2
24532 @need 200
24533 @itemx -msse3
24534 @opindex msse3
24535 @need 200
24536 @itemx -mssse3
24537 @opindex mssse3
24538 @need 200
24539 @itemx -msse4
24540 @opindex msse4
24541 @need 200
24542 @itemx -msse4a
24543 @opindex msse4a
24544 @need 200
24545 @itemx -msse4.1
24546 @opindex msse4.1
24547 @need 200
24548 @itemx -msse4.2
24549 @opindex msse4.2
24550 @need 200
24551 @itemx -mavx
24552 @opindex mavx
24553 @need 200
24554 @itemx -mavx2
24555 @opindex mavx2
24556 @need 200
24557 @itemx -mavx512f
24558 @opindex mavx512f
24559 @need 200
24560 @itemx -mavx512pf
24561 @opindex mavx512pf
24562 @need 200
24563 @itemx -mavx512er
24564 @opindex mavx512er
24565 @need 200
24566 @itemx -mavx512cd
24567 @opindex mavx512cd
24568 @need 200
24569 @itemx -mavx512vl
24570 @opindex mavx512vl
24571 @need 200
24572 @itemx -mavx512bw
24573 @opindex mavx512bw
24574 @need 200
24575 @itemx -mavx512dq
24576 @opindex mavx512dq
24577 @need 200
24578 @itemx -mavx512ifma
24579 @opindex mavx512ifma
24580 @need 200
24581 @itemx -mavx512vbmi
24582 @opindex mavx512vbmi
24583 @need 200
24584 @itemx -msha
24585 @opindex msha
24586 @need 200
24587 @itemx -maes
24588 @opindex maes
24589 @need 200
24590 @itemx -mpclmul
24591 @opindex mpclmul
24592 @need 200
24593 @itemx -mclfushopt
24594 @opindex mclfushopt
24595 @need 200
24596 @itemx -mfsgsbase
24597 @opindex mfsgsbase
24598 @need 200
24599 @itemx -mrdrnd
24600 @opindex mrdrnd
24601 @need 200
24602 @itemx -mf16c
24603 @opindex mf16c
24604 @need 200
24605 @itemx -mfma
24606 @opindex mfma
24607 @need 200
24608 @itemx -mfma4
24609 @opindex mfma4
24610 @need 200
24611 @itemx -mprefetchwt1
24612 @opindex mprefetchwt1
24613 @need 200
24614 @itemx -mxop
24615 @opindex mxop
24616 @need 200
24617 @itemx -mlwp
24618 @opindex mlwp
24619 @need 200
24620 @itemx -m3dnow
24621 @opindex m3dnow
24622 @need 200
24623 @itemx -mpopcnt
24624 @opindex mpopcnt
24625 @need 200
24626 @itemx -mabm
24627 @opindex mabm
24628 @need 200
24629 @itemx -mbmi
24630 @opindex mbmi
24631 @need 200
24632 @itemx -mbmi2
24633 @need 200
24634 @itemx -mlzcnt
24635 @opindex mlzcnt
24636 @need 200
24637 @itemx -mfxsr
24638 @opindex mfxsr
24639 @need 200
24640 @itemx -mxsave
24641 @opindex mxsave
24642 @need 200
24643 @itemx -mxsaveopt
24644 @opindex mxsaveopt
24645 @need 200
24646 @itemx -mxsavec
24647 @opindex mxsavec
24648 @need 200
24649 @itemx -mxsaves
24650 @opindex mxsaves
24651 @need 200
24652 @itemx -mrtm
24653 @opindex mrtm
24654 @need 200
24655 @itemx -mtbm
24656 @opindex mtbm
24657 @need 200
24658 @itemx -mmpx
24659 @opindex mmpx
24660 @need 200
24661 @itemx -mmwaitx
24662 @opindex mmwaitx
24663 @need 200
24664 @itemx -mclzero
24665 @opindex mclzero
24666 @itemx -mpku
24667 @opindex mpku
24668 These switches enable the use of instructions in the MMX, SSE,
24669 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
24670 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
24671 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
24672 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU or 3DNow!@:
24673 extended instruction sets.  Each has a corresponding @option{-mno-} option
24674 to disable use of these instructions.
24676 These extensions are also available as built-in functions: see
24677 @ref{x86 Built-in Functions}, for details of the functions enabled and
24678 disabled by these switches.
24680 To generate SSE/SSE2 instructions automatically from floating-point
24681 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
24683 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
24684 generates new AVX instructions or AVX equivalence for all SSEx instructions
24685 when needed.
24687 These options enable GCC to use these extended instructions in
24688 generated code, even without @option{-mfpmath=sse}.  Applications that
24689 perform run-time CPU detection must compile separate files for each
24690 supported architecture, using the appropriate flags.  In particular,
24691 the file containing the CPU detection code should be compiled without
24692 these options.
24694 @item -mdump-tune-features
24695 @opindex mdump-tune-features
24696 This option instructs GCC to dump the names of the x86 performance 
24697 tuning features and default settings. The names can be used in 
24698 @option{-mtune-ctrl=@var{feature-list}}.
24700 @item -mtune-ctrl=@var{feature-list}
24701 @opindex mtune-ctrl=@var{feature-list}
24702 This option is used to do fine grain control of x86 code generation features.
24703 @var{feature-list} is a comma separated list of @var{feature} names. See also
24704 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
24705 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
24706 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
24707 developers. Using it may lead to code paths not covered by testing and can
24708 potentially result in compiler ICEs or runtime errors.
24710 @item -mno-default
24711 @opindex mno-default
24712 This option instructs GCC to turn off all tunable features. See also 
24713 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
24715 @item -mcld
24716 @opindex mcld
24717 This option instructs GCC to emit a @code{cld} instruction in the prologue
24718 of functions that use string instructions.  String instructions depend on
24719 the DF flag to select between autoincrement or autodecrement mode.  While the
24720 ABI specifies the DF flag to be cleared on function entry, some operating
24721 systems violate this specification by not clearing the DF flag in their
24722 exception dispatchers.  The exception handler can be invoked with the DF flag
24723 set, which leads to wrong direction mode when string instructions are used.
24724 This option can be enabled by default on 32-bit x86 targets by configuring
24725 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
24726 instructions can be suppressed with the @option{-mno-cld} compiler option
24727 in this case.
24729 @item -mvzeroupper
24730 @opindex mvzeroupper
24731 This option instructs GCC to emit a @code{vzeroupper} instruction
24732 before a transfer of control flow out of the function to minimize
24733 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
24734 intrinsics.
24736 @item -mprefer-avx128
24737 @opindex mprefer-avx128
24738 This option instructs GCC to use 128-bit AVX instructions instead of
24739 256-bit AVX instructions in the auto-vectorizer.
24741 @item -mcx16
24742 @opindex mcx16
24743 This option enables GCC to generate @code{CMPXCHG16B} instructions.
24744 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
24745 (or oword) data types.  
24746 This is useful for high-resolution counters that can be updated
24747 by multiple processors (or cores).  This instruction is generated as part of
24748 atomic built-in functions: see @ref{__sync Builtins} or
24749 @ref{__atomic Builtins} for details.
24751 @item -msahf
24752 @opindex msahf
24753 This option enables generation of @code{SAHF} instructions in 64-bit code.
24754 Early Intel Pentium 4 CPUs with Intel 64 support,
24755 prior to the introduction of Pentium 4 G1 step in December 2005,
24756 lacked the @code{LAHF} and @code{SAHF} instructions
24757 which are supported by AMD64.
24758 These are load and store instructions, respectively, for certain status flags.
24759 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
24760 @code{drem}, and @code{remainder} built-in functions;
24761 see @ref{Other Builtins} for details.
24763 @item -mmovbe
24764 @opindex mmovbe
24765 This option enables use of the @code{movbe} instruction to implement
24766 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
24768 @item -mcrc32
24769 @opindex mcrc32
24770 This option enables built-in functions @code{__builtin_ia32_crc32qi},
24771 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
24772 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
24774 @item -mrecip
24775 @opindex mrecip
24776 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
24777 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
24778 with an additional Newton-Raphson step
24779 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
24780 (and their vectorized
24781 variants) for single-precision floating-point arguments.  These instructions
24782 are generated only when @option{-funsafe-math-optimizations} is enabled
24783 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
24784 Note that while the throughput of the sequence is higher than the throughput
24785 of the non-reciprocal instruction, the precision of the sequence can be
24786 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
24788 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
24789 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
24790 combination), and doesn't need @option{-mrecip}.
24792 Also note that GCC emits the above sequence with additional Newton-Raphson step
24793 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
24794 already with @option{-ffast-math} (or the above option combination), and
24795 doesn't need @option{-mrecip}.
24797 @item -mrecip=@var{opt}
24798 @opindex mrecip=opt
24799 This option controls which reciprocal estimate instructions
24800 may be used.  @var{opt} is a comma-separated list of options, which may
24801 be preceded by a @samp{!} to invert the option:
24803 @table @samp
24804 @item all
24805 Enable all estimate instructions.
24807 @item default
24808 Enable the default instructions, equivalent to @option{-mrecip}.
24810 @item none
24811 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24813 @item div
24814 Enable the approximation for scalar division.
24816 @item vec-div
24817 Enable the approximation for vectorized division.
24819 @item sqrt
24820 Enable the approximation for scalar square root.
24822 @item vec-sqrt
24823 Enable the approximation for vectorized square root.
24824 @end table
24826 So, for example, @option{-mrecip=all,!sqrt} enables
24827 all of the reciprocal approximations, except for square root.
24829 @item -mveclibabi=@var{type}
24830 @opindex mveclibabi
24831 Specifies the ABI type to use for vectorizing intrinsics using an
24832 external library.  Supported values for @var{type} are @samp{svml} 
24833 for the Intel short
24834 vector math library and @samp{acml} for the AMD math core library.
24835 To use this option, both @option{-ftree-vectorize} and
24836 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
24837 ABI-compatible library must be specified at link time.
24839 GCC currently emits calls to @code{vmldExp2},
24840 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
24841 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
24842 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
24843 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
24844 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
24845 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
24846 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
24847 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
24848 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
24849 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
24850 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
24851 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
24852 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
24853 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
24854 when @option{-mveclibabi=acml} is used.  
24856 @item -mabi=@var{name}
24857 @opindex mabi
24858 Generate code for the specified calling convention.  Permissible values
24859 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
24860 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
24861 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
24862 You can control this behavior for specific functions by
24863 using the function attributes @code{ms_abi} and @code{sysv_abi}.
24864 @xref{Function Attributes}.
24866 @item -mtls-dialect=@var{type}
24867 @opindex mtls-dialect
24868 Generate code to access thread-local storage using the @samp{gnu} or
24869 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
24870 @samp{gnu2} is more efficient, but it may add compile- and run-time
24871 requirements that cannot be satisfied on all systems.
24873 @item -mpush-args
24874 @itemx -mno-push-args
24875 @opindex mpush-args
24876 @opindex mno-push-args
24877 Use PUSH operations to store outgoing parameters.  This method is shorter
24878 and usually equally fast as method using SUB/MOV operations and is enabled
24879 by default.  In some cases disabling it may improve performance because of
24880 improved scheduling and reduced dependencies.
24882 @item -maccumulate-outgoing-args
24883 @opindex maccumulate-outgoing-args
24884 If enabled, the maximum amount of space required for outgoing arguments is
24885 computed in the function prologue.  This is faster on most modern CPUs
24886 because of reduced dependencies, improved scheduling and reduced stack usage
24887 when the preferred stack boundary is not equal to 2.  The drawback is a notable
24888 increase in code size.  This switch implies @option{-mno-push-args}.
24890 @item -mthreads
24891 @opindex mthreads
24892 Support thread-safe exception handling on MinGW.  Programs that rely
24893 on thread-safe exception handling must compile and link all code with the
24894 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
24895 @option{-D_MT}; when linking, it links in a special thread helper library
24896 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
24898 @item -mms-bitfields
24899 @itemx -mno-ms-bitfields
24900 @opindex mms-bitfields
24901 @opindex mno-ms-bitfields
24903 Enable/disable bit-field layout compatible with the native Microsoft
24904 Windows compiler.  
24906 If @code{packed} is used on a structure, or if bit-fields are used,
24907 it may be that the Microsoft ABI lays out the structure differently
24908 than the way GCC normally does.  Particularly when moving packed
24909 data between functions compiled with GCC and the native Microsoft compiler
24910 (either via function call or as data in a file), it may be necessary to access
24911 either format.
24913 This option is enabled by default for Microsoft Windows
24914 targets.  This behavior can also be controlled locally by use of variable
24915 or type attributes.  For more information, see @ref{x86 Variable Attributes}
24916 and @ref{x86 Type Attributes}.
24918 The Microsoft structure layout algorithm is fairly simple with the exception
24919 of the bit-field packing.  
24920 The padding and alignment of members of structures and whether a bit-field 
24921 can straddle a storage-unit boundary are determine by these rules:
24923 @enumerate
24924 @item Structure members are stored sequentially in the order in which they are
24925 declared: the first member has the lowest memory address and the last member
24926 the highest.
24928 @item Every data object has an alignment requirement.  The alignment requirement
24929 for all data except structures, unions, and arrays is either the size of the
24930 object or the current packing size (specified with either the
24931 @code{aligned} attribute or the @code{pack} pragma),
24932 whichever is less.  For structures, unions, and arrays,
24933 the alignment requirement is the largest alignment requirement of its members.
24934 Every object is allocated an offset so that:
24936 @smallexample
24937 offset % alignment_requirement == 0
24938 @end smallexample
24940 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
24941 unit if the integral types are the same size and if the next bit-field fits
24942 into the current allocation unit without crossing the boundary imposed by the
24943 common alignment requirements of the bit-fields.
24944 @end enumerate
24946 MSVC interprets zero-length bit-fields in the following ways:
24948 @enumerate
24949 @item If a zero-length bit-field is inserted between two bit-fields that
24950 are normally coalesced, the bit-fields are not coalesced.
24952 For example:
24954 @smallexample
24955 struct
24956  @{
24957    unsigned long bf_1 : 12;
24958    unsigned long : 0;
24959    unsigned long bf_2 : 12;
24960  @} t1;
24961 @end smallexample
24963 @noindent
24964 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
24965 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
24967 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
24968 alignment of the zero-length bit-field is greater than the member that follows it,
24969 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
24971 For example:
24973 @smallexample
24974 struct
24975  @{
24976    char foo : 4;
24977    short : 0;
24978    char bar;
24979  @} t2;
24981 struct
24982  @{
24983    char foo : 4;
24984    short : 0;
24985    double bar;
24986  @} t3;
24987 @end smallexample
24989 @noindent
24990 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
24991 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
24992 bit-field does not affect the alignment of @code{bar} or, as a result, the size
24993 of the structure.
24995 Taking this into account, it is important to note the following:
24997 @enumerate
24998 @item If a zero-length bit-field follows a normal bit-field, the type of the
24999 zero-length bit-field may affect the alignment of the structure as whole. For
25000 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25001 normal bit-field, and is of type short.
25003 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25004 still affect the alignment of the structure:
25006 @smallexample
25007 struct
25008  @{
25009    char foo : 6;
25010    long : 0;
25011  @} t4;
25012 @end smallexample
25014 @noindent
25015 Here, @code{t4} takes up 4 bytes.
25016 @end enumerate
25018 @item Zero-length bit-fields following non-bit-field members are ignored:
25020 @smallexample
25021 struct
25022  @{
25023    char foo;
25024    long : 0;
25025    char bar;
25026  @} t5;
25027 @end smallexample
25029 @noindent
25030 Here, @code{t5} takes up 2 bytes.
25031 @end enumerate
25034 @item -mno-align-stringops
25035 @opindex mno-align-stringops
25036 Do not align the destination of inlined string operations.  This switch reduces
25037 code size and improves performance in case the destination is already aligned,
25038 but GCC doesn't know about it.
25040 @item -minline-all-stringops
25041 @opindex minline-all-stringops
25042 By default GCC inlines string operations only when the destination is 
25043 known to be aligned to least a 4-byte boundary.  
25044 This enables more inlining and increases code
25045 size, but may improve performance of code that depends on fast
25046 @code{memcpy}, @code{strlen},
25047 and @code{memset} for short lengths.
25049 @item -minline-stringops-dynamically
25050 @opindex minline-stringops-dynamically
25051 For string operations of unknown size, use run-time checks with
25052 inline code for small blocks and a library call for large blocks.
25054 @item -mstringop-strategy=@var{alg}
25055 @opindex mstringop-strategy=@var{alg}
25056 Override the internal decision heuristic for the particular algorithm to use
25057 for inlining string operations.  The allowed values for @var{alg} are:
25059 @table @samp
25060 @item rep_byte
25061 @itemx rep_4byte
25062 @itemx rep_8byte
25063 Expand using i386 @code{rep} prefix of the specified size.
25065 @item byte_loop
25066 @itemx loop
25067 @itemx unrolled_loop
25068 Expand into an inline loop.
25070 @item libcall
25071 Always use a library call.
25072 @end table
25074 @item -mmemcpy-strategy=@var{strategy}
25075 @opindex mmemcpy-strategy=@var{strategy}
25076 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25077 should be inlined and what inline algorithm to use when the expected size
25078 of the copy operation is known. @var{strategy} 
25079 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25080 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25081 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25082 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25083 in the list must be specified in increasing order.  The minimal byte size for 
25084 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25085 preceding range.
25087 @item -mmemset-strategy=@var{strategy}
25088 @opindex mmemset-strategy=@var{strategy}
25089 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25090 @code{__builtin_memset} expansion.
25092 @item -momit-leaf-frame-pointer
25093 @opindex momit-leaf-frame-pointer
25094 Don't keep the frame pointer in a register for leaf functions.  This
25095 avoids the instructions to save, set up, and restore frame pointers and
25096 makes an extra register available in leaf functions.  The option
25097 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25098 which might make debugging harder.
25100 @item -mtls-direct-seg-refs
25101 @itemx -mno-tls-direct-seg-refs
25102 @opindex mtls-direct-seg-refs
25103 Controls whether TLS variables may be accessed with offsets from the
25104 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25105 or whether the thread base pointer must be added.  Whether or not this
25106 is valid depends on the operating system, and whether it maps the
25107 segment to cover the entire TLS area.
25109 For systems that use the GNU C Library, the default is on.
25111 @item -msse2avx
25112 @itemx -mno-sse2avx
25113 @opindex msse2avx
25114 Specify that the assembler should encode SSE instructions with VEX
25115 prefix.  The option @option{-mavx} turns this on by default.
25117 @item -mfentry
25118 @itemx -mno-fentry
25119 @opindex mfentry
25120 If profiling is active (@option{-pg}), put the profiling
25121 counter call before the prologue.
25122 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25123 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25125 @item -mrecord-mcount
25126 @itemx -mno-record-mcount
25127 @opindex mrecord-mcount
25128 If profiling is active (@option{-pg}), generate a __mcount_loc section
25129 that contains pointers to each profiling call. This is useful for
25130 automatically patching and out calls.
25132 @item -mnop-mcount
25133 @itemx -mno-nop-mcount
25134 @opindex mnop-mcount
25135 If profiling is active (@option{-pg}), generate the calls to
25136 the profiling functions as NOPs. This is useful when they
25137 should be patched in later dynamically. This is likely only
25138 useful together with @option{-mrecord-mcount}.
25140 @item -mskip-rax-setup
25141 @itemx -mno-skip-rax-setup
25142 @opindex mskip-rax-setup
25143 When generating code for the x86-64 architecture with SSE extensions
25144 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25145 register when there are no variable arguments passed in vector registers.
25147 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25148 saving vector registers on stack when passing variable arguments, the
25149 impacts of this option are callees may waste some stack space,
25150 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25151 those issues, regardless the RAX register value.
25153 @item -m8bit-idiv
25154 @itemx -mno-8bit-idiv
25155 @opindex m8bit-idiv
25156 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25157 much faster than 32-bit/64-bit integer divide.  This option generates a
25158 run-time check.  If both dividend and divisor are within range of 0
25159 to 255, 8-bit unsigned integer divide is used instead of
25160 32-bit/64-bit integer divide.
25162 @item -mavx256-split-unaligned-load
25163 @itemx -mavx256-split-unaligned-store
25164 @opindex mavx256-split-unaligned-load
25165 @opindex mavx256-split-unaligned-store
25166 Split 32-byte AVX unaligned load and store.
25168 @item -mstack-protector-guard=@var{guard}
25169 @opindex mstack-protector-guard=@var{guard}
25170 Generate stack protection code using canary at @var{guard}.  Supported
25171 locations are @samp{global} for global canary or @samp{tls} for per-thread
25172 canary in the TLS block (the default).  This option has effect only when
25173 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25175 @item -mmitigate-rop
25176 @opindex mmitigate-rop
25177 Try to avoid generating code sequences that contain unintended return
25178 opcodes, to mitigate against certain forms of attack. At the moment,
25179 this option is limited in what it can do and should not be relied
25180 on to provide serious protection.
25182 @item -mgeneral-regs-only
25183 @opindex mgeneral-regs-only
25184 Generate code that uses only the general-purpose registers.  This
25185 prevents the compiler from using floating-point, vector, mask and bound
25186 registers.
25188 @end table
25190 These @samp{-m} switches are supported in addition to the above
25191 on x86-64 processors in 64-bit environments.
25193 @table @gcctabopt
25194 @item -m32
25195 @itemx -m64
25196 @itemx -mx32
25197 @itemx -m16
25198 @itemx -miamcu
25199 @opindex m32
25200 @opindex m64
25201 @opindex mx32
25202 @opindex m16
25203 @opindex miamcu
25204 Generate code for a 16-bit, 32-bit or 64-bit environment.
25205 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25206 to 32 bits, and
25207 generates code that runs on any i386 system.
25209 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25210 types to 64 bits, and generates code for the x86-64 architecture.
25211 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25212 and @option{-mdynamic-no-pic} options.
25214 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25215 to 32 bits, and
25216 generates code for the x86-64 architecture.
25218 The @option{-m16} option is the same as @option{-m32}, except for that
25219 it outputs the @code{.code16gcc} assembly directive at the beginning of
25220 the assembly output so that the binary can run in 16-bit mode.
25222 The @option{-miamcu} option generates code which conforms to Intel MCU
25223 psABI.  It requires the @option{-m32} option to be turned on.
25225 @item -mno-red-zone
25226 @opindex mno-red-zone
25227 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25228 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25229 stack pointer that is not modified by signal or interrupt handlers
25230 and therefore can be used for temporary data without adjusting the stack
25231 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25233 @item -mcmodel=small
25234 @opindex mcmodel=small
25235 Generate code for the small code model: the program and its symbols must
25236 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25237 Programs can be statically or dynamically linked.  This is the default
25238 code model.
25240 @item -mcmodel=kernel
25241 @opindex mcmodel=kernel
25242 Generate code for the kernel code model.  The kernel runs in the
25243 negative 2 GB of the address space.
25244 This model has to be used for Linux kernel code.
25246 @item -mcmodel=medium
25247 @opindex mcmodel=medium
25248 Generate code for the medium model: the program is linked in the lower 2
25249 GB of the address space.  Small symbols are also placed there.  Symbols
25250 with sizes larger than @option{-mlarge-data-threshold} are put into
25251 large data or BSS sections and can be located above 2GB.  Programs can
25252 be statically or dynamically linked.
25254 @item -mcmodel=large
25255 @opindex mcmodel=large
25256 Generate code for the large model.  This model makes no assumptions
25257 about addresses and sizes of sections.
25259 @item -maddress-mode=long
25260 @opindex maddress-mode=long
25261 Generate code for long address mode.  This is only supported for 64-bit
25262 and x32 environments.  It is the default address mode for 64-bit
25263 environments.
25265 @item -maddress-mode=short
25266 @opindex maddress-mode=short
25267 Generate code for short address mode.  This is only supported for 32-bit
25268 and x32 environments.  It is the default address mode for 32-bit and
25269 x32 environments.
25270 @end table
25272 @node x86 Windows Options
25273 @subsection x86 Windows Options
25274 @cindex x86 Windows Options
25275 @cindex Windows Options for x86
25277 These additional options are available for Microsoft Windows targets:
25279 @table @gcctabopt
25280 @item -mconsole
25281 @opindex mconsole
25282 This option
25283 specifies that a console application is to be generated, by
25284 instructing the linker to set the PE header subsystem type
25285 required for console applications.
25286 This option is available for Cygwin and MinGW targets and is
25287 enabled by default on those targets.
25289 @item -mdll
25290 @opindex mdll
25291 This option is available for Cygwin and MinGW targets.  It
25292 specifies that a DLL---a dynamic link library---is to be
25293 generated, enabling the selection of the required runtime
25294 startup object and entry point.
25296 @item -mnop-fun-dllimport
25297 @opindex mnop-fun-dllimport
25298 This option is available for Cygwin and MinGW targets.  It
25299 specifies that the @code{dllimport} attribute should be ignored.
25301 @item -mthread
25302 @opindex mthread
25303 This option is available for MinGW targets. It specifies
25304 that MinGW-specific thread support is to be used.
25306 @item -municode
25307 @opindex municode
25308 This option is available for MinGW-w64 targets.  It causes
25309 the @code{UNICODE} preprocessor macro to be predefined, and
25310 chooses Unicode-capable runtime startup code.
25312 @item -mwin32
25313 @opindex mwin32
25314 This option is available for Cygwin and MinGW targets.  It
25315 specifies that the typical Microsoft Windows predefined macros are to
25316 be set in the pre-processor, but does not influence the choice
25317 of runtime library/startup code.
25319 @item -mwindows
25320 @opindex mwindows
25321 This option is available for Cygwin and MinGW targets.  It
25322 specifies that a GUI application is to be generated by
25323 instructing the linker to set the PE header subsystem type
25324 appropriately.
25326 @item -fno-set-stack-executable
25327 @opindex fno-set-stack-executable
25328 This option is available for MinGW targets. It specifies that
25329 the executable flag for the stack used by nested functions isn't
25330 set. This is necessary for binaries running in kernel mode of
25331 Microsoft Windows, as there the User32 API, which is used to set executable
25332 privileges, isn't available.
25334 @item -fwritable-relocated-rdata
25335 @opindex fno-writable-relocated-rdata
25336 This option is available for MinGW and Cygwin targets.  It specifies
25337 that relocated-data in read-only section is put into the @code{.data}
25338 section.  This is a necessary for older runtimes not supporting
25339 modification of @code{.rdata} sections for pseudo-relocation.
25341 @item -mpe-aligned-commons
25342 @opindex mpe-aligned-commons
25343 This option is available for Cygwin and MinGW targets.  It
25344 specifies that the GNU extension to the PE file format that
25345 permits the correct alignment of COMMON variables should be
25346 used when generating code.  It is enabled by default if
25347 GCC detects that the target assembler found during configuration
25348 supports the feature.
25349 @end table
25351 See also under @ref{x86 Options} for standard options.
25353 @node Xstormy16 Options
25354 @subsection Xstormy16 Options
25355 @cindex Xstormy16 Options
25357 These options are defined for Xstormy16:
25359 @table @gcctabopt
25360 @item -msim
25361 @opindex msim
25362 Choose startup files and linker script suitable for the simulator.
25363 @end table
25365 @node Xtensa Options
25366 @subsection Xtensa Options
25367 @cindex Xtensa Options
25369 These options are supported for Xtensa targets:
25371 @table @gcctabopt
25372 @item -mconst16
25373 @itemx -mno-const16
25374 @opindex mconst16
25375 @opindex mno-const16
25376 Enable or disable use of @code{CONST16} instructions for loading
25377 constant values.  The @code{CONST16} instruction is currently not a
25378 standard option from Tensilica.  When enabled, @code{CONST16}
25379 instructions are always used in place of the standard @code{L32R}
25380 instructions.  The use of @code{CONST16} is enabled by default only if
25381 the @code{L32R} instruction is not available.
25383 @item -mfused-madd
25384 @itemx -mno-fused-madd
25385 @opindex mfused-madd
25386 @opindex mno-fused-madd
25387 Enable or disable use of fused multiply/add and multiply/subtract
25388 instructions in the floating-point option.  This has no effect if the
25389 floating-point option is not also enabled.  Disabling fused multiply/add
25390 and multiply/subtract instructions forces the compiler to use separate
25391 instructions for the multiply and add/subtract operations.  This may be
25392 desirable in some cases where strict IEEE 754-compliant results are
25393 required: the fused multiply add/subtract instructions do not round the
25394 intermediate result, thereby producing results with @emph{more} bits of
25395 precision than specified by the IEEE standard.  Disabling fused multiply
25396 add/subtract instructions also ensures that the program output is not
25397 sensitive to the compiler's ability to combine multiply and add/subtract
25398 operations.
25400 @item -mserialize-volatile
25401 @itemx -mno-serialize-volatile
25402 @opindex mserialize-volatile
25403 @opindex mno-serialize-volatile
25404 When this option is enabled, GCC inserts @code{MEMW} instructions before
25405 @code{volatile} memory references to guarantee sequential consistency.
25406 The default is @option{-mserialize-volatile}.  Use
25407 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25409 @item -mforce-no-pic
25410 @opindex mforce-no-pic
25411 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25412 position-independent code (PIC), this option disables PIC for compiling
25413 kernel code.
25415 @item -mtext-section-literals
25416 @itemx -mno-text-section-literals
25417 @opindex mtext-section-literals
25418 @opindex mno-text-section-literals
25419 These options control the treatment of literal pools.  The default is
25420 @option{-mno-text-section-literals}, which places literals in a separate
25421 section in the output file.  This allows the literal pool to be placed
25422 in a data RAM/ROM, and it also allows the linker to combine literal
25423 pools from separate object files to remove redundant literals and
25424 improve code size.  With @option{-mtext-section-literals}, the literals
25425 are interspersed in the text section in order to keep them as close as
25426 possible to their references.  This may be necessary for large assembly
25427 files.  Literals for each function are placed right before that function.
25429 @item -mauto-litpools
25430 @itemx -mno-auto-litpools
25431 @opindex mauto-litpools
25432 @opindex mno-auto-litpools
25433 These options control the treatment of literal pools.  The default is
25434 @option{-mno-auto-litpools}, which places literals in a separate
25435 section in the output file unless @option{-mtext-section-literals} is
25436 used.  With @option{-mauto-litpools} the literals are interspersed in
25437 the text section by the assembler.  Compiler does not produce explicit
25438 @code{.literal} directives and loads literals into registers with
25439 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25440 do relaxation and place literals as necessary.  This option allows
25441 assembler to create several literal pools per function and assemble
25442 very big functions, which may not be possible with
25443 @option{-mtext-section-literals}.
25445 @item -mtarget-align
25446 @itemx -mno-target-align
25447 @opindex mtarget-align
25448 @opindex mno-target-align
25449 When this option is enabled, GCC instructs the assembler to
25450 automatically align instructions to reduce branch penalties at the
25451 expense of some code density.  The assembler attempts to widen density
25452 instructions to align branch targets and the instructions following call
25453 instructions.  If there are not enough preceding safe density
25454 instructions to align a target, no widening is performed.  The
25455 default is @option{-mtarget-align}.  These options do not affect the
25456 treatment of auto-aligned instructions like @code{LOOP}, which the
25457 assembler always aligns, either by widening density instructions or
25458 by inserting NOP instructions.
25460 @item -mlongcalls
25461 @itemx -mno-longcalls
25462 @opindex mlongcalls
25463 @opindex mno-longcalls
25464 When this option is enabled, GCC instructs the assembler to translate
25465 direct calls to indirect calls unless it can determine that the target
25466 of a direct call is in the range allowed by the call instruction.  This
25467 translation typically occurs for calls to functions in other source
25468 files.  Specifically, the assembler translates a direct @code{CALL}
25469 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25470 The default is @option{-mno-longcalls}.  This option should be used in
25471 programs where the call target can potentially be out of range.  This
25472 option is implemented in the assembler, not the compiler, so the
25473 assembly code generated by GCC still shows direct call
25474 instructions---look at the disassembled object code to see the actual
25475 instructions.  Note that the assembler uses an indirect call for
25476 every cross-file call, not just those that really are out of range.
25477 @end table
25479 @node zSeries Options
25480 @subsection zSeries Options
25481 @cindex zSeries options
25483 These are listed under @xref{S/390 and zSeries Options}.
25486 @c man end
25488 @node Spec Files
25489 @section Specifying Subprocesses and the Switches to Pass to Them
25490 @cindex Spec Files
25492 @command{gcc} is a driver program.  It performs its job by invoking a
25493 sequence of other programs to do the work of compiling, assembling and
25494 linking.  GCC interprets its command-line parameters and uses these to
25495 deduce which programs it should invoke, and which command-line options
25496 it ought to place on their command lines.  This behavior is controlled
25497 by @dfn{spec strings}.  In most cases there is one spec string for each
25498 program that GCC can invoke, but a few programs have multiple spec
25499 strings to control their behavior.  The spec strings built into GCC can
25500 be overridden by using the @option{-specs=} command-line switch to specify
25501 a spec file.
25503 @dfn{Spec files} are plain-text files that are used to construct spec
25504 strings.  They consist of a sequence of directives separated by blank
25505 lines.  The type of directive is determined by the first non-whitespace
25506 character on the line, which can be one of the following:
25508 @table @code
25509 @item %@var{command}
25510 Issues a @var{command} to the spec file processor.  The commands that can
25511 appear here are:
25513 @table @code
25514 @item %include <@var{file}>
25515 @cindex @code{%include}
25516 Search for @var{file} and insert its text at the current point in the
25517 specs file.
25519 @item %include_noerr <@var{file}>
25520 @cindex @code{%include_noerr}
25521 Just like @samp{%include}, but do not generate an error message if the include
25522 file cannot be found.
25524 @item %rename @var{old_name} @var{new_name}
25525 @cindex @code{%rename}
25526 Rename the spec string @var{old_name} to @var{new_name}.
25528 @end table
25530 @item *[@var{spec_name}]:
25531 This tells the compiler to create, override or delete the named spec
25532 string.  All lines after this directive up to the next directive or
25533 blank line are considered to be the text for the spec string.  If this
25534 results in an empty string then the spec is deleted.  (Or, if the
25535 spec did not exist, then nothing happens.)  Otherwise, if the spec
25536 does not currently exist a new spec is created.  If the spec does
25537 exist then its contents are overridden by the text of this
25538 directive, unless the first character of that text is the @samp{+}
25539 character, in which case the text is appended to the spec.
25541 @item [@var{suffix}]:
25542 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25543 and up to the next directive or blank line are considered to make up the
25544 spec string for the indicated suffix.  When the compiler encounters an
25545 input file with the named suffix, it processes the spec string in
25546 order to work out how to compile that file.  For example:
25548 @smallexample
25549 .ZZ:
25550 z-compile -input %i
25551 @end smallexample
25553 This says that any input file whose name ends in @samp{.ZZ} should be
25554 passed to the program @samp{z-compile}, which should be invoked with the
25555 command-line switch @option{-input} and with the result of performing the
25556 @samp{%i} substitution.  (See below.)
25558 As an alternative to providing a spec string, the text following a
25559 suffix directive can be one of the following:
25561 @table @code
25562 @item @@@var{language}
25563 This says that the suffix is an alias for a known @var{language}.  This is
25564 similar to using the @option{-x} command-line switch to GCC to specify a
25565 language explicitly.  For example:
25567 @smallexample
25568 .ZZ:
25569 @@c++
25570 @end smallexample
25572 Says that .ZZ files are, in fact, C++ source files.
25574 @item #@var{name}
25575 This causes an error messages saying:
25577 @smallexample
25578 @var{name} compiler not installed on this system.
25579 @end smallexample
25580 @end table
25582 GCC already has an extensive list of suffixes built into it.
25583 This directive adds an entry to the end of the list of suffixes, but
25584 since the list is searched from the end backwards, it is effectively
25585 possible to override earlier entries using this technique.
25587 @end table
25589 GCC has the following spec strings built into it.  Spec files can
25590 override these strings or create their own.  Note that individual
25591 targets can also add their own spec strings to this list.
25593 @smallexample
25594 asm          Options to pass to the assembler
25595 asm_final    Options to pass to the assembler post-processor
25596 cpp          Options to pass to the C preprocessor
25597 cc1          Options to pass to the C compiler
25598 cc1plus      Options to pass to the C++ compiler
25599 endfile      Object files to include at the end of the link
25600 link         Options to pass to the linker
25601 lib          Libraries to include on the command line to the linker
25602 libgcc       Decides which GCC support library to pass to the linker
25603 linker       Sets the name of the linker
25604 predefines   Defines to be passed to the C preprocessor
25605 signed_char  Defines to pass to CPP to say whether @code{char} is signed
25606              by default
25607 startfile    Object files to include at the start of the link
25608 @end smallexample
25610 Here is a small example of a spec file:
25612 @smallexample
25613 %rename lib                 old_lib
25615 *lib:
25616 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
25617 @end smallexample
25619 This example renames the spec called @samp{lib} to @samp{old_lib} and
25620 then overrides the previous definition of @samp{lib} with a new one.
25621 The new definition adds in some extra command-line options before
25622 including the text of the old definition.
25624 @dfn{Spec strings} are a list of command-line options to be passed to their
25625 corresponding program.  In addition, the spec strings can contain
25626 @samp{%}-prefixed sequences to substitute variable text or to
25627 conditionally insert text into the command line.  Using these constructs
25628 it is possible to generate quite complex command lines.
25630 Here is a table of all defined @samp{%}-sequences for spec
25631 strings.  Note that spaces are not generated automatically around the
25632 results of expanding these sequences.  Therefore you can concatenate them
25633 together or combine them with constant text in a single argument.
25635 @table @code
25636 @item %%
25637 Substitute one @samp{%} into the program name or argument.
25639 @item %i
25640 Substitute the name of the input file being processed.
25642 @item %b
25643 Substitute the basename of the input file being processed.
25644 This is the substring up to (and not including) the last period
25645 and not including the directory.
25647 @item %B
25648 This is the same as @samp{%b}, but include the file suffix (text after
25649 the last period).
25651 @item %d
25652 Marks the argument containing or following the @samp{%d} as a
25653 temporary file name, so that that file is deleted if GCC exits
25654 successfully.  Unlike @samp{%g}, this contributes no text to the
25655 argument.
25657 @item %g@var{suffix}
25658 Substitute a file name that has suffix @var{suffix} and is chosen
25659 once per compilation, and mark the argument in the same way as
25660 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
25661 name is now chosen in a way that is hard to predict even when previously
25662 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
25663 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
25664 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
25665 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
25666 was simply substituted with a file name chosen once per compilation,
25667 without regard to any appended suffix (which was therefore treated
25668 just like ordinary text), making such attacks more likely to succeed.
25670 @item %u@var{suffix}
25671 Like @samp{%g}, but generates a new temporary file name
25672 each time it appears instead of once per compilation.
25674 @item %U@var{suffix}
25675 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
25676 new one if there is no such last file name.  In the absence of any
25677 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
25678 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
25679 involves the generation of two distinct file names, one
25680 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
25681 simply substituted with a file name chosen for the previous @samp{%u},
25682 without regard to any appended suffix.
25684 @item %j@var{suffix}
25685 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
25686 writable, and if @option{-save-temps} is not used; 
25687 otherwise, substitute the name
25688 of a temporary file, just like @samp{%u}.  This temporary file is not
25689 meant for communication between processes, but rather as a junk
25690 disposal mechanism.
25692 @item %|@var{suffix}
25693 @itemx %m@var{suffix}
25694 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
25695 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
25696 all.  These are the two most common ways to instruct a program that it
25697 should read from standard input or write to standard output.  If you
25698 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
25699 construct: see for example @file{f/lang-specs.h}.
25701 @item %.@var{SUFFIX}
25702 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
25703 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
25704 terminated by the next space or %.
25706 @item %w
25707 Marks the argument containing or following the @samp{%w} as the
25708 designated output file of this compilation.  This puts the argument
25709 into the sequence of arguments that @samp{%o} substitutes.
25711 @item %o
25712 Substitutes the names of all the output files, with spaces
25713 automatically placed around them.  You should write spaces
25714 around the @samp{%o} as well or the results are undefined.
25715 @samp{%o} is for use in the specs for running the linker.
25716 Input files whose names have no recognized suffix are not compiled
25717 at all, but they are included among the output files, so they are
25718 linked.
25720 @item %O
25721 Substitutes the suffix for object files.  Note that this is
25722 handled specially when it immediately follows @samp{%g, %u, or %U},
25723 because of the need for those to form complete file names.  The
25724 handling is such that @samp{%O} is treated exactly as if it had already
25725 been substituted, except that @samp{%g, %u, and %U} do not currently
25726 support additional @var{suffix} characters following @samp{%O} as they do
25727 following, for example, @samp{.o}.
25729 @item %p
25730 Substitutes the standard macro predefinitions for the
25731 current target machine.  Use this when running @command{cpp}.
25733 @item %P
25734 Like @samp{%p}, but puts @samp{__} before and after the name of each
25735 predefined macro, except for macros that start with @samp{__} or with
25736 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
25739 @item %I
25740 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
25741 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
25742 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
25743 and @option{-imultilib} as necessary.
25745 @item %s
25746 Current argument is the name of a library or startup file of some sort.
25747 Search for that file in a standard list of directories and substitute
25748 the full name found.  The current working directory is included in the
25749 list of directories scanned.
25751 @item %T
25752 Current argument is the name of a linker script.  Search for that file
25753 in the current list of directories to scan for libraries. If the file
25754 is located insert a @option{--script} option into the command line
25755 followed by the full path name found.  If the file is not found then
25756 generate an error message.  Note: the current working directory is not
25757 searched.
25759 @item %e@var{str}
25760 Print @var{str} as an error message.  @var{str} is terminated by a newline.
25761 Use this when inconsistent options are detected.
25763 @item %(@var{name})
25764 Substitute the contents of spec string @var{name} at this point.
25766 @item %x@{@var{option}@}
25767 Accumulate an option for @samp{%X}.
25769 @item %X
25770 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
25771 spec string.
25773 @item %Y
25774 Output the accumulated assembler options specified by @option{-Wa}.
25776 @item %Z
25777 Output the accumulated preprocessor options specified by @option{-Wp}.
25779 @item %a
25780 Process the @code{asm} spec.  This is used to compute the
25781 switches to be passed to the assembler.
25783 @item %A
25784 Process the @code{asm_final} spec.  This is a spec string for
25785 passing switches to an assembler post-processor, if such a program is
25786 needed.
25788 @item %l
25789 Process the @code{link} spec.  This is the spec for computing the
25790 command line passed to the linker.  Typically it makes use of the
25791 @samp{%L %G %S %D and %E} sequences.
25793 @item %D
25794 Dump out a @option{-L} option for each directory that GCC believes might
25795 contain startup files.  If the target supports multilibs then the
25796 current multilib directory is prepended to each of these paths.
25798 @item %L
25799 Process the @code{lib} spec.  This is a spec string for deciding which
25800 libraries are included on the command line to the linker.
25802 @item %G
25803 Process the @code{libgcc} spec.  This is a spec string for deciding
25804 which GCC support library is included on the command line to the linker.
25806 @item %S
25807 Process the @code{startfile} spec.  This is a spec for deciding which
25808 object files are the first ones passed to the linker.  Typically
25809 this might be a file named @file{crt0.o}.
25811 @item %E
25812 Process the @code{endfile} spec.  This is a spec string that specifies
25813 the last object files that are passed to the linker.
25815 @item %C
25816 Process the @code{cpp} spec.  This is used to construct the arguments
25817 to be passed to the C preprocessor.
25819 @item %1
25820 Process the @code{cc1} spec.  This is used to construct the options to be
25821 passed to the actual C compiler (@command{cc1}).
25823 @item %2
25824 Process the @code{cc1plus} spec.  This is used to construct the options to be
25825 passed to the actual C++ compiler (@command{cc1plus}).
25827 @item %*
25828 Substitute the variable part of a matched option.  See below.
25829 Note that each comma in the substituted string is replaced by
25830 a single space.
25832 @item %<@code{S}
25833 Remove all occurrences of @code{-S} from the command line.  Note---this
25834 command is position dependent.  @samp{%} commands in the spec string
25835 before this one see @code{-S}, @samp{%} commands in the spec string
25836 after this one do not.
25838 @item %:@var{function}(@var{args})
25839 Call the named function @var{function}, passing it @var{args}.
25840 @var{args} is first processed as a nested spec string, then split
25841 into an argument vector in the usual fashion.  The function returns
25842 a string which is processed as if it had appeared literally as part
25843 of the current spec.
25845 The following built-in spec functions are provided:
25847 @table @code
25848 @item @code{getenv}
25849 The @code{getenv} spec function takes two arguments: an environment
25850 variable name and a string.  If the environment variable is not
25851 defined, a fatal error is issued.  Otherwise, the return value is the
25852 value of the environment variable concatenated with the string.  For
25853 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
25855 @smallexample
25856 %:getenv(TOPDIR /include)
25857 @end smallexample
25859 expands to @file{/path/to/top/include}.
25861 @item @code{if-exists}
25862 The @code{if-exists} spec function takes one argument, an absolute
25863 pathname to a file.  If the file exists, @code{if-exists} returns the
25864 pathname.  Here is a small example of its usage:
25866 @smallexample
25867 *startfile:
25868 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
25869 @end smallexample
25871 @item @code{if-exists-else}
25872 The @code{if-exists-else} spec function is similar to the @code{if-exists}
25873 spec function, except that it takes two arguments.  The first argument is
25874 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
25875 returns the pathname.  If it does not exist, it returns the second argument.
25876 This way, @code{if-exists-else} can be used to select one file or another,
25877 based on the existence of the first.  Here is a small example of its usage:
25879 @smallexample
25880 *startfile:
25881 crt0%O%s %:if-exists(crti%O%s) \
25882 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
25883 @end smallexample
25885 @item @code{replace-outfile}
25886 The @code{replace-outfile} spec function takes two arguments.  It looks for the
25887 first argument in the outfiles array and replaces it with the second argument.  Here
25888 is a small example of its usage:
25890 @smallexample
25891 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
25892 @end smallexample
25894 @item @code{remove-outfile}
25895 The @code{remove-outfile} spec function takes one argument.  It looks for the
25896 first argument in the outfiles array and removes it.  Here is a small example
25897 its usage:
25899 @smallexample
25900 %:remove-outfile(-lm)
25901 @end smallexample
25903 @item @code{pass-through-libs}
25904 The @code{pass-through-libs} spec function takes any number of arguments.  It
25905 finds any @option{-l} options and any non-options ending in @file{.a} (which it
25906 assumes are the names of linker input library archive files) and returns a
25907 result containing all the found arguments each prepended by
25908 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
25909 intended to be passed to the LTO linker plugin.
25911 @smallexample
25912 %:pass-through-libs(%G %L %G)
25913 @end smallexample
25915 @item @code{print-asm-header}
25916 The @code{print-asm-header} function takes no arguments and simply
25917 prints a banner like:
25919 @smallexample
25920 Assembler options
25921 =================
25923 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
25924 @end smallexample
25926 It is used to separate compiler options from assembler options
25927 in the @option{--target-help} output.
25928 @end table
25930 @item %@{@code{S}@}
25931 Substitutes the @code{-S} switch, if that switch is given to GCC@.
25932 If that switch is not specified, this substitutes nothing.  Note that
25933 the leading dash is omitted when specifying this option, and it is
25934 automatically inserted if the substitution is performed.  Thus the spec
25935 string @samp{%@{foo@}} matches the command-line option @option{-foo}
25936 and outputs the command-line option @option{-foo}.
25938 @item %W@{@code{S}@}
25939 Like %@{@code{S}@} but mark last argument supplied within as a file to be
25940 deleted on failure.
25942 @item %@{@code{S}*@}
25943 Substitutes all the switches specified to GCC whose names start
25944 with @code{-S}, but which also take an argument.  This is used for
25945 switches like @option{-o}, @option{-D}, @option{-I}, etc.
25946 GCC considers @option{-o foo} as being
25947 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
25948 text, including the space.  Thus two arguments are generated.
25950 @item %@{@code{S}*&@code{T}*@}
25951 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
25952 (the order of @code{S} and @code{T} in the spec is not significant).
25953 There can be any number of ampersand-separated variables; for each the
25954 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
25956 @item %@{@code{S}:@code{X}@}
25957 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
25959 @item %@{!@code{S}:@code{X}@}
25960 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
25962 @item %@{@code{S}*:@code{X}@}
25963 Substitutes @code{X} if one or more switches whose names start with
25964 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
25965 once, no matter how many such switches appeared.  However, if @code{%*}
25966 appears somewhere in @code{X}, then @code{X} is substituted once
25967 for each matching switch, with the @code{%*} replaced by the part of
25968 that switch matching the @code{*}.
25970 If @code{%*} appears as the last part of a spec sequence then a space
25971 is added after the end of the last substitution.  If there is more
25972 text in the sequence, however, then a space is not generated.  This
25973 allows the @code{%*} substitution to be used as part of a larger
25974 string.  For example, a spec string like this:
25976 @smallexample
25977 %@{mcu=*:--script=%*/memory.ld@}
25978 @end smallexample
25980 @noindent
25981 when matching an option like @option{-mcu=newchip} produces:
25983 @smallexample
25984 --script=newchip/memory.ld
25985 @end smallexample
25987 @item %@{.@code{S}:@code{X}@}
25988 Substitutes @code{X}, if processing a file with suffix @code{S}.
25990 @item %@{!.@code{S}:@code{X}@}
25991 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
25993 @item %@{,@code{S}:@code{X}@}
25994 Substitutes @code{X}, if processing a file for language @code{S}.
25996 @item %@{!,@code{S}:@code{X}@}
25997 Substitutes @code{X}, if not processing a file for language @code{S}.
25999 @item %@{@code{S}|@code{P}:@code{X}@}
26000 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26001 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26002 @code{*} sequences as well, although they have a stronger binding than
26003 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26004 alternatives must be starred, and only the first matching alternative
26005 is substituted.
26007 For example, a spec string like this:
26009 @smallexample
26010 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26011 @end smallexample
26013 @noindent
26014 outputs the following command-line options from the following input
26015 command-line options:
26017 @smallexample
26018 fred.c        -foo -baz
26019 jim.d         -bar -boggle
26020 -d fred.c     -foo -baz -boggle
26021 -d jim.d      -bar -baz -boggle
26022 @end smallexample
26024 @item %@{S:X; T:Y; :D@}
26026 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26027 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26028 be as many clauses as you need.  This may be combined with @code{.},
26029 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26032 @end table
26034 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26035 construct may contain other nested @samp{%} constructs or spaces, or
26036 even newlines.  They are processed as usual, as described above.
26037 Trailing white space in @code{X} is ignored.  White space may also
26038 appear anywhere on the left side of the colon in these constructs,
26039 except between @code{.} or @code{*} and the corresponding word.
26041 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26042 handled specifically in these constructs.  If another value of
26043 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26044 @option{-W} switch is found later in the command line, the earlier
26045 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26046 just one letter, which passes all matching options.
26048 The character @samp{|} at the beginning of the predicate text is used to
26049 indicate that a command should be piped to the following command, but
26050 only if @option{-pipe} is specified.
26052 It is built into GCC which switches take arguments and which do not.
26053 (You might think it would be useful to generalize this to allow each
26054 compiler's spec to say which switches take arguments.  But this cannot
26055 be done in a consistent fashion.  GCC cannot even decide which input
26056 files have been specified without knowing which switches take arguments,
26057 and it must know which input files to compile in order to tell which
26058 compilers to run).
26060 GCC also knows implicitly that arguments starting in @option{-l} are to be
26061 treated as compiler output files, and passed to the linker in their
26062 proper position among the other output files.
26064 @node Environment Variables
26065 @section Environment Variables Affecting GCC
26066 @cindex environment variables
26068 @c man begin ENVIRONMENT
26069 This section describes several environment variables that affect how GCC
26070 operates.  Some of them work by specifying directories or prefixes to use
26071 when searching for various kinds of files.  Some are used to specify other
26072 aspects of the compilation environment.
26074 Note that you can also specify places to search using options such as
26075 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26076 take precedence over places specified using environment variables, which
26077 in turn take precedence over those specified by the configuration of GCC@.
26078 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26079 GNU Compiler Collection (GCC) Internals}.
26081 @table @env
26082 @item LANG
26083 @itemx LC_CTYPE
26084 @c @itemx LC_COLLATE
26085 @itemx LC_MESSAGES
26086 @c @itemx LC_MONETARY
26087 @c @itemx LC_NUMERIC
26088 @c @itemx LC_TIME
26089 @itemx LC_ALL
26090 @findex LANG
26091 @findex LC_CTYPE
26092 @c @findex LC_COLLATE
26093 @findex LC_MESSAGES
26094 @c @findex LC_MONETARY
26095 @c @findex LC_NUMERIC
26096 @c @findex LC_TIME
26097 @findex LC_ALL
26098 @cindex locale
26099 These environment variables control the way that GCC uses
26100 localization information which allows GCC to work with different
26101 national conventions.  GCC inspects the locale categories
26102 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26103 so.  These locale categories can be set to any value supported by your
26104 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26105 Kingdom encoded in UTF-8.
26107 The @env{LC_CTYPE} environment variable specifies character
26108 classification.  GCC uses it to determine the character boundaries in
26109 a string; this is needed for some multibyte encodings that contain quote
26110 and escape characters that are otherwise interpreted as a string
26111 end or escape.
26113 The @env{LC_MESSAGES} environment variable specifies the language to
26114 use in diagnostic messages.
26116 If the @env{LC_ALL} environment variable is set, it overrides the value
26117 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26118 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26119 environment variable.  If none of these variables are set, GCC
26120 defaults to traditional C English behavior.
26122 @item TMPDIR
26123 @findex TMPDIR
26124 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26125 files.  GCC uses temporary files to hold the output of one stage of
26126 compilation which is to be used as input to the next stage: for example,
26127 the output of the preprocessor, which is the input to the compiler
26128 proper.
26130 @item GCC_COMPARE_DEBUG
26131 @findex GCC_COMPARE_DEBUG
26132 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26133 @option{-fcompare-debug} to the compiler driver.  See the documentation
26134 of this option for more details.
26136 @item GCC_EXEC_PREFIX
26137 @findex GCC_EXEC_PREFIX
26138 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26139 names of the subprograms executed by the compiler.  No slash is added
26140 when this prefix is combined with the name of a subprogram, but you can
26141 specify a prefix that ends with a slash if you wish.
26143 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26144 an appropriate prefix to use based on the pathname it is invoked with.
26146 If GCC cannot find the subprogram using the specified prefix, it
26147 tries looking in the usual places for the subprogram.
26149 The default value of @env{GCC_EXEC_PREFIX} is
26150 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26151 the installed compiler. In many cases @var{prefix} is the value
26152 of @code{prefix} when you ran the @file{configure} script.
26154 Other prefixes specified with @option{-B} take precedence over this prefix.
26156 This prefix is also used for finding files such as @file{crt0.o} that are
26157 used for linking.
26159 In addition, the prefix is used in an unusual way in finding the
26160 directories to search for header files.  For each of the standard
26161 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26162 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26163 replacing that beginning with the specified prefix to produce an
26164 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26165 @file{foo/bar} just before it searches the standard directory 
26166 @file{/usr/local/lib/bar}.
26167 If a standard directory begins with the configured
26168 @var{prefix} then the value of @var{prefix} is replaced by
26169 @env{GCC_EXEC_PREFIX} when looking for header files.
26171 @item COMPILER_PATH
26172 @findex COMPILER_PATH
26173 The value of @env{COMPILER_PATH} is a colon-separated list of
26174 directories, much like @env{PATH}.  GCC tries the directories thus
26175 specified when searching for subprograms, if it can't find the
26176 subprograms using @env{GCC_EXEC_PREFIX}.
26178 @item LIBRARY_PATH
26179 @findex LIBRARY_PATH
26180 The value of @env{LIBRARY_PATH} is a colon-separated list of
26181 directories, much like @env{PATH}.  When configured as a native compiler,
26182 GCC tries the directories thus specified when searching for special
26183 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
26184 using GCC also uses these directories when searching for ordinary
26185 libraries for the @option{-l} option (but directories specified with
26186 @option{-L} come first).
26188 @item LANG
26189 @findex LANG
26190 @cindex locale definition
26191 This variable is used to pass locale information to the compiler.  One way in
26192 which this information is used is to determine the character set to be used
26193 when character literals, string literals and comments are parsed in C and C++.
26194 When the compiler is configured to allow multibyte characters,
26195 the following values for @env{LANG} are recognized:
26197 @table @samp
26198 @item C-JIS
26199 Recognize JIS characters.
26200 @item C-SJIS
26201 Recognize SJIS characters.
26202 @item C-EUCJP
26203 Recognize EUCJP characters.
26204 @end table
26206 If @env{LANG} is not defined, or if it has some other value, then the
26207 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26208 recognize and translate multibyte characters.
26209 @end table
26211 @noindent
26212 Some additional environment variables affect the behavior of the
26213 preprocessor.
26215 @include cppenv.texi
26217 @c man end
26219 @node Precompiled Headers
26220 @section Using Precompiled Headers
26221 @cindex precompiled headers
26222 @cindex speed of compilation
26224 Often large projects have many header files that are included in every
26225 source file.  The time the compiler takes to process these header files
26226 over and over again can account for nearly all of the time required to
26227 build the project.  To make builds faster, GCC allows you to
26228 @dfn{precompile} a header file.
26230 To create a precompiled header file, simply compile it as you would any
26231 other file, if necessary using the @option{-x} option to make the driver
26232 treat it as a C or C++ header file.  You may want to use a
26233 tool like @command{make} to keep the precompiled header up-to-date when
26234 the headers it contains change.
26236 A precompiled header file is searched for when @code{#include} is
26237 seen in the compilation.  As it searches for the included file
26238 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26239 compiler looks for a precompiled header in each directory just before it
26240 looks for the include file in that directory.  The name searched for is
26241 the name specified in the @code{#include} with @samp{.gch} appended.  If
26242 the precompiled header file can't be used, it is ignored.
26244 For instance, if you have @code{#include "all.h"}, and you have
26245 @file{all.h.gch} in the same directory as @file{all.h}, then the
26246 precompiled header file is used if possible, and the original
26247 header is used otherwise.
26249 Alternatively, you might decide to put the precompiled header file in a
26250 directory and use @option{-I} to ensure that directory is searched
26251 before (or instead of) the directory containing the original header.
26252 Then, if you want to check that the precompiled header file is always
26253 used, you can put a file of the same name as the original header in this
26254 directory containing an @code{#error} command.
26256 This also works with @option{-include}.  So yet another way to use
26257 precompiled headers, good for projects not designed with precompiled
26258 header files in mind, is to simply take most of the header files used by
26259 a project, include them from another header file, precompile that header
26260 file, and @option{-include} the precompiled header.  If the header files
26261 have guards against multiple inclusion, they are skipped because
26262 they've already been included (in the precompiled header).
26264 If you need to precompile the same header file for different
26265 languages, targets, or compiler options, you can instead make a
26266 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26267 header in the directory, perhaps using @option{-o}.  It doesn't matter
26268 what you call the files in the directory; every precompiled header in
26269 the directory is considered.  The first precompiled header
26270 encountered in the directory that is valid for this compilation is
26271 used; they're searched in no particular order.
26273 There are many other possibilities, limited only by your imagination,
26274 good sense, and the constraints of your build system.
26276 A precompiled header file can be used only when these conditions apply:
26278 @itemize
26279 @item
26280 Only one precompiled header can be used in a particular compilation.
26282 @item
26283 A precompiled header can't be used once the first C token is seen.  You
26284 can have preprocessor directives before a precompiled header; you cannot
26285 include a precompiled header from inside another header.
26287 @item
26288 The precompiled header file must be produced for the same language as
26289 the current compilation.  You can't use a C precompiled header for a C++
26290 compilation.
26292 @item
26293 The precompiled header file must have been produced by the same compiler
26294 binary as the current compilation is using.
26296 @item
26297 Any macros defined before the precompiled header is included must
26298 either be defined in the same way as when the precompiled header was
26299 generated, or must not affect the precompiled header, which usually
26300 means that they don't appear in the precompiled header at all.
26302 The @option{-D} option is one way to define a macro before a
26303 precompiled header is included; using a @code{#define} can also do it.
26304 There are also some options that define macros implicitly, like
26305 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26306 defined this way.
26308 @item If debugging information is output when using the precompiled
26309 header, using @option{-g} or similar, the same kind of debugging information
26310 must have been output when building the precompiled header.  However,
26311 a precompiled header built using @option{-g} can be used in a compilation
26312 when no debugging information is being output.
26314 @item The same @option{-m} options must generally be used when building
26315 and using the precompiled header.  @xref{Submodel Options},
26316 for any cases where this rule is relaxed.
26318 @item Each of the following options must be the same when building and using
26319 the precompiled header:
26321 @gccoptlist{-fexceptions}
26323 @item
26324 Some other command-line options starting with @option{-f},
26325 @option{-p}, or @option{-O} must be defined in the same way as when
26326 the precompiled header was generated.  At present, it's not clear
26327 which options are safe to change and which are not; the safest choice
26328 is to use exactly the same options when generating and using the
26329 precompiled header.  The following are known to be safe:
26331 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26332 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26333 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26334 -pedantic-errors}
26336 @end itemize
26338 For all of these except the last, the compiler automatically
26339 ignores the precompiled header if the conditions aren't met.  If you
26340 find an option combination that doesn't work and doesn't cause the
26341 precompiled header to be ignored, please consider filing a bug report,
26342 see @ref{Bugs}.
26344 If you do use differing options when generating and using the
26345 precompiled header, the actual behavior is a mixture of the
26346 behavior for the options.  For instance, if you use @option{-g} to
26347 generate the precompiled header but not when using it, you may or may
26348 not get debugging information for routines in the precompiled header.