x86: Enable -fcf-protection with multi-byte NOPs
[official-gcc.git] / gcc / doc / invoke.texi
blob09a2472be0992d3efa48f950b21150892844ef2f
1 @c Copyright (C) 1988-2018 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-2018 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), dbx(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}  -ffile-prefix-map=@var{old}=@var{new}  @gol
176 -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
177 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
179 @item C Language Options
180 @xref{C Dialect Options,,Options Controlling C Dialect}.
181 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
182 -fpermitted-flt-eval-methods=@var{standard} @gol
183 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
184 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
185 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
186 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
187 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
188 -fsigned-bitfields  -fsigned-char @gol
189 -funsigned-bitfields  -funsigned-char}
191 @item C++ Language Options
192 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
193 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
194 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
195 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
196 -ffriend-injection @gol
197 -fno-elide-constructors @gol
198 -fno-enforce-eh-specs @gol
199 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
200 -fno-implicit-templates @gol
201 -fno-implicit-inline-templates @gol
202 -fno-implement-inlines  -fms-extensions @gol
203 -fnew-inheriting-ctors @gol
204 -fnew-ttp-matching @gol
205 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
206 -fno-optional-diags  -fpermissive @gol
207 -fno-pretty-templates @gol
208 -frepo  -fno-rtti  -fsized-deallocation @gol
209 -ftemplate-backtrace-limit=@var{n} @gol
210 -ftemplate-depth=@var{n} @gol
211 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
212 -fno-weak  -nostdinc++ @gol
213 -fvisibility-inlines-hidden @gol
214 -fvisibility-ms-compat @gol
215 -fext-numeric-literals @gol
216 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
217 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
218 -Wnamespaces  -Wnarrowing @gol
219 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
220 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
221 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
222 -Wno-non-template-friend  -Wold-style-cast @gol
223 -Woverloaded-virtual  -Wno-pmf-conversions @gol
224 -Wsign-promo  -Wvirtual-inheritance}
226 @item Objective-C and Objective-C++ Language Options
227 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
228 Objective-C and Objective-C++ Dialects}.
229 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
230 -fgnu-runtime  -fnext-runtime @gol
231 -fno-nil-receivers @gol
232 -fobjc-abi-version=@var{n} @gol
233 -fobjc-call-cxx-cdtors @gol
234 -fobjc-direct-dispatch @gol
235 -fobjc-exceptions @gol
236 -fobjc-gc @gol
237 -fobjc-nilcheck @gol
238 -fobjc-std=objc1 @gol
239 -fno-local-ivars @gol
240 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
241 -freplace-objc-classes @gol
242 -fzero-link @gol
243 -gen-decls @gol
244 -Wassign-intercept @gol
245 -Wno-protocol  -Wselector @gol
246 -Wstrict-selector-match @gol
247 -Wundeclared-selector}
249 @item Diagnostic Message Formatting Options
250 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
251 @gccoptlist{-fmessage-length=@var{n}  @gol
252 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
253 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
254 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
255 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
256 -fdiagnostics-show-template-tree -fno-elide-type @gol
257 -fno-show-column}
259 @item Warning Options
260 @xref{Warning Options,,Options to Request or Suppress Warnings}.
261 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
262 -pedantic-errors @gol
263 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
264 -Walloc-zero  -Walloc-size-larger-than=@var{n}
265 -Walloca  -Walloca-larger-than=@var{n} @gol
266 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
267 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
268 -Wno-builtin-declaration-mismatch @gol
269 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
270 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
271 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
272 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
273 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
274 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
275 -Wdelete-incomplete @gol
276 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
277 -Wdisabled-optimization @gol
278 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
279 -Wno-div-by-zero  -Wdouble-promotion @gol
280 -Wduplicated-branches  -Wduplicated-cond @gol
281 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
282 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
283 -Wfloat-equal  -Wformat  -Wformat=2 @gol
284 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
285 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
286 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
287 -Wformat-y2k  -Wframe-address @gol
288 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
289 -Wif-not-aligned @gol
290 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
291 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
292 -Wimplicit-function-declaration  -Wimplicit-int @gol
293 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
294 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
295 -Winvalid-pch  -Wlarger-than=@var{len} @gol
296 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
297 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
298 -Wmisleading-indentation  -Wmissing-attributes -Wmissing-braces @gol
299 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
300 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
301 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
302 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
303 -Woverride-init-side-effects  -Woverlength-strings @gol
304 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
305 -Wparentheses  -Wno-pedantic-ms-format @gol
306 -Wplacement-new  -Wplacement-new=@var{n} @gol
307 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
308 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
309 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
310 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
311 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
312 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
313 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
314 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
315 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
316 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
317 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
318 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
319 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
320 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
321 -Wmissing-format-attribute  -Wsubobject-linkage @gol
322 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
323 -Wswitch-unreachable  -Wsync-nand @gol
324 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
325 -Wtype-limits  -Wundef @gol
326 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
327 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
328 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
329 -Wunused-parameter  -Wno-unused-result @gol
330 -Wunused-value  -Wunused-variable @gol
331 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
332 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
333 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
334 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
335 -Wzero-as-null-pointer-constant  -Whsa}
337 @item C and Objective-C-only Warning Options
338 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
339 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
340 -Wold-style-declaration  -Wold-style-definition @gol
341 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
342 -Wdeclaration-after-statement  -Wpointer-sign}
344 @item Debugging Options
345 @xref{Debugging Options,,Options for Debugging Your Program}.
346 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
347 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
348 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
349 -gas-loc-support  -gno-as-loc-support @gol
350 -gas-locview-support  -gno-as-locview-support @gol
351 -gcolumn-info  -gno-column-info @gol
352 -gstatement-frontiers  -gno-statement-frontiers @gol
353 -gvariable-location-views  -gno-variable-location-views @gol
354 -ginternal-reset-location-views  -gno-internal-reset-location-views @gol
355 -ginline-points  -gno-inline-points @gol
356 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
357 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
358 -fno-eliminate-unused-debug-types @gol
359 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
360 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
361 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
362 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
363 -fvar-tracking  -fvar-tracking-assignments}
365 @item Optimization Options
366 @xref{Optimize Options,,Options that Control Optimization}.
367 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
368 -falign-jumps[=@var{n}] @gol
369 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
370 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
371 -fauto-inc-dec  -fbranch-probabilities @gol
372 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
373 -fbtr-bb-exclusive  -fcaller-saves @gol
374 -fcombine-stack-adjustments  -fconserve-stack @gol
375 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
376 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
377 -fcx-limited-range @gol
378 -fdata-sections  -fdce  -fdelayed-branch @gol
379 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
380 -fdevirtualize-at-ltrans  -fdse @gol
381 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
382 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
383 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
384 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
385 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
386 -fif-conversion2  -findirect-inlining @gol
387 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
388 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
389 -fipa-bit-cp -fipa-vrp @gol
390 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
391 -fira-algorithm=@var{algorithm} @gol
392 -fira-region=@var{region}  -fira-hoist-pressure @gol
393 -fira-loop-pressure  -fno-ira-share-save-slots @gol
394 -fno-ira-share-spill-slots @gol
395 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
396 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
397 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
398 -floop-block  -floop-interchange  -floop-strip-mine @gol
399 -floop-unroll-and-jam  -floop-nest-optimize @gol
400 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
401 -flto-partition=@var{alg}  -fmerge-all-constants @gol
402 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
403 -fmove-loop-invariants  -fno-branch-count-reg @gol
404 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
405 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
406 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
407 -fno-sched-spec  -fno-signed-zeros @gol
408 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
409 -fomit-frame-pointer  -foptimize-sibling-calls @gol
410 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
411 -fprefetch-loop-arrays @gol
412 -fprofile-correction @gol
413 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
414 -fprofile-reorder-functions @gol
415 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
416 -freorder-blocks-algorithm=@var{algorithm} @gol
417 -freorder-blocks-and-partition  -freorder-functions @gol
418 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
419 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
420 -fsched-spec-load  -fsched-spec-load-dangerous @gol
421 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
422 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
423 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
424 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
425 -fschedule-fusion @gol
426 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
427 -fselective-scheduling  -fselective-scheduling2 @gol
428 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
429 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
430 -fsignaling-nans @gol
431 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
432 -fsplit-paths @gol
433 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
434 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
435 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
436 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
437 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
438 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
439 -ftree-loop-if-convert  -ftree-loop-im @gol
440 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
441 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
442 -ftree-loop-vectorize @gol
443 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
444 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
445 -ftree-switch-conversion  -ftree-tail-merge @gol
446 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
447 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
448 -funsafe-math-optimizations  -funswitch-loops @gol
449 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
450 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
451 --param @var{name}=@var{value}
452 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
454 @item Program Instrumentation Options
455 @xref{Instrumentation Options,,Program Instrumentation Options}.
456 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
457 -fprofile-abs-path @gol
458 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
459 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
460 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
461 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
462 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
463 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
464 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
465 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
466 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
467 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
468 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
469 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
470 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
471 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
472 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
473 -fstack-protector-explicit  -fstack-check @gol
474 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
475 -fno-stack-limit  -fsplit-stack @gol
476 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
477 -fvtv-counts  -fvtv-debug @gol
478 -finstrument-functions @gol
479 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
480 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
482 @item Preprocessor Options
483 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
484 @gccoptlist{-A@var{question}=@var{answer} @gol
485 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
486 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
487 -dD  -dI  -dM  -dN  -dU @gol
488 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
489 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
490 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
491 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
492 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
493 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
494 -H  -imacros @var{file}  -include @var{file} @gol
495 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
496 -no-integrated-cpp  -P  -pthread  -remap @gol
497 -traditional  -traditional-cpp  -trigraphs @gol
498 -U@var{macro}  -undef  @gol
499 -Wp,@var{option}  -Xpreprocessor @var{option}}
501 @item Assembler Options
502 @xref{Assembler Options,,Passing Options to the Assembler}.
503 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
505 @item Linker Options
506 @xref{Link Options,,Options for Linking}.
507 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
508 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
509 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
510 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
511 -static-libmpx  -static-libmpxwrappers @gol
512 -shared  -shared-libgcc  -symbolic @gol
513 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
514 -u @var{symbol}  -z @var{keyword}}
516 @item Directory Options
517 @xref{Directory Options,,Options for Directory Search}.
518 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
519 -idirafter @var{dir} @gol
520 -imacros @var{file}  -imultilib @var{dir} @gol
521 -iplugindir=@var{dir}  -iprefix @var{file} @gol
522 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
523 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
524 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
525 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
527 @item Code Generation Options
528 @xref{Code Gen Options,,Options for Code Generation Conventions}.
529 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
530 -ffixed-@var{reg}  -fexceptions @gol
531 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
532 -fasynchronous-unwind-tables @gol
533 -fno-gnu-unique @gol
534 -finhibit-size-directive  -fno-common  -fno-ident @gol
535 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
536 -fno-jump-tables @gol
537 -frecord-gcc-switches @gol
538 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
539 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
540 -fleading-underscore  -ftls-model=@var{model} @gol
541 -fstack-reuse=@var{reuse_level} @gol
542 -ftrampolines  -ftrapv  -fwrapv @gol
543 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
544 -fstrict-volatile-bitfields  -fsync-libcalls}
546 @item Developer Options
547 @xref{Developer Options,,GCC Developer Options}.
548 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
549 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
550 -fdbg-cnt=@var{counter-value-list} @gol
551 -fdisable-ipa-@var{pass_name} @gol
552 -fdisable-rtl-@var{pass_name} @gol
553 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
554 -fdisable-tree-@var{pass_name} @gol
555 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
556 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
557 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
558 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
559 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
560 -fdump-lang-all @gol
561 -fdump-lang-@var{switch} @gol
562 -fdump-lang-@var{switch}-@var{options} @gol
563 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
564 -fdump-passes @gol
565 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
566 -fdump-statistics @gol
567 -fdump-tree-all @gol
568 -fdump-tree-@var{switch} @gol
569 -fdump-tree-@var{switch}-@var{options} @gol
570 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
571 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
572 -fenable-@var{kind}-@var{pass} @gol
573 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
574 -fira-verbose=@var{n} @gol
575 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
576 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
577 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
578 -fprofile-report @gol
579 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
580 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
581 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
582 -fvar-tracking-assignments-toggle  -gtoggle @gol
583 -print-file-name=@var{library}  -print-libgcc-file-name @gol
584 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
585 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
586 -print-sysroot  -print-sysroot-headers-suffix @gol
587 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
589 @item Machine-Dependent Options
590 @xref{Submodel Options,,Machine-Dependent Options}.
591 @c This list is ordered alphanumerically by subsection name.
592 @c Try and put the significant identifier (CPU or system) first,
593 @c so users have a clue at guessing where the ones they want will be.
595 @emph{AArch64 Options}
596 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
597 -mgeneral-regs-only @gol
598 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
599 -mstrict-align @gol
600 -momit-leaf-frame-pointer @gol
601 -mtls-dialect=desc  -mtls-dialect=traditional @gol
602 -mtls-size=@var{size} @gol
603 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
604 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
605 -mpc-relative-literal-loads @gol
606 -msign-return-address=@var{scope} @gol
607 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
608 -moverride=@var{string}  -mverbose-cost-dump}
610 @emph{Adapteva Epiphany Options}
611 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
612 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
613 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
614 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
615 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
616 -msplit-vecmove-early  -m1reg-@var{reg}}
618 @emph{ARC Options}
619 @gccoptlist{-mbarrel-shifter -mjli-always @gol
620 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
621 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
622 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
623 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
624 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
625 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
626 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
627 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
628 -mvolatile-cache  -mtp-regno=@var{regno} @gol
629 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
630 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
631 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
632 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
633 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
634 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
635 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
636 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16}
638 @emph{ARM Options}
639 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
640 -mabi=@var{name} @gol
641 -mapcs-stack-check  -mno-apcs-stack-check @gol
642 -mapcs-reentrant  -mno-apcs-reentrant @gol
643 -msched-prolog  -mno-sched-prolog @gol
644 -mlittle-endian  -mbig-endian @gol
645 -mbe8 -mbe32 @gol
646 -mfloat-abi=@var{name} @gol
647 -mfp16-format=@var{name}
648 -mthumb-interwork  -mno-thumb-interwork @gol
649 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
650 -mtune=@var{name}  -mprint-tune-info @gol
651 -mstructure-size-boundary=@var{n} @gol
652 -mabort-on-noreturn @gol
653 -mlong-calls  -mno-long-calls @gol
654 -msingle-pic-base  -mno-single-pic-base @gol
655 -mpic-register=@var{reg} @gol
656 -mnop-fun-dllimport @gol
657 -mpoke-function-name @gol
658 -mthumb  -marm  -mflip-thumb @gol
659 -mtpcs-frame  -mtpcs-leaf-frame @gol
660 -mcaller-super-interworking  -mcallee-super-interworking @gol
661 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
662 -mword-relocations @gol
663 -mfix-cortex-m3-ldrd @gol
664 -munaligned-access @gol
665 -mneon-for-64bits @gol
666 -mslow-flash-data @gol
667 -masm-syntax-unified @gol
668 -mrestrict-it @gol
669 -mverbose-cost-dump @gol
670 -mpure-code @gol
671 -mcmse}
673 @emph{AVR Options}
674 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
675 -mbranch-cost=@var{cost} @gol
676 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
677 -mn_flash=@var{size}  -mno-interrupts @gol
678 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
679 -mfract-convert-truncate @gol
680 -mshort-calls  -nodevicelib @gol
681 -Waddr-space-convert  -Wmisspelled-isr}
683 @emph{Blackfin Options}
684 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
685 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
686 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
687 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
688 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
689 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
690 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
691 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
692 -micplb}
694 @emph{C6X Options}
695 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
696 -msim  -msdata=@var{sdata-type}}
698 @emph{CRIS Options}
699 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
700 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
701 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
702 -mstack-align  -mdata-align  -mconst-align @gol
703 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
704 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
705 -mmul-bug-workaround  -mno-mul-bug-workaround}
707 @emph{CR16 Options}
708 @gccoptlist{-mmac @gol
709 -mcr16cplus  -mcr16c @gol
710 -msim  -mint32  -mbit-ops
711 -mdata-model=@var{model}}
713 @emph{Darwin Options}
714 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
715 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
716 -client_name  -compatibility_version  -current_version @gol
717 -dead_strip @gol
718 -dependency-file  -dylib_file  -dylinker_install_name @gol
719 -dynamic  -dynamiclib  -exported_symbols_list @gol
720 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
721 -force_flat_namespace  -headerpad_max_install_names @gol
722 -iframework @gol
723 -image_base  -init  -install_name  -keep_private_externs @gol
724 -multi_module  -multiply_defined  -multiply_defined_unused @gol
725 -noall_load   -no_dead_strip_inits_and_terms @gol
726 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
727 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
728 -private_bundle  -read_only_relocs  -sectalign @gol
729 -sectobjectsymbols  -whyload  -seg1addr @gol
730 -sectcreate  -sectobjectsymbols  -sectorder @gol
731 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
732 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
733 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
734 -single_module  -static  -sub_library  -sub_umbrella @gol
735 -twolevel_namespace  -umbrella  -undefined @gol
736 -unexported_symbols_list  -weak_reference_mismatches @gol
737 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
738 -mkernel  -mone-byte-bool}
740 @emph{DEC Alpha Options}
741 @gccoptlist{-mno-fp-regs  -msoft-float @gol
742 -mieee  -mieee-with-inexact  -mieee-conformant @gol
743 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
744 -mtrap-precision=@var{mode}  -mbuild-constants @gol
745 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
746 -mbwx  -mmax  -mfix  -mcix @gol
747 -mfloat-vax  -mfloat-ieee @gol
748 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
749 -msmall-text  -mlarge-text @gol
750 -mmemory-latency=@var{time}}
752 @emph{FR30 Options}
753 @gccoptlist{-msmall-model  -mno-lsim}
755 @emph{FT32 Options}
756 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
758 @emph{FRV Options}
759 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
760 -mhard-float  -msoft-float @gol
761 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
762 -mdouble  -mno-double @gol
763 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
764 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
765 -mlinked-fp  -mlong-calls  -malign-labels @gol
766 -mlibrary-pic  -macc-4  -macc-8 @gol
767 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
768 -moptimize-membar  -mno-optimize-membar @gol
769 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
770 -mvliw-branch  -mno-vliw-branch @gol
771 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
772 -mno-nested-cond-exec  -mtomcat-stats @gol
773 -mTLS  -mtls @gol
774 -mcpu=@var{cpu}}
776 @emph{GNU/Linux Options}
777 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
778 -tno-android-cc  -tno-android-ld}
780 @emph{H8/300 Options}
781 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
783 @emph{HPPA Options}
784 @gccoptlist{-march=@var{architecture-type} @gol
785 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
786 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
787 -mfixed-range=@var{register-range} @gol
788 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
789 -mlong-load-store  -mno-disable-fpregs @gol
790 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
791 -mno-jump-in-delay  -mno-long-load-store @gol
792 -mno-portable-runtime  -mno-soft-float @gol
793 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
794 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
795 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
796 -munix=@var{unix-std}  -nolibdld  -static  -threads}
798 @emph{IA-64 Options}
799 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
800 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
801 -mconstant-gp  -mauto-pic  -mfused-madd @gol
802 -minline-float-divide-min-latency @gol
803 -minline-float-divide-max-throughput @gol
804 -mno-inline-float-divide @gol
805 -minline-int-divide-min-latency @gol
806 -minline-int-divide-max-throughput  @gol
807 -mno-inline-int-divide @gol
808 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
809 -mno-inline-sqrt @gol
810 -mdwarf2-asm  -mearly-stop-bits @gol
811 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
812 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
813 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
814 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
815 -msched-spec-ldc  -msched-spec-control-ldc @gol
816 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
817 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
818 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
819 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
821 @emph{LM32 Options}
822 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
823 -msign-extend-enabled  -muser-enabled}
825 @emph{M32R/D Options}
826 @gccoptlist{-m32r2  -m32rx  -m32r @gol
827 -mdebug @gol
828 -malign-loops  -mno-align-loops @gol
829 -missue-rate=@var{number} @gol
830 -mbranch-cost=@var{number} @gol
831 -mmodel=@var{code-size-model-type} @gol
832 -msdata=@var{sdata-type} @gol
833 -mno-flush-func  -mflush-func=@var{name} @gol
834 -mno-flush-trap  -mflush-trap=@var{number} @gol
835 -G @var{num}}
837 @emph{M32C Options}
838 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
840 @emph{M680x0 Options}
841 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
842 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
843 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
844 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
845 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
846 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
847 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
848 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
849 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
851 @emph{MCore Options}
852 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
853 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
854 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
855 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
856 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
858 @emph{MeP Options}
859 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
860 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
861 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
862 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
863 -mtiny=@var{n}}
865 @emph{MicroBlaze Options}
866 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
867 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
868 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
869 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
870 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
872 @emph{MIPS Options}
873 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
874 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
875 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
876 -mips16  -mno-mips16  -mflip-mips16 @gol
877 -minterlink-compressed  -mno-interlink-compressed @gol
878 -minterlink-mips16  -mno-interlink-mips16 @gol
879 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
880 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
881 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
882 -mno-float  -msingle-float  -mdouble-float @gol
883 -modd-spreg  -mno-odd-spreg @gol
884 -mabs=@var{mode}  -mnan=@var{encoding} @gol
885 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
886 -mmcu  -mmno-mcu @gol
887 -meva  -mno-eva @gol
888 -mvirt  -mno-virt @gol
889 -mxpa  -mno-xpa @gol
890 -mmicromips  -mno-micromips @gol
891 -mmsa  -mno-msa @gol
892 -mfpu=@var{fpu-type} @gol
893 -msmartmips  -mno-smartmips @gol
894 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
895 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
896 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
897 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
898 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
899 -membedded-data  -mno-embedded-data @gol
900 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
901 -mcode-readable=@var{setting} @gol
902 -msplit-addresses  -mno-split-addresses @gol
903 -mexplicit-relocs  -mno-explicit-relocs @gol
904 -mcheck-zero-division  -mno-check-zero-division @gol
905 -mdivide-traps  -mdivide-breaks @gol
906 -mload-store-pairs  -mno-load-store-pairs @gol
907 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
908 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
909 -mfix-24k  -mno-fix-24k @gol
910 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
911 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
912 -mfix-vr4120  -mno-fix-vr4120 @gol
913 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
914 -mflush-func=@var{func}  -mno-flush-func @gol
915 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
916 -mcompact-branches=@var{policy} @gol
917 -mfp-exceptions  -mno-fp-exceptions @gol
918 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
919 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
920 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
921 -mframe-header-opt  -mno-frame-header-opt}
923 @emph{MMIX Options}
924 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
925 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
926 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
927 -mno-base-addresses  -msingle-exit  -mno-single-exit}
929 @emph{MN10300 Options}
930 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
931 -mno-am33  -mam33  -mam33-2  -mam34 @gol
932 -mtune=@var{cpu-type} @gol
933 -mreturn-pointer-on-d0 @gol
934 -mno-crt0  -mrelax  -mliw  -msetlb}
936 @emph{Moxie Options}
937 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
939 @emph{MSP430 Options}
940 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
941 -mwarn-mcu @gol
942 -mcode-region=  -mdata-region= @gol
943 -msilicon-errata=  -msilicon-errata-warn= @gol
944 -mhwmult=  -minrt}
946 @emph{NDS32 Options}
947 @gccoptlist{-mbig-endian  -mlittle-endian @gol
948 -mreduced-regs  -mfull-regs @gol
949 -mcmov  -mno-cmov @gol
950 -mext-perf  -mno-ext-perf @gol
951 -mext-perf2  -mno-ext-perf2 @gol
952 -mext-string  -mno-ext-string @gol
953 -mv3push  -mno-v3push @gol
954 -m16bit  -mno-16bit @gol
955 -misr-vector-size=@var{num} @gol
956 -mcache-block-size=@var{num} @gol
957 -march=@var{arch} @gol
958 -mcmodel=@var{code-model} @gol
959 -mctor-dtor  -mrelax}
961 @emph{Nios II Options}
962 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
963 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
964 -mel  -meb @gol
965 -mno-bypass-cache  -mbypass-cache @gol
966 -mno-cache-volatile  -mcache-volatile @gol
967 -mno-fast-sw-div  -mfast-sw-div @gol
968 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
969 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
970 -mcustom-fpu-cfg=@var{name} @gol
971 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
972 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
974 @emph{Nvidia PTX Options}
975 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
977 @emph{PDP-11 Options}
978 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
979 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
980 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
981 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
982 -mbranch-expensive  -mbranch-cheap @gol
983 -munix-asm  -mdec-asm}
985 @emph{picoChip Options}
986 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
987 -msymbol-as-address  -mno-inefficient-warnings}
989 @emph{PowerPC Options}
990 See RS/6000 and PowerPC Options.
992 @emph{PowerPC SPE Options}
993 @gccoptlist{-mcpu=@var{cpu-type} @gol
994 -mtune=@var{cpu-type} @gol
995 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
996 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
997 -m32  -mxl-compat  -mno-xl-compat @gol
998 -malign-power  -malign-natural @gol
999 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1000 -msingle-float  -mdouble-float @gol
1001 -mupdate  -mno-update @gol
1002 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1003 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1004 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1005 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1006 -msingle-pic-base @gol
1007 -mprioritize-restricted-insns=@var{priority} @gol
1008 -msched-costly-dep=@var{dependence_type} @gol
1009 -minsert-sched-nops=@var{scheme} @gol
1010 -mcall-sysv  -mcall-netbsd @gol
1011 -maix-struct-return  -msvr4-struct-return @gol
1012 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1013 -mblock-move-inline-limit=@var{num} @gol
1014 -misel  -mno-isel @gol
1015 -misel=yes  -misel=no @gol
1016 -mspe  -mno-spe @gol
1017 -mspe=yes  -mspe=no @gol
1018 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1019 -mprototype  -mno-prototype @gol
1020 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1021 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1022 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1023 -mno-recip-precision @gol
1024 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1025 -msave-toc-indirect  -mno-save-toc-indirect @gol
1026 -mcompat-align-parm  -mno-compat-align-parm @gol
1027 -mfloat128  -mno-float128 @gol
1028 -mgnu-attribute  -mno-gnu-attribute @gol
1029 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1030 -mstack-protector-guard-offset=@var{offset}}
1032 @emph{RISC-V Options}
1033 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1034 -mplt  -mno-plt @gol
1035 -mabi=@var{ABI-string} @gol
1036 -mfdiv  -mno-fdiv @gol
1037 -mdiv  -mno-div @gol
1038 -march=@var{ISA-string} @gol
1039 -mtune=@var{processor-string} @gol
1040 -mpreferred-stack-boundary=@var{num} @gol
1041 -msmall-data-limit=@var{N-bytes} @gol
1042 -msave-restore  -mno-save-restore @gol
1043 -mstrict-align -mno-strict-align @gol
1044 -mcmodel=medlow -mcmodel=medany @gol
1045 -mexplicit-relocs  -mno-explicit-relocs @gol
1046 -mrelax -mno-relax @gol}
1048 @emph{RL78 Options}
1049 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1050 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1051 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1053 @emph{RS/6000 and PowerPC Options}
1054 @gccoptlist{-mcpu=@var{cpu-type} @gol
1055 -mtune=@var{cpu-type} @gol
1056 -mcmodel=@var{code-model} @gol
1057 -mpowerpc64 @gol
1058 -maltivec  -mno-altivec @gol
1059 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1060 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1061 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1062 -mfprnd  -mno-fprnd @gol
1063 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1064 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1065 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1066 -malign-power  -malign-natural @gol
1067 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1068 -msingle-float  -mdouble-float  -msimple-fpu @gol
1069 -mupdate  -mno-update @gol
1070 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1071 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1072 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1073 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1074 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1075 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1076 -mprioritize-restricted-insns=@var{priority} @gol
1077 -msched-costly-dep=@var{dependence_type} @gol
1078 -minsert-sched-nops=@var{scheme} @gol
1079 -mcall-aixdesc  -mcall-eabi  -mcall-freebsd  @gol
1080 -mcall-linux  -mcall-netbsd  -mcall-openbsd  @gol
1081 -mcall-sysv  -mcall-sysv-eabi  -mcall-sysv-noeabi @gol
1082 -mtraceback=@var{traceback_type} @gol
1083 -maix-struct-return  -msvr4-struct-return @gol
1084 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1085 -mblock-move-inline-limit=@var{num} @gol
1086 -mblock-compare-inline-limit=@var{num} @gol
1087 -mblock-compare-inline-loop-limit=@var{num} @gol
1088 -mstring-compare-inline-limit=@var{num} @gol
1089 -misel  -mno-isel @gol
1090 -misel=yes  -misel=no @gol
1091 -mpaired @gol
1092 -mvrsave  -mno-vrsave @gol
1093 -mmulhw  -mno-mulhw @gol
1094 -mdlmzb  -mno-dlmzb @gol
1095 -mprototype  -mno-prototype @gol
1096 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1097 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1098 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1099 -mno-recip-precision @gol
1100 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1101 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1102 -msave-toc-indirect  -mno-save-toc-indirect @gol
1103 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1104 -mcrypto  -mno-crypto  -mhtm  -mno-htm @gol
1105 -mquad-memory  -mno-quad-memory @gol
1106 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1107 -mcompat-align-parm  -mno-compat-align-parm @gol
1108 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1109 -mgnu-attribute  -mno-gnu-attribute @gol
1110 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1111 -mstack-protector-guard-offset=@var{offset}}
1113 @emph{RX Options}
1114 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1115 -mcpu=@gol
1116 -mbig-endian-data  -mlittle-endian-data @gol
1117 -msmall-data @gol
1118 -msim  -mno-sim@gol
1119 -mas100-syntax  -mno-as100-syntax@gol
1120 -mrelax@gol
1121 -mmax-constant-size=@gol
1122 -mint-register=@gol
1123 -mpid@gol
1124 -mallow-string-insns  -mno-allow-string-insns@gol
1125 -mjsr@gol
1126 -mno-warn-multiple-fast-interrupts@gol
1127 -msave-acc-in-interrupts}
1129 @emph{S/390 and zSeries Options}
1130 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1131 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1132 -mlong-double-64  -mlong-double-128 @gol
1133 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1134 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1135 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1136 -mhtm  -mvx  -mzvector @gol
1137 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1138 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1139 -mhotpatch=@var{halfwords},@var{halfwords}}
1141 @emph{Score Options}
1142 @gccoptlist{-meb  -mel @gol
1143 -mnhwloop @gol
1144 -muls @gol
1145 -mmac @gol
1146 -mscore5  -mscore5u  -mscore7  -mscore7d}
1148 @emph{SH Options}
1149 @gccoptlist{-m1  -m2  -m2e @gol
1150 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1151 -m3  -m3e @gol
1152 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1153 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1154 -mb  -ml  -mdalign  -mrelax @gol
1155 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1156 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1157 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1158 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1159 -maccumulate-outgoing-args @gol
1160 -matomic-model=@var{atomic-model} @gol
1161 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1162 -mcbranch-force-delay-slot @gol
1163 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1164 -mpretend-cmove  -mtas}
1166 @emph{Solaris 2 Options}
1167 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1168 -pthreads}
1170 @emph{SPARC Options}
1171 @gccoptlist{-mcpu=@var{cpu-type} @gol
1172 -mtune=@var{cpu-type} @gol
1173 -mcmodel=@var{code-model} @gol
1174 -mmemory-model=@var{mem-model} @gol
1175 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1176 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1177 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1178 -mhard-quad-float  -msoft-quad-float @gol
1179 -mstack-bias  -mno-stack-bias @gol
1180 -mstd-struct-return  -mno-std-struct-return @gol
1181 -munaligned-doubles  -mno-unaligned-doubles @gol
1182 -muser-mode  -mno-user-mode @gol
1183 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1184 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1185 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1186 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1187 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1188 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1189 -mlra  -mno-lra}
1191 @emph{SPU Options}
1192 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1193 -msafe-dma  -munsafe-dma @gol
1194 -mbranch-hints @gol
1195 -msmall-mem  -mlarge-mem  -mstdmain @gol
1196 -mfixed-range=@var{register-range} @gol
1197 -mea32  -mea64 @gol
1198 -maddress-space-conversion  -mno-address-space-conversion @gol
1199 -mcache-size=@var{cache-size} @gol
1200 -matomic-updates  -mno-atomic-updates}
1202 @emph{System V Options}
1203 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1205 @emph{TILE-Gx Options}
1206 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1207 -mcmodel=@var{code-model}}
1209 @emph{TILEPro Options}
1210 @gccoptlist{-mcpu=@var{cpu}  -m32}
1212 @emph{V850 Options}
1213 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1214 -mprolog-function  -mno-prolog-function  -mspace @gol
1215 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1216 -mapp-regs  -mno-app-regs @gol
1217 -mdisable-callt  -mno-disable-callt @gol
1218 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1219 -mv850e  -mv850  -mv850e3v5 @gol
1220 -mloop @gol
1221 -mrelax @gol
1222 -mlong-jumps @gol
1223 -msoft-float @gol
1224 -mhard-float @gol
1225 -mgcc-abi @gol
1226 -mrh850-abi @gol
1227 -mbig-switch}
1229 @emph{VAX Options}
1230 @gccoptlist{-mg  -mgnu  -munix}
1232 @emph{Visium Options}
1233 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1234 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1236 @emph{VMS Options}
1237 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1238 -mpointer-size=@var{size}}
1240 @emph{VxWorks Options}
1241 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1242 -Xbind-lazy  -Xbind-now}
1244 @emph{x86 Options}
1245 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1246 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1247 -mfpmath=@var{unit} @gol
1248 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1249 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1250 -mno-wide-multiply  -mrtd  -malign-double @gol
1251 -mpreferred-stack-boundary=@var{num} @gol
1252 -mincoming-stack-boundary=@var{num} @gol
1253 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1254 -mrecip  -mrecip=@var{opt} @gol
1255 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1256 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1257 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1258 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1259 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1260 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1261 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1262 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1263 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1264 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1265 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq @gol
1266 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1267 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1268 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1269 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1270 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1271 -mregparm=@var{num}  -msseregparm @gol
1272 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1273 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1274 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1275 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1276 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1277 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1278 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1279 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1280 -mstack-protector-guard-reg=@var{reg} @gol
1281 -mstack-protector-guard-offset=@var{offset} @gol
1282 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1283 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1284 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1285 -mindirect-branch-register}
1287 @emph{x86 Windows Options}
1288 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1289 -mnop-fun-dllimport  -mthread @gol
1290 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1292 @emph{Xstormy16 Options}
1293 @gccoptlist{-msim}
1295 @emph{Xtensa Options}
1296 @gccoptlist{-mconst16  -mno-const16 @gol
1297 -mfused-madd  -mno-fused-madd @gol
1298 -mforce-no-pic @gol
1299 -mserialize-volatile  -mno-serialize-volatile @gol
1300 -mtext-section-literals  -mno-text-section-literals @gol
1301 -mauto-litpools  -mno-auto-litpools @gol
1302 -mtarget-align  -mno-target-align @gol
1303 -mlongcalls  -mno-longcalls}
1305 @emph{zSeries Options}
1306 See S/390 and zSeries Options.
1307 @end table
1310 @node Overall Options
1311 @section Options Controlling the Kind of Output
1313 Compilation can involve up to four stages: preprocessing, compilation
1314 proper, assembly and linking, always in that order.  GCC is capable of
1315 preprocessing and compiling several files either into several
1316 assembler input files, or into one assembler input file; then each
1317 assembler input file produces an object file, and linking combines all
1318 the object files (those newly compiled, and those specified as input)
1319 into an executable file.
1321 @cindex file name suffix
1322 For any given input file, the file name suffix determines what kind of
1323 compilation is done:
1325 @table @gcctabopt
1326 @item @var{file}.c
1327 C source code that must be preprocessed.
1329 @item @var{file}.i
1330 C source code that should not be preprocessed.
1332 @item @var{file}.ii
1333 C++ source code that should not be preprocessed.
1335 @item @var{file}.m
1336 Objective-C source code.  Note that you must link with the @file{libobjc}
1337 library to make an Objective-C program work.
1339 @item @var{file}.mi
1340 Objective-C source code that should not be preprocessed.
1342 @item @var{file}.mm
1343 @itemx @var{file}.M
1344 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1345 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1346 to a literal capital M@.
1348 @item @var{file}.mii
1349 Objective-C++ source code that should not be preprocessed.
1351 @item @var{file}.h
1352 C, C++, Objective-C or Objective-C++ header file to be turned into a
1353 precompiled header (default), or C, C++ header file to be turned into an
1354 Ada spec (via the @option{-fdump-ada-spec} switch).
1356 @item @var{file}.cc
1357 @itemx @var{file}.cp
1358 @itemx @var{file}.cxx
1359 @itemx @var{file}.cpp
1360 @itemx @var{file}.CPP
1361 @itemx @var{file}.c++
1362 @itemx @var{file}.C
1363 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1364 the last two letters must both be literally @samp{x}.  Likewise,
1365 @samp{.C} refers to a literal capital C@.
1367 @item @var{file}.mm
1368 @itemx @var{file}.M
1369 Objective-C++ source code that must be preprocessed.
1371 @item @var{file}.mii
1372 Objective-C++ source code that should not be preprocessed.
1374 @item @var{file}.hh
1375 @itemx @var{file}.H
1376 @itemx @var{file}.hp
1377 @itemx @var{file}.hxx
1378 @itemx @var{file}.hpp
1379 @itemx @var{file}.HPP
1380 @itemx @var{file}.h++
1381 @itemx @var{file}.tcc
1382 C++ header file to be turned into a precompiled header or Ada spec.
1384 @item @var{file}.f
1385 @itemx @var{file}.for
1386 @itemx @var{file}.ftn
1387 Fixed form Fortran source code that should not be preprocessed.
1389 @item @var{file}.F
1390 @itemx @var{file}.FOR
1391 @itemx @var{file}.fpp
1392 @itemx @var{file}.FPP
1393 @itemx @var{file}.FTN
1394 Fixed form Fortran source code that must be preprocessed (with the traditional
1395 preprocessor).
1397 @item @var{file}.f90
1398 @itemx @var{file}.f95
1399 @itemx @var{file}.f03
1400 @itemx @var{file}.f08
1401 Free form Fortran source code that should not be preprocessed.
1403 @item @var{file}.F90
1404 @itemx @var{file}.F95
1405 @itemx @var{file}.F03
1406 @itemx @var{file}.F08
1407 Free form Fortran source code that must be preprocessed (with the
1408 traditional preprocessor).
1410 @item @var{file}.go
1411 Go source code.
1413 @item @var{file}.brig
1414 BRIG files (binary representation of HSAIL).
1416 @item @var{file}.ads
1417 Ada source code file that contains a library unit declaration (a
1418 declaration of a package, subprogram, or generic, or a generic
1419 instantiation), or a library unit renaming declaration (a package,
1420 generic, or subprogram renaming declaration).  Such files are also
1421 called @dfn{specs}.
1423 @item @var{file}.adb
1424 Ada source code file containing a library unit body (a subprogram or
1425 package body).  Such files are also called @dfn{bodies}.
1427 @c GCC also knows about some suffixes for languages not yet included:
1428 @c Pascal:
1429 @c @var{file}.p
1430 @c @var{file}.pas
1431 @c Ratfor:
1432 @c @var{file}.r
1434 @item @var{file}.s
1435 Assembler code.
1437 @item @var{file}.S
1438 @itemx @var{file}.sx
1439 Assembler code that must be preprocessed.
1441 @item @var{other}
1442 An object file to be fed straight into linking.
1443 Any file name with no recognized suffix is treated this way.
1444 @end table
1446 @opindex x
1447 You can specify the input language explicitly with the @option{-x} option:
1449 @table @gcctabopt
1450 @item -x @var{language}
1451 Specify explicitly the @var{language} for the following input files
1452 (rather than letting the compiler choose a default based on the file
1453 name suffix).  This option applies to all following input files until
1454 the next @option{-x} option.  Possible values for @var{language} are:
1455 @smallexample
1456 c  c-header  cpp-output
1457 c++  c++-header  c++-cpp-output
1458 objective-c  objective-c-header  objective-c-cpp-output
1459 objective-c++ objective-c++-header objective-c++-cpp-output
1460 assembler  assembler-with-cpp
1462 f77  f77-cpp-input f95  f95-cpp-input
1464 brig
1465 @end smallexample
1467 @item -x none
1468 Turn off any specification of a language, so that subsequent files are
1469 handled according to their file name suffixes (as they are if @option{-x}
1470 has not been used at all).
1471 @end table
1473 If you only want some of the stages of compilation, you can use
1474 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1475 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1476 @command{gcc} is to stop.  Note that some combinations (for example,
1477 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1479 @table @gcctabopt
1480 @item -c
1481 @opindex c
1482 Compile or assemble the source files, but do not link.  The linking
1483 stage simply is not done.  The ultimate output is in the form of an
1484 object file for each source file.
1486 By default, the object file name for a source file is made by replacing
1487 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1489 Unrecognized input files, not requiring compilation or assembly, are
1490 ignored.
1492 @item -S
1493 @opindex S
1494 Stop after the stage of compilation proper; do not assemble.  The output
1495 is in the form of an assembler code file for each non-assembler input
1496 file specified.
1498 By default, the assembler file name for a source file is made by
1499 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1501 Input files that don't require compilation are ignored.
1503 @item -E
1504 @opindex E
1505 Stop after the preprocessing stage; do not run the compiler proper.  The
1506 output is in the form of preprocessed source code, which is sent to the
1507 standard output.
1509 Input files that don't require preprocessing are ignored.
1511 @cindex output file option
1512 @item -o @var{file}
1513 @opindex o
1514 Place output in file @var{file}.  This applies to whatever
1515 sort of output is being produced, whether it be an executable file,
1516 an object file, an assembler file or preprocessed C code.
1518 If @option{-o} is not specified, the default is to put an executable
1519 file in @file{a.out}, the object file for
1520 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1521 assembler file in @file{@var{source}.s}, a precompiled header file in
1522 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1523 standard output.
1525 @item -v
1526 @opindex v
1527 Print (on standard error output) the commands executed to run the stages
1528 of compilation.  Also print the version number of the compiler driver
1529 program and of the preprocessor and the compiler proper.
1531 @item -###
1532 @opindex ###
1533 Like @option{-v} except the commands are not executed and arguments
1534 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1535 This is useful for shell scripts to capture the driver-generated command lines.
1537 @item --help
1538 @opindex help
1539 Print (on the standard output) a description of the command-line options
1540 understood by @command{gcc}.  If the @option{-v} option is also specified
1541 then @option{--help} is also passed on to the various processes
1542 invoked by @command{gcc}, so that they can display the command-line options
1543 they accept.  If the @option{-Wextra} option has also been specified
1544 (prior to the @option{--help} option), then command-line options that
1545 have no documentation associated with them are also displayed.
1547 @item --target-help
1548 @opindex target-help
1549 Print (on the standard output) a description of target-specific command-line
1550 options for each tool.  For some targets extra target-specific
1551 information may also be printed.
1553 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1554 Print (on the standard output) a description of the command-line
1555 options understood by the compiler that fit into all specified classes
1556 and qualifiers.  These are the supported classes:
1558 @table @asis
1559 @item @samp{optimizers}
1560 Display all of the optimization options supported by the
1561 compiler.
1563 @item @samp{warnings}
1564 Display all of the options controlling warning messages
1565 produced by the compiler.
1567 @item @samp{target}
1568 Display target-specific options.  Unlike the
1569 @option{--target-help} option however, target-specific options of the
1570 linker and assembler are not displayed.  This is because those
1571 tools do not currently support the extended @option{--help=} syntax.
1573 @item @samp{params}
1574 Display the values recognized by the @option{--param}
1575 option.
1577 @item @var{language}
1578 Display the options supported for @var{language}, where
1579 @var{language} is the name of one of the languages supported in this
1580 version of GCC@.
1582 @item @samp{common}
1583 Display the options that are common to all languages.
1584 @end table
1586 These are the supported qualifiers:
1588 @table @asis
1589 @item @samp{undocumented}
1590 Display only those options that are undocumented.
1592 @item @samp{joined}
1593 Display options taking an argument that appears after an equal
1594 sign in the same continuous piece of text, such as:
1595 @samp{--help=target}.
1597 @item @samp{separate}
1598 Display options taking an argument that appears as a separate word
1599 following the original option, such as: @samp{-o output-file}.
1600 @end table
1602 Thus for example to display all the undocumented target-specific
1603 switches supported by the compiler, use:
1605 @smallexample
1606 --help=target,undocumented
1607 @end smallexample
1609 The sense of a qualifier can be inverted by prefixing it with the
1610 @samp{^} character, so for example to display all binary warning
1611 options (i.e., ones that are either on or off and that do not take an
1612 argument) that have a description, use:
1614 @smallexample
1615 --help=warnings,^joined,^undocumented
1616 @end smallexample
1618 The argument to @option{--help=} should not consist solely of inverted
1619 qualifiers.
1621 Combining several classes is possible, although this usually
1622 restricts the output so much that there is nothing to display.  One
1623 case where it does work, however, is when one of the classes is
1624 @var{target}.  For example, to display all the target-specific
1625 optimization options, use:
1627 @smallexample
1628 --help=target,optimizers
1629 @end smallexample
1631 The @option{--help=} option can be repeated on the command line.  Each
1632 successive use displays its requested class of options, skipping
1633 those that have already been displayed.
1635 If the @option{-Q} option appears on the command line before the
1636 @option{--help=} option, then the descriptive text displayed by
1637 @option{--help=} is changed.  Instead of describing the displayed
1638 options, an indication is given as to whether the option is enabled,
1639 disabled or set to a specific value (assuming that the compiler
1640 knows this at the point where the @option{--help=} option is used).
1642 Here is a truncated example from the ARM port of @command{gcc}:
1644 @smallexample
1645   % gcc -Q -mabi=2 --help=target -c
1646   The following options are target specific:
1647   -mabi=                                2
1648   -mabort-on-noreturn                   [disabled]
1649   -mapcs                                [disabled]
1650 @end smallexample
1652 The output is sensitive to the effects of previous command-line
1653 options, so for example it is possible to find out which optimizations
1654 are enabled at @option{-O2} by using:
1656 @smallexample
1657 -Q -O2 --help=optimizers
1658 @end smallexample
1660 Alternatively you can discover which binary optimizations are enabled
1661 by @option{-O3} by using:
1663 @smallexample
1664 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1665 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1666 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1667 @end smallexample
1669 @item --version
1670 @opindex version
1671 Display the version number and copyrights of the invoked GCC@.
1673 @item -pass-exit-codes
1674 @opindex pass-exit-codes
1675 Normally the @command{gcc} program exits with the code of 1 if any
1676 phase of the compiler returns a non-success return code.  If you specify
1677 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1678 the numerically highest error produced by any phase returning an error
1679 indication.  The C, C++, and Fortran front ends return 4 if an internal
1680 compiler error is encountered.
1682 @item -pipe
1683 @opindex pipe
1684 Use pipes rather than temporary files for communication between the
1685 various stages of compilation.  This fails to work on some systems where
1686 the assembler is unable to read from a pipe; but the GNU assembler has
1687 no trouble.
1689 @item -specs=@var{file}
1690 @opindex specs
1691 Process @var{file} after the compiler reads in the standard @file{specs}
1692 file, in order to override the defaults which the @command{gcc} driver
1693 program uses when determining what switches to pass to @command{cc1},
1694 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1695 @option{-specs=@var{file}} can be specified on the command line, and they
1696 are processed in order, from left to right.  @xref{Spec Files}, for
1697 information about the format of the @var{file}.
1699 @item -wrapper
1700 @opindex wrapper
1701 Invoke all subcommands under a wrapper program.  The name of the
1702 wrapper program and its parameters are passed as a comma separated
1703 list.
1705 @smallexample
1706 gcc -c t.c -wrapper gdb,--args
1707 @end smallexample
1709 @noindent
1710 This invokes all subprograms of @command{gcc} under
1711 @samp{gdb --args}, thus the invocation of @command{cc1} is
1712 @samp{gdb --args cc1 @dots{}}.
1714 @item -ffile-prefix-map=@var{old}=@var{new}
1715 @opindex ffile-prefix-map
1716 When compiling files residing in directory @file{@var{old}}, record
1717 any references to them in the result of the compilation as if the
1718 files resided in directory @file{@var{new}} instead.  Specifying this
1719 option is equivalent to specifying all the individual
1720 @option{-f*-prefix-map} options.  This can be used to make reproducible
1721 builds that are location independent.  See also
1722 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1724 @item -fplugin=@var{name}.so
1725 @opindex fplugin
1726 Load the plugin code in file @var{name}.so, assumed to be a
1727 shared object to be dlopen'd by the compiler.  The base name of
1728 the shared object file is used to identify the plugin for the
1729 purposes of argument parsing (See
1730 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1731 Each plugin should define the callback functions specified in the
1732 Plugins API.
1734 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1735 @opindex fplugin-arg
1736 Define an argument called @var{key} with a value of @var{value}
1737 for the plugin called @var{name}.
1739 @item -fdump-ada-spec@r{[}-slim@r{]}
1740 @opindex fdump-ada-spec
1741 For C and C++ source and include files, generate corresponding Ada specs.
1742 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1743 GNAT User's Guide}, which provides detailed documentation on this feature.
1745 @item -fada-spec-parent=@var{unit}
1746 @opindex fada-spec-parent
1747 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1748 Ada specs as child units of parent @var{unit}.
1750 @item -fdump-go-spec=@var{file}
1751 @opindex fdump-go-spec
1752 For input files in any language, generate corresponding Go
1753 declarations in @var{file}.  This generates Go @code{const},
1754 @code{type}, @code{var}, and @code{func} declarations which may be a
1755 useful way to start writing a Go interface to code written in some
1756 other language.
1758 @include @value{srcdir}/../libiberty/at-file.texi
1759 @end table
1761 @node Invoking G++
1762 @section Compiling C++ Programs
1764 @cindex suffixes for C++ source
1765 @cindex C++ source file suffixes
1766 C++ source files conventionally use one of the suffixes @samp{.C},
1767 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1768 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1769 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1770 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1771 files with these names and compiles them as C++ programs even if you
1772 call the compiler the same way as for compiling C programs (usually
1773 with the name @command{gcc}).
1775 @findex g++
1776 @findex c++
1777 However, the use of @command{gcc} does not add the C++ library.
1778 @command{g++} is a program that calls GCC and automatically specifies linking
1779 against the C++ library.  It treats @samp{.c},
1780 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1781 files unless @option{-x} is used.  This program is also useful when
1782 precompiling a C header file with a @samp{.h} extension for use in C++
1783 compilations.  On many systems, @command{g++} is also installed with
1784 the name @command{c++}.
1786 @cindex invoking @command{g++}
1787 When you compile C++ programs, you may specify many of the same
1788 command-line options that you use for compiling programs in any
1789 language; or command-line options meaningful for C and related
1790 languages; or options that are meaningful only for C++ programs.
1791 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1792 explanations of options for languages related to C@.
1793 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1794 explanations of options that are meaningful only for C++ programs.
1796 @node C Dialect Options
1797 @section Options Controlling C Dialect
1798 @cindex dialect options
1799 @cindex language dialect options
1800 @cindex options, dialect
1802 The following options control the dialect of C (or languages derived
1803 from C, such as C++, Objective-C and Objective-C++) that the compiler
1804 accepts:
1806 @table @gcctabopt
1807 @cindex ANSI support
1808 @cindex ISO support
1809 @item -ansi
1810 @opindex ansi
1811 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1812 equivalent to @option{-std=c++98}.
1814 This turns off certain features of GCC that are incompatible with ISO
1815 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1816 such as the @code{asm} and @code{typeof} keywords, and
1817 predefined macros such as @code{unix} and @code{vax} that identify the
1818 type of system you are using.  It also enables the undesirable and
1819 rarely used ISO trigraph feature.  For the C compiler,
1820 it disables recognition of C++ style @samp{//} comments as well as
1821 the @code{inline} keyword.
1823 The alternate keywords @code{__asm__}, @code{__extension__},
1824 @code{__inline__} and @code{__typeof__} continue to work despite
1825 @option{-ansi}.  You would not want to use them in an ISO C program, of
1826 course, but it is useful to put them in header files that might be included
1827 in compilations done with @option{-ansi}.  Alternate predefined macros
1828 such as @code{__unix__} and @code{__vax__} are also available, with or
1829 without @option{-ansi}.
1831 The @option{-ansi} option does not cause non-ISO programs to be
1832 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1833 addition to @option{-ansi}.  @xref{Warning Options}.
1835 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1836 option is used.  Some header files may notice this macro and refrain
1837 from declaring certain functions or defining certain macros that the
1838 ISO standard doesn't call for; this is to avoid interfering with any
1839 programs that might use these names for other things.
1841 Functions that are normally built in but do not have semantics
1842 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1843 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1844 built-in functions provided by GCC}, for details of the functions
1845 affected.
1847 @item -std=
1848 @opindex std
1849 Determine the language standard. @xref{Standards,,Language Standards
1850 Supported by GCC}, for details of these standard versions.  This option
1851 is currently only supported when compiling C or C++.
1853 The compiler can accept several base standards, such as @samp{c90} or
1854 @samp{c++98}, and GNU dialects of those standards, such as
1855 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1856 compiler accepts all programs following that standard plus those
1857 using GNU extensions that do not contradict it.  For example,
1858 @option{-std=c90} turns off certain features of GCC that are
1859 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1860 keywords, but not other GNU extensions that do not have a meaning in
1861 ISO C90, such as omitting the middle term of a @code{?:}
1862 expression. On the other hand, when a GNU dialect of a standard is
1863 specified, all features supported by the compiler are enabled, even when
1864 those features change the meaning of the base standard.  As a result, some
1865 strict-conforming programs may be rejected.  The particular standard
1866 is used by @option{-Wpedantic} to identify which features are GNU
1867 extensions given that version of the standard. For example
1868 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1869 comments, while @option{-std=gnu99 -Wpedantic} does not.
1871 A value for this option must be provided; possible values are
1873 @table @samp
1874 @item c90
1875 @itemx c89
1876 @itemx iso9899:1990
1877 Support all ISO C90 programs (certain GNU extensions that conflict
1878 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1880 @item iso9899:199409
1881 ISO C90 as modified in amendment 1.
1883 @item c99
1884 @itemx c9x
1885 @itemx iso9899:1999
1886 @itemx iso9899:199x
1887 ISO C99.  This standard is substantially completely supported, modulo
1888 bugs and floating-point issues
1889 (mainly but not entirely relating to optional C99 features from
1890 Annexes F and G).  See
1891 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1892 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1894 @item c11
1895 @itemx c1x
1896 @itemx iso9899:2011
1897 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1898 substantially completely supported, modulo bugs, floating-point issues
1899 (mainly but not entirely relating to optional C11 features from
1900 Annexes F and G) and the optional Annexes K (Bounds-checking
1901 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1903 @item c17
1904 @itemx c18
1905 @itemx iso9899:2017
1906 @itemx iso9899:2018
1907 ISO C17, the 2017 revision of the ISO C standard (expected to be
1908 published in 2018).  This standard is
1909 same as C11 except for corrections of defects (all of which are also
1910 applied with @option{-std=c11}) and a new value of
1911 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1913 @item gnu90
1914 @itemx gnu89
1915 GNU dialect of ISO C90 (including some C99 features).
1917 @item gnu99
1918 @itemx gnu9x
1919 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1921 @item gnu11
1922 @itemx gnu1x
1923 GNU dialect of ISO C11.
1924 The name @samp{gnu1x} is deprecated.
1926 @item gnu17
1927 @itemx gnu18
1928 GNU dialect of ISO C17.  This is the default for C code.
1930 @item c++98
1931 @itemx c++03
1932 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1933 additional defect reports. Same as @option{-ansi} for C++ code.
1935 @item gnu++98
1936 @itemx gnu++03
1937 GNU dialect of @option{-std=c++98}.
1939 @item c++11
1940 @itemx c++0x
1941 The 2011 ISO C++ standard plus amendments.
1942 The name @samp{c++0x} is deprecated.
1944 @item gnu++11
1945 @itemx gnu++0x
1946 GNU dialect of @option{-std=c++11}.
1947 The name @samp{gnu++0x} is deprecated.
1949 @item c++14
1950 @itemx c++1y
1951 The 2014 ISO C++ standard plus amendments.
1952 The name @samp{c++1y} is deprecated.
1954 @item gnu++14
1955 @itemx gnu++1y
1956 GNU dialect of @option{-std=c++14}.
1957 This is the default for C++ code.
1958 The name @samp{gnu++1y} is deprecated.
1960 @item c++17
1961 @itemx c++1z
1962 The 2017 ISO C++ standard plus amendments.
1963 The name @samp{c++1z} is deprecated.
1965 @item gnu++17
1966 @itemx gnu++1z
1967 GNU dialect of @option{-std=c++17}.
1968 The name @samp{gnu++1z} is deprecated.
1970 @item c++2a
1971 The next revision of the ISO C++ standard, tentatively planned for
1972 2020.  Support is highly experimental, and will almost certainly
1973 change in incompatible ways in future releases.
1975 @item gnu++2a
1976 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1977 and will almost certainly change in incompatible ways in future
1978 releases.
1979 @end table
1981 @item -fgnu89-inline
1982 @opindex fgnu89-inline
1983 The option @option{-fgnu89-inline} tells GCC to use the traditional
1984 GNU semantics for @code{inline} functions when in C99 mode.
1985 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1986 Using this option is roughly equivalent to adding the
1987 @code{gnu_inline} function attribute to all inline functions
1988 (@pxref{Function Attributes}).
1990 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1991 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1992 specifies the default behavior).
1993 This option is not supported in @option{-std=c90} or
1994 @option{-std=gnu90} mode.
1996 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1997 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1998 in effect for @code{inline} functions.  @xref{Common Predefined
1999 Macros,,,cpp,The C Preprocessor}.
2001 @item -fpermitted-flt-eval-methods=@var{style}
2002 @opindex fpermitted-flt-eval-methods
2003 @opindex fpermitted-flt-eval-methods=c11
2004 @opindex fpermitted-flt-eval-methods=ts-18661-3
2005 ISO/IEC TS 18661-3 defines new permissible values for
2006 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2007 a semantic type that is an interchange or extended format should be
2008 evaluated to the precision and range of that type.  These new values are
2009 a superset of those permitted under C99/C11, which does not specify the
2010 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2011 conforming to C11 may not have been written expecting the possibility of
2012 the new values.
2014 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2015 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2016 or the extended set of values specified in ISO/IEC TS 18661-3.
2018 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2020 The default when in a standards compliant mode (@option{-std=c11} or similar)
2021 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2022 dialect (@option{-std=gnu11} or similar) is
2023 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2025 @item -aux-info @var{filename}
2026 @opindex aux-info
2027 Output to the given filename prototyped declarations for all functions
2028 declared and/or defined in a translation unit, including those in header
2029 files.  This option is silently ignored in any language other than C@.
2031 Besides declarations, the file indicates, in comments, the origin of
2032 each declaration (source file and line), whether the declaration was
2033 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2034 @samp{O} for old, respectively, in the first character after the line
2035 number and the colon), and whether it came from a declaration or a
2036 definition (@samp{C} or @samp{F}, respectively, in the following
2037 character).  In the case of function definitions, a K&R-style list of
2038 arguments followed by their declarations is also provided, inside
2039 comments, after the declaration.
2041 @item -fallow-parameterless-variadic-functions
2042 @opindex fallow-parameterless-variadic-functions
2043 Accept variadic functions without named parameters.
2045 Although it is possible to define such a function, this is not very
2046 useful as it is not possible to read the arguments.  This is only
2047 supported for C as this construct is allowed by C++.
2049 @item -fno-asm
2050 @opindex fno-asm
2051 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2052 keyword, so that code can use these words as identifiers.  You can use
2053 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2054 instead.  @option{-ansi} implies @option{-fno-asm}.
2056 In C++, this switch only affects the @code{typeof} keyword, since
2057 @code{asm} and @code{inline} are standard keywords.  You may want to
2058 use the @option{-fno-gnu-keywords} flag instead, which has the same
2059 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2060 switch only affects the @code{asm} and @code{typeof} keywords, since
2061 @code{inline} is a standard keyword in ISO C99.
2063 @item -fno-builtin
2064 @itemx -fno-builtin-@var{function}
2065 @opindex fno-builtin
2066 @cindex built-in functions
2067 Don't recognize built-in functions that do not begin with
2068 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2069 functions provided by GCC}, for details of the functions affected,
2070 including those which are not built-in functions when @option{-ansi} or
2071 @option{-std} options for strict ISO C conformance are used because they
2072 do not have an ISO standard meaning.
2074 GCC normally generates special code to handle certain built-in functions
2075 more efficiently; for instance, calls to @code{alloca} may become single
2076 instructions which adjust the stack directly, and calls to @code{memcpy}
2077 may become inline copy loops.  The resulting code is often both smaller
2078 and faster, but since the function calls no longer appear as such, you
2079 cannot set a breakpoint on those calls, nor can you change the behavior
2080 of the functions by linking with a different library.  In addition,
2081 when a function is recognized as a built-in function, GCC may use
2082 information about that function to warn about problems with calls to
2083 that function, or to generate more efficient code, even if the
2084 resulting code still contains calls to that function.  For example,
2085 warnings are given with @option{-Wformat} for bad calls to
2086 @code{printf} when @code{printf} is built in and @code{strlen} is
2087 known not to modify global memory.
2089 With the @option{-fno-builtin-@var{function}} option
2090 only the built-in function @var{function} is
2091 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2092 function is named that is not built-in in this version of GCC, this
2093 option is ignored.  There is no corresponding
2094 @option{-fbuiltin-@var{function}} option; if you wish to enable
2095 built-in functions selectively when using @option{-fno-builtin} or
2096 @option{-ffreestanding}, you may define macros such as:
2098 @smallexample
2099 #define abs(n)          __builtin_abs ((n))
2100 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2101 @end smallexample
2103 @item -fgimple
2104 @opindex fgimple
2106 Enable parsing of function definitions marked with @code{__GIMPLE}.
2107 This is an experimental feature that allows unit testing of GIMPLE
2108 passes.
2110 @item -fhosted
2111 @opindex fhosted
2112 @cindex hosted environment
2114 Assert that compilation targets a hosted environment.  This implies
2115 @option{-fbuiltin}.  A hosted environment is one in which the
2116 entire standard library is available, and in which @code{main} has a return
2117 type of @code{int}.  Examples are nearly everything except a kernel.
2118 This is equivalent to @option{-fno-freestanding}.
2120 @item -ffreestanding
2121 @opindex ffreestanding
2122 @cindex hosted environment
2124 Assert that compilation targets a freestanding environment.  This
2125 implies @option{-fno-builtin}.  A freestanding environment
2126 is one in which the standard library may not exist, and program startup may
2127 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2128 This is equivalent to @option{-fno-hosted}.
2130 @xref{Standards,,Language Standards Supported by GCC}, for details of
2131 freestanding and hosted environments.
2133 @item -fopenacc
2134 @opindex fopenacc
2135 @cindex OpenACC accelerator programming
2136 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2137 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2138 compiler generates accelerated code according to the OpenACC Application
2139 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2140 implies @option{-pthread}, and thus is only supported on targets that
2141 have support for @option{-pthread}.
2143 @item -fopenacc-dim=@var{geom}
2144 @opindex fopenacc-dim
2145 @cindex OpenACC accelerator programming
2146 Specify default compute dimensions for parallel offload regions that do
2147 not explicitly specify.  The @var{geom} value is a triple of
2148 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2149 can be omitted, to use a target-specific default value.
2151 @item -fopenmp
2152 @opindex fopenmp
2153 @cindex OpenMP parallel
2154 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2155 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2156 compiler generates parallel code according to the OpenMP Application
2157 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2158 implies @option{-pthread}, and thus is only supported on targets that
2159 have support for @option{-pthread}. @option{-fopenmp} implies
2160 @option{-fopenmp-simd}.
2162 @item -fopenmp-simd
2163 @opindex fopenmp-simd
2164 @cindex OpenMP SIMD
2165 @cindex SIMD
2166 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2167 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2168 are ignored.
2170 @item -fgnu-tm
2171 @opindex fgnu-tm
2172 When the option @option{-fgnu-tm} is specified, the compiler
2173 generates code for the Linux variant of Intel's current Transactional
2174 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2175 an experimental feature whose interface may change in future versions
2176 of GCC, as the official specification changes.  Please note that not
2177 all architectures are supported for this feature.
2179 For more information on GCC's support for transactional memory,
2180 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2181 Transactional Memory Library}.
2183 Note that the transactional memory feature is not supported with
2184 non-call exceptions (@option{-fnon-call-exceptions}).
2186 @item -fms-extensions
2187 @opindex fms-extensions
2188 Accept some non-standard constructs used in Microsoft header files.
2190 In C++ code, this allows member names in structures to be similar
2191 to previous types declarations.
2193 @smallexample
2194 typedef int UOW;
2195 struct ABC @{
2196   UOW UOW;
2198 @end smallexample
2200 Some cases of unnamed fields in structures and unions are only
2201 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2202 fields within structs/unions}, for details.
2204 Note that this option is off for all targets but x86 
2205 targets using ms-abi.
2207 @item -fplan9-extensions
2208 @opindex fplan9-extensions
2209 Accept some non-standard constructs used in Plan 9 code.
2211 This enables @option{-fms-extensions}, permits passing pointers to
2212 structures with anonymous fields to functions that expect pointers to
2213 elements of the type of the field, and permits referring to anonymous
2214 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2215 struct/union fields within structs/unions}, for details.  This is only
2216 supported for C, not C++.
2218 @item -fcond-mismatch
2219 @opindex fcond-mismatch
2220 Allow conditional expressions with mismatched types in the second and
2221 third arguments.  The value of such an expression is void.  This option
2222 is not supported for C++.
2224 @item -flax-vector-conversions
2225 @opindex flax-vector-conversions
2226 Allow implicit conversions between vectors with differing numbers of
2227 elements and/or incompatible element types.  This option should not be
2228 used for new code.
2230 @item -funsigned-char
2231 @opindex funsigned-char
2232 Let the type @code{char} be unsigned, like @code{unsigned char}.
2234 Each kind of machine has a default for what @code{char} should
2235 be.  It is either like @code{unsigned char} by default or like
2236 @code{signed char} by default.
2238 Ideally, a portable program should always use @code{signed char} or
2239 @code{unsigned char} when it depends on the signedness of an object.
2240 But many programs have been written to use plain @code{char} and
2241 expect it to be signed, or expect it to be unsigned, depending on the
2242 machines they were written for.  This option, and its inverse, let you
2243 make such a program work with the opposite default.
2245 The type @code{char} is always a distinct type from each of
2246 @code{signed char} or @code{unsigned char}, even though its behavior
2247 is always just like one of those two.
2249 @item -fsigned-char
2250 @opindex fsigned-char
2251 Let the type @code{char} be signed, like @code{signed char}.
2253 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2254 the negative form of @option{-funsigned-char}.  Likewise, the option
2255 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2257 @item -fsigned-bitfields
2258 @itemx -funsigned-bitfields
2259 @itemx -fno-signed-bitfields
2260 @itemx -fno-unsigned-bitfields
2261 @opindex fsigned-bitfields
2262 @opindex funsigned-bitfields
2263 @opindex fno-signed-bitfields
2264 @opindex fno-unsigned-bitfields
2265 These options control whether a bit-field is signed or unsigned, when the
2266 declaration does not use either @code{signed} or @code{unsigned}.  By
2267 default, such a bit-field is signed, because this is consistent: the
2268 basic integer types such as @code{int} are signed types.
2270 @item -fsso-struct=@var{endianness}
2271 @opindex fsso-struct
2272 Set the default scalar storage order of structures and unions to the
2273 specified endianness.  The accepted values are @samp{big-endian},
2274 @samp{little-endian} and @samp{native} for the native endianness of
2275 the target (the default).  This option is not supported for C++.
2277 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2278 code that is not binary compatible with code generated without it if the
2279 specified endianness is not the native endianness of the target.
2280 @end table
2282 @node C++ Dialect Options
2283 @section Options Controlling C++ Dialect
2285 @cindex compiler options, C++
2286 @cindex C++ options, command-line
2287 @cindex options, C++
2288 This section describes the command-line options that are only meaningful
2289 for C++ programs.  You can also use most of the GNU compiler options
2290 regardless of what language your program is in.  For example, you
2291 might compile a file @file{firstClass.C} like this:
2293 @smallexample
2294 g++ -g -fstrict-enums -O -c firstClass.C
2295 @end smallexample
2297 @noindent
2298 In this example, only @option{-fstrict-enums} is an option meant
2299 only for C++ programs; you can use the other options with any
2300 language supported by GCC@.
2302 Some options for compiling C programs, such as @option{-std}, are also
2303 relevant for C++ programs.
2304 @xref{C Dialect Options,,Options Controlling C Dialect}.
2306 Here is a list of options that are @emph{only} for compiling C++ programs:
2308 @table @gcctabopt
2310 @item -fabi-version=@var{n}
2311 @opindex fabi-version
2312 Use version @var{n} of the C++ ABI@.  The default is version 0.
2314 Version 0 refers to the version conforming most closely to
2315 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2316 will change in different versions of G++ as ABI bugs are fixed.
2318 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2320 Version 2 is the version of the C++ ABI that first appeared in G++
2321 3.4, and was the default through G++ 4.9.
2323 Version 3 corrects an error in mangling a constant address as a
2324 template argument.
2326 Version 4, which first appeared in G++ 4.5, implements a standard
2327 mangling for vector types.
2329 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2330 attribute const/volatile on function pointer types, decltype of a
2331 plain decl, and use of a function parameter in the declaration of
2332 another parameter.
2334 Version 6, which first appeared in G++ 4.7, corrects the promotion
2335 behavior of C++11 scoped enums and the mangling of template argument
2336 packs, const/static_cast, prefix ++ and --, and a class scope function
2337 used as a template argument.
2339 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2340 builtin type and corrects the mangling of lambdas in default argument
2341 scope.
2343 Version 8, which first appeared in G++ 4.9, corrects the substitution
2344 behavior of function types with function-cv-qualifiers.
2346 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2347 @code{nullptr_t}.
2349 Version 10, which first appeared in G++ 6.1, adds mangling of
2350 attributes that affect type identity, such as ia32 calling convention
2351 attributes (e.g. @samp{stdcall}).
2353 Version 11, which first appeared in G++ 7, corrects the mangling of
2354 sizeof... expressions and operator names.  For multiple entities with
2355 the same name within a function, that are declared in different scopes,
2356 the mangling now changes starting with the twelfth occurrence.  It also
2357 implies @option{-fnew-inheriting-ctors}.
2359 See also @option{-Wabi}.
2361 @item -fabi-compat-version=@var{n}
2362 @opindex fabi-compat-version
2363 On targets that support strong aliases, G++
2364 works around mangling changes by creating an alias with the correct
2365 mangled name when defining a symbol with an incorrect mangled name.
2366 This switch specifies which ABI version to use for the alias.
2368 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2369 compatibility).  If another ABI version is explicitly selected, this
2370 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2371 use @option{-fabi-compat-version=2}.
2373 If this option is not provided but @option{-Wabi=@var{n}} is, that
2374 version is used for compatibility aliases.  If this option is provided
2375 along with @option{-Wabi} (without the version), the version from this
2376 option is used for the warning.
2378 @item -fno-access-control
2379 @opindex fno-access-control
2380 Turn off all access checking.  This switch is mainly useful for working
2381 around bugs in the access control code.
2383 @item -faligned-new
2384 @opindex faligned-new
2385 Enable support for C++17 @code{new} of types that require more
2386 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2387 numeric argument such as @code{-faligned-new=32} can be used to
2388 specify how much alignment (in bytes) is provided by that function,
2389 but few users will need to override the default of
2390 @code{alignof(std::max_align_t)}.
2392 This flag is enabled by default for @option{-std=c++17}.
2394 @item -fcheck-new
2395 @opindex fcheck-new
2396 Check that the pointer returned by @code{operator new} is non-null
2397 before attempting to modify the storage allocated.  This check is
2398 normally unnecessary because the C++ standard specifies that
2399 @code{operator new} only returns @code{0} if it is declared
2400 @code{throw()}, in which case the compiler always checks the
2401 return value even without this option.  In all other cases, when
2402 @code{operator new} has a non-empty exception specification, memory
2403 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2404 @samp{new (nothrow)}.
2406 @item -fconcepts
2407 @opindex fconcepts
2408 Enable support for the C++ Extensions for Concepts Technical
2409 Specification, ISO 19217 (2015), which allows code like
2411 @smallexample
2412 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2413 template <Addable T> T add (T a, T b) @{ return a + b; @}
2414 @end smallexample
2416 @item -fconstexpr-depth=@var{n}
2417 @opindex fconstexpr-depth
2418 Set the maximum nested evaluation depth for C++11 constexpr functions
2419 to @var{n}.  A limit is needed to detect endless recursion during
2420 constant expression evaluation.  The minimum specified by the standard
2421 is 512.
2423 @item -fconstexpr-loop-limit=@var{n}
2424 @opindex fconstexpr-loop-limit
2425 Set the maximum number of iterations for a loop in C++14 constexpr functions
2426 to @var{n}.  A limit is needed to detect infinite loops during
2427 constant expression evaluation.  The default is 262144 (1<<18).
2429 @item -fdeduce-init-list
2430 @opindex fdeduce-init-list
2431 Enable deduction of a template type parameter as
2432 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2434 @smallexample
2435 template <class T> auto forward(T t) -> decltype (realfn (t))
2437   return realfn (t);
2440 void f()
2442   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2444 @end smallexample
2446 This deduction was implemented as a possible extension to the
2447 originally proposed semantics for the C++11 standard, but was not part
2448 of the final standard, so it is disabled by default.  This option is
2449 deprecated, and may be removed in a future version of G++.
2451 @item -ffriend-injection
2452 @opindex ffriend-injection
2453 Inject friend functions into the enclosing namespace, so that they are
2454 visible outside the scope of the class in which they are declared.
2455 Friend functions were documented to work this way in the old Annotated
2456 C++ Reference Manual.  
2457 However, in ISO C++ a friend function that is not declared
2458 in an enclosing scope can only be found using argument dependent
2459 lookup.  GCC defaults to the standard behavior.
2461 This option is deprecated and will be removed.
2463 @item -fno-elide-constructors
2464 @opindex fno-elide-constructors
2465 The C++ standard allows an implementation to omit creating a temporary
2466 that is only used to initialize another object of the same type.
2467 Specifying this option disables that optimization, and forces G++ to
2468 call the copy constructor in all cases.  This option also causes G++
2469 to call trivial member functions which otherwise would be expanded inline.
2471 In C++17, the compiler is required to omit these temporaries, but this
2472 option still affects trivial member functions.
2474 @item -fno-enforce-eh-specs
2475 @opindex fno-enforce-eh-specs
2476 Don't generate code to check for violation of exception specifications
2477 at run time.  This option violates the C++ standard, but may be useful
2478 for reducing code size in production builds, much like defining
2479 @code{NDEBUG}.  This does not give user code permission to throw
2480 exceptions in violation of the exception specifications; the compiler
2481 still optimizes based on the specifications, so throwing an
2482 unexpected exception results in undefined behavior at run time.
2484 @item -fextern-tls-init
2485 @itemx -fno-extern-tls-init
2486 @opindex fextern-tls-init
2487 @opindex fno-extern-tls-init
2488 The C++11 and OpenMP standards allow @code{thread_local} and
2489 @code{threadprivate} variables to have dynamic (runtime)
2490 initialization.  To support this, any use of such a variable goes
2491 through a wrapper function that performs any necessary initialization.
2492 When the use and definition of the variable are in the same
2493 translation unit, this overhead can be optimized away, but when the
2494 use is in a different translation unit there is significant overhead
2495 even if the variable doesn't actually need dynamic initialization.  If
2496 the programmer can be sure that no use of the variable in a
2497 non-defining TU needs to trigger dynamic initialization (either
2498 because the variable is statically initialized, or a use of the
2499 variable in the defining TU will be executed before any uses in
2500 another TU), they can avoid this overhead with the
2501 @option{-fno-extern-tls-init} option.
2503 On targets that support symbol aliases, the default is
2504 @option{-fextern-tls-init}.  On targets that do not support symbol
2505 aliases, the default is @option{-fno-extern-tls-init}.
2507 @item -ffor-scope
2508 @itemx -fno-for-scope
2509 @opindex ffor-scope
2510 @opindex fno-for-scope
2511 If @option{-ffor-scope} is specified, the scope of variables declared in
2512 a @i{for-init-statement} is limited to the @code{for} loop itself,
2513 as specified by the C++ standard.
2514 If @option{-fno-for-scope} is specified, the scope of variables declared in
2515 a @i{for-init-statement} extends to the end of the enclosing scope,
2516 as was the case in old versions of G++, and other (traditional)
2517 implementations of C++.
2519 This option is deprecated and the associated non-standard
2520 functionality will be removed.
2522 @item -fno-gnu-keywords
2523 @opindex fno-gnu-keywords
2524 Do not recognize @code{typeof} as a keyword, so that code can use this
2525 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2526 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2527 @option{-std=c++98}, @option{-std=c++11}, etc.
2529 @item -fno-implicit-templates
2530 @opindex fno-implicit-templates
2531 Never emit code for non-inline templates that are instantiated
2532 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2533 @xref{Template Instantiation}, for more information.
2535 @item -fno-implicit-inline-templates
2536 @opindex fno-implicit-inline-templates
2537 Don't emit code for implicit instantiations of inline templates, either.
2538 The default is to handle inlines differently so that compiles with and
2539 without optimization need the same set of explicit instantiations.
2541 @item -fno-implement-inlines
2542 @opindex fno-implement-inlines
2543 To save space, do not emit out-of-line copies of inline functions
2544 controlled by @code{#pragma implementation}.  This causes linker
2545 errors if these functions are not inlined everywhere they are called.
2547 @item -fms-extensions
2548 @opindex fms-extensions
2549 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2550 int and getting a pointer to member function via non-standard syntax.
2552 @item -fnew-inheriting-ctors
2553 @opindex fnew-inheriting-ctors
2554 Enable the P0136 adjustment to the semantics of C++11 constructor
2555 inheritance.  This is part of C++17 but also considered to be a Defect
2556 Report against C++11 and C++14.  This flag is enabled by default
2557 unless @option{-fabi-version=10} or lower is specified.
2559 @item -fnew-ttp-matching
2560 @opindex fnew-ttp-matching
2561 Enable the P0522 resolution to Core issue 150, template template
2562 parameters and default arguments: this allows a template with default
2563 template arguments as an argument for a template template parameter
2564 with fewer template parameters.  This flag is enabled by default for
2565 @option{-std=c++17}.
2567 @item -fno-nonansi-builtins
2568 @opindex fno-nonansi-builtins
2569 Disable built-in declarations of functions that are not mandated by
2570 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2571 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2573 @item -fnothrow-opt
2574 @opindex fnothrow-opt
2575 Treat a @code{throw()} exception specification as if it were a
2576 @code{noexcept} specification to reduce or eliminate the text size
2577 overhead relative to a function with no exception specification.  If
2578 the function has local variables of types with non-trivial
2579 destructors, the exception specification actually makes the
2580 function smaller because the EH cleanups for those variables can be
2581 optimized away.  The semantic effect is that an exception thrown out of
2582 a function with such an exception specification results in a call
2583 to @code{terminate} rather than @code{unexpected}.
2585 @item -fno-operator-names
2586 @opindex fno-operator-names
2587 Do not treat the operator name keywords @code{and}, @code{bitand},
2588 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2589 synonyms as keywords.
2591 @item -fno-optional-diags
2592 @opindex fno-optional-diags
2593 Disable diagnostics that the standard says a compiler does not need to
2594 issue.  Currently, the only such diagnostic issued by G++ is the one for
2595 a name having multiple meanings within a class.
2597 @item -fpermissive
2598 @opindex fpermissive
2599 Downgrade some diagnostics about nonconformant code from errors to
2600 warnings.  Thus, using @option{-fpermissive} allows some
2601 nonconforming code to compile.
2603 @item -fno-pretty-templates
2604 @opindex fno-pretty-templates
2605 When an error message refers to a specialization of a function
2606 template, the compiler normally prints the signature of the
2607 template followed by the template arguments and any typedefs or
2608 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2609 rather than @code{void f(int)}) so that it's clear which template is
2610 involved.  When an error message refers to a specialization of a class
2611 template, the compiler omits any template arguments that match
2612 the default template arguments for that template.  If either of these
2613 behaviors make it harder to understand the error message rather than
2614 easier, you can use @option{-fno-pretty-templates} to disable them.
2616 @item -frepo
2617 @opindex frepo
2618 Enable automatic template instantiation at link time.  This option also
2619 implies @option{-fno-implicit-templates}.  @xref{Template
2620 Instantiation}, for more information.
2622 @item -fno-rtti
2623 @opindex fno-rtti
2624 Disable generation of information about every class with virtual
2625 functions for use by the C++ run-time type identification features
2626 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2627 of the language, you can save some space by using this flag.  Note that
2628 exception handling uses the same information, but G++ generates it as
2629 needed. The @code{dynamic_cast} operator can still be used for casts that
2630 do not require run-time type information, i.e.@: casts to @code{void *} or to
2631 unambiguous base classes.
2633 @item -fsized-deallocation
2634 @opindex fsized-deallocation
2635 Enable the built-in global declarations
2636 @smallexample
2637 void operator delete (void *, std::size_t) noexcept;
2638 void operator delete[] (void *, std::size_t) noexcept;
2639 @end smallexample
2640 as introduced in C++14.  This is useful for user-defined replacement
2641 deallocation functions that, for example, use the size of the object
2642 to make deallocation faster.  Enabled by default under
2643 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2644 warns about places that might want to add a definition.
2646 @item -fstrict-enums
2647 @opindex fstrict-enums
2648 Allow the compiler to optimize using the assumption that a value of
2649 enumerated type can only be one of the values of the enumeration (as
2650 defined in the C++ standard; basically, a value that can be
2651 represented in the minimum number of bits needed to represent all the
2652 enumerators).  This assumption may not be valid if the program uses a
2653 cast to convert an arbitrary integer value to the enumerated type.
2655 @item -fstrong-eval-order
2656 @opindex fstrong-eval-order
2657 Evaluate member access, array subscripting, and shift expressions in
2658 left-to-right order, and evaluate assignment in right-to-left order,
2659 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2660 @option{-fstrong-eval-order=some} enables just the ordering of member
2661 access and shift expressions, and is the default without
2662 @option{-std=c++17}.
2664 @item -ftemplate-backtrace-limit=@var{n}
2665 @opindex ftemplate-backtrace-limit
2666 Set the maximum number of template instantiation notes for a single
2667 warning or error to @var{n}.  The default value is 10.
2669 @item -ftemplate-depth=@var{n}
2670 @opindex ftemplate-depth
2671 Set the maximum instantiation depth for template classes to @var{n}.
2672 A limit on the template instantiation depth is needed to detect
2673 endless recursions during template class instantiation.  ANSI/ISO C++
2674 conforming programs must not rely on a maximum depth greater than 17
2675 (changed to 1024 in C++11).  The default value is 900, as the compiler
2676 can run out of stack space before hitting 1024 in some situations.
2678 @item -fno-threadsafe-statics
2679 @opindex fno-threadsafe-statics
2680 Do not emit the extra code to use the routines specified in the C++
2681 ABI for thread-safe initialization of local statics.  You can use this
2682 option to reduce code size slightly in code that doesn't need to be
2683 thread-safe.
2685 @item -fuse-cxa-atexit
2686 @opindex fuse-cxa-atexit
2687 Register destructors for objects with static storage duration with the
2688 @code{__cxa_atexit} function rather than the @code{atexit} function.
2689 This option is required for fully standards-compliant handling of static
2690 destructors, but only works if your C library supports
2691 @code{__cxa_atexit}.
2693 @item -fno-use-cxa-get-exception-ptr
2694 @opindex fno-use-cxa-get-exception-ptr
2695 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2696 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2697 if the runtime routine is not available.
2699 @item -fvisibility-inlines-hidden
2700 @opindex fvisibility-inlines-hidden
2701 This switch declares that the user does not attempt to compare
2702 pointers to inline functions or methods where the addresses of the two functions
2703 are taken in different shared objects.
2705 The effect of this is that GCC may, effectively, mark inline methods with
2706 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2707 appear in the export table of a DSO and do not require a PLT indirection
2708 when used within the DSO@.  Enabling this option can have a dramatic effect
2709 on load and link times of a DSO as it massively reduces the size of the
2710 dynamic export table when the library makes heavy use of templates.
2712 The behavior of this switch is not quite the same as marking the
2713 methods as hidden directly, because it does not affect static variables
2714 local to the function or cause the compiler to deduce that
2715 the function is defined in only one shared object.
2717 You may mark a method as having a visibility explicitly to negate the
2718 effect of the switch for that method.  For example, if you do want to
2719 compare pointers to a particular inline method, you might mark it as
2720 having default visibility.  Marking the enclosing class with explicit
2721 visibility has no effect.
2723 Explicitly instantiated inline methods are unaffected by this option
2724 as their linkage might otherwise cross a shared library boundary.
2725 @xref{Template Instantiation}.
2727 @item -fvisibility-ms-compat
2728 @opindex fvisibility-ms-compat
2729 This flag attempts to use visibility settings to make GCC's C++
2730 linkage model compatible with that of Microsoft Visual Studio.
2732 The flag makes these changes to GCC's linkage model:
2734 @enumerate
2735 @item
2736 It sets the default visibility to @code{hidden}, like
2737 @option{-fvisibility=hidden}.
2739 @item
2740 Types, but not their members, are not hidden by default.
2742 @item
2743 The One Definition Rule is relaxed for types without explicit
2744 visibility specifications that are defined in more than one
2745 shared object: those declarations are permitted if they are
2746 permitted when this option is not used.
2747 @end enumerate
2749 In new code it is better to use @option{-fvisibility=hidden} and
2750 export those classes that are intended to be externally visible.
2751 Unfortunately it is possible for code to rely, perhaps accidentally,
2752 on the Visual Studio behavior.
2754 Among the consequences of these changes are that static data members
2755 of the same type with the same name but defined in different shared
2756 objects are different, so changing one does not change the other;
2757 and that pointers to function members defined in different shared
2758 objects may not compare equal.  When this flag is given, it is a
2759 violation of the ODR to define types with the same name differently.
2761 @item -fno-weak
2762 @opindex fno-weak
2763 Do not use weak symbol support, even if it is provided by the linker.
2764 By default, G++ uses weak symbols if they are available.  This
2765 option exists only for testing, and should not be used by end-users;
2766 it results in inferior code and has no benefits.  This option may
2767 be removed in a future release of G++.
2769 @item -nostdinc++
2770 @opindex nostdinc++
2771 Do not search for header files in the standard directories specific to
2772 C++, but do still search the other standard directories.  (This option
2773 is used when building the C++ library.)
2774 @end table
2776 In addition, these optimization, warning, and code generation options
2777 have meanings only for C++ programs:
2779 @table @gcctabopt
2780 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2781 @opindex Wabi
2782 @opindex Wno-abi
2783 Warn when G++ it generates code that is probably not compatible with
2784 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2785 ABI with each major release, normally @option{-Wabi} will warn only if
2786 there is a check added later in a release series for an ABI issue
2787 discovered since the initial release.  @option{-Wabi} will warn about
2788 more things if an older ABI version is selected (with
2789 @option{-fabi-version=@var{n}}).
2791 @option{-Wabi} can also be used with an explicit version number to
2792 warn about compatibility with a particular @option{-fabi-version}
2793 level, e.g. @option{-Wabi=2} to warn about changes relative to
2794 @option{-fabi-version=2}.
2796 If an explicit version number is provided and
2797 @option{-fabi-compat-version} is not specified, the version number
2798 from this option is used for compatibility aliases.  If no explicit
2799 version number is provided with this option, but
2800 @option{-fabi-compat-version} is specified, that version number is
2801 used for ABI warnings.
2803 Although an effort has been made to warn about
2804 all such cases, there are probably some cases that are not warned about,
2805 even though G++ is generating incompatible code.  There may also be
2806 cases where warnings are emitted even though the code that is generated
2807 is compatible.
2809 You should rewrite your code to avoid these warnings if you are
2810 concerned about the fact that code generated by G++ may not be binary
2811 compatible with code generated by other compilers.
2813 Known incompatibilities in @option{-fabi-version=2} (which was the
2814 default from GCC 3.4 to 4.9) include:
2816 @itemize @bullet
2818 @item
2819 A template with a non-type template parameter of reference type was
2820 mangled incorrectly:
2821 @smallexample
2822 extern int N;
2823 template <int &> struct S @{@};
2824 void n (S<N>) @{2@}
2825 @end smallexample
2827 This was fixed in @option{-fabi-version=3}.
2829 @item
2830 SIMD vector types declared using @code{__attribute ((vector_size))} were
2831 mangled in a non-standard way that does not allow for overloading of
2832 functions taking vectors of different sizes.
2834 The mangling was changed in @option{-fabi-version=4}.
2836 @item
2837 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2838 qualifiers, and @code{decltype} of a plain declaration was folded away.
2840 These mangling issues were fixed in @option{-fabi-version=5}.
2842 @item
2843 Scoped enumerators passed as arguments to a variadic function are
2844 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2845 On most targets this does not actually affect the parameter passing
2846 ABI, as there is no way to pass an argument smaller than @code{int}.
2848 Also, the ABI changed the mangling of template argument packs,
2849 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2850 a class scope function used as a template argument.
2852 These issues were corrected in @option{-fabi-version=6}.
2854 @item
2855 Lambdas in default argument scope were mangled incorrectly, and the
2856 ABI changed the mangling of @code{nullptr_t}.
2858 These issues were corrected in @option{-fabi-version=7}.
2860 @item
2861 When mangling a function type with function-cv-qualifiers, the
2862 un-qualified function type was incorrectly treated as a substitution
2863 candidate.
2865 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2867 @item
2868 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2869 unaligned accesses.  Note that this did not affect the ABI of a
2870 function with a @code{nullptr_t} parameter, as parameters have a
2871 minimum alignment.
2873 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2875 @item
2876 Target-specific attributes that affect the identity of a type, such as
2877 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2878 did not affect the mangled name, leading to name collisions when
2879 function pointers were used as template arguments.
2881 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2883 @end itemize
2885 It also warns about psABI-related changes.  The known psABI changes at this
2886 point include:
2888 @itemize @bullet
2890 @item
2891 For SysV/x86-64, unions with @code{long double} members are 
2892 passed in memory as specified in psABI.  For example:
2894 @smallexample
2895 union U @{
2896   long double ld;
2897   int i;
2899 @end smallexample
2901 @noindent
2902 @code{union U} is always passed in memory.
2904 @end itemize
2906 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2907 @opindex Wabi-tag
2908 @opindex -Wabi-tag
2909 Warn when a type with an ABI tag is used in a context that does not
2910 have that ABI tag.  See @ref{C++ Attributes} for more information
2911 about ABI tags.
2913 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2914 @opindex Wctor-dtor-privacy
2915 @opindex Wno-ctor-dtor-privacy
2916 Warn when a class seems unusable because all the constructors or
2917 destructors in that class are private, and it has neither friends nor
2918 public static member functions.  Also warn if there are no non-private
2919 methods, and there's at least one private member function that isn't
2920 a constructor or destructor.
2922 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2923 @opindex Wdelete-non-virtual-dtor
2924 @opindex Wno-delete-non-virtual-dtor
2925 Warn when @code{delete} is used to destroy an instance of a class that
2926 has virtual functions and non-virtual destructor. It is unsafe to delete
2927 an instance of a derived class through a pointer to a base class if the
2928 base class does not have a virtual destructor.  This warning is enabled
2929 by @option{-Wall}.
2931 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2932 @opindex Wliteral-suffix
2933 @opindex Wno-literal-suffix
2934 Warn when a string or character literal is followed by a ud-suffix which does
2935 not begin with an underscore.  As a conforming extension, GCC treats such
2936 suffixes as separate preprocessing tokens in order to maintain backwards
2937 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2938 For example:
2940 @smallexample
2941 #define __STDC_FORMAT_MACROS
2942 #include <inttypes.h>
2943 #include <stdio.h>
2945 int main() @{
2946   int64_t i64 = 123;
2947   printf("My int64: %" PRId64"\n", i64);
2949 @end smallexample
2951 In this case, @code{PRId64} is treated as a separate preprocessing token.
2953 Additionally, warn when a user-defined literal operator is declared with
2954 a literal suffix identifier that doesn't begin with an underscore. Literal
2955 suffix identifiers that don't begin with an underscore are reserved for
2956 future standardization.
2958 This warning is enabled by default.
2960 @item -Wlto-type-mismatch
2961 @opindex Wlto-type-mismatch
2962 @opindex Wno-lto-type-mismatch
2964 During the link-time optimization warn about type mismatches in
2965 global declarations from different compilation units.
2966 Requires @option{-flto} to be enabled.  Enabled by default.
2968 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2969 @opindex Wnarrowing
2970 @opindex Wno-narrowing
2971 For C++11 and later standards, narrowing conversions are diagnosed by default,
2972 as required by the standard.  A narrowing conversion from a constant produces
2973 an error, and a narrowing conversion from a non-constant produces a warning,
2974 but @option{-Wno-narrowing} suppresses the diagnostic.
2975 Note that this does not affect the meaning of well-formed code;
2976 narrowing conversions are still considered ill-formed in SFINAE contexts.
2978 With @option{-Wnarrowing} in C++98, warn when a narrowing
2979 conversion prohibited by C++11 occurs within
2980 @samp{@{ @}}, e.g.
2982 @smallexample
2983 int i = @{ 2.2 @}; // error: narrowing from double to int
2984 @end smallexample
2986 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2988 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2989 @opindex Wnoexcept
2990 @opindex Wno-noexcept
2991 Warn when a noexcept-expression evaluates to false because of a call
2992 to a function that does not have a non-throwing exception
2993 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2994 the compiler to never throw an exception.
2996 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2997 @opindex Wnoexcept-type
2998 @opindex Wno-noexcept-type
2999 Warn if the C++17 feature making @code{noexcept} part of a function
3000 type changes the mangled name of a symbol relative to C++14.  Enabled
3001 by @option{-Wabi} and @option{-Wc++17-compat}.
3003 As an example:
3005 @smallexample
3006 template <class T> void f(T t) @{ t(); @};
3007 void g() noexcept;
3008 void h() @{ f(g); @} 
3009 @end smallexample
3011 @noindent
3012 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
3013 C++17 it calls @code{f<void(*)()noexcept>}.
3015 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3016 @opindex Wclass-memaccess
3017 Warn when the destination of a call to a raw memory function such as
3018 @code{memset} or @code{memcpy} is an object of class type, and when writing
3019 into such an object might bypass the class non-trivial or deleted constructor
3020 or copy assignment, violate const-correctness or encapsulation, or corrupt
3021 virtual table pointers.  Modifying the representation of such objects may
3022 violate invariants maintained by member functions of the class.  For example,
3023 the call to @code{memset} below is undefined because it modifies a non-trivial
3024 class object and is, therefore, diagnosed.  The safe way to either initialize
3025 or clear the storage of objects of such types is by using the appropriate
3026 constructor or assignment operator, if one is available.
3027 @smallexample
3028 std::string str = "abc";
3029 memset (&str, 0, sizeof str);
3030 @end smallexample
3031 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3032 Explicitly casting the pointer to the class object to @code{void *} or
3033 to a type that can be safely accessed by the raw memory function suppresses
3034 the warning.
3036 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3037 @opindex Wnon-virtual-dtor
3038 @opindex Wno-non-virtual-dtor
3039 Warn when a class has virtual functions and an accessible non-virtual
3040 destructor itself or in an accessible polymorphic base class, in which
3041 case it is possible but unsafe to delete an instance of a derived
3042 class through a pointer to the class itself or base class.  This
3043 warning is automatically enabled if @option{-Weffc++} is specified.
3045 @item -Wregister @r{(C++ and Objective-C++ only)}
3046 @opindex Wregister
3047 @opindex Wno-register
3048 Warn on uses of the @code{register} storage class specifier, except
3049 when it is part of the GNU @ref{Explicit Register Variables} extension.
3050 The use of the @code{register} keyword as storage class specifier has
3051 been deprecated in C++11 and removed in C++17.
3052 Enabled by default with @option{-std=c++17}.
3054 @item -Wreorder @r{(C++ and Objective-C++ only)}
3055 @opindex Wreorder
3056 @opindex Wno-reorder
3057 @cindex reordering, warning
3058 @cindex warning for reordering of member initializers
3059 Warn when the order of member initializers given in the code does not
3060 match the order in which they must be executed.  For instance:
3062 @smallexample
3063 struct A @{
3064   int i;
3065   int j;
3066   A(): j (0), i (1) @{ @}
3068 @end smallexample
3070 @noindent
3071 The compiler rearranges the member initializers for @code{i}
3072 and @code{j} to match the declaration order of the members, emitting
3073 a warning to that effect.  This warning is enabled by @option{-Wall}.
3075 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3076 @opindex fext-numeric-literals
3077 @opindex fno-ext-numeric-literals
3078 Accept imaginary, fixed-point, or machine-defined
3079 literal number suffixes as GNU extensions.
3080 When this option is turned off these suffixes are treated
3081 as C++11 user-defined literal numeric suffixes.
3082 This is on by default for all pre-C++11 dialects and all GNU dialects:
3083 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3084 @option{-std=gnu++14}.
3085 This option is off by default
3086 for ISO C++11 onwards (@option{-std=c++11}, ...).
3087 @end table
3089 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3091 @table @gcctabopt
3092 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3093 @opindex Weffc++
3094 @opindex Wno-effc++
3095 Warn about violations of the following style guidelines from Scott Meyers'
3096 @cite{Effective C++} series of books:
3098 @itemize @bullet
3099 @item
3100 Define a copy constructor and an assignment operator for classes
3101 with dynamically-allocated memory.
3103 @item
3104 Prefer initialization to assignment in constructors.
3106 @item
3107 Have @code{operator=} return a reference to @code{*this}.
3109 @item
3110 Don't try to return a reference when you must return an object.
3112 @item
3113 Distinguish between prefix and postfix forms of increment and
3114 decrement operators.
3116 @item
3117 Never overload @code{&&}, @code{||}, or @code{,}.
3119 @end itemize
3121 This option also enables @option{-Wnon-virtual-dtor}, which is also
3122 one of the effective C++ recommendations.  However, the check is
3123 extended to warn about the lack of virtual destructor in accessible
3124 non-polymorphic bases classes too.
3126 When selecting this option, be aware that the standard library
3127 headers do not obey all of these guidelines; use @samp{grep -v}
3128 to filter out those warnings.
3130 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3131 @opindex Wstrict-null-sentinel
3132 @opindex Wno-strict-null-sentinel
3133 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3134 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3135 to @code{__null}.  Although it is a null pointer constant rather than a
3136 null pointer, it is guaranteed to be of the same size as a pointer.
3137 But this use is not portable across different compilers.
3139 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3140 @opindex Wno-non-template-friend
3141 @opindex Wnon-template-friend
3142 Disable warnings when non-template friend functions are declared
3143 within a template.  In very old versions of GCC that predate implementation
3144 of the ISO standard, declarations such as 
3145 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3146 could be interpreted as a particular specialization of a template
3147 function; the warning exists to diagnose compatibility problems, 
3148 and is enabled by default.
3150 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3151 @opindex Wold-style-cast
3152 @opindex Wno-old-style-cast
3153 Warn if an old-style (C-style) cast to a non-void type is used within
3154 a C++ program.  The new-style casts (@code{dynamic_cast},
3155 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3156 less vulnerable to unintended effects and much easier to search for.
3158 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3159 @opindex Woverloaded-virtual
3160 @opindex Wno-overloaded-virtual
3161 @cindex overloaded virtual function, warning
3162 @cindex warning for overloaded virtual function
3163 Warn when a function declaration hides virtual functions from a
3164 base class.  For example, in:
3166 @smallexample
3167 struct A @{
3168   virtual void f();
3171 struct B: public A @{
3172   void f(int);
3174 @end smallexample
3176 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3177 like:
3179 @smallexample
3180 B* b;
3181 b->f();
3182 @end smallexample
3184 @noindent
3185 fails to compile.
3187 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3188 @opindex Wno-pmf-conversions
3189 @opindex Wpmf-conversions
3190 Disable the diagnostic for converting a bound pointer to member function
3191 to a plain pointer.
3193 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3194 @opindex Wsign-promo
3195 @opindex Wno-sign-promo
3196 Warn when overload resolution chooses a promotion from unsigned or
3197 enumerated type to a signed type, over a conversion to an unsigned type of
3198 the same size.  Previous versions of G++ tried to preserve
3199 unsignedness, but the standard mandates the current behavior.
3201 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3202 @opindex Wtemplates
3203 Warn when a primary template declaration is encountered.  Some coding
3204 rules disallow templates, and this may be used to enforce that rule.
3205 The warning is inactive inside a system header file, such as the STL, so
3206 one can still use the STL.  One may also instantiate or specialize
3207 templates.
3209 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3210 @opindex Wmultiple-inheritance
3211 Warn when a class is defined with multiple direct base classes.  Some
3212 coding rules disallow multiple inheritance, and this may be used to
3213 enforce that rule.  The warning is inactive inside a system header file,
3214 such as the STL, so one can still use the STL.  One may also define
3215 classes that indirectly use multiple inheritance.
3217 @item -Wvirtual-inheritance
3218 @opindex Wvirtual-inheritance
3219 Warn when a class is defined with a virtual direct base class.  Some
3220 coding rules disallow multiple inheritance, and this may be used to
3221 enforce that rule.  The warning is inactive inside a system header file,
3222 such as the STL, so one can still use the STL.  One may also define
3223 classes that indirectly use virtual inheritance.
3225 @item -Wnamespaces
3226 @opindex Wnamespaces
3227 Warn when a namespace definition is opened.  Some coding rules disallow
3228 namespaces, and this may be used to enforce that rule.  The warning is
3229 inactive inside a system header file, such as the STL, so one can still
3230 use the STL.  One may also use using directives and qualified names.
3232 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3233 @opindex Wterminate
3234 @opindex Wno-terminate
3235 Disable the warning about a throw-expression that will immediately
3236 result in a call to @code{terminate}.
3237 @end table
3239 @node Objective-C and Objective-C++ Dialect Options
3240 @section Options Controlling Objective-C and Objective-C++ Dialects
3242 @cindex compiler options, Objective-C and Objective-C++
3243 @cindex Objective-C and Objective-C++ options, command-line
3244 @cindex options, Objective-C and Objective-C++
3245 (NOTE: This manual does not describe the Objective-C and Objective-C++
3246 languages themselves.  @xref{Standards,,Language Standards
3247 Supported by GCC}, for references.)
3249 This section describes the command-line options that are only meaningful
3250 for Objective-C and Objective-C++ programs.  You can also use most of
3251 the language-independent GNU compiler options.
3252 For example, you might compile a file @file{some_class.m} like this:
3254 @smallexample
3255 gcc -g -fgnu-runtime -O -c some_class.m
3256 @end smallexample
3258 @noindent
3259 In this example, @option{-fgnu-runtime} is an option meant only for
3260 Objective-C and Objective-C++ programs; you can use the other options with
3261 any language supported by GCC@.
3263 Note that since Objective-C is an extension of the C language, Objective-C
3264 compilations may also use options specific to the C front-end (e.g.,
3265 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3266 C++-specific options (e.g., @option{-Wabi}).
3268 Here is a list of options that are @emph{only} for compiling Objective-C
3269 and Objective-C++ programs:
3271 @table @gcctabopt
3272 @item -fconstant-string-class=@var{class-name}
3273 @opindex fconstant-string-class
3274 Use @var{class-name} as the name of the class to instantiate for each
3275 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3276 class name is @code{NXConstantString} if the GNU runtime is being used, and
3277 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3278 @option{-fconstant-cfstrings} option, if also present, overrides the
3279 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3280 to be laid out as constant CoreFoundation strings.
3282 @item -fgnu-runtime
3283 @opindex fgnu-runtime
3284 Generate object code compatible with the standard GNU Objective-C
3285 runtime.  This is the default for most types of systems.
3287 @item -fnext-runtime
3288 @opindex fnext-runtime
3289 Generate output compatible with the NeXT runtime.  This is the default
3290 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3291 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3292 used.
3294 @item -fno-nil-receivers
3295 @opindex fno-nil-receivers
3296 Assume that all Objective-C message dispatches (@code{[receiver
3297 message:arg]}) in this translation unit ensure that the receiver is
3298 not @code{nil}.  This allows for more efficient entry points in the
3299 runtime to be used.  This option is only available in conjunction with
3300 the NeXT runtime and ABI version 0 or 1.
3302 @item -fobjc-abi-version=@var{n}
3303 @opindex fobjc-abi-version
3304 Use version @var{n} of the Objective-C ABI for the selected runtime.
3305 This option is currently supported only for the NeXT runtime.  In that
3306 case, Version 0 is the traditional (32-bit) ABI without support for
3307 properties and other Objective-C 2.0 additions.  Version 1 is the
3308 traditional (32-bit) ABI with support for properties and other
3309 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3310 nothing is specified, the default is Version 0 on 32-bit target
3311 machines, and Version 2 on 64-bit target machines.
3313 @item -fobjc-call-cxx-cdtors
3314 @opindex fobjc-call-cxx-cdtors
3315 For each Objective-C class, check if any of its instance variables is a
3316 C++ object with a non-trivial default constructor.  If so, synthesize a
3317 special @code{- (id) .cxx_construct} instance method which runs
3318 non-trivial default constructors on any such instance variables, in order,
3319 and then return @code{self}.  Similarly, check if any instance variable
3320 is a C++ object with a non-trivial destructor, and if so, synthesize a
3321 special @code{- (void) .cxx_destruct} method which runs
3322 all such default destructors, in reverse order.
3324 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3325 methods thusly generated only operate on instance variables
3326 declared in the current Objective-C class, and not those inherited
3327 from superclasses.  It is the responsibility of the Objective-C
3328 runtime to invoke all such methods in an object's inheritance
3329 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3330 by the runtime immediately after a new object instance is allocated;
3331 the @code{- (void) .cxx_destruct} methods are invoked immediately
3332 before the runtime deallocates an object instance.
3334 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3335 support for invoking the @code{- (id) .cxx_construct} and
3336 @code{- (void) .cxx_destruct} methods.
3338 @item -fobjc-direct-dispatch
3339 @opindex fobjc-direct-dispatch
3340 Allow fast jumps to the message dispatcher.  On Darwin this is
3341 accomplished via the comm page.
3343 @item -fobjc-exceptions
3344 @opindex fobjc-exceptions
3345 Enable syntactic support for structured exception handling in
3346 Objective-C, similar to what is offered by C++.  This option
3347 is required to use the Objective-C keywords @code{@@try},
3348 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3349 @code{@@synchronized}.  This option is available with both the GNU
3350 runtime and the NeXT runtime (but not available in conjunction with
3351 the NeXT runtime on Mac OS X 10.2 and earlier).
3353 @item -fobjc-gc
3354 @opindex fobjc-gc
3355 Enable garbage collection (GC) in Objective-C and Objective-C++
3356 programs.  This option is only available with the NeXT runtime; the
3357 GNU runtime has a different garbage collection implementation that
3358 does not require special compiler flags.
3360 @item -fobjc-nilcheck
3361 @opindex fobjc-nilcheck
3362 For the NeXT runtime with version 2 of the ABI, check for a nil
3363 receiver in method invocations before doing the actual method call.
3364 This is the default and can be disabled using
3365 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3366 checked for nil in this way no matter what this flag is set to.
3367 Currently this flag does nothing when the GNU runtime, or an older
3368 version of the NeXT runtime ABI, is used.
3370 @item -fobjc-std=objc1
3371 @opindex fobjc-std
3372 Conform to the language syntax of Objective-C 1.0, the language
3373 recognized by GCC 4.0.  This only affects the Objective-C additions to
3374 the C/C++ language; it does not affect conformance to C/C++ standards,
3375 which is controlled by the separate C/C++ dialect option flags.  When
3376 this option is used with the Objective-C or Objective-C++ compiler,
3377 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3378 This is useful if you need to make sure that your Objective-C code can
3379 be compiled with older versions of GCC@.
3381 @item -freplace-objc-classes
3382 @opindex freplace-objc-classes
3383 Emit a special marker instructing @command{ld(1)} not to statically link in
3384 the resulting object file, and allow @command{dyld(1)} to load it in at
3385 run time instead.  This is used in conjunction with the Fix-and-Continue
3386 debugging mode, where the object file in question may be recompiled and
3387 dynamically reloaded in the course of program execution, without the need
3388 to restart the program itself.  Currently, Fix-and-Continue functionality
3389 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3390 and later.
3392 @item -fzero-link
3393 @opindex fzero-link
3394 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3395 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3396 compile time) with static class references that get initialized at load time,
3397 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3398 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3399 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3400 for individual class implementations to be modified during program execution.
3401 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3402 regardless of command-line options.
3404 @item -fno-local-ivars
3405 @opindex fno-local-ivars
3406 @opindex flocal-ivars
3407 By default instance variables in Objective-C can be accessed as if
3408 they were local variables from within the methods of the class they're
3409 declared in.  This can lead to shadowing between instance variables
3410 and other variables declared either locally inside a class method or
3411 globally with the same name.  Specifying the @option{-fno-local-ivars}
3412 flag disables this behavior thus avoiding variable shadowing issues.
3414 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3415 @opindex fivar-visibility
3416 Set the default instance variable visibility to the specified option
3417 so that instance variables declared outside the scope of any access
3418 modifier directives default to the specified visibility.
3420 @item -gen-decls
3421 @opindex gen-decls
3422 Dump interface declarations for all classes seen in the source file to a
3423 file named @file{@var{sourcename}.decl}.
3425 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3426 @opindex Wassign-intercept
3427 @opindex Wno-assign-intercept
3428 Warn whenever an Objective-C assignment is being intercepted by the
3429 garbage collector.
3431 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3432 @opindex Wno-protocol
3433 @opindex Wprotocol
3434 If a class is declared to implement a protocol, a warning is issued for
3435 every method in the protocol that is not implemented by the class.  The
3436 default behavior is to issue a warning for every method not explicitly
3437 implemented in the class, even if a method implementation is inherited
3438 from the superclass.  If you use the @option{-Wno-protocol} option, then
3439 methods inherited from the superclass are considered to be implemented,
3440 and no warning is issued for them.
3442 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3443 @opindex Wselector
3444 @opindex Wno-selector
3445 Warn if multiple methods of different types for the same selector are
3446 found during compilation.  The check is performed on the list of methods
3447 in the final stage of compilation.  Additionally, a check is performed
3448 for each selector appearing in a @code{@@selector(@dots{})}
3449 expression, and a corresponding method for that selector has been found
3450 during compilation.  Because these checks scan the method table only at
3451 the end of compilation, these warnings are not produced if the final
3452 stage of compilation is not reached, for example because an error is
3453 found during compilation, or because the @option{-fsyntax-only} option is
3454 being used.
3456 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3457 @opindex Wstrict-selector-match
3458 @opindex Wno-strict-selector-match
3459 Warn if multiple methods with differing argument and/or return types are
3460 found for a given selector when attempting to send a message using this
3461 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3462 is off (which is the default behavior), the compiler omits such warnings
3463 if any differences found are confined to types that share the same size
3464 and alignment.
3466 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3467 @opindex Wundeclared-selector
3468 @opindex Wno-undeclared-selector
3469 Warn if a @code{@@selector(@dots{})} expression referring to an
3470 undeclared selector is found.  A selector is considered undeclared if no
3471 method with that name has been declared before the
3472 @code{@@selector(@dots{})} expression, either explicitly in an
3473 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3474 an @code{@@implementation} section.  This option always performs its
3475 checks as soon as a @code{@@selector(@dots{})} expression is found,
3476 while @option{-Wselector} only performs its checks in the final stage of
3477 compilation.  This also enforces the coding style convention
3478 that methods and selectors must be declared before being used.
3480 @item -print-objc-runtime-info
3481 @opindex print-objc-runtime-info
3482 Generate C header describing the largest structure that is passed by
3483 value, if any.
3485 @end table
3487 @node Diagnostic Message Formatting Options
3488 @section Options to Control Diagnostic Messages Formatting
3489 @cindex options to control diagnostics formatting
3490 @cindex diagnostic messages
3491 @cindex message formatting
3493 Traditionally, diagnostic messages have been formatted irrespective of
3494 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3495 options described below
3496 to control the formatting algorithm for diagnostic messages, 
3497 e.g.@: how many characters per line, how often source location
3498 information should be reported.  Note that some language front ends may not
3499 honor these options.
3501 @table @gcctabopt
3502 @item -fmessage-length=@var{n}
3503 @opindex fmessage-length
3504 Try to format error messages so that they fit on lines of about
3505 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3506 done; each error message appears on a single line.  This is the
3507 default for all front ends.
3509 @item -fdiagnostics-show-location=once
3510 @opindex fdiagnostics-show-location
3511 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3512 reporter to emit source location information @emph{once}; that is, in
3513 case the message is too long to fit on a single physical line and has to
3514 be wrapped, the source location won't be emitted (as prefix) again,
3515 over and over, in subsequent continuation lines.  This is the default
3516 behavior.
3518 @item -fdiagnostics-show-location=every-line
3519 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3520 messages reporter to emit the same source location information (as
3521 prefix) for physical lines that result from the process of breaking
3522 a message which is too long to fit on a single line.
3524 @item -fdiagnostics-color[=@var{WHEN}]
3525 @itemx -fno-diagnostics-color
3526 @opindex fdiagnostics-color
3527 @cindex highlight, color
3528 @vindex GCC_COLORS @r{environment variable}
3529 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3530 or @samp{auto}.  The default depends on how the compiler has been configured,
3531 it can be any of the above @var{WHEN} options or also @samp{never}
3532 if @env{GCC_COLORS} environment variable isn't present in the environment,
3533 and @samp{auto} otherwise.
3534 @samp{auto} means to use color only when the standard error is a terminal.
3535 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3536 aliases for @option{-fdiagnostics-color=always} and
3537 @option{-fdiagnostics-color=never}, respectively.
3539 The colors are defined by the environment variable @env{GCC_COLORS}.
3540 Its value is a colon-separated list of capabilities and Select Graphic
3541 Rendition (SGR) substrings. SGR commands are interpreted by the
3542 terminal or terminal emulator.  (See the section in the documentation
3543 of your text terminal for permitted values and their meanings as
3544 character attributes.)  These substring values are integers in decimal
3545 representation and can be concatenated with semicolons.
3546 Common values to concatenate include
3547 @samp{1} for bold,
3548 @samp{4} for underline,
3549 @samp{5} for blink,
3550 @samp{7} for inverse,
3551 @samp{39} for default foreground color,
3552 @samp{30} to @samp{37} for foreground colors,
3553 @samp{90} to @samp{97} for 16-color mode foreground colors,
3554 @samp{38;5;0} to @samp{38;5;255}
3555 for 88-color and 256-color modes foreground colors,
3556 @samp{49} for default background color,
3557 @samp{40} to @samp{47} for background colors,
3558 @samp{100} to @samp{107} for 16-color mode background colors,
3559 and @samp{48;5;0} to @samp{48;5;255}
3560 for 88-color and 256-color modes background colors.
3562 The default @env{GCC_COLORS} is
3563 @smallexample
3564 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3565 quote=01:fixit-insert=32:fixit-delete=31:\
3566 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3567 type-diff=01;32
3568 @end smallexample
3569 @noindent
3570 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3571 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3572 @samp{01} is bold, and @samp{31} is red.
3573 Setting @env{GCC_COLORS} to the empty string disables colors.
3574 Supported capabilities are as follows.
3576 @table @code
3577 @item error=
3578 @vindex error GCC_COLORS @r{capability}
3579 SGR substring for error: markers.
3581 @item warning=
3582 @vindex warning GCC_COLORS @r{capability}
3583 SGR substring for warning: markers.
3585 @item note=
3586 @vindex note GCC_COLORS @r{capability}
3587 SGR substring for note: markers.
3589 @item range1=
3590 @vindex range1 GCC_COLORS @r{capability}
3591 SGR substring for first additional range.
3593 @item range2=
3594 @vindex range2 GCC_COLORS @r{capability}
3595 SGR substring for second additional range.
3597 @item locus=
3598 @vindex locus GCC_COLORS @r{capability}
3599 SGR substring for location information, @samp{file:line} or
3600 @samp{file:line:column} etc.
3602 @item quote=
3603 @vindex quote GCC_COLORS @r{capability}
3604 SGR substring for information printed within quotes.
3606 @item fixit-insert=
3607 @vindex fixit-insert GCC_COLORS @r{capability}
3608 SGR substring for fix-it hints suggesting text to
3609 be inserted or replaced.
3611 @item fixit-delete=
3612 @vindex fixit-delete GCC_COLORS @r{capability}
3613 SGR substring for fix-it hints suggesting text to
3614 be deleted.
3616 @item diff-filename=
3617 @vindex diff-filename GCC_COLORS @r{capability}
3618 SGR substring for filename headers within generated patches.
3620 @item diff-hunk=
3621 @vindex diff-hunk GCC_COLORS @r{capability}
3622 SGR substring for the starts of hunks within generated patches.
3624 @item diff-delete=
3625 @vindex diff-delete GCC_COLORS @r{capability}
3626 SGR substring for deleted lines within generated patches.
3628 @item diff-insert=
3629 @vindex diff-insert GCC_COLORS @r{capability}
3630 SGR substring for inserted lines within generated patches.
3632 @item type-diff=
3633 @vindex type-diff GCC_COLORS @r{capability}
3634 SGR substring for highlighting mismatching types within template
3635 arguments in the C++ frontend.
3636 @end table
3638 @item -fno-diagnostics-show-option
3639 @opindex fno-diagnostics-show-option
3640 @opindex fdiagnostics-show-option
3641 By default, each diagnostic emitted includes text indicating the
3642 command-line option that directly controls the diagnostic (if such an
3643 option is known to the diagnostic machinery).  Specifying the
3644 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3646 @item -fno-diagnostics-show-caret
3647 @opindex fno-diagnostics-show-caret
3648 @opindex fdiagnostics-show-caret
3649 By default, each diagnostic emitted includes the original source line
3650 and a caret @samp{^} indicating the column.  This option suppresses this
3651 information.  The source line is truncated to @var{n} characters, if
3652 the @option{-fmessage-length=n} option is given.  When the output is done
3653 to the terminal, the width is limited to the width given by the
3654 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3656 @item -fdiagnostics-parseable-fixits
3657 @opindex fdiagnostics-parseable-fixits
3658 Emit fix-it hints in a machine-parseable format, suitable for consumption
3659 by IDEs.  For each fix-it, a line will be printed after the relevant
3660 diagnostic, starting with the string ``fix-it:''.  For example:
3662 @smallexample
3663 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3664 @end smallexample
3666 The location is expressed as a half-open range, expressed as a count of
3667 bytes, starting at byte 1 for the initial column.  In the above example,
3668 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3669 given string:
3671 @smallexample
3672 00000000011111111112222222222
3673 12345678901234567890123456789
3674   gtk_widget_showall (dlg);
3675   ^^^^^^^^^^^^^^^^^^
3676   gtk_widget_show_all
3677 @end smallexample
3679 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3680 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3681 (e.g. vertical tab as ``\013'').
3683 An empty replacement string indicates that the given range is to be removed.
3684 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3685 be inserted at the given position.
3687 @item -fdiagnostics-generate-patch
3688 @opindex fdiagnostics-generate-patch
3689 Print fix-it hints to stderr in unified diff format, after any diagnostics
3690 are printed.  For example:
3692 @smallexample
3693 --- test.c
3694 +++ test.c
3695 @@ -42,5 +42,5 @@
3697  void show_cb(GtkDialog *dlg)
3698  @{
3699 -  gtk_widget_showall(dlg);
3700 +  gtk_widget_show_all(dlg);
3701  @}
3703 @end smallexample
3705 The diff may or may not be colorized, following the same rules
3706 as for diagnostics (see @option{-fdiagnostics-color}).
3708 @item -fdiagnostics-show-template-tree
3709 @opindex fdiagnostics-show-template-tree
3711 In the C++ frontend, when printing diagnostics showing mismatching
3712 template types, such as:
3714 @smallexample
3715   could not convert 'std::map<int, std::vector<double> >()'
3716     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3717 @end smallexample
3719 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3720 tree-like structure showing the common and differing parts of the types,
3721 such as:
3723 @smallexample
3724   map<
3725     [...],
3726     vector<
3727       [double != float]>>
3728 @end smallexample
3730 The parts that differ are highlighted with color (``double'' and
3731 ``float'' in this case).
3733 @item -fno-elide-type
3734 @opindex fno-elide-type
3735 @opindex felide-type
3736 By default when the C++ frontend prints diagnostics showing mismatching
3737 template types, common parts of the types are printed as ``[...]'' to
3738 simplify the error message.  For example:
3740 @smallexample
3741   could not convert 'std::map<int, std::vector<double> >()'
3742     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3743 @end smallexample
3745 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3746 This flag also affects the output of the
3747 @option{-fdiagnostics-show-template-tree} flag.
3749 @item -fno-show-column
3750 @opindex fno-show-column
3751 Do not print column numbers in diagnostics.  This may be necessary if
3752 diagnostics are being scanned by a program that does not understand the
3753 column numbers, such as @command{dejagnu}.
3755 @end table
3757 @node Warning Options
3758 @section Options to Request or Suppress Warnings
3759 @cindex options to control warnings
3760 @cindex warning messages
3761 @cindex messages, warning
3762 @cindex suppressing warnings
3764 Warnings are diagnostic messages that report constructions that
3765 are not inherently erroneous but that are risky or suggest there
3766 may have been an error.
3768 The following language-independent options do not enable specific
3769 warnings but control the kinds of diagnostics produced by GCC@.
3771 @table @gcctabopt
3772 @cindex syntax checking
3773 @item -fsyntax-only
3774 @opindex fsyntax-only
3775 Check the code for syntax errors, but don't do anything beyond that.
3777 @item -fmax-errors=@var{n}
3778 @opindex fmax-errors
3779 Limits the maximum number of error messages to @var{n}, at which point
3780 GCC bails out rather than attempting to continue processing the source
3781 code.  If @var{n} is 0 (the default), there is no limit on the number
3782 of error messages produced.  If @option{-Wfatal-errors} is also
3783 specified, then @option{-Wfatal-errors} takes precedence over this
3784 option.
3786 @item -w
3787 @opindex w
3788 Inhibit all warning messages.
3790 @item -Werror
3791 @opindex Werror
3792 @opindex Wno-error
3793 Make all warnings into errors.
3795 @item -Werror=
3796 @opindex Werror=
3797 @opindex Wno-error=
3798 Make the specified warning into an error.  The specifier for a warning
3799 is appended; for example @option{-Werror=switch} turns the warnings
3800 controlled by @option{-Wswitch} into errors.  This switch takes a
3801 negative form, to be used to negate @option{-Werror} for specific
3802 warnings; for example @option{-Wno-error=switch} makes
3803 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3804 is in effect.
3806 The warning message for each controllable warning includes the
3807 option that controls the warning.  That option can then be used with
3808 @option{-Werror=} and @option{-Wno-error=} as described above.
3809 (Printing of the option in the warning message can be disabled using the
3810 @option{-fno-diagnostics-show-option} flag.)
3812 Note that specifying @option{-Werror=}@var{foo} automatically implies
3813 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3814 imply anything.
3816 @item -Wfatal-errors
3817 @opindex Wfatal-errors
3818 @opindex Wno-fatal-errors
3819 This option causes the compiler to abort compilation on the first error
3820 occurred rather than trying to keep going and printing further error
3821 messages.
3823 @end table
3825 You can request many specific warnings with options beginning with
3826 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3827 implicit declarations.  Each of these specific warning options also
3828 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3829 example, @option{-Wno-implicit}.  This manual lists only one of the
3830 two forms, whichever is not the default.  For further
3831 language-specific options also refer to @ref{C++ Dialect Options} and
3832 @ref{Objective-C and Objective-C++ Dialect Options}.
3834 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3835 options, such as @option{-Wunused}, which may turn on further options,
3836 such as @option{-Wunused-value}. The combined effect of positive and
3837 negative forms is that more specific options have priority over less
3838 specific ones, independently of their position in the command-line. For
3839 options of the same specificity, the last one takes effect. Options
3840 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3841 as if they appeared at the end of the command-line.
3843 When an unrecognized warning option is requested (e.g.,
3844 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3845 that the option is not recognized.  However, if the @option{-Wno-} form
3846 is used, the behavior is slightly different: no diagnostic is
3847 produced for @option{-Wno-unknown-warning} unless other diagnostics
3848 are being produced.  This allows the use of new @option{-Wno-} options
3849 with old compilers, but if something goes wrong, the compiler
3850 warns that an unrecognized option is present.
3852 @table @gcctabopt
3853 @item -Wpedantic
3854 @itemx -pedantic
3855 @opindex pedantic
3856 @opindex Wpedantic
3857 Issue all the warnings demanded by strict ISO C and ISO C++;
3858 reject all programs that use forbidden extensions, and some other
3859 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3860 version of the ISO C standard specified by any @option{-std} option used.
3862 Valid ISO C and ISO C++ programs should compile properly with or without
3863 this option (though a rare few require @option{-ansi} or a
3864 @option{-std} option specifying the required version of ISO C)@.  However,
3865 without this option, certain GNU extensions and traditional C and C++
3866 features are supported as well.  With this option, they are rejected.
3868 @option{-Wpedantic} does not cause warning messages for use of the
3869 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3870 warnings are also disabled in the expression that follows
3871 @code{__extension__}.  However, only system header files should use
3872 these escape routes; application programs should avoid them.
3873 @xref{Alternate Keywords}.
3875 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3876 C conformance.  They soon find that it does not do quite what they want:
3877 it finds some non-ISO practices, but not all---only those for which
3878 ISO C @emph{requires} a diagnostic, and some others for which
3879 diagnostics have been added.
3881 A feature to report any failure to conform to ISO C might be useful in
3882 some instances, but would require considerable additional work and would
3883 be quite different from @option{-Wpedantic}.  We don't have plans to
3884 support such a feature in the near future.
3886 Where the standard specified with @option{-std} represents a GNU
3887 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3888 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3889 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3890 where they are required by the base standard.  (It does not make sense
3891 for such warnings to be given only for features not in the specified GNU
3892 C dialect, since by definition the GNU dialects of C include all
3893 features the compiler supports with the given option, and there would be
3894 nothing to warn about.)
3896 @item -pedantic-errors
3897 @opindex pedantic-errors
3898 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3899 requires a diagnostic, in some cases where there is undefined behavior
3900 at compile-time and in some other cases that do not prevent compilation
3901 of programs that are valid according to the standard. This is not
3902 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3903 by this option and not enabled by the latter and vice versa.
3905 @item -Wall
3906 @opindex Wall
3907 @opindex Wno-all
3908 This enables all the warnings about constructions that some users
3909 consider questionable, and that are easy to avoid (or modify to
3910 prevent the warning), even in conjunction with macros.  This also
3911 enables some language-specific warnings described in @ref{C++ Dialect
3912 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3914 @option{-Wall} turns on the following warning flags:
3916 @gccoptlist{-Waddress   @gol
3917 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3918 -Wbool-compare  @gol
3919 -Wbool-operation  @gol
3920 -Wc++11-compat  -Wc++14-compat  @gol
3921 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3922 -Wchar-subscripts  @gol
3923 -Wcomment  @gol
3924 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3925 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3926 -Wformat   @gol
3927 -Wint-in-bool-context  @gol
3928 -Wimplicit @r{(C and Objective-C only)} @gol
3929 -Wimplicit-int @r{(C and Objective-C only)} @gol
3930 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3931 -Winit-self @r{(only for C++)} @gol
3932 -Wlogical-not-parentheses @gol
3933 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3934 -Wmaybe-uninitialized @gol
3935 -Wmemset-elt-size @gol
3936 -Wmemset-transposed-args @gol
3937 -Wmisleading-indentation @r{(only for C/C++)} @gol
3938 -Wmissing-attributes @gol
3939 -Wmissing-braces @r{(only for C/ObjC)} @gol
3940 -Wmultistatement-macros  @gol
3941 -Wnarrowing @r{(only for C++)}  @gol
3942 -Wnonnull  @gol
3943 -Wnonnull-compare  @gol
3944 -Wopenmp-simd @gol
3945 -Wparentheses  @gol
3946 -Wpointer-sign  @gol
3947 -Wreorder   @gol
3948 -Wrestrict   @gol
3949 -Wreturn-type  @gol
3950 -Wsequence-point  @gol
3951 -Wsign-compare @r{(only in C++)}  @gol
3952 -Wsizeof-pointer-div @gol
3953 -Wsizeof-pointer-memaccess @gol
3954 -Wstrict-aliasing  @gol
3955 -Wstrict-overflow=1  @gol
3956 -Wswitch  @gol
3957 -Wtautological-compare  @gol
3958 -Wtrigraphs  @gol
3959 -Wuninitialized  @gol
3960 -Wunknown-pragmas  @gol
3961 -Wunused-function  @gol
3962 -Wunused-label     @gol
3963 -Wunused-value     @gol
3964 -Wunused-variable  @gol
3965 -Wvolatile-register-var @gol
3968 Note that some warning flags are not implied by @option{-Wall}.  Some of
3969 them warn about constructions that users generally do not consider
3970 questionable, but which occasionally you might wish to check for;
3971 others warn about constructions that are necessary or hard to avoid in
3972 some cases, and there is no simple way to modify the code to suppress
3973 the warning. Some of them are enabled by @option{-Wextra} but many of
3974 them must be enabled individually.
3976 @item -Wextra
3977 @opindex W
3978 @opindex Wextra
3979 @opindex Wno-extra
3980 This enables some extra warning flags that are not enabled by
3981 @option{-Wall}. (This option used to be called @option{-W}.  The older
3982 name is still supported, but the newer name is more descriptive.)
3984 @gccoptlist{-Wclobbered  @gol
3985 -Wcast-function-type  @gol
3986 -Wempty-body  @gol
3987 -Wignored-qualifiers @gol
3988 -Wimplicit-fallthrough=3 @gol
3989 -Wmissing-field-initializers  @gol
3990 -Wmissing-parameter-type @r{(C only)}  @gol
3991 -Wold-style-declaration @r{(C only)}  @gol
3992 -Woverride-init  @gol
3993 -Wsign-compare @r{(C only)} @gol
3994 -Wtype-limits  @gol
3995 -Wuninitialized  @gol
3996 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3997 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3998 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
4001 The option @option{-Wextra} also prints warning messages for the
4002 following cases:
4004 @itemize @bullet
4006 @item
4007 A pointer is compared against integer zero with @code{<}, @code{<=},
4008 @code{>}, or @code{>=}.
4010 @item
4011 (C++ only) An enumerator and a non-enumerator both appear in a
4012 conditional expression.
4014 @item
4015 (C++ only) Ambiguous virtual bases.
4017 @item
4018 (C++ only) Subscripting an array that has been declared @code{register}.
4020 @item
4021 (C++ only) Taking the address of a variable that has been declared
4022 @code{register}.
4024 @item
4025 (C++ only) A base class is not initialized in the copy constructor
4026 of a derived class.
4028 @end itemize
4030 @item -Wchar-subscripts
4031 @opindex Wchar-subscripts
4032 @opindex Wno-char-subscripts
4033 Warn if an array subscript has type @code{char}.  This is a common cause
4034 of error, as programmers often forget that this type is signed on some
4035 machines.
4036 This warning is enabled by @option{-Wall}.
4038 @item -Wchkp
4039 @opindex Wchkp
4040 Warn about an invalid memory access that is found by Pointer Bounds Checker
4041 (@option{-fcheck-pointer-bounds}).
4043 @item -Wno-coverage-mismatch
4044 @opindex Wno-coverage-mismatch
4045 Warn if feedback profiles do not match when using the
4046 @option{-fprofile-use} option.
4047 If a source file is changed between compiling with @option{-fprofile-gen} and
4048 with @option{-fprofile-use}, the files with the profile feedback can fail
4049 to match the source file and GCC cannot use the profile feedback
4050 information.  By default, this warning is enabled and is treated as an
4051 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4052 warning or @option{-Wno-error=coverage-mismatch} can be used to
4053 disable the error.  Disabling the error for this warning can result in
4054 poorly optimized code and is useful only in the
4055 case of very minor changes such as bug fixes to an existing code-base.
4056 Completely disabling the warning is not recommended.
4058 @item -Wno-cpp
4059 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4061 Suppress warning messages emitted by @code{#warning} directives.
4063 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4064 @opindex Wdouble-promotion
4065 @opindex Wno-double-promotion
4066 Give a warning when a value of type @code{float} is implicitly
4067 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4068 floating-point unit implement @code{float} in hardware, but emulate
4069 @code{double} in software.  On such a machine, doing computations
4070 using @code{double} values is much more expensive because of the
4071 overhead required for software emulation.
4073 It is easy to accidentally do computations with @code{double} because
4074 floating-point literals are implicitly of type @code{double}.  For
4075 example, in:
4076 @smallexample
4077 @group
4078 float area(float radius)
4080    return 3.14159 * radius * radius;
4082 @end group
4083 @end smallexample
4084 the compiler performs the entire computation with @code{double}
4085 because the floating-point literal is a @code{double}.
4087 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4088 @opindex Wduplicate-decl-specifier
4089 @opindex Wno-duplicate-decl-specifier
4090 Warn if a declaration has duplicate @code{const}, @code{volatile},
4091 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4092 @option{-Wall}.
4094 @item -Wformat
4095 @itemx -Wformat=@var{n}
4096 @opindex Wformat
4097 @opindex Wno-format
4098 @opindex ffreestanding
4099 @opindex fno-builtin
4100 @opindex Wformat=
4101 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4102 the arguments supplied have types appropriate to the format string
4103 specified, and that the conversions specified in the format string make
4104 sense.  This includes standard functions, and others specified by format
4105 attributes (@pxref{Function Attributes}), in the @code{printf},
4106 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4107 not in the C standard) families (or other target-specific families).
4108 Which functions are checked without format attributes having been
4109 specified depends on the standard version selected, and such checks of
4110 functions without the attribute specified are disabled by
4111 @option{-ffreestanding} or @option{-fno-builtin}.
4113 The formats are checked against the format features supported by GNU
4114 libc version 2.2.  These include all ISO C90 and C99 features, as well
4115 as features from the Single Unix Specification and some BSD and GNU
4116 extensions.  Other library implementations may not support all these
4117 features; GCC does not support warning about features that go beyond a
4118 particular library's limitations.  However, if @option{-Wpedantic} is used
4119 with @option{-Wformat}, warnings are given about format features not
4120 in the selected standard version (but not for @code{strfmon} formats,
4121 since those are not in any version of the C standard).  @xref{C Dialect
4122 Options,,Options Controlling C Dialect}.
4124 @table @gcctabopt
4125 @item -Wformat=1
4126 @itemx -Wformat
4127 @opindex Wformat
4128 @opindex Wformat=1
4129 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4130 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4131 @option{-Wformat} also checks for null format arguments for several
4132 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4133 aspects of this level of format checking can be disabled by the
4134 options: @option{-Wno-format-contains-nul},
4135 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4136 @option{-Wformat} is enabled by @option{-Wall}.
4138 @item -Wno-format-contains-nul
4139 @opindex Wno-format-contains-nul
4140 @opindex Wformat-contains-nul
4141 If @option{-Wformat} is specified, do not warn about format strings that
4142 contain NUL bytes.
4144 @item -Wno-format-extra-args
4145 @opindex Wno-format-extra-args
4146 @opindex Wformat-extra-args
4147 If @option{-Wformat} is specified, do not warn about excess arguments to a
4148 @code{printf} or @code{scanf} format function.  The C standard specifies
4149 that such arguments are ignored.
4151 Where the unused arguments lie between used arguments that are
4152 specified with @samp{$} operand number specifications, normally
4153 warnings are still given, since the implementation could not know what
4154 type to pass to @code{va_arg} to skip the unused arguments.  However,
4155 in the case of @code{scanf} formats, this option suppresses the
4156 warning if the unused arguments are all pointers, since the Single
4157 Unix Specification says that such unused arguments are allowed.
4159 @item -Wformat-overflow
4160 @itemx -Wformat-overflow=@var{level}
4161 @opindex Wformat-overflow
4162 @opindex Wno-format-overflow
4163 Warn about calls to formatted input/output functions such as @code{sprintf}
4164 and @code{vsprintf} that might overflow the destination buffer.  When the
4165 exact number of bytes written by a format directive cannot be determined
4166 at compile-time it is estimated based on heuristics that depend on the
4167 @var{level} argument and on optimization.  While enabling optimization
4168 will in most cases improve the accuracy of the warning, it may also
4169 result in false positives.
4171 @table @gcctabopt
4172 @item -Wformat-overflow
4173 @itemx -Wformat-overflow=1
4174 @opindex Wformat-overflow
4175 @opindex Wno-format-overflow
4176 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4177 employs a conservative approach that warns only about calls that most
4178 likely overflow the buffer.  At this level, numeric arguments to format
4179 directives with unknown values are assumed to have the value of one, and
4180 strings of unknown length to be empty.  Numeric arguments that are known
4181 to be bounded to a subrange of their type, or string arguments whose output
4182 is bounded either by their directive's precision or by a finite set of
4183 string literals, are assumed to take on the value within the range that
4184 results in the most bytes on output.  For example, the call to @code{sprintf}
4185 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4186 the terminating NUL character (@code{'\0'}) appended by the function
4187 to the destination buffer will be written past its end.  Increasing
4188 the size of the buffer by a single byte is sufficient to avoid the
4189 warning, though it may not be sufficient to avoid the overflow.
4191 @smallexample
4192 void f (int a, int b)
4194   char buf [13];
4195   sprintf (buf, "a = %i, b = %i\n", a, b);
4197 @end smallexample
4199 @item -Wformat-overflow=2
4200 Level @var{2} warns also about calls that might overflow the destination
4201 buffer given an argument of sufficient length or magnitude.  At level
4202 @var{2}, unknown numeric arguments are assumed to have the minimum
4203 representable value for signed types with a precision greater than 1, and
4204 the maximum representable value otherwise.  Unknown string arguments whose
4205 length cannot be assumed to be bounded either by the directive's precision,
4206 or by a finite set of string literals they may evaluate to, or the character
4207 array they may point to, are assumed to be 1 character long.
4209 At level @var{2}, the call in the example above is again diagnosed, but
4210 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4211 @code{%i} directive will write some of its digits beyond the end of
4212 the destination buffer.  To make the call safe regardless of the values
4213 of the two variables, the size of the destination buffer must be increased
4214 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4215 an informational note following the warning.
4217 An alternative to increasing the size of the destination buffer is to
4218 constrain the range of formatted values.  The maximum length of string
4219 arguments can be bounded by specifying the precision in the format
4220 directive.  When numeric arguments of format directives can be assumed
4221 to be bounded by less than the precision of their type, choosing
4222 an appropriate length modifier to the format specifier will reduce
4223 the required buffer size.  For example, if @var{a} and @var{b} in the
4224 example above can be assumed to be within the precision of
4225 the @code{short int} type then using either the @code{%hi} format
4226 directive or casting the argument to @code{short} reduces the maximum
4227 required size of the buffer to 24 bytes.
4229 @smallexample
4230 void f (int a, int b)
4232   char buf [23];
4233   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4235 @end smallexample
4236 @end table
4238 @item -Wno-format-zero-length
4239 @opindex Wno-format-zero-length
4240 @opindex Wformat-zero-length
4241 If @option{-Wformat} is specified, do not warn about zero-length formats.
4242 The C standard specifies that zero-length formats are allowed.
4245 @item -Wformat=2
4246 @opindex Wformat=2
4247 Enable @option{-Wformat} plus additional format checks.  Currently
4248 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4249 -Wformat-y2k}.
4251 @item -Wformat-nonliteral
4252 @opindex Wformat-nonliteral
4253 @opindex Wno-format-nonliteral
4254 If @option{-Wformat} is specified, also warn if the format string is not a
4255 string literal and so cannot be checked, unless the format function
4256 takes its format arguments as a @code{va_list}.
4258 @item -Wformat-security
4259 @opindex Wformat-security
4260 @opindex Wno-format-security
4261 If @option{-Wformat} is specified, also warn about uses of format
4262 functions that represent possible security problems.  At present, this
4263 warns about calls to @code{printf} and @code{scanf} functions where the
4264 format string is not a string literal and there are no format arguments,
4265 as in @code{printf (foo);}.  This may be a security hole if the format
4266 string came from untrusted input and contains @samp{%n}.  (This is
4267 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4268 in future warnings may be added to @option{-Wformat-security} that are not
4269 included in @option{-Wformat-nonliteral}.)
4271 @item -Wformat-signedness
4272 @opindex Wformat-signedness
4273 @opindex Wno-format-signedness
4274 If @option{-Wformat} is specified, also warn if the format string
4275 requires an unsigned argument and the argument is signed and vice versa.
4277 @item -Wformat-truncation
4278 @itemx -Wformat-truncation=@var{level}
4279 @opindex Wformat-truncation
4280 @opindex Wno-format-truncation
4281 Warn about calls to formatted input/output functions such as @code{snprintf}
4282 and @code{vsnprintf} that might result in output truncation.  When the exact
4283 number of bytes written by a format directive cannot be determined at
4284 compile-time it is estimated based on heuristics that depend on
4285 the @var{level} argument and on optimization.  While enabling optimization
4286 will in most cases improve the accuracy of the warning, it may also result
4287 in false positives.  Except as noted otherwise, the option uses the same
4288 logic @option{-Wformat-overflow}.
4290 @table @gcctabopt
4291 @item -Wformat-truncation
4292 @itemx -Wformat-truncation=1
4293 @opindex Wformat-truncation
4294 @opindex Wno-format-overflow
4295 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4296 employs a conservative approach that warns only about calls to bounded
4297 functions whose return value is unused and that will most likely result
4298 in output truncation.
4300 @item -Wformat-truncation=2
4301 Level @var{2} warns also about calls to bounded functions whose return
4302 value is used and that might result in truncation given an argument of
4303 sufficient length or magnitude.
4304 @end table
4306 @item -Wformat-y2k
4307 @opindex Wformat-y2k
4308 @opindex Wno-format-y2k
4309 If @option{-Wformat} is specified, also warn about @code{strftime}
4310 formats that may yield only a two-digit year.
4311 @end table
4313 @item -Wnonnull
4314 @opindex Wnonnull
4315 @opindex Wno-nonnull
4316 Warn about passing a null pointer for arguments marked as
4317 requiring a non-null value by the @code{nonnull} function attribute.
4319 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4320 can be disabled with the @option{-Wno-nonnull} option.
4322 @item -Wnonnull-compare
4323 @opindex Wnonnull-compare
4324 @opindex Wno-nonnull-compare
4325 Warn when comparing an argument marked with the @code{nonnull}
4326 function attribute against null inside the function.
4328 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4329 can be disabled with the @option{-Wno-nonnull-compare} option.
4331 @item -Wnull-dereference
4332 @opindex Wnull-dereference
4333 @opindex Wno-null-dereference
4334 Warn if the compiler detects paths that trigger erroneous or
4335 undefined behavior due to dereferencing a null pointer.  This option
4336 is only active when @option{-fdelete-null-pointer-checks} is active,
4337 which is enabled by optimizations in most targets.  The precision of
4338 the warnings depends on the optimization options used.
4340 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4341 @opindex Winit-self
4342 @opindex Wno-init-self
4343 Warn about uninitialized variables that are initialized with themselves.
4344 Note this option can only be used with the @option{-Wuninitialized} option.
4346 For example, GCC warns about @code{i} being uninitialized in the
4347 following snippet only when @option{-Winit-self} has been specified:
4348 @smallexample
4349 @group
4350 int f()
4352   int i = i;
4353   return i;
4355 @end group
4356 @end smallexample
4358 This warning is enabled by @option{-Wall} in C++.
4360 @item -Wimplicit-int @r{(C and Objective-C only)}
4361 @opindex Wimplicit-int
4362 @opindex Wno-implicit-int
4363 Warn when a declaration does not specify a type.
4364 This warning is enabled by @option{-Wall}.
4366 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4367 @opindex Wimplicit-function-declaration
4368 @opindex Wno-implicit-function-declaration
4369 Give a warning whenever a function is used before being declared. In
4370 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4371 enabled by default and it is made into an error by
4372 @option{-pedantic-errors}. This warning is also enabled by
4373 @option{-Wall}.
4375 @item -Wimplicit @r{(C and Objective-C only)}
4376 @opindex Wimplicit
4377 @opindex Wno-implicit
4378 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4379 This warning is enabled by @option{-Wall}.
4381 @item -Wimplicit-fallthrough
4382 @opindex Wimplicit-fallthrough
4383 @opindex Wno-implicit-fallthrough
4384 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4385 and @option{-Wno-implicit-fallthrough} is the same as
4386 @option{-Wimplicit-fallthrough=0}.
4388 @item -Wimplicit-fallthrough=@var{n}
4389 @opindex Wimplicit-fallthrough=
4390 Warn when a switch case falls through.  For example:
4392 @smallexample
4393 @group
4394 switch (cond)
4395   @{
4396   case 1:
4397     a = 1;
4398     break;
4399   case 2:
4400     a = 2;
4401   case 3:
4402     a = 3;
4403     break;
4404   @}
4405 @end group
4406 @end smallexample
4408 This warning does not warn when the last statement of a case cannot
4409 fall through, e.g. when there is a return statement or a call to function
4410 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4411 also takes into account control flow statements, such as ifs, and only
4412 warns when appropriate.  E.g.@:
4414 @smallexample
4415 @group
4416 switch (cond)
4417   @{
4418   case 1:
4419     if (i > 3) @{
4420       bar (5);
4421       break;
4422     @} else if (i < 1) @{
4423       bar (0);
4424     @} else
4425       return;
4426   default:
4427     @dots{}
4428   @}
4429 @end group
4430 @end smallexample
4432 Since there are occasions where a switch case fall through is desirable,
4433 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4434 to be used along with a null statement to suppress this warning that
4435 would normally occur:
4437 @smallexample
4438 @group
4439 switch (cond)
4440   @{
4441   case 1:
4442     bar (0);
4443     __attribute__ ((fallthrough));
4444   default:
4445     @dots{}
4446   @}
4447 @end group
4448 @end smallexample
4450 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4451 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4452 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4453 Instead of these attributes, it is also possible to add a fallthrough comment
4454 to silence the warning.  The whole body of the C or C++ style comment should
4455 match the given regular expressions listed below.  The option argument @var{n}
4456 specifies what kind of comments are accepted:
4458 @itemize @bullet
4460 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4462 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4463 expression, any comment is used as fallthrough comment.
4465 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4466 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4468 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4469 following regular expressions:
4471 @itemize @bullet
4473 @item @code{-fallthrough}
4475 @item @code{@@fallthrough@@}
4477 @item @code{lint -fallthrough[ \t]*}
4479 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4481 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4483 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4485 @end itemize
4487 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4488 following regular expressions:
4490 @itemize @bullet
4492 @item @code{-fallthrough}
4494 @item @code{@@fallthrough@@}
4496 @item @code{lint -fallthrough[ \t]*}
4498 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4500 @end itemize
4502 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4503 fallthrough comments, only attributes disable the warning.
4505 @end itemize
4507 The comment needs to be followed after optional whitespace and other comments
4508 by @code{case} or @code{default} keywords or by a user label that precedes some
4509 @code{case} or @code{default} label.
4511 @smallexample
4512 @group
4513 switch (cond)
4514   @{
4515   case 1:
4516     bar (0);
4517     /* FALLTHRU */
4518   default:
4519     @dots{}
4520   @}
4521 @end group
4522 @end smallexample
4524 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4526 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4527 @opindex Wif-not-aligned
4528 @opindex Wno-if-not-aligned
4529 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4530 should be issued.  This is is enabled by default.
4531 Use @option{-Wno-if-not-aligned} to disable it.
4533 @item -Wignored-qualifiers @r{(C and C++ only)}
4534 @opindex Wignored-qualifiers
4535 @opindex Wno-ignored-qualifiers
4536 Warn if the return type of a function has a type qualifier
4537 such as @code{const}.  For ISO C such a type qualifier has no effect,
4538 since the value returned by a function is not an lvalue.
4539 For C++, the warning is only emitted for scalar types or @code{void}.
4540 ISO C prohibits qualified @code{void} return types on function
4541 definitions, so such return types always receive a warning
4542 even without this option.
4544 This warning is also enabled by @option{-Wextra}.
4546 @item -Wignored-attributes @r{(C and C++ only)}
4547 @opindex Wignored-attributes
4548 @opindex Wno-ignored-attributes
4549 Warn when an attribute is ignored.  This is different from the
4550 @option{-Wattributes} option in that it warns whenever the compiler decides
4551 to drop an attribute, not that the attribute is either unknown, used in a
4552 wrong place, etc.  This warning is enabled by default.
4554 @item -Wmain
4555 @opindex Wmain
4556 @opindex Wno-main
4557 Warn if the type of @code{main} is suspicious.  @code{main} should be
4558 a function with external linkage, returning int, taking either zero
4559 arguments, two, or three arguments of appropriate types.  This warning
4560 is enabled by default in C++ and is enabled by either @option{-Wall}
4561 or @option{-Wpedantic}.
4563 @item -Wmisleading-indentation @r{(C and C++ only)}
4564 @opindex Wmisleading-indentation
4565 @opindex Wno-misleading-indentation
4566 Warn when the indentation of the code does not reflect the block structure.
4567 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4568 @code{for} clauses with a guarded statement that does not use braces,
4569 followed by an unguarded statement with the same indentation.
4571 In the following example, the call to ``bar'' is misleadingly indented as
4572 if it were guarded by the ``if'' conditional.
4574 @smallexample
4575   if (some_condition ())
4576     foo ();
4577     bar ();  /* Gotcha: this is not guarded by the "if".  */
4578 @end smallexample
4580 In the case of mixed tabs and spaces, the warning uses the
4581 @option{-ftabstop=} option to determine if the statements line up
4582 (defaulting to 8).
4584 The warning is not issued for code involving multiline preprocessor logic
4585 such as the following example.
4587 @smallexample
4588   if (flagA)
4589     foo (0);
4590 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4591   if (flagB)
4592 #endif
4593     foo (1);
4594 @end smallexample
4596 The warning is not issued after a @code{#line} directive, since this
4597 typically indicates autogenerated code, and no assumptions can be made
4598 about the layout of the file that the directive references.
4600 This warning is enabled by @option{-Wall} in C and C++.
4602 @item -Wmissing-attributes
4603 @opindex Wmissing-attributes
4604 @opindex Wno-missing-attributes
4605 Warn when a declaration of a function is missing one or more attributes
4606 that a related function is declared with and whose absence may adversely
4607 affect the correctness or efficiency of generated code.  For example, in
4608 C++, the warning is issued when an explicit specialization of a primary
4609 template declared with attribute @code{alloc_align}, @code{alloc_size},
4610 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4611 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4612 @code{error}, and @code{warning} suppress the warning.
4613 (@pxref{Function Attributes}).
4615 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4617 For example, since the declaration of the primary function template
4618 below makes use of both attribute @code{malloc} and @code{alloc_size}
4619 the declaration of the explicit specialization of the template is
4620 diagnosed because it is missing one of the attributes.
4622 @smallexample
4623 template <class T>
4624 T* __attribute__ ((malloc, alloc_size (1)))
4625 allocate (size_t);
4627 template <>
4628 void* __attribute__ ((malloc))   // missing alloc_size
4629 allocate<void> (size_t);
4630 @end smallexample
4632 @item -Wmissing-braces
4633 @opindex Wmissing-braces
4634 @opindex Wno-missing-braces
4635 Warn if an aggregate or union initializer is not fully bracketed.  In
4636 the following example, the initializer for @code{a} is not fully
4637 bracketed, but that for @code{b} is fully bracketed.  This warning is
4638 enabled by @option{-Wall} in C.
4640 @smallexample
4641 int a[2][2] = @{ 0, 1, 2, 3 @};
4642 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4643 @end smallexample
4645 This warning is enabled by @option{-Wall}.
4647 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4648 @opindex Wmissing-include-dirs
4649 @opindex Wno-missing-include-dirs
4650 Warn if a user-supplied include directory does not exist.
4652 @item -Wmultistatement-macros
4653 @opindex Wmultistatement-macros
4654 @opindex Wno-multistatement-macros
4655 Warn about unsafe multiple statement macros that appear to be guarded
4656 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4657 @code{while}, in which only the first statement is actually guarded after
4658 the macro is expanded.
4660 For example:
4662 @smallexample
4663 #define DOIT x++; y++
4664 if (c)
4665   DOIT;
4666 @end smallexample
4668 will increment @code{y} unconditionally, not just when @code{c} holds.
4669 The can usually be fixed by wrapping the macro in a do-while loop:
4670 @smallexample
4671 #define DOIT do @{ x++; y++; @} while (0)
4672 if (c)
4673   DOIT;
4674 @end smallexample
4676 This warning is enabled by @option{-Wall} in C and C++.
4678 @item -Wparentheses
4679 @opindex Wparentheses
4680 @opindex Wno-parentheses
4681 Warn if parentheses are omitted in certain contexts, such
4682 as when there is an assignment in a context where a truth value
4683 is expected, or when operators are nested whose precedence people
4684 often get confused about.
4686 Also warn if a comparison like @code{x<=y<=z} appears; this is
4687 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4688 interpretation from that of ordinary mathematical notation.
4690 Also warn for dangerous uses of the GNU extension to
4691 @code{?:} with omitted middle operand. When the condition
4692 in the @code{?}: operator is a boolean expression, the omitted value is
4693 always 1.  Often programmers expect it to be a value computed
4694 inside the conditional expression instead.
4696 For C++ this also warns for some cases of unnecessary parentheses in
4697 declarations, which can indicate an attempt at a function call instead
4698 of a declaration:
4699 @smallexample
4701   // Declares a local variable called mymutex.
4702   std::unique_lock<std::mutex> (mymutex);
4703   // User meant std::unique_lock<std::mutex> lock (mymutex);
4705 @end smallexample
4707 This warning is enabled by @option{-Wall}.
4709 @item -Wsequence-point
4710 @opindex Wsequence-point
4711 @opindex Wno-sequence-point
4712 Warn about code that may have undefined semantics because of violations
4713 of sequence point rules in the C and C++ standards.
4715 The C and C++ standards define the order in which expressions in a C/C++
4716 program are evaluated in terms of @dfn{sequence points}, which represent
4717 a partial ordering between the execution of parts of the program: those
4718 executed before the sequence point, and those executed after it.  These
4719 occur after the evaluation of a full expression (one which is not part
4720 of a larger expression), after the evaluation of the first operand of a
4721 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4722 function is called (but after the evaluation of its arguments and the
4723 expression denoting the called function), and in certain other places.
4724 Other than as expressed by the sequence point rules, the order of
4725 evaluation of subexpressions of an expression is not specified.  All
4726 these rules describe only a partial order rather than a total order,
4727 since, for example, if two functions are called within one expression
4728 with no sequence point between them, the order in which the functions
4729 are called is not specified.  However, the standards committee have
4730 ruled that function calls do not overlap.
4732 It is not specified when between sequence points modifications to the
4733 values of objects take effect.  Programs whose behavior depends on this
4734 have undefined behavior; the C and C++ standards specify that ``Between
4735 the previous and next sequence point an object shall have its stored
4736 value modified at most once by the evaluation of an expression.
4737 Furthermore, the prior value shall be read only to determine the value
4738 to be stored.''.  If a program breaks these rules, the results on any
4739 particular implementation are entirely unpredictable.
4741 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4742 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4743 diagnosed by this option, and it may give an occasional false positive
4744 result, but in general it has been found fairly effective at detecting
4745 this sort of problem in programs.
4747 The C++17 standard will define the order of evaluation of operands in
4748 more cases: in particular it requires that the right-hand side of an
4749 assignment be evaluated before the left-hand side, so the above
4750 examples are no longer undefined.  But this warning will still warn
4751 about them, to help people avoid writing code that is undefined in C
4752 and earlier revisions of C++.
4754 The standard is worded confusingly, therefore there is some debate
4755 over the precise meaning of the sequence point rules in subtle cases.
4756 Links to discussions of the problem, including proposed formal
4757 definitions, may be found on the GCC readings page, at
4758 @uref{http://gcc.gnu.org/@/readings.html}.
4760 This warning is enabled by @option{-Wall} for C and C++.
4762 @item -Wno-return-local-addr
4763 @opindex Wno-return-local-addr
4764 @opindex Wreturn-local-addr
4765 Do not warn about returning a pointer (or in C++, a reference) to a
4766 variable that goes out of scope after the function returns.
4768 @item -Wreturn-type
4769 @opindex Wreturn-type
4770 @opindex Wno-return-type
4771 Warn whenever a function is defined with a return type that defaults
4772 to @code{int}.  Also warn about any @code{return} statement with no
4773 return value in a function whose return type is not @code{void}
4774 (falling off the end of the function body is considered returning
4775 without a value).
4777 For C only, warn about a @code{return} statement with an expression in a
4778 function whose return type is @code{void}, unless the expression type is
4779 also @code{void}.  As a GNU extension, the latter case is accepted
4780 without a warning unless @option{-Wpedantic} is used.
4782 For C++, a function without return type always produces a diagnostic
4783 message, even when @option{-Wno-return-type} is specified.  The only
4784 exceptions are @code{main} and functions defined in system headers.
4786 This warning is enabled by @option{-Wall}.
4788 @item -Wshift-count-negative
4789 @opindex Wshift-count-negative
4790 @opindex Wno-shift-count-negative
4791 Warn if shift count is negative. This warning is enabled by default.
4793 @item -Wshift-count-overflow
4794 @opindex Wshift-count-overflow
4795 @opindex Wno-shift-count-overflow
4796 Warn if shift count >= width of type. This warning is enabled by default.
4798 @item -Wshift-negative-value
4799 @opindex Wshift-negative-value
4800 @opindex Wno-shift-negative-value
4801 Warn if left shifting a negative value.  This warning is enabled by
4802 @option{-Wextra} in C99 and C++11 modes (and newer).
4804 @item -Wshift-overflow
4805 @itemx -Wshift-overflow=@var{n}
4806 @opindex Wshift-overflow
4807 @opindex Wno-shift-overflow
4808 Warn about left shift overflows.  This warning is enabled by
4809 default in C99 and C++11 modes (and newer).
4811 @table @gcctabopt
4812 @item -Wshift-overflow=1
4813 This is the warning level of @option{-Wshift-overflow} and is enabled
4814 by default in C99 and C++11 modes (and newer).  This warning level does
4815 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4816 an overflow is still rejected in contexts where an integer constant expression
4817 is required.)
4819 @item -Wshift-overflow=2
4820 This warning level also warns about left-shifting 1 into the sign bit,
4821 unless C++14 mode is active.
4822 @end table
4824 @item -Wswitch
4825 @opindex Wswitch
4826 @opindex Wno-switch
4827 Warn whenever a @code{switch} statement has an index of enumerated type
4828 and lacks a @code{case} for one or more of the named codes of that
4829 enumeration.  (The presence of a @code{default} label prevents this
4830 warning.)  @code{case} labels outside the enumeration range also
4831 provoke warnings when this option is used (even if there is a
4832 @code{default} label).
4833 This warning is enabled by @option{-Wall}.
4835 @item -Wswitch-default
4836 @opindex Wswitch-default
4837 @opindex Wno-switch-default
4838 Warn whenever a @code{switch} statement does not have a @code{default}
4839 case.
4841 @item -Wswitch-enum
4842 @opindex Wswitch-enum
4843 @opindex Wno-switch-enum
4844 Warn whenever a @code{switch} statement has an index of enumerated type
4845 and lacks a @code{case} for one or more of the named codes of that
4846 enumeration.  @code{case} labels outside the enumeration range also
4847 provoke warnings when this option is used.  The only difference
4848 between @option{-Wswitch} and this option is that this option gives a
4849 warning about an omitted enumeration code even if there is a
4850 @code{default} label.
4852 @item -Wswitch-bool
4853 @opindex Wswitch-bool
4854 @opindex Wno-switch-bool
4855 Warn whenever a @code{switch} statement has an index of boolean type
4856 and the case values are outside the range of a boolean type.
4857 It is possible to suppress this warning by casting the controlling
4858 expression to a type other than @code{bool}.  For example:
4859 @smallexample
4860 @group
4861 switch ((int) (a == 4))
4862   @{
4863   @dots{}
4864   @}
4865 @end group
4866 @end smallexample
4867 This warning is enabled by default for C and C++ programs.
4869 @item -Wswitch-unreachable
4870 @opindex Wswitch-unreachable
4871 @opindex Wno-switch-unreachable
4872 Warn whenever a @code{switch} statement contains statements between the
4873 controlling expression and the first case label, which will never be
4874 executed.  For example:
4875 @smallexample
4876 @group
4877 switch (cond)
4878   @{
4879    i = 15;
4880   @dots{}
4881    case 5:
4882   @dots{}
4883   @}
4884 @end group
4885 @end smallexample
4886 @option{-Wswitch-unreachable} does not warn if the statement between the
4887 controlling expression and the first case label is just a declaration:
4888 @smallexample
4889 @group
4890 switch (cond)
4891   @{
4892    int i;
4893   @dots{}
4894    case 5:
4895    i = 5;
4896   @dots{}
4897   @}
4898 @end group
4899 @end smallexample
4900 This warning is enabled by default for C and C++ programs.
4902 @item -Wsync-nand @r{(C and C++ only)}
4903 @opindex Wsync-nand
4904 @opindex Wno-sync-nand
4905 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4906 built-in functions are used.  These functions changed semantics in GCC 4.4.
4908 @item -Wunused-but-set-parameter
4909 @opindex Wunused-but-set-parameter
4910 @opindex Wno-unused-but-set-parameter
4911 Warn whenever a function parameter is assigned to, but otherwise unused
4912 (aside from its declaration).
4914 To suppress this warning use the @code{unused} attribute
4915 (@pxref{Variable Attributes}).
4917 This warning is also enabled by @option{-Wunused} together with
4918 @option{-Wextra}.
4920 @item -Wunused-but-set-variable
4921 @opindex Wunused-but-set-variable
4922 @opindex Wno-unused-but-set-variable
4923 Warn whenever a local variable is assigned to, but otherwise unused
4924 (aside from its declaration).
4925 This warning is enabled by @option{-Wall}.
4927 To suppress this warning use the @code{unused} attribute
4928 (@pxref{Variable Attributes}).
4930 This warning is also enabled by @option{-Wunused}, which is enabled
4931 by @option{-Wall}.
4933 @item -Wunused-function
4934 @opindex Wunused-function
4935 @opindex Wno-unused-function
4936 Warn whenever a static function is declared but not defined or a
4937 non-inline static function is unused.
4938 This warning is enabled by @option{-Wall}.
4940 @item -Wunused-label
4941 @opindex Wunused-label
4942 @opindex Wno-unused-label
4943 Warn whenever a label is declared but not used.
4944 This warning is enabled by @option{-Wall}.
4946 To suppress this warning use the @code{unused} attribute
4947 (@pxref{Variable Attributes}).
4949 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4950 @opindex Wunused-local-typedefs
4951 Warn when a typedef locally defined in a function is not used.
4952 This warning is enabled by @option{-Wall}.
4954 @item -Wunused-parameter
4955 @opindex Wunused-parameter
4956 @opindex Wno-unused-parameter
4957 Warn whenever a function parameter is unused aside from its declaration.
4959 To suppress this warning use the @code{unused} attribute
4960 (@pxref{Variable Attributes}).
4962 @item -Wno-unused-result
4963 @opindex Wunused-result
4964 @opindex Wno-unused-result
4965 Do not warn if a caller of a function marked with attribute
4966 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4967 its return value. The default is @option{-Wunused-result}.
4969 @item -Wunused-variable
4970 @opindex Wunused-variable
4971 @opindex Wno-unused-variable
4972 Warn whenever a local or static variable is unused aside from its
4973 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4974 but not for C++. This warning is enabled by @option{-Wall}.
4976 To suppress this warning use the @code{unused} attribute
4977 (@pxref{Variable Attributes}).
4979 @item -Wunused-const-variable
4980 @itemx -Wunused-const-variable=@var{n}
4981 @opindex Wunused-const-variable
4982 @opindex Wno-unused-const-variable
4983 Warn whenever a constant static variable is unused aside from its declaration.
4984 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4985 for C, but not for C++. In C this declares variable storage, but in C++ this
4986 is not an error since const variables take the place of @code{#define}s.
4988 To suppress this warning use the @code{unused} attribute
4989 (@pxref{Variable Attributes}).
4991 @table @gcctabopt
4992 @item -Wunused-const-variable=1
4993 This is the warning level that is enabled by @option{-Wunused-variable} for
4994 C.  It warns only about unused static const variables defined in the main
4995 compilation unit, but not about static const variables declared in any
4996 header included.
4998 @item -Wunused-const-variable=2
4999 This warning level also warns for unused constant static variables in
5000 headers (excluding system headers).  This is the warning level of
5001 @option{-Wunused-const-variable} and must be explicitly requested since
5002 in C++ this isn't an error and in C it might be harder to clean up all
5003 headers included.
5004 @end table
5006 @item -Wunused-value
5007 @opindex Wunused-value
5008 @opindex Wno-unused-value
5009 Warn whenever a statement computes a result that is explicitly not
5010 used. To suppress this warning cast the unused expression to
5011 @code{void}. This includes an expression-statement or the left-hand
5012 side of a comma expression that contains no side effects. For example,
5013 an expression such as @code{x[i,j]} causes a warning, while
5014 @code{x[(void)i,j]} does not.
5016 This warning is enabled by @option{-Wall}.
5018 @item -Wunused
5019 @opindex Wunused
5020 @opindex Wno-unused
5021 All the above @option{-Wunused} options combined.
5023 In order to get a warning about an unused function parameter, you must
5024 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5025 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5027 @item -Wuninitialized
5028 @opindex Wuninitialized
5029 @opindex Wno-uninitialized
5030 Warn if an automatic variable is used without first being initialized
5031 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5032 warn if a non-static reference or non-static @code{const} member
5033 appears in a class without constructors.
5035 If you want to warn about code that uses the uninitialized value of the
5036 variable in its own initializer, use the @option{-Winit-self} option.
5038 These warnings occur for individual uninitialized or clobbered
5039 elements of structure, union or array variables as well as for
5040 variables that are uninitialized or clobbered as a whole.  They do
5041 not occur for variables or elements declared @code{volatile}.  Because
5042 these warnings depend on optimization, the exact variables or elements
5043 for which there are warnings depends on the precise optimization
5044 options and version of GCC used.
5046 Note that there may be no warning about a variable that is used only
5047 to compute a value that itself is never used, because such
5048 computations may be deleted by data flow analysis before the warnings
5049 are printed.
5051 @item -Winvalid-memory-model
5052 @opindex Winvalid-memory-model
5053 @opindex Wno-invalid-memory-model
5054 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5055 and the C11 atomic generic functions with a memory consistency argument
5056 that is either invalid for the operation or outside the range of values
5057 of the @code{memory_order} enumeration.  For example, since the
5058 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5059 defined for the relaxed, release, and sequentially consistent memory
5060 orders the following code is diagnosed:
5062 @smallexample
5063 void store (int *i)
5065   __atomic_store_n (i, 0, memory_order_consume);
5067 @end smallexample
5069 @option{-Winvalid-memory-model} is enabled by default.
5071 @item -Wmaybe-uninitialized
5072 @opindex Wmaybe-uninitialized
5073 @opindex Wno-maybe-uninitialized
5074 For an automatic (i.e.@ local) variable, if there exists a path from the
5075 function entry to a use of the variable that is initialized, but there exist
5076 some other paths for which the variable is not initialized, the compiler
5077 emits a warning if it cannot prove the uninitialized paths are not
5078 executed at run time.
5080 These warnings are only possible in optimizing compilation, because otherwise
5081 GCC does not keep track of the state of variables.
5083 These warnings are made optional because GCC may not be able to determine when
5084 the code is correct in spite of appearing to have an error.  Here is one
5085 example of how this can happen:
5087 @smallexample
5088 @group
5090   int x;
5091   switch (y)
5092     @{
5093     case 1: x = 1;
5094       break;
5095     case 2: x = 4;
5096       break;
5097     case 3: x = 5;
5098     @}
5099   foo (x);
5101 @end group
5102 @end smallexample
5104 @noindent
5105 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5106 always initialized, but GCC doesn't know this. To suppress the
5107 warning, you need to provide a default case with assert(0) or
5108 similar code.
5110 @cindex @code{longjmp} warnings
5111 This option also warns when a non-volatile automatic variable might be
5112 changed by a call to @code{longjmp}.
5113 The compiler sees only the calls to @code{setjmp}.  It cannot know
5114 where @code{longjmp} will be called; in fact, a signal handler could
5115 call it at any point in the code.  As a result, you may get a warning
5116 even when there is in fact no problem because @code{longjmp} cannot
5117 in fact be called at the place that would cause a problem.
5119 Some spurious warnings can be avoided if you declare all the functions
5120 you use that never return as @code{noreturn}.  @xref{Function
5121 Attributes}.
5123 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5125 @item -Wunknown-pragmas
5126 @opindex Wunknown-pragmas
5127 @opindex Wno-unknown-pragmas
5128 @cindex warning for unknown pragmas
5129 @cindex unknown pragmas, warning
5130 @cindex pragmas, warning of unknown
5131 Warn when a @code{#pragma} directive is encountered that is not understood by 
5132 GCC@.  If this command-line option is used, warnings are even issued
5133 for unknown pragmas in system header files.  This is not the case if
5134 the warnings are only enabled by the @option{-Wall} command-line option.
5136 @item -Wno-pragmas
5137 @opindex Wno-pragmas
5138 @opindex Wpragmas
5139 Do not warn about misuses of pragmas, such as incorrect parameters,
5140 invalid syntax, or conflicts between pragmas.  See also
5141 @option{-Wunknown-pragmas}.
5143 @item -Wstrict-aliasing
5144 @opindex Wstrict-aliasing
5145 @opindex Wno-strict-aliasing
5146 This option is only active when @option{-fstrict-aliasing} is active.
5147 It warns about code that might break the strict aliasing rules that the
5148 compiler is using for optimization.  The warning does not catch all
5149 cases, but does attempt to catch the more common pitfalls.  It is
5150 included in @option{-Wall}.
5151 It is equivalent to @option{-Wstrict-aliasing=3}
5153 @item -Wstrict-aliasing=n
5154 @opindex Wstrict-aliasing=n
5155 This option is only active when @option{-fstrict-aliasing} is active.
5156 It warns about code that might break the strict aliasing rules that the
5157 compiler is using for optimization.
5158 Higher levels correspond to higher accuracy (fewer false positives).
5159 Higher levels also correspond to more effort, similar to the way @option{-O} 
5160 works.
5161 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5163 Level 1: Most aggressive, quick, least accurate.
5164 Possibly useful when higher levels
5165 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5166 false negatives.  However, it has many false positives.
5167 Warns for all pointer conversions between possibly incompatible types,
5168 even if never dereferenced.  Runs in the front end only.
5170 Level 2: Aggressive, quick, not too precise.
5171 May still have many false positives (not as many as level 1 though),
5172 and few false negatives (but possibly more than level 1).
5173 Unlike level 1, it only warns when an address is taken.  Warns about
5174 incomplete types.  Runs in the front end only.
5176 Level 3 (default for @option{-Wstrict-aliasing}):
5177 Should have very few false positives and few false
5178 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5179 Takes care of the common pun+dereference pattern in the front end:
5180 @code{*(int*)&some_float}.
5181 If optimization is enabled, it also runs in the back end, where it deals
5182 with multiple statement cases using flow-sensitive points-to information.
5183 Only warns when the converted pointer is dereferenced.
5184 Does not warn about incomplete types.
5186 @item -Wstrict-overflow
5187 @itemx -Wstrict-overflow=@var{n}
5188 @opindex Wstrict-overflow
5189 @opindex Wno-strict-overflow
5190 This option is only active when signed overflow is undefined.
5191 It warns about cases where the compiler optimizes based on the
5192 assumption that signed overflow does not occur.  Note that it does not
5193 warn about all cases where the code might overflow: it only warns
5194 about cases where the compiler implements some optimization.  Thus
5195 this warning depends on the optimization level.
5197 An optimization that assumes that signed overflow does not occur is
5198 perfectly safe if the values of the variables involved are such that
5199 overflow never does, in fact, occur.  Therefore this warning can
5200 easily give a false positive: a warning about code that is not
5201 actually a problem.  To help focus on important issues, several
5202 warning levels are defined.  No warnings are issued for the use of
5203 undefined signed overflow when estimating how many iterations a loop
5204 requires, in particular when determining whether a loop will be
5205 executed at all.
5207 @table @gcctabopt
5208 @item -Wstrict-overflow=1
5209 Warn about cases that are both questionable and easy to avoid.  For
5210 example the compiler simplifies
5211 @code{x + 1 > x} to @code{1}.  This level of
5212 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5213 are not, and must be explicitly requested.
5215 @item -Wstrict-overflow=2
5216 Also warn about other cases where a comparison is simplified to a
5217 constant.  For example: @code{abs (x) >= 0}.  This can only be
5218 simplified when signed integer overflow is undefined, because
5219 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5220 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5221 @option{-Wstrict-overflow=2}.
5223 @item -Wstrict-overflow=3
5224 Also warn about other cases where a comparison is simplified.  For
5225 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5227 @item -Wstrict-overflow=4
5228 Also warn about other simplifications not covered by the above cases.
5229 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5231 @item -Wstrict-overflow=5
5232 Also warn about cases where the compiler reduces the magnitude of a
5233 constant involved in a comparison.  For example: @code{x + 2 > y} is
5234 simplified to @code{x + 1 >= y}.  This is reported only at the
5235 highest warning level because this simplification applies to many
5236 comparisons, so this warning level gives a very large number of
5237 false positives.
5238 @end table
5240 @item -Wstringop-overflow
5241 @itemx -Wstringop-overflow=@var{type}
5242 @opindex Wstringop-overflow
5243 @opindex Wno-stringop-overflow
5244 Warn for calls to string manipulation functions such as @code{memcpy} and
5245 @code{strcpy} that are determined to overflow the destination buffer.  The
5246 optional argument is one greater than the type of Object Size Checking to
5247 perform to determine the size of the destination.  @xref{Object Size Checking}.
5248 The argument is meaningful only for functions that operate on character arrays
5249 but not for raw memory functions like @code{memcpy} which always make use
5250 of Object Size type-0.  The option also warns for calls that specify a size
5251 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5252 The option produces the best results with optimization enabled but can detect
5253 a small subset of simple buffer overflows even without optimization in
5254 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5255 correspond to the standard functions.  In any case, the option warns about
5256 just a subset of buffer overflows detected by the corresponding overflow
5257 checking built-ins.  For example, the option will issue a warning for
5258 the @code{strcpy} call below because it copies at least 5 characters
5259 (the string @code{"blue"} including the terminating NUL) into the buffer
5260 of size 4.
5262 @smallexample
5263 enum Color @{ blue, purple, yellow @};
5264 const char* f (enum Color clr)
5266   static char buf [4];
5267   const char *str;
5268   switch (clr)
5269     @{
5270       case blue: str = "blue"; break;
5271       case purple: str = "purple"; break;
5272       case yellow: str = "yellow"; break;
5273     @}
5275   return strcpy (buf, str);   // warning here
5277 @end smallexample
5279 Option @option{-Wstringop-overflow=2} is enabled by default.
5281 @table @gcctabopt
5282 @item -Wstringop-overflow
5283 @itemx -Wstringop-overflow=1
5284 @opindex Wstringop-overflow
5285 @opindex Wno-stringop-overflow
5286 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5287 to determine the sizes of destination objects.  This is the default setting
5288 of the option.  At this setting the option will not warn for writes past
5289 the end of subobjects of larger objects accessed by pointers unless the
5290 size of the largest surrounding object is known.  When the destination may
5291 be one of several objects it is assumed to be the largest one of them.  On
5292 Linux systems, when optimization is enabled at this setting the option warns
5293 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5294 a non-zero value.
5296 @item -Wstringop-overflow=2
5297 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5298 to determine the sizes of destination objects.  At this setting the option
5299 will warn about overflows when writing to members of the largest complete
5300 objects whose exact size is known.  It will, however, not warn for excessive
5301 writes to the same members of unknown objects referenced by pointers since
5302 they may point to arrays containing unknown numbers of elements.
5304 @item -Wstringop-overflow=3
5305 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5306 to determine the sizes of destination objects.  At this setting the option
5307 warns about overflowing the smallest object or data member.  This is the
5308 most restrictive setting of the option that may result in warnings for safe
5309 code.
5311 @item -Wstringop-overflow=4
5312 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5313 to determine the sizes of destination objects.  At this setting the option
5314 will warn about overflowing any data members, and when the destination is
5315 one of several objects it uses the size of the largest of them to decide
5316 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5317 setting of the option may result in warnings for benign code.
5318 @end table
5320 @item -Wstringop-truncation
5321 @opindex Wstringop-truncation
5322 @opindex Wno-stringop-truncation
5323 Warn for calls to bounded string manipulation functions such as @code{strncat},
5324 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5325 or leave the destination unchanged.
5327 In the following example, the call to @code{strncat} specifies a bound that
5328 is less than the length of the source string.  As a result, the copy of
5329 the source will be truncated and so the call is diagnosed.  To avoid the
5330 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5332 @smallexample
5333 void append (char *buf, size_t bufsize)
5335   strncat (buf, ".txt", 3);
5337 @end smallexample
5339 As another example, the following call to @code{strncpy} results in copying
5340 to @code{d} just the characters preceding the terminating NUL, without
5341 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5342 necessarily a NUL-terminated string is a common mistake, and so the call
5343 is diagnosed.  To avoid the warning when the result is not expected to be
5344 NUL-terminated, call @code{memcpy} instead.
5346 @smallexample
5347 void copy (char *d, const char *s)
5349   strncpy (d, s, strlen (s));
5351 @end smallexample
5353 In the following example, the call to @code{strncpy} specifies the size
5354 of the destination buffer as the bound.  If the length of the source
5355 string is equal to or greater than this size the result of the copy will
5356 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5357 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5358 element of the buffer to @code{NUL}.
5360 @smallexample
5361 void copy (const char *s)
5363   char buf[80];
5364   strncpy (buf, s, sizeof buf);
5365   @dots{}
5367 @end smallexample
5369 In situations where a character array is intended to store a sequence
5370 of bytes with no terminating @code{NUL} such an array may be annotated
5371 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5372 however, are not suitable arguments to functions that expect
5373 @code{NUL}-terminated strings.  To help detect accidental misuses of
5374 such arrays GCC issues warnings unless it can prove that the use is
5375 safe.  @xref{Common Variable Attributes}.
5377 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5378 @opindex Wsuggest-attribute=
5379 @opindex Wno-suggest-attribute=
5380 Warn for cases where adding an attribute may be beneficial. The
5381 attributes currently supported are listed below.
5383 @table @gcctabopt
5384 @item -Wsuggest-attribute=pure
5385 @itemx -Wsuggest-attribute=const
5386 @itemx -Wsuggest-attribute=noreturn
5387 @itemx -Wsuggest-attribute=malloc
5388 @opindex Wsuggest-attribute=pure
5389 @opindex Wno-suggest-attribute=pure
5390 @opindex Wsuggest-attribute=const
5391 @opindex Wno-suggest-attribute=const
5392 @opindex Wsuggest-attribute=noreturn
5393 @opindex Wno-suggest-attribute=noreturn
5394 @opindex Wsuggest-attribute=malloc
5395 @opindex Wno-suggest-attribute=malloc
5397 Warn about functions that might be candidates for attributes
5398 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5399 only warns for functions visible in other compilation units or (in the case of
5400 @code{pure} and @code{const}) if it cannot prove that the function returns
5401 normally. A function returns normally if it doesn't contain an infinite loop or
5402 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5403 requires option @option{-fipa-pure-const}, which is enabled by default at
5404 @option{-O} and higher.  Higher optimization levels improve the accuracy
5405 of the analysis.
5407 @item -Wsuggest-attribute=format
5408 @itemx -Wmissing-format-attribute
5409 @opindex Wsuggest-attribute=format
5410 @opindex Wmissing-format-attribute
5411 @opindex Wno-suggest-attribute=format
5412 @opindex Wno-missing-format-attribute
5413 @opindex Wformat
5414 @opindex Wno-format
5416 Warn about function pointers that might be candidates for @code{format}
5417 attributes.  Note these are only possible candidates, not absolute ones.
5418 GCC guesses that function pointers with @code{format} attributes that
5419 are used in assignment, initialization, parameter passing or return
5420 statements should have a corresponding @code{format} attribute in the
5421 resulting type.  I.e.@: the left-hand side of the assignment or
5422 initialization, the type of the parameter variable, or the return type
5423 of the containing function respectively should also have a @code{format}
5424 attribute to avoid the warning.
5426 GCC also warns about function definitions that might be
5427 candidates for @code{format} attributes.  Again, these are only
5428 possible candidates.  GCC guesses that @code{format} attributes
5429 might be appropriate for any function that calls a function like
5430 @code{vprintf} or @code{vscanf}, but this might not always be the
5431 case, and some functions for which @code{format} attributes are
5432 appropriate may not be detected.
5434 @item -Wsuggest-attribute=cold
5435 @opindex Wsuggest-attribute=cold
5436 @opindex Wno-suggest-attribute=cold
5438 Warn about functions that might be candidates for @code{cold} attribute.  This
5439 is based on static detection and generally will only warn about functions which
5440 always leads to a call to another @code{cold} function such as wrappers of
5441 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5442 @end table
5444 @item -Wsuggest-final-types
5445 @opindex Wno-suggest-final-types
5446 @opindex Wsuggest-final-types
5447 Warn about types with virtual methods where code quality would be improved
5448 if the type were declared with the C++11 @code{final} specifier, 
5449 or, if possible,
5450 declared in an anonymous namespace. This allows GCC to more aggressively
5451 devirtualize the polymorphic calls. This warning is more effective with link
5452 time optimization, where the information about the class hierarchy graph is
5453 more complete.
5455 @item -Wsuggest-final-methods
5456 @opindex Wno-suggest-final-methods
5457 @opindex Wsuggest-final-methods
5458 Warn about virtual methods where code quality would be improved if the method
5459 were declared with the C++11 @code{final} specifier, 
5460 or, if possible, its type were
5461 declared in an anonymous namespace or with the @code{final} specifier.
5462 This warning is
5463 more effective with link-time optimization, where the information about the
5464 class hierarchy graph is more complete. It is recommended to first consider
5465 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5466 annotations.
5468 @item -Wsuggest-override
5469 Warn about overriding virtual functions that are not marked with the override
5470 keyword.
5472 @item -Walloc-zero
5473 @opindex Wno-alloc-zero
5474 @opindex Walloc-zero
5475 Warn about calls to allocation functions decorated with attribute
5476 @code{alloc_size} that specify zero bytes, including those to the built-in
5477 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5478 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5479 when called with a zero size differs among implementations (and in the case
5480 of @code{realloc} has been deprecated) relying on it may result in subtle
5481 portability bugs and should be avoided.
5483 @item -Walloc-size-larger-than=@var{n}
5484 Warn about calls to functions decorated with attribute @code{alloc_size}
5485 that attempt to allocate objects larger than the specified number of bytes,
5486 or where the result of the size computation in an integer type with infinite
5487 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5488 may end in one of the standard suffixes designating a multiple of bytes
5489 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5490 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5491 @xref{Function Attributes}.
5493 @item -Walloca
5494 @opindex Wno-alloca
5495 @opindex Walloca
5496 This option warns on all uses of @code{alloca} in the source.
5498 @item -Walloca-larger-than=@var{n}
5499 This option warns on calls to @code{alloca} that are not bounded by a
5500 controlling predicate limiting its argument of integer type to at most
5501 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5502 Arguments of non-integer types are considered unbounded even if they
5503 appear to be constrained to the expected range.
5505 For example, a bounded case of @code{alloca} could be:
5507 @smallexample
5508 void func (size_t n)
5510   void *p;
5511   if (n <= 1000)
5512     p = alloca (n);
5513   else
5514     p = malloc (n);
5515   f (p);
5517 @end smallexample
5519 In the above example, passing @code{-Walloca-larger-than=1000} would not
5520 issue a warning because the call to @code{alloca} is known to be at most
5521 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5522 the compiler would emit a warning.
5524 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5525 controlling predicate constraining its integer argument.  For example:
5527 @smallexample
5528 void func ()
5530   void *p = alloca (n);
5531   f (p);
5533 @end smallexample
5535 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5536 a warning, but this time because of the lack of bounds checking.
5538 Note, that even seemingly correct code involving signed integers could
5539 cause a warning:
5541 @smallexample
5542 void func (signed int n)
5544   if (n < 500)
5545     @{
5546       p = alloca (n);
5547       f (p);
5548     @}
5550 @end smallexample
5552 In the above example, @var{n} could be negative, causing a larger than
5553 expected argument to be implicitly cast into the @code{alloca} call.
5555 This option also warns when @code{alloca} is used in a loop.
5557 This warning is not enabled by @option{-Wall}, and is only active when
5558 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5560 See also @option{-Wvla-larger-than=@var{n}}.
5562 @item -Warray-bounds
5563 @itemx -Warray-bounds=@var{n}
5564 @opindex Wno-array-bounds
5565 @opindex Warray-bounds
5566 This option is only active when @option{-ftree-vrp} is active
5567 (default for @option{-O2} and above). It warns about subscripts to arrays
5568 that are always out of bounds. This warning is enabled by @option{-Wall}.
5570 @table @gcctabopt
5571 @item -Warray-bounds=1
5572 This is the warning level of @option{-Warray-bounds} and is enabled
5573 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5575 @item -Warray-bounds=2
5576 This warning level also warns about out of bounds access for
5577 arrays at the end of a struct and for arrays accessed through
5578 pointers. This warning level may give a larger number of
5579 false positives and is deactivated by default.
5580 @end table
5582 @item -Wattribute-alias
5583 Warn about declarations using the @code{alias} and similar attributes whose
5584 target is incompatible with the type of the alias.  @xref{Function Attributes,
5585 ,Declaring Attributes of Functions}.
5587 @item -Wbool-compare
5588 @opindex Wno-bool-compare
5589 @opindex Wbool-compare
5590 Warn about boolean expression compared with an integer value different from
5591 @code{true}/@code{false}.  For instance, the following comparison is
5592 always false:
5593 @smallexample
5594 int n = 5;
5595 @dots{}
5596 if ((n > 1) == 2) @{ @dots{} @}
5597 @end smallexample
5598 This warning is enabled by @option{-Wall}.
5600 @item -Wbool-operation
5601 @opindex Wno-bool-operation
5602 @opindex Wbool-operation
5603 Warn about suspicious operations on expressions of a boolean type.  For
5604 instance, bitwise negation of a boolean is very likely a bug in the program.
5605 For C, this warning also warns about incrementing or decrementing a boolean,
5606 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5607 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5609 This warning is enabled by @option{-Wall}.
5611 @item -Wduplicated-branches
5612 @opindex Wno-duplicated-branches
5613 @opindex Wduplicated-branches
5614 Warn when an if-else has identical branches.  This warning detects cases like
5615 @smallexample
5616 if (p != NULL)
5617   return 0;
5618 else
5619   return 0;
5620 @end smallexample
5621 It doesn't warn when both branches contain just a null statement.  This warning
5622 also warn for conditional operators:
5623 @smallexample
5624   int i = x ? *p : *p;
5625 @end smallexample
5627 @item -Wduplicated-cond
5628 @opindex Wno-duplicated-cond
5629 @opindex Wduplicated-cond
5630 Warn about duplicated conditions in an if-else-if chain.  For instance,
5631 warn for the following code:
5632 @smallexample
5633 if (p->q != NULL) @{ @dots{} @}
5634 else if (p->q != NULL) @{ @dots{} @}
5635 @end smallexample
5637 @item -Wframe-address
5638 @opindex Wno-frame-address
5639 @opindex Wframe-address
5640 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5641 is called with an argument greater than 0.  Such calls may return indeterminate
5642 values or crash the program.  The warning is included in @option{-Wall}.
5644 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5645 @opindex Wno-discarded-qualifiers
5646 @opindex Wdiscarded-qualifiers
5647 Do not warn if type qualifiers on pointers are being discarded.
5648 Typically, the compiler warns if a @code{const char *} variable is
5649 passed to a function that takes a @code{char *} parameter.  This option
5650 can be used to suppress such a warning.
5652 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5653 @opindex Wno-discarded-array-qualifiers
5654 @opindex Wdiscarded-array-qualifiers
5655 Do not warn if type qualifiers on arrays which are pointer targets
5656 are being discarded. Typically, the compiler warns if a
5657 @code{const int (*)[]} variable is passed to a function that
5658 takes a @code{int (*)[]} parameter.  This option can be used to
5659 suppress such a warning.
5661 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5662 @opindex Wno-incompatible-pointer-types
5663 @opindex Wincompatible-pointer-types
5664 Do not warn when there is a conversion between pointers that have incompatible
5665 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5666 which warns for pointer argument passing or assignment with different
5667 signedness.
5669 @item -Wno-int-conversion @r{(C and Objective-C only)}
5670 @opindex Wno-int-conversion
5671 @opindex Wint-conversion
5672 Do not warn about incompatible integer to pointer and pointer to integer
5673 conversions.  This warning is about implicit conversions; for explicit
5674 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5675 @option{-Wno-pointer-to-int-cast} may be used.
5677 @item -Wno-div-by-zero
5678 @opindex Wno-div-by-zero
5679 @opindex Wdiv-by-zero
5680 Do not warn about compile-time integer division by zero.  Floating-point
5681 division by zero is not warned about, as it can be a legitimate way of
5682 obtaining infinities and NaNs.
5684 @item -Wsystem-headers
5685 @opindex Wsystem-headers
5686 @opindex Wno-system-headers
5687 @cindex warnings from system headers
5688 @cindex system headers, warnings from
5689 Print warning messages for constructs found in system header files.
5690 Warnings from system headers are normally suppressed, on the assumption
5691 that they usually do not indicate real problems and would only make the
5692 compiler output harder to read.  Using this command-line option tells
5693 GCC to emit warnings from system headers as if they occurred in user
5694 code.  However, note that using @option{-Wall} in conjunction with this
5695 option does @emph{not} warn about unknown pragmas in system
5696 headers---for that, @option{-Wunknown-pragmas} must also be used.
5698 @item -Wtautological-compare
5699 @opindex Wtautological-compare
5700 @opindex Wno-tautological-compare
5701 Warn if a self-comparison always evaluates to true or false.  This
5702 warning detects various mistakes such as:
5703 @smallexample
5704 int i = 1;
5705 @dots{}
5706 if (i > i) @{ @dots{} @}
5707 @end smallexample
5709 This warning also warns about bitwise comparisons that always evaluate
5710 to true or false, for instance:
5711 @smallexample
5712 if ((a & 16) == 10) @{ @dots{} @}
5713 @end smallexample
5714 will always be false.
5716 This warning is enabled by @option{-Wall}.
5718 @item -Wtrampolines
5719 @opindex Wtrampolines
5720 @opindex Wno-trampolines
5721 Warn about trampolines generated for pointers to nested functions.
5722 A trampoline is a small piece of data or code that is created at run
5723 time on the stack when the address of a nested function is taken, and is
5724 used to call the nested function indirectly.  For some targets, it is
5725 made up of data only and thus requires no special treatment.  But, for
5726 most targets, it is made up of code and thus requires the stack to be
5727 made executable in order for the program to work properly.
5729 @item -Wfloat-equal
5730 @opindex Wfloat-equal
5731 @opindex Wno-float-equal
5732 Warn if floating-point values are used in equality comparisons.
5734 The idea behind this is that sometimes it is convenient (for the
5735 programmer) to consider floating-point values as approximations to
5736 infinitely precise real numbers.  If you are doing this, then you need
5737 to compute (by analyzing the code, or in some other way) the maximum or
5738 likely maximum error that the computation introduces, and allow for it
5739 when performing comparisons (and when producing output, but that's a
5740 different problem).  In particular, instead of testing for equality, you
5741 should check to see whether the two values have ranges that overlap; and
5742 this is done with the relational operators, so equality comparisons are
5743 probably mistaken.
5745 @item -Wtraditional @r{(C and Objective-C only)}
5746 @opindex Wtraditional
5747 @opindex Wno-traditional
5748 Warn about certain constructs that behave differently in traditional and
5749 ISO C@.  Also warn about ISO C constructs that have no traditional C
5750 equivalent, and/or problematic constructs that should be avoided.
5752 @itemize @bullet
5753 @item
5754 Macro parameters that appear within string literals in the macro body.
5755 In traditional C macro replacement takes place within string literals,
5756 but in ISO C it does not.
5758 @item
5759 In traditional C, some preprocessor directives did not exist.
5760 Traditional preprocessors only considered a line to be a directive
5761 if the @samp{#} appeared in column 1 on the line.  Therefore
5762 @option{-Wtraditional} warns about directives that traditional C
5763 understands but ignores because the @samp{#} does not appear as the
5764 first character on the line.  It also suggests you hide directives like
5765 @code{#pragma} not understood by traditional C by indenting them.  Some
5766 traditional implementations do not recognize @code{#elif}, so this option
5767 suggests avoiding it altogether.
5769 @item
5770 A function-like macro that appears without arguments.
5772 @item
5773 The unary plus operator.
5775 @item
5776 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5777 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5778 constants.)  Note, these suffixes appear in macros defined in the system
5779 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5780 Use of these macros in user code might normally lead to spurious
5781 warnings, however GCC's integrated preprocessor has enough context to
5782 avoid warning in these cases.
5784 @item
5785 A function declared external in one block and then used after the end of
5786 the block.
5788 @item
5789 A @code{switch} statement has an operand of type @code{long}.
5791 @item
5792 A non-@code{static} function declaration follows a @code{static} one.
5793 This construct is not accepted by some traditional C compilers.
5795 @item
5796 The ISO type of an integer constant has a different width or
5797 signedness from its traditional type.  This warning is only issued if
5798 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5799 typically represent bit patterns, are not warned about.
5801 @item
5802 Usage of ISO string concatenation is detected.
5804 @item
5805 Initialization of automatic aggregates.
5807 @item
5808 Identifier conflicts with labels.  Traditional C lacks a separate
5809 namespace for labels.
5811 @item
5812 Initialization of unions.  If the initializer is zero, the warning is
5813 omitted.  This is done under the assumption that the zero initializer in
5814 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5815 initializer warnings and relies on default initialization to zero in the
5816 traditional C case.
5818 @item
5819 Conversions by prototypes between fixed/floating-point values and vice
5820 versa.  The absence of these prototypes when compiling with traditional
5821 C causes serious problems.  This is a subset of the possible
5822 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5824 @item
5825 Use of ISO C style function definitions.  This warning intentionally is
5826 @emph{not} issued for prototype declarations or variadic functions
5827 because these ISO C features appear in your code when using
5828 libiberty's traditional C compatibility macros, @code{PARAMS} and
5829 @code{VPARAMS}.  This warning is also bypassed for nested functions
5830 because that feature is already a GCC extension and thus not relevant to
5831 traditional C compatibility.
5832 @end itemize
5834 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5835 @opindex Wtraditional-conversion
5836 @opindex Wno-traditional-conversion
5837 Warn if a prototype causes a type conversion that is different from what
5838 would happen to the same argument in the absence of a prototype.  This
5839 includes conversions of fixed point to floating and vice versa, and
5840 conversions changing the width or signedness of a fixed-point argument
5841 except when the same as the default promotion.
5843 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5844 @opindex Wdeclaration-after-statement
5845 @opindex Wno-declaration-after-statement
5846 Warn when a declaration is found after a statement in a block.  This
5847 construct, known from C++, was introduced with ISO C99 and is by default
5848 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5850 @item -Wshadow
5851 @opindex Wshadow
5852 @opindex Wno-shadow
5853 Warn whenever a local variable or type declaration shadows another
5854 variable, parameter, type, class member (in C++), or instance variable
5855 (in Objective-C) or whenever a built-in function is shadowed. Note
5856 that in C++, the compiler warns if a local variable shadows an
5857 explicit typedef, but not if it shadows a struct/class/enum.
5858 Same as @option{-Wshadow=global}.
5860 @item -Wno-shadow-ivar @r{(Objective-C only)}
5861 @opindex Wno-shadow-ivar
5862 @opindex Wshadow-ivar
5863 Do not warn whenever a local variable shadows an instance variable in an
5864 Objective-C method.
5866 @item -Wshadow=global
5867 @opindex Wshadow=local
5868 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5870 @item -Wshadow=local
5871 @opindex Wshadow=local
5872 Warn when a local variable shadows another local variable or parameter.
5873 This warning is enabled by @option{-Wshadow=global}.
5875 @item -Wshadow=compatible-local
5876 @opindex Wshadow=compatible-local
5877 Warn when a local variable shadows another local variable or parameter
5878 whose type is compatible with that of the shadowing variable. In C++,
5879 type compatibility here means the type of the shadowing variable can be
5880 converted to that of the shadowed variable. The creation of this flag
5881 (in addition to @option{-Wshadow=local}) is based on the idea that when
5882 a local variable shadows another one of incompatible type, it is most
5883 likely intentional, not a bug or typo, as shown in the following example:
5885 @smallexample
5886 @group
5887 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5889   for (int i = 0; i < N; ++i)
5890   @{
5891     ...
5892   @}
5893   ...
5895 @end group
5896 @end smallexample
5898 Since the two variable @code{i} in the example above have incompatible types,
5899 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5900 Because their types are incompatible, if a programmer accidentally uses one
5901 in place of the other, type checking will catch that and emit an error or
5902 warning. So not warning (about shadowing) in this case will not lead to
5903 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5904 possibly reduce the number of warnings triggered by intentional shadowing.
5906 This warning is enabled by @option{-Wshadow=local}.
5908 @item -Wlarger-than=@var{len}
5909 @opindex Wlarger-than=@var{len}
5910 @opindex Wlarger-than-@var{len}
5911 Warn whenever an object of larger than @var{len} bytes is defined.
5913 @item -Wframe-larger-than=@var{len}
5914 @opindex Wframe-larger-than
5915 Warn if the size of a function frame is larger than @var{len} bytes.
5916 The computation done to determine the stack frame size is approximate
5917 and not conservative.
5918 The actual requirements may be somewhat greater than @var{len}
5919 even if you do not get a warning.  In addition, any space allocated
5920 via @code{alloca}, variable-length arrays, or related constructs
5921 is not included by the compiler when determining
5922 whether or not to issue a warning.
5924 @item -Wno-free-nonheap-object
5925 @opindex Wno-free-nonheap-object
5926 @opindex Wfree-nonheap-object
5927 Do not warn when attempting to free an object that was not allocated
5928 on the heap.
5930 @item -Wstack-usage=@var{len}
5931 @opindex Wstack-usage
5932 Warn if the stack usage of a function might be larger than @var{len} bytes.
5933 The computation done to determine the stack usage is conservative.
5934 Any space allocated via @code{alloca}, variable-length arrays, or related
5935 constructs is included by the compiler when determining whether or not to
5936 issue a warning.
5938 The message is in keeping with the output of @option{-fstack-usage}.
5940 @itemize
5941 @item
5942 If the stack usage is fully static but exceeds the specified amount, it's:
5944 @smallexample
5945   warning: stack usage is 1120 bytes
5946 @end smallexample
5947 @item
5948 If the stack usage is (partly) dynamic but bounded, it's:
5950 @smallexample
5951   warning: stack usage might be 1648 bytes
5952 @end smallexample
5953 @item
5954 If the stack usage is (partly) dynamic and not bounded, it's:
5956 @smallexample
5957   warning: stack usage might be unbounded
5958 @end smallexample
5959 @end itemize
5961 @item -Wunsafe-loop-optimizations
5962 @opindex Wunsafe-loop-optimizations
5963 @opindex Wno-unsafe-loop-optimizations
5964 Warn if the loop cannot be optimized because the compiler cannot
5965 assume anything on the bounds of the loop indices.  With
5966 @option{-funsafe-loop-optimizations} warn if the compiler makes
5967 such assumptions.
5969 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5970 @opindex Wno-pedantic-ms-format
5971 @opindex Wpedantic-ms-format
5972 When used in combination with @option{-Wformat}
5973 and @option{-pedantic} without GNU extensions, this option
5974 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5975 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5976 which depend on the MS runtime.
5978 @item -Waligned-new
5979 @opindex Waligned-new
5980 @opindex Wno-aligned-new
5981 Warn about a new-expression of a type that requires greater alignment
5982 than the @code{alignof(std::max_align_t)} but uses an allocation
5983 function without an explicit alignment parameter. This option is
5984 enabled by @option{-Wall}.
5986 Normally this only warns about global allocation functions, but
5987 @option{-Waligned-new=all} also warns about class member allocation
5988 functions.
5990 @item -Wplacement-new
5991 @itemx -Wplacement-new=@var{n}
5992 @opindex Wplacement-new
5993 @opindex Wno-placement-new
5994 Warn about placement new expressions with undefined behavior, such as
5995 constructing an object in a buffer that is smaller than the type of
5996 the object.  For example, the placement new expression below is diagnosed
5997 because it attempts to construct an array of 64 integers in a buffer only
5998 64 bytes large.
5999 @smallexample
6000 char buf [64];
6001 new (buf) int[64];
6002 @end smallexample
6003 This warning is enabled by default.
6005 @table @gcctabopt
6006 @item -Wplacement-new=1
6007 This is the default warning level of @option{-Wplacement-new}.  At this
6008 level the warning is not issued for some strictly undefined constructs that
6009 GCC allows as extensions for compatibility with legacy code.  For example,
6010 the following @code{new} expression is not diagnosed at this level even
6011 though it has undefined behavior according to the C++ standard because
6012 it writes past the end of the one-element array.
6013 @smallexample
6014 struct S @{ int n, a[1]; @};
6015 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6016 new (s->a)int [32]();
6017 @end smallexample
6019 @item -Wplacement-new=2
6020 At this level, in addition to diagnosing all the same constructs as at level
6021 1, a diagnostic is also issued for placement new expressions that construct
6022 an object in the last member of structure whose type is an array of a single
6023 element and whose size is less than the size of the object being constructed.
6024 While the previous example would be diagnosed, the following construct makes
6025 use of the flexible member array extension to avoid the warning at level 2.
6026 @smallexample
6027 struct S @{ int n, a[]; @};
6028 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6029 new (s->a)int [32]();
6030 @end smallexample
6032 @end table
6034 @item -Wpointer-arith
6035 @opindex Wpointer-arith
6036 @opindex Wno-pointer-arith
6037 Warn about anything that depends on the ``size of'' a function type or
6038 of @code{void}.  GNU C assigns these types a size of 1, for
6039 convenience in calculations with @code{void *} pointers and pointers
6040 to functions.  In C++, warn also when an arithmetic operation involves
6041 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6043 @item -Wpointer-compare
6044 @opindex Wpointer-compare
6045 @opindex Wno-pointer-compare
6046 Warn if a pointer is compared with a zero character constant.  This usually
6047 means that the pointer was meant to be dereferenced.  For example:
6049 @smallexample
6050 const char *p = foo ();
6051 if (p == '\0')
6052   return 42;
6053 @end smallexample
6055 Note that the code above is invalid in C++11.
6057 This warning is enabled by default.
6059 @item -Wtype-limits
6060 @opindex Wtype-limits
6061 @opindex Wno-type-limits
6062 Warn if a comparison is always true or always false due to the limited
6063 range of the data type, but do not warn for constant expressions.  For
6064 example, warn if an unsigned variable is compared against zero with
6065 @code{<} or @code{>=}.  This warning is also enabled by
6066 @option{-Wextra}.
6068 @include cppwarnopts.texi
6070 @item -Wbad-function-cast @r{(C and Objective-C only)}
6071 @opindex Wbad-function-cast
6072 @opindex Wno-bad-function-cast
6073 Warn when a function call is cast to a non-matching type.
6074 For example, warn if a call to a function returning an integer type 
6075 is cast to a pointer type.
6077 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6078 @opindex Wc90-c99-compat
6079 @opindex Wno-c90-c99-compat
6080 Warn about features not present in ISO C90, but present in ISO C99.
6081 For instance, warn about use of variable length arrays, @code{long long}
6082 type, @code{bool} type, compound literals, designated initializers, and so
6083 on.  This option is independent of the standards mode.  Warnings are disabled
6084 in the expression that follows @code{__extension__}.
6086 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6087 @opindex Wc99-c11-compat
6088 @opindex Wno-c99-c11-compat
6089 Warn about features not present in ISO C99, but present in ISO C11.
6090 For instance, warn about use of anonymous structures and unions,
6091 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6092 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6093 and so on.  This option is independent of the standards mode.  Warnings are
6094 disabled in the expression that follows @code{__extension__}.
6096 @item -Wc++-compat @r{(C and Objective-C only)}
6097 @opindex Wc++-compat
6098 Warn about ISO C constructs that are outside of the common subset of
6099 ISO C and ISO C++, e.g.@: request for implicit conversion from
6100 @code{void *} to a pointer to non-@code{void} type.
6102 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6103 @opindex Wc++11-compat
6104 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6105 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6106 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6107 enabled by @option{-Wall}.
6109 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6110 @opindex Wc++14-compat
6111 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6112 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6114 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6115 @opindex Wc++17-compat
6116 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6117 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6119 @item -Wcast-qual
6120 @opindex Wcast-qual
6121 @opindex Wno-cast-qual
6122 Warn whenever a pointer is cast so as to remove a type qualifier from
6123 the target type.  For example, warn if a @code{const char *} is cast
6124 to an ordinary @code{char *}.
6126 Also warn when making a cast that introduces a type qualifier in an
6127 unsafe way.  For example, casting @code{char **} to @code{const char **}
6128 is unsafe, as in this example:
6130 @smallexample
6131   /* p is char ** value.  */
6132   const char **q = (const char **) p;
6133   /* Assignment of readonly string to const char * is OK.  */
6134   *q = "string";
6135   /* Now char** pointer points to read-only memory.  */
6136   **p = 'b';
6137 @end smallexample
6139 @item -Wcast-align
6140 @opindex Wcast-align
6141 @opindex Wno-cast-align
6142 Warn whenever a pointer is cast such that the required alignment of the
6143 target is increased.  For example, warn if a @code{char *} is cast to
6144 an @code{int *} on machines where integers can only be accessed at
6145 two- or four-byte boundaries.
6147 @item -Wcast-align=strict
6148 @opindex Wcast-align=strict
6149 Warn whenever a pointer is cast such that the required alignment of the
6150 target is increased.  For example, warn if a @code{char *} is cast to
6151 an @code{int *} regardless of the target machine.
6153 @item -Wcast-function-type
6154 @opindex Wcast-function-type
6155 @opindex Wno-cast-function-type
6156 Warn when a function pointer is cast to an incompatible function pointer.
6157 In a cast involving function types with a variable argument list only
6158 the types of initial arguments that are provided are considered.
6159 Any parameter of pointer-type matches any other pointer-type.  Any benign
6160 differences in integral types are ignored, like @code{int} vs. @code{long}
6161 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6162 type @code{void (*) (void)} is special and matches everything, which can
6163 be used to suppress this warning.
6164 In a cast involving pointer to member types this warning warns whenever
6165 the type cast is changing the pointer to member type.
6166 This warning is enabled by @option{-Wextra}.
6168 @item -Wwrite-strings
6169 @opindex Wwrite-strings
6170 @opindex Wno-write-strings
6171 When compiling C, give string constants the type @code{const
6172 char[@var{length}]} so that copying the address of one into a
6173 non-@code{const} @code{char *} pointer produces a warning.  These
6174 warnings help you find at compile time code that can try to write
6175 into a string constant, but only if you have been very careful about
6176 using @code{const} in declarations and prototypes.  Otherwise, it is
6177 just a nuisance. This is why we did not make @option{-Wall} request
6178 these warnings.
6180 When compiling C++, warn about the deprecated conversion from string
6181 literals to @code{char *}.  This warning is enabled by default for C++
6182 programs.
6184 @item -Wcatch-value
6185 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6186 @opindex Wcatch-value
6187 @opindex Wno-catch-value
6188 Warn about catch handlers that do not catch via reference.
6189 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6190 warn about polymorphic class types that are caught by value.
6191 With @option{-Wcatch-value=2} warn about all class types that are caught
6192 by value. With @option{-Wcatch-value=3} warn about all types that are
6193 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6195 @item -Wclobbered
6196 @opindex Wclobbered
6197 @opindex Wno-clobbered
6198 Warn for variables that might be changed by @code{longjmp} or
6199 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6201 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6202 @opindex Wconditionally-supported
6203 @opindex Wno-conditionally-supported
6204 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6206 @item -Wconversion
6207 @opindex Wconversion
6208 @opindex Wno-conversion
6209 Warn for implicit conversions that may alter a value. This includes
6210 conversions between real and integer, like @code{abs (x)} when
6211 @code{x} is @code{double}; conversions between signed and unsigned,
6212 like @code{unsigned ui = -1}; and conversions to smaller types, like
6213 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6214 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6215 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6216 conversions between signed and unsigned integers can be disabled by
6217 using @option{-Wno-sign-conversion}.
6219 For C++, also warn for confusing overload resolution for user-defined
6220 conversions; and conversions that never use a type conversion
6221 operator: conversions to @code{void}, the same type, a base class or a
6222 reference to them. Warnings about conversions between signed and
6223 unsigned integers are disabled by default in C++ unless
6224 @option{-Wsign-conversion} is explicitly enabled.
6226 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6227 @opindex Wconversion-null
6228 @opindex Wno-conversion-null
6229 Do not warn for conversions between @code{NULL} and non-pointer
6230 types. @option{-Wconversion-null} is enabled by default.
6232 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6233 @opindex Wzero-as-null-pointer-constant
6234 @opindex Wno-zero-as-null-pointer-constant
6235 Warn when a literal @samp{0} is used as null pointer constant.  This can
6236 be useful to facilitate the conversion to @code{nullptr} in C++11.
6238 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6239 @opindex Wsubobject-linkage
6240 @opindex Wno-subobject-linkage
6241 Warn if a class type has a base or a field whose type uses the anonymous
6242 namespace or depends on a type with no linkage.  If a type A depends on
6243 a type B with no or internal linkage, defining it in multiple
6244 translation units would be an ODR violation because the meaning of B
6245 is different in each translation unit.  If A only appears in a single
6246 translation unit, the best way to silence the warning is to give it
6247 internal linkage by putting it in an anonymous namespace as well.  The
6248 compiler doesn't give this warning for types defined in the main .C
6249 file, as those are unlikely to have multiple definitions.
6250 @option{-Wsubobject-linkage} is enabled by default.
6252 @item -Wdangling-else
6253 @opindex Wdangling-else
6254 @opindex Wno-dangling-else
6255 Warn about constructions where there may be confusion to which
6256 @code{if} statement an @code{else} branch belongs.  Here is an example of
6257 such a case:
6259 @smallexample
6260 @group
6262   if (a)
6263     if (b)
6264       foo ();
6265   else
6266     bar ();
6268 @end group
6269 @end smallexample
6271 In C/C++, every @code{else} branch belongs to the innermost possible
6272 @code{if} statement, which in this example is @code{if (b)}.  This is
6273 often not what the programmer expected, as illustrated in the above
6274 example by indentation the programmer chose.  When there is the
6275 potential for this confusion, GCC issues a warning when this flag
6276 is specified.  To eliminate the warning, add explicit braces around
6277 the innermost @code{if} statement so there is no way the @code{else}
6278 can belong to the enclosing @code{if}.  The resulting code
6279 looks like this:
6281 @smallexample
6282 @group
6284   if (a)
6285     @{
6286       if (b)
6287         foo ();
6288       else
6289         bar ();
6290     @}
6292 @end group
6293 @end smallexample
6295 This warning is enabled by @option{-Wparentheses}.
6297 @item -Wdate-time
6298 @opindex Wdate-time
6299 @opindex Wno-date-time
6300 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6301 are encountered as they might prevent bit-wise-identical reproducible
6302 compilations.
6304 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6305 @opindex Wdelete-incomplete
6306 @opindex Wno-delete-incomplete
6307 Warn when deleting a pointer to incomplete type, which may cause
6308 undefined behavior at runtime.  This warning is enabled by default.
6310 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6311 @opindex Wuseless-cast
6312 @opindex Wno-useless-cast
6313 Warn when an expression is casted to its own type.
6315 @item -Wempty-body
6316 @opindex Wempty-body
6317 @opindex Wno-empty-body
6318 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6319 while} statement.  This warning is also enabled by @option{-Wextra}.
6321 @item -Wenum-compare
6322 @opindex Wenum-compare
6323 @opindex Wno-enum-compare
6324 Warn about a comparison between values of different enumerated types.
6325 In C++ enumerated type mismatches in conditional expressions are also
6326 diagnosed and the warning is enabled by default.  In C this warning is 
6327 enabled by @option{-Wall}.
6329 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6330 @opindex Wextra-semi
6331 @opindex Wno-extra-semi
6332 Warn about redundant semicolon after in-class function definition.
6334 @item -Wjump-misses-init @r{(C, Objective-C only)}
6335 @opindex Wjump-misses-init
6336 @opindex Wno-jump-misses-init
6337 Warn if a @code{goto} statement or a @code{switch} statement jumps
6338 forward across the initialization of a variable, or jumps backward to a
6339 label after the variable has been initialized.  This only warns about
6340 variables that are initialized when they are declared.  This warning is
6341 only supported for C and Objective-C; in C++ this sort of branch is an
6342 error in any case.
6344 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6345 can be disabled with the @option{-Wno-jump-misses-init} option.
6347 @item -Wsign-compare
6348 @opindex Wsign-compare
6349 @opindex Wno-sign-compare
6350 @cindex warning for comparison of signed and unsigned values
6351 @cindex comparison of signed and unsigned values, warning
6352 @cindex signed and unsigned values, comparison warning
6353 Warn when a comparison between signed and unsigned values could produce
6354 an incorrect result when the signed value is converted to unsigned.
6355 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6356 also enabled by @option{-Wextra}.
6358 @item -Wsign-conversion
6359 @opindex Wsign-conversion
6360 @opindex Wno-sign-conversion
6361 Warn for implicit conversions that may change the sign of an integer
6362 value, like assigning a signed integer expression to an unsigned
6363 integer variable. An explicit cast silences the warning. In C, this
6364 option is enabled also by @option{-Wconversion}.
6366 @item -Wfloat-conversion
6367 @opindex Wfloat-conversion
6368 @opindex Wno-float-conversion
6369 Warn for implicit conversions that reduce the precision of a real value.
6370 This includes conversions from real to integer, and from higher precision
6371 real to lower precision real values.  This option is also enabled by
6372 @option{-Wconversion}.
6374 @item -Wno-scalar-storage-order
6375 @opindex -Wno-scalar-storage-order
6376 @opindex -Wscalar-storage-order
6377 Do not warn on suspicious constructs involving reverse scalar storage order.
6379 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6380 @opindex Wsized-deallocation
6381 @opindex Wno-sized-deallocation
6382 Warn about a definition of an unsized deallocation function
6383 @smallexample
6384 void operator delete (void *) noexcept;
6385 void operator delete[] (void *) noexcept;
6386 @end smallexample
6387 without a definition of the corresponding sized deallocation function
6388 @smallexample
6389 void operator delete (void *, std::size_t) noexcept;
6390 void operator delete[] (void *, std::size_t) noexcept;
6391 @end smallexample
6392 or vice versa.  Enabled by @option{-Wextra} along with
6393 @option{-fsized-deallocation}.
6395 @item -Wsizeof-pointer-div
6396 @opindex Wsizeof-pointer-div
6397 @opindex Wno-sizeof-pointer-div
6398 Warn for suspicious divisions of two sizeof expressions that divide
6399 the pointer size by the element size, which is the usual way to compute
6400 the array size but won't work out correctly with pointers.  This warning
6401 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6402 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6404 @item -Wsizeof-pointer-memaccess
6405 @opindex Wsizeof-pointer-memaccess
6406 @opindex Wno-sizeof-pointer-memaccess
6407 Warn for suspicious length parameters to certain string and memory built-in
6408 functions if the argument uses @code{sizeof}.  This warning triggers for
6409 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6410 an array, but a pointer, and suggests a possible fix, or about
6411 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6412 also warns about calls to bounded string copy functions like @code{strncat}
6413 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6414 the source array.  For example, in the following function the call to
6415 @code{strncat} specifies the size of the source string as the bound.  That
6416 is almost certainly a mistake and so the call is diagnosed.
6417 @smallexample
6418 void make_file (const char *name)
6420   char path[PATH_MAX];
6421   strncpy (path, name, sizeof path - 1);
6422   strncat (path, ".text", sizeof ".text");
6423   @dots{}
6425 @end smallexample
6427 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6429 @item -Wsizeof-array-argument
6430 @opindex Wsizeof-array-argument
6431 @opindex Wno-sizeof-array-argument
6432 Warn when the @code{sizeof} operator is applied to a parameter that is
6433 declared as an array in a function definition.  This warning is enabled by
6434 default for C and C++ programs.
6436 @item -Wmemset-elt-size
6437 @opindex Wmemset-elt-size
6438 @opindex Wno-memset-elt-size
6439 Warn for suspicious calls to the @code{memset} built-in function, if the
6440 first argument references an array, and the third argument is a number
6441 equal to the number of elements, but not equal to the size of the array
6442 in memory.  This indicates that the user has omitted a multiplication by
6443 the element size.  This warning is enabled by @option{-Wall}.
6445 @item -Wmemset-transposed-args
6446 @opindex Wmemset-transposed-args
6447 @opindex Wno-memset-transposed-args
6448 Warn for suspicious calls to the @code{memset} built-in function, if the
6449 second argument is not zero and the third argument is zero.  This warns e.g.@
6450 about @code{memset (buf, sizeof buf, 0)} where most probably
6451 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6452 is only emitted if the third argument is literal zero.  If it is some
6453 expression that is folded to zero, a cast of zero to some type, etc., 
6454 it is far less likely that the user has mistakenly exchanged the arguments 
6455 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6457 @item -Waddress
6458 @opindex Waddress
6459 @opindex Wno-address
6460 Warn about suspicious uses of memory addresses. These include using
6461 the address of a function in a conditional expression, such as
6462 @code{void func(void); if (func)}, and comparisons against the memory
6463 address of a string literal, such as @code{if (x == "abc")}.  Such
6464 uses typically indicate a programmer error: the address of a function
6465 always evaluates to true, so their use in a conditional usually
6466 indicate that the programmer forgot the parentheses in a function
6467 call; and comparisons against string literals result in unspecified
6468 behavior and are not portable in C, so they usually indicate that the
6469 programmer intended to use @code{strcmp}.  This warning is enabled by
6470 @option{-Wall}.
6472 @item -Wlogical-op
6473 @opindex Wlogical-op
6474 @opindex Wno-logical-op
6475 Warn about suspicious uses of logical operators in expressions.
6476 This includes using logical operators in contexts where a
6477 bit-wise operator is likely to be expected.  Also warns when
6478 the operands of a logical operator are the same:
6479 @smallexample
6480 extern int a;
6481 if (a < 0 && a < 0) @{ @dots{} @}
6482 @end smallexample
6484 @item -Wlogical-not-parentheses
6485 @opindex Wlogical-not-parentheses
6486 @opindex Wno-logical-not-parentheses
6487 Warn about logical not used on the left hand side operand of a comparison.
6488 This option does not warn if the right operand is considered to be a boolean
6489 expression.  Its purpose is to detect suspicious code like the following:
6490 @smallexample
6491 int a;
6492 @dots{}
6493 if (!a > 1) @{ @dots{} @}
6494 @end smallexample
6496 It is possible to suppress the warning by wrapping the LHS into
6497 parentheses:
6498 @smallexample
6499 if ((!a) > 1) @{ @dots{} @}
6500 @end smallexample
6502 This warning is enabled by @option{-Wall}.
6504 @item -Waggregate-return
6505 @opindex Waggregate-return
6506 @opindex Wno-aggregate-return
6507 Warn if any functions that return structures or unions are defined or
6508 called.  (In languages where you can return an array, this also elicits
6509 a warning.)
6511 @item -Wno-aggressive-loop-optimizations
6512 @opindex Wno-aggressive-loop-optimizations
6513 @opindex Waggressive-loop-optimizations
6514 Warn if in a loop with constant number of iterations the compiler detects
6515 undefined behavior in some statement during one or more of the iterations.
6517 @item -Wno-attributes
6518 @opindex Wno-attributes
6519 @opindex Wattributes
6520 Do not warn if an unexpected @code{__attribute__} is used, such as
6521 unrecognized attributes, function attributes applied to variables,
6522 etc.  This does not stop errors for incorrect use of supported
6523 attributes.
6525 @item -Wno-builtin-declaration-mismatch
6526 @opindex Wno-builtin-declaration-mismatch
6527 @opindex Wbuiltin-declaration-mismatch
6528 Warn if a built-in function is declared with the wrong signature or 
6529 as non-function.
6530 This warning is enabled by default.
6532 @item -Wno-builtin-macro-redefined
6533 @opindex Wno-builtin-macro-redefined
6534 @opindex Wbuiltin-macro-redefined
6535 Do not warn if certain built-in macros are redefined.  This suppresses
6536 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6537 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6539 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6540 @opindex Wstrict-prototypes
6541 @opindex Wno-strict-prototypes
6542 Warn if a function is declared or defined without specifying the
6543 argument types.  (An old-style function definition is permitted without
6544 a warning if preceded by a declaration that specifies the argument
6545 types.)
6547 @item -Wold-style-declaration @r{(C and Objective-C only)}
6548 @opindex Wold-style-declaration
6549 @opindex Wno-old-style-declaration
6550 Warn for obsolescent usages, according to the C Standard, in a
6551 declaration. For example, warn if storage-class specifiers like
6552 @code{static} are not the first things in a declaration.  This warning
6553 is also enabled by @option{-Wextra}.
6555 @item -Wold-style-definition @r{(C and Objective-C only)}
6556 @opindex Wold-style-definition
6557 @opindex Wno-old-style-definition
6558 Warn if an old-style function definition is used.  A warning is given
6559 even if there is a previous prototype.
6561 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6562 @opindex Wmissing-parameter-type
6563 @opindex Wno-missing-parameter-type
6564 A function parameter is declared without a type specifier in K&R-style
6565 functions:
6567 @smallexample
6568 void foo(bar) @{ @}
6569 @end smallexample
6571 This warning is also enabled by @option{-Wextra}.
6573 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6574 @opindex Wmissing-prototypes
6575 @opindex Wno-missing-prototypes
6576 Warn if a global function is defined without a previous prototype
6577 declaration.  This warning is issued even if the definition itself
6578 provides a prototype.  Use this option to detect global functions
6579 that do not have a matching prototype declaration in a header file.
6580 This option is not valid for C++ because all function declarations
6581 provide prototypes and a non-matching declaration declares an
6582 overload rather than conflict with an earlier declaration.
6583 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6585 @item -Wmissing-declarations
6586 @opindex Wmissing-declarations
6587 @opindex Wno-missing-declarations
6588 Warn if a global function is defined without a previous declaration.
6589 Do so even if the definition itself provides a prototype.
6590 Use this option to detect global functions that are not declared in
6591 header files.  In C, no warnings are issued for functions with previous
6592 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6593 missing prototypes.  In C++, no warnings are issued for function templates,
6594 or for inline functions, or for functions in anonymous namespaces.
6596 @item -Wmissing-field-initializers
6597 @opindex Wmissing-field-initializers
6598 @opindex Wno-missing-field-initializers
6599 @opindex W
6600 @opindex Wextra
6601 @opindex Wno-extra
6602 Warn if a structure's initializer has some fields missing.  For
6603 example, the following code causes such a warning, because
6604 @code{x.h} is implicitly zero:
6606 @smallexample
6607 struct s @{ int f, g, h; @};
6608 struct s x = @{ 3, 4 @};
6609 @end smallexample
6611 This option does not warn about designated initializers, so the following
6612 modification does not trigger a warning:
6614 @smallexample
6615 struct s @{ int f, g, h; @};
6616 struct s x = @{ .f = 3, .g = 4 @};
6617 @end smallexample
6619 In C this option does not warn about the universal zero initializer
6620 @samp{@{ 0 @}}:
6622 @smallexample
6623 struct s @{ int f, g, h; @};
6624 struct s x = @{ 0 @};
6625 @end smallexample
6627 Likewise, in C++ this option does not warn about the empty @{ @}
6628 initializer, for example:
6630 @smallexample
6631 struct s @{ int f, g, h; @};
6632 s x = @{ @};
6633 @end smallexample
6635 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6636 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6638 @item -Wno-multichar
6639 @opindex Wno-multichar
6640 @opindex Wmultichar
6641 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6642 Usually they indicate a typo in the user's code, as they have
6643 implementation-defined values, and should not be used in portable code.
6645 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6646 @opindex Wnormalized=
6647 @opindex Wnormalized
6648 @opindex Wno-normalized
6649 @cindex NFC
6650 @cindex NFKC
6651 @cindex character set, input normalization
6652 In ISO C and ISO C++, two identifiers are different if they are
6653 different sequences of characters.  However, sometimes when characters
6654 outside the basic ASCII character set are used, you can have two
6655 different character sequences that look the same.  To avoid confusion,
6656 the ISO 10646 standard sets out some @dfn{normalization rules} which
6657 when applied ensure that two sequences that look the same are turned into
6658 the same sequence.  GCC can warn you if you are using identifiers that
6659 have not been normalized; this option controls that warning.
6661 There are four levels of warning supported by GCC@.  The default is
6662 @option{-Wnormalized=nfc}, which warns about any identifier that is
6663 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6664 recommended form for most uses.  It is equivalent to
6665 @option{-Wnormalized}.
6667 Unfortunately, there are some characters allowed in identifiers by
6668 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6669 identifiers.  That is, there's no way to use these symbols in portable
6670 ISO C or C++ and have all your identifiers in NFC@.
6671 @option{-Wnormalized=id} suppresses the warning for these characters.
6672 It is hoped that future versions of the standards involved will correct
6673 this, which is why this option is not the default.
6675 You can switch the warning off for all characters by writing
6676 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6677 only do this if you are using some other normalization scheme (like
6678 ``D''), because otherwise you can easily create bugs that are
6679 literally impossible to see.
6681 Some characters in ISO 10646 have distinct meanings but look identical
6682 in some fonts or display methodologies, especially once formatting has
6683 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6684 LETTER N'', displays just like a regular @code{n} that has been
6685 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6686 normalization scheme to convert all these into a standard form as
6687 well, and GCC warns if your code is not in NFKC if you use
6688 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6689 about every identifier that contains the letter O because it might be
6690 confused with the digit 0, and so is not the default, but may be
6691 useful as a local coding convention if the programming environment 
6692 cannot be fixed to display these characters distinctly.
6694 @item -Wno-deprecated
6695 @opindex Wno-deprecated
6696 @opindex Wdeprecated
6697 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6699 @item -Wno-deprecated-declarations
6700 @opindex Wno-deprecated-declarations
6701 @opindex Wdeprecated-declarations
6702 Do not warn about uses of functions (@pxref{Function Attributes}),
6703 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6704 Attributes}) marked as deprecated by using the @code{deprecated}
6705 attribute.
6707 @item -Wno-overflow
6708 @opindex Wno-overflow
6709 @opindex Woverflow
6710 Do not warn about compile-time overflow in constant expressions.
6712 @item -Wno-odr
6713 @opindex Wno-odr
6714 @opindex Wodr
6715 Warn about One Definition Rule violations during link-time optimization.
6716 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6718 @item -Wopenmp-simd
6719 @opindex Wopenm-simd
6720 Warn if the vectorizer cost model overrides the OpenMP
6721 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6722 option can be used to relax the cost model.
6724 @item -Woverride-init @r{(C and Objective-C only)}
6725 @opindex Woverride-init
6726 @opindex Wno-override-init
6727 @opindex W
6728 @opindex Wextra
6729 @opindex Wno-extra
6730 Warn if an initialized field without side effects is overridden when
6731 using designated initializers (@pxref{Designated Inits, , Designated
6732 Initializers}).
6734 This warning is included in @option{-Wextra}.  To get other
6735 @option{-Wextra} warnings without this one, use @option{-Wextra
6736 -Wno-override-init}.
6738 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6739 @opindex Woverride-init-side-effects
6740 @opindex Wno-override-init-side-effects
6741 Warn if an initialized field with side effects is overridden when
6742 using designated initializers (@pxref{Designated Inits, , Designated
6743 Initializers}).  This warning is enabled by default.
6745 @item -Wpacked
6746 @opindex Wpacked
6747 @opindex Wno-packed
6748 Warn if a structure is given the packed attribute, but the packed
6749 attribute has no effect on the layout or size of the structure.
6750 Such structures may be mis-aligned for little benefit.  For
6751 instance, in this code, the variable @code{f.x} in @code{struct bar}
6752 is misaligned even though @code{struct bar} does not itself
6753 have the packed attribute:
6755 @smallexample
6756 @group
6757 struct foo @{
6758   int x;
6759   char a, b, c, d;
6760 @} __attribute__((packed));
6761 struct bar @{
6762   char z;
6763   struct foo f;
6765 @end group
6766 @end smallexample
6768 @item -Wpacked-bitfield-compat
6769 @opindex Wpacked-bitfield-compat
6770 @opindex Wno-packed-bitfield-compat
6771 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6772 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6773 the change can lead to differences in the structure layout.  GCC
6774 informs you when the offset of such a field has changed in GCC 4.4.
6775 For example there is no longer a 4-bit padding between field @code{a}
6776 and @code{b} in this structure:
6778 @smallexample
6779 struct foo
6781   char a:4;
6782   char b:8;
6783 @} __attribute__ ((packed));
6784 @end smallexample
6786 This warning is enabled by default.  Use
6787 @option{-Wno-packed-bitfield-compat} to disable this warning.
6789 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6790 @opindex Wpacked-not-aligned
6791 @opindex Wno-packed-not-aligned
6792 Warn if a structure field with explicitly specified alignment in a
6793 packed struct or union is misaligned.  For example, a warning will
6794 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6795 'struct S' is less than 8}, in this code:
6797 @smallexample
6798 @group
6799 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6800 struct __attribute__ ((packed)) S @{
6801   struct S8 s8;
6803 @end group
6804 @end smallexample
6806 This warning is enabled by @option{-Wall}.
6808 @item -Wpadded
6809 @opindex Wpadded
6810 @opindex Wno-padded
6811 Warn if padding is included in a structure, either to align an element
6812 of the structure or to align the whole structure.  Sometimes when this
6813 happens it is possible to rearrange the fields of the structure to
6814 reduce the padding and so make the structure smaller.
6816 @item -Wredundant-decls
6817 @opindex Wredundant-decls
6818 @opindex Wno-redundant-decls
6819 Warn if anything is declared more than once in the same scope, even in
6820 cases where multiple declaration is valid and changes nothing.
6822 @item -Wno-restrict
6823 @opindex Wrestrict
6824 @opindex Wno-restrict
6825 Warn when an object referenced by a @code{restrict}-qualified parameter
6826 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6827 argument, or when copies between such objects overlap.  For example,
6828 the call to the @code{strcpy} function below attempts to truncate the string
6829 by replacing its initial characters with the last four.  However, because
6830 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6831 the call is diagnosed.
6833 @smallexample
6834 void foo (void)
6836   char a[] = "abcd1234";
6837   strcpy (a, a + 4);
6838   @dots{}
6840 @end smallexample
6841 The @option{-Wrestrict} option detects some instances of simple overlap
6842 even without optimization but works best at @option{-O2} and above.  It
6843 is included in @option{-Wall}.
6845 @item -Wnested-externs @r{(C and Objective-C only)}
6846 @opindex Wnested-externs
6847 @opindex Wno-nested-externs
6848 Warn if an @code{extern} declaration is encountered within a function.
6850 @item -Wno-inherited-variadic-ctor
6851 @opindex Winherited-variadic-ctor
6852 @opindex Wno-inherited-variadic-ctor
6853 Suppress warnings about use of C++11 inheriting constructors when the
6854 base class inherited from has a C variadic constructor; the warning is
6855 on by default because the ellipsis is not inherited.
6857 @item -Winline
6858 @opindex Winline
6859 @opindex Wno-inline
6860 Warn if a function that is declared as inline cannot be inlined.
6861 Even with this option, the compiler does not warn about failures to
6862 inline functions declared in system headers.
6864 The compiler uses a variety of heuristics to determine whether or not
6865 to inline a function.  For example, the compiler takes into account
6866 the size of the function being inlined and the amount of inlining
6867 that has already been done in the current function.  Therefore,
6868 seemingly insignificant changes in the source program can cause the
6869 warnings produced by @option{-Winline} to appear or disappear.
6871 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6872 @opindex Wno-invalid-offsetof
6873 @opindex Winvalid-offsetof
6874 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6875 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6876 to a non-standard-layout type is undefined.  In existing C++ implementations,
6877 however, @code{offsetof} typically gives meaningful results.
6878 This flag is for users who are aware that they are
6879 writing nonportable code and who have deliberately chosen to ignore the
6880 warning about it.
6882 The restrictions on @code{offsetof} may be relaxed in a future version
6883 of the C++ standard.
6885 @item -Wint-in-bool-context
6886 @opindex Wint-in-bool-context
6887 @opindex Wno-int-in-bool-context
6888 Warn for suspicious use of integer values where boolean values are expected,
6889 such as conditional expressions (?:) using non-boolean integer constants in
6890 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6891 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6892 for all kinds of multiplications regardless of the data type.
6893 This warning is enabled by @option{-Wall}.
6895 @item -Wno-int-to-pointer-cast
6896 @opindex Wno-int-to-pointer-cast
6897 @opindex Wint-to-pointer-cast
6898 Suppress warnings from casts to pointer type of an integer of a
6899 different size. In C++, casting to a pointer type of smaller size is
6900 an error. @option{Wint-to-pointer-cast} is enabled by default.
6903 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6904 @opindex Wno-pointer-to-int-cast
6905 @opindex Wpointer-to-int-cast
6906 Suppress warnings from casts from a pointer to an integer type of a
6907 different size.
6909 @item -Winvalid-pch
6910 @opindex Winvalid-pch
6911 @opindex Wno-invalid-pch
6912 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6913 the search path but cannot be used.
6915 @item -Wlong-long
6916 @opindex Wlong-long
6917 @opindex Wno-long-long
6918 Warn if @code{long long} type is used.  This is enabled by either
6919 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6920 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6922 @item -Wvariadic-macros
6923 @opindex Wvariadic-macros
6924 @opindex Wno-variadic-macros
6925 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6926 alternate syntax is used in ISO C99 mode.  This is enabled by either
6927 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6928 messages, use @option{-Wno-variadic-macros}.
6930 @item -Wvarargs
6931 @opindex Wvarargs
6932 @opindex Wno-varargs
6933 Warn upon questionable usage of the macros used to handle variable
6934 arguments like @code{va_start}.  This is default.  To inhibit the
6935 warning messages, use @option{-Wno-varargs}.
6937 @item -Wvector-operation-performance
6938 @opindex Wvector-operation-performance
6939 @opindex Wno-vector-operation-performance
6940 Warn if vector operation is not implemented via SIMD capabilities of the
6941 architecture.  Mainly useful for the performance tuning.
6942 Vector operation can be implemented @code{piecewise}, which means that the
6943 scalar operation is performed on every vector element; 
6944 @code{in parallel}, which means that the vector operation is implemented
6945 using scalars of wider type, which normally is more performance efficient;
6946 and @code{as a single scalar}, which means that vector fits into a
6947 scalar type.
6949 @item -Wno-virtual-move-assign
6950 @opindex Wvirtual-move-assign
6951 @opindex Wno-virtual-move-assign
6952 Suppress warnings about inheriting from a virtual base with a
6953 non-trivial C++11 move assignment operator.  This is dangerous because
6954 if the virtual base is reachable along more than one path, it is
6955 moved multiple times, which can mean both objects end up in the
6956 moved-from state.  If the move assignment operator is written to avoid
6957 moving from a moved-from object, this warning can be disabled.
6959 @item -Wvla
6960 @opindex Wvla
6961 @opindex Wno-vla
6962 Warn if a variable-length array is used in the code.
6963 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6964 the variable-length array.
6966 @item -Wvla-larger-than=@var{n}
6967 If this option is used, the compiler will warn on uses of
6968 variable-length arrays where the size is either unbounded, or bounded
6969 by an argument that can be larger than @var{n} bytes.  This is similar
6970 to how @option{-Walloca-larger-than=@var{n}} works, but with
6971 variable-length arrays.
6973 Note that GCC may optimize small variable-length arrays of a known
6974 value into plain arrays, so this warning may not get triggered for
6975 such arrays.
6977 This warning is not enabled by @option{-Wall}, and is only active when
6978 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6980 See also @option{-Walloca-larger-than=@var{n}}.
6982 @item -Wvolatile-register-var
6983 @opindex Wvolatile-register-var
6984 @opindex Wno-volatile-register-var
6985 Warn if a register variable is declared volatile.  The volatile
6986 modifier does not inhibit all optimizations that may eliminate reads
6987 and/or writes to register variables.  This warning is enabled by
6988 @option{-Wall}.
6990 @item -Wdisabled-optimization
6991 @opindex Wdisabled-optimization
6992 @opindex Wno-disabled-optimization
6993 Warn if a requested optimization pass is disabled.  This warning does
6994 not generally indicate that there is anything wrong with your code; it
6995 merely indicates that GCC's optimizers are unable to handle the code
6996 effectively.  Often, the problem is that your code is too big or too
6997 complex; GCC refuses to optimize programs when the optimization
6998 itself is likely to take inordinate amounts of time.
7000 @item -Wpointer-sign @r{(C and Objective-C only)}
7001 @opindex Wpointer-sign
7002 @opindex Wno-pointer-sign
7003 Warn for pointer argument passing or assignment with different signedness.
7004 This option is only supported for C and Objective-C@.  It is implied by
7005 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
7006 @option{-Wno-pointer-sign}.
7008 @item -Wstack-protector
7009 @opindex Wstack-protector
7010 @opindex Wno-stack-protector
7011 This option is only active when @option{-fstack-protector} is active.  It
7012 warns about functions that are not protected against stack smashing.
7014 @item -Woverlength-strings
7015 @opindex Woverlength-strings
7016 @opindex Wno-overlength-strings
7017 Warn about string constants that are longer than the ``minimum
7018 maximum'' length specified in the C standard.  Modern compilers
7019 generally allow string constants that are much longer than the
7020 standard's minimum limit, but very portable programs should avoid
7021 using longer strings.
7023 The limit applies @emph{after} string constant concatenation, and does
7024 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7025 C99, it was raised to 4095.  C++98 does not specify a normative
7026 minimum maximum, so we do not diagnose overlength strings in C++@.
7028 This option is implied by @option{-Wpedantic}, and can be disabled with
7029 @option{-Wno-overlength-strings}.
7031 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7032 @opindex Wunsuffixed-float-constants
7034 Issue a warning for any floating constant that does not have
7035 a suffix.  When used together with @option{-Wsystem-headers} it
7036 warns about such constants in system header files.  This can be useful
7037 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7038 from the decimal floating-point extension to C99.
7040 @item -Wno-designated-init @r{(C and Objective-C only)}
7041 Suppress warnings when a positional initializer is used to initialize
7042 a structure that has been marked with the @code{designated_init}
7043 attribute.
7045 @item -Whsa
7046 Issue a warning when HSAIL cannot be emitted for the compiled function or
7047 OpenMP construct.
7049 @end table
7051 @node Debugging Options
7052 @section Options for Debugging Your Program
7053 @cindex options, debugging
7054 @cindex debugging information options
7056 To tell GCC to emit extra information for use by a debugger, in almost 
7057 all cases you need only to add @option{-g} to your other options.
7059 GCC allows you to use @option{-g} with
7060 @option{-O}.  The shortcuts taken by optimized code may occasionally
7061 be surprising: some variables you declared may not exist
7062 at all; flow of control may briefly move where you did not expect it;
7063 some statements may not be executed because they compute constant
7064 results or their values are already at hand; some statements may
7065 execute in different places because they have been moved out of loops.
7066 Nevertheless it is possible to debug optimized output.  This makes
7067 it reasonable to use the optimizer for programs that might have bugs.
7069 If you are not using some other optimization option, consider
7070 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7071 With no @option{-O} option at all, some compiler passes that collect
7072 information useful for debugging do not run at all, so that
7073 @option{-Og} may result in a better debugging experience.
7075 @table @gcctabopt
7076 @item -g
7077 @opindex g
7078 Produce debugging information in the operating system's native format
7079 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7080 information.
7082 On most systems that use stabs format, @option{-g} enables use of extra
7083 debugging information that only GDB can use; this extra information
7084 makes debugging work better in GDB but probably makes other debuggers
7085 crash or
7086 refuse to read the program.  If you want to control for certain whether
7087 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7088 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7090 @item -ggdb
7091 @opindex ggdb
7092 Produce debugging information for use by GDB@.  This means to use the
7093 most expressive format available (DWARF, stabs, or the native format
7094 if neither of those are supported), including GDB extensions if at all
7095 possible.
7097 @item -gdwarf
7098 @itemx -gdwarf-@var{version}
7099 @opindex gdwarf
7100 Produce debugging information in DWARF format (if that is supported).
7101 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7102 for most targets is 4.  DWARF Version 5 is only experimental.
7104 Note that with DWARF Version 2, some ports require and always
7105 use some non-conflicting DWARF 3 extensions in the unwind tables.
7107 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7108 for maximum benefit.
7110 GCC no longer supports DWARF Version 1, which is substantially
7111 different than Version 2 and later.  For historical reasons, some
7112 other DWARF-related options such as
7113 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7114 in their names, but apply to all currently-supported versions of DWARF.
7116 @item -gstabs
7117 @opindex gstabs
7118 Produce debugging information in stabs format (if that is supported),
7119 without GDB extensions.  This is the format used by DBX on most BSD
7120 systems.  On MIPS, Alpha and System V Release 4 systems this option
7121 produces stabs debugging output that is not understood by DBX@.
7122 On System V Release 4 systems this option requires the GNU assembler.
7124 @item -gstabs+
7125 @opindex gstabs+
7126 Produce debugging information in stabs format (if that is supported),
7127 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7128 use of these extensions is likely to make other debuggers crash or
7129 refuse to read the program.
7131 @item -gxcoff
7132 @opindex gxcoff
7133 Produce debugging information in XCOFF format (if that is supported).
7134 This is the format used by the DBX debugger on IBM RS/6000 systems.
7136 @item -gxcoff+
7137 @opindex gxcoff+
7138 Produce debugging information in XCOFF format (if that is supported),
7139 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7140 use of these extensions is likely to make other debuggers crash or
7141 refuse to read the program, and may cause assemblers other than the GNU
7142 assembler (GAS) to fail with an error.
7144 @item -gvms
7145 @opindex gvms
7146 Produce debugging information in Alpha/VMS debug format (if that is
7147 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7149 @item -g@var{level}
7150 @itemx -ggdb@var{level}
7151 @itemx -gstabs@var{level}
7152 @itemx -gxcoff@var{level}
7153 @itemx -gvms@var{level}
7154 Request debugging information and also use @var{level} to specify how
7155 much information.  The default level is 2.
7157 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7158 @option{-g}.
7160 Level 1 produces minimal information, enough for making backtraces in
7161 parts of the program that you don't plan to debug.  This includes
7162 descriptions of functions and external variables, and line number
7163 tables, but no information about local variables.
7165 Level 3 includes extra information, such as all the macro definitions
7166 present in the program.  Some debuggers support macro expansion when
7167 you use @option{-g3}.
7169 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7170 confusion with @option{-gdwarf-@var{level}}.
7171 Instead use an additional @option{-g@var{level}} option to change the
7172 debug level for DWARF.
7174 @item -feliminate-unused-debug-symbols
7175 @opindex feliminate-unused-debug-symbols
7176 Produce debugging information in stabs format (if that is supported),
7177 for only symbols that are actually used.
7179 @item -femit-class-debug-always
7180 @opindex femit-class-debug-always
7181 Instead of emitting debugging information for a C++ class in only one
7182 object file, emit it in all object files using the class.  This option
7183 should be used only with debuggers that are unable to handle the way GCC
7184 normally emits debugging information for classes because using this
7185 option increases the size of debugging information by as much as a
7186 factor of two.
7188 @item -fno-merge-debug-strings
7189 @opindex fmerge-debug-strings
7190 @opindex fno-merge-debug-strings
7191 Direct the linker to not merge together strings in the debugging
7192 information that are identical in different object files.  Merging is
7193 not supported by all assemblers or linkers.  Merging decreases the size
7194 of the debug information in the output file at the cost of increasing
7195 link processing time.  Merging is enabled by default.
7197 @item -fdebug-prefix-map=@var{old}=@var{new}
7198 @opindex fdebug-prefix-map
7199 When compiling files residing in directory @file{@var{old}}, record
7200 debugging information describing them as if the files resided in
7201 directory @file{@var{new}} instead.  This can be used to replace a
7202 build-time path with an install-time path in the debug info.  It can
7203 also be used to change an absolute path to a relative path by using
7204 @file{.} for @var{new}.  This can give more reproducible builds, which
7205 are location independent, but may require an extra command to tell GDB
7206 where to find the source files. See also @option{-ffile-prefix-map}.
7208 @item -fvar-tracking
7209 @opindex fvar-tracking
7210 Run variable tracking pass.  It computes where variables are stored at each
7211 position in code.  Better debugging information is then generated
7212 (if the debugging information format supports this information).
7214 It is enabled by default when compiling with optimization (@option{-Os},
7215 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7216 the debug info format supports it.
7218 @item -fvar-tracking-assignments
7219 @opindex fvar-tracking-assignments
7220 @opindex fno-var-tracking-assignments
7221 Annotate assignments to user variables early in the compilation and
7222 attempt to carry the annotations over throughout the compilation all the
7223 way to the end, in an attempt to improve debug information while
7224 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7226 It can be enabled even if var-tracking is disabled, in which case
7227 annotations are created and maintained, but discarded at the end.
7228 By default, this flag is enabled together with @option{-fvar-tracking},
7229 except when selective scheduling is enabled.
7231 @item -gsplit-dwarf
7232 @opindex gsplit-dwarf
7233 Separate as much DWARF debugging information as possible into a
7234 separate output file with the extension @file{.dwo}.  This option allows
7235 the build system to avoid linking files with debug information.  To
7236 be useful, this option requires a debugger capable of reading @file{.dwo}
7237 files.
7239 @item -gpubnames
7240 @opindex gpubnames
7241 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7243 @item -ggnu-pubnames
7244 @opindex ggnu-pubnames
7245 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7246 suitable for conversion into a GDB@ index.  This option is only useful
7247 with a linker that can produce GDB@ index version 7.
7249 @item -fdebug-types-section
7250 @opindex fdebug-types-section
7251 @opindex fno-debug-types-section
7252 When using DWARF Version 4 or higher, type DIEs can be put into
7253 their own @code{.debug_types} section instead of making them part of the
7254 @code{.debug_info} section.  It is more efficient to put them in a separate
7255 comdat sections since the linker can then remove duplicates.
7256 But not all DWARF consumers support @code{.debug_types} sections yet
7257 and on some objects @code{.debug_types} produces larger instead of smaller
7258 debugging information.
7260 @item -grecord-gcc-switches
7261 @itemx -gno-record-gcc-switches
7262 @opindex grecord-gcc-switches
7263 @opindex gno-record-gcc-switches
7264 This switch causes the command-line options used to invoke the
7265 compiler that may affect code generation to be appended to the
7266 DW_AT_producer attribute in DWARF debugging information.  The options
7267 are concatenated with spaces separating them from each other and from
7268 the compiler version.  
7269 It is enabled by default.
7270 See also @option{-frecord-gcc-switches} for another
7271 way of storing compiler options into the object file.  
7273 @item -gstrict-dwarf
7274 @opindex gstrict-dwarf
7275 Disallow using extensions of later DWARF standard version than selected
7276 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7277 DWARF extensions from later standard versions is allowed.
7279 @item -gno-strict-dwarf
7280 @opindex gno-strict-dwarf
7281 Allow using extensions of later DWARF standard version than selected with
7282 @option{-gdwarf-@var{version}}.
7284 @item -gas-loc-support
7285 @opindex gas-loc-support
7286 Inform the compiler that the assembler supports @code{.loc} directives.
7287 It may then use them for the assembler to generate DWARF2+ line number
7288 tables.
7290 This is generally desirable, because assembler-generated line-number
7291 tables are a lot more compact than those the compiler can generate
7292 itself.
7294 This option will be enabled by default if, at GCC configure time, the
7295 assembler was found to support such directives.
7297 @item -gno-as-loc-support
7298 @opindex gno-as-loc-support
7299 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7300 line number tables are to be generated.
7302 @item gas-locview-support
7303 @opindex gas-locview-support
7304 Inform the compiler that the assembler supports @code{view} assignment
7305 and reset assertion checking in @code{.loc} directives.
7307 This option will be enabled by default if, at GCC configure time, the
7308 assembler was found to support them.
7310 @item gno-as-locview-support
7311 Force GCC to assign view numbers internally, if
7312 @option{-gvariable-location-views} are explicitly requested.
7314 @item -gcolumn-info
7315 @itemx -gno-column-info
7316 @opindex gcolumn-info
7317 @opindex gno-column-info
7318 Emit location column information into DWARF debugging information, rather
7319 than just file and line.
7320 This option is enabled by default.
7322 @item -gstatement-frontiers
7323 @itemx -gno-statement-frontiers
7324 @opindex gstatement-frontiers
7325 @opindex gno-statement-frontiers
7326 This option causes GCC to create markers in the internal representation
7327 at the beginning of statements, and to keep them roughly in place
7328 throughout compilation, using them to guide the output of @code{is_stmt}
7329 markers in the line number table.  This is enabled by default when
7330 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7331 @dots{}), and outputting DWARF 2 debug information at the normal level.
7333 @item -gvariable-location-views
7334 @itemx -gvariable-location-views=incompat5
7335 @itemx -gno-variable-location-views
7336 @opindex gvariable-location-views
7337 @opindex gvariable-location-views=incompat5
7338 @opindex gno-variable-location-views
7339 Augment variable location lists with progressive view numbers implied
7340 from the line number table.  This enables debug information consumers to
7341 inspect state at certain points of the program, even if no instructions
7342 associated with the corresponding source locations are present at that
7343 point.  If the assembler lacks support for view numbers in line number
7344 tables, this will cause the compiler to emit the line number table,
7345 which generally makes them somewhat less compact.  The augmented line
7346 number tables and location lists are fully backward-compatible, so they
7347 can be consumed by debug information consumers that are not aware of
7348 these augmentations, but they won't derive any benefit from them either.
7350 This is enabled by default when outputting DWARF 2 debug information at
7351 the normal level, as long as there is assembler support,
7352 @option{-fvar-tracking-assignments} is enabled and
7353 @option{-gstrict-dwarf} is not.  When assembler support is not
7354 available, this may still be enabled, but it will force GCC to output
7355 internal line number tables, and if
7356 @option{-ginternal-reset-location-views} is not enabled, that will most
7357 certainly lead to silently mismatching location views.
7359 There is a proposed representation for view numbers that is not backward
7360 compatible with the location list format introduced in DWARF 5, that can
7361 be enabled with @option{-gvariable-location-views=incompat5}.  This
7362 option may be removed in the future, is only provided as a reference
7363 implementation of the proposed representation.  Debug information
7364 consumers are not expected to support this extended format, and they
7365 would be rendered unable to decode location lists using it.
7367 @item -ginternal-reset-location-views
7368 @itemx -gnointernal-reset-location-views
7369 @opindex ginternal-reset-location-views
7370 @opindex gno-internal-reset-location-views
7371 Attempt to determine location views that can be omitted from location
7372 view lists.  This requires the compiler to have very accurate insn
7373 length estimates, which isn't always the case, and it may cause
7374 incorrect view lists to be generated silently when using an assembler
7375 that does not support location view lists.  The GNU assembler will flag
7376 any such error as a @code{view number mismatch}.  This is only enabled
7377 on ports that define a reliable estimation function.
7379 @item -ginline-points
7380 @itemx -gno-inline-points
7381 @opindex ginline-points
7382 @opindex gno-inline-points
7383 Generate extended debug information for inlined functions.  Location
7384 view tracking markers are inserted at inlined entry points, so that
7385 address and view numbers can be computed and output in debug
7386 information.  This can be enabled independently of location views, in
7387 which case the view numbers won't be output, but it can only be enabled
7388 along with statement frontiers, and it is only enabled by default if
7389 location views are enabled.
7391 @item -gz@r{[}=@var{type}@r{]}
7392 @opindex gz
7393 Produce compressed debug sections in DWARF format, if that is supported.
7394 If @var{type} is not given, the default type depends on the capabilities
7395 of the assembler and linker used.  @var{type} may be one of
7396 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7397 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7398 compression in traditional GNU format).  If the linker doesn't support
7399 writing compressed debug sections, the option is rejected.  Otherwise,
7400 if the assembler does not support them, @option{-gz} is silently ignored
7401 when producing object files.
7403 @item -femit-struct-debug-baseonly
7404 @opindex femit-struct-debug-baseonly
7405 Emit debug information for struct-like types
7406 only when the base name of the compilation source file
7407 matches the base name of file in which the struct is defined.
7409 This option substantially reduces the size of debugging information,
7410 but at significant potential loss in type information to the debugger.
7411 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7412 See @option{-femit-struct-debug-detailed} for more detailed control.
7414 This option works only with DWARF debug output.
7416 @item -femit-struct-debug-reduced
7417 @opindex femit-struct-debug-reduced
7418 Emit debug information for struct-like types
7419 only when the base name of the compilation source file
7420 matches the base name of file in which the type is defined,
7421 unless the struct is a template or defined in a system header.
7423 This option significantly reduces the size of debugging information,
7424 with some potential loss in type information to the debugger.
7425 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7426 See @option{-femit-struct-debug-detailed} for more detailed control.
7428 This option works only with DWARF debug output.
7430 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7431 @opindex femit-struct-debug-detailed
7432 Specify the struct-like types
7433 for which the compiler generates debug information.
7434 The intent is to reduce duplicate struct debug information
7435 between different object files within the same program.
7437 This option is a detailed version of
7438 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7439 which serves for most needs.
7441 A specification has the syntax@*
7442 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7444 The optional first word limits the specification to
7445 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7446 A struct type is used directly when it is the type of a variable, member.
7447 Indirect uses arise through pointers to structs.
7448 That is, when use of an incomplete struct is valid, the use is indirect.
7449 An example is
7450 @samp{struct one direct; struct two * indirect;}.
7452 The optional second word limits the specification to
7453 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7454 Generic structs are a bit complicated to explain.
7455 For C++, these are non-explicit specializations of template classes,
7456 or non-template classes within the above.
7457 Other programming languages have generics,
7458 but @option{-femit-struct-debug-detailed} does not yet implement them.
7460 The third word specifies the source files for those
7461 structs for which the compiler should emit debug information.
7462 The values @samp{none} and @samp{any} have the normal meaning.
7463 The value @samp{base} means that
7464 the base of name of the file in which the type declaration appears
7465 must match the base of the name of the main compilation file.
7466 In practice, this means that when compiling @file{foo.c}, debug information
7467 is generated for types declared in that file and @file{foo.h},
7468 but not other header files.
7469 The value @samp{sys} means those types satisfying @samp{base}
7470 or declared in system or compiler headers.
7472 You may need to experiment to determine the best settings for your application.
7474 The default is @option{-femit-struct-debug-detailed=all}.
7476 This option works only with DWARF debug output.
7478 @item -fno-dwarf2-cfi-asm
7479 @opindex fdwarf2-cfi-asm
7480 @opindex fno-dwarf2-cfi-asm
7481 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7482 instead of using GAS @code{.cfi_*} directives.
7484 @item -fno-eliminate-unused-debug-types
7485 @opindex feliminate-unused-debug-types
7486 @opindex fno-eliminate-unused-debug-types
7487 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7488 output for types that are nowhere used in the source file being compiled.
7489 Sometimes it is useful to have GCC emit debugging
7490 information for all types declared in a compilation
7491 unit, regardless of whether or not they are actually used
7492 in that compilation unit, for example 
7493 if, in the debugger, you want to cast a value to a type that is
7494 not actually used in your program (but is declared).  More often,
7495 however, this results in a significant amount of wasted space.
7496 @end table
7498 @node Optimize Options
7499 @section Options That Control Optimization
7500 @cindex optimize options
7501 @cindex options, optimization
7503 These options control various sorts of optimizations.
7505 Without any optimization option, the compiler's goal is to reduce the
7506 cost of compilation and to make debugging produce the expected
7507 results.  Statements are independent: if you stop the program with a
7508 breakpoint between statements, you can then assign a new value to any
7509 variable or change the program counter to any other statement in the
7510 function and get exactly the results you expect from the source
7511 code.
7513 Turning on optimization flags makes the compiler attempt to improve
7514 the performance and/or code size at the expense of compilation time
7515 and possibly the ability to debug the program.
7517 The compiler performs optimization based on the knowledge it has of the
7518 program.  Compiling multiple files at once to a single output file mode allows
7519 the compiler to use information gained from all of the files when compiling
7520 each of them.
7522 Not all optimizations are controlled directly by a flag.  Only
7523 optimizations that have a flag are listed in this section.
7525 Most optimizations are only enabled if an @option{-O} level is set on
7526 the command line.  Otherwise they are disabled, even if individual
7527 optimization flags are specified.
7529 Depending on the target and how GCC was configured, a slightly different
7530 set of optimizations may be enabled at each @option{-O} level than
7531 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7532 to find out the exact set of optimizations that are enabled at each level.
7533 @xref{Overall Options}, for examples.
7535 @table @gcctabopt
7536 @item -O
7537 @itemx -O1
7538 @opindex O
7539 @opindex O1
7540 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7541 more memory for a large function.
7543 With @option{-O}, the compiler tries to reduce code size and execution
7544 time, without performing any optimizations that take a great deal of
7545 compilation time.
7547 @option{-O} turns on the following optimization flags:
7548 @gccoptlist{
7549 -fauto-inc-dec @gol
7550 -fbranch-count-reg @gol
7551 -fcombine-stack-adjustments @gol
7552 -fcompare-elim @gol
7553 -fcprop-registers @gol
7554 -fdce @gol
7555 -fdefer-pop @gol
7556 -fdelayed-branch @gol
7557 -fdse @gol
7558 -fforward-propagate @gol
7559 -fguess-branch-probability @gol
7560 -fif-conversion2 @gol
7561 -fif-conversion @gol
7562 -finline-functions-called-once @gol
7563 -fipa-pure-const @gol
7564 -fipa-profile @gol
7565 -fipa-reference @gol
7566 -fmerge-constants @gol
7567 -fmove-loop-invariants @gol
7568 -fomit-frame-pointer @gol
7569 -freorder-blocks @gol
7570 -fshrink-wrap @gol
7571 -fshrink-wrap-separate @gol
7572 -fsplit-wide-types @gol
7573 -fssa-backprop @gol
7574 -fssa-phiopt @gol
7575 -ftree-bit-ccp @gol
7576 -ftree-ccp @gol
7577 -ftree-ch @gol
7578 -ftree-coalesce-vars @gol
7579 -ftree-copy-prop @gol
7580 -ftree-dce @gol
7581 -ftree-dominator-opts @gol
7582 -ftree-dse @gol
7583 -ftree-forwprop @gol
7584 -ftree-fre @gol
7585 -ftree-phiprop @gol
7586 -ftree-sink @gol
7587 -ftree-slsr @gol
7588 -ftree-sra @gol
7589 -ftree-pta @gol
7590 -ftree-ter @gol
7591 -funit-at-a-time}
7593 @item -O2
7594 @opindex O2
7595 Optimize even more.  GCC performs nearly all supported optimizations
7596 that do not involve a space-speed tradeoff.
7597 As compared to @option{-O}, this option increases both compilation time
7598 and the performance of the generated code.
7600 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7601 also turns on the following optimization flags:
7602 @gccoptlist{-fthread-jumps @gol
7603 -falign-functions  -falign-jumps @gol
7604 -falign-loops  -falign-labels @gol
7605 -fcaller-saves @gol
7606 -fcrossjumping @gol
7607 -fcse-follow-jumps  -fcse-skip-blocks @gol
7608 -fdelete-null-pointer-checks @gol
7609 -fdevirtualize -fdevirtualize-speculatively @gol
7610 -fexpensive-optimizations @gol
7611 -fgcse  -fgcse-lm  @gol
7612 -fhoist-adjacent-loads @gol
7613 -finline-small-functions @gol
7614 -findirect-inlining @gol
7615 -fipa-cp @gol
7616 -fipa-bit-cp @gol
7617 -fipa-vrp @gol
7618 -fipa-sra @gol
7619 -fipa-icf @gol
7620 -fisolate-erroneous-paths-dereference @gol
7621 -flra-remat @gol
7622 -foptimize-sibling-calls @gol
7623 -foptimize-strlen @gol
7624 -fpartial-inlining @gol
7625 -fpeephole2 @gol
7626 -freorder-blocks-algorithm=stc @gol
7627 -freorder-blocks-and-partition -freorder-functions @gol
7628 -frerun-cse-after-loop  @gol
7629 -fsched-interblock  -fsched-spec @gol
7630 -fschedule-insns  -fschedule-insns2 @gol
7631 -fstore-merging @gol
7632 -fstrict-aliasing @gol
7633 -ftree-builtin-call-dce @gol
7634 -ftree-switch-conversion -ftree-tail-merge @gol
7635 -fcode-hoisting @gol
7636 -ftree-pre @gol
7637 -ftree-vrp @gol
7638 -fipa-ra}
7640 Please note the warning under @option{-fgcse} about
7641 invoking @option{-O2} on programs that use computed gotos.
7643 @item -O3
7644 @opindex O3
7645 Optimize yet more.  @option{-O3} turns on all optimizations specified
7646 by @option{-O2} and also turns on the following optimization flags:
7647 @gccoptlist{-finline-functions @gol
7648 -funswitch-loops @gol
7649 -fpredictive-commoning @gol
7650 -fgcse-after-reload @gol
7651 -ftree-loop-vectorize @gol
7652 -ftree-loop-distribution @gol
7653 -ftree-loop-distribute-patterns @gol
7654 -floop-interchange @gol
7655 -fsplit-paths @gol
7656 -ftree-slp-vectorize @gol
7657 -fvect-cost-model @gol
7658 -ftree-partial-pre @gol
7659 -fpeel-loops @gol
7660 -fipa-cp-clone}
7662 @item -O0
7663 @opindex O0
7664 Reduce compilation time and make debugging produce the expected
7665 results.  This is the default.
7667 @item -Os
7668 @opindex Os
7669 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7670 do not typically increase code size.  It also performs further
7671 optimizations designed to reduce code size.
7673 @option{-Os} disables the following optimization flags:
7674 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7675 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7676 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7678 @item -Ofast
7679 @opindex Ofast
7680 Disregard strict standards compliance.  @option{-Ofast} enables all
7681 @option{-O3} optimizations.  It also enables optimizations that are not
7682 valid for all standard-compliant programs.
7683 It turns on @option{-ffast-math} and the Fortran-specific
7684 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7685 specified, and @option{-fno-protect-parens}.
7687 @item -Og
7688 @opindex Og
7689 Optimize debugging experience.  @option{-Og} enables optimizations
7690 that do not interfere with debugging. It should be the optimization
7691 level of choice for the standard edit-compile-debug cycle, offering
7692 a reasonable level of optimization while maintaining fast compilation
7693 and a good debugging experience.
7694 @end table
7696 If you use multiple @option{-O} options, with or without level numbers,
7697 the last such option is the one that is effective.
7699 Options of the form @option{-f@var{flag}} specify machine-independent
7700 flags.  Most flags have both positive and negative forms; the negative
7701 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7702 below, only one of the forms is listed---the one you typically 
7703 use.  You can figure out the other form by either removing @samp{no-}
7704 or adding it.
7706 The following options control specific optimizations.  They are either
7707 activated by @option{-O} options or are related to ones that are.  You
7708 can use the following flags in the rare cases when ``fine-tuning'' of
7709 optimizations to be performed is desired.
7711 @table @gcctabopt
7712 @item -fno-defer-pop
7713 @opindex fno-defer-pop
7714 Always pop the arguments to each function call as soon as that function
7715 returns.  For machines that must pop arguments after a function call,
7716 the compiler normally lets arguments accumulate on the stack for several
7717 function calls and pops them all at once.
7719 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7721 @item -fforward-propagate
7722 @opindex fforward-propagate
7723 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7724 instructions and checks if the result can be simplified.  If loop unrolling
7725 is active, two passes are performed and the second is scheduled after
7726 loop unrolling.
7728 This option is enabled by default at optimization levels @option{-O},
7729 @option{-O2}, @option{-O3}, @option{-Os}.
7731 @item -ffp-contract=@var{style}
7732 @opindex ffp-contract
7733 @option{-ffp-contract=off} disables floating-point expression contraction.
7734 @option{-ffp-contract=fast} enables floating-point expression contraction
7735 such as forming of fused multiply-add operations if the target has
7736 native support for them.
7737 @option{-ffp-contract=on} enables floating-point expression contraction
7738 if allowed by the language standard.  This is currently not implemented
7739 and treated equal to @option{-ffp-contract=off}.
7741 The default is @option{-ffp-contract=fast}.
7743 @item -fomit-frame-pointer
7744 @opindex fomit-frame-pointer
7745 Omit the frame pointer in functions that don't need one.  This avoids the
7746 instructions to save, set up and restore the frame pointer; on many targets
7747 it also makes an extra register available.
7749 On some targets this flag has no effect because the standard calling sequence
7750 always uses a frame pointer, so it cannot be omitted.
7752 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7753 is used in all functions.  Several targets always omit the frame pointer in
7754 leaf functions.
7756 Enabled by default at @option{-O} and higher.
7758 @item -foptimize-sibling-calls
7759 @opindex foptimize-sibling-calls
7760 Optimize sibling and tail recursive calls.
7762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7764 @item -foptimize-strlen
7765 @opindex foptimize-strlen
7766 Optimize various standard C string functions (e.g. @code{strlen},
7767 @code{strchr} or @code{strcpy}) and
7768 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7770 Enabled at levels @option{-O2}, @option{-O3}.
7772 @item -fno-inline
7773 @opindex fno-inline
7774 Do not expand any functions inline apart from those marked with
7775 the @code{always_inline} attribute.  This is the default when not
7776 optimizing.
7778 Single functions can be exempted from inlining by marking them
7779 with the @code{noinline} attribute.
7781 @item -finline-small-functions
7782 @opindex finline-small-functions
7783 Integrate functions into their callers when their body is smaller than expected
7784 function call code (so overall size of program gets smaller).  The compiler
7785 heuristically decides which functions are simple enough to be worth integrating
7786 in this way.  This inlining applies to all functions, even those not declared
7787 inline.
7789 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7791 @item -findirect-inlining
7792 @opindex findirect-inlining
7793 Inline also indirect calls that are discovered to be known at compile
7794 time thanks to previous inlining.  This option has any effect only
7795 when inlining itself is turned on by the @option{-finline-functions}
7796 or @option{-finline-small-functions} options.
7798 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7800 @item -finline-functions
7801 @opindex finline-functions
7802 Consider all functions for inlining, even if they are not declared inline.
7803 The compiler heuristically decides which functions are worth integrating
7804 in this way.
7806 If all calls to a given function are integrated, and the function is
7807 declared @code{static}, then the function is normally not output as
7808 assembler code in its own right.
7810 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7812 @item -finline-functions-called-once
7813 @opindex finline-functions-called-once
7814 Consider all @code{static} functions called once for inlining into their
7815 caller even if they are not marked @code{inline}.  If a call to a given
7816 function is integrated, then the function is not output as assembler code
7817 in its own right.
7819 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7821 @item -fearly-inlining
7822 @opindex fearly-inlining
7823 Inline functions marked by @code{always_inline} and functions whose body seems
7824 smaller than the function call overhead early before doing
7825 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7826 makes profiling significantly cheaper and usually inlining faster on programs
7827 having large chains of nested wrapper functions.
7829 Enabled by default.
7831 @item -fipa-sra
7832 @opindex fipa-sra
7833 Perform interprocedural scalar replacement of aggregates, removal of
7834 unused parameters and replacement of parameters passed by reference
7835 by parameters passed by value.
7837 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7839 @item -finline-limit=@var{n}
7840 @opindex finline-limit
7841 By default, GCC limits the size of functions that can be inlined.  This flag
7842 allows coarse control of this limit.  @var{n} is the size of functions that
7843 can be inlined in number of pseudo instructions.
7845 Inlining is actually controlled by a number of parameters, which may be
7846 specified individually by using @option{--param @var{name}=@var{value}}.
7847 The @option{-finline-limit=@var{n}} option sets some of these parameters
7848 as follows:
7850 @table @gcctabopt
7851 @item max-inline-insns-single
7852 is set to @var{n}/2.
7853 @item max-inline-insns-auto
7854 is set to @var{n}/2.
7855 @end table
7857 See below for a documentation of the individual
7858 parameters controlling inlining and for the defaults of these parameters.
7860 @emph{Note:} there may be no value to @option{-finline-limit} that results
7861 in default behavior.
7863 @emph{Note:} pseudo instruction represents, in this particular context, an
7864 abstract measurement of function's size.  In no way does it represent a count
7865 of assembly instructions and as such its exact meaning might change from one
7866 release to an another.
7868 @item -fno-keep-inline-dllexport
7869 @opindex fno-keep-inline-dllexport
7870 This is a more fine-grained version of @option{-fkeep-inline-functions},
7871 which applies only to functions that are declared using the @code{dllexport}
7872 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7873 Functions}.
7875 @item -fkeep-inline-functions
7876 @opindex fkeep-inline-functions
7877 In C, emit @code{static} functions that are declared @code{inline}
7878 into the object file, even if the function has been inlined into all
7879 of its callers.  This switch does not affect functions using the
7880 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7881 inline functions into the object file.
7883 @item -fkeep-static-functions
7884 @opindex fkeep-static-functions
7885 Emit @code{static} functions into the object file, even if the function
7886 is never used.
7888 @item -fkeep-static-consts
7889 @opindex fkeep-static-consts
7890 Emit variables declared @code{static const} when optimization isn't turned
7891 on, even if the variables aren't referenced.
7893 GCC enables this option by default.  If you want to force the compiler to
7894 check if a variable is referenced, regardless of whether or not
7895 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7897 @item -fmerge-constants
7898 @opindex fmerge-constants
7899 Attempt to merge identical constants (string constants and floating-point
7900 constants) across compilation units.
7902 This option is the default for optimized compilation if the assembler and
7903 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7904 behavior.
7906 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7908 @item -fmerge-all-constants
7909 @opindex fmerge-all-constants
7910 Attempt to merge identical constants and identical variables.
7912 This option implies @option{-fmerge-constants}.  In addition to
7913 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7914 arrays or initialized constant variables with integral or floating-point
7915 types.  Languages like C or C++ require each variable, including multiple
7916 instances of the same variable in recursive calls, to have distinct locations,
7917 so using this option results in non-conforming
7918 behavior.
7920 @item -fmodulo-sched
7921 @opindex fmodulo-sched
7922 Perform swing modulo scheduling immediately before the first scheduling
7923 pass.  This pass looks at innermost loops and reorders their
7924 instructions by overlapping different iterations.
7926 @item -fmodulo-sched-allow-regmoves
7927 @opindex fmodulo-sched-allow-regmoves
7928 Perform more aggressive SMS-based modulo scheduling with register moves
7929 allowed.  By setting this flag certain anti-dependences edges are
7930 deleted, which triggers the generation of reg-moves based on the
7931 life-range analysis.  This option is effective only with
7932 @option{-fmodulo-sched} enabled.
7934 @item -fno-branch-count-reg
7935 @opindex fno-branch-count-reg
7936 Avoid running a pass scanning for opportunities to use ``decrement and
7937 branch'' instructions on a count register instead of generating sequences
7938 of instructions that decrement a register, compare it against zero, and
7939 then branch based upon the result.  This option is only meaningful on
7940 architectures that support such instructions, which include x86, PowerPC,
7941 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7942 doesn't remove the decrement and branch instructions from the generated
7943 instruction stream introduced by other optimization passes.
7945 Enabled by default at @option{-O1} and higher.
7947 The default is @option{-fbranch-count-reg}.
7949 @item -fno-function-cse
7950 @opindex fno-function-cse
7951 Do not put function addresses in registers; make each instruction that
7952 calls a constant function contain the function's address explicitly.
7954 This option results in less efficient code, but some strange hacks
7955 that alter the assembler output may be confused by the optimizations
7956 performed when this option is not used.
7958 The default is @option{-ffunction-cse}
7960 @item -fno-zero-initialized-in-bss
7961 @opindex fno-zero-initialized-in-bss
7962 If the target supports a BSS section, GCC by default puts variables that
7963 are initialized to zero into BSS@.  This can save space in the resulting
7964 code.
7966 This option turns off this behavior because some programs explicitly
7967 rely on variables going to the data section---e.g., so that the
7968 resulting executable can find the beginning of that section and/or make
7969 assumptions based on that.
7971 The default is @option{-fzero-initialized-in-bss}.
7973 @item -fthread-jumps
7974 @opindex fthread-jumps
7975 Perform optimizations that check to see if a jump branches to a
7976 location where another comparison subsumed by the first is found.  If
7977 so, the first branch is redirected to either the destination of the
7978 second branch or a point immediately following it, depending on whether
7979 the condition is known to be true or false.
7981 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7983 @item -fsplit-wide-types
7984 @opindex fsplit-wide-types
7985 When using a type that occupies multiple registers, such as @code{long
7986 long} on a 32-bit system, split the registers apart and allocate them
7987 independently.  This normally generates better code for those types,
7988 but may make debugging more difficult.
7990 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7991 @option{-Os}.
7993 @item -fcse-follow-jumps
7994 @opindex fcse-follow-jumps
7995 In common subexpression elimination (CSE), scan through jump instructions
7996 when the target of the jump is not reached by any other path.  For
7997 example, when CSE encounters an @code{if} statement with an
7998 @code{else} clause, CSE follows the jump when the condition
7999 tested is false.
8001 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8003 @item -fcse-skip-blocks
8004 @opindex fcse-skip-blocks
8005 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8006 follow jumps that conditionally skip over blocks.  When CSE
8007 encounters a simple @code{if} statement with no else clause,
8008 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8009 body of the @code{if}.
8011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8013 @item -frerun-cse-after-loop
8014 @opindex frerun-cse-after-loop
8015 Re-run common subexpression elimination after loop optimizations are
8016 performed.
8018 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8020 @item -fgcse
8021 @opindex fgcse
8022 Perform a global common subexpression elimination pass.
8023 This pass also performs global constant and copy propagation.
8025 @emph{Note:} When compiling a program using computed gotos, a GCC
8026 extension, you may get better run-time performance if you disable
8027 the global common subexpression elimination pass by adding
8028 @option{-fno-gcse} to the command line.
8030 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8032 @item -fgcse-lm
8033 @opindex fgcse-lm
8034 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8035 attempts to move loads that are only killed by stores into themselves.  This
8036 allows a loop containing a load/store sequence to be changed to a load outside
8037 the loop, and a copy/store within the loop.
8039 Enabled by default when @option{-fgcse} is enabled.
8041 @item -fgcse-sm
8042 @opindex fgcse-sm
8043 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8044 global common subexpression elimination.  This pass attempts to move
8045 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8046 loops containing a load/store sequence can be changed to a load before
8047 the loop and a store after the loop.
8049 Not enabled at any optimization level.
8051 @item -fgcse-las
8052 @opindex fgcse-las
8053 When @option{-fgcse-las} is enabled, the global common subexpression
8054 elimination pass eliminates redundant loads that come after stores to the
8055 same memory location (both partial and full redundancies).
8057 Not enabled at any optimization level.
8059 @item -fgcse-after-reload
8060 @opindex fgcse-after-reload
8061 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8062 pass is performed after reload.  The purpose of this pass is to clean up
8063 redundant spilling.
8065 @item -faggressive-loop-optimizations
8066 @opindex faggressive-loop-optimizations
8067 This option tells the loop optimizer to use language constraints to
8068 derive bounds for the number of iterations of a loop.  This assumes that
8069 loop code does not invoke undefined behavior by for example causing signed
8070 integer overflows or out-of-bound array accesses.  The bounds for the
8071 number of iterations of a loop are used to guide loop unrolling and peeling
8072 and loop exit test optimizations.
8073 This option is enabled by default.
8075 @item -funconstrained-commons
8076 @opindex funconstrained-commons
8077 This option tells the compiler that variables declared in common blocks
8078 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8079 prevents certain optimizations that depend on knowing the array bounds.
8081 @item -fcrossjumping
8082 @opindex fcrossjumping
8083 Perform cross-jumping transformation.
8084 This transformation unifies equivalent code and saves code size.  The
8085 resulting code may or may not perform better than without cross-jumping.
8087 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8089 @item -fauto-inc-dec
8090 @opindex fauto-inc-dec
8091 Combine increments or decrements of addresses with memory accesses.
8092 This pass is always skipped on architectures that do not have
8093 instructions to support this.  Enabled by default at @option{-O} and
8094 higher on architectures that support this.
8096 @item -fdce
8097 @opindex fdce
8098 Perform dead code elimination (DCE) on RTL@.
8099 Enabled by default at @option{-O} and higher.
8101 @item -fdse
8102 @opindex fdse
8103 Perform dead store elimination (DSE) on RTL@.
8104 Enabled by default at @option{-O} and higher.
8106 @item -fif-conversion
8107 @opindex fif-conversion
8108 Attempt to transform conditional jumps into branch-less equivalents.  This
8109 includes use of conditional moves, min, max, set flags and abs instructions, and
8110 some tricks doable by standard arithmetics.  The use of conditional execution
8111 on chips where it is available is controlled by @option{-fif-conversion2}.
8113 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8115 @item -fif-conversion2
8116 @opindex fif-conversion2
8117 Use conditional execution (where available) to transform conditional jumps into
8118 branch-less equivalents.
8120 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8122 @item -fdeclone-ctor-dtor
8123 @opindex fdeclone-ctor-dtor
8124 The C++ ABI requires multiple entry points for constructors and
8125 destructors: one for a base subobject, one for a complete object, and
8126 one for a virtual destructor that calls operator delete afterwards.
8127 For a hierarchy with virtual bases, the base and complete variants are
8128 clones, which means two copies of the function.  With this option, the
8129 base and complete variants are changed to be thunks that call a common
8130 implementation.
8132 Enabled by @option{-Os}.
8134 @item -fdelete-null-pointer-checks
8135 @opindex fdelete-null-pointer-checks
8136 Assume that programs cannot safely dereference null pointers, and that
8137 no code or data element resides at address zero.
8138 This option enables simple constant
8139 folding optimizations at all optimization levels.  In addition, other
8140 optimization passes in GCC use this flag to control global dataflow
8141 analyses that eliminate useless checks for null pointers; these assume
8142 that a memory access to address zero always results in a trap, so
8143 that if a pointer is checked after it has already been dereferenced,
8144 it cannot be null.
8146 Note however that in some environments this assumption is not true.
8147 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8148 for programs that depend on that behavior.
8150 This option is enabled by default on most targets.  On Nios II ELF, it
8151 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8153 Passes that use the dataflow information
8154 are enabled independently at different optimization levels.
8156 @item -fdevirtualize
8157 @opindex fdevirtualize
8158 Attempt to convert calls to virtual functions to direct calls.  This
8159 is done both within a procedure and interprocedurally as part of
8160 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8161 propagation (@option{-fipa-cp}).
8162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8164 @item -fdevirtualize-speculatively
8165 @opindex fdevirtualize-speculatively
8166 Attempt to convert calls to virtual functions to speculative direct calls.
8167 Based on the analysis of the type inheritance graph, determine for a given call
8168 the set of likely targets. If the set is small, preferably of size 1, change
8169 the call into a conditional deciding between direct and indirect calls.  The
8170 speculative calls enable more optimizations, such as inlining.  When they seem
8171 useless after further optimization, they are converted back into original form.
8173 @item -fdevirtualize-at-ltrans
8174 @opindex fdevirtualize-at-ltrans
8175 Stream extra information needed for aggressive devirtualization when running
8176 the link-time optimizer in local transformation mode.  
8177 This option enables more devirtualization but
8178 significantly increases the size of streamed data. For this reason it is
8179 disabled by default.
8181 @item -fexpensive-optimizations
8182 @opindex fexpensive-optimizations
8183 Perform a number of minor optimizations that are relatively expensive.
8185 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8187 @item -free
8188 @opindex free
8189 Attempt to remove redundant extension instructions.  This is especially
8190 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8191 registers after writing to their lower 32-bit half.
8193 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8194 @option{-O3}, @option{-Os}.
8196 @item -fno-lifetime-dse
8197 @opindex fno-lifetime-dse
8198 In C++ the value of an object is only affected by changes within its
8199 lifetime: when the constructor begins, the object has an indeterminate
8200 value, and any changes during the lifetime of the object are dead when
8201 the object is destroyed.  Normally dead store elimination will take
8202 advantage of this; if your code relies on the value of the object
8203 storage persisting beyond the lifetime of the object, you can use this
8204 flag to disable this optimization.  To preserve stores before the
8205 constructor starts (e.g. because your operator new clears the object
8206 storage) but still treat the object as dead after the destructor you,
8207 can use @option{-flifetime-dse=1}.  The default behavior can be
8208 explicitly selected with @option{-flifetime-dse=2}.
8209 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8211 @item -flive-range-shrinkage
8212 @opindex flive-range-shrinkage
8213 Attempt to decrease register pressure through register live range
8214 shrinkage.  This is helpful for fast processors with small or moderate
8215 size register sets.
8217 @item -fira-algorithm=@var{algorithm}
8218 @opindex fira-algorithm
8219 Use the specified coloring algorithm for the integrated register
8220 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8221 specifies Chow's priority coloring, or @samp{CB}, which specifies
8222 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8223 for all architectures, but for those targets that do support it, it is
8224 the default because it generates better code.
8226 @item -fira-region=@var{region}
8227 @opindex fira-region
8228 Use specified regions for the integrated register allocator.  The
8229 @var{region} argument should be one of the following:
8231 @table @samp
8233 @item all
8234 Use all loops as register allocation regions.
8235 This can give the best results for machines with a small and/or
8236 irregular register set.
8238 @item mixed
8239 Use all loops except for loops with small register pressure 
8240 as the regions.  This value usually gives
8241 the best results in most cases and for most architectures,
8242 and is enabled by default when compiling with optimization for speed
8243 (@option{-O}, @option{-O2}, @dots{}).
8245 @item one
8246 Use all functions as a single region.  
8247 This typically results in the smallest code size, and is enabled by default for
8248 @option{-Os} or @option{-O0}.
8250 @end table
8252 @item -fira-hoist-pressure
8253 @opindex fira-hoist-pressure
8254 Use IRA to evaluate register pressure in the code hoisting pass for
8255 decisions to hoist expressions.  This option usually results in smaller
8256 code, but it can slow the compiler down.
8258 This option is enabled at level @option{-Os} for all targets.
8260 @item -fira-loop-pressure
8261 @opindex fira-loop-pressure
8262 Use IRA to evaluate register pressure in loops for decisions to move
8263 loop invariants.  This option usually results in generation
8264 of faster and smaller code on machines with large register files (>= 32
8265 registers), but it can slow the compiler down.
8267 This option is enabled at level @option{-O3} for some targets.
8269 @item -fno-ira-share-save-slots
8270 @opindex fno-ira-share-save-slots
8271 Disable sharing of stack slots used for saving call-used hard
8272 registers living through a call.  Each hard register gets a
8273 separate stack slot, and as a result function stack frames are
8274 larger.
8276 @item -fno-ira-share-spill-slots
8277 @opindex fno-ira-share-spill-slots
8278 Disable sharing of stack slots allocated for pseudo-registers.  Each
8279 pseudo-register that does not get a hard register gets a separate
8280 stack slot, and as a result function stack frames are larger.
8282 @item -flra-remat
8283 @opindex flra-remat
8284 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8285 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8286 values if it is profitable.
8288 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8290 @item -fdelayed-branch
8291 @opindex fdelayed-branch
8292 If supported for the target machine, attempt to reorder instructions
8293 to exploit instruction slots available after delayed branch
8294 instructions.
8296 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8298 @item -fschedule-insns
8299 @opindex fschedule-insns
8300 If supported for the target machine, attempt to reorder instructions to
8301 eliminate execution stalls due to required data being unavailable.  This
8302 helps machines that have slow floating point or memory load instructions
8303 by allowing other instructions to be issued until the result of the load
8304 or floating-point instruction is required.
8306 Enabled at levels @option{-O2}, @option{-O3}.
8308 @item -fschedule-insns2
8309 @opindex fschedule-insns2
8310 Similar to @option{-fschedule-insns}, but requests an additional pass of
8311 instruction scheduling after register allocation has been done.  This is
8312 especially useful on machines with a relatively small number of
8313 registers and where memory load instructions take more than one cycle.
8315 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8317 @item -fno-sched-interblock
8318 @opindex fno-sched-interblock
8319 Don't schedule instructions across basic blocks.  This is normally
8320 enabled by default when scheduling before register allocation, i.e.@:
8321 with @option{-fschedule-insns} or at @option{-O2} or higher.
8323 @item -fno-sched-spec
8324 @opindex fno-sched-spec
8325 Don't allow speculative motion of non-load instructions.  This is normally
8326 enabled by default when scheduling before register allocation, i.e.@:
8327 with @option{-fschedule-insns} or at @option{-O2} or higher.
8329 @item -fsched-pressure
8330 @opindex fsched-pressure
8331 Enable register pressure sensitive insn scheduling before register
8332 allocation.  This only makes sense when scheduling before register
8333 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8334 @option{-O2} or higher.  Usage of this option can improve the
8335 generated code and decrease its size by preventing register pressure
8336 increase above the number of available hard registers and subsequent
8337 spills in register allocation.
8339 @item -fsched-spec-load
8340 @opindex fsched-spec-load
8341 Allow speculative motion of some load instructions.  This only makes
8342 sense when scheduling before register allocation, i.e.@: with
8343 @option{-fschedule-insns} or at @option{-O2} or higher.
8345 @item -fsched-spec-load-dangerous
8346 @opindex fsched-spec-load-dangerous
8347 Allow speculative motion of more load instructions.  This only makes
8348 sense when scheduling before register allocation, i.e.@: with
8349 @option{-fschedule-insns} or at @option{-O2} or higher.
8351 @item -fsched-stalled-insns
8352 @itemx -fsched-stalled-insns=@var{n}
8353 @opindex fsched-stalled-insns
8354 Define how many insns (if any) can be moved prematurely from the queue
8355 of stalled insns into the ready list during the second scheduling pass.
8356 @option{-fno-sched-stalled-insns} means that no insns are moved
8357 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8358 on how many queued insns can be moved prematurely.
8359 @option{-fsched-stalled-insns} without a value is equivalent to
8360 @option{-fsched-stalled-insns=1}.
8362 @item -fsched-stalled-insns-dep
8363 @itemx -fsched-stalled-insns-dep=@var{n}
8364 @opindex fsched-stalled-insns-dep
8365 Define how many insn groups (cycles) are examined for a dependency
8366 on a stalled insn that is a candidate for premature removal from the queue
8367 of stalled insns.  This has an effect only during the second scheduling pass,
8368 and only if @option{-fsched-stalled-insns} is used.
8369 @option{-fno-sched-stalled-insns-dep} is equivalent to
8370 @option{-fsched-stalled-insns-dep=0}.
8371 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8372 @option{-fsched-stalled-insns-dep=1}.
8374 @item -fsched2-use-superblocks
8375 @opindex fsched2-use-superblocks
8376 When scheduling after register allocation, use superblock scheduling.
8377 This allows motion across basic block boundaries,
8378 resulting in faster schedules.  This option is experimental, as not all machine
8379 descriptions used by GCC model the CPU closely enough to avoid unreliable
8380 results from the algorithm.
8382 This only makes sense when scheduling after register allocation, i.e.@: with
8383 @option{-fschedule-insns2} or at @option{-O2} or higher.
8385 @item -fsched-group-heuristic
8386 @opindex fsched-group-heuristic
8387 Enable the group heuristic in the scheduler.  This heuristic favors
8388 the instruction that belongs to a schedule group.  This is enabled
8389 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8390 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8392 @item -fsched-critical-path-heuristic
8393 @opindex fsched-critical-path-heuristic
8394 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8395 instructions on the critical path.  This is enabled by default when
8396 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8397 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8399 @item -fsched-spec-insn-heuristic
8400 @opindex fsched-spec-insn-heuristic
8401 Enable the speculative instruction heuristic in the scheduler.  This
8402 heuristic favors speculative instructions with greater dependency weakness.
8403 This is enabled by default when scheduling is enabled, i.e.@:
8404 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8405 or at @option{-O2} or higher.
8407 @item -fsched-rank-heuristic
8408 @opindex fsched-rank-heuristic
8409 Enable the rank heuristic in the scheduler.  This heuristic favors
8410 the instruction belonging to a basic block with greater size or frequency.
8411 This is enabled by default when scheduling is enabled, i.e.@:
8412 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8413 at @option{-O2} or higher.
8415 @item -fsched-last-insn-heuristic
8416 @opindex fsched-last-insn-heuristic
8417 Enable the last-instruction heuristic in the scheduler.  This heuristic
8418 favors the instruction that is less dependent on the last instruction
8419 scheduled.  This is enabled by default when scheduling is enabled,
8420 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8421 at @option{-O2} or higher.
8423 @item -fsched-dep-count-heuristic
8424 @opindex fsched-dep-count-heuristic
8425 Enable the dependent-count heuristic in the scheduler.  This heuristic
8426 favors the instruction that has more instructions depending on it.
8427 This is enabled by default when scheduling is enabled, i.e.@:
8428 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8429 at @option{-O2} or higher.
8431 @item -freschedule-modulo-scheduled-loops
8432 @opindex freschedule-modulo-scheduled-loops
8433 Modulo scheduling is performed before traditional scheduling.  If a loop
8434 is modulo scheduled, later scheduling passes may change its schedule.  
8435 Use this option to control that behavior.
8437 @item -fselective-scheduling
8438 @opindex fselective-scheduling
8439 Schedule instructions using selective scheduling algorithm.  Selective
8440 scheduling runs instead of the first scheduler pass.
8442 @item -fselective-scheduling2
8443 @opindex fselective-scheduling2
8444 Schedule instructions using selective scheduling algorithm.  Selective
8445 scheduling runs instead of the second scheduler pass.
8447 @item -fsel-sched-pipelining
8448 @opindex fsel-sched-pipelining
8449 Enable software pipelining of innermost loops during selective scheduling.
8450 This option has no effect unless one of @option{-fselective-scheduling} or
8451 @option{-fselective-scheduling2} is turned on.
8453 @item -fsel-sched-pipelining-outer-loops
8454 @opindex fsel-sched-pipelining-outer-loops
8455 When pipelining loops during selective scheduling, also pipeline outer loops.
8456 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8458 @item -fsemantic-interposition
8459 @opindex fsemantic-interposition
8460 Some object formats, like ELF, allow interposing of symbols by the 
8461 dynamic linker.
8462 This means that for symbols exported from the DSO, the compiler cannot perform
8463 interprocedural propagation, inlining and other optimizations in anticipation
8464 that the function or variable in question may change. While this feature is
8465 useful, for example, to rewrite memory allocation functions by a debugging
8466 implementation, it is expensive in the terms of code quality.
8467 With @option{-fno-semantic-interposition} the compiler assumes that 
8468 if interposition happens for functions the overwriting function will have 
8469 precisely the same semantics (and side effects). 
8470 Similarly if interposition happens
8471 for variables, the constructor of the variable will be the same. The flag
8472 has no effect for functions explicitly declared inline 
8473 (where it is never allowed for interposition to change semantics) 
8474 and for symbols explicitly declared weak.
8476 @item -fshrink-wrap
8477 @opindex fshrink-wrap
8478 Emit function prologues only before parts of the function that need it,
8479 rather than at the top of the function.  This flag is enabled by default at
8480 @option{-O} and higher.
8482 @item -fshrink-wrap-separate
8483 @opindex fshrink-wrap-separate
8484 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8485 those parts are only executed when needed.
8486 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8487 is also turned on and the target supports this.
8489 @item -fcaller-saves
8490 @opindex fcaller-saves
8491 Enable allocation of values to registers that are clobbered by
8492 function calls, by emitting extra instructions to save and restore the
8493 registers around such calls.  Such allocation is done only when it
8494 seems to result in better code.
8496 This option is always enabled by default on certain machines, usually
8497 those which have no call-preserved registers to use instead.
8499 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8501 @item -fcombine-stack-adjustments
8502 @opindex fcombine-stack-adjustments
8503 Tracks stack adjustments (pushes and pops) and stack memory references
8504 and then tries to find ways to combine them.
8506 Enabled by default at @option{-O1} and higher.
8508 @item -fipa-ra
8509 @opindex fipa-ra
8510 Use caller save registers for allocation if those registers are not used by
8511 any called function.  In that case it is not necessary to save and restore
8512 them around calls.  This is only possible if called functions are part of
8513 same compilation unit as current function and they are compiled before it.
8515 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8516 is disabled if generated code will be instrumented for profiling
8517 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8518 exactly (this happens on targets that do not expose prologues
8519 and epilogues in RTL).
8521 @item -fconserve-stack
8522 @opindex fconserve-stack
8523 Attempt to minimize stack usage.  The compiler attempts to use less
8524 stack space, even if that makes the program slower.  This option
8525 implies setting the @option{large-stack-frame} parameter to 100
8526 and the @option{large-stack-frame-growth} parameter to 400.
8528 @item -ftree-reassoc
8529 @opindex ftree-reassoc
8530 Perform reassociation on trees.  This flag is enabled by default
8531 at @option{-O} and higher.
8533 @item -fcode-hoisting
8534 @opindex fcode-hoisting
8535 Perform code hoisting.  Code hoisting tries to move the
8536 evaluation of expressions executed on all paths to the function exit
8537 as early as possible.  This is especially useful as a code size
8538 optimization, but it often helps for code speed as well.
8539 This flag is enabled by default at @option{-O2} and higher.
8541 @item -ftree-pre
8542 @opindex ftree-pre
8543 Perform partial redundancy elimination (PRE) on trees.  This flag is
8544 enabled by default at @option{-O2} and @option{-O3}.
8546 @item -ftree-partial-pre
8547 @opindex ftree-partial-pre
8548 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8549 enabled by default at @option{-O3}.
8551 @item -ftree-forwprop
8552 @opindex ftree-forwprop
8553 Perform forward propagation on trees.  This flag is enabled by default
8554 at @option{-O} and higher.
8556 @item -ftree-fre
8557 @opindex ftree-fre
8558 Perform full redundancy elimination (FRE) on trees.  The difference
8559 between FRE and PRE is that FRE only considers expressions
8560 that are computed on all paths leading to the redundant computation.
8561 This analysis is faster than PRE, though it exposes fewer redundancies.
8562 This flag is enabled by default at @option{-O} and higher.
8564 @item -ftree-phiprop
8565 @opindex ftree-phiprop
8566 Perform hoisting of loads from conditional pointers on trees.  This
8567 pass is enabled by default at @option{-O} and higher.
8569 @item -fhoist-adjacent-loads
8570 @opindex fhoist-adjacent-loads
8571 Speculatively hoist loads from both branches of an if-then-else if the
8572 loads are from adjacent locations in the same structure and the target
8573 architecture has a conditional move instruction.  This flag is enabled
8574 by default at @option{-O2} and higher.
8576 @item -ftree-copy-prop
8577 @opindex ftree-copy-prop
8578 Perform copy propagation on trees.  This pass eliminates unnecessary
8579 copy operations.  This flag is enabled by default at @option{-O} and
8580 higher.
8582 @item -fipa-pure-const
8583 @opindex fipa-pure-const
8584 Discover which functions are pure or constant.
8585 Enabled by default at @option{-O} and higher.
8587 @item -fipa-reference
8588 @opindex fipa-reference
8589 Discover which static variables do not escape the
8590 compilation unit.
8591 Enabled by default at @option{-O} and higher.
8593 @item -fipa-pta
8594 @opindex fipa-pta
8595 Perform interprocedural pointer analysis and interprocedural modification
8596 and reference analysis.  This option can cause excessive memory and
8597 compile-time usage on large compilation units.  It is not enabled by
8598 default at any optimization level.
8600 @item -fipa-profile
8601 @opindex fipa-profile
8602 Perform interprocedural profile propagation.  The functions called only from
8603 cold functions are marked as cold. Also functions executed once (such as
8604 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8605 functions and loop less parts of functions executed once are then optimized for
8606 size.
8607 Enabled by default at @option{-O} and higher.
8609 @item -fipa-cp
8610 @opindex fipa-cp
8611 Perform interprocedural constant propagation.
8612 This optimization analyzes the program to determine when values passed
8613 to functions are constants and then optimizes accordingly.
8614 This optimization can substantially increase performance
8615 if the application has constants passed to functions.
8616 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8618 @item -fipa-cp-clone
8619 @opindex fipa-cp-clone
8620 Perform function cloning to make interprocedural constant propagation stronger.
8621 When enabled, interprocedural constant propagation performs function cloning
8622 when externally visible function can be called with constant arguments.
8623 Because this optimization can create multiple copies of functions,
8624 it may significantly increase code size
8625 (see @option{--param ipcp-unit-growth=@var{value}}).
8626 This flag is enabled by default at @option{-O3}.
8628 @item -fipa-bit-cp
8629 @opindex -fipa-bit-cp
8630 When enabled, perform interprocedural bitwise constant
8631 propagation. This flag is enabled by default at @option{-O2}. It
8632 requires that @option{-fipa-cp} is enabled.
8634 @item -fipa-vrp
8635 @opindex -fipa-vrp
8636 When enabled, perform interprocedural propagation of value
8637 ranges. This flag is enabled by default at @option{-O2}. It requires
8638 that @option{-fipa-cp} is enabled.
8640 @item -fipa-icf
8641 @opindex fipa-icf
8642 Perform Identical Code Folding for functions and read-only variables.
8643 The optimization reduces code size and may disturb unwind stacks by replacing
8644 a function by equivalent one with a different name. The optimization works
8645 more effectively with link-time optimization enabled.
8647 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8648 works on different levels and thus the optimizations are not same - there are
8649 equivalences that are found only by GCC and equivalences found only by Gold.
8651 This flag is enabled by default at @option{-O2} and @option{-Os}.
8653 @item -fisolate-erroneous-paths-dereference
8654 @opindex fisolate-erroneous-paths-dereference
8655 Detect paths that trigger erroneous or undefined behavior due to
8656 dereferencing a null pointer.  Isolate those paths from the main control
8657 flow and turn the statement with erroneous or undefined behavior into a trap.
8658 This flag is enabled by default at @option{-O2} and higher and depends on
8659 @option{-fdelete-null-pointer-checks} also being enabled.
8661 @item -fisolate-erroneous-paths-attribute
8662 @opindex fisolate-erroneous-paths-attribute
8663 Detect paths that trigger erroneous or undefined behavior due to a null value
8664 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8665 attribute.  Isolate those paths from the main control flow and turn the
8666 statement with erroneous or undefined behavior into a trap.  This is not
8667 currently enabled, but may be enabled by @option{-O2} in the future.
8669 @item -ftree-sink
8670 @opindex ftree-sink
8671 Perform forward store motion on trees.  This flag is
8672 enabled by default at @option{-O} and higher.
8674 @item -ftree-bit-ccp
8675 @opindex ftree-bit-ccp
8676 Perform sparse conditional bit constant propagation on trees and propagate
8677 pointer alignment information.
8678 This pass only operates on local scalar variables and is enabled by default
8679 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8681 @item -ftree-ccp
8682 @opindex ftree-ccp
8683 Perform sparse conditional constant propagation (CCP) on trees.  This
8684 pass only operates on local scalar variables and is enabled by default
8685 at @option{-O} and higher.
8687 @item -fssa-backprop
8688 @opindex fssa-backprop
8689 Propagate information about uses of a value up the definition chain
8690 in order to simplify the definitions.  For example, this pass strips
8691 sign operations if the sign of a value never matters.  The flag is
8692 enabled by default at @option{-O} and higher.
8694 @item -fssa-phiopt
8695 @opindex fssa-phiopt
8696 Perform pattern matching on SSA PHI nodes to optimize conditional
8697 code.  This pass is enabled by default at @option{-O} and higher.
8699 @item -ftree-switch-conversion
8700 @opindex ftree-switch-conversion
8701 Perform conversion of simple initializations in a switch to
8702 initializations from a scalar array.  This flag is enabled by default
8703 at @option{-O2} and higher.
8705 @item -ftree-tail-merge
8706 @opindex ftree-tail-merge
8707 Look for identical code sequences.  When found, replace one with a jump to the
8708 other.  This optimization is known as tail merging or cross jumping.  This flag
8709 is enabled by default at @option{-O2} and higher.  The compilation time
8710 in this pass can
8711 be limited using @option{max-tail-merge-comparisons} parameter and
8712 @option{max-tail-merge-iterations} parameter.
8714 @item -ftree-dce
8715 @opindex ftree-dce
8716 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8717 default at @option{-O} and higher.
8719 @item -ftree-builtin-call-dce
8720 @opindex ftree-builtin-call-dce
8721 Perform conditional dead code elimination (DCE) for calls to built-in functions
8722 that may set @code{errno} but are otherwise free of side effects.  This flag is
8723 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8724 specified.
8726 @item -ftree-dominator-opts
8727 @opindex ftree-dominator-opts
8728 Perform a variety of simple scalar cleanups (constant/copy
8729 propagation, redundancy elimination, range propagation and expression
8730 simplification) based on a dominator tree traversal.  This also
8731 performs jump threading (to reduce jumps to jumps). This flag is
8732 enabled by default at @option{-O} and higher.
8734 @item -ftree-dse
8735 @opindex ftree-dse
8736 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8737 a memory location that is later overwritten by another store without
8738 any intervening loads.  In this case the earlier store can be deleted.  This
8739 flag is enabled by default at @option{-O} and higher.
8741 @item -ftree-ch
8742 @opindex ftree-ch
8743 Perform loop header copying on trees.  This is beneficial since it increases
8744 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8745 is enabled by default at @option{-O} and higher.  It is not enabled
8746 for @option{-Os}, since it usually increases code size.
8748 @item -ftree-loop-optimize
8749 @opindex ftree-loop-optimize
8750 Perform loop optimizations on trees.  This flag is enabled by default
8751 at @option{-O} and higher.
8753 @item -ftree-loop-linear
8754 @itemx -floop-strip-mine
8755 @itemx -floop-block
8756 @opindex ftree-loop-linear
8757 @opindex floop-strip-mine
8758 @opindex floop-block
8759 Perform loop nest optimizations.  Same as
8760 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8761 to be configured with @option{--with-isl} to enable the Graphite loop
8762 transformation infrastructure.
8764 @item -fgraphite-identity
8765 @opindex fgraphite-identity
8766 Enable the identity transformation for graphite.  For every SCoP we generate
8767 the polyhedral representation and transform it back to gimple.  Using
8768 @option{-fgraphite-identity} we can check the costs or benefits of the
8769 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8770 are also performed by the code generator isl, like index splitting and
8771 dead code elimination in loops.
8773 @item -floop-nest-optimize
8774 @opindex floop-nest-optimize
8775 Enable the isl based loop nest optimizer.  This is a generic loop nest
8776 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8777 structure optimized for data-locality and parallelism.  This option
8778 is experimental.
8780 @item -floop-parallelize-all
8781 @opindex floop-parallelize-all
8782 Use the Graphite data dependence analysis to identify loops that can
8783 be parallelized.  Parallelize all the loops that can be analyzed to
8784 not contain loop carried dependences without checking that it is
8785 profitable to parallelize the loops.
8787 @item -ftree-coalesce-vars
8788 @opindex ftree-coalesce-vars
8789 While transforming the program out of the SSA representation, attempt to
8790 reduce copying by coalescing versions of different user-defined
8791 variables, instead of just compiler temporaries.  This may severely
8792 limit the ability to debug an optimized program compiled with
8793 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8794 prevents SSA coalescing of user variables.  This option is enabled by
8795 default if optimization is enabled, and it does very little otherwise.
8797 @item -ftree-loop-if-convert
8798 @opindex ftree-loop-if-convert
8799 Attempt to transform conditional jumps in the innermost loops to
8800 branch-less equivalents.  The intent is to remove control-flow from
8801 the innermost loops in order to improve the ability of the
8802 vectorization pass to handle these loops.  This is enabled by default
8803 if vectorization is enabled.
8805 @item -ftree-loop-distribution
8806 @opindex ftree-loop-distribution
8807 Perform loop distribution.  This flag can improve cache performance on
8808 big loop bodies and allow further loop optimizations, like
8809 parallelization or vectorization, to take place.  For example, the loop
8810 @smallexample
8811 DO I = 1, N
8812   A(I) = B(I) + C
8813   D(I) = E(I) * F
8814 ENDDO
8815 @end smallexample
8816 is transformed to
8817 @smallexample
8818 DO I = 1, N
8819    A(I) = B(I) + C
8820 ENDDO
8821 DO I = 1, N
8822    D(I) = E(I) * F
8823 ENDDO
8824 @end smallexample
8826 @item -ftree-loop-distribute-patterns
8827 @opindex ftree-loop-distribute-patterns
8828 Perform loop distribution of patterns that can be code generated with
8829 calls to a library.  This flag is enabled by default at @option{-O3}.
8831 This pass distributes the initialization loops and generates a call to
8832 memset zero.  For example, the loop
8833 @smallexample
8834 DO I = 1, N
8835   A(I) = 0
8836   B(I) = A(I) + I
8837 ENDDO
8838 @end smallexample
8839 is transformed to
8840 @smallexample
8841 DO I = 1, N
8842    A(I) = 0
8843 ENDDO
8844 DO I = 1, N
8845    B(I) = A(I) + I
8846 ENDDO
8847 @end smallexample
8848 and the initialization loop is transformed into a call to memset zero.
8850 @item -floop-interchange
8851 @opindex floop-interchange
8852 Perform loop interchange outside of graphite.  This flag can improve cache
8853 performance on loop nest and allow further loop optimizations, like
8854 vectorization, to take place.  For example, the loop
8855 @smallexample
8856 for (int i = 0; i < N; i++)
8857   for (int j = 0; j < N; j++)
8858     for (int k = 0; k < N; k++)
8859       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8860 @end smallexample
8861 is transformed to
8862 @smallexample
8863 for (int i = 0; i < N; i++)
8864   for (int k = 0; k < N; k++)
8865     for (int j = 0; j < N; j++)
8866       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8867 @end smallexample
8869 @item -ftree-loop-im
8870 @opindex ftree-loop-im
8871 Perform loop invariant motion on trees.  This pass moves only invariants that
8872 are hard to handle at RTL level (function calls, operations that expand to
8873 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8874 operands of conditions that are invariant out of the loop, so that we can use
8875 just trivial invariantness analysis in loop unswitching.  The pass also includes
8876 store motion.
8878 @item -ftree-loop-ivcanon
8879 @opindex ftree-loop-ivcanon
8880 Create a canonical counter for number of iterations in loops for which
8881 determining number of iterations requires complicated analysis.  Later
8882 optimizations then may determine the number easily.  Useful especially
8883 in connection with unrolling.
8885 @item -fivopts
8886 @opindex fivopts
8887 Perform induction variable optimizations (strength reduction, induction
8888 variable merging and induction variable elimination) on trees.
8890 @item -ftree-parallelize-loops=n
8891 @opindex ftree-parallelize-loops
8892 Parallelize loops, i.e., split their iteration space to run in n threads.
8893 This is only possible for loops whose iterations are independent
8894 and can be arbitrarily reordered.  The optimization is only
8895 profitable on multiprocessor machines, for loops that are CPU-intensive,
8896 rather than constrained e.g.@: by memory bandwidth.  This option
8897 implies @option{-pthread}, and thus is only supported on targets
8898 that have support for @option{-pthread}.
8900 @item -ftree-pta
8901 @opindex ftree-pta
8902 Perform function-local points-to analysis on trees.  This flag is
8903 enabled by default at @option{-O} and higher.
8905 @item -ftree-sra
8906 @opindex ftree-sra
8907 Perform scalar replacement of aggregates.  This pass replaces structure
8908 references with scalars to prevent committing structures to memory too
8909 early.  This flag is enabled by default at @option{-O} and higher.
8911 @item -fstore-merging
8912 @opindex fstore-merging
8913 Perform merging of narrow stores to consecutive memory addresses.  This pass
8914 merges contiguous stores of immediate values narrower than a word into fewer
8915 wider stores to reduce the number of instructions.  This is enabled by default
8916 at @option{-O2} and higher as well as @option{-Os}.
8918 @item -ftree-ter
8919 @opindex ftree-ter
8920 Perform temporary expression replacement during the SSA->normal phase.  Single
8921 use/single def temporaries are replaced at their use location with their
8922 defining expression.  This results in non-GIMPLE code, but gives the expanders
8923 much more complex trees to work on resulting in better RTL generation.  This is
8924 enabled by default at @option{-O} and higher.
8926 @item -ftree-slsr
8927 @opindex ftree-slsr
8928 Perform straight-line strength reduction on trees.  This recognizes related
8929 expressions involving multiplications and replaces them by less expensive
8930 calculations when possible.  This is enabled by default at @option{-O} and
8931 higher.
8933 @item -ftree-vectorize
8934 @opindex ftree-vectorize
8935 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8936 and @option{-ftree-slp-vectorize} if not explicitly specified.
8938 @item -ftree-loop-vectorize
8939 @opindex ftree-loop-vectorize
8940 Perform loop vectorization on trees. This flag is enabled by default at
8941 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8943 @item -ftree-slp-vectorize
8944 @opindex ftree-slp-vectorize
8945 Perform basic block vectorization on trees. This flag is enabled by default at
8946 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8948 @item -fvect-cost-model=@var{model}
8949 @opindex fvect-cost-model
8950 Alter the cost model used for vectorization.  The @var{model} argument
8951 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8952 With the @samp{unlimited} model the vectorized code-path is assumed
8953 to be profitable while with the @samp{dynamic} model a runtime check
8954 guards the vectorized code-path to enable it only for iteration
8955 counts that will likely execute faster than when executing the original
8956 scalar loop.  The @samp{cheap} model disables vectorization of
8957 loops where doing so would be cost prohibitive for example due to
8958 required runtime checks for data dependence or alignment but otherwise
8959 is equal to the @samp{dynamic} model.
8960 The default cost model depends on other optimization flags and is
8961 either @samp{dynamic} or @samp{cheap}.
8963 @item -fsimd-cost-model=@var{model}
8964 @opindex fsimd-cost-model
8965 Alter the cost model used for vectorization of loops marked with the OpenMP
8966 simd directive.  The @var{model} argument should be one of
8967 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8968 have the same meaning as described in @option{-fvect-cost-model} and by
8969 default a cost model defined with @option{-fvect-cost-model} is used.
8971 @item -ftree-vrp
8972 @opindex ftree-vrp
8973 Perform Value Range Propagation on trees.  This is similar to the
8974 constant propagation pass, but instead of values, ranges of values are
8975 propagated.  This allows the optimizers to remove unnecessary range
8976 checks like array bound checks and null pointer checks.  This is
8977 enabled by default at @option{-O2} and higher.  Null pointer check
8978 elimination is only done if @option{-fdelete-null-pointer-checks} is
8979 enabled.
8981 @item -fsplit-paths
8982 @opindex fsplit-paths
8983 Split paths leading to loop backedges.  This can improve dead code
8984 elimination and common subexpression elimination.  This is enabled by
8985 default at @option{-O2} and above.
8987 @item -fsplit-ivs-in-unroller
8988 @opindex fsplit-ivs-in-unroller
8989 Enables expression of values of induction variables in later iterations
8990 of the unrolled loop using the value in the first iteration.  This breaks
8991 long dependency chains, thus improving efficiency of the scheduling passes.
8993 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8994 same effect.  However, that is not reliable in cases where the loop body
8995 is more complicated than a single basic block.  It also does not work at all
8996 on some architectures due to restrictions in the CSE pass.
8998 This optimization is enabled by default.
9000 @item -fvariable-expansion-in-unroller
9001 @opindex fvariable-expansion-in-unroller
9002 With this option, the compiler creates multiple copies of some
9003 local variables when unrolling a loop, which can result in superior code.
9005 @item -fpartial-inlining
9006 @opindex fpartial-inlining
9007 Inline parts of functions.  This option has any effect only
9008 when inlining itself is turned on by the @option{-finline-functions}
9009 or @option{-finline-small-functions} options.
9011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9013 @item -fpredictive-commoning
9014 @opindex fpredictive-commoning
9015 Perform predictive commoning optimization, i.e., reusing computations
9016 (especially memory loads and stores) performed in previous
9017 iterations of loops.
9019 This option is enabled at level @option{-O3}.
9021 @item -fprefetch-loop-arrays
9022 @opindex fprefetch-loop-arrays
9023 If supported by the target machine, generate instructions to prefetch
9024 memory to improve the performance of loops that access large arrays.
9026 This option may generate better or worse code; results are highly
9027 dependent on the structure of loops within the source code.
9029 Disabled at level @option{-Os}.
9031 @item -fno-printf-return-value
9032 @opindex fno-printf-return-value
9033 Do not substitute constants for known return value of formatted output
9034 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9035 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9036 transformation allows GCC to optimize or even eliminate branches based
9037 on the known return value of these functions called with arguments that
9038 are either constant, or whose values are known to be in a range that
9039 makes determining the exact return value possible.  For example, when
9040 @option{-fprintf-return-value} is in effect, both the branch and the
9041 body of the @code{if} statement (but not the call to @code{snprint})
9042 can be optimized away when @code{i} is a 32-bit or smaller integer
9043 because the return value is guaranteed to be at most 8.
9045 @smallexample
9046 char buf[9];
9047 if (snprintf (buf, "%08x", i) >= sizeof buf)
9048   @dots{}
9049 @end smallexample
9051 The @option{-fprintf-return-value} option relies on other optimizations
9052 and yields best results with @option{-O2} and above.  It works in tandem
9053 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9054 options.  The @option{-fprintf-return-value} option is enabled by default.
9056 @item -fno-peephole
9057 @itemx -fno-peephole2
9058 @opindex fno-peephole
9059 @opindex fno-peephole2
9060 Disable any machine-specific peephole optimizations.  The difference
9061 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9062 are implemented in the compiler; some targets use one, some use the
9063 other, a few use both.
9065 @option{-fpeephole} is enabled by default.
9066 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9068 @item -fno-guess-branch-probability
9069 @opindex fno-guess-branch-probability
9070 Do not guess branch probabilities using heuristics.
9072 GCC uses heuristics to guess branch probabilities if they are
9073 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9074 heuristics are based on the control flow graph.  If some branch probabilities
9075 are specified by @code{__builtin_expect}, then the heuristics are
9076 used to guess branch probabilities for the rest of the control flow graph,
9077 taking the @code{__builtin_expect} info into account.  The interactions
9078 between the heuristics and @code{__builtin_expect} can be complex, and in
9079 some cases, it may be useful to disable the heuristics so that the effects
9080 of @code{__builtin_expect} are easier to understand.
9082 The default is @option{-fguess-branch-probability} at levels
9083 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9085 @item -freorder-blocks
9086 @opindex freorder-blocks
9087 Reorder basic blocks in the compiled function in order to reduce number of
9088 taken branches and improve code locality.
9090 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9092 @item -freorder-blocks-algorithm=@var{algorithm}
9093 @opindex freorder-blocks-algorithm
9094 Use the specified algorithm for basic block reordering.  The
9095 @var{algorithm} argument can be @samp{simple}, which does not increase
9096 code size (except sometimes due to secondary effects like alignment),
9097 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9098 put all often executed code together, minimizing the number of branches
9099 executed by making extra copies of code.
9101 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9102 @samp{stc} at levels @option{-O2}, @option{-O3}.
9104 @item -freorder-blocks-and-partition
9105 @opindex freorder-blocks-and-partition
9106 In addition to reordering basic blocks in the compiled function, in order
9107 to reduce number of taken branches, partitions hot and cold basic blocks
9108 into separate sections of the assembly and @file{.o} files, to improve
9109 paging and cache locality performance.
9111 This optimization is automatically turned off in the presence of
9112 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9113 section attribute and on any architecture that does not support named
9114 sections.  When @option{-fsplit-stack} is used this option is not
9115 enabled by default (to avoid linker errors), but may be enabled
9116 explicitly (if using a working linker).
9118 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9120 @item -freorder-functions
9121 @opindex freorder-functions
9122 Reorder functions in the object file in order to
9123 improve code locality.  This is implemented by using special
9124 subsections @code{.text.hot} for most frequently executed functions and
9125 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9126 the linker so object file format must support named sections and linker must
9127 place them in a reasonable way.
9129 Also profile feedback must be available to make this option effective.  See
9130 @option{-fprofile-arcs} for details.
9132 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9134 @item -fstrict-aliasing
9135 @opindex fstrict-aliasing
9136 Allow the compiler to assume the strictest aliasing rules applicable to
9137 the language being compiled.  For C (and C++), this activates
9138 optimizations based on the type of expressions.  In particular, an
9139 object of one type is assumed never to reside at the same address as an
9140 object of a different type, unless the types are almost the same.  For
9141 example, an @code{unsigned int} can alias an @code{int}, but not a
9142 @code{void*} or a @code{double}.  A character type may alias any other
9143 type.
9145 @anchor{Type-punning}Pay special attention to code like this:
9146 @smallexample
9147 union a_union @{
9148   int i;
9149   double d;
9152 int f() @{
9153   union a_union t;
9154   t.d = 3.0;
9155   return t.i;
9157 @end smallexample
9158 The practice of reading from a different union member than the one most
9159 recently written to (called ``type-punning'') is common.  Even with
9160 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9161 is accessed through the union type.  So, the code above works as
9162 expected.  @xref{Structures unions enumerations and bit-fields
9163 implementation}.  However, this code might not:
9164 @smallexample
9165 int f() @{
9166   union a_union t;
9167   int* ip;
9168   t.d = 3.0;
9169   ip = &t.i;
9170   return *ip;
9172 @end smallexample
9174 Similarly, access by taking the address, casting the resulting pointer
9175 and dereferencing the result has undefined behavior, even if the cast
9176 uses a union type, e.g.:
9177 @smallexample
9178 int f() @{
9179   double d = 3.0;
9180   return ((union a_union *) &d)->i;
9182 @end smallexample
9184 The @option{-fstrict-aliasing} option is enabled at levels
9185 @option{-O2}, @option{-O3}, @option{-Os}.
9187 @item -falign-functions
9188 @itemx -falign-functions=@var{n}
9189 @opindex falign-functions
9190 Align the start of functions to the next power-of-two greater than
9191 @var{n}, skipping up to @var{n} bytes.  For instance,
9192 @option{-falign-functions=32} aligns functions to the next 32-byte
9193 boundary, but @option{-falign-functions=24} aligns to the next
9194 32-byte boundary only if this can be done by skipping 23 bytes or less.
9196 @option{-fno-align-functions} and @option{-falign-functions=1} are
9197 equivalent and mean that functions are not aligned.
9199 Some assemblers only support this flag when @var{n} is a power of two;
9200 in that case, it is rounded up.
9202 If @var{n} is not specified or is zero, use a machine-dependent default.
9203 The maximum allowed @var{n} option value is 65536.
9205 Enabled at levels @option{-O2}, @option{-O3}.
9207 @item -flimit-function-alignment
9208 If this option is enabled, the compiler tries to avoid unnecessarily
9209 overaligning functions. It attempts to instruct the assembler to align
9210 by the amount specified by @option{-falign-functions}, but not to
9211 skip more bytes than the size of the function.
9213 @item -falign-labels
9214 @itemx -falign-labels=@var{n}
9215 @opindex falign-labels
9216 Align all branch targets to a power-of-two boundary, skipping up to
9217 @var{n} bytes like @option{-falign-functions}.  This option can easily
9218 make code slower, because it must insert dummy operations for when the
9219 branch target is reached in the usual flow of the code.
9221 @option{-fno-align-labels} and @option{-falign-labels=1} are
9222 equivalent and mean that labels are not aligned.
9224 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9225 are greater than this value, then their values are used instead.
9227 If @var{n} is not specified or is zero, use a machine-dependent default
9228 which is very likely to be @samp{1}, meaning no alignment.
9229 The maximum allowed @var{n} option value is 65536.
9231 Enabled at levels @option{-O2}, @option{-O3}.
9233 @item -falign-loops
9234 @itemx -falign-loops=@var{n}
9235 @opindex falign-loops
9236 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9237 like @option{-falign-functions}.  If the loops are
9238 executed many times, this makes up for any execution of the dummy
9239 operations.
9241 @option{-fno-align-loops} and @option{-falign-loops=1} are
9242 equivalent and mean that loops are not aligned.
9243 The maximum allowed @var{n} option value is 65536.
9245 If @var{n} is not specified or is zero, use a machine-dependent default.
9247 Enabled at levels @option{-O2}, @option{-O3}.
9249 @item -falign-jumps
9250 @itemx -falign-jumps=@var{n}
9251 @opindex falign-jumps
9252 Align branch targets to a power-of-two boundary, for branch targets
9253 where the targets can only be reached by jumping, skipping up to @var{n}
9254 bytes like @option{-falign-functions}.  In this case, no dummy operations
9255 need be executed.
9257 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9258 equivalent and mean that loops are not aligned.
9260 If @var{n} is not specified or is zero, use a machine-dependent default.
9261 The maximum allowed @var{n} option value is 65536.
9263 Enabled at levels @option{-O2}, @option{-O3}.
9265 @item -funit-at-a-time
9266 @opindex funit-at-a-time
9267 This option is left for compatibility reasons. @option{-funit-at-a-time}
9268 has no effect, while @option{-fno-unit-at-a-time} implies
9269 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9271 Enabled by default.
9273 @item -fno-toplevel-reorder
9274 @opindex fno-toplevel-reorder
9275 Do not reorder top-level functions, variables, and @code{asm}
9276 statements.  Output them in the same order that they appear in the
9277 input file.  When this option is used, unreferenced static variables
9278 are not removed.  This option is intended to support existing code
9279 that relies on a particular ordering.  For new code, it is better to
9280 use attributes when possible.
9282 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9283 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9284 targets.
9286 @item -fweb
9287 @opindex fweb
9288 Constructs webs as commonly used for register allocation purposes and assign
9289 each web individual pseudo register.  This allows the register allocation pass
9290 to operate on pseudos directly, but also strengthens several other optimization
9291 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9292 however, make debugging impossible, since variables no longer stay in a
9293 ``home register''.
9295 Enabled by default with @option{-funroll-loops}.
9297 @item -fwhole-program
9298 @opindex fwhole-program
9299 Assume that the current compilation unit represents the whole program being
9300 compiled.  All public functions and variables with the exception of @code{main}
9301 and those merged by attribute @code{externally_visible} become static functions
9302 and in effect are optimized more aggressively by interprocedural optimizers.
9304 This option should not be used in combination with @option{-flto}.
9305 Instead relying on a linker plugin should provide safer and more precise
9306 information.
9308 @item -flto[=@var{n}]
9309 @opindex flto
9310 This option runs the standard link-time optimizer.  When invoked
9311 with source code, it generates GIMPLE (one of GCC's internal
9312 representations) and writes it to special ELF sections in the object
9313 file.  When the object files are linked together, all the function
9314 bodies are read from these ELF sections and instantiated as if they
9315 had been part of the same translation unit.
9317 To use the link-time optimizer, @option{-flto} and optimization
9318 options should be specified at compile time and during the final link.
9319 It is recommended that you compile all the files participating in the
9320 same link with the same options and also specify those options at
9321 link time.  
9322 For example:
9324 @smallexample
9325 gcc -c -O2 -flto foo.c
9326 gcc -c -O2 -flto bar.c
9327 gcc -o myprog -flto -O2 foo.o bar.o
9328 @end smallexample
9330 The first two invocations to GCC save a bytecode representation
9331 of GIMPLE into special ELF sections inside @file{foo.o} and
9332 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9333 @file{foo.o} and @file{bar.o}, merges the two files into a single
9334 internal image, and compiles the result as usual.  Since both
9335 @file{foo.o} and @file{bar.o} are merged into a single image, this
9336 causes all the interprocedural analyses and optimizations in GCC to
9337 work across the two files as if they were a single one.  This means,
9338 for example, that the inliner is able to inline functions in
9339 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9341 Another (simpler) way to enable link-time optimization is:
9343 @smallexample
9344 gcc -o myprog -flto -O2 foo.c bar.c
9345 @end smallexample
9347 The above generates bytecode for @file{foo.c} and @file{bar.c},
9348 merges them together into a single GIMPLE representation and optimizes
9349 them as usual to produce @file{myprog}.
9351 The only important thing to keep in mind is that to enable link-time
9352 optimizations you need to use the GCC driver to perform the link step.
9353 GCC then automatically performs link-time optimization if any of the
9354 objects involved were compiled with the @option{-flto} command-line option.  
9355 You generally
9356 should specify the optimization options to be used for link-time
9357 optimization though GCC tries to be clever at guessing an
9358 optimization level to use from the options used at compile time
9359 if you fail to specify one at link time.  You can always override
9360 the automatic decision to do link-time optimization
9361 by passing @option{-fno-lto} to the link command.
9363 To make whole program optimization effective, it is necessary to make
9364 certain whole program assumptions.  The compiler needs to know
9365 what functions and variables can be accessed by libraries and runtime
9366 outside of the link-time optimized unit.  When supported by the linker,
9367 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9368 to the compiler about used and externally visible symbols.  When
9369 the linker plugin is not available, @option{-fwhole-program} should be
9370 used to allow the compiler to make these assumptions, which leads
9371 to more aggressive optimization decisions.
9373 When @option{-fuse-linker-plugin} is not enabled, when a file is
9374 compiled with @option{-flto}, the generated object file is larger than
9375 a regular object file because it contains GIMPLE bytecodes and the usual
9376 final code (see @option{-ffat-lto-objects}.  This means that
9377 object files with LTO information can be linked as normal object
9378 files; if @option{-fno-lto} is passed to the linker, no
9379 interprocedural optimizations are applied.  Note that when
9380 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9381 but you cannot perform a regular, non-LTO link on them.
9383 Additionally, the optimization flags used to compile individual files
9384 are not necessarily related to those used at link time.  For instance,
9386 @smallexample
9387 gcc -c -O0 -ffat-lto-objects -flto foo.c
9388 gcc -c -O0 -ffat-lto-objects -flto bar.c
9389 gcc -o myprog -O3 foo.o bar.o
9390 @end smallexample
9392 This produces individual object files with unoptimized assembler
9393 code, but the resulting binary @file{myprog} is optimized at
9394 @option{-O3}.  If, instead, the final binary is generated with
9395 @option{-fno-lto}, then @file{myprog} is not optimized.
9397 When producing the final binary, GCC only
9398 applies link-time optimizations to those files that contain bytecode.
9399 Therefore, you can mix and match object files and libraries with
9400 GIMPLE bytecodes and final object code.  GCC automatically selects
9401 which files to optimize in LTO mode and which files to link without
9402 further processing.
9404 There are some code generation flags preserved by GCC when
9405 generating bytecodes, as they need to be used during the final link
9406 stage.  Generally options specified at link time override those
9407 specified at compile time.
9409 If you do not specify an optimization level option @option{-O} at
9410 link time, then GCC uses the highest optimization level 
9411 used when compiling the object files.
9413 Currently, the following options and their settings are taken from
9414 the first object file that explicitly specifies them: 
9415 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9416 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9417 and all the @option{-m} target flags.
9419 Certain ABI-changing flags are required to match in all compilation units,
9420 and trying to override this at link time with a conflicting value
9421 is ignored.  This includes options such as @option{-freg-struct-return}
9422 and @option{-fpcc-struct-return}. 
9424 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9425 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9426 are passed through to the link stage and merged conservatively for
9427 conflicting translation units.  Specifically
9428 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9429 precedence; and for example @option{-ffp-contract=off} takes precedence
9430 over @option{-ffp-contract=fast}.  You can override them at link time.
9432 If LTO encounters objects with C linkage declared with incompatible
9433 types in separate translation units to be linked together (undefined
9434 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9435 issued.  The behavior is still undefined at run time.  Similar
9436 diagnostics may be raised for other languages.
9438 Another feature of LTO is that it is possible to apply interprocedural
9439 optimizations on files written in different languages:
9441 @smallexample
9442 gcc -c -flto foo.c
9443 g++ -c -flto bar.cc
9444 gfortran -c -flto baz.f90
9445 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9446 @end smallexample
9448 Notice that the final link is done with @command{g++} to get the C++
9449 runtime libraries and @option{-lgfortran} is added to get the Fortran
9450 runtime libraries.  In general, when mixing languages in LTO mode, you
9451 should use the same link command options as when mixing languages in a
9452 regular (non-LTO) compilation.
9454 If object files containing GIMPLE bytecode are stored in a library archive, say
9455 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9456 are using a linker with plugin support.  To create static libraries suitable
9457 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9458 and @command{ranlib}; 
9459 to show the symbols of object files with GIMPLE bytecode, use
9460 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9461 and @command{nm} have been compiled with plugin support.  At link time, use the the
9462 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9463 the LTO optimization process:
9465 @smallexample
9466 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9467 @end smallexample
9469 With the linker plugin enabled, the linker extracts the needed
9470 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9471 to make them part of the aggregated GIMPLE image to be optimized.
9473 If you are not using a linker with plugin support and/or do not
9474 enable the linker plugin, then the objects inside @file{libfoo.a}
9475 are extracted and linked as usual, but they do not participate
9476 in the LTO optimization process.  In order to make a static library suitable
9477 for both LTO optimization and usual linkage, compile its object files with
9478 @option{-flto} @option{-ffat-lto-objects}.
9480 Link-time optimizations do not require the presence of the whole program to
9481 operate.  If the program does not require any symbols to be exported, it is
9482 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9483 the interprocedural optimizers to use more aggressive assumptions which may
9484 lead to improved optimization opportunities.
9485 Use of @option{-fwhole-program} is not needed when linker plugin is
9486 active (see @option{-fuse-linker-plugin}).
9488 The current implementation of LTO makes no
9489 attempt to generate bytecode that is portable between different
9490 types of hosts.  The bytecode files are versioned and there is a
9491 strict version check, so bytecode files generated in one version of
9492 GCC do not work with an older or newer version of GCC.
9494 Link-time optimization does not work well with generation of debugging
9495 information on systems other than those using a combination of ELF and
9496 DWARF.
9498 If you specify the optional @var{n}, the optimization and code
9499 generation done at link time is executed in parallel using @var{n}
9500 parallel jobs by utilizing an installed @command{make} program.  The
9501 environment variable @env{MAKE} may be used to override the program
9502 used.  The default value for @var{n} is 1.
9504 You can also specify @option{-flto=jobserver} to use GNU make's
9505 job server mode to determine the number of parallel jobs. This
9506 is useful when the Makefile calling GCC is already executing in parallel.
9507 You must prepend a @samp{+} to the command recipe in the parent Makefile
9508 for this to work.  This option likely only works if @env{MAKE} is
9509 GNU make.
9511 @item -flto-partition=@var{alg}
9512 @opindex flto-partition
9513 Specify the partitioning algorithm used by the link-time optimizer.
9514 The value is either @samp{1to1} to specify a partitioning mirroring
9515 the original source files or @samp{balanced} to specify partitioning
9516 into equally sized chunks (whenever possible) or @samp{max} to create
9517 new partition for every symbol where possible.  Specifying @samp{none}
9518 as an algorithm disables partitioning and streaming completely. 
9519 The default value is @samp{balanced}. While @samp{1to1} can be used
9520 as an workaround for various code ordering issues, the @samp{max}
9521 partitioning is intended for internal testing only.
9522 The value @samp{one} specifies that exactly one partition should be
9523 used while the value @samp{none} bypasses partitioning and executes
9524 the link-time optimization step directly from the WPA phase.
9526 @item -flto-odr-type-merging
9527 @opindex flto-odr-type-merging
9528 Enable streaming of mangled types names of C++ types and their unification
9529 at link time.  This increases size of LTO object files, but enables
9530 diagnostics about One Definition Rule violations.
9532 @item -flto-compression-level=@var{n}
9533 @opindex flto-compression-level
9534 This option specifies the level of compression used for intermediate
9535 language written to LTO object files, and is only meaningful in
9536 conjunction with LTO mode (@option{-flto}).  Valid
9537 values are 0 (no compression) to 9 (maximum compression).  Values
9538 outside this range are clamped to either 0 or 9.  If the option is not
9539 given, a default balanced compression setting is used.
9541 @item -fuse-linker-plugin
9542 @opindex fuse-linker-plugin
9543 Enables the use of a linker plugin during link-time optimization.  This
9544 option relies on plugin support in the linker, which is available in gold
9545 or in GNU ld 2.21 or newer.
9547 This option enables the extraction of object files with GIMPLE bytecode out
9548 of library archives. This improves the quality of optimization by exposing
9549 more code to the link-time optimizer.  This information specifies what
9550 symbols can be accessed externally (by non-LTO object or during dynamic
9551 linking).  Resulting code quality improvements on binaries (and shared
9552 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9553 See @option{-flto} for a description of the effect of this flag and how to
9554 use it.
9556 This option is enabled by default when LTO support in GCC is enabled
9557 and GCC was configured for use with
9558 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9560 @item -ffat-lto-objects
9561 @opindex ffat-lto-objects
9562 Fat LTO objects are object files that contain both the intermediate language
9563 and the object code. This makes them usable for both LTO linking and normal
9564 linking. This option is effective only when compiling with @option{-flto}
9565 and is ignored at link time.
9567 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9568 requires the complete toolchain to be aware of LTO. It requires a linker with
9569 linker plugin support for basic functionality.  Additionally,
9570 @command{nm}, @command{ar} and @command{ranlib}
9571 need to support linker plugins to allow a full-featured build environment
9572 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9573 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9574 to these tools. With non fat LTO makefiles need to be modified to use them.
9576 Note that modern binutils provide plugin auto-load mechanism.
9577 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9578 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9579 @command{gcc-ranlib}).
9581 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9582 support.
9584 @item -fcompare-elim
9585 @opindex fcompare-elim
9586 After register allocation and post-register allocation instruction splitting,
9587 identify arithmetic instructions that compute processor flags similar to a
9588 comparison operation based on that arithmetic.  If possible, eliminate the
9589 explicit comparison operation.
9591 This pass only applies to certain targets that cannot explicitly represent
9592 the comparison operation before register allocation is complete.
9594 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9596 @item -fcprop-registers
9597 @opindex fcprop-registers
9598 After register allocation and post-register allocation instruction splitting,
9599 perform a copy-propagation pass to try to reduce scheduling dependencies
9600 and occasionally eliminate the copy.
9602 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9604 @item -fprofile-correction
9605 @opindex fprofile-correction
9606 Profiles collected using an instrumented binary for multi-threaded programs may
9607 be inconsistent due to missed counter updates. When this option is specified,
9608 GCC uses heuristics to correct or smooth out such inconsistencies. By
9609 default, GCC emits an error message when an inconsistent profile is detected.
9611 @item -fprofile-use
9612 @itemx -fprofile-use=@var{path}
9613 @opindex fprofile-use
9614 Enable profile feedback-directed optimizations, 
9615 and the following optimizations
9616 which are generally profitable only with profile feedback available:
9617 @option{-fbranch-probabilities}, @option{-fvpt},
9618 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9619 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9621 Before you can use this option, you must first generate profiling information.
9622 @xref{Instrumentation Options}, for information about the
9623 @option{-fprofile-generate} option.
9625 By default, GCC emits an error message if the feedback profiles do not
9626 match the source code.  This error can be turned into a warning by using
9627 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9628 code.
9630 If @var{path} is specified, GCC looks at the @var{path} to find
9631 the profile feedback data files. See @option{-fprofile-dir}.
9633 @item -fauto-profile
9634 @itemx -fauto-profile=@var{path}
9635 @opindex fauto-profile
9636 Enable sampling-based feedback-directed optimizations, 
9637 and the following optimizations
9638 which are generally profitable only with profile feedback available:
9639 @option{-fbranch-probabilities}, @option{-fvpt},
9640 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9641 @option{-ftree-vectorize},
9642 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9643 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9644 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9646 @var{path} is the name of a file containing AutoFDO profile information.
9647 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9649 Producing an AutoFDO profile data file requires running your program
9650 with the @command{perf} utility on a supported GNU/Linux target system.
9651 For more information, see @uref{https://perf.wiki.kernel.org/}.
9653 E.g.
9654 @smallexample
9655 perf record -e br_inst_retired:near_taken -b -o perf.data \
9656     -- your_program
9657 @end smallexample
9659 Then use the @command{create_gcov} tool to convert the raw profile data
9660 to a format that can be used by GCC.@  You must also supply the 
9661 unstripped binary for your program to this tool.  
9662 See @uref{https://github.com/google/autofdo}.
9664 E.g.
9665 @smallexample
9666 create_gcov --binary=your_program.unstripped --profile=perf.data \
9667     --gcov=profile.afdo
9668 @end smallexample
9669 @end table
9671 The following options control compiler behavior regarding floating-point 
9672 arithmetic.  These options trade off between speed and
9673 correctness.  All must be specifically enabled.
9675 @table @gcctabopt
9676 @item -ffloat-store
9677 @opindex ffloat-store
9678 Do not store floating-point variables in registers, and inhibit other
9679 options that might change whether a floating-point value is taken from a
9680 register or memory.
9682 @cindex floating-point precision
9683 This option prevents undesirable excess precision on machines such as
9684 the 68000 where the floating registers (of the 68881) keep more
9685 precision than a @code{double} is supposed to have.  Similarly for the
9686 x86 architecture.  For most programs, the excess precision does only
9687 good, but a few programs rely on the precise definition of IEEE floating
9688 point.  Use @option{-ffloat-store} for such programs, after modifying
9689 them to store all pertinent intermediate computations into variables.
9691 @item -fexcess-precision=@var{style}
9692 @opindex fexcess-precision
9693 This option allows further control over excess precision on machines
9694 where floating-point operations occur in a format with more precision or
9695 range than the IEEE standard and interchange floating-point types.  By
9696 default, @option{-fexcess-precision=fast} is in effect; this means that
9697 operations may be carried out in a wider precision than the types specified
9698 in the source if that would result in faster code, and it is unpredictable
9699 when rounding to the types specified in the source code takes place.
9700 When compiling C, if @option{-fexcess-precision=standard} is specified then
9701 excess precision follows the rules specified in ISO C99; in particular,
9702 both casts and assignments cause values to be rounded to their
9703 semantic types (whereas @option{-ffloat-store} only affects
9704 assignments).  This option is enabled by default for C if a strict
9705 conformance option such as @option{-std=c99} is used.
9706 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9707 regardless of whether a strict conformance option is used.
9709 @opindex mfpmath
9710 @option{-fexcess-precision=standard} is not implemented for languages
9711 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9712 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9713 semantics apply without excess precision, and in the latter, rounding
9714 is unpredictable.
9716 @item -ffast-math
9717 @opindex ffast-math
9718 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9719 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9720 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9721 @option{-fexcess-precision=fast}.
9723 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9725 This option is not turned on by any @option{-O} option besides
9726 @option{-Ofast} since it can result in incorrect output for programs
9727 that depend on an exact implementation of IEEE or ISO rules/specifications
9728 for math functions. It may, however, yield faster code for programs
9729 that do not require the guarantees of these specifications.
9731 @item -fno-math-errno
9732 @opindex fno-math-errno
9733 Do not set @code{errno} after calling math functions that are executed
9734 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9735 IEEE exceptions for math error handling may want to use this flag
9736 for speed while maintaining IEEE arithmetic compatibility.
9738 This option is not turned on by any @option{-O} option since
9739 it can result in incorrect output for programs that depend on
9740 an exact implementation of IEEE or ISO rules/specifications for
9741 math functions. It may, however, yield faster code for programs
9742 that do not require the guarantees of these specifications.
9744 The default is @option{-fmath-errno}.
9746 On Darwin systems, the math library never sets @code{errno}.  There is
9747 therefore no reason for the compiler to consider the possibility that
9748 it might, and @option{-fno-math-errno} is the default.
9750 @item -funsafe-math-optimizations
9751 @opindex funsafe-math-optimizations
9753 Allow optimizations for floating-point arithmetic that (a) assume
9754 that arguments and results are valid and (b) may violate IEEE or
9755 ANSI standards.  When used at link time, it may include libraries
9756 or startup files that change the default FPU control word or other
9757 similar optimizations.
9759 This option is not turned on by any @option{-O} option since
9760 it can result in incorrect output for programs that depend on
9761 an exact implementation of IEEE or ISO rules/specifications for
9762 math functions. It may, however, yield faster code for programs
9763 that do not require the guarantees of these specifications.
9764 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9765 @option{-fassociative-math} and @option{-freciprocal-math}.
9767 The default is @option{-fno-unsafe-math-optimizations}.
9769 @item -fassociative-math
9770 @opindex fassociative-math
9772 Allow re-association of operands in series of floating-point operations.
9773 This violates the ISO C and C++ language standard by possibly changing
9774 computation result.  NOTE: re-ordering may change the sign of zero as
9775 well as ignore NaNs and inhibit or create underflow or overflow (and
9776 thus cannot be used on code that relies on rounding behavior like
9777 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9778 and thus may not be used when ordered comparisons are required.
9779 This option requires that both @option{-fno-signed-zeros} and
9780 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9781 much sense with @option{-frounding-math}. For Fortran the option
9782 is automatically enabled when both @option{-fno-signed-zeros} and
9783 @option{-fno-trapping-math} are in effect.
9785 The default is @option{-fno-associative-math}.
9787 @item -freciprocal-math
9788 @opindex freciprocal-math
9790 Allow the reciprocal of a value to be used instead of dividing by
9791 the value if this enables optimizations.  For example @code{x / y}
9792 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9793 is subject to common subexpression elimination.  Note that this loses
9794 precision and increases the number of flops operating on the value.
9796 The default is @option{-fno-reciprocal-math}.
9798 @item -ffinite-math-only
9799 @opindex ffinite-math-only
9800 Allow optimizations for floating-point arithmetic that assume
9801 that arguments and results are not NaNs or +-Infs.
9803 This option is not turned on by any @option{-O} option since
9804 it can result in incorrect output for programs that depend on
9805 an exact implementation of IEEE or ISO rules/specifications for
9806 math functions. It may, however, yield faster code for programs
9807 that do not require the guarantees of these specifications.
9809 The default is @option{-fno-finite-math-only}.
9811 @item -fno-signed-zeros
9812 @opindex fno-signed-zeros
9813 Allow optimizations for floating-point arithmetic that ignore the
9814 signedness of zero.  IEEE arithmetic specifies the behavior of
9815 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9816 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9817 This option implies that the sign of a zero result isn't significant.
9819 The default is @option{-fsigned-zeros}.
9821 @item -fno-trapping-math
9822 @opindex fno-trapping-math
9823 Compile code assuming that floating-point operations cannot generate
9824 user-visible traps.  These traps include division by zero, overflow,
9825 underflow, inexact result and invalid operation.  This option requires
9826 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9827 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9829 This option should never be turned on by any @option{-O} option since
9830 it can result in incorrect output for programs that depend on
9831 an exact implementation of IEEE or ISO rules/specifications for
9832 math functions.
9834 The default is @option{-ftrapping-math}.
9836 @item -frounding-math
9837 @opindex frounding-math
9838 Disable transformations and optimizations that assume default floating-point
9839 rounding behavior.  This is round-to-zero for all floating point
9840 to integer conversions, and round-to-nearest for all other arithmetic
9841 truncations.  This option should be specified for programs that change
9842 the FP rounding mode dynamically, or that may be executed with a
9843 non-default rounding mode.  This option disables constant folding of
9844 floating-point expressions at compile time (which may be affected by
9845 rounding mode) and arithmetic transformations that are unsafe in the
9846 presence of sign-dependent rounding modes.
9848 The default is @option{-fno-rounding-math}.
9850 This option is experimental and does not currently guarantee to
9851 disable all GCC optimizations that are affected by rounding mode.
9852 Future versions of GCC may provide finer control of this setting
9853 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9854 will be used to specify the default state for @code{FENV_ACCESS}.
9856 @item -fsignaling-nans
9857 @opindex fsignaling-nans
9858 Compile code assuming that IEEE signaling NaNs may generate user-visible
9859 traps during floating-point operations.  Setting this option disables
9860 optimizations that may change the number of exceptions visible with
9861 signaling NaNs.  This option implies @option{-ftrapping-math}.
9863 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9864 be defined.
9866 The default is @option{-fno-signaling-nans}.
9868 This option is experimental and does not currently guarantee to
9869 disable all GCC optimizations that affect signaling NaN behavior.
9871 @item -fno-fp-int-builtin-inexact
9872 @opindex fno-fp-int-builtin-inexact
9873 Do not allow the built-in functions @code{ceil}, @code{floor},
9874 @code{round} and @code{trunc}, and their @code{float} and @code{long
9875 double} variants, to generate code that raises the ``inexact''
9876 floating-point exception for noninteger arguments.  ISO C99 and C11
9877 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9878 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9879 functions to do so.
9881 The default is @option{-ffp-int-builtin-inexact}, allowing the
9882 exception to be raised.  This option does nothing unless
9883 @option{-ftrapping-math} is in effect.
9885 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9886 generate a call to a library function then the ``inexact'' exception
9887 may be raised if the library implementation does not follow TS 18661.
9889 @item -fsingle-precision-constant
9890 @opindex fsingle-precision-constant
9891 Treat floating-point constants as single precision instead of
9892 implicitly converting them to double-precision constants.
9894 @item -fcx-limited-range
9895 @opindex fcx-limited-range
9896 When enabled, this option states that a range reduction step is not
9897 needed when performing complex division.  Also, there is no checking
9898 whether the result of a complex multiplication or division is @code{NaN
9899 + I*NaN}, with an attempt to rescue the situation in that case.  The
9900 default is @option{-fno-cx-limited-range}, but is enabled by
9901 @option{-ffast-math}.
9903 This option controls the default setting of the ISO C99
9904 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9905 all languages.
9907 @item -fcx-fortran-rules
9908 @opindex fcx-fortran-rules
9909 Complex multiplication and division follow Fortran rules.  Range
9910 reduction is done as part of complex division, but there is no checking
9911 whether the result of a complex multiplication or division is @code{NaN
9912 + I*NaN}, with an attempt to rescue the situation in that case.
9914 The default is @option{-fno-cx-fortran-rules}.
9916 @end table
9918 The following options control optimizations that may improve
9919 performance, but are not enabled by any @option{-O} options.  This
9920 section includes experimental options that may produce broken code.
9922 @table @gcctabopt
9923 @item -fbranch-probabilities
9924 @opindex fbranch-probabilities
9925 After running a program compiled with @option{-fprofile-arcs}
9926 (@pxref{Instrumentation Options}),
9927 you can compile it a second time using
9928 @option{-fbranch-probabilities}, to improve optimizations based on
9929 the number of times each branch was taken.  When a program
9930 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9931 counts to a file called @file{@var{sourcename}.gcda} for each source
9932 file.  The information in this data file is very dependent on the
9933 structure of the generated code, so you must use the same source code
9934 and the same optimization options for both compilations.
9936 With @option{-fbranch-probabilities}, GCC puts a
9937 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9938 These can be used to improve optimization.  Currently, they are only
9939 used in one place: in @file{reorg.c}, instead of guessing which path a
9940 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9941 exactly determine which path is taken more often.
9943 @item -fprofile-values
9944 @opindex fprofile-values
9945 If combined with @option{-fprofile-arcs}, it adds code so that some
9946 data about values of expressions in the program is gathered.
9948 With @option{-fbranch-probabilities}, it reads back the data gathered
9949 from profiling values of expressions for usage in optimizations.
9951 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9953 @item -fprofile-reorder-functions
9954 @opindex fprofile-reorder-functions
9955 Function reordering based on profile instrumentation collects
9956 first time of execution of a function and orders these functions
9957 in ascending order.
9959 Enabled with @option{-fprofile-use}.
9961 @item -fvpt
9962 @opindex fvpt
9963 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9964 to add code to gather information about values of expressions.
9966 With @option{-fbranch-probabilities}, it reads back the data gathered
9967 and actually performs the optimizations based on them.
9968 Currently the optimizations include specialization of division operations
9969 using the knowledge about the value of the denominator.
9971 @item -frename-registers
9972 @opindex frename-registers
9973 Attempt to avoid false dependencies in scheduled code by making use
9974 of registers left over after register allocation.  This optimization
9975 most benefits processors with lots of registers.  Depending on the
9976 debug information format adopted by the target, however, it can
9977 make debugging impossible, since variables no longer stay in
9978 a ``home register''.
9980 Enabled by default with @option{-funroll-loops}.
9982 @item -fschedule-fusion
9983 @opindex fschedule-fusion
9984 Performs a target dependent pass over the instruction stream to schedule
9985 instructions of same type together because target machine can execute them
9986 more efficiently if they are adjacent to each other in the instruction flow.
9988 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9990 @item -ftracer
9991 @opindex ftracer
9992 Perform tail duplication to enlarge superblock size.  This transformation
9993 simplifies the control flow of the function allowing other optimizations to do
9994 a better job.
9996 Enabled with @option{-fprofile-use}.
9998 @item -funroll-loops
9999 @opindex funroll-loops
10000 Unroll loops whose number of iterations can be determined at compile time or
10001 upon entry to the loop.  @option{-funroll-loops} implies
10002 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10003 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10004 a small constant number of iterations).  This option makes code larger, and may
10005 or may not make it run faster.
10007 Enabled with @option{-fprofile-use}.
10009 @item -funroll-all-loops
10010 @opindex funroll-all-loops
10011 Unroll all loops, even if their number of iterations is uncertain when
10012 the loop is entered.  This usually makes programs run more slowly.
10013 @option{-funroll-all-loops} implies the same options as
10014 @option{-funroll-loops}.
10016 @item -fpeel-loops
10017 @opindex fpeel-loops
10018 Peels loops for which there is enough information that they do not
10019 roll much (from profile feedback or static analysis).  It also turns on
10020 complete loop peeling (i.e.@: complete removal of loops with small constant
10021 number of iterations).
10023 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10025 @item -fmove-loop-invariants
10026 @opindex fmove-loop-invariants
10027 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10028 at level @option{-O1}
10030 @item -fsplit-loops
10031 @opindex fsplit-loops
10032 Split a loop into two if it contains a condition that's always true
10033 for one side of the iteration space and false for the other.
10035 @item -funswitch-loops
10036 @opindex funswitch-loops
10037 Move branches with loop invariant conditions out of the loop, with duplicates
10038 of the loop on both branches (modified according to result of the condition).
10040 @item -floop-unroll-and-jam
10041 @opindex floop-unroll-and-jam
10042 Apply unroll and jam transformations on feasible loops.  In a loop
10043 nest this unrolls the outer loop by some factor and fuses the resulting
10044 multiple inner loops.
10046 @item -ffunction-sections
10047 @itemx -fdata-sections
10048 @opindex ffunction-sections
10049 @opindex fdata-sections
10050 Place each function or data item into its own section in the output
10051 file if the target supports arbitrary sections.  The name of the
10052 function or the name of the data item determines the section's name
10053 in the output file.
10055 Use these options on systems where the linker can perform optimizations to
10056 improve locality of reference in the instruction space.  Most systems using the
10057 ELF object format have linkers with such optimizations.  On AIX, the linker
10058 rearranges sections (CSECTs) based on the call graph.  The performance impact
10059 varies.
10061 Together with a linker garbage collection (linker @option{--gc-sections}
10062 option) these options may lead to smaller statically-linked executables (after
10063 stripping).
10065 On ELF/DWARF systems these options do not degenerate the quality of the debug
10066 information.  There could be issues with other object files/debug info formats.
10068 Only use these options when there are significant benefits from doing so.  When
10069 you specify these options, the assembler and linker create larger object and
10070 executable files and are also slower.  These options affect code generation.
10071 They prevent optimizations by the compiler and assembler using relative
10072 locations inside a translation unit since the locations are unknown until
10073 link time.  An example of such an optimization is relaxing calls to short call
10074 instructions.
10076 @item -fbranch-target-load-optimize
10077 @opindex fbranch-target-load-optimize
10078 Perform branch target register load optimization before prologue / epilogue
10079 threading.
10080 The use of target registers can typically be exposed only during reload,
10081 thus hoisting loads out of loops and doing inter-block scheduling needs
10082 a separate optimization pass.
10084 @item -fbranch-target-load-optimize2
10085 @opindex fbranch-target-load-optimize2
10086 Perform branch target register load optimization after prologue / epilogue
10087 threading.
10089 @item -fbtr-bb-exclusive
10090 @opindex fbtr-bb-exclusive
10091 When performing branch target register load optimization, don't reuse
10092 branch target registers within any basic block.
10094 @item -fstdarg-opt
10095 @opindex fstdarg-opt
10096 Optimize the prologue of variadic argument functions with respect to usage of
10097 those arguments.
10099 @item -fsection-anchors
10100 @opindex fsection-anchors
10101 Try to reduce the number of symbolic address calculations by using
10102 shared ``anchor'' symbols to address nearby objects.  This transformation
10103 can help to reduce the number of GOT entries and GOT accesses on some
10104 targets.
10106 For example, the implementation of the following function @code{foo}:
10108 @smallexample
10109 static int a, b, c;
10110 int foo (void) @{ return a + b + c; @}
10111 @end smallexample
10113 @noindent
10114 usually calculates the addresses of all three variables, but if you
10115 compile it with @option{-fsection-anchors}, it accesses the variables
10116 from a common anchor point instead.  The effect is similar to the
10117 following pseudocode (which isn't valid C):
10119 @smallexample
10120 int foo (void)
10122   register int *xr = &x;
10123   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10125 @end smallexample
10127 Not all targets support this option.
10129 @item --param @var{name}=@var{value}
10130 @opindex param
10131 In some places, GCC uses various constants to control the amount of
10132 optimization that is done.  For example, GCC does not inline functions
10133 that contain more than a certain number of instructions.  You can
10134 control some of these constants on the command line using the
10135 @option{--param} option.
10137 The names of specific parameters, and the meaning of the values, are
10138 tied to the internals of the compiler, and are subject to change
10139 without notice in future releases.
10141 In each case, the @var{value} is an integer.  The allowable choices for
10142 @var{name} are:
10144 @table @gcctabopt
10145 @item predictable-branch-outcome
10146 When branch is predicted to be taken with probability lower than this threshold
10147 (in percent), then it is considered well predictable. The default is 10.
10149 @item max-rtl-if-conversion-insns
10150 RTL if-conversion tries to remove conditional branches around a block and
10151 replace them with conditionally executed instructions.  This parameter
10152 gives the maximum number of instructions in a block which should be
10153 considered for if-conversion.  The default is 10, though the compiler will
10154 also use other heuristics to decide whether if-conversion is likely to be
10155 profitable.
10157 @item max-rtl-if-conversion-predictable-cost
10158 @itemx max-rtl-if-conversion-unpredictable-cost
10159 RTL if-conversion will try to remove conditional branches around a block
10160 and replace them with conditionally executed instructions.  These parameters
10161 give the maximum permissible cost for the sequence that would be generated
10162 by if-conversion depending on whether the branch is statically determined
10163 to be predictable or not.  The units for this parameter are the same as
10164 those for the GCC internal seq_cost metric.  The compiler will try to
10165 provide a reasonable default for this parameter using the BRANCH_COST
10166 target macro.
10168 @item max-crossjump-edges
10169 The maximum number of incoming edges to consider for cross-jumping.
10170 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10171 the number of edges incoming to each block.  Increasing values mean
10172 more aggressive optimization, making the compilation time increase with
10173 probably small improvement in executable size.
10175 @item min-crossjump-insns
10176 The minimum number of instructions that must be matched at the end
10177 of two blocks before cross-jumping is performed on them.  This
10178 value is ignored in the case where all instructions in the block being
10179 cross-jumped from are matched.  The default value is 5.
10181 @item max-grow-copy-bb-insns
10182 The maximum code size expansion factor when copying basic blocks
10183 instead of jumping.  The expansion is relative to a jump instruction.
10184 The default value is 8.
10186 @item max-goto-duplication-insns
10187 The maximum number of instructions to duplicate to a block that jumps
10188 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10189 passes, GCC factors computed gotos early in the compilation process,
10190 and unfactors them as late as possible.  Only computed jumps at the
10191 end of a basic blocks with no more than max-goto-duplication-insns are
10192 unfactored.  The default value is 8.
10194 @item max-delay-slot-insn-search
10195 The maximum number of instructions to consider when looking for an
10196 instruction to fill a delay slot.  If more than this arbitrary number of
10197 instructions are searched, the time savings from filling the delay slot
10198 are minimal, so stop searching.  Increasing values mean more
10199 aggressive optimization, making the compilation time increase with probably
10200 small improvement in execution time.
10202 @item max-delay-slot-live-search
10203 When trying to fill delay slots, the maximum number of instructions to
10204 consider when searching for a block with valid live register
10205 information.  Increasing this arbitrarily chosen value means more
10206 aggressive optimization, increasing the compilation time.  This parameter
10207 should be removed when the delay slot code is rewritten to maintain the
10208 control-flow graph.
10210 @item max-gcse-memory
10211 The approximate maximum amount of memory that can be allocated in
10212 order to perform the global common subexpression elimination
10213 optimization.  If more memory than specified is required, the
10214 optimization is not done.
10216 @item max-gcse-insertion-ratio
10217 If the ratio of expression insertions to deletions is larger than this value
10218 for any expression, then RTL PRE inserts or removes the expression and thus
10219 leaves partially redundant computations in the instruction stream.  The default value is 20.
10221 @item max-pending-list-length
10222 The maximum number of pending dependencies scheduling allows
10223 before flushing the current state and starting over.  Large functions
10224 with few branches or calls can create excessively large lists which
10225 needlessly consume memory and resources.
10227 @item max-modulo-backtrack-attempts
10228 The maximum number of backtrack attempts the scheduler should make
10229 when modulo scheduling a loop.  Larger values can exponentially increase
10230 compilation time.
10232 @item max-inline-insns-single
10233 Several parameters control the tree inliner used in GCC@.
10234 This number sets the maximum number of instructions (counted in GCC's
10235 internal representation) in a single function that the tree inliner
10236 considers for inlining.  This only affects functions declared
10237 inline and methods implemented in a class declaration (C++).
10238 The default value is 400.
10240 @item max-inline-insns-auto
10241 When you use @option{-finline-functions} (included in @option{-O3}),
10242 a lot of functions that would otherwise not be considered for inlining
10243 by the compiler are investigated.  To those functions, a different
10244 (more restrictive) limit compared to functions declared inline can
10245 be applied.
10246 The default value is 30.
10248 @item inline-min-speedup
10249 When estimated performance improvement of caller + callee runtime exceeds this
10250 threshold (in percent), the function can be inlined regardless of the limit on
10251 @option{--param max-inline-insns-single} and @option{--param
10252 max-inline-insns-auto}.
10253 The default value is 15.
10255 @item large-function-insns
10256 The limit specifying really large functions.  For functions larger than this
10257 limit after inlining, inlining is constrained by
10258 @option{--param large-function-growth}.  This parameter is useful primarily
10259 to avoid extreme compilation time caused by non-linear algorithms used by the
10260 back end.
10261 The default value is 2700.
10263 @item large-function-growth
10264 Specifies maximal growth of large function caused by inlining in percents.
10265 The default value is 100 which limits large function growth to 2.0 times
10266 the original size.
10268 @item large-unit-insns
10269 The limit specifying large translation unit.  Growth caused by inlining of
10270 units larger than this limit is limited by @option{--param inline-unit-growth}.
10271 For small units this might be too tight.
10272 For example, consider a unit consisting of function A
10273 that is inline and B that just calls A three times.  If B is small relative to
10274 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10275 large units consisting of small inlineable functions, however, the overall unit
10276 growth limit is needed to avoid exponential explosion of code size.  Thus for
10277 smaller units, the size is increased to @option{--param large-unit-insns}
10278 before applying @option{--param inline-unit-growth}.  The default is 10000.
10280 @item inline-unit-growth
10281 Specifies maximal overall growth of the compilation unit caused by inlining.
10282 The default value is 20 which limits unit growth to 1.2 times the original
10283 size. Cold functions (either marked cold via an attribute or by profile
10284 feedback) are not accounted into the unit size.
10286 @item ipcp-unit-growth
10287 Specifies maximal overall growth of the compilation unit caused by
10288 interprocedural constant propagation.  The default value is 10 which limits
10289 unit growth to 1.1 times the original size.
10291 @item large-stack-frame
10292 The limit specifying large stack frames.  While inlining the algorithm is trying
10293 to not grow past this limit too much.  The default value is 256 bytes.
10295 @item large-stack-frame-growth
10296 Specifies maximal growth of large stack frames caused by inlining in percents.
10297 The default value is 1000 which limits large stack frame growth to 11 times
10298 the original size.
10300 @item max-inline-insns-recursive
10301 @itemx max-inline-insns-recursive-auto
10302 Specifies the maximum number of instructions an out-of-line copy of a
10303 self-recursive inline
10304 function can grow into by performing recursive inlining.
10306 @option{--param max-inline-insns-recursive} applies to functions
10307 declared inline.
10308 For functions not declared inline, recursive inlining
10309 happens only when @option{-finline-functions} (included in @option{-O3}) is
10310 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10311 default value is 450.
10313 @item max-inline-recursive-depth
10314 @itemx max-inline-recursive-depth-auto
10315 Specifies the maximum recursion depth used for recursive inlining.
10317 @option{--param max-inline-recursive-depth} applies to functions
10318 declared inline.  For functions not declared inline, recursive inlining
10319 happens only when @option{-finline-functions} (included in @option{-O3}) is
10320 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10321 default value is 8.
10323 @item min-inline-recursive-probability
10324 Recursive inlining is profitable only for function having deep recursion
10325 in average and can hurt for function having little recursion depth by
10326 increasing the prologue size or complexity of function body to other
10327 optimizers.
10329 When profile feedback is available (see @option{-fprofile-generate}) the actual
10330 recursion depth can be guessed from the probability that function recurses
10331 via a given call expression.  This parameter limits inlining only to call
10332 expressions whose probability exceeds the given threshold (in percents).
10333 The default value is 10.
10335 @item early-inlining-insns
10336 Specify growth that the early inliner can make.  In effect it increases
10337 the amount of inlining for code having a large abstraction penalty.
10338 The default value is 14.
10340 @item max-early-inliner-iterations
10341 Limit of iterations of the early inliner.  This basically bounds
10342 the number of nested indirect calls the early inliner can resolve.
10343 Deeper chains are still handled by late inlining.
10345 @item comdat-sharing-probability
10346 Probability (in percent) that C++ inline function with comdat visibility
10347 are shared across multiple compilation units.  The default value is 20.
10349 @item profile-func-internal-id
10350 A parameter to control whether to use function internal id in profile
10351 database lookup. If the value is 0, the compiler uses an id that
10352 is based on function assembler name and filename, which makes old profile
10353 data more tolerant to source changes such as function reordering etc.
10354 The default value is 0.
10356 @item min-vect-loop-bound
10357 The minimum number of iterations under which loops are not vectorized
10358 when @option{-ftree-vectorize} is used.  The number of iterations after
10359 vectorization needs to be greater than the value specified by this option
10360 to allow vectorization.  The default value is 0.
10362 @item gcse-cost-distance-ratio
10363 Scaling factor in calculation of maximum distance an expression
10364 can be moved by GCSE optimizations.  This is currently supported only in the
10365 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10366 is with simple expressions, i.e., the expressions that have cost
10367 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10368 hoisting of simple expressions.  The default value is 10.
10370 @item gcse-unrestricted-cost
10371 Cost, roughly measured as the cost of a single typical machine
10372 instruction, at which GCSE optimizations do not constrain
10373 the distance an expression can travel.  This is currently
10374 supported only in the code hoisting pass.  The lesser the cost,
10375 the more aggressive code hoisting is.  Specifying 0 
10376 allows all expressions to travel unrestricted distances.
10377 The default value is 3.
10379 @item max-hoist-depth
10380 The depth of search in the dominator tree for expressions to hoist.
10381 This is used to avoid quadratic behavior in hoisting algorithm.
10382 The value of 0 does not limit on the search, but may slow down compilation
10383 of huge functions.  The default value is 30.
10385 @item max-tail-merge-comparisons
10386 The maximum amount of similar bbs to compare a bb with.  This is used to
10387 avoid quadratic behavior in tree tail merging.  The default value is 10.
10389 @item max-tail-merge-iterations
10390 The maximum amount of iterations of the pass over the function.  This is used to
10391 limit compilation time in tree tail merging.  The default value is 2.
10393 @item store-merging-allow-unaligned
10394 Allow the store merging pass to introduce unaligned stores if it is legal to
10395 do so.  The default value is 1.
10397 @item max-stores-to-merge
10398 The maximum number of stores to attempt to merge into wider stores in the store
10399 merging pass.  The minimum value is 2 and the default is 64.
10401 @item max-unrolled-insns
10402 The maximum number of instructions that a loop may have to be unrolled.
10403 If a loop is unrolled, this parameter also determines how many times
10404 the loop code is unrolled.
10406 @item max-average-unrolled-insns
10407 The maximum number of instructions biased by probabilities of their execution
10408 that a loop may have to be unrolled.  If a loop is unrolled,
10409 this parameter also determines how many times the loop code is unrolled.
10411 @item max-unroll-times
10412 The maximum number of unrollings of a single loop.
10414 @item max-peeled-insns
10415 The maximum number of instructions that a loop may have to be peeled.
10416 If a loop is peeled, this parameter also determines how many times
10417 the loop code is peeled.
10419 @item max-peel-times
10420 The maximum number of peelings of a single loop.
10422 @item max-peel-branches
10423 The maximum number of branches on the hot path through the peeled sequence.
10425 @item max-completely-peeled-insns
10426 The maximum number of insns of a completely peeled loop.
10428 @item max-completely-peel-times
10429 The maximum number of iterations of a loop to be suitable for complete peeling.
10431 @item max-completely-peel-loop-nest-depth
10432 The maximum depth of a loop nest suitable for complete peeling.
10434 @item max-unswitch-insns
10435 The maximum number of insns of an unswitched loop.
10437 @item max-unswitch-level
10438 The maximum number of branches unswitched in a single loop.
10440 @item max-loop-headers-insns
10441 The maximum number of insns in loop header duplicated by the copy loop headers
10442 pass.
10444 @item lim-expensive
10445 The minimum cost of an expensive expression in the loop invariant motion.
10447 @item iv-consider-all-candidates-bound
10448 Bound on number of candidates for induction variables, below which
10449 all candidates are considered for each use in induction variable
10450 optimizations.  If there are more candidates than this,
10451 only the most relevant ones are considered to avoid quadratic time complexity.
10453 @item iv-max-considered-uses
10454 The induction variable optimizations give up on loops that contain more
10455 induction variable uses.
10457 @item iv-always-prune-cand-set-bound
10458 If the number of candidates in the set is smaller than this value,
10459 always try to remove unnecessary ivs from the set
10460 when adding a new one.
10462 @item avg-loop-niter
10463 Average number of iterations of a loop.
10465 @item dse-max-object-size
10466 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10467 Larger values may result in larger compilation times.
10469 @item scev-max-expr-size
10470 Bound on size of expressions used in the scalar evolutions analyzer.
10471 Large expressions slow the analyzer.
10473 @item scev-max-expr-complexity
10474 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10475 Complex expressions slow the analyzer.
10477 @item max-tree-if-conversion-phi-args
10478 Maximum number of arguments in a PHI supported by TREE if conversion
10479 unless the loop is marked with simd pragma.
10481 @item vect-max-version-for-alignment-checks
10482 The maximum number of run-time checks that can be performed when
10483 doing loop versioning for alignment in the vectorizer.
10485 @item vect-max-version-for-alias-checks
10486 The maximum number of run-time checks that can be performed when
10487 doing loop versioning for alias in the vectorizer.
10489 @item vect-max-peeling-for-alignment
10490 The maximum number of loop peels to enhance access alignment
10491 for vectorizer. Value -1 means no limit.
10493 @item max-iterations-to-track
10494 The maximum number of iterations of a loop the brute-force algorithm
10495 for analysis of the number of iterations of the loop tries to evaluate.
10497 @item hot-bb-count-ws-permille
10498 A basic block profile count is considered hot if it contributes to 
10499 the given permillage (i.e. 0...1000) of the entire profiled execution.
10501 @item hot-bb-frequency-fraction
10502 Select fraction of the entry block frequency of executions of basic block in
10503 function given basic block needs to have to be considered hot.
10505 @item max-predicted-iterations
10506 The maximum number of loop iterations we predict statically.  This is useful
10507 in cases where a function contains a single loop with known bound and
10508 another loop with unknown bound.
10509 The known number of iterations is predicted correctly, while
10510 the unknown number of iterations average to roughly 10.  This means that the
10511 loop without bounds appears artificially cold relative to the other one.
10513 @item builtin-expect-probability
10514 Control the probability of the expression having the specified value. This
10515 parameter takes a percentage (i.e. 0 ... 100) as input.
10516 The default probability of 90 is obtained empirically.
10518 @item align-threshold
10520 Select fraction of the maximal frequency of executions of a basic block in
10521 a function to align the basic block.
10523 @item align-loop-iterations
10525 A loop expected to iterate at least the selected number of iterations is
10526 aligned.
10528 @item tracer-dynamic-coverage
10529 @itemx tracer-dynamic-coverage-feedback
10531 This value is used to limit superblock formation once the given percentage of
10532 executed instructions is covered.  This limits unnecessary code size
10533 expansion.
10535 The @option{tracer-dynamic-coverage-feedback} parameter
10536 is used only when profile
10537 feedback is available.  The real profiles (as opposed to statically estimated
10538 ones) are much less balanced allowing the threshold to be larger value.
10540 @item tracer-max-code-growth
10541 Stop tail duplication once code growth has reached given percentage.  This is
10542 a rather artificial limit, as most of the duplicates are eliminated later in
10543 cross jumping, so it may be set to much higher values than is the desired code
10544 growth.
10546 @item tracer-min-branch-ratio
10548 Stop reverse growth when the reverse probability of best edge is less than this
10549 threshold (in percent).
10551 @item tracer-min-branch-probability
10552 @itemx tracer-min-branch-probability-feedback
10554 Stop forward growth if the best edge has probability lower than this
10555 threshold.
10557 Similarly to @option{tracer-dynamic-coverage} two parameters are
10558 provided.  @option{tracer-min-branch-probability-feedback} is used for
10559 compilation with profile feedback and @option{tracer-min-branch-probability}
10560 compilation without.  The value for compilation with profile feedback
10561 needs to be more conservative (higher) in order to make tracer
10562 effective.
10564 @item stack-clash-protection-guard-size
10565 Specify the size of the operating system provided stack guard as
10566 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10567 Acceptable values are between 12 and 30.  Higher values may reduce the
10568 number of explicit probes, but a value larger than the operating system
10569 provided guard will leave code vulnerable to stack clash style attacks.
10571 @item stack-clash-protection-probe-interval
10572 Stack clash protection involves probing stack space as it is allocated.  This
10573 param controls the maximum distance between probes into the stack as 2 raised
10574 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10575 12.  Higher values may reduce the number of explicit probes, but a value
10576 larger than the operating system provided guard will leave code vulnerable to
10577 stack clash style attacks.
10579 @item max-cse-path-length
10581 The maximum number of basic blocks on path that CSE considers.
10582 The default is 10.
10584 @item max-cse-insns
10585 The maximum number of instructions CSE processes before flushing.
10586 The default is 1000.
10588 @item ggc-min-expand
10590 GCC uses a garbage collector to manage its own memory allocation.  This
10591 parameter specifies the minimum percentage by which the garbage
10592 collector's heap should be allowed to expand between collections.
10593 Tuning this may improve compilation speed; it has no effect on code
10594 generation.
10596 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10597 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10598 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10599 GCC is not able to calculate RAM on a particular platform, the lower
10600 bound of 30% is used.  Setting this parameter and
10601 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10602 every opportunity.  This is extremely slow, but can be useful for
10603 debugging.
10605 @item ggc-min-heapsize
10607 Minimum size of the garbage collector's heap before it begins bothering
10608 to collect garbage.  The first collection occurs after the heap expands
10609 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10610 tuning this may improve compilation speed, and has no effect on code
10611 generation.
10613 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10614 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10615 with a lower bound of 4096 (four megabytes) and an upper bound of
10616 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10617 particular platform, the lower bound is used.  Setting this parameter
10618 very large effectively disables garbage collection.  Setting this
10619 parameter and @option{ggc-min-expand} to zero causes a full collection
10620 to occur at every opportunity.
10622 @item max-reload-search-insns
10623 The maximum number of instruction reload should look backward for equivalent
10624 register.  Increasing values mean more aggressive optimization, making the
10625 compilation time increase with probably slightly better performance.
10626 The default value is 100.
10628 @item max-cselib-memory-locations
10629 The maximum number of memory locations cselib should take into account.
10630 Increasing values mean more aggressive optimization, making the compilation time
10631 increase with probably slightly better performance.  The default value is 500.
10633 @item max-sched-ready-insns
10634 The maximum number of instructions ready to be issued the scheduler should
10635 consider at any given time during the first scheduling pass.  Increasing
10636 values mean more thorough searches, making the compilation time increase
10637 with probably little benefit.  The default value is 100.
10639 @item max-sched-region-blocks
10640 The maximum number of blocks in a region to be considered for
10641 interblock scheduling.  The default value is 10.
10643 @item max-pipeline-region-blocks
10644 The maximum number of blocks in a region to be considered for
10645 pipelining in the selective scheduler.  The default value is 15.
10647 @item max-sched-region-insns
10648 The maximum number of insns in a region to be considered for
10649 interblock scheduling.  The default value is 100.
10651 @item max-pipeline-region-insns
10652 The maximum number of insns in a region to be considered for
10653 pipelining in the selective scheduler.  The default value is 200.
10655 @item min-spec-prob
10656 The minimum probability (in percents) of reaching a source block
10657 for interblock speculative scheduling.  The default value is 40.
10659 @item max-sched-extend-regions-iters
10660 The maximum number of iterations through CFG to extend regions.
10661 A value of 0 (the default) disables region extensions.
10663 @item max-sched-insn-conflict-delay
10664 The maximum conflict delay for an insn to be considered for speculative motion.
10665 The default value is 3.
10667 @item sched-spec-prob-cutoff
10668 The minimal probability of speculation success (in percents), so that
10669 speculative insns are scheduled.
10670 The default value is 40.
10672 @item sched-state-edge-prob-cutoff
10673 The minimum probability an edge must have for the scheduler to save its
10674 state across it.
10675 The default value is 10.
10677 @item sched-mem-true-dep-cost
10678 Minimal distance (in CPU cycles) between store and load targeting same
10679 memory locations.  The default value is 1.
10681 @item selsched-max-lookahead
10682 The maximum size of the lookahead window of selective scheduling.  It is a
10683 depth of search for available instructions.
10684 The default value is 50.
10686 @item selsched-max-sched-times
10687 The maximum number of times that an instruction is scheduled during
10688 selective scheduling.  This is the limit on the number of iterations
10689 through which the instruction may be pipelined.  The default value is 2.
10691 @item selsched-insns-to-rename
10692 The maximum number of best instructions in the ready list that are considered
10693 for renaming in the selective scheduler.  The default value is 2.
10695 @item sms-min-sc
10696 The minimum value of stage count that swing modulo scheduler
10697 generates.  The default value is 2.
10699 @item max-last-value-rtl
10700 The maximum size measured as number of RTLs that can be recorded in an expression
10701 in combiner for a pseudo register as last known value of that register.  The default
10702 is 10000.
10704 @item max-combine-insns
10705 The maximum number of instructions the RTL combiner tries to combine.
10706 The default value is 2 at @option{-Og} and 4 otherwise.
10708 @item integer-share-limit
10709 Small integer constants can use a shared data structure, reducing the
10710 compiler's memory usage and increasing its speed.  This sets the maximum
10711 value of a shared integer constant.  The default value is 256.
10713 @item ssp-buffer-size
10714 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10715 protection when @option{-fstack-protection} is used.
10717 @item min-size-for-stack-sharing
10718 The minimum size of variables taking part in stack slot sharing when not
10719 optimizing. The default value is 32.
10721 @item max-jump-thread-duplication-stmts
10722 Maximum number of statements allowed in a block that needs to be
10723 duplicated when threading jumps.
10725 @item max-fields-for-field-sensitive
10726 Maximum number of fields in a structure treated in
10727 a field sensitive manner during pointer analysis.  The default is zero
10728 for @option{-O0} and @option{-O1},
10729 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10731 @item prefetch-latency
10732 Estimate on average number of instructions that are executed before
10733 prefetch finishes.  The distance prefetched ahead is proportional
10734 to this constant.  Increasing this number may also lead to less
10735 streams being prefetched (see @option{simultaneous-prefetches}).
10737 @item simultaneous-prefetches
10738 Maximum number of prefetches that can run at the same time.
10740 @item l1-cache-line-size
10741 The size of cache line in L1 cache, in bytes.
10743 @item l1-cache-size
10744 The size of L1 cache, in kilobytes.
10746 @item l2-cache-size
10747 The size of L2 cache, in kilobytes.
10749 @item loop-interchange-max-num-stmts
10750 The maximum number of stmts in a loop to be interchanged.
10752 @item loop-interchange-stride-ratio
10753 The minimum ratio between stride of two loops for interchange to be profitable.
10755 @item min-insn-to-prefetch-ratio
10756 The minimum ratio between the number of instructions and the
10757 number of prefetches to enable prefetching in a loop.
10759 @item prefetch-min-insn-to-mem-ratio
10760 The minimum ratio between the number of instructions and the
10761 number of memory references to enable prefetching in a loop.
10763 @item use-canonical-types
10764 Whether the compiler should use the ``canonical'' type system.  By
10765 default, this should always be 1, which uses a more efficient internal
10766 mechanism for comparing types in C++ and Objective-C++.  However, if
10767 bugs in the canonical type system are causing compilation failures,
10768 set this value to 0 to disable canonical types.
10770 @item switch-conversion-max-branch-ratio
10771 Switch initialization conversion refuses to create arrays that are
10772 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10773 branches in the switch.
10775 @item max-partial-antic-length
10776 Maximum length of the partial antic set computed during the tree
10777 partial redundancy elimination optimization (@option{-ftree-pre}) when
10778 optimizing at @option{-O3} and above.  For some sorts of source code
10779 the enhanced partial redundancy elimination optimization can run away,
10780 consuming all of the memory available on the host machine.  This
10781 parameter sets a limit on the length of the sets that are computed,
10782 which prevents the runaway behavior.  Setting a value of 0 for
10783 this parameter allows an unlimited set length.
10785 @item sccvn-max-scc-size
10786 Maximum size of a strongly connected component (SCC) during SCCVN
10787 processing.  If this limit is hit, SCCVN processing for the whole
10788 function is not done and optimizations depending on it are
10789 disabled.  The default maximum SCC size is 10000.
10791 @item sccvn-max-alias-queries-per-access
10792 Maximum number of alias-oracle queries we perform when looking for
10793 redundancies for loads and stores.  If this limit is hit the search
10794 is aborted and the load or store is not considered redundant.  The
10795 number of queries is algorithmically limited to the number of
10796 stores on all paths from the load to the function entry.
10797 The default maximum number of queries is 1000.
10799 @item ira-max-loops-num
10800 IRA uses regional register allocation by default.  If a function
10801 contains more loops than the number given by this parameter, only at most
10802 the given number of the most frequently-executed loops form regions
10803 for regional register allocation.  The default value of the
10804 parameter is 100.
10806 @item ira-max-conflict-table-size 
10807 Although IRA uses a sophisticated algorithm to compress the conflict
10808 table, the table can still require excessive amounts of memory for
10809 huge functions.  If the conflict table for a function could be more
10810 than the size in MB given by this parameter, the register allocator
10811 instead uses a faster, simpler, and lower-quality
10812 algorithm that does not require building a pseudo-register conflict table.  
10813 The default value of the parameter is 2000.
10815 @item ira-loop-reserved-regs
10816 IRA can be used to evaluate more accurate register pressure in loops
10817 for decisions to move loop invariants (see @option{-O3}).  The number
10818 of available registers reserved for some other purposes is given
10819 by this parameter.  The default value of the parameter is 2, which is
10820 the minimal number of registers needed by typical instructions.
10821 This value is the best found from numerous experiments.
10823 @item lra-inheritance-ebb-probability-cutoff
10824 LRA tries to reuse values reloaded in registers in subsequent insns.
10825 This optimization is called inheritance.  EBB is used as a region to
10826 do this optimization.  The parameter defines a minimal fall-through
10827 edge probability in percentage used to add BB to inheritance EBB in
10828 LRA.  The default value of the parameter is 40.  The value was chosen
10829 from numerous runs of SPEC2000 on x86-64.
10831 @item loop-invariant-max-bbs-in-loop
10832 Loop invariant motion can be very expensive, both in compilation time and
10833 in amount of needed compile-time memory, with very large loops.  Loops
10834 with more basic blocks than this parameter won't have loop invariant
10835 motion optimization performed on them.  The default value of the
10836 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10838 @item loop-max-datarefs-for-datadeps
10839 Building data dependencies is expensive for very large loops.  This
10840 parameter limits the number of data references in loops that are
10841 considered for data dependence analysis.  These large loops are no
10842 handled by the optimizations using loop data dependencies.
10843 The default value is 1000.
10845 @item max-vartrack-size
10846 Sets a maximum number of hash table slots to use during variable
10847 tracking dataflow analysis of any function.  If this limit is exceeded
10848 with variable tracking at assignments enabled, analysis for that
10849 function is retried without it, after removing all debug insns from
10850 the function.  If the limit is exceeded even without debug insns, var
10851 tracking analysis is completely disabled for the function.  Setting
10852 the parameter to zero makes it unlimited.
10854 @item max-vartrack-expr-depth
10855 Sets a maximum number of recursion levels when attempting to map
10856 variable names or debug temporaries to value expressions.  This trades
10857 compilation time for more complete debug information.  If this is set too
10858 low, value expressions that are available and could be represented in
10859 debug information may end up not being used; setting this higher may
10860 enable the compiler to find more complex debug expressions, but compile
10861 time and memory use may grow.  The default is 12.
10863 @item max-debug-marker-count
10864 Sets a threshold on the number of debug markers (e.g. begin stmt
10865 markers) to avoid complexity explosion at inlining or expanding to RTL.
10866 If a function has more such gimple stmts than the set limit, such stmts
10867 will be dropped from the inlined copy of a function, and from its RTL
10868 expansion.  The default is 100000.
10870 @item min-nondebug-insn-uid
10871 Use uids starting at this parameter for nondebug insns.  The range below
10872 the parameter is reserved exclusively for debug insns created by
10873 @option{-fvar-tracking-assignments}, but debug insns may get
10874 (non-overlapping) uids above it if the reserved range is exhausted.
10876 @item ipa-sra-ptr-growth-factor
10877 IPA-SRA replaces a pointer to an aggregate with one or more new
10878 parameters only when their cumulative size is less or equal to
10879 @option{ipa-sra-ptr-growth-factor} times the size of the original
10880 pointer parameter.
10882 @item sra-max-scalarization-size-Ospeed
10883 @itemx sra-max-scalarization-size-Osize
10884 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10885 replace scalar parts of aggregates with uses of independent scalar
10886 variables.  These parameters control the maximum size, in storage units,
10887 of aggregate which is considered for replacement when compiling for
10888 speed
10889 (@option{sra-max-scalarization-size-Ospeed}) or size
10890 (@option{sra-max-scalarization-size-Osize}) respectively.
10892 @item tm-max-aggregate-size
10893 When making copies of thread-local variables in a transaction, this
10894 parameter specifies the size in bytes after which variables are
10895 saved with the logging functions as opposed to save/restore code
10896 sequence pairs.  This option only applies when using
10897 @option{-fgnu-tm}.
10899 @item graphite-max-nb-scop-params
10900 To avoid exponential effects in the Graphite loop transforms, the
10901 number of parameters in a Static Control Part (SCoP) is bounded.  The
10902 default value is 10 parameters, a value of zero can be used to lift
10903 the bound.  A variable whose value is unknown at compilation time and
10904 defined outside a SCoP is a parameter of the SCoP.
10906 @item loop-block-tile-size
10907 Loop blocking or strip mining transforms, enabled with
10908 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10909 loop in the loop nest by a given number of iterations.  The strip
10910 length can be changed using the @option{loop-block-tile-size}
10911 parameter.  The default value is 51 iterations.
10913 @item loop-unroll-jam-size
10914 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10915 default value is 4.
10917 @item loop-unroll-jam-depth
10918 Specify the dimension to be unrolled (counting from the most inner loop)
10919 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10921 @item ipa-cp-value-list-size
10922 IPA-CP attempts to track all possible values and types passed to a function's
10923 parameter in order to propagate them and perform devirtualization.
10924 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10925 stores per one formal parameter of a function.
10927 @item ipa-cp-eval-threshold
10928 IPA-CP calculates its own score of cloning profitability heuristics
10929 and performs those cloning opportunities with scores that exceed
10930 @option{ipa-cp-eval-threshold}.
10932 @item ipa-cp-recursion-penalty
10933 Percentage penalty the recursive functions will receive when they
10934 are evaluated for cloning.
10936 @item ipa-cp-single-call-penalty
10937 Percentage penalty functions containing a single call to another
10938 function will receive when they are evaluated for cloning.
10941 @item ipa-max-agg-items
10942 IPA-CP is also capable to propagate a number of scalar values passed
10943 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10944 number of such values per one parameter.
10946 @item ipa-cp-loop-hint-bonus
10947 When IPA-CP determines that a cloning candidate would make the number
10948 of iterations of a loop known, it adds a bonus of
10949 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10950 the candidate.
10952 @item ipa-cp-array-index-hint-bonus
10953 When IPA-CP determines that a cloning candidate would make the index of
10954 an array access known, it adds a bonus of
10955 @option{ipa-cp-array-index-hint-bonus} to the profitability
10956 score of the candidate.
10958 @item ipa-max-aa-steps
10959 During its analysis of function bodies, IPA-CP employs alias analysis
10960 in order to track values pointed to by function parameters.  In order
10961 not spend too much time analyzing huge functions, it gives up and
10962 consider all memory clobbered after examining
10963 @option{ipa-max-aa-steps} statements modifying memory.
10965 @item lto-partitions
10966 Specify desired number of partitions produced during WHOPR compilation.
10967 The number of partitions should exceed the number of CPUs used for compilation.
10968 The default value is 32.
10970 @item lto-min-partition
10971 Size of minimal partition for WHOPR (in estimated instructions).
10972 This prevents expenses of splitting very small programs into too many
10973 partitions.
10975 @item lto-max-partition
10976 Size of max partition for WHOPR (in estimated instructions).
10977 to provide an upper bound for individual size of partition.
10978 Meant to be used only with balanced partitioning.
10980 @item cxx-max-namespaces-for-diagnostic-help
10981 The maximum number of namespaces to consult for suggestions when C++
10982 name lookup fails for an identifier.  The default is 1000.
10984 @item sink-frequency-threshold
10985 The maximum relative execution frequency (in percents) of the target block
10986 relative to a statement's original block to allow statement sinking of a
10987 statement.  Larger numbers result in more aggressive statement sinking.
10988 The default value is 75.  A small positive adjustment is applied for
10989 statements with memory operands as those are even more profitable so sink.
10991 @item max-stores-to-sink
10992 The maximum number of conditional store pairs that can be sunk.  Set to 0
10993 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10994 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10996 @item allow-store-data-races
10997 Allow optimizers to introduce new data races on stores.
10998 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10999 at optimization level @option{-Ofast}.
11001 @item case-values-threshold
11002 The smallest number of different values for which it is best to use a
11003 jump-table instead of a tree of conditional branches.  If the value is
11004 0, use the default for the machine.  The default is 0.
11006 @item tree-reassoc-width
11007 Set the maximum number of instructions executed in parallel in
11008 reassociated tree. This parameter overrides target dependent
11009 heuristics used by default if has non zero value.
11011 @item sched-pressure-algorithm
11012 Choose between the two available implementations of
11013 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11014 and is the more likely to prevent instructions from being reordered.
11015 Algorithm 2 was designed to be a compromise between the relatively
11016 conservative approach taken by algorithm 1 and the rather aggressive
11017 approach taken by the default scheduler.  It relies more heavily on
11018 having a regular register file and accurate register pressure classes.
11019 See @file{haifa-sched.c} in the GCC sources for more details.
11021 The default choice depends on the target.
11023 @item max-slsr-cand-scan
11024 Set the maximum number of existing candidates that are considered when
11025 seeking a basis for a new straight-line strength reduction candidate.
11027 @item asan-globals
11028 Enable buffer overflow detection for global objects.  This kind
11029 of protection is enabled by default if you are using
11030 @option{-fsanitize=address} option.
11031 To disable global objects protection use @option{--param asan-globals=0}.
11033 @item asan-stack
11034 Enable buffer overflow detection for stack objects.  This kind of
11035 protection is enabled by default when using @option{-fsanitize=address}.
11036 To disable stack protection use @option{--param asan-stack=0} option.
11038 @item asan-instrument-reads
11039 Enable buffer overflow detection for memory reads.  This kind of
11040 protection is enabled by default when using @option{-fsanitize=address}.
11041 To disable memory reads protection use
11042 @option{--param asan-instrument-reads=0}.
11044 @item asan-instrument-writes
11045 Enable buffer overflow detection for memory writes.  This kind of
11046 protection is enabled by default when using @option{-fsanitize=address}.
11047 To disable memory writes protection use
11048 @option{--param asan-instrument-writes=0} option.
11050 @item asan-memintrin
11051 Enable detection for built-in functions.  This kind of protection
11052 is enabled by default when using @option{-fsanitize=address}.
11053 To disable built-in functions protection use
11054 @option{--param asan-memintrin=0}.
11056 @item asan-use-after-return
11057 Enable detection of use-after-return.  This kind of protection
11058 is enabled by default when using the @option{-fsanitize=address} option.
11059 To disable it use @option{--param asan-use-after-return=0}.
11061 Note: By default the check is disabled at run time.  To enable it,
11062 add @code{detect_stack_use_after_return=1} to the environment variable
11063 @env{ASAN_OPTIONS}.
11065 @item asan-instrumentation-with-call-threshold
11066 If number of memory accesses in function being instrumented
11067 is greater or equal to this number, use callbacks instead of inline checks.
11068 E.g. to disable inline code use
11069 @option{--param asan-instrumentation-with-call-threshold=0}.
11071 @item use-after-scope-direct-emission-threshold
11072 If the size of a local variable in bytes is smaller or equal to this
11073 number, directly poison (or unpoison) shadow memory instead of using
11074 run-time callbacks.  The default value is 256.
11076 @item chkp-max-ctor-size
11077 Static constructors generated by Pointer Bounds Checker may become very
11078 large and significantly increase compile time at optimization level
11079 @option{-O1} and higher.  This parameter is a maximum number of statements
11080 in a single generated constructor.  Default value is 5000.
11082 @item max-fsm-thread-path-insns
11083 Maximum number of instructions to copy when duplicating blocks on a
11084 finite state automaton jump thread path.  The default is 100.
11086 @item max-fsm-thread-length
11087 Maximum number of basic blocks on a finite state automaton jump thread
11088 path.  The default is 10.
11090 @item max-fsm-thread-paths
11091 Maximum number of new jump thread paths to create for a finite state
11092 automaton.  The default is 50.
11094 @item parloops-chunk-size
11095 Chunk size of omp schedule for loops parallelized by parloops.  The default
11096 is 0.
11098 @item parloops-schedule
11099 Schedule type of omp schedule for loops parallelized by parloops (static,
11100 dynamic, guided, auto, runtime).  The default is static.
11102 @item parloops-min-per-thread
11103 The minimum number of iterations per thread of an innermost parallelized
11104 loop for which the parallelized variant is prefered over the single threaded
11105 one.  The default is 100.  Note that for a parallelized loop nest the
11106 minimum number of iterations of the outermost loop per thread is two.
11108 @item max-ssa-name-query-depth
11109 Maximum depth of recursion when querying properties of SSA names in things
11110 like fold routines.  One level of recursion corresponds to following a
11111 use-def chain.
11113 @item hsa-gen-debug-stores
11114 Enable emission of special debug stores within HSA kernels which are
11115 then read and reported by libgomp plugin.  Generation of these stores
11116 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11117 enable it.
11119 @item max-speculative-devirt-maydefs
11120 The maximum number of may-defs we analyze when looking for a must-def
11121 specifying the dynamic type of an object that invokes a virtual call
11122 we may be able to devirtualize speculatively.
11124 @item max-vrp-switch-assertions
11125 The maximum number of assertions to add along the default edge of a switch
11126 statement during VRP.  The default is 10.
11128 @item unroll-jam-min-percent
11129 The minimum percentage of memory references that must be optimized
11130 away for the unroll-and-jam transformation to be considered profitable.
11132 @item unroll-jam-max-unroll
11133 The maximum number of times the outer loop should be unrolled by
11134 the unroll-and-jam transformation.
11135 @end table
11136 @end table
11138 @node Instrumentation Options
11139 @section Program Instrumentation Options
11140 @cindex instrumentation options
11141 @cindex program instrumentation options
11142 @cindex run-time error checking options
11143 @cindex profiling options
11144 @cindex options, program instrumentation
11145 @cindex options, run-time error checking
11146 @cindex options, profiling
11148 GCC supports a number of command-line options that control adding
11149 run-time instrumentation to the code it normally generates.  
11150 For example, one purpose of instrumentation is collect profiling
11151 statistics for use in finding program hot spots, code coverage
11152 analysis, or profile-guided optimizations.
11153 Another class of program instrumentation is adding run-time checking 
11154 to detect programming errors like invalid pointer
11155 dereferences or out-of-bounds array accesses, as well as deliberately
11156 hostile attacks such as stack smashing or C++ vtable hijacking.
11157 There is also a general hook which can be used to implement other
11158 forms of tracing or function-level instrumentation for debug or
11159 program analysis purposes.
11161 @table @gcctabopt
11162 @cindex @command{prof}
11163 @item -p
11164 @opindex p
11165 Generate extra code to write profile information suitable for the
11166 analysis program @command{prof}.  You must use this option when compiling
11167 the source files you want data about, and you must also use it when
11168 linking.
11170 @cindex @command{gprof}
11171 @item -pg
11172 @opindex pg
11173 Generate extra code to write profile information suitable for the
11174 analysis program @command{gprof}.  You must use this option when compiling
11175 the source files you want data about, and you must also use it when
11176 linking.
11178 @item -fprofile-arcs
11179 @opindex fprofile-arcs
11180 Add code so that program flow @dfn{arcs} are instrumented.  During
11181 execution the program records how many times each branch and call is
11182 executed and how many times it is taken or returns.  On targets that support
11183 constructors with priority support, profiling properly handles constructors,
11184 destructors and C++ constructors (and destructors) of classes which are used
11185 as a type of a global variable.
11187 When the compiled
11188 program exits it saves this data to a file called
11189 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11190 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11191 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11192 @var{auxname} is generated from the name of the output file, if
11193 explicitly specified and it is not the final executable, otherwise it is
11194 the basename of the source file.  In both cases any suffix is removed
11195 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11196 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11197 @xref{Cross-profiling}.
11199 @cindex @command{gcov}
11200 @item --coverage
11201 @opindex coverage
11203 This option is used to compile and link code instrumented for coverage
11204 analysis.  The option is a synonym for @option{-fprofile-arcs}
11205 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11206 linking).  See the documentation for those options for more details.
11208 @itemize
11210 @item
11211 Compile the source files with @option{-fprofile-arcs} plus optimization
11212 and code generation options.  For test coverage analysis, use the
11213 additional @option{-ftest-coverage} option.  You do not need to profile
11214 every source file in a program.
11216 @item
11217 Compile the source files additionally with @option{-fprofile-abs-path}
11218 to create absolute path names in the @file{.gcno} files.  This allows
11219 @command{gcov} to find the correct sources in projects where compilations
11220 occur with different working directories.
11222 @item
11223 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11224 (the latter implies the former).
11226 @item
11227 Run the program on a representative workload to generate the arc profile
11228 information.  This may be repeated any number of times.  You can run
11229 concurrent instances of your program, and provided that the file system
11230 supports locking, the data files will be correctly updated.  Unless
11231 a strict ISO C dialect option is in effect, @code{fork} calls are
11232 detected and correctly handled without double counting.
11234 @item
11235 For profile-directed optimizations, compile the source files again with
11236 the same optimization and code generation options plus
11237 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11238 Control Optimization}).
11240 @item
11241 For test coverage analysis, use @command{gcov} to produce human readable
11242 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11243 @command{gcov} documentation for further information.
11245 @end itemize
11247 With @option{-fprofile-arcs}, for each function of your program GCC
11248 creates a program flow graph, then finds a spanning tree for the graph.
11249 Only arcs that are not on the spanning tree have to be instrumented: the
11250 compiler adds code to count the number of times that these arcs are
11251 executed.  When an arc is the only exit or only entrance to a block, the
11252 instrumentation code can be added to the block; otherwise, a new basic
11253 block must be created to hold the instrumentation code.
11255 @need 2000
11256 @item -ftest-coverage
11257 @opindex ftest-coverage
11258 Produce a notes file that the @command{gcov} code-coverage utility
11259 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11260 show program coverage.  Each source file's note file is called
11261 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11262 above for a description of @var{auxname} and instructions on how to
11263 generate test coverage data.  Coverage data matches the source files
11264 more closely if you do not optimize.
11266 @item -fprofile-abs-path
11267 @opindex fprofile-abs-path
11268 Automatically convert relative source file names to absolute path names
11269 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11270 sources in projects where compilations occur with different working
11271 directories.
11273 @item -fprofile-dir=@var{path}
11274 @opindex fprofile-dir
11276 Set the directory to search for the profile data files in to @var{path}.
11277 This option affects only the profile data generated by
11278 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11279 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11280 and its related options.  Both absolute and relative paths can be used.
11281 By default, GCC uses the current directory as @var{path}, thus the
11282 profile data file appears in the same directory as the object file.
11284 @item -fprofile-generate
11285 @itemx -fprofile-generate=@var{path}
11286 @opindex fprofile-generate
11288 Enable options usually used for instrumenting application to produce
11289 profile useful for later recompilation with profile feedback based
11290 optimization.  You must use @option{-fprofile-generate} both when
11291 compiling and when linking your program.
11293 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11295 If @var{path} is specified, GCC looks at the @var{path} to find
11296 the profile feedback data files. See @option{-fprofile-dir}.
11298 To optimize the program based on the collected profile information, use
11299 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11301 @item -fprofile-update=@var{method}
11302 @opindex fprofile-update
11304 Alter the update method for an application instrumented for profile
11305 feedback based optimization.  The @var{method} argument should be one of
11306 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11307 The first one is useful for single-threaded applications,
11308 while the second one prevents profile corruption by emitting thread-safe code.
11310 @strong{Warning:} When an application does not properly join all threads
11311 (or creates an detached thread), a profile file can be still corrupted.
11313 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11314 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11315 automatically selects @samp{prefer-atomic} when @option{-pthread}
11316 is present in the command line.
11318 @item -fsanitize=address
11319 @opindex fsanitize=address
11320 Enable AddressSanitizer, a fast memory error detector.
11321 Memory access instructions are instrumented to detect
11322 out-of-bounds and use-after-free bugs.
11323 The option enables @option{-fsanitize-address-use-after-scope}.
11324 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11325 more details.  The run-time behavior can be influenced using the
11326 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11327 the available options are shown at startup of the instrumented program.  See
11328 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11329 for a list of supported options.
11330 The option cannot be combined with @option{-fsanitize=thread}
11331 and/or @option{-fcheck-pointer-bounds}.
11333 @item -fsanitize=kernel-address
11334 @opindex fsanitize=kernel-address
11335 Enable AddressSanitizer for Linux kernel.
11336 See @uref{https://github.com/google/kasan/wiki} for more details.
11337 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11339 @item -fsanitize=pointer-compare
11340 @opindex fsanitize=pointer-compare
11341 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11342 The option must be combined with either @option{-fsanitize=kernel-address} or
11343 @option{-fsanitize=address}
11344 The option cannot be combined with @option{-fsanitize=thread}
11345 and/or @option{-fcheck-pointer-bounds}.
11346 Note: By default the check is disabled at run time.  To enable it,
11347 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11348 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11349 invalid operation only when both pointers are non-null.
11351 @item -fsanitize=pointer-subtract
11352 @opindex fsanitize=pointer-subtract
11353 Instrument subtraction with pointer operands.
11354 The option must be combined with either @option{-fsanitize=kernel-address} or
11355 @option{-fsanitize=address}
11356 The option cannot be combined with @option{-fsanitize=thread}
11357 and/or @option{-fcheck-pointer-bounds}.
11358 Note: By default the check is disabled at run time.  To enable it,
11359 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11360 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11361 invalid operation only when both pointers are non-null.
11363 @item -fsanitize=thread
11364 @opindex fsanitize=thread
11365 Enable ThreadSanitizer, a fast data race detector.
11366 Memory access instructions are instrumented to detect
11367 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11368 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11369 environment variable; see
11370 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11371 supported options.
11372 The option cannot be combined with @option{-fsanitize=address},
11373 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11375 Note that sanitized atomic builtins cannot throw exceptions when
11376 operating on invalid memory addresses with non-call exceptions
11377 (@option{-fnon-call-exceptions}).
11379 @item -fsanitize=leak
11380 @opindex fsanitize=leak
11381 Enable LeakSanitizer, a memory leak detector.
11382 This option only matters for linking of executables and
11383 the executable is linked against a library that overrides @code{malloc}
11384 and other allocator functions.  See
11385 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11386 details.  The run-time behavior can be influenced using the
11387 @env{LSAN_OPTIONS} environment variable.
11388 The option cannot be combined with @option{-fsanitize=thread}.
11390 @item -fsanitize=undefined
11391 @opindex fsanitize=undefined
11392 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11393 Various computations are instrumented to detect undefined behavior
11394 at runtime.  Current suboptions are:
11396 @table @gcctabopt
11398 @item -fsanitize=shift
11399 @opindex fsanitize=shift
11400 This option enables checking that the result of a shift operation is
11401 not undefined.  Note that what exactly is considered undefined differs
11402 slightly between C and C++, as well as between ISO C90 and C99, etc.
11403 This option has two suboptions, @option{-fsanitize=shift-base} and
11404 @option{-fsanitize=shift-exponent}.
11406 @item -fsanitize=shift-exponent
11407 @opindex fsanitize=shift-exponent
11408 This option enables checking that the second argument of a shift operation
11409 is not negative and is smaller than the precision of the promoted first
11410 argument.
11412 @item -fsanitize=shift-base
11413 @opindex fsanitize=shift-base
11414 If the second argument of a shift operation is within range, check that the
11415 result of a shift operation is not undefined.  Note that what exactly is
11416 considered undefined differs slightly between C and C++, as well as between
11417 ISO C90 and C99, etc.
11419 @item -fsanitize=integer-divide-by-zero
11420 @opindex fsanitize=integer-divide-by-zero
11421 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11423 @item -fsanitize=unreachable
11424 @opindex fsanitize=unreachable
11425 With this option, the compiler turns the @code{__builtin_unreachable}
11426 call into a diagnostics message call instead.  When reaching the
11427 @code{__builtin_unreachable} call, the behavior is undefined.
11429 @item -fsanitize=vla-bound
11430 @opindex fsanitize=vla-bound
11431 This option instructs the compiler to check that the size of a variable
11432 length array is positive.
11434 @item -fsanitize=null
11435 @opindex fsanitize=null
11436 This option enables pointer checking.  Particularly, the application
11437 built with this option turned on will issue an error message when it
11438 tries to dereference a NULL pointer, or if a reference (possibly an
11439 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11440 on an object pointed by a NULL pointer.
11442 @item -fsanitize=return
11443 @opindex fsanitize=return
11444 This option enables return statement checking.  Programs
11445 built with this option turned on will issue an error message
11446 when the end of a non-void function is reached without actually
11447 returning a value.  This option works in C++ only.
11449 @item -fsanitize=signed-integer-overflow
11450 @opindex fsanitize=signed-integer-overflow
11451 This option enables signed integer overflow checking.  We check that
11452 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11453 does not overflow in the signed arithmetics.  Note, integer promotion
11454 rules must be taken into account.  That is, the following is not an
11455 overflow:
11456 @smallexample
11457 signed char a = SCHAR_MAX;
11458 a++;
11459 @end smallexample
11461 @item -fsanitize=bounds
11462 @opindex fsanitize=bounds
11463 This option enables instrumentation of array bounds.  Various out of bounds
11464 accesses are detected.  Flexible array members, flexible array member-like
11465 arrays, and initializers of variables with static storage are not instrumented.
11466 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11468 @item -fsanitize=bounds-strict
11469 @opindex fsanitize=bounds-strict
11470 This option enables strict instrumentation of array bounds.  Most out of bounds
11471 accesses are detected, including flexible array members and flexible array
11472 member-like arrays.  Initializers of variables with static storage are not
11473 instrumented.  The option cannot be combined
11474 with @option{-fcheck-pointer-bounds}.
11476 @item -fsanitize=alignment
11477 @opindex fsanitize=alignment
11479 This option enables checking of alignment of pointers when they are
11480 dereferenced, or when a reference is bound to insufficiently aligned target,
11481 or when a method or constructor is invoked on insufficiently aligned object.
11483 @item -fsanitize=object-size
11484 @opindex fsanitize=object-size
11485 This option enables instrumentation of memory references using the
11486 @code{__builtin_object_size} function.  Various out of bounds pointer
11487 accesses are detected.
11489 @item -fsanitize=float-divide-by-zero
11490 @opindex fsanitize=float-divide-by-zero
11491 Detect floating-point division by zero.  Unlike other similar options,
11492 @option{-fsanitize=float-divide-by-zero} is not enabled by
11493 @option{-fsanitize=undefined}, since floating-point division by zero can
11494 be a legitimate way of obtaining infinities and NaNs.
11496 @item -fsanitize=float-cast-overflow
11497 @opindex fsanitize=float-cast-overflow
11498 This option enables floating-point type to integer conversion checking.
11499 We check that the result of the conversion does not overflow.
11500 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11501 not enabled by @option{-fsanitize=undefined}.
11502 This option does not work well with @code{FE_INVALID} exceptions enabled.
11504 @item -fsanitize=nonnull-attribute
11505 @opindex fsanitize=nonnull-attribute
11507 This option enables instrumentation of calls, checking whether null values
11508 are not passed to arguments marked as requiring a non-null value by the
11509 @code{nonnull} function attribute.
11511 @item -fsanitize=returns-nonnull-attribute
11512 @opindex fsanitize=returns-nonnull-attribute
11514 This option enables instrumentation of return statements in functions
11515 marked with @code{returns_nonnull} function attribute, to detect returning
11516 of null values from such functions.
11518 @item -fsanitize=bool
11519 @opindex fsanitize=bool
11521 This option enables instrumentation of loads from bool.  If a value other
11522 than 0/1 is loaded, a run-time error is issued.
11524 @item -fsanitize=enum
11525 @opindex fsanitize=enum
11527 This option enables instrumentation of loads from an enum type.  If
11528 a value outside the range of values for the enum type is loaded,
11529 a run-time error is issued.
11531 @item -fsanitize=vptr
11532 @opindex fsanitize=vptr
11534 This option enables instrumentation of C++ member function calls, member
11535 accesses and some conversions between pointers to base and derived classes,
11536 to verify the referenced object has the correct dynamic type.
11538 @item -fsanitize=pointer-overflow
11539 @opindex fsanitize=pointer-overflow
11541 This option enables instrumentation of pointer arithmetics.  If the pointer
11542 arithmetics overflows, a run-time error is issued.
11544 @item -fsanitize=builtin
11545 @opindex fsanitize=builtin
11547 This option enables instrumentation of arguments to selected builtin
11548 functions.  If an invalid value is passed to such arguments, a run-time
11549 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11550 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11551 by this option.
11553 @end table
11555 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11556 @option{-fsanitize=undefined} gives a diagnostic message.
11557 This currently works only for the C family of languages.
11559 @item -fno-sanitize=all
11560 @opindex fno-sanitize=all
11562 This option disables all previously enabled sanitizers.
11563 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11564 together.
11566 @item -fasan-shadow-offset=@var{number}
11567 @opindex fasan-shadow-offset
11568 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11569 It is useful for experimenting with different shadow memory layouts in
11570 Kernel AddressSanitizer.
11572 @item -fsanitize-sections=@var{s1},@var{s2},...
11573 @opindex fsanitize-sections
11574 Sanitize global variables in selected user-defined sections.  @var{si} may
11575 contain wildcards.
11577 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11578 @opindex fsanitize-recover
11579 @opindex fno-sanitize-recover
11580 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11581 mentioned in comma-separated list of @var{opts}.  Enabling this option
11582 for a sanitizer component causes it to attempt to continue
11583 running the program as if no error happened.  This means multiple
11584 runtime errors can be reported in a single program run, and the exit
11585 code of the program may indicate success even when errors
11586 have been reported.  The @option{-fno-sanitize-recover=} option
11587 can be used to alter
11588 this behavior: only the first detected error is reported
11589 and program then exits with a non-zero exit code.
11591 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11592 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11593 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11594 @option{-fsanitize=bounds-strict},
11595 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11596 For these sanitizers error recovery is turned on by default,
11597 except @option{-fsanitize=address}, for which this feature is experimental.
11598 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11599 accepted, the former enables recovery for all sanitizers that support it,
11600 the latter disables recovery for all sanitizers that support it.
11602 Even if a recovery mode is turned on the compiler side, it needs to be also
11603 enabled on the runtime library side, otherwise the failures are still fatal.
11604 The runtime library defaults to @code{halt_on_error=0} for
11605 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11606 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11607 setting the @code{halt_on_error} flag in the corresponding environment variable.
11609 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11610 equivalent to specifying an @var{opts} list of:
11612 @smallexample
11613 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11614 @end smallexample
11616 @item -fsanitize-address-use-after-scope
11617 @opindex fsanitize-address-use-after-scope
11618 Enable sanitization of local variables to detect use-after-scope bugs.
11619 The option sets @option{-fstack-reuse} to @samp{none}.
11621 @item -fsanitize-undefined-trap-on-error
11622 @opindex fsanitize-undefined-trap-on-error
11623 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11624 report undefined behavior using @code{__builtin_trap} rather than
11625 a @code{libubsan} library routine.  The advantage of this is that the
11626 @code{libubsan} library is not needed and is not linked in, so this
11627 is usable even in freestanding environments.
11629 @item -fsanitize-coverage=trace-pc
11630 @opindex fsanitize-coverage=trace-pc
11631 Enable coverage-guided fuzzing code instrumentation.
11632 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11634 @item -fsanitize-coverage=trace-cmp
11635 @opindex fsanitize-coverage=trace-cmp
11636 Enable dataflow guided fuzzing code instrumentation.
11637 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11638 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11639 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11640 variable or @code{__sanitizer_cov_trace_const_cmp1},
11641 @code{__sanitizer_cov_trace_const_cmp2},
11642 @code{__sanitizer_cov_trace_const_cmp4} or
11643 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11644 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11645 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11646 @code{__sanitizer_cov_trace_switch} for switch statements.
11648 @item -fbounds-check
11649 @opindex fbounds-check
11650 For front ends that support it, generate additional code to check that
11651 indices used to access arrays are within the declared range.  This is
11652 currently only supported by the Fortran front end, where this option
11653 defaults to false.
11655 @item -fcheck-pointer-bounds
11656 @opindex fcheck-pointer-bounds
11657 @opindex fno-check-pointer-bounds
11658 @cindex Pointer Bounds Checker options
11659 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11660 is instrumented with checks of the pointer used for memory access against
11661 bounds associated with that pointer.  
11663 Currently there
11664 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11665 and @option{-mmpx} are required to enable this feature.  
11666 MPX-based instrumentation requires
11667 a runtime library to enable MPX in hardware and handle bounds
11668 violation signals.  By default when @option{-fcheck-pointer-bounds}
11669 and @option{-mmpx} options are used to link a program, the GCC driver
11670 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11671 Bounds checking on calls to dynamic libraries requires a linker
11672 with @option{-z bndplt} support; if GCC was configured with a linker
11673 without support for this option (including the Gold linker and older
11674 versions of ld), a warning is given if you link with @option{-mmpx}
11675 without also specifying @option{-static}, since the overall effectiveness
11676 of the bounds checking protection is reduced.
11677 See also @option{-static-libmpxwrappers}.
11679 MPX-based instrumentation
11680 may be used for debugging and also may be included in production code
11681 to increase program security.  Depending on usage, you may
11682 have different requirements for the runtime library.  The current version
11683 of the MPX runtime library is more oriented for use as a debugging
11684 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11685 also @option{-static-libmpx}.  The runtime library  behavior can be
11686 influenced using various @env{CHKP_RT_*} environment variables.  See
11687 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11688 for more details.
11690 Generated instrumentation may be controlled by various
11691 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11692 structure field attribute (@pxref{Type Attributes}) and
11693 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11694 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11695 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11696 Bounds Checker builtins}, for more information.
11698 @item -fchkp-check-incomplete-type
11699 @opindex fchkp-check-incomplete-type
11700 @opindex fno-chkp-check-incomplete-type
11701 Generate pointer bounds checks for variables with incomplete type.
11702 Enabled by default.
11704 @item -fchkp-narrow-bounds
11705 @opindex fchkp-narrow-bounds
11706 @opindex fno-chkp-narrow-bounds
11707 Controls bounds used by Pointer Bounds Checker for pointers to object
11708 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11709 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11710 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11712 @item -fchkp-first-field-has-own-bounds
11713 @opindex fchkp-first-field-has-own-bounds
11714 @opindex fno-chkp-first-field-has-own-bounds
11715 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11716 first field in the structure.  By default a pointer to the first field has
11717 the same bounds as a pointer to the whole structure.
11719 @item -fchkp-flexible-struct-trailing-arrays
11720 @opindex fchkp-flexible-struct-trailing-arrays
11721 @opindex fno-chkp-flexible-struct-trailing-arrays
11722 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11723 possibly flexible.  By default only array fields with zero length or that are
11724 marked with attribute bnd_variable_size are treated as flexible.
11726 @item -fchkp-narrow-to-innermost-array
11727 @opindex fchkp-narrow-to-innermost-array
11728 @opindex fno-chkp-narrow-to-innermost-array
11729 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11730 case of nested static array access.  By default this option is disabled and
11731 bounds of the outermost array are used.
11733 @item -fchkp-optimize
11734 @opindex fchkp-optimize
11735 @opindex fno-chkp-optimize
11736 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11737 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11739 @item -fchkp-use-fast-string-functions
11740 @opindex fchkp-use-fast-string-functions
11741 @opindex fno-chkp-use-fast-string-functions
11742 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11743 by Pointer Bounds Checker.  Disabled by default.
11745 @item -fchkp-use-nochk-string-functions
11746 @opindex fchkp-use-nochk-string-functions
11747 @opindex fno-chkp-use-nochk-string-functions
11748 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11749 by Pointer Bounds Checker.  Disabled by default.
11751 @item -fchkp-use-static-bounds
11752 @opindex fchkp-use-static-bounds
11753 @opindex fno-chkp-use-static-bounds
11754 Allow Pointer Bounds Checker to generate static bounds holding
11755 bounds of static variables.  Enabled by default.
11757 @item -fchkp-use-static-const-bounds
11758 @opindex fchkp-use-static-const-bounds
11759 @opindex fno-chkp-use-static-const-bounds
11760 Use statically-initialized bounds for constant bounds instead of
11761 generating them each time they are required.  By default enabled when
11762 @option{-fchkp-use-static-bounds} is enabled.
11764 @item -fchkp-treat-zero-dynamic-size-as-infinite
11765 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11766 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11767 With this option, objects with incomplete type whose
11768 dynamically-obtained size is zero are treated as having infinite size
11769 instead by Pointer Bounds
11770 Checker.  This option may be helpful if a program is linked with a library
11771 missing size information for some symbols.  Disabled by default.
11773 @item -fchkp-check-read
11774 @opindex fchkp-check-read
11775 @opindex fno-chkp-check-read
11776 Instructs Pointer Bounds Checker to generate checks for all read
11777 accesses to memory.  Enabled by default.
11779 @item -fchkp-check-write
11780 @opindex fchkp-check-write
11781 @opindex fno-chkp-check-write
11782 Instructs Pointer Bounds Checker to generate checks for all write
11783 accesses to memory.  Enabled by default.
11785 @item -fchkp-store-bounds
11786 @opindex fchkp-store-bounds
11787 @opindex fno-chkp-store-bounds
11788 Instructs Pointer Bounds Checker to generate bounds stores for
11789 pointer writes.  Enabled by default.
11791 @item -fchkp-instrument-calls
11792 @opindex fchkp-instrument-calls
11793 @opindex fno-chkp-instrument-calls
11794 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11795 Enabled by default.
11797 @item -fchkp-instrument-marked-only
11798 @opindex fchkp-instrument-marked-only
11799 @opindex fno-chkp-instrument-marked-only
11800 Instructs Pointer Bounds Checker to instrument only functions
11801 marked with the @code{bnd_instrument} attribute
11802 (@pxref{Function Attributes}).  Disabled by default.
11804 @item -fchkp-use-wrappers
11805 @opindex fchkp-use-wrappers
11806 @opindex fno-chkp-use-wrappers
11807 Allows Pointer Bounds Checker to replace calls to built-in functions
11808 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11809 is used to link a program, the GCC driver automatically links
11810 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11811 Enabled by default.
11813 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11814 @opindex fcf-protection
11815 Enable code instrumentation of control-flow transfers to increase
11816 program security by checking that target addresses of control-flow
11817 transfer instructions (such as indirect function call, function return,
11818 indirect jump) are valid.  This prevents diverting the flow of control
11819 to an unexpected target.  This is intended to protect against such
11820 threats as Return-oriented Programming (ROP), and similarly
11821 call/jmp-oriented programming (COP/JOP).
11823 The value @code{branch} tells the compiler to implement checking of
11824 validity of control-flow transfer at the point of indirect branch
11825 instructions, i.e. call/jmp instructions.  The value @code{return}
11826 implements checking of validity at the point of returning from a
11827 function.  The value @code{full} is an alias for specifying both
11828 @code{branch} and @code{return}. The value @code{none} turns off
11829 instrumentation.
11831 You can also use the @code{nocf_check} attribute to identify
11832 which functions and calls should be skipped from instrumentation
11833 (@pxref{Function Attributes}).
11835 Currently the x86 GNU/Linux target provides an implementation based
11836 on Intel Control-flow Enforcement Technology (CET).
11838 @item -fstack-protector
11839 @opindex fstack-protector
11840 Emit extra code to check for buffer overflows, such as stack smashing
11841 attacks.  This is done by adding a guard variable to functions with
11842 vulnerable objects.  This includes functions that call @code{alloca}, and
11843 functions with buffers larger than 8 bytes.  The guards are initialized
11844 when a function is entered and then checked when the function exits.
11845 If a guard check fails, an error message is printed and the program exits.
11847 @item -fstack-protector-all
11848 @opindex fstack-protector-all
11849 Like @option{-fstack-protector} except that all functions are protected.
11851 @item -fstack-protector-strong
11852 @opindex fstack-protector-strong
11853 Like @option{-fstack-protector} but includes additional functions to
11854 be protected --- those that have local array definitions, or have
11855 references to local frame addresses.
11857 @item -fstack-protector-explicit
11858 @opindex fstack-protector-explicit
11859 Like @option{-fstack-protector} but only protects those functions which
11860 have the @code{stack_protect} attribute.
11862 @item -fstack-check
11863 @opindex fstack-check
11864 Generate code to verify that you do not go beyond the boundary of the
11865 stack.  You should specify this flag if you are running in an
11866 environment with multiple threads, but you only rarely need to specify it in
11867 a single-threaded environment since stack overflow is automatically
11868 detected on nearly all systems if there is only one stack.
11870 Note that this switch does not actually cause checking to be done; the
11871 operating system or the language runtime must do that.  The switch causes
11872 generation of code to ensure that they see the stack being extended.
11874 You can additionally specify a string parameter: @samp{no} means no
11875 checking, @samp{generic} means force the use of old-style checking,
11876 @samp{specific} means use the best checking method and is equivalent
11877 to bare @option{-fstack-check}.
11879 Old-style checking is a generic mechanism that requires no specific
11880 target support in the compiler but comes with the following drawbacks:
11882 @enumerate
11883 @item
11884 Modified allocation strategy for large objects: they are always
11885 allocated dynamically if their size exceeds a fixed threshold.  Note this
11886 may change the semantics of some code.
11888 @item
11889 Fixed limit on the size of the static frame of functions: when it is
11890 topped by a particular function, stack checking is not reliable and
11891 a warning is issued by the compiler.
11893 @item
11894 Inefficiency: because of both the modified allocation strategy and the
11895 generic implementation, code performance is hampered.
11896 @end enumerate
11898 Note that old-style stack checking is also the fallback method for
11899 @samp{specific} if no target support has been added in the compiler.
11901 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11902 and stack overflows.  @samp{specific} is an excellent choice when compiling
11903 Ada code.  It is not generally sufficient to protect against stack-clash
11904 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11906 @item -fstack-clash-protection
11907 @opindex fstack-clash-protection
11908 Generate code to prevent stack clash style attacks.  When this option is
11909 enabled, the compiler will only allocate one page of stack space at a time
11910 and each page is accessed immediately after allocation.  Thus, it prevents
11911 allocations from jumping over any stack guard page provided by the
11912 operating system.
11914 Most targets do not fully support stack clash protection.  However, on
11915 those targets @option{-fstack-clash-protection} will protect dynamic stack
11916 allocations.  @option{-fstack-clash-protection} may also provide limited
11917 protection for static stack allocations if the target supports
11918 @option{-fstack-check=specific}.
11920 @item -fstack-limit-register=@var{reg}
11921 @itemx -fstack-limit-symbol=@var{sym}
11922 @itemx -fno-stack-limit
11923 @opindex fstack-limit-register
11924 @opindex fstack-limit-symbol
11925 @opindex fno-stack-limit
11926 Generate code to ensure that the stack does not grow beyond a certain value,
11927 either the value of a register or the address of a symbol.  If a larger
11928 stack is required, a signal is raised at run time.  For most targets,
11929 the signal is raised before the stack overruns the boundary, so
11930 it is possible to catch the signal without taking special precautions.
11932 For instance, if the stack starts at absolute address @samp{0x80000000}
11933 and grows downwards, you can use the flags
11934 @option{-fstack-limit-symbol=__stack_limit} and
11935 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11936 of 128KB@.  Note that this may only work with the GNU linker.
11938 You can locally override stack limit checking by using the
11939 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11941 @item -fsplit-stack
11942 @opindex fsplit-stack
11943 Generate code to automatically split the stack before it overflows.
11944 The resulting program has a discontiguous stack which can only
11945 overflow if the program is unable to allocate any more memory.  This
11946 is most useful when running threaded programs, as it is no longer
11947 necessary to calculate a good stack size to use for each thread.  This
11948 is currently only implemented for the x86 targets running
11949 GNU/Linux.
11951 When code compiled with @option{-fsplit-stack} calls code compiled
11952 without @option{-fsplit-stack}, there may not be much stack space
11953 available for the latter code to run.  If compiling all code,
11954 including library code, with @option{-fsplit-stack} is not an option,
11955 then the linker can fix up these calls so that the code compiled
11956 without @option{-fsplit-stack} always has a large stack.  Support for
11957 this is implemented in the gold linker in GNU binutils release 2.21
11958 and later.
11960 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11961 @opindex fvtable-verify
11962 This option is only available when compiling C++ code.
11963 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11964 feature that verifies at run time, for every virtual call, that
11965 the vtable pointer through which the call is made is valid for the type of
11966 the object, and has not been corrupted or overwritten.  If an invalid vtable
11967 pointer is detected at run time, an error is reported and execution of the
11968 program is immediately halted.
11970 This option causes run-time data structures to be built at program startup,
11971 which are used for verifying the vtable pointers.  
11972 The options @samp{std} and @samp{preinit}
11973 control the timing of when these data structures are built.  In both cases the
11974 data structures are built before execution reaches @code{main}.  Using
11975 @option{-fvtable-verify=std} causes the data structures to be built after
11976 shared libraries have been loaded and initialized.
11977 @option{-fvtable-verify=preinit} causes them to be built before shared
11978 libraries have been loaded and initialized.
11980 If this option appears multiple times in the command line with different
11981 values specified, @samp{none} takes highest priority over both @samp{std} and
11982 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11984 @item -fvtv-debug
11985 @opindex fvtv-debug
11986 When used in conjunction with @option{-fvtable-verify=std} or 
11987 @option{-fvtable-verify=preinit}, causes debug versions of the 
11988 runtime functions for the vtable verification feature to be called.  
11989 This flag also causes the compiler to log information about which 
11990 vtable pointers it finds for each class.
11991 This information is written to a file named @file{vtv_set_ptr_data.log} 
11992 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11993 if that is defined or the current working directory otherwise.
11995 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11996 file, be sure to delete any existing one.
11998 @item -fvtv-counts
11999 @opindex fvtv-counts
12000 This is a debugging flag.  When used in conjunction with
12001 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
12002 causes the compiler to keep track of the total number of virtual calls
12003 it encounters and the number of verifications it inserts.  It also
12004 counts the number of calls to certain run-time library functions
12005 that it inserts and logs this information for each compilation unit.
12006 The compiler writes this information to a file named
12007 @file{vtv_count_data.log} in the directory named by the environment
12008 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12009 directory otherwise.  It also counts the size of the vtable pointer sets
12010 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12011 in the same directory.
12013 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12014 files, be sure to delete any existing ones.
12016 @item -finstrument-functions
12017 @opindex finstrument-functions
12018 Generate instrumentation calls for entry and exit to functions.  Just
12019 after function entry and just before function exit, the following
12020 profiling functions are called with the address of the current
12021 function and its call site.  (On some platforms,
12022 @code{__builtin_return_address} does not work beyond the current
12023 function, so the call site information may not be available to the
12024 profiling functions otherwise.)
12026 @smallexample
12027 void __cyg_profile_func_enter (void *this_fn,
12028                                void *call_site);
12029 void __cyg_profile_func_exit  (void *this_fn,
12030                                void *call_site);
12031 @end smallexample
12033 The first argument is the address of the start of the current function,
12034 which may be looked up exactly in the symbol table.
12036 This instrumentation is also done for functions expanded inline in other
12037 functions.  The profiling calls indicate where, conceptually, the
12038 inline function is entered and exited.  This means that addressable
12039 versions of such functions must be available.  If all your uses of a
12040 function are expanded inline, this may mean an additional expansion of
12041 code size.  If you use @code{extern inline} in your C code, an
12042 addressable version of such functions must be provided.  (This is
12043 normally the case anyway, but if you get lucky and the optimizer always
12044 expands the functions inline, you might have gotten away without
12045 providing static copies.)
12047 A function may be given the attribute @code{no_instrument_function}, in
12048 which case this instrumentation is not done.  This can be used, for
12049 example, for the profiling functions listed above, high-priority
12050 interrupt routines, and any functions from which the profiling functions
12051 cannot safely be called (perhaps signal handlers, if the profiling
12052 routines generate output or allocate memory).
12054 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12055 @opindex finstrument-functions-exclude-file-list
12057 Set the list of functions that are excluded from instrumentation (see
12058 the description of @option{-finstrument-functions}).  If the file that
12059 contains a function definition matches with one of @var{file}, then
12060 that function is not instrumented.  The match is done on substrings:
12061 if the @var{file} parameter is a substring of the file name, it is
12062 considered to be a match.
12064 For example:
12066 @smallexample
12067 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12068 @end smallexample
12070 @noindent
12071 excludes any inline function defined in files whose pathnames
12072 contain @file{/bits/stl} or @file{include/sys}.
12074 If, for some reason, you want to include letter @samp{,} in one of
12075 @var{sym}, write @samp{\,}. For example,
12076 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12077 (note the single quote surrounding the option).
12079 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12080 @opindex finstrument-functions-exclude-function-list
12082 This is similar to @option{-finstrument-functions-exclude-file-list},
12083 but this option sets the list of function names to be excluded from
12084 instrumentation.  The function name to be matched is its user-visible
12085 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12086 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12087 match is done on substrings: if the @var{sym} parameter is a substring
12088 of the function name, it is considered to be a match.  For C99 and C++
12089 extended identifiers, the function name must be given in UTF-8, not
12090 using universal character names.
12092 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12093 @opindex fpatchable-function-entry
12094 Generate @var{N} NOPs right at the beginning
12095 of each function, with the function entry point before the @var{M}th NOP.
12096 If @var{M} is omitted, it defaults to @code{0} so the
12097 function entry points to the address just at the first NOP.
12098 The NOP instructions reserve extra space which can be used to patch in
12099 any desired instrumentation at run time, provided that the code segment
12100 is writable.  The amount of space is controllable indirectly via
12101 the number of NOPs; the NOP instruction used corresponds to the instruction
12102 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12103 is target-specific and may also depend on the architecture variant and/or
12104 other compilation options.
12106 For run-time identification, the starting addresses of these areas,
12107 which correspond to their respective function entries minus @var{M},
12108 are additionally collected in the @code{__patchable_function_entries}
12109 section of the resulting binary.
12111 Note that the value of @code{__attribute__ ((patchable_function_entry
12112 (N,M)))} takes precedence over command-line option
12113 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12114 the area size or to remove it completely on a single function.
12115 If @code{N=0}, no pad location is recorded.
12117 The NOP instructions are inserted at---and maybe before, depending on
12118 @var{M}---the function entry address, even before the prologue.
12120 @end table
12123 @node Preprocessor Options
12124 @section Options Controlling the Preprocessor
12125 @cindex preprocessor options
12126 @cindex options, preprocessor
12128 These options control the C preprocessor, which is run on each C source
12129 file before actual compilation.
12131 If you use the @option{-E} option, nothing is done except preprocessing.
12132 Some of these options make sense only together with @option{-E} because
12133 they cause the preprocessor output to be unsuitable for actual
12134 compilation.
12136 In addition to the options listed here, there are a number of options 
12137 to control search paths for include files documented in 
12138 @ref{Directory Options}.  
12139 Options to control preprocessor diagnostics are listed in 
12140 @ref{Warning Options}.
12142 @table @gcctabopt
12143 @include cppopts.texi
12145 @item -Wp,@var{option}
12146 @opindex Wp
12147 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12148 and pass @var{option} directly through to the preprocessor.  If
12149 @var{option} contains commas, it is split into multiple options at the
12150 commas.  However, many options are modified, translated or interpreted
12151 by the compiler driver before being passed to the preprocessor, and
12152 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12153 interface is undocumented and subject to change, so whenever possible
12154 you should avoid using @option{-Wp} and let the driver handle the
12155 options instead.
12157 @item -Xpreprocessor @var{option}
12158 @opindex Xpreprocessor
12159 Pass @var{option} as an option to the preprocessor.  You can use this to
12160 supply system-specific preprocessor options that GCC does not 
12161 recognize.
12163 If you want to pass an option that takes an argument, you must use
12164 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12166 @item -no-integrated-cpp
12167 @opindex no-integrated-cpp
12168 Perform preprocessing as a separate pass before compilation.
12169 By default, GCC performs preprocessing as an integrated part of
12170 input tokenization and parsing.
12171 If this option is provided, the appropriate language front end
12172 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12173 and Objective-C, respectively) is instead invoked twice,
12174 once for preprocessing only and once for actual compilation
12175 of the preprocessed input.
12176 This option may be useful in conjunction with the @option{-B} or
12177 @option{-wrapper} options to specify an alternate preprocessor or
12178 perform additional processing of the program source between
12179 normal preprocessing and compilation.
12181 @end table
12183 @node Assembler Options
12184 @section Passing Options to the Assembler
12186 @c prevent bad page break with this line
12187 You can pass options to the assembler.
12189 @table @gcctabopt
12190 @item -Wa,@var{option}
12191 @opindex Wa
12192 Pass @var{option} as an option to the assembler.  If @var{option}
12193 contains commas, it is split into multiple options at the commas.
12195 @item -Xassembler @var{option}
12196 @opindex Xassembler
12197 Pass @var{option} as an option to the assembler.  You can use this to
12198 supply system-specific assembler options that GCC does not
12199 recognize.
12201 If you want to pass an option that takes an argument, you must use
12202 @option{-Xassembler} twice, once for the option and once for the argument.
12204 @end table
12206 @node Link Options
12207 @section Options for Linking
12208 @cindex link options
12209 @cindex options, linking
12211 These options come into play when the compiler links object files into
12212 an executable output file.  They are meaningless if the compiler is
12213 not doing a link step.
12215 @table @gcctabopt
12216 @cindex file names
12217 @item @var{object-file-name}
12218 A file name that does not end in a special recognized suffix is
12219 considered to name an object file or library.  (Object files are
12220 distinguished from libraries by the linker according to the file
12221 contents.)  If linking is done, these object files are used as input
12222 to the linker.
12224 @item -c
12225 @itemx -S
12226 @itemx -E
12227 @opindex c
12228 @opindex S
12229 @opindex E
12230 If any of these options is used, then the linker is not run, and
12231 object file names should not be used as arguments.  @xref{Overall
12232 Options}.
12234 @item -fuse-ld=bfd
12235 @opindex fuse-ld=bfd
12236 Use the @command{bfd} linker instead of the default linker.
12238 @item -fuse-ld=gold
12239 @opindex fuse-ld=gold
12240 Use the @command{gold} linker instead of the default linker.
12242 @cindex Libraries
12243 @item -l@var{library}
12244 @itemx -l @var{library}
12245 @opindex l
12246 Search the library named @var{library} when linking.  (The second
12247 alternative with the library as a separate argument is only for
12248 POSIX compliance and is not recommended.)
12250 It makes a difference where in the command you write this option; the
12251 linker searches and processes libraries and object files in the order they
12252 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12253 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12254 to functions in @samp{z}, those functions may not be loaded.
12256 The linker searches a standard list of directories for the library,
12257 which is actually a file named @file{lib@var{library}.a}.  The linker
12258 then uses this file as if it had been specified precisely by name.
12260 The directories searched include several standard system directories
12261 plus any that you specify with @option{-L}.
12263 Normally the files found this way are library files---archive files
12264 whose members are object files.  The linker handles an archive file by
12265 scanning through it for members which define symbols that have so far
12266 been referenced but not defined.  But if the file that is found is an
12267 ordinary object file, it is linked in the usual fashion.  The only
12268 difference between using an @option{-l} option and specifying a file name
12269 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12270 and searches several directories.
12272 @item -lobjc
12273 @opindex lobjc
12274 You need this special case of the @option{-l} option in order to
12275 link an Objective-C or Objective-C++ program.
12277 @item -nostartfiles
12278 @opindex nostartfiles
12279 Do not use the standard system startup files when linking.
12280 The standard system libraries are used normally, unless @option{-nostdlib}
12281 or @option{-nodefaultlibs} is used.
12283 @item -nodefaultlibs
12284 @opindex nodefaultlibs
12285 Do not use the standard system libraries when linking.
12286 Only the libraries you specify are passed to the linker, and options
12287 specifying linkage of the system libraries, such as @option{-static-libgcc}
12288 or @option{-shared-libgcc}, are ignored.  
12289 The standard startup files are used normally, unless @option{-nostartfiles}
12290 is used.  
12292 The compiler may generate calls to @code{memcmp},
12293 @code{memset}, @code{memcpy} and @code{memmove}.
12294 These entries are usually resolved by entries in
12295 libc.  These entry points should be supplied through some other
12296 mechanism when this option is specified.
12298 @item -nostdlib
12299 @opindex nostdlib
12300 Do not use the standard system startup files or libraries when linking.
12301 No startup files and only the libraries you specify are passed to
12302 the linker, and options specifying linkage of the system libraries, such as
12303 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12305 The compiler may generate calls to @code{memcmp}, @code{memset},
12306 @code{memcpy} and @code{memmove}.
12307 These entries are usually resolved by entries in
12308 libc.  These entry points should be supplied through some other
12309 mechanism when this option is specified.
12311 @cindex @option{-lgcc}, use with @option{-nostdlib}
12312 @cindex @option{-nostdlib} and unresolved references
12313 @cindex unresolved references and @option{-nostdlib}
12314 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12315 @cindex @option{-nodefaultlibs} and unresolved references
12316 @cindex unresolved references and @option{-nodefaultlibs}
12317 One of the standard libraries bypassed by @option{-nostdlib} and
12318 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12319 which GCC uses to overcome shortcomings of particular machines, or special
12320 needs for some languages.
12321 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12322 Collection (GCC) Internals},
12323 for more discussion of @file{libgcc.a}.)
12324 In most cases, you need @file{libgcc.a} even when you want to avoid
12325 other standard libraries.  In other words, when you specify @option{-nostdlib}
12326 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12327 This ensures that you have no unresolved references to internal GCC
12328 library subroutines.
12329 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12330 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12331 GNU Compiler Collection (GCC) Internals}.)
12333 @item -pie
12334 @opindex pie
12335 Produce a dynamically linked position independent executable on targets
12336 that support it.  For predictable results, you must also specify the same
12337 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12338 or model suboptions) when you specify this linker option.
12340 @item -no-pie
12341 @opindex no-pie
12342 Don't produce a dynamically linked position independent executable.
12344 @item -static-pie
12345 @opindex static-pie
12346 Produce a static position independent executable on targets that support
12347 it.  A static position independent executable is similar to a static
12348 executable, but can be loaded at any address without a dynamic linker.
12349 For predictable results, you must also specify the same set of options
12350 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12351 suboptions) when you specify this linker option.
12353 @item -pthread
12354 @opindex pthread
12355 Link with the POSIX threads library.  This option is supported on 
12356 GNU/Linux targets, most other Unix derivatives, and also on 
12357 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12358 flags for the preprocessor, so it should be used consistently for both
12359 compilation and linking.
12361 @item -rdynamic
12362 @opindex rdynamic
12363 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12364 that support it. This instructs the linker to add all symbols, not
12365 only used ones, to the dynamic symbol table. This option is needed
12366 for some uses of @code{dlopen} or to allow obtaining backtraces
12367 from within a program.
12369 @item -s
12370 @opindex s
12371 Remove all symbol table and relocation information from the executable.
12373 @item -static
12374 @opindex static
12375 On systems that support dynamic linking, this overrides @option{-pie}
12376 and prevents linking with the shared libraries.  On other systems, this
12377 option has no effect.
12379 @item -shared
12380 @opindex shared
12381 Produce a shared object which can then be linked with other objects to
12382 form an executable.  Not all systems support this option.  For predictable
12383 results, you must also specify the same set of options used for compilation
12384 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12385 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12386 needs to build supplementary stub code for constructors to work.  On
12387 multi-libbed systems, @samp{gcc -shared} must select the correct support
12388 libraries to link against.  Failing to supply the correct flags may lead
12389 to subtle defects.  Supplying them in cases where they are not necessary
12390 is innocuous.}
12392 @item -shared-libgcc
12393 @itemx -static-libgcc
12394 @opindex shared-libgcc
12395 @opindex static-libgcc
12396 On systems that provide @file{libgcc} as a shared library, these options
12397 force the use of either the shared or static version, respectively.
12398 If no shared version of @file{libgcc} was built when the compiler was
12399 configured, these options have no effect.
12401 There are several situations in which an application should use the
12402 shared @file{libgcc} instead of the static version.  The most common
12403 of these is when the application wishes to throw and catch exceptions
12404 across different shared libraries.  In that case, each of the libraries
12405 as well as the application itself should use the shared @file{libgcc}.
12407 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12408  whenever you build a shared library or a main executable, because C++
12409  programs typically use exceptions, so this is the right thing to do.
12411 If, instead, you use the GCC driver to create shared libraries, you may
12412 find that they are not always linked with the shared @file{libgcc}.
12413 If GCC finds, at its configuration time, that you have a non-GNU linker
12414 or a GNU linker that does not support option @option{--eh-frame-hdr},
12415 it links the shared version of @file{libgcc} into shared libraries
12416 by default.  Otherwise, it takes advantage of the linker and optimizes
12417 away the linking with the shared version of @file{libgcc}, linking with
12418 the static version of libgcc by default.  This allows exceptions to
12419 propagate through such shared libraries, without incurring relocation
12420 costs at library load time.
12422 However, if a library or main executable is supposed to throw or catch
12423 exceptions, you must link it using the G++ driver, as appropriate
12424 for the languages used in the program, or using the option
12425 @option{-shared-libgcc}, such that it is linked with the shared
12426 @file{libgcc}.
12428 @item -static-libasan
12429 @opindex static-libasan
12430 When the @option{-fsanitize=address} option is used to link a program,
12431 the GCC driver automatically links against @option{libasan}.  If
12432 @file{libasan} is available as a shared library, and the @option{-static}
12433 option is not used, then this links against the shared version of
12434 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12435 driver to link @file{libasan} statically, without necessarily linking
12436 other libraries statically.
12438 @item -static-libtsan
12439 @opindex static-libtsan
12440 When the @option{-fsanitize=thread} option is used to link a program,
12441 the GCC driver automatically links against @option{libtsan}.  If
12442 @file{libtsan} is available as a shared library, and the @option{-static}
12443 option is not used, then this links against the shared version of
12444 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12445 driver to link @file{libtsan} statically, without necessarily linking
12446 other libraries statically.
12448 @item -static-liblsan
12449 @opindex static-liblsan
12450 When the @option{-fsanitize=leak} option is used to link a program,
12451 the GCC driver automatically links against @option{liblsan}.  If
12452 @file{liblsan} is available as a shared library, and the @option{-static}
12453 option is not used, then this links against the shared version of
12454 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12455 driver to link @file{liblsan} statically, without necessarily linking
12456 other libraries statically.
12458 @item -static-libubsan
12459 @opindex static-libubsan
12460 When the @option{-fsanitize=undefined} option is used to link a program,
12461 the GCC driver automatically links against @option{libubsan}.  If
12462 @file{libubsan} is available as a shared library, and the @option{-static}
12463 option is not used, then this links against the shared version of
12464 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12465 driver to link @file{libubsan} statically, without necessarily linking
12466 other libraries statically.
12468 @item -static-libmpx
12469 @opindex static-libmpx
12470 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12471 used to link a program, the GCC driver automatically links against
12472 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12473 and the @option{-static} option is not used, then this links against
12474 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12475 option directs the GCC driver to link @file{libmpx} statically,
12476 without necessarily linking other libraries statically.
12478 @item -static-libmpxwrappers
12479 @opindex static-libmpxwrappers
12480 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12481 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12482 GCC driver automatically links against @file{libmpxwrappers}.  If
12483 @file{libmpxwrappers} is available as a shared library, and the
12484 @option{-static} option is not used, then this links against the shared
12485 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12486 option directs the GCC driver to link @file{libmpxwrappers} statically,
12487 without necessarily linking other libraries statically.
12489 @item -static-libstdc++
12490 @opindex static-libstdc++
12491 When the @command{g++} program is used to link a C++ program, it
12492 normally automatically links against @option{libstdc++}.  If
12493 @file{libstdc++} is available as a shared library, and the
12494 @option{-static} option is not used, then this links against the
12495 shared version of @file{libstdc++}.  That is normally fine.  However, it
12496 is sometimes useful to freeze the version of @file{libstdc++} used by
12497 the program without going all the way to a fully static link.  The
12498 @option{-static-libstdc++} option directs the @command{g++} driver to
12499 link @file{libstdc++} statically, without necessarily linking other
12500 libraries statically.
12502 @item -symbolic
12503 @opindex symbolic
12504 Bind references to global symbols when building a shared object.  Warn
12505 about any unresolved references (unless overridden by the link editor
12506 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12507 this option.
12509 @item -T @var{script}
12510 @opindex T
12511 @cindex linker script
12512 Use @var{script} as the linker script.  This option is supported by most
12513 systems using the GNU linker.  On some targets, such as bare-board
12514 targets without an operating system, the @option{-T} option may be required
12515 when linking to avoid references to undefined symbols.
12517 @item -Xlinker @var{option}
12518 @opindex Xlinker
12519 Pass @var{option} as an option to the linker.  You can use this to
12520 supply system-specific linker options that GCC does not recognize.
12522 If you want to pass an option that takes a separate argument, you must use
12523 @option{-Xlinker} twice, once for the option and once for the argument.
12524 For example, to pass @option{-assert definitions}, you must write
12525 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12526 @option{-Xlinker "-assert definitions"}, because this passes the entire
12527 string as a single argument, which is not what the linker expects.
12529 When using the GNU linker, it is usually more convenient to pass
12530 arguments to linker options using the @option{@var{option}=@var{value}}
12531 syntax than as separate arguments.  For example, you can specify
12532 @option{-Xlinker -Map=output.map} rather than
12533 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12534 this syntax for command-line options.
12536 @item -Wl,@var{option}
12537 @opindex Wl
12538 Pass @var{option} as an option to the linker.  If @var{option} contains
12539 commas, it is split into multiple options at the commas.  You can use this
12540 syntax to pass an argument to the option.
12541 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12542 linker.  When using the GNU linker, you can also get the same effect with
12543 @option{-Wl,-Map=output.map}.
12545 @item -u @var{symbol}
12546 @opindex u
12547 Pretend the symbol @var{symbol} is undefined, to force linking of
12548 library modules to define it.  You can use @option{-u} multiple times with
12549 different symbols to force loading of additional library modules.
12551 @item -z @var{keyword}
12552 @opindex z
12553 @option{-z} is passed directly on to the linker along with the keyword
12554 @var{keyword}. See the section in the documentation of your linker for
12555 permitted values and their meanings.
12556 @end table
12558 @node Directory Options
12559 @section Options for Directory Search
12560 @cindex directory options
12561 @cindex options, directory search
12562 @cindex search path
12564 These options specify directories to search for header files, for
12565 libraries and for parts of the compiler:
12567 @table @gcctabopt
12568 @include cppdiropts.texi
12570 @item -iplugindir=@var{dir}
12571 @opindex iplugindir=
12572 Set the directory to search for plugins that are passed
12573 by @option{-fplugin=@var{name}} instead of
12574 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12575 to be used by the user, but only passed by the driver.
12577 @item -L@var{dir}
12578 @opindex L
12579 Add directory @var{dir} to the list of directories to be searched
12580 for @option{-l}.
12582 @item -B@var{prefix}
12583 @opindex B
12584 This option specifies where to find the executables, libraries,
12585 include files, and data files of the compiler itself.
12587 The compiler driver program runs one or more of the subprograms
12588 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12589 @var{prefix} as a prefix for each program it tries to run, both with and
12590 without @samp{@var{machine}/@var{version}/} for the corresponding target
12591 machine and compiler version.
12593 For each subprogram to be run, the compiler driver first tries the
12594 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12595 is not specified, the driver tries two standard prefixes, 
12596 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12597 those results in a file name that is found, the unmodified program
12598 name is searched for using the directories specified in your
12599 @env{PATH} environment variable.
12601 The compiler checks to see if the path provided by @option{-B}
12602 refers to a directory, and if necessary it adds a directory
12603 separator character at the end of the path.
12605 @option{-B} prefixes that effectively specify directory names also apply
12606 to libraries in the linker, because the compiler translates these
12607 options into @option{-L} options for the linker.  They also apply to
12608 include files in the preprocessor, because the compiler translates these
12609 options into @option{-isystem} options for the preprocessor.  In this case,
12610 the compiler appends @samp{include} to the prefix.
12612 The runtime support file @file{libgcc.a} can also be searched for using
12613 the @option{-B} prefix, if needed.  If it is not found there, the two
12614 standard prefixes above are tried, and that is all.  The file is left
12615 out of the link if it is not found by those means.
12617 Another way to specify a prefix much like the @option{-B} prefix is to use
12618 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12619 Variables}.
12621 As a special kludge, if the path provided by @option{-B} is
12622 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12623 9, then it is replaced by @file{[dir/]include}.  This is to help
12624 with boot-strapping the compiler.
12626 @item -no-canonical-prefixes
12627 @opindex no-canonical-prefixes
12628 Do not expand any symbolic links, resolve references to @samp{/../}
12629 or @samp{/./}, or make the path absolute when generating a relative
12630 prefix.
12632 @item --sysroot=@var{dir}
12633 @opindex sysroot
12634 Use @var{dir} as the logical root directory for headers and libraries.
12635 For example, if the compiler normally searches for headers in
12636 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12637 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12639 If you use both this option and the @option{-isysroot} option, then
12640 the @option{--sysroot} option applies to libraries, but the
12641 @option{-isysroot} option applies to header files.
12643 The GNU linker (beginning with version 2.16) has the necessary support
12644 for this option.  If your linker does not support this option, the
12645 header file aspect of @option{--sysroot} still works, but the
12646 library aspect does not.
12648 @item --no-sysroot-suffix
12649 @opindex no-sysroot-suffix
12650 For some targets, a suffix is added to the root directory specified
12651 with @option{--sysroot}, depending on the other options used, so that
12652 headers may for example be found in
12653 @file{@var{dir}/@var{suffix}/usr/include} instead of
12654 @file{@var{dir}/usr/include}.  This option disables the addition of
12655 such a suffix.
12657 @end table
12659 @node Code Gen Options
12660 @section Options for Code Generation Conventions
12661 @cindex code generation conventions
12662 @cindex options, code generation
12663 @cindex run-time options
12665 These machine-independent options control the interface conventions
12666 used in code generation.
12668 Most of them have both positive and negative forms; the negative form
12669 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12670 one of the forms is listed---the one that is not the default.  You
12671 can figure out the other form by either removing @samp{no-} or adding
12674 @table @gcctabopt
12675 @item -fstack-reuse=@var{reuse-level}
12676 @opindex fstack_reuse
12677 This option controls stack space reuse for user declared local/auto variables
12678 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12679 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12680 local variables and temporaries, @samp{named_vars} enables the reuse only for
12681 user defined local variables with names, and @samp{none} disables stack reuse
12682 completely. The default value is @samp{all}. The option is needed when the
12683 program extends the lifetime of a scoped local variable or a compiler generated
12684 temporary beyond the end point defined by the language.  When a lifetime of
12685 a variable ends, and if the variable lives in memory, the optimizing compiler
12686 has the freedom to reuse its stack space with other temporaries or scoped
12687 local variables whose live range does not overlap with it. Legacy code extending
12688 local lifetime is likely to break with the stack reuse optimization.
12690 For example,
12692 @smallexample
12693    int *p;
12694    @{
12695      int local1;
12697      p = &local1;
12698      local1 = 10;
12699      ....
12700    @}
12701    @{
12702       int local2;
12703       local2 = 20;
12704       ...
12705    @}
12707    if (*p == 10)  // out of scope use of local1
12708      @{
12710      @}
12711 @end smallexample
12713 Another example:
12714 @smallexample
12716    struct A
12717    @{
12718        A(int k) : i(k), j(k) @{ @}
12719        int i;
12720        int j;
12721    @};
12723    A *ap;
12725    void foo(const A& ar)
12726    @{
12727       ap = &ar;
12728    @}
12730    void bar()
12731    @{
12732       foo(A(10)); // temp object's lifetime ends when foo returns
12734       @{
12735         A a(20);
12736         ....
12737       @}
12738       ap->i+= 10;  // ap references out of scope temp whose space
12739                    // is reused with a. What is the value of ap->i?
12740    @}
12742 @end smallexample
12744 The lifetime of a compiler generated temporary is well defined by the C++
12745 standard. When a lifetime of a temporary ends, and if the temporary lives
12746 in memory, the optimizing compiler has the freedom to reuse its stack
12747 space with other temporaries or scoped local variables whose live range
12748 does not overlap with it. However some of the legacy code relies on
12749 the behavior of older compilers in which temporaries' stack space is
12750 not reused, the aggressive stack reuse can lead to runtime errors. This
12751 option is used to control the temporary stack reuse optimization.
12753 @item -ftrapv
12754 @opindex ftrapv
12755 This option generates traps for signed overflow on addition, subtraction,
12756 multiplication operations.
12757 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12758 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12759 @option{-fwrapv} being effective.  Note that only active options override, so
12760 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12761 results in @option{-ftrapv} being effective.
12763 @item -fwrapv
12764 @opindex fwrapv
12765 This option instructs the compiler to assume that signed arithmetic
12766 overflow of addition, subtraction and multiplication wraps around
12767 using twos-complement representation.  This flag enables some optimizations
12768 and disables others.
12769 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12770 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12771 @option{-fwrapv} being effective.  Note that only active options override, so
12772 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12773 results in @option{-ftrapv} being effective.
12775 @item -fwrapv-pointer
12776 @opindex fwrapv-pointer
12777 This option instructs the compiler to assume that pointer arithmetic
12778 overflow on addition and subtraction wraps around using twos-complement
12779 representation.  This flag disables some optimizations which assume
12780 pointer overflow is invalid.
12782 @item -fstrict-overflow
12783 @opindex fstrict-overflow
12784 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12785 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12787 @item -fexceptions
12788 @opindex fexceptions
12789 Enable exception handling.  Generates extra code needed to propagate
12790 exceptions.  For some targets, this implies GCC generates frame
12791 unwind information for all functions, which can produce significant data
12792 size overhead, although it does not affect execution.  If you do not
12793 specify this option, GCC enables it by default for languages like
12794 C++ that normally require exception handling, and disables it for
12795 languages like C that do not normally require it.  However, you may need
12796 to enable this option when compiling C code that needs to interoperate
12797 properly with exception handlers written in C++.  You may also wish to
12798 disable this option if you are compiling older C++ programs that don't
12799 use exception handling.
12801 @item -fnon-call-exceptions
12802 @opindex fnon-call-exceptions
12803 Generate code that allows trapping instructions to throw exceptions.
12804 Note that this requires platform-specific runtime support that does
12805 not exist everywhere.  Moreover, it only allows @emph{trapping}
12806 instructions to throw exceptions, i.e.@: memory references or floating-point
12807 instructions.  It does not allow exceptions to be thrown from
12808 arbitrary signal handlers such as @code{SIGALRM}.
12810 @item -fdelete-dead-exceptions
12811 @opindex fdelete-dead-exceptions
12812 Consider that instructions that may throw exceptions but don't otherwise
12813 contribute to the execution of the program can be optimized away.
12814 This option is enabled by default for the Ada front end, as permitted by
12815 the Ada language specification.
12816 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12818 @item -funwind-tables
12819 @opindex funwind-tables
12820 Similar to @option{-fexceptions}, except that it just generates any needed
12821 static data, but does not affect the generated code in any other way.
12822 You normally do not need to enable this option; instead, a language processor
12823 that needs this handling enables it on your behalf.
12825 @item -fasynchronous-unwind-tables
12826 @opindex fasynchronous-unwind-tables
12827 Generate unwind table in DWARF format, if supported by target machine.  The
12828 table is exact at each instruction boundary, so it can be used for stack
12829 unwinding from asynchronous events (such as debugger or garbage collector).
12831 @item -fno-gnu-unique
12832 @opindex fno-gnu-unique
12833 On systems with recent GNU assembler and C library, the C++ compiler
12834 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12835 of template static data members and static local variables in inline
12836 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12837 is necessary to avoid problems with a library used by two different
12838 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12839 therefore disagreeing with the other one about the binding of the
12840 symbol.  But this causes @code{dlclose} to be ignored for affected
12841 DSOs; if your program relies on reinitialization of a DSO via
12842 @code{dlclose} and @code{dlopen}, you can use
12843 @option{-fno-gnu-unique}.
12845 @item -fpcc-struct-return
12846 @opindex fpcc-struct-return
12847 Return ``short'' @code{struct} and @code{union} values in memory like
12848 longer ones, rather than in registers.  This convention is less
12849 efficient, but it has the advantage of allowing intercallability between
12850 GCC-compiled files and files compiled with other compilers, particularly
12851 the Portable C Compiler (pcc).
12853 The precise convention for returning structures in memory depends
12854 on the target configuration macros.
12856 Short structures and unions are those whose size and alignment match
12857 that of some integer type.
12859 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12860 switch is not binary compatible with code compiled with the
12861 @option{-freg-struct-return} switch.
12862 Use it to conform to a non-default application binary interface.
12864 @item -freg-struct-return
12865 @opindex freg-struct-return
12866 Return @code{struct} and @code{union} values in registers when possible.
12867 This is more efficient for small structures than
12868 @option{-fpcc-struct-return}.
12870 If you specify neither @option{-fpcc-struct-return} nor
12871 @option{-freg-struct-return}, GCC defaults to whichever convention is
12872 standard for the target.  If there is no standard convention, GCC
12873 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12874 the principal compiler.  In those cases, we can choose the standard, and
12875 we chose the more efficient register return alternative.
12877 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12878 switch is not binary compatible with code compiled with the
12879 @option{-fpcc-struct-return} switch.
12880 Use it to conform to a non-default application binary interface.
12882 @item -fshort-enums
12883 @opindex fshort-enums
12884 Allocate to an @code{enum} type only as many bytes as it needs for the
12885 declared range of possible values.  Specifically, the @code{enum} type
12886 is equivalent to the smallest integer type that has enough room.
12888 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12889 code that is not binary compatible with code generated without that switch.
12890 Use it to conform to a non-default application binary interface.
12892 @item -fshort-wchar
12893 @opindex fshort-wchar
12894 Override the underlying type for @code{wchar_t} to be @code{short
12895 unsigned int} instead of the default for the target.  This option is
12896 useful for building programs to run under WINE@.
12898 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12899 code that is not binary compatible with code generated without that switch.
12900 Use it to conform to a non-default application binary interface.
12902 @item -fno-common
12903 @opindex fno-common
12904 @cindex tentative definitions
12905 In C code, this option controls the placement of global variables 
12906 defined without an initializer, known as @dfn{tentative definitions} 
12907 in the C standard.  Tentative definitions are distinct from declarations 
12908 of a variable with the @code{extern} keyword, which do not allocate storage.
12910 Unix C compilers have traditionally allocated storage for
12911 uninitialized global variables in a common block.  This allows the
12912 linker to resolve all tentative definitions of the same variable
12913 in different compilation units to the same object, or to a non-tentative
12914 definition.  
12915 This is the behavior specified by @option{-fcommon}, and is the default for 
12916 GCC on most targets.  
12917 On the other hand, this behavior is not required by ISO
12918 C, and on some targets may carry a speed or code size penalty on
12919 variable references.
12921 The @option{-fno-common} option specifies that the compiler should instead
12922 place uninitialized global variables in the data section of the object file.
12923 This inhibits the merging of tentative definitions by the linker so
12924 you get a multiple-definition error if the same 
12925 variable is defined in more than one compilation unit.
12926 Compiling with @option{-fno-common} is useful on targets for which
12927 it provides better performance, or if you wish to verify that the
12928 program will work on other systems that always treat uninitialized
12929 variable definitions this way.
12931 @item -fno-ident
12932 @opindex fno-ident
12933 Ignore the @code{#ident} directive.
12935 @item -finhibit-size-directive
12936 @opindex finhibit-size-directive
12937 Don't output a @code{.size} assembler directive, or anything else that
12938 would cause trouble if the function is split in the middle, and the
12939 two halves are placed at locations far apart in memory.  This option is
12940 used when compiling @file{crtstuff.c}; you should not need to use it
12941 for anything else.
12943 @item -fverbose-asm
12944 @opindex fverbose-asm
12945 Put extra commentary information in the generated assembly code to
12946 make it more readable.  This option is generally only of use to those
12947 who actually need to read the generated assembly code (perhaps while
12948 debugging the compiler itself).
12950 @option{-fno-verbose-asm}, the default, causes the
12951 extra information to be omitted and is useful when comparing two assembler
12952 files.
12954 The added comments include:
12956 @itemize @bullet
12958 @item
12959 information on the compiler version and command-line options,
12961 @item
12962 the source code lines associated with the assembly instructions,
12963 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12965 @item
12966 hints on which high-level expressions correspond to
12967 the various assembly instruction operands.
12969 @end itemize
12971 For example, given this C source file:
12973 @smallexample
12974 int test (int n)
12976   int i;
12977   int total = 0;
12979   for (i = 0; i < n; i++)
12980     total += i * i;
12982   return total;
12984 @end smallexample
12986 compiling to (x86_64) assembly via @option{-S} and emitting the result
12987 direct to stdout via @option{-o} @option{-}
12989 @smallexample
12990 gcc -S test.c -fverbose-asm -Os -o -
12991 @end smallexample
12993 gives output similar to this:
12995 @smallexample
12996         .file   "test.c"
12997 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12998   [...snip...]
12999 # options passed:
13000   [...snip...]
13002         .text
13003         .globl  test
13004         .type   test, @@function
13005 test:
13006 .LFB0:
13007         .cfi_startproc
13008 # test.c:4:   int total = 0;
13009         xorl    %eax, %eax      # <retval>
13010 # test.c:6:   for (i = 0; i < n; i++)
13011         xorl    %edx, %edx      # i
13012 .L2:
13013 # test.c:6:   for (i = 0; i < n; i++)
13014         cmpl    %edi, %edx      # n, i
13015         jge     .L5     #,
13016 # test.c:7:     total += i * i;
13017         movl    %edx, %ecx      # i, tmp92
13018         imull   %edx, %ecx      # i, tmp92
13019 # test.c:6:   for (i = 0; i < n; i++)
13020         incl    %edx    # i
13021 # test.c:7:     total += i * i;
13022         addl    %ecx, %eax      # tmp92, <retval>
13023         jmp     .L2     #
13024 .L5:
13025 # test.c:10: @}
13026         ret
13027         .cfi_endproc
13028 .LFE0:
13029         .size   test, .-test
13030         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13031         .section        .note.GNU-stack,"",@@progbits
13032 @end smallexample
13034 The comments are intended for humans rather than machines and hence the
13035 precise format of the comments is subject to change.
13037 @item -frecord-gcc-switches
13038 @opindex frecord-gcc-switches
13039 This switch causes the command line used to invoke the
13040 compiler to be recorded into the object file that is being created.
13041 This switch is only implemented on some targets and the exact format
13042 of the recording is target and binary file format dependent, but it
13043 usually takes the form of a section containing ASCII text.  This
13044 switch is related to the @option{-fverbose-asm} switch, but that
13045 switch only records information in the assembler output file as
13046 comments, so it never reaches the object file.
13047 See also @option{-grecord-gcc-switches} for another
13048 way of storing compiler options into the object file.
13050 @item -fpic
13051 @opindex fpic
13052 @cindex global offset table
13053 @cindex PIC
13054 Generate position-independent code (PIC) suitable for use in a shared
13055 library, if supported for the target machine.  Such code accesses all
13056 constant addresses through a global offset table (GOT)@.  The dynamic
13057 loader resolves the GOT entries when the program starts (the dynamic
13058 loader is not part of GCC; it is part of the operating system).  If
13059 the GOT size for the linked executable exceeds a machine-specific
13060 maximum size, you get an error message from the linker indicating that
13061 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13062 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13063 on the m68k and RS/6000.  The x86 has no such limit.)
13065 Position-independent code requires special support, and therefore works
13066 only on certain machines.  For the x86, GCC supports PIC for System V
13067 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13068 position-independent.
13070 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13071 are defined to 1.
13073 @item -fPIC
13074 @opindex fPIC
13075 If supported for the target machine, emit position-independent code,
13076 suitable for dynamic linking and avoiding any limit on the size of the
13077 global offset table.  This option makes a difference on AArch64, m68k,
13078 PowerPC and SPARC@.
13080 Position-independent code requires special support, and therefore works
13081 only on certain machines.
13083 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13084 are defined to 2.
13086 @item -fpie
13087 @itemx -fPIE
13088 @opindex fpie
13089 @opindex fPIE
13090 These options are similar to @option{-fpic} and @option{-fPIC}, but
13091 generated position independent code can be only linked into executables.
13092 Usually these options are used when @option{-pie} GCC option is
13093 used during linking.
13095 @option{-fpie} and @option{-fPIE} both define the macros
13096 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13097 for @option{-fpie} and 2 for @option{-fPIE}.
13099 @item -fno-plt
13100 @opindex fno-plt
13101 Do not use the PLT for external function calls in position-independent code.
13102 Instead, load the callee address at call sites from the GOT and branch to it.
13103 This leads to more efficient code by eliminating PLT stubs and exposing
13104 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13105 PLT stubs expect the GOT pointer in a specific register, this gives more
13106 register allocation freedom to the compiler.
13107 Lazy binding requires use of the PLT; 
13108 with @option{-fno-plt} all external symbols are resolved at load time.
13110 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13111 through the PLT for specific external functions.
13113 In position-dependent code, a few targets also convert calls to
13114 functions that are marked to not use the PLT to use the GOT instead.
13116 @item -fno-jump-tables
13117 @opindex fno-jump-tables
13118 Do not use jump tables for switch statements even where it would be
13119 more efficient than other code generation strategies.  This option is
13120 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13121 building code that forms part of a dynamic linker and cannot
13122 reference the address of a jump table.  On some targets, jump tables
13123 do not require a GOT and this option is not needed.
13125 @item -ffixed-@var{reg}
13126 @opindex ffixed
13127 Treat the register named @var{reg} as a fixed register; generated code
13128 should never refer to it (except perhaps as a stack pointer, frame
13129 pointer or in some other fixed role).
13131 @var{reg} must be the name of a register.  The register names accepted
13132 are machine-specific and are defined in the @code{REGISTER_NAMES}
13133 macro in the machine description macro file.
13135 This flag does not have a negative form, because it specifies a
13136 three-way choice.
13138 @item -fcall-used-@var{reg}
13139 @opindex fcall-used
13140 Treat the register named @var{reg} as an allocable register that is
13141 clobbered by function calls.  It may be allocated for temporaries or
13142 variables that do not live across a call.  Functions compiled this way
13143 do not save and restore the register @var{reg}.
13145 It is an error to use this flag with the frame pointer or stack pointer.
13146 Use of this flag for other registers that have fixed pervasive roles in
13147 the machine's execution model produces disastrous results.
13149 This flag does not have a negative form, because it specifies a
13150 three-way choice.
13152 @item -fcall-saved-@var{reg}
13153 @opindex fcall-saved
13154 Treat the register named @var{reg} as an allocable register saved by
13155 functions.  It may be allocated even for temporaries or variables that
13156 live across a call.  Functions compiled this way save and restore
13157 the register @var{reg} if they use it.
13159 It is an error to use this flag with the frame pointer or stack pointer.
13160 Use of this flag for other registers that have fixed pervasive roles in
13161 the machine's execution model produces disastrous results.
13163 A different sort of disaster results from the use of this flag for
13164 a register in which function values may be returned.
13166 This flag does not have a negative form, because it specifies a
13167 three-way choice.
13169 @item -fpack-struct[=@var{n}]
13170 @opindex fpack-struct
13171 Without a value specified, pack all structure members together without
13172 holes.  When a value is specified (which must be a small power of two), pack
13173 structure members according to this value, representing the maximum
13174 alignment (that is, objects with default alignment requirements larger than
13175 this are output potentially unaligned at the next fitting location.
13177 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13178 code that is not binary compatible with code generated without that switch.
13179 Additionally, it makes the code suboptimal.
13180 Use it to conform to a non-default application binary interface.
13182 @item -fleading-underscore
13183 @opindex fleading-underscore
13184 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13185 change the way C symbols are represented in the object file.  One use
13186 is to help link with legacy assembly code.
13188 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13189 generate code that is not binary compatible with code generated without that
13190 switch.  Use it to conform to a non-default application binary interface.
13191 Not all targets provide complete support for this switch.
13193 @item -ftls-model=@var{model}
13194 @opindex ftls-model
13195 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13196 The @var{model} argument should be one of @samp{global-dynamic},
13197 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13198 Note that the choice is subject to optimization: the compiler may use
13199 a more efficient model for symbols not visible outside of the translation
13200 unit, or if @option{-fpic} is not given on the command line.
13202 The default without @option{-fpic} is @samp{initial-exec}; with
13203 @option{-fpic} the default is @samp{global-dynamic}.
13205 @item -ftrampolines
13206 @opindex ftrampolines
13207 For targets that normally need trampolines for nested functions, always
13208 generate them instead of using descriptors.  Otherwise, for targets that
13209 do not need them, like for example HP-PA or IA-64, do nothing.
13211 A trampoline is a small piece of code that is created at run time on the
13212 stack when the address of a nested function is taken, and is used to call
13213 the nested function indirectly.  Therefore, it requires the stack to be
13214 made executable in order for the program to work properly.
13216 @option{-fno-trampolines} is enabled by default on a language by language
13217 basis to let the compiler avoid generating them, if it computes that this
13218 is safe, and replace them with descriptors.  Descriptors are made up of data
13219 only, but the generated code must be prepared to deal with them.  As of this
13220 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13222 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13223 @option{-fno-trampolines} are not binary compatible if nested functions are
13224 present.  This option must therefore be used on a program-wide basis and be
13225 manipulated with extreme care.
13227 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13228 @opindex fvisibility
13229 Set the default ELF image symbol visibility to the specified option---all
13230 symbols are marked with this unless overridden within the code.
13231 Using this feature can very substantially improve linking and
13232 load times of shared object libraries, produce more optimized
13233 code, provide near-perfect API export and prevent symbol clashes.
13234 It is @strong{strongly} recommended that you use this in any shared objects
13235 you distribute.
13237 Despite the nomenclature, @samp{default} always means public; i.e.,
13238 available to be linked against from outside the shared object.
13239 @samp{protected} and @samp{internal} are pretty useless in real-world
13240 usage so the only other commonly used option is @samp{hidden}.
13241 The default if @option{-fvisibility} isn't specified is
13242 @samp{default}, i.e., make every symbol public.
13244 A good explanation of the benefits offered by ensuring ELF
13245 symbols have the correct visibility is given by ``How To Write
13246 Shared Libraries'' by Ulrich Drepper (which can be found at
13247 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13248 solution made possible by this option to marking things hidden when
13249 the default is public is to make the default hidden and mark things
13250 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13251 and @code{__attribute__ ((visibility("default")))} instead of
13252 @code{__declspec(dllexport)} you get almost identical semantics with
13253 identical syntax.  This is a great boon to those working with
13254 cross-platform projects.
13256 For those adding visibility support to existing code, you may find
13257 @code{#pragma GCC visibility} of use.  This works by you enclosing
13258 the declarations you wish to set visibility for with (for example)
13259 @code{#pragma GCC visibility push(hidden)} and
13260 @code{#pragma GCC visibility pop}.
13261 Bear in mind that symbol visibility should be viewed @strong{as
13262 part of the API interface contract} and thus all new code should
13263 always specify visibility when it is not the default; i.e., declarations
13264 only for use within the local DSO should @strong{always} be marked explicitly
13265 as hidden as so to avoid PLT indirection overheads---making this
13266 abundantly clear also aids readability and self-documentation of the code.
13267 Note that due to ISO C++ specification requirements, @code{operator new} and
13268 @code{operator delete} must always be of default visibility.
13270 Be aware that headers from outside your project, in particular system
13271 headers and headers from any other library you use, may not be
13272 expecting to be compiled with visibility other than the default.  You
13273 may need to explicitly say @code{#pragma GCC visibility push(default)}
13274 before including any such headers.
13276 @code{extern} declarations are not affected by @option{-fvisibility}, so
13277 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13278 no modifications.  However, this means that calls to @code{extern}
13279 functions with no explicit visibility use the PLT, so it is more
13280 effective to use @code{__attribute ((visibility))} and/or
13281 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13282 declarations should be treated as hidden.
13284 Note that @option{-fvisibility} does affect C++ vague linkage
13285 entities. This means that, for instance, an exception class that is
13286 be thrown between DSOs must be explicitly marked with default
13287 visibility so that the @samp{type_info} nodes are unified between
13288 the DSOs.
13290 An overview of these techniques, their benefits and how to use them
13291 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13293 @item -fstrict-volatile-bitfields
13294 @opindex fstrict-volatile-bitfields
13295 This option should be used if accesses to volatile bit-fields (or other
13296 structure fields, although the compiler usually honors those types
13297 anyway) should use a single access of the width of the
13298 field's type, aligned to a natural alignment if possible.  For
13299 example, targets with memory-mapped peripheral registers might require
13300 all such accesses to be 16 bits wide; with this flag you can
13301 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13302 is 16 bits on these targets) to force GCC to use 16-bit accesses
13303 instead of, perhaps, a more efficient 32-bit access.
13305 If this option is disabled, the compiler uses the most efficient
13306 instruction.  In the previous example, that might be a 32-bit load
13307 instruction, even though that accesses bytes that do not contain
13308 any portion of the bit-field, or memory-mapped registers unrelated to
13309 the one being updated.
13311 In some cases, such as when the @code{packed} attribute is applied to a 
13312 structure field, it may not be possible to access the field with a single
13313 read or write that is correctly aligned for the target machine.  In this
13314 case GCC falls back to generating multiple accesses rather than code that 
13315 will fault or truncate the result at run time.
13317 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13318 not allowed to touch non bit-field members.  It is therefore recommended
13319 to define all bits of the field's type as bit-field members.
13321 The default value of this option is determined by the application binary
13322 interface for the target processor.
13324 @item -fsync-libcalls
13325 @opindex fsync-libcalls
13326 This option controls whether any out-of-line instance of the @code{__sync}
13327 family of functions may be used to implement the C++11 @code{__atomic}
13328 family of functions.
13330 The default value of this option is enabled, thus the only useful form
13331 of the option is @option{-fno-sync-libcalls}.  This option is used in
13332 the implementation of the @file{libatomic} runtime library.
13334 @end table
13336 @node Developer Options
13337 @section GCC Developer Options
13338 @cindex developer options
13339 @cindex debugging GCC
13340 @cindex debug dump options
13341 @cindex dump options
13342 @cindex compilation statistics
13344 This section describes command-line options that are primarily of
13345 interest to GCC developers, including options to support compiler
13346 testing and investigation of compiler bugs and compile-time
13347 performance problems.  This includes options that produce debug dumps
13348 at various points in the compilation; that print statistics such as
13349 memory use and execution time; and that print information about GCC's
13350 configuration, such as where it searches for libraries.  You should
13351 rarely need to use any of these options for ordinary compilation and
13352 linking tasks.
13354 @table @gcctabopt
13356 @item -d@var{letters}
13357 @itemx -fdump-rtl-@var{pass}
13358 @itemx -fdump-rtl-@var{pass}=@var{filename}
13359 @opindex d
13360 @opindex fdump-rtl-@var{pass}
13361 Says to make debugging dumps during compilation at times specified by
13362 @var{letters}.  This is used for debugging the RTL-based passes of the
13363 compiler.  The file names for most of the dumps are made by appending
13364 a pass number and a word to the @var{dumpname}, and the files are
13365 created in the directory of the output file.  In case of
13366 @option{=@var{filename}} option, the dump is output on the given file
13367 instead of the pass numbered dump files.  Note that the pass number is
13368 assigned as passes are registered into the pass manager.  Most passes
13369 are registered in the order that they will execute and for these passes
13370 the number corresponds to the pass execution order.  However, passes
13371 registered by plugins, passes specific to compilation targets, or
13372 passes that are otherwise registered after all the other passes are
13373 numbered higher than a pass named "final", even if they are executed
13374 earlier.  @var{dumpname} is generated from the name of the output
13375 file if explicitly specified and not an executable, otherwise it is
13376 the basename of the source file.  
13378 Some @option{-d@var{letters}} switches have different meaning when
13379 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13380 for information about preprocessor-specific dump options.
13382 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13383 @option{-d} option @var{letters}.  Here are the possible
13384 letters for use in @var{pass} and @var{letters}, and their meanings:
13386 @table @gcctabopt
13388 @item -fdump-rtl-alignments
13389 @opindex fdump-rtl-alignments
13390 Dump after branch alignments have been computed.
13392 @item -fdump-rtl-asmcons
13393 @opindex fdump-rtl-asmcons
13394 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13396 @item -fdump-rtl-auto_inc_dec
13397 @opindex fdump-rtl-auto_inc_dec
13398 Dump after auto-inc-dec discovery.  This pass is only run on
13399 architectures that have auto inc or auto dec instructions.
13401 @item -fdump-rtl-barriers
13402 @opindex fdump-rtl-barriers
13403 Dump after cleaning up the barrier instructions.
13405 @item -fdump-rtl-bbpart
13406 @opindex fdump-rtl-bbpart
13407 Dump after partitioning hot and cold basic blocks.
13409 @item -fdump-rtl-bbro
13410 @opindex fdump-rtl-bbro
13411 Dump after block reordering.
13413 @item -fdump-rtl-btl1
13414 @itemx -fdump-rtl-btl2
13415 @opindex fdump-rtl-btl2
13416 @opindex fdump-rtl-btl2
13417 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13418 after the two branch
13419 target load optimization passes.
13421 @item -fdump-rtl-bypass
13422 @opindex fdump-rtl-bypass
13423 Dump after jump bypassing and control flow optimizations.
13425 @item -fdump-rtl-combine
13426 @opindex fdump-rtl-combine
13427 Dump after the RTL instruction combination pass.
13429 @item -fdump-rtl-compgotos
13430 @opindex fdump-rtl-compgotos
13431 Dump after duplicating the computed gotos.
13433 @item -fdump-rtl-ce1
13434 @itemx -fdump-rtl-ce2
13435 @itemx -fdump-rtl-ce3
13436 @opindex fdump-rtl-ce1
13437 @opindex fdump-rtl-ce2
13438 @opindex fdump-rtl-ce3
13439 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13440 @option{-fdump-rtl-ce3} enable dumping after the three
13441 if conversion passes.
13443 @item -fdump-rtl-cprop_hardreg
13444 @opindex fdump-rtl-cprop_hardreg
13445 Dump after hard register copy propagation.
13447 @item -fdump-rtl-csa
13448 @opindex fdump-rtl-csa
13449 Dump after combining stack adjustments.
13451 @item -fdump-rtl-cse1
13452 @itemx -fdump-rtl-cse2
13453 @opindex fdump-rtl-cse1
13454 @opindex fdump-rtl-cse2
13455 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13456 the two common subexpression elimination passes.
13458 @item -fdump-rtl-dce
13459 @opindex fdump-rtl-dce
13460 Dump after the standalone dead code elimination passes.
13462 @item -fdump-rtl-dbr
13463 @opindex fdump-rtl-dbr
13464 Dump after delayed branch scheduling.
13466 @item -fdump-rtl-dce1
13467 @itemx -fdump-rtl-dce2
13468 @opindex fdump-rtl-dce1
13469 @opindex fdump-rtl-dce2
13470 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13471 the two dead store elimination passes.
13473 @item -fdump-rtl-eh
13474 @opindex fdump-rtl-eh
13475 Dump after finalization of EH handling code.
13477 @item -fdump-rtl-eh_ranges
13478 @opindex fdump-rtl-eh_ranges
13479 Dump after conversion of EH handling range regions.
13481 @item -fdump-rtl-expand
13482 @opindex fdump-rtl-expand
13483 Dump after RTL generation.
13485 @item -fdump-rtl-fwprop1
13486 @itemx -fdump-rtl-fwprop2
13487 @opindex fdump-rtl-fwprop1
13488 @opindex fdump-rtl-fwprop2
13489 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13490 dumping after the two forward propagation passes.
13492 @item -fdump-rtl-gcse1
13493 @itemx -fdump-rtl-gcse2
13494 @opindex fdump-rtl-gcse1
13495 @opindex fdump-rtl-gcse2
13496 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13497 after global common subexpression elimination.
13499 @item -fdump-rtl-init-regs
13500 @opindex fdump-rtl-init-regs
13501 Dump after the initialization of the registers.
13503 @item -fdump-rtl-initvals
13504 @opindex fdump-rtl-initvals
13505 Dump after the computation of the initial value sets.
13507 @item -fdump-rtl-into_cfglayout
13508 @opindex fdump-rtl-into_cfglayout
13509 Dump after converting to cfglayout mode.
13511 @item -fdump-rtl-ira
13512 @opindex fdump-rtl-ira
13513 Dump after iterated register allocation.
13515 @item -fdump-rtl-jump
13516 @opindex fdump-rtl-jump
13517 Dump after the second jump optimization.
13519 @item -fdump-rtl-loop2
13520 @opindex fdump-rtl-loop2
13521 @option{-fdump-rtl-loop2} enables dumping after the rtl
13522 loop optimization passes.
13524 @item -fdump-rtl-mach
13525 @opindex fdump-rtl-mach
13526 Dump after performing the machine dependent reorganization pass, if that
13527 pass exists.
13529 @item -fdump-rtl-mode_sw
13530 @opindex fdump-rtl-mode_sw
13531 Dump after removing redundant mode switches.
13533 @item -fdump-rtl-rnreg
13534 @opindex fdump-rtl-rnreg
13535 Dump after register renumbering.
13537 @item -fdump-rtl-outof_cfglayout
13538 @opindex fdump-rtl-outof_cfglayout
13539 Dump after converting from cfglayout mode.
13541 @item -fdump-rtl-peephole2
13542 @opindex fdump-rtl-peephole2
13543 Dump after the peephole pass.
13545 @item -fdump-rtl-postreload
13546 @opindex fdump-rtl-postreload
13547 Dump after post-reload optimizations.
13549 @item -fdump-rtl-pro_and_epilogue
13550 @opindex fdump-rtl-pro_and_epilogue
13551 Dump after generating the function prologues and epilogues.
13553 @item -fdump-rtl-sched1
13554 @itemx -fdump-rtl-sched2
13555 @opindex fdump-rtl-sched1
13556 @opindex fdump-rtl-sched2
13557 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13558 after the basic block scheduling passes.
13560 @item -fdump-rtl-ree
13561 @opindex fdump-rtl-ree
13562 Dump after sign/zero extension elimination.
13564 @item -fdump-rtl-seqabstr
13565 @opindex fdump-rtl-seqabstr
13566 Dump after common sequence discovery.
13568 @item -fdump-rtl-shorten
13569 @opindex fdump-rtl-shorten
13570 Dump after shortening branches.
13572 @item -fdump-rtl-sibling
13573 @opindex fdump-rtl-sibling
13574 Dump after sibling call optimizations.
13576 @item -fdump-rtl-split1
13577 @itemx -fdump-rtl-split2
13578 @itemx -fdump-rtl-split3
13579 @itemx -fdump-rtl-split4
13580 @itemx -fdump-rtl-split5
13581 @opindex fdump-rtl-split1
13582 @opindex fdump-rtl-split2
13583 @opindex fdump-rtl-split3
13584 @opindex fdump-rtl-split4
13585 @opindex fdump-rtl-split5
13586 These options enable dumping after five rounds of
13587 instruction splitting.
13589 @item -fdump-rtl-sms
13590 @opindex fdump-rtl-sms
13591 Dump after modulo scheduling.  This pass is only run on some
13592 architectures.
13594 @item -fdump-rtl-stack
13595 @opindex fdump-rtl-stack
13596 Dump after conversion from GCC's ``flat register file'' registers to the
13597 x87's stack-like registers.  This pass is only run on x86 variants.
13599 @item -fdump-rtl-subreg1
13600 @itemx -fdump-rtl-subreg2
13601 @opindex fdump-rtl-subreg1
13602 @opindex fdump-rtl-subreg2
13603 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13604 the two subreg expansion passes.
13606 @item -fdump-rtl-unshare
13607 @opindex fdump-rtl-unshare
13608 Dump after all rtl has been unshared.
13610 @item -fdump-rtl-vartrack
13611 @opindex fdump-rtl-vartrack
13612 Dump after variable tracking.
13614 @item -fdump-rtl-vregs
13615 @opindex fdump-rtl-vregs
13616 Dump after converting virtual registers to hard registers.
13618 @item -fdump-rtl-web
13619 @opindex fdump-rtl-web
13620 Dump after live range splitting.
13622 @item -fdump-rtl-regclass
13623 @itemx -fdump-rtl-subregs_of_mode_init
13624 @itemx -fdump-rtl-subregs_of_mode_finish
13625 @itemx -fdump-rtl-dfinit
13626 @itemx -fdump-rtl-dfinish
13627 @opindex fdump-rtl-regclass
13628 @opindex fdump-rtl-subregs_of_mode_init
13629 @opindex fdump-rtl-subregs_of_mode_finish
13630 @opindex fdump-rtl-dfinit
13631 @opindex fdump-rtl-dfinish
13632 These dumps are defined but always produce empty files.
13634 @item -da
13635 @itemx -fdump-rtl-all
13636 @opindex da
13637 @opindex fdump-rtl-all
13638 Produce all the dumps listed above.
13640 @item -dA
13641 @opindex dA
13642 Annotate the assembler output with miscellaneous debugging information.
13644 @item -dD
13645 @opindex dD
13646 Dump all macro definitions, at the end of preprocessing, in addition to
13647 normal output.
13649 @item -dH
13650 @opindex dH
13651 Produce a core dump whenever an error occurs.
13653 @item -dp
13654 @opindex dp
13655 Annotate the assembler output with a comment indicating which
13656 pattern and alternative is used.  The length and cost of each instruction are
13657 also printed.
13659 @item -dP
13660 @opindex dP
13661 Dump the RTL in the assembler output as a comment before each instruction.
13662 Also turns on @option{-dp} annotation.
13664 @item -dx
13665 @opindex dx
13666 Just generate RTL for a function instead of compiling it.  Usually used
13667 with @option{-fdump-rtl-expand}.
13668 @end table
13670 @item -fdump-noaddr
13671 @opindex fdump-noaddr
13672 When doing debugging dumps, suppress address output.  This makes it more
13673 feasible to use diff on debugging dumps for compiler invocations with
13674 different compiler binaries and/or different
13675 text / bss / data / heap / stack / dso start locations.
13677 @item -freport-bug
13678 @opindex freport-bug
13679 Collect and dump debug information into a temporary file if an
13680 internal compiler error (ICE) occurs.
13682 @item -fdump-unnumbered
13683 @opindex fdump-unnumbered
13684 When doing debugging dumps, suppress instruction numbers and address output.
13685 This makes it more feasible to use diff on debugging dumps for compiler
13686 invocations with different options, in particular with and without
13687 @option{-g}.
13689 @item -fdump-unnumbered-links
13690 @opindex fdump-unnumbered-links
13691 When doing debugging dumps (see @option{-d} option above), suppress
13692 instruction numbers for the links to the previous and next instructions
13693 in a sequence.
13695 @item -fdump-ipa-@var{switch}
13696 @opindex fdump-ipa
13697 Control the dumping at various stages of inter-procedural analysis
13698 language tree to a file.  The file name is generated by appending a
13699 switch specific suffix to the source file name, and the file is created
13700 in the same directory as the output file.  The following dumps are
13701 possible:
13703 @table @samp
13704 @item all
13705 Enables all inter-procedural analysis dumps.
13707 @item cgraph
13708 Dumps information about call-graph optimization, unused function removal,
13709 and inlining decisions.
13711 @item inline
13712 Dump after function inlining.
13714 @end table
13716 @item -fdump-lang-all
13717 @itemx -fdump-lang-@var{switch}
13718 @itemx -fdump-lang-@var{switch}-@var{options}
13719 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13720 @opindex fdump-lang-all
13721 @opindex fdump-lang
13722 Control the dumping of language-specific information.  The @var{options}
13723 and @var{filename} portions behave as described in the
13724 @option{-fdump-tree} option.  The following @var{switch} values are
13725 accepted:
13727 @table @samp
13728 @item all
13730 Enable all language-specific dumps.
13732 @item class
13733 Dump class hierarchy information.  Virtual table information is emitted
13734 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13736 @item raw
13737 Dump the raw internal tree data.  This option is applicable to C++ only.
13739 @end table
13741 @item -fdump-passes
13742 @opindex fdump-passes
13743 Print on @file{stderr} the list of optimization passes that are turned
13744 on and off by the current command-line options.
13746 @item -fdump-statistics-@var{option}
13747 @opindex fdump-statistics
13748 Enable and control dumping of pass statistics in a separate file.  The
13749 file name is generated by appending a suffix ending in
13750 @samp{.statistics} to the source file name, and the file is created in
13751 the same directory as the output file.  If the @samp{-@var{option}}
13752 form is used, @samp{-stats} causes counters to be summed over the
13753 whole compilation unit while @samp{-details} dumps every event as
13754 the passes generate them.  The default with no option is to sum
13755 counters for each function compiled.
13757 @item -fdump-tree-all
13758 @itemx -fdump-tree-@var{switch}
13759 @itemx -fdump-tree-@var{switch}-@var{options}
13760 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13761 @opindex fdump-tree-all
13762 @opindex fdump-tree
13763 Control the dumping at various stages of processing the intermediate
13764 language tree to a file.  The file name is generated by appending a
13765 switch-specific suffix to the source file name, and the file is
13766 created in the same directory as the output file. In case of
13767 @option{=@var{filename}} option, the dump is output on the given file
13768 instead of the auto named dump files.  If the @samp{-@var{options}}
13769 form is used, @var{options} is a list of @samp{-} separated options
13770 which control the details of the dump.  Not all options are applicable
13771 to all dumps; those that are not meaningful are ignored.  The
13772 following options are available
13774 @table @samp
13775 @item address
13776 Print the address of each node.  Usually this is not meaningful as it
13777 changes according to the environment and source file.  Its primary use
13778 is for tying up a dump file with a debug environment.
13779 @item asmname
13780 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13781 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13782 use working backward from mangled names in the assembly file.
13783 @item slim
13784 When dumping front-end intermediate representations, inhibit dumping
13785 of members of a scope or body of a function merely because that scope
13786 has been reached.  Only dump such items when they are directly reachable
13787 by some other path.
13789 When dumping pretty-printed trees, this option inhibits dumping the
13790 bodies of control structures.
13792 When dumping RTL, print the RTL in slim (condensed) form instead of
13793 the default LISP-like representation.
13794 @item raw
13795 Print a raw representation of the tree.  By default, trees are
13796 pretty-printed into a C-like representation.
13797 @item details
13798 Enable more detailed dumps (not honored by every dump option). Also
13799 include information from the optimization passes.
13800 @item stats
13801 Enable dumping various statistics about the pass (not honored by every dump
13802 option).
13803 @item blocks
13804 Enable showing basic block boundaries (disabled in raw dumps).
13805 @item graph
13806 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13807 dump a representation of the control flow graph suitable for viewing with
13808 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13809 the file is pretty-printed as a subgraph, so that GraphViz can render them
13810 all in a single plot.
13812 This option currently only works for RTL dumps, and the RTL is always
13813 dumped in slim form.
13814 @item vops
13815 Enable showing virtual operands for every statement.
13816 @item lineno
13817 Enable showing line numbers for statements.
13818 @item uid
13819 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13820 @item verbose
13821 Enable showing the tree dump for each statement.
13822 @item eh
13823 Enable showing the EH region number holding each statement.
13824 @item scev
13825 Enable showing scalar evolution analysis details.
13826 @item optimized
13827 Enable showing optimization information (only available in certain
13828 passes).
13829 @item missed
13830 Enable showing missed optimization information (only available in certain
13831 passes).
13832 @item note
13833 Enable other detailed optimization information (only available in
13834 certain passes).
13835 @item =@var{filename}
13836 Instead of an auto named dump file, output into the given file
13837 name. The file names @file{stdout} and @file{stderr} are treated
13838 specially and are considered already open standard streams. For
13839 example,
13841 @smallexample
13842 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13843      -fdump-tree-pre=/dev/stderr file.c
13844 @end smallexample
13846 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13847 output on to @file{stderr}. If two conflicting dump filenames are
13848 given for the same pass, then the latter option overrides the earlier
13849 one.
13851 @item all
13852 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13853 and @option{lineno}.
13855 @item optall
13856 Turn on all optimization options, i.e., @option{optimized},
13857 @option{missed}, and @option{note}.
13858 @end table
13860 To determine what tree dumps are available or find the dump for a pass
13861 of interest follow the steps below.
13863 @enumerate
13864 @item
13865 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13866 look for a code that corresponds to the pass you are interested in.
13867 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13868 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13869 The number at the end distinguishes distinct invocations of the same pass.
13870 @item
13871 To enable the creation of the dump file, append the pass code to
13872 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13873 to enable the dump from the Early Value Range Propagation pass, invoke
13874 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13875 specify the name of the dump file.  If you don't specify one, GCC
13876 creates as described below.
13877 @item
13878 Find the pass dump in a file whose name is composed of three components
13879 separated by a period: the name of the source file GCC was invoked to
13880 compile, a numeric suffix indicating the pass number followed by the
13881 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13882 and finally the pass code.  For example, the Early VRP pass dump might
13883 be in a file named @file{myfile.c.038t.evrp} in the current working
13884 directory.  Note that the numeric codes are not stable and may change
13885 from one version of GCC to another.
13886 @end enumerate
13888 @item -fopt-info
13889 @itemx -fopt-info-@var{options}
13890 @itemx -fopt-info-@var{options}=@var{filename}
13891 @opindex fopt-info
13892 Controls optimization dumps from various optimization passes. If the
13893 @samp{-@var{options}} form is used, @var{options} is a list of
13894 @samp{-} separated option keywords to select the dump details and
13895 optimizations.  
13897 The @var{options} can be divided into two groups: options describing the
13898 verbosity of the dump, and options describing which optimizations
13899 should be included. The options from both the groups can be freely
13900 mixed as they are non-overlapping. However, in case of any conflicts,
13901 the later options override the earlier options on the command
13902 line. 
13904 The following options control the dump verbosity:
13906 @table @samp
13907 @item optimized
13908 Print information when an optimization is successfully applied. It is
13909 up to a pass to decide which information is relevant. For example, the
13910 vectorizer passes print the source location of loops which are
13911 successfully vectorized.
13912 @item missed
13913 Print information about missed optimizations. Individual passes
13914 control which information to include in the output. 
13915 @item note
13916 Print verbose information about optimizations, such as certain
13917 transformations, more detailed messages about decisions etc.
13918 @item all
13919 Print detailed optimization information. This includes
13920 @samp{optimized}, @samp{missed}, and @samp{note}.
13921 @end table
13923 One or more of the following option keywords can be used to describe a
13924 group of optimizations:
13926 @table @samp
13927 @item ipa
13928 Enable dumps from all interprocedural optimizations.
13929 @item loop
13930 Enable dumps from all loop optimizations.
13931 @item inline
13932 Enable dumps from all inlining optimizations.
13933 @item omp
13934 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13935 @item vec
13936 Enable dumps from all vectorization optimizations.
13937 @item optall
13938 Enable dumps from all optimizations. This is a superset of
13939 the optimization groups listed above.
13940 @end table
13942 If @var{options} is
13943 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13944 info about successful optimizations from all the passes.  
13946 If the @var{filename} is provided, then the dumps from all the
13947 applicable optimizations are concatenated into the @var{filename}.
13948 Otherwise the dump is output onto @file{stderr}. Though multiple
13949 @option{-fopt-info} options are accepted, only one of them can include
13950 a @var{filename}. If other filenames are provided then all but the
13951 first such option are ignored.
13953 Note that the output @var{filename} is overwritten
13954 in case of multiple translation units. If a combined output from
13955 multiple translation units is desired, @file{stderr} should be used
13956 instead.
13958 In the following example, the optimization info is output to
13959 @file{stderr}:
13961 @smallexample
13962 gcc -O3 -fopt-info
13963 @end smallexample
13965 This example:
13966 @smallexample
13967 gcc -O3 -fopt-info-missed=missed.all
13968 @end smallexample
13970 @noindent
13971 outputs missed optimization report from all the passes into
13972 @file{missed.all}, and this one:
13974 @smallexample
13975 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13976 @end smallexample
13978 @noindent
13979 prints information about missed optimization opportunities from
13980 vectorization passes on @file{stderr}.  
13981 Note that @option{-fopt-info-vec-missed} is equivalent to 
13982 @option{-fopt-info-missed-vec}.  The order of the optimization group
13983 names and message types listed after @option{-fopt-info} does not matter.
13985 As another example,
13986 @smallexample
13987 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13988 @end smallexample
13990 @noindent
13991 outputs information about missed optimizations as well as
13992 optimized locations from all the inlining passes into
13993 @file{inline.txt}.
13995 Finally, consider:
13997 @smallexample
13998 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13999 @end smallexample
14001 @noindent
14002 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
14003 in conflict since only one output file is allowed. In this case, only
14004 the first option takes effect and the subsequent options are
14005 ignored. Thus only @file{vec.miss} is produced which contains
14006 dumps from the vectorizer about missed opportunities.
14008 @item -fsched-verbose=@var{n}
14009 @opindex fsched-verbose
14010 On targets that use instruction scheduling, this option controls the
14011 amount of debugging output the scheduler prints to the dump files.
14013 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14014 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14015 For @var{n} greater than one, it also output basic block probabilities,
14016 detailed ready list information and unit/insn info.  For @var{n} greater
14017 than two, it includes RTL at abort point, control-flow and regions info.
14018 And for @var{n} over four, @option{-fsched-verbose} also includes
14019 dependence info.
14023 @item -fenable-@var{kind}-@var{pass}
14024 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14025 @opindex fdisable-
14026 @opindex fenable-
14028 This is a set of options that are used to explicitly disable/enable
14029 optimization passes.  These options are intended for use for debugging GCC.
14030 Compiler users should use regular options for enabling/disabling
14031 passes instead.
14033 @table @gcctabopt
14035 @item -fdisable-ipa-@var{pass}
14036 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14037 statically invoked in the compiler multiple times, the pass name should be
14038 appended with a sequential number starting from 1.
14040 @item -fdisable-rtl-@var{pass}
14041 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14042 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14043 statically invoked in the compiler multiple times, the pass name should be
14044 appended with a sequential number starting from 1.  @var{range-list} is a 
14045 comma-separated list of function ranges or assembler names.  Each range is a number
14046 pair separated by a colon.  The range is inclusive in both ends.  If the range
14047 is trivial, the number pair can be simplified as a single number.  If the
14048 function's call graph node's @var{uid} falls within one of the specified ranges,
14049 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14050 function header of a dump file, and the pass names can be dumped by using
14051 option @option{-fdump-passes}.
14053 @item -fdisable-tree-@var{pass}
14054 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14055 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14056 option arguments.
14058 @item -fenable-ipa-@var{pass}
14059 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14060 statically invoked in the compiler multiple times, the pass name should be
14061 appended with a sequential number starting from 1.
14063 @item -fenable-rtl-@var{pass}
14064 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14065 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14066 description and examples.
14068 @item -fenable-tree-@var{pass}
14069 @itemx -fenable-tree-@var{pass}=@var{range-list}
14070 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14071 of option arguments.
14073 @end table
14075 Here are some examples showing uses of these options.
14077 @smallexample
14079 # disable ccp1 for all functions
14080    -fdisable-tree-ccp1
14081 # disable complete unroll for function whose cgraph node uid is 1
14082    -fenable-tree-cunroll=1
14083 # disable gcse2 for functions at the following ranges [1,1],
14084 # [300,400], and [400,1000]
14085 # disable gcse2 for functions foo and foo2
14086    -fdisable-rtl-gcse2=foo,foo2
14087 # disable early inlining
14088    -fdisable-tree-einline
14089 # disable ipa inlining
14090    -fdisable-ipa-inline
14091 # enable tree full unroll
14092    -fenable-tree-unroll
14094 @end smallexample
14096 @item -fchecking
14097 @itemx -fchecking=@var{n}
14098 @opindex fchecking
14099 @opindex fno-checking
14100 Enable internal consistency checking.  The default depends on
14101 the compiler configuration.  @option{-fchecking=2} enables further
14102 internal consistency checking that might affect code generation.
14104 @item -frandom-seed=@var{string}
14105 @opindex frandom-seed
14106 This option provides a seed that GCC uses in place of
14107 random numbers in generating certain symbol names
14108 that have to be different in every compiled file.  It is also used to
14109 place unique stamps in coverage data files and the object files that
14110 produce them.  You can use the @option{-frandom-seed} option to produce
14111 reproducibly identical object files.
14113 The @var{string} can either be a number (decimal, octal or hex) or an
14114 arbitrary string (in which case it's converted to a number by
14115 computing CRC32).
14117 The @var{string} should be different for every file you compile.
14119 @item -save-temps
14120 @itemx -save-temps=cwd
14121 @opindex save-temps
14122 Store the usual ``temporary'' intermediate files permanently; place them
14123 in the current directory and name them based on the source file.  Thus,
14124 compiling @file{foo.c} with @option{-c -save-temps} produces files
14125 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14126 preprocessed @file{foo.i} output file even though the compiler now
14127 normally uses an integrated preprocessor.
14129 When used in combination with the @option{-x} command-line option,
14130 @option{-save-temps} is sensible enough to avoid over writing an
14131 input source file with the same extension as an intermediate file.
14132 The corresponding intermediate file may be obtained by renaming the
14133 source file before using @option{-save-temps}.
14135 If you invoke GCC in parallel, compiling several different source
14136 files that share a common base name in different subdirectories or the
14137 same source file compiled for multiple output destinations, it is
14138 likely that the different parallel compilers will interfere with each
14139 other, and overwrite the temporary files.  For instance:
14141 @smallexample
14142 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14143 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14144 @end smallexample
14146 may result in @file{foo.i} and @file{foo.o} being written to
14147 simultaneously by both compilers.
14149 @item -save-temps=obj
14150 @opindex save-temps=obj
14151 Store the usual ``temporary'' intermediate files permanently.  If the
14152 @option{-o} option is used, the temporary files are based on the
14153 object file.  If the @option{-o} option is not used, the
14154 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14156 For example:
14158 @smallexample
14159 gcc -save-temps=obj -c foo.c
14160 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14161 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14162 @end smallexample
14164 @noindent
14165 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14166 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14167 @file{dir2/yfoobar.o}.
14169 @item -time@r{[}=@var{file}@r{]}
14170 @opindex time
14171 Report the CPU time taken by each subprocess in the compilation
14172 sequence.  For C source files, this is the compiler proper and assembler
14173 (plus the linker if linking is done).
14175 Without the specification of an output file, the output looks like this:
14177 @smallexample
14178 # cc1 0.12 0.01
14179 # as 0.00 0.01
14180 @end smallexample
14182 The first number on each line is the ``user time'', that is time spent
14183 executing the program itself.  The second number is ``system time'',
14184 time spent executing operating system routines on behalf of the program.
14185 Both numbers are in seconds.
14187 With the specification of an output file, the output is appended to the
14188 named file, and it looks like this:
14190 @smallexample
14191 0.12 0.01 cc1 @var{options}
14192 0.00 0.01 as @var{options}
14193 @end smallexample
14195 The ``user time'' and the ``system time'' are moved before the program
14196 name, and the options passed to the program are displayed, so that one
14197 can later tell what file was being compiled, and with which options.
14199 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14200 @opindex fdump-final-insns
14201 Dump the final internal representation (RTL) to @var{file}.  If the
14202 optional argument is omitted (or if @var{file} is @code{.}), the name
14203 of the dump file is determined by appending @code{.gkd} to the
14204 compilation output file name.
14206 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14207 @opindex fcompare-debug
14208 @opindex fno-compare-debug
14209 If no error occurs during compilation, run the compiler a second time,
14210 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14211 passed to the second compilation.  Dump the final internal
14212 representation in both compilations, and print an error if they differ.
14214 If the equal sign is omitted, the default @option{-gtoggle} is used.
14216 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14217 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14218 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14219 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14220 is used.
14222 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14223 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14224 of the final representation and the second compilation, preventing even
14225 @env{GCC_COMPARE_DEBUG} from taking effect.
14227 To verify full coverage during @option{-fcompare-debug} testing, set
14228 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14229 which GCC rejects as an invalid option in any actual compilation
14230 (rather than preprocessing, assembly or linking).  To get just a
14231 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14232 not overridden} will do.
14234 @item -fcompare-debug-second
14235 @opindex fcompare-debug-second
14236 This option is implicitly passed to the compiler for the second
14237 compilation requested by @option{-fcompare-debug}, along with options to
14238 silence warnings, and omitting other options that would cause the compiler
14239 to produce output to files or to standard output as a side effect.  Dump
14240 files and preserved temporary files are renamed so as to contain the
14241 @code{.gk} additional extension during the second compilation, to avoid
14242 overwriting those generated by the first.
14244 When this option is passed to the compiler driver, it causes the
14245 @emph{first} compilation to be skipped, which makes it useful for little
14246 other than debugging the compiler proper.
14248 @item -gtoggle
14249 @opindex gtoggle
14250 Turn off generation of debug info, if leaving out this option
14251 generates it, or turn it on at level 2 otherwise.  The position of this
14252 argument in the command line does not matter; it takes effect after all
14253 other options are processed, and it does so only once, no matter how
14254 many times it is given.  This is mainly intended to be used with
14255 @option{-fcompare-debug}.
14257 @item -fvar-tracking-assignments-toggle
14258 @opindex fvar-tracking-assignments-toggle
14259 @opindex fno-var-tracking-assignments-toggle
14260 Toggle @option{-fvar-tracking-assignments}, in the same way that
14261 @option{-gtoggle} toggles @option{-g}.
14263 @item -Q
14264 @opindex Q
14265 Makes the compiler print out each function name as it is compiled, and
14266 print some statistics about each pass when it finishes.
14268 @item -ftime-report
14269 @opindex ftime-report
14270 Makes the compiler print some statistics about the time consumed by each
14271 pass when it finishes.
14273 @item -ftime-report-details
14274 @opindex ftime-report-details
14275 Record the time consumed by infrastructure parts separately for each pass.
14277 @item -fira-verbose=@var{n}
14278 @opindex fira-verbose
14279 Control the verbosity of the dump file for the integrated register allocator.
14280 The default value is 5.  If the value @var{n} is greater or equal to 10,
14281 the dump output is sent to stderr using the same format as @var{n} minus 10.
14283 @item -flto-report
14284 @opindex flto-report
14285 Prints a report with internal details on the workings of the link-time
14286 optimizer.  The contents of this report vary from version to version.
14287 It is meant to be useful to GCC developers when processing object
14288 files in LTO mode (via @option{-flto}).
14290 Disabled by default.
14292 @item -flto-report-wpa
14293 @opindex flto-report-wpa
14294 Like @option{-flto-report}, but only print for the WPA phase of Link
14295 Time Optimization.
14297 @item -fmem-report
14298 @opindex fmem-report
14299 Makes the compiler print some statistics about permanent memory
14300 allocation when it finishes.
14302 @item -fmem-report-wpa
14303 @opindex fmem-report-wpa
14304 Makes the compiler print some statistics about permanent memory
14305 allocation for the WPA phase only.
14307 @item -fpre-ipa-mem-report
14308 @opindex fpre-ipa-mem-report
14309 @item -fpost-ipa-mem-report
14310 @opindex fpost-ipa-mem-report
14311 Makes the compiler print some statistics about permanent memory
14312 allocation before or after interprocedural optimization.
14314 @item -fprofile-report
14315 @opindex fprofile-report
14316 Makes the compiler print some statistics about consistency of the
14317 (estimated) profile and effect of individual passes.
14319 @item -fstack-usage
14320 @opindex fstack-usage
14321 Makes the compiler output stack usage information for the program, on a
14322 per-function basis.  The filename for the dump is made by appending
14323 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14324 the output file, if explicitly specified and it is not an executable,
14325 otherwise it is the basename of the source file.  An entry is made up
14326 of three fields:
14328 @itemize
14329 @item
14330 The name of the function.
14331 @item
14332 A number of bytes.
14333 @item
14334 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14335 @end itemize
14337 The qualifier @code{static} means that the function manipulates the stack
14338 statically: a fixed number of bytes are allocated for the frame on function
14339 entry and released on function exit; no stack adjustments are otherwise made
14340 in the function.  The second field is this fixed number of bytes.
14342 The qualifier @code{dynamic} means that the function manipulates the stack
14343 dynamically: in addition to the static allocation described above, stack
14344 adjustments are made in the body of the function, for example to push/pop
14345 arguments around function calls.  If the qualifier @code{bounded} is also
14346 present, the amount of these adjustments is bounded at compile time and
14347 the second field is an upper bound of the total amount of stack used by
14348 the function.  If it is not present, the amount of these adjustments is
14349 not bounded at compile time and the second field only represents the
14350 bounded part.
14352 @item -fstats
14353 @opindex fstats
14354 Emit statistics about front-end processing at the end of the compilation.
14355 This option is supported only by the C++ front end, and
14356 the information is generally only useful to the G++ development team.
14358 @item -fdbg-cnt-list
14359 @opindex fdbg-cnt-list
14360 Print the name and the counter upper bound for all debug counters.
14363 @item -fdbg-cnt=@var{counter-value-list}
14364 @opindex fdbg-cnt
14365 Set the internal debug counter upper bound.  @var{counter-value-list}
14366 is a comma-separated list of @var{name}:@var{value} pairs
14367 which sets the upper bound of each debug counter @var{name} to @var{value}.
14368 All debug counters have the initial upper bound of @code{UINT_MAX};
14369 thus @code{dbg_cnt} returns true always unless the upper bound
14370 is set by this option.
14371 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14372 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14374 @item -print-file-name=@var{library}
14375 @opindex print-file-name
14376 Print the full absolute name of the library file @var{library} that
14377 would be used when linking---and don't do anything else.  With this
14378 option, GCC does not compile or link anything; it just prints the
14379 file name.
14381 @item -print-multi-directory
14382 @opindex print-multi-directory
14383 Print the directory name corresponding to the multilib selected by any
14384 other switches present in the command line.  This directory is supposed
14385 to exist in @env{GCC_EXEC_PREFIX}.
14387 @item -print-multi-lib
14388 @opindex print-multi-lib
14389 Print the mapping from multilib directory names to compiler switches
14390 that enable them.  The directory name is separated from the switches by
14391 @samp{;}, and each switch starts with an @samp{@@} instead of the
14392 @samp{-}, without spaces between multiple switches.  This is supposed to
14393 ease shell processing.
14395 @item -print-multi-os-directory
14396 @opindex print-multi-os-directory
14397 Print the path to OS libraries for the selected
14398 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14399 present in the @file{lib} subdirectory and no multilibs are used, this is
14400 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14401 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14402 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14403 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14405 @item -print-multiarch
14406 @opindex print-multiarch
14407 Print the path to OS libraries for the selected multiarch,
14408 relative to some @file{lib} subdirectory.
14410 @item -print-prog-name=@var{program}
14411 @opindex print-prog-name
14412 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14414 @item -print-libgcc-file-name
14415 @opindex print-libgcc-file-name
14416 Same as @option{-print-file-name=libgcc.a}.
14418 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14419 but you do want to link with @file{libgcc.a}.  You can do:
14421 @smallexample
14422 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14423 @end smallexample
14425 @item -print-search-dirs
14426 @opindex print-search-dirs
14427 Print the name of the configured installation directory and a list of
14428 program and library directories @command{gcc} searches---and don't do anything else.
14430 This is useful when @command{gcc} prints the error message
14431 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14432 To resolve this you either need to put @file{cpp0} and the other compiler
14433 components where @command{gcc} expects to find them, or you can set the environment
14434 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14435 Don't forget the trailing @samp{/}.
14436 @xref{Environment Variables}.
14438 @item -print-sysroot
14439 @opindex print-sysroot
14440 Print the target sysroot directory that is used during
14441 compilation.  This is the target sysroot specified either at configure
14442 time or using the @option{--sysroot} option, possibly with an extra
14443 suffix that depends on compilation options.  If no target sysroot is
14444 specified, the option prints nothing.
14446 @item -print-sysroot-headers-suffix
14447 @opindex print-sysroot-headers-suffix
14448 Print the suffix added to the target sysroot when searching for
14449 headers, or give an error if the compiler is not configured with such
14450 a suffix---and don't do anything else.
14452 @item -dumpmachine
14453 @opindex dumpmachine
14454 Print the compiler's target machine (for example,
14455 @samp{i686-pc-linux-gnu})---and don't do anything else.
14457 @item -dumpversion
14458 @opindex dumpversion
14459 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14460 anything else.  This is the compiler version used in filesystem paths,
14461 specs, can be depending on how the compiler has been configured just
14462 a single number (major version), two numbers separated by dot (major and
14463 minor version) or three numbers separated by dots (major, minor and patchlevel
14464 version).
14466 @item -dumpfullversion
14467 @opindex dumpfullversion
14468 Print the full compiler version, always 3 numbers separated by dots,
14469 major, minor and patchlevel version.
14471 @item -dumpspecs
14472 @opindex dumpspecs
14473 Print the compiler's built-in specs---and don't do anything else.  (This
14474 is used when GCC itself is being built.)  @xref{Spec Files}.
14475 @end table
14477 @node Submodel Options
14478 @section Machine-Dependent Options
14479 @cindex submodel options
14480 @cindex specifying hardware config
14481 @cindex hardware models and configurations, specifying
14482 @cindex target-dependent options
14483 @cindex machine-dependent options
14485 Each target machine supported by GCC can have its own options---for
14486 example, to allow you to compile for a particular processor variant or
14487 ABI, or to control optimizations specific to that machine.  By
14488 convention, the names of machine-specific options start with
14489 @samp{-m}.
14491 Some configurations of the compiler also support additional target-specific
14492 options, usually for compatibility with other compilers on the same
14493 platform.
14495 @c This list is ordered alphanumerically by subsection name.
14496 @c It should be the same order and spelling as these options are listed
14497 @c in Machine Dependent Options
14499 @menu
14500 * AArch64 Options::
14501 * Adapteva Epiphany Options::
14502 * ARC Options::
14503 * ARM Options::
14504 * AVR Options::
14505 * Blackfin Options::
14506 * C6X Options::
14507 * CRIS Options::
14508 * CR16 Options::
14509 * Darwin Options::
14510 * DEC Alpha Options::
14511 * FR30 Options::
14512 * FT32 Options::
14513 * FRV Options::
14514 * GNU/Linux Options::
14515 * H8/300 Options::
14516 * HPPA Options::
14517 * IA-64 Options::
14518 * LM32 Options::
14519 * M32C Options::
14520 * M32R/D Options::
14521 * M680x0 Options::
14522 * MCore Options::
14523 * MeP Options::
14524 * MicroBlaze Options::
14525 * MIPS Options::
14526 * MMIX Options::
14527 * MN10300 Options::
14528 * Moxie Options::
14529 * MSP430 Options::
14530 * NDS32 Options::
14531 * Nios II Options::
14532 * Nvidia PTX Options::
14533 * PDP-11 Options::
14534 * picoChip Options::
14535 * PowerPC Options::
14536 * PowerPC SPE Options::
14537 * RISC-V Options::
14538 * RL78 Options::
14539 * RS/6000 and PowerPC Options::
14540 * RX Options::
14541 * S/390 and zSeries Options::
14542 * Score Options::
14543 * SH Options::
14544 * Solaris 2 Options::
14545 * SPARC Options::
14546 * SPU Options::
14547 * System V Options::
14548 * TILE-Gx Options::
14549 * TILEPro Options::
14550 * V850 Options::
14551 * VAX Options::
14552 * Visium Options::
14553 * VMS Options::
14554 * VxWorks Options::
14555 * x86 Options::
14556 * x86 Windows Options::
14557 * Xstormy16 Options::
14558 * Xtensa Options::
14559 * zSeries Options::
14560 @end menu
14562 @node AArch64 Options
14563 @subsection AArch64 Options
14564 @cindex AArch64 Options
14566 These options are defined for AArch64 implementations:
14568 @table @gcctabopt
14570 @item -mabi=@var{name}
14571 @opindex mabi
14572 Generate code for the specified data model.  Permissible values
14573 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14574 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14575 but long int and pointers are 64 bits.
14577 The default depends on the specific target configuration.  Note that
14578 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14579 entire program with the same ABI, and link with a compatible set of libraries.
14581 @item -mbig-endian
14582 @opindex mbig-endian
14583 Generate big-endian code.  This is the default when GCC is configured for an
14584 @samp{aarch64_be-*-*} target.
14586 @item -mgeneral-regs-only
14587 @opindex mgeneral-regs-only
14588 Generate code which uses only the general-purpose registers.  This will prevent
14589 the compiler from using floating-point and Advanced SIMD registers but will not
14590 impose any restrictions on the assembler.
14592 @item -mlittle-endian
14593 @opindex mlittle-endian
14594 Generate little-endian code.  This is the default when GCC is configured for an
14595 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14597 @item -mcmodel=tiny
14598 @opindex mcmodel=tiny
14599 Generate code for the tiny code model.  The program and its statically defined
14600 symbols must be within 1MB of each other.  Programs can be statically or
14601 dynamically linked.
14603 @item -mcmodel=small
14604 @opindex mcmodel=small
14605 Generate code for the small code model.  The program and its statically defined
14606 symbols must be within 4GB of each other.  Programs can be statically or
14607 dynamically linked.  This is the default code model.
14609 @item -mcmodel=large
14610 @opindex mcmodel=large
14611 Generate code for the large code model.  This makes no assumptions about
14612 addresses and sizes of sections.  Programs can be statically linked only.
14614 @item -mstrict-align
14615 @opindex mstrict-align
14616 Avoid generating memory accesses that may not be aligned on a natural object
14617 boundary as described in the architecture specification.
14619 @item -momit-leaf-frame-pointer
14620 @itemx -mno-omit-leaf-frame-pointer
14621 @opindex momit-leaf-frame-pointer
14622 @opindex mno-omit-leaf-frame-pointer
14623 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14624 default.
14626 @item -mtls-dialect=desc
14627 @opindex mtls-dialect=desc
14628 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14629 of TLS variables.  This is the default.
14631 @item -mtls-dialect=traditional
14632 @opindex mtls-dialect=traditional
14633 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14634 of TLS variables.
14636 @item -mtls-size=@var{size}
14637 @opindex mtls-size
14638 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14639 This option requires binutils 2.26 or newer.
14641 @item -mfix-cortex-a53-835769
14642 @itemx -mno-fix-cortex-a53-835769
14643 @opindex mfix-cortex-a53-835769
14644 @opindex mno-fix-cortex-a53-835769
14645 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14646 This involves inserting a NOP instruction between memory instructions and
14647 64-bit integer multiply-accumulate instructions.
14649 @item -mfix-cortex-a53-843419
14650 @itemx -mno-fix-cortex-a53-843419
14651 @opindex mfix-cortex-a53-843419
14652 @opindex mno-fix-cortex-a53-843419
14653 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14654 This erratum workaround is made at link time and this will only pass the
14655 corresponding flag to the linker.
14657 @item -mlow-precision-recip-sqrt
14658 @itemx -mno-low-precision-recip-sqrt
14659 @opindex mlow-precision-recip-sqrt
14660 @opindex mno-low-precision-recip-sqrt
14661 Enable or disable the reciprocal square root approximation.
14662 This option only has an effect if @option{-ffast-math} or
14663 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14664 precision of reciprocal square root results to about 16 bits for
14665 single precision and to 32 bits for double precision.
14667 @item -mlow-precision-sqrt
14668 @itemx -mno-low-precision-sqrt
14669 @opindex -mlow-precision-sqrt
14670 @opindex -mno-low-precision-sqrt
14671 Enable or disable the square root approximation.
14672 This option only has an effect if @option{-ffast-math} or
14673 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14674 precision of square root results to about 16 bits for
14675 single precision and to 32 bits for double precision.
14676 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14678 @item -mlow-precision-div
14679 @itemx -mno-low-precision-div
14680 @opindex -mlow-precision-div
14681 @opindex -mno-low-precision-div
14682 Enable or disable the division approximation.
14683 This option only has an effect if @option{-ffast-math} or
14684 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14685 precision of division results to about 16 bits for
14686 single precision and to 32 bits for double precision.
14688 @item -march=@var{name}
14689 @opindex march
14690 Specify the name of the target architecture and, optionally, one or
14691 more feature modifiers.  This option has the form
14692 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14694 The permissible values for @var{arch} are @samp{armv8-a},
14695 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14696 or @var{native}.
14698 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14699 support for the ARMv8.4-A architecture extensions.
14701 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14702 support for the ARMv8.3-A architecture extensions.
14704 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14705 support for the ARMv8.2-A architecture extensions.
14707 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14708 support for the ARMv8.1-A architecture extension.  In particular, it
14709 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14711 The value @samp{native} is available on native AArch64 GNU/Linux and
14712 causes the compiler to pick the architecture of the host system.  This
14713 option has no effect if the compiler is unable to recognize the
14714 architecture of the host system,
14716 The permissible values for @var{feature} are listed in the sub-section
14717 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14718 Feature Modifiers}.  Where conflicting feature modifiers are
14719 specified, the right-most feature is used.
14721 GCC uses @var{name} to determine what kind of instructions it can emit
14722 when generating assembly code.  If @option{-march} is specified
14723 without either of @option{-mtune} or @option{-mcpu} also being
14724 specified, the code is tuned to perform well across a range of target
14725 processors implementing the target architecture.
14727 @item -mtune=@var{name}
14728 @opindex mtune
14729 Specify the name of the target processor for which GCC should tune the
14730 performance of the code.  Permissible values for this option are:
14731 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14732 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14733 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14734 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14735 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14736 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14737 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14738 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14739 @samp{native}.
14741 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14742 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14743 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14744 big.LITTLE system.
14746 Additionally on native AArch64 GNU/Linux systems the value
14747 @samp{native} tunes performance to the host system.  This option has no effect
14748 if the compiler is unable to recognize the processor of the host system.
14750 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14751 are specified, the code is tuned to perform well across a range
14752 of target processors.
14754 This option cannot be suffixed by feature modifiers.
14756 @item -mcpu=@var{name}
14757 @opindex mcpu
14758 Specify the name of the target processor, optionally suffixed by one
14759 or more feature modifiers.  This option has the form
14760 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14761 the permissible values for @var{cpu} are the same as those available
14762 for @option{-mtune}.  The permissible values for @var{feature} are
14763 documented in the sub-section on
14764 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14765 Feature Modifiers}.  Where conflicting feature modifiers are
14766 specified, the right-most feature is used.
14768 GCC uses @var{name} to determine what kind of instructions it can emit when
14769 generating assembly code (as if by @option{-march}) and to determine
14770 the target processor for which to tune for performance (as if
14771 by @option{-mtune}).  Where this option is used in conjunction
14772 with @option{-march} or @option{-mtune}, those options take precedence
14773 over the appropriate part of this option.
14775 @item -moverride=@var{string}
14776 @opindex moverride
14777 Override tuning decisions made by the back-end in response to a
14778 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14779 for @var{string} in this option are not guaranteed to be consistent
14780 across releases.
14782 This option is only intended to be useful when developing GCC.
14784 @item -mverbose-cost-dump
14785 @opindex mverbose-cost-dump
14786 Enable verbose cost model dumping in the debug dump files.  This option is
14787 provided for use in debugging the compiler.
14789 @item -mpc-relative-literal-loads
14790 @itemx -mno-pc-relative-literal-loads
14791 @opindex mpc-relative-literal-loads
14792 @opindex mno-pc-relative-literal-loads
14793 Enable or disable PC-relative literal loads.  With this option literal pools are
14794 accessed using a single instruction and emitted after each function.  This
14795 limits the maximum size of functions to 1MB.  This is enabled by default for
14796 @option{-mcmodel=tiny}.
14798 @item -msign-return-address=@var{scope}
14799 @opindex msign-return-address
14800 Select the function scope on which return address signing will be applied.
14801 Permissible values are @samp{none}, which disables return address signing,
14802 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14803 functions, and @samp{all}, which enables pointer signing for all functions.  The
14804 default value is @samp{none}.
14806 @item -msve-vector-bits=@var{bits}
14807 @opindex msve-vector-bits
14808 Specify the number of bits in an SVE vector register.  This option only has
14809 an effect when SVE is enabled.
14811 GCC supports two forms of SVE code generation: ``vector-length
14812 agnostic'' output that works with any size of vector register and
14813 ``vector-length specific'' output that only works when the vector
14814 registers are a particular size.  Replacing @var{bits} with
14815 @samp{scalable} selects vector-length agnostic output while
14816 replacing it with a number selects vector-length specific output.
14817 The possible lengths in the latter case are: 128, 256, 512, 1024
14818 and 2048.  @samp{scalable} is the default.
14820 At present, @samp{-msve-vector-bits=128} produces the same output
14821 as @samp{-msve-vector-bits=scalable}.
14823 @end table
14825 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14826 @anchor{aarch64-feature-modifiers}
14827 @cindex @option{-march} feature modifiers
14828 @cindex @option{-mcpu} feature modifiers
14829 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14830 the following and their inverses @option{no@var{feature}}:
14832 @table @samp
14833 @item crc
14834 Enable CRC extension.  This is on by default for
14835 @option{-march=armv8.1-a}.
14836 @item crypto
14837 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14838 instructions.
14839 @item fp
14840 Enable floating-point instructions.  This is on by default for all possible
14841 values for options @option{-march} and @option{-mcpu}.
14842 @item simd
14843 Enable Advanced SIMD instructions.  This also enables floating-point
14844 instructions.  This is on by default for all possible values for options
14845 @option{-march} and @option{-mcpu}.
14846 @item sve
14847 Enable Scalable Vector Extension instructions.  This also enables Advanced
14848 SIMD and floating-point instructions.
14849 @item lse
14850 Enable Large System Extension instructions.  This is on by default for
14851 @option{-march=armv8.1-a}.
14852 @item rdma
14853 Enable Round Double Multiply Accumulate instructions.  This is on by default
14854 for @option{-march=armv8.1-a}.
14855 @item fp16
14856 Enable FP16 extension.  This also enables floating-point instructions.
14857 @item fp16fml
14858 Enable FP16 fmla extension.  This also enables FP16 extensions and
14859 floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported.
14861 @item rcpc
14862 Enable the RcPc extension.  This does not change code generation from GCC,
14863 but is passed on to the assembler, enabling inline asm statements to use
14864 instructions from the RcPc extension.
14865 @item dotprod
14866 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14867 @item aes
14868 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14869 SIMD instructions.
14870 @item sha2
14871 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14872 @item sha3
14873 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14874 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14875 @item sm4
14876 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14877 Use of this option with architectures prior to Armv8.2-A is not supported.
14879 @end table
14881 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14882 which implies @option{fp}.
14883 Conversely, @option{nofp} implies @option{nosimd}, which implies
14884 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14886 @node Adapteva Epiphany Options
14887 @subsection Adapteva Epiphany Options
14889 These @samp{-m} options are defined for Adapteva Epiphany:
14891 @table @gcctabopt
14892 @item -mhalf-reg-file
14893 @opindex mhalf-reg-file
14894 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14895 That allows code to run on hardware variants that lack these registers.
14897 @item -mprefer-short-insn-regs
14898 @opindex mprefer-short-insn-regs
14899 Preferentially allocate registers that allow short instruction generation.
14900 This can result in increased instruction count, so this may either reduce or
14901 increase overall code size.
14903 @item -mbranch-cost=@var{num}
14904 @opindex mbranch-cost
14905 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14906 This cost is only a heuristic and is not guaranteed to produce
14907 consistent results across releases.
14909 @item -mcmove
14910 @opindex mcmove
14911 Enable the generation of conditional moves.
14913 @item -mnops=@var{num}
14914 @opindex mnops
14915 Emit @var{num} NOPs before every other generated instruction.
14917 @item -mno-soft-cmpsf
14918 @opindex mno-soft-cmpsf
14919 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14920 and test the flags.  This is faster than a software comparison, but can
14921 get incorrect results in the presence of NaNs, or when two different small
14922 numbers are compared such that their difference is calculated as zero.
14923 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14924 software comparisons.
14926 @item -mstack-offset=@var{num}
14927 @opindex mstack-offset
14928 Set the offset between the top of the stack and the stack pointer.
14929 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14930 can be used by leaf functions without stack allocation.
14931 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14932 Note also that this option changes the ABI; compiling a program with a
14933 different stack offset than the libraries have been compiled with
14934 generally does not work.
14935 This option can be useful if you want to evaluate if a different stack
14936 offset would give you better code, but to actually use a different stack
14937 offset to build working programs, it is recommended to configure the
14938 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14940 @item -mno-round-nearest
14941 @opindex mno-round-nearest
14942 Make the scheduler assume that the rounding mode has been set to
14943 truncating.  The default is @option{-mround-nearest}.
14945 @item -mlong-calls
14946 @opindex mlong-calls
14947 If not otherwise specified by an attribute, assume all calls might be beyond
14948 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14949 function address into a register before performing a (otherwise direct) call.
14950 This is the default.
14952 @item -mshort-calls
14953 @opindex short-calls
14954 If not otherwise specified by an attribute, assume all direct calls are
14955 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14956 for direct calls.  The default is @option{-mlong-calls}.
14958 @item -msmall16
14959 @opindex msmall16
14960 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14961 apply to function addresses for which @option{-mlong-calls} semantics
14962 are in effect.
14964 @item -mfp-mode=@var{mode}
14965 @opindex mfp-mode
14966 Set the prevailing mode of the floating-point unit.
14967 This determines the floating-point mode that is provided and expected
14968 at function call and return time.  Making this mode match the mode you
14969 predominantly need at function start can make your programs smaller and
14970 faster by avoiding unnecessary mode switches.
14972 @var{mode} can be set to one the following values:
14974 @table @samp
14975 @item caller
14976 Any mode at function entry is valid, and retained or restored when
14977 the function returns, and when it calls other functions.
14978 This mode is useful for compiling libraries or other compilation units
14979 you might want to incorporate into different programs with different
14980 prevailing FPU modes, and the convenience of being able to use a single
14981 object file outweighs the size and speed overhead for any extra
14982 mode switching that might be needed, compared with what would be needed
14983 with a more specific choice of prevailing FPU mode.
14985 @item truncate
14986 This is the mode used for floating-point calculations with
14987 truncating (i.e.@: round towards zero) rounding mode.  That includes
14988 conversion from floating point to integer.
14990 @item round-nearest
14991 This is the mode used for floating-point calculations with
14992 round-to-nearest-or-even rounding mode.
14994 @item int
14995 This is the mode used to perform integer calculations in the FPU, e.g.@:
14996 integer multiply, or integer multiply-and-accumulate.
14997 @end table
14999 The default is @option{-mfp-mode=caller}
15001 @item -mnosplit-lohi
15002 @itemx -mno-postinc
15003 @itemx -mno-postmodify
15004 @opindex mnosplit-lohi
15005 @opindex mno-postinc
15006 @opindex mno-postmodify
15007 Code generation tweaks that disable, respectively, splitting of 32-bit
15008 loads, generation of post-increment addresses, and generation of
15009 post-modify addresses.  The defaults are @option{msplit-lohi},
15010 @option{-mpost-inc}, and @option{-mpost-modify}.
15012 @item -mnovect-double
15013 @opindex mno-vect-double
15014 Change the preferred SIMD mode to SImode.  The default is
15015 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15017 @item -max-vect-align=@var{num}
15018 @opindex max-vect-align
15019 The maximum alignment for SIMD vector mode types.
15020 @var{num} may be 4 or 8.  The default is 8.
15021 Note that this is an ABI change, even though many library function
15022 interfaces are unaffected if they don't use SIMD vector modes
15023 in places that affect size and/or alignment of relevant types.
15025 @item -msplit-vecmove-early
15026 @opindex msplit-vecmove-early
15027 Split vector moves into single word moves before reload.  In theory this
15028 can give better register allocation, but so far the reverse seems to be
15029 generally the case.
15031 @item -m1reg-@var{reg}
15032 @opindex m1reg-
15033 Specify a register to hold the constant @minus{}1, which makes loading small negative
15034 constants and certain bitmasks faster.
15035 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15036 which specify use of that register as a fixed register,
15037 and @samp{none}, which means that no register is used for this
15038 purpose.  The default is @option{-m1reg-none}.
15040 @end table
15042 @node ARC Options
15043 @subsection ARC Options
15044 @cindex ARC options
15046 The following options control the architecture variant for which code
15047 is being compiled:
15049 @c architecture variants
15050 @table @gcctabopt
15052 @item -mbarrel-shifter
15053 @opindex mbarrel-shifter
15054 Generate instructions supported by barrel shifter.  This is the default
15055 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15057 @item -mjli-always
15058 @opindex mjli-alawys
15059 Force to call a function using jli_s instruction.  This option is
15060 valid only for ARCv2 architecture.
15062 @item -mcpu=@var{cpu}
15063 @opindex mcpu
15064 Set architecture type, register usage, and instruction scheduling
15065 parameters for @var{cpu}.  There are also shortcut alias options
15066 available for backward compatibility and convenience.  Supported
15067 values for @var{cpu} are
15069 @table @samp
15070 @opindex mA6
15071 @opindex mARC600
15072 @item arc600
15073 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15075 @item arc601
15076 @opindex mARC601
15077 Compile for ARC601.  Alias: @option{-mARC601}.
15079 @item arc700
15080 @opindex mA7
15081 @opindex mARC700
15082 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15083 This is the default when configured with @option{--with-cpu=arc700}@.
15085 @item arcem
15086 Compile for ARC EM.
15088 @item archs
15089 Compile for ARC HS.
15091 @item em
15092 Compile for ARC EM CPU with no hardware extensions.
15094 @item em4
15095 Compile for ARC EM4 CPU.
15097 @item em4_dmips
15098 Compile for ARC EM4 DMIPS CPU.
15100 @item em4_fpus
15101 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15102 extension.
15104 @item em4_fpuda
15105 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15106 double assist instructions.
15108 @item hs
15109 Compile for ARC HS CPU with no hardware extensions except the atomic
15110 instructions.
15112 @item hs34
15113 Compile for ARC HS34 CPU.
15115 @item hs38
15116 Compile for ARC HS38 CPU.
15118 @item hs38_linux
15119 Compile for ARC HS38 CPU with all hardware extensions on.
15121 @item arc600_norm
15122 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15124 @item arc600_mul32x16
15125 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15126 instructions enabled.
15128 @item arc600_mul64
15129 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15130 instructions enabled.
15132 @item arc601_norm
15133 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15135 @item arc601_mul32x16
15136 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15137 instructions enabled.
15139 @item arc601_mul64
15140 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15141 instructions enabled.
15143 @item nps400
15144 Compile for ARC 700 on NPS400 chip.
15146 @item em_mini
15147 Compile for ARC EM minimalist configuration featuring reduced register
15148 set.
15150 @end table
15152 @item -mdpfp
15153 @opindex mdpfp
15154 @itemx -mdpfp-compact
15155 @opindex mdpfp-compact
15156 Generate double-precision FPX instructions, tuned for the compact
15157 implementation.
15159 @item -mdpfp-fast
15160 @opindex mdpfp-fast
15161 Generate double-precision FPX instructions, tuned for the fast
15162 implementation.
15164 @item -mno-dpfp-lrsr
15165 @opindex mno-dpfp-lrsr
15166 Disable @code{lr} and @code{sr} instructions from using FPX extension
15167 aux registers.
15169 @item -mea
15170 @opindex mea
15171 Generate extended arithmetic instructions.  Currently only
15172 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15173 supported.  This is always enabled for @option{-mcpu=ARC700}.
15175 @item -mno-mpy
15176 @opindex mno-mpy
15177 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15178 deprecated.
15180 @item -mmul32x16
15181 @opindex mmul32x16
15182 Generate 32x16-bit multiply and multiply-accumulate instructions.
15184 @item -mmul64
15185 @opindex mmul64
15186 Generate @code{mul64} and @code{mulu64} instructions.  
15187 Only valid for @option{-mcpu=ARC600}.
15189 @item -mnorm
15190 @opindex mnorm
15191 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15192 is in effect.
15194 @item -mspfp
15195 @opindex mspfp
15196 @itemx -mspfp-compact
15197 @opindex mspfp-compact
15198 Generate single-precision FPX instructions, tuned for the compact
15199 implementation.
15201 @item -mspfp-fast
15202 @opindex mspfp-fast
15203 Generate single-precision FPX instructions, tuned for the fast
15204 implementation.
15206 @item -msimd
15207 @opindex msimd
15208 Enable generation of ARC SIMD instructions via target-specific
15209 builtins.  Only valid for @option{-mcpu=ARC700}.
15211 @item -msoft-float
15212 @opindex msoft-float
15213 This option ignored; it is provided for compatibility purposes only.
15214 Software floating-point code is emitted by default, and this default
15215 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15216 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15217 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15219 @item -mswap
15220 @opindex mswap
15221 Generate @code{swap} instructions.
15223 @item -matomic
15224 @opindex matomic
15225 This enables use of the locked load/store conditional extension to implement
15226 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15227 EM cores.
15229 @item -mdiv-rem
15230 @opindex mdiv-rem
15231 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15233 @item -mcode-density
15234 @opindex mcode-density
15235 Enable code density instructions for ARC EM.  
15236 This option is on by default for ARC HS.
15238 @item -mll64
15239 @opindex mll64
15240 Enable double load/store operations for ARC HS cores.
15242 @item -mtp-regno=@var{regno}
15243 @opindex mtp-regno
15244 Specify thread pointer register number.
15246 @item -mmpy-option=@var{multo}
15247 @opindex mmpy-option
15248 Compile ARCv2 code with a multiplier design option.  You can specify 
15249 the option using either a string or numeric value for @var{multo}.  
15250 @samp{wlh1} is the default value.  The recognized values are:
15252 @table @samp
15253 @item 0
15254 @itemx none
15255 No multiplier available.
15257 @item 1
15258 @itemx w
15259 16x16 multiplier, fully pipelined.
15260 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15262 @item 2
15263 @itemx wlh1
15264 32x32 multiplier, fully
15265 pipelined (1 stage).  The following instructions are additionally
15266 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15268 @item 3
15269 @itemx wlh2
15270 32x32 multiplier, fully pipelined
15271 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15272 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15274 @item 4
15275 @itemx wlh3
15276 Two 16x16 multipliers, blocking,
15277 sequential.  The following instructions are additionally enabled: @code{mpy},
15278 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15280 @item 5
15281 @itemx wlh4
15282 One 16x16 multiplier, blocking,
15283 sequential.  The following instructions are additionally enabled: @code{mpy},
15284 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15286 @item 6
15287 @itemx wlh5
15288 One 32x4 multiplier, blocking,
15289 sequential.  The following instructions are additionally enabled: @code{mpy},
15290 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15292 @item 7
15293 @itemx plus_dmpy
15294 ARC HS SIMD support.
15296 @item 8
15297 @itemx plus_macd
15298 ARC HS SIMD support.
15300 @item 9
15301 @itemx plus_qmacw
15302 ARC HS SIMD support.
15304 @end table
15306 This option is only available for ARCv2 cores@.
15308 @item -mfpu=@var{fpu}
15309 @opindex mfpu
15310 Enables support for specific floating-point hardware extensions for ARCv2
15311 cores.  Supported values for @var{fpu} are:
15313 @table @samp
15315 @item fpus
15316 Enables support for single-precision floating-point hardware
15317 extensions@.
15319 @item fpud
15320 Enables support for double-precision floating-point hardware
15321 extensions.  The single-precision floating-point extension is also
15322 enabled.  Not available for ARC EM@.
15324 @item fpuda
15325 Enables support for double-precision floating-point hardware
15326 extensions using double-precision assist instructions.  The single-precision
15327 floating-point extension is also enabled.  This option is
15328 only available for ARC EM@.
15330 @item fpuda_div
15331 Enables support for double-precision floating-point hardware
15332 extensions using double-precision assist instructions.
15333 The single-precision floating-point, square-root, and divide 
15334 extensions are also enabled.  This option is
15335 only available for ARC EM@.
15337 @item fpuda_fma
15338 Enables support for double-precision floating-point hardware
15339 extensions using double-precision assist instructions.
15340 The single-precision floating-point and fused multiply and add 
15341 hardware extensions are also enabled.  This option is
15342 only available for ARC EM@.
15344 @item fpuda_all
15345 Enables support for double-precision floating-point hardware
15346 extensions using double-precision assist instructions.
15347 All single-precision floating-point hardware extensions are also
15348 enabled.  This option is only available for ARC EM@.
15350 @item fpus_div
15351 Enables support for single-precision floating-point, square-root and divide 
15352 hardware extensions@.
15354 @item fpud_div
15355 Enables support for double-precision floating-point, square-root and divide 
15356 hardware extensions.  This option
15357 includes option @samp{fpus_div}. Not available for ARC EM@.
15359 @item fpus_fma
15360 Enables support for single-precision floating-point and 
15361 fused multiply and add hardware extensions@.
15363 @item fpud_fma
15364 Enables support for double-precision floating-point and 
15365 fused multiply and add hardware extensions.  This option
15366 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15368 @item fpus_all
15369 Enables support for all single-precision floating-point hardware
15370 extensions@.
15372 @item fpud_all
15373 Enables support for all single- and double-precision floating-point
15374 hardware extensions.  Not available for ARC EM@.
15376 @end table
15378 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15379 @opindex mirq-ctrl-saved
15380 Specifies general-purposes registers that the processor automatically
15381 saves/restores on interrupt entry and exit.  @var{register-range} is
15382 specified as two registers separated by a dash.  The register range
15383 always starts with @code{r0}, the upper limit is @code{fp} register.
15384 @var{blink} and @var{lp_count} are optional.  This option is only
15385 valid for ARC EM and ARC HS cores.
15387 @item -mrgf-banked-regs=@var{number}
15388 @opindex mrgf-banked-regs
15389 Specifies the number of registers replicated in second register bank
15390 on entry to fast interrupt.  Fast interrupts are interrupts with the
15391 highest priority level P0.  These interrupts save only PC and STATUS32
15392 registers to avoid memory transactions during interrupt entry and exit
15393 sequences.  Use this option when you are using fast interrupts in an
15394 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15396 @item -mlpc-width=@var{width}
15397 @opindex mlpc-width
15398 Specify the width of the @code{lp_count} register.  Valid values for
15399 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15400 fixed to 32 bits.  If the width is less than 32, the compiler does not
15401 attempt to transform loops in your program to use the zero-delay loop
15402 mechanism unless it is known that the @code{lp_count} register can
15403 hold the required loop-counter value.  Depending on the width
15404 specified, the compiler and run-time library might continue to use the
15405 loop mechanism for various needs.  This option defines macro
15406 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15408 @item -mrf16
15409 @opindex mrf16
15410 This option instructs the compiler to generate code for a 16-entry
15411 register file.  This option defines the @code{__ARC_RF16__}
15412 preprocessor macro.
15414 @end table
15416 The following options are passed through to the assembler, and also
15417 define preprocessor macro symbols.
15419 @c Flags used by the assembler, but for which we define preprocessor
15420 @c macro symbols as well.
15421 @table @gcctabopt
15422 @item -mdsp-packa
15423 @opindex mdsp-packa
15424 Passed down to the assembler to enable the DSP Pack A extensions.
15425 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15426 deprecated.
15428 @item -mdvbf
15429 @opindex mdvbf
15430 Passed down to the assembler to enable the dual Viterbi butterfly
15431 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15432 option is deprecated.
15434 @c ARC700 4.10 extension instruction
15435 @item -mlock
15436 @opindex mlock
15437 Passed down to the assembler to enable the locked load/store
15438 conditional extension.  Also sets the preprocessor symbol
15439 @code{__Xlock}.
15441 @item -mmac-d16
15442 @opindex mmac-d16
15443 Passed down to the assembler.  Also sets the preprocessor symbol
15444 @code{__Xxmac_d16}.  This option is deprecated.
15446 @item -mmac-24
15447 @opindex mmac-24
15448 Passed down to the assembler.  Also sets the preprocessor symbol
15449 @code{__Xxmac_24}.  This option is deprecated.
15451 @c ARC700 4.10 extension instruction
15452 @item -mrtsc
15453 @opindex mrtsc
15454 Passed down to the assembler to enable the 64-bit time-stamp counter
15455 extension instruction.  Also sets the preprocessor symbol
15456 @code{__Xrtsc}.  This option is deprecated.
15458 @c ARC700 4.10 extension instruction
15459 @item -mswape
15460 @opindex mswape
15461 Passed down to the assembler to enable the swap byte ordering
15462 extension instruction.  Also sets the preprocessor symbol
15463 @code{__Xswape}.
15465 @item -mtelephony
15466 @opindex mtelephony
15467 Passed down to the assembler to enable dual- and single-operand
15468 instructions for telephony.  Also sets the preprocessor symbol
15469 @code{__Xtelephony}.  This option is deprecated.
15471 @item -mxy
15472 @opindex mxy
15473 Passed down to the assembler to enable the XY memory extension.  Also
15474 sets the preprocessor symbol @code{__Xxy}.
15476 @end table
15478 The following options control how the assembly code is annotated:
15480 @c Assembly annotation options
15481 @table @gcctabopt
15482 @item -misize
15483 @opindex misize
15484 Annotate assembler instructions with estimated addresses.
15486 @item -mannotate-align
15487 @opindex mannotate-align
15488 Explain what alignment considerations lead to the decision to make an
15489 instruction short or long.
15491 @end table
15493 The following options are passed through to the linker:
15495 @c options passed through to the linker
15496 @table @gcctabopt
15497 @item -marclinux
15498 @opindex marclinux
15499 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15500 This option is enabled by default in tool chains built for
15501 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15502 when profiling is not requested.
15504 @item -marclinux_prof
15505 @opindex marclinux_prof
15506 Passed through to the linker, to specify use of the
15507 @code{arclinux_prof} emulation.  This option is enabled by default in
15508 tool chains built for @w{@code{arc-linux-uclibc}} and
15509 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15511 @end table
15513 The following options control the semantics of generated code:
15515 @c semantically relevant code generation options
15516 @table @gcctabopt
15517 @item -mlong-calls
15518 @opindex mlong-calls
15519 Generate calls as register indirect calls, thus providing access
15520 to the full 32-bit address range.
15522 @item -mmedium-calls
15523 @opindex mmedium-calls
15524 Don't use less than 25-bit addressing range for calls, which is the
15525 offset available for an unconditional branch-and-link
15526 instruction.  Conditional execution of function calls is suppressed, to
15527 allow use of the 25-bit range, rather than the 21-bit range with
15528 conditional branch-and-link.  This is the default for tool chains built
15529 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15531 @item -G @var{num}
15532 @opindex G
15533 Put definitions of externally-visible data in a small data section if
15534 that data is no bigger than @var{num} bytes.  The default value of
15535 @var{num} is 4 for any ARC configuration, or 8 when we have double
15536 load/store operations.
15538 @item -mno-sdata
15539 @opindex mno-sdata
15540 Do not generate sdata references.  This is the default for tool chains
15541 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15542 targets.
15544 @item -mvolatile-cache
15545 @opindex mvolatile-cache
15546 Use ordinarily cached memory accesses for volatile references.  This is the
15547 default.
15549 @item -mno-volatile-cache
15550 @opindex mno-volatile-cache
15551 Enable cache bypass for volatile references.
15553 @end table
15555 The following options fine tune code generation:
15556 @c code generation tuning options
15557 @table @gcctabopt
15558 @item -malign-call
15559 @opindex malign-call
15560 Do alignment optimizations for call instructions.
15562 @item -mauto-modify-reg
15563 @opindex mauto-modify-reg
15564 Enable the use of pre/post modify with register displacement.
15566 @item -mbbit-peephole
15567 @opindex mbbit-peephole
15568 Enable bbit peephole2.
15570 @item -mno-brcc
15571 @opindex mno-brcc
15572 This option disables a target-specific pass in @file{arc_reorg} to
15573 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15574 It has no effect on
15575 generation of these instructions driven by the combiner pass.
15577 @item -mcase-vector-pcrel
15578 @opindex mcase-vector-pcrel
15579 Use PC-relative switch case tables to enable case table shortening.
15580 This is the default for @option{-Os}.
15582 @item -mcompact-casesi
15583 @opindex mcompact-casesi
15584 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15585 and only available for ARCv1 cores.
15587 @item -mno-cond-exec
15588 @opindex mno-cond-exec
15589 Disable the ARCompact-specific pass to generate conditional 
15590 execution instructions.
15592 Due to delay slot scheduling and interactions between operand numbers,
15593 literal sizes, instruction lengths, and the support for conditional execution,
15594 the target-independent pass to generate conditional execution is often lacking,
15595 so the ARC port has kept a special pass around that tries to find more
15596 conditional execution generation opportunities after register allocation,
15597 branch shortening, and delay slot scheduling have been done.  This pass
15598 generally, but not always, improves performance and code size, at the cost of
15599 extra compilation time, which is why there is an option to switch it off.
15600 If you have a problem with call instructions exceeding their allowable
15601 offset range because they are conditionalized, you should consider using
15602 @option{-mmedium-calls} instead.
15604 @item -mearly-cbranchsi
15605 @opindex mearly-cbranchsi
15606 Enable pre-reload use of the @code{cbranchsi} pattern.
15608 @item -mexpand-adddi
15609 @opindex mexpand-adddi
15610 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15611 @code{add.f}, @code{adc} etc.  This option is deprecated.
15613 @item -mindexed-loads
15614 @opindex mindexed-loads
15615 Enable the use of indexed loads.  This can be problematic because some
15616 optimizers then assume that indexed stores exist, which is not
15617 the case.
15619 @item -mlra
15620 @opindex mlra
15621 Enable Local Register Allocation.  This is still experimental for ARC,
15622 so by default the compiler uses standard reload
15623 (i.e. @option{-mno-lra}).
15625 @item -mlra-priority-none
15626 @opindex mlra-priority-none
15627 Don't indicate any priority for target registers.
15629 @item -mlra-priority-compact
15630 @opindex mlra-priority-compact
15631 Indicate target register priority for r0..r3 / r12..r15.
15633 @item -mlra-priority-noncompact
15634 @opindex mlra-priority-noncompact
15635 Reduce target register priority for r0..r3 / r12..r15.
15637 @item -mno-millicode
15638 @opindex mno-millicode
15639 When optimizing for size (using @option{-Os}), prologues and epilogues
15640 that have to save or restore a large number of registers are often
15641 shortened by using call to a special function in libgcc; this is
15642 referred to as a @emph{millicode} call.  As these calls can pose
15643 performance issues, and/or cause linking issues when linking in a
15644 nonstandard way, this option is provided to turn off millicode call
15645 generation.
15647 @item -mmixed-code
15648 @opindex mmixed-code
15649 Tweak register allocation to help 16-bit instruction generation.
15650 This generally has the effect of decreasing the average instruction size
15651 while increasing the instruction count.
15653 @item -mq-class
15654 @opindex mq-class
15655 Enable @samp{q} instruction alternatives.
15656 This is the default for @option{-Os}.
15658 @item -mRcq
15659 @opindex mRcq
15660 Enable @samp{Rcq} constraint handling.  
15661 Most short code generation depends on this.
15662 This is the default.
15664 @item -mRcw
15665 @opindex mRcw
15666 Enable @samp{Rcw} constraint handling.  
15667 Most ccfsm condexec mostly depends on this.
15668 This is the default.
15670 @item -msize-level=@var{level}
15671 @opindex msize-level
15672 Fine-tune size optimization with regards to instruction lengths and alignment.
15673 The recognized values for @var{level} are:
15674 @table @samp
15675 @item 0
15676 No size optimization.  This level is deprecated and treated like @samp{1}.
15678 @item 1
15679 Short instructions are used opportunistically.
15681 @item 2
15682 In addition, alignment of loops and of code after barriers are dropped.
15684 @item 3
15685 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15687 @end table
15689 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15690 the behavior when this is not set is equivalent to level @samp{1}.
15692 @item -mtune=@var{cpu}
15693 @opindex mtune
15694 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15695 by @option{-mcpu=}.
15697 Supported values for @var{cpu} are
15699 @table @samp
15700 @item ARC600
15701 Tune for ARC600 CPU.
15703 @item ARC601
15704 Tune for ARC601 CPU.
15706 @item ARC700
15707 Tune for ARC700 CPU with standard multiplier block.
15709 @item ARC700-xmac
15710 Tune for ARC700 CPU with XMAC block.
15712 @item ARC725D
15713 Tune for ARC725D CPU.
15715 @item ARC750D
15716 Tune for ARC750D CPU.
15718 @end table
15720 @item -mmultcost=@var{num}
15721 @opindex mmultcost
15722 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15723 normal instruction.
15725 @item -munalign-prob-threshold=@var{probability}
15726 @opindex munalign-prob-threshold
15727 Set probability threshold for unaligning branches.
15728 When tuning for @samp{ARC700} and optimizing for speed, branches without
15729 filled delay slot are preferably emitted unaligned and long, unless
15730 profiling indicates that the probability for the branch to be taken
15731 is below @var{probability}.  @xref{Cross-profiling}.
15732 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15734 @end table
15736 The following options are maintained for backward compatibility, but
15737 are now deprecated and will be removed in a future release:
15739 @c Deprecated options
15740 @table @gcctabopt
15742 @item -margonaut
15743 @opindex margonaut
15744 Obsolete FPX.
15746 @item -mbig-endian
15747 @opindex mbig-endian
15748 @itemx -EB
15749 @opindex EB
15750 Compile code for big-endian targets.  Use of these options is now
15751 deprecated.  Big-endian code is supported by configuring GCC to build
15752 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15753 for which big endian is the default.
15755 @item -mlittle-endian
15756 @opindex mlittle-endian
15757 @itemx -EL
15758 @opindex EL
15759 Compile code for little-endian targets.  Use of these options is now
15760 deprecated.  Little-endian code is supported by configuring GCC to build 
15761 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15762 for which little endian is the default.
15764 @item -mbarrel_shifter
15765 @opindex mbarrel_shifter
15766 Replaced by @option{-mbarrel-shifter}.
15768 @item -mdpfp_compact
15769 @opindex mdpfp_compact
15770 Replaced by @option{-mdpfp-compact}.
15772 @item -mdpfp_fast
15773 @opindex mdpfp_fast
15774 Replaced by @option{-mdpfp-fast}.
15776 @item -mdsp_packa
15777 @opindex mdsp_packa
15778 Replaced by @option{-mdsp-packa}.
15780 @item -mEA
15781 @opindex mEA
15782 Replaced by @option{-mea}.
15784 @item -mmac_24
15785 @opindex mmac_24
15786 Replaced by @option{-mmac-24}.
15788 @item -mmac_d16
15789 @opindex mmac_d16
15790 Replaced by @option{-mmac-d16}.
15792 @item -mspfp_compact
15793 @opindex mspfp_compact
15794 Replaced by @option{-mspfp-compact}.
15796 @item -mspfp_fast
15797 @opindex mspfp_fast
15798 Replaced by @option{-mspfp-fast}.
15800 @item -mtune=@var{cpu}
15801 @opindex mtune
15802 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15803 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15804 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15806 @item -multcost=@var{num}
15807 @opindex multcost
15808 Replaced by @option{-mmultcost}.
15810 @end table
15812 @node ARM Options
15813 @subsection ARM Options
15814 @cindex ARM options
15816 These @samp{-m} options are defined for the ARM port:
15818 @table @gcctabopt
15819 @item -mabi=@var{name}
15820 @opindex mabi
15821 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15822 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15824 @item -mapcs-frame
15825 @opindex mapcs-frame
15826 Generate a stack frame that is compliant with the ARM Procedure Call
15827 Standard for all functions, even if this is not strictly necessary for
15828 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15829 with this option causes the stack frames not to be generated for
15830 leaf functions.  The default is @option{-mno-apcs-frame}.
15831 This option is deprecated.
15833 @item -mapcs
15834 @opindex mapcs
15835 This is a synonym for @option{-mapcs-frame} and is deprecated.
15837 @ignore
15838 @c not currently implemented
15839 @item -mapcs-stack-check
15840 @opindex mapcs-stack-check
15841 Generate code to check the amount of stack space available upon entry to
15842 every function (that actually uses some stack space).  If there is
15843 insufficient space available then either the function
15844 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15845 called, depending upon the amount of stack space required.  The runtime
15846 system is required to provide these functions.  The default is
15847 @option{-mno-apcs-stack-check}, since this produces smaller code.
15849 @c not currently implemented
15850 @item -mapcs-reentrant
15851 @opindex mapcs-reentrant
15852 Generate reentrant, position-independent code.  The default is
15853 @option{-mno-apcs-reentrant}.
15854 @end ignore
15856 @item -mthumb-interwork
15857 @opindex mthumb-interwork
15858 Generate code that supports calling between the ARM and Thumb
15859 instruction sets.  Without this option, on pre-v5 architectures, the
15860 two instruction sets cannot be reliably used inside one program.  The
15861 default is @option{-mno-thumb-interwork}, since slightly larger code
15862 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15863 configurations this option is meaningless.
15865 @item -mno-sched-prolog
15866 @opindex mno-sched-prolog
15867 Prevent the reordering of instructions in the function prologue, or the
15868 merging of those instruction with the instructions in the function's
15869 body.  This means that all functions start with a recognizable set
15870 of instructions (or in fact one of a choice from a small set of
15871 different function prologues), and this information can be used to
15872 locate the start of functions inside an executable piece of code.  The
15873 default is @option{-msched-prolog}.
15875 @item -mfloat-abi=@var{name}
15876 @opindex mfloat-abi
15877 Specifies which floating-point ABI to use.  Permissible values
15878 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15880 Specifying @samp{soft} causes GCC to generate output containing
15881 library calls for floating-point operations.
15882 @samp{softfp} allows the generation of code using hardware floating-point
15883 instructions, but still uses the soft-float calling conventions.
15884 @samp{hard} allows generation of floating-point instructions
15885 and uses FPU-specific calling conventions.
15887 The default depends on the specific target configuration.  Note that
15888 the hard-float and soft-float ABIs are not link-compatible; you must
15889 compile your entire program with the same ABI, and link with a
15890 compatible set of libraries.
15892 @item -mlittle-endian
15893 @opindex mlittle-endian
15894 Generate code for a processor running in little-endian mode.  This is
15895 the default for all standard configurations.
15897 @item -mbig-endian
15898 @opindex mbig-endian
15899 Generate code for a processor running in big-endian mode; the default is
15900 to compile code for a little-endian processor.
15902 @item -mbe8
15903 @itemx -mbe32
15904 @opindex mbe8
15905 When linking a big-endian image select between BE8 and BE32 formats.
15906 The option has no effect for little-endian images and is ignored.  The
15907 default is dependent on the selected target architecture.  For ARMv6
15908 and later architectures the default is BE8, for older architectures
15909 the default is BE32.  BE32 format has been deprecated by ARM.
15911 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15912 @opindex march
15913 This specifies the name of the target ARM architecture.  GCC uses this
15914 name to determine what kind of instructions it can emit when generating
15915 assembly code.  This option can be used in conjunction with or instead
15916 of the @option{-mcpu=} option.
15918 Permissible names are:
15919 @samp{armv4t},
15920 @samp{armv5t}, @samp{armv5te},
15921 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15922 @samp{armv6z}, @samp{armv6zk},
15923 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15924 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15925 @samp{armv8.4-a},
15926 @samp{armv7-r},
15927 @samp{armv8-r},
15928 @samp{armv6-m}, @samp{armv6s-m},
15929 @samp{armv7-m}, @samp{armv7e-m},
15930 @samp{armv8-m.base}, @samp{armv8-m.main},
15931 @samp{iwmmxt} and @samp{iwmmxt2}.
15933 Additionally, the following architectures, which lack support for the
15934 Thumb execution state, are recognized but support is deprecated:
15935 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15936 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15938 Many of the architectures support extensions.  These can be added by
15939 appending @samp{+@var{extension}} to the architecture name.  Extension
15940 options are processed in order and capabilities accumulate.  An extension
15941 will also enable any necessary base extensions
15942 upon which it depends.  For example, the @samp{+crypto} extension
15943 will always enable the @samp{+simd} extension.  The exception to the
15944 additive construction is for extensions that are prefixed with
15945 @samp{+no@dots{}}: these extensions disable the specified option and
15946 any other extensions that may depend on the presence of that
15947 extension.
15949 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15950 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15951 entirely disabled by the @samp{+nofp} option that follows it.
15953 Most extension names are generically named, but have an effect that is
15954 dependent upon the architecture to which it is applied.  For example,
15955 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15956 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15957 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15958 variant for @samp{armv8-a}.
15960 The table below lists the supported extensions for each architecture.
15961 Architectures not mentioned do not support any extensions.
15963 @table @samp
15964 @item  armv5e
15965 @itemx armv5te
15966 @itemx armv6
15967 @itemx armv6j
15968 @itemx armv6k
15969 @itemx armv6kz
15970 @itemx armv6t2
15971 @itemx armv6z
15972 @itemx armv6zk
15973 @table @samp
15974 @item +fp
15975 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15976 used as an alias for this extension.
15978 @item +nofp
15979 Disable the floating-point instructions.
15980 @end table
15982 @item armv7
15983 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15984 @table @samp
15985 @item +fp
15986 The VFPv3 floating-point instructions, with 16 double-precision
15987 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15988 for this extension.  Note that floating-point is not supported by the
15989 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15990 ARMv7-R architectures.
15992 @item +nofp
15993 Disable the floating-point instructions.
15994 @end table
15996 @item armv7-a
15997 @table @samp
15998 @item +fp
15999 The VFPv3 floating-point instructions, with 16 double-precision
16000 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
16001 for this extension.
16003 @item +simd
16004 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16005 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
16006 for this extension.
16008 @item +vfpv3
16009 The VFPv3 floating-point instructions, with 32 double-precision
16010 registers.
16012 @item +vfpv3-d16-fp16
16013 The VFPv3 floating-point instructions, with 16 double-precision
16014 registers and the half-precision floating-point conversion operations.
16016 @item +vfpv3-fp16
16017 The VFPv3 floating-point instructions, with 32 double-precision
16018 registers and the half-precision floating-point conversion operations.
16020 @item +vfpv4-d16
16021 The VFPv4 floating-point instructions, with 16 double-precision
16022 registers.
16024 @item +vfpv4
16025 The VFPv4 floating-point instructions, with 32 double-precision
16026 registers.
16028 @item +neon-fp16
16029 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16030 the half-precision floating-point conversion operations.
16032 @item +neon-vfpv4
16033 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16035 @item +nosimd
16036 Disable the Advanced SIMD instructions (does not disable floating point).
16038 @item +nofp
16039 Disable the floating-point and Advanced SIMD instructions.
16040 @end table
16042 @item armv7ve
16043 The extended version of the ARMv7-A architecture with support for
16044 virtualization.
16045 @table @samp
16046 @item +fp
16047 The VFPv4 floating-point instructions, with 16 double-precision registers.
16048 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16050 @item +simd
16051 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16052 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16054 @item +vfpv3-d16
16055 The VFPv3 floating-point instructions, with 16 double-precision
16056 registers.
16058 @item +vfpv3
16059 The VFPv3 floating-point instructions, with 32 double-precision
16060 registers.
16062 @item +vfpv3-d16-fp16
16063 The VFPv3 floating-point instructions, with 16 double-precision
16064 registers and the half-precision floating-point conversion operations.
16066 @item +vfpv3-fp16
16067 The VFPv3 floating-point instructions, with 32 double-precision
16068 registers and the half-precision floating-point conversion operations.
16070 @item +vfpv4-d16
16071 The VFPv4 floating-point instructions, with 16 double-precision
16072 registers.
16074 @item +vfpv4
16075 The VFPv4 floating-point instructions, with 32 double-precision
16076 registers.
16078 @item +neon
16079 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16080 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16082 @item +neon-fp16
16083 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16084 the half-precision floating-point conversion operations.
16086 @item +nosimd
16087 Disable the Advanced SIMD instructions (does not disable floating point).
16089 @item +nofp
16090 Disable the floating-point and Advanced SIMD instructions.
16091 @end table
16093 @item armv8-a
16094 @table @samp
16095 @item +crc
16096 The Cyclic Redundancy Check (CRC) instructions.
16097 @item +simd
16098 The ARMv8-A Advanced SIMD and floating-point instructions.
16099 @item +crypto
16100 The cryptographic instructions.
16101 @item +nocrypto
16102 Disable the cryptographic instructions.
16103 @item +nofp
16104 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16105 @end table
16107 @item armv8.1-a
16108 @table @samp
16109 @item +simd
16110 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16112 @item +crypto
16113 The cryptographic instructions.  This also enables the Advanced SIMD and
16114 floating-point instructions.
16116 @item +nocrypto
16117 Disable the cryptographic instructions.
16119 @item +nofp
16120 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16121 @end table
16123 @item armv8.2-a
16124 @itemx armv8.3-a
16125 @table @samp
16126 @item +fp16
16127 The half-precision floating-point data processing instructions.
16128 This also enables the Advanced SIMD and floating-point instructions.
16130 @item +fp16fml
16131 The half-precision floating-point fmla extension.  This also enables
16132 the half-precision floating-point extension and Advanced SIMD and
16133 floating-point instructions.
16135 @item +simd
16136 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16138 @item +crypto
16139 The cryptographic instructions.  This also enables the Advanced SIMD and
16140 floating-point instructions.
16142 @item +dotprod
16143 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16145 @item +nocrypto
16146 Disable the cryptographic extension.
16148 @item +nofp
16149 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16150 @end table
16152 @item armv8.4-a
16153 @table @samp
16154 @item +fp16
16155 The half-precision floating-point data processing instructions.
16156 This also enables the Advanced SIMD and floating-point instructions as well
16157 as the Dot Product extension and the half-precision floating-point fmla
16158 extension.
16160 @item +simd
16161 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16162 Dot Product extension.
16164 @item +crypto
16165 The cryptographic instructions.  This also enables the Advanced SIMD and
16166 floating-point instructions as well as the Dot Product extension.
16168 @item +nocrypto
16169 Disable the cryptographic extension.
16171 @item +nofp
16172 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16173 @end table
16175 @item armv7-r
16176 @table @samp
16177 @item +fp.sp
16178 The single-precision VFPv3 floating-point instructions.  The extension
16179 @samp{+vfpv3xd} can be used as an alias for this extension.
16181 @item +fp
16182 The VFPv3 floating-point instructions with 16 double-precision registers.
16183 The extension +vfpv3-d16 can be used as an alias for this extension.
16185 @item +nofp
16186 Disable the floating-point extension.
16188 @item +idiv
16189 The ARM-state integer division instructions.
16191 @item +noidiv
16192 Disable the ARM-state integer division extension.
16193 @end table
16195 @item armv7e-m
16196 @table @samp
16197 @item +fp
16198 The single-precision VFPv4 floating-point instructions.
16200 @item +fpv5
16201 The single-precision FPv5 floating-point instructions.
16203 @item +fp.dp
16204 The single- and double-precision FPv5 floating-point instructions.
16206 @item +nofp
16207 Disable the floating-point extensions.
16208 @end table
16210 @item  armv8-m.main
16211 @table @samp
16212 @item +dsp
16213 The DSP instructions.
16215 @item +nodsp
16216 Disable the DSP extension.
16218 @item +fp
16219 The single-precision floating-point instructions.
16221 @item +fp.dp
16222 The single- and double-precision floating-point instructions.
16224 @item +nofp
16225 Disable the floating-point extension.
16226 @end table
16228 @item armv8-r
16229 @table @samp
16230 @item +crc
16231 The Cyclic Redundancy Check (CRC) instructions.
16232 @item +fp.sp
16233 The single-precision FPv5 floating-point instructions.
16234 @item +simd
16235 The ARMv8-A Advanced SIMD and floating-point instructions.
16236 @item +crypto
16237 The cryptographic instructions.
16238 @item +nocrypto
16239 Disable the cryptographic instructions.
16240 @item +nofp
16241 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16242 @end table
16244 @end table
16246 @option{-march=native} causes the compiler to auto-detect the architecture
16247 of the build computer.  At present, this feature is only supported on
16248 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16249 is unsuccessful the option has no effect.
16251 @item -mtune=@var{name}
16252 @opindex mtune
16253 This option specifies the name of the target ARM processor for
16254 which GCC should tune the performance of the code.
16255 For some ARM implementations better performance can be obtained by using
16256 this option.
16257 Permissible names are: @samp{arm2}, @samp{arm250},
16258 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16259 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16260 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16261 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16262 @samp{arm720},
16263 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16264 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16265 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16266 @samp{strongarm1110},
16267 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16268 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16269 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16270 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16271 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16272 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16273 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16274 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16275 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16276 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16277 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16278 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16279 @samp{cortex-r8}, @samp{cortex-r52},
16280 @samp{cortex-m33},
16281 @samp{cortex-m23},
16282 @samp{cortex-m7},
16283 @samp{cortex-m4},
16284 @samp{cortex-m3},
16285 @samp{cortex-m1},
16286 @samp{cortex-m0},
16287 @samp{cortex-m0plus},
16288 @samp{cortex-m1.small-multiply},
16289 @samp{cortex-m0.small-multiply},
16290 @samp{cortex-m0plus.small-multiply},
16291 @samp{exynos-m1},
16292 @samp{marvell-pj4},
16293 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16294 @samp{fa526}, @samp{fa626},
16295 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16296 @samp{xgene1}.
16298 Additionally, this option can specify that GCC should tune the performance
16299 of the code for a big.LITTLE system.  Permissible names are:
16300 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16301 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16302 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16303 @samp{cortex-a75.cortex-a55}.
16305 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16306 performance for a blend of processors within architecture @var{arch}.
16307 The aim is to generate code that run well on the current most popular
16308 processors, balancing between optimizations that benefit some CPUs in the
16309 range, and avoiding performance pitfalls of other CPUs.  The effects of
16310 this option may change in future GCC versions as CPU models come and go.
16312 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16313 the extension options do not affect the tuning of the generated code.
16315 @option{-mtune=native} causes the compiler to auto-detect the CPU
16316 of the build computer.  At present, this feature is only supported on
16317 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16318 unsuccessful the option has no effect.
16320 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16321 @opindex mcpu
16322 This specifies the name of the target ARM processor.  GCC uses this name
16323 to derive the name of the target ARM architecture (as if specified
16324 by @option{-march}) and the ARM processor type for which to tune for
16325 performance (as if specified by @option{-mtune}).  Where this option
16326 is used in conjunction with @option{-march} or @option{-mtune},
16327 those options take precedence over the appropriate part of this option.
16329 Many of the supported CPUs implement optional architectural
16330 extensions.  Where this is so the architectural extensions are
16331 normally enabled by default.  If implementations that lack the
16332 extension exist, then the extension syntax can be used to disable
16333 those extensions that have been omitted.  For floating-point and
16334 Advanced SIMD (Neon) instructions, the settings of the options
16335 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16336 floating-point and Advanced SIMD instructions will only be used if
16337 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16338 @option{-mfpu} other than @samp{auto} will override the available
16339 floating-point and SIMD extension instructions.
16341 For example, @samp{cortex-a9} can be found in three major
16342 configurations: integer only, with just a floating-point unit or with
16343 floating-point and Advanced SIMD.  The default is to enable all the
16344 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16345 be used to disable just the SIMD or both the SIMD and floating-point
16346 instructions respectively.
16348 Permissible names for this option are the same as those for
16349 @option{-mtune}.
16351 The following extension options are common to the listed CPUs:
16353 @table @samp
16354 @item +nodsp
16355 Disable the DSP instructions on @samp{cortex-m33}.
16357 @item  +nofp
16358 Disables the floating-point instructions on @samp{arm9e},
16359 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16360 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16361 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16362 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16363 Disables the floating-point and SIMD instructions on
16364 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16365 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16366 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16367 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16368 @samp{cortex-a53} and @samp{cortex-a55}.
16370 @item +nofp.dp
16371 Disables the double-precision component of the floating-point instructions
16372 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16374 @item +nosimd
16375 Disables the SIMD (but not floating-point) instructions on
16376 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16377 and @samp{cortex-a9}.
16379 @item +crypto
16380 Enables the cryptographic instructions on @samp{cortex-a32},
16381 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16382 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16383 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16384 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16385 @samp{cortex-a75.cortex-a55}.
16386 @end table
16388 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16389 VFPv3 with 16 double-precision registers.  It supports the following
16390 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16391 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16392 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16393 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16394 @option{-march=armv7-a}.
16396 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16397 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16398 See @option{-mtune} for more information.
16400 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16401 of the build computer.  At present, this feature is only supported on
16402 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16403 is unsuccessful the option has no effect.
16405 @item -mfpu=@var{name}
16406 @opindex mfpu
16407 This specifies what floating-point hardware (or hardware emulation) is
16408 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16409 @samp{vfpv3},
16410 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16411 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16412 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16413 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16414 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16415 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16416 is an alias for @samp{vfpv2}.
16418 The setting @samp{auto} is the default and is special.  It causes the
16419 compiler to select the floating-point and Advanced SIMD instructions
16420 based on the settings of @option{-mcpu} and @option{-march}.
16422 If the selected floating-point hardware includes the NEON extension
16423 (e.g. @option{-mfpu=neon}), note that floating-point
16424 operations are not generated by GCC's auto-vectorization pass unless
16425 @option{-funsafe-math-optimizations} is also specified.  This is
16426 because NEON hardware does not fully implement the IEEE 754 standard for
16427 floating-point arithmetic (in particular denormal values are treated as
16428 zero), so the use of NEON instructions may lead to a loss of precision.
16430 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}).
16432 @item -mfp16-format=@var{name}
16433 @opindex mfp16-format
16434 Specify the format of the @code{__fp16} half-precision floating-point type.
16435 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16436 the default is @samp{none}, in which case the @code{__fp16} type is not
16437 defined.  @xref{Half-Precision}, for more information.
16439 @item -mstructure-size-boundary=@var{n}
16440 @opindex mstructure-size-boundary
16441 The sizes of all structures and unions are rounded up to a multiple
16442 of the number of bits set by this option.  Permissible values are 8, 32
16443 and 64.  The default value varies for different toolchains.  For the COFF
16444 targeted toolchain the default value is 8.  A value of 64 is only allowed
16445 if the underlying ABI supports it.
16447 Specifying a larger number can produce faster, more efficient code, but
16448 can also increase the size of the program.  Different values are potentially
16449 incompatible.  Code compiled with one value cannot necessarily expect to
16450 work with code or libraries compiled with another value, if they exchange
16451 information using structures or unions.
16453 This option is deprecated.
16455 @item -mabort-on-noreturn
16456 @opindex mabort-on-noreturn
16457 Generate a call to the function @code{abort} at the end of a
16458 @code{noreturn} function.  It is executed if the function tries to
16459 return.
16461 @item -mlong-calls
16462 @itemx -mno-long-calls
16463 @opindex mlong-calls
16464 @opindex mno-long-calls
16465 Tells the compiler to perform function calls by first loading the
16466 address of the function into a register and then performing a subroutine
16467 call on this register.  This switch is needed if the target function
16468 lies outside of the 64-megabyte addressing range of the offset-based
16469 version of subroutine call instruction.
16471 Even if this switch is enabled, not all function calls are turned
16472 into long calls.  The heuristic is that static functions, functions
16473 that have the @code{short_call} attribute, functions that are inside
16474 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16475 definitions have already been compiled within the current compilation
16476 unit are not turned into long calls.  The exceptions to this rule are
16477 that weak function definitions, functions with the @code{long_call}
16478 attribute or the @code{section} attribute, and functions that are within
16479 the scope of a @code{#pragma long_calls} directive are always
16480 turned into long calls.
16482 This feature is not enabled by default.  Specifying
16483 @option{-mno-long-calls} restores the default behavior, as does
16484 placing the function calls within the scope of a @code{#pragma
16485 long_calls_off} directive.  Note these switches have no effect on how
16486 the compiler generates code to handle function calls via function
16487 pointers.
16489 @item -msingle-pic-base
16490 @opindex msingle-pic-base
16491 Treat the register used for PIC addressing as read-only, rather than
16492 loading it in the prologue for each function.  The runtime system is
16493 responsible for initializing this register with an appropriate value
16494 before execution begins.
16496 @item -mpic-register=@var{reg}
16497 @opindex mpic-register
16498 Specify the register to be used for PIC addressing.
16499 For standard PIC base case, the default is any suitable register
16500 determined by compiler.  For single PIC base case, the default is
16501 @samp{R9} if target is EABI based or stack-checking is enabled,
16502 otherwise the default is @samp{R10}.
16504 @item -mpic-data-is-text-relative
16505 @opindex mpic-data-is-text-relative
16506 Assume that the displacement between the text and data segments is fixed
16507 at static link time.  This permits using PC-relative addressing
16508 operations to access data known to be in the data segment.  For
16509 non-VxWorks RTP targets, this option is enabled by default.  When
16510 disabled on such targets, it will enable @option{-msingle-pic-base} by
16511 default.
16513 @item -mpoke-function-name
16514 @opindex mpoke-function-name
16515 Write the name of each function into the text section, directly
16516 preceding the function prologue.  The generated code is similar to this:
16518 @smallexample
16519      t0
16520          .ascii "arm_poke_function_name", 0
16521          .align
16522      t1
16523          .word 0xff000000 + (t1 - t0)
16524      arm_poke_function_name
16525          mov     ip, sp
16526          stmfd   sp!, @{fp, ip, lr, pc@}
16527          sub     fp, ip, #4
16528 @end smallexample
16530 When performing a stack backtrace, code can inspect the value of
16531 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16532 location @code{pc - 12} and the top 8 bits are set, then we know that
16533 there is a function name embedded immediately preceding this location
16534 and has length @code{((pc[-3]) & 0xff000000)}.
16536 @item -mthumb
16537 @itemx -marm
16538 @opindex marm
16539 @opindex mthumb
16541 Select between generating code that executes in ARM and Thumb
16542 states.  The default for most configurations is to generate code
16543 that executes in ARM state, but the default can be changed by
16544 configuring GCC with the @option{--with-mode=}@var{state}
16545 configure option.
16547 You can also override the ARM and Thumb mode for each function
16548 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16549 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16551 @item -mflip-thumb 
16552 @opindex mflip-thumb
16553 Switch ARM/Thumb modes on alternating functions.
16554 This option is provided for regression testing of mixed Thumb/ARM code
16555 generation, and is not intended for ordinary use in compiling code.
16557 @item -mtpcs-frame
16558 @opindex mtpcs-frame
16559 Generate a stack frame that is compliant with the Thumb Procedure Call
16560 Standard for all non-leaf functions.  (A leaf function is one that does
16561 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16563 @item -mtpcs-leaf-frame
16564 @opindex mtpcs-leaf-frame
16565 Generate a stack frame that is compliant with the Thumb Procedure Call
16566 Standard for all leaf functions.  (A leaf function is one that does
16567 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16569 @item -mcallee-super-interworking
16570 @opindex mcallee-super-interworking
16571 Gives all externally visible functions in the file being compiled an ARM
16572 instruction set header which switches to Thumb mode before executing the
16573 rest of the function.  This allows these functions to be called from
16574 non-interworking code.  This option is not valid in AAPCS configurations
16575 because interworking is enabled by default.
16577 @item -mcaller-super-interworking
16578 @opindex mcaller-super-interworking
16579 Allows calls via function pointers (including virtual functions) to
16580 execute correctly regardless of whether the target code has been
16581 compiled for interworking or not.  There is a small overhead in the cost
16582 of executing a function pointer if this option is enabled.  This option
16583 is not valid in AAPCS configurations because interworking is enabled
16584 by default.
16586 @item -mtp=@var{name}
16587 @opindex mtp
16588 Specify the access model for the thread local storage pointer.  The valid
16589 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16590 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16591 (supported in the arm6k architecture), and @samp{auto}, which uses the
16592 best available method for the selected processor.  The default setting is
16593 @samp{auto}.
16595 @item -mtls-dialect=@var{dialect}
16596 @opindex mtls-dialect
16597 Specify the dialect to use for accessing thread local storage.  Two
16598 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16599 @samp{gnu} dialect selects the original GNU scheme for supporting
16600 local and global dynamic TLS models.  The @samp{gnu2} dialect
16601 selects the GNU descriptor scheme, which provides better performance
16602 for shared libraries.  The GNU descriptor scheme is compatible with
16603 the original scheme, but does require new assembler, linker and
16604 library support.  Initial and local exec TLS models are unaffected by
16605 this option and always use the original scheme.
16607 @item -mword-relocations
16608 @opindex mword-relocations
16609 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16610 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16611 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16612 is specified.
16614 @item -mfix-cortex-m3-ldrd
16615 @opindex mfix-cortex-m3-ldrd
16616 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16617 with overlapping destination and base registers are used.  This option avoids
16618 generating these instructions.  This option is enabled by default when
16619 @option{-mcpu=cortex-m3} is specified.
16621 @item -munaligned-access
16622 @itemx -mno-unaligned-access
16623 @opindex munaligned-access
16624 @opindex mno-unaligned-access
16625 Enables (or disables) reading and writing of 16- and 32- bit values
16626 from addresses that are not 16- or 32- bit aligned.  By default
16627 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16628 ARMv8-M Baseline architectures, and enabled for all other
16629 architectures.  If unaligned access is not enabled then words in packed
16630 data structures are accessed a byte at a time.
16632 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16633 generated object file to either true or false, depending upon the
16634 setting of this option.  If unaligned access is enabled then the
16635 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16636 defined.
16638 @item -mneon-for-64bits
16639 @opindex mneon-for-64bits
16640 Enables using Neon to handle scalar 64-bits operations. This is
16641 disabled by default since the cost of moving data from core registers
16642 to Neon is high.
16644 @item -mslow-flash-data
16645 @opindex mslow-flash-data
16646 Assume loading data from flash is slower than fetching instruction.
16647 Therefore literal load is minimized for better performance.
16648 This option is only supported when compiling for ARMv7 M-profile and
16649 off by default.
16651 @item -masm-syntax-unified
16652 @opindex masm-syntax-unified
16653 Assume inline assembler is using unified asm syntax.  The default is
16654 currently off which implies divided syntax.  This option has no impact
16655 on Thumb2. However, this may change in future releases of GCC.
16656 Divided syntax should be considered deprecated.
16658 @item -mrestrict-it
16659 @opindex mrestrict-it
16660 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16661 IT blocks can only contain a single 16-bit instruction from a select
16662 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16664 @item -mprint-tune-info
16665 @opindex mprint-tune-info
16666 Print CPU tuning information as comment in assembler file.  This is
16667 an option used only for regression testing of the compiler and not
16668 intended for ordinary use in compiling code.  This option is disabled
16669 by default.
16671 @item -mverbose-cost-dump
16672 @opindex mverbose-cost-dump
16673 Enable verbose cost model dumping in the debug dump files.  This option is
16674 provided for use in debugging the compiler.
16676 @item -mpure-code
16677 @opindex mpure-code
16678 Do not allow constant data to be placed in code sections.
16679 Additionally, when compiling for ELF object format give all text sections the
16680 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16681 is only available when generating non-pic code for M-profile targets with the
16682 MOVT instruction.
16684 @item -mcmse
16685 @opindex mcmse
16686 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16687 Development Tools Engineering Specification", which can be found on
16688 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16689 @end table
16691 @node AVR Options
16692 @subsection AVR Options
16693 @cindex AVR Options
16695 These options are defined for AVR implementations:
16697 @table @gcctabopt
16698 @item -mmcu=@var{mcu}
16699 @opindex mmcu
16700 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16702 The default for this option is@tie{}@samp{avr2}.
16704 GCC supports the following AVR devices and ISAs:
16706 @include avr-mmcu.texi
16708 @item -mabsdata
16709 @opindex mabsdata
16711 Assume that all data in static storage can be accessed by LDS / STS
16712 instructions.  This option has only an effect on reduced Tiny devices like
16713 ATtiny40.  See also the @code{absdata}
16714 @ref{AVR Variable Attributes,variable attribute}.
16716 @item -maccumulate-args
16717 @opindex maccumulate-args
16718 Accumulate outgoing function arguments and acquire/release the needed
16719 stack space for outgoing function arguments once in function
16720 prologue/epilogue.  Without this option, outgoing arguments are pushed
16721 before calling a function and popped afterwards.
16723 Popping the arguments after the function call can be expensive on
16724 AVR so that accumulating the stack space might lead to smaller
16725 executables because arguments need not be removed from the
16726 stack after such a function call.
16728 This option can lead to reduced code size for functions that perform
16729 several calls to functions that get their arguments on the stack like
16730 calls to printf-like functions.
16732 @item -mbranch-cost=@var{cost}
16733 @opindex mbranch-cost
16734 Set the branch costs for conditional branch instructions to
16735 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16736 integers. The default branch cost is 0.
16738 @item -mcall-prologues
16739 @opindex mcall-prologues
16740 Functions prologues/epilogues are expanded as calls to appropriate
16741 subroutines.  Code size is smaller.
16743 @item -mgas-isr-prologues
16744 @opindex mgas-isr-prologues
16745 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16746 instruction supported by GNU Binutils.
16747 If this option is on, the feature can still be disabled for individual
16748 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16749 function attribute.  This feature is activated per default
16750 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16751 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16753 @item -mint8
16754 @opindex mint8
16755 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16756 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16757 and @code{long long} is 4 bytes.  Please note that this option does not
16758 conform to the C standards, but it results in smaller code
16759 size.
16761 @item -mmain-is-OS_task
16762 @opindex mmain-is-OS_task
16763 Do not save registers in @code{main}.  The effect is the same like
16764 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16765 to @code{main}. It is activated per default if optimization is on.
16767 @item -mn-flash=@var{num}
16768 @opindex mn-flash
16769 Assume that the flash memory has a size of 
16770 @var{num} times 64@tie{}KiB.
16772 @item -mno-interrupts
16773 @opindex mno-interrupts
16774 Generated code is not compatible with hardware interrupts.
16775 Code size is smaller.
16777 @item -mrelax
16778 @opindex mrelax
16779 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16780 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16781 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16782 the assembler's command line and the @option{--relax} option to the
16783 linker's command line.
16785 Jump relaxing is performed by the linker because jump offsets are not
16786 known before code is located. Therefore, the assembler code generated by the
16787 compiler is the same, but the instructions in the executable may
16788 differ from instructions in the assembler code.
16790 Relaxing must be turned on if linker stubs are needed, see the
16791 section on @code{EIND} and linker stubs below.
16793 @item -mrmw
16794 @opindex mrmw
16795 Assume that the device supports the Read-Modify-Write
16796 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16798 @item -mshort-calls
16799 @opindex mshort-calls
16801 Assume that @code{RJMP} and @code{RCALL} can target the whole
16802 program memory.
16804 This option is used internally for multilib selection.  It is
16805 not an optimization option, and you don't need to set it by hand.
16807 @item -msp8
16808 @opindex msp8
16809 Treat the stack pointer register as an 8-bit register,
16810 i.e.@: assume the high byte of the stack pointer is zero.
16811 In general, you don't need to set this option by hand.
16813 This option is used internally by the compiler to select and
16814 build multilibs for architectures @code{avr2} and @code{avr25}.
16815 These architectures mix devices with and without @code{SPH}.
16816 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16817 the compiler driver adds or removes this option from the compiler
16818 proper's command line, because the compiler then knows if the device
16819 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16820 register or not.
16822 @item -mstrict-X
16823 @opindex mstrict-X
16824 Use address register @code{X} in a way proposed by the hardware.  This means
16825 that @code{X} is only used in indirect, post-increment or
16826 pre-decrement addressing.
16828 Without this option, the @code{X} register may be used in the same way
16829 as @code{Y} or @code{Z} which then is emulated by additional
16830 instructions.  
16831 For example, loading a value with @code{X+const} addressing with a
16832 small non-negative @code{const < 64} to a register @var{Rn} is
16833 performed as
16835 @example
16836 adiw r26, const   ; X += const
16837 ld   @var{Rn}, X        ; @var{Rn} = *X
16838 sbiw r26, const   ; X -= const
16839 @end example
16841 @item -mtiny-stack
16842 @opindex mtiny-stack
16843 Only change the lower 8@tie{}bits of the stack pointer.
16845 @item -mfract-convert-truncate
16846 @opindex mfract-convert-truncate
16847 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16849 @item -nodevicelib
16850 @opindex nodevicelib
16851 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16853 @item -Waddr-space-convert
16854 @opindex Waddr-space-convert
16855 Warn about conversions between address spaces in the case where the
16856 resulting address space is not contained in the incoming address space.
16858 @item -Wmisspelled-isr
16859 @opindex Wmisspelled-isr
16860 Warn if the ISR is misspelled, i.e. without __vector prefix.
16861 Enabled by default.
16862 @end table
16864 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16865 @cindex @code{EIND}
16866 Pointers in the implementation are 16@tie{}bits wide.
16867 The address of a function or label is represented as word address so
16868 that indirect jumps and calls can target any code address in the
16869 range of 64@tie{}Ki words.
16871 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16872 bytes of program memory space, there is a special function register called
16873 @code{EIND} that serves as most significant part of the target address
16874 when @code{EICALL} or @code{EIJMP} instructions are used.
16876 Indirect jumps and calls on these devices are handled as follows by
16877 the compiler and are subject to some limitations:
16879 @itemize @bullet
16881 @item
16882 The compiler never sets @code{EIND}.
16884 @item
16885 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16886 instructions or might read @code{EIND} directly in order to emulate an
16887 indirect call/jump by means of a @code{RET} instruction.
16889 @item
16890 The compiler assumes that @code{EIND} never changes during the startup
16891 code or during the application. In particular, @code{EIND} is not
16892 saved/restored in function or interrupt service routine
16893 prologue/epilogue.
16895 @item
16896 For indirect calls to functions and computed goto, the linker
16897 generates @emph{stubs}. Stubs are jump pads sometimes also called
16898 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16899 The stub contains a direct jump to the desired address.
16901 @item
16902 Linker relaxation must be turned on so that the linker generates
16903 the stubs correctly in all situations. See the compiler option
16904 @option{-mrelax} and the linker option @option{--relax}.
16905 There are corner cases where the linker is supposed to generate stubs
16906 but aborts without relaxation and without a helpful error message.
16908 @item
16909 The default linker script is arranged for code with @code{EIND = 0}.
16910 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16911 linker script has to be used in order to place the sections whose
16912 name start with @code{.trampolines} into the segment where @code{EIND}
16913 points to.
16915 @item
16916 The startup code from libgcc never sets @code{EIND}.
16917 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16918 For the impact of AVR-LibC on @code{EIND}, see the
16919 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16921 @item
16922 It is legitimate for user-specific startup code to set up @code{EIND}
16923 early, for example by means of initialization code located in
16924 section @code{.init3}. Such code runs prior to general startup code
16925 that initializes RAM and calls constructors, but after the bit
16926 of startup code from AVR-LibC that sets @code{EIND} to the segment
16927 where the vector table is located.
16928 @example
16929 #include <avr/io.h>
16931 static void
16932 __attribute__((section(".init3"),naked,used,no_instrument_function))
16933 init3_set_eind (void)
16935   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16936                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16938 @end example
16940 @noindent
16941 The @code{__trampolines_start} symbol is defined in the linker script.
16943 @item
16944 Stubs are generated automatically by the linker if
16945 the following two conditions are met:
16946 @itemize @minus
16948 @item The address of a label is taken by means of the @code{gs} modifier
16949 (short for @emph{generate stubs}) like so:
16950 @example
16951 LDI r24, lo8(gs(@var{func}))
16952 LDI r25, hi8(gs(@var{func}))
16953 @end example
16954 @item The final location of that label is in a code segment
16955 @emph{outside} the segment where the stubs are located.
16956 @end itemize
16958 @item
16959 The compiler emits such @code{gs} modifiers for code labels in the
16960 following situations:
16961 @itemize @minus
16962 @item Taking address of a function or code label.
16963 @item Computed goto.
16964 @item If prologue-save function is used, see @option{-mcall-prologues}
16965 command-line option.
16966 @item Switch/case dispatch tables. If you do not want such dispatch
16967 tables you can specify the @option{-fno-jump-tables} command-line option.
16968 @item C and C++ constructors/destructors called during startup/shutdown.
16969 @item If the tools hit a @code{gs()} modifier explained above.
16970 @end itemize
16972 @item
16973 Jumping to non-symbolic addresses like so is @emph{not} supported:
16975 @example
16976 int main (void)
16978     /* Call function at word address 0x2 */
16979     return ((int(*)(void)) 0x2)();
16981 @end example
16983 Instead, a stub has to be set up, i.e.@: the function has to be called
16984 through a symbol (@code{func_4} in the example):
16986 @example
16987 int main (void)
16989     extern int func_4 (void);
16991     /* Call function at byte address 0x4 */
16992     return func_4();
16994 @end example
16996 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16997 Alternatively, @code{func_4} can be defined in the linker script.
16998 @end itemize
17000 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
17001 @cindex @code{RAMPD}
17002 @cindex @code{RAMPX}
17003 @cindex @code{RAMPY}
17004 @cindex @code{RAMPZ}
17005 Some AVR devices support memories larger than the 64@tie{}KiB range
17006 that can be accessed with 16-bit pointers.  To access memory locations
17007 outside this 64@tie{}KiB range, the content of a @code{RAMP}
17008 register is used as high part of the address:
17009 The @code{X}, @code{Y}, @code{Z} address register is concatenated
17010 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
17011 register, respectively, to get a wide address. Similarly,
17012 @code{RAMPD} is used together with direct addressing.
17014 @itemize
17015 @item
17016 The startup code initializes the @code{RAMP} special function
17017 registers with zero.
17019 @item
17020 If a @ref{AVR Named Address Spaces,named address space} other than
17021 generic or @code{__flash} is used, then @code{RAMPZ} is set
17022 as needed before the operation.
17024 @item
17025 If the device supports RAM larger than 64@tie{}KiB and the compiler
17026 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17027 is reset to zero after the operation.
17029 @item
17030 If the device comes with a specific @code{RAMP} register, the ISR
17031 prologue/epilogue saves/restores that SFR and initializes it with
17032 zero in case the ISR code might (implicitly) use it.
17034 @item
17035 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17036 If you use inline assembler to read from locations outside the
17037 16-bit address range and change one of the @code{RAMP} registers,
17038 you must reset it to zero after the access.
17040 @end itemize
17042 @subsubsection AVR Built-in Macros
17044 GCC defines several built-in macros so that the user code can test
17045 for the presence or absence of features.  Almost any of the following
17046 built-in macros are deduced from device capabilities and thus
17047 triggered by the @option{-mmcu=} command-line option.
17049 For even more AVR-specific built-in macros see
17050 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17052 @table @code
17054 @item __AVR_ARCH__
17055 Build-in macro that resolves to a decimal number that identifies the
17056 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17057 Possible values are:
17059 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17060 @code{4}, @code{5}, @code{51}, @code{6}
17062 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17063 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17065 respectively and
17067 @code{100},
17068 @code{102}, @code{103}, @code{104},
17069 @code{105}, @code{106}, @code{107}
17071 for @var{mcu}=@code{avrtiny},
17072 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17073 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17074 If @var{mcu} specifies a device, this built-in macro is set
17075 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17076 defined to @code{4}.
17078 @item __AVR_@var{Device}__
17079 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17080 the device's name. For example, @option{-mmcu=atmega8} defines the
17081 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17082 @code{__AVR_ATtiny261A__}, etc.
17084 The built-in macros' names follow
17085 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17086 the device name as from the AVR user manual. The difference between
17087 @var{Device} in the built-in macro and @var{device} in
17088 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17090 If @var{device} is not a device but only a core architecture like
17091 @samp{avr51}, this macro is not defined.
17093 @item __AVR_DEVICE_NAME__
17094 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17095 the device's name. For example, with @option{-mmcu=atmega8} the macro
17096 is defined to @code{atmega8}.
17098 If @var{device} is not a device but only a core architecture like
17099 @samp{avr51}, this macro is not defined.
17101 @item __AVR_XMEGA__
17102 The device / architecture belongs to the XMEGA family of devices.
17104 @item __AVR_HAVE_ELPM__
17105 The device has the @code{ELPM} instruction.
17107 @item __AVR_HAVE_ELPMX__
17108 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17109 R@var{n},Z+} instructions.
17111 @item __AVR_HAVE_MOVW__
17112 The device has the @code{MOVW} instruction to perform 16-bit
17113 register-register moves.
17115 @item __AVR_HAVE_LPMX__
17116 The device has the @code{LPM R@var{n},Z} and
17117 @code{LPM R@var{n},Z+} instructions.
17119 @item __AVR_HAVE_MUL__
17120 The device has a hardware multiplier. 
17122 @item __AVR_HAVE_JMP_CALL__
17123 The device has the @code{JMP} and @code{CALL} instructions.
17124 This is the case for devices with more than 8@tie{}KiB of program
17125 memory.
17127 @item __AVR_HAVE_EIJMP_EICALL__
17128 @itemx __AVR_3_BYTE_PC__
17129 The device has the @code{EIJMP} and @code{EICALL} instructions.
17130 This is the case for devices with more than 128@tie{}KiB of program memory.
17131 This also means that the program counter
17132 (PC) is 3@tie{}bytes wide.
17134 @item __AVR_2_BYTE_PC__
17135 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17136 with up to 128@tie{}KiB of program memory.
17138 @item __AVR_HAVE_8BIT_SP__
17139 @itemx __AVR_HAVE_16BIT_SP__
17140 The stack pointer (SP) register is treated as 8-bit respectively
17141 16-bit register by the compiler.
17142 The definition of these macros is affected by @option{-mtiny-stack}.
17144 @item __AVR_HAVE_SPH__
17145 @itemx __AVR_SP8__
17146 The device has the SPH (high part of stack pointer) special function
17147 register or has an 8-bit stack pointer, respectively.
17148 The definition of these macros is affected by @option{-mmcu=} and
17149 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17150 by @option{-msp8}.
17152 @item __AVR_HAVE_RAMPD__
17153 @itemx __AVR_HAVE_RAMPX__
17154 @itemx __AVR_HAVE_RAMPY__
17155 @itemx __AVR_HAVE_RAMPZ__
17156 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17157 @code{RAMPZ} special function register, respectively.
17159 @item __NO_INTERRUPTS__
17160 This macro reflects the @option{-mno-interrupts} command-line option.
17162 @item __AVR_ERRATA_SKIP__
17163 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17164 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17165 instructions because of a hardware erratum.  Skip instructions are
17166 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17167 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17168 set.
17170 @item __AVR_ISA_RMW__
17171 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17173 @item __AVR_SFR_OFFSET__=@var{offset}
17174 Instructions that can address I/O special function registers directly
17175 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17176 address as if addressed by an instruction to access RAM like @code{LD}
17177 or @code{STS}. This offset depends on the device architecture and has
17178 to be subtracted from the RAM address in order to get the
17179 respective I/O@tie{}address.
17181 @item __AVR_SHORT_CALLS__
17182 The @option{-mshort-calls} command line option is set.
17184 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17185 Some devices support reading from flash memory by means of @code{LD*}
17186 instructions.  The flash memory is seen in the data address space
17187 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17188 is not defined, this feature is not available.  If defined,
17189 the address space is linear and there is no need to put
17190 @code{.rodata} into RAM.  This is handled by the default linker
17191 description file, and is currently available for
17192 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17193 there is no need to use address spaces like @code{__flash} or
17194 features like attribute @code{progmem} and @code{pgm_read_*}.
17196 @item __WITH_AVRLIBC__
17197 The compiler is configured to be used together with AVR-Libc.
17198 See the @option{--with-avrlibc} configure option.
17200 @end table
17202 @node Blackfin Options
17203 @subsection Blackfin Options
17204 @cindex Blackfin Options
17206 @table @gcctabopt
17207 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17208 @opindex mcpu=
17209 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17210 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17211 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17212 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17213 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17214 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17215 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17216 @samp{bf561}, @samp{bf592}.
17218 The optional @var{sirevision} specifies the silicon revision of the target
17219 Blackfin processor.  Any workarounds available for the targeted silicon revision
17220 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17221 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17222 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17223 hexadecimal digits representing the major and minor numbers in the silicon
17224 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17225 is not defined.  If @var{sirevision} is @samp{any}, the
17226 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17227 If this optional @var{sirevision} is not used, GCC assumes the latest known
17228 silicon revision of the targeted Blackfin processor.
17230 GCC defines a preprocessor macro for the specified @var{cpu}.
17231 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17232 provided by libgloss to be linked in if @option{-msim} is not given.
17234 Without this option, @samp{bf532} is used as the processor by default.
17236 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17237 only the preprocessor macro is defined.
17239 @item -msim
17240 @opindex msim
17241 Specifies that the program will be run on the simulator.  This causes
17242 the simulator BSP provided by libgloss to be linked in.  This option
17243 has effect only for @samp{bfin-elf} toolchain.
17244 Certain other options, such as @option{-mid-shared-library} and
17245 @option{-mfdpic}, imply @option{-msim}.
17247 @item -momit-leaf-frame-pointer
17248 @opindex momit-leaf-frame-pointer
17249 Don't keep the frame pointer in a register for leaf functions.  This
17250 avoids the instructions to save, set up and restore frame pointers and
17251 makes an extra register available in leaf functions.
17253 @item -mspecld-anomaly
17254 @opindex mspecld-anomaly
17255 When enabled, the compiler ensures that the generated code does not
17256 contain speculative loads after jump instructions. If this option is used,
17257 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17259 @item -mno-specld-anomaly
17260 @opindex mno-specld-anomaly
17261 Don't generate extra code to prevent speculative loads from occurring.
17263 @item -mcsync-anomaly
17264 @opindex mcsync-anomaly
17265 When enabled, the compiler ensures that the generated code does not
17266 contain CSYNC or SSYNC instructions too soon after conditional branches.
17267 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17269 @item -mno-csync-anomaly
17270 @opindex mno-csync-anomaly
17271 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17272 occurring too soon after a conditional branch.
17274 @item -mlow-64k
17275 @opindex mlow-64k
17276 When enabled, the compiler is free to take advantage of the knowledge that
17277 the entire program fits into the low 64k of memory.
17279 @item -mno-low-64k
17280 @opindex mno-low-64k
17281 Assume that the program is arbitrarily large.  This is the default.
17283 @item -mstack-check-l1
17284 @opindex mstack-check-l1
17285 Do stack checking using information placed into L1 scratchpad memory by the
17286 uClinux kernel.
17288 @item -mid-shared-library
17289 @opindex mid-shared-library
17290 Generate code that supports shared libraries via the library ID method.
17291 This allows for execute in place and shared libraries in an environment
17292 without virtual memory management.  This option implies @option{-fPIC}.
17293 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17295 @item -mno-id-shared-library
17296 @opindex mno-id-shared-library
17297 Generate code that doesn't assume ID-based shared libraries are being used.
17298 This is the default.
17300 @item -mleaf-id-shared-library
17301 @opindex mleaf-id-shared-library
17302 Generate code that supports shared libraries via the library ID method,
17303 but assumes that this library or executable won't link against any other
17304 ID shared libraries.  That allows the compiler to use faster code for jumps
17305 and calls.
17307 @item -mno-leaf-id-shared-library
17308 @opindex mno-leaf-id-shared-library
17309 Do not assume that the code being compiled won't link against any ID shared
17310 libraries.  Slower code is generated for jump and call insns.
17312 @item -mshared-library-id=n
17313 @opindex mshared-library-id
17314 Specifies the identification number of the ID-based shared library being
17315 compiled.  Specifying a value of 0 generates more compact code; specifying
17316 other values forces the allocation of that number to the current
17317 library but is no more space- or time-efficient than omitting this option.
17319 @item -msep-data
17320 @opindex msep-data
17321 Generate code that allows the data segment to be located in a different
17322 area of memory from the text segment.  This allows for execute in place in
17323 an environment without virtual memory management by eliminating relocations
17324 against the text section.
17326 @item -mno-sep-data
17327 @opindex mno-sep-data
17328 Generate code that assumes that the data segment follows the text segment.
17329 This is the default.
17331 @item -mlong-calls
17332 @itemx -mno-long-calls
17333 @opindex mlong-calls
17334 @opindex mno-long-calls
17335 Tells the compiler to perform function calls by first loading the
17336 address of the function into a register and then performing a subroutine
17337 call on this register.  This switch is needed if the target function
17338 lies outside of the 24-bit addressing range of the offset-based
17339 version of subroutine call instruction.
17341 This feature is not enabled by default.  Specifying
17342 @option{-mno-long-calls} restores the default behavior.  Note these
17343 switches have no effect on how the compiler generates code to handle
17344 function calls via function pointers.
17346 @item -mfast-fp
17347 @opindex mfast-fp
17348 Link with the fast floating-point library. This library relaxes some of
17349 the IEEE floating-point standard's rules for checking inputs against
17350 Not-a-Number (NAN), in the interest of performance.
17352 @item -minline-plt
17353 @opindex minline-plt
17354 Enable inlining of PLT entries in function calls to functions that are
17355 not known to bind locally.  It has no effect without @option{-mfdpic}.
17357 @item -mmulticore
17358 @opindex mmulticore
17359 Build a standalone application for multicore Blackfin processors. 
17360 This option causes proper start files and link scripts supporting 
17361 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17362 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17364 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17365 selects the one-application-per-core programming model.  Without
17366 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17367 programming model is used. In this model, the main function of Core B
17368 should be named as @code{coreb_main}.
17370 If this option is not used, the single-core application programming
17371 model is used.
17373 @item -mcorea
17374 @opindex mcorea
17375 Build a standalone application for Core A of BF561 when using
17376 the one-application-per-core programming model. Proper start files
17377 and link scripts are used to support Core A, and the macro
17378 @code{__BFIN_COREA} is defined.
17379 This option can only be used in conjunction with @option{-mmulticore}.
17381 @item -mcoreb
17382 @opindex mcoreb
17383 Build a standalone application for Core B of BF561 when using
17384 the one-application-per-core programming model. Proper start files
17385 and link scripts are used to support Core B, and the macro
17386 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17387 should be used instead of @code{main}. 
17388 This option can only be used in conjunction with @option{-mmulticore}.
17390 @item -msdram
17391 @opindex msdram
17392 Build a standalone application for SDRAM. Proper start files and
17393 link scripts are used to put the application into SDRAM, and the macro
17394 @code{__BFIN_SDRAM} is defined.
17395 The loader should initialize SDRAM before loading the application.
17397 @item -micplb
17398 @opindex micplb
17399 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17400 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17401 are enabled; for standalone applications the default is off.
17402 @end table
17404 @node C6X Options
17405 @subsection C6X Options
17406 @cindex C6X Options
17408 @table @gcctabopt
17409 @item -march=@var{name}
17410 @opindex march
17411 This specifies the name of the target architecture.  GCC uses this
17412 name to determine what kind of instructions it can emit when generating
17413 assembly code.  Permissible names are: @samp{c62x},
17414 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17416 @item -mbig-endian
17417 @opindex mbig-endian
17418 Generate code for a big-endian target.
17420 @item -mlittle-endian
17421 @opindex mlittle-endian
17422 Generate code for a little-endian target.  This is the default.
17424 @item -msim
17425 @opindex msim
17426 Choose startup files and linker script suitable for the simulator.
17428 @item -msdata=default
17429 @opindex msdata=default
17430 Put small global and static data in the @code{.neardata} section,
17431 which is pointed to by register @code{B14}.  Put small uninitialized
17432 global and static data in the @code{.bss} section, which is adjacent
17433 to the @code{.neardata} section.  Put small read-only data into the
17434 @code{.rodata} section.  The corresponding sections used for large
17435 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17437 @item -msdata=all
17438 @opindex msdata=all
17439 Put all data, not just small objects, into the sections reserved for
17440 small data, and use addressing relative to the @code{B14} register to
17441 access them.
17443 @item -msdata=none
17444 @opindex msdata=none
17445 Make no use of the sections reserved for small data, and use absolute
17446 addresses to access all data.  Put all initialized global and static
17447 data in the @code{.fardata} section, and all uninitialized data in the
17448 @code{.far} section.  Put all constant data into the @code{.const}
17449 section.
17450 @end table
17452 @node CRIS Options
17453 @subsection CRIS Options
17454 @cindex CRIS Options
17456 These options are defined specifically for the CRIS ports.
17458 @table @gcctabopt
17459 @item -march=@var{architecture-type}
17460 @itemx -mcpu=@var{architecture-type}
17461 @opindex march
17462 @opindex mcpu
17463 Generate code for the specified architecture.  The choices for
17464 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17465 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17466 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17467 @samp{v10}.
17469 @item -mtune=@var{architecture-type}
17470 @opindex mtune
17471 Tune to @var{architecture-type} everything applicable about the generated
17472 code, except for the ABI and the set of available instructions.  The
17473 choices for @var{architecture-type} are the same as for
17474 @option{-march=@var{architecture-type}}.
17476 @item -mmax-stack-frame=@var{n}
17477 @opindex mmax-stack-frame
17478 Warn when the stack frame of a function exceeds @var{n} bytes.
17480 @item -metrax4
17481 @itemx -metrax100
17482 @opindex metrax4
17483 @opindex metrax100
17484 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17485 @option{-march=v3} and @option{-march=v8} respectively.
17487 @item -mmul-bug-workaround
17488 @itemx -mno-mul-bug-workaround
17489 @opindex mmul-bug-workaround
17490 @opindex mno-mul-bug-workaround
17491 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17492 models where it applies.  This option is active by default.
17494 @item -mpdebug
17495 @opindex mpdebug
17496 Enable CRIS-specific verbose debug-related information in the assembly
17497 code.  This option also has the effect of turning off the @samp{#NO_APP}
17498 formatted-code indicator to the assembler at the beginning of the
17499 assembly file.
17501 @item -mcc-init
17502 @opindex mcc-init
17503 Do not use condition-code results from previous instruction; always emit
17504 compare and test instructions before use of condition codes.
17506 @item -mno-side-effects
17507 @opindex mno-side-effects
17508 Do not emit instructions with side effects in addressing modes other than
17509 post-increment.
17511 @item -mstack-align
17512 @itemx -mno-stack-align
17513 @itemx -mdata-align
17514 @itemx -mno-data-align
17515 @itemx -mconst-align
17516 @itemx -mno-const-align
17517 @opindex mstack-align
17518 @opindex mno-stack-align
17519 @opindex mdata-align
17520 @opindex mno-data-align
17521 @opindex mconst-align
17522 @opindex mno-const-align
17523 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17524 stack frame, individual data and constants to be aligned for the maximum
17525 single data access size for the chosen CPU model.  The default is to
17526 arrange for 32-bit alignment.  ABI details such as structure layout are
17527 not affected by these options.
17529 @item -m32-bit
17530 @itemx -m16-bit
17531 @itemx -m8-bit
17532 @opindex m32-bit
17533 @opindex m16-bit
17534 @opindex m8-bit
17535 Similar to the stack- data- and const-align options above, these options
17536 arrange for stack frame, writable data and constants to all be 32-bit,
17537 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17539 @item -mno-prologue-epilogue
17540 @itemx -mprologue-epilogue
17541 @opindex mno-prologue-epilogue
17542 @opindex mprologue-epilogue
17543 With @option{-mno-prologue-epilogue}, the normal function prologue and
17544 epilogue which set up the stack frame are omitted and no return
17545 instructions or return sequences are generated in the code.  Use this
17546 option only together with visual inspection of the compiled code: no
17547 warnings or errors are generated when call-saved registers must be saved,
17548 or storage for local variables needs to be allocated.
17550 @item -mno-gotplt
17551 @itemx -mgotplt
17552 @opindex mno-gotplt
17553 @opindex mgotplt
17554 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17555 instruction sequences that load addresses for functions from the PLT part
17556 of the GOT rather than (traditional on other architectures) calls to the
17557 PLT@.  The default is @option{-mgotplt}.
17559 @item -melf
17560 @opindex melf
17561 Legacy no-op option only recognized with the cris-axis-elf and
17562 cris-axis-linux-gnu targets.
17564 @item -mlinux
17565 @opindex mlinux
17566 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17568 @item -sim
17569 @opindex sim
17570 This option, recognized for the cris-axis-elf, arranges
17571 to link with input-output functions from a simulator library.  Code,
17572 initialized data and zero-initialized data are allocated consecutively.
17574 @item -sim2
17575 @opindex sim2
17576 Like @option{-sim}, but pass linker options to locate initialized data at
17577 0x40000000 and zero-initialized data at 0x80000000.
17578 @end table
17580 @node CR16 Options
17581 @subsection CR16 Options
17582 @cindex CR16 Options
17584 These options are defined specifically for the CR16 ports.
17586 @table @gcctabopt
17588 @item -mmac
17589 @opindex mmac
17590 Enable the use of multiply-accumulate instructions. Disabled by default.
17592 @item -mcr16cplus
17593 @itemx -mcr16c
17594 @opindex mcr16cplus
17595 @opindex mcr16c
17596 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17597 is default.
17599 @item -msim
17600 @opindex msim
17601 Links the library libsim.a which is in compatible with simulator. Applicable
17602 to ELF compiler only.
17604 @item -mint32
17605 @opindex mint32
17606 Choose integer type as 32-bit wide.
17608 @item -mbit-ops
17609 @opindex mbit-ops
17610 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17612 @item -mdata-model=@var{model}
17613 @opindex mdata-model
17614 Choose a data model. The choices for @var{model} are @samp{near},
17615 @samp{far} or @samp{medium}. @samp{medium} is default.
17616 However, @samp{far} is not valid with @option{-mcr16c}, as the
17617 CR16C architecture does not support the far data model.
17618 @end table
17620 @node Darwin Options
17621 @subsection Darwin Options
17622 @cindex Darwin options
17624 These options are defined for all architectures running the Darwin operating
17625 system.
17627 FSF GCC on Darwin does not create ``fat'' object files; it creates
17628 an object file for the single architecture that GCC was built to
17629 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17630 @option{-arch} options are used; it does so by running the compiler or
17631 linker multiple times and joining the results together with
17632 @file{lipo}.
17634 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17635 @samp{i686}) is determined by the flags that specify the ISA
17636 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17637 @option{-force_cpusubtype_ALL} option can be used to override this.
17639 The Darwin tools vary in their behavior when presented with an ISA
17640 mismatch.  The assembler, @file{as}, only permits instructions to
17641 be used that are valid for the subtype of the file it is generating,
17642 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17643 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17644 and prints an error if asked to create a shared library with a less
17645 restrictive subtype than its input files (for instance, trying to put
17646 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17647 for executables, @command{ld}, quietly gives the executable the most
17648 restrictive subtype of any of its input files.
17650 @table @gcctabopt
17651 @item -F@var{dir}
17652 @opindex F
17653 Add the framework directory @var{dir} to the head of the list of
17654 directories to be searched for header files.  These directories are
17655 interleaved with those specified by @option{-I} options and are
17656 scanned in a left-to-right order.
17658 A framework directory is a directory with frameworks in it.  A
17659 framework is a directory with a @file{Headers} and/or
17660 @file{PrivateHeaders} directory contained directly in it that ends
17661 in @file{.framework}.  The name of a framework is the name of this
17662 directory excluding the @file{.framework}.  Headers associated with
17663 the framework are found in one of those two directories, with
17664 @file{Headers} being searched first.  A subframework is a framework
17665 directory that is in a framework's @file{Frameworks} directory.
17666 Includes of subframework headers can only appear in a header of a
17667 framework that contains the subframework, or in a sibling subframework
17668 header.  Two subframeworks are siblings if they occur in the same
17669 framework.  A subframework should not have the same name as a
17670 framework; a warning is issued if this is violated.  Currently a
17671 subframework cannot have subframeworks; in the future, the mechanism
17672 may be extended to support this.  The standard frameworks can be found
17673 in @file{/System/Library/Frameworks} and
17674 @file{/Library/Frameworks}.  An example include looks like
17675 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17676 the name of the framework and @file{header.h} is found in the
17677 @file{PrivateHeaders} or @file{Headers} directory.
17679 @item -iframework@var{dir}
17680 @opindex iframework
17681 Like @option{-F} except the directory is a treated as a system
17682 directory.  The main difference between this @option{-iframework} and
17683 @option{-F} is that with @option{-iframework} the compiler does not
17684 warn about constructs contained within header files found via
17685 @var{dir}.  This option is valid only for the C family of languages.
17687 @item -gused
17688 @opindex gused
17689 Emit debugging information for symbols that are used.  For stabs
17690 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17691 This is by default ON@.
17693 @item -gfull
17694 @opindex gfull
17695 Emit debugging information for all symbols and types.
17697 @item -mmacosx-version-min=@var{version}
17698 The earliest version of MacOS X that this executable will run on
17699 is @var{version}.  Typical values of @var{version} include @code{10.1},
17700 @code{10.2}, and @code{10.3.9}.
17702 If the compiler was built to use the system's headers by default,
17703 then the default for this option is the system version on which the
17704 compiler is running, otherwise the default is to make choices that
17705 are compatible with as many systems and code bases as possible.
17707 @item -mkernel
17708 @opindex mkernel
17709 Enable kernel development mode.  The @option{-mkernel} option sets
17710 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17711 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17712 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17713 applicable.  This mode also sets @option{-mno-altivec},
17714 @option{-msoft-float}, @option{-fno-builtin} and
17715 @option{-mlong-branch} for PowerPC targets.
17717 @item -mone-byte-bool
17718 @opindex mone-byte-bool
17719 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17720 By default @code{sizeof(bool)} is @code{4} when compiling for
17721 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17722 option has no effect on x86.
17724 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17725 to generate code that is not binary compatible with code generated
17726 without that switch.  Using this switch may require recompiling all
17727 other modules in a program, including system libraries.  Use this
17728 switch to conform to a non-default data model.
17730 @item -mfix-and-continue
17731 @itemx -ffix-and-continue
17732 @itemx -findirect-data
17733 @opindex mfix-and-continue
17734 @opindex ffix-and-continue
17735 @opindex findirect-data
17736 Generate code suitable for fast turnaround development, such as to
17737 allow GDB to dynamically load @file{.o} files into already-running
17738 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17739 are provided for backwards compatibility.
17741 @item -all_load
17742 @opindex all_load
17743 Loads all members of static archive libraries.
17744 See man ld(1) for more information.
17746 @item -arch_errors_fatal
17747 @opindex arch_errors_fatal
17748 Cause the errors having to do with files that have the wrong architecture
17749 to be fatal.
17751 @item -bind_at_load
17752 @opindex bind_at_load
17753 Causes the output file to be marked such that the dynamic linker will
17754 bind all undefined references when the file is loaded or launched.
17756 @item -bundle
17757 @opindex bundle
17758 Produce a Mach-o bundle format file.
17759 See man ld(1) for more information.
17761 @item -bundle_loader @var{executable}
17762 @opindex bundle_loader
17763 This option specifies the @var{executable} that will load the build
17764 output file being linked.  See man ld(1) for more information.
17766 @item -dynamiclib
17767 @opindex dynamiclib
17768 When passed this option, GCC produces a dynamic library instead of
17769 an executable when linking, using the Darwin @file{libtool} command.
17771 @item -force_cpusubtype_ALL
17772 @opindex force_cpusubtype_ALL
17773 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17774 one controlled by the @option{-mcpu} or @option{-march} option.
17776 @item -allowable_client  @var{client_name}
17777 @itemx -client_name
17778 @itemx -compatibility_version
17779 @itemx -current_version
17780 @itemx -dead_strip
17781 @itemx -dependency-file
17782 @itemx -dylib_file
17783 @itemx -dylinker_install_name
17784 @itemx -dynamic
17785 @itemx -exported_symbols_list
17786 @itemx -filelist
17787 @need 800
17788 @itemx -flat_namespace
17789 @itemx -force_flat_namespace
17790 @itemx -headerpad_max_install_names
17791 @itemx -image_base
17792 @itemx -init
17793 @itemx -install_name
17794 @itemx -keep_private_externs
17795 @itemx -multi_module
17796 @itemx -multiply_defined
17797 @itemx -multiply_defined_unused
17798 @need 800
17799 @itemx -noall_load
17800 @itemx -no_dead_strip_inits_and_terms
17801 @itemx -nofixprebinding
17802 @itemx -nomultidefs
17803 @itemx -noprebind
17804 @itemx -noseglinkedit
17805 @itemx -pagezero_size
17806 @itemx -prebind
17807 @itemx -prebind_all_twolevel_modules
17808 @itemx -private_bundle
17809 @need 800
17810 @itemx -read_only_relocs
17811 @itemx -sectalign
17812 @itemx -sectobjectsymbols
17813 @itemx -whyload
17814 @itemx -seg1addr
17815 @itemx -sectcreate
17816 @itemx -sectobjectsymbols
17817 @itemx -sectorder
17818 @itemx -segaddr
17819 @itemx -segs_read_only_addr
17820 @need 800
17821 @itemx -segs_read_write_addr
17822 @itemx -seg_addr_table
17823 @itemx -seg_addr_table_filename
17824 @itemx -seglinkedit
17825 @itemx -segprot
17826 @itemx -segs_read_only_addr
17827 @itemx -segs_read_write_addr
17828 @itemx -single_module
17829 @itemx -static
17830 @itemx -sub_library
17831 @need 800
17832 @itemx -sub_umbrella
17833 @itemx -twolevel_namespace
17834 @itemx -umbrella
17835 @itemx -undefined
17836 @itemx -unexported_symbols_list
17837 @itemx -weak_reference_mismatches
17838 @itemx -whatsloaded
17839 @opindex allowable_client
17840 @opindex client_name
17841 @opindex compatibility_version
17842 @opindex current_version
17843 @opindex dead_strip
17844 @opindex dependency-file
17845 @opindex dylib_file
17846 @opindex dylinker_install_name
17847 @opindex dynamic
17848 @opindex exported_symbols_list
17849 @opindex filelist
17850 @opindex flat_namespace
17851 @opindex force_flat_namespace
17852 @opindex headerpad_max_install_names
17853 @opindex image_base
17854 @opindex init
17855 @opindex install_name
17856 @opindex keep_private_externs
17857 @opindex multi_module
17858 @opindex multiply_defined
17859 @opindex multiply_defined_unused
17860 @opindex noall_load
17861 @opindex no_dead_strip_inits_and_terms
17862 @opindex nofixprebinding
17863 @opindex nomultidefs
17864 @opindex noprebind
17865 @opindex noseglinkedit
17866 @opindex pagezero_size
17867 @opindex prebind
17868 @opindex prebind_all_twolevel_modules
17869 @opindex private_bundle
17870 @opindex read_only_relocs
17871 @opindex sectalign
17872 @opindex sectobjectsymbols
17873 @opindex whyload
17874 @opindex seg1addr
17875 @opindex sectcreate
17876 @opindex sectobjectsymbols
17877 @opindex sectorder
17878 @opindex segaddr
17879 @opindex segs_read_only_addr
17880 @opindex segs_read_write_addr
17881 @opindex seg_addr_table
17882 @opindex seg_addr_table_filename
17883 @opindex seglinkedit
17884 @opindex segprot
17885 @opindex segs_read_only_addr
17886 @opindex segs_read_write_addr
17887 @opindex single_module
17888 @opindex static
17889 @opindex sub_library
17890 @opindex sub_umbrella
17891 @opindex twolevel_namespace
17892 @opindex umbrella
17893 @opindex undefined
17894 @opindex unexported_symbols_list
17895 @opindex weak_reference_mismatches
17896 @opindex whatsloaded
17897 These options are passed to the Darwin linker.  The Darwin linker man page
17898 describes them in detail.
17899 @end table
17901 @node DEC Alpha Options
17902 @subsection DEC Alpha Options
17904 These @samp{-m} options are defined for the DEC Alpha implementations:
17906 @table @gcctabopt
17907 @item -mno-soft-float
17908 @itemx -msoft-float
17909 @opindex mno-soft-float
17910 @opindex msoft-float
17911 Use (do not use) the hardware floating-point instructions for
17912 floating-point operations.  When @option{-msoft-float} is specified,
17913 functions in @file{libgcc.a} are used to perform floating-point
17914 operations.  Unless they are replaced by routines that emulate the
17915 floating-point operations, or compiled in such a way as to call such
17916 emulations routines, these routines issue floating-point
17917 operations.   If you are compiling for an Alpha without floating-point
17918 operations, you must ensure that the library is built so as not to call
17919 them.
17921 Note that Alpha implementations without floating-point operations are
17922 required to have floating-point registers.
17924 @item -mfp-reg
17925 @itemx -mno-fp-regs
17926 @opindex mfp-reg
17927 @opindex mno-fp-regs
17928 Generate code that uses (does not use) the floating-point register set.
17929 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17930 register set is not used, floating-point operands are passed in integer
17931 registers as if they were integers and floating-point results are passed
17932 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17933 so any function with a floating-point argument or return value called by code
17934 compiled with @option{-mno-fp-regs} must also be compiled with that
17935 option.
17937 A typical use of this option is building a kernel that does not use,
17938 and hence need not save and restore, any floating-point registers.
17940 @item -mieee
17941 @opindex mieee
17942 The Alpha architecture implements floating-point hardware optimized for
17943 maximum performance.  It is mostly compliant with the IEEE floating-point
17944 standard.  However, for full compliance, software assistance is
17945 required.  This option generates code fully IEEE-compliant code
17946 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17947 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17948 defined during compilation.  The resulting code is less efficient but is
17949 able to correctly support denormalized numbers and exceptional IEEE
17950 values such as not-a-number and plus/minus infinity.  Other Alpha
17951 compilers call this option @option{-ieee_with_no_inexact}.
17953 @item -mieee-with-inexact
17954 @opindex mieee-with-inexact
17955 This is like @option{-mieee} except the generated code also maintains
17956 the IEEE @var{inexact-flag}.  Turning on this option causes the
17957 generated code to implement fully-compliant IEEE math.  In addition to
17958 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17959 macro.  On some Alpha implementations the resulting code may execute
17960 significantly slower than the code generated by default.  Since there is
17961 very little code that depends on the @var{inexact-flag}, you should
17962 normally not specify this option.  Other Alpha compilers call this
17963 option @option{-ieee_with_inexact}.
17965 @item -mfp-trap-mode=@var{trap-mode}
17966 @opindex mfp-trap-mode
17967 This option controls what floating-point related traps are enabled.
17968 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17969 The trap mode can be set to one of four values:
17971 @table @samp
17972 @item n
17973 This is the default (normal) setting.  The only traps that are enabled
17974 are the ones that cannot be disabled in software (e.g., division by zero
17975 trap).
17977 @item u
17978 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17979 as well.
17981 @item su
17982 Like @samp{u}, but the instructions are marked to be safe for software
17983 completion (see Alpha architecture manual for details).
17985 @item sui
17986 Like @samp{su}, but inexact traps are enabled as well.
17987 @end table
17989 @item -mfp-rounding-mode=@var{rounding-mode}
17990 @opindex mfp-rounding-mode
17991 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17992 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17995 @table @samp
17996 @item n
17997 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17998 the nearest machine number or towards the even machine number in case
17999 of a tie.
18001 @item m
18002 Round towards minus infinity.
18004 @item c
18005 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
18007 @item d
18008 Dynamic rounding mode.  A field in the floating-point control register
18009 (@var{fpcr}, see Alpha architecture reference manual) controls the
18010 rounding mode in effect.  The C library initializes this register for
18011 rounding towards plus infinity.  Thus, unless your program modifies the
18012 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18013 @end table
18015 @item -mtrap-precision=@var{trap-precision}
18016 @opindex mtrap-precision
18017 In the Alpha architecture, floating-point traps are imprecise.  This
18018 means without software assistance it is impossible to recover from a
18019 floating trap and program execution normally needs to be terminated.
18020 GCC can generate code that can assist operating system trap handlers
18021 in determining the exact location that caused a floating-point trap.
18022 Depending on the requirements of an application, different levels of
18023 precisions can be selected:
18025 @table @samp
18026 @item p
18027 Program precision.  This option is the default and means a trap handler
18028 can only identify which program caused a floating-point exception.
18030 @item f
18031 Function precision.  The trap handler can determine the function that
18032 caused a floating-point exception.
18034 @item i
18035 Instruction precision.  The trap handler can determine the exact
18036 instruction that caused a floating-point exception.
18037 @end table
18039 Other Alpha compilers provide the equivalent options called
18040 @option{-scope_safe} and @option{-resumption_safe}.
18042 @item -mieee-conformant
18043 @opindex mieee-conformant
18044 This option marks the generated code as IEEE conformant.  You must not
18045 use this option unless you also specify @option{-mtrap-precision=i} and either
18046 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18047 is to emit the line @samp{.eflag 48} in the function prologue of the
18048 generated assembly file.
18050 @item -mbuild-constants
18051 @opindex mbuild-constants
18052 Normally GCC examines a 32- or 64-bit integer constant to
18053 see if it can construct it from smaller constants in two or three
18054 instructions.  If it cannot, it outputs the constant as a literal and
18055 generates code to load it from the data segment at run time.
18057 Use this option to require GCC to construct @emph{all} integer constants
18058 using code, even if it takes more instructions (the maximum is six).
18060 You typically use this option to build a shared library dynamic
18061 loader.  Itself a shared library, it must relocate itself in memory
18062 before it can find the variables and constants in its own data segment.
18064 @item -mbwx
18065 @itemx -mno-bwx
18066 @itemx -mcix
18067 @itemx -mno-cix
18068 @itemx -mfix
18069 @itemx -mno-fix
18070 @itemx -mmax
18071 @itemx -mno-max
18072 @opindex mbwx
18073 @opindex mno-bwx
18074 @opindex mcix
18075 @opindex mno-cix
18076 @opindex mfix
18077 @opindex mno-fix
18078 @opindex mmax
18079 @opindex mno-max
18080 Indicate whether GCC should generate code to use the optional BWX,
18081 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18082 sets supported by the CPU type specified via @option{-mcpu=} option or that
18083 of the CPU on which GCC was built if none is specified.
18085 @item -mfloat-vax
18086 @itemx -mfloat-ieee
18087 @opindex mfloat-vax
18088 @opindex mfloat-ieee
18089 Generate code that uses (does not use) VAX F and G floating-point
18090 arithmetic instead of IEEE single and double precision.
18092 @item -mexplicit-relocs
18093 @itemx -mno-explicit-relocs
18094 @opindex mexplicit-relocs
18095 @opindex mno-explicit-relocs
18096 Older Alpha assemblers provided no way to generate symbol relocations
18097 except via assembler macros.  Use of these macros does not allow
18098 optimal instruction scheduling.  GNU binutils as of version 2.12
18099 supports a new syntax that allows the compiler to explicitly mark
18100 which relocations should apply to which instructions.  This option
18101 is mostly useful for debugging, as GCC detects the capabilities of
18102 the assembler when it is built and sets the default accordingly.
18104 @item -msmall-data
18105 @itemx -mlarge-data
18106 @opindex msmall-data
18107 @opindex mlarge-data
18108 When @option{-mexplicit-relocs} is in effect, static data is
18109 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18110 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18111 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18112 16-bit relocations off of the @code{$gp} register.  This limits the
18113 size of the small data area to 64KB, but allows the variables to be
18114 directly accessed via a single instruction.
18116 The default is @option{-mlarge-data}.  With this option the data area
18117 is limited to just below 2GB@.  Programs that require more than 2GB of
18118 data must use @code{malloc} or @code{mmap} to allocate the data in the
18119 heap instead of in the program's data segment.
18121 When generating code for shared libraries, @option{-fpic} implies
18122 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18124 @item -msmall-text
18125 @itemx -mlarge-text
18126 @opindex msmall-text
18127 @opindex mlarge-text
18128 When @option{-msmall-text} is used, the compiler assumes that the
18129 code of the entire program (or shared library) fits in 4MB, and is
18130 thus reachable with a branch instruction.  When @option{-msmall-data}
18131 is used, the compiler can assume that all local symbols share the
18132 same @code{$gp} value, and thus reduce the number of instructions
18133 required for a function call from 4 to 1.
18135 The default is @option{-mlarge-text}.
18137 @item -mcpu=@var{cpu_type}
18138 @opindex mcpu
18139 Set the instruction set and instruction scheduling parameters for
18140 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18141 style name or the corresponding chip number.  GCC supports scheduling
18142 parameters for the EV4, EV5 and EV6 family of processors and
18143 chooses the default values for the instruction set from the processor
18144 you specify.  If you do not specify a processor type, GCC defaults
18145 to the processor on which the compiler was built.
18147 Supported values for @var{cpu_type} are
18149 @table @samp
18150 @item ev4
18151 @itemx ev45
18152 @itemx 21064
18153 Schedules as an EV4 and has no instruction set extensions.
18155 @item ev5
18156 @itemx 21164
18157 Schedules as an EV5 and has no instruction set extensions.
18159 @item ev56
18160 @itemx 21164a
18161 Schedules as an EV5 and supports the BWX extension.
18163 @item pca56
18164 @itemx 21164pc
18165 @itemx 21164PC
18166 Schedules as an EV5 and supports the BWX and MAX extensions.
18168 @item ev6
18169 @itemx 21264
18170 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18172 @item ev67
18173 @itemx 21264a
18174 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18175 @end table
18177 Native toolchains also support the value @samp{native},
18178 which selects the best architecture option for the host processor.
18179 @option{-mcpu=native} has no effect if GCC does not recognize
18180 the processor.
18182 @item -mtune=@var{cpu_type}
18183 @opindex mtune
18184 Set only the instruction scheduling parameters for machine type
18185 @var{cpu_type}.  The instruction set is not changed.
18187 Native toolchains also support the value @samp{native},
18188 which selects the best architecture option for the host processor.
18189 @option{-mtune=native} has no effect if GCC does not recognize
18190 the processor.
18192 @item -mmemory-latency=@var{time}
18193 @opindex mmemory-latency
18194 Sets the latency the scheduler should assume for typical memory
18195 references as seen by the application.  This number is highly
18196 dependent on the memory access patterns used by the application
18197 and the size of the external cache on the machine.
18199 Valid options for @var{time} are
18201 @table @samp
18202 @item @var{number}
18203 A decimal number representing clock cycles.
18205 @item L1
18206 @itemx L2
18207 @itemx L3
18208 @itemx main
18209 The compiler contains estimates of the number of clock cycles for
18210 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18211 (also called Dcache, Scache, and Bcache), as well as to main memory.
18212 Note that L3 is only valid for EV5.
18214 @end table
18215 @end table
18217 @node FR30 Options
18218 @subsection FR30 Options
18219 @cindex FR30 Options
18221 These options are defined specifically for the FR30 port.
18223 @table @gcctabopt
18225 @item -msmall-model
18226 @opindex msmall-model
18227 Use the small address space model.  This can produce smaller code, but
18228 it does assume that all symbolic values and addresses fit into a
18229 20-bit range.
18231 @item -mno-lsim
18232 @opindex mno-lsim
18233 Assume that runtime support has been provided and so there is no need
18234 to include the simulator library (@file{libsim.a}) on the linker
18235 command line.
18237 @end table
18239 @node FT32 Options
18240 @subsection FT32 Options
18241 @cindex FT32 Options
18243 These options are defined specifically for the FT32 port.
18245 @table @gcctabopt
18247 @item -msim
18248 @opindex msim
18249 Specifies that the program will be run on the simulator.  This causes
18250 an alternate runtime startup and library to be linked.
18251 You must not use this option when generating programs that will run on
18252 real hardware; you must provide your own runtime library for whatever
18253 I/O functions are needed.
18255 @item -mlra
18256 @opindex mlra
18257 Enable Local Register Allocation.  This is still experimental for FT32,
18258 so by default the compiler uses standard reload.
18260 @item -mnodiv
18261 @opindex mnodiv
18262 Do not use div and mod instructions.
18264 @item -mft32b
18265 @opindex mft32b
18266 Enable use of the extended instructions of the FT32B processor.
18268 @item -mcompress
18269 @opindex mcompress
18270 Compress all code using the Ft32B code compression scheme.
18272 @item -mnopm
18273 @opindex  mnopm
18274 Do not generate code that reads program memory.
18276 @end table
18278 @node FRV Options
18279 @subsection FRV Options
18280 @cindex FRV Options
18282 @table @gcctabopt
18283 @item -mgpr-32
18284 @opindex mgpr-32
18286 Only use the first 32 general-purpose registers.
18288 @item -mgpr-64
18289 @opindex mgpr-64
18291 Use all 64 general-purpose registers.
18293 @item -mfpr-32
18294 @opindex mfpr-32
18296 Use only the first 32 floating-point registers.
18298 @item -mfpr-64
18299 @opindex mfpr-64
18301 Use all 64 floating-point registers.
18303 @item -mhard-float
18304 @opindex mhard-float
18306 Use hardware instructions for floating-point operations.
18308 @item -msoft-float
18309 @opindex msoft-float
18311 Use library routines for floating-point operations.
18313 @item -malloc-cc
18314 @opindex malloc-cc
18316 Dynamically allocate condition code registers.
18318 @item -mfixed-cc
18319 @opindex mfixed-cc
18321 Do not try to dynamically allocate condition code registers, only
18322 use @code{icc0} and @code{fcc0}.
18324 @item -mdword
18325 @opindex mdword
18327 Change ABI to use double word insns.
18329 @item -mno-dword
18330 @opindex mno-dword
18332 Do not use double word instructions.
18334 @item -mdouble
18335 @opindex mdouble
18337 Use floating-point double instructions.
18339 @item -mno-double
18340 @opindex mno-double
18342 Do not use floating-point double instructions.
18344 @item -mmedia
18345 @opindex mmedia
18347 Use media instructions.
18349 @item -mno-media
18350 @opindex mno-media
18352 Do not use media instructions.
18354 @item -mmuladd
18355 @opindex mmuladd
18357 Use multiply and add/subtract instructions.
18359 @item -mno-muladd
18360 @opindex mno-muladd
18362 Do not use multiply and add/subtract instructions.
18364 @item -mfdpic
18365 @opindex mfdpic
18367 Select the FDPIC ABI, which uses function descriptors to represent
18368 pointers to functions.  Without any PIC/PIE-related options, it
18369 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18370 assumes GOT entries and small data are within a 12-bit range from the
18371 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18372 are computed with 32 bits.
18373 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18375 @item -minline-plt
18376 @opindex minline-plt
18378 Enable inlining of PLT entries in function calls to functions that are
18379 not known to bind locally.  It has no effect without @option{-mfdpic}.
18380 It's enabled by default if optimizing for speed and compiling for
18381 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18382 optimization option such as @option{-O3} or above is present in the
18383 command line.
18385 @item -mTLS
18386 @opindex mTLS
18388 Assume a large TLS segment when generating thread-local code.
18390 @item -mtls
18391 @opindex mtls
18393 Do not assume a large TLS segment when generating thread-local code.
18395 @item -mgprel-ro
18396 @opindex mgprel-ro
18398 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18399 that is known to be in read-only sections.  It's enabled by default,
18400 except for @option{-fpic} or @option{-fpie}: even though it may help
18401 make the global offset table smaller, it trades 1 instruction for 4.
18402 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18403 one of which may be shared by multiple symbols, and it avoids the need
18404 for a GOT entry for the referenced symbol, so it's more likely to be a
18405 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18407 @item -multilib-library-pic
18408 @opindex multilib-library-pic
18410 Link with the (library, not FD) pic libraries.  It's implied by
18411 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18412 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18413 it explicitly.
18415 @item -mlinked-fp
18416 @opindex mlinked-fp
18418 Follow the EABI requirement of always creating a frame pointer whenever
18419 a stack frame is allocated.  This option is enabled by default and can
18420 be disabled with @option{-mno-linked-fp}.
18422 @item -mlong-calls
18423 @opindex mlong-calls
18425 Use indirect addressing to call functions outside the current
18426 compilation unit.  This allows the functions to be placed anywhere
18427 within the 32-bit address space.
18429 @item -malign-labels
18430 @opindex malign-labels
18432 Try to align labels to an 8-byte boundary by inserting NOPs into the
18433 previous packet.  This option only has an effect when VLIW packing
18434 is enabled.  It doesn't create new packets; it merely adds NOPs to
18435 existing ones.
18437 @item -mlibrary-pic
18438 @opindex mlibrary-pic
18440 Generate position-independent EABI code.
18442 @item -macc-4
18443 @opindex macc-4
18445 Use only the first four media accumulator registers.
18447 @item -macc-8
18448 @opindex macc-8
18450 Use all eight media accumulator registers.
18452 @item -mpack
18453 @opindex mpack
18455 Pack VLIW instructions.
18457 @item -mno-pack
18458 @opindex mno-pack
18460 Do not pack VLIW instructions.
18462 @item -mno-eflags
18463 @opindex mno-eflags
18465 Do not mark ABI switches in e_flags.
18467 @item -mcond-move
18468 @opindex mcond-move
18470 Enable the use of conditional-move instructions (default).
18472 This switch is mainly for debugging the compiler and will likely be removed
18473 in a future version.
18475 @item -mno-cond-move
18476 @opindex mno-cond-move
18478 Disable the use of conditional-move instructions.
18480 This switch is mainly for debugging the compiler and will likely be removed
18481 in a future version.
18483 @item -mscc
18484 @opindex mscc
18486 Enable the use of conditional set instructions (default).
18488 This switch is mainly for debugging the compiler and will likely be removed
18489 in a future version.
18491 @item -mno-scc
18492 @opindex mno-scc
18494 Disable the use of conditional set instructions.
18496 This switch is mainly for debugging the compiler and will likely be removed
18497 in a future version.
18499 @item -mcond-exec
18500 @opindex mcond-exec
18502 Enable the use of conditional execution (default).
18504 This switch is mainly for debugging the compiler and will likely be removed
18505 in a future version.
18507 @item -mno-cond-exec
18508 @opindex mno-cond-exec
18510 Disable the use of conditional execution.
18512 This switch is mainly for debugging the compiler and will likely be removed
18513 in a future version.
18515 @item -mvliw-branch
18516 @opindex mvliw-branch
18518 Run a pass to pack branches into VLIW instructions (default).
18520 This switch is mainly for debugging the compiler and will likely be removed
18521 in a future version.
18523 @item -mno-vliw-branch
18524 @opindex mno-vliw-branch
18526 Do not run a pass to pack branches into VLIW instructions.
18528 This switch is mainly for debugging the compiler and will likely be removed
18529 in a future version.
18531 @item -mmulti-cond-exec
18532 @opindex mmulti-cond-exec
18534 Enable optimization of @code{&&} and @code{||} in conditional execution
18535 (default).
18537 This switch is mainly for debugging the compiler and will likely be removed
18538 in a future version.
18540 @item -mno-multi-cond-exec
18541 @opindex mno-multi-cond-exec
18543 Disable optimization of @code{&&} and @code{||} in conditional execution.
18545 This switch is mainly for debugging the compiler and will likely be removed
18546 in a future version.
18548 @item -mnested-cond-exec
18549 @opindex mnested-cond-exec
18551 Enable nested conditional execution optimizations (default).
18553 This switch is mainly for debugging the compiler and will likely be removed
18554 in a future version.
18556 @item -mno-nested-cond-exec
18557 @opindex mno-nested-cond-exec
18559 Disable nested conditional execution optimizations.
18561 This switch is mainly for debugging the compiler and will likely be removed
18562 in a future version.
18564 @item -moptimize-membar
18565 @opindex moptimize-membar
18567 This switch removes redundant @code{membar} instructions from the
18568 compiler-generated code.  It is enabled by default.
18570 @item -mno-optimize-membar
18571 @opindex mno-optimize-membar
18573 This switch disables the automatic removal of redundant @code{membar}
18574 instructions from the generated code.
18576 @item -mtomcat-stats
18577 @opindex mtomcat-stats
18579 Cause gas to print out tomcat statistics.
18581 @item -mcpu=@var{cpu}
18582 @opindex mcpu
18584 Select the processor type for which to generate code.  Possible values are
18585 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18586 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18588 @end table
18590 @node GNU/Linux Options
18591 @subsection GNU/Linux Options
18593 These @samp{-m} options are defined for GNU/Linux targets:
18595 @table @gcctabopt
18596 @item -mglibc
18597 @opindex mglibc
18598 Use the GNU C library.  This is the default except
18599 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18600 @samp{*-*-linux-*android*} targets.
18602 @item -muclibc
18603 @opindex muclibc
18604 Use uClibc C library.  This is the default on
18605 @samp{*-*-linux-*uclibc*} targets.
18607 @item -mmusl
18608 @opindex mmusl
18609 Use the musl C library.  This is the default on
18610 @samp{*-*-linux-*musl*} targets.
18612 @item -mbionic
18613 @opindex mbionic
18614 Use Bionic C library.  This is the default on
18615 @samp{*-*-linux-*android*} targets.
18617 @item -mandroid
18618 @opindex mandroid
18619 Compile code compatible with Android platform.  This is the default on
18620 @samp{*-*-linux-*android*} targets.
18622 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18623 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18624 this option makes the GCC driver pass Android-specific options to the linker.
18625 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18626 to be defined.
18628 @item -tno-android-cc
18629 @opindex tno-android-cc
18630 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18631 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18632 @option{-fno-rtti} by default.
18634 @item -tno-android-ld
18635 @opindex tno-android-ld
18636 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18637 linking options to the linker.
18639 @end table
18641 @node H8/300 Options
18642 @subsection H8/300 Options
18644 These @samp{-m} options are defined for the H8/300 implementations:
18646 @table @gcctabopt
18647 @item -mrelax
18648 @opindex mrelax
18649 Shorten some address references at link time, when possible; uses the
18650 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18651 ld, Using ld}, for a fuller description.
18653 @item -mh
18654 @opindex mh
18655 Generate code for the H8/300H@.
18657 @item -ms
18658 @opindex ms
18659 Generate code for the H8S@.
18661 @item -mn
18662 @opindex mn
18663 Generate code for the H8S and H8/300H in the normal mode.  This switch
18664 must be used either with @option{-mh} or @option{-ms}.
18666 @item -ms2600
18667 @opindex ms2600
18668 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18670 @item -mexr
18671 @opindex mexr
18672 Extended registers are stored on stack before execution of function
18673 with monitor attribute. Default option is @option{-mexr}.
18674 This option is valid only for H8S targets.
18676 @item -mno-exr
18677 @opindex mno-exr
18678 Extended registers are not stored on stack before execution of function 
18679 with monitor attribute. Default option is @option{-mno-exr}. 
18680 This option is valid only for H8S targets.
18682 @item -mint32
18683 @opindex mint32
18684 Make @code{int} data 32 bits by default.
18686 @item -malign-300
18687 @opindex malign-300
18688 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18689 The default for the H8/300H and H8S is to align longs and floats on
18690 4-byte boundaries.
18691 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18692 This option has no effect on the H8/300.
18693 @end table
18695 @node HPPA Options
18696 @subsection HPPA Options
18697 @cindex HPPA Options
18699 These @samp{-m} options are defined for the HPPA family of computers:
18701 @table @gcctabopt
18702 @item -march=@var{architecture-type}
18703 @opindex march
18704 Generate code for the specified architecture.  The choices for
18705 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18706 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18707 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18708 architecture option for your machine.  Code compiled for lower numbered
18709 architectures runs on higher numbered architectures, but not the
18710 other way around.
18712 @item -mpa-risc-1-0
18713 @itemx -mpa-risc-1-1
18714 @itemx -mpa-risc-2-0
18715 @opindex mpa-risc-1-0
18716 @opindex mpa-risc-1-1
18717 @opindex mpa-risc-2-0
18718 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18720 @item -mcaller-copies
18721 @opindex mcaller-copies
18722 The caller copies function arguments passed by hidden reference.  This
18723 option should be used with care as it is not compatible with the default
18724 32-bit runtime.  However, only aggregates larger than eight bytes are
18725 passed by hidden reference and the option provides better compatibility
18726 with OpenMP.
18728 @item -mjump-in-delay
18729 @opindex mjump-in-delay
18730 This option is ignored and provided for compatibility purposes only.
18732 @item -mdisable-fpregs
18733 @opindex mdisable-fpregs
18734 Prevent floating-point registers from being used in any manner.  This is
18735 necessary for compiling kernels that perform lazy context switching of
18736 floating-point registers.  If you use this option and attempt to perform
18737 floating-point operations, the compiler aborts.
18739 @item -mdisable-indexing
18740 @opindex mdisable-indexing
18741 Prevent the compiler from using indexing address modes.  This avoids some
18742 rather obscure problems when compiling MIG generated code under MACH@.
18744 @item -mno-space-regs
18745 @opindex mno-space-regs
18746 Generate code that assumes the target has no space registers.  This allows
18747 GCC to generate faster indirect calls and use unscaled index address modes.
18749 Such code is suitable for level 0 PA systems and kernels.
18751 @item -mfast-indirect-calls
18752 @opindex mfast-indirect-calls
18753 Generate code that assumes calls never cross space boundaries.  This
18754 allows GCC to emit code that performs faster indirect calls.
18756 This option does not work in the presence of shared libraries or nested
18757 functions.
18759 @item -mfixed-range=@var{register-range}
18760 @opindex mfixed-range
18761 Generate code treating the given register range as fixed registers.
18762 A fixed register is one that the register allocator cannot use.  This is
18763 useful when compiling kernel code.  A register range is specified as
18764 two registers separated by a dash.  Multiple register ranges can be
18765 specified separated by a comma.
18767 @item -mlong-load-store
18768 @opindex mlong-load-store
18769 Generate 3-instruction load and store sequences as sometimes required by
18770 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18771 the HP compilers.
18773 @item -mportable-runtime
18774 @opindex mportable-runtime
18775 Use the portable calling conventions proposed by HP for ELF systems.
18777 @item -mgas
18778 @opindex mgas
18779 Enable the use of assembler directives only GAS understands.
18781 @item -mschedule=@var{cpu-type}
18782 @opindex mschedule
18783 Schedule code according to the constraints for the machine type
18784 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18785 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18786 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18787 proper scheduling option for your machine.  The default scheduling is
18788 @samp{8000}.
18790 @item -mlinker-opt
18791 @opindex mlinker-opt
18792 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18793 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18794 linkers in which they give bogus error messages when linking some programs.
18796 @item -msoft-float
18797 @opindex msoft-float
18798 Generate output containing library calls for floating point.
18799 @strong{Warning:} the requisite libraries are not available for all HPPA
18800 targets.  Normally the facilities of the machine's usual C compiler are
18801 used, but this cannot be done directly in cross-compilation.  You must make
18802 your own arrangements to provide suitable library functions for
18803 cross-compilation.
18805 @option{-msoft-float} changes the calling convention in the output file;
18806 therefore, it is only useful if you compile @emph{all} of a program with
18807 this option.  In particular, you need to compile @file{libgcc.a}, the
18808 library that comes with GCC, with @option{-msoft-float} in order for
18809 this to work.
18811 @item -msio
18812 @opindex msio
18813 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18814 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18815 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18816 options are available under HP-UX and HI-UX@.
18818 @item -mgnu-ld
18819 @opindex mgnu-ld
18820 Use options specific to GNU @command{ld}.
18821 This passes @option{-shared} to @command{ld} when
18822 building a shared library.  It is the default when GCC is configured,
18823 explicitly or implicitly, with the GNU linker.  This option does not
18824 affect which @command{ld} is called; it only changes what parameters
18825 are passed to that @command{ld}.
18826 The @command{ld} that is called is determined by the
18827 @option{--with-ld} configure option, GCC's program search path, and
18828 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18829 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18830 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18832 @item -mhp-ld
18833 @opindex mhp-ld
18834 Use options specific to HP @command{ld}.
18835 This passes @option{-b} to @command{ld} when building
18836 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18837 links.  It is the default when GCC is configured, explicitly or
18838 implicitly, with the HP linker.  This option does not affect
18839 which @command{ld} is called; it only changes what parameters are passed to that
18840 @command{ld}.
18841 The @command{ld} that is called is determined by the @option{--with-ld}
18842 configure option, GCC's program search path, and finally by the user's
18843 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18844 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18845 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18847 @item -mlong-calls
18848 @opindex mno-long-calls
18849 Generate code that uses long call sequences.  This ensures that a call
18850 is always able to reach linker generated stubs.  The default is to generate
18851 long calls only when the distance from the call site to the beginning
18852 of the function or translation unit, as the case may be, exceeds a
18853 predefined limit set by the branch type being used.  The limits for
18854 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18855 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18856 240,000 bytes.
18858 Distances are measured from the beginning of functions when using the
18859 @option{-ffunction-sections} option, or when using the @option{-mgas}
18860 and @option{-mno-portable-runtime} options together under HP-UX with
18861 the SOM linker.
18863 It is normally not desirable to use this option as it degrades
18864 performance.  However, it may be useful in large applications,
18865 particularly when partial linking is used to build the application.
18867 The types of long calls used depends on the capabilities of the
18868 assembler and linker, and the type of code being generated.  The
18869 impact on systems that support long absolute calls, and long pic
18870 symbol-difference or pc-relative calls should be relatively small.
18871 However, an indirect call is used on 32-bit ELF systems in pic code
18872 and it is quite long.
18874 @item -munix=@var{unix-std}
18875 @opindex march
18876 Generate compiler predefines and select a startfile for the specified
18877 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18878 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18879 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18880 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18881 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18882 and later.
18884 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18885 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18886 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18887 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18888 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18889 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18891 It is @emph{important} to note that this option changes the interfaces
18892 for various library routines.  It also affects the operational behavior
18893 of the C library.  Thus, @emph{extreme} care is needed in using this
18894 option.
18896 Library code that is intended to operate with more than one UNIX
18897 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18898 as appropriate.  Most GNU software doesn't provide this capability.
18900 @item -nolibdld
18901 @opindex nolibdld
18902 Suppress the generation of link options to search libdld.sl when the
18903 @option{-static} option is specified on HP-UX 10 and later.
18905 @item -static
18906 @opindex static
18907 The HP-UX implementation of setlocale in libc has a dependency on
18908 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18909 when the @option{-static} option is specified, special link options
18910 are needed to resolve this dependency.
18912 On HP-UX 10 and later, the GCC driver adds the necessary options to
18913 link with libdld.sl when the @option{-static} option is specified.
18914 This causes the resulting binary to be dynamic.  On the 64-bit port,
18915 the linkers generate dynamic binaries by default in any case.  The
18916 @option{-nolibdld} option can be used to prevent the GCC driver from
18917 adding these link options.
18919 @item -threads
18920 @opindex threads
18921 Add support for multithreading with the @dfn{dce thread} library
18922 under HP-UX@.  This option sets flags for both the preprocessor and
18923 linker.
18924 @end table
18926 @node IA-64 Options
18927 @subsection IA-64 Options
18928 @cindex IA-64 Options
18930 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18932 @table @gcctabopt
18933 @item -mbig-endian
18934 @opindex mbig-endian
18935 Generate code for a big-endian target.  This is the default for HP-UX@.
18937 @item -mlittle-endian
18938 @opindex mlittle-endian
18939 Generate code for a little-endian target.  This is the default for AIX5
18940 and GNU/Linux.
18942 @item -mgnu-as
18943 @itemx -mno-gnu-as
18944 @opindex mgnu-as
18945 @opindex mno-gnu-as
18946 Generate (or don't) code for the GNU assembler.  This is the default.
18947 @c Also, this is the default if the configure option @option{--with-gnu-as}
18948 @c is used.
18950 @item -mgnu-ld
18951 @itemx -mno-gnu-ld
18952 @opindex mgnu-ld
18953 @opindex mno-gnu-ld
18954 Generate (or don't) code for the GNU linker.  This is the default.
18955 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18956 @c is used.
18958 @item -mno-pic
18959 @opindex mno-pic
18960 Generate code that does not use a global pointer register.  The result
18961 is not position independent code, and violates the IA-64 ABI@.
18963 @item -mvolatile-asm-stop
18964 @itemx -mno-volatile-asm-stop
18965 @opindex mvolatile-asm-stop
18966 @opindex mno-volatile-asm-stop
18967 Generate (or don't) a stop bit immediately before and after volatile asm
18968 statements.
18970 @item -mregister-names
18971 @itemx -mno-register-names
18972 @opindex mregister-names
18973 @opindex mno-register-names
18974 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18975 the stacked registers.  This may make assembler output more readable.
18977 @item -mno-sdata
18978 @itemx -msdata
18979 @opindex mno-sdata
18980 @opindex msdata
18981 Disable (or enable) optimizations that use the small data section.  This may
18982 be useful for working around optimizer bugs.
18984 @item -mconstant-gp
18985 @opindex mconstant-gp
18986 Generate code that uses a single constant global pointer value.  This is
18987 useful when compiling kernel code.
18989 @item -mauto-pic
18990 @opindex mauto-pic
18991 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18992 This is useful when compiling firmware code.
18994 @item -minline-float-divide-min-latency
18995 @opindex minline-float-divide-min-latency
18996 Generate code for inline divides of floating-point values
18997 using the minimum latency algorithm.
18999 @item -minline-float-divide-max-throughput
19000 @opindex minline-float-divide-max-throughput
19001 Generate code for inline divides of floating-point values
19002 using the maximum throughput algorithm.
19004 @item -mno-inline-float-divide
19005 @opindex mno-inline-float-divide
19006 Do not generate inline code for divides of floating-point values.
19008 @item -minline-int-divide-min-latency
19009 @opindex minline-int-divide-min-latency
19010 Generate code for inline divides of integer values
19011 using the minimum latency algorithm.
19013 @item -minline-int-divide-max-throughput
19014 @opindex minline-int-divide-max-throughput
19015 Generate code for inline divides of integer values
19016 using the maximum throughput algorithm.
19018 @item -mno-inline-int-divide
19019 @opindex mno-inline-int-divide
19020 Do not generate inline code for divides of integer values.
19022 @item -minline-sqrt-min-latency
19023 @opindex minline-sqrt-min-latency
19024 Generate code for inline square roots
19025 using the minimum latency algorithm.
19027 @item -minline-sqrt-max-throughput
19028 @opindex minline-sqrt-max-throughput
19029 Generate code for inline square roots
19030 using the maximum throughput algorithm.
19032 @item -mno-inline-sqrt
19033 @opindex mno-inline-sqrt
19034 Do not generate inline code for @code{sqrt}.
19036 @item -mfused-madd
19037 @itemx -mno-fused-madd
19038 @opindex mfused-madd
19039 @opindex mno-fused-madd
19040 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19041 instructions.  The default is to use these instructions.
19043 @item -mno-dwarf2-asm
19044 @itemx -mdwarf2-asm
19045 @opindex mno-dwarf2-asm
19046 @opindex mdwarf2-asm
19047 Don't (or do) generate assembler code for the DWARF line number debugging
19048 info.  This may be useful when not using the GNU assembler.
19050 @item -mearly-stop-bits
19051 @itemx -mno-early-stop-bits
19052 @opindex mearly-stop-bits
19053 @opindex mno-early-stop-bits
19054 Allow stop bits to be placed earlier than immediately preceding the
19055 instruction that triggered the stop bit.  This can improve instruction
19056 scheduling, but does not always do so.
19058 @item -mfixed-range=@var{register-range}
19059 @opindex mfixed-range
19060 Generate code treating the given register range as fixed registers.
19061 A fixed register is one that the register allocator cannot use.  This is
19062 useful when compiling kernel code.  A register range is specified as
19063 two registers separated by a dash.  Multiple register ranges can be
19064 specified separated by a comma.
19066 @item -mtls-size=@var{tls-size}
19067 @opindex mtls-size
19068 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19071 @item -mtune=@var{cpu-type}
19072 @opindex mtune
19073 Tune the instruction scheduling for a particular CPU, Valid values are
19074 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19075 and @samp{mckinley}.
19077 @item -milp32
19078 @itemx -mlp64
19079 @opindex milp32
19080 @opindex mlp64
19081 Generate code for a 32-bit or 64-bit environment.
19082 The 32-bit environment sets int, long and pointer to 32 bits.
19083 The 64-bit environment sets int to 32 bits and long and pointer
19084 to 64 bits.  These are HP-UX specific flags.
19086 @item -mno-sched-br-data-spec
19087 @itemx -msched-br-data-spec
19088 @opindex mno-sched-br-data-spec
19089 @opindex msched-br-data-spec
19090 (Dis/En)able data speculative scheduling before reload.
19091 This results in generation of @code{ld.a} instructions and
19092 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19093 The default setting is disabled.
19095 @item -msched-ar-data-spec
19096 @itemx -mno-sched-ar-data-spec
19097 @opindex msched-ar-data-spec
19098 @opindex mno-sched-ar-data-spec
19099 (En/Dis)able data speculative scheduling after reload.
19100 This results in generation of @code{ld.a} instructions and
19101 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19102 The default setting is enabled.
19104 @item -mno-sched-control-spec
19105 @itemx -msched-control-spec
19106 @opindex mno-sched-control-spec
19107 @opindex msched-control-spec
19108 (Dis/En)able control speculative scheduling.  This feature is
19109 available only during region scheduling (i.e.@: before reload).
19110 This results in generation of the @code{ld.s} instructions and
19111 the corresponding check instructions @code{chk.s}.
19112 The default setting is disabled.
19114 @item -msched-br-in-data-spec
19115 @itemx -mno-sched-br-in-data-spec
19116 @opindex msched-br-in-data-spec
19117 @opindex mno-sched-br-in-data-spec
19118 (En/Dis)able speculative scheduling of the instructions that
19119 are dependent on the data speculative loads before reload.
19120 This is effective only with @option{-msched-br-data-spec} enabled.
19121 The default setting is enabled.
19123 @item -msched-ar-in-data-spec
19124 @itemx -mno-sched-ar-in-data-spec
19125 @opindex msched-ar-in-data-spec
19126 @opindex mno-sched-ar-in-data-spec
19127 (En/Dis)able speculative scheduling of the instructions that
19128 are dependent on the data speculative loads after reload.
19129 This is effective only with @option{-msched-ar-data-spec} enabled.
19130 The default setting is enabled.
19132 @item -msched-in-control-spec
19133 @itemx -mno-sched-in-control-spec
19134 @opindex msched-in-control-spec
19135 @opindex mno-sched-in-control-spec
19136 (En/Dis)able speculative scheduling of the instructions that
19137 are dependent on the control speculative loads.
19138 This is effective only with @option{-msched-control-spec} enabled.
19139 The default setting is enabled.
19141 @item -mno-sched-prefer-non-data-spec-insns
19142 @itemx -msched-prefer-non-data-spec-insns
19143 @opindex mno-sched-prefer-non-data-spec-insns
19144 @opindex msched-prefer-non-data-spec-insns
19145 If enabled, data-speculative instructions are chosen for schedule
19146 only if there are no other choices at the moment.  This makes
19147 the use of the data speculation much more conservative.
19148 The default setting is disabled.
19150 @item -mno-sched-prefer-non-control-spec-insns
19151 @itemx -msched-prefer-non-control-spec-insns
19152 @opindex mno-sched-prefer-non-control-spec-insns
19153 @opindex msched-prefer-non-control-spec-insns
19154 If enabled, control-speculative instructions are chosen for schedule
19155 only if there are no other choices at the moment.  This makes
19156 the use of the control speculation much more conservative.
19157 The default setting is disabled.
19159 @item -mno-sched-count-spec-in-critical-path
19160 @itemx -msched-count-spec-in-critical-path
19161 @opindex mno-sched-count-spec-in-critical-path
19162 @opindex msched-count-spec-in-critical-path
19163 If enabled, speculative dependencies are considered during
19164 computation of the instructions priorities.  This makes the use of the
19165 speculation a bit more conservative.
19166 The default setting is disabled.
19168 @item -msched-spec-ldc
19169 @opindex msched-spec-ldc
19170 Use a simple data speculation check.  This option is on by default.
19172 @item -msched-control-spec-ldc
19173 @opindex msched-spec-ldc
19174 Use a simple check for control speculation.  This option is on by default.
19176 @item -msched-stop-bits-after-every-cycle
19177 @opindex msched-stop-bits-after-every-cycle
19178 Place a stop bit after every cycle when scheduling.  This option is on
19179 by default.
19181 @item -msched-fp-mem-deps-zero-cost
19182 @opindex msched-fp-mem-deps-zero-cost
19183 Assume that floating-point stores and loads are not likely to cause a conflict
19184 when placed into the same instruction group.  This option is disabled by
19185 default.
19187 @item -msel-sched-dont-check-control-spec
19188 @opindex msel-sched-dont-check-control-spec
19189 Generate checks for control speculation in selective scheduling.
19190 This flag is disabled by default.
19192 @item -msched-max-memory-insns=@var{max-insns}
19193 @opindex msched-max-memory-insns
19194 Limit on the number of memory insns per instruction group, giving lower
19195 priority to subsequent memory insns attempting to schedule in the same
19196 instruction group. Frequently useful to prevent cache bank conflicts.
19197 The default value is 1.
19199 @item -msched-max-memory-insns-hard-limit
19200 @opindex msched-max-memory-insns-hard-limit
19201 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19202 disallowing more than that number in an instruction group.
19203 Otherwise, the limit is ``soft'', meaning that non-memory operations
19204 are preferred when the limit is reached, but memory operations may still
19205 be scheduled.
19207 @end table
19209 @node LM32 Options
19210 @subsection LM32 Options
19211 @cindex LM32 options
19213 These @option{-m} options are defined for the LatticeMico32 architecture:
19215 @table @gcctabopt
19216 @item -mbarrel-shift-enabled
19217 @opindex mbarrel-shift-enabled
19218 Enable barrel-shift instructions.
19220 @item -mdivide-enabled
19221 @opindex mdivide-enabled
19222 Enable divide and modulus instructions.
19224 @item -mmultiply-enabled
19225 @opindex multiply-enabled
19226 Enable multiply instructions.
19228 @item -msign-extend-enabled
19229 @opindex msign-extend-enabled
19230 Enable sign extend instructions.
19232 @item -muser-enabled
19233 @opindex muser-enabled
19234 Enable user-defined instructions.
19236 @end table
19238 @node M32C Options
19239 @subsection M32C Options
19240 @cindex M32C options
19242 @table @gcctabopt
19243 @item -mcpu=@var{name}
19244 @opindex mcpu=
19245 Select the CPU for which code is generated.  @var{name} may be one of
19246 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19247 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19248 the M32C/80 series.
19250 @item -msim
19251 @opindex msim
19252 Specifies that the program will be run on the simulator.  This causes
19253 an alternate runtime library to be linked in which supports, for
19254 example, file I/O@.  You must not use this option when generating
19255 programs that will run on real hardware; you must provide your own
19256 runtime library for whatever I/O functions are needed.
19258 @item -memregs=@var{number}
19259 @opindex memregs=
19260 Specifies the number of memory-based pseudo-registers GCC uses
19261 during code generation.  These pseudo-registers are used like real
19262 registers, so there is a tradeoff between GCC's ability to fit the
19263 code into available registers, and the performance penalty of using
19264 memory instead of registers.  Note that all modules in a program must
19265 be compiled with the same value for this option.  Because of that, you
19266 must not use this option with GCC's default runtime libraries.
19268 @end table
19270 @node M32R/D Options
19271 @subsection M32R/D Options
19272 @cindex M32R/D options
19274 These @option{-m} options are defined for Renesas M32R/D architectures:
19276 @table @gcctabopt
19277 @item -m32r2
19278 @opindex m32r2
19279 Generate code for the M32R/2@.
19281 @item -m32rx
19282 @opindex m32rx
19283 Generate code for the M32R/X@.
19285 @item -m32r
19286 @opindex m32r
19287 Generate code for the M32R@.  This is the default.
19289 @item -mmodel=small
19290 @opindex mmodel=small
19291 Assume all objects live in the lower 16MB of memory (so that their addresses
19292 can be loaded with the @code{ld24} instruction), and assume all subroutines
19293 are reachable with the @code{bl} instruction.
19294 This is the default.
19296 The addressability of a particular object can be set with the
19297 @code{model} attribute.
19299 @item -mmodel=medium
19300 @opindex mmodel=medium
19301 Assume objects may be anywhere in the 32-bit address space (the compiler
19302 generates @code{seth/add3} instructions to load their addresses), and
19303 assume all subroutines are reachable with the @code{bl} instruction.
19305 @item -mmodel=large
19306 @opindex mmodel=large
19307 Assume objects may be anywhere in the 32-bit address space (the compiler
19308 generates @code{seth/add3} instructions to load their addresses), and
19309 assume subroutines may not be reachable with the @code{bl} instruction
19310 (the compiler generates the much slower @code{seth/add3/jl}
19311 instruction sequence).
19313 @item -msdata=none
19314 @opindex msdata=none
19315 Disable use of the small data area.  Variables are put into
19316 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19317 @code{section} attribute has been specified).
19318 This is the default.
19320 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19321 Objects may be explicitly put in the small data area with the
19322 @code{section} attribute using one of these sections.
19324 @item -msdata=sdata
19325 @opindex msdata=sdata
19326 Put small global and static data in the small data area, but do not
19327 generate special code to reference them.
19329 @item -msdata=use
19330 @opindex msdata=use
19331 Put small global and static data in the small data area, and generate
19332 special instructions to reference them.
19334 @item -G @var{num}
19335 @opindex G
19336 @cindex smaller data references
19337 Put global and static objects less than or equal to @var{num} bytes
19338 into the small data or BSS sections instead of the normal data or BSS
19339 sections.  The default value of @var{num} is 8.
19340 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19341 for this option to have any effect.
19343 All modules should be compiled with the same @option{-G @var{num}} value.
19344 Compiling with different values of @var{num} may or may not work; if it
19345 doesn't the linker gives an error message---incorrect code is not
19346 generated.
19348 @item -mdebug
19349 @opindex mdebug
19350 Makes the M32R-specific code in the compiler display some statistics
19351 that might help in debugging programs.
19353 @item -malign-loops
19354 @opindex malign-loops
19355 Align all loops to a 32-byte boundary.
19357 @item -mno-align-loops
19358 @opindex mno-align-loops
19359 Do not enforce a 32-byte alignment for loops.  This is the default.
19361 @item -missue-rate=@var{number}
19362 @opindex missue-rate=@var{number}
19363 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19364 or 2.
19366 @item -mbranch-cost=@var{number}
19367 @opindex mbranch-cost=@var{number}
19368 @var{number} can only be 1 or 2.  If it is 1 then branches are
19369 preferred over conditional code, if it is 2, then the opposite applies.
19371 @item -mflush-trap=@var{number}
19372 @opindex mflush-trap=@var{number}
19373 Specifies the trap number to use to flush the cache.  The default is
19374 12.  Valid numbers are between 0 and 15 inclusive.
19376 @item -mno-flush-trap
19377 @opindex mno-flush-trap
19378 Specifies that the cache cannot be flushed by using a trap.
19380 @item -mflush-func=@var{name}
19381 @opindex mflush-func=@var{name}
19382 Specifies the name of the operating system function to call to flush
19383 the cache.  The default is @samp{_flush_cache}, but a function call
19384 is only used if a trap is not available.
19386 @item -mno-flush-func
19387 @opindex mno-flush-func
19388 Indicates that there is no OS function for flushing the cache.
19390 @end table
19392 @node M680x0 Options
19393 @subsection M680x0 Options
19394 @cindex M680x0 options
19396 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19397 The default settings depend on which architecture was selected when
19398 the compiler was configured; the defaults for the most common choices
19399 are given below.
19401 @table @gcctabopt
19402 @item -march=@var{arch}
19403 @opindex march
19404 Generate code for a specific M680x0 or ColdFire instruction set
19405 architecture.  Permissible values of @var{arch} for M680x0
19406 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19407 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19408 architectures are selected according to Freescale's ISA classification
19409 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19410 @samp{isab} and @samp{isac}.
19412 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19413 code for a ColdFire target.  The @var{arch} in this macro is one of the
19414 @option{-march} arguments given above.
19416 When used together, @option{-march} and @option{-mtune} select code
19417 that runs on a family of similar processors but that is optimized
19418 for a particular microarchitecture.
19420 @item -mcpu=@var{cpu}
19421 @opindex mcpu
19422 Generate code for a specific M680x0 or ColdFire processor.
19423 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19424 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19425 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19426 below, which also classifies the CPUs into families:
19428 @multitable @columnfractions 0.20 0.80
19429 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19430 @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}
19431 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19432 @item @samp{5206e} @tab @samp{5206e}
19433 @item @samp{5208} @tab @samp{5207} @samp{5208}
19434 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19435 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19436 @item @samp{5216} @tab @samp{5214} @samp{5216}
19437 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19438 @item @samp{5225} @tab @samp{5224} @samp{5225}
19439 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19440 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19441 @item @samp{5249} @tab @samp{5249}
19442 @item @samp{5250} @tab @samp{5250}
19443 @item @samp{5271} @tab @samp{5270} @samp{5271}
19444 @item @samp{5272} @tab @samp{5272}
19445 @item @samp{5275} @tab @samp{5274} @samp{5275}
19446 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19447 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19448 @item @samp{5307} @tab @samp{5307}
19449 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19450 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19451 @item @samp{5407} @tab @samp{5407}
19452 @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}
19453 @end multitable
19455 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19456 @var{arch} is compatible with @var{cpu}.  Other combinations of
19457 @option{-mcpu} and @option{-march} are rejected.
19459 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19460 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19461 where the value of @var{family} is given by the table above.
19463 @item -mtune=@var{tune}
19464 @opindex mtune
19465 Tune the code for a particular microarchitecture within the
19466 constraints set by @option{-march} and @option{-mcpu}.
19467 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19468 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19469 and @samp{cpu32}.  The ColdFire microarchitectures
19470 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19472 You can also use @option{-mtune=68020-40} for code that needs
19473 to run relatively well on 68020, 68030 and 68040 targets.
19474 @option{-mtune=68020-60} is similar but includes 68060 targets
19475 as well.  These two options select the same tuning decisions as
19476 @option{-m68020-40} and @option{-m68020-60} respectively.
19478 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19479 when tuning for 680x0 architecture @var{arch}.  It also defines
19480 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19481 option is used.  If GCC is tuning for a range of architectures,
19482 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19483 it defines the macros for every architecture in the range.
19485 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19486 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19487 of the arguments given above.
19489 @item -m68000
19490 @itemx -mc68000
19491 @opindex m68000
19492 @opindex mc68000
19493 Generate output for a 68000.  This is the default
19494 when the compiler is configured for 68000-based systems.
19495 It is equivalent to @option{-march=68000}.
19497 Use this option for microcontrollers with a 68000 or EC000 core,
19498 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19500 @item -m68010
19501 @opindex m68010
19502 Generate output for a 68010.  This is the default
19503 when the compiler is configured for 68010-based systems.
19504 It is equivalent to @option{-march=68010}.
19506 @item -m68020
19507 @itemx -mc68020
19508 @opindex m68020
19509 @opindex mc68020
19510 Generate output for a 68020.  This is the default
19511 when the compiler is configured for 68020-based systems.
19512 It is equivalent to @option{-march=68020}.
19514 @item -m68030
19515 @opindex m68030
19516 Generate output for a 68030.  This is the default when the compiler is
19517 configured for 68030-based systems.  It is equivalent to
19518 @option{-march=68030}.
19520 @item -m68040
19521 @opindex m68040
19522 Generate output for a 68040.  This is the default when the compiler is
19523 configured for 68040-based systems.  It is equivalent to
19524 @option{-march=68040}.
19526 This option inhibits the use of 68881/68882 instructions that have to be
19527 emulated by software on the 68040.  Use this option if your 68040 does not
19528 have code to emulate those instructions.
19530 @item -m68060
19531 @opindex m68060
19532 Generate output for a 68060.  This is the default when the compiler is
19533 configured for 68060-based systems.  It is equivalent to
19534 @option{-march=68060}.
19536 This option inhibits the use of 68020 and 68881/68882 instructions that
19537 have to be emulated by software on the 68060.  Use this option if your 68060
19538 does not have code to emulate those instructions.
19540 @item -mcpu32
19541 @opindex mcpu32
19542 Generate output for a CPU32.  This is the default
19543 when the compiler is configured for CPU32-based systems.
19544 It is equivalent to @option{-march=cpu32}.
19546 Use this option for microcontrollers with a
19547 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19548 68336, 68340, 68341, 68349 and 68360.
19550 @item -m5200
19551 @opindex m5200
19552 Generate output for a 520X ColdFire CPU@.  This is the default
19553 when the compiler is configured for 520X-based systems.
19554 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19555 in favor of that option.
19557 Use this option for microcontroller with a 5200 core, including
19558 the MCF5202, MCF5203, MCF5204 and MCF5206.
19560 @item -m5206e
19561 @opindex m5206e
19562 Generate output for a 5206e ColdFire CPU@.  The option is now
19563 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19565 @item -m528x
19566 @opindex m528x
19567 Generate output for a member of the ColdFire 528X family.
19568 The option is now deprecated in favor of the equivalent
19569 @option{-mcpu=528x}.
19571 @item -m5307
19572 @opindex m5307
19573 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19574 in favor of the equivalent @option{-mcpu=5307}.
19576 @item -m5407
19577 @opindex m5407
19578 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19579 in favor of the equivalent @option{-mcpu=5407}.
19581 @item -mcfv4e
19582 @opindex mcfv4e
19583 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19584 This includes use of hardware floating-point instructions.
19585 The option is equivalent to @option{-mcpu=547x}, and is now
19586 deprecated in favor of that option.
19588 @item -m68020-40
19589 @opindex m68020-40
19590 Generate output for a 68040, without using any of the new instructions.
19591 This results in code that can run relatively efficiently on either a
19592 68020/68881 or a 68030 or a 68040.  The generated code does use the
19593 68881 instructions that are emulated on the 68040.
19595 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19597 @item -m68020-60
19598 @opindex m68020-60
19599 Generate output for a 68060, without using any of the new instructions.
19600 This results in code that can run relatively efficiently on either a
19601 68020/68881 or a 68030 or a 68040.  The generated code does use the
19602 68881 instructions that are emulated on the 68060.
19604 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19606 @item -mhard-float
19607 @itemx -m68881
19608 @opindex mhard-float
19609 @opindex m68881
19610 Generate floating-point instructions.  This is the default for 68020
19611 and above, and for ColdFire devices that have an FPU@.  It defines the
19612 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19613 on ColdFire targets.
19615 @item -msoft-float
19616 @opindex msoft-float
19617 Do not generate floating-point instructions; use library calls instead.
19618 This is the default for 68000, 68010, and 68832 targets.  It is also
19619 the default for ColdFire devices that have no FPU.
19621 @item -mdiv
19622 @itemx -mno-div
19623 @opindex mdiv
19624 @opindex mno-div
19625 Generate (do not generate) ColdFire hardware divide and remainder
19626 instructions.  If @option{-march} is used without @option{-mcpu},
19627 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19628 architectures.  Otherwise, the default is taken from the target CPU
19629 (either the default CPU, or the one specified by @option{-mcpu}).  For
19630 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19631 @option{-mcpu=5206e}.
19633 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19635 @item -mshort
19636 @opindex mshort
19637 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19638 Additionally, parameters passed on the stack are also aligned to a
19639 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19641 @item -mno-short
19642 @opindex mno-short
19643 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19645 @item -mnobitfield
19646 @itemx -mno-bitfield
19647 @opindex mnobitfield
19648 @opindex mno-bitfield
19649 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19650 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19652 @item -mbitfield
19653 @opindex mbitfield
19654 Do use the bit-field instructions.  The @option{-m68020} option implies
19655 @option{-mbitfield}.  This is the default if you use a configuration
19656 designed for a 68020.
19658 @item -mrtd
19659 @opindex mrtd
19660 Use a different function-calling convention, in which functions
19661 that take a fixed number of arguments return with the @code{rtd}
19662 instruction, which pops their arguments while returning.  This
19663 saves one instruction in the caller since there is no need to pop
19664 the arguments there.
19666 This calling convention is incompatible with the one normally
19667 used on Unix, so you cannot use it if you need to call libraries
19668 compiled with the Unix compiler.
19670 Also, you must provide function prototypes for all functions that
19671 take variable numbers of arguments (including @code{printf});
19672 otherwise incorrect code is generated for calls to those
19673 functions.
19675 In addition, seriously incorrect code results if you call a
19676 function with too many arguments.  (Normally, extra arguments are
19677 harmlessly ignored.)
19679 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19680 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19682 @item -mno-rtd
19683 @opindex mno-rtd
19684 Do not use the calling conventions selected by @option{-mrtd}.
19685 This is the default.
19687 @item -malign-int
19688 @itemx -mno-align-int
19689 @opindex malign-int
19690 @opindex mno-align-int
19691 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19692 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19693 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19694 Aligning variables on 32-bit boundaries produces code that runs somewhat
19695 faster on processors with 32-bit busses at the expense of more memory.
19697 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19698 aligns structures containing the above types differently than
19699 most published application binary interface specifications for the m68k.
19701 @item -mpcrel
19702 @opindex mpcrel
19703 Use the pc-relative addressing mode of the 68000 directly, instead of
19704 using a global offset table.  At present, this option implies @option{-fpic},
19705 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19706 not presently supported with @option{-mpcrel}, though this could be supported for
19707 68020 and higher processors.
19709 @item -mno-strict-align
19710 @itemx -mstrict-align
19711 @opindex mno-strict-align
19712 @opindex mstrict-align
19713 Do not (do) assume that unaligned memory references are handled by
19714 the system.
19716 @item -msep-data
19717 Generate code that allows the data segment to be located in a different
19718 area of memory from the text segment.  This allows for execute-in-place in
19719 an environment without virtual memory management.  This option implies
19720 @option{-fPIC}.
19722 @item -mno-sep-data
19723 Generate code that assumes that the data segment follows the text segment.
19724 This is the default.
19726 @item -mid-shared-library
19727 Generate code that supports shared libraries via the library ID method.
19728 This allows for execute-in-place and shared libraries in an environment
19729 without virtual memory management.  This option implies @option{-fPIC}.
19731 @item -mno-id-shared-library
19732 Generate code that doesn't assume ID-based shared libraries are being used.
19733 This is the default.
19735 @item -mshared-library-id=n
19736 Specifies the identification number of the ID-based shared library being
19737 compiled.  Specifying a value of 0 generates more compact code; specifying
19738 other values forces the allocation of that number to the current
19739 library, but is no more space- or time-efficient than omitting this option.
19741 @item -mxgot
19742 @itemx -mno-xgot
19743 @opindex mxgot
19744 @opindex mno-xgot
19745 When generating position-independent code for ColdFire, generate code
19746 that works if the GOT has more than 8192 entries.  This code is
19747 larger and slower than code generated without this option.  On M680x0
19748 processors, this option is not needed; @option{-fPIC} suffices.
19750 GCC normally uses a single instruction to load values from the GOT@.
19751 While this is relatively efficient, it only works if the GOT
19752 is smaller than about 64k.  Anything larger causes the linker
19753 to report an error such as:
19755 @cindex relocation truncated to fit (ColdFire)
19756 @smallexample
19757 relocation truncated to fit: R_68K_GOT16O foobar
19758 @end smallexample
19760 If this happens, you should recompile your code with @option{-mxgot}.
19761 It should then work with very large GOTs.  However, code generated with
19762 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19763 the value of a global symbol.
19765 Note that some linkers, including newer versions of the GNU linker,
19766 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19767 you should only need to use @option{-mxgot} when compiling a single
19768 object file that accesses more than 8192 GOT entries.  Very few do.
19770 These options have no effect unless GCC is generating
19771 position-independent code.
19773 @item -mlong-jump-table-offsets
19774 @opindex mlong-jump-table-offsets
19775 Use 32-bit offsets in @code{switch} tables.  The default is to use
19776 16-bit offsets.
19778 @end table
19780 @node MCore Options
19781 @subsection MCore Options
19782 @cindex MCore options
19784 These are the @samp{-m} options defined for the Motorola M*Core
19785 processors.
19787 @table @gcctabopt
19789 @item -mhardlit
19790 @itemx -mno-hardlit
19791 @opindex mhardlit
19792 @opindex mno-hardlit
19793 Inline constants into the code stream if it can be done in two
19794 instructions or less.
19796 @item -mdiv
19797 @itemx -mno-div
19798 @opindex mdiv
19799 @opindex mno-div
19800 Use the divide instruction.  (Enabled by default).
19802 @item -mrelax-immediate
19803 @itemx -mno-relax-immediate
19804 @opindex mrelax-immediate
19805 @opindex mno-relax-immediate
19806 Allow arbitrary-sized immediates in bit operations.
19808 @item -mwide-bitfields
19809 @itemx -mno-wide-bitfields
19810 @opindex mwide-bitfields
19811 @opindex mno-wide-bitfields
19812 Always treat bit-fields as @code{int}-sized.
19814 @item -m4byte-functions
19815 @itemx -mno-4byte-functions
19816 @opindex m4byte-functions
19817 @opindex mno-4byte-functions
19818 Force all functions to be aligned to a 4-byte boundary.
19820 @item -mcallgraph-data
19821 @itemx -mno-callgraph-data
19822 @opindex mcallgraph-data
19823 @opindex mno-callgraph-data
19824 Emit callgraph information.
19826 @item -mslow-bytes
19827 @itemx -mno-slow-bytes
19828 @opindex mslow-bytes
19829 @opindex mno-slow-bytes
19830 Prefer word access when reading byte quantities.
19832 @item -mlittle-endian
19833 @itemx -mbig-endian
19834 @opindex mlittle-endian
19835 @opindex mbig-endian
19836 Generate code for a little-endian target.
19838 @item -m210
19839 @itemx -m340
19840 @opindex m210
19841 @opindex m340
19842 Generate code for the 210 processor.
19844 @item -mno-lsim
19845 @opindex mno-lsim
19846 Assume that runtime support has been provided and so omit the
19847 simulator library (@file{libsim.a)} from the linker command line.
19849 @item -mstack-increment=@var{size}
19850 @opindex mstack-increment
19851 Set the maximum amount for a single stack increment operation.  Large
19852 values can increase the speed of programs that contain functions
19853 that need a large amount of stack space, but they can also trigger a
19854 segmentation fault if the stack is extended too much.  The default
19855 value is 0x1000.
19857 @end table
19859 @node MeP Options
19860 @subsection MeP Options
19861 @cindex MeP options
19863 @table @gcctabopt
19865 @item -mabsdiff
19866 @opindex mabsdiff
19867 Enables the @code{abs} instruction, which is the absolute difference
19868 between two registers.
19870 @item -mall-opts
19871 @opindex mall-opts
19872 Enables all the optional instructions---average, multiply, divide, bit
19873 operations, leading zero, absolute difference, min/max, clip, and
19874 saturation.
19877 @item -maverage
19878 @opindex maverage
19879 Enables the @code{ave} instruction, which computes the average of two
19880 registers.
19882 @item -mbased=@var{n}
19883 @opindex mbased=
19884 Variables of size @var{n} bytes or smaller are placed in the
19885 @code{.based} section by default.  Based variables use the @code{$tp}
19886 register as a base register, and there is a 128-byte limit to the
19887 @code{.based} section.
19889 @item -mbitops
19890 @opindex mbitops
19891 Enables the bit operation instructions---bit test (@code{btstm}), set
19892 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19893 test-and-set (@code{tas}).
19895 @item -mc=@var{name}
19896 @opindex mc=
19897 Selects which section constant data is placed in.  @var{name} may
19898 be @samp{tiny}, @samp{near}, or @samp{far}.
19900 @item -mclip
19901 @opindex mclip
19902 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19903 useful unless you also provide @option{-mminmax}.
19905 @item -mconfig=@var{name}
19906 @opindex mconfig=
19907 Selects one of the built-in core configurations.  Each MeP chip has
19908 one or more modules in it; each module has a core CPU and a variety of
19909 coprocessors, optional instructions, and peripherals.  The
19910 @code{MeP-Integrator} tool, not part of GCC, provides these
19911 configurations through this option; using this option is the same as
19912 using all the corresponding command-line options.  The default
19913 configuration is @samp{default}.
19915 @item -mcop
19916 @opindex mcop
19917 Enables the coprocessor instructions.  By default, this is a 32-bit
19918 coprocessor.  Note that the coprocessor is normally enabled via the
19919 @option{-mconfig=} option.
19921 @item -mcop32
19922 @opindex mcop32
19923 Enables the 32-bit coprocessor's instructions.
19925 @item -mcop64
19926 @opindex mcop64
19927 Enables the 64-bit coprocessor's instructions.
19929 @item -mivc2
19930 @opindex mivc2
19931 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19933 @item -mdc
19934 @opindex mdc
19935 Causes constant variables to be placed in the @code{.near} section.
19937 @item -mdiv
19938 @opindex mdiv
19939 Enables the @code{div} and @code{divu} instructions.
19941 @item -meb
19942 @opindex meb
19943 Generate big-endian code.
19945 @item -mel
19946 @opindex mel
19947 Generate little-endian code.
19949 @item -mio-volatile
19950 @opindex mio-volatile
19951 Tells the compiler that any variable marked with the @code{io}
19952 attribute is to be considered volatile.
19954 @item -ml
19955 @opindex ml
19956 Causes variables to be assigned to the @code{.far} section by default.
19958 @item -mleadz
19959 @opindex mleadz
19960 Enables the @code{leadz} (leading zero) instruction.
19962 @item -mm
19963 @opindex mm
19964 Causes variables to be assigned to the @code{.near} section by default.
19966 @item -mminmax
19967 @opindex mminmax
19968 Enables the @code{min} and @code{max} instructions.
19970 @item -mmult
19971 @opindex mmult
19972 Enables the multiplication and multiply-accumulate instructions.
19974 @item -mno-opts
19975 @opindex mno-opts
19976 Disables all the optional instructions enabled by @option{-mall-opts}.
19978 @item -mrepeat
19979 @opindex mrepeat
19980 Enables the @code{repeat} and @code{erepeat} instructions, used for
19981 low-overhead looping.
19983 @item -ms
19984 @opindex ms
19985 Causes all variables to default to the @code{.tiny} section.  Note
19986 that there is a 65536-byte limit to this section.  Accesses to these
19987 variables use the @code{%gp} base register.
19989 @item -msatur
19990 @opindex msatur
19991 Enables the saturation instructions.  Note that the compiler does not
19992 currently generate these itself, but this option is included for
19993 compatibility with other tools, like @code{as}.
19995 @item -msdram
19996 @opindex msdram
19997 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19999 @item -msim
20000 @opindex msim
20001 Link the simulator run-time libraries.
20003 @item -msimnovec
20004 @opindex msimnovec
20005 Link the simulator runtime libraries, excluding built-in support
20006 for reset and exception vectors and tables.
20008 @item -mtf
20009 @opindex mtf
20010 Causes all functions to default to the @code{.far} section.  Without
20011 this option, functions default to the @code{.near} section.
20013 @item -mtiny=@var{n}
20014 @opindex mtiny=
20015 Variables that are @var{n} bytes or smaller are allocated to the
20016 @code{.tiny} section.  These variables use the @code{$gp} base
20017 register.  The default for this option is 4, but note that there's a
20018 65536-byte limit to the @code{.tiny} section.
20020 @end table
20022 @node MicroBlaze Options
20023 @subsection MicroBlaze Options
20024 @cindex MicroBlaze Options
20026 @table @gcctabopt
20028 @item -msoft-float
20029 @opindex msoft-float
20030 Use software emulation for floating point (default).
20032 @item -mhard-float
20033 @opindex mhard-float
20034 Use hardware floating-point instructions.
20036 @item -mmemcpy
20037 @opindex mmemcpy
20038 Do not optimize block moves, use @code{memcpy}.
20040 @item -mno-clearbss
20041 @opindex mno-clearbss
20042 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20044 @item -mcpu=@var{cpu-type}
20045 @opindex mcpu=
20046 Use features of, and schedule code for, the given CPU.
20047 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20048 where @var{X} is a major version, @var{YY} is the minor version, and
20049 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20050 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20052 @item -mxl-soft-mul
20053 @opindex mxl-soft-mul
20054 Use software multiply emulation (default).
20056 @item -mxl-soft-div
20057 @opindex mxl-soft-div
20058 Use software emulation for divides (default).
20060 @item -mxl-barrel-shift
20061 @opindex mxl-barrel-shift
20062 Use the hardware barrel shifter.
20064 @item -mxl-pattern-compare
20065 @opindex mxl-pattern-compare
20066 Use pattern compare instructions.
20068 @item -msmall-divides
20069 @opindex msmall-divides
20070 Use table lookup optimization for small signed integer divisions.
20072 @item -mxl-stack-check
20073 @opindex mxl-stack-check
20074 This option is deprecated.  Use @option{-fstack-check} instead.
20076 @item -mxl-gp-opt
20077 @opindex mxl-gp-opt
20078 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20080 @item -mxl-multiply-high
20081 @opindex mxl-multiply-high
20082 Use multiply high instructions for high part of 32x32 multiply.
20084 @item -mxl-float-convert
20085 @opindex mxl-float-convert
20086 Use hardware floating-point conversion instructions.
20088 @item -mxl-float-sqrt
20089 @opindex mxl-float-sqrt
20090 Use hardware floating-point square root instruction.
20092 @item -mbig-endian
20093 @opindex mbig-endian
20094 Generate code for a big-endian target.
20096 @item -mlittle-endian
20097 @opindex mlittle-endian
20098 Generate code for a little-endian target.
20100 @item -mxl-reorder
20101 @opindex mxl-reorder
20102 Use reorder instructions (swap and byte reversed load/store).
20104 @item -mxl-mode-@var{app-model}
20105 Select application model @var{app-model}.  Valid models are
20106 @table @samp
20107 @item executable
20108 normal executable (default), uses startup code @file{crt0.o}.
20110 @item xmdstub
20111 for use with Xilinx Microprocessor Debugger (XMD) based
20112 software intrusive debug agent called xmdstub. This uses startup file
20113 @file{crt1.o} and sets the start address of the program to 0x800.
20115 @item bootstrap
20116 for applications that are loaded using a bootloader.
20117 This model uses startup file @file{crt2.o} which does not contain a processor
20118 reset vector handler. This is suitable for transferring control on a
20119 processor reset to the bootloader rather than the application.
20121 @item novectors
20122 for applications that do not require any of the
20123 MicroBlaze vectors. This option may be useful for applications running
20124 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20125 @end table
20127 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20128 @option{-mxl-mode-@var{app-model}}.
20130 @end table
20132 @node MIPS Options
20133 @subsection MIPS Options
20134 @cindex MIPS options
20136 @table @gcctabopt
20138 @item -EB
20139 @opindex EB
20140 Generate big-endian code.
20142 @item -EL
20143 @opindex EL
20144 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20145 configurations.
20147 @item -march=@var{arch}
20148 @opindex march
20149 Generate code that runs on @var{arch}, which can be the name of a
20150 generic MIPS ISA, or the name of a particular processor.
20151 The ISA names are:
20152 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20153 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20154 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20155 @samp{mips64r5} and @samp{mips64r6}.
20156 The processor names are:
20157 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20158 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20159 @samp{5kc}, @samp{5kf},
20160 @samp{20kc},
20161 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20162 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20163 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20164 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20165 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20166 @samp{i6400},
20167 @samp{interaptiv},
20168 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20169 @samp{m4k},
20170 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20171 @samp{m5100}, @samp{m5101},
20172 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20173 @samp{orion},
20174 @samp{p5600},
20175 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20176 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20177 @samp{rm7000}, @samp{rm9000},
20178 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20179 @samp{sb1},
20180 @samp{sr71000},
20181 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20182 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20183 @samp{xlr} and @samp{xlp}.
20184 The special value @samp{from-abi} selects the
20185 most compatible architecture for the selected ABI (that is,
20186 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20188 The native Linux/GNU toolchain also supports the value @samp{native},
20189 which selects the best architecture option for the host processor.
20190 @option{-march=native} has no effect if GCC does not recognize
20191 the processor.
20193 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20194 (for example, @option{-march=r2k}).  Prefixes are optional, and
20195 @samp{vr} may be written @samp{r}.
20197 Names of the form @samp{@var{n}f2_1} refer to processors with
20198 FPUs clocked at half the rate of the core, names of the form
20199 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20200 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20201 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20202 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20203 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20204 accepted as synonyms for @samp{@var{n}f1_1}.
20206 GCC defines two macros based on the value of this option.  The first
20207 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20208 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20209 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20210 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20211 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20213 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20214 above.  In other words, it has the full prefix and does not
20215 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20216 the macro names the resolved architecture (either @code{"mips1"} or
20217 @code{"mips3"}).  It names the default architecture when no
20218 @option{-march} option is given.
20220 @item -mtune=@var{arch}
20221 @opindex mtune
20222 Optimize for @var{arch}.  Among other things, this option controls
20223 the way instructions are scheduled, and the perceived cost of arithmetic
20224 operations.  The list of @var{arch} values is the same as for
20225 @option{-march}.
20227 When this option is not used, GCC optimizes for the processor
20228 specified by @option{-march}.  By using @option{-march} and
20229 @option{-mtune} together, it is possible to generate code that
20230 runs on a family of processors, but optimize the code for one
20231 particular member of that family.
20233 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20234 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20235 @option{-march} ones described above.
20237 @item -mips1
20238 @opindex mips1
20239 Equivalent to @option{-march=mips1}.
20241 @item -mips2
20242 @opindex mips2
20243 Equivalent to @option{-march=mips2}.
20245 @item -mips3
20246 @opindex mips3
20247 Equivalent to @option{-march=mips3}.
20249 @item -mips4
20250 @opindex mips4
20251 Equivalent to @option{-march=mips4}.
20253 @item -mips32
20254 @opindex mips32
20255 Equivalent to @option{-march=mips32}.
20257 @item -mips32r3
20258 @opindex mips32r3
20259 Equivalent to @option{-march=mips32r3}.
20261 @item -mips32r5
20262 @opindex mips32r5
20263 Equivalent to @option{-march=mips32r5}.
20265 @item -mips32r6
20266 @opindex mips32r6
20267 Equivalent to @option{-march=mips32r6}.
20269 @item -mips64
20270 @opindex mips64
20271 Equivalent to @option{-march=mips64}.
20273 @item -mips64r2
20274 @opindex mips64r2
20275 Equivalent to @option{-march=mips64r2}.
20277 @item -mips64r3
20278 @opindex mips64r3
20279 Equivalent to @option{-march=mips64r3}.
20281 @item -mips64r5
20282 @opindex mips64r5
20283 Equivalent to @option{-march=mips64r5}.
20285 @item -mips64r6
20286 @opindex mips64r6
20287 Equivalent to @option{-march=mips64r6}.
20289 @item -mips16
20290 @itemx -mno-mips16
20291 @opindex mips16
20292 @opindex mno-mips16
20293 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20294 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20296 MIPS16 code generation can also be controlled on a per-function basis
20297 by means of @code{mips16} and @code{nomips16} attributes.
20298 @xref{Function Attributes}, for more information.
20300 @item -mflip-mips16
20301 @opindex mflip-mips16
20302 Generate MIPS16 code on alternating functions.  This option is provided
20303 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20304 not intended for ordinary use in compiling user code.
20306 @item -minterlink-compressed
20307 @itemx -mno-interlink-compressed
20308 @opindex minterlink-compressed
20309 @opindex mno-interlink-compressed
20310 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20311 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20313 For example, code using the standard ISA encoding cannot jump directly
20314 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20315 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20316 knows that the target of the jump is not compressed.
20318 @item -minterlink-mips16
20319 @itemx -mno-interlink-mips16
20320 @opindex minterlink-mips16
20321 @opindex mno-interlink-mips16
20322 Aliases of @option{-minterlink-compressed} and
20323 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20324 and are retained for backwards compatibility.
20326 @item -mabi=32
20327 @itemx -mabi=o64
20328 @itemx -mabi=n32
20329 @itemx -mabi=64
20330 @itemx -mabi=eabi
20331 @opindex mabi=32
20332 @opindex mabi=o64
20333 @opindex mabi=n32
20334 @opindex mabi=64
20335 @opindex mabi=eabi
20336 Generate code for the given ABI@.
20338 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20339 generates 64-bit code when you select a 64-bit architecture, but you
20340 can use @option{-mgp32} to get 32-bit code instead.
20342 For information about the O64 ABI, see
20343 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20345 GCC supports a variant of the o32 ABI in which floating-point registers
20346 are 64 rather than 32 bits wide.  You can select this combination with
20347 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20348 and @code{mfhc1} instructions and is therefore only supported for
20349 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20351 The register assignments for arguments and return values remain the
20352 same, but each scalar value is passed in a single 64-bit register
20353 rather than a pair of 32-bit registers.  For example, scalar
20354 floating-point values are returned in @samp{$f0} only, not a
20355 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20356 remains the same in that the even-numbered double-precision registers
20357 are saved.
20359 Two additional variants of the o32 ABI are supported to enable
20360 a transition from 32-bit to 64-bit registers.  These are FPXX
20361 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20362 The FPXX extension mandates that all code must execute correctly
20363 when run using 32-bit or 64-bit registers.  The code can be interlinked
20364 with either FP32 or FP64, but not both.
20365 The FP64A extension is similar to the FP64 extension but forbids the
20366 use of odd-numbered single-precision registers.  This can be used
20367 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20368 processors and allows both FP32 and FP64A code to interlink and
20369 run in the same process without changing FPU modes.
20371 @item -mabicalls
20372 @itemx -mno-abicalls
20373 @opindex mabicalls
20374 @opindex mno-abicalls
20375 Generate (do not generate) code that is suitable for SVR4-style
20376 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20377 systems.
20379 @item -mshared
20380 @itemx -mno-shared
20381 Generate (do not generate) code that is fully position-independent,
20382 and that can therefore be linked into shared libraries.  This option
20383 only affects @option{-mabicalls}.
20385 All @option{-mabicalls} code has traditionally been position-independent,
20386 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20387 as an extension, the GNU toolchain allows executables to use absolute
20388 accesses for locally-binding symbols.  It can also use shorter GP
20389 initialization sequences and generate direct calls to locally-defined
20390 functions.  This mode is selected by @option{-mno-shared}.
20392 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20393 objects that can only be linked by the GNU linker.  However, the option
20394 does not affect the ABI of the final executable; it only affects the ABI
20395 of relocatable objects.  Using @option{-mno-shared} generally makes
20396 executables both smaller and quicker.
20398 @option{-mshared} is the default.
20400 @item -mplt
20401 @itemx -mno-plt
20402 @opindex mplt
20403 @opindex mno-plt
20404 Assume (do not assume) that the static and dynamic linkers
20405 support PLTs and copy relocations.  This option only affects
20406 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20407 has no effect without @option{-msym32}.
20409 You can make @option{-mplt} the default by configuring
20410 GCC with @option{--with-mips-plt}.  The default is
20411 @option{-mno-plt} otherwise.
20413 @item -mxgot
20414 @itemx -mno-xgot
20415 @opindex mxgot
20416 @opindex mno-xgot
20417 Lift (do not lift) the usual restrictions on the size of the global
20418 offset table.
20420 GCC normally uses a single instruction to load values from the GOT@.
20421 While this is relatively efficient, it only works if the GOT
20422 is smaller than about 64k.  Anything larger causes the linker
20423 to report an error such as:
20425 @cindex relocation truncated to fit (MIPS)
20426 @smallexample
20427 relocation truncated to fit: R_MIPS_GOT16 foobar
20428 @end smallexample
20430 If this happens, you should recompile your code with @option{-mxgot}.
20431 This works with very large GOTs, although the code is also
20432 less efficient, since it takes three instructions to fetch the
20433 value of a global symbol.
20435 Note that some linkers can create multiple GOTs.  If you have such a
20436 linker, you should only need to use @option{-mxgot} when a single object
20437 file accesses more than 64k's worth of GOT entries.  Very few do.
20439 These options have no effect unless GCC is generating position
20440 independent code.
20442 @item -mgp32
20443 @opindex mgp32
20444 Assume that general-purpose registers are 32 bits wide.
20446 @item -mgp64
20447 @opindex mgp64
20448 Assume that general-purpose registers are 64 bits wide.
20450 @item -mfp32
20451 @opindex mfp32
20452 Assume that floating-point registers are 32 bits wide.
20454 @item -mfp64
20455 @opindex mfp64
20456 Assume that floating-point registers are 64 bits wide.
20458 @item -mfpxx
20459 @opindex mfpxx
20460 Do not assume the width of floating-point registers.
20462 @item -mhard-float
20463 @opindex mhard-float
20464 Use floating-point coprocessor instructions.
20466 @item -msoft-float
20467 @opindex msoft-float
20468 Do not use floating-point coprocessor instructions.  Implement
20469 floating-point calculations using library calls instead.
20471 @item -mno-float
20472 @opindex mno-float
20473 Equivalent to @option{-msoft-float}, but additionally asserts that the
20474 program being compiled does not perform any floating-point operations.
20475 This option is presently supported only by some bare-metal MIPS
20476 configurations, where it may select a special set of libraries
20477 that lack all floating-point support (including, for example, the
20478 floating-point @code{printf} formats).  
20479 If code compiled with @option{-mno-float} accidentally contains
20480 floating-point operations, it is likely to suffer a link-time
20481 or run-time failure.
20483 @item -msingle-float
20484 @opindex msingle-float
20485 Assume that the floating-point coprocessor only supports single-precision
20486 operations.
20488 @item -mdouble-float
20489 @opindex mdouble-float
20490 Assume that the floating-point coprocessor supports double-precision
20491 operations.  This is the default.
20493 @item -modd-spreg
20494 @itemx -mno-odd-spreg
20495 @opindex modd-spreg
20496 @opindex mno-odd-spreg
20497 Enable the use of odd-numbered single-precision floating-point registers
20498 for the o32 ABI.  This is the default for processors that are known to
20499 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20500 is set by default.
20502 @item -mabs=2008
20503 @itemx -mabs=legacy
20504 @opindex mabs=2008
20505 @opindex mabs=legacy
20506 These options control the treatment of the special not-a-number (NaN)
20507 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20508 @code{neg.@i{fmt}} machine instructions.
20510 By default or when @option{-mabs=legacy} is used the legacy
20511 treatment is selected.  In this case these instructions are considered
20512 arithmetic and avoided where correct operation is required and the
20513 input operand might be a NaN.  A longer sequence of instructions that
20514 manipulate the sign bit of floating-point datum manually is used
20515 instead unless the @option{-ffinite-math-only} option has also been
20516 specified.
20518 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20519 this case these instructions are considered non-arithmetic and therefore
20520 operating correctly in all cases, including in particular where the
20521 input operand is a NaN.  These instructions are therefore always used
20522 for the respective operations.
20524 @item -mnan=2008
20525 @itemx -mnan=legacy
20526 @opindex mnan=2008
20527 @opindex mnan=legacy
20528 These options control the encoding of the special not-a-number (NaN)
20529 IEEE 754 floating-point data.
20531 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20532 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20533 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20534 by the first bit of their trailing significand field being 1.
20536 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20537 this case qNaNs are denoted by the first bit of their trailing
20538 significand field being 1, whereas sNaNs are denoted by the first bit of
20539 their trailing significand field being 0.
20541 The default is @option{-mnan=legacy} unless GCC has been configured with
20542 @option{--with-nan=2008}.
20544 @item -mllsc
20545 @itemx -mno-llsc
20546 @opindex mllsc
20547 @opindex mno-llsc
20548 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20549 implement atomic memory built-in functions.  When neither option is
20550 specified, GCC uses the instructions if the target architecture
20551 supports them.
20553 @option{-mllsc} is useful if the runtime environment can emulate the
20554 instructions and @option{-mno-llsc} can be useful when compiling for
20555 nonstandard ISAs.  You can make either option the default by
20556 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20557 respectively.  @option{--with-llsc} is the default for some
20558 configurations; see the installation documentation for details.
20560 @item -mdsp
20561 @itemx -mno-dsp
20562 @opindex mdsp
20563 @opindex mno-dsp
20564 Use (do not use) revision 1 of the MIPS DSP ASE@.
20565 @xref{MIPS DSP Built-in Functions}.  This option defines the
20566 preprocessor macro @code{__mips_dsp}.  It also defines
20567 @code{__mips_dsp_rev} to 1.
20569 @item -mdspr2
20570 @itemx -mno-dspr2
20571 @opindex mdspr2
20572 @opindex mno-dspr2
20573 Use (do not use) revision 2 of the MIPS DSP ASE@.
20574 @xref{MIPS DSP Built-in Functions}.  This option defines the
20575 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20576 It also defines @code{__mips_dsp_rev} to 2.
20578 @item -msmartmips
20579 @itemx -mno-smartmips
20580 @opindex msmartmips
20581 @opindex mno-smartmips
20582 Use (do not use) the MIPS SmartMIPS ASE.
20584 @item -mpaired-single
20585 @itemx -mno-paired-single
20586 @opindex mpaired-single
20587 @opindex mno-paired-single
20588 Use (do not use) paired-single floating-point instructions.
20589 @xref{MIPS Paired-Single Support}.  This option requires
20590 hardware floating-point support to be enabled.
20592 @item -mdmx
20593 @itemx -mno-mdmx
20594 @opindex mdmx
20595 @opindex mno-mdmx
20596 Use (do not use) MIPS Digital Media Extension instructions.
20597 This option can only be used when generating 64-bit code and requires
20598 hardware floating-point support to be enabled.
20600 @item -mips3d
20601 @itemx -mno-mips3d
20602 @opindex mips3d
20603 @opindex mno-mips3d
20604 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20605 The option @option{-mips3d} implies @option{-mpaired-single}.
20607 @item -mmicromips
20608 @itemx -mno-micromips
20609 @opindex mmicromips
20610 @opindex mno-mmicromips
20611 Generate (do not generate) microMIPS code.
20613 MicroMIPS code generation can also be controlled on a per-function basis
20614 by means of @code{micromips} and @code{nomicromips} attributes.
20615 @xref{Function Attributes}, for more information.
20617 @item -mmt
20618 @itemx -mno-mt
20619 @opindex mmt
20620 @opindex mno-mt
20621 Use (do not use) MT Multithreading instructions.
20623 @item -mmcu
20624 @itemx -mno-mcu
20625 @opindex mmcu
20626 @opindex mno-mcu
20627 Use (do not use) the MIPS MCU ASE instructions.
20629 @item -meva
20630 @itemx -mno-eva
20631 @opindex meva
20632 @opindex mno-eva
20633 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20635 @item -mvirt
20636 @itemx -mno-virt
20637 @opindex mvirt
20638 @opindex mno-virt
20639 Use (do not use) the MIPS Virtualization (VZ) instructions.
20641 @item -mxpa
20642 @itemx -mno-xpa
20643 @opindex mxpa
20644 @opindex mno-xpa
20645 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20647 @item -mlong64
20648 @opindex mlong64
20649 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20650 an explanation of the default and the way that the pointer size is
20651 determined.
20653 @item -mlong32
20654 @opindex mlong32
20655 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20657 The default size of @code{int}s, @code{long}s and pointers depends on
20658 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20659 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20660 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20661 or the same size as integer registers, whichever is smaller.
20663 @item -msym32
20664 @itemx -mno-sym32
20665 @opindex msym32
20666 @opindex mno-sym32
20667 Assume (do not assume) that all symbols have 32-bit values, regardless
20668 of the selected ABI@.  This option is useful in combination with
20669 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20670 to generate shorter and faster references to symbolic addresses.
20672 @item -G @var{num}
20673 @opindex G
20674 Put definitions of externally-visible data in a small data section
20675 if that data is no bigger than @var{num} bytes.  GCC can then generate
20676 more efficient accesses to the data; see @option{-mgpopt} for details.
20678 The default @option{-G} option depends on the configuration.
20680 @item -mlocal-sdata
20681 @itemx -mno-local-sdata
20682 @opindex mlocal-sdata
20683 @opindex mno-local-sdata
20684 Extend (do not extend) the @option{-G} behavior to local data too,
20685 such as to static variables in C@.  @option{-mlocal-sdata} is the
20686 default for all configurations.
20688 If the linker complains that an application is using too much small data,
20689 you might want to try rebuilding the less performance-critical parts with
20690 @option{-mno-local-sdata}.  You might also want to build large
20691 libraries with @option{-mno-local-sdata}, so that the libraries leave
20692 more room for the main program.
20694 @item -mextern-sdata
20695 @itemx -mno-extern-sdata
20696 @opindex mextern-sdata
20697 @opindex mno-extern-sdata
20698 Assume (do not assume) that externally-defined data is in
20699 a small data section if the size of that data is within the @option{-G} limit.
20700 @option{-mextern-sdata} is the default for all configurations.
20702 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20703 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20704 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20705 is placed in a small data section.  If @var{Var} is defined by another
20706 module, you must either compile that module with a high-enough
20707 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20708 definition.  If @var{Var} is common, you must link the application
20709 with a high-enough @option{-G} setting.
20711 The easiest way of satisfying these restrictions is to compile
20712 and link every module with the same @option{-G} option.  However,
20713 you may wish to build a library that supports several different
20714 small data limits.  You can do this by compiling the library with
20715 the highest supported @option{-G} setting and additionally using
20716 @option{-mno-extern-sdata} to stop the library from making assumptions
20717 about externally-defined data.
20719 @item -mgpopt
20720 @itemx -mno-gpopt
20721 @opindex mgpopt
20722 @opindex mno-gpopt
20723 Use (do not use) GP-relative accesses for symbols that are known to be
20724 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20725 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20726 configurations.
20728 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20729 might not hold the value of @code{_gp}.  For example, if the code is
20730 part of a library that might be used in a boot monitor, programs that
20731 call boot monitor routines pass an unknown value in @code{$gp}.
20732 (In such situations, the boot monitor itself is usually compiled
20733 with @option{-G0}.)
20735 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20736 @option{-mno-extern-sdata}.
20738 @item -membedded-data
20739 @itemx -mno-embedded-data
20740 @opindex membedded-data
20741 @opindex mno-embedded-data
20742 Allocate variables to the read-only data section first if possible, then
20743 next in the small data section if possible, otherwise in data.  This gives
20744 slightly slower code than the default, but reduces the amount of RAM required
20745 when executing, and thus may be preferred for some embedded systems.
20747 @item -muninit-const-in-rodata
20748 @itemx -mno-uninit-const-in-rodata
20749 @opindex muninit-const-in-rodata
20750 @opindex mno-uninit-const-in-rodata
20751 Put uninitialized @code{const} variables in the read-only data section.
20752 This option is only meaningful in conjunction with @option{-membedded-data}.
20754 @item -mcode-readable=@var{setting}
20755 @opindex mcode-readable
20756 Specify whether GCC may generate code that reads from executable sections.
20757 There are three possible settings:
20759 @table @gcctabopt
20760 @item -mcode-readable=yes
20761 Instructions may freely access executable sections.  This is the
20762 default setting.
20764 @item -mcode-readable=pcrel
20765 MIPS16 PC-relative load instructions can access executable sections,
20766 but other instructions must not do so.  This option is useful on 4KSc
20767 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20768 It is also useful on processors that can be configured to have a dual
20769 instruction/data SRAM interface and that, like the M4K, automatically
20770 redirect PC-relative loads to the instruction RAM.
20772 @item -mcode-readable=no
20773 Instructions must not access executable sections.  This option can be
20774 useful on targets that are configured to have a dual instruction/data
20775 SRAM interface but that (unlike the M4K) do not automatically redirect
20776 PC-relative loads to the instruction RAM.
20777 @end table
20779 @item -msplit-addresses
20780 @itemx -mno-split-addresses
20781 @opindex msplit-addresses
20782 @opindex mno-split-addresses
20783 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20784 relocation operators.  This option has been superseded by
20785 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20787 @item -mexplicit-relocs
20788 @itemx -mno-explicit-relocs
20789 @opindex mexplicit-relocs
20790 @opindex mno-explicit-relocs
20791 Use (do not use) assembler relocation operators when dealing with symbolic
20792 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20793 is to use assembler macros instead.
20795 @option{-mexplicit-relocs} is the default if GCC was configured
20796 to use an assembler that supports relocation operators.
20798 @item -mcheck-zero-division
20799 @itemx -mno-check-zero-division
20800 @opindex mcheck-zero-division
20801 @opindex mno-check-zero-division
20802 Trap (do not trap) on integer division by zero.
20804 The default is @option{-mcheck-zero-division}.
20806 @item -mdivide-traps
20807 @itemx -mdivide-breaks
20808 @opindex mdivide-traps
20809 @opindex mdivide-breaks
20810 MIPS systems check for division by zero by generating either a
20811 conditional trap or a break instruction.  Using traps results in
20812 smaller code, but is only supported on MIPS II and later.  Also, some
20813 versions of the Linux kernel have a bug that prevents trap from
20814 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20815 allow conditional traps on architectures that support them and
20816 @option{-mdivide-breaks} to force the use of breaks.
20818 The default is usually @option{-mdivide-traps}, but this can be
20819 overridden at configure time using @option{--with-divide=breaks}.
20820 Divide-by-zero checks can be completely disabled using
20821 @option{-mno-check-zero-division}.
20823 @item -mload-store-pairs
20824 @itemx -mno-load-store-pairs
20825 @opindex mload-store-pairs
20826 @opindex mno-load-store-pairs
20827 Enable (disable) an optimization that pairs consecutive load or store
20828 instructions to enable load/store bonding.  This option is enabled by
20829 default but only takes effect when the selected architecture is known
20830 to support bonding.
20832 @item -mmemcpy
20833 @itemx -mno-memcpy
20834 @opindex mmemcpy
20835 @opindex mno-memcpy
20836 Force (do not force) the use of @code{memcpy} for non-trivial block
20837 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20838 most constant-sized copies.
20840 @item -mlong-calls
20841 @itemx -mno-long-calls
20842 @opindex mlong-calls
20843 @opindex mno-long-calls
20844 Disable (do not disable) use of the @code{jal} instruction.  Calling
20845 functions using @code{jal} is more efficient but requires the caller
20846 and callee to be in the same 256 megabyte segment.
20848 This option has no effect on abicalls code.  The default is
20849 @option{-mno-long-calls}.
20851 @item -mmad
20852 @itemx -mno-mad
20853 @opindex mmad
20854 @opindex mno-mad
20855 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20856 instructions, as provided by the R4650 ISA@.
20858 @item -mimadd
20859 @itemx -mno-imadd
20860 @opindex mimadd
20861 @opindex mno-imadd
20862 Enable (disable) use of the @code{madd} and @code{msub} integer
20863 instructions.  The default is @option{-mimadd} on architectures
20864 that support @code{madd} and @code{msub} except for the 74k 
20865 architecture where it was found to generate slower code.
20867 @item -mfused-madd
20868 @itemx -mno-fused-madd
20869 @opindex mfused-madd
20870 @opindex mno-fused-madd
20871 Enable (disable) use of the floating-point multiply-accumulate
20872 instructions, when they are available.  The default is
20873 @option{-mfused-madd}.
20875 On the R8000 CPU when multiply-accumulate instructions are used,
20876 the intermediate product is calculated to infinite precision
20877 and is not subject to the FCSR Flush to Zero bit.  This may be
20878 undesirable in some circumstances.  On other processors the result
20879 is numerically identical to the equivalent computation using
20880 separate multiply, add, subtract and negate instructions.
20882 @item -nocpp
20883 @opindex nocpp
20884 Tell the MIPS assembler to not run its preprocessor over user
20885 assembler files (with a @samp{.s} suffix) when assembling them.
20887 @item -mfix-24k
20888 @itemx -mno-fix-24k
20889 @opindex mfix-24k
20890 @opindex mno-fix-24k
20891 Work around the 24K E48 (lost data on stores during refill) errata.
20892 The workarounds are implemented by the assembler rather than by GCC@.
20894 @item -mfix-r4000
20895 @itemx -mno-fix-r4000
20896 @opindex mfix-r4000
20897 @opindex mno-fix-r4000
20898 Work around certain R4000 CPU errata:
20899 @itemize @minus
20900 @item
20901 A double-word or a variable shift may give an incorrect result if executed
20902 immediately after starting an integer division.
20903 @item
20904 A double-word or a variable shift may give an incorrect result if executed
20905 while an integer multiplication is in progress.
20906 @item
20907 An integer division may give an incorrect result if started in a delay slot
20908 of a taken branch or a jump.
20909 @end itemize
20911 @item -mfix-r4400
20912 @itemx -mno-fix-r4400
20913 @opindex mfix-r4400
20914 @opindex mno-fix-r4400
20915 Work around certain R4400 CPU errata:
20916 @itemize @minus
20917 @item
20918 A double-word or a variable shift may give an incorrect result if executed
20919 immediately after starting an integer division.
20920 @end itemize
20922 @item -mfix-r10000
20923 @itemx -mno-fix-r10000
20924 @opindex mfix-r10000
20925 @opindex mno-fix-r10000
20926 Work around certain R10000 errata:
20927 @itemize @minus
20928 @item
20929 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20930 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20931 @end itemize
20933 This option can only be used if the target architecture supports
20934 branch-likely instructions.  @option{-mfix-r10000} is the default when
20935 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20936 otherwise.
20938 @item -mfix-rm7000
20939 @itemx -mno-fix-rm7000
20940 @opindex mfix-rm7000
20941 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20942 workarounds are implemented by the assembler rather than by GCC@.
20944 @item -mfix-vr4120
20945 @itemx -mno-fix-vr4120
20946 @opindex mfix-vr4120
20947 Work around certain VR4120 errata:
20948 @itemize @minus
20949 @item
20950 @code{dmultu} does not always produce the correct result.
20951 @item
20952 @code{div} and @code{ddiv} do not always produce the correct result if one
20953 of the operands is negative.
20954 @end itemize
20955 The workarounds for the division errata rely on special functions in
20956 @file{libgcc.a}.  At present, these functions are only provided by
20957 the @code{mips64vr*-elf} configurations.
20959 Other VR4120 errata require a NOP to be inserted between certain pairs of
20960 instructions.  These errata are handled by the assembler, not by GCC itself.
20962 @item -mfix-vr4130
20963 @opindex mfix-vr4130
20964 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20965 workarounds are implemented by the assembler rather than by GCC,
20966 although GCC avoids using @code{mflo} and @code{mfhi} if the
20967 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20968 instructions are available instead.
20970 @item -mfix-sb1
20971 @itemx -mno-fix-sb1
20972 @opindex mfix-sb1
20973 Work around certain SB-1 CPU core errata.
20974 (This flag currently works around the SB-1 revision 2
20975 ``F1'' and ``F2'' floating-point errata.)
20977 @item -mr10k-cache-barrier=@var{setting}
20978 @opindex mr10k-cache-barrier
20979 Specify whether GCC should insert cache barriers to avoid the
20980 side effects of speculation on R10K processors.
20982 In common with many processors, the R10K tries to predict the outcome
20983 of a conditional branch and speculatively executes instructions from
20984 the ``taken'' branch.  It later aborts these instructions if the
20985 predicted outcome is wrong.  However, on the R10K, even aborted
20986 instructions can have side effects.
20988 This problem only affects kernel stores and, depending on the system,
20989 kernel loads.  As an example, a speculatively-executed store may load
20990 the target memory into cache and mark the cache line as dirty, even if
20991 the store itself is later aborted.  If a DMA operation writes to the
20992 same area of memory before the ``dirty'' line is flushed, the cached
20993 data overwrites the DMA-ed data.  See the R10K processor manual
20994 for a full description, including other potential problems.
20996 One workaround is to insert cache barrier instructions before every memory
20997 access that might be speculatively executed and that might have side
20998 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20999 controls GCC's implementation of this workaround.  It assumes that
21000 aborted accesses to any byte in the following regions does not have
21001 side effects:
21003 @enumerate
21004 @item
21005 the memory occupied by the current function's stack frame;
21007 @item
21008 the memory occupied by an incoming stack argument;
21010 @item
21011 the memory occupied by an object with a link-time-constant address.
21012 @end enumerate
21014 It is the kernel's responsibility to ensure that speculative
21015 accesses to these regions are indeed safe.
21017 If the input program contains a function declaration such as:
21019 @smallexample
21020 void foo (void);
21021 @end smallexample
21023 then the implementation of @code{foo} must allow @code{j foo} and
21024 @code{jal foo} to be executed speculatively.  GCC honors this
21025 restriction for functions it compiles itself.  It expects non-GCC
21026 functions (such as hand-written assembly code) to do the same.
21028 The option has three forms:
21030 @table @gcctabopt
21031 @item -mr10k-cache-barrier=load-store
21032 Insert a cache barrier before a load or store that might be
21033 speculatively executed and that might have side effects even
21034 if aborted.
21036 @item -mr10k-cache-barrier=store
21037 Insert a cache barrier before a store that might be speculatively
21038 executed and that might have side effects even if aborted.
21040 @item -mr10k-cache-barrier=none
21041 Disable the insertion of cache barriers.  This is the default setting.
21042 @end table
21044 @item -mflush-func=@var{func}
21045 @itemx -mno-flush-func
21046 @opindex mflush-func
21047 Specifies the function to call to flush the I and D caches, or to not
21048 call any such function.  If called, the function must take the same
21049 arguments as the common @code{_flush_func}, that is, the address of the
21050 memory range for which the cache is being flushed, the size of the
21051 memory range, and the number 3 (to flush both caches).  The default
21052 depends on the target GCC was configured for, but commonly is either
21053 @code{_flush_func} or @code{__cpu_flush}.
21055 @item mbranch-cost=@var{num}
21056 @opindex mbranch-cost
21057 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21058 This cost is only a heuristic and is not guaranteed to produce
21059 consistent results across releases.  A zero cost redundantly selects
21060 the default, which is based on the @option{-mtune} setting.
21062 @item -mbranch-likely
21063 @itemx -mno-branch-likely
21064 @opindex mbranch-likely
21065 @opindex mno-branch-likely
21066 Enable or disable use of Branch Likely instructions, regardless of the
21067 default for the selected architecture.  By default, Branch Likely
21068 instructions may be generated if they are supported by the selected
21069 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21070 and processors that implement those architectures; for those, Branch
21071 Likely instructions are not be generated by default because the MIPS32
21072 and MIPS64 architectures specifically deprecate their use.
21074 @item -mcompact-branches=never
21075 @itemx -mcompact-branches=optimal
21076 @itemx -mcompact-branches=always
21077 @opindex mcompact-branches=never
21078 @opindex mcompact-branches=optimal
21079 @opindex mcompact-branches=always
21080 These options control which form of branches will be generated.  The
21081 default is @option{-mcompact-branches=optimal}.
21083 The @option{-mcompact-branches=never} option ensures that compact branch
21084 instructions will never be generated.
21086 The @option{-mcompact-branches=always} option ensures that a compact
21087 branch instruction will be generated if available.  If a compact branch
21088 instruction is not available, a delay slot form of the branch will be
21089 used instead.
21091 This option is supported from MIPS Release 6 onwards.
21093 The @option{-mcompact-branches=optimal} option will cause a delay slot
21094 branch to be used if one is available in the current ISA and the delay
21095 slot is successfully filled.  If the delay slot is not filled, a compact
21096 branch will be chosen if one is available.
21098 @item -mfp-exceptions
21099 @itemx -mno-fp-exceptions
21100 @opindex mfp-exceptions
21101 Specifies whether FP exceptions are enabled.  This affects how
21102 FP instructions are scheduled for some processors.
21103 The default is that FP exceptions are
21104 enabled.
21106 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21107 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21108 FP pipe.
21110 @item -mvr4130-align
21111 @itemx -mno-vr4130-align
21112 @opindex mvr4130-align
21113 The VR4130 pipeline is two-way superscalar, but can only issue two
21114 instructions together if the first one is 8-byte aligned.  When this
21115 option is enabled, GCC aligns pairs of instructions that it
21116 thinks should execute in parallel.
21118 This option only has an effect when optimizing for the VR4130.
21119 It normally makes code faster, but at the expense of making it bigger.
21120 It is enabled by default at optimization level @option{-O3}.
21122 @item -msynci
21123 @itemx -mno-synci
21124 @opindex msynci
21125 Enable (disable) generation of @code{synci} instructions on
21126 architectures that support it.  The @code{synci} instructions (if
21127 enabled) are generated when @code{__builtin___clear_cache} is
21128 compiled.
21130 This option defaults to @option{-mno-synci}, but the default can be
21131 overridden by configuring GCC with @option{--with-synci}.
21133 When compiling code for single processor systems, it is generally safe
21134 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21135 does not invalidate the instruction caches on all cores and may lead
21136 to undefined behavior.
21138 @item -mrelax-pic-calls
21139 @itemx -mno-relax-pic-calls
21140 @opindex mrelax-pic-calls
21141 Try to turn PIC calls that are normally dispatched via register
21142 @code{$25} into direct calls.  This is only possible if the linker can
21143 resolve the destination at link time and if the destination is within
21144 range for a direct call.
21146 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21147 an assembler and a linker that support the @code{.reloc} assembly
21148 directive and @option{-mexplicit-relocs} is in effect.  With
21149 @option{-mno-explicit-relocs}, this optimization can be performed by the
21150 assembler and the linker alone without help from the compiler.
21152 @item -mmcount-ra-address
21153 @itemx -mno-mcount-ra-address
21154 @opindex mmcount-ra-address
21155 @opindex mno-mcount-ra-address
21156 Emit (do not emit) code that allows @code{_mcount} to modify the
21157 calling function's return address.  When enabled, this option extends
21158 the usual @code{_mcount} interface with a new @var{ra-address}
21159 parameter, which has type @code{intptr_t *} and is passed in register
21160 @code{$12}.  @code{_mcount} can then modify the return address by
21161 doing both of the following:
21162 @itemize
21163 @item
21164 Returning the new address in register @code{$31}.
21165 @item
21166 Storing the new address in @code{*@var{ra-address}},
21167 if @var{ra-address} is nonnull.
21168 @end itemize
21170 The default is @option{-mno-mcount-ra-address}.
21172 @item -mframe-header-opt
21173 @itemx -mno-frame-header-opt
21174 @opindex mframe-header-opt
21175 Enable (disable) frame header optimization in the o32 ABI.  When using the
21176 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21177 function to write out register arguments.  When enabled, this optimization
21178 will suppress the allocation of the frame header if it can be determined that
21179 it is unused.
21181 This optimization is off by default at all optimization levels.
21183 @item -mlxc1-sxc1
21184 @itemx -mno-lxc1-sxc1
21185 @opindex mlxc1-sxc1
21186 When applicable, enable (disable) the generation of @code{lwxc1},
21187 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21189 @item -mmadd4
21190 @itemx -mno-madd4
21191 @opindex mmadd4
21192 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21193 @code{madd.d} and related instructions.  Enabled by default.
21195 @end table
21197 @node MMIX Options
21198 @subsection MMIX Options
21199 @cindex MMIX Options
21201 These options are defined for the MMIX:
21203 @table @gcctabopt
21204 @item -mlibfuncs
21205 @itemx -mno-libfuncs
21206 @opindex mlibfuncs
21207 @opindex mno-libfuncs
21208 Specify that intrinsic library functions are being compiled, passing all
21209 values in registers, no matter the size.
21211 @item -mepsilon
21212 @itemx -mno-epsilon
21213 @opindex mepsilon
21214 @opindex mno-epsilon
21215 Generate floating-point comparison instructions that compare with respect
21216 to the @code{rE} epsilon register.
21218 @item -mabi=mmixware
21219 @itemx -mabi=gnu
21220 @opindex mabi=mmixware
21221 @opindex mabi=gnu
21222 Generate code that passes function parameters and return values that (in
21223 the called function) are seen as registers @code{$0} and up, as opposed to
21224 the GNU ABI which uses global registers @code{$231} and up.
21226 @item -mzero-extend
21227 @itemx -mno-zero-extend
21228 @opindex mzero-extend
21229 @opindex mno-zero-extend
21230 When reading data from memory in sizes shorter than 64 bits, use (do not
21231 use) zero-extending load instructions by default, rather than
21232 sign-extending ones.
21234 @item -mknuthdiv
21235 @itemx -mno-knuthdiv
21236 @opindex mknuthdiv
21237 @opindex mno-knuthdiv
21238 Make the result of a division yielding a remainder have the same sign as
21239 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21240 remainder follows the sign of the dividend.  Both methods are
21241 arithmetically valid, the latter being almost exclusively used.
21243 @item -mtoplevel-symbols
21244 @itemx -mno-toplevel-symbols
21245 @opindex mtoplevel-symbols
21246 @opindex mno-toplevel-symbols
21247 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21248 code can be used with the @code{PREFIX} assembly directive.
21250 @item -melf
21251 @opindex melf
21252 Generate an executable in the ELF format, rather than the default
21253 @samp{mmo} format used by the @command{mmix} simulator.
21255 @item -mbranch-predict
21256 @itemx -mno-branch-predict
21257 @opindex mbranch-predict
21258 @opindex mno-branch-predict
21259 Use (do not use) the probable-branch instructions, when static branch
21260 prediction indicates a probable branch.
21262 @item -mbase-addresses
21263 @itemx -mno-base-addresses
21264 @opindex mbase-addresses
21265 @opindex mno-base-addresses
21266 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21267 base address automatically generates a request (handled by the assembler
21268 and the linker) for a constant to be set up in a global register.  The
21269 register is used for one or more base address requests within the range 0
21270 to 255 from the value held in the register.  The generally leads to short
21271 and fast code, but the number of different data items that can be
21272 addressed is limited.  This means that a program that uses lots of static
21273 data may require @option{-mno-base-addresses}.
21275 @item -msingle-exit
21276 @itemx -mno-single-exit
21277 @opindex msingle-exit
21278 @opindex mno-single-exit
21279 Force (do not force) generated code to have a single exit point in each
21280 function.
21281 @end table
21283 @node MN10300 Options
21284 @subsection MN10300 Options
21285 @cindex MN10300 options
21287 These @option{-m} options are defined for Matsushita MN10300 architectures:
21289 @table @gcctabopt
21290 @item -mmult-bug
21291 @opindex mmult-bug
21292 Generate code to avoid bugs in the multiply instructions for the MN10300
21293 processors.  This is the default.
21295 @item -mno-mult-bug
21296 @opindex mno-mult-bug
21297 Do not generate code to avoid bugs in the multiply instructions for the
21298 MN10300 processors.
21300 @item -mam33
21301 @opindex mam33
21302 Generate code using features specific to the AM33 processor.
21304 @item -mno-am33
21305 @opindex mno-am33
21306 Do not generate code using features specific to the AM33 processor.  This
21307 is the default.
21309 @item -mam33-2
21310 @opindex mam33-2
21311 Generate code using features specific to the AM33/2.0 processor.
21313 @item -mam34
21314 @opindex mam34
21315 Generate code using features specific to the AM34 processor.
21317 @item -mtune=@var{cpu-type}
21318 @opindex mtune
21319 Use the timing characteristics of the indicated CPU type when
21320 scheduling instructions.  This does not change the targeted processor
21321 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21322 @samp{am33-2} or @samp{am34}.
21324 @item -mreturn-pointer-on-d0
21325 @opindex mreturn-pointer-on-d0
21326 When generating a function that returns a pointer, return the pointer
21327 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21328 only in @code{a0}, and attempts to call such functions without a prototype
21329 result in errors.  Note that this option is on by default; use
21330 @option{-mno-return-pointer-on-d0} to disable it.
21332 @item -mno-crt0
21333 @opindex mno-crt0
21334 Do not link in the C run-time initialization object file.
21336 @item -mrelax
21337 @opindex mrelax
21338 Indicate to the linker that it should perform a relaxation optimization pass
21339 to shorten branches, calls and absolute memory addresses.  This option only
21340 has an effect when used on the command line for the final link step.
21342 This option makes symbolic debugging impossible.
21344 @item -mliw
21345 @opindex mliw
21346 Allow the compiler to generate @emph{Long Instruction Word}
21347 instructions if the target is the @samp{AM33} or later.  This is the
21348 default.  This option defines the preprocessor macro @code{__LIW__}.
21350 @item -mnoliw
21351 @opindex mnoliw
21352 Do not allow the compiler to generate @emph{Long Instruction Word}
21353 instructions.  This option defines the preprocessor macro
21354 @code{__NO_LIW__}.
21356 @item -msetlb
21357 @opindex msetlb
21358 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21359 instructions if the target is the @samp{AM33} or later.  This is the
21360 default.  This option defines the preprocessor macro @code{__SETLB__}.
21362 @item -mnosetlb
21363 @opindex mnosetlb
21364 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21365 instructions.  This option defines the preprocessor macro
21366 @code{__NO_SETLB__}.
21368 @end table
21370 @node Moxie Options
21371 @subsection Moxie Options
21372 @cindex Moxie Options
21374 @table @gcctabopt
21376 @item -meb
21377 @opindex meb
21378 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21379 configurations.
21381 @item -mel
21382 @opindex mel
21383 Generate little-endian code.
21385 @item -mmul.x
21386 @opindex mmul.x
21387 Generate mul.x and umul.x instructions.  This is the default for
21388 @samp{moxiebox-*-*} configurations.
21390 @item -mno-crt0
21391 @opindex mno-crt0
21392 Do not link in the C run-time initialization object file.
21394 @end table
21396 @node MSP430 Options
21397 @subsection MSP430 Options
21398 @cindex MSP430 Options
21400 These options are defined for the MSP430:
21402 @table @gcctabopt
21404 @item -masm-hex
21405 @opindex masm-hex
21406 Force assembly output to always use hex constants.  Normally such
21407 constants are signed decimals, but this option is available for
21408 testsuite and/or aesthetic purposes.
21410 @item -mmcu=
21411 @opindex mmcu=
21412 Select the MCU to target.  This is used to create a C preprocessor
21413 symbol based upon the MCU name, converted to upper case and pre- and
21414 post-fixed with @samp{__}.  This in turn is used by the
21415 @file{msp430.h} header file to select an MCU-specific supplementary
21416 header file.
21418 The option also sets the ISA to use.  If the MCU name is one that is
21419 known to only support the 430 ISA then that is selected, otherwise the
21420 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21421 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21422 name selects the 430X ISA.
21424 In addition an MCU-specific linker script is added to the linker
21425 command line.  The script's name is the name of the MCU with
21426 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21427 command line defines the C preprocessor symbol @code{__XXX__} and
21428 cause the linker to search for a script called @file{xxx.ld}.
21430 This option is also passed on to the assembler.
21432 @item -mwarn-mcu
21433 @itemx -mno-warn-mcu
21434 @opindex mwarn-mcu
21435 @opindex mno-warn-mcu
21436 This option enables or disables warnings about conflicts between the
21437 MCU name specified by the @option{-mmcu} option and the ISA set by the
21438 @option{-mcpu} option and/or the hardware multiply support set by the
21439 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21440 MCU names.  This option is on by default.
21442 @item -mcpu=
21443 @opindex mcpu=
21444 Specifies the ISA to use.  Accepted values are @samp{msp430},
21445 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21446 @option{-mmcu=} option should be used to select the ISA.
21448 @item -msim
21449 @opindex msim
21450 Link to the simulator runtime libraries and linker script.  Overrides
21451 any scripts that would be selected by the @option{-mmcu=} option.
21453 @item -mlarge
21454 @opindex mlarge
21455 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21457 @item -msmall
21458 @opindex msmall
21459 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21461 @item -mrelax
21462 @opindex mrelax
21463 This option is passed to the assembler and linker, and allows the
21464 linker to perform certain optimizations that cannot be done until
21465 the final link.
21467 @item mhwmult=
21468 @opindex mhwmult=
21469 Describes the type of hardware multiply supported by the target.
21470 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21471 for the original 16-bit-only multiply supported by early MCUs.
21472 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21473 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21474 A value of @samp{auto} can also be given.  This tells GCC to deduce
21475 the hardware multiply support based upon the MCU name provided by the
21476 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21477 the MCU name is not recognized then no hardware multiply support is
21478 assumed.  @code{auto} is the default setting.
21480 Hardware multiplies are normally performed by calling a library
21481 routine.  This saves space in the generated code.  When compiling at
21482 @option{-O3} or higher however the hardware multiplier is invoked
21483 inline.  This makes for bigger, but faster code.
21485 The hardware multiply routines disable interrupts whilst running and
21486 restore the previous interrupt state when they finish.  This makes
21487 them safe to use inside interrupt handlers as well as in normal code.
21489 @item -minrt
21490 @opindex minrt
21491 Enable the use of a minimum runtime environment - no static
21492 initializers or constructors.  This is intended for memory-constrained
21493 devices.  The compiler includes special symbols in some objects
21494 that tell the linker and runtime which code fragments are required.
21496 @item -mcode-region=
21497 @itemx -mdata-region=
21498 @opindex mcode-region
21499 @opindex mdata-region
21500 These options tell the compiler where to place functions and data that
21501 do not have one of the @code{lower}, @code{upper}, @code{either} or
21502 @code{section} attributes.  Possible values are @code{lower},
21503 @code{upper}, @code{either} or @code{any}.  The first three behave
21504 like the corresponding attribute.  The fourth possible value -
21505 @code{any} - is the default.  It leaves placement entirely up to the
21506 linker script and how it assigns the standard sections
21507 (@code{.text}, @code{.data}, etc) to the memory regions.
21509 @item -msilicon-errata=
21510 @opindex msilicon-errata
21511 This option passes on a request to assembler to enable the fixes for
21512 the named silicon errata.
21514 @item -msilicon-errata-warn=
21515 @opindex msilicon-errata-warn
21516 This option passes on a request to the assembler to enable warning
21517 messages when a silicon errata might need to be applied.
21519 @end table
21521 @node NDS32 Options
21522 @subsection NDS32 Options
21523 @cindex NDS32 Options
21525 These options are defined for NDS32 implementations:
21527 @table @gcctabopt
21529 @item -mbig-endian
21530 @opindex mbig-endian
21531 Generate code in big-endian mode.
21533 @item -mlittle-endian
21534 @opindex mlittle-endian
21535 Generate code in little-endian mode.
21537 @item -mreduced-regs
21538 @opindex mreduced-regs
21539 Use reduced-set registers for register allocation.
21541 @item -mfull-regs
21542 @opindex mfull-regs
21543 Use full-set registers for register allocation.
21545 @item -mcmov
21546 @opindex mcmov
21547 Generate conditional move instructions.
21549 @item -mno-cmov
21550 @opindex mno-cmov
21551 Do not generate conditional move instructions.
21553 @item -mext-perf
21554 @opindex mperf-ext
21555 Generate performance extension instructions.
21557 @item -mno-ext-perf
21558 @opindex mno-perf-ext
21559 Do not generate performance extension instructions.
21561 @item -mext-perf2
21562 @opindex mperf-ext
21563 Generate performance extension 2 instructions.
21565 @item -mno-ext-perf2
21566 @opindex mno-perf-ext
21567 Do not generate performance extension 2 instructions.
21569 @item -mext-string
21570 @opindex mperf-ext
21571 Generate string extension instructions.
21573 @item -mno-ext-string
21574 @opindex mno-perf-ext
21575 Do not generate string extension instructions.
21577 @item -mv3push
21578 @opindex mv3push
21579 Generate v3 push25/pop25 instructions.
21581 @item -mno-v3push
21582 @opindex mno-v3push
21583 Do not generate v3 push25/pop25 instructions.
21585 @item -m16-bit
21586 @opindex m16-bit
21587 Generate 16-bit instructions.
21589 @item -mno-16-bit
21590 @opindex mno-16-bit
21591 Do not generate 16-bit instructions.
21593 @item -misr-vector-size=@var{num}
21594 @opindex misr-vector-size
21595 Specify the size of each interrupt vector, which must be 4 or 16.
21597 @item -mcache-block-size=@var{num}
21598 @opindex mcache-block-size
21599 Specify the size of each cache block,
21600 which must be a power of 2 between 4 and 512.
21602 @item -march=@var{arch}
21603 @opindex march
21604 Specify the name of the target architecture.
21606 @item -mcmodel=@var{code-model}
21607 @opindex mcmodel
21608 Set the code model to one of
21609 @table @asis
21610 @item @samp{small}
21611 All the data and read-only data segments must be within 512KB addressing space.
21612 The text segment must be within 16MB addressing space.
21613 @item @samp{medium}
21614 The data segment must be within 512KB while the read-only data segment can be
21615 within 4GB addressing space.  The text segment should be still within 16MB
21616 addressing space.
21617 @item @samp{large}
21618 All the text and data segments can be within 4GB addressing space.
21619 @end table
21621 @item -mctor-dtor
21622 @opindex mctor-dtor
21623 Enable constructor/destructor feature.
21625 @item -mrelax
21626 @opindex mrelax
21627 Guide linker to relax instructions.
21629 @end table
21631 @node Nios II Options
21632 @subsection Nios II Options
21633 @cindex Nios II options
21634 @cindex Altera Nios II options
21636 These are the options defined for the Altera Nios II processor.
21638 @table @gcctabopt
21640 @item -G @var{num}
21641 @opindex G
21642 @cindex smaller data references
21643 Put global and static objects less than or equal to @var{num} bytes
21644 into the small data or BSS sections instead of the normal data or BSS
21645 sections.  The default value of @var{num} is 8.
21647 @item -mgpopt=@var{option}
21648 @itemx -mgpopt
21649 @itemx -mno-gpopt
21650 @opindex mgpopt
21651 @opindex mno-gpopt
21652 Generate (do not generate) GP-relative accesses.  The following 
21653 @var{option} names are recognized:
21655 @table @samp
21657 @item none
21658 Do not generate GP-relative accesses.
21660 @item local
21661 Generate GP-relative accesses for small data objects that are not 
21662 external, weak, or uninitialized common symbols.  
21663 Also use GP-relative addressing for objects that
21664 have been explicitly placed in a small data section via a @code{section}
21665 attribute.
21667 @item global
21668 As for @samp{local}, but also generate GP-relative accesses for
21669 small data objects that are external, weak, or common.  If you use this option,
21670 you must ensure that all parts of your program (including libraries) are
21671 compiled with the same @option{-G} setting.
21673 @item data
21674 Generate GP-relative accesses for all data objects in the program.  If you
21675 use this option, the entire data and BSS segments
21676 of your program must fit in 64K of memory and you must use an appropriate
21677 linker script to allocate them within the addressable range of the
21678 global pointer.
21680 @item all
21681 Generate GP-relative addresses for function pointers as well as data
21682 pointers.  If you use this option, the entire text, data, and BSS segments
21683 of your program must fit in 64K of memory and you must use an appropriate
21684 linker script to allocate them within the addressable range of the
21685 global pointer.
21687 @end table
21689 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21690 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21692 The default is @option{-mgpopt} except when @option{-fpic} or
21693 @option{-fPIC} is specified to generate position-independent code.
21694 Note that the Nios II ABI does not permit GP-relative accesses from
21695 shared libraries.
21697 You may need to specify @option{-mno-gpopt} explicitly when building
21698 programs that include large amounts of small data, including large
21699 GOT data sections.  In this case, the 16-bit offset for GP-relative
21700 addressing may not be large enough to allow access to the entire 
21701 small data section.
21703 @item -mgprel-sec=@var{regexp}
21704 @opindex mgprel-sec
21705 This option specifies additional section names that can be accessed via
21706 GP-relative addressing.  It is most useful in conjunction with 
21707 @code{section} attributes on variable declarations 
21708 (@pxref{Common Variable Attributes}) and a custom linker script.  
21709 The @var{regexp} is a POSIX Extended Regular Expression.
21711 This option does not affect the behavior of the @option{-G} option, and 
21712 and the specified sections are in addition to the standard @code{.sdata} 
21713 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21715 @item -mr0rel-sec=@var{regexp}
21716 @opindex mr0rel-sec
21717 This option specifies names of sections that can be accessed via a 
21718 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21719 of the 32-bit address space.  It is most useful in conjunction with 
21720 @code{section} attributes on variable declarations 
21721 (@pxref{Common Variable Attributes}) and a custom linker script.  
21722 The @var{regexp} is a POSIX Extended Regular Expression.
21724 In contrast to the use of GP-relative addressing for small data, 
21725 zero-based addressing is never generated by default and there are no 
21726 conventional section names used in standard linker scripts for sections
21727 in the low or high areas of memory.
21729 @item -mel
21730 @itemx -meb
21731 @opindex mel
21732 @opindex meb
21733 Generate little-endian (default) or big-endian (experimental) code,
21734 respectively.
21736 @item -march=@var{arch}
21737 @opindex march
21738 This specifies the name of the target Nios II architecture.  GCC uses this
21739 name to determine what kind of instructions it can emit when generating
21740 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21742 The preprocessor macro @code{__nios2_arch__} is available to programs,
21743 with value 1 or 2, indicating the targeted ISA level.
21745 @item -mbypass-cache
21746 @itemx -mno-bypass-cache
21747 @opindex mno-bypass-cache
21748 @opindex mbypass-cache
21749 Force all load and store instructions to always bypass cache by 
21750 using I/O variants of the instructions. The default is not to
21751 bypass the cache.
21753 @item -mno-cache-volatile 
21754 @itemx -mcache-volatile       
21755 @opindex mcache-volatile 
21756 @opindex mno-cache-volatile
21757 Volatile memory access bypass the cache using the I/O variants of 
21758 the load and store instructions. The default is not to bypass the cache.
21760 @item -mno-fast-sw-div
21761 @itemx -mfast-sw-div
21762 @opindex mno-fast-sw-div
21763 @opindex mfast-sw-div
21764 Do not use table-based fast divide for small numbers. The default 
21765 is to use the fast divide at @option{-O3} and above.
21767 @item -mno-hw-mul
21768 @itemx -mhw-mul
21769 @itemx -mno-hw-mulx
21770 @itemx -mhw-mulx
21771 @itemx -mno-hw-div
21772 @itemx -mhw-div
21773 @opindex mno-hw-mul
21774 @opindex mhw-mul
21775 @opindex mno-hw-mulx
21776 @opindex mhw-mulx
21777 @opindex mno-hw-div
21778 @opindex mhw-div
21779 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21780 instructions by the compiler. The default is to emit @code{mul}
21781 and not emit @code{div} and @code{mulx}.
21783 @item -mbmx
21784 @itemx -mno-bmx
21785 @itemx -mcdx
21786 @itemx -mno-cdx
21787 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21788 CDX (code density) instructions.  Enabling these instructions also
21789 requires @option{-march=r2}.  Since these instructions are optional
21790 extensions to the R2 architecture, the default is not to emit them.
21792 @item -mcustom-@var{insn}=@var{N}
21793 @itemx -mno-custom-@var{insn}
21794 @opindex mcustom-@var{insn}
21795 @opindex mno-custom-@var{insn}
21796 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21797 custom instruction with encoding @var{N} when generating code that uses 
21798 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21799 instruction 253 for single-precision floating-point add operations instead
21800 of the default behavior of using a library call.
21802 The following values of @var{insn} are supported.  Except as otherwise
21803 noted, floating-point operations are expected to be implemented with
21804 normal IEEE 754 semantics and correspond directly to the C operators or the
21805 equivalent GCC built-in functions (@pxref{Other Builtins}).
21807 Single-precision floating point:
21808 @table @asis
21810 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21811 Binary arithmetic operations.
21813 @item @samp{fnegs}
21814 Unary negation.
21816 @item @samp{fabss}
21817 Unary absolute value.
21819 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21820 Comparison operations.
21822 @item @samp{fmins}, @samp{fmaxs}
21823 Floating-point minimum and maximum.  These instructions are only
21824 generated if @option{-ffinite-math-only} is specified.
21826 @item @samp{fsqrts}
21827 Unary square root operation.
21829 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21830 Floating-point trigonometric and exponential functions.  These instructions
21831 are only generated if @option{-funsafe-math-optimizations} is also specified.
21833 @end table
21835 Double-precision floating point:
21836 @table @asis
21838 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21839 Binary arithmetic operations.
21841 @item @samp{fnegd}
21842 Unary negation.
21844 @item @samp{fabsd}
21845 Unary absolute value.
21847 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21848 Comparison operations.
21850 @item @samp{fmind}, @samp{fmaxd}
21851 Double-precision minimum and maximum.  These instructions are only
21852 generated if @option{-ffinite-math-only} is specified.
21854 @item @samp{fsqrtd}
21855 Unary square root operation.
21857 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21858 Double-precision trigonometric and exponential functions.  These instructions
21859 are only generated if @option{-funsafe-math-optimizations} is also specified.
21861 @end table
21863 Conversions:
21864 @table @asis
21865 @item @samp{fextsd}
21866 Conversion from single precision to double precision.
21868 @item @samp{ftruncds}
21869 Conversion from double precision to single precision.
21871 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21872 Conversion from floating point to signed or unsigned integer types, with
21873 truncation towards zero.
21875 @item @samp{round}
21876 Conversion from single-precision floating point to signed integer,
21877 rounding to the nearest integer and ties away from zero.
21878 This corresponds to the @code{__builtin_lroundf} function when
21879 @option{-fno-math-errno} is used.
21881 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21882 Conversion from signed or unsigned integer types to floating-point types.
21884 @end table
21886 In addition, all of the following transfer instructions for internal
21887 registers X and Y must be provided to use any of the double-precision
21888 floating-point instructions.  Custom instructions taking two
21889 double-precision source operands expect the first operand in the
21890 64-bit register X.  The other operand (or only operand of a unary
21891 operation) is given to the custom arithmetic instruction with the
21892 least significant half in source register @var{src1} and the most
21893 significant half in @var{src2}.  A custom instruction that returns a
21894 double-precision result returns the most significant 32 bits in the
21895 destination register and the other half in 32-bit register Y.  
21896 GCC automatically generates the necessary code sequences to write
21897 register X and/or read register Y when double-precision floating-point
21898 instructions are used.
21900 @table @asis
21902 @item @samp{fwrx}
21903 Write @var{src1} into the least significant half of X and @var{src2} into
21904 the most significant half of X.
21906 @item @samp{fwry}
21907 Write @var{src1} into Y.
21909 @item @samp{frdxhi}, @samp{frdxlo}
21910 Read the most or least (respectively) significant half of X and store it in
21911 @var{dest}.
21913 @item @samp{frdy}
21914 Read the value of Y and store it into @var{dest}.
21915 @end table
21917 Note that you can gain more local control over generation of Nios II custom
21918 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21919 and @code{target("no-custom-@var{insn}")} function attributes
21920 (@pxref{Function Attributes})
21921 or pragmas (@pxref{Function Specific Option Pragmas}).
21923 @item -mcustom-fpu-cfg=@var{name}
21924 @opindex mcustom-fpu-cfg
21926 This option enables a predefined, named set of custom instruction encodings
21927 (see @option{-mcustom-@var{insn}} above).  
21928 Currently, the following sets are defined:
21930 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21931 @gccoptlist{-mcustom-fmuls=252 @gol
21932 -mcustom-fadds=253 @gol
21933 -mcustom-fsubs=254 @gol
21934 -fsingle-precision-constant}
21936 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21937 @gccoptlist{-mcustom-fmuls=252 @gol
21938 -mcustom-fadds=253 @gol
21939 -mcustom-fsubs=254 @gol
21940 -mcustom-fdivs=255 @gol
21941 -fsingle-precision-constant}
21943 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21944 @gccoptlist{-mcustom-floatus=243 @gol
21945 -mcustom-fixsi=244 @gol
21946 -mcustom-floatis=245 @gol
21947 -mcustom-fcmpgts=246 @gol
21948 -mcustom-fcmples=249 @gol
21949 -mcustom-fcmpeqs=250 @gol
21950 -mcustom-fcmpnes=251 @gol
21951 -mcustom-fmuls=252 @gol
21952 -mcustom-fadds=253 @gol
21953 -mcustom-fsubs=254 @gol
21954 -mcustom-fdivs=255 @gol
21955 -fsingle-precision-constant}
21957 Custom instruction assignments given by individual
21958 @option{-mcustom-@var{insn}=} options override those given by
21959 @option{-mcustom-fpu-cfg=}, regardless of the
21960 order of the options on the command line.
21962 Note that you can gain more local control over selection of a FPU
21963 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21964 function attribute (@pxref{Function Attributes})
21965 or pragma (@pxref{Function Specific Option Pragmas}).
21967 @end table
21969 These additional @samp{-m} options are available for the Altera Nios II
21970 ELF (bare-metal) target:
21972 @table @gcctabopt
21974 @item -mhal
21975 @opindex mhal
21976 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21977 startup and termination code, and is typically used in conjunction with
21978 @option{-msys-crt0=} to specify the location of the alternate startup code
21979 provided by the HAL BSP.
21981 @item -msmallc
21982 @opindex msmallc
21983 Link with a limited version of the C library, @option{-lsmallc}, rather than
21984 Newlib.
21986 @item -msys-crt0=@var{startfile}
21987 @opindex msys-crt0
21988 @var{startfile} is the file name of the startfile (crt0) to use 
21989 when linking.  This option is only useful in conjunction with @option{-mhal}.
21991 @item -msys-lib=@var{systemlib}
21992 @opindex msys-lib
21993 @var{systemlib} is the library name of the library that provides
21994 low-level system calls required by the C library,
21995 e.g. @code{read} and @code{write}.
21996 This option is typically used to link with a library provided by a HAL BSP.
21998 @end table
22000 @node Nvidia PTX Options
22001 @subsection Nvidia PTX Options
22002 @cindex Nvidia PTX options
22003 @cindex nvptx options
22005 These options are defined for Nvidia PTX:
22007 @table @gcctabopt
22009 @item -m32
22010 @itemx -m64
22011 @opindex m32
22012 @opindex m64
22013 Generate code for 32-bit or 64-bit ABI.
22015 @item -mmainkernel
22016 @opindex mmainkernel
22017 Link in code for a __main kernel.  This is for stand-alone instead of
22018 offloading execution.
22020 @item -moptimize
22021 @opindex moptimize
22022 Apply partitioned execution optimizations.  This is the default when any
22023 level of optimization is selected.
22025 @item -msoft-stack
22026 @opindex msoft-stack
22027 Generate code that does not use @code{.local} memory
22028 directly for stack storage. Instead, a per-warp stack pointer is
22029 maintained explicitly. This enables variable-length stack allocation (with
22030 variable-length arrays or @code{alloca}), and when global memory is used for
22031 underlying storage, makes it possible to access automatic variables from other
22032 threads, or with atomic instructions. This code generation variant is used
22033 for OpenMP offloading, but the option is exposed on its own for the purpose
22034 of testing the compiler; to generate code suitable for linking into programs
22035 using OpenMP offloading, use option @option{-mgomp}.
22037 @item -muniform-simt
22038 @opindex muniform-simt
22039 Switch to code generation variant that allows to execute all threads in each
22040 warp, while maintaining memory state and side effects as if only one thread
22041 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22042 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22043 current lane index equals the master lane index), and the register being
22044 assigned is copied via a shuffle instruction from the master lane.  Outside of
22045 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22046 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22047 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22048 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22049 with current lane index to compute the master lane index.
22051 @item -mgomp
22052 @opindex mgomp
22053 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22054 @option{-muniform-simt} options, and selects corresponding multilib variant.
22056 @end table
22058 @node PDP-11 Options
22059 @subsection PDP-11 Options
22060 @cindex PDP-11 Options
22062 These options are defined for the PDP-11:
22064 @table @gcctabopt
22065 @item -mfpu
22066 @opindex mfpu
22067 Use hardware FPP floating point.  This is the default.  (FIS floating
22068 point on the PDP-11/40 is not supported.)
22070 @item -msoft-float
22071 @opindex msoft-float
22072 Do not use hardware floating point.
22074 @item -mac0
22075 @opindex mac0
22076 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22078 @item -mno-ac0
22079 @opindex mno-ac0
22080 Return floating-point results in memory.  This is the default.
22082 @item -m40
22083 @opindex m40
22084 Generate code for a PDP-11/40.
22086 @item -m45
22087 @opindex m45
22088 Generate code for a PDP-11/45.  This is the default.
22090 @item -m10
22091 @opindex m10
22092 Generate code for a PDP-11/10.
22094 @item -mbcopy-builtin
22095 @opindex mbcopy-builtin
22096 Use inline @code{movmemhi} patterns for copying memory.  This is the
22097 default.
22099 @item -mbcopy
22100 @opindex mbcopy
22101 Do not use inline @code{movmemhi} patterns for copying memory.
22103 @item -mint16
22104 @itemx -mno-int32
22105 @opindex mint16
22106 @opindex mno-int32
22107 Use 16-bit @code{int}.  This is the default.
22109 @item -mint32
22110 @itemx -mno-int16
22111 @opindex mint32
22112 @opindex mno-int16
22113 Use 32-bit @code{int}.
22115 @item -mfloat64
22116 @itemx -mno-float32
22117 @opindex mfloat64
22118 @opindex mno-float32
22119 Use 64-bit @code{float}.  This is the default.
22121 @item -mfloat32
22122 @itemx -mno-float64
22123 @opindex mfloat32
22124 @opindex mno-float64
22125 Use 32-bit @code{float}.
22127 @item -mabshi
22128 @opindex mabshi
22129 Use @code{abshi2} pattern.  This is the default.
22131 @item -mno-abshi
22132 @opindex mno-abshi
22133 Do not use @code{abshi2} pattern.
22135 @item -mbranch-expensive
22136 @opindex mbranch-expensive
22137 Pretend that branches are expensive.  This is for experimenting with
22138 code generation only.
22140 @item -mbranch-cheap
22141 @opindex mbranch-cheap
22142 Do not pretend that branches are expensive.  This is the default.
22144 @item -munix-asm
22145 @opindex munix-asm
22146 Use Unix assembler syntax.  This is the default when configured for
22147 @samp{pdp11-*-bsd}.
22149 @item -mdec-asm
22150 @opindex mdec-asm
22151 Use DEC assembler syntax.  This is the default when configured for any
22152 PDP-11 target other than @samp{pdp11-*-bsd}.
22153 @end table
22155 @node picoChip Options
22156 @subsection picoChip Options
22157 @cindex picoChip options
22159 These @samp{-m} options are defined for picoChip implementations:
22161 @table @gcctabopt
22163 @item -mae=@var{ae_type}
22164 @opindex mcpu
22165 Set the instruction set, register set, and instruction scheduling
22166 parameters for array element type @var{ae_type}.  Supported values
22167 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22169 @option{-mae=ANY} selects a completely generic AE type.  Code
22170 generated with this option runs on any of the other AE types.  The
22171 code is not as efficient as it would be if compiled for a specific
22172 AE type, and some types of operation (e.g., multiplication) do not
22173 work properly on all types of AE.
22175 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22176 for compiled code, and is the default.
22178 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22179 option may suffer from poor performance of byte (char) manipulation,
22180 since the DSP AE does not provide hardware support for byte load/stores.
22182 @item -msymbol-as-address
22183 Enable the compiler to directly use a symbol name as an address in a
22184 load/store instruction, without first loading it into a
22185 register.  Typically, the use of this option generates larger
22186 programs, which run faster than when the option isn't used.  However, the
22187 results vary from program to program, so it is left as a user option,
22188 rather than being permanently enabled.
22190 @item -mno-inefficient-warnings
22191 Disables warnings about the generation of inefficient code.  These
22192 warnings can be generated, for example, when compiling code that
22193 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22194 no hardware support for byte-level memory operations, so all byte
22195 load/stores must be synthesized from word load/store operations.  This is
22196 inefficient and a warning is generated to indicate
22197 that you should rewrite the code to avoid byte operations, or to target
22198 an AE type that has the necessary hardware support.  This option disables
22199 these warnings.
22201 @end table
22203 @node PowerPC Options
22204 @subsection PowerPC Options
22205 @cindex PowerPC options
22207 These are listed under @xref{RS/6000 and PowerPC Options}.
22209 @node PowerPC SPE Options
22210 @subsection PowerPC SPE Options
22211 @cindex PowerPC SPE options
22213 These @samp{-m} options are defined for PowerPC SPE:
22214 @table @gcctabopt
22215 @item -mmfcrf
22216 @itemx -mno-mfcrf
22217 @itemx -mpopcntb
22218 @itemx -mno-popcntb
22219 @opindex mmfcrf
22220 @opindex mno-mfcrf
22221 @opindex mpopcntb
22222 @opindex mno-popcntb
22223 You use these options to specify which instructions are available on the
22224 processor you are using.  The default value of these options is
22225 determined when configuring GCC@.  Specifying the
22226 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22227 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22228 rather than the options listed above.
22230 The @option{-mmfcrf} option allows GCC to generate the move from
22231 condition register field instruction implemented on the POWER4
22232 processor and other processors that support the PowerPC V2.01
22233 architecture.
22234 The @option{-mpopcntb} option allows GCC to generate the popcount and
22235 double-precision FP reciprocal estimate instruction implemented on the
22236 POWER5 processor and other processors that support the PowerPC V2.02
22237 architecture.
22239 @item -mcpu=@var{cpu_type}
22240 @opindex mcpu
22241 Set architecture type, register usage, and
22242 instruction scheduling parameters for machine type @var{cpu_type}.
22243 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22244 and @samp{native}.
22246 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22247 endian), with an appropriate, generic processor model assumed for
22248 scheduling purposes.
22250 Specifying @samp{native} as cpu type detects and selects the
22251 architecture option that corresponds to the host processor of the
22252 system performing the compilation.
22253 @option{-mcpu=native} has no effect if GCC does not recognize the
22254 processor.
22256 The other options specify a specific processor.  Code generated under
22257 those options runs best on that processor, and may not run at all on
22258 others.
22260 The @option{-mcpu} options automatically enable or disable the
22261 following options:
22263 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22264 -mpopcntb -mpopcntd @gol
22265 -msingle-float -mdouble-float @gol
22266 -mfloat128}
22268 The particular options set for any particular CPU varies between
22269 compiler versions, depending on what setting seems to produce optimal
22270 code for that CPU; it doesn't necessarily reflect the actual hardware's
22271 capabilities.  If you wish to set an individual option to a particular
22272 value, you may specify it after the @option{-mcpu} option, like
22273 @option{-mcpu=8548}.
22275 @item -mtune=@var{cpu_type}
22276 @opindex mtune
22277 Set the instruction scheduling parameters for machine type
22278 @var{cpu_type}, but do not set the architecture type or register usage,
22279 as @option{-mcpu=@var{cpu_type}} does.  The same
22280 values for @var{cpu_type} are used for @option{-mtune} as for
22281 @option{-mcpu}.  If both are specified, the code generated uses the
22282 architecture and registers set by @option{-mcpu}, but the
22283 scheduling parameters set by @option{-mtune}.
22285 @item -msecure-plt
22286 @opindex msecure-plt
22287 Generate code that allows @command{ld} and @command{ld.so}
22288 to build executables and shared
22289 libraries with non-executable @code{.plt} and @code{.got} sections.
22290 This is a PowerPC
22291 32-bit SYSV ABI option.
22293 @item -mbss-plt
22294 @opindex mbss-plt
22295 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22296 fills in, and
22297 requires @code{.plt} and @code{.got}
22298 sections that are both writable and executable.
22299 This is a PowerPC 32-bit SYSV ABI option.
22301 @item -misel
22302 @itemx -mno-isel
22303 @opindex misel
22304 @opindex mno-isel
22305 This switch enables or disables the generation of ISEL instructions.
22307 @item -misel=@var{yes/no}
22308 This switch has been deprecated.  Use @option{-misel} and
22309 @option{-mno-isel} instead.
22311 @item -mspe
22312 @itemx -mno-spe
22313 @opindex mspe
22314 @opindex mno-spe
22315 This switch enables or disables the generation of SPE simd
22316 instructions.
22318 @item -mspe=@var{yes/no}
22319 This option has been deprecated.  Use @option{-mspe} and
22320 @option{-mno-spe} instead.
22322 @item -mfloat128
22323 @itemx -mno-float128
22324 @opindex mfloat128
22325 @opindex mno-float128
22326 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22327 and use either software emulation for IEEE 128-bit floating point or
22328 hardware instructions.
22330 @item -mfloat-gprs=@var{yes/single/double/no}
22331 @itemx -mfloat-gprs
22332 @opindex mfloat-gprs
22333 This switch enables or disables the generation of floating-point
22334 operations on the general-purpose registers for architectures that
22335 support it.
22337 The argument @samp{yes} or @samp{single} enables the use of
22338 single-precision floating-point operations.
22340 The argument @samp{double} enables the use of single and
22341 double-precision floating-point operations.
22343 The argument @samp{no} disables floating-point operations on the
22344 general-purpose registers.
22346 This option is currently only available on the MPC854x.
22348 @item -mfull-toc
22349 @itemx -mno-fp-in-toc
22350 @itemx -mno-sum-in-toc
22351 @itemx -mminimal-toc
22352 @opindex mfull-toc
22353 @opindex mno-fp-in-toc
22354 @opindex mno-sum-in-toc
22355 @opindex mminimal-toc
22356 Modify generation of the TOC (Table Of Contents), which is created for
22357 every executable file.  The @option{-mfull-toc} option is selected by
22358 default.  In that case, GCC allocates at least one TOC entry for
22359 each unique non-automatic variable reference in your program.  GCC
22360 also places floating-point constants in the TOC@.  However, only
22361 16,384 entries are available in the TOC@.
22363 If you receive a linker error message that saying you have overflowed
22364 the available TOC space, you can reduce the amount of TOC space used
22365 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22366 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22367 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22368 generate code to calculate the sum of an address and a constant at
22369 run time instead of putting that sum into the TOC@.  You may specify one
22370 or both of these options.  Each causes GCC to produce very slightly
22371 slower and larger code at the expense of conserving TOC space.
22373 If you still run out of space in the TOC even when you specify both of
22374 these options, specify @option{-mminimal-toc} instead.  This option causes
22375 GCC to make only one TOC entry for every file.  When you specify this
22376 option, GCC produces code that is slower and larger but which
22377 uses extremely little TOC space.  You may wish to use this option
22378 only on files that contain less frequently-executed code.
22380 @item -maix32
22381 @opindex maix32
22382 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22384 @item -mxl-compat
22385 @itemx -mno-xl-compat
22386 @opindex mxl-compat
22387 @opindex mno-xl-compat
22388 Produce code that conforms more closely to IBM XL compiler semantics
22389 when using AIX-compatible ABI@.  Pass floating-point arguments to
22390 prototyped functions beyond the register save area (RSA) on the stack
22391 in addition to argument FPRs.  Do not assume that most significant
22392 double in 128-bit long double value is properly rounded when comparing
22393 values and converting to double.  Use XL symbol names for long double
22394 support routines.
22396 The AIX calling convention was extended but not initially documented to
22397 handle an obscure K&R C case of calling a function that takes the
22398 address of its arguments with fewer arguments than declared.  IBM XL
22399 compilers access floating-point arguments that do not fit in the
22400 RSA from the stack when a subroutine is compiled without
22401 optimization.  Because always storing floating-point arguments on the
22402 stack is inefficient and rarely needed, this option is not enabled by
22403 default and only is necessary when calling subroutines compiled by IBM
22404 XL compilers without optimization.
22406 @item -malign-natural
22407 @itemx -malign-power
22408 @opindex malign-natural
22409 @opindex malign-power
22410 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22411 @option{-malign-natural} overrides the ABI-defined alignment of larger
22412 types, such as floating-point doubles, on their natural size-based boundary.
22413 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22414 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22416 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22417 is not supported.
22419 @item -msoft-float
22420 @itemx -mhard-float
22421 @opindex msoft-float
22422 @opindex mhard-float
22423 Generate code that does not use (uses) the floating-point register set.
22424 Software floating-point emulation is provided if you use the
22425 @option{-msoft-float} option, and pass the option to GCC when linking.
22427 @item -msingle-float
22428 @itemx -mdouble-float
22429 @opindex msingle-float
22430 @opindex mdouble-float
22431 Generate code for single- or double-precision floating-point operations.
22432 @option{-mdouble-float} implies @option{-msingle-float}.
22434 @item -mmultiple
22435 @itemx -mno-multiple
22436 @opindex mmultiple
22437 @opindex mno-multiple
22438 Generate code that uses (does not use) the load multiple word
22439 instructions and the store multiple word instructions.  These
22440 instructions are generated by default on POWER systems, and not
22441 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22442 PowerPC systems, since those instructions do not work when the
22443 processor is in little-endian mode.  The exceptions are PPC740 and
22444 PPC750 which permit these instructions in little-endian mode.
22446 @item -mupdate
22447 @itemx -mno-update
22448 @opindex mupdate
22449 @opindex mno-update
22450 Generate code that uses (does not use) the load or store instructions
22451 that update the base register to the address of the calculated memory
22452 location.  These instructions are generated by default.  If you use
22453 @option{-mno-update}, there is a small window between the time that the
22454 stack pointer is updated and the address of the previous frame is
22455 stored, which means code that walks the stack frame across interrupts or
22456 signals may get corrupted data.
22458 @item -mavoid-indexed-addresses
22459 @itemx -mno-avoid-indexed-addresses
22460 @opindex mavoid-indexed-addresses
22461 @opindex mno-avoid-indexed-addresses
22462 Generate code that tries to avoid (not avoid) the use of indexed load
22463 or store instructions. These instructions can incur a performance
22464 penalty on Power6 processors in certain situations, such as when
22465 stepping through large arrays that cross a 16M boundary.  This option
22466 is enabled by default when targeting Power6 and disabled otherwise.
22468 @item -mfused-madd
22469 @itemx -mno-fused-madd
22470 @opindex mfused-madd
22471 @opindex mno-fused-madd
22472 Generate code that uses (does not use) the floating-point multiply and
22473 accumulate instructions.  These instructions are generated by default
22474 if hardware floating point is used.  The machine-dependent
22475 @option{-mfused-madd} option is now mapped to the machine-independent
22476 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22477 mapped to @option{-ffp-contract=off}.
22479 @item -mno-strict-align
22480 @itemx -mstrict-align
22481 @opindex mno-strict-align
22482 @opindex mstrict-align
22483 On System V.4 and embedded PowerPC systems do not (do) assume that
22484 unaligned memory references are handled by the system.
22486 @item -mrelocatable
22487 @itemx -mno-relocatable
22488 @opindex mrelocatable
22489 @opindex mno-relocatable
22490 Generate code that allows (does not allow) a static executable to be
22491 relocated to a different address at run time.  A simple embedded
22492 PowerPC system loader should relocate the entire contents of
22493 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22494 a table of 32-bit addresses generated by this option.  For this to
22495 work, all objects linked together must be compiled with
22496 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22497 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22499 @item -mrelocatable-lib
22500 @itemx -mno-relocatable-lib
22501 @opindex mrelocatable-lib
22502 @opindex mno-relocatable-lib
22503 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22504 @code{.fixup} section to allow static executables to be relocated at
22505 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22506 alignment of @option{-mrelocatable}.  Objects compiled with
22507 @option{-mrelocatable-lib} may be linked with objects compiled with
22508 any combination of the @option{-mrelocatable} options.
22510 @item -mno-toc
22511 @itemx -mtoc
22512 @opindex mno-toc
22513 @opindex mtoc
22514 On System V.4 and embedded PowerPC systems do not (do) assume that
22515 register 2 contains a pointer to a global area pointing to the addresses
22516 used in the program.
22518 @item -mlittle
22519 @itemx -mlittle-endian
22520 @opindex mlittle
22521 @opindex mlittle-endian
22522 On System V.4 and embedded PowerPC systems compile code for the
22523 processor in little-endian mode.  The @option{-mlittle-endian} option is
22524 the same as @option{-mlittle}.
22526 @item -mbig
22527 @itemx -mbig-endian
22528 @opindex mbig
22529 @opindex mbig-endian
22530 On System V.4 and embedded PowerPC systems compile code for the
22531 processor in big-endian mode.  The @option{-mbig-endian} option is
22532 the same as @option{-mbig}.
22534 @item -mdynamic-no-pic
22535 @opindex mdynamic-no-pic
22536 On Darwin and Mac OS X systems, compile code so that it is not
22537 relocatable, but that its external references are relocatable.  The
22538 resulting code is suitable for applications, but not shared
22539 libraries.
22541 @item -msingle-pic-base
22542 @opindex msingle-pic-base
22543 Treat the register used for PIC addressing as read-only, rather than
22544 loading it in the prologue for each function.  The runtime system is
22545 responsible for initializing this register with an appropriate value
22546 before execution begins.
22548 @item -mprioritize-restricted-insns=@var{priority}
22549 @opindex mprioritize-restricted-insns
22550 This option controls the priority that is assigned to
22551 dispatch-slot restricted instructions during the second scheduling
22552 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22553 or @samp{2} to assign no, highest, or second-highest (respectively)
22554 priority to dispatch-slot restricted
22555 instructions.
22557 @item -msched-costly-dep=@var{dependence_type}
22558 @opindex msched-costly-dep
22559 This option controls which dependences are considered costly
22560 by the target during instruction scheduling.  The argument
22561 @var{dependence_type} takes one of the following values:
22563 @table @asis
22564 @item @samp{no}
22565 No dependence is costly.
22567 @item @samp{all}
22568 All dependences are costly.
22570 @item @samp{true_store_to_load}
22571 A true dependence from store to load is costly.
22573 @item @samp{store_to_load}
22574 Any dependence from store to load is costly.
22576 @item @var{number}
22577 Any dependence for which the latency is greater than or equal to
22578 @var{number} is costly.
22579 @end table
22581 @item -minsert-sched-nops=@var{scheme}
22582 @opindex minsert-sched-nops
22583 This option controls which NOP insertion scheme is used during
22584 the second scheduling pass.  The argument @var{scheme} takes one of the
22585 following values:
22587 @table @asis
22588 @item @samp{no}
22589 Don't insert NOPs.
22591 @item @samp{pad}
22592 Pad with NOPs any dispatch group that has vacant issue slots,
22593 according to the scheduler's grouping.
22595 @item @samp{regroup_exact}
22596 Insert NOPs to force costly dependent insns into
22597 separate groups.  Insert exactly as many NOPs as needed to force an insn
22598 to a new group, according to the estimated processor grouping.
22600 @item @var{number}
22601 Insert NOPs to force costly dependent insns into
22602 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22603 @end table
22605 @item -mcall-sysv
22606 @opindex mcall-sysv
22607 On System V.4 and embedded PowerPC systems compile code using calling
22608 conventions that adhere to the March 1995 draft of the System V
22609 Application Binary Interface, PowerPC processor supplement.  This is the
22610 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22612 @item -mcall-sysv-eabi
22613 @itemx -mcall-eabi
22614 @opindex mcall-sysv-eabi
22615 @opindex mcall-eabi
22616 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22618 @item -mcall-sysv-noeabi
22619 @opindex mcall-sysv-noeabi
22620 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22622 @item -mcall-aixdesc
22623 @opindex m
22624 On System V.4 and embedded PowerPC systems compile code for the AIX
22625 operating system.
22627 @item -mcall-linux
22628 @opindex mcall-linux
22629 On System V.4 and embedded PowerPC systems compile code for the
22630 Linux-based GNU system.
22632 @item -mcall-freebsd
22633 @opindex mcall-freebsd
22634 On System V.4 and embedded PowerPC systems compile code for the
22635 FreeBSD operating system.
22637 @item -mcall-netbsd
22638 @opindex mcall-netbsd
22639 On System V.4 and embedded PowerPC systems compile code for the
22640 NetBSD operating system.
22642 @item -mcall-openbsd
22643 @opindex mcall-netbsd
22644 On System V.4 and embedded PowerPC systems compile code for the
22645 OpenBSD operating system.
22647 @item -maix-struct-return
22648 @opindex maix-struct-return
22649 Return all structures in memory (as specified by the AIX ABI)@.
22651 @item -msvr4-struct-return
22652 @opindex msvr4-struct-return
22653 Return structures smaller than 8 bytes in registers (as specified by the
22654 SVR4 ABI)@.
22656 @item -mabi=@var{abi-type}
22657 @opindex mabi
22658 Extend the current ABI with a particular extension, or remove such extension.
22659 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22660 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22661 @samp{elfv1}, @samp{elfv2}@.
22663 @item -mabi=spe
22664 @opindex mabi=spe
22665 Extend the current ABI with SPE ABI extensions.  This does not change
22666 the default ABI, instead it adds the SPE ABI extensions to the current
22667 ABI@.
22669 @item -mabi=no-spe
22670 @opindex mabi=no-spe
22671 Disable Book-E SPE ABI extensions for the current ABI@.
22673 @item -mabi=ibmlongdouble
22674 @opindex mabi=ibmlongdouble
22675 Change the current ABI to use IBM extended-precision long double.
22676 This is not likely to work if your system defaults to using IEEE
22677 extended-precision long double.  If you change the long double type
22678 from IEEE extended-precision, the compiler will issue a warning unless
22679 you use the @option{-Wno-psabi} option.
22681 @item -mabi=ieeelongdouble
22682 @opindex mabi=ieeelongdouble
22683 Change the current ABI to use IEEE extended-precision long double.
22684 This is not likely to work if your system defaults to using IBM
22685 extended-precision long double.  If you change the long double type
22686 from IBM extended-precision, the compiler will issue a warning unless
22687 you use the @option{-Wno-psabi} option.
22689 @item -mabi=elfv1
22690 @opindex mabi=elfv1
22691 Change the current ABI to use the ELFv1 ABI.
22692 This is the default ABI for big-endian PowerPC 64-bit Linux.
22693 Overriding the default ABI requires special system support and is
22694 likely to fail in spectacular ways.
22696 @item -mabi=elfv2
22697 @opindex mabi=elfv2
22698 Change the current ABI to use the ELFv2 ABI.
22699 This is the default ABI for little-endian PowerPC 64-bit Linux.
22700 Overriding the default ABI requires special system support and is
22701 likely to fail in spectacular ways.
22703 @item -mgnu-attribute
22704 @itemx -mno-gnu-attribute
22705 @opindex mgnu-attribute
22706 @opindex mno-gnu-attribute
22707 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22708 .gnu.attributes section that specify ABI variations in function
22709 parameters or return values.
22711 @item -mprototype
22712 @itemx -mno-prototype
22713 @opindex mprototype
22714 @opindex mno-prototype
22715 On System V.4 and embedded PowerPC systems assume that all calls to
22716 variable argument functions are properly prototyped.  Otherwise, the
22717 compiler must insert an instruction before every non-prototyped call to
22718 set or clear bit 6 of the condition code register (@code{CR}) to
22719 indicate whether floating-point values are passed in the floating-point
22720 registers in case the function takes variable arguments.  With
22721 @option{-mprototype}, only calls to prototyped variable argument functions
22722 set or clear the bit.
22724 @item -msim
22725 @opindex msim
22726 On embedded PowerPC systems, assume that the startup module is called
22727 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22728 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22729 configurations.
22731 @item -mmvme
22732 @opindex mmvme
22733 On embedded PowerPC systems, assume that the startup module is called
22734 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22735 @file{libc.a}.
22737 @item -mads
22738 @opindex mads
22739 On embedded PowerPC systems, assume that the startup module is called
22740 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22741 @file{libc.a}.
22743 @item -myellowknife
22744 @opindex myellowknife
22745 On embedded PowerPC systems, assume that the startup module is called
22746 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22747 @file{libc.a}.
22749 @item -mvxworks
22750 @opindex mvxworks
22751 On System V.4 and embedded PowerPC systems, specify that you are
22752 compiling for a VxWorks system.
22754 @item -memb
22755 @opindex memb
22756 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22757 header to indicate that @samp{eabi} extended relocations are used.
22759 @item -meabi
22760 @itemx -mno-eabi
22761 @opindex meabi
22762 @opindex mno-eabi
22763 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22764 Embedded Applications Binary Interface (EABI), which is a set of
22765 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22766 means that the stack is aligned to an 8-byte boundary, a function
22767 @code{__eabi} is called from @code{main} to set up the EABI
22768 environment, and the @option{-msdata} option can use both @code{r2} and
22769 @code{r13} to point to two separate small data areas.  Selecting
22770 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22771 no EABI initialization function is called from @code{main}, and the
22772 @option{-msdata} option only uses @code{r13} to point to a single
22773 small data area.  The @option{-meabi} option is on by default if you
22774 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22776 @item -msdata=eabi
22777 @opindex msdata=eabi
22778 On System V.4 and embedded PowerPC systems, put small initialized
22779 @code{const} global and static data in the @code{.sdata2} section, which
22780 is pointed to by register @code{r2}.  Put small initialized
22781 non-@code{const} global and static data in the @code{.sdata} section,
22782 which is pointed to by register @code{r13}.  Put small uninitialized
22783 global and static data in the @code{.sbss} section, which is adjacent to
22784 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22785 incompatible with the @option{-mrelocatable} option.  The
22786 @option{-msdata=eabi} option also sets the @option{-memb} option.
22788 @item -msdata=sysv
22789 @opindex msdata=sysv
22790 On System V.4 and embedded PowerPC systems, put small global and static
22791 data in the @code{.sdata} section, which is pointed to by register
22792 @code{r13}.  Put small uninitialized global and static data in the
22793 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22794 The @option{-msdata=sysv} option is incompatible with the
22795 @option{-mrelocatable} option.
22797 @item -msdata=default
22798 @itemx -msdata
22799 @opindex msdata=default
22800 @opindex msdata
22801 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22802 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22803 same as @option{-msdata=sysv}.
22805 @item -msdata=data
22806 @opindex msdata=data
22807 On System V.4 and embedded PowerPC systems, put small global
22808 data in the @code{.sdata} section.  Put small uninitialized global
22809 data in the @code{.sbss} section.  Do not use register @code{r13}
22810 to address small data however.  This is the default behavior unless
22811 other @option{-msdata} options are used.
22813 @item -msdata=none
22814 @itemx -mno-sdata
22815 @opindex msdata=none
22816 @opindex mno-sdata
22817 On embedded PowerPC systems, put all initialized global and static data
22818 in the @code{.data} section, and all uninitialized data in the
22819 @code{.bss} section.
22821 @item -mblock-move-inline-limit=@var{num}
22822 @opindex mblock-move-inline-limit
22823 Inline all block moves (such as calls to @code{memcpy} or structure
22824 copies) less than or equal to @var{num} bytes.  The minimum value for
22825 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22826 targets.  The default value is target-specific.
22828 @item -G @var{num}
22829 @opindex G
22830 @cindex smaller data references (PowerPC)
22831 @cindex .sdata/.sdata2 references (PowerPC)
22832 On embedded PowerPC systems, put global and static items less than or
22833 equal to @var{num} bytes into the small data or BSS sections instead of
22834 the normal data or BSS section.  By default, @var{num} is 8.  The
22835 @option{-G @var{num}} switch is also passed to the linker.
22836 All modules should be compiled with the same @option{-G @var{num}} value.
22838 @item -mregnames
22839 @itemx -mno-regnames
22840 @opindex mregnames
22841 @opindex mno-regnames
22842 On System V.4 and embedded PowerPC systems do (do not) emit register
22843 names in the assembly language output using symbolic forms.
22845 @item -mlongcall
22846 @itemx -mno-longcall
22847 @opindex mlongcall
22848 @opindex mno-longcall
22849 By default assume that all calls are far away so that a longer and more
22850 expensive calling sequence is required.  This is required for calls
22851 farther than 32 megabytes (33,554,432 bytes) from the current location.
22852 A short call is generated if the compiler knows
22853 the call cannot be that far away.  This setting can be overridden by
22854 the @code{shortcall} function attribute, or by @code{#pragma
22855 longcall(0)}.
22857 Some linkers are capable of detecting out-of-range calls and generating
22858 glue code on the fly.  On these systems, long calls are unnecessary and
22859 generate slower code.  As of this writing, the AIX linker can do this,
22860 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22861 to the GNU linker for 32-bit PowerPC systems as well.
22863 In the future, GCC may ignore all longcall specifications
22864 when the linker is known to generate glue.
22866 @item -mtls-markers
22867 @itemx -mno-tls-markers
22868 @opindex mtls-markers
22869 @opindex mno-tls-markers
22870 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22871 specifying the function argument.  The relocation allows the linker to
22872 reliably associate function call with argument setup instructions for
22873 TLS optimization, which in turn allows GCC to better schedule the
22874 sequence.
22876 @item -mrecip
22877 @itemx -mno-recip
22878 @opindex mrecip
22879 This option enables use of the reciprocal estimate and
22880 reciprocal square root estimate instructions with additional
22881 Newton-Raphson steps to increase precision instead of doing a divide or
22882 square root and divide for floating-point arguments.  You should use
22883 the @option{-ffast-math} option when using @option{-mrecip} (or at
22884 least @option{-funsafe-math-optimizations},
22885 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22886 @option{-fno-trapping-math}).  Note that while the throughput of the
22887 sequence is generally higher than the throughput of the non-reciprocal
22888 instruction, the precision of the sequence can be decreased by up to 2
22889 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22890 roots.
22892 @item -mrecip=@var{opt}
22893 @opindex mrecip=opt
22894 This option controls which reciprocal estimate instructions
22895 may be used.  @var{opt} is a comma-separated list of options, which may
22896 be preceded by a @code{!} to invert the option:
22898 @table @samp
22900 @item all
22901 Enable all estimate instructions.
22903 @item default
22904 Enable the default instructions, equivalent to @option{-mrecip}.
22906 @item none
22907 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22909 @item div
22910 Enable the reciprocal approximation instructions for both
22911 single and double precision.
22913 @item divf
22914 Enable the single-precision reciprocal approximation instructions.
22916 @item divd
22917 Enable the double-precision reciprocal approximation instructions.
22919 @item rsqrt
22920 Enable the reciprocal square root approximation instructions for both
22921 single and double precision.
22923 @item rsqrtf
22924 Enable the single-precision reciprocal square root approximation instructions.
22926 @item rsqrtd
22927 Enable the double-precision reciprocal square root approximation instructions.
22929 @end table
22931 So, for example, @option{-mrecip=all,!rsqrtd} enables
22932 all of the reciprocal estimate instructions, except for the
22933 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22934 which handle the double-precision reciprocal square root calculations.
22936 @item -mrecip-precision
22937 @itemx -mno-recip-precision
22938 @opindex mrecip-precision
22939 Assume (do not assume) that the reciprocal estimate instructions
22940 provide higher-precision estimates than is mandated by the PowerPC
22941 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22942 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22943 The double-precision square root estimate instructions are not generated by
22944 default on low-precision machines, since they do not provide an
22945 estimate that converges after three steps.
22947 @item -mpointers-to-nested-functions
22948 @itemx -mno-pointers-to-nested-functions
22949 @opindex mpointers-to-nested-functions
22950 Generate (do not generate) code to load up the static chain register
22951 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22952 systems where a function pointer points to a 3-word descriptor giving
22953 the function address, TOC value to be loaded in register @code{r2}, and
22954 static chain value to be loaded in register @code{r11}.  The
22955 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22956 call through pointers to nested functions or pointers
22957 to functions compiled in other languages that use the static chain if
22958 you use @option{-mno-pointers-to-nested-functions}.
22960 @item -msave-toc-indirect
22961 @itemx -mno-save-toc-indirect
22962 @opindex msave-toc-indirect
22963 Generate (do not generate) code to save the TOC value in the reserved
22964 stack location in the function prologue if the function calls through
22965 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22966 saved in the prologue, it is saved just before the call through the
22967 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22969 @item -mcompat-align-parm
22970 @itemx -mno-compat-align-parm
22971 @opindex mcompat-align-parm
22972 Generate (do not generate) code to pass structure parameters with a
22973 maximum alignment of 64 bits, for compatibility with older versions
22974 of GCC.
22976 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22977 structure parameter on a 128-bit boundary when that structure contained
22978 a member requiring 128-bit alignment.  This is corrected in more
22979 recent versions of GCC.  This option may be used to generate code
22980 that is compatible with functions compiled with older versions of
22981 GCC.
22983 The @option{-mno-compat-align-parm} option is the default.
22985 @item -mstack-protector-guard=@var{guard}
22986 @itemx -mstack-protector-guard-reg=@var{reg}
22987 @itemx -mstack-protector-guard-offset=@var{offset}
22988 @itemx -mstack-protector-guard-symbol=@var{symbol}
22989 @opindex mstack-protector-guard
22990 @opindex mstack-protector-guard-reg
22991 @opindex mstack-protector-guard-offset
22992 @opindex mstack-protector-guard-symbol
22993 Generate stack protection code using canary at @var{guard}.  Supported
22994 locations are @samp{global} for global canary or @samp{tls} for per-thread
22995 canary in the TLS block (the default with GNU libc version 2.4 or later).
22997 With the latter choice the options
22998 @option{-mstack-protector-guard-reg=@var{reg}} and
22999 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23000 which register to use as base register for reading the canary, and from what
23001 offset from that base register. The default for those is as specified in the
23002 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23003 the offset with a symbol reference to a canary in the TLS block.
23004 @end table
23007 @node RISC-V Options
23008 @subsection RISC-V Options
23009 @cindex RISC-V Options
23011 These command-line options are defined for RISC-V targets:
23013 @table @gcctabopt
23014 @item -mbranch-cost=@var{n}
23015 @opindex mbranch-cost
23016 Set the cost of branches to roughly @var{n} instructions.
23018 @item -mplt
23019 @itemx -mno-plt
23020 @opindex plt
23021 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23022 non-PIC.  The default is @option{-mplt}.
23024 @item -mabi=@var{ABI-string}
23025 @opindex mabi
23026 Specify integer and floating-point calling convention.  @var{ABI-string}
23027 contains two parts: the size of integer types and the registers used for
23028 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23029 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23030 32-bit), and that floating-point values up to 64 bits wide are passed in F
23031 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23032 allows the compiler to generate code that uses the F and D extensions but only
23033 allows floating-point values up to 32 bits long to be passed in registers; or
23034 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23035 passed in registers.
23037 The default for this argument is system dependent, users who want a specific
23038 calling convention should specify one explicitly.  The valid calling
23039 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23040 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23041 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23042 invalid because the ABI requires 64-bit values be passed in F registers, but F
23043 registers are only 32 bits wide.
23045 @item -mfdiv
23046 @itemx -mno-fdiv
23047 @opindex mfdiv
23048 Do or don't use hardware floating-point divide and square root instructions.
23049 This requires the F or D extensions for floating-point registers.  The default
23050 is to use them if the specified architecture has these instructions.
23052 @item -mdiv
23053 @itemx -mno-div
23054 @opindex mdiv
23055 Do or don't use hardware instructions for integer division.  This requires the
23056 M extension.  The default is to use them if the specified architecture has
23057 these instructions.
23059 @item -march=@var{ISA-string}
23060 @opindex march
23061 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23062 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23064 @item -mtune=@var{processor-string}
23065 @opindex mtune
23066 Optimize the output for the given processor, specified by microarchitecture
23067 name.
23069 @item -mpreferred-stack-boundary=@var{num}
23070 @opindex mpreferred-stack-boundary
23071 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23072 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23073 the default is 4 (16 bytes or 128-bits).
23075 @strong{Warning:} If you use this switch, then you must build all modules with
23076 the same value, including any libraries.  This includes the system libraries
23077 and startup modules.
23079 @item -msmall-data-limit=@var{n}
23080 @opindex msmall-data-limit
23081 Put global and static data smaller than @var{n} bytes into a special section
23082 (on some targets).
23084 @item -msave-restore
23085 @itemx -mno-save-restore
23086 @opindex msave-restore
23087 Do or don't use smaller but slower prologue and epilogue code that uses
23088 library function calls.  The default is to use fast inline prologues and
23089 epilogues.
23091 @item -mstrict-align
23092 @itemx -mno-strict-align
23093 @opindex mstrict-align
23094 Do not or do generate unaligned memory accesses.  The default is set depending
23095 on whether the processor we are optimizing for supports fast unaligned access
23096 or not.
23098 @item -mcmodel=medlow
23099 @opindex mcmodel=medlow
23100 Generate code for the medium-low code model. The program and its statically
23101 defined symbols must lie within a single 2 GiB address range and must lie
23102 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23103 statically or dynamically linked. This is the default code model.
23105 @item -mcmodel=medany
23106 @opindex mcmodel=medany
23107 Generate code for the medium-any code model. The program and its statically
23108 defined symbols must be within any single 2 GiB address range. Programs can be
23109 statically or dynamically linked.
23111 @item -mexplicit-relocs
23112 @itemx -mno-exlicit-relocs
23113 Use or do not use assembler relocation operators when dealing with symbolic
23114 addresses.  The alternative is to use assembler macros instead, which may
23115 limit optimization.
23117 @item -mrelax
23118 @itemx -mno-relax
23119 Take advantage of linker relaxations to reduce the number of instructions
23120 required to materialize symbol addresses. The default is to take advantage of
23121 linker relaxations.
23123 @end table
23125 @node RL78 Options
23126 @subsection RL78 Options
23127 @cindex RL78 Options
23129 @table @gcctabopt
23131 @item -msim
23132 @opindex msim
23133 Links in additional target libraries to support operation within a
23134 simulator.
23136 @item -mmul=none
23137 @itemx -mmul=g10
23138 @itemx -mmul=g13
23139 @itemx -mmul=g14
23140 @itemx -mmul=rl78
23141 @opindex mmul
23142 Specifies the type of hardware multiplication and division support to
23143 be used.  The simplest is @code{none}, which uses software for both
23144 multiplication and division.  This is the default.  The @code{g13}
23145 value is for the hardware multiply/divide peripheral found on the
23146 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23147 the multiplication and division instructions supported by the RL78/G14
23148 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23149 the value @code{mg10} is an alias for @code{none}.
23151 In addition a C preprocessor macro is defined, based upon the setting
23152 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23153 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23155 @item -mcpu=g10
23156 @itemx -mcpu=g13
23157 @itemx -mcpu=g14
23158 @itemx -mcpu=rl78
23159 @opindex mcpu
23160 Specifies the RL78 core to target.  The default is the G14 core, also
23161 known as an S3 core or just RL78.  The G13 or S2 core does not have
23162 multiply or divide instructions, instead it uses a hardware peripheral
23163 for these operations.  The G10 or S1 core does not have register
23164 banks, so it uses a different calling convention.
23166 If this option is set it also selects the type of hardware multiply
23167 support to use, unless this is overridden by an explicit
23168 @option{-mmul=none} option on the command line.  Thus specifying
23169 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23170 peripheral and specifying @option{-mcpu=g10} disables the use of
23171 hardware multiplications altogether.
23173 Note, although the RL78/G14 core is the default target, specifying
23174 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23175 change the behavior of the toolchain since it also enables G14
23176 hardware multiply support.  If these options are not specified on the
23177 command line then software multiplication routines will be used even
23178 though the code targets the RL78 core.  This is for backwards
23179 compatibility with older toolchains which did not have hardware
23180 multiply and divide support.
23182 In addition a C preprocessor macro is defined, based upon the setting
23183 of this option.  Possible values are: @code{__RL78_G10__},
23184 @code{__RL78_G13__} or @code{__RL78_G14__}.
23186 @item -mg10
23187 @itemx -mg13
23188 @itemx -mg14
23189 @itemx -mrl78
23190 @opindex mg10
23191 @opindex mg13
23192 @opindex mg14
23193 @opindex mrl78
23194 These are aliases for the corresponding @option{-mcpu=} option.  They
23195 are provided for backwards compatibility.
23197 @item -mallregs
23198 @opindex mallregs
23199 Allow the compiler to use all of the available registers.  By default
23200 registers @code{r24..r31} are reserved for use in interrupt handlers.
23201 With this option enabled these registers can be used in ordinary
23202 functions as well.
23204 @item -m64bit-doubles
23205 @itemx -m32bit-doubles
23206 @opindex m64bit-doubles
23207 @opindex m32bit-doubles
23208 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23209 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23210 @option{-m32bit-doubles}.
23212 @item -msave-mduc-in-interrupts
23213 @itemx -mno-save-mduc-in-interrupts
23214 @opindex msave-mduc-in-interrupts
23215 @opindex mno-save-mduc-in-interrupts
23216 Specifies that interrupt handler functions should preserve the
23217 MDUC registers.  This is only necessary if normal code might use
23218 the MDUC registers, for example because it performs multiplication
23219 and division operations.  The default is to ignore the MDUC registers
23220 as this makes the interrupt handlers faster.  The target option -mg13
23221 needs to be passed for this to work as this feature is only available
23222 on the G13 target (S2 core).  The MDUC registers will only be saved
23223 if the interrupt handler performs a multiplication or division
23224 operation or it calls another function.
23226 @end table
23228 @node RS/6000 and PowerPC Options
23229 @subsection IBM RS/6000 and PowerPC Options
23230 @cindex RS/6000 and PowerPC Options
23231 @cindex IBM RS/6000 and PowerPC Options
23233 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23234 @table @gcctabopt
23235 @item -mpowerpc-gpopt
23236 @itemx -mno-powerpc-gpopt
23237 @itemx -mpowerpc-gfxopt
23238 @itemx -mno-powerpc-gfxopt
23239 @need 800
23240 @itemx -mpowerpc64
23241 @itemx -mno-powerpc64
23242 @itemx -mmfcrf
23243 @itemx -mno-mfcrf
23244 @itemx -mpopcntb
23245 @itemx -mno-popcntb
23246 @itemx -mpopcntd
23247 @itemx -mno-popcntd
23248 @itemx -mfprnd
23249 @itemx -mno-fprnd
23250 @need 800
23251 @itemx -mcmpb
23252 @itemx -mno-cmpb
23253 @itemx -mmfpgpr
23254 @itemx -mno-mfpgpr
23255 @itemx -mhard-dfp
23256 @itemx -mno-hard-dfp
23257 @opindex mpowerpc-gpopt
23258 @opindex mno-powerpc-gpopt
23259 @opindex mpowerpc-gfxopt
23260 @opindex mno-powerpc-gfxopt
23261 @opindex mpowerpc64
23262 @opindex mno-powerpc64
23263 @opindex mmfcrf
23264 @opindex mno-mfcrf
23265 @opindex mpopcntb
23266 @opindex mno-popcntb
23267 @opindex mpopcntd
23268 @opindex mno-popcntd
23269 @opindex mfprnd
23270 @opindex mno-fprnd
23271 @opindex mcmpb
23272 @opindex mno-cmpb
23273 @opindex mmfpgpr
23274 @opindex mno-mfpgpr
23275 @opindex mhard-dfp
23276 @opindex mno-hard-dfp
23277 You use these options to specify which instructions are available on the
23278 processor you are using.  The default value of these options is
23279 determined when configuring GCC@.  Specifying the
23280 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23281 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23282 rather than the options listed above.
23284 Specifying @option{-mpowerpc-gpopt} allows
23285 GCC to use the optional PowerPC architecture instructions in the
23286 General Purpose group, including floating-point square root.  Specifying
23287 @option{-mpowerpc-gfxopt} allows GCC to
23288 use the optional PowerPC architecture instructions in the Graphics
23289 group, including floating-point select.
23291 The @option{-mmfcrf} option allows GCC to generate the move from
23292 condition register field instruction implemented on the POWER4
23293 processor and other processors that support the PowerPC V2.01
23294 architecture.
23295 The @option{-mpopcntb} option allows GCC to generate the popcount and
23296 double-precision FP reciprocal estimate instruction implemented on the
23297 POWER5 processor and other processors that support the PowerPC V2.02
23298 architecture.
23299 The @option{-mpopcntd} option allows GCC to generate the popcount
23300 instruction implemented on the POWER7 processor and other processors
23301 that support the PowerPC V2.06 architecture.
23302 The @option{-mfprnd} option allows GCC to generate the FP round to
23303 integer instructions implemented on the POWER5+ processor and other
23304 processors that support the PowerPC V2.03 architecture.
23305 The @option{-mcmpb} option allows GCC to generate the compare bytes
23306 instruction implemented on the POWER6 processor and other processors
23307 that support the PowerPC V2.05 architecture.
23308 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23309 general-purpose register instructions implemented on the POWER6X
23310 processor and other processors that support the extended PowerPC V2.05
23311 architecture.
23312 The @option{-mhard-dfp} option allows GCC to generate the decimal
23313 floating-point instructions implemented on some POWER processors.
23315 The @option{-mpowerpc64} option allows GCC to generate the additional
23316 64-bit instructions that are found in the full PowerPC64 architecture
23317 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23318 @option{-mno-powerpc64}.
23320 @item -mcpu=@var{cpu_type}
23321 @opindex mcpu
23322 Set architecture type, register usage, and
23323 instruction scheduling parameters for machine type @var{cpu_type}.
23324 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23325 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23326 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23327 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23328 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23329 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23330 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23331 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23332 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23333 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23334 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23335 @samp{rs64}, and @samp{native}.
23337 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23338 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23339 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23340 architecture machine types, with an appropriate, generic processor
23341 model assumed for scheduling purposes.
23343 Specifying @samp{native} as cpu type detects and selects the
23344 architecture option that corresponds to the host processor of the
23345 system performing the compilation.
23346 @option{-mcpu=native} has no effect if GCC does not recognize the
23347 processor.
23349 The other options specify a specific processor.  Code generated under
23350 those options runs best on that processor, and may not run at all on
23351 others.
23353 The @option{-mcpu} options automatically enable or disable the
23354 following options:
23356 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23357 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23358 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
23359 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23360 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
23361 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23363 The particular options set for any particular CPU varies between
23364 compiler versions, depending on what setting seems to produce optimal
23365 code for that CPU; it doesn't necessarily reflect the actual hardware's
23366 capabilities.  If you wish to set an individual option to a particular
23367 value, you may specify it after the @option{-mcpu} option, like
23368 @option{-mcpu=970 -mno-altivec}.
23370 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23371 not enabled or disabled by the @option{-mcpu} option at present because
23372 AIX does not have full support for these options.  You may still
23373 enable or disable them individually if you're sure it'll work in your
23374 environment.
23376 @item -mtune=@var{cpu_type}
23377 @opindex mtune
23378 Set the instruction scheduling parameters for machine type
23379 @var{cpu_type}, but do not set the architecture type or register usage,
23380 as @option{-mcpu=@var{cpu_type}} does.  The same
23381 values for @var{cpu_type} are used for @option{-mtune} as for
23382 @option{-mcpu}.  If both are specified, the code generated uses the
23383 architecture and registers set by @option{-mcpu}, but the
23384 scheduling parameters set by @option{-mtune}.
23386 @item -mcmodel=small
23387 @opindex mcmodel=small
23388 Generate PowerPC64 code for the small model: The TOC is limited to
23389 64k.
23391 @item -mcmodel=medium
23392 @opindex mcmodel=medium
23393 Generate PowerPC64 code for the medium model: The TOC and other static
23394 data may be up to a total of 4G in size.  This is the default for 64-bit
23395 Linux.
23397 @item -mcmodel=large
23398 @opindex mcmodel=large
23399 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23400 in size.  Other data and code is only limited by the 64-bit address
23401 space.
23403 @item -maltivec
23404 @itemx -mno-altivec
23405 @opindex maltivec
23406 @opindex mno-altivec
23407 Generate code that uses (does not use) AltiVec instructions, and also
23408 enable the use of built-in functions that allow more direct access to
23409 the AltiVec instruction set.  You may also need to set
23410 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23411 enhancements.
23413 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23414 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23415 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23416 match array element order corresponding to the endianness of the
23417 target.  That is, element zero identifies the leftmost element in a
23418 vector register when targeting a big-endian platform, and identifies
23419 the rightmost element in a vector register when targeting a
23420 little-endian platform.
23422 @item -maltivec=be
23423 @opindex maltivec=be
23424 Generate AltiVec instructions using big-endian element order,
23425 regardless of whether the target is big- or little-endian.  This is
23426 the default when targeting a big-endian platform.  Using this option
23427 is currently deprecated.  Support for this feature will be removed in
23428 GCC 9.
23430 The element order is used to interpret element numbers in AltiVec
23431 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23432 @code{vec_insert}.  By default, these match array element order
23433 corresponding to the endianness for the target.
23435 @item -maltivec=le
23436 @opindex maltivec=le
23437 Generate AltiVec instructions using little-endian element order,
23438 regardless of whether the target is big- or little-endian.  This is
23439 the default when targeting a little-endian platform.  This option is
23440 currently ignored when targeting a big-endian platform.
23442 The element order is used to interpret element numbers in AltiVec
23443 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23444 @code{vec_insert}.  By default, these match array element order
23445 corresponding to the endianness for the target.
23447 @item -mvrsave
23448 @itemx -mno-vrsave
23449 @opindex mvrsave
23450 @opindex mno-vrsave
23451 Generate VRSAVE instructions when generating AltiVec code.
23453 @item -msecure-plt
23454 @opindex msecure-plt
23455 Generate code that allows @command{ld} and @command{ld.so}
23456 to build executables and shared
23457 libraries with non-executable @code{.plt} and @code{.got} sections.
23458 This is a PowerPC
23459 32-bit SYSV ABI option.
23461 @item -mbss-plt
23462 @opindex mbss-plt
23463 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23464 fills in, and
23465 requires @code{.plt} and @code{.got}
23466 sections that are both writable and executable.
23467 This is a PowerPC 32-bit SYSV ABI option.
23469 @item -misel
23470 @itemx -mno-isel
23471 @opindex misel
23472 @opindex mno-isel
23473 This switch enables or disables the generation of ISEL instructions.
23475 @item -misel=@var{yes/no}
23476 This switch has been deprecated.  Use @option{-misel} and
23477 @option{-mno-isel} instead.
23479 @item -mpaired
23480 @itemx -mno-paired
23481 @opindex mpaired
23482 @opindex mno-paired
23483 This switch enables or disables the generation of PAIRED simd
23484 instructions.
23486 @item -mvsx
23487 @itemx -mno-vsx
23488 @opindex mvsx
23489 @opindex mno-vsx
23490 Generate code that uses (does not use) vector/scalar (VSX)
23491 instructions, and also enable the use of built-in functions that allow
23492 more direct access to the VSX instruction set.
23494 @item -mcrypto
23495 @itemx -mno-crypto
23496 @opindex mcrypto
23497 @opindex mno-crypto
23498 Enable the use (disable) of the built-in functions that allow direct
23499 access to the cryptographic instructions that were added in version
23500 2.07 of the PowerPC ISA.
23502 @item -mhtm
23503 @itemx -mno-htm
23504 @opindex mhtm
23505 @opindex mno-htm
23506 Enable (disable) the use of the built-in functions that allow direct
23507 access to the Hardware Transactional Memory (HTM) instructions that
23508 were added in version 2.07 of the PowerPC ISA.
23510 @item -mpower8-fusion
23511 @itemx -mno-power8-fusion
23512 @opindex mpower8-fusion
23513 @opindex mno-power8-fusion
23514 Generate code that keeps (does not keeps) some integer operations
23515 adjacent so that the instructions can be fused together on power8 and
23516 later processors.
23518 @item -mpower8-vector
23519 @itemx -mno-power8-vector
23520 @opindex mpower8-vector
23521 @opindex mno-power8-vector
23522 Generate code that uses (does not use) the vector and scalar
23523 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23524 enable the use of built-in functions that allow more direct access to
23525 the vector instructions.
23527 @item -mquad-memory
23528 @itemx -mno-quad-memory
23529 @opindex mquad-memory
23530 @opindex mno-quad-memory
23531 Generate code that uses (does not use) the non-atomic quad word memory
23532 instructions.  The @option{-mquad-memory} option requires use of
23533 64-bit mode.
23535 @item -mquad-memory-atomic
23536 @itemx -mno-quad-memory-atomic
23537 @opindex mquad-memory-atomic
23538 @opindex mno-quad-memory-atomic
23539 Generate code that uses (does not use) the atomic quad word memory
23540 instructions.  The @option{-mquad-memory-atomic} option requires use of
23541 64-bit mode.
23543 @item -mfloat128
23544 @itemx -mno-float128
23545 @opindex mfloat128
23546 @opindex mno-float128
23547 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23548 and use either software emulation for IEEE 128-bit floating point or
23549 hardware instructions.
23551 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23552 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23553 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23554 floating point support only works on PowerPC Linux systems.
23556 The default for @option{-mfloat128} is enabled on PowerPC Linux
23557 systems using the VSX instruction set, and disabled on other systems.
23559 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23560 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23561 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23562 floating point instructions.  Otherwise, if you do not specify to
23563 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23564 system, IEEE 128-bit floating point will be done with software
23565 emulation.
23567 @item -mfloat128-hardware
23568 @itemx -mno-float128-hardware
23569 @opindex mfloat128-hardware
23570 @opindex mno-float128-hardware
23571 Enable/disable using ISA 3.0 hardware instructions to support the
23572 @var{__float128} data type.
23574 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23575 Linux systems using the ISA 3.0 instruction set, and disabled on other
23576 systems.
23578 @item -m32
23579 @itemx -m64
23580 @opindex m32
23581 @opindex m64
23582 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23583 targets (including GNU/Linux).  The 32-bit environment sets int, long
23584 and pointer to 32 bits and generates code that runs on any PowerPC
23585 variant.  The 64-bit environment sets int to 32 bits and long and
23586 pointer to 64 bits, and generates code for PowerPC64, as for
23587 @option{-mpowerpc64}.
23589 @item -mfull-toc
23590 @itemx -mno-fp-in-toc
23591 @itemx -mno-sum-in-toc
23592 @itemx -mminimal-toc
23593 @opindex mfull-toc
23594 @opindex mno-fp-in-toc
23595 @opindex mno-sum-in-toc
23596 @opindex mminimal-toc
23597 Modify generation of the TOC (Table Of Contents), which is created for
23598 every executable file.  The @option{-mfull-toc} option is selected by
23599 default.  In that case, GCC allocates at least one TOC entry for
23600 each unique non-automatic variable reference in your program.  GCC
23601 also places floating-point constants in the TOC@.  However, only
23602 16,384 entries are available in the TOC@.
23604 If you receive a linker error message that saying you have overflowed
23605 the available TOC space, you can reduce the amount of TOC space used
23606 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23607 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23608 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23609 generate code to calculate the sum of an address and a constant at
23610 run time instead of putting that sum into the TOC@.  You may specify one
23611 or both of these options.  Each causes GCC to produce very slightly
23612 slower and larger code at the expense of conserving TOC space.
23614 If you still run out of space in the TOC even when you specify both of
23615 these options, specify @option{-mminimal-toc} instead.  This option causes
23616 GCC to make only one TOC entry for every file.  When you specify this
23617 option, GCC produces code that is slower and larger but which
23618 uses extremely little TOC space.  You may wish to use this option
23619 only on files that contain less frequently-executed code.
23621 @item -maix64
23622 @itemx -maix32
23623 @opindex maix64
23624 @opindex maix32
23625 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23626 @code{long} type, and the infrastructure needed to support them.
23627 Specifying @option{-maix64} implies @option{-mpowerpc64},
23628 while @option{-maix32} disables the 64-bit ABI and
23629 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23631 @item -mxl-compat
23632 @itemx -mno-xl-compat
23633 @opindex mxl-compat
23634 @opindex mno-xl-compat
23635 Produce code that conforms more closely to IBM XL compiler semantics
23636 when using AIX-compatible ABI@.  Pass floating-point arguments to
23637 prototyped functions beyond the register save area (RSA) on the stack
23638 in addition to argument FPRs.  Do not assume that most significant
23639 double in 128-bit long double value is properly rounded when comparing
23640 values and converting to double.  Use XL symbol names for long double
23641 support routines.
23643 The AIX calling convention was extended but not initially documented to
23644 handle an obscure K&R C case of calling a function that takes the
23645 address of its arguments with fewer arguments than declared.  IBM XL
23646 compilers access floating-point arguments that do not fit in the
23647 RSA from the stack when a subroutine is compiled without
23648 optimization.  Because always storing floating-point arguments on the
23649 stack is inefficient and rarely needed, this option is not enabled by
23650 default and only is necessary when calling subroutines compiled by IBM
23651 XL compilers without optimization.
23653 @item -mpe
23654 @opindex mpe
23655 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23656 application written to use message passing with special startup code to
23657 enable the application to run.  The system must have PE installed in the
23658 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23659 must be overridden with the @option{-specs=} option to specify the
23660 appropriate directory location.  The Parallel Environment does not
23661 support threads, so the @option{-mpe} option and the @option{-pthread}
23662 option are incompatible.
23664 @item -malign-natural
23665 @itemx -malign-power
23666 @opindex malign-natural
23667 @opindex malign-power
23668 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23669 @option{-malign-natural} overrides the ABI-defined alignment of larger
23670 types, such as floating-point doubles, on their natural size-based boundary.
23671 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23672 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23674 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23675 is not supported.
23677 @item -msoft-float
23678 @itemx -mhard-float
23679 @opindex msoft-float
23680 @opindex mhard-float
23681 Generate code that does not use (uses) the floating-point register set.
23682 Software floating-point emulation is provided if you use the
23683 @option{-msoft-float} option, and pass the option to GCC when linking.
23685 @item -msingle-float
23686 @itemx -mdouble-float
23687 @opindex msingle-float
23688 @opindex mdouble-float
23689 Generate code for single- or double-precision floating-point operations.
23690 @option{-mdouble-float} implies @option{-msingle-float}.
23692 @item -msimple-fpu
23693 @opindex msimple-fpu
23694 Do not generate @code{sqrt} and @code{div} instructions for hardware
23695 floating-point unit.
23697 @item -mfpu=@var{name}
23698 @opindex mfpu
23699 Specify type of floating-point unit.  Valid values for @var{name} are
23700 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
23701 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
23702 @samp{sp_full} (equivalent to @option{-msingle-float}),
23703 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
23705 @item -mxilinx-fpu
23706 @opindex mxilinx-fpu
23707 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
23709 @item -mmultiple
23710 @itemx -mno-multiple
23711 @opindex mmultiple
23712 @opindex mno-multiple
23713 Generate code that uses (does not use) the load multiple word
23714 instructions and the store multiple word instructions.  These
23715 instructions are generated by default on POWER systems, and not
23716 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23717 PowerPC systems, since those instructions do not work when the
23718 processor is in little-endian mode.  The exceptions are PPC740 and
23719 PPC750 which permit these instructions in little-endian mode.
23721 @item -mupdate
23722 @itemx -mno-update
23723 @opindex mupdate
23724 @opindex mno-update
23725 Generate code that uses (does not use) the load or store instructions
23726 that update the base register to the address of the calculated memory
23727 location.  These instructions are generated by default.  If you use
23728 @option{-mno-update}, there is a small window between the time that the
23729 stack pointer is updated and the address of the previous frame is
23730 stored, which means code that walks the stack frame across interrupts or
23731 signals may get corrupted data.
23733 @item -mavoid-indexed-addresses
23734 @itemx -mno-avoid-indexed-addresses
23735 @opindex mavoid-indexed-addresses
23736 @opindex mno-avoid-indexed-addresses
23737 Generate code that tries to avoid (not avoid) the use of indexed load
23738 or store instructions. These instructions can incur a performance
23739 penalty on Power6 processors in certain situations, such as when
23740 stepping through large arrays that cross a 16M boundary.  This option
23741 is enabled by default when targeting Power6 and disabled otherwise.
23743 @item -mfused-madd
23744 @itemx -mno-fused-madd
23745 @opindex mfused-madd
23746 @opindex mno-fused-madd
23747 Generate code that uses (does not use) the floating-point multiply and
23748 accumulate instructions.  These instructions are generated by default
23749 if hardware floating point is used.  The machine-dependent
23750 @option{-mfused-madd} option is now mapped to the machine-independent
23751 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23752 mapped to @option{-ffp-contract=off}.
23754 @item -mmulhw
23755 @itemx -mno-mulhw
23756 @opindex mmulhw
23757 @opindex mno-mulhw
23758 Generate code that uses (does not use) the half-word multiply and
23759 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23760 These instructions are generated by default when targeting those
23761 processors.
23763 @item -mdlmzb
23764 @itemx -mno-dlmzb
23765 @opindex mdlmzb
23766 @opindex mno-dlmzb
23767 Generate code that uses (does not use) the string-search @samp{dlmzb}
23768 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23769 generated by default when targeting those processors.
23771 @item -mno-bit-align
23772 @itemx -mbit-align
23773 @opindex mno-bit-align
23774 @opindex mbit-align
23775 On System V.4 and embedded PowerPC systems do not (do) force structures
23776 and unions that contain bit-fields to be aligned to the base type of the
23777 bit-field.
23779 For example, by default a structure containing nothing but 8
23780 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23781 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23782 the structure is aligned to a 1-byte boundary and is 1 byte in
23783 size.
23785 @item -mno-strict-align
23786 @itemx -mstrict-align
23787 @opindex mno-strict-align
23788 @opindex mstrict-align
23789 On System V.4 and embedded PowerPC systems do not (do) assume that
23790 unaligned memory references are handled by the system.
23792 @item -mrelocatable
23793 @itemx -mno-relocatable
23794 @opindex mrelocatable
23795 @opindex mno-relocatable
23796 Generate code that allows (does not allow) a static executable to be
23797 relocated to a different address at run time.  A simple embedded
23798 PowerPC system loader should relocate the entire contents of
23799 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23800 a table of 32-bit addresses generated by this option.  For this to
23801 work, all objects linked together must be compiled with
23802 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23803 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23805 @item -mrelocatable-lib
23806 @itemx -mno-relocatable-lib
23807 @opindex mrelocatable-lib
23808 @opindex mno-relocatable-lib
23809 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23810 @code{.fixup} section to allow static executables to be relocated at
23811 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23812 alignment of @option{-mrelocatable}.  Objects compiled with
23813 @option{-mrelocatable-lib} may be linked with objects compiled with
23814 any combination of the @option{-mrelocatable} options.
23816 @item -mno-toc
23817 @itemx -mtoc
23818 @opindex mno-toc
23819 @opindex mtoc
23820 On System V.4 and embedded PowerPC systems do not (do) assume that
23821 register 2 contains a pointer to a global area pointing to the addresses
23822 used in the program.
23824 @item -mlittle
23825 @itemx -mlittle-endian
23826 @opindex mlittle
23827 @opindex mlittle-endian
23828 On System V.4 and embedded PowerPC systems compile code for the
23829 processor in little-endian mode.  The @option{-mlittle-endian} option is
23830 the same as @option{-mlittle}.
23832 @item -mbig
23833 @itemx -mbig-endian
23834 @opindex mbig
23835 @opindex mbig-endian
23836 On System V.4 and embedded PowerPC systems compile code for the
23837 processor in big-endian mode.  The @option{-mbig-endian} option is
23838 the same as @option{-mbig}.
23840 @item -mdynamic-no-pic
23841 @opindex mdynamic-no-pic
23842 On Darwin and Mac OS X systems, compile code so that it is not
23843 relocatable, but that its external references are relocatable.  The
23844 resulting code is suitable for applications, but not shared
23845 libraries.
23847 @item -msingle-pic-base
23848 @opindex msingle-pic-base
23849 Treat the register used for PIC addressing as read-only, rather than
23850 loading it in the prologue for each function.  The runtime system is
23851 responsible for initializing this register with an appropriate value
23852 before execution begins.
23854 @item -mprioritize-restricted-insns=@var{priority}
23855 @opindex mprioritize-restricted-insns
23856 This option controls the priority that is assigned to
23857 dispatch-slot restricted instructions during the second scheduling
23858 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23859 or @samp{2} to assign no, highest, or second-highest (respectively) 
23860 priority to dispatch-slot restricted
23861 instructions.
23863 @item -msched-costly-dep=@var{dependence_type}
23864 @opindex msched-costly-dep
23865 This option controls which dependences are considered costly
23866 by the target during instruction scheduling.  The argument
23867 @var{dependence_type} takes one of the following values:
23869 @table @asis
23870 @item @samp{no}
23871 No dependence is costly.
23873 @item @samp{all}
23874 All dependences are costly.
23876 @item @samp{true_store_to_load}
23877 A true dependence from store to load is costly.
23879 @item @samp{store_to_load}
23880 Any dependence from store to load is costly.
23882 @item @var{number}
23883 Any dependence for which the latency is greater than or equal to 
23884 @var{number} is costly.
23885 @end table
23887 @item -minsert-sched-nops=@var{scheme}
23888 @opindex minsert-sched-nops
23889 This option controls which NOP insertion scheme is used during
23890 the second scheduling pass.  The argument @var{scheme} takes one of the
23891 following values:
23893 @table @asis
23894 @item @samp{no}
23895 Don't insert NOPs.
23897 @item @samp{pad}
23898 Pad with NOPs any dispatch group that has vacant issue slots,
23899 according to the scheduler's grouping.
23901 @item @samp{regroup_exact}
23902 Insert NOPs to force costly dependent insns into
23903 separate groups.  Insert exactly as many NOPs as needed to force an insn
23904 to a new group, according to the estimated processor grouping.
23906 @item @var{number}
23907 Insert NOPs to force costly dependent insns into
23908 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23909 @end table
23911 @item -mcall-sysv
23912 @opindex mcall-sysv
23913 On System V.4 and embedded PowerPC systems compile code using calling
23914 conventions that adhere to the March 1995 draft of the System V
23915 Application Binary Interface, PowerPC processor supplement.  This is the
23916 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23918 @item -mcall-sysv-eabi
23919 @itemx -mcall-eabi
23920 @opindex mcall-sysv-eabi
23921 @opindex mcall-eabi
23922 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23924 @item -mcall-sysv-noeabi
23925 @opindex mcall-sysv-noeabi
23926 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23928 @item -mcall-aixdesc
23929 @opindex m
23930 On System V.4 and embedded PowerPC systems compile code for the AIX
23931 operating system.
23933 @item -mcall-linux
23934 @opindex mcall-linux
23935 On System V.4 and embedded PowerPC systems compile code for the
23936 Linux-based GNU system.
23938 @item -mcall-freebsd
23939 @opindex mcall-freebsd
23940 On System V.4 and embedded PowerPC systems compile code for the
23941 FreeBSD operating system.
23943 @item -mcall-netbsd
23944 @opindex mcall-netbsd
23945 On System V.4 and embedded PowerPC systems compile code for the
23946 NetBSD operating system.
23948 @item -mcall-openbsd
23949 @opindex mcall-netbsd
23950 On System V.4 and embedded PowerPC systems compile code for the
23951 OpenBSD operating system.
23953 @item -mtraceback=@var{traceback_type}
23954 @opindex mtraceback
23955 Select the type of traceback table. Valid values for @var{traceback_type}
23956 are @samp{full}, @samp{part}, and @samp{no}.
23958 @item -maix-struct-return
23959 @opindex maix-struct-return
23960 Return all structures in memory (as specified by the AIX ABI)@.
23962 @item -msvr4-struct-return
23963 @opindex msvr4-struct-return
23964 Return structures smaller than 8 bytes in registers (as specified by the
23965 SVR4 ABI)@.
23967 @item -mabi=@var{abi-type}
23968 @opindex mabi
23969 Extend the current ABI with a particular extension, or remove such extension.
23970 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23971 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23972 @samp{elfv1}, @samp{elfv2}@.
23974 @item -mabi=ibmlongdouble
23975 @opindex mabi=ibmlongdouble
23976 Change the current ABI to use IBM extended-precision long double.
23977 This is not likely to work if your system defaults to using IEEE
23978 extended-precision long double.  If you change the long double type
23979 from IEEE extended-precision, the compiler will issue a warning unless
23980 you use the @option{-Wno-psabi} option.
23982 @item -mabi=ieeelongdouble
23983 @opindex mabi=ieeelongdouble
23984 Change the current ABI to use IEEE extended-precision long double.
23985 This is not likely to work if your system defaults to using IBM
23986 extended-precision long double.  If you change the long double type
23987 from IBM extended-precision, the compiler will issue a warning unless
23988 you use the @option{-Wno-psabi} option.
23990 @item -mabi=elfv1
23991 @opindex mabi=elfv1
23992 Change the current ABI to use the ELFv1 ABI.
23993 This is the default ABI for big-endian PowerPC 64-bit Linux.
23994 Overriding the default ABI requires special system support and is
23995 likely to fail in spectacular ways.
23997 @item -mabi=elfv2
23998 @opindex mabi=elfv2
23999 Change the current ABI to use the ELFv2 ABI.
24000 This is the default ABI for little-endian PowerPC 64-bit Linux.
24001 Overriding the default ABI requires special system support and is
24002 likely to fail in spectacular ways.
24004 @item -mgnu-attribute
24005 @itemx -mno-gnu-attribute
24006 @opindex mgnu-attribute
24007 @opindex mno-gnu-attribute
24008 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24009 .gnu.attributes section that specify ABI variations in function
24010 parameters or return values.
24012 @item -mprototype
24013 @itemx -mno-prototype
24014 @opindex mprototype
24015 @opindex mno-prototype
24016 On System V.4 and embedded PowerPC systems assume that all calls to
24017 variable argument functions are properly prototyped.  Otherwise, the
24018 compiler must insert an instruction before every non-prototyped call to
24019 set or clear bit 6 of the condition code register (@code{CR}) to
24020 indicate whether floating-point values are passed in the floating-point
24021 registers in case the function takes variable arguments.  With
24022 @option{-mprototype}, only calls to prototyped variable argument functions
24023 set or clear the bit.
24025 @item -msim
24026 @opindex msim
24027 On embedded PowerPC systems, assume that the startup module is called
24028 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24029 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24030 configurations.
24032 @item -mmvme
24033 @opindex mmvme
24034 On embedded PowerPC systems, assume that the startup module is called
24035 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24036 @file{libc.a}.
24038 @item -mads
24039 @opindex mads
24040 On embedded PowerPC systems, assume that the startup module is called
24041 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24042 @file{libc.a}.
24044 @item -myellowknife
24045 @opindex myellowknife
24046 On embedded PowerPC systems, assume that the startup module is called
24047 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24048 @file{libc.a}.
24050 @item -mvxworks
24051 @opindex mvxworks
24052 On System V.4 and embedded PowerPC systems, specify that you are
24053 compiling for a VxWorks system.
24055 @item -memb
24056 @opindex memb
24057 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24058 header to indicate that @samp{eabi} extended relocations are used.
24060 @item -meabi
24061 @itemx -mno-eabi
24062 @opindex meabi
24063 @opindex mno-eabi
24064 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24065 Embedded Applications Binary Interface (EABI), which is a set of
24066 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24067 means that the stack is aligned to an 8-byte boundary, a function
24068 @code{__eabi} is called from @code{main} to set up the EABI
24069 environment, and the @option{-msdata} option can use both @code{r2} and
24070 @code{r13} to point to two separate small data areas.  Selecting
24071 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24072 no EABI initialization function is called from @code{main}, and the
24073 @option{-msdata} option only uses @code{r13} to point to a single
24074 small data area.  The @option{-meabi} option is on by default if you
24075 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24077 @item -msdata=eabi
24078 @opindex msdata=eabi
24079 On System V.4 and embedded PowerPC systems, put small initialized
24080 @code{const} global and static data in the @code{.sdata2} section, which
24081 is pointed to by register @code{r2}.  Put small initialized
24082 non-@code{const} global and static data in the @code{.sdata} section,
24083 which is pointed to by register @code{r13}.  Put small uninitialized
24084 global and static data in the @code{.sbss} section, which is adjacent to
24085 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24086 incompatible with the @option{-mrelocatable} option.  The
24087 @option{-msdata=eabi} option also sets the @option{-memb} option.
24089 @item -msdata=sysv
24090 @opindex msdata=sysv
24091 On System V.4 and embedded PowerPC systems, put small global and static
24092 data in the @code{.sdata} section, which is pointed to by register
24093 @code{r13}.  Put small uninitialized global and static data in the
24094 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24095 The @option{-msdata=sysv} option is incompatible with the
24096 @option{-mrelocatable} option.
24098 @item -msdata=default
24099 @itemx -msdata
24100 @opindex msdata=default
24101 @opindex msdata
24102 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24103 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24104 same as @option{-msdata=sysv}.
24106 @item -msdata=data
24107 @opindex msdata=data
24108 On System V.4 and embedded PowerPC systems, put small global
24109 data in the @code{.sdata} section.  Put small uninitialized global
24110 data in the @code{.sbss} section.  Do not use register @code{r13}
24111 to address small data however.  This is the default behavior unless
24112 other @option{-msdata} options are used.
24114 @item -msdata=none
24115 @itemx -mno-sdata
24116 @opindex msdata=none
24117 @opindex mno-sdata
24118 On embedded PowerPC systems, put all initialized global and static data
24119 in the @code{.data} section, and all uninitialized data in the
24120 @code{.bss} section.
24122 @item -mreadonly-in-sdata
24123 @itemx -mreadonly-in-sdata
24124 @opindex mreadonly-in-sdata
24125 @opindex mno-readonly-in-sdata
24126 Put read-only objects in the @code{.sdata} section as well.  This is the
24127 default.
24129 @item -mblock-move-inline-limit=@var{num}
24130 @opindex mblock-move-inline-limit
24131 Inline all block moves (such as calls to @code{memcpy} or structure
24132 copies) less than or equal to @var{num} bytes.  The minimum value for
24133 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24134 targets.  The default value is target-specific.
24136 @item -mblock-compare-inline-limit=@var{num}
24137 @opindex mblock-compare-inline-limit
24138 Generate non-looping inline code for all block compares (such as calls
24139 to @code{memcmp} or structure compares) less than or equal to @var{num}
24140 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24141 block compare is disabled. The default value is target-specific.
24143 @item -mblock-compare-inline-loop-limit=@var{num}
24144 @opindex mblock-compare-inline-loop-limit
24145 Generate an inline expansion using loop code for all block compares that
24146 are less than or equal to @var{num} bytes, but greater than the limit
24147 for non-loop inline block compare expansion. If the block length is not
24148 constant, at most @var{num} bytes will be compared before @code{memcmp}
24149 is called to compare the remainder of the block. The default value is
24150 target-specific.
24152 @item -mstring-compare-inline-limit=@var{num}
24153 @opindex mstring-compare-inline-limit
24154 Generate at most @var{num} pairs of load instructions to compare the
24155 string inline. If the difference or end of string is not found at the
24156 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24157 take care of the rest of the comparison. The default is 8 pairs of
24158 loads, which will compare 64 bytes on a 64-bit target and 32 bytes on a
24159 32-bit target.
24161 @item -G @var{num}
24162 @opindex G
24163 @cindex smaller data references (PowerPC)
24164 @cindex .sdata/.sdata2 references (PowerPC)
24165 On embedded PowerPC systems, put global and static items less than or
24166 equal to @var{num} bytes into the small data or BSS sections instead of
24167 the normal data or BSS section.  By default, @var{num} is 8.  The
24168 @option{-G @var{num}} switch is also passed to the linker.
24169 All modules should be compiled with the same @option{-G @var{num}} value.
24171 @item -mregnames
24172 @itemx -mno-regnames
24173 @opindex mregnames
24174 @opindex mno-regnames
24175 On System V.4 and embedded PowerPC systems do (do not) emit register
24176 names in the assembly language output using symbolic forms.
24178 @item -mlongcall
24179 @itemx -mno-longcall
24180 @opindex mlongcall
24181 @opindex mno-longcall
24182 By default assume that all calls are far away so that a longer and more
24183 expensive calling sequence is required.  This is required for calls
24184 farther than 32 megabytes (33,554,432 bytes) from the current location.
24185 A short call is generated if the compiler knows
24186 the call cannot be that far away.  This setting can be overridden by
24187 the @code{shortcall} function attribute, or by @code{#pragma
24188 longcall(0)}.
24190 Some linkers are capable of detecting out-of-range calls and generating
24191 glue code on the fly.  On these systems, long calls are unnecessary and
24192 generate slower code.  As of this writing, the AIX linker can do this,
24193 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24194 to the GNU linker for 32-bit PowerPC systems as well.
24196 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24197 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24198 addresses represent the callee and the branch island.  The
24199 Darwin/PPC linker prefers the first address and generates a @code{bl
24200 callee} if the PPC @code{bl} instruction reaches the callee directly;
24201 otherwise, the linker generates @code{bl L42} to call the branch
24202 island.  The branch island is appended to the body of the
24203 calling function; it computes the full 32-bit address of the callee
24204 and jumps to it.
24206 On Mach-O (Darwin) systems, this option directs the compiler emit to
24207 the glue for every direct call, and the Darwin linker decides whether
24208 to use or discard it.
24210 In the future, GCC may ignore all longcall specifications
24211 when the linker is known to generate glue.
24213 @item -mtls-markers
24214 @itemx -mno-tls-markers
24215 @opindex mtls-markers
24216 @opindex mno-tls-markers
24217 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24218 specifying the function argument.  The relocation allows the linker to
24219 reliably associate function call with argument setup instructions for
24220 TLS optimization, which in turn allows GCC to better schedule the
24221 sequence.
24223 @item -mrecip
24224 @itemx -mno-recip
24225 @opindex mrecip
24226 This option enables use of the reciprocal estimate and
24227 reciprocal square root estimate instructions with additional
24228 Newton-Raphson steps to increase precision instead of doing a divide or
24229 square root and divide for floating-point arguments.  You should use
24230 the @option{-ffast-math} option when using @option{-mrecip} (or at
24231 least @option{-funsafe-math-optimizations},
24232 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24233 @option{-fno-trapping-math}).  Note that while the throughput of the
24234 sequence is generally higher than the throughput of the non-reciprocal
24235 instruction, the precision of the sequence can be decreased by up to 2
24236 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24237 roots.
24239 @item -mrecip=@var{opt}
24240 @opindex mrecip=opt
24241 This option controls which reciprocal estimate instructions
24242 may be used.  @var{opt} is a comma-separated list of options, which may
24243 be preceded by a @code{!} to invert the option:
24245 @table @samp
24247 @item all
24248 Enable all estimate instructions.
24250 @item default 
24251 Enable the default instructions, equivalent to @option{-mrecip}.
24253 @item none 
24254 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24256 @item div 
24257 Enable the reciprocal approximation instructions for both 
24258 single and double precision.
24260 @item divf 
24261 Enable the single-precision reciprocal approximation instructions.
24263 @item divd 
24264 Enable the double-precision reciprocal approximation instructions.
24266 @item rsqrt 
24267 Enable the reciprocal square root approximation instructions for both
24268 single and double precision.
24270 @item rsqrtf 
24271 Enable the single-precision reciprocal square root approximation instructions.
24273 @item rsqrtd 
24274 Enable the double-precision reciprocal square root approximation instructions.
24276 @end table
24278 So, for example, @option{-mrecip=all,!rsqrtd} enables
24279 all of the reciprocal estimate instructions, except for the
24280 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24281 which handle the double-precision reciprocal square root calculations.
24283 @item -mrecip-precision
24284 @itemx -mno-recip-precision
24285 @opindex mrecip-precision
24286 Assume (do not assume) that the reciprocal estimate instructions
24287 provide higher-precision estimates than is mandated by the PowerPC
24288 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24289 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24290 The double-precision square root estimate instructions are not generated by
24291 default on low-precision machines, since they do not provide an
24292 estimate that converges after three steps.
24294 @item -mveclibabi=@var{type}
24295 @opindex mveclibabi
24296 Specifies the ABI type to use for vectorizing intrinsics using an
24297 external library.  The only type supported at present is @samp{mass},
24298 which specifies to use IBM's Mathematical Acceleration Subsystem
24299 (MASS) libraries for vectorizing intrinsics using external libraries.
24300 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24301 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24302 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24303 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24304 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24305 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24306 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24307 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24308 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24309 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24310 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24311 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24312 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24313 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24314 for power7.  Both @option{-ftree-vectorize} and
24315 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24316 libraries must be specified at link time.
24318 @item -mfriz
24319 @itemx -mno-friz
24320 @opindex mfriz
24321 Generate (do not generate) the @code{friz} instruction when the
24322 @option{-funsafe-math-optimizations} option is used to optimize
24323 rounding of floating-point values to 64-bit integer and back to floating
24324 point.  The @code{friz} instruction does not return the same value if
24325 the floating-point number is too large to fit in an integer.
24327 @item -mpointers-to-nested-functions
24328 @itemx -mno-pointers-to-nested-functions
24329 @opindex mpointers-to-nested-functions
24330 Generate (do not generate) code to load up the static chain register
24331 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24332 systems where a function pointer points to a 3-word descriptor giving
24333 the function address, TOC value to be loaded in register @code{r2}, and
24334 static chain value to be loaded in register @code{r11}.  The
24335 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24336 call through pointers to nested functions or pointers
24337 to functions compiled in other languages that use the static chain if
24338 you use @option{-mno-pointers-to-nested-functions}.
24340 @item -msave-toc-indirect
24341 @itemx -mno-save-toc-indirect
24342 @opindex msave-toc-indirect
24343 Generate (do not generate) code to save the TOC value in the reserved
24344 stack location in the function prologue if the function calls through
24345 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24346 saved in the prologue, it is saved just before the call through the
24347 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24349 @item -mcompat-align-parm
24350 @itemx -mno-compat-align-parm
24351 @opindex mcompat-align-parm
24352 Generate (do not generate) code to pass structure parameters with a
24353 maximum alignment of 64 bits, for compatibility with older versions
24354 of GCC.
24356 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24357 structure parameter on a 128-bit boundary when that structure contained
24358 a member requiring 128-bit alignment.  This is corrected in more
24359 recent versions of GCC.  This option may be used to generate code
24360 that is compatible with functions compiled with older versions of
24361 GCC.
24363 The @option{-mno-compat-align-parm} option is the default.
24365 @item -mstack-protector-guard=@var{guard}
24366 @itemx -mstack-protector-guard-reg=@var{reg}
24367 @itemx -mstack-protector-guard-offset=@var{offset}
24368 @itemx -mstack-protector-guard-symbol=@var{symbol}
24369 @opindex mstack-protector-guard
24370 @opindex mstack-protector-guard-reg
24371 @opindex mstack-protector-guard-offset
24372 @opindex mstack-protector-guard-symbol
24373 Generate stack protection code using canary at @var{guard}.  Supported
24374 locations are @samp{global} for global canary or @samp{tls} for per-thread
24375 canary in the TLS block (the default with GNU libc version 2.4 or later).
24377 With the latter choice the options
24378 @option{-mstack-protector-guard-reg=@var{reg}} and
24379 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24380 which register to use as base register for reading the canary, and from what
24381 offset from that base register. The default for those is as specified in the
24382 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24383 the offset with a symbol reference to a canary in the TLS block.
24384 @end table
24386 @node RX Options
24387 @subsection RX Options
24388 @cindex RX Options
24390 These command-line options are defined for RX targets:
24392 @table @gcctabopt
24393 @item -m64bit-doubles
24394 @itemx -m32bit-doubles
24395 @opindex m64bit-doubles
24396 @opindex m32bit-doubles
24397 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24398 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24399 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24400 works on 32-bit values, which is why the default is
24401 @option{-m32bit-doubles}.
24403 @item -fpu
24404 @itemx -nofpu
24405 @opindex fpu
24406 @opindex nofpu
24407 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24408 floating-point hardware.  The default is enabled for the RX600
24409 series and disabled for the RX200 series.
24411 Floating-point instructions are only generated for 32-bit floating-point 
24412 values, however, so the FPU hardware is not used for doubles if the
24413 @option{-m64bit-doubles} option is used.
24415 @emph{Note} If the @option{-fpu} option is enabled then
24416 @option{-funsafe-math-optimizations} is also enabled automatically.
24417 This is because the RX FPU instructions are themselves unsafe.
24419 @item -mcpu=@var{name}
24420 @opindex mcpu
24421 Selects the type of RX CPU to be targeted.  Currently three types are
24422 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24423 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24425 The only difference between @samp{RX600} and @samp{RX610} is that the
24426 @samp{RX610} does not support the @code{MVTIPL} instruction.
24428 The @samp{RX200} series does not have a hardware floating-point unit
24429 and so @option{-nofpu} is enabled by default when this type is
24430 selected.
24432 @item -mbig-endian-data
24433 @itemx -mlittle-endian-data
24434 @opindex mbig-endian-data
24435 @opindex mlittle-endian-data
24436 Store data (but not code) in the big-endian format.  The default is
24437 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24438 format.
24440 @item -msmall-data-limit=@var{N}
24441 @opindex msmall-data-limit
24442 Specifies the maximum size in bytes of global and static variables
24443 which can be placed into the small data area.  Using the small data
24444 area can lead to smaller and faster code, but the size of area is
24445 limited and it is up to the programmer to ensure that the area does
24446 not overflow.  Also when the small data area is used one of the RX's
24447 registers (usually @code{r13}) is reserved for use pointing to this
24448 area, so it is no longer available for use by the compiler.  This
24449 could result in slower and/or larger code if variables are pushed onto
24450 the stack instead of being held in this register.
24452 Note, common variables (variables that have not been initialized) and
24453 constants are not placed into the small data area as they are assigned
24454 to other sections in the output executable.
24456 The default value is zero, which disables this feature.  Note, this
24457 feature is not enabled by default with higher optimization levels
24458 (@option{-O2} etc) because of the potentially detrimental effects of
24459 reserving a register.  It is up to the programmer to experiment and
24460 discover whether this feature is of benefit to their program.  See the
24461 description of the @option{-mpid} option for a description of how the
24462 actual register to hold the small data area pointer is chosen.
24464 @item -msim
24465 @itemx -mno-sim
24466 @opindex msim
24467 @opindex mno-sim
24468 Use the simulator runtime.  The default is to use the libgloss
24469 board-specific runtime.
24471 @item -mas100-syntax
24472 @itemx -mno-as100-syntax
24473 @opindex mas100-syntax
24474 @opindex mno-as100-syntax
24475 When generating assembler output use a syntax that is compatible with
24476 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24477 assembler, but it has some restrictions so it is not generated by default.
24479 @item -mmax-constant-size=@var{N}
24480 @opindex mmax-constant-size
24481 Specifies the maximum size, in bytes, of a constant that can be used as
24482 an operand in a RX instruction.  Although the RX instruction set does
24483 allow constants of up to 4 bytes in length to be used in instructions,
24484 a longer value equates to a longer instruction.  Thus in some
24485 circumstances it can be beneficial to restrict the size of constants
24486 that are used in instructions.  Constants that are too big are instead
24487 placed into a constant pool and referenced via register indirection.
24489 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24490 or 4 means that constants of any size are allowed.
24492 @item -mrelax
24493 @opindex mrelax
24494 Enable linker relaxation.  Linker relaxation is a process whereby the
24495 linker attempts to reduce the size of a program by finding shorter
24496 versions of various instructions.  Disabled by default.
24498 @item -mint-register=@var{N}
24499 @opindex mint-register
24500 Specify the number of registers to reserve for fast interrupt handler
24501 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24502 means that register @code{r13} is reserved for the exclusive use
24503 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24504 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24505 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24506 A value of 0, the default, does not reserve any registers.
24508 @item -msave-acc-in-interrupts
24509 @opindex msave-acc-in-interrupts
24510 Specifies that interrupt handler functions should preserve the
24511 accumulator register.  This is only necessary if normal code might use
24512 the accumulator register, for example because it performs 64-bit
24513 multiplications.  The default is to ignore the accumulator as this
24514 makes the interrupt handlers faster.
24516 @item -mpid
24517 @itemx -mno-pid
24518 @opindex mpid
24519 @opindex mno-pid
24520 Enables the generation of position independent data.  When enabled any
24521 access to constant data is done via an offset from a base address
24522 held in a register.  This allows the location of constant data to be
24523 determined at run time without requiring the executable to be
24524 relocated, which is a benefit to embedded applications with tight
24525 memory constraints.  Data that can be modified is not affected by this
24526 option.
24528 Note, using this feature reserves a register, usually @code{r13}, for
24529 the constant data base address.  This can result in slower and/or
24530 larger code, especially in complicated functions.
24532 The actual register chosen to hold the constant data base address
24533 depends upon whether the @option{-msmall-data-limit} and/or the
24534 @option{-mint-register} command-line options are enabled.  Starting
24535 with register @code{r13} and proceeding downwards, registers are
24536 allocated first to satisfy the requirements of @option{-mint-register},
24537 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24538 is possible for the small data area register to be @code{r8} if both
24539 @option{-mint-register=4} and @option{-mpid} are specified on the
24540 command line.
24542 By default this feature is not enabled.  The default can be restored
24543 via the @option{-mno-pid} command-line option.
24545 @item -mno-warn-multiple-fast-interrupts
24546 @itemx -mwarn-multiple-fast-interrupts
24547 @opindex mno-warn-multiple-fast-interrupts
24548 @opindex mwarn-multiple-fast-interrupts
24549 Prevents GCC from issuing a warning message if it finds more than one
24550 fast interrupt handler when it is compiling a file.  The default is to
24551 issue a warning for each extra fast interrupt handler found, as the RX
24552 only supports one such interrupt.
24554 @item -mallow-string-insns
24555 @itemx -mno-allow-string-insns
24556 @opindex mallow-string-insns
24557 @opindex mno-allow-string-insns
24558 Enables or disables the use of the string manipulation instructions
24559 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24560 @code{SWHILE} and also the @code{RMPA} instruction.  These
24561 instructions may prefetch data, which is not safe to do if accessing
24562 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24563 for more information).
24565 The default is to allow these instructions, but it is not possible for
24566 GCC to reliably detect all circumstances where a string instruction
24567 might be used to access an I/O register, so their use cannot be
24568 disabled automatically.  Instead it is reliant upon the programmer to
24569 use the @option{-mno-allow-string-insns} option if their program
24570 accesses I/O space.
24572 When the instructions are enabled GCC defines the C preprocessor
24573 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24574 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24576 @item -mjsr
24577 @itemx -mno-jsr
24578 @opindex mjsr
24579 @opindex mno-jsr
24580 Use only (or not only) @code{JSR} instructions to access functions.
24581 This option can be used when code size exceeds the range of @code{BSR}
24582 instructions.  Note that @option{-mno-jsr} does not mean to not use
24583 @code{JSR} but instead means that any type of branch may be used.
24584 @end table
24586 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24587 has special significance to the RX port when used with the
24588 @code{interrupt} function attribute.  This attribute indicates a
24589 function intended to process fast interrupts.  GCC ensures
24590 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24591 and/or @code{r13} and only provided that the normal use of the
24592 corresponding registers have been restricted via the
24593 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24594 options.
24596 @node S/390 and zSeries Options
24597 @subsection S/390 and zSeries Options
24598 @cindex S/390 and zSeries Options
24600 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24602 @table @gcctabopt
24603 @item -mhard-float
24604 @itemx -msoft-float
24605 @opindex mhard-float
24606 @opindex msoft-float
24607 Use (do not use) the hardware floating-point instructions and registers
24608 for floating-point operations.  When @option{-msoft-float} is specified,
24609 functions in @file{libgcc.a} are used to perform floating-point
24610 operations.  When @option{-mhard-float} is specified, the compiler
24611 generates IEEE floating-point instructions.  This is the default.
24613 @item -mhard-dfp
24614 @itemx -mno-hard-dfp
24615 @opindex mhard-dfp
24616 @opindex mno-hard-dfp
24617 Use (do not use) the hardware decimal-floating-point instructions for
24618 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24619 specified, functions in @file{libgcc.a} are used to perform
24620 decimal-floating-point operations.  When @option{-mhard-dfp} is
24621 specified, the compiler generates decimal-floating-point hardware
24622 instructions.  This is the default for @option{-march=z9-ec} or higher.
24624 @item -mlong-double-64
24625 @itemx -mlong-double-128
24626 @opindex mlong-double-64
24627 @opindex mlong-double-128
24628 These switches control the size of @code{long double} type. A size
24629 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24630 type. This is the default.
24632 @item -mbackchain
24633 @itemx -mno-backchain
24634 @opindex mbackchain
24635 @opindex mno-backchain
24636 Store (do not store) the address of the caller's frame as backchain pointer
24637 into the callee's stack frame.
24638 A backchain may be needed to allow debugging using tools that do not understand
24639 DWARF call frame information.
24640 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24641 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24642 the backchain is placed into the topmost word of the 96/160 byte register
24643 save area.
24645 In general, code compiled with @option{-mbackchain} is call-compatible with
24646 code compiled with @option{-mmo-backchain}; however, use of the backchain
24647 for debugging purposes usually requires that the whole binary is built with
24648 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24649 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24650 to build a linux kernel use @option{-msoft-float}.
24652 The default is to not maintain the backchain.
24654 @item -mpacked-stack
24655 @itemx -mno-packed-stack
24656 @opindex mpacked-stack
24657 @opindex mno-packed-stack
24658 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24659 specified, the compiler uses the all fields of the 96/160 byte register save
24660 area only for their default purpose; unused fields still take up stack space.
24661 When @option{-mpacked-stack} is specified, register save slots are densely
24662 packed at the top of the register save area; unused space is reused for other
24663 purposes, allowing for more efficient use of the available stack space.
24664 However, when @option{-mbackchain} is also in effect, the topmost word of
24665 the save area is always used to store the backchain, and the return address
24666 register is always saved two words below the backchain.
24668 As long as the stack frame backchain is not used, code generated with
24669 @option{-mpacked-stack} is call-compatible with code generated with
24670 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24671 S/390 or zSeries generated code that uses the stack frame backchain at run
24672 time, not just for debugging purposes.  Such code is not call-compatible
24673 with code compiled with @option{-mpacked-stack}.  Also, note that the
24674 combination of @option{-mbackchain},
24675 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24676 to build a linux kernel use @option{-msoft-float}.
24678 The default is to not use the packed stack layout.
24680 @item -msmall-exec
24681 @itemx -mno-small-exec
24682 @opindex msmall-exec
24683 @opindex mno-small-exec
24684 Generate (or do not generate) code using the @code{bras} instruction
24685 to do subroutine calls.
24686 This only works reliably if the total executable size does not
24687 exceed 64k.  The default is to use the @code{basr} instruction instead,
24688 which does not have this limitation.
24690 @item -m64
24691 @itemx -m31
24692 @opindex m64
24693 @opindex m31
24694 When @option{-m31} is specified, generate code compliant to the
24695 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24696 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24697 particular to generate 64-bit instructions.  For the @samp{s390}
24698 targets, the default is @option{-m31}, while the @samp{s390x}
24699 targets default to @option{-m64}.
24701 @item -mzarch
24702 @itemx -mesa
24703 @opindex mzarch
24704 @opindex mesa
24705 When @option{-mzarch} is specified, generate code using the
24706 instructions available on z/Architecture.
24707 When @option{-mesa} is specified, generate code using the
24708 instructions available on ESA/390.  Note that @option{-mesa} is
24709 not possible with @option{-m64}.
24710 When generating code compliant to the GNU/Linux for S/390 ABI,
24711 the default is @option{-mesa}.  When generating code compliant
24712 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24714 @item -mhtm
24715 @itemx -mno-htm
24716 @opindex mhtm
24717 @opindex mno-htm
24718 The @option{-mhtm} option enables a set of builtins making use of
24719 instructions available with the transactional execution facility
24720 introduced with the IBM zEnterprise EC12 machine generation
24721 @ref{S/390 System z Built-in Functions}.
24722 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24724 @item -mvx
24725 @itemx -mno-vx
24726 @opindex mvx
24727 @opindex mno-vx
24728 When @option{-mvx} is specified, generate code using the instructions
24729 available with the vector extension facility introduced with the IBM
24730 z13 machine generation.
24731 This option changes the ABI for some vector type values with regard to
24732 alignment and calling conventions.  In case vector type values are
24733 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24734 command will be added to mark the resulting binary with the ABI used.
24735 @option{-mvx} is enabled by default when using @option{-march=z13}.
24737 @item -mzvector
24738 @itemx -mno-zvector
24739 @opindex mzvector
24740 @opindex mno-zvector
24741 The @option{-mzvector} option enables vector language extensions and
24742 builtins using instructions available with the vector extension
24743 facility introduced with the IBM z13 machine generation.
24744 This option adds support for @samp{vector} to be used as a keyword to
24745 define vector type variables and arguments.  @samp{vector} is only
24746 available when GNU extensions are enabled.  It will not be expanded
24747 when requesting strict standard compliance e.g. with @option{-std=c99}.
24748 In addition to the GCC low-level builtins @option{-mzvector} enables
24749 a set of builtins added for compatibility with AltiVec-style
24750 implementations like Power and Cell.  In order to make use of these
24751 builtins the header file @file{vecintrin.h} needs to be included.
24752 @option{-mzvector} is disabled by default.
24754 @item -mmvcle
24755 @itemx -mno-mvcle
24756 @opindex mmvcle
24757 @opindex mno-mvcle
24758 Generate (or do not generate) code using the @code{mvcle} instruction
24759 to perform block moves.  When @option{-mno-mvcle} is specified,
24760 use a @code{mvc} loop instead.  This is the default unless optimizing for
24761 size.
24763 @item -mdebug
24764 @itemx -mno-debug
24765 @opindex mdebug
24766 @opindex mno-debug
24767 Print (or do not print) additional debug information when compiling.
24768 The default is to not print debug information.
24770 @item -march=@var{cpu-type}
24771 @opindex march
24772 Generate code that runs on @var{cpu-type}, which is the name of a
24773 system representing a certain processor type.  Possible values for
24774 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24775 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24776 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24777 @samp{native}.
24779 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24780 @samp{g6} are deprecated and will be removed with future releases.
24782 Specifying @samp{native} as cpu type can be used to select the best
24783 architecture option for the host processor.
24784 @option{-march=native} has no effect if GCC does not recognize the
24785 processor.
24787 @item -mtune=@var{cpu-type}
24788 @opindex mtune
24789 Tune to @var{cpu-type} everything applicable about the generated code,
24790 except for the ABI and the set of available instructions.
24791 The list of @var{cpu-type} values is the same as for @option{-march}.
24792 The default is the value used for @option{-march}.
24794 @item -mtpf-trace
24795 @itemx -mno-tpf-trace
24796 @opindex mtpf-trace
24797 @opindex mno-tpf-trace
24798 Generate code that adds (does not add) in TPF OS specific branches to trace
24799 routines in the operating system.  This option is off by default, even
24800 when compiling for the TPF OS@.
24802 @item -mfused-madd
24803 @itemx -mno-fused-madd
24804 @opindex mfused-madd
24805 @opindex mno-fused-madd
24806 Generate code that uses (does not use) the floating-point multiply and
24807 accumulate instructions.  These instructions are generated by default if
24808 hardware floating point is used.
24810 @item -mwarn-framesize=@var{framesize}
24811 @opindex mwarn-framesize
24812 Emit a warning if the current function exceeds the given frame size.  Because
24813 this is a compile-time check it doesn't need to be a real problem when the program
24814 runs.  It is intended to identify functions that most probably cause
24815 a stack overflow.  It is useful to be used in an environment with limited stack
24816 size e.g.@: the linux kernel.
24818 @item -mwarn-dynamicstack
24819 @opindex mwarn-dynamicstack
24820 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24821 arrays.  This is generally a bad idea with a limited stack size.
24823 @item -mstack-guard=@var{stack-guard}
24824 @itemx -mstack-size=@var{stack-size}
24825 @opindex mstack-guard
24826 @opindex mstack-size
24827 If these options are provided the S/390 back end emits additional instructions in
24828 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24829 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24830 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24831 the frame size of the compiled function is chosen.
24832 These options are intended to be used to help debugging stack overflow problems.
24833 The additionally emitted code causes only little overhead and hence can also be
24834 used in production-like systems without greater performance degradation.  The given
24835 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24836 @var{stack-guard} without exceeding 64k.
24837 In order to be efficient the extra code makes the assumption that the stack starts
24838 at an address aligned to the value given by @var{stack-size}.
24839 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24841 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24842 @opindex mhotpatch
24843 If the hotpatch option is enabled, a ``hot-patching'' function
24844 prologue is generated for all functions in the compilation unit.
24845 The funtion label is prepended with the given number of two-byte
24846 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24847 the label, 2 * @var{post-halfwords} bytes are appended, using the
24848 largest NOP like instructions the architecture allows (maximum
24849 1000000).
24851 If both arguments are zero, hotpatching is disabled.
24853 This option can be overridden for individual functions with the
24854 @code{hotpatch} attribute.
24855 @end table
24857 @node Score Options
24858 @subsection Score Options
24859 @cindex Score Options
24861 These options are defined for Score implementations:
24863 @table @gcctabopt
24864 @item -meb
24865 @opindex meb
24866 Compile code for big-endian mode.  This is the default.
24868 @item -mel
24869 @opindex mel
24870 Compile code for little-endian mode.
24872 @item -mnhwloop
24873 @opindex mnhwloop
24874 Disable generation of @code{bcnz} instructions.
24876 @item -muls
24877 @opindex muls
24878 Enable generation of unaligned load and store instructions.
24880 @item -mmac
24881 @opindex mmac
24882 Enable the use of multiply-accumulate instructions. Disabled by default.
24884 @item -mscore5
24885 @opindex mscore5
24886 Specify the SCORE5 as the target architecture.
24888 @item -mscore5u
24889 @opindex mscore5u
24890 Specify the SCORE5U of the target architecture.
24892 @item -mscore7
24893 @opindex mscore7
24894 Specify the SCORE7 as the target architecture. This is the default.
24896 @item -mscore7d
24897 @opindex mscore7d
24898 Specify the SCORE7D as the target architecture.
24899 @end table
24901 @node SH Options
24902 @subsection SH Options
24904 These @samp{-m} options are defined for the SH implementations:
24906 @table @gcctabopt
24907 @item -m1
24908 @opindex m1
24909 Generate code for the SH1.
24911 @item -m2
24912 @opindex m2
24913 Generate code for the SH2.
24915 @item -m2e
24916 Generate code for the SH2e.
24918 @item -m2a-nofpu
24919 @opindex m2a-nofpu
24920 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24921 that the floating-point unit is not used.
24923 @item -m2a-single-only
24924 @opindex m2a-single-only
24925 Generate code for the SH2a-FPU, in such a way that no double-precision
24926 floating-point operations are used.
24928 @item -m2a-single
24929 @opindex m2a-single
24930 Generate code for the SH2a-FPU assuming the floating-point unit is in
24931 single-precision mode by default.
24933 @item -m2a
24934 @opindex m2a
24935 Generate code for the SH2a-FPU assuming the floating-point unit is in
24936 double-precision mode by default.
24938 @item -m3
24939 @opindex m3
24940 Generate code for the SH3.
24942 @item -m3e
24943 @opindex m3e
24944 Generate code for the SH3e.
24946 @item -m4-nofpu
24947 @opindex m4-nofpu
24948 Generate code for the SH4 without a floating-point unit.
24950 @item -m4-single-only
24951 @opindex m4-single-only
24952 Generate code for the SH4 with a floating-point unit that only
24953 supports single-precision arithmetic.
24955 @item -m4-single
24956 @opindex m4-single
24957 Generate code for the SH4 assuming the floating-point unit is in
24958 single-precision mode by default.
24960 @item -m4
24961 @opindex m4
24962 Generate code for the SH4.
24964 @item -m4-100
24965 @opindex m4-100
24966 Generate code for SH4-100.
24968 @item -m4-100-nofpu
24969 @opindex m4-100-nofpu
24970 Generate code for SH4-100 in such a way that the
24971 floating-point unit is not used.
24973 @item -m4-100-single
24974 @opindex m4-100-single
24975 Generate code for SH4-100 assuming the floating-point unit is in
24976 single-precision mode by default.
24978 @item -m4-100-single-only
24979 @opindex m4-100-single-only
24980 Generate code for SH4-100 in such a way that no double-precision
24981 floating-point operations are used.
24983 @item -m4-200
24984 @opindex m4-200
24985 Generate code for SH4-200.
24987 @item -m4-200-nofpu
24988 @opindex m4-200-nofpu
24989 Generate code for SH4-200 without in such a way that the
24990 floating-point unit is not used.
24992 @item -m4-200-single
24993 @opindex m4-200-single
24994 Generate code for SH4-200 assuming the floating-point unit is in
24995 single-precision mode by default.
24997 @item -m4-200-single-only
24998 @opindex m4-200-single-only
24999 Generate code for SH4-200 in such a way that no double-precision
25000 floating-point operations are used.
25002 @item -m4-300
25003 @opindex m4-300
25004 Generate code for SH4-300.
25006 @item -m4-300-nofpu
25007 @opindex m4-300-nofpu
25008 Generate code for SH4-300 without in such a way that the
25009 floating-point unit is not used.
25011 @item -m4-300-single
25012 @opindex m4-300-single
25013 Generate code for SH4-300 in such a way that no double-precision
25014 floating-point operations are used.
25016 @item -m4-300-single-only
25017 @opindex m4-300-single-only
25018 Generate code for SH4-300 in such a way that no double-precision
25019 floating-point operations are used.
25021 @item -m4-340
25022 @opindex m4-340
25023 Generate code for SH4-340 (no MMU, no FPU).
25025 @item -m4-500
25026 @opindex m4-500
25027 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
25028 assembler.
25030 @item -m4a-nofpu
25031 @opindex m4a-nofpu
25032 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25033 floating-point unit is not used.
25035 @item -m4a-single-only
25036 @opindex m4a-single-only
25037 Generate code for the SH4a, in such a way that no double-precision
25038 floating-point operations are used.
25040 @item -m4a-single
25041 @opindex m4a-single
25042 Generate code for the SH4a assuming the floating-point unit is in
25043 single-precision mode by default.
25045 @item -m4a
25046 @opindex m4a
25047 Generate code for the SH4a.
25049 @item -m4al
25050 @opindex m4al
25051 Same as @option{-m4a-nofpu}, except that it implicitly passes
25052 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25053 instructions at the moment.
25055 @item -mb
25056 @opindex mb
25057 Compile code for the processor in big-endian mode.
25059 @item -ml
25060 @opindex ml
25061 Compile code for the processor in little-endian mode.
25063 @item -mdalign
25064 @opindex mdalign
25065 Align doubles at 64-bit boundaries.  Note that this changes the calling
25066 conventions, and thus some functions from the standard C library do
25067 not work unless you recompile it first with @option{-mdalign}.
25069 @item -mrelax
25070 @opindex mrelax
25071 Shorten some address references at link time, when possible; uses the
25072 linker option @option{-relax}.
25074 @item -mbigtable
25075 @opindex mbigtable
25076 Use 32-bit offsets in @code{switch} tables.  The default is to use
25077 16-bit offsets.
25079 @item -mbitops
25080 @opindex mbitops
25081 Enable the use of bit manipulation instructions on SH2A.
25083 @item -mfmovd
25084 @opindex mfmovd
25085 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25086 alignment constraints.
25088 @item -mrenesas
25089 @opindex mrenesas
25090 Comply with the calling conventions defined by Renesas.
25092 @item -mno-renesas
25093 @opindex mno-renesas
25094 Comply with the calling conventions defined for GCC before the Renesas
25095 conventions were available.  This option is the default for all
25096 targets of the SH toolchain.
25098 @item -mnomacsave
25099 @opindex mnomacsave
25100 Mark the @code{MAC} register as call-clobbered, even if
25101 @option{-mrenesas} is given.
25103 @item -mieee
25104 @itemx -mno-ieee
25105 @opindex mieee
25106 @opindex mno-ieee
25107 Control the IEEE compliance of floating-point comparisons, which affects the
25108 handling of cases where the result of a comparison is unordered.  By default
25109 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25110 enabled @option{-mno-ieee} is implicitly set, which results in faster
25111 floating-point greater-equal and less-equal comparisons.  The implicit settings
25112 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25114 @item -minline-ic_invalidate
25115 @opindex minline-ic_invalidate
25116 Inline code to invalidate instruction cache entries after setting up
25117 nested function trampolines.
25118 This option has no effect if @option{-musermode} is in effect and the selected
25119 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25120 instruction.
25121 If the selected code generation option does not allow the use of the @code{icbi}
25122 instruction, and @option{-musermode} is not in effect, the inlined code
25123 manipulates the instruction cache address array directly with an associative
25124 write.  This not only requires privileged mode at run time, but it also
25125 fails if the cache line had been mapped via the TLB and has become unmapped.
25127 @item -misize
25128 @opindex misize
25129 Dump instruction size and location in the assembly code.
25131 @item -mpadstruct
25132 @opindex mpadstruct
25133 This option is deprecated.  It pads structures to multiple of 4 bytes,
25134 which is incompatible with the SH ABI@.
25136 @item -matomic-model=@var{model}
25137 @opindex matomic-model=@var{model}
25138 Sets the model of atomic operations and additional parameters as a comma
25139 separated list.  For details on the atomic built-in functions see
25140 @ref{__atomic Builtins}.  The following models and parameters are supported:
25142 @table @samp
25144 @item none
25145 Disable compiler generated atomic sequences and emit library calls for atomic
25146 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25148 @item soft-gusa
25149 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25150 built-in functions.  The generated atomic sequences require additional support
25151 from the interrupt/exception handling code of the system and are only suitable
25152 for SH3* and SH4* single-core systems.  This option is enabled by default when
25153 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25154 this option also partially utilizes the hardware atomic instructions
25155 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25156 @samp{strict} is specified.  
25158 @item soft-tcb
25159 Generate software atomic sequences that use a variable in the thread control
25160 block.  This is a variation of the gUSA sequences which can also be used on
25161 SH1* and SH2* targets.  The generated atomic sequences require additional
25162 support from the interrupt/exception handling code of the system and are only
25163 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25164 parameter has to be specified as well.
25166 @item soft-imask
25167 Generate software atomic sequences that temporarily disable interrupts by
25168 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25169 in privileged mode and is only suitable for single-core systems.  Additional
25170 support from the interrupt/exception handling code of the system is not
25171 required.  This model is enabled by default when the target is
25172 @code{sh*-*-linux*} and SH1* or SH2*.
25174 @item hard-llcs
25175 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25176 instructions only.  This is only available on SH4A and is suitable for
25177 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25178 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25179 Code compiled with this option is also compatible with other software
25180 atomic model interrupt/exception handling systems if executed on an SH4A
25181 system.  Additional support from the interrupt/exception handling code of the
25182 system is not required for this model.
25184 @item gbr-offset=
25185 This parameter specifies the offset in bytes of the variable in the thread
25186 control block structure that should be used by the generated atomic sequences
25187 when the @samp{soft-tcb} model has been selected.  For other models this
25188 parameter is ignored.  The specified value must be an integer multiple of four
25189 and in the range 0-1020.
25191 @item strict
25192 This parameter prevents mixed usage of multiple atomic models, even if they
25193 are compatible, and makes the compiler generate atomic sequences of the
25194 specified model only.
25196 @end table
25198 @item -mtas
25199 @opindex mtas
25200 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25201 Notice that depending on the particular hardware and software configuration
25202 this can degrade overall performance due to the operand cache line flushes
25203 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25204 processors the @code{tas.b} instruction must be used with caution since it
25205 can result in data corruption for certain cache configurations.
25207 @item -mprefergot
25208 @opindex mprefergot
25209 When generating position-independent code, emit function calls using
25210 the Global Offset Table instead of the Procedure Linkage Table.
25212 @item -musermode
25213 @itemx -mno-usermode
25214 @opindex musermode
25215 @opindex mno-usermode
25216 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25217 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25218 inlined code would not work in user mode.  @option{-musermode} is the default
25219 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25220 @option{-musermode} has no effect, since there is no user mode.
25222 @item -multcost=@var{number}
25223 @opindex multcost=@var{number}
25224 Set the cost to assume for a multiply insn.
25226 @item -mdiv=@var{strategy}
25227 @opindex mdiv=@var{strategy}
25228 Set the division strategy to be used for integer division operations.
25229 @var{strategy} can be one of: 
25231 @table @samp
25233 @item call-div1
25234 Calls a library function that uses the single-step division instruction
25235 @code{div1} to perform the operation.  Division by zero calculates an
25236 unspecified result and does not trap.  This is the default except for SH4,
25237 SH2A and SHcompact.
25239 @item call-fp
25240 Calls a library function that performs the operation in double precision
25241 floating point.  Division by zero causes a floating-point exception.  This is
25242 the default for SHcompact with FPU.  Specifying this for targets that do not
25243 have a double precision FPU defaults to @code{call-div1}.
25245 @item call-table
25246 Calls a library function that uses a lookup table for small divisors and
25247 the @code{div1} instruction with case distinction for larger divisors.  Division
25248 by zero calculates an unspecified result and does not trap.  This is the default
25249 for SH4.  Specifying this for targets that do not have dynamic shift
25250 instructions defaults to @code{call-div1}.
25252 @end table
25254 When a division strategy has not been specified the default strategy is
25255 selected based on the current target.  For SH2A the default strategy is to
25256 use the @code{divs} and @code{divu} instructions instead of library function
25257 calls.
25259 @item -maccumulate-outgoing-args
25260 @opindex maccumulate-outgoing-args
25261 Reserve space once for outgoing arguments in the function prologue rather
25262 than around each call.  Generally beneficial for performance and size.  Also
25263 needed for unwinding to avoid changing the stack frame around conditional code.
25265 @item -mdivsi3_libfunc=@var{name}
25266 @opindex mdivsi3_libfunc=@var{name}
25267 Set the name of the library function used for 32-bit signed division to
25268 @var{name}.
25269 This only affects the name used in the @samp{call} division strategies, and
25270 the compiler still expects the same sets of input/output/clobbered registers as
25271 if this option were not present.
25273 @item -mfixed-range=@var{register-range}
25274 @opindex mfixed-range
25275 Generate code treating the given register range as fixed registers.
25276 A fixed register is one that the register allocator can not use.  This is
25277 useful when compiling kernel code.  A register range is specified as
25278 two registers separated by a dash.  Multiple register ranges can be
25279 specified separated by a comma.
25281 @item -mbranch-cost=@var{num}
25282 @opindex mbranch-cost=@var{num}
25283 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25284 make the compiler try to generate more branch-free code if possible.  
25285 If not specified the value is selected depending on the processor type that
25286 is being compiled for.
25288 @item -mzdcbranch
25289 @itemx -mno-zdcbranch
25290 @opindex mzdcbranch
25291 @opindex mno-zdcbranch
25292 Assume (do not assume) that zero displacement conditional branch instructions
25293 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25294 compiler prefers zero displacement branch code sequences.  This is
25295 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25296 disabled by specifying @option{-mno-zdcbranch}.
25298 @item -mcbranch-force-delay-slot
25299 @opindex mcbranch-force-delay-slot
25300 Force the usage of delay slots for conditional branches, which stuffs the delay
25301 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25302 this option is disabled.  It can be enabled to work around hardware bugs as
25303 found in the original SH7055.
25305 @item -mfused-madd
25306 @itemx -mno-fused-madd
25307 @opindex mfused-madd
25308 @opindex mno-fused-madd
25309 Generate code that uses (does not use) the floating-point multiply and
25310 accumulate instructions.  These instructions are generated by default
25311 if hardware floating point is used.  The machine-dependent
25312 @option{-mfused-madd} option is now mapped to the machine-independent
25313 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25314 mapped to @option{-ffp-contract=off}.
25316 @item -mfsca
25317 @itemx -mno-fsca
25318 @opindex mfsca
25319 @opindex mno-fsca
25320 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25321 and cosine approximations.  The option @option{-mfsca} must be used in
25322 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25323 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25324 approximations even if @option{-funsafe-math-optimizations} is in effect.
25326 @item -mfsrra
25327 @itemx -mno-fsrra
25328 @opindex mfsrra
25329 @opindex mno-fsrra
25330 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25331 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25332 in combination with @option{-funsafe-math-optimizations} and
25333 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25334 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25335 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25336 in effect.
25338 @item -mpretend-cmove
25339 @opindex mpretend-cmove
25340 Prefer zero-displacement conditional branches for conditional move instruction
25341 patterns.  This can result in faster code on the SH4 processor.
25343 @item -mfdpic
25344 @opindex fdpic
25345 Generate code using the FDPIC ABI.
25347 @end table
25349 @node Solaris 2 Options
25350 @subsection Solaris 2 Options
25351 @cindex Solaris 2 options
25353 These @samp{-m} options are supported on Solaris 2:
25355 @table @gcctabopt
25356 @item -mclear-hwcap
25357 @opindex mclear-hwcap
25358 @option{-mclear-hwcap} tells the compiler to remove the hardware
25359 capabilities generated by the Solaris assembler.  This is only necessary
25360 when object files use ISA extensions not supported by the current
25361 machine, but check at runtime whether or not to use them.
25363 @item -mimpure-text
25364 @opindex mimpure-text
25365 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25366 the compiler to not pass @option{-z text} to the linker when linking a
25367 shared object.  Using this option, you can link position-dependent
25368 code into a shared object.
25370 @option{-mimpure-text} suppresses the ``relocations remain against
25371 allocatable but non-writable sections'' linker error message.
25372 However, the necessary relocations trigger copy-on-write, and the
25373 shared object is not actually shared across processes.  Instead of
25374 using @option{-mimpure-text}, you should compile all source code with
25375 @option{-fpic} or @option{-fPIC}.
25377 @end table
25379 These switches are supported in addition to the above on Solaris 2:
25381 @table @gcctabopt
25382 @item -pthreads
25383 @opindex pthreads
25384 This is a synonym for @option{-pthread}.
25385 @end table
25387 @node SPARC Options
25388 @subsection SPARC Options
25389 @cindex SPARC options
25391 These @samp{-m} options are supported on the SPARC:
25393 @table @gcctabopt
25394 @item -mno-app-regs
25395 @itemx -mapp-regs
25396 @opindex mno-app-regs
25397 @opindex mapp-regs
25398 Specify @option{-mapp-regs} to generate output using the global registers
25399 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25400 global register 1, each global register 2 through 4 is then treated as an
25401 allocable register that is clobbered by function calls.  This is the default.
25403 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25404 specify @option{-mno-app-regs}.  You should compile libraries and system
25405 software with this option.
25407 @item -mflat
25408 @itemx -mno-flat
25409 @opindex mflat
25410 @opindex mno-flat
25411 With @option{-mflat}, the compiler does not generate save/restore instructions
25412 and uses a ``flat'' or single register window model.  This model is compatible
25413 with the regular register window model.  The local registers and the input
25414 registers (0--5) are still treated as ``call-saved'' registers and are
25415 saved on the stack as needed.
25417 With @option{-mno-flat} (the default), the compiler generates save/restore
25418 instructions (except for leaf functions).  This is the normal operating mode.
25420 @item -mfpu
25421 @itemx -mhard-float
25422 @opindex mfpu
25423 @opindex mhard-float
25424 Generate output containing floating-point instructions.  This is the
25425 default.
25427 @item -mno-fpu
25428 @itemx -msoft-float
25429 @opindex mno-fpu
25430 @opindex msoft-float
25431 Generate output containing library calls for floating point.
25432 @strong{Warning:} the requisite libraries are not available for all SPARC
25433 targets.  Normally the facilities of the machine's usual C compiler are
25434 used, but this cannot be done directly in cross-compilation.  You must make
25435 your own arrangements to provide suitable library functions for
25436 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25437 @samp{sparclite-*-*} do provide software floating-point support.
25439 @option{-msoft-float} changes the calling convention in the output file;
25440 therefore, it is only useful if you compile @emph{all} of a program with
25441 this option.  In particular, you need to compile @file{libgcc.a}, the
25442 library that comes with GCC, with @option{-msoft-float} in order for
25443 this to work.
25445 @item -mhard-quad-float
25446 @opindex mhard-quad-float
25447 Generate output containing quad-word (long double) floating-point
25448 instructions.
25450 @item -msoft-quad-float
25451 @opindex msoft-quad-float
25452 Generate output containing library calls for quad-word (long double)
25453 floating-point instructions.  The functions called are those specified
25454 in the SPARC ABI@.  This is the default.
25456 As of this writing, there are no SPARC implementations that have hardware
25457 support for the quad-word floating-point instructions.  They all invoke
25458 a trap handler for one of these instructions, and then the trap handler
25459 emulates the effect of the instruction.  Because of the trap handler overhead,
25460 this is much slower than calling the ABI library routines.  Thus the
25461 @option{-msoft-quad-float} option is the default.
25463 @item -mno-unaligned-doubles
25464 @itemx -munaligned-doubles
25465 @opindex mno-unaligned-doubles
25466 @opindex munaligned-doubles
25467 Assume that doubles have 8-byte alignment.  This is the default.
25469 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25470 alignment only if they are contained in another type, or if they have an
25471 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25472 Specifying this option avoids some rare compatibility problems with code
25473 generated by other compilers.  It is not the default because it results
25474 in a performance loss, especially for floating-point code.
25476 @item -muser-mode
25477 @itemx -mno-user-mode
25478 @opindex muser-mode
25479 @opindex mno-user-mode
25480 Do not generate code that can only run in supervisor mode.  This is relevant
25481 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25482 is the default.
25484 @item -mfaster-structs
25485 @itemx -mno-faster-structs
25486 @opindex mfaster-structs
25487 @opindex mno-faster-structs
25488 With @option{-mfaster-structs}, the compiler assumes that structures
25489 should have 8-byte alignment.  This enables the use of pairs of
25490 @code{ldd} and @code{std} instructions for copies in structure
25491 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25492 However, the use of this changed alignment directly violates the SPARC
25493 ABI@.  Thus, it's intended only for use on targets where the developer
25494 acknowledges that their resulting code is not directly in line with
25495 the rules of the ABI@.
25497 @item -mstd-struct-return
25498 @itemx -mno-std-struct-return
25499 @opindex mstd-struct-return
25500 @opindex mno-std-struct-return
25501 With @option{-mstd-struct-return}, the compiler generates checking code
25502 in functions returning structures or unions to detect size mismatches
25503 between the two sides of function calls, as per the 32-bit ABI@.
25505 The default is @option{-mno-std-struct-return}.  This option has no effect
25506 in 64-bit mode.
25508 @item -mlra
25509 @itemx -mno-lra
25510 @opindex mlra
25511 @opindex mno-lra
25512 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25513 so @option{-mno-lra} needs to be passed to get old Reload.
25515 @item -mcpu=@var{cpu_type}
25516 @opindex mcpu
25517 Set the instruction set, register set, and instruction scheduling parameters
25518 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25519 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25520 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25521 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25522 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25523 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25525 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25526 which selects the best architecture option for the host processor.
25527 @option{-mcpu=native} has no effect if GCC does not recognize
25528 the processor.
25530 Default instruction scheduling parameters are used for values that select
25531 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25532 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25534 Here is a list of each supported architecture and their supported
25535 implementations.
25537 @table @asis
25538 @item v7
25539 cypress, leon3v7
25541 @item v8
25542 supersparc, hypersparc, leon, leon3
25544 @item sparclite
25545 f930, f934, sparclite86x
25547 @item sparclet
25548 tsc701
25550 @item v9
25551 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25552 niagara7, m8
25553 @end table
25555 By default (unless configured otherwise), GCC generates code for the V7
25556 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25557 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25558 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25559 SPARCStation 1, 2, IPX etc.
25561 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25562 architecture.  The only difference from V7 code is that the compiler emits
25563 the integer multiply and integer divide instructions which exist in SPARC-V8
25564 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25565 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25566 2000 series.
25568 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25569 the SPARC architecture.  This adds the integer multiply, integer divide step
25570 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25571 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25572 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25573 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25574 MB86934 chip, which is the more recent SPARClite with FPU@.
25576 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25577 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25578 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25579 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25580 optimizes it for the TEMIC SPARClet chip.
25582 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25583 architecture.  This adds 64-bit integer and floating-point move instructions,
25584 3 additional floating-point condition code registers and conditional move
25585 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25586 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25587 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25588 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25589 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25590 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25591 additionally optimizes it for Sun UltraSPARC T2 chips. With
25592 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25593 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25594 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25595 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25596 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25597 additionally optimizes it for Oracle M8 chips.
25599 @item -mtune=@var{cpu_type}
25600 @opindex mtune
25601 Set the instruction scheduling parameters for machine type
25602 @var{cpu_type}, but do not set the instruction set or register set that the
25603 option @option{-mcpu=@var{cpu_type}} does.
25605 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25606 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25607 that select a particular CPU implementation.  Those are
25608 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25609 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25610 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25611 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25612 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25613 and GNU/Linux toolchains, @samp{native} can also be used.
25615 @item -mv8plus
25616 @itemx -mno-v8plus
25617 @opindex mv8plus
25618 @opindex mno-v8plus
25619 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25620 difference from the V8 ABI is that the global and out registers are
25621 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25622 mode for all SPARC-V9 processors.
25624 @item -mvis
25625 @itemx -mno-vis
25626 @opindex mvis
25627 @opindex mno-vis
25628 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25629 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25631 @item -mvis2
25632 @itemx -mno-vis2
25633 @opindex mvis2
25634 @opindex mno-vis2
25635 With @option{-mvis2}, GCC generates code that takes advantage of
25636 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25637 default is @option{-mvis2} when targeting a cpu that supports such
25638 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25639 also sets @option{-mvis}.
25641 @item -mvis3
25642 @itemx -mno-vis3
25643 @opindex mvis3
25644 @opindex mno-vis3
25645 With @option{-mvis3}, GCC generates code that takes advantage of
25646 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25647 default is @option{-mvis3} when targeting a cpu that supports such
25648 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25649 also sets @option{-mvis2} and @option{-mvis}.
25651 @item -mvis4
25652 @itemx -mno-vis4
25653 @opindex mvis4
25654 @opindex mno-vis4
25655 With @option{-mvis4}, GCC generates code that takes advantage of
25656 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25657 default is @option{-mvis4} when targeting a cpu that supports such
25658 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25659 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25661 @item -mvis4b
25662 @itemx -mno-vis4b
25663 @opindex mvis4b
25664 @opindex mno-vis4b
25665 With @option{-mvis4b}, GCC generates code that takes advantage of
25666 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25667 the additional VIS instructions introduced in the Oracle SPARC
25668 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25669 cpu that supports such instructions, such as m8 and later.  Setting
25670 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25671 @option{-mvis2} and @option{-mvis}.
25673 @item -mcbcond
25674 @itemx -mno-cbcond
25675 @opindex mcbcond
25676 @opindex mno-cbcond
25677 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25678 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25679 when targeting a CPU that supports such instructions, such as Niagara-4 and
25680 later.
25682 @item -mfmaf
25683 @itemx -mno-fmaf
25684 @opindex mfmaf
25685 @opindex mno-fmaf
25686 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25687 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25688 when targeting a CPU that supports such instructions, such as Niagara-3 and
25689 later.
25691 @item -mfsmuld
25692 @itemx -mno-fsmuld
25693 @opindex mfsmuld
25694 @opindex mno-fsmuld
25695 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25696 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25697 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25698 or V9 with FPU except @option{-mcpu=leon}.
25700 @item -mpopc
25701 @itemx -mno-popc
25702 @opindex mpopc
25703 @opindex mno-popc
25704 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25705 Population Count instruction.  The default is @option{-mpopc}
25706 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25707 later.
25709 @item -msubxc
25710 @itemx -mno-subxc
25711 @opindex msubxc
25712 @opindex mno-subxc
25713 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25714 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25715 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25716 later.
25718 @item -mfix-at697f
25719 @opindex mfix-at697f
25720 Enable the documented workaround for the single erratum of the Atmel AT697F
25721 processor (which corresponds to erratum #13 of the AT697E processor).
25723 @item -mfix-ut699
25724 @opindex mfix-ut699
25725 Enable the documented workarounds for the floating-point errata and the data
25726 cache nullify errata of the UT699 processor.
25728 @item -mfix-ut700
25729 @opindex mfix-ut700
25730 Enable the documented workaround for the back-to-back store errata of
25731 the UT699E/UT700 processor.
25733 @item -mfix-gr712rc
25734 @opindex mfix-gr712rc
25735 Enable the documented workaround for the back-to-back store errata of
25736 the GR712RC processor.
25737 @end table
25739 These @samp{-m} options are supported in addition to the above
25740 on SPARC-V9 processors in 64-bit environments:
25742 @table @gcctabopt
25743 @item -m32
25744 @itemx -m64
25745 @opindex m32
25746 @opindex m64
25747 Generate code for a 32-bit or 64-bit environment.
25748 The 32-bit environment sets int, long and pointer to 32 bits.
25749 The 64-bit environment sets int to 32 bits and long and pointer
25750 to 64 bits.
25752 @item -mcmodel=@var{which}
25753 @opindex mcmodel
25754 Set the code model to one of
25756 @table @samp
25757 @item medlow
25758 The Medium/Low code model: 64-bit addresses, programs
25759 must be linked in the low 32 bits of memory.  Programs can be statically
25760 or dynamically linked.
25762 @item medmid
25763 The Medium/Middle code model: 64-bit addresses, programs
25764 must be linked in the low 44 bits of memory, the text and data segments must
25765 be less than 2GB in size and the data segment must be located within 2GB of
25766 the text segment.
25768 @item medany
25769 The Medium/Anywhere code model: 64-bit addresses, programs
25770 may be linked anywhere in memory, the text and data segments must be less
25771 than 2GB in size and the data segment must be located within 2GB of the
25772 text segment.
25774 @item embmedany
25775 The Medium/Anywhere code model for embedded systems:
25776 64-bit addresses, the text and data segments must be less than 2GB in
25777 size, both starting anywhere in memory (determined at link time).  The
25778 global register %g4 points to the base of the data segment.  Programs
25779 are statically linked and PIC is not supported.
25780 @end table
25782 @item -mmemory-model=@var{mem-model}
25783 @opindex mmemory-model
25784 Set the memory model in force on the processor to one of
25786 @table @samp
25787 @item default
25788 The default memory model for the processor and operating system.
25790 @item rmo
25791 Relaxed Memory Order
25793 @item pso
25794 Partial Store Order
25796 @item tso
25797 Total Store Order
25799 @item sc
25800 Sequential Consistency
25801 @end table
25803 These memory models are formally defined in Appendix D of the SPARC-V9
25804 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25806 @item -mstack-bias
25807 @itemx -mno-stack-bias
25808 @opindex mstack-bias
25809 @opindex mno-stack-bias
25810 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25811 frame pointer if present, are offset by @minus{}2047 which must be added back
25812 when making stack frame references.  This is the default in 64-bit mode.
25813 Otherwise, assume no such offset is present.
25814 @end table
25816 @node SPU Options
25817 @subsection SPU Options
25818 @cindex SPU options
25820 These @samp{-m} options are supported on the SPU:
25822 @table @gcctabopt
25823 @item -mwarn-reloc
25824 @itemx -merror-reloc
25825 @opindex mwarn-reloc
25826 @opindex merror-reloc
25828 The loader for SPU does not handle dynamic relocations.  By default, GCC
25829 gives an error when it generates code that requires a dynamic
25830 relocation.  @option{-mno-error-reloc} disables the error,
25831 @option{-mwarn-reloc} generates a warning instead.
25833 @item -msafe-dma
25834 @itemx -munsafe-dma
25835 @opindex msafe-dma
25836 @opindex munsafe-dma
25838 Instructions that initiate or test completion of DMA must not be
25839 reordered with respect to loads and stores of the memory that is being
25840 accessed.
25841 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25842 memory accesses, but that can lead to inefficient code in places where the
25843 memory is known to not change.  Rather than mark the memory as volatile,
25844 you can use @option{-msafe-dma} to tell the compiler to treat
25845 the DMA instructions as potentially affecting all memory.  
25847 @item -mbranch-hints
25848 @opindex mbranch-hints
25850 By default, GCC generates a branch hint instruction to avoid
25851 pipeline stalls for always-taken or probably-taken branches.  A hint
25852 is not generated closer than 8 instructions away from its branch.
25853 There is little reason to disable them, except for debugging purposes,
25854 or to make an object a little bit smaller.
25856 @item -msmall-mem
25857 @itemx -mlarge-mem
25858 @opindex msmall-mem
25859 @opindex mlarge-mem
25861 By default, GCC generates code assuming that addresses are never larger
25862 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25863 a full 32-bit address.
25865 @item -mstdmain
25866 @opindex mstdmain
25868 By default, GCC links against startup code that assumes the SPU-style
25869 main function interface (which has an unconventional parameter list).
25870 With @option{-mstdmain}, GCC links your program against startup
25871 code that assumes a C99-style interface to @code{main}, including a
25872 local copy of @code{argv} strings.
25874 @item -mfixed-range=@var{register-range}
25875 @opindex mfixed-range
25876 Generate code treating the given register range as fixed registers.
25877 A fixed register is one that the register allocator cannot use.  This is
25878 useful when compiling kernel code.  A register range is specified as
25879 two registers separated by a dash.  Multiple register ranges can be
25880 specified separated by a comma.
25882 @item -mea32
25883 @itemx -mea64
25884 @opindex mea32
25885 @opindex mea64
25886 Compile code assuming that pointers to the PPU address space accessed
25887 via the @code{__ea} named address space qualifier are either 32 or 64
25888 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25889 all object code in an executable must be compiled with the same setting.
25891 @item -maddress-space-conversion
25892 @itemx -mno-address-space-conversion
25893 @opindex maddress-space-conversion
25894 @opindex mno-address-space-conversion
25895 Allow/disallow treating the @code{__ea} address space as superset
25896 of the generic address space.  This enables explicit type casts
25897 between @code{__ea} and generic pointer as well as implicit
25898 conversions of generic pointers to @code{__ea} pointers.  The
25899 default is to allow address space pointer conversions.
25901 @item -mcache-size=@var{cache-size}
25902 @opindex mcache-size
25903 This option controls the version of libgcc that the compiler links to an
25904 executable and selects a software-managed cache for accessing variables
25905 in the @code{__ea} address space with a particular cache size.  Possible
25906 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25907 and @samp{128}.  The default cache size is 64KB.
25909 @item -matomic-updates
25910 @itemx -mno-atomic-updates
25911 @opindex matomic-updates
25912 @opindex mno-atomic-updates
25913 This option controls the version of libgcc that the compiler links to an
25914 executable and selects whether atomic updates to the software-managed
25915 cache of PPU-side variables are used.  If you use atomic updates, changes
25916 to a PPU variable from SPU code using the @code{__ea} named address space
25917 qualifier do not interfere with changes to other PPU variables residing
25918 in the same cache line from PPU code.  If you do not use atomic updates,
25919 such interference may occur; however, writing back cache lines is
25920 more efficient.  The default behavior is to use atomic updates.
25922 @item -mdual-nops
25923 @itemx -mdual-nops=@var{n}
25924 @opindex mdual-nops
25925 By default, GCC inserts NOPs to increase dual issue when it expects
25926 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25927 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25928 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25930 @item -mhint-max-nops=@var{n}
25931 @opindex mhint-max-nops
25932 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25933 be at least 8 instructions away from the branch it is affecting.  GCC
25934 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25935 generate the branch hint.
25937 @item -mhint-max-distance=@var{n}
25938 @opindex mhint-max-distance
25939 The encoding of the branch hint instruction limits the hint to be within
25940 256 instructions of the branch it is affecting.  By default, GCC makes
25941 sure it is within 125.
25943 @item -msafe-hints
25944 @opindex msafe-hints
25945 Work around a hardware bug that causes the SPU to stall indefinitely.
25946 By default, GCC inserts the @code{hbrp} instruction to make sure
25947 this stall won't happen.
25949 @end table
25951 @node System V Options
25952 @subsection Options for System V
25954 These additional options are available on System V Release 4 for
25955 compatibility with other compilers on those systems:
25957 @table @gcctabopt
25958 @item -G
25959 @opindex G
25960 Create a shared object.
25961 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25963 @item -Qy
25964 @opindex Qy
25965 Identify the versions of each tool used by the compiler, in a
25966 @code{.ident} assembler directive in the output.
25968 @item -Qn
25969 @opindex Qn
25970 Refrain from adding @code{.ident} directives to the output file (this is
25971 the default).
25973 @item -YP,@var{dirs}
25974 @opindex YP
25975 Search the directories @var{dirs}, and no others, for libraries
25976 specified with @option{-l}.
25978 @item -Ym,@var{dir}
25979 @opindex Ym
25980 Look in the directory @var{dir} to find the M4 preprocessor.
25981 The assembler uses this option.
25982 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25983 @c the generic assembler that comes with Solaris takes just -Ym.
25984 @end table
25986 @node TILE-Gx Options
25987 @subsection TILE-Gx Options
25988 @cindex TILE-Gx options
25990 These @samp{-m} options are supported on the TILE-Gx:
25992 @table @gcctabopt
25993 @item -mcmodel=small
25994 @opindex mcmodel=small
25995 Generate code for the small model.  The distance for direct calls is
25996 limited to 500M in either direction.  PC-relative addresses are 32
25997 bits.  Absolute addresses support the full address range.
25999 @item -mcmodel=large
26000 @opindex mcmodel=large
26001 Generate code for the large model.  There is no limitation on call
26002 distance, pc-relative addresses, or absolute addresses.
26004 @item -mcpu=@var{name}
26005 @opindex mcpu
26006 Selects the type of CPU to be targeted.  Currently the only supported
26007 type is @samp{tilegx}.
26009 @item -m32
26010 @itemx -m64
26011 @opindex m32
26012 @opindex m64
26013 Generate code for a 32-bit or 64-bit environment.  The 32-bit
26014 environment sets int, long, and pointer to 32 bits.  The 64-bit
26015 environment sets int to 32 bits and long and pointer to 64 bits.
26017 @item -mbig-endian
26018 @itemx -mlittle-endian
26019 @opindex mbig-endian
26020 @opindex mlittle-endian
26021 Generate code in big/little endian mode, respectively.
26022 @end table
26024 @node TILEPro Options
26025 @subsection TILEPro Options
26026 @cindex TILEPro options
26028 These @samp{-m} options are supported on the TILEPro:
26030 @table @gcctabopt
26031 @item -mcpu=@var{name}
26032 @opindex mcpu
26033 Selects the type of CPU to be targeted.  Currently the only supported
26034 type is @samp{tilepro}.
26036 @item -m32
26037 @opindex m32
26038 Generate code for a 32-bit environment, which sets int, long, and
26039 pointer to 32 bits.  This is the only supported behavior so the flag
26040 is essentially ignored.
26041 @end table
26043 @node V850 Options
26044 @subsection V850 Options
26045 @cindex V850 Options
26047 These @samp{-m} options are defined for V850 implementations:
26049 @table @gcctabopt
26050 @item -mlong-calls
26051 @itemx -mno-long-calls
26052 @opindex mlong-calls
26053 @opindex mno-long-calls
26054 Treat all calls as being far away (near).  If calls are assumed to be
26055 far away, the compiler always loads the function's address into a
26056 register, and calls indirect through the pointer.
26058 @item -mno-ep
26059 @itemx -mep
26060 @opindex mno-ep
26061 @opindex mep
26062 Do not optimize (do optimize) basic blocks that use the same index
26063 pointer 4 or more times to copy pointer into the @code{ep} register, and
26064 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26065 option is on by default if you optimize.
26067 @item -mno-prolog-function
26068 @itemx -mprolog-function
26069 @opindex mno-prolog-function
26070 @opindex mprolog-function
26071 Do not use (do use) external functions to save and restore registers
26072 at the prologue and epilogue of a function.  The external functions
26073 are slower, but use less code space if more than one function saves
26074 the same number of registers.  The @option{-mprolog-function} option
26075 is on by default if you optimize.
26077 @item -mspace
26078 @opindex mspace
26079 Try to make the code as small as possible.  At present, this just turns
26080 on the @option{-mep} and @option{-mprolog-function} options.
26082 @item -mtda=@var{n}
26083 @opindex mtda
26084 Put static or global variables whose size is @var{n} bytes or less into
26085 the tiny data area that register @code{ep} points to.  The tiny data
26086 area can hold up to 256 bytes in total (128 bytes for byte references).
26088 @item -msda=@var{n}
26089 @opindex msda
26090 Put static or global variables whose size is @var{n} bytes or less into
26091 the small data area that register @code{gp} points to.  The small data
26092 area can hold up to 64 kilobytes.
26094 @item -mzda=@var{n}
26095 @opindex mzda
26096 Put static or global variables whose size is @var{n} bytes or less into
26097 the first 32 kilobytes of memory.
26099 @item -mv850
26100 @opindex mv850
26101 Specify that the target processor is the V850.
26103 @item -mv850e3v5
26104 @opindex mv850e3v5
26105 Specify that the target processor is the V850E3V5.  The preprocessor
26106 constant @code{__v850e3v5__} is defined if this option is used.
26108 @item -mv850e2v4
26109 @opindex mv850e2v4
26110 Specify that the target processor is the V850E3V5.  This is an alias for
26111 the @option{-mv850e3v5} option.
26113 @item -mv850e2v3
26114 @opindex mv850e2v3
26115 Specify that the target processor is the V850E2V3.  The preprocessor
26116 constant @code{__v850e2v3__} is defined if this option is used.
26118 @item -mv850e2
26119 @opindex mv850e2
26120 Specify that the target processor is the V850E2.  The preprocessor
26121 constant @code{__v850e2__} is defined if this option is used.
26123 @item -mv850e1
26124 @opindex mv850e1
26125 Specify that the target processor is the V850E1.  The preprocessor
26126 constants @code{__v850e1__} and @code{__v850e__} are defined if
26127 this option is used.
26129 @item -mv850es
26130 @opindex mv850es
26131 Specify that the target processor is the V850ES.  This is an alias for
26132 the @option{-mv850e1} option.
26134 @item -mv850e
26135 @opindex mv850e
26136 Specify that the target processor is the V850E@.  The preprocessor
26137 constant @code{__v850e__} is defined if this option is used.
26139 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26140 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26141 are defined then a default target processor is chosen and the
26142 relevant @samp{__v850*__} preprocessor constant is defined.
26144 The preprocessor constants @code{__v850} and @code{__v851__} are always
26145 defined, regardless of which processor variant is the target.
26147 @item -mdisable-callt
26148 @itemx -mno-disable-callt
26149 @opindex mdisable-callt
26150 @opindex mno-disable-callt
26151 This option suppresses generation of the @code{CALLT} instruction for the
26152 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26153 architecture.
26155 This option is enabled by default when the RH850 ABI is
26156 in use (see @option{-mrh850-abi}), and disabled by default when the
26157 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26158 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26160 @item -mrelax
26161 @itemx -mno-relax
26162 @opindex mrelax
26163 @opindex mno-relax
26164 Pass on (or do not pass on) the @option{-mrelax} command-line option
26165 to the assembler.
26167 @item -mlong-jumps
26168 @itemx -mno-long-jumps
26169 @opindex mlong-jumps
26170 @opindex mno-long-jumps
26171 Disable (or re-enable) the generation of PC-relative jump instructions.
26173 @item -msoft-float
26174 @itemx -mhard-float
26175 @opindex msoft-float
26176 @opindex mhard-float
26177 Disable (or re-enable) the generation of hardware floating point
26178 instructions.  This option is only significant when the target
26179 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26180 instructions are being generated then the C preprocessor symbol
26181 @code{__FPU_OK__} is defined, otherwise the symbol
26182 @code{__NO_FPU__} is defined.
26184 @item -mloop
26185 @opindex mloop
26186 Enables the use of the e3v5 LOOP instruction.  The use of this
26187 instruction is not enabled by default when the e3v5 architecture is
26188 selected because its use is still experimental.
26190 @item -mrh850-abi
26191 @itemx -mghs
26192 @opindex mrh850-abi
26193 @opindex mghs
26194 Enables support for the RH850 version of the V850 ABI.  This is the
26195 default.  With this version of the ABI the following rules apply:
26197 @itemize
26198 @item
26199 Integer sized structures and unions are returned via a memory pointer
26200 rather than a register.
26202 @item
26203 Large structures and unions (more than 8 bytes in size) are passed by
26204 value.
26206 @item
26207 Functions are aligned to 16-bit boundaries.
26209 @item
26210 The @option{-m8byte-align} command-line option is supported.
26212 @item
26213 The @option{-mdisable-callt} command-line option is enabled by
26214 default.  The @option{-mno-disable-callt} command-line option is not
26215 supported.
26216 @end itemize
26218 When this version of the ABI is enabled the C preprocessor symbol
26219 @code{__V850_RH850_ABI__} is defined.
26221 @item -mgcc-abi
26222 @opindex mgcc-abi
26223 Enables support for the old GCC version of the V850 ABI.  With this
26224 version of the ABI the following rules apply:
26226 @itemize
26227 @item
26228 Integer sized structures and unions are returned in register @code{r10}.
26230 @item
26231 Large structures and unions (more than 8 bytes in size) are passed by
26232 reference.
26234 @item
26235 Functions are aligned to 32-bit boundaries, unless optimizing for
26236 size.
26238 @item
26239 The @option{-m8byte-align} command-line option is not supported.
26241 @item
26242 The @option{-mdisable-callt} command-line option is supported but not
26243 enabled by default.
26244 @end itemize
26246 When this version of the ABI is enabled the C preprocessor symbol
26247 @code{__V850_GCC_ABI__} is defined.
26249 @item -m8byte-align
26250 @itemx -mno-8byte-align
26251 @opindex m8byte-align
26252 @opindex mno-8byte-align
26253 Enables support for @code{double} and @code{long long} types to be
26254 aligned on 8-byte boundaries.  The default is to restrict the
26255 alignment of all objects to at most 4-bytes.  When
26256 @option{-m8byte-align} is in effect the C preprocessor symbol
26257 @code{__V850_8BYTE_ALIGN__} is defined.
26259 @item -mbig-switch
26260 @opindex mbig-switch
26261 Generate code suitable for big switch tables.  Use this option only if
26262 the assembler/linker complain about out of range branches within a switch
26263 table.
26265 @item -mapp-regs
26266 @opindex mapp-regs
26267 This option causes r2 and r5 to be used in the code generated by
26268 the compiler.  This setting is the default.
26270 @item -mno-app-regs
26271 @opindex mno-app-regs
26272 This option causes r2 and r5 to be treated as fixed registers.
26274 @end table
26276 @node VAX Options
26277 @subsection VAX Options
26278 @cindex VAX options
26280 These @samp{-m} options are defined for the VAX:
26282 @table @gcctabopt
26283 @item -munix
26284 @opindex munix
26285 Do not output certain jump instructions (@code{aobleq} and so on)
26286 that the Unix assembler for the VAX cannot handle across long
26287 ranges.
26289 @item -mgnu
26290 @opindex mgnu
26291 Do output those jump instructions, on the assumption that the
26292 GNU assembler is being used.
26294 @item -mg
26295 @opindex mg
26296 Output code for G-format floating-point numbers instead of D-format.
26297 @end table
26299 @node Visium Options
26300 @subsection Visium Options
26301 @cindex Visium options
26303 @table @gcctabopt
26305 @item -mdebug
26306 @opindex mdebug
26307 A program which performs file I/O and is destined to run on an MCM target
26308 should be linked with this option.  It causes the libraries libc.a and
26309 libdebug.a to be linked.  The program should be run on the target under
26310 the control of the GDB remote debugging stub.
26312 @item -msim
26313 @opindex msim
26314 A program which performs file I/O and is destined to run on the simulator
26315 should be linked with option.  This causes libraries libc.a and libsim.a to
26316 be linked.
26318 @item -mfpu
26319 @itemx -mhard-float
26320 @opindex mfpu
26321 @opindex mhard-float
26322 Generate code containing floating-point instructions.  This is the
26323 default.
26325 @item -mno-fpu
26326 @itemx -msoft-float
26327 @opindex mno-fpu
26328 @opindex msoft-float
26329 Generate code containing library calls for floating-point.
26331 @option{-msoft-float} changes the calling convention in the output file;
26332 therefore, it is only useful if you compile @emph{all} of a program with
26333 this option.  In particular, you need to compile @file{libgcc.a}, the
26334 library that comes with GCC, with @option{-msoft-float} in order for
26335 this to work.
26337 @item -mcpu=@var{cpu_type}
26338 @opindex mcpu
26339 Set the instruction set, register set, and instruction scheduling parameters
26340 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26341 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26343 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26345 By default (unless configured otherwise), GCC generates code for the GR5
26346 variant of the Visium architecture.  
26348 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26349 architecture.  The only difference from GR5 code is that the compiler will
26350 generate block move instructions.
26352 @item -mtune=@var{cpu_type}
26353 @opindex mtune
26354 Set the instruction scheduling parameters for machine type @var{cpu_type},
26355 but do not set the instruction set or register set that the option
26356 @option{-mcpu=@var{cpu_type}} would.
26358 @item -msv-mode
26359 @opindex msv-mode
26360 Generate code for the supervisor mode, where there are no restrictions on
26361 the access to general registers.  This is the default.
26363 @item -muser-mode
26364 @opindex muser-mode
26365 Generate code for the user mode, where the access to some general registers
26366 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26367 mode; on the GR6, only registers r29 to r31 are affected.
26368 @end table
26370 @node VMS Options
26371 @subsection VMS Options
26373 These @samp{-m} options are defined for the VMS implementations:
26375 @table @gcctabopt
26376 @item -mvms-return-codes
26377 @opindex mvms-return-codes
26378 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26379 condition (e.g.@ error) codes.
26381 @item -mdebug-main=@var{prefix}
26382 @opindex mdebug-main=@var{prefix}
26383 Flag the first routine whose name starts with @var{prefix} as the main
26384 routine for the debugger.
26386 @item -mmalloc64
26387 @opindex mmalloc64
26388 Default to 64-bit memory allocation routines.
26390 @item -mpointer-size=@var{size}
26391 @opindex mpointer-size=@var{size}
26392 Set the default size of pointers. Possible options for @var{size} are
26393 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26394 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26395 The later option disables @code{pragma pointer_size}.
26396 @end table
26398 @node VxWorks Options
26399 @subsection VxWorks Options
26400 @cindex VxWorks Options
26402 The options in this section are defined for all VxWorks targets.
26403 Options specific to the target hardware are listed with the other
26404 options for that target.
26406 @table @gcctabopt
26407 @item -mrtp
26408 @opindex mrtp
26409 GCC can generate code for both VxWorks kernels and real time processes
26410 (RTPs).  This option switches from the former to the latter.  It also
26411 defines the preprocessor macro @code{__RTP__}.
26413 @item -non-static
26414 @opindex non-static
26415 Link an RTP executable against shared libraries rather than static
26416 libraries.  The options @option{-static} and @option{-shared} can
26417 also be used for RTPs (@pxref{Link Options}); @option{-static}
26418 is the default.
26420 @item -Bstatic
26421 @itemx -Bdynamic
26422 @opindex Bstatic
26423 @opindex Bdynamic
26424 These options are passed down to the linker.  They are defined for
26425 compatibility with Diab.
26427 @item -Xbind-lazy
26428 @opindex Xbind-lazy
26429 Enable lazy binding of function calls.  This option is equivalent to
26430 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26432 @item -Xbind-now
26433 @opindex Xbind-now
26434 Disable lazy binding of function calls.  This option is the default and
26435 is defined for compatibility with Diab.
26436 @end table
26438 @node x86 Options
26439 @subsection x86 Options
26440 @cindex x86 Options
26442 These @samp{-m} options are defined for the x86 family of computers.
26444 @table @gcctabopt
26446 @item -march=@var{cpu-type}
26447 @opindex march
26448 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26449 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26450 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26451 to generate code that may not run at all on processors other than the one
26452 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26453 @option{-mtune=@var{cpu-type}}.
26455 The choices for @var{cpu-type} are:
26457 @table @samp
26458 @item native
26459 This selects the CPU to generate code for at compilation time by determining
26460 the processor type of the compiling machine.  Using @option{-march=native}
26461 enables all instruction subsets supported by the local machine (hence
26462 the result might not run on different machines).  Using @option{-mtune=native}
26463 produces code optimized for the local machine under the constraints
26464 of the selected instruction set.  
26466 @item x86-64
26467 A generic CPU with 64-bit extensions.
26469 @item i386
26470 Original Intel i386 CPU@.
26472 @item i486
26473 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26475 @item i586
26476 @itemx pentium
26477 Intel Pentium CPU with no MMX support.
26479 @item lakemont
26480 Intel Lakemont MCU, based on Intel Pentium CPU.
26482 @item pentium-mmx
26483 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26485 @item pentiumpro
26486 Intel Pentium Pro CPU@.
26488 @item i686
26489 When used with @option{-march}, the Pentium Pro
26490 instruction set is used, so the code runs on all i686 family chips.
26491 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26493 @item pentium2
26494 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26495 support.
26497 @item pentium3
26498 @itemx pentium3m
26499 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26500 set support.
26502 @item pentium-m
26503 Intel Pentium M; low-power version of Intel Pentium III CPU
26504 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26506 @item pentium4
26507 @itemx pentium4m
26508 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26510 @item prescott
26511 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26512 set support.
26514 @item nocona
26515 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26516 SSE2 and SSE3 instruction set support.
26518 @item core2
26519 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26520 instruction set support.
26522 @item nehalem
26523 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26524 SSE4.1, SSE4.2 and POPCNT instruction set support.
26526 @item westmere
26527 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26528 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26530 @item sandybridge
26531 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26532 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26534 @item ivybridge
26535 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26536 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26537 instruction set support.
26539 @item haswell
26540 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26541 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26542 BMI, BMI2 and F16C instruction set support.
26544 @item broadwell
26545 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26546 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26547 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26549 @item skylake
26550 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26551 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26552 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26553 XSAVES instruction set support.
26555 @item bonnell
26556 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26557 instruction set support.
26559 @item silvermont
26560 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26561 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26563 @item knl
26564 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26565 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26566 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26567 AVX512CD instruction set support.
26569 @item knm
26570 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26571 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26572 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26573 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26575 @item skylake-avx512
26576 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26577 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26578 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26579 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26581 @item cannonlake
26582 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26583 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26584 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26585 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26586 AVX512IFMA, SHA and UMIP instruction set support.
26588 @item icelake-client
26589 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26590 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26591 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26592 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26593 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26594 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26596 @item icelake-server
26597 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26598 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26599 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26600 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26601 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26602 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26603 set support.
26605 @item k6
26606 AMD K6 CPU with MMX instruction set support.
26608 @item k6-2
26609 @itemx k6-3
26610 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26612 @item athlon
26613 @itemx athlon-tbird
26614 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26615 support.
26617 @item athlon-4
26618 @itemx athlon-xp
26619 @itemx athlon-mp
26620 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26621 instruction set support.
26623 @item k8
26624 @itemx opteron
26625 @itemx athlon64
26626 @itemx athlon-fx
26627 Processors based on the AMD K8 core with x86-64 instruction set support,
26628 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26629 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26630 instruction set extensions.)
26632 @item k8-sse3
26633 @itemx opteron-sse3
26634 @itemx athlon64-sse3
26635 Improved versions of AMD K8 cores with SSE3 instruction set support.
26637 @item amdfam10
26638 @itemx barcelona
26639 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26640 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26641 instruction set extensions.)
26643 @item bdver1
26644 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26645 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26646 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26647 @item bdver2
26648 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26649 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26650 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26651 extensions.)
26652 @item bdver3
26653 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26654 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26655 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26656 64-bit instruction set extensions.
26657 @item bdver4
26658 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26659 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26660 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26661 SSE4.2, ABM and 64-bit instruction set extensions.
26663 @item znver1
26664 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26665 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26666 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26667 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26668 instruction set extensions.
26670 @item btver1
26671 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26672 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26673 instruction set extensions.)
26675 @item btver2
26676 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26677 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26678 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26680 @item winchip-c6
26681 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26682 set support.
26684 @item winchip2
26685 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26686 instruction set support.
26688 @item c3
26689 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26690 (No scheduling is implemented for this chip.)
26692 @item c3-2
26693 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26694 (No scheduling is implemented for this chip.)
26696 @item c7
26697 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26698 (No scheduling is implemented for this chip.)
26700 @item samuel-2
26701 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26702 (No scheduling is implemented for this chip.)
26704 @item nehemiah
26705 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26706 (No scheduling is implemented for this chip.)
26708 @item esther
26709 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26710 (No scheduling is implemented for this chip.)
26712 @item eden-x2
26713 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26714 (No scheduling is implemented for this chip.)
26716 @item eden-x4
26717 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26718 AVX and AVX2 instruction set support.
26719 (No scheduling is implemented for this chip.)
26721 @item nano
26722 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26723 instruction set support.
26724 (No scheduling is implemented for this chip.)
26726 @item nano-1000
26727 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26728 instruction set support.
26729 (No scheduling is implemented for this chip.)
26731 @item nano-2000
26732 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26733 instruction set support.
26734 (No scheduling is implemented for this chip.)
26736 @item nano-3000
26737 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26738 instruction set support.
26739 (No scheduling is implemented for this chip.)
26741 @item nano-x2
26742 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26743 instruction set support.
26744 (No scheduling is implemented for this chip.)
26746 @item nano-x4
26747 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26748 instruction set support.
26749 (No scheduling is implemented for this chip.)
26751 @item geode
26752 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26753 @end table
26755 @item -mtune=@var{cpu-type}
26756 @opindex mtune
26757 Tune to @var{cpu-type} everything applicable about the generated code, except
26758 for the ABI and the set of available instructions.  
26759 While picking a specific @var{cpu-type} schedules things appropriately
26760 for that particular chip, the compiler does not generate any code that
26761 cannot run on the default machine type unless you use a
26762 @option{-march=@var{cpu-type}} option.
26763 For example, if GCC is configured for i686-pc-linux-gnu
26764 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26765 but still runs on i686 machines.
26767 The choices for @var{cpu-type} are the same as for @option{-march}.
26768 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26770 @table @samp
26771 @item generic
26772 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26773 If you know the CPU on which your code will run, then you should use
26774 the corresponding @option{-mtune} or @option{-march} option instead of
26775 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26776 of your application will have, then you should use this option.
26778 As new processors are deployed in the marketplace, the behavior of this
26779 option will change.  Therefore, if you upgrade to a newer version of
26780 GCC, code generation controlled by this option will change to reflect
26781 the processors
26782 that are most common at the time that version of GCC is released.
26784 There is no @option{-march=generic} option because @option{-march}
26785 indicates the instruction set the compiler can use, and there is no
26786 generic instruction set applicable to all processors.  In contrast,
26787 @option{-mtune} indicates the processor (or, in this case, collection of
26788 processors) for which the code is optimized.
26790 @item intel
26791 Produce code optimized for the most current Intel processors, which are
26792 Haswell and Silvermont for this version of GCC.  If you know the CPU
26793 on which your code will run, then you should use the corresponding
26794 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26795 But, if you want your application performs better on both Haswell and
26796 Silvermont, then you should use this option.
26798 As new Intel processors are deployed in the marketplace, the behavior of
26799 this option will change.  Therefore, if you upgrade to a newer version of
26800 GCC, code generation controlled by this option will change to reflect
26801 the most current Intel processors at the time that version of GCC is
26802 released.
26804 There is no @option{-march=intel} option because @option{-march} indicates
26805 the instruction set the compiler can use, and there is no common
26806 instruction set applicable to all processors.  In contrast,
26807 @option{-mtune} indicates the processor (or, in this case, collection of
26808 processors) for which the code is optimized.
26809 @end table
26811 @item -mcpu=@var{cpu-type}
26812 @opindex mcpu
26813 A deprecated synonym for @option{-mtune}.
26815 @item -mfpmath=@var{unit}
26816 @opindex mfpmath
26817 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26818 for @var{unit} are:
26820 @table @samp
26821 @item 387
26822 Use the standard 387 floating-point coprocessor present on the majority of chips and
26823 emulated otherwise.  Code compiled with this option runs almost everywhere.
26824 The temporary results are computed in 80-bit precision instead of the precision
26825 specified by the type, resulting in slightly different results compared to most
26826 of other chips.  See @option{-ffloat-store} for more detailed description.
26828 This is the default choice for non-Darwin x86-32 targets.
26830 @item sse
26831 Use scalar floating-point instructions present in the SSE instruction set.
26832 This instruction set is supported by Pentium III and newer chips,
26833 and in the AMD line
26834 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26835 instruction set supports only single-precision arithmetic, thus the double and
26836 extended-precision arithmetic are still done using 387.  A later version, present
26837 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26838 arithmetic too.
26840 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26841 or @option{-msse2} switches to enable SSE extensions and make this option
26842 effective.  For the x86-64 compiler, these extensions are enabled by default.
26844 The resulting code should be considerably faster in the majority of cases and avoid
26845 the numerical instability problems of 387 code, but may break some existing
26846 code that expects temporaries to be 80 bits.
26848 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26849 and the default choice for x86-32 targets with the SSE2 instruction set
26850 when @option{-ffast-math} is enabled.
26852 @item sse,387
26853 @itemx sse+387
26854 @itemx both
26855 Attempt to utilize both instruction sets at once.  This effectively doubles the
26856 amount of available registers, and on chips with separate execution units for
26857 387 and SSE the execution resources too.  Use this option with care, as it is
26858 still experimental, because the GCC register allocator does not model separate
26859 functional units well, resulting in unstable performance.
26860 @end table
26862 @item -masm=@var{dialect}
26863 @opindex masm=@var{dialect}
26864 Output assembly instructions using selected @var{dialect}.  Also affects
26865 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26866 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26867 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26868 not support @samp{intel}.
26870 @item -mieee-fp
26871 @itemx -mno-ieee-fp
26872 @opindex mieee-fp
26873 @opindex mno-ieee-fp
26874 Control whether or not the compiler uses IEEE floating-point
26875 comparisons.  These correctly handle the case where the result of a
26876 comparison is unordered.
26878 @item -m80387
26879 @itemx -mhard-float
26880 @opindex 80387
26881 @opindex mhard-float
26882 Generate output containing 80387 instructions for floating point.
26884 @item -mno-80387
26885 @itemx -msoft-float
26886 @opindex no-80387
26887 @opindex msoft-float
26888 Generate output containing library calls for floating point.
26890 @strong{Warning:} the requisite libraries are not part of GCC@.
26891 Normally the facilities of the machine's usual C compiler are used, but
26892 this cannot be done directly in cross-compilation.  You must make your
26893 own arrangements to provide suitable library functions for
26894 cross-compilation.
26896 On machines where a function returns floating-point results in the 80387
26897 register stack, some floating-point opcodes may be emitted even if
26898 @option{-msoft-float} is used.
26900 @item -mno-fp-ret-in-387
26901 @opindex mno-fp-ret-in-387
26902 Do not use the FPU registers for return values of functions.
26904 The usual calling convention has functions return values of types
26905 @code{float} and @code{double} in an FPU register, even if there
26906 is no FPU@.  The idea is that the operating system should emulate
26907 an FPU@.
26909 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26910 in ordinary CPU registers instead.
26912 @item -mno-fancy-math-387
26913 @opindex mno-fancy-math-387
26914 Some 387 emulators do not support the @code{sin}, @code{cos} and
26915 @code{sqrt} instructions for the 387.  Specify this option to avoid
26916 generating those instructions.  This option is the default on
26917 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26918 indicates that the target CPU always has an FPU and so the
26919 instruction does not need emulation.  These
26920 instructions are not generated unless you also use the
26921 @option{-funsafe-math-optimizations} switch.
26923 @item -malign-double
26924 @itemx -mno-align-double
26925 @opindex malign-double
26926 @opindex mno-align-double
26927 Control whether GCC aligns @code{double}, @code{long double}, and
26928 @code{long long} variables on a two-word boundary or a one-word
26929 boundary.  Aligning @code{double} variables on a two-word boundary
26930 produces code that runs somewhat faster on a Pentium at the
26931 expense of more memory.
26933 On x86-64, @option{-malign-double} is enabled by default.
26935 @strong{Warning:} if you use the @option{-malign-double} switch,
26936 structures containing the above types are aligned differently than
26937 the published application binary interface specifications for the x86-32
26938 and are not binary compatible with structures in code compiled
26939 without that switch.
26941 @item -m96bit-long-double
26942 @itemx -m128bit-long-double
26943 @opindex m96bit-long-double
26944 @opindex m128bit-long-double
26945 These switches control the size of @code{long double} type.  The x86-32
26946 application binary interface specifies the size to be 96 bits,
26947 so @option{-m96bit-long-double} is the default in 32-bit mode.
26949 Modern architectures (Pentium and newer) prefer @code{long double}
26950 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26951 conforming to the ABI, this is not possible.  So specifying
26952 @option{-m128bit-long-double} aligns @code{long double}
26953 to a 16-byte boundary by padding the @code{long double} with an additional
26954 32-bit zero.
26956 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26957 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26959 Notice that neither of these options enable any extra precision over the x87
26960 standard of 80 bits for a @code{long double}.
26962 @strong{Warning:} if you override the default value for your target ABI, this
26963 changes the size of 
26964 structures and arrays containing @code{long double} variables,
26965 as well as modifying the function calling convention for functions taking
26966 @code{long double}.  Hence they are not binary-compatible
26967 with code compiled without that switch.
26969 @item -mlong-double-64
26970 @itemx -mlong-double-80
26971 @itemx -mlong-double-128
26972 @opindex mlong-double-64
26973 @opindex mlong-double-80
26974 @opindex mlong-double-128
26975 These switches control the size of @code{long double} type. A size
26976 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26977 type. This is the default for 32-bit Bionic C library.  A size
26978 of 128 bits makes the @code{long double} type equivalent to the
26979 @code{__float128} type. This is the default for 64-bit Bionic C library.
26981 @strong{Warning:} if you override the default value for your target ABI, this
26982 changes the size of
26983 structures and arrays containing @code{long double} variables,
26984 as well as modifying the function calling convention for functions taking
26985 @code{long double}.  Hence they are not binary-compatible
26986 with code compiled without that switch.
26988 @item -malign-data=@var{type}
26989 @opindex malign-data
26990 Control how GCC aligns variables.  Supported values for @var{type} are
26991 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26992 and earlier, @samp{abi} uses alignment value as specified by the
26993 psABI, and @samp{cacheline} uses increased alignment value to match
26994 the cache line size.  @samp{compat} is the default.
26996 @item -mlarge-data-threshold=@var{threshold}
26997 @opindex mlarge-data-threshold
26998 When @option{-mcmodel=medium} is specified, data objects larger than
26999 @var{threshold} are placed in the large data section.  This value must be the
27000 same across all objects linked into the binary, and defaults to 65535.
27002 @item -mrtd
27003 @opindex mrtd
27004 Use a different function-calling convention, in which functions that
27005 take a fixed number of arguments return with the @code{ret @var{num}}
27006 instruction, which pops their arguments while returning.  This saves one
27007 instruction in the caller since there is no need to pop the arguments
27008 there.
27010 You can specify that an individual function is called with this calling
27011 sequence with the function attribute @code{stdcall}.  You can also
27012 override the @option{-mrtd} option by using the function attribute
27013 @code{cdecl}.  @xref{Function Attributes}.
27015 @strong{Warning:} this calling convention is incompatible with the one
27016 normally used on Unix, so you cannot use it if you need to call
27017 libraries compiled with the Unix compiler.
27019 Also, you must provide function prototypes for all functions that
27020 take variable numbers of arguments (including @code{printf});
27021 otherwise incorrect code is generated for calls to those
27022 functions.
27024 In addition, seriously incorrect code results if you call a
27025 function with too many arguments.  (Normally, extra arguments are
27026 harmlessly ignored.)
27028 @item -mregparm=@var{num}
27029 @opindex mregparm
27030 Control how many registers are used to pass integer arguments.  By
27031 default, no registers are used to pass arguments, and at most 3
27032 registers can be used.  You can control this behavior for a specific
27033 function by using the function attribute @code{regparm}.
27034 @xref{Function Attributes}.
27036 @strong{Warning:} if you use this switch, and
27037 @var{num} is nonzero, then you must build all modules with the same
27038 value, including any libraries.  This includes the system libraries and
27039 startup modules.
27041 @item -msseregparm
27042 @opindex msseregparm
27043 Use SSE register passing conventions for float and double arguments
27044 and return values.  You can control this behavior for a specific
27045 function by using the function attribute @code{sseregparm}.
27046 @xref{Function Attributes}.
27048 @strong{Warning:} if you use this switch then you must build all
27049 modules with the same value, including any libraries.  This includes
27050 the system libraries and startup modules.
27052 @item -mvect8-ret-in-mem
27053 @opindex mvect8-ret-in-mem
27054 Return 8-byte vectors in memory instead of MMX registers.  This is the
27055 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27056 Studio compilers until version 12.  Later compiler versions (starting
27057 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27058 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27059 you need to remain compatible with existing code produced by those
27060 previous compiler versions or older versions of GCC@.
27062 @item -mpc32
27063 @itemx -mpc64
27064 @itemx -mpc80
27065 @opindex mpc32
27066 @opindex mpc64
27067 @opindex mpc80
27069 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27070 is specified, the significands of results of floating-point operations are
27071 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27072 significands of results of floating-point operations to 53 bits (double
27073 precision) and @option{-mpc80} rounds the significands of results of
27074 floating-point operations to 64 bits (extended double precision), which is
27075 the default.  When this option is used, floating-point operations in higher
27076 precisions are not available to the programmer without setting the FPU
27077 control word explicitly.
27079 Setting the rounding of floating-point operations to less than the default
27080 80 bits can speed some programs by 2% or more.  Note that some mathematical
27081 libraries assume that extended-precision (80-bit) floating-point operations
27082 are enabled by default; routines in such libraries could suffer significant
27083 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27084 when this option is used to set the precision to less than extended precision.
27086 @item -mstackrealign
27087 @opindex mstackrealign
27088 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27089 option generates an alternate prologue and epilogue that realigns the
27090 run-time stack if necessary.  This supports mixing legacy codes that keep
27091 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27092 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27093 applicable to individual functions.
27095 @item -mpreferred-stack-boundary=@var{num}
27096 @opindex mpreferred-stack-boundary
27097 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27098 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27099 the default is 4 (16 bytes or 128 bits).
27101 @strong{Warning:} When generating code for the x86-64 architecture with
27102 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27103 used to keep the stack boundary aligned to 8 byte boundary.  Since
27104 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27105 intended to be used in controlled environment where stack space is
27106 important limitation.  This option leads to wrong code when functions
27107 compiled with 16 byte stack alignment (such as functions from a standard
27108 library) are called with misaligned stack.  In this case, SSE
27109 instructions may lead to misaligned memory access traps.  In addition,
27110 variable arguments are handled incorrectly for 16 byte aligned
27111 objects (including x87 long double and __int128), leading to wrong
27112 results.  You must build all modules with
27113 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27114 includes the system libraries and startup modules.
27116 @item -mincoming-stack-boundary=@var{num}
27117 @opindex mincoming-stack-boundary
27118 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27119 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27120 the one specified by @option{-mpreferred-stack-boundary} is used.
27122 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27123 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27124 suffer significant run time performance penalties.  On Pentium III, the
27125 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27126 properly if it is not 16-byte aligned.
27128 To ensure proper alignment of this values on the stack, the stack boundary
27129 must be as aligned as that required by any value stored on the stack.
27130 Further, every function must be generated such that it keeps the stack
27131 aligned.  Thus calling a function compiled with a higher preferred
27132 stack boundary from a function compiled with a lower preferred stack
27133 boundary most likely misaligns the stack.  It is recommended that
27134 libraries that use callbacks always use the default setting.
27136 This extra alignment does consume extra stack space, and generally
27137 increases code size.  Code that is sensitive to stack space usage, such
27138 as embedded systems and operating system kernels, may want to reduce the
27139 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27141 @need 200
27142 @item -mmmx
27143 @opindex mmmx
27144 @need 200
27145 @itemx -msse
27146 @opindex msse
27147 @need 200
27148 @itemx -msse2
27149 @opindex msse2
27150 @need 200
27151 @itemx -msse3
27152 @opindex msse3
27153 @need 200
27154 @itemx -mssse3
27155 @opindex mssse3
27156 @need 200
27157 @itemx -msse4
27158 @opindex msse4
27159 @need 200
27160 @itemx -msse4a
27161 @opindex msse4a
27162 @need 200
27163 @itemx -msse4.1
27164 @opindex msse4.1
27165 @need 200
27166 @itemx -msse4.2
27167 @opindex msse4.2
27168 @need 200
27169 @itemx -mavx
27170 @opindex mavx
27171 @need 200
27172 @itemx -mavx2
27173 @opindex mavx2
27174 @need 200
27175 @itemx -mavx512f
27176 @opindex mavx512f
27177 @need 200
27178 @itemx -mavx512pf
27179 @opindex mavx512pf
27180 @need 200
27181 @itemx -mavx512er
27182 @opindex mavx512er
27183 @need 200
27184 @itemx -mavx512cd
27185 @opindex mavx512cd
27186 @need 200
27187 @itemx -mavx512vl
27188 @opindex mavx512vl
27189 @need 200
27190 @itemx -mavx512bw
27191 @opindex mavx512bw
27192 @need 200
27193 @itemx -mavx512dq
27194 @opindex mavx512dq
27195 @need 200
27196 @itemx -mavx512ifma
27197 @opindex mavx512ifma
27198 @need 200
27199 @itemx -mavx512vbmi
27200 @opindex mavx512vbmi
27201 @need 200
27202 @itemx -msha
27203 @opindex msha
27204 @need 200
27205 @itemx -maes
27206 @opindex maes
27207 @need 200
27208 @itemx -mpclmul
27209 @opindex mpclmul
27210 @need 200
27211 @itemx -mclflushopt
27212 @opindex mclflushopt
27213 @need 200
27214 @itemx -mfsgsbase
27215 @opindex mfsgsbase
27216 @need 200
27217 @itemx -mrdrnd
27218 @opindex mrdrnd
27219 @need 200
27220 @itemx -mf16c
27221 @opindex mf16c
27222 @need 200
27223 @itemx -mfma
27224 @opindex mfma
27225 @need 200
27226 @itemx -mpconfig
27227 @opindex mpconfig
27228 @need 200
27229 @itemx -mwbnoinvd
27230 @opindex mwbnoinvd
27231 @need 200
27232 @itemx -mfma4
27233 @opindex mfma4
27234 @need 200
27235 @itemx -mprefetchwt1
27236 @opindex mprefetchwt1
27237 @need 200
27238 @itemx -mxop
27239 @opindex mxop
27240 @need 200
27241 @itemx -mlwp
27242 @opindex mlwp
27243 @need 200
27244 @itemx -m3dnow
27245 @opindex m3dnow
27246 @need 200
27247 @itemx -m3dnowa
27248 @opindex m3dnowa
27249 @need 200
27250 @itemx -mpopcnt
27251 @opindex mpopcnt
27252 @need 200
27253 @itemx -mabm
27254 @opindex mabm
27255 @need 200
27256 @itemx -mbmi
27257 @opindex mbmi
27258 @need 200
27259 @itemx -mbmi2
27260 @need 200
27261 @itemx -mlzcnt
27262 @opindex mlzcnt
27263 @need 200
27264 @itemx -mfxsr
27265 @opindex mfxsr
27266 @need 200
27267 @itemx -mxsave
27268 @opindex mxsave
27269 @need 200
27270 @itemx -mxsaveopt
27271 @opindex mxsaveopt
27272 @need 200
27273 @itemx -mxsavec
27274 @opindex mxsavec
27275 @need 200
27276 @itemx -mxsaves
27277 @opindex mxsaves
27278 @need 200
27279 @itemx -mrtm
27280 @opindex mrtm
27281 @need 200
27282 @itemx -mtbm
27283 @opindex mtbm
27284 @need 200
27285 @itemx -mmpx
27286 @opindex mmpx
27287 @need 200
27288 @itemx -mmwaitx
27289 @opindex mmwaitx
27290 @need 200
27291 @itemx -mclzero
27292 @opindex mclzero
27293 @need 200
27294 @itemx -mpku
27295 @opindex mpku
27296 @need 200
27297 @itemx -mcet
27298 @opindex mcet
27299 @need 200
27300 @itemx -mavx512vbmi2
27301 @opindex mavx512vbmi2
27302 @need 200
27303 @itemx -mgfni
27304 @opindex mgfni
27305 @need 200
27306 @itemx -mvaes
27307 @opindex mvaes
27308 @need 200
27309 @itemx -mvpclmulqdq
27310 @opindex mvpclmulqdq
27311 @need 200
27312 @itemx -mavx512bitalg
27313 @opindex mavx512bitalg
27314 @need 200
27315 @itemx -mmovdiri
27316 @opindex mmovdiri
27317 @need 200
27318 @itemx -mmovdir64b
27319 @opindex mmovdir64b
27320 @need 200
27321 @itemx -mavx512vpopcntdq
27322 @opindex mavx512vpopcntdq
27323 These switches enable the use of instructions in the MMX, SSE,
27324 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27325 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27326 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
27327 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27328 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
27329 AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@: extended instruction sets.
27330 Each has a corresponding @option{-mno-} option to disable use of these
27331 instructions.
27333 These extensions are also available as built-in functions: see
27334 @ref{x86 Built-in Functions}, for details of the functions enabled and
27335 disabled by these switches.
27337 To generate SSE/SSE2 instructions automatically from floating-point
27338 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27340 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27341 generates new AVX instructions or AVX equivalence for all SSEx instructions
27342 when needed.
27344 These options enable GCC to use these extended instructions in
27345 generated code, even without @option{-mfpmath=sse}.  Applications that
27346 perform run-time CPU detection must compile separate files for each
27347 supported architecture, using the appropriate flags.  In particular,
27348 the file containing the CPU detection code should be compiled without
27349 these options.
27351 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
27352 options.  The compiler provides a number of built-in functions for
27353 fine-grained control in a CET-based application.  See
27354 @xref{x86 Built-in Functions}, for more information.
27356 @item -mdump-tune-features
27357 @opindex mdump-tune-features
27358 This option instructs GCC to dump the names of the x86 performance 
27359 tuning features and default settings. The names can be used in 
27360 @option{-mtune-ctrl=@var{feature-list}}.
27362 @item -mtune-ctrl=@var{feature-list}
27363 @opindex mtune-ctrl=@var{feature-list}
27364 This option is used to do fine grain control of x86 code generation features.
27365 @var{feature-list} is a comma separated list of @var{feature} names. See also
27366 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27367 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27368 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27369 developers. Using it may lead to code paths not covered by testing and can
27370 potentially result in compiler ICEs or runtime errors.
27372 @item -mno-default
27373 @opindex mno-default
27374 This option instructs GCC to turn off all tunable features. See also 
27375 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27377 @item -mcld
27378 @opindex mcld
27379 This option instructs GCC to emit a @code{cld} instruction in the prologue
27380 of functions that use string instructions.  String instructions depend on
27381 the DF flag to select between autoincrement or autodecrement mode.  While the
27382 ABI specifies the DF flag to be cleared on function entry, some operating
27383 systems violate this specification by not clearing the DF flag in their
27384 exception dispatchers.  The exception handler can be invoked with the DF flag
27385 set, which leads to wrong direction mode when string instructions are used.
27386 This option can be enabled by default on 32-bit x86 targets by configuring
27387 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27388 instructions can be suppressed with the @option{-mno-cld} compiler option
27389 in this case.
27391 @item -mvzeroupper
27392 @opindex mvzeroupper
27393 This option instructs GCC to emit a @code{vzeroupper} instruction
27394 before a transfer of control flow out of the function to minimize
27395 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27396 intrinsics.
27398 @item -mprefer-avx128
27399 @opindex mprefer-avx128
27400 This option instructs GCC to use 128-bit AVX instructions instead of
27401 256-bit AVX instructions in the auto-vectorizer.
27403 @item -mprefer-vector-width=@var{opt}
27404 @opindex mprefer-vector-width
27405 This option instructs GCC to use @var{opt}-bit vector width in instructions
27406 instead of default on the selected platform.
27408 @table @samp
27409 @item none
27410 No extra limitations applied to GCC other than defined by the selected platform.
27412 @item 128
27413 Prefer 128-bit vector width for instructions.
27415 @item 256
27416 Prefer 256-bit vector width for instructions.
27418 @item 512
27419 Prefer 512-bit vector width for instructions.
27420 @end table
27422 @item -mcx16
27423 @opindex mcx16
27424 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27425 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27426 objects.  This is useful for atomic updates of data structures exceeding one
27427 machine word in size.  The compiler uses this instruction to implement
27428 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27429 128-bit integers, a library call is always used.
27431 @item -msahf
27432 @opindex msahf
27433 This option enables generation of @code{SAHF} instructions in 64-bit code.
27434 Early Intel Pentium 4 CPUs with Intel 64 support,
27435 prior to the introduction of Pentium 4 G1 step in December 2005,
27436 lacked the @code{LAHF} and @code{SAHF} instructions
27437 which are supported by AMD64.
27438 These are load and store instructions, respectively, for certain status flags.
27439 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27440 @code{drem}, and @code{remainder} built-in functions;
27441 see @ref{Other Builtins} for details.
27443 @item -mmovbe
27444 @opindex mmovbe
27445 This option enables use of the @code{movbe} instruction to implement
27446 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27448 @item -mibt
27449 @opindex mibt
27450 This option enables indirect branch tracking built-in functions from
27451 x86 Control-flow Enforcement Technology (CET).  The option
27452 @option{-mibt} is on by default when the @code{-mcet} option is
27453 specified.
27455 @item -mshstk
27456 @opindex mshstk
27457 This option enables shadow stack built-in functions from x86
27458 Control-flow Enforcement Technology (CET).  The option
27459 @option{-mshstk} is on by default when the @option{-mcet} option is
27460 specified.
27462 @item -mcrc32
27463 @opindex mcrc32
27464 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27465 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27466 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27468 @item -mrecip
27469 @opindex mrecip
27470 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27471 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27472 with an additional Newton-Raphson step
27473 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27474 (and their vectorized
27475 variants) for single-precision floating-point arguments.  These instructions
27476 are generated only when @option{-funsafe-math-optimizations} is enabled
27477 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27478 Note that while the throughput of the sequence is higher than the throughput
27479 of the non-reciprocal instruction, the precision of the sequence can be
27480 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27482 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27483 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27484 combination), and doesn't need @option{-mrecip}.
27486 Also note that GCC emits the above sequence with additional Newton-Raphson step
27487 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27488 already with @option{-ffast-math} (or the above option combination), and
27489 doesn't need @option{-mrecip}.
27491 @item -mrecip=@var{opt}
27492 @opindex mrecip=opt
27493 This option controls which reciprocal estimate instructions
27494 may be used.  @var{opt} is a comma-separated list of options, which may
27495 be preceded by a @samp{!} to invert the option:
27497 @table @samp
27498 @item all
27499 Enable all estimate instructions.
27501 @item default
27502 Enable the default instructions, equivalent to @option{-mrecip}.
27504 @item none
27505 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27507 @item div
27508 Enable the approximation for scalar division.
27510 @item vec-div
27511 Enable the approximation for vectorized division.
27513 @item sqrt
27514 Enable the approximation for scalar square root.
27516 @item vec-sqrt
27517 Enable the approximation for vectorized square root.
27518 @end table
27520 So, for example, @option{-mrecip=all,!sqrt} enables
27521 all of the reciprocal approximations, except for square root.
27523 @item -mveclibabi=@var{type}
27524 @opindex mveclibabi
27525 Specifies the ABI type to use for vectorizing intrinsics using an
27526 external library.  Supported values for @var{type} are @samp{svml} 
27527 for the Intel short
27528 vector math library and @samp{acml} for the AMD math core library.
27529 To use this option, both @option{-ftree-vectorize} and
27530 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27531 ABI-compatible library must be specified at link time.
27533 GCC currently emits calls to @code{vmldExp2},
27534 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27535 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27536 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27537 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27538 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27539 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27540 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27541 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27542 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27543 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27544 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27545 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27546 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27547 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27548 when @option{-mveclibabi=acml} is used.  
27550 @item -mabi=@var{name}
27551 @opindex mabi
27552 Generate code for the specified calling convention.  Permissible values
27553 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27554 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27555 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27556 You can control this behavior for specific functions by
27557 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27558 @xref{Function Attributes}.
27560 @item -mforce-indirect-call
27561 @opindex mforce-indirect-call
27562 Force all calls to functions to be indirect. This is useful
27563 when using Intel Processor Trace where it generates more precise timing
27564 information for function calls.
27566 @item -mcall-ms2sysv-xlogues
27567 @opindex mcall-ms2sysv-xlogues
27568 @opindex mno-call-ms2sysv-xlogues
27569 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27570 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27571 default, the code for saving and restoring these registers is emitted inline,
27572 resulting in fairly lengthy prologues and epilogues.  Using
27573 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27574 use stubs in the static portion of libgcc to perform these saves and restores,
27575 thus reducing function size at the cost of a few extra instructions.
27577 @item -mtls-dialect=@var{type}
27578 @opindex mtls-dialect
27579 Generate code to access thread-local storage using the @samp{gnu} or
27580 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27581 @samp{gnu2} is more efficient, but it may add compile- and run-time
27582 requirements that cannot be satisfied on all systems.
27584 @item -mpush-args
27585 @itemx -mno-push-args
27586 @opindex mpush-args
27587 @opindex mno-push-args
27588 Use PUSH operations to store outgoing parameters.  This method is shorter
27589 and usually equally fast as method using SUB/MOV operations and is enabled
27590 by default.  In some cases disabling it may improve performance because of
27591 improved scheduling and reduced dependencies.
27593 @item -maccumulate-outgoing-args
27594 @opindex maccumulate-outgoing-args
27595 If enabled, the maximum amount of space required for outgoing arguments is
27596 computed in the function prologue.  This is faster on most modern CPUs
27597 because of reduced dependencies, improved scheduling and reduced stack usage
27598 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27599 increase in code size.  This switch implies @option{-mno-push-args}.
27601 @item -mthreads
27602 @opindex mthreads
27603 Support thread-safe exception handling on MinGW.  Programs that rely
27604 on thread-safe exception handling must compile and link all code with the
27605 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27606 @option{-D_MT}; when linking, it links in a special thread helper library
27607 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27609 @item -mms-bitfields
27610 @itemx -mno-ms-bitfields
27611 @opindex mms-bitfields
27612 @opindex mno-ms-bitfields
27614 Enable/disable bit-field layout compatible with the native Microsoft
27615 Windows compiler.  
27617 If @code{packed} is used on a structure, or if bit-fields are used,
27618 it may be that the Microsoft ABI lays out the structure differently
27619 than the way GCC normally does.  Particularly when moving packed
27620 data between functions compiled with GCC and the native Microsoft compiler
27621 (either via function call or as data in a file), it may be necessary to access
27622 either format.
27624 This option is enabled by default for Microsoft Windows
27625 targets.  This behavior can also be controlled locally by use of variable
27626 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27627 and @ref{x86 Type Attributes}.
27629 The Microsoft structure layout algorithm is fairly simple with the exception
27630 of the bit-field packing.  
27631 The padding and alignment of members of structures and whether a bit-field 
27632 can straddle a storage-unit boundary are determine by these rules:
27634 @enumerate
27635 @item Structure members are stored sequentially in the order in which they are
27636 declared: the first member has the lowest memory address and the last member
27637 the highest.
27639 @item Every data object has an alignment requirement.  The alignment requirement
27640 for all data except structures, unions, and arrays is either the size of the
27641 object or the current packing size (specified with either the
27642 @code{aligned} attribute or the @code{pack} pragma),
27643 whichever is less.  For structures, unions, and arrays,
27644 the alignment requirement is the largest alignment requirement of its members.
27645 Every object is allocated an offset so that:
27647 @smallexample
27648 offset % alignment_requirement == 0
27649 @end smallexample
27651 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27652 unit if the integral types are the same size and if the next bit-field fits
27653 into the current allocation unit without crossing the boundary imposed by the
27654 common alignment requirements of the bit-fields.
27655 @end enumerate
27657 MSVC interprets zero-length bit-fields in the following ways:
27659 @enumerate
27660 @item If a zero-length bit-field is inserted between two bit-fields that
27661 are normally coalesced, the bit-fields are not coalesced.
27663 For example:
27665 @smallexample
27666 struct
27667  @{
27668    unsigned long bf_1 : 12;
27669    unsigned long : 0;
27670    unsigned long bf_2 : 12;
27671  @} t1;
27672 @end smallexample
27674 @noindent
27675 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27676 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27678 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27679 alignment of the zero-length bit-field is greater than the member that follows it,
27680 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27682 For example:
27684 @smallexample
27685 struct
27686  @{
27687    char foo : 4;
27688    short : 0;
27689    char bar;
27690  @} t2;
27692 struct
27693  @{
27694    char foo : 4;
27695    short : 0;
27696    double bar;
27697  @} t3;
27698 @end smallexample
27700 @noindent
27701 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27702 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27703 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27704 of the structure.
27706 Taking this into account, it is important to note the following:
27708 @enumerate
27709 @item If a zero-length bit-field follows a normal bit-field, the type of the
27710 zero-length bit-field may affect the alignment of the structure as whole. For
27711 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27712 normal bit-field, and is of type short.
27714 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27715 still affect the alignment of the structure:
27717 @smallexample
27718 struct
27719  @{
27720    char foo : 6;
27721    long : 0;
27722  @} t4;
27723 @end smallexample
27725 @noindent
27726 Here, @code{t4} takes up 4 bytes.
27727 @end enumerate
27729 @item Zero-length bit-fields following non-bit-field members are ignored:
27731 @smallexample
27732 struct
27733  @{
27734    char foo;
27735    long : 0;
27736    char bar;
27737  @} t5;
27738 @end smallexample
27740 @noindent
27741 Here, @code{t5} takes up 2 bytes.
27742 @end enumerate
27745 @item -mno-align-stringops
27746 @opindex mno-align-stringops
27747 Do not align the destination of inlined string operations.  This switch reduces
27748 code size and improves performance in case the destination is already aligned,
27749 but GCC doesn't know about it.
27751 @item -minline-all-stringops
27752 @opindex minline-all-stringops
27753 By default GCC inlines string operations only when the destination is 
27754 known to be aligned to least a 4-byte boundary.  
27755 This enables more inlining and increases code
27756 size, but may improve performance of code that depends on fast
27757 @code{memcpy}, @code{strlen},
27758 and @code{memset} for short lengths.
27760 @item -minline-stringops-dynamically
27761 @opindex minline-stringops-dynamically
27762 For string operations of unknown size, use run-time checks with
27763 inline code for small blocks and a library call for large blocks.
27765 @item -mstringop-strategy=@var{alg}
27766 @opindex mstringop-strategy=@var{alg}
27767 Override the internal decision heuristic for the particular algorithm to use
27768 for inlining string operations.  The allowed values for @var{alg} are:
27770 @table @samp
27771 @item rep_byte
27772 @itemx rep_4byte
27773 @itemx rep_8byte
27774 Expand using i386 @code{rep} prefix of the specified size.
27776 @item byte_loop
27777 @itemx loop
27778 @itemx unrolled_loop
27779 Expand into an inline loop.
27781 @item libcall
27782 Always use a library call.
27783 @end table
27785 @item -mmemcpy-strategy=@var{strategy}
27786 @opindex mmemcpy-strategy=@var{strategy}
27787 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27788 should be inlined and what inline algorithm to use when the expected size
27789 of the copy operation is known. @var{strategy} 
27790 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27791 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27792 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27793 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27794 in the list must be specified in increasing order.  The minimal byte size for 
27795 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27796 preceding range.
27798 @item -mmemset-strategy=@var{strategy}
27799 @opindex mmemset-strategy=@var{strategy}
27800 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27801 @code{__builtin_memset} expansion.
27803 @item -momit-leaf-frame-pointer
27804 @opindex momit-leaf-frame-pointer
27805 Don't keep the frame pointer in a register for leaf functions.  This
27806 avoids the instructions to save, set up, and restore frame pointers and
27807 makes an extra register available in leaf functions.  The option
27808 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27809 which might make debugging harder.
27811 @item -mtls-direct-seg-refs
27812 @itemx -mno-tls-direct-seg-refs
27813 @opindex mtls-direct-seg-refs
27814 Controls whether TLS variables may be accessed with offsets from the
27815 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27816 or whether the thread base pointer must be added.  Whether or not this
27817 is valid depends on the operating system, and whether it maps the
27818 segment to cover the entire TLS area.
27820 For systems that use the GNU C Library, the default is on.
27822 @item -msse2avx
27823 @itemx -mno-sse2avx
27824 @opindex msse2avx
27825 Specify that the assembler should encode SSE instructions with VEX
27826 prefix.  The option @option{-mavx} turns this on by default.
27828 @item -mfentry
27829 @itemx -mno-fentry
27830 @opindex mfentry
27831 If profiling is active (@option{-pg}), put the profiling
27832 counter call before the prologue.
27833 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27834 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27836 @item -mrecord-mcount
27837 @itemx -mno-record-mcount
27838 @opindex mrecord-mcount
27839 If profiling is active (@option{-pg}), generate a __mcount_loc section
27840 that contains pointers to each profiling call. This is useful for
27841 automatically patching and out calls.
27843 @item -mnop-mcount
27844 @itemx -mno-nop-mcount
27845 @opindex mnop-mcount
27846 If profiling is active (@option{-pg}), generate the calls to
27847 the profiling functions as NOPs. This is useful when they
27848 should be patched in later dynamically. This is likely only
27849 useful together with @option{-mrecord-mcount}.
27851 @item -mskip-rax-setup
27852 @itemx -mno-skip-rax-setup
27853 @opindex mskip-rax-setup
27854 When generating code for the x86-64 architecture with SSE extensions
27855 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27856 register when there are no variable arguments passed in vector registers.
27858 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27859 saving vector registers on stack when passing variable arguments, the
27860 impacts of this option are callees may waste some stack space,
27861 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27862 those issues, regardless the RAX register value.
27864 @item -m8bit-idiv
27865 @itemx -mno-8bit-idiv
27866 @opindex m8bit-idiv
27867 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27868 much faster than 32-bit/64-bit integer divide.  This option generates a
27869 run-time check.  If both dividend and divisor are within range of 0
27870 to 255, 8-bit unsigned integer divide is used instead of
27871 32-bit/64-bit integer divide.
27873 @item -mavx256-split-unaligned-load
27874 @itemx -mavx256-split-unaligned-store
27875 @opindex mavx256-split-unaligned-load
27876 @opindex mavx256-split-unaligned-store
27877 Split 32-byte AVX unaligned load and store.
27879 @item -mstack-protector-guard=@var{guard}
27880 @itemx -mstack-protector-guard-reg=@var{reg}
27881 @itemx -mstack-protector-guard-offset=@var{offset}
27882 @opindex mstack-protector-guard
27883 @opindex mstack-protector-guard-reg
27884 @opindex mstack-protector-guard-offset
27885 Generate stack protection code using canary at @var{guard}.  Supported
27886 locations are @samp{global} for global canary or @samp{tls} for per-thread
27887 canary in the TLS block (the default).  This option has effect only when
27888 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27890 With the latter choice the options
27891 @option{-mstack-protector-guard-reg=@var{reg}} and
27892 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27893 which segment register (@code{%fs} or @code{%gs}) to use as base register
27894 for reading the canary, and from what offset from that base register.
27895 The default for those is as specified in the relevant ABI.
27897 @item -mmitigate-rop
27898 @opindex mmitigate-rop
27899 Try to avoid generating code sequences that contain unintended return
27900 opcodes, to mitigate against certain forms of attack. At the moment,
27901 this option is limited in what it can do and should not be relied
27902 on to provide serious protection.
27904 @item -mgeneral-regs-only
27905 @opindex mgeneral-regs-only
27906 Generate code that uses only the general-purpose registers.  This
27907 prevents the compiler from using floating-point, vector, mask and bound
27908 registers.
27910 @item -mindirect-branch=@var{choice}
27911 @opindex -mindirect-branch
27912 Convert indirect call and jump with @var{choice}.  The default is
27913 @samp{keep}, which keeps indirect call and jump unmodified.
27914 @samp{thunk} converts indirect call and jump to call and return thunk.
27915 @samp{thunk-inline} converts indirect call and jump to inlined call
27916 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27917 to external call and return thunk provided in a separate object file.
27918 You can control this behavior for a specific function by using the
27919 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27921 Note that @option{-mcmodel=large} is incompatible with
27922 @option{-mindirect-branch=thunk} and
27923 @option{-mindirect-branch=thunk-extern} since the thunk function may
27924 not be reachable in the large code model.
27926 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27927 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27928 since the external thunk can not be modified to disable control-flow
27929 check.
27931 @item -mfunction-return=@var{choice}
27932 @opindex -mfunction-return
27933 Convert function return with @var{choice}.  The default is @samp{keep},
27934 which keeps function return unmodified.  @samp{thunk} converts function
27935 return to call and return thunk.  @samp{thunk-inline} converts function
27936 return to inlined call and return thunk.  @samp{thunk-extern} converts
27937 function return to external call and return thunk provided in a separate
27938 object file.  You can control this behavior for a specific function by
27939 using the function attribute @code{function_return}.
27940 @xref{Function Attributes}.
27942 Note that @option{-mcmodel=large} is incompatible with
27943 @option{-mfunction-return=thunk} and
27944 @option{-mfunction-return=thunk-extern} since the thunk function may
27945 not be reachable in the large code model.
27948 @item -mindirect-branch-register
27949 @opindex -mindirect-branch-register
27950 Force indirect call and jump via register.
27952 @end table
27954 These @samp{-m} switches are supported in addition to the above
27955 on x86-64 processors in 64-bit environments.
27957 @table @gcctabopt
27958 @item -m32
27959 @itemx -m64
27960 @itemx -mx32
27961 @itemx -m16
27962 @itemx -miamcu
27963 @opindex m32
27964 @opindex m64
27965 @opindex mx32
27966 @opindex m16
27967 @opindex miamcu
27968 Generate code for a 16-bit, 32-bit or 64-bit environment.
27969 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27970 to 32 bits, and
27971 generates code that runs on any i386 system.
27973 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27974 types to 64 bits, and generates code for the x86-64 architecture.
27975 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27976 and @option{-mdynamic-no-pic} options.
27978 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27979 to 32 bits, and
27980 generates code for the x86-64 architecture.
27982 The @option{-m16} option is the same as @option{-m32}, except for that
27983 it outputs the @code{.code16gcc} assembly directive at the beginning of
27984 the assembly output so that the binary can run in 16-bit mode.
27986 The @option{-miamcu} option generates code which conforms to Intel MCU
27987 psABI.  It requires the @option{-m32} option to be turned on.
27989 @item -mno-red-zone
27990 @opindex mno-red-zone
27991 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27992 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27993 stack pointer that is not modified by signal or interrupt handlers
27994 and therefore can be used for temporary data without adjusting the stack
27995 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27997 @item -mcmodel=small
27998 @opindex mcmodel=small
27999 Generate code for the small code model: the program and its symbols must
28000 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
28001 Programs can be statically or dynamically linked.  This is the default
28002 code model.
28004 @item -mcmodel=kernel
28005 @opindex mcmodel=kernel
28006 Generate code for the kernel code model.  The kernel runs in the
28007 negative 2 GB of the address space.
28008 This model has to be used for Linux kernel code.
28010 @item -mcmodel=medium
28011 @opindex mcmodel=medium
28012 Generate code for the medium model: the program is linked in the lower 2
28013 GB of the address space.  Small symbols are also placed there.  Symbols
28014 with sizes larger than @option{-mlarge-data-threshold} are put into
28015 large data or BSS sections and can be located above 2GB.  Programs can
28016 be statically or dynamically linked.
28018 @item -mcmodel=large
28019 @opindex mcmodel=large
28020 Generate code for the large model.  This model makes no assumptions
28021 about addresses and sizes of sections.
28023 @item -maddress-mode=long
28024 @opindex maddress-mode=long
28025 Generate code for long address mode.  This is only supported for 64-bit
28026 and x32 environments.  It is the default address mode for 64-bit
28027 environments.
28029 @item -maddress-mode=short
28030 @opindex maddress-mode=short
28031 Generate code for short address mode.  This is only supported for 32-bit
28032 and x32 environments.  It is the default address mode for 32-bit and
28033 x32 environments.
28034 @end table
28036 @node x86 Windows Options
28037 @subsection x86 Windows Options
28038 @cindex x86 Windows Options
28039 @cindex Windows Options for x86
28041 These additional options are available for Microsoft Windows targets:
28043 @table @gcctabopt
28044 @item -mconsole
28045 @opindex mconsole
28046 This option
28047 specifies that a console application is to be generated, by
28048 instructing the linker to set the PE header subsystem type
28049 required for console applications.
28050 This option is available for Cygwin and MinGW targets and is
28051 enabled by default on those targets.
28053 @item -mdll
28054 @opindex mdll
28055 This option is available for Cygwin and MinGW targets.  It
28056 specifies that a DLL---a dynamic link library---is to be
28057 generated, enabling the selection of the required runtime
28058 startup object and entry point.
28060 @item -mnop-fun-dllimport
28061 @opindex mnop-fun-dllimport
28062 This option is available for Cygwin and MinGW targets.  It
28063 specifies that the @code{dllimport} attribute should be ignored.
28065 @item -mthread
28066 @opindex mthread
28067 This option is available for MinGW targets. It specifies
28068 that MinGW-specific thread support is to be used.
28070 @item -municode
28071 @opindex municode
28072 This option is available for MinGW-w64 targets.  It causes
28073 the @code{UNICODE} preprocessor macro to be predefined, and
28074 chooses Unicode-capable runtime startup code.
28076 @item -mwin32
28077 @opindex mwin32
28078 This option is available for Cygwin and MinGW targets.  It
28079 specifies that the typical Microsoft Windows predefined macros are to
28080 be set in the pre-processor, but does not influence the choice
28081 of runtime library/startup code.
28083 @item -mwindows
28084 @opindex mwindows
28085 This option is available for Cygwin and MinGW targets.  It
28086 specifies that a GUI application is to be generated by
28087 instructing the linker to set the PE header subsystem type
28088 appropriately.
28090 @item -fno-set-stack-executable
28091 @opindex fno-set-stack-executable
28092 This option is available for MinGW targets. It specifies that
28093 the executable flag for the stack used by nested functions isn't
28094 set. This is necessary for binaries running in kernel mode of
28095 Microsoft Windows, as there the User32 API, which is used to set executable
28096 privileges, isn't available.
28098 @item -fwritable-relocated-rdata
28099 @opindex fno-writable-relocated-rdata
28100 This option is available for MinGW and Cygwin targets.  It specifies
28101 that relocated-data in read-only section is put into the @code{.data}
28102 section.  This is a necessary for older runtimes not supporting
28103 modification of @code{.rdata} sections for pseudo-relocation.
28105 @item -mpe-aligned-commons
28106 @opindex mpe-aligned-commons
28107 This option is available for Cygwin and MinGW targets.  It
28108 specifies that the GNU extension to the PE file format that
28109 permits the correct alignment of COMMON variables should be
28110 used when generating code.  It is enabled by default if
28111 GCC detects that the target assembler found during configuration
28112 supports the feature.
28113 @end table
28115 See also under @ref{x86 Options} for standard options.
28117 @node Xstormy16 Options
28118 @subsection Xstormy16 Options
28119 @cindex Xstormy16 Options
28121 These options are defined for Xstormy16:
28123 @table @gcctabopt
28124 @item -msim
28125 @opindex msim
28126 Choose startup files and linker script suitable for the simulator.
28127 @end table
28129 @node Xtensa Options
28130 @subsection Xtensa Options
28131 @cindex Xtensa Options
28133 These options are supported for Xtensa targets:
28135 @table @gcctabopt
28136 @item -mconst16
28137 @itemx -mno-const16
28138 @opindex mconst16
28139 @opindex mno-const16
28140 Enable or disable use of @code{CONST16} instructions for loading
28141 constant values.  The @code{CONST16} instruction is currently not a
28142 standard option from Tensilica.  When enabled, @code{CONST16}
28143 instructions are always used in place of the standard @code{L32R}
28144 instructions.  The use of @code{CONST16} is enabled by default only if
28145 the @code{L32R} instruction is not available.
28147 @item -mfused-madd
28148 @itemx -mno-fused-madd
28149 @opindex mfused-madd
28150 @opindex mno-fused-madd
28151 Enable or disable use of fused multiply/add and multiply/subtract
28152 instructions in the floating-point option.  This has no effect if the
28153 floating-point option is not also enabled.  Disabling fused multiply/add
28154 and multiply/subtract instructions forces the compiler to use separate
28155 instructions for the multiply and add/subtract operations.  This may be
28156 desirable in some cases where strict IEEE 754-compliant results are
28157 required: the fused multiply add/subtract instructions do not round the
28158 intermediate result, thereby producing results with @emph{more} bits of
28159 precision than specified by the IEEE standard.  Disabling fused multiply
28160 add/subtract instructions also ensures that the program output is not
28161 sensitive to the compiler's ability to combine multiply and add/subtract
28162 operations.
28164 @item -mserialize-volatile
28165 @itemx -mno-serialize-volatile
28166 @opindex mserialize-volatile
28167 @opindex mno-serialize-volatile
28168 When this option is enabled, GCC inserts @code{MEMW} instructions before
28169 @code{volatile} memory references to guarantee sequential consistency.
28170 The default is @option{-mserialize-volatile}.  Use
28171 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28173 @item -mforce-no-pic
28174 @opindex mforce-no-pic
28175 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28176 position-independent code (PIC), this option disables PIC for compiling
28177 kernel code.
28179 @item -mtext-section-literals
28180 @itemx -mno-text-section-literals
28181 @opindex mtext-section-literals
28182 @opindex mno-text-section-literals
28183 These options control the treatment of literal pools.  The default is
28184 @option{-mno-text-section-literals}, which places literals in a separate
28185 section in the output file.  This allows the literal pool to be placed
28186 in a data RAM/ROM, and it also allows the linker to combine literal
28187 pools from separate object files to remove redundant literals and
28188 improve code size.  With @option{-mtext-section-literals}, the literals
28189 are interspersed in the text section in order to keep them as close as
28190 possible to their references.  This may be necessary for large assembly
28191 files.  Literals for each function are placed right before that function.
28193 @item -mauto-litpools
28194 @itemx -mno-auto-litpools
28195 @opindex mauto-litpools
28196 @opindex mno-auto-litpools
28197 These options control the treatment of literal pools.  The default is
28198 @option{-mno-auto-litpools}, which places literals in a separate
28199 section in the output file unless @option{-mtext-section-literals} is
28200 used.  With @option{-mauto-litpools} the literals are interspersed in
28201 the text section by the assembler.  Compiler does not produce explicit
28202 @code{.literal} directives and loads literals into registers with
28203 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28204 do relaxation and place literals as necessary.  This option allows
28205 assembler to create several literal pools per function and assemble
28206 very big functions, which may not be possible with
28207 @option{-mtext-section-literals}.
28209 @item -mtarget-align
28210 @itemx -mno-target-align
28211 @opindex mtarget-align
28212 @opindex mno-target-align
28213 When this option is enabled, GCC instructs the assembler to
28214 automatically align instructions to reduce branch penalties at the
28215 expense of some code density.  The assembler attempts to widen density
28216 instructions to align branch targets and the instructions following call
28217 instructions.  If there are not enough preceding safe density
28218 instructions to align a target, no widening is performed.  The
28219 default is @option{-mtarget-align}.  These options do not affect the
28220 treatment of auto-aligned instructions like @code{LOOP}, which the
28221 assembler always aligns, either by widening density instructions or
28222 by inserting NOP instructions.
28224 @item -mlongcalls
28225 @itemx -mno-longcalls
28226 @opindex mlongcalls
28227 @opindex mno-longcalls
28228 When this option is enabled, GCC instructs the assembler to translate
28229 direct calls to indirect calls unless it can determine that the target
28230 of a direct call is in the range allowed by the call instruction.  This
28231 translation typically occurs for calls to functions in other source
28232 files.  Specifically, the assembler translates a direct @code{CALL}
28233 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28234 The default is @option{-mno-longcalls}.  This option should be used in
28235 programs where the call target can potentially be out of range.  This
28236 option is implemented in the assembler, not the compiler, so the
28237 assembly code generated by GCC still shows direct call
28238 instructions---look at the disassembled object code to see the actual
28239 instructions.  Note that the assembler uses an indirect call for
28240 every cross-file call, not just those that really are out of range.
28241 @end table
28243 @node zSeries Options
28244 @subsection zSeries Options
28245 @cindex zSeries options
28247 These are listed under @xref{S/390 and zSeries Options}.
28250 @c man end
28252 @node Spec Files
28253 @section Specifying Subprocesses and the Switches to Pass to Them
28254 @cindex Spec Files
28256 @command{gcc} is a driver program.  It performs its job by invoking a
28257 sequence of other programs to do the work of compiling, assembling and
28258 linking.  GCC interprets its command-line parameters and uses these to
28259 deduce which programs it should invoke, and which command-line options
28260 it ought to place on their command lines.  This behavior is controlled
28261 by @dfn{spec strings}.  In most cases there is one spec string for each
28262 program that GCC can invoke, but a few programs have multiple spec
28263 strings to control their behavior.  The spec strings built into GCC can
28264 be overridden by using the @option{-specs=} command-line switch to specify
28265 a spec file.
28267 @dfn{Spec files} are plain-text files that are used to construct spec
28268 strings.  They consist of a sequence of directives separated by blank
28269 lines.  The type of directive is determined by the first non-whitespace
28270 character on the line, which can be one of the following:
28272 @table @code
28273 @item %@var{command}
28274 Issues a @var{command} to the spec file processor.  The commands that can
28275 appear here are:
28277 @table @code
28278 @item %include <@var{file}>
28279 @cindex @code{%include}
28280 Search for @var{file} and insert its text at the current point in the
28281 specs file.
28283 @item %include_noerr <@var{file}>
28284 @cindex @code{%include_noerr}
28285 Just like @samp{%include}, but do not generate an error message if the include
28286 file cannot be found.
28288 @item %rename @var{old_name} @var{new_name}
28289 @cindex @code{%rename}
28290 Rename the spec string @var{old_name} to @var{new_name}.
28292 @end table
28294 @item *[@var{spec_name}]:
28295 This tells the compiler to create, override or delete the named spec
28296 string.  All lines after this directive up to the next directive or
28297 blank line are considered to be the text for the spec string.  If this
28298 results in an empty string then the spec is deleted.  (Or, if the
28299 spec did not exist, then nothing happens.)  Otherwise, if the spec
28300 does not currently exist a new spec is created.  If the spec does
28301 exist then its contents are overridden by the text of this
28302 directive, unless the first character of that text is the @samp{+}
28303 character, in which case the text is appended to the spec.
28305 @item [@var{suffix}]:
28306 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28307 and up to the next directive or blank line are considered to make up the
28308 spec string for the indicated suffix.  When the compiler encounters an
28309 input file with the named suffix, it processes the spec string in
28310 order to work out how to compile that file.  For example:
28312 @smallexample
28313 .ZZ:
28314 z-compile -input %i
28315 @end smallexample
28317 This says that any input file whose name ends in @samp{.ZZ} should be
28318 passed to the program @samp{z-compile}, which should be invoked with the
28319 command-line switch @option{-input} and with the result of performing the
28320 @samp{%i} substitution.  (See below.)
28322 As an alternative to providing a spec string, the text following a
28323 suffix directive can be one of the following:
28325 @table @code
28326 @item @@@var{language}
28327 This says that the suffix is an alias for a known @var{language}.  This is
28328 similar to using the @option{-x} command-line switch to GCC to specify a
28329 language explicitly.  For example:
28331 @smallexample
28332 .ZZ:
28333 @@c++
28334 @end smallexample
28336 Says that .ZZ files are, in fact, C++ source files.
28338 @item #@var{name}
28339 This causes an error messages saying:
28341 @smallexample
28342 @var{name} compiler not installed on this system.
28343 @end smallexample
28344 @end table
28346 GCC already has an extensive list of suffixes built into it.
28347 This directive adds an entry to the end of the list of suffixes, but
28348 since the list is searched from the end backwards, it is effectively
28349 possible to override earlier entries using this technique.
28351 @end table
28353 GCC has the following spec strings built into it.  Spec files can
28354 override these strings or create their own.  Note that individual
28355 targets can also add their own spec strings to this list.
28357 @smallexample
28358 asm          Options to pass to the assembler
28359 asm_final    Options to pass to the assembler post-processor
28360 cpp          Options to pass to the C preprocessor
28361 cc1          Options to pass to the C compiler
28362 cc1plus      Options to pass to the C++ compiler
28363 endfile      Object files to include at the end of the link
28364 link         Options to pass to the linker
28365 lib          Libraries to include on the command line to the linker
28366 libgcc       Decides which GCC support library to pass to the linker
28367 linker       Sets the name of the linker
28368 predefines   Defines to be passed to the C preprocessor
28369 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28370              by default
28371 startfile    Object files to include at the start of the link
28372 @end smallexample
28374 Here is a small example of a spec file:
28376 @smallexample
28377 %rename lib                 old_lib
28379 *lib:
28380 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28381 @end smallexample
28383 This example renames the spec called @samp{lib} to @samp{old_lib} and
28384 then overrides the previous definition of @samp{lib} with a new one.
28385 The new definition adds in some extra command-line options before
28386 including the text of the old definition.
28388 @dfn{Spec strings} are a list of command-line options to be passed to their
28389 corresponding program.  In addition, the spec strings can contain
28390 @samp{%}-prefixed sequences to substitute variable text or to
28391 conditionally insert text into the command line.  Using these constructs
28392 it is possible to generate quite complex command lines.
28394 Here is a table of all defined @samp{%}-sequences for spec
28395 strings.  Note that spaces are not generated automatically around the
28396 results of expanding these sequences.  Therefore you can concatenate them
28397 together or combine them with constant text in a single argument.
28399 @table @code
28400 @item %%
28401 Substitute one @samp{%} into the program name or argument.
28403 @item %i
28404 Substitute the name of the input file being processed.
28406 @item %b
28407 Substitute the basename of the input file being processed.
28408 This is the substring up to (and not including) the last period
28409 and not including the directory.
28411 @item %B
28412 This is the same as @samp{%b}, but include the file suffix (text after
28413 the last period).
28415 @item %d
28416 Marks the argument containing or following the @samp{%d} as a
28417 temporary file name, so that that file is deleted if GCC exits
28418 successfully.  Unlike @samp{%g}, this contributes no text to the
28419 argument.
28421 @item %g@var{suffix}
28422 Substitute a file name that has suffix @var{suffix} and is chosen
28423 once per compilation, and mark the argument in the same way as
28424 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28425 name is now chosen in a way that is hard to predict even when previously
28426 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28427 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28428 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28429 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28430 was simply substituted with a file name chosen once per compilation,
28431 without regard to any appended suffix (which was therefore treated
28432 just like ordinary text), making such attacks more likely to succeed.
28434 @item %u@var{suffix}
28435 Like @samp{%g}, but generates a new temporary file name
28436 each time it appears instead of once per compilation.
28438 @item %U@var{suffix}
28439 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28440 new one if there is no such last file name.  In the absence of any
28441 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28442 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28443 involves the generation of two distinct file names, one
28444 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28445 simply substituted with a file name chosen for the previous @samp{%u},
28446 without regard to any appended suffix.
28448 @item %j@var{suffix}
28449 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28450 writable, and if @option{-save-temps} is not used; 
28451 otherwise, substitute the name
28452 of a temporary file, just like @samp{%u}.  This temporary file is not
28453 meant for communication between processes, but rather as a junk
28454 disposal mechanism.
28456 @item %|@var{suffix}
28457 @itemx %m@var{suffix}
28458 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28459 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28460 all.  These are the two most common ways to instruct a program that it
28461 should read from standard input or write to standard output.  If you
28462 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28463 construct: see for example @file{f/lang-specs.h}.
28465 @item %.@var{SUFFIX}
28466 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28467 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28468 terminated by the next space or %.
28470 @item %w
28471 Marks the argument containing or following the @samp{%w} as the
28472 designated output file of this compilation.  This puts the argument
28473 into the sequence of arguments that @samp{%o} substitutes.
28475 @item %o
28476 Substitutes the names of all the output files, with spaces
28477 automatically placed around them.  You should write spaces
28478 around the @samp{%o} as well or the results are undefined.
28479 @samp{%o} is for use in the specs for running the linker.
28480 Input files whose names have no recognized suffix are not compiled
28481 at all, but they are included among the output files, so they are
28482 linked.
28484 @item %O
28485 Substitutes the suffix for object files.  Note that this is
28486 handled specially when it immediately follows @samp{%g, %u, or %U},
28487 because of the need for those to form complete file names.  The
28488 handling is such that @samp{%O} is treated exactly as if it had already
28489 been substituted, except that @samp{%g, %u, and %U} do not currently
28490 support additional @var{suffix} characters following @samp{%O} as they do
28491 following, for example, @samp{.o}.
28493 @item %p
28494 Substitutes the standard macro predefinitions for the
28495 current target machine.  Use this when running @command{cpp}.
28497 @item %P
28498 Like @samp{%p}, but puts @samp{__} before and after the name of each
28499 predefined macro, except for macros that start with @samp{__} or with
28500 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28503 @item %I
28504 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28505 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28506 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28507 and @option{-imultilib} as necessary.
28509 @item %s
28510 Current argument is the name of a library or startup file of some sort.
28511 Search for that file in a standard list of directories and substitute
28512 the full name found.  The current working directory is included in the
28513 list of directories scanned.
28515 @item %T
28516 Current argument is the name of a linker script.  Search for that file
28517 in the current list of directories to scan for libraries. If the file
28518 is located insert a @option{--script} option into the command line
28519 followed by the full path name found.  If the file is not found then
28520 generate an error message.  Note: the current working directory is not
28521 searched.
28523 @item %e@var{str}
28524 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28525 Use this when inconsistent options are detected.
28527 @item %(@var{name})
28528 Substitute the contents of spec string @var{name} at this point.
28530 @item %x@{@var{option}@}
28531 Accumulate an option for @samp{%X}.
28533 @item %X
28534 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28535 spec string.
28537 @item %Y
28538 Output the accumulated assembler options specified by @option{-Wa}.
28540 @item %Z
28541 Output the accumulated preprocessor options specified by @option{-Wp}.
28543 @item %a
28544 Process the @code{asm} spec.  This is used to compute the
28545 switches to be passed to the assembler.
28547 @item %A
28548 Process the @code{asm_final} spec.  This is a spec string for
28549 passing switches to an assembler post-processor, if such a program is
28550 needed.
28552 @item %l
28553 Process the @code{link} spec.  This is the spec for computing the
28554 command line passed to the linker.  Typically it makes use of the
28555 @samp{%L %G %S %D and %E} sequences.
28557 @item %D
28558 Dump out a @option{-L} option for each directory that GCC believes might
28559 contain startup files.  If the target supports multilibs then the
28560 current multilib directory is prepended to each of these paths.
28562 @item %L
28563 Process the @code{lib} spec.  This is a spec string for deciding which
28564 libraries are included on the command line to the linker.
28566 @item %G
28567 Process the @code{libgcc} spec.  This is a spec string for deciding
28568 which GCC support library is included on the command line to the linker.
28570 @item %S
28571 Process the @code{startfile} spec.  This is a spec for deciding which
28572 object files are the first ones passed to the linker.  Typically
28573 this might be a file named @file{crt0.o}.
28575 @item %E
28576 Process the @code{endfile} spec.  This is a spec string that specifies
28577 the last object files that are passed to the linker.
28579 @item %C
28580 Process the @code{cpp} spec.  This is used to construct the arguments
28581 to be passed to the C preprocessor.
28583 @item %1
28584 Process the @code{cc1} spec.  This is used to construct the options to be
28585 passed to the actual C compiler (@command{cc1}).
28587 @item %2
28588 Process the @code{cc1plus} spec.  This is used to construct the options to be
28589 passed to the actual C++ compiler (@command{cc1plus}).
28591 @item %*
28592 Substitute the variable part of a matched option.  See below.
28593 Note that each comma in the substituted string is replaced by
28594 a single space.
28596 @item %<S
28597 Remove all occurrences of @code{-S} from the command line.  Note---this
28598 command is position dependent.  @samp{%} commands in the spec string
28599 before this one see @code{-S}, @samp{%} commands in the spec string
28600 after this one do not.
28602 @item %:@var{function}(@var{args})
28603 Call the named function @var{function}, passing it @var{args}.
28604 @var{args} is first processed as a nested spec string, then split
28605 into an argument vector in the usual fashion.  The function returns
28606 a string which is processed as if it had appeared literally as part
28607 of the current spec.
28609 The following built-in spec functions are provided:
28611 @table @code
28612 @item @code{getenv}
28613 The @code{getenv} spec function takes two arguments: an environment
28614 variable name and a string.  If the environment variable is not
28615 defined, a fatal error is issued.  Otherwise, the return value is the
28616 value of the environment variable concatenated with the string.  For
28617 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28619 @smallexample
28620 %:getenv(TOPDIR /include)
28621 @end smallexample
28623 expands to @file{/path/to/top/include}.
28625 @item @code{if-exists}
28626 The @code{if-exists} spec function takes one argument, an absolute
28627 pathname to a file.  If the file exists, @code{if-exists} returns the
28628 pathname.  Here is a small example of its usage:
28630 @smallexample
28631 *startfile:
28632 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28633 @end smallexample
28635 @item @code{if-exists-else}
28636 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28637 spec function, except that it takes two arguments.  The first argument is
28638 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28639 returns the pathname.  If it does not exist, it returns the second argument.
28640 This way, @code{if-exists-else} can be used to select one file or another,
28641 based on the existence of the first.  Here is a small example of its usage:
28643 @smallexample
28644 *startfile:
28645 crt0%O%s %:if-exists(crti%O%s) \
28646 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28647 @end smallexample
28649 @item @code{replace-outfile}
28650 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28651 first argument in the outfiles array and replaces it with the second argument.  Here
28652 is a small example of its usage:
28654 @smallexample
28655 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28656 @end smallexample
28658 @item @code{remove-outfile}
28659 The @code{remove-outfile} spec function takes one argument.  It looks for the
28660 first argument in the outfiles array and removes it.  Here is a small example
28661 its usage:
28663 @smallexample
28664 %:remove-outfile(-lm)
28665 @end smallexample
28667 @item @code{pass-through-libs}
28668 The @code{pass-through-libs} spec function takes any number of arguments.  It
28669 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28670 assumes are the names of linker input library archive files) and returns a
28671 result containing all the found arguments each prepended by
28672 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28673 intended to be passed to the LTO linker plugin.
28675 @smallexample
28676 %:pass-through-libs(%G %L %G)
28677 @end smallexample
28679 @item @code{print-asm-header}
28680 The @code{print-asm-header} function takes no arguments and simply
28681 prints a banner like:
28683 @smallexample
28684 Assembler options
28685 =================
28687 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28688 @end smallexample
28690 It is used to separate compiler options from assembler options
28691 in the @option{--target-help} output.
28692 @end table
28694 @item %@{S@}
28695 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28696 If that switch is not specified, this substitutes nothing.  Note that
28697 the leading dash is omitted when specifying this option, and it is
28698 automatically inserted if the substitution is performed.  Thus the spec
28699 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28700 and outputs the command-line option @option{-foo}.
28702 @item %W@{S@}
28703 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28704 deleted on failure.
28706 @item %@{S*@}
28707 Substitutes all the switches specified to GCC whose names start
28708 with @code{-S}, but which also take an argument.  This is used for
28709 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28710 GCC considers @option{-o foo} as being
28711 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28712 text, including the space.  Thus two arguments are generated.
28714 @item %@{S*&T*@}
28715 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28716 (the order of @code{S} and @code{T} in the spec is not significant).
28717 There can be any number of ampersand-separated variables; for each the
28718 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28720 @item %@{S:X@}
28721 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28723 @item %@{!S:X@}
28724 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28726 @item %@{S*:X@}
28727 Substitutes @code{X} if one or more switches whose names start with
28728 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28729 once, no matter how many such switches appeared.  However, if @code{%*}
28730 appears somewhere in @code{X}, then @code{X} is substituted once
28731 for each matching switch, with the @code{%*} replaced by the part of
28732 that switch matching the @code{*}.
28734 If @code{%*} appears as the last part of a spec sequence then a space
28735 is added after the end of the last substitution.  If there is more
28736 text in the sequence, however, then a space is not generated.  This
28737 allows the @code{%*} substitution to be used as part of a larger
28738 string.  For example, a spec string like this:
28740 @smallexample
28741 %@{mcu=*:--script=%*/memory.ld@}
28742 @end smallexample
28744 @noindent
28745 when matching an option like @option{-mcu=newchip} produces:
28747 @smallexample
28748 --script=newchip/memory.ld
28749 @end smallexample
28751 @item %@{.S:X@}
28752 Substitutes @code{X}, if processing a file with suffix @code{S}.
28754 @item %@{!.S:X@}
28755 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28757 @item %@{,S:X@}
28758 Substitutes @code{X}, if processing a file for language @code{S}.
28760 @item %@{!,S:X@}
28761 Substitutes @code{X}, if not processing a file for language @code{S}.
28763 @item %@{S|P:X@}
28764 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28765 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28766 @code{*} sequences as well, although they have a stronger binding than
28767 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28768 alternatives must be starred, and only the first matching alternative
28769 is substituted.
28771 For example, a spec string like this:
28773 @smallexample
28774 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28775 @end smallexample
28777 @noindent
28778 outputs the following command-line options from the following input
28779 command-line options:
28781 @smallexample
28782 fred.c        -foo -baz
28783 jim.d         -bar -boggle
28784 -d fred.c     -foo -baz -boggle
28785 -d jim.d      -bar -baz -boggle
28786 @end smallexample
28788 @item %@{S:X; T:Y; :D@}
28790 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28791 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28792 be as many clauses as you need.  This may be combined with @code{.},
28793 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28796 @end table
28798 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28799 or similar construct can use a backslash to ignore the special meaning
28800 of the character following it, thus allowing literal matching of a
28801 character that is otherwise specially treated.  For example,
28802 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28803 @option{-std=iso9899:1999} option is given.
28805 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28806 construct may contain other nested @samp{%} constructs or spaces, or
28807 even newlines.  They are processed as usual, as described above.
28808 Trailing white space in @code{X} is ignored.  White space may also
28809 appear anywhere on the left side of the colon in these constructs,
28810 except between @code{.} or @code{*} and the corresponding word.
28812 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28813 handled specifically in these constructs.  If another value of
28814 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28815 @option{-W} switch is found later in the command line, the earlier
28816 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28817 just one letter, which passes all matching options.
28819 The character @samp{|} at the beginning of the predicate text is used to
28820 indicate that a command should be piped to the following command, but
28821 only if @option{-pipe} is specified.
28823 It is built into GCC which switches take arguments and which do not.
28824 (You might think it would be useful to generalize this to allow each
28825 compiler's spec to say which switches take arguments.  But this cannot
28826 be done in a consistent fashion.  GCC cannot even decide which input
28827 files have been specified without knowing which switches take arguments,
28828 and it must know which input files to compile in order to tell which
28829 compilers to run).
28831 GCC also knows implicitly that arguments starting in @option{-l} are to be
28832 treated as compiler output files, and passed to the linker in their
28833 proper position among the other output files.
28835 @node Environment Variables
28836 @section Environment Variables Affecting GCC
28837 @cindex environment variables
28839 @c man begin ENVIRONMENT
28840 This section describes several environment variables that affect how GCC
28841 operates.  Some of them work by specifying directories or prefixes to use
28842 when searching for various kinds of files.  Some are used to specify other
28843 aspects of the compilation environment.
28845 Note that you can also specify places to search using options such as
28846 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28847 take precedence over places specified using environment variables, which
28848 in turn take precedence over those specified by the configuration of GCC@.
28849 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28850 GNU Compiler Collection (GCC) Internals}.
28852 @table @env
28853 @item LANG
28854 @itemx LC_CTYPE
28855 @c @itemx LC_COLLATE
28856 @itemx LC_MESSAGES
28857 @c @itemx LC_MONETARY
28858 @c @itemx LC_NUMERIC
28859 @c @itemx LC_TIME
28860 @itemx LC_ALL
28861 @findex LANG
28862 @findex LC_CTYPE
28863 @c @findex LC_COLLATE
28864 @findex LC_MESSAGES
28865 @c @findex LC_MONETARY
28866 @c @findex LC_NUMERIC
28867 @c @findex LC_TIME
28868 @findex LC_ALL
28869 @cindex locale
28870 These environment variables control the way that GCC uses
28871 localization information which allows GCC to work with different
28872 national conventions.  GCC inspects the locale categories
28873 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28874 so.  These locale categories can be set to any value supported by your
28875 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28876 Kingdom encoded in UTF-8.
28878 The @env{LC_CTYPE} environment variable specifies character
28879 classification.  GCC uses it to determine the character boundaries in
28880 a string; this is needed for some multibyte encodings that contain quote
28881 and escape characters that are otherwise interpreted as a string
28882 end or escape.
28884 The @env{LC_MESSAGES} environment variable specifies the language to
28885 use in diagnostic messages.
28887 If the @env{LC_ALL} environment variable is set, it overrides the value
28888 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28889 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28890 environment variable.  If none of these variables are set, GCC
28891 defaults to traditional C English behavior.
28893 @item TMPDIR
28894 @findex TMPDIR
28895 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28896 files.  GCC uses temporary files to hold the output of one stage of
28897 compilation which is to be used as input to the next stage: for example,
28898 the output of the preprocessor, which is the input to the compiler
28899 proper.
28901 @item GCC_COMPARE_DEBUG
28902 @findex GCC_COMPARE_DEBUG
28903 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28904 @option{-fcompare-debug} to the compiler driver.  See the documentation
28905 of this option for more details.
28907 @item GCC_EXEC_PREFIX
28908 @findex GCC_EXEC_PREFIX
28909 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28910 names of the subprograms executed by the compiler.  No slash is added
28911 when this prefix is combined with the name of a subprogram, but you can
28912 specify a prefix that ends with a slash if you wish.
28914 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28915 an appropriate prefix to use based on the pathname it is invoked with.
28917 If GCC cannot find the subprogram using the specified prefix, it
28918 tries looking in the usual places for the subprogram.
28920 The default value of @env{GCC_EXEC_PREFIX} is
28921 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28922 the installed compiler. In many cases @var{prefix} is the value
28923 of @code{prefix} when you ran the @file{configure} script.
28925 Other prefixes specified with @option{-B} take precedence over this prefix.
28927 This prefix is also used for finding files such as @file{crt0.o} that are
28928 used for linking.
28930 In addition, the prefix is used in an unusual way in finding the
28931 directories to search for header files.  For each of the standard
28932 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28933 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28934 replacing that beginning with the specified prefix to produce an
28935 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28936 @file{foo/bar} just before it searches the standard directory 
28937 @file{/usr/local/lib/bar}.
28938 If a standard directory begins with the configured
28939 @var{prefix} then the value of @var{prefix} is replaced by
28940 @env{GCC_EXEC_PREFIX} when looking for header files.
28942 @item COMPILER_PATH
28943 @findex COMPILER_PATH
28944 The value of @env{COMPILER_PATH} is a colon-separated list of
28945 directories, much like @env{PATH}.  GCC tries the directories thus
28946 specified when searching for subprograms, if it cannot find the
28947 subprograms using @env{GCC_EXEC_PREFIX}.
28949 @item LIBRARY_PATH
28950 @findex LIBRARY_PATH
28951 The value of @env{LIBRARY_PATH} is a colon-separated list of
28952 directories, much like @env{PATH}.  When configured as a native compiler,
28953 GCC tries the directories thus specified when searching for special
28954 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28955 using GCC also uses these directories when searching for ordinary
28956 libraries for the @option{-l} option (but directories specified with
28957 @option{-L} come first).
28959 @item LANG
28960 @findex LANG
28961 @cindex locale definition
28962 This variable is used to pass locale information to the compiler.  One way in
28963 which this information is used is to determine the character set to be used
28964 when character literals, string literals and comments are parsed in C and C++.
28965 When the compiler is configured to allow multibyte characters,
28966 the following values for @env{LANG} are recognized:
28968 @table @samp
28969 @item C-JIS
28970 Recognize JIS characters.
28971 @item C-SJIS
28972 Recognize SJIS characters.
28973 @item C-EUCJP
28974 Recognize EUCJP characters.
28975 @end table
28977 If @env{LANG} is not defined, or if it has some other value, then the
28978 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28979 recognize and translate multibyte characters.
28980 @end table
28982 @noindent
28983 Some additional environment variables affect the behavior of the
28984 preprocessor.
28986 @include cppenv.texi
28988 @c man end
28990 @node Precompiled Headers
28991 @section Using Precompiled Headers
28992 @cindex precompiled headers
28993 @cindex speed of compilation
28995 Often large projects have many header files that are included in every
28996 source file.  The time the compiler takes to process these header files
28997 over and over again can account for nearly all of the time required to
28998 build the project.  To make builds faster, GCC allows you to
28999 @dfn{precompile} a header file.
29001 To create a precompiled header file, simply compile it as you would any
29002 other file, if necessary using the @option{-x} option to make the driver
29003 treat it as a C or C++ header file.  You may want to use a
29004 tool like @command{make} to keep the precompiled header up-to-date when
29005 the headers it contains change.
29007 A precompiled header file is searched for when @code{#include} is
29008 seen in the compilation.  As it searches for the included file
29009 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
29010 compiler looks for a precompiled header in each directory just before it
29011 looks for the include file in that directory.  The name searched for is
29012 the name specified in the @code{#include} with @samp{.gch} appended.  If
29013 the precompiled header file cannot be used, it is ignored.
29015 For instance, if you have @code{#include "all.h"}, and you have
29016 @file{all.h.gch} in the same directory as @file{all.h}, then the
29017 precompiled header file is used if possible, and the original
29018 header is used otherwise.
29020 Alternatively, you might decide to put the precompiled header file in a
29021 directory and use @option{-I} to ensure that directory is searched
29022 before (or instead of) the directory containing the original header.
29023 Then, if you want to check that the precompiled header file is always
29024 used, you can put a file of the same name as the original header in this
29025 directory containing an @code{#error} command.
29027 This also works with @option{-include}.  So yet another way to use
29028 precompiled headers, good for projects not designed with precompiled
29029 header files in mind, is to simply take most of the header files used by
29030 a project, include them from another header file, precompile that header
29031 file, and @option{-include} the precompiled header.  If the header files
29032 have guards against multiple inclusion, they are skipped because
29033 they've already been included (in the precompiled header).
29035 If you need to precompile the same header file for different
29036 languages, targets, or compiler options, you can instead make a
29037 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29038 header in the directory, perhaps using @option{-o}.  It doesn't matter
29039 what you call the files in the directory; every precompiled header in
29040 the directory is considered.  The first precompiled header
29041 encountered in the directory that is valid for this compilation is
29042 used; they're searched in no particular order.
29044 There are many other possibilities, limited only by your imagination,
29045 good sense, and the constraints of your build system.
29047 A precompiled header file can be used only when these conditions apply:
29049 @itemize
29050 @item
29051 Only one precompiled header can be used in a particular compilation.
29053 @item
29054 A precompiled header cannot be used once the first C token is seen.  You
29055 can have preprocessor directives before a precompiled header; you cannot
29056 include a precompiled header from inside another header.
29058 @item
29059 The precompiled header file must be produced for the same language as
29060 the current compilation.  You cannot use a C precompiled header for a C++
29061 compilation.
29063 @item
29064 The precompiled header file must have been produced by the same compiler
29065 binary as the current compilation is using.
29067 @item
29068 Any macros defined before the precompiled header is included must
29069 either be defined in the same way as when the precompiled header was
29070 generated, or must not affect the precompiled header, which usually
29071 means that they don't appear in the precompiled header at all.
29073 The @option{-D} option is one way to define a macro before a
29074 precompiled header is included; using a @code{#define} can also do it.
29075 There are also some options that define macros implicitly, like
29076 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29077 defined this way.
29079 @item If debugging information is output when using the precompiled
29080 header, using @option{-g} or similar, the same kind of debugging information
29081 must have been output when building the precompiled header.  However,
29082 a precompiled header built using @option{-g} can be used in a compilation
29083 when no debugging information is being output.
29085 @item The same @option{-m} options must generally be used when building
29086 and using the precompiled header.  @xref{Submodel Options},
29087 for any cases where this rule is relaxed.
29089 @item Each of the following options must be the same when building and using
29090 the precompiled header:
29092 @gccoptlist{-fexceptions}
29094 @item
29095 Some other command-line options starting with @option{-f},
29096 @option{-p}, or @option{-O} must be defined in the same way as when
29097 the precompiled header was generated.  At present, it's not clear
29098 which options are safe to change and which are not; the safest choice
29099 is to use exactly the same options when generating and using the
29100 precompiled header.  The following are known to be safe:
29102 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29103 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29104 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29105 -pedantic-errors}
29107 @end itemize
29109 For all of these except the last, the compiler automatically
29110 ignores the precompiled header if the conditions aren't met.  If you
29111 find an option combination that doesn't work and doesn't cause the
29112 precompiled header to be ignored, please consider filing a bug report,
29113 see @ref{Bugs}.
29115 If you do use differing options when generating and using the
29116 precompiled header, the actual behavior is a mixture of the
29117 behavior for the options.  For instance, if you use @option{-g} to
29118 generate the precompiled header but not when using it, you may or may
29119 not get debugging information for routines in the precompiled header.