PR inline-asm/84742
[official-gcc.git] / gcc / doc / invoke.texi
blob2492148b30f2d5c5c7ab4e2131e71506546910ad
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}
1047 @emph{RL78 Options}
1048 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1049 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1050 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1052 @emph{RS/6000 and PowerPC Options}
1053 @gccoptlist{-mcpu=@var{cpu-type} @gol
1054 -mtune=@var{cpu-type} @gol
1055 -mcmodel=@var{code-model} @gol
1056 -mpowerpc64 @gol
1057 -maltivec  -mno-altivec @gol
1058 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1059 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1060 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1061 -mfprnd  -mno-fprnd @gol
1062 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1063 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1064 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1065 -malign-power  -malign-natural @gol
1066 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1067 -msingle-float  -mdouble-float  -msimple-fpu @gol
1068 -mupdate  -mno-update @gol
1069 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1070 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1071 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1072 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1073 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1074 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1075 -mprioritize-restricted-insns=@var{priority} @gol
1076 -msched-costly-dep=@var{dependence_type} @gol
1077 -minsert-sched-nops=@var{scheme} @gol
1078 -mcall-sysv  -mcall-netbsd @gol
1079 -maix-struct-return  -msvr4-struct-return @gol
1080 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1081 -mblock-move-inline-limit=@var{num} @gol
1082 -misel  -mno-isel @gol
1083 -misel=yes  -misel=no @gol
1084 -mpaired @gol
1085 -mvrsave  -mno-vrsave @gol
1086 -mmulhw  -mno-mulhw @gol
1087 -mdlmzb  -mno-dlmzb @gol
1088 -mprototype  -mno-prototype @gol
1089 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1090 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1091 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1092 -mno-recip-precision @gol
1093 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1094 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1095 -msave-toc-indirect  -mno-save-toc-indirect @gol
1096 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1097 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1098 -mquad-memory  -mno-quad-memory @gol
1099 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1100 -mcompat-align-parm  -mno-compat-align-parm @gol
1101 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1102 -mgnu-attribute  -mno-gnu-attribute @gol
1103 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1104 -mstack-protector-guard-offset=@var{offset}}
1106 @emph{RX Options}
1107 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1108 -mcpu=@gol
1109 -mbig-endian-data  -mlittle-endian-data @gol
1110 -msmall-data @gol
1111 -msim  -mno-sim@gol
1112 -mas100-syntax  -mno-as100-syntax@gol
1113 -mrelax@gol
1114 -mmax-constant-size=@gol
1115 -mint-register=@gol
1116 -mpid@gol
1117 -mallow-string-insns  -mno-allow-string-insns@gol
1118 -mjsr@gol
1119 -mno-warn-multiple-fast-interrupts@gol
1120 -msave-acc-in-interrupts}
1122 @emph{S/390 and zSeries Options}
1123 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1124 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1125 -mlong-double-64  -mlong-double-128 @gol
1126 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1127 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1128 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1129 -mhtm  -mvx  -mzvector @gol
1130 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1131 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1132 -mhotpatch=@var{halfwords},@var{halfwords}}
1134 @emph{Score Options}
1135 @gccoptlist{-meb  -mel @gol
1136 -mnhwloop @gol
1137 -muls @gol
1138 -mmac @gol
1139 -mscore5  -mscore5u  -mscore7  -mscore7d}
1141 @emph{SH Options}
1142 @gccoptlist{-m1  -m2  -m2e @gol
1143 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1144 -m3  -m3e @gol
1145 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1146 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1147 -mb  -ml  -mdalign  -mrelax @gol
1148 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1149 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1150 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1151 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1152 -maccumulate-outgoing-args @gol
1153 -matomic-model=@var{atomic-model} @gol
1154 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1155 -mcbranch-force-delay-slot @gol
1156 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1157 -mpretend-cmove  -mtas}
1159 @emph{Solaris 2 Options}
1160 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1161 -pthreads}
1163 @emph{SPARC Options}
1164 @gccoptlist{-mcpu=@var{cpu-type} @gol
1165 -mtune=@var{cpu-type} @gol
1166 -mcmodel=@var{code-model} @gol
1167 -mmemory-model=@var{mem-model} @gol
1168 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1169 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1170 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1171 -mhard-quad-float  -msoft-quad-float @gol
1172 -mstack-bias  -mno-stack-bias @gol
1173 -mstd-struct-return  -mno-std-struct-return @gol
1174 -munaligned-doubles  -mno-unaligned-doubles @gol
1175 -muser-mode  -mno-user-mode @gol
1176 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1177 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1178 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1179 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1180 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1181 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1182 -mlra  -mno-lra}
1184 @emph{SPU Options}
1185 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1186 -msafe-dma  -munsafe-dma @gol
1187 -mbranch-hints @gol
1188 -msmall-mem  -mlarge-mem  -mstdmain @gol
1189 -mfixed-range=@var{register-range} @gol
1190 -mea32  -mea64 @gol
1191 -maddress-space-conversion  -mno-address-space-conversion @gol
1192 -mcache-size=@var{cache-size} @gol
1193 -matomic-updates  -mno-atomic-updates}
1195 @emph{System V Options}
1196 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1198 @emph{TILE-Gx Options}
1199 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1200 -mcmodel=@var{code-model}}
1202 @emph{TILEPro Options}
1203 @gccoptlist{-mcpu=@var{cpu}  -m32}
1205 @emph{V850 Options}
1206 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1207 -mprolog-function  -mno-prolog-function  -mspace @gol
1208 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1209 -mapp-regs  -mno-app-regs @gol
1210 -mdisable-callt  -mno-disable-callt @gol
1211 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1212 -mv850e  -mv850  -mv850e3v5 @gol
1213 -mloop @gol
1214 -mrelax @gol
1215 -mlong-jumps @gol
1216 -msoft-float @gol
1217 -mhard-float @gol
1218 -mgcc-abi @gol
1219 -mrh850-abi @gol
1220 -mbig-switch}
1222 @emph{VAX Options}
1223 @gccoptlist{-mg  -mgnu  -munix}
1225 @emph{Visium Options}
1226 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1227 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1229 @emph{VMS Options}
1230 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1231 -mpointer-size=@var{size}}
1233 @emph{VxWorks Options}
1234 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1235 -Xbind-lazy  -Xbind-now}
1237 @emph{x86 Options}
1238 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1239 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1240 -mfpmath=@var{unit} @gol
1241 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1242 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1243 -mno-wide-multiply  -mrtd  -malign-double @gol
1244 -mpreferred-stack-boundary=@var{num} @gol
1245 -mincoming-stack-boundary=@var{num} @gol
1246 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1247 -mrecip  -mrecip=@var{opt} @gol
1248 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1249 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1250 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1251 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1252 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1253 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1254 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1255 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1256 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1257 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1258 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1259 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1260 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1261 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1262 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1263 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1264 -mregparm=@var{num}  -msseregparm @gol
1265 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1266 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1267 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1268 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1269 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1270 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1271 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1272 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1273 -mstack-protector-guard-reg=@var{reg} @gol
1274 -mstack-protector-guard-offset=@var{offset} @gol
1275 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1276 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1277 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1278 -mindirect-branch-register}
1280 @emph{x86 Windows Options}
1281 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1282 -mnop-fun-dllimport  -mthread @gol
1283 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1285 @emph{Xstormy16 Options}
1286 @gccoptlist{-msim}
1288 @emph{Xtensa Options}
1289 @gccoptlist{-mconst16  -mno-const16 @gol
1290 -mfused-madd  -mno-fused-madd @gol
1291 -mforce-no-pic @gol
1292 -mserialize-volatile  -mno-serialize-volatile @gol
1293 -mtext-section-literals  -mno-text-section-literals @gol
1294 -mauto-litpools  -mno-auto-litpools @gol
1295 -mtarget-align  -mno-target-align @gol
1296 -mlongcalls  -mno-longcalls}
1298 @emph{zSeries Options}
1299 See S/390 and zSeries Options.
1300 @end table
1303 @node Overall Options
1304 @section Options Controlling the Kind of Output
1306 Compilation can involve up to four stages: preprocessing, compilation
1307 proper, assembly and linking, always in that order.  GCC is capable of
1308 preprocessing and compiling several files either into several
1309 assembler input files, or into one assembler input file; then each
1310 assembler input file produces an object file, and linking combines all
1311 the object files (those newly compiled, and those specified as input)
1312 into an executable file.
1314 @cindex file name suffix
1315 For any given input file, the file name suffix determines what kind of
1316 compilation is done:
1318 @table @gcctabopt
1319 @item @var{file}.c
1320 C source code that must be preprocessed.
1322 @item @var{file}.i
1323 C source code that should not be preprocessed.
1325 @item @var{file}.ii
1326 C++ source code that should not be preprocessed.
1328 @item @var{file}.m
1329 Objective-C source code.  Note that you must link with the @file{libobjc}
1330 library to make an Objective-C program work.
1332 @item @var{file}.mi
1333 Objective-C source code that should not be preprocessed.
1335 @item @var{file}.mm
1336 @itemx @var{file}.M
1337 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1338 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1339 to a literal capital M@.
1341 @item @var{file}.mii
1342 Objective-C++ source code that should not be preprocessed.
1344 @item @var{file}.h
1345 C, C++, Objective-C or Objective-C++ header file to be turned into a
1346 precompiled header (default), or C, C++ header file to be turned into an
1347 Ada spec (via the @option{-fdump-ada-spec} switch).
1349 @item @var{file}.cc
1350 @itemx @var{file}.cp
1351 @itemx @var{file}.cxx
1352 @itemx @var{file}.cpp
1353 @itemx @var{file}.CPP
1354 @itemx @var{file}.c++
1355 @itemx @var{file}.C
1356 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1357 the last two letters must both be literally @samp{x}.  Likewise,
1358 @samp{.C} refers to a literal capital C@.
1360 @item @var{file}.mm
1361 @itemx @var{file}.M
1362 Objective-C++ source code that must be preprocessed.
1364 @item @var{file}.mii
1365 Objective-C++ source code that should not be preprocessed.
1367 @item @var{file}.hh
1368 @itemx @var{file}.H
1369 @itemx @var{file}.hp
1370 @itemx @var{file}.hxx
1371 @itemx @var{file}.hpp
1372 @itemx @var{file}.HPP
1373 @itemx @var{file}.h++
1374 @itemx @var{file}.tcc
1375 C++ header file to be turned into a precompiled header or Ada spec.
1377 @item @var{file}.f
1378 @itemx @var{file}.for
1379 @itemx @var{file}.ftn
1380 Fixed form Fortran source code that should not be preprocessed.
1382 @item @var{file}.F
1383 @itemx @var{file}.FOR
1384 @itemx @var{file}.fpp
1385 @itemx @var{file}.FPP
1386 @itemx @var{file}.FTN
1387 Fixed form Fortran source code that must be preprocessed (with the traditional
1388 preprocessor).
1390 @item @var{file}.f90
1391 @itemx @var{file}.f95
1392 @itemx @var{file}.f03
1393 @itemx @var{file}.f08
1394 Free form Fortran source code that should not be preprocessed.
1396 @item @var{file}.F90
1397 @itemx @var{file}.F95
1398 @itemx @var{file}.F03
1399 @itemx @var{file}.F08
1400 Free form Fortran source code that must be preprocessed (with the
1401 traditional preprocessor).
1403 @item @var{file}.go
1404 Go source code.
1406 @item @var{file}.brig
1407 BRIG files (binary representation of HSAIL).
1409 @item @var{file}.ads
1410 Ada source code file that contains a library unit declaration (a
1411 declaration of a package, subprogram, or generic, or a generic
1412 instantiation), or a library unit renaming declaration (a package,
1413 generic, or subprogram renaming declaration).  Such files are also
1414 called @dfn{specs}.
1416 @item @var{file}.adb
1417 Ada source code file containing a library unit body (a subprogram or
1418 package body).  Such files are also called @dfn{bodies}.
1420 @c GCC also knows about some suffixes for languages not yet included:
1421 @c Pascal:
1422 @c @var{file}.p
1423 @c @var{file}.pas
1424 @c Ratfor:
1425 @c @var{file}.r
1427 @item @var{file}.s
1428 Assembler code.
1430 @item @var{file}.S
1431 @itemx @var{file}.sx
1432 Assembler code that must be preprocessed.
1434 @item @var{other}
1435 An object file to be fed straight into linking.
1436 Any file name with no recognized suffix is treated this way.
1437 @end table
1439 @opindex x
1440 You can specify the input language explicitly with the @option{-x} option:
1442 @table @gcctabopt
1443 @item -x @var{language}
1444 Specify explicitly the @var{language} for the following input files
1445 (rather than letting the compiler choose a default based on the file
1446 name suffix).  This option applies to all following input files until
1447 the next @option{-x} option.  Possible values for @var{language} are:
1448 @smallexample
1449 c  c-header  cpp-output
1450 c++  c++-header  c++-cpp-output
1451 objective-c  objective-c-header  objective-c-cpp-output
1452 objective-c++ objective-c++-header objective-c++-cpp-output
1453 assembler  assembler-with-cpp
1455 f77  f77-cpp-input f95  f95-cpp-input
1457 brig
1458 @end smallexample
1460 @item -x none
1461 Turn off any specification of a language, so that subsequent files are
1462 handled according to their file name suffixes (as they are if @option{-x}
1463 has not been used at all).
1464 @end table
1466 If you only want some of the stages of compilation, you can use
1467 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1468 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1469 @command{gcc} is to stop.  Note that some combinations (for example,
1470 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1472 @table @gcctabopt
1473 @item -c
1474 @opindex c
1475 Compile or assemble the source files, but do not link.  The linking
1476 stage simply is not done.  The ultimate output is in the form of an
1477 object file for each source file.
1479 By default, the object file name for a source file is made by replacing
1480 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1482 Unrecognized input files, not requiring compilation or assembly, are
1483 ignored.
1485 @item -S
1486 @opindex S
1487 Stop after the stage of compilation proper; do not assemble.  The output
1488 is in the form of an assembler code file for each non-assembler input
1489 file specified.
1491 By default, the assembler file name for a source file is made by
1492 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1494 Input files that don't require compilation are ignored.
1496 @item -E
1497 @opindex E
1498 Stop after the preprocessing stage; do not run the compiler proper.  The
1499 output is in the form of preprocessed source code, which is sent to the
1500 standard output.
1502 Input files that don't require preprocessing are ignored.
1504 @cindex output file option
1505 @item -o @var{file}
1506 @opindex o
1507 Place output in file @var{file}.  This applies to whatever
1508 sort of output is being produced, whether it be an executable file,
1509 an object file, an assembler file or preprocessed C code.
1511 If @option{-o} is not specified, the default is to put an executable
1512 file in @file{a.out}, the object file for
1513 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1514 assembler file in @file{@var{source}.s}, a precompiled header file in
1515 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1516 standard output.
1518 @item -v
1519 @opindex v
1520 Print (on standard error output) the commands executed to run the stages
1521 of compilation.  Also print the version number of the compiler driver
1522 program and of the preprocessor and the compiler proper.
1524 @item -###
1525 @opindex ###
1526 Like @option{-v} except the commands are not executed and arguments
1527 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1528 This is useful for shell scripts to capture the driver-generated command lines.
1530 @item --help
1531 @opindex help
1532 Print (on the standard output) a description of the command-line options
1533 understood by @command{gcc}.  If the @option{-v} option is also specified
1534 then @option{--help} is also passed on to the various processes
1535 invoked by @command{gcc}, so that they can display the command-line options
1536 they accept.  If the @option{-Wextra} option has also been specified
1537 (prior to the @option{--help} option), then command-line options that
1538 have no documentation associated with them are also displayed.
1540 @item --target-help
1541 @opindex target-help
1542 Print (on the standard output) a description of target-specific command-line
1543 options for each tool.  For some targets extra target-specific
1544 information may also be printed.
1546 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1547 Print (on the standard output) a description of the command-line
1548 options understood by the compiler that fit into all specified classes
1549 and qualifiers.  These are the supported classes:
1551 @table @asis
1552 @item @samp{optimizers}
1553 Display all of the optimization options supported by the
1554 compiler.
1556 @item @samp{warnings}
1557 Display all of the options controlling warning messages
1558 produced by the compiler.
1560 @item @samp{target}
1561 Display target-specific options.  Unlike the
1562 @option{--target-help} option however, target-specific options of the
1563 linker and assembler are not displayed.  This is because those
1564 tools do not currently support the extended @option{--help=} syntax.
1566 @item @samp{params}
1567 Display the values recognized by the @option{--param}
1568 option.
1570 @item @var{language}
1571 Display the options supported for @var{language}, where
1572 @var{language} is the name of one of the languages supported in this
1573 version of GCC@.
1575 @item @samp{common}
1576 Display the options that are common to all languages.
1577 @end table
1579 These are the supported qualifiers:
1581 @table @asis
1582 @item @samp{undocumented}
1583 Display only those options that are undocumented.
1585 @item @samp{joined}
1586 Display options taking an argument that appears after an equal
1587 sign in the same continuous piece of text, such as:
1588 @samp{--help=target}.
1590 @item @samp{separate}
1591 Display options taking an argument that appears as a separate word
1592 following the original option, such as: @samp{-o output-file}.
1593 @end table
1595 Thus for example to display all the undocumented target-specific
1596 switches supported by the compiler, use:
1598 @smallexample
1599 --help=target,undocumented
1600 @end smallexample
1602 The sense of a qualifier can be inverted by prefixing it with the
1603 @samp{^} character, so for example to display all binary warning
1604 options (i.e., ones that are either on or off and that do not take an
1605 argument) that have a description, use:
1607 @smallexample
1608 --help=warnings,^joined,^undocumented
1609 @end smallexample
1611 The argument to @option{--help=} should not consist solely of inverted
1612 qualifiers.
1614 Combining several classes is possible, although this usually
1615 restricts the output so much that there is nothing to display.  One
1616 case where it does work, however, is when one of the classes is
1617 @var{target}.  For example, to display all the target-specific
1618 optimization options, use:
1620 @smallexample
1621 --help=target,optimizers
1622 @end smallexample
1624 The @option{--help=} option can be repeated on the command line.  Each
1625 successive use displays its requested class of options, skipping
1626 those that have already been displayed.
1628 If the @option{-Q} option appears on the command line before the
1629 @option{--help=} option, then the descriptive text displayed by
1630 @option{--help=} is changed.  Instead of describing the displayed
1631 options, an indication is given as to whether the option is enabled,
1632 disabled or set to a specific value (assuming that the compiler
1633 knows this at the point where the @option{--help=} option is used).
1635 Here is a truncated example from the ARM port of @command{gcc}:
1637 @smallexample
1638   % gcc -Q -mabi=2 --help=target -c
1639   The following options are target specific:
1640   -mabi=                                2
1641   -mabort-on-noreturn                   [disabled]
1642   -mapcs                                [disabled]
1643 @end smallexample
1645 The output is sensitive to the effects of previous command-line
1646 options, so for example it is possible to find out which optimizations
1647 are enabled at @option{-O2} by using:
1649 @smallexample
1650 -Q -O2 --help=optimizers
1651 @end smallexample
1653 Alternatively you can discover which binary optimizations are enabled
1654 by @option{-O3} by using:
1656 @smallexample
1657 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1658 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1659 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1660 @end smallexample
1662 @item --version
1663 @opindex version
1664 Display the version number and copyrights of the invoked GCC@.
1666 @item -pass-exit-codes
1667 @opindex pass-exit-codes
1668 Normally the @command{gcc} program exits with the code of 1 if any
1669 phase of the compiler returns a non-success return code.  If you specify
1670 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1671 the numerically highest error produced by any phase returning an error
1672 indication.  The C, C++, and Fortran front ends return 4 if an internal
1673 compiler error is encountered.
1675 @item -pipe
1676 @opindex pipe
1677 Use pipes rather than temporary files for communication between the
1678 various stages of compilation.  This fails to work on some systems where
1679 the assembler is unable to read from a pipe; but the GNU assembler has
1680 no trouble.
1682 @item -specs=@var{file}
1683 @opindex specs
1684 Process @var{file} after the compiler reads in the standard @file{specs}
1685 file, in order to override the defaults which the @command{gcc} driver
1686 program uses when determining what switches to pass to @command{cc1},
1687 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1688 @option{-specs=@var{file}} can be specified on the command line, and they
1689 are processed in order, from left to right.  @xref{Spec Files}, for
1690 information about the format of the @var{file}.
1692 @item -wrapper
1693 @opindex wrapper
1694 Invoke all subcommands under a wrapper program.  The name of the
1695 wrapper program and its parameters are passed as a comma separated
1696 list.
1698 @smallexample
1699 gcc -c t.c -wrapper gdb,--args
1700 @end smallexample
1702 @noindent
1703 This invokes all subprograms of @command{gcc} under
1704 @samp{gdb --args}, thus the invocation of @command{cc1} is
1705 @samp{gdb --args cc1 @dots{}}.
1707 @item -ffile-prefix-map=@var{old}=@var{new}
1708 @opindex ffile-prefix-map
1709 When compiling files residing in directory @file{@var{old}}, record
1710 any references to them in the result of the compilation as if the
1711 files resided in directory @file{@var{new}} instead.  Specifying this
1712 option is equivalent to specifying all the individual
1713 @option{-f*-prefix-map} options.  This can be used to make reproducible
1714 builds that are location independent.  See also
1715 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1717 @item -fplugin=@var{name}.so
1718 @opindex fplugin
1719 Load the plugin code in file @var{name}.so, assumed to be a
1720 shared object to be dlopen'd by the compiler.  The base name of
1721 the shared object file is used to identify the plugin for the
1722 purposes of argument parsing (See
1723 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1724 Each plugin should define the callback functions specified in the
1725 Plugins API.
1727 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1728 @opindex fplugin-arg
1729 Define an argument called @var{key} with a value of @var{value}
1730 for the plugin called @var{name}.
1732 @item -fdump-ada-spec@r{[}-slim@r{]}
1733 @opindex fdump-ada-spec
1734 For C and C++ source and include files, generate corresponding Ada specs.
1735 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1736 GNAT User's Guide}, which provides detailed documentation on this feature.
1738 @item -fada-spec-parent=@var{unit}
1739 @opindex fada-spec-parent
1740 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1741 Ada specs as child units of parent @var{unit}.
1743 @item -fdump-go-spec=@var{file}
1744 @opindex fdump-go-spec
1745 For input files in any language, generate corresponding Go
1746 declarations in @var{file}.  This generates Go @code{const},
1747 @code{type}, @code{var}, and @code{func} declarations which may be a
1748 useful way to start writing a Go interface to code written in some
1749 other language.
1751 @include @value{srcdir}/../libiberty/at-file.texi
1752 @end table
1754 @node Invoking G++
1755 @section Compiling C++ Programs
1757 @cindex suffixes for C++ source
1758 @cindex C++ source file suffixes
1759 C++ source files conventionally use one of the suffixes @samp{.C},
1760 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1761 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1762 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1763 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1764 files with these names and compiles them as C++ programs even if you
1765 call the compiler the same way as for compiling C programs (usually
1766 with the name @command{gcc}).
1768 @findex g++
1769 @findex c++
1770 However, the use of @command{gcc} does not add the C++ library.
1771 @command{g++} is a program that calls GCC and automatically specifies linking
1772 against the C++ library.  It treats @samp{.c},
1773 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1774 files unless @option{-x} is used.  This program is also useful when
1775 precompiling a C header file with a @samp{.h} extension for use in C++
1776 compilations.  On many systems, @command{g++} is also installed with
1777 the name @command{c++}.
1779 @cindex invoking @command{g++}
1780 When you compile C++ programs, you may specify many of the same
1781 command-line options that you use for compiling programs in any
1782 language; or command-line options meaningful for C and related
1783 languages; or options that are meaningful only for C++ programs.
1784 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1785 explanations of options for languages related to C@.
1786 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1787 explanations of options that are meaningful only for C++ programs.
1789 @node C Dialect Options
1790 @section Options Controlling C Dialect
1791 @cindex dialect options
1792 @cindex language dialect options
1793 @cindex options, dialect
1795 The following options control the dialect of C (or languages derived
1796 from C, such as C++, Objective-C and Objective-C++) that the compiler
1797 accepts:
1799 @table @gcctabopt
1800 @cindex ANSI support
1801 @cindex ISO support
1802 @item -ansi
1803 @opindex ansi
1804 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1805 equivalent to @option{-std=c++98}.
1807 This turns off certain features of GCC that are incompatible with ISO
1808 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1809 such as the @code{asm} and @code{typeof} keywords, and
1810 predefined macros such as @code{unix} and @code{vax} that identify the
1811 type of system you are using.  It also enables the undesirable and
1812 rarely used ISO trigraph feature.  For the C compiler,
1813 it disables recognition of C++ style @samp{//} comments as well as
1814 the @code{inline} keyword.
1816 The alternate keywords @code{__asm__}, @code{__extension__},
1817 @code{__inline__} and @code{__typeof__} continue to work despite
1818 @option{-ansi}.  You would not want to use them in an ISO C program, of
1819 course, but it is useful to put them in header files that might be included
1820 in compilations done with @option{-ansi}.  Alternate predefined macros
1821 such as @code{__unix__} and @code{__vax__} are also available, with or
1822 without @option{-ansi}.
1824 The @option{-ansi} option does not cause non-ISO programs to be
1825 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1826 addition to @option{-ansi}.  @xref{Warning Options}.
1828 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1829 option is used.  Some header files may notice this macro and refrain
1830 from declaring certain functions or defining certain macros that the
1831 ISO standard doesn't call for; this is to avoid interfering with any
1832 programs that might use these names for other things.
1834 Functions that are normally built in but do not have semantics
1835 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1836 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1837 built-in functions provided by GCC}, for details of the functions
1838 affected.
1840 @item -std=
1841 @opindex std
1842 Determine the language standard. @xref{Standards,,Language Standards
1843 Supported by GCC}, for details of these standard versions.  This option
1844 is currently only supported when compiling C or C++.
1846 The compiler can accept several base standards, such as @samp{c90} or
1847 @samp{c++98}, and GNU dialects of those standards, such as
1848 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1849 compiler accepts all programs following that standard plus those
1850 using GNU extensions that do not contradict it.  For example,
1851 @option{-std=c90} turns off certain features of GCC that are
1852 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1853 keywords, but not other GNU extensions that do not have a meaning in
1854 ISO C90, such as omitting the middle term of a @code{?:}
1855 expression. On the other hand, when a GNU dialect of a standard is
1856 specified, all features supported by the compiler are enabled, even when
1857 those features change the meaning of the base standard.  As a result, some
1858 strict-conforming programs may be rejected.  The particular standard
1859 is used by @option{-Wpedantic} to identify which features are GNU
1860 extensions given that version of the standard. For example
1861 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1862 comments, while @option{-std=gnu99 -Wpedantic} does not.
1864 A value for this option must be provided; possible values are
1866 @table @samp
1867 @item c90
1868 @itemx c89
1869 @itemx iso9899:1990
1870 Support all ISO C90 programs (certain GNU extensions that conflict
1871 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1873 @item iso9899:199409
1874 ISO C90 as modified in amendment 1.
1876 @item c99
1877 @itemx c9x
1878 @itemx iso9899:1999
1879 @itemx iso9899:199x
1880 ISO C99.  This standard is substantially completely supported, modulo
1881 bugs and floating-point issues
1882 (mainly but not entirely relating to optional C99 features from
1883 Annexes F and G).  See
1884 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1885 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1887 @item c11
1888 @itemx c1x
1889 @itemx iso9899:2011
1890 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1891 substantially completely supported, modulo bugs, floating-point issues
1892 (mainly but not entirely relating to optional C11 features from
1893 Annexes F and G) and the optional Annexes K (Bounds-checking
1894 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1896 @item c17
1897 @itemx c18
1898 @itemx iso9899:2017
1899 @itemx iso9899:2018
1900 ISO C17, the 2017 revision of the ISO C standard (expected to be
1901 published in 2018).  This standard is
1902 same as C11 except for corrections of defects (all of which are also
1903 applied with @option{-std=c11}) and a new value of
1904 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1906 @item gnu90
1907 @itemx gnu89
1908 GNU dialect of ISO C90 (including some C99 features).
1910 @item gnu99
1911 @itemx gnu9x
1912 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1914 @item gnu11
1915 @itemx gnu1x
1916 GNU dialect of ISO C11.
1917 The name @samp{gnu1x} is deprecated.
1919 @item gnu17
1920 @itemx gnu18
1921 GNU dialect of ISO C17.  This is the default for C code.
1923 @item c++98
1924 @itemx c++03
1925 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1926 additional defect reports. Same as @option{-ansi} for C++ code.
1928 @item gnu++98
1929 @itemx gnu++03
1930 GNU dialect of @option{-std=c++98}.
1932 @item c++11
1933 @itemx c++0x
1934 The 2011 ISO C++ standard plus amendments.
1935 The name @samp{c++0x} is deprecated.
1937 @item gnu++11
1938 @itemx gnu++0x
1939 GNU dialect of @option{-std=c++11}.
1940 The name @samp{gnu++0x} is deprecated.
1942 @item c++14
1943 @itemx c++1y
1944 The 2014 ISO C++ standard plus amendments.
1945 The name @samp{c++1y} is deprecated.
1947 @item gnu++14
1948 @itemx gnu++1y
1949 GNU dialect of @option{-std=c++14}.
1950 This is the default for C++ code.
1951 The name @samp{gnu++1y} is deprecated.
1953 @item c++17
1954 @itemx c++1z
1955 The 2017 ISO C++ standard plus amendments.
1956 The name @samp{c++1z} is deprecated.
1958 @item gnu++17
1959 @itemx gnu++1z
1960 GNU dialect of @option{-std=c++17}.
1961 The name @samp{gnu++1z} is deprecated.
1963 @item c++2a
1964 The next revision of the ISO C++ standard, tentatively planned for
1965 2020.  Support is highly experimental, and will almost certainly
1966 change in incompatible ways in future releases.
1968 @item gnu++2a
1969 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1970 and will almost certainly change in incompatible ways in future
1971 releases.
1972 @end table
1974 @item -fgnu89-inline
1975 @opindex fgnu89-inline
1976 The option @option{-fgnu89-inline} tells GCC to use the traditional
1977 GNU semantics for @code{inline} functions when in C99 mode.
1978 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1979 Using this option is roughly equivalent to adding the
1980 @code{gnu_inline} function attribute to all inline functions
1981 (@pxref{Function Attributes}).
1983 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1984 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1985 specifies the default behavior).
1986 This option is not supported in @option{-std=c90} or
1987 @option{-std=gnu90} mode.
1989 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1990 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1991 in effect for @code{inline} functions.  @xref{Common Predefined
1992 Macros,,,cpp,The C Preprocessor}.
1994 @item -fpermitted-flt-eval-methods=@var{style}
1995 @opindex fpermitted-flt-eval-methods
1996 @opindex fpermitted-flt-eval-methods=c11
1997 @opindex fpermitted-flt-eval-methods=ts-18661-3
1998 ISO/IEC TS 18661-3 defines new permissible values for
1999 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2000 a semantic type that is an interchange or extended format should be
2001 evaluated to the precision and range of that type.  These new values are
2002 a superset of those permitted under C99/C11, which does not specify the
2003 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2004 conforming to C11 may not have been written expecting the possibility of
2005 the new values.
2007 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2008 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2009 or the extended set of values specified in ISO/IEC TS 18661-3.
2011 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2013 The default when in a standards compliant mode (@option{-std=c11} or similar)
2014 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2015 dialect (@option{-std=gnu11} or similar) is
2016 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2018 @item -aux-info @var{filename}
2019 @opindex aux-info
2020 Output to the given filename prototyped declarations for all functions
2021 declared and/or defined in a translation unit, including those in header
2022 files.  This option is silently ignored in any language other than C@.
2024 Besides declarations, the file indicates, in comments, the origin of
2025 each declaration (source file and line), whether the declaration was
2026 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2027 @samp{O} for old, respectively, in the first character after the line
2028 number and the colon), and whether it came from a declaration or a
2029 definition (@samp{C} or @samp{F}, respectively, in the following
2030 character).  In the case of function definitions, a K&R-style list of
2031 arguments followed by their declarations is also provided, inside
2032 comments, after the declaration.
2034 @item -fallow-parameterless-variadic-functions
2035 @opindex fallow-parameterless-variadic-functions
2036 Accept variadic functions without named parameters.
2038 Although it is possible to define such a function, this is not very
2039 useful as it is not possible to read the arguments.  This is only
2040 supported for C as this construct is allowed by C++.
2042 @item -fno-asm
2043 @opindex fno-asm
2044 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2045 keyword, so that code can use these words as identifiers.  You can use
2046 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2047 instead.  @option{-ansi} implies @option{-fno-asm}.
2049 In C++, this switch only affects the @code{typeof} keyword, since
2050 @code{asm} and @code{inline} are standard keywords.  You may want to
2051 use the @option{-fno-gnu-keywords} flag instead, which has the same
2052 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2053 switch only affects the @code{asm} and @code{typeof} keywords, since
2054 @code{inline} is a standard keyword in ISO C99.
2056 @item -fno-builtin
2057 @itemx -fno-builtin-@var{function}
2058 @opindex fno-builtin
2059 @cindex built-in functions
2060 Don't recognize built-in functions that do not begin with
2061 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2062 functions provided by GCC}, for details of the functions affected,
2063 including those which are not built-in functions when @option{-ansi} or
2064 @option{-std} options for strict ISO C conformance are used because they
2065 do not have an ISO standard meaning.
2067 GCC normally generates special code to handle certain built-in functions
2068 more efficiently; for instance, calls to @code{alloca} may become single
2069 instructions which adjust the stack directly, and calls to @code{memcpy}
2070 may become inline copy loops.  The resulting code is often both smaller
2071 and faster, but since the function calls no longer appear as such, you
2072 cannot set a breakpoint on those calls, nor can you change the behavior
2073 of the functions by linking with a different library.  In addition,
2074 when a function is recognized as a built-in function, GCC may use
2075 information about that function to warn about problems with calls to
2076 that function, or to generate more efficient code, even if the
2077 resulting code still contains calls to that function.  For example,
2078 warnings are given with @option{-Wformat} for bad calls to
2079 @code{printf} when @code{printf} is built in and @code{strlen} is
2080 known not to modify global memory.
2082 With the @option{-fno-builtin-@var{function}} option
2083 only the built-in function @var{function} is
2084 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2085 function is named that is not built-in in this version of GCC, this
2086 option is ignored.  There is no corresponding
2087 @option{-fbuiltin-@var{function}} option; if you wish to enable
2088 built-in functions selectively when using @option{-fno-builtin} or
2089 @option{-ffreestanding}, you may define macros such as:
2091 @smallexample
2092 #define abs(n)          __builtin_abs ((n))
2093 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2094 @end smallexample
2096 @item -fgimple
2097 @opindex fgimple
2099 Enable parsing of function definitions marked with @code{__GIMPLE}.
2100 This is an experimental feature that allows unit testing of GIMPLE
2101 passes.
2103 @item -fhosted
2104 @opindex fhosted
2105 @cindex hosted environment
2107 Assert that compilation targets a hosted environment.  This implies
2108 @option{-fbuiltin}.  A hosted environment is one in which the
2109 entire standard library is available, and in which @code{main} has a return
2110 type of @code{int}.  Examples are nearly everything except a kernel.
2111 This is equivalent to @option{-fno-freestanding}.
2113 @item -ffreestanding
2114 @opindex ffreestanding
2115 @cindex hosted environment
2117 Assert that compilation targets a freestanding environment.  This
2118 implies @option{-fno-builtin}.  A freestanding environment
2119 is one in which the standard library may not exist, and program startup may
2120 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2121 This is equivalent to @option{-fno-hosted}.
2123 @xref{Standards,,Language Standards Supported by GCC}, for details of
2124 freestanding and hosted environments.
2126 @item -fopenacc
2127 @opindex fopenacc
2128 @cindex OpenACC accelerator programming
2129 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2130 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2131 compiler generates accelerated code according to the OpenACC Application
2132 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2133 implies @option{-pthread}, and thus is only supported on targets that
2134 have support for @option{-pthread}.
2136 @item -fopenacc-dim=@var{geom}
2137 @opindex fopenacc-dim
2138 @cindex OpenACC accelerator programming
2139 Specify default compute dimensions for parallel offload regions that do
2140 not explicitly specify.  The @var{geom} value is a triple of
2141 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2142 can be omitted, to use a target-specific default value.
2144 @item -fopenmp
2145 @opindex fopenmp
2146 @cindex OpenMP parallel
2147 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2148 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2149 compiler generates parallel code according to the OpenMP Application
2150 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2151 implies @option{-pthread}, and thus is only supported on targets that
2152 have support for @option{-pthread}. @option{-fopenmp} implies
2153 @option{-fopenmp-simd}.
2155 @item -fopenmp-simd
2156 @opindex fopenmp-simd
2157 @cindex OpenMP SIMD
2158 @cindex SIMD
2159 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2160 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2161 are ignored.
2163 @item -fgnu-tm
2164 @opindex fgnu-tm
2165 When the option @option{-fgnu-tm} is specified, the compiler
2166 generates code for the Linux variant of Intel's current Transactional
2167 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2168 an experimental feature whose interface may change in future versions
2169 of GCC, as the official specification changes.  Please note that not
2170 all architectures are supported for this feature.
2172 For more information on GCC's support for transactional memory,
2173 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2174 Transactional Memory Library}.
2176 Note that the transactional memory feature is not supported with
2177 non-call exceptions (@option{-fnon-call-exceptions}).
2179 @item -fms-extensions
2180 @opindex fms-extensions
2181 Accept some non-standard constructs used in Microsoft header files.
2183 In C++ code, this allows member names in structures to be similar
2184 to previous types declarations.
2186 @smallexample
2187 typedef int UOW;
2188 struct ABC @{
2189   UOW UOW;
2191 @end smallexample
2193 Some cases of unnamed fields in structures and unions are only
2194 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2195 fields within structs/unions}, for details.
2197 Note that this option is off for all targets but x86 
2198 targets using ms-abi.
2200 @item -fplan9-extensions
2201 @opindex fplan9-extensions
2202 Accept some non-standard constructs used in Plan 9 code.
2204 This enables @option{-fms-extensions}, permits passing pointers to
2205 structures with anonymous fields to functions that expect pointers to
2206 elements of the type of the field, and permits referring to anonymous
2207 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2208 struct/union fields within structs/unions}, for details.  This is only
2209 supported for C, not C++.
2211 @item -fcond-mismatch
2212 @opindex fcond-mismatch
2213 Allow conditional expressions with mismatched types in the second and
2214 third arguments.  The value of such an expression is void.  This option
2215 is not supported for C++.
2217 @item -flax-vector-conversions
2218 @opindex flax-vector-conversions
2219 Allow implicit conversions between vectors with differing numbers of
2220 elements and/or incompatible element types.  This option should not be
2221 used for new code.
2223 @item -funsigned-char
2224 @opindex funsigned-char
2225 Let the type @code{char} be unsigned, like @code{unsigned char}.
2227 Each kind of machine has a default for what @code{char} should
2228 be.  It is either like @code{unsigned char} by default or like
2229 @code{signed char} by default.
2231 Ideally, a portable program should always use @code{signed char} or
2232 @code{unsigned char} when it depends on the signedness of an object.
2233 But many programs have been written to use plain @code{char} and
2234 expect it to be signed, or expect it to be unsigned, depending on the
2235 machines they were written for.  This option, and its inverse, let you
2236 make such a program work with the opposite default.
2238 The type @code{char} is always a distinct type from each of
2239 @code{signed char} or @code{unsigned char}, even though its behavior
2240 is always just like one of those two.
2242 @item -fsigned-char
2243 @opindex fsigned-char
2244 Let the type @code{char} be signed, like @code{signed char}.
2246 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2247 the negative form of @option{-funsigned-char}.  Likewise, the option
2248 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2250 @item -fsigned-bitfields
2251 @itemx -funsigned-bitfields
2252 @itemx -fno-signed-bitfields
2253 @itemx -fno-unsigned-bitfields
2254 @opindex fsigned-bitfields
2255 @opindex funsigned-bitfields
2256 @opindex fno-signed-bitfields
2257 @opindex fno-unsigned-bitfields
2258 These options control whether a bit-field is signed or unsigned, when the
2259 declaration does not use either @code{signed} or @code{unsigned}.  By
2260 default, such a bit-field is signed, because this is consistent: the
2261 basic integer types such as @code{int} are signed types.
2263 @item -fsso-struct=@var{endianness}
2264 @opindex fsso-struct
2265 Set the default scalar storage order of structures and unions to the
2266 specified endianness.  The accepted values are @samp{big-endian},
2267 @samp{little-endian} and @samp{native} for the native endianness of
2268 the target (the default).  This option is not supported for C++.
2270 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2271 code that is not binary compatible with code generated without it if the
2272 specified endianness is not the native endianness of the target.
2273 @end table
2275 @node C++ Dialect Options
2276 @section Options Controlling C++ Dialect
2278 @cindex compiler options, C++
2279 @cindex C++ options, command-line
2280 @cindex options, C++
2281 This section describes the command-line options that are only meaningful
2282 for C++ programs.  You can also use most of the GNU compiler options
2283 regardless of what language your program is in.  For example, you
2284 might compile a file @file{firstClass.C} like this:
2286 @smallexample
2287 g++ -g -fstrict-enums -O -c firstClass.C
2288 @end smallexample
2290 @noindent
2291 In this example, only @option{-fstrict-enums} is an option meant
2292 only for C++ programs; you can use the other options with any
2293 language supported by GCC@.
2295 Some options for compiling C programs, such as @option{-std}, are also
2296 relevant for C++ programs.
2297 @xref{C Dialect Options,,Options Controlling C Dialect}.
2299 Here is a list of options that are @emph{only} for compiling C++ programs:
2301 @table @gcctabopt
2303 @item -fabi-version=@var{n}
2304 @opindex fabi-version
2305 Use version @var{n} of the C++ ABI@.  The default is version 0.
2307 Version 0 refers to the version conforming most closely to
2308 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2309 will change in different versions of G++ as ABI bugs are fixed.
2311 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2313 Version 2 is the version of the C++ ABI that first appeared in G++
2314 3.4, and was the default through G++ 4.9.
2316 Version 3 corrects an error in mangling a constant address as a
2317 template argument.
2319 Version 4, which first appeared in G++ 4.5, implements a standard
2320 mangling for vector types.
2322 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2323 attribute const/volatile on function pointer types, decltype of a
2324 plain decl, and use of a function parameter in the declaration of
2325 another parameter.
2327 Version 6, which first appeared in G++ 4.7, corrects the promotion
2328 behavior of C++11 scoped enums and the mangling of template argument
2329 packs, const/static_cast, prefix ++ and --, and a class scope function
2330 used as a template argument.
2332 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2333 builtin type and corrects the mangling of lambdas in default argument
2334 scope.
2336 Version 8, which first appeared in G++ 4.9, corrects the substitution
2337 behavior of function types with function-cv-qualifiers.
2339 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2340 @code{nullptr_t}.
2342 Version 10, which first appeared in G++ 6.1, adds mangling of
2343 attributes that affect type identity, such as ia32 calling convention
2344 attributes (e.g. @samp{stdcall}).
2346 Version 11, which first appeared in G++ 7, corrects the mangling of
2347 sizeof... expressions and operator names.  For multiple entities with
2348 the same name within a function, that are declared in different scopes,
2349 the mangling now changes starting with the twelfth occurrence.  It also
2350 implies @option{-fnew-inheriting-ctors}.
2352 See also @option{-Wabi}.
2354 @item -fabi-compat-version=@var{n}
2355 @opindex fabi-compat-version
2356 On targets that support strong aliases, G++
2357 works around mangling changes by creating an alias with the correct
2358 mangled name when defining a symbol with an incorrect mangled name.
2359 This switch specifies which ABI version to use for the alias.
2361 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2362 compatibility).  If another ABI version is explicitly selected, this
2363 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2364 use @option{-fabi-compat-version=2}.
2366 If this option is not provided but @option{-Wabi=@var{n}} is, that
2367 version is used for compatibility aliases.  If this option is provided
2368 along with @option{-Wabi} (without the version), the version from this
2369 option is used for the warning.
2371 @item -fno-access-control
2372 @opindex fno-access-control
2373 Turn off all access checking.  This switch is mainly useful for working
2374 around bugs in the access control code.
2376 @item -faligned-new
2377 @opindex faligned-new
2378 Enable support for C++17 @code{new} of types that require more
2379 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2380 numeric argument such as @code{-faligned-new=32} can be used to
2381 specify how much alignment (in bytes) is provided by that function,
2382 but few users will need to override the default of
2383 @code{alignof(std::max_align_t)}.
2385 This flag is enabled by default for @option{-std=c++17}.
2387 @item -fcheck-new
2388 @opindex fcheck-new
2389 Check that the pointer returned by @code{operator new} is non-null
2390 before attempting to modify the storage allocated.  This check is
2391 normally unnecessary because the C++ standard specifies that
2392 @code{operator new} only returns @code{0} if it is declared
2393 @code{throw()}, in which case the compiler always checks the
2394 return value even without this option.  In all other cases, when
2395 @code{operator new} has a non-empty exception specification, memory
2396 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2397 @samp{new (nothrow)}.
2399 @item -fconcepts
2400 @opindex fconcepts
2401 Enable support for the C++ Extensions for Concepts Technical
2402 Specification, ISO 19217 (2015), which allows code like
2404 @smallexample
2405 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2406 template <Addable T> T add (T a, T b) @{ return a + b; @}
2407 @end smallexample
2409 @item -fconstexpr-depth=@var{n}
2410 @opindex fconstexpr-depth
2411 Set the maximum nested evaluation depth for C++11 constexpr functions
2412 to @var{n}.  A limit is needed to detect endless recursion during
2413 constant expression evaluation.  The minimum specified by the standard
2414 is 512.
2416 @item -fconstexpr-loop-limit=@var{n}
2417 @opindex fconstexpr-loop-limit
2418 Set the maximum number of iterations for a loop in C++14 constexpr functions
2419 to @var{n}.  A limit is needed to detect infinite loops during
2420 constant expression evaluation.  The default is 262144 (1<<18).
2422 @item -fdeduce-init-list
2423 @opindex fdeduce-init-list
2424 Enable deduction of a template type parameter as
2425 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2427 @smallexample
2428 template <class T> auto forward(T t) -> decltype (realfn (t))
2430   return realfn (t);
2433 void f()
2435   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2437 @end smallexample
2439 This deduction was implemented as a possible extension to the
2440 originally proposed semantics for the C++11 standard, but was not part
2441 of the final standard, so it is disabled by default.  This option is
2442 deprecated, and may be removed in a future version of G++.
2444 @item -ffriend-injection
2445 @opindex ffriend-injection
2446 Inject friend functions into the enclosing namespace, so that they are
2447 visible outside the scope of the class in which they are declared.
2448 Friend functions were documented to work this way in the old Annotated
2449 C++ Reference Manual.  
2450 However, in ISO C++ a friend function that is not declared
2451 in an enclosing scope can only be found using argument dependent
2452 lookup.  GCC defaults to the standard behavior.
2454 This option is deprecated and will be removed.
2456 @item -fno-elide-constructors
2457 @opindex fno-elide-constructors
2458 The C++ standard allows an implementation to omit creating a temporary
2459 that is only used to initialize another object of the same type.
2460 Specifying this option disables that optimization, and forces G++ to
2461 call the copy constructor in all cases.  This option also causes G++
2462 to call trivial member functions which otherwise would be expanded inline.
2464 In C++17, the compiler is required to omit these temporaries, but this
2465 option still affects trivial member functions.
2467 @item -fno-enforce-eh-specs
2468 @opindex fno-enforce-eh-specs
2469 Don't generate code to check for violation of exception specifications
2470 at run time.  This option violates the C++ standard, but may be useful
2471 for reducing code size in production builds, much like defining
2472 @code{NDEBUG}.  This does not give user code permission to throw
2473 exceptions in violation of the exception specifications; the compiler
2474 still optimizes based on the specifications, so throwing an
2475 unexpected exception results in undefined behavior at run time.
2477 @item -fextern-tls-init
2478 @itemx -fno-extern-tls-init
2479 @opindex fextern-tls-init
2480 @opindex fno-extern-tls-init
2481 The C++11 and OpenMP standards allow @code{thread_local} and
2482 @code{threadprivate} variables to have dynamic (runtime)
2483 initialization.  To support this, any use of such a variable goes
2484 through a wrapper function that performs any necessary initialization.
2485 When the use and definition of the variable are in the same
2486 translation unit, this overhead can be optimized away, but when the
2487 use is in a different translation unit there is significant overhead
2488 even if the variable doesn't actually need dynamic initialization.  If
2489 the programmer can be sure that no use of the variable in a
2490 non-defining TU needs to trigger dynamic initialization (either
2491 because the variable is statically initialized, or a use of the
2492 variable in the defining TU will be executed before any uses in
2493 another TU), they can avoid this overhead with the
2494 @option{-fno-extern-tls-init} option.
2496 On targets that support symbol aliases, the default is
2497 @option{-fextern-tls-init}.  On targets that do not support symbol
2498 aliases, the default is @option{-fno-extern-tls-init}.
2500 @item -ffor-scope
2501 @itemx -fno-for-scope
2502 @opindex ffor-scope
2503 @opindex fno-for-scope
2504 If @option{-ffor-scope} is specified, the scope of variables declared in
2505 a @i{for-init-statement} is limited to the @code{for} loop itself,
2506 as specified by the C++ standard.
2507 If @option{-fno-for-scope} is specified, the scope of variables declared in
2508 a @i{for-init-statement} extends to the end of the enclosing scope,
2509 as was the case in old versions of G++, and other (traditional)
2510 implementations of C++.
2512 This option is deprecated and the associated non-standard
2513 functionality will be removed.
2515 @item -fno-gnu-keywords
2516 @opindex fno-gnu-keywords
2517 Do not recognize @code{typeof} as a keyword, so that code can use this
2518 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2519 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2520 @option{-std=c++98}, @option{-std=c++11}, etc.
2522 @item -fno-implicit-templates
2523 @opindex fno-implicit-templates
2524 Never emit code for non-inline templates that are instantiated
2525 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2526 @xref{Template Instantiation}, for more information.
2528 @item -fno-implicit-inline-templates
2529 @opindex fno-implicit-inline-templates
2530 Don't emit code for implicit instantiations of inline templates, either.
2531 The default is to handle inlines differently so that compiles with and
2532 without optimization need the same set of explicit instantiations.
2534 @item -fno-implement-inlines
2535 @opindex fno-implement-inlines
2536 To save space, do not emit out-of-line copies of inline functions
2537 controlled by @code{#pragma implementation}.  This causes linker
2538 errors if these functions are not inlined everywhere they are called.
2540 @item -fms-extensions
2541 @opindex fms-extensions
2542 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2543 int and getting a pointer to member function via non-standard syntax.
2545 @item -fnew-inheriting-ctors
2546 @opindex fnew-inheriting-ctors
2547 Enable the P0136 adjustment to the semantics of C++11 constructor
2548 inheritance.  This is part of C++17 but also considered to be a Defect
2549 Report against C++11 and C++14.  This flag is enabled by default
2550 unless @option{-fabi-version=10} or lower is specified.
2552 @item -fnew-ttp-matching
2553 @opindex fnew-ttp-matching
2554 Enable the P0522 resolution to Core issue 150, template template
2555 parameters and default arguments: this allows a template with default
2556 template arguments as an argument for a template template parameter
2557 with fewer template parameters.  This flag is enabled by default for
2558 @option{-std=c++17}.
2560 @item -fno-nonansi-builtins
2561 @opindex fno-nonansi-builtins
2562 Disable built-in declarations of functions that are not mandated by
2563 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2564 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2566 @item -fnothrow-opt
2567 @opindex fnothrow-opt
2568 Treat a @code{throw()} exception specification as if it were a
2569 @code{noexcept} specification to reduce or eliminate the text size
2570 overhead relative to a function with no exception specification.  If
2571 the function has local variables of types with non-trivial
2572 destructors, the exception specification actually makes the
2573 function smaller because the EH cleanups for those variables can be
2574 optimized away.  The semantic effect is that an exception thrown out of
2575 a function with such an exception specification results in a call
2576 to @code{terminate} rather than @code{unexpected}.
2578 @item -fno-operator-names
2579 @opindex fno-operator-names
2580 Do not treat the operator name keywords @code{and}, @code{bitand},
2581 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2582 synonyms as keywords.
2584 @item -fno-optional-diags
2585 @opindex fno-optional-diags
2586 Disable diagnostics that the standard says a compiler does not need to
2587 issue.  Currently, the only such diagnostic issued by G++ is the one for
2588 a name having multiple meanings within a class.
2590 @item -fpermissive
2591 @opindex fpermissive
2592 Downgrade some diagnostics about nonconformant code from errors to
2593 warnings.  Thus, using @option{-fpermissive} allows some
2594 nonconforming code to compile.
2596 @item -fno-pretty-templates
2597 @opindex fno-pretty-templates
2598 When an error message refers to a specialization of a function
2599 template, the compiler normally prints the signature of the
2600 template followed by the template arguments and any typedefs or
2601 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2602 rather than @code{void f(int)}) so that it's clear which template is
2603 involved.  When an error message refers to a specialization of a class
2604 template, the compiler omits any template arguments that match
2605 the default template arguments for that template.  If either of these
2606 behaviors make it harder to understand the error message rather than
2607 easier, you can use @option{-fno-pretty-templates} to disable them.
2609 @item -frepo
2610 @opindex frepo
2611 Enable automatic template instantiation at link time.  This option also
2612 implies @option{-fno-implicit-templates}.  @xref{Template
2613 Instantiation}, for more information.
2615 @item -fno-rtti
2616 @opindex fno-rtti
2617 Disable generation of information about every class with virtual
2618 functions for use by the C++ run-time type identification features
2619 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2620 of the language, you can save some space by using this flag.  Note that
2621 exception handling uses the same information, but G++ generates it as
2622 needed. The @code{dynamic_cast} operator can still be used for casts that
2623 do not require run-time type information, i.e.@: casts to @code{void *} or to
2624 unambiguous base classes.
2626 @item -fsized-deallocation
2627 @opindex fsized-deallocation
2628 Enable the built-in global declarations
2629 @smallexample
2630 void operator delete (void *, std::size_t) noexcept;
2631 void operator delete[] (void *, std::size_t) noexcept;
2632 @end smallexample
2633 as introduced in C++14.  This is useful for user-defined replacement
2634 deallocation functions that, for example, use the size of the object
2635 to make deallocation faster.  Enabled by default under
2636 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2637 warns about places that might want to add a definition.
2639 @item -fstrict-enums
2640 @opindex fstrict-enums
2641 Allow the compiler to optimize using the assumption that a value of
2642 enumerated type can only be one of the values of the enumeration (as
2643 defined in the C++ standard; basically, a value that can be
2644 represented in the minimum number of bits needed to represent all the
2645 enumerators).  This assumption may not be valid if the program uses a
2646 cast to convert an arbitrary integer value to the enumerated type.
2648 @item -fstrong-eval-order
2649 @opindex fstrong-eval-order
2650 Evaluate member access, array subscripting, and shift expressions in
2651 left-to-right order, and evaluate assignment in right-to-left order,
2652 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2653 @option{-fstrong-eval-order=some} enables just the ordering of member
2654 access and shift expressions, and is the default without
2655 @option{-std=c++17}.
2657 @item -ftemplate-backtrace-limit=@var{n}
2658 @opindex ftemplate-backtrace-limit
2659 Set the maximum number of template instantiation notes for a single
2660 warning or error to @var{n}.  The default value is 10.
2662 @item -ftemplate-depth=@var{n}
2663 @opindex ftemplate-depth
2664 Set the maximum instantiation depth for template classes to @var{n}.
2665 A limit on the template instantiation depth is needed to detect
2666 endless recursions during template class instantiation.  ANSI/ISO C++
2667 conforming programs must not rely on a maximum depth greater than 17
2668 (changed to 1024 in C++11).  The default value is 900, as the compiler
2669 can run out of stack space before hitting 1024 in some situations.
2671 @item -fno-threadsafe-statics
2672 @opindex fno-threadsafe-statics
2673 Do not emit the extra code to use the routines specified in the C++
2674 ABI for thread-safe initialization of local statics.  You can use this
2675 option to reduce code size slightly in code that doesn't need to be
2676 thread-safe.
2678 @item -fuse-cxa-atexit
2679 @opindex fuse-cxa-atexit
2680 Register destructors for objects with static storage duration with the
2681 @code{__cxa_atexit} function rather than the @code{atexit} function.
2682 This option is required for fully standards-compliant handling of static
2683 destructors, but only works if your C library supports
2684 @code{__cxa_atexit}.
2686 @item -fno-use-cxa-get-exception-ptr
2687 @opindex fno-use-cxa-get-exception-ptr
2688 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2689 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2690 if the runtime routine is not available.
2692 @item -fvisibility-inlines-hidden
2693 @opindex fvisibility-inlines-hidden
2694 This switch declares that the user does not attempt to compare
2695 pointers to inline functions or methods where the addresses of the two functions
2696 are taken in different shared objects.
2698 The effect of this is that GCC may, effectively, mark inline methods with
2699 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2700 appear in the export table of a DSO and do not require a PLT indirection
2701 when used within the DSO@.  Enabling this option can have a dramatic effect
2702 on load and link times of a DSO as it massively reduces the size of the
2703 dynamic export table when the library makes heavy use of templates.
2705 The behavior of this switch is not quite the same as marking the
2706 methods as hidden directly, because it does not affect static variables
2707 local to the function or cause the compiler to deduce that
2708 the function is defined in only one shared object.
2710 You may mark a method as having a visibility explicitly to negate the
2711 effect of the switch for that method.  For example, if you do want to
2712 compare pointers to a particular inline method, you might mark it as
2713 having default visibility.  Marking the enclosing class with explicit
2714 visibility has no effect.
2716 Explicitly instantiated inline methods are unaffected by this option
2717 as their linkage might otherwise cross a shared library boundary.
2718 @xref{Template Instantiation}.
2720 @item -fvisibility-ms-compat
2721 @opindex fvisibility-ms-compat
2722 This flag attempts to use visibility settings to make GCC's C++
2723 linkage model compatible with that of Microsoft Visual Studio.
2725 The flag makes these changes to GCC's linkage model:
2727 @enumerate
2728 @item
2729 It sets the default visibility to @code{hidden}, like
2730 @option{-fvisibility=hidden}.
2732 @item
2733 Types, but not their members, are not hidden by default.
2735 @item
2736 The One Definition Rule is relaxed for types without explicit
2737 visibility specifications that are defined in more than one
2738 shared object: those declarations are permitted if they are
2739 permitted when this option is not used.
2740 @end enumerate
2742 In new code it is better to use @option{-fvisibility=hidden} and
2743 export those classes that are intended to be externally visible.
2744 Unfortunately it is possible for code to rely, perhaps accidentally,
2745 on the Visual Studio behavior.
2747 Among the consequences of these changes are that static data members
2748 of the same type with the same name but defined in different shared
2749 objects are different, so changing one does not change the other;
2750 and that pointers to function members defined in different shared
2751 objects may not compare equal.  When this flag is given, it is a
2752 violation of the ODR to define types with the same name differently.
2754 @item -fno-weak
2755 @opindex fno-weak
2756 Do not use weak symbol support, even if it is provided by the linker.
2757 By default, G++ uses weak symbols if they are available.  This
2758 option exists only for testing, and should not be used by end-users;
2759 it results in inferior code and has no benefits.  This option may
2760 be removed in a future release of G++.
2762 @item -nostdinc++
2763 @opindex nostdinc++
2764 Do not search for header files in the standard directories specific to
2765 C++, but do still search the other standard directories.  (This option
2766 is used when building the C++ library.)
2767 @end table
2769 In addition, these optimization, warning, and code generation options
2770 have meanings only for C++ programs:
2772 @table @gcctabopt
2773 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2774 @opindex Wabi
2775 @opindex Wno-abi
2776 Warn when G++ it generates code that is probably not compatible with
2777 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2778 ABI with each major release, normally @option{-Wabi} will warn only if
2779 there is a check added later in a release series for an ABI issue
2780 discovered since the initial release.  @option{-Wabi} will warn about
2781 more things if an older ABI version is selected (with
2782 @option{-fabi-version=@var{n}}).
2784 @option{-Wabi} can also be used with an explicit version number to
2785 warn about compatibility with a particular @option{-fabi-version}
2786 level, e.g. @option{-Wabi=2} to warn about changes relative to
2787 @option{-fabi-version=2}.
2789 If an explicit version number is provided and
2790 @option{-fabi-compat-version} is not specified, the version number
2791 from this option is used for compatibility aliases.  If no explicit
2792 version number is provided with this option, but
2793 @option{-fabi-compat-version} is specified, that version number is
2794 used for ABI warnings.
2796 Although an effort has been made to warn about
2797 all such cases, there are probably some cases that are not warned about,
2798 even though G++ is generating incompatible code.  There may also be
2799 cases where warnings are emitted even though the code that is generated
2800 is compatible.
2802 You should rewrite your code to avoid these warnings if you are
2803 concerned about the fact that code generated by G++ may not be binary
2804 compatible with code generated by other compilers.
2806 Known incompatibilities in @option{-fabi-version=2} (which was the
2807 default from GCC 3.4 to 4.9) include:
2809 @itemize @bullet
2811 @item
2812 A template with a non-type template parameter of reference type was
2813 mangled incorrectly:
2814 @smallexample
2815 extern int N;
2816 template <int &> struct S @{@};
2817 void n (S<N>) @{2@}
2818 @end smallexample
2820 This was fixed in @option{-fabi-version=3}.
2822 @item
2823 SIMD vector types declared using @code{__attribute ((vector_size))} were
2824 mangled in a non-standard way that does not allow for overloading of
2825 functions taking vectors of different sizes.
2827 The mangling was changed in @option{-fabi-version=4}.
2829 @item
2830 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2831 qualifiers, and @code{decltype} of a plain declaration was folded away.
2833 These mangling issues were fixed in @option{-fabi-version=5}.
2835 @item
2836 Scoped enumerators passed as arguments to a variadic function are
2837 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2838 On most targets this does not actually affect the parameter passing
2839 ABI, as there is no way to pass an argument smaller than @code{int}.
2841 Also, the ABI changed the mangling of template argument packs,
2842 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2843 a class scope function used as a template argument.
2845 These issues were corrected in @option{-fabi-version=6}.
2847 @item
2848 Lambdas in default argument scope were mangled incorrectly, and the
2849 ABI changed the mangling of @code{nullptr_t}.
2851 These issues were corrected in @option{-fabi-version=7}.
2853 @item
2854 When mangling a function type with function-cv-qualifiers, the
2855 un-qualified function type was incorrectly treated as a substitution
2856 candidate.
2858 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2860 @item
2861 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2862 unaligned accesses.  Note that this did not affect the ABI of a
2863 function with a @code{nullptr_t} parameter, as parameters have a
2864 minimum alignment.
2866 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2868 @item
2869 Target-specific attributes that affect the identity of a type, such as
2870 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2871 did not affect the mangled name, leading to name collisions when
2872 function pointers were used as template arguments.
2874 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2876 @end itemize
2878 It also warns about psABI-related changes.  The known psABI changes at this
2879 point include:
2881 @itemize @bullet
2883 @item
2884 For SysV/x86-64, unions with @code{long double} members are 
2885 passed in memory as specified in psABI.  For example:
2887 @smallexample
2888 union U @{
2889   long double ld;
2890   int i;
2892 @end smallexample
2894 @noindent
2895 @code{union U} is always passed in memory.
2897 @end itemize
2899 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2900 @opindex Wabi-tag
2901 @opindex -Wabi-tag
2902 Warn when a type with an ABI tag is used in a context that does not
2903 have that ABI tag.  See @ref{C++ Attributes} for more information
2904 about ABI tags.
2906 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2907 @opindex Wctor-dtor-privacy
2908 @opindex Wno-ctor-dtor-privacy
2909 Warn when a class seems unusable because all the constructors or
2910 destructors in that class are private, and it has neither friends nor
2911 public static member functions.  Also warn if there are no non-private
2912 methods, and there's at least one private member function that isn't
2913 a constructor or destructor.
2915 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2916 @opindex Wdelete-non-virtual-dtor
2917 @opindex Wno-delete-non-virtual-dtor
2918 Warn when @code{delete} is used to destroy an instance of a class that
2919 has virtual functions and non-virtual destructor. It is unsafe to delete
2920 an instance of a derived class through a pointer to a base class if the
2921 base class does not have a virtual destructor.  This warning is enabled
2922 by @option{-Wall}.
2924 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2925 @opindex Wliteral-suffix
2926 @opindex Wno-literal-suffix
2927 Warn when a string or character literal is followed by a ud-suffix which does
2928 not begin with an underscore.  As a conforming extension, GCC treats such
2929 suffixes as separate preprocessing tokens in order to maintain backwards
2930 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2931 For example:
2933 @smallexample
2934 #define __STDC_FORMAT_MACROS
2935 #include <inttypes.h>
2936 #include <stdio.h>
2938 int main() @{
2939   int64_t i64 = 123;
2940   printf("My int64: %" PRId64"\n", i64);
2942 @end smallexample
2944 In this case, @code{PRId64} is treated as a separate preprocessing token.
2946 Additionally, warn when a user-defined literal operator is declared with
2947 a literal suffix identifier that doesn't begin with an underscore. Literal
2948 suffix identifiers that don't begin with an underscore are reserved for
2949 future standardization.
2951 This warning is enabled by default.
2953 @item -Wlto-type-mismatch
2954 @opindex Wlto-type-mismatch
2955 @opindex Wno-lto-type-mismatch
2957 During the link-time optimization warn about type mismatches in
2958 global declarations from different compilation units.
2959 Requires @option{-flto} to be enabled.  Enabled by default.
2961 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2962 @opindex Wnarrowing
2963 @opindex Wno-narrowing
2964 For C++11 and later standards, narrowing conversions are diagnosed by default,
2965 as required by the standard.  A narrowing conversion from a constant produces
2966 an error, and a narrowing conversion from a non-constant produces a warning,
2967 but @option{-Wno-narrowing} suppresses the diagnostic.
2968 Note that this does not affect the meaning of well-formed code;
2969 narrowing conversions are still considered ill-formed in SFINAE contexts.
2971 With @option{-Wnarrowing} in C++98, warn when a narrowing
2972 conversion prohibited by C++11 occurs within
2973 @samp{@{ @}}, e.g.
2975 @smallexample
2976 int i = @{ 2.2 @}; // error: narrowing from double to int
2977 @end smallexample
2979 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2981 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2982 @opindex Wnoexcept
2983 @opindex Wno-noexcept
2984 Warn when a noexcept-expression evaluates to false because of a call
2985 to a function that does not have a non-throwing exception
2986 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2987 the compiler to never throw an exception.
2989 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2990 @opindex Wnoexcept-type
2991 @opindex Wno-noexcept-type
2992 Warn if the C++17 feature making @code{noexcept} part of a function
2993 type changes the mangled name of a symbol relative to C++14.  Enabled
2994 by @option{-Wabi} and @option{-Wc++17-compat}.
2996 As an example:
2998 @smallexample
2999 template <class T> void f(T t) @{ t(); @};
3000 void g() noexcept;
3001 void h() @{ f(g); @} 
3002 @end smallexample
3004 @noindent
3005 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
3006 C++17 it calls @code{f<void(*)()noexcept>}.
3008 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3009 @opindex Wclass-memaccess
3010 Warn when the destination of a call to a raw memory function such as
3011 @code{memset} or @code{memcpy} is an object of class type, and when writing
3012 into such an object might bypass the class non-trivial or deleted constructor
3013 or copy assignment, violate const-correctness or encapsulation, or corrupt
3014 virtual table pointers.  Modifying the representation of such objects may
3015 violate invariants maintained by member functions of the class.  For example,
3016 the call to @code{memset} below is undefined because it modifies a non-trivial
3017 class object and is, therefore, diagnosed.  The safe way to either initialize
3018 or clear the storage of objects of such types is by using the appropriate
3019 constructor or assignment operator, if one is available.
3020 @smallexample
3021 std::string str = "abc";
3022 memset (&str, 0, sizeof str);
3023 @end smallexample
3024 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3025 Explicitly casting the pointer to the class object to @code{void *} or
3026 to a type that can be safely accessed by the raw memory function suppresses
3027 the warning.
3029 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3030 @opindex Wnon-virtual-dtor
3031 @opindex Wno-non-virtual-dtor
3032 Warn when a class has virtual functions and an accessible non-virtual
3033 destructor itself or in an accessible polymorphic base class, in which
3034 case it is possible but unsafe to delete an instance of a derived
3035 class through a pointer to the class itself or base class.  This
3036 warning is automatically enabled if @option{-Weffc++} is specified.
3038 @item -Wregister @r{(C++ and Objective-C++ only)}
3039 @opindex Wregister
3040 @opindex Wno-register
3041 Warn on uses of the @code{register} storage class specifier, except
3042 when it is part of the GNU @ref{Explicit Register Variables} extension.
3043 The use of the @code{register} keyword as storage class specifier has
3044 been deprecated in C++11 and removed in C++17.
3045 Enabled by default with @option{-std=c++17}.
3047 @item -Wreorder @r{(C++ and Objective-C++ only)}
3048 @opindex Wreorder
3049 @opindex Wno-reorder
3050 @cindex reordering, warning
3051 @cindex warning for reordering of member initializers
3052 Warn when the order of member initializers given in the code does not
3053 match the order in which they must be executed.  For instance:
3055 @smallexample
3056 struct A @{
3057   int i;
3058   int j;
3059   A(): j (0), i (1) @{ @}
3061 @end smallexample
3063 @noindent
3064 The compiler rearranges the member initializers for @code{i}
3065 and @code{j} to match the declaration order of the members, emitting
3066 a warning to that effect.  This warning is enabled by @option{-Wall}.
3068 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3069 @opindex fext-numeric-literals
3070 @opindex fno-ext-numeric-literals
3071 Accept imaginary, fixed-point, or machine-defined
3072 literal number suffixes as GNU extensions.
3073 When this option is turned off these suffixes are treated
3074 as C++11 user-defined literal numeric suffixes.
3075 This is on by default for all pre-C++11 dialects and all GNU dialects:
3076 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3077 @option{-std=gnu++14}.
3078 This option is off by default
3079 for ISO C++11 onwards (@option{-std=c++11}, ...).
3080 @end table
3082 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3084 @table @gcctabopt
3085 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3086 @opindex Weffc++
3087 @opindex Wno-effc++
3088 Warn about violations of the following style guidelines from Scott Meyers'
3089 @cite{Effective C++} series of books:
3091 @itemize @bullet
3092 @item
3093 Define a copy constructor and an assignment operator for classes
3094 with dynamically-allocated memory.
3096 @item
3097 Prefer initialization to assignment in constructors.
3099 @item
3100 Have @code{operator=} return a reference to @code{*this}.
3102 @item
3103 Don't try to return a reference when you must return an object.
3105 @item
3106 Distinguish between prefix and postfix forms of increment and
3107 decrement operators.
3109 @item
3110 Never overload @code{&&}, @code{||}, or @code{,}.
3112 @end itemize
3114 This option also enables @option{-Wnon-virtual-dtor}, which is also
3115 one of the effective C++ recommendations.  However, the check is
3116 extended to warn about the lack of virtual destructor in accessible
3117 non-polymorphic bases classes too.
3119 When selecting this option, be aware that the standard library
3120 headers do not obey all of these guidelines; use @samp{grep -v}
3121 to filter out those warnings.
3123 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3124 @opindex Wstrict-null-sentinel
3125 @opindex Wno-strict-null-sentinel
3126 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3127 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3128 to @code{__null}.  Although it is a null pointer constant rather than a
3129 null pointer, it is guaranteed to be of the same size as a pointer.
3130 But this use is not portable across different compilers.
3132 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3133 @opindex Wno-non-template-friend
3134 @opindex Wnon-template-friend
3135 Disable warnings when non-template friend functions are declared
3136 within a template.  In very old versions of GCC that predate implementation
3137 of the ISO standard, declarations such as 
3138 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3139 could be interpreted as a particular specialization of a template
3140 function; the warning exists to diagnose compatibility problems, 
3141 and is enabled by default.
3143 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3144 @opindex Wold-style-cast
3145 @opindex Wno-old-style-cast
3146 Warn if an old-style (C-style) cast to a non-void type is used within
3147 a C++ program.  The new-style casts (@code{dynamic_cast},
3148 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3149 less vulnerable to unintended effects and much easier to search for.
3151 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3152 @opindex Woverloaded-virtual
3153 @opindex Wno-overloaded-virtual
3154 @cindex overloaded virtual function, warning
3155 @cindex warning for overloaded virtual function
3156 Warn when a function declaration hides virtual functions from a
3157 base class.  For example, in:
3159 @smallexample
3160 struct A @{
3161   virtual void f();
3164 struct B: public A @{
3165   void f(int);
3167 @end smallexample
3169 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3170 like:
3172 @smallexample
3173 B* b;
3174 b->f();
3175 @end smallexample
3177 @noindent
3178 fails to compile.
3180 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3181 @opindex Wno-pmf-conversions
3182 @opindex Wpmf-conversions
3183 Disable the diagnostic for converting a bound pointer to member function
3184 to a plain pointer.
3186 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3187 @opindex Wsign-promo
3188 @opindex Wno-sign-promo
3189 Warn when overload resolution chooses a promotion from unsigned or
3190 enumerated type to a signed type, over a conversion to an unsigned type of
3191 the same size.  Previous versions of G++ tried to preserve
3192 unsignedness, but the standard mandates the current behavior.
3194 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3195 @opindex Wtemplates
3196 Warn when a primary template declaration is encountered.  Some coding
3197 rules disallow templates, and this may be used to enforce that rule.
3198 The warning is inactive inside a system header file, such as the STL, so
3199 one can still use the STL.  One may also instantiate or specialize
3200 templates.
3202 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3203 @opindex Wmultiple-inheritance
3204 Warn when a class is defined with multiple direct base classes.  Some
3205 coding rules disallow multiple inheritance, and this may be used to
3206 enforce that rule.  The warning is inactive inside a system header file,
3207 such as the STL, so one can still use the STL.  One may also define
3208 classes that indirectly use multiple inheritance.
3210 @item -Wvirtual-inheritance
3211 @opindex Wvirtual-inheritance
3212 Warn when a class is defined with a virtual direct base class.  Some
3213 coding rules disallow multiple inheritance, and this may be used to
3214 enforce that rule.  The warning is inactive inside a system header file,
3215 such as the STL, so one can still use the STL.  One may also define
3216 classes that indirectly use virtual inheritance.
3218 @item -Wnamespaces
3219 @opindex Wnamespaces
3220 Warn when a namespace definition is opened.  Some coding rules disallow
3221 namespaces, and this may be used to enforce that rule.  The warning is
3222 inactive inside a system header file, such as the STL, so one can still
3223 use the STL.  One may also use using directives and qualified names.
3225 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3226 @opindex Wterminate
3227 @opindex Wno-terminate
3228 Disable the warning about a throw-expression that will immediately
3229 result in a call to @code{terminate}.
3230 @end table
3232 @node Objective-C and Objective-C++ Dialect Options
3233 @section Options Controlling Objective-C and Objective-C++ Dialects
3235 @cindex compiler options, Objective-C and Objective-C++
3236 @cindex Objective-C and Objective-C++ options, command-line
3237 @cindex options, Objective-C and Objective-C++
3238 (NOTE: This manual does not describe the Objective-C and Objective-C++
3239 languages themselves.  @xref{Standards,,Language Standards
3240 Supported by GCC}, for references.)
3242 This section describes the command-line options that are only meaningful
3243 for Objective-C and Objective-C++ programs.  You can also use most of
3244 the language-independent GNU compiler options.
3245 For example, you might compile a file @file{some_class.m} like this:
3247 @smallexample
3248 gcc -g -fgnu-runtime -O -c some_class.m
3249 @end smallexample
3251 @noindent
3252 In this example, @option{-fgnu-runtime} is an option meant only for
3253 Objective-C and Objective-C++ programs; you can use the other options with
3254 any language supported by GCC@.
3256 Note that since Objective-C is an extension of the C language, Objective-C
3257 compilations may also use options specific to the C front-end (e.g.,
3258 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3259 C++-specific options (e.g., @option{-Wabi}).
3261 Here is a list of options that are @emph{only} for compiling Objective-C
3262 and Objective-C++ programs:
3264 @table @gcctabopt
3265 @item -fconstant-string-class=@var{class-name}
3266 @opindex fconstant-string-class
3267 Use @var{class-name} as the name of the class to instantiate for each
3268 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3269 class name is @code{NXConstantString} if the GNU runtime is being used, and
3270 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3271 @option{-fconstant-cfstrings} option, if also present, overrides the
3272 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3273 to be laid out as constant CoreFoundation strings.
3275 @item -fgnu-runtime
3276 @opindex fgnu-runtime
3277 Generate object code compatible with the standard GNU Objective-C
3278 runtime.  This is the default for most types of systems.
3280 @item -fnext-runtime
3281 @opindex fnext-runtime
3282 Generate output compatible with the NeXT runtime.  This is the default
3283 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3284 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3285 used.
3287 @item -fno-nil-receivers
3288 @opindex fno-nil-receivers
3289 Assume that all Objective-C message dispatches (@code{[receiver
3290 message:arg]}) in this translation unit ensure that the receiver is
3291 not @code{nil}.  This allows for more efficient entry points in the
3292 runtime to be used.  This option is only available in conjunction with
3293 the NeXT runtime and ABI version 0 or 1.
3295 @item -fobjc-abi-version=@var{n}
3296 @opindex fobjc-abi-version
3297 Use version @var{n} of the Objective-C ABI for the selected runtime.
3298 This option is currently supported only for the NeXT runtime.  In that
3299 case, Version 0 is the traditional (32-bit) ABI without support for
3300 properties and other Objective-C 2.0 additions.  Version 1 is the
3301 traditional (32-bit) ABI with support for properties and other
3302 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3303 nothing is specified, the default is Version 0 on 32-bit target
3304 machines, and Version 2 on 64-bit target machines.
3306 @item -fobjc-call-cxx-cdtors
3307 @opindex fobjc-call-cxx-cdtors
3308 For each Objective-C class, check if any of its instance variables is a
3309 C++ object with a non-trivial default constructor.  If so, synthesize a
3310 special @code{- (id) .cxx_construct} instance method which runs
3311 non-trivial default constructors on any such instance variables, in order,
3312 and then return @code{self}.  Similarly, check if any instance variable
3313 is a C++ object with a non-trivial destructor, and if so, synthesize a
3314 special @code{- (void) .cxx_destruct} method which runs
3315 all such default destructors, in reverse order.
3317 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3318 methods thusly generated only operate on instance variables
3319 declared in the current Objective-C class, and not those inherited
3320 from superclasses.  It is the responsibility of the Objective-C
3321 runtime to invoke all such methods in an object's inheritance
3322 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3323 by the runtime immediately after a new object instance is allocated;
3324 the @code{- (void) .cxx_destruct} methods are invoked immediately
3325 before the runtime deallocates an object instance.
3327 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3328 support for invoking the @code{- (id) .cxx_construct} and
3329 @code{- (void) .cxx_destruct} methods.
3331 @item -fobjc-direct-dispatch
3332 @opindex fobjc-direct-dispatch
3333 Allow fast jumps to the message dispatcher.  On Darwin this is
3334 accomplished via the comm page.
3336 @item -fobjc-exceptions
3337 @opindex fobjc-exceptions
3338 Enable syntactic support for structured exception handling in
3339 Objective-C, similar to what is offered by C++.  This option
3340 is required to use the Objective-C keywords @code{@@try},
3341 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3342 @code{@@synchronized}.  This option is available with both the GNU
3343 runtime and the NeXT runtime (but not available in conjunction with
3344 the NeXT runtime on Mac OS X 10.2 and earlier).
3346 @item -fobjc-gc
3347 @opindex fobjc-gc
3348 Enable garbage collection (GC) in Objective-C and Objective-C++
3349 programs.  This option is only available with the NeXT runtime; the
3350 GNU runtime has a different garbage collection implementation that
3351 does not require special compiler flags.
3353 @item -fobjc-nilcheck
3354 @opindex fobjc-nilcheck
3355 For the NeXT runtime with version 2 of the ABI, check for a nil
3356 receiver in method invocations before doing the actual method call.
3357 This is the default and can be disabled using
3358 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3359 checked for nil in this way no matter what this flag is set to.
3360 Currently this flag does nothing when the GNU runtime, or an older
3361 version of the NeXT runtime ABI, is used.
3363 @item -fobjc-std=objc1
3364 @opindex fobjc-std
3365 Conform to the language syntax of Objective-C 1.0, the language
3366 recognized by GCC 4.0.  This only affects the Objective-C additions to
3367 the C/C++ language; it does not affect conformance to C/C++ standards,
3368 which is controlled by the separate C/C++ dialect option flags.  When
3369 this option is used with the Objective-C or Objective-C++ compiler,
3370 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3371 This is useful if you need to make sure that your Objective-C code can
3372 be compiled with older versions of GCC@.
3374 @item -freplace-objc-classes
3375 @opindex freplace-objc-classes
3376 Emit a special marker instructing @command{ld(1)} not to statically link in
3377 the resulting object file, and allow @command{dyld(1)} to load it in at
3378 run time instead.  This is used in conjunction with the Fix-and-Continue
3379 debugging mode, where the object file in question may be recompiled and
3380 dynamically reloaded in the course of program execution, without the need
3381 to restart the program itself.  Currently, Fix-and-Continue functionality
3382 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3383 and later.
3385 @item -fzero-link
3386 @opindex fzero-link
3387 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3388 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3389 compile time) with static class references that get initialized at load time,
3390 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3391 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3392 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3393 for individual class implementations to be modified during program execution.
3394 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3395 regardless of command-line options.
3397 @item -fno-local-ivars
3398 @opindex fno-local-ivars
3399 @opindex flocal-ivars
3400 By default instance variables in Objective-C can be accessed as if
3401 they were local variables from within the methods of the class they're
3402 declared in.  This can lead to shadowing between instance variables
3403 and other variables declared either locally inside a class method or
3404 globally with the same name.  Specifying the @option{-fno-local-ivars}
3405 flag disables this behavior thus avoiding variable shadowing issues.
3407 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3408 @opindex fivar-visibility
3409 Set the default instance variable visibility to the specified option
3410 so that instance variables declared outside the scope of any access
3411 modifier directives default to the specified visibility.
3413 @item -gen-decls
3414 @opindex gen-decls
3415 Dump interface declarations for all classes seen in the source file to a
3416 file named @file{@var{sourcename}.decl}.
3418 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3419 @opindex Wassign-intercept
3420 @opindex Wno-assign-intercept
3421 Warn whenever an Objective-C assignment is being intercepted by the
3422 garbage collector.
3424 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3425 @opindex Wno-protocol
3426 @opindex Wprotocol
3427 If a class is declared to implement a protocol, a warning is issued for
3428 every method in the protocol that is not implemented by the class.  The
3429 default behavior is to issue a warning for every method not explicitly
3430 implemented in the class, even if a method implementation is inherited
3431 from the superclass.  If you use the @option{-Wno-protocol} option, then
3432 methods inherited from the superclass are considered to be implemented,
3433 and no warning is issued for them.
3435 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3436 @opindex Wselector
3437 @opindex Wno-selector
3438 Warn if multiple methods of different types for the same selector are
3439 found during compilation.  The check is performed on the list of methods
3440 in the final stage of compilation.  Additionally, a check is performed
3441 for each selector appearing in a @code{@@selector(@dots{})}
3442 expression, and a corresponding method for that selector has been found
3443 during compilation.  Because these checks scan the method table only at
3444 the end of compilation, these warnings are not produced if the final
3445 stage of compilation is not reached, for example because an error is
3446 found during compilation, or because the @option{-fsyntax-only} option is
3447 being used.
3449 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3450 @opindex Wstrict-selector-match
3451 @opindex Wno-strict-selector-match
3452 Warn if multiple methods with differing argument and/or return types are
3453 found for a given selector when attempting to send a message using this
3454 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3455 is off (which is the default behavior), the compiler omits such warnings
3456 if any differences found are confined to types that share the same size
3457 and alignment.
3459 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3460 @opindex Wundeclared-selector
3461 @opindex Wno-undeclared-selector
3462 Warn if a @code{@@selector(@dots{})} expression referring to an
3463 undeclared selector is found.  A selector is considered undeclared if no
3464 method with that name has been declared before the
3465 @code{@@selector(@dots{})} expression, either explicitly in an
3466 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3467 an @code{@@implementation} section.  This option always performs its
3468 checks as soon as a @code{@@selector(@dots{})} expression is found,
3469 while @option{-Wselector} only performs its checks in the final stage of
3470 compilation.  This also enforces the coding style convention
3471 that methods and selectors must be declared before being used.
3473 @item -print-objc-runtime-info
3474 @opindex print-objc-runtime-info
3475 Generate C header describing the largest structure that is passed by
3476 value, if any.
3478 @end table
3480 @node Diagnostic Message Formatting Options
3481 @section Options to Control Diagnostic Messages Formatting
3482 @cindex options to control diagnostics formatting
3483 @cindex diagnostic messages
3484 @cindex message formatting
3486 Traditionally, diagnostic messages have been formatted irrespective of
3487 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3488 options described below
3489 to control the formatting algorithm for diagnostic messages, 
3490 e.g.@: how many characters per line, how often source location
3491 information should be reported.  Note that some language front ends may not
3492 honor these options.
3494 @table @gcctabopt
3495 @item -fmessage-length=@var{n}
3496 @opindex fmessage-length
3497 Try to format error messages so that they fit on lines of about
3498 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3499 done; each error message appears on a single line.  This is the
3500 default for all front ends.
3502 @item -fdiagnostics-show-location=once
3503 @opindex fdiagnostics-show-location
3504 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3505 reporter to emit source location information @emph{once}; that is, in
3506 case the message is too long to fit on a single physical line and has to
3507 be wrapped, the source location won't be emitted (as prefix) again,
3508 over and over, in subsequent continuation lines.  This is the default
3509 behavior.
3511 @item -fdiagnostics-show-location=every-line
3512 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3513 messages reporter to emit the same source location information (as
3514 prefix) for physical lines that result from the process of breaking
3515 a message which is too long to fit on a single line.
3517 @item -fdiagnostics-color[=@var{WHEN}]
3518 @itemx -fno-diagnostics-color
3519 @opindex fdiagnostics-color
3520 @cindex highlight, color
3521 @vindex GCC_COLORS @r{environment variable}
3522 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3523 or @samp{auto}.  The default depends on how the compiler has been configured,
3524 it can be any of the above @var{WHEN} options or also @samp{never}
3525 if @env{GCC_COLORS} environment variable isn't present in the environment,
3526 and @samp{auto} otherwise.
3527 @samp{auto} means to use color only when the standard error is a terminal.
3528 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3529 aliases for @option{-fdiagnostics-color=always} and
3530 @option{-fdiagnostics-color=never}, respectively.
3532 The colors are defined by the environment variable @env{GCC_COLORS}.
3533 Its value is a colon-separated list of capabilities and Select Graphic
3534 Rendition (SGR) substrings. SGR commands are interpreted by the
3535 terminal or terminal emulator.  (See the section in the documentation
3536 of your text terminal for permitted values and their meanings as
3537 character attributes.)  These substring values are integers in decimal
3538 representation and can be concatenated with semicolons.
3539 Common values to concatenate include
3540 @samp{1} for bold,
3541 @samp{4} for underline,
3542 @samp{5} for blink,
3543 @samp{7} for inverse,
3544 @samp{39} for default foreground color,
3545 @samp{30} to @samp{37} for foreground colors,
3546 @samp{90} to @samp{97} for 16-color mode foreground colors,
3547 @samp{38;5;0} to @samp{38;5;255}
3548 for 88-color and 256-color modes foreground colors,
3549 @samp{49} for default background color,
3550 @samp{40} to @samp{47} for background colors,
3551 @samp{100} to @samp{107} for 16-color mode background colors,
3552 and @samp{48;5;0} to @samp{48;5;255}
3553 for 88-color and 256-color modes background colors.
3555 The default @env{GCC_COLORS} is
3556 @smallexample
3557 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3558 quote=01:fixit-insert=32:fixit-delete=31:\
3559 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3560 type-diff=01;32
3561 @end smallexample
3562 @noindent
3563 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3564 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3565 @samp{01} is bold, and @samp{31} is red.
3566 Setting @env{GCC_COLORS} to the empty string disables colors.
3567 Supported capabilities are as follows.
3569 @table @code
3570 @item error=
3571 @vindex error GCC_COLORS @r{capability}
3572 SGR substring for error: markers.
3574 @item warning=
3575 @vindex warning GCC_COLORS @r{capability}
3576 SGR substring for warning: markers.
3578 @item note=
3579 @vindex note GCC_COLORS @r{capability}
3580 SGR substring for note: markers.
3582 @item range1=
3583 @vindex range1 GCC_COLORS @r{capability}
3584 SGR substring for first additional range.
3586 @item range2=
3587 @vindex range2 GCC_COLORS @r{capability}
3588 SGR substring for second additional range.
3590 @item locus=
3591 @vindex locus GCC_COLORS @r{capability}
3592 SGR substring for location information, @samp{file:line} or
3593 @samp{file:line:column} etc.
3595 @item quote=
3596 @vindex quote GCC_COLORS @r{capability}
3597 SGR substring for information printed within quotes.
3599 @item fixit-insert=
3600 @vindex fixit-insert GCC_COLORS @r{capability}
3601 SGR substring for fix-it hints suggesting text to
3602 be inserted or replaced.
3604 @item fixit-delete=
3605 @vindex fixit-delete GCC_COLORS @r{capability}
3606 SGR substring for fix-it hints suggesting text to
3607 be deleted.
3609 @item diff-filename=
3610 @vindex diff-filename GCC_COLORS @r{capability}
3611 SGR substring for filename headers within generated patches.
3613 @item diff-hunk=
3614 @vindex diff-hunk GCC_COLORS @r{capability}
3615 SGR substring for the starts of hunks within generated patches.
3617 @item diff-delete=
3618 @vindex diff-delete GCC_COLORS @r{capability}
3619 SGR substring for deleted lines within generated patches.
3621 @item diff-insert=
3622 @vindex diff-insert GCC_COLORS @r{capability}
3623 SGR substring for inserted lines within generated patches.
3625 @item type-diff=
3626 @vindex type-diff GCC_COLORS @r{capability}
3627 SGR substring for highlighting mismatching types within template
3628 arguments in the C++ frontend.
3629 @end table
3631 @item -fno-diagnostics-show-option
3632 @opindex fno-diagnostics-show-option
3633 @opindex fdiagnostics-show-option
3634 By default, each diagnostic emitted includes text indicating the
3635 command-line option that directly controls the diagnostic (if such an
3636 option is known to the diagnostic machinery).  Specifying the
3637 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3639 @item -fno-diagnostics-show-caret
3640 @opindex fno-diagnostics-show-caret
3641 @opindex fdiagnostics-show-caret
3642 By default, each diagnostic emitted includes the original source line
3643 and a caret @samp{^} indicating the column.  This option suppresses this
3644 information.  The source line is truncated to @var{n} characters, if
3645 the @option{-fmessage-length=n} option is given.  When the output is done
3646 to the terminal, the width is limited to the width given by the
3647 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3649 @item -fdiagnostics-parseable-fixits
3650 @opindex fdiagnostics-parseable-fixits
3651 Emit fix-it hints in a machine-parseable format, suitable for consumption
3652 by IDEs.  For each fix-it, a line will be printed after the relevant
3653 diagnostic, starting with the string ``fix-it:''.  For example:
3655 @smallexample
3656 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3657 @end smallexample
3659 The location is expressed as a half-open range, expressed as a count of
3660 bytes, starting at byte 1 for the initial column.  In the above example,
3661 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3662 given string:
3664 @smallexample
3665 00000000011111111112222222222
3666 12345678901234567890123456789
3667   gtk_widget_showall (dlg);
3668   ^^^^^^^^^^^^^^^^^^
3669   gtk_widget_show_all
3670 @end smallexample
3672 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3673 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3674 (e.g. vertical tab as ``\013'').
3676 An empty replacement string indicates that the given range is to be removed.
3677 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3678 be inserted at the given position.
3680 @item -fdiagnostics-generate-patch
3681 @opindex fdiagnostics-generate-patch
3682 Print fix-it hints to stderr in unified diff format, after any diagnostics
3683 are printed.  For example:
3685 @smallexample
3686 --- test.c
3687 +++ test.c
3688 @@ -42,5 +42,5 @@
3690  void show_cb(GtkDialog *dlg)
3691  @{
3692 -  gtk_widget_showall(dlg);
3693 +  gtk_widget_show_all(dlg);
3694  @}
3696 @end smallexample
3698 The diff may or may not be colorized, following the same rules
3699 as for diagnostics (see @option{-fdiagnostics-color}).
3701 @item -fdiagnostics-show-template-tree
3702 @opindex fdiagnostics-show-template-tree
3704 In the C++ frontend, when printing diagnostics showing mismatching
3705 template types, such as:
3707 @smallexample
3708   could not convert 'std::map<int, std::vector<double> >()'
3709     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3710 @end smallexample
3712 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3713 tree-like structure showing the common and differing parts of the types,
3714 such as:
3716 @smallexample
3717   map<
3718     [...],
3719     vector<
3720       [double != float]>>
3721 @end smallexample
3723 The parts that differ are highlighted with color (``double'' and
3724 ``float'' in this case).
3726 @item -fno-elide-type
3727 @opindex fno-elide-type
3728 @opindex felide-type
3729 By default when the C++ frontend prints diagnostics showing mismatching
3730 template types, common parts of the types are printed as ``[...]'' to
3731 simplify the error message.  For example:
3733 @smallexample
3734   could not convert 'std::map<int, std::vector<double> >()'
3735     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3736 @end smallexample
3738 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3739 This flag also affects the output of the
3740 @option{-fdiagnostics-show-template-tree} flag.
3742 @item -fno-show-column
3743 @opindex fno-show-column
3744 Do not print column numbers in diagnostics.  This may be necessary if
3745 diagnostics are being scanned by a program that does not understand the
3746 column numbers, such as @command{dejagnu}.
3748 @end table
3750 @node Warning Options
3751 @section Options to Request or Suppress Warnings
3752 @cindex options to control warnings
3753 @cindex warning messages
3754 @cindex messages, warning
3755 @cindex suppressing warnings
3757 Warnings are diagnostic messages that report constructions that
3758 are not inherently erroneous but that are risky or suggest there
3759 may have been an error.
3761 The following language-independent options do not enable specific
3762 warnings but control the kinds of diagnostics produced by GCC@.
3764 @table @gcctabopt
3765 @cindex syntax checking
3766 @item -fsyntax-only
3767 @opindex fsyntax-only
3768 Check the code for syntax errors, but don't do anything beyond that.
3770 @item -fmax-errors=@var{n}
3771 @opindex fmax-errors
3772 Limits the maximum number of error messages to @var{n}, at which point
3773 GCC bails out rather than attempting to continue processing the source
3774 code.  If @var{n} is 0 (the default), there is no limit on the number
3775 of error messages produced.  If @option{-Wfatal-errors} is also
3776 specified, then @option{-Wfatal-errors} takes precedence over this
3777 option.
3779 @item -w
3780 @opindex w
3781 Inhibit all warning messages.
3783 @item -Werror
3784 @opindex Werror
3785 @opindex Wno-error
3786 Make all warnings into errors.
3788 @item -Werror=
3789 @opindex Werror=
3790 @opindex Wno-error=
3791 Make the specified warning into an error.  The specifier for a warning
3792 is appended; for example @option{-Werror=switch} turns the warnings
3793 controlled by @option{-Wswitch} into errors.  This switch takes a
3794 negative form, to be used to negate @option{-Werror} for specific
3795 warnings; for example @option{-Wno-error=switch} makes
3796 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3797 is in effect.
3799 The warning message for each controllable warning includes the
3800 option that controls the warning.  That option can then be used with
3801 @option{-Werror=} and @option{-Wno-error=} as described above.
3802 (Printing of the option in the warning message can be disabled using the
3803 @option{-fno-diagnostics-show-option} flag.)
3805 Note that specifying @option{-Werror=}@var{foo} automatically implies
3806 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3807 imply anything.
3809 @item -Wfatal-errors
3810 @opindex Wfatal-errors
3811 @opindex Wno-fatal-errors
3812 This option causes the compiler to abort compilation on the first error
3813 occurred rather than trying to keep going and printing further error
3814 messages.
3816 @end table
3818 You can request many specific warnings with options beginning with
3819 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3820 implicit declarations.  Each of these specific warning options also
3821 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3822 example, @option{-Wno-implicit}.  This manual lists only one of the
3823 two forms, whichever is not the default.  For further
3824 language-specific options also refer to @ref{C++ Dialect Options} and
3825 @ref{Objective-C and Objective-C++ Dialect Options}.
3827 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3828 options, such as @option{-Wunused}, which may turn on further options,
3829 such as @option{-Wunused-value}. The combined effect of positive and
3830 negative forms is that more specific options have priority over less
3831 specific ones, independently of their position in the command-line. For
3832 options of the same specificity, the last one takes effect. Options
3833 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3834 as if they appeared at the end of the command-line.
3836 When an unrecognized warning option is requested (e.g.,
3837 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3838 that the option is not recognized.  However, if the @option{-Wno-} form
3839 is used, the behavior is slightly different: no diagnostic is
3840 produced for @option{-Wno-unknown-warning} unless other diagnostics
3841 are being produced.  This allows the use of new @option{-Wno-} options
3842 with old compilers, but if something goes wrong, the compiler
3843 warns that an unrecognized option is present.
3845 @table @gcctabopt
3846 @item -Wpedantic
3847 @itemx -pedantic
3848 @opindex pedantic
3849 @opindex Wpedantic
3850 Issue all the warnings demanded by strict ISO C and ISO C++;
3851 reject all programs that use forbidden extensions, and some other
3852 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3853 version of the ISO C standard specified by any @option{-std} option used.
3855 Valid ISO C and ISO C++ programs should compile properly with or without
3856 this option (though a rare few require @option{-ansi} or a
3857 @option{-std} option specifying the required version of ISO C)@.  However,
3858 without this option, certain GNU extensions and traditional C and C++
3859 features are supported as well.  With this option, they are rejected.
3861 @option{-Wpedantic} does not cause warning messages for use of the
3862 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3863 warnings are also disabled in the expression that follows
3864 @code{__extension__}.  However, only system header files should use
3865 these escape routes; application programs should avoid them.
3866 @xref{Alternate Keywords}.
3868 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3869 C conformance.  They soon find that it does not do quite what they want:
3870 it finds some non-ISO practices, but not all---only those for which
3871 ISO C @emph{requires} a diagnostic, and some others for which
3872 diagnostics have been added.
3874 A feature to report any failure to conform to ISO C might be useful in
3875 some instances, but would require considerable additional work and would
3876 be quite different from @option{-Wpedantic}.  We don't have plans to
3877 support such a feature in the near future.
3879 Where the standard specified with @option{-std} represents a GNU
3880 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3881 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3882 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3883 where they are required by the base standard.  (It does not make sense
3884 for such warnings to be given only for features not in the specified GNU
3885 C dialect, since by definition the GNU dialects of C include all
3886 features the compiler supports with the given option, and there would be
3887 nothing to warn about.)
3889 @item -pedantic-errors
3890 @opindex pedantic-errors
3891 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3892 requires a diagnostic, in some cases where there is undefined behavior
3893 at compile-time and in some other cases that do not prevent compilation
3894 of programs that are valid according to the standard. This is not
3895 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3896 by this option and not enabled by the latter and vice versa.
3898 @item -Wall
3899 @opindex Wall
3900 @opindex Wno-all
3901 This enables all the warnings about constructions that some users
3902 consider questionable, and that are easy to avoid (or modify to
3903 prevent the warning), even in conjunction with macros.  This also
3904 enables some language-specific warnings described in @ref{C++ Dialect
3905 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3907 @option{-Wall} turns on the following warning flags:
3909 @gccoptlist{-Waddress   @gol
3910 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3911 -Wbool-compare  @gol
3912 -Wbool-operation  @gol
3913 -Wc++11-compat  -Wc++14-compat  @gol
3914 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3915 -Wchar-subscripts  @gol
3916 -Wcomment  @gol
3917 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3918 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3919 -Wformat   @gol
3920 -Wint-in-bool-context  @gol
3921 -Wimplicit @r{(C and Objective-C only)} @gol
3922 -Wimplicit-int @r{(C and Objective-C only)} @gol
3923 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3924 -Winit-self @r{(only for C++)} @gol
3925 -Wlogical-not-parentheses @gol
3926 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3927 -Wmaybe-uninitialized @gol
3928 -Wmemset-elt-size @gol
3929 -Wmemset-transposed-args @gol
3930 -Wmisleading-indentation @r{(only for C/C++)} @gol
3931 -Wmissing-attributes @gol
3932 -Wmissing-braces @r{(only for C/ObjC)} @gol
3933 -Wmultistatement-macros  @gol
3934 -Wnarrowing @r{(only for C++)}  @gol
3935 -Wnonnull  @gol
3936 -Wnonnull-compare  @gol
3937 -Wopenmp-simd @gol
3938 -Wparentheses  @gol
3939 -Wpointer-sign  @gol
3940 -Wreorder   @gol
3941 -Wrestrict   @gol
3942 -Wreturn-type  @gol
3943 -Wsequence-point  @gol
3944 -Wsign-compare @r{(only in C++)}  @gol
3945 -Wsizeof-pointer-div @gol
3946 -Wsizeof-pointer-memaccess @gol
3947 -Wstrict-aliasing  @gol
3948 -Wstrict-overflow=1  @gol
3949 -Wswitch  @gol
3950 -Wtautological-compare  @gol
3951 -Wtrigraphs  @gol
3952 -Wuninitialized  @gol
3953 -Wunknown-pragmas  @gol
3954 -Wunused-function  @gol
3955 -Wunused-label     @gol
3956 -Wunused-value     @gol
3957 -Wunused-variable  @gol
3958 -Wvolatile-register-var @gol
3961 Note that some warning flags are not implied by @option{-Wall}.  Some of
3962 them warn about constructions that users generally do not consider
3963 questionable, but which occasionally you might wish to check for;
3964 others warn about constructions that are necessary or hard to avoid in
3965 some cases, and there is no simple way to modify the code to suppress
3966 the warning. Some of them are enabled by @option{-Wextra} but many of
3967 them must be enabled individually.
3969 @item -Wextra
3970 @opindex W
3971 @opindex Wextra
3972 @opindex Wno-extra
3973 This enables some extra warning flags that are not enabled by
3974 @option{-Wall}. (This option used to be called @option{-W}.  The older
3975 name is still supported, but the newer name is more descriptive.)
3977 @gccoptlist{-Wclobbered  @gol
3978 -Wcast-function-type  @gol
3979 -Wempty-body  @gol
3980 -Wignored-qualifiers @gol
3981 -Wimplicit-fallthrough=3 @gol
3982 -Wmissing-field-initializers  @gol
3983 -Wmissing-parameter-type @r{(C only)}  @gol
3984 -Wold-style-declaration @r{(C only)}  @gol
3985 -Woverride-init  @gol
3986 -Wsign-compare @r{(C only)} @gol
3987 -Wtype-limits  @gol
3988 -Wuninitialized  @gol
3989 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3990 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3991 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3994 The option @option{-Wextra} also prints warning messages for the
3995 following cases:
3997 @itemize @bullet
3999 @item
4000 A pointer is compared against integer zero with @code{<}, @code{<=},
4001 @code{>}, or @code{>=}.
4003 @item
4004 (C++ only) An enumerator and a non-enumerator both appear in a
4005 conditional expression.
4007 @item
4008 (C++ only) Ambiguous virtual bases.
4010 @item
4011 (C++ only) Subscripting an array that has been declared @code{register}.
4013 @item
4014 (C++ only) Taking the address of a variable that has been declared
4015 @code{register}.
4017 @item
4018 (C++ only) A base class is not initialized in the copy constructor
4019 of a derived class.
4021 @end itemize
4023 @item -Wchar-subscripts
4024 @opindex Wchar-subscripts
4025 @opindex Wno-char-subscripts
4026 Warn if an array subscript has type @code{char}.  This is a common cause
4027 of error, as programmers often forget that this type is signed on some
4028 machines.
4029 This warning is enabled by @option{-Wall}.
4031 @item -Wchkp
4032 @opindex Wchkp
4033 Warn about an invalid memory access that is found by Pointer Bounds Checker
4034 (@option{-fcheck-pointer-bounds}).
4036 @item -Wno-coverage-mismatch
4037 @opindex Wno-coverage-mismatch
4038 Warn if feedback profiles do not match when using the
4039 @option{-fprofile-use} option.
4040 If a source file is changed between compiling with @option{-fprofile-gen} and
4041 with @option{-fprofile-use}, the files with the profile feedback can fail
4042 to match the source file and GCC cannot use the profile feedback
4043 information.  By default, this warning is enabled and is treated as an
4044 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4045 warning or @option{-Wno-error=coverage-mismatch} can be used to
4046 disable the error.  Disabling the error for this warning can result in
4047 poorly optimized code and is useful only in the
4048 case of very minor changes such as bug fixes to an existing code-base.
4049 Completely disabling the warning is not recommended.
4051 @item -Wno-cpp
4052 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4054 Suppress warning messages emitted by @code{#warning} directives.
4056 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4057 @opindex Wdouble-promotion
4058 @opindex Wno-double-promotion
4059 Give a warning when a value of type @code{float} is implicitly
4060 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4061 floating-point unit implement @code{float} in hardware, but emulate
4062 @code{double} in software.  On such a machine, doing computations
4063 using @code{double} values is much more expensive because of the
4064 overhead required for software emulation.
4066 It is easy to accidentally do computations with @code{double} because
4067 floating-point literals are implicitly of type @code{double}.  For
4068 example, in:
4069 @smallexample
4070 @group
4071 float area(float radius)
4073    return 3.14159 * radius * radius;
4075 @end group
4076 @end smallexample
4077 the compiler performs the entire computation with @code{double}
4078 because the floating-point literal is a @code{double}.
4080 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4081 @opindex Wduplicate-decl-specifier
4082 @opindex Wno-duplicate-decl-specifier
4083 Warn if a declaration has duplicate @code{const}, @code{volatile},
4084 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4085 @option{-Wall}.
4087 @item -Wformat
4088 @itemx -Wformat=@var{n}
4089 @opindex Wformat
4090 @opindex Wno-format
4091 @opindex ffreestanding
4092 @opindex fno-builtin
4093 @opindex Wformat=
4094 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4095 the arguments supplied have types appropriate to the format string
4096 specified, and that the conversions specified in the format string make
4097 sense.  This includes standard functions, and others specified by format
4098 attributes (@pxref{Function Attributes}), in the @code{printf},
4099 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4100 not in the C standard) families (or other target-specific families).
4101 Which functions are checked without format attributes having been
4102 specified depends on the standard version selected, and such checks of
4103 functions without the attribute specified are disabled by
4104 @option{-ffreestanding} or @option{-fno-builtin}.
4106 The formats are checked against the format features supported by GNU
4107 libc version 2.2.  These include all ISO C90 and C99 features, as well
4108 as features from the Single Unix Specification and some BSD and GNU
4109 extensions.  Other library implementations may not support all these
4110 features; GCC does not support warning about features that go beyond a
4111 particular library's limitations.  However, if @option{-Wpedantic} is used
4112 with @option{-Wformat}, warnings are given about format features not
4113 in the selected standard version (but not for @code{strfmon} formats,
4114 since those are not in any version of the C standard).  @xref{C Dialect
4115 Options,,Options Controlling C Dialect}.
4117 @table @gcctabopt
4118 @item -Wformat=1
4119 @itemx -Wformat
4120 @opindex Wformat
4121 @opindex Wformat=1
4122 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4123 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4124 @option{-Wformat} also checks for null format arguments for several
4125 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4126 aspects of this level of format checking can be disabled by the
4127 options: @option{-Wno-format-contains-nul},
4128 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4129 @option{-Wformat} is enabled by @option{-Wall}.
4131 @item -Wno-format-contains-nul
4132 @opindex Wno-format-contains-nul
4133 @opindex Wformat-contains-nul
4134 If @option{-Wformat} is specified, do not warn about format strings that
4135 contain NUL bytes.
4137 @item -Wno-format-extra-args
4138 @opindex Wno-format-extra-args
4139 @opindex Wformat-extra-args
4140 If @option{-Wformat} is specified, do not warn about excess arguments to a
4141 @code{printf} or @code{scanf} format function.  The C standard specifies
4142 that such arguments are ignored.
4144 Where the unused arguments lie between used arguments that are
4145 specified with @samp{$} operand number specifications, normally
4146 warnings are still given, since the implementation could not know what
4147 type to pass to @code{va_arg} to skip the unused arguments.  However,
4148 in the case of @code{scanf} formats, this option suppresses the
4149 warning if the unused arguments are all pointers, since the Single
4150 Unix Specification says that such unused arguments are allowed.
4152 @item -Wformat-overflow
4153 @itemx -Wformat-overflow=@var{level}
4154 @opindex Wformat-overflow
4155 @opindex Wno-format-overflow
4156 Warn about calls to formatted input/output functions such as @code{sprintf}
4157 and @code{vsprintf} that might overflow the destination buffer.  When the
4158 exact number of bytes written by a format directive cannot be determined
4159 at compile-time it is estimated based on heuristics that depend on the
4160 @var{level} argument and on optimization.  While enabling optimization
4161 will in most cases improve the accuracy of the warning, it may also
4162 result in false positives.
4164 @table @gcctabopt
4165 @item -Wformat-overflow
4166 @itemx -Wformat-overflow=1
4167 @opindex Wformat-overflow
4168 @opindex Wno-format-overflow
4169 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4170 employs a conservative approach that warns only about calls that most
4171 likely overflow the buffer.  At this level, numeric arguments to format
4172 directives with unknown values are assumed to have the value of one, and
4173 strings of unknown length to be empty.  Numeric arguments that are known
4174 to be bounded to a subrange of their type, or string arguments whose output
4175 is bounded either by their directive's precision or by a finite set of
4176 string literals, are assumed to take on the value within the range that
4177 results in the most bytes on output.  For example, the call to @code{sprintf}
4178 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4179 the terminating NUL character (@code{'\0'}) appended by the function
4180 to the destination buffer will be written past its end.  Increasing
4181 the size of the buffer by a single byte is sufficient to avoid the
4182 warning, though it may not be sufficient to avoid the overflow.
4184 @smallexample
4185 void f (int a, int b)
4187   char buf [13];
4188   sprintf (buf, "a = %i, b = %i\n", a, b);
4190 @end smallexample
4192 @item -Wformat-overflow=2
4193 Level @var{2} warns also about calls that might overflow the destination
4194 buffer given an argument of sufficient length or magnitude.  At level
4195 @var{2}, unknown numeric arguments are assumed to have the minimum
4196 representable value for signed types with a precision greater than 1, and
4197 the maximum representable value otherwise.  Unknown string arguments whose
4198 length cannot be assumed to be bounded either by the directive's precision,
4199 or by a finite set of string literals they may evaluate to, or the character
4200 array they may point to, are assumed to be 1 character long.
4202 At level @var{2}, the call in the example above is again diagnosed, but
4203 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4204 @code{%i} directive will write some of its digits beyond the end of
4205 the destination buffer.  To make the call safe regardless of the values
4206 of the two variables, the size of the destination buffer must be increased
4207 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4208 an informational note following the warning.
4210 An alternative to increasing the size of the destination buffer is to
4211 constrain the range of formatted values.  The maximum length of string
4212 arguments can be bounded by specifying the precision in the format
4213 directive.  When numeric arguments of format directives can be assumed
4214 to be bounded by less than the precision of their type, choosing
4215 an appropriate length modifier to the format specifier will reduce
4216 the required buffer size.  For example, if @var{a} and @var{b} in the
4217 example above can be assumed to be within the precision of
4218 the @code{short int} type then using either the @code{%hi} format
4219 directive or casting the argument to @code{short} reduces the maximum
4220 required size of the buffer to 24 bytes.
4222 @smallexample
4223 void f (int a, int b)
4225   char buf [23];
4226   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4228 @end smallexample
4229 @end table
4231 @item -Wno-format-zero-length
4232 @opindex Wno-format-zero-length
4233 @opindex Wformat-zero-length
4234 If @option{-Wformat} is specified, do not warn about zero-length formats.
4235 The C standard specifies that zero-length formats are allowed.
4238 @item -Wformat=2
4239 @opindex Wformat=2
4240 Enable @option{-Wformat} plus additional format checks.  Currently
4241 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4242 -Wformat-y2k}.
4244 @item -Wformat-nonliteral
4245 @opindex Wformat-nonliteral
4246 @opindex Wno-format-nonliteral
4247 If @option{-Wformat} is specified, also warn if the format string is not a
4248 string literal and so cannot be checked, unless the format function
4249 takes its format arguments as a @code{va_list}.
4251 @item -Wformat-security
4252 @opindex Wformat-security
4253 @opindex Wno-format-security
4254 If @option{-Wformat} is specified, also warn about uses of format
4255 functions that represent possible security problems.  At present, this
4256 warns about calls to @code{printf} and @code{scanf} functions where the
4257 format string is not a string literal and there are no format arguments,
4258 as in @code{printf (foo);}.  This may be a security hole if the format
4259 string came from untrusted input and contains @samp{%n}.  (This is
4260 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4261 in future warnings may be added to @option{-Wformat-security} that are not
4262 included in @option{-Wformat-nonliteral}.)
4264 @item -Wformat-signedness
4265 @opindex Wformat-signedness
4266 @opindex Wno-format-signedness
4267 If @option{-Wformat} is specified, also warn if the format string
4268 requires an unsigned argument and the argument is signed and vice versa.
4270 @item -Wformat-truncation
4271 @itemx -Wformat-truncation=@var{level}
4272 @opindex Wformat-truncation
4273 @opindex Wno-format-truncation
4274 Warn about calls to formatted input/output functions such as @code{snprintf}
4275 and @code{vsnprintf} that might result in output truncation.  When the exact
4276 number of bytes written by a format directive cannot be determined at
4277 compile-time it is estimated based on heuristics that depend on
4278 the @var{level} argument and on optimization.  While enabling optimization
4279 will in most cases improve the accuracy of the warning, it may also result
4280 in false positives.  Except as noted otherwise, the option uses the same
4281 logic @option{-Wformat-overflow}.
4283 @table @gcctabopt
4284 @item -Wformat-truncation
4285 @itemx -Wformat-truncation=1
4286 @opindex Wformat-truncation
4287 @opindex Wno-format-overflow
4288 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4289 employs a conservative approach that warns only about calls to bounded
4290 functions whose return value is unused and that will most likely result
4291 in output truncation.
4293 @item -Wformat-truncation=2
4294 Level @var{2} warns also about calls to bounded functions whose return
4295 value is used and that might result in truncation given an argument of
4296 sufficient length or magnitude.
4297 @end table
4299 @item -Wformat-y2k
4300 @opindex Wformat-y2k
4301 @opindex Wno-format-y2k
4302 If @option{-Wformat} is specified, also warn about @code{strftime}
4303 formats that may yield only a two-digit year.
4304 @end table
4306 @item -Wnonnull
4307 @opindex Wnonnull
4308 @opindex Wno-nonnull
4309 Warn about passing a null pointer for arguments marked as
4310 requiring a non-null value by the @code{nonnull} function attribute.
4312 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4313 can be disabled with the @option{-Wno-nonnull} option.
4315 @item -Wnonnull-compare
4316 @opindex Wnonnull-compare
4317 @opindex Wno-nonnull-compare
4318 Warn when comparing an argument marked with the @code{nonnull}
4319 function attribute against null inside the function.
4321 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4322 can be disabled with the @option{-Wno-nonnull-compare} option.
4324 @item -Wnull-dereference
4325 @opindex Wnull-dereference
4326 @opindex Wno-null-dereference
4327 Warn if the compiler detects paths that trigger erroneous or
4328 undefined behavior due to dereferencing a null pointer.  This option
4329 is only active when @option{-fdelete-null-pointer-checks} is active,
4330 which is enabled by optimizations in most targets.  The precision of
4331 the warnings depends on the optimization options used.
4333 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4334 @opindex Winit-self
4335 @opindex Wno-init-self
4336 Warn about uninitialized variables that are initialized with themselves.
4337 Note this option can only be used with the @option{-Wuninitialized} option.
4339 For example, GCC warns about @code{i} being uninitialized in the
4340 following snippet only when @option{-Winit-self} has been specified:
4341 @smallexample
4342 @group
4343 int f()
4345   int i = i;
4346   return i;
4348 @end group
4349 @end smallexample
4351 This warning is enabled by @option{-Wall} in C++.
4353 @item -Wimplicit-int @r{(C and Objective-C only)}
4354 @opindex Wimplicit-int
4355 @opindex Wno-implicit-int
4356 Warn when a declaration does not specify a type.
4357 This warning is enabled by @option{-Wall}.
4359 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4360 @opindex Wimplicit-function-declaration
4361 @opindex Wno-implicit-function-declaration
4362 Give a warning whenever a function is used before being declared. In
4363 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4364 enabled by default and it is made into an error by
4365 @option{-pedantic-errors}. This warning is also enabled by
4366 @option{-Wall}.
4368 @item -Wimplicit @r{(C and Objective-C only)}
4369 @opindex Wimplicit
4370 @opindex Wno-implicit
4371 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4372 This warning is enabled by @option{-Wall}.
4374 @item -Wimplicit-fallthrough
4375 @opindex Wimplicit-fallthrough
4376 @opindex Wno-implicit-fallthrough
4377 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4378 and @option{-Wno-implicit-fallthrough} is the same as
4379 @option{-Wimplicit-fallthrough=0}.
4381 @item -Wimplicit-fallthrough=@var{n}
4382 @opindex Wimplicit-fallthrough=
4383 Warn when a switch case falls through.  For example:
4385 @smallexample
4386 @group
4387 switch (cond)
4388   @{
4389   case 1:
4390     a = 1;
4391     break;
4392   case 2:
4393     a = 2;
4394   case 3:
4395     a = 3;
4396     break;
4397   @}
4398 @end group
4399 @end smallexample
4401 This warning does not warn when the last statement of a case cannot
4402 fall through, e.g. when there is a return statement or a call to function
4403 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4404 also takes into account control flow statements, such as ifs, and only
4405 warns when appropriate.  E.g.@:
4407 @smallexample
4408 @group
4409 switch (cond)
4410   @{
4411   case 1:
4412     if (i > 3) @{
4413       bar (5);
4414       break;
4415     @} else if (i < 1) @{
4416       bar (0);
4417     @} else
4418       return;
4419   default:
4420     @dots{}
4421   @}
4422 @end group
4423 @end smallexample
4425 Since there are occasions where a switch case fall through is desirable,
4426 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4427 to be used along with a null statement to suppress this warning that
4428 would normally occur:
4430 @smallexample
4431 @group
4432 switch (cond)
4433   @{
4434   case 1:
4435     bar (0);
4436     __attribute__ ((fallthrough));
4437   default:
4438     @dots{}
4439   @}
4440 @end group
4441 @end smallexample
4443 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4444 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4445 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4446 Instead of these attributes, it is also possible to add a fallthrough comment
4447 to silence the warning.  The whole body of the C or C++ style comment should
4448 match the given regular expressions listed below.  The option argument @var{n}
4449 specifies what kind of comments are accepted:
4451 @itemize @bullet
4453 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4455 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4456 expression, any comment is used as fallthrough comment.
4458 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4459 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4461 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4462 following regular expressions:
4464 @itemize @bullet
4466 @item @code{-fallthrough}
4468 @item @code{@@fallthrough@@}
4470 @item @code{lint -fallthrough[ \t]*}
4472 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4474 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4476 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4478 @end itemize
4480 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4481 following regular expressions:
4483 @itemize @bullet
4485 @item @code{-fallthrough}
4487 @item @code{@@fallthrough@@}
4489 @item @code{lint -fallthrough[ \t]*}
4491 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4493 @end itemize
4495 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4496 fallthrough comments, only attributes disable the warning.
4498 @end itemize
4500 The comment needs to be followed after optional whitespace and other comments
4501 by @code{case} or @code{default} keywords or by a user label that precedes some
4502 @code{case} or @code{default} label.
4504 @smallexample
4505 @group
4506 switch (cond)
4507   @{
4508   case 1:
4509     bar (0);
4510     /* FALLTHRU */
4511   default:
4512     @dots{}
4513   @}
4514 @end group
4515 @end smallexample
4517 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4519 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4520 @opindex Wif-not-aligned
4521 @opindex Wno-if-not-aligned
4522 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4523 should be issued.  This is is enabled by default.
4524 Use @option{-Wno-if-not-aligned} to disable it.
4526 @item -Wignored-qualifiers @r{(C and C++ only)}
4527 @opindex Wignored-qualifiers
4528 @opindex Wno-ignored-qualifiers
4529 Warn if the return type of a function has a type qualifier
4530 such as @code{const}.  For ISO C such a type qualifier has no effect,
4531 since the value returned by a function is not an lvalue.
4532 For C++, the warning is only emitted for scalar types or @code{void}.
4533 ISO C prohibits qualified @code{void} return types on function
4534 definitions, so such return types always receive a warning
4535 even without this option.
4537 This warning is also enabled by @option{-Wextra}.
4539 @item -Wignored-attributes @r{(C and C++ only)}
4540 @opindex Wignored-attributes
4541 @opindex Wno-ignored-attributes
4542 Warn when an attribute is ignored.  This is different from the
4543 @option{-Wattributes} option in that it warns whenever the compiler decides
4544 to drop an attribute, not that the attribute is either unknown, used in a
4545 wrong place, etc.  This warning is enabled by default.
4547 @item -Wmain
4548 @opindex Wmain
4549 @opindex Wno-main
4550 Warn if the type of @code{main} is suspicious.  @code{main} should be
4551 a function with external linkage, returning int, taking either zero
4552 arguments, two, or three arguments of appropriate types.  This warning
4553 is enabled by default in C++ and is enabled by either @option{-Wall}
4554 or @option{-Wpedantic}.
4556 @item -Wmisleading-indentation @r{(C and C++ only)}
4557 @opindex Wmisleading-indentation
4558 @opindex Wno-misleading-indentation
4559 Warn when the indentation of the code does not reflect the block structure.
4560 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4561 @code{for} clauses with a guarded statement that does not use braces,
4562 followed by an unguarded statement with the same indentation.
4564 In the following example, the call to ``bar'' is misleadingly indented as
4565 if it were guarded by the ``if'' conditional.
4567 @smallexample
4568   if (some_condition ())
4569     foo ();
4570     bar ();  /* Gotcha: this is not guarded by the "if".  */
4571 @end smallexample
4573 In the case of mixed tabs and spaces, the warning uses the
4574 @option{-ftabstop=} option to determine if the statements line up
4575 (defaulting to 8).
4577 The warning is not issued for code involving multiline preprocessor logic
4578 such as the following example.
4580 @smallexample
4581   if (flagA)
4582     foo (0);
4583 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4584   if (flagB)
4585 #endif
4586     foo (1);
4587 @end smallexample
4589 The warning is not issued after a @code{#line} directive, since this
4590 typically indicates autogenerated code, and no assumptions can be made
4591 about the layout of the file that the directive references.
4593 This warning is enabled by @option{-Wall} in C and C++.
4595 @item -Wmissing-attributes
4596 @opindex Wmissing-attributes
4597 @opindex Wno-missing-attributes
4598 Warn when a declaration of a function is missing one or more attributes
4599 that a related function is declared with and whose absence may adversely
4600 affect the correctness or efficiency of generated code.  For example, in
4601 C++, the warning is issued when an explicit specialization of a primary
4602 template declared with attribute @code{alloc_align}, @code{alloc_size},
4603 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4604 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4605 @code{error}, and @code{warning} suppress the warning.
4606 (@pxref{Function Attributes}).
4608 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4610 For example, since the declaration of the primary function template
4611 below makes use of both attribute @code{malloc} and @code{alloc_size}
4612 the declaration of the explicit specialization of the template is
4613 diagnosed because it is missing one of the attributes.
4615 @smallexample
4616 template <class T>
4617 T* __attribute__ ((malloc, alloc_size (1)))
4618 allocate (size_t);
4620 template <>
4621 void* __attribute__ ((malloc))   // missing alloc_size
4622 allocate<void> (size_t);
4623 @end smallexample
4625 @item -Wmissing-braces
4626 @opindex Wmissing-braces
4627 @opindex Wno-missing-braces
4628 Warn if an aggregate or union initializer is not fully bracketed.  In
4629 the following example, the initializer for @code{a} is not fully
4630 bracketed, but that for @code{b} is fully bracketed.  This warning is
4631 enabled by @option{-Wall} in C.
4633 @smallexample
4634 int a[2][2] = @{ 0, 1, 2, 3 @};
4635 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4636 @end smallexample
4638 This warning is enabled by @option{-Wall}.
4640 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4641 @opindex Wmissing-include-dirs
4642 @opindex Wno-missing-include-dirs
4643 Warn if a user-supplied include directory does not exist.
4645 @item -Wmultistatement-macros
4646 @opindex Wmultistatement-macros
4647 @opindex Wno-multistatement-macros
4648 Warn about unsafe multiple statement macros that appear to be guarded
4649 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4650 @code{while}, in which only the first statement is actually guarded after
4651 the macro is expanded.
4653 For example:
4655 @smallexample
4656 #define DOIT x++; y++
4657 if (c)
4658   DOIT;
4659 @end smallexample
4661 will increment @code{y} unconditionally, not just when @code{c} holds.
4662 The can usually be fixed by wrapping the macro in a do-while loop:
4663 @smallexample
4664 #define DOIT do @{ x++; y++; @} while (0)
4665 if (c)
4666   DOIT;
4667 @end smallexample
4669 This warning is enabled by @option{-Wall} in C and C++.
4671 @item -Wparentheses
4672 @opindex Wparentheses
4673 @opindex Wno-parentheses
4674 Warn if parentheses are omitted in certain contexts, such
4675 as when there is an assignment in a context where a truth value
4676 is expected, or when operators are nested whose precedence people
4677 often get confused about.
4679 Also warn if a comparison like @code{x<=y<=z} appears; this is
4680 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4681 interpretation from that of ordinary mathematical notation.
4683 Also warn for dangerous uses of the GNU extension to
4684 @code{?:} with omitted middle operand. When the condition
4685 in the @code{?}: operator is a boolean expression, the omitted value is
4686 always 1.  Often programmers expect it to be a value computed
4687 inside the conditional expression instead.
4689 For C++ this also warns for some cases of unnecessary parentheses in
4690 declarations, which can indicate an attempt at a function call instead
4691 of a declaration:
4692 @smallexample
4694   // Declares a local variable called mymutex.
4695   std::unique_lock<std::mutex> (mymutex);
4696   // User meant std::unique_lock<std::mutex> lock (mymutex);
4698 @end smallexample
4700 This warning is enabled by @option{-Wall}.
4702 @item -Wsequence-point
4703 @opindex Wsequence-point
4704 @opindex Wno-sequence-point
4705 Warn about code that may have undefined semantics because of violations
4706 of sequence point rules in the C and C++ standards.
4708 The C and C++ standards define the order in which expressions in a C/C++
4709 program are evaluated in terms of @dfn{sequence points}, which represent
4710 a partial ordering between the execution of parts of the program: those
4711 executed before the sequence point, and those executed after it.  These
4712 occur after the evaluation of a full expression (one which is not part
4713 of a larger expression), after the evaluation of the first operand of a
4714 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4715 function is called (but after the evaluation of its arguments and the
4716 expression denoting the called function), and in certain other places.
4717 Other than as expressed by the sequence point rules, the order of
4718 evaluation of subexpressions of an expression is not specified.  All
4719 these rules describe only a partial order rather than a total order,
4720 since, for example, if two functions are called within one expression
4721 with no sequence point between them, the order in which the functions
4722 are called is not specified.  However, the standards committee have
4723 ruled that function calls do not overlap.
4725 It is not specified when between sequence points modifications to the
4726 values of objects take effect.  Programs whose behavior depends on this
4727 have undefined behavior; the C and C++ standards specify that ``Between
4728 the previous and next sequence point an object shall have its stored
4729 value modified at most once by the evaluation of an expression.
4730 Furthermore, the prior value shall be read only to determine the value
4731 to be stored.''.  If a program breaks these rules, the results on any
4732 particular implementation are entirely unpredictable.
4734 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4735 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4736 diagnosed by this option, and it may give an occasional false positive
4737 result, but in general it has been found fairly effective at detecting
4738 this sort of problem in programs.
4740 The C++17 standard will define the order of evaluation of operands in
4741 more cases: in particular it requires that the right-hand side of an
4742 assignment be evaluated before the left-hand side, so the above
4743 examples are no longer undefined.  But this warning will still warn
4744 about them, to help people avoid writing code that is undefined in C
4745 and earlier revisions of C++.
4747 The standard is worded confusingly, therefore there is some debate
4748 over the precise meaning of the sequence point rules in subtle cases.
4749 Links to discussions of the problem, including proposed formal
4750 definitions, may be found on the GCC readings page, at
4751 @uref{http://gcc.gnu.org/@/readings.html}.
4753 This warning is enabled by @option{-Wall} for C and C++.
4755 @item -Wno-return-local-addr
4756 @opindex Wno-return-local-addr
4757 @opindex Wreturn-local-addr
4758 Do not warn about returning a pointer (or in C++, a reference) to a
4759 variable that goes out of scope after the function returns.
4761 @item -Wreturn-type
4762 @opindex Wreturn-type
4763 @opindex Wno-return-type
4764 Warn whenever a function is defined with a return type that defaults
4765 to @code{int}.  Also warn about any @code{return} statement with no
4766 return value in a function whose return type is not @code{void}
4767 (falling off the end of the function body is considered returning
4768 without a value).
4770 For C only, warn about a @code{return} statement with an expression in a
4771 function whose return type is @code{void}, unless the expression type is
4772 also @code{void}.  As a GNU extension, the latter case is accepted
4773 without a warning unless @option{-Wpedantic} is used.
4775 For C++, a function without return type always produces a diagnostic
4776 message, even when @option{-Wno-return-type} is specified.  The only
4777 exceptions are @code{main} and functions defined in system headers.
4779 This warning is enabled by @option{-Wall}.
4781 @item -Wshift-count-negative
4782 @opindex Wshift-count-negative
4783 @opindex Wno-shift-count-negative
4784 Warn if shift count is negative. This warning is enabled by default.
4786 @item -Wshift-count-overflow
4787 @opindex Wshift-count-overflow
4788 @opindex Wno-shift-count-overflow
4789 Warn if shift count >= width of type. This warning is enabled by default.
4791 @item -Wshift-negative-value
4792 @opindex Wshift-negative-value
4793 @opindex Wno-shift-negative-value
4794 Warn if left shifting a negative value.  This warning is enabled by
4795 @option{-Wextra} in C99 and C++11 modes (and newer).
4797 @item -Wshift-overflow
4798 @itemx -Wshift-overflow=@var{n}
4799 @opindex Wshift-overflow
4800 @opindex Wno-shift-overflow
4801 Warn about left shift overflows.  This warning is enabled by
4802 default in C99 and C++11 modes (and newer).
4804 @table @gcctabopt
4805 @item -Wshift-overflow=1
4806 This is the warning level of @option{-Wshift-overflow} and is enabled
4807 by default in C99 and C++11 modes (and newer).  This warning level does
4808 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4809 an overflow is still rejected in contexts where an integer constant expression
4810 is required.)
4812 @item -Wshift-overflow=2
4813 This warning level also warns about left-shifting 1 into the sign bit,
4814 unless C++14 mode is active.
4815 @end table
4817 @item -Wswitch
4818 @opindex Wswitch
4819 @opindex Wno-switch
4820 Warn whenever a @code{switch} statement has an index of enumerated type
4821 and lacks a @code{case} for one or more of the named codes of that
4822 enumeration.  (The presence of a @code{default} label prevents this
4823 warning.)  @code{case} labels outside the enumeration range also
4824 provoke warnings when this option is used (even if there is a
4825 @code{default} label).
4826 This warning is enabled by @option{-Wall}.
4828 @item -Wswitch-default
4829 @opindex Wswitch-default
4830 @opindex Wno-switch-default
4831 Warn whenever a @code{switch} statement does not have a @code{default}
4832 case.
4834 @item -Wswitch-enum
4835 @opindex Wswitch-enum
4836 @opindex Wno-switch-enum
4837 Warn whenever a @code{switch} statement has an index of enumerated type
4838 and lacks a @code{case} for one or more of the named codes of that
4839 enumeration.  @code{case} labels outside the enumeration range also
4840 provoke warnings when this option is used.  The only difference
4841 between @option{-Wswitch} and this option is that this option gives a
4842 warning about an omitted enumeration code even if there is a
4843 @code{default} label.
4845 @item -Wswitch-bool
4846 @opindex Wswitch-bool
4847 @opindex Wno-switch-bool
4848 Warn whenever a @code{switch} statement has an index of boolean type
4849 and the case values are outside the range of a boolean type.
4850 It is possible to suppress this warning by casting the controlling
4851 expression to a type other than @code{bool}.  For example:
4852 @smallexample
4853 @group
4854 switch ((int) (a == 4))
4855   @{
4856   @dots{}
4857   @}
4858 @end group
4859 @end smallexample
4860 This warning is enabled by default for C and C++ programs.
4862 @item -Wswitch-unreachable
4863 @opindex Wswitch-unreachable
4864 @opindex Wno-switch-unreachable
4865 Warn whenever a @code{switch} statement contains statements between the
4866 controlling expression and the first case label, which will never be
4867 executed.  For example:
4868 @smallexample
4869 @group
4870 switch (cond)
4871   @{
4872    i = 15;
4873   @dots{}
4874    case 5:
4875   @dots{}
4876   @}
4877 @end group
4878 @end smallexample
4879 @option{-Wswitch-unreachable} does not warn if the statement between the
4880 controlling expression and the first case label is just a declaration:
4881 @smallexample
4882 @group
4883 switch (cond)
4884   @{
4885    int i;
4886   @dots{}
4887    case 5:
4888    i = 5;
4889   @dots{}
4890   @}
4891 @end group
4892 @end smallexample
4893 This warning is enabled by default for C and C++ programs.
4895 @item -Wsync-nand @r{(C and C++ only)}
4896 @opindex Wsync-nand
4897 @opindex Wno-sync-nand
4898 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4899 built-in functions are used.  These functions changed semantics in GCC 4.4.
4901 @item -Wunused-but-set-parameter
4902 @opindex Wunused-but-set-parameter
4903 @opindex Wno-unused-but-set-parameter
4904 Warn whenever a function parameter is assigned to, but otherwise unused
4905 (aside from its declaration).
4907 To suppress this warning use the @code{unused} attribute
4908 (@pxref{Variable Attributes}).
4910 This warning is also enabled by @option{-Wunused} together with
4911 @option{-Wextra}.
4913 @item -Wunused-but-set-variable
4914 @opindex Wunused-but-set-variable
4915 @opindex Wno-unused-but-set-variable
4916 Warn whenever a local variable is assigned to, but otherwise unused
4917 (aside from its declaration).
4918 This warning is enabled by @option{-Wall}.
4920 To suppress this warning use the @code{unused} attribute
4921 (@pxref{Variable Attributes}).
4923 This warning is also enabled by @option{-Wunused}, which is enabled
4924 by @option{-Wall}.
4926 @item -Wunused-function
4927 @opindex Wunused-function
4928 @opindex Wno-unused-function
4929 Warn whenever a static function is declared but not defined or a
4930 non-inline static function is unused.
4931 This warning is enabled by @option{-Wall}.
4933 @item -Wunused-label
4934 @opindex Wunused-label
4935 @opindex Wno-unused-label
4936 Warn whenever a label is declared but not used.
4937 This warning is enabled by @option{-Wall}.
4939 To suppress this warning use the @code{unused} attribute
4940 (@pxref{Variable Attributes}).
4942 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4943 @opindex Wunused-local-typedefs
4944 Warn when a typedef locally defined in a function is not used.
4945 This warning is enabled by @option{-Wall}.
4947 @item -Wunused-parameter
4948 @opindex Wunused-parameter
4949 @opindex Wno-unused-parameter
4950 Warn whenever a function parameter is unused aside from its declaration.
4952 To suppress this warning use the @code{unused} attribute
4953 (@pxref{Variable Attributes}).
4955 @item -Wno-unused-result
4956 @opindex Wunused-result
4957 @opindex Wno-unused-result
4958 Do not warn if a caller of a function marked with attribute
4959 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4960 its return value. The default is @option{-Wunused-result}.
4962 @item -Wunused-variable
4963 @opindex Wunused-variable
4964 @opindex Wno-unused-variable
4965 Warn whenever a local or static variable is unused aside from its
4966 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4967 but not for C++. This warning is enabled by @option{-Wall}.
4969 To suppress this warning use the @code{unused} attribute
4970 (@pxref{Variable Attributes}).
4972 @item -Wunused-const-variable
4973 @itemx -Wunused-const-variable=@var{n}
4974 @opindex Wunused-const-variable
4975 @opindex Wno-unused-const-variable
4976 Warn whenever a constant static variable is unused aside from its declaration.
4977 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4978 for C, but not for C++. In C this declares variable storage, but in C++ this
4979 is not an error since const variables take the place of @code{#define}s.
4981 To suppress this warning use the @code{unused} attribute
4982 (@pxref{Variable Attributes}).
4984 @table @gcctabopt
4985 @item -Wunused-const-variable=1
4986 This is the warning level that is enabled by @option{-Wunused-variable} for
4987 C.  It warns only about unused static const variables defined in the main
4988 compilation unit, but not about static const variables declared in any
4989 header included.
4991 @item -Wunused-const-variable=2
4992 This warning level also warns for unused constant static variables in
4993 headers (excluding system headers).  This is the warning level of
4994 @option{-Wunused-const-variable} and must be explicitly requested since
4995 in C++ this isn't an error and in C it might be harder to clean up all
4996 headers included.
4997 @end table
4999 @item -Wunused-value
5000 @opindex Wunused-value
5001 @opindex Wno-unused-value
5002 Warn whenever a statement computes a result that is explicitly not
5003 used. To suppress this warning cast the unused expression to
5004 @code{void}. This includes an expression-statement or the left-hand
5005 side of a comma expression that contains no side effects. For example,
5006 an expression such as @code{x[i,j]} causes a warning, while
5007 @code{x[(void)i,j]} does not.
5009 This warning is enabled by @option{-Wall}.
5011 @item -Wunused
5012 @opindex Wunused
5013 @opindex Wno-unused
5014 All the above @option{-Wunused} options combined.
5016 In order to get a warning about an unused function parameter, you must
5017 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5018 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5020 @item -Wuninitialized
5021 @opindex Wuninitialized
5022 @opindex Wno-uninitialized
5023 Warn if an automatic variable is used without first being initialized
5024 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5025 warn if a non-static reference or non-static @code{const} member
5026 appears in a class without constructors.
5028 If you want to warn about code that uses the uninitialized value of the
5029 variable in its own initializer, use the @option{-Winit-self} option.
5031 These warnings occur for individual uninitialized or clobbered
5032 elements of structure, union or array variables as well as for
5033 variables that are uninitialized or clobbered as a whole.  They do
5034 not occur for variables or elements declared @code{volatile}.  Because
5035 these warnings depend on optimization, the exact variables or elements
5036 for which there are warnings depends on the precise optimization
5037 options and version of GCC used.
5039 Note that there may be no warning about a variable that is used only
5040 to compute a value that itself is never used, because such
5041 computations may be deleted by data flow analysis before the warnings
5042 are printed.
5044 @item -Winvalid-memory-model
5045 @opindex Winvalid-memory-model
5046 @opindex Wno-invalid-memory-model
5047 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5048 and the C11 atomic generic functions with a memory consistency argument
5049 that is either invalid for the operation or outside the range of values
5050 of the @code{memory_order} enumeration.  For example, since the
5051 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5052 defined for the relaxed, release, and sequentially consistent memory
5053 orders the following code is diagnosed:
5055 @smallexample
5056 void store (int *i)
5058   __atomic_store_n (i, 0, memory_order_consume);
5060 @end smallexample
5062 @option{-Winvalid-memory-model} is enabled by default.
5064 @item -Wmaybe-uninitialized
5065 @opindex Wmaybe-uninitialized
5066 @opindex Wno-maybe-uninitialized
5067 For an automatic (i.e.@ local) variable, if there exists a path from the
5068 function entry to a use of the variable that is initialized, but there exist
5069 some other paths for which the variable is not initialized, the compiler
5070 emits a warning if it cannot prove the uninitialized paths are not
5071 executed at run time.
5073 These warnings are only possible in optimizing compilation, because otherwise
5074 GCC does not keep track of the state of variables.
5076 These warnings are made optional because GCC may not be able to determine when
5077 the code is correct in spite of appearing to have an error.  Here is one
5078 example of how this can happen:
5080 @smallexample
5081 @group
5083   int x;
5084   switch (y)
5085     @{
5086     case 1: x = 1;
5087       break;
5088     case 2: x = 4;
5089       break;
5090     case 3: x = 5;
5091     @}
5092   foo (x);
5094 @end group
5095 @end smallexample
5097 @noindent
5098 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5099 always initialized, but GCC doesn't know this. To suppress the
5100 warning, you need to provide a default case with assert(0) or
5101 similar code.
5103 @cindex @code{longjmp} warnings
5104 This option also warns when a non-volatile automatic variable might be
5105 changed by a call to @code{longjmp}.
5106 The compiler sees only the calls to @code{setjmp}.  It cannot know
5107 where @code{longjmp} will be called; in fact, a signal handler could
5108 call it at any point in the code.  As a result, you may get a warning
5109 even when there is in fact no problem because @code{longjmp} cannot
5110 in fact be called at the place that would cause a problem.
5112 Some spurious warnings can be avoided if you declare all the functions
5113 you use that never return as @code{noreturn}.  @xref{Function
5114 Attributes}.
5116 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5118 @item -Wunknown-pragmas
5119 @opindex Wunknown-pragmas
5120 @opindex Wno-unknown-pragmas
5121 @cindex warning for unknown pragmas
5122 @cindex unknown pragmas, warning
5123 @cindex pragmas, warning of unknown
5124 Warn when a @code{#pragma} directive is encountered that is not understood by 
5125 GCC@.  If this command-line option is used, warnings are even issued
5126 for unknown pragmas in system header files.  This is not the case if
5127 the warnings are only enabled by the @option{-Wall} command-line option.
5129 @item -Wno-pragmas
5130 @opindex Wno-pragmas
5131 @opindex Wpragmas
5132 Do not warn about misuses of pragmas, such as incorrect parameters,
5133 invalid syntax, or conflicts between pragmas.  See also
5134 @option{-Wunknown-pragmas}.
5136 @item -Wstrict-aliasing
5137 @opindex Wstrict-aliasing
5138 @opindex Wno-strict-aliasing
5139 This option is only active when @option{-fstrict-aliasing} is active.
5140 It warns about code that might break the strict aliasing rules that the
5141 compiler is using for optimization.  The warning does not catch all
5142 cases, but does attempt to catch the more common pitfalls.  It is
5143 included in @option{-Wall}.
5144 It is equivalent to @option{-Wstrict-aliasing=3}
5146 @item -Wstrict-aliasing=n
5147 @opindex Wstrict-aliasing=n
5148 This option is only active when @option{-fstrict-aliasing} is active.
5149 It warns about code that might break the strict aliasing rules that the
5150 compiler is using for optimization.
5151 Higher levels correspond to higher accuracy (fewer false positives).
5152 Higher levels also correspond to more effort, similar to the way @option{-O} 
5153 works.
5154 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5156 Level 1: Most aggressive, quick, least accurate.
5157 Possibly useful when higher levels
5158 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5159 false negatives.  However, it has many false positives.
5160 Warns for all pointer conversions between possibly incompatible types,
5161 even if never dereferenced.  Runs in the front end only.
5163 Level 2: Aggressive, quick, not too precise.
5164 May still have many false positives (not as many as level 1 though),
5165 and few false negatives (but possibly more than level 1).
5166 Unlike level 1, it only warns when an address is taken.  Warns about
5167 incomplete types.  Runs in the front end only.
5169 Level 3 (default for @option{-Wstrict-aliasing}):
5170 Should have very few false positives and few false
5171 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5172 Takes care of the common pun+dereference pattern in the front end:
5173 @code{*(int*)&some_float}.
5174 If optimization is enabled, it also runs in the back end, where it deals
5175 with multiple statement cases using flow-sensitive points-to information.
5176 Only warns when the converted pointer is dereferenced.
5177 Does not warn about incomplete types.
5179 @item -Wstrict-overflow
5180 @itemx -Wstrict-overflow=@var{n}
5181 @opindex Wstrict-overflow
5182 @opindex Wno-strict-overflow
5183 This option is only active when signed overflow is undefined.
5184 It warns about cases where the compiler optimizes based on the
5185 assumption that signed overflow does not occur.  Note that it does not
5186 warn about all cases where the code might overflow: it only warns
5187 about cases where the compiler implements some optimization.  Thus
5188 this warning depends on the optimization level.
5190 An optimization that assumes that signed overflow does not occur is
5191 perfectly safe if the values of the variables involved are such that
5192 overflow never does, in fact, occur.  Therefore this warning can
5193 easily give a false positive: a warning about code that is not
5194 actually a problem.  To help focus on important issues, several
5195 warning levels are defined.  No warnings are issued for the use of
5196 undefined signed overflow when estimating how many iterations a loop
5197 requires, in particular when determining whether a loop will be
5198 executed at all.
5200 @table @gcctabopt
5201 @item -Wstrict-overflow=1
5202 Warn about cases that are both questionable and easy to avoid.  For
5203 example the compiler simplifies
5204 @code{x + 1 > x} to @code{1}.  This level of
5205 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5206 are not, and must be explicitly requested.
5208 @item -Wstrict-overflow=2
5209 Also warn about other cases where a comparison is simplified to a
5210 constant.  For example: @code{abs (x) >= 0}.  This can only be
5211 simplified when signed integer overflow is undefined, because
5212 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5213 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5214 @option{-Wstrict-overflow=2}.
5216 @item -Wstrict-overflow=3
5217 Also warn about other cases where a comparison is simplified.  For
5218 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5220 @item -Wstrict-overflow=4
5221 Also warn about other simplifications not covered by the above cases.
5222 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5224 @item -Wstrict-overflow=5
5225 Also warn about cases where the compiler reduces the magnitude of a
5226 constant involved in a comparison.  For example: @code{x + 2 > y} is
5227 simplified to @code{x + 1 >= y}.  This is reported only at the
5228 highest warning level because this simplification applies to many
5229 comparisons, so this warning level gives a very large number of
5230 false positives.
5231 @end table
5233 @item -Wstringop-overflow
5234 @itemx -Wstringop-overflow=@var{type}
5235 @opindex Wstringop-overflow
5236 @opindex Wno-stringop-overflow
5237 Warn for calls to string manipulation functions such as @code{memcpy} and
5238 @code{strcpy} that are determined to overflow the destination buffer.  The
5239 optional argument is one greater than the type of Object Size Checking to
5240 perform to determine the size of the destination.  @xref{Object Size Checking}.
5241 The argument is meaningful only for functions that operate on character arrays
5242 but not for raw memory functions like @code{memcpy} which always make use
5243 of Object Size type-0.  The option also warns for calls that specify a size
5244 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5245 The option produces the best results with optimization enabled but can detect
5246 a small subset of simple buffer overflows even without optimization in
5247 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5248 correspond to the standard functions.  In any case, the option warns about
5249 just a subset of buffer overflows detected by the corresponding overflow
5250 checking built-ins.  For example, the option will issue a warning for
5251 the @code{strcpy} call below because it copies at least 5 characters
5252 (the string @code{"blue"} including the terminating NUL) into the buffer
5253 of size 4.
5255 @smallexample
5256 enum Color @{ blue, purple, yellow @};
5257 const char* f (enum Color clr)
5259   static char buf [4];
5260   const char *str;
5261   switch (clr)
5262     @{
5263       case blue: str = "blue"; break;
5264       case purple: str = "purple"; break;
5265       case yellow: str = "yellow"; break;
5266     @}
5268   return strcpy (buf, str);   // warning here
5270 @end smallexample
5272 Option @option{-Wstringop-overflow=2} is enabled by default.
5274 @table @gcctabopt
5275 @item -Wstringop-overflow
5276 @itemx -Wstringop-overflow=1
5277 @opindex Wstringop-overflow
5278 @opindex Wno-stringop-overflow
5279 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5280 to determine the sizes of destination objects.  This is the default setting
5281 of the option.  At this setting the option will not warn for writes past
5282 the end of subobjects of larger objects accessed by pointers unless the
5283 size of the largest surrounding object is known.  When the destination may
5284 be one of several objects it is assumed to be the largest one of them.  On
5285 Linux systems, when optimization is enabled at this setting the option warns
5286 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5287 a non-zero value.
5289 @item -Wstringop-overflow=2
5290 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5291 to determine the sizes of destination objects.  At this setting the option
5292 will warn about overflows when writing to members of the largest complete
5293 objects whose exact size is known.  It will, however, not warn for excessive
5294 writes to the same members of unknown objects referenced by pointers since
5295 they may point to arrays containing unknown numbers of elements.
5297 @item -Wstringop-overflow=3
5298 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5299 to determine the sizes of destination objects.  At this setting the option
5300 warns about overflowing the smallest object or data member.  This is the
5301 most restrictive setting of the option that may result in warnings for safe
5302 code.
5304 @item -Wstringop-overflow=4
5305 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5306 to determine the sizes of destination objects.  At this setting the option
5307 will warn about overflowing any data members, and when the destination is
5308 one of several objects it uses the size of the largest of them to decide
5309 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5310 setting of the option may result in warnings for benign code.
5311 @end table
5313 @item -Wstringop-truncation
5314 @opindex Wstringop-truncation
5315 @opindex Wno-stringop-truncation
5316 Warn for calls to bounded string manipulation functions such as @code{strncat},
5317 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5318 or leave the destination unchanged.
5320 In the following example, the call to @code{strncat} specifies a bound that
5321 is less than the length of the source string.  As a result, the copy of
5322 the source will be truncated and so the call is diagnosed.  To avoid the
5323 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5325 @smallexample
5326 void append (char *buf, size_t bufsize)
5328   strncat (buf, ".txt", 3);
5330 @end smallexample
5332 As another example, the following call to @code{strncpy} results in copying
5333 to @code{d} just the characters preceding the terminating NUL, without
5334 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5335 necessarily a NUL-terminated string is a common mistake, and so the call
5336 is diagnosed.  To avoid the warning when the result is not expected to be
5337 NUL-terminated, call @code{memcpy} instead.
5339 @smallexample
5340 void copy (char *d, const char *s)
5342   strncpy (d, s, strlen (s));
5344 @end smallexample
5346 In the following example, the call to @code{strncpy} specifies the size
5347 of the destination buffer as the bound.  If the length of the source
5348 string is equal to or greater than this size the result of the copy will
5349 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5350 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5351 element of the buffer to @code{NUL}.
5353 @smallexample
5354 void copy (const char *s)
5356   char buf[80];
5357   strncpy (buf, s, sizeof buf);
5358   @dots{}
5360 @end smallexample
5362 In situations where a character array is intended to store a sequence
5363 of bytes with no terminating @code{NUL} such an array may be annotated
5364 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5365 however, are not suitable arguments to functions that expect
5366 @code{NUL}-terminated strings.  To help detect accidental misuses of
5367 such arrays GCC issues warnings unless it can prove that the use is
5368 safe.  @xref{Common Variable Attributes}.
5370 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5371 @opindex Wsuggest-attribute=
5372 @opindex Wno-suggest-attribute=
5373 Warn for cases where adding an attribute may be beneficial. The
5374 attributes currently supported are listed below.
5376 @table @gcctabopt
5377 @item -Wsuggest-attribute=pure
5378 @itemx -Wsuggest-attribute=const
5379 @itemx -Wsuggest-attribute=noreturn
5380 @itemx -Wsuggest-attribute=malloc
5381 @opindex Wsuggest-attribute=pure
5382 @opindex Wno-suggest-attribute=pure
5383 @opindex Wsuggest-attribute=const
5384 @opindex Wno-suggest-attribute=const
5385 @opindex Wsuggest-attribute=noreturn
5386 @opindex Wno-suggest-attribute=noreturn
5387 @opindex Wsuggest-attribute=malloc
5388 @opindex Wno-suggest-attribute=malloc
5390 Warn about functions that might be candidates for attributes
5391 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5392 only warns for functions visible in other compilation units or (in the case of
5393 @code{pure} and @code{const}) if it cannot prove that the function returns
5394 normally. A function returns normally if it doesn't contain an infinite loop or
5395 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5396 requires option @option{-fipa-pure-const}, which is enabled by default at
5397 @option{-O} and higher.  Higher optimization levels improve the accuracy
5398 of the analysis.
5400 @item -Wsuggest-attribute=format
5401 @itemx -Wmissing-format-attribute
5402 @opindex Wsuggest-attribute=format
5403 @opindex Wmissing-format-attribute
5404 @opindex Wno-suggest-attribute=format
5405 @opindex Wno-missing-format-attribute
5406 @opindex Wformat
5407 @opindex Wno-format
5409 Warn about function pointers that might be candidates for @code{format}
5410 attributes.  Note these are only possible candidates, not absolute ones.
5411 GCC guesses that function pointers with @code{format} attributes that
5412 are used in assignment, initialization, parameter passing or return
5413 statements should have a corresponding @code{format} attribute in the
5414 resulting type.  I.e.@: the left-hand side of the assignment or
5415 initialization, the type of the parameter variable, or the return type
5416 of the containing function respectively should also have a @code{format}
5417 attribute to avoid the warning.
5419 GCC also warns about function definitions that might be
5420 candidates for @code{format} attributes.  Again, these are only
5421 possible candidates.  GCC guesses that @code{format} attributes
5422 might be appropriate for any function that calls a function like
5423 @code{vprintf} or @code{vscanf}, but this might not always be the
5424 case, and some functions for which @code{format} attributes are
5425 appropriate may not be detected.
5427 @item -Wsuggest-attribute=cold
5428 @opindex Wsuggest-attribute=cold
5429 @opindex Wno-suggest-attribute=cold
5431 Warn about functions that might be candidates for @code{cold} attribute.  This
5432 is based on static detection and generally will only warn about functions which
5433 always leads to a call to another @code{cold} function such as wrappers of
5434 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5435 @end table
5437 @item -Wsuggest-final-types
5438 @opindex Wno-suggest-final-types
5439 @opindex Wsuggest-final-types
5440 Warn about types with virtual methods where code quality would be improved
5441 if the type were declared with the C++11 @code{final} specifier, 
5442 or, if possible,
5443 declared in an anonymous namespace. This allows GCC to more aggressively
5444 devirtualize the polymorphic calls. This warning is more effective with link
5445 time optimization, where the information about the class hierarchy graph is
5446 more complete.
5448 @item -Wsuggest-final-methods
5449 @opindex Wno-suggest-final-methods
5450 @opindex Wsuggest-final-methods
5451 Warn about virtual methods where code quality would be improved if the method
5452 were declared with the C++11 @code{final} specifier, 
5453 or, if possible, its type were
5454 declared in an anonymous namespace or with the @code{final} specifier.
5455 This warning is
5456 more effective with link-time optimization, where the information about the
5457 class hierarchy graph is more complete. It is recommended to first consider
5458 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5459 annotations.
5461 @item -Wsuggest-override
5462 Warn about overriding virtual functions that are not marked with the override
5463 keyword.
5465 @item -Walloc-zero
5466 @opindex Wno-alloc-zero
5467 @opindex Walloc-zero
5468 Warn about calls to allocation functions decorated with attribute
5469 @code{alloc_size} that specify zero bytes, including those to the built-in
5470 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5471 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5472 when called with a zero size differs among implementations (and in the case
5473 of @code{realloc} has been deprecated) relying on it may result in subtle
5474 portability bugs and should be avoided.
5476 @item -Walloc-size-larger-than=@var{n}
5477 Warn about calls to functions decorated with attribute @code{alloc_size}
5478 that attempt to allocate objects larger than the specified number of bytes,
5479 or where the result of the size computation in an integer type with infinite
5480 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5481 may end in one of the standard suffixes designating a multiple of bytes
5482 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5483 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5484 @xref{Function Attributes}.
5486 @item -Walloca
5487 @opindex Wno-alloca
5488 @opindex Walloca
5489 This option warns on all uses of @code{alloca} in the source.
5491 @item -Walloca-larger-than=@var{n}
5492 This option warns on calls to @code{alloca} that are not bounded by a
5493 controlling predicate limiting its argument of integer type to at most
5494 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5495 Arguments of non-integer types are considered unbounded even if they
5496 appear to be constrained to the expected range.
5498 For example, a bounded case of @code{alloca} could be:
5500 @smallexample
5501 void func (size_t n)
5503   void *p;
5504   if (n <= 1000)
5505     p = alloca (n);
5506   else
5507     p = malloc (n);
5508   f (p);
5510 @end smallexample
5512 In the above example, passing @code{-Walloca-larger-than=1000} would not
5513 issue a warning because the call to @code{alloca} is known to be at most
5514 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5515 the compiler would emit a warning.
5517 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5518 controlling predicate constraining its integer argument.  For example:
5520 @smallexample
5521 void func ()
5523   void *p = alloca (n);
5524   f (p);
5526 @end smallexample
5528 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5529 a warning, but this time because of the lack of bounds checking.
5531 Note, that even seemingly correct code involving signed integers could
5532 cause a warning:
5534 @smallexample
5535 void func (signed int n)
5537   if (n < 500)
5538     @{
5539       p = alloca (n);
5540       f (p);
5541     @}
5543 @end smallexample
5545 In the above example, @var{n} could be negative, causing a larger than
5546 expected argument to be implicitly cast into the @code{alloca} call.
5548 This option also warns when @code{alloca} is used in a loop.
5550 This warning is not enabled by @option{-Wall}, and is only active when
5551 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5553 See also @option{-Wvla-larger-than=@var{n}}.
5555 @item -Warray-bounds
5556 @itemx -Warray-bounds=@var{n}
5557 @opindex Wno-array-bounds
5558 @opindex Warray-bounds
5559 This option is only active when @option{-ftree-vrp} is active
5560 (default for @option{-O2} and above). It warns about subscripts to arrays
5561 that are always out of bounds. This warning is enabled by @option{-Wall}.
5563 @table @gcctabopt
5564 @item -Warray-bounds=1
5565 This is the warning level of @option{-Warray-bounds} and is enabled
5566 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5568 @item -Warray-bounds=2
5569 This warning level also warns about out of bounds access for
5570 arrays at the end of a struct and for arrays accessed through
5571 pointers. This warning level may give a larger number of
5572 false positives and is deactivated by default.
5573 @end table
5575 @item -Wattribute-alias
5576 Warn about declarations using the @code{alias} and similar attributes whose
5577 target is incompatible with the type of the alias.  @xref{Function Attributes,
5578 ,Declaring Attributes of Functions}.
5580 @item -Wbool-compare
5581 @opindex Wno-bool-compare
5582 @opindex Wbool-compare
5583 Warn about boolean expression compared with an integer value different from
5584 @code{true}/@code{false}.  For instance, the following comparison is
5585 always false:
5586 @smallexample
5587 int n = 5;
5588 @dots{}
5589 if ((n > 1) == 2) @{ @dots{} @}
5590 @end smallexample
5591 This warning is enabled by @option{-Wall}.
5593 @item -Wbool-operation
5594 @opindex Wno-bool-operation
5595 @opindex Wbool-operation
5596 Warn about suspicious operations on expressions of a boolean type.  For
5597 instance, bitwise negation of a boolean is very likely a bug in the program.
5598 For C, this warning also warns about incrementing or decrementing a boolean,
5599 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5600 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5602 This warning is enabled by @option{-Wall}.
5604 @item -Wduplicated-branches
5605 @opindex Wno-duplicated-branches
5606 @opindex Wduplicated-branches
5607 Warn when an if-else has identical branches.  This warning detects cases like
5608 @smallexample
5609 if (p != NULL)
5610   return 0;
5611 else
5612   return 0;
5613 @end smallexample
5614 It doesn't warn when both branches contain just a null statement.  This warning
5615 also warn for conditional operators:
5616 @smallexample
5617   int i = x ? *p : *p;
5618 @end smallexample
5620 @item -Wduplicated-cond
5621 @opindex Wno-duplicated-cond
5622 @opindex Wduplicated-cond
5623 Warn about duplicated conditions in an if-else-if chain.  For instance,
5624 warn for the following code:
5625 @smallexample
5626 if (p->q != NULL) @{ @dots{} @}
5627 else if (p->q != NULL) @{ @dots{} @}
5628 @end smallexample
5630 @item -Wframe-address
5631 @opindex Wno-frame-address
5632 @opindex Wframe-address
5633 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5634 is called with an argument greater than 0.  Such calls may return indeterminate
5635 values or crash the program.  The warning is included in @option{-Wall}.
5637 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5638 @opindex Wno-discarded-qualifiers
5639 @opindex Wdiscarded-qualifiers
5640 Do not warn if type qualifiers on pointers are being discarded.
5641 Typically, the compiler warns if a @code{const char *} variable is
5642 passed to a function that takes a @code{char *} parameter.  This option
5643 can be used to suppress such a warning.
5645 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5646 @opindex Wno-discarded-array-qualifiers
5647 @opindex Wdiscarded-array-qualifiers
5648 Do not warn if type qualifiers on arrays which are pointer targets
5649 are being discarded. Typically, the compiler warns if a
5650 @code{const int (*)[]} variable is passed to a function that
5651 takes a @code{int (*)[]} parameter.  This option can be used to
5652 suppress such a warning.
5654 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5655 @opindex Wno-incompatible-pointer-types
5656 @opindex Wincompatible-pointer-types
5657 Do not warn when there is a conversion between pointers that have incompatible
5658 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5659 which warns for pointer argument passing or assignment with different
5660 signedness.
5662 @item -Wno-int-conversion @r{(C and Objective-C only)}
5663 @opindex Wno-int-conversion
5664 @opindex Wint-conversion
5665 Do not warn about incompatible integer to pointer and pointer to integer
5666 conversions.  This warning is about implicit conversions; for explicit
5667 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5668 @option{-Wno-pointer-to-int-cast} may be used.
5670 @item -Wno-div-by-zero
5671 @opindex Wno-div-by-zero
5672 @opindex Wdiv-by-zero
5673 Do not warn about compile-time integer division by zero.  Floating-point
5674 division by zero is not warned about, as it can be a legitimate way of
5675 obtaining infinities and NaNs.
5677 @item -Wsystem-headers
5678 @opindex Wsystem-headers
5679 @opindex Wno-system-headers
5680 @cindex warnings from system headers
5681 @cindex system headers, warnings from
5682 Print warning messages for constructs found in system header files.
5683 Warnings from system headers are normally suppressed, on the assumption
5684 that they usually do not indicate real problems and would only make the
5685 compiler output harder to read.  Using this command-line option tells
5686 GCC to emit warnings from system headers as if they occurred in user
5687 code.  However, note that using @option{-Wall} in conjunction with this
5688 option does @emph{not} warn about unknown pragmas in system
5689 headers---for that, @option{-Wunknown-pragmas} must also be used.
5691 @item -Wtautological-compare
5692 @opindex Wtautological-compare
5693 @opindex Wno-tautological-compare
5694 Warn if a self-comparison always evaluates to true or false.  This
5695 warning detects various mistakes such as:
5696 @smallexample
5697 int i = 1;
5698 @dots{}
5699 if (i > i) @{ @dots{} @}
5700 @end smallexample
5702 This warning also warns about bitwise comparisons that always evaluate
5703 to true or false, for instance:
5704 @smallexample
5705 if ((a & 16) == 10) @{ @dots{} @}
5706 @end smallexample
5707 will always be false.
5709 This warning is enabled by @option{-Wall}.
5711 @item -Wtrampolines
5712 @opindex Wtrampolines
5713 @opindex Wno-trampolines
5714 Warn about trampolines generated for pointers to nested functions.
5715 A trampoline is a small piece of data or code that is created at run
5716 time on the stack when the address of a nested function is taken, and is
5717 used to call the nested function indirectly.  For some targets, it is
5718 made up of data only and thus requires no special treatment.  But, for
5719 most targets, it is made up of code and thus requires the stack to be
5720 made executable in order for the program to work properly.
5722 @item -Wfloat-equal
5723 @opindex Wfloat-equal
5724 @opindex Wno-float-equal
5725 Warn if floating-point values are used in equality comparisons.
5727 The idea behind this is that sometimes it is convenient (for the
5728 programmer) to consider floating-point values as approximations to
5729 infinitely precise real numbers.  If you are doing this, then you need
5730 to compute (by analyzing the code, or in some other way) the maximum or
5731 likely maximum error that the computation introduces, and allow for it
5732 when performing comparisons (and when producing output, but that's a
5733 different problem).  In particular, instead of testing for equality, you
5734 should check to see whether the two values have ranges that overlap; and
5735 this is done with the relational operators, so equality comparisons are
5736 probably mistaken.
5738 @item -Wtraditional @r{(C and Objective-C only)}
5739 @opindex Wtraditional
5740 @opindex Wno-traditional
5741 Warn about certain constructs that behave differently in traditional and
5742 ISO C@.  Also warn about ISO C constructs that have no traditional C
5743 equivalent, and/or problematic constructs that should be avoided.
5745 @itemize @bullet
5746 @item
5747 Macro parameters that appear within string literals in the macro body.
5748 In traditional C macro replacement takes place within string literals,
5749 but in ISO C it does not.
5751 @item
5752 In traditional C, some preprocessor directives did not exist.
5753 Traditional preprocessors only considered a line to be a directive
5754 if the @samp{#} appeared in column 1 on the line.  Therefore
5755 @option{-Wtraditional} warns about directives that traditional C
5756 understands but ignores because the @samp{#} does not appear as the
5757 first character on the line.  It also suggests you hide directives like
5758 @code{#pragma} not understood by traditional C by indenting them.  Some
5759 traditional implementations do not recognize @code{#elif}, so this option
5760 suggests avoiding it altogether.
5762 @item
5763 A function-like macro that appears without arguments.
5765 @item
5766 The unary plus operator.
5768 @item
5769 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5770 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5771 constants.)  Note, these suffixes appear in macros defined in the system
5772 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5773 Use of these macros in user code might normally lead to spurious
5774 warnings, however GCC's integrated preprocessor has enough context to
5775 avoid warning in these cases.
5777 @item
5778 A function declared external in one block and then used after the end of
5779 the block.
5781 @item
5782 A @code{switch} statement has an operand of type @code{long}.
5784 @item
5785 A non-@code{static} function declaration follows a @code{static} one.
5786 This construct is not accepted by some traditional C compilers.
5788 @item
5789 The ISO type of an integer constant has a different width or
5790 signedness from its traditional type.  This warning is only issued if
5791 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5792 typically represent bit patterns, are not warned about.
5794 @item
5795 Usage of ISO string concatenation is detected.
5797 @item
5798 Initialization of automatic aggregates.
5800 @item
5801 Identifier conflicts with labels.  Traditional C lacks a separate
5802 namespace for labels.
5804 @item
5805 Initialization of unions.  If the initializer is zero, the warning is
5806 omitted.  This is done under the assumption that the zero initializer in
5807 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5808 initializer warnings and relies on default initialization to zero in the
5809 traditional C case.
5811 @item
5812 Conversions by prototypes between fixed/floating-point values and vice
5813 versa.  The absence of these prototypes when compiling with traditional
5814 C causes serious problems.  This is a subset of the possible
5815 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5817 @item
5818 Use of ISO C style function definitions.  This warning intentionally is
5819 @emph{not} issued for prototype declarations or variadic functions
5820 because these ISO C features appear in your code when using
5821 libiberty's traditional C compatibility macros, @code{PARAMS} and
5822 @code{VPARAMS}.  This warning is also bypassed for nested functions
5823 because that feature is already a GCC extension and thus not relevant to
5824 traditional C compatibility.
5825 @end itemize
5827 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5828 @opindex Wtraditional-conversion
5829 @opindex Wno-traditional-conversion
5830 Warn if a prototype causes a type conversion that is different from what
5831 would happen to the same argument in the absence of a prototype.  This
5832 includes conversions of fixed point to floating and vice versa, and
5833 conversions changing the width or signedness of a fixed-point argument
5834 except when the same as the default promotion.
5836 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5837 @opindex Wdeclaration-after-statement
5838 @opindex Wno-declaration-after-statement
5839 Warn when a declaration is found after a statement in a block.  This
5840 construct, known from C++, was introduced with ISO C99 and is by default
5841 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5843 @item -Wshadow
5844 @opindex Wshadow
5845 @opindex Wno-shadow
5846 Warn whenever a local variable or type declaration shadows another
5847 variable, parameter, type, class member (in C++), or instance variable
5848 (in Objective-C) or whenever a built-in function is shadowed. Note
5849 that in C++, the compiler warns if a local variable shadows an
5850 explicit typedef, but not if it shadows a struct/class/enum.
5851 Same as @option{-Wshadow=global}.
5853 @item -Wno-shadow-ivar @r{(Objective-C only)}
5854 @opindex Wno-shadow-ivar
5855 @opindex Wshadow-ivar
5856 Do not warn whenever a local variable shadows an instance variable in an
5857 Objective-C method.
5859 @item -Wshadow=global
5860 @opindex Wshadow=local
5861 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5863 @item -Wshadow=local
5864 @opindex Wshadow=local
5865 Warn when a local variable shadows another local variable or parameter.
5866 This warning is enabled by @option{-Wshadow=global}.
5868 @item -Wshadow=compatible-local
5869 @opindex Wshadow=compatible-local
5870 Warn when a local variable shadows another local variable or parameter
5871 whose type is compatible with that of the shadowing variable. In C++,
5872 type compatibility here means the type of the shadowing variable can be
5873 converted to that of the shadowed variable. The creation of this flag
5874 (in addition to @option{-Wshadow=local}) is based on the idea that when
5875 a local variable shadows another one of incompatible type, it is most
5876 likely intentional, not a bug or typo, as shown in the following example:
5878 @smallexample
5879 @group
5880 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5882   for (int i = 0; i < N; ++i)
5883   @{
5884     ...
5885   @}
5886   ...
5888 @end group
5889 @end smallexample
5891 Since the two variable @code{i} in the example above have incompatible types,
5892 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5893 Because their types are incompatible, if a programmer accidentally uses one
5894 in place of the other, type checking will catch that and emit an error or
5895 warning. So not warning (about shadowing) in this case will not lead to
5896 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5897 possibly reduce the number of warnings triggered by intentional shadowing.
5899 This warning is enabled by @option{-Wshadow=local}.
5901 @item -Wlarger-than=@var{len}
5902 @opindex Wlarger-than=@var{len}
5903 @opindex Wlarger-than-@var{len}
5904 Warn whenever an object of larger than @var{len} bytes is defined.
5906 @item -Wframe-larger-than=@var{len}
5907 @opindex Wframe-larger-than
5908 Warn if the size of a function frame is larger than @var{len} bytes.
5909 The computation done to determine the stack frame size is approximate
5910 and not conservative.
5911 The actual requirements may be somewhat greater than @var{len}
5912 even if you do not get a warning.  In addition, any space allocated
5913 via @code{alloca}, variable-length arrays, or related constructs
5914 is not included by the compiler when determining
5915 whether or not to issue a warning.
5917 @item -Wno-free-nonheap-object
5918 @opindex Wno-free-nonheap-object
5919 @opindex Wfree-nonheap-object
5920 Do not warn when attempting to free an object that was not allocated
5921 on the heap.
5923 @item -Wstack-usage=@var{len}
5924 @opindex Wstack-usage
5925 Warn if the stack usage of a function might be larger than @var{len} bytes.
5926 The computation done to determine the stack usage is conservative.
5927 Any space allocated via @code{alloca}, variable-length arrays, or related
5928 constructs is included by the compiler when determining whether or not to
5929 issue a warning.
5931 The message is in keeping with the output of @option{-fstack-usage}.
5933 @itemize
5934 @item
5935 If the stack usage is fully static but exceeds the specified amount, it's:
5937 @smallexample
5938   warning: stack usage is 1120 bytes
5939 @end smallexample
5940 @item
5941 If the stack usage is (partly) dynamic but bounded, it's:
5943 @smallexample
5944   warning: stack usage might be 1648 bytes
5945 @end smallexample
5946 @item
5947 If the stack usage is (partly) dynamic and not bounded, it's:
5949 @smallexample
5950   warning: stack usage might be unbounded
5951 @end smallexample
5952 @end itemize
5954 @item -Wunsafe-loop-optimizations
5955 @opindex Wunsafe-loop-optimizations
5956 @opindex Wno-unsafe-loop-optimizations
5957 Warn if the loop cannot be optimized because the compiler cannot
5958 assume anything on the bounds of the loop indices.  With
5959 @option{-funsafe-loop-optimizations} warn if the compiler makes
5960 such assumptions.
5962 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5963 @opindex Wno-pedantic-ms-format
5964 @opindex Wpedantic-ms-format
5965 When used in combination with @option{-Wformat}
5966 and @option{-pedantic} without GNU extensions, this option
5967 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5968 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5969 which depend on the MS runtime.
5971 @item -Waligned-new
5972 @opindex Waligned-new
5973 @opindex Wno-aligned-new
5974 Warn about a new-expression of a type that requires greater alignment
5975 than the @code{alignof(std::max_align_t)} but uses an allocation
5976 function without an explicit alignment parameter. This option is
5977 enabled by @option{-Wall}.
5979 Normally this only warns about global allocation functions, but
5980 @option{-Waligned-new=all} also warns about class member allocation
5981 functions.
5983 @item -Wplacement-new
5984 @itemx -Wplacement-new=@var{n}
5985 @opindex Wplacement-new
5986 @opindex Wno-placement-new
5987 Warn about placement new expressions with undefined behavior, such as
5988 constructing an object in a buffer that is smaller than the type of
5989 the object.  For example, the placement new expression below is diagnosed
5990 because it attempts to construct an array of 64 integers in a buffer only
5991 64 bytes large.
5992 @smallexample
5993 char buf [64];
5994 new (buf) int[64];
5995 @end smallexample
5996 This warning is enabled by default.
5998 @table @gcctabopt
5999 @item -Wplacement-new=1
6000 This is the default warning level of @option{-Wplacement-new}.  At this
6001 level the warning is not issued for some strictly undefined constructs that
6002 GCC allows as extensions for compatibility with legacy code.  For example,
6003 the following @code{new} expression is not diagnosed at this level even
6004 though it has undefined behavior according to the C++ standard because
6005 it writes past the end of the one-element array.
6006 @smallexample
6007 struct S @{ int n, a[1]; @};
6008 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6009 new (s->a)int [32]();
6010 @end smallexample
6012 @item -Wplacement-new=2
6013 At this level, in addition to diagnosing all the same constructs as at level
6014 1, a diagnostic is also issued for placement new expressions that construct
6015 an object in the last member of structure whose type is an array of a single
6016 element and whose size is less than the size of the object being constructed.
6017 While the previous example would be diagnosed, the following construct makes
6018 use of the flexible member array extension to avoid the warning at level 2.
6019 @smallexample
6020 struct S @{ int n, a[]; @};
6021 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6022 new (s->a)int [32]();
6023 @end smallexample
6025 @end table
6027 @item -Wpointer-arith
6028 @opindex Wpointer-arith
6029 @opindex Wno-pointer-arith
6030 Warn about anything that depends on the ``size of'' a function type or
6031 of @code{void}.  GNU C assigns these types a size of 1, for
6032 convenience in calculations with @code{void *} pointers and pointers
6033 to functions.  In C++, warn also when an arithmetic operation involves
6034 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6036 @item -Wpointer-compare
6037 @opindex Wpointer-compare
6038 @opindex Wno-pointer-compare
6039 Warn if a pointer is compared with a zero character constant.  This usually
6040 means that the pointer was meant to be dereferenced.  For example:
6042 @smallexample
6043 const char *p = foo ();
6044 if (p == '\0')
6045   return 42;
6046 @end smallexample
6048 Note that the code above is invalid in C++11.
6050 This warning is enabled by default.
6052 @item -Wtype-limits
6053 @opindex Wtype-limits
6054 @opindex Wno-type-limits
6055 Warn if a comparison is always true or always false due to the limited
6056 range of the data type, but do not warn for constant expressions.  For
6057 example, warn if an unsigned variable is compared against zero with
6058 @code{<} or @code{>=}.  This warning is also enabled by
6059 @option{-Wextra}.
6061 @include cppwarnopts.texi
6063 @item -Wbad-function-cast @r{(C and Objective-C only)}
6064 @opindex Wbad-function-cast
6065 @opindex Wno-bad-function-cast
6066 Warn when a function call is cast to a non-matching type.
6067 For example, warn if a call to a function returning an integer type 
6068 is cast to a pointer type.
6070 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6071 @opindex Wc90-c99-compat
6072 @opindex Wno-c90-c99-compat
6073 Warn about features not present in ISO C90, but present in ISO C99.
6074 For instance, warn about use of variable length arrays, @code{long long}
6075 type, @code{bool} type, compound literals, designated initializers, and so
6076 on.  This option is independent of the standards mode.  Warnings are disabled
6077 in the expression that follows @code{__extension__}.
6079 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6080 @opindex Wc99-c11-compat
6081 @opindex Wno-c99-c11-compat
6082 Warn about features not present in ISO C99, but present in ISO C11.
6083 For instance, warn about use of anonymous structures and unions,
6084 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6085 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6086 and so on.  This option is independent of the standards mode.  Warnings are
6087 disabled in the expression that follows @code{__extension__}.
6089 @item -Wc++-compat @r{(C and Objective-C only)}
6090 @opindex Wc++-compat
6091 Warn about ISO C constructs that are outside of the common subset of
6092 ISO C and ISO C++, e.g.@: request for implicit conversion from
6093 @code{void *} to a pointer to non-@code{void} type.
6095 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6096 @opindex Wc++11-compat
6097 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6098 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6099 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6100 enabled by @option{-Wall}.
6102 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6103 @opindex Wc++14-compat
6104 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6105 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6107 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6108 @opindex Wc++17-compat
6109 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6110 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6112 @item -Wcast-qual
6113 @opindex Wcast-qual
6114 @opindex Wno-cast-qual
6115 Warn whenever a pointer is cast so as to remove a type qualifier from
6116 the target type.  For example, warn if a @code{const char *} is cast
6117 to an ordinary @code{char *}.
6119 Also warn when making a cast that introduces a type qualifier in an
6120 unsafe way.  For example, casting @code{char **} to @code{const char **}
6121 is unsafe, as in this example:
6123 @smallexample
6124   /* p is char ** value.  */
6125   const char **q = (const char **) p;
6126   /* Assignment of readonly string to const char * is OK.  */
6127   *q = "string";
6128   /* Now char** pointer points to read-only memory.  */
6129   **p = 'b';
6130 @end smallexample
6132 @item -Wcast-align
6133 @opindex Wcast-align
6134 @opindex Wno-cast-align
6135 Warn whenever a pointer is cast such that the required alignment of the
6136 target is increased.  For example, warn if a @code{char *} is cast to
6137 an @code{int *} on machines where integers can only be accessed at
6138 two- or four-byte boundaries.
6140 @item -Wcast-align=strict
6141 @opindex Wcast-align=strict
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 *} regardless of the target machine.
6146 @item -Wcast-function-type
6147 @opindex Wcast-function-type
6148 @opindex Wno-cast-function-type
6149 Warn when a function pointer is cast to an incompatible function pointer.
6150 In a cast involving function types with a variable argument list only
6151 the types of initial arguments that are provided are considered.
6152 Any parameter of pointer-type matches any other pointer-type.  Any benign
6153 differences in integral types are ignored, like @code{int} vs. @code{long}
6154 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6155 type @code{void (*) (void)} is special and matches everything, which can
6156 be used to suppress this warning.
6157 In a cast involving pointer to member types this warning warns whenever
6158 the type cast is changing the pointer to member type.
6159 This warning is enabled by @option{-Wextra}.
6161 @item -Wwrite-strings
6162 @opindex Wwrite-strings
6163 @opindex Wno-write-strings
6164 When compiling C, give string constants the type @code{const
6165 char[@var{length}]} so that copying the address of one into a
6166 non-@code{const} @code{char *} pointer produces a warning.  These
6167 warnings help you find at compile time code that can try to write
6168 into a string constant, but only if you have been very careful about
6169 using @code{const} in declarations and prototypes.  Otherwise, it is
6170 just a nuisance. This is why we did not make @option{-Wall} request
6171 these warnings.
6173 When compiling C++, warn about the deprecated conversion from string
6174 literals to @code{char *}.  This warning is enabled by default for C++
6175 programs.
6177 @item -Wcatch-value
6178 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6179 @opindex Wcatch-value
6180 @opindex Wno-catch-value
6181 Warn about catch handlers that do not catch via reference.
6182 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6183 warn about polymorphic class types that are caught by value.
6184 With @option{-Wcatch-value=2} warn about all class types that are caught
6185 by value. With @option{-Wcatch-value=3} warn about all types that are
6186 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6188 @item -Wclobbered
6189 @opindex Wclobbered
6190 @opindex Wno-clobbered
6191 Warn for variables that might be changed by @code{longjmp} or
6192 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6194 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6195 @opindex Wconditionally-supported
6196 @opindex Wno-conditionally-supported
6197 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6199 @item -Wconversion
6200 @opindex Wconversion
6201 @opindex Wno-conversion
6202 Warn for implicit conversions that may alter a value. This includes
6203 conversions between real and integer, like @code{abs (x)} when
6204 @code{x} is @code{double}; conversions between signed and unsigned,
6205 like @code{unsigned ui = -1}; and conversions to smaller types, like
6206 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6207 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6208 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6209 conversions between signed and unsigned integers can be disabled by
6210 using @option{-Wno-sign-conversion}.
6212 For C++, also warn for confusing overload resolution for user-defined
6213 conversions; and conversions that never use a type conversion
6214 operator: conversions to @code{void}, the same type, a base class or a
6215 reference to them. Warnings about conversions between signed and
6216 unsigned integers are disabled by default in C++ unless
6217 @option{-Wsign-conversion} is explicitly enabled.
6219 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6220 @opindex Wconversion-null
6221 @opindex Wno-conversion-null
6222 Do not warn for conversions between @code{NULL} and non-pointer
6223 types. @option{-Wconversion-null} is enabled by default.
6225 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6226 @opindex Wzero-as-null-pointer-constant
6227 @opindex Wno-zero-as-null-pointer-constant
6228 Warn when a literal @samp{0} is used as null pointer constant.  This can
6229 be useful to facilitate the conversion to @code{nullptr} in C++11.
6231 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6232 @opindex Wsubobject-linkage
6233 @opindex Wno-subobject-linkage
6234 Warn if a class type has a base or a field whose type uses the anonymous
6235 namespace or depends on a type with no linkage.  If a type A depends on
6236 a type B with no or internal linkage, defining it in multiple
6237 translation units would be an ODR violation because the meaning of B
6238 is different in each translation unit.  If A only appears in a single
6239 translation unit, the best way to silence the warning is to give it
6240 internal linkage by putting it in an anonymous namespace as well.  The
6241 compiler doesn't give this warning for types defined in the main .C
6242 file, as those are unlikely to have multiple definitions.
6243 @option{-Wsubobject-linkage} is enabled by default.
6245 @item -Wdangling-else
6246 @opindex Wdangling-else
6247 @opindex Wno-dangling-else
6248 Warn about constructions where there may be confusion to which
6249 @code{if} statement an @code{else} branch belongs.  Here is an example of
6250 such a case:
6252 @smallexample
6253 @group
6255   if (a)
6256     if (b)
6257       foo ();
6258   else
6259     bar ();
6261 @end group
6262 @end smallexample
6264 In C/C++, every @code{else} branch belongs to the innermost possible
6265 @code{if} statement, which in this example is @code{if (b)}.  This is
6266 often not what the programmer expected, as illustrated in the above
6267 example by indentation the programmer chose.  When there is the
6268 potential for this confusion, GCC issues a warning when this flag
6269 is specified.  To eliminate the warning, add explicit braces around
6270 the innermost @code{if} statement so there is no way the @code{else}
6271 can belong to the enclosing @code{if}.  The resulting code
6272 looks like this:
6274 @smallexample
6275 @group
6277   if (a)
6278     @{
6279       if (b)
6280         foo ();
6281       else
6282         bar ();
6283     @}
6285 @end group
6286 @end smallexample
6288 This warning is enabled by @option{-Wparentheses}.
6290 @item -Wdate-time
6291 @opindex Wdate-time
6292 @opindex Wno-date-time
6293 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6294 are encountered as they might prevent bit-wise-identical reproducible
6295 compilations.
6297 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6298 @opindex Wdelete-incomplete
6299 @opindex Wno-delete-incomplete
6300 Warn when deleting a pointer to incomplete type, which may cause
6301 undefined behavior at runtime.  This warning is enabled by default.
6303 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6304 @opindex Wuseless-cast
6305 @opindex Wno-useless-cast
6306 Warn when an expression is casted to its own type.
6308 @item -Wempty-body
6309 @opindex Wempty-body
6310 @opindex Wno-empty-body
6311 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6312 while} statement.  This warning is also enabled by @option{-Wextra}.
6314 @item -Wenum-compare
6315 @opindex Wenum-compare
6316 @opindex Wno-enum-compare
6317 Warn about a comparison between values of different enumerated types.
6318 In C++ enumerated type mismatches in conditional expressions are also
6319 diagnosed and the warning is enabled by default.  In C this warning is 
6320 enabled by @option{-Wall}.
6322 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6323 @opindex Wextra-semi
6324 @opindex Wno-extra-semi
6325 Warn about redundant semicolon after in-class function definition.
6327 @item -Wjump-misses-init @r{(C, Objective-C only)}
6328 @opindex Wjump-misses-init
6329 @opindex Wno-jump-misses-init
6330 Warn if a @code{goto} statement or a @code{switch} statement jumps
6331 forward across the initialization of a variable, or jumps backward to a
6332 label after the variable has been initialized.  This only warns about
6333 variables that are initialized when they are declared.  This warning is
6334 only supported for C and Objective-C; in C++ this sort of branch is an
6335 error in any case.
6337 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6338 can be disabled with the @option{-Wno-jump-misses-init} option.
6340 @item -Wsign-compare
6341 @opindex Wsign-compare
6342 @opindex Wno-sign-compare
6343 @cindex warning for comparison of signed and unsigned values
6344 @cindex comparison of signed and unsigned values, warning
6345 @cindex signed and unsigned values, comparison warning
6346 Warn when a comparison between signed and unsigned values could produce
6347 an incorrect result when the signed value is converted to unsigned.
6348 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6349 also enabled by @option{-Wextra}.
6351 @item -Wsign-conversion
6352 @opindex Wsign-conversion
6353 @opindex Wno-sign-conversion
6354 Warn for implicit conversions that may change the sign of an integer
6355 value, like assigning a signed integer expression to an unsigned
6356 integer variable. An explicit cast silences the warning. In C, this
6357 option is enabled also by @option{-Wconversion}.
6359 @item -Wfloat-conversion
6360 @opindex Wfloat-conversion
6361 @opindex Wno-float-conversion
6362 Warn for implicit conversions that reduce the precision of a real value.
6363 This includes conversions from real to integer, and from higher precision
6364 real to lower precision real values.  This option is also enabled by
6365 @option{-Wconversion}.
6367 @item -Wno-scalar-storage-order
6368 @opindex -Wno-scalar-storage-order
6369 @opindex -Wscalar-storage-order
6370 Do not warn on suspicious constructs involving reverse scalar storage order.
6372 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6373 @opindex Wsized-deallocation
6374 @opindex Wno-sized-deallocation
6375 Warn about a definition of an unsized deallocation function
6376 @smallexample
6377 void operator delete (void *) noexcept;
6378 void operator delete[] (void *) noexcept;
6379 @end smallexample
6380 without a definition of the corresponding sized deallocation function
6381 @smallexample
6382 void operator delete (void *, std::size_t) noexcept;
6383 void operator delete[] (void *, std::size_t) noexcept;
6384 @end smallexample
6385 or vice versa.  Enabled by @option{-Wextra} along with
6386 @option{-fsized-deallocation}.
6388 @item -Wsizeof-pointer-div
6389 @opindex Wsizeof-pointer-div
6390 @opindex Wno-sizeof-pointer-div
6391 Warn for suspicious divisions of two sizeof expressions that divide
6392 the pointer size by the element size, which is the usual way to compute
6393 the array size but won't work out correctly with pointers.  This warning
6394 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6395 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6397 @item -Wsizeof-pointer-memaccess
6398 @opindex Wsizeof-pointer-memaccess
6399 @opindex Wno-sizeof-pointer-memaccess
6400 Warn for suspicious length parameters to certain string and memory built-in
6401 functions if the argument uses @code{sizeof}.  This warning triggers for
6402 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6403 an array, but a pointer, and suggests a possible fix, or about
6404 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6405 also warns about calls to bounded string copy functions like @code{strncat}
6406 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6407 the source array.  For example, in the following function the call to
6408 @code{strncat} specifies the size of the source string as the bound.  That
6409 is almost certainly a mistake and so the call is diagnosed.
6410 @smallexample
6411 void make_file (const char *name)
6413   char path[PATH_MAX];
6414   strncpy (path, name, sizeof path - 1);
6415   strncat (path, ".text", sizeof ".text");
6416   @dots{}
6418 @end smallexample
6420 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6422 @item -Wsizeof-array-argument
6423 @opindex Wsizeof-array-argument
6424 @opindex Wno-sizeof-array-argument
6425 Warn when the @code{sizeof} operator is applied to a parameter that is
6426 declared as an array in a function definition.  This warning is enabled by
6427 default for C and C++ programs.
6429 @item -Wmemset-elt-size
6430 @opindex Wmemset-elt-size
6431 @opindex Wno-memset-elt-size
6432 Warn for suspicious calls to the @code{memset} built-in function, if the
6433 first argument references an array, and the third argument is a number
6434 equal to the number of elements, but not equal to the size of the array
6435 in memory.  This indicates that the user has omitted a multiplication by
6436 the element size.  This warning is enabled by @option{-Wall}.
6438 @item -Wmemset-transposed-args
6439 @opindex Wmemset-transposed-args
6440 @opindex Wno-memset-transposed-args
6441 Warn for suspicious calls to the @code{memset} built-in function, if the
6442 second argument is not zero and the third argument is zero.  This warns e.g.@
6443 about @code{memset (buf, sizeof buf, 0)} where most probably
6444 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6445 is only emitted if the third argument is literal zero.  If it is some
6446 expression that is folded to zero, a cast of zero to some type, etc., 
6447 it is far less likely that the user has mistakenly exchanged the arguments 
6448 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6450 @item -Waddress
6451 @opindex Waddress
6452 @opindex Wno-address
6453 Warn about suspicious uses of memory addresses. These include using
6454 the address of a function in a conditional expression, such as
6455 @code{void func(void); if (func)}, and comparisons against the memory
6456 address of a string literal, such as @code{if (x == "abc")}.  Such
6457 uses typically indicate a programmer error: the address of a function
6458 always evaluates to true, so their use in a conditional usually
6459 indicate that the programmer forgot the parentheses in a function
6460 call; and comparisons against string literals result in unspecified
6461 behavior and are not portable in C, so they usually indicate that the
6462 programmer intended to use @code{strcmp}.  This warning is enabled by
6463 @option{-Wall}.
6465 @item -Wlogical-op
6466 @opindex Wlogical-op
6467 @opindex Wno-logical-op
6468 Warn about suspicious uses of logical operators in expressions.
6469 This includes using logical operators in contexts where a
6470 bit-wise operator is likely to be expected.  Also warns when
6471 the operands of a logical operator are the same:
6472 @smallexample
6473 extern int a;
6474 if (a < 0 && a < 0) @{ @dots{} @}
6475 @end smallexample
6477 @item -Wlogical-not-parentheses
6478 @opindex Wlogical-not-parentheses
6479 @opindex Wno-logical-not-parentheses
6480 Warn about logical not used on the left hand side operand of a comparison.
6481 This option does not warn if the right operand is considered to be a boolean
6482 expression.  Its purpose is to detect suspicious code like the following:
6483 @smallexample
6484 int a;
6485 @dots{}
6486 if (!a > 1) @{ @dots{} @}
6487 @end smallexample
6489 It is possible to suppress the warning by wrapping the LHS into
6490 parentheses:
6491 @smallexample
6492 if ((!a) > 1) @{ @dots{} @}
6493 @end smallexample
6495 This warning is enabled by @option{-Wall}.
6497 @item -Waggregate-return
6498 @opindex Waggregate-return
6499 @opindex Wno-aggregate-return
6500 Warn if any functions that return structures or unions are defined or
6501 called.  (In languages where you can return an array, this also elicits
6502 a warning.)
6504 @item -Wno-aggressive-loop-optimizations
6505 @opindex Wno-aggressive-loop-optimizations
6506 @opindex Waggressive-loop-optimizations
6507 Warn if in a loop with constant number of iterations the compiler detects
6508 undefined behavior in some statement during one or more of the iterations.
6510 @item -Wno-attributes
6511 @opindex Wno-attributes
6512 @opindex Wattributes
6513 Do not warn if an unexpected @code{__attribute__} is used, such as
6514 unrecognized attributes, function attributes applied to variables,
6515 etc.  This does not stop errors for incorrect use of supported
6516 attributes.
6518 @item -Wno-builtin-declaration-mismatch
6519 @opindex Wno-builtin-declaration-mismatch
6520 @opindex Wbuiltin-declaration-mismatch
6521 Warn if a built-in function is declared with the wrong signature or 
6522 as non-function.
6523 This warning is enabled by default.
6525 @item -Wno-builtin-macro-redefined
6526 @opindex Wno-builtin-macro-redefined
6527 @opindex Wbuiltin-macro-redefined
6528 Do not warn if certain built-in macros are redefined.  This suppresses
6529 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6530 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6532 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6533 @opindex Wstrict-prototypes
6534 @opindex Wno-strict-prototypes
6535 Warn if a function is declared or defined without specifying the
6536 argument types.  (An old-style function definition is permitted without
6537 a warning if preceded by a declaration that specifies the argument
6538 types.)
6540 @item -Wold-style-declaration @r{(C and Objective-C only)}
6541 @opindex Wold-style-declaration
6542 @opindex Wno-old-style-declaration
6543 Warn for obsolescent usages, according to the C Standard, in a
6544 declaration. For example, warn if storage-class specifiers like
6545 @code{static} are not the first things in a declaration.  This warning
6546 is also enabled by @option{-Wextra}.
6548 @item -Wold-style-definition @r{(C and Objective-C only)}
6549 @opindex Wold-style-definition
6550 @opindex Wno-old-style-definition
6551 Warn if an old-style function definition is used.  A warning is given
6552 even if there is a previous prototype.
6554 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6555 @opindex Wmissing-parameter-type
6556 @opindex Wno-missing-parameter-type
6557 A function parameter is declared without a type specifier in K&R-style
6558 functions:
6560 @smallexample
6561 void foo(bar) @{ @}
6562 @end smallexample
6564 This warning is also enabled by @option{-Wextra}.
6566 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6567 @opindex Wmissing-prototypes
6568 @opindex Wno-missing-prototypes
6569 Warn if a global function is defined without a previous prototype
6570 declaration.  This warning is issued even if the definition itself
6571 provides a prototype.  Use this option to detect global functions
6572 that do not have a matching prototype declaration in a header file.
6573 This option is not valid for C++ because all function declarations
6574 provide prototypes and a non-matching declaration declares an
6575 overload rather than conflict with an earlier declaration.
6576 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6578 @item -Wmissing-declarations
6579 @opindex Wmissing-declarations
6580 @opindex Wno-missing-declarations
6581 Warn if a global function is defined without a previous declaration.
6582 Do so even if the definition itself provides a prototype.
6583 Use this option to detect global functions that are not declared in
6584 header files.  In C, no warnings are issued for functions with previous
6585 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6586 missing prototypes.  In C++, no warnings are issued for function templates,
6587 or for inline functions, or for functions in anonymous namespaces.
6589 @item -Wmissing-field-initializers
6590 @opindex Wmissing-field-initializers
6591 @opindex Wno-missing-field-initializers
6592 @opindex W
6593 @opindex Wextra
6594 @opindex Wno-extra
6595 Warn if a structure's initializer has some fields missing.  For
6596 example, the following code causes such a warning, because
6597 @code{x.h} is implicitly zero:
6599 @smallexample
6600 struct s @{ int f, g, h; @};
6601 struct s x = @{ 3, 4 @};
6602 @end smallexample
6604 This option does not warn about designated initializers, so the following
6605 modification does not trigger a warning:
6607 @smallexample
6608 struct s @{ int f, g, h; @};
6609 struct s x = @{ .f = 3, .g = 4 @};
6610 @end smallexample
6612 In C this option does not warn about the universal zero initializer
6613 @samp{@{ 0 @}}:
6615 @smallexample
6616 struct s @{ int f, g, h; @};
6617 struct s x = @{ 0 @};
6618 @end smallexample
6620 Likewise, in C++ this option does not warn about the empty @{ @}
6621 initializer, for example:
6623 @smallexample
6624 struct s @{ int f, g, h; @};
6625 s x = @{ @};
6626 @end smallexample
6628 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6629 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6631 @item -Wno-multichar
6632 @opindex Wno-multichar
6633 @opindex Wmultichar
6634 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6635 Usually they indicate a typo in the user's code, as they have
6636 implementation-defined values, and should not be used in portable code.
6638 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6639 @opindex Wnormalized=
6640 @opindex Wnormalized
6641 @opindex Wno-normalized
6642 @cindex NFC
6643 @cindex NFKC
6644 @cindex character set, input normalization
6645 In ISO C and ISO C++, two identifiers are different if they are
6646 different sequences of characters.  However, sometimes when characters
6647 outside the basic ASCII character set are used, you can have two
6648 different character sequences that look the same.  To avoid confusion,
6649 the ISO 10646 standard sets out some @dfn{normalization rules} which
6650 when applied ensure that two sequences that look the same are turned into
6651 the same sequence.  GCC can warn you if you are using identifiers that
6652 have not been normalized; this option controls that warning.
6654 There are four levels of warning supported by GCC@.  The default is
6655 @option{-Wnormalized=nfc}, which warns about any identifier that is
6656 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6657 recommended form for most uses.  It is equivalent to
6658 @option{-Wnormalized}.
6660 Unfortunately, there are some characters allowed in identifiers by
6661 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6662 identifiers.  That is, there's no way to use these symbols in portable
6663 ISO C or C++ and have all your identifiers in NFC@.
6664 @option{-Wnormalized=id} suppresses the warning for these characters.
6665 It is hoped that future versions of the standards involved will correct
6666 this, which is why this option is not the default.
6668 You can switch the warning off for all characters by writing
6669 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6670 only do this if you are using some other normalization scheme (like
6671 ``D''), because otherwise you can easily create bugs that are
6672 literally impossible to see.
6674 Some characters in ISO 10646 have distinct meanings but look identical
6675 in some fonts or display methodologies, especially once formatting has
6676 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6677 LETTER N'', displays just like a regular @code{n} that has been
6678 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6679 normalization scheme to convert all these into a standard form as
6680 well, and GCC warns if your code is not in NFKC if you use
6681 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6682 about every identifier that contains the letter O because it might be
6683 confused with the digit 0, and so is not the default, but may be
6684 useful as a local coding convention if the programming environment 
6685 cannot be fixed to display these characters distinctly.
6687 @item -Wno-deprecated
6688 @opindex Wno-deprecated
6689 @opindex Wdeprecated
6690 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6692 @item -Wno-deprecated-declarations
6693 @opindex Wno-deprecated-declarations
6694 @opindex Wdeprecated-declarations
6695 Do not warn about uses of functions (@pxref{Function Attributes}),
6696 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6697 Attributes}) marked as deprecated by using the @code{deprecated}
6698 attribute.
6700 @item -Wno-overflow
6701 @opindex Wno-overflow
6702 @opindex Woverflow
6703 Do not warn about compile-time overflow in constant expressions.
6705 @item -Wno-odr
6706 @opindex Wno-odr
6707 @opindex Wodr
6708 Warn about One Definition Rule violations during link-time optimization.
6709 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6711 @item -Wopenmp-simd
6712 @opindex Wopenm-simd
6713 Warn if the vectorizer cost model overrides the OpenMP
6714 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6715 option can be used to relax the cost model.
6717 @item -Woverride-init @r{(C and Objective-C only)}
6718 @opindex Woverride-init
6719 @opindex Wno-override-init
6720 @opindex W
6721 @opindex Wextra
6722 @opindex Wno-extra
6723 Warn if an initialized field without side effects is overridden when
6724 using designated initializers (@pxref{Designated Inits, , Designated
6725 Initializers}).
6727 This warning is included in @option{-Wextra}.  To get other
6728 @option{-Wextra} warnings without this one, use @option{-Wextra
6729 -Wno-override-init}.
6731 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6732 @opindex Woverride-init-side-effects
6733 @opindex Wno-override-init-side-effects
6734 Warn if an initialized field with side effects is overridden when
6735 using designated initializers (@pxref{Designated Inits, , Designated
6736 Initializers}).  This warning is enabled by default.
6738 @item -Wpacked
6739 @opindex Wpacked
6740 @opindex Wno-packed
6741 Warn if a structure is given the packed attribute, but the packed
6742 attribute has no effect on the layout or size of the structure.
6743 Such structures may be mis-aligned for little benefit.  For
6744 instance, in this code, the variable @code{f.x} in @code{struct bar}
6745 is misaligned even though @code{struct bar} does not itself
6746 have the packed attribute:
6748 @smallexample
6749 @group
6750 struct foo @{
6751   int x;
6752   char a, b, c, d;
6753 @} __attribute__((packed));
6754 struct bar @{
6755   char z;
6756   struct foo f;
6758 @end group
6759 @end smallexample
6761 @item -Wpacked-bitfield-compat
6762 @opindex Wpacked-bitfield-compat
6763 @opindex Wno-packed-bitfield-compat
6764 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6765 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6766 the change can lead to differences in the structure layout.  GCC
6767 informs you when the offset of such a field has changed in GCC 4.4.
6768 For example there is no longer a 4-bit padding between field @code{a}
6769 and @code{b} in this structure:
6771 @smallexample
6772 struct foo
6774   char a:4;
6775   char b:8;
6776 @} __attribute__ ((packed));
6777 @end smallexample
6779 This warning is enabled by default.  Use
6780 @option{-Wno-packed-bitfield-compat} to disable this warning.
6782 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6783 @opindex Wpacked-not-aligned
6784 @opindex Wno-packed-not-aligned
6785 Warn if a structure field with explicitly specified alignment in a
6786 packed struct or union is misaligned.  For example, a warning will
6787 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6788 'struct S' is less than 8}, in this code:
6790 @smallexample
6791 @group
6792 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6793 struct __attribute__ ((packed)) S @{
6794   struct S8 s8;
6796 @end group
6797 @end smallexample
6799 This warning is enabled by @option{-Wall}.
6801 @item -Wpadded
6802 @opindex Wpadded
6803 @opindex Wno-padded
6804 Warn if padding is included in a structure, either to align an element
6805 of the structure or to align the whole structure.  Sometimes when this
6806 happens it is possible to rearrange the fields of the structure to
6807 reduce the padding and so make the structure smaller.
6809 @item -Wredundant-decls
6810 @opindex Wredundant-decls
6811 @opindex Wno-redundant-decls
6812 Warn if anything is declared more than once in the same scope, even in
6813 cases where multiple declaration is valid and changes nothing.
6815 @item -Wno-restrict
6816 @opindex Wrestrict
6817 @opindex Wno-restrict
6818 Warn when an object referenced by a @code{restrict}-qualified parameter
6819 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6820 argument, or when copies between such objects overlap.  For example,
6821 the call to the @code{strcpy} function below attempts to truncate the string
6822 by replacing its initial characters with the last four.  However, because
6823 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6824 the call is diagnosed.
6826 @smallexample
6827 struct foo
6829   char a[] = "abcd1234";
6830   strcpy (a, a + 4);
6832 @end smallexample
6833 The @option{-Wrestrict} is included in @option{-Wall}.
6835 @item -Wnested-externs @r{(C and Objective-C only)}
6836 @opindex Wnested-externs
6837 @opindex Wno-nested-externs
6838 Warn if an @code{extern} declaration is encountered within a function.
6840 @item -Wno-inherited-variadic-ctor
6841 @opindex Winherited-variadic-ctor
6842 @opindex Wno-inherited-variadic-ctor
6843 Suppress warnings about use of C++11 inheriting constructors when the
6844 base class inherited from has a C variadic constructor; the warning is
6845 on by default because the ellipsis is not inherited.
6847 @item -Winline
6848 @opindex Winline
6849 @opindex Wno-inline
6850 Warn if a function that is declared as inline cannot be inlined.
6851 Even with this option, the compiler does not warn about failures to
6852 inline functions declared in system headers.
6854 The compiler uses a variety of heuristics to determine whether or not
6855 to inline a function.  For example, the compiler takes into account
6856 the size of the function being inlined and the amount of inlining
6857 that has already been done in the current function.  Therefore,
6858 seemingly insignificant changes in the source program can cause the
6859 warnings produced by @option{-Winline} to appear or disappear.
6861 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6862 @opindex Wno-invalid-offsetof
6863 @opindex Winvalid-offsetof
6864 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6865 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6866 to a non-standard-layout type is undefined.  In existing C++ implementations,
6867 however, @code{offsetof} typically gives meaningful results.
6868 This flag is for users who are aware that they are
6869 writing nonportable code and who have deliberately chosen to ignore the
6870 warning about it.
6872 The restrictions on @code{offsetof} may be relaxed in a future version
6873 of the C++ standard.
6875 @item -Wint-in-bool-context
6876 @opindex Wint-in-bool-context
6877 @opindex Wno-int-in-bool-context
6878 Warn for suspicious use of integer values where boolean values are expected,
6879 such as conditional expressions (?:) using non-boolean integer constants in
6880 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6881 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6882 for all kinds of multiplications regardless of the data type.
6883 This warning is enabled by @option{-Wall}.
6885 @item -Wno-int-to-pointer-cast
6886 @opindex Wno-int-to-pointer-cast
6887 @opindex Wint-to-pointer-cast
6888 Suppress warnings from casts to pointer type of an integer of a
6889 different size. In C++, casting to a pointer type of smaller size is
6890 an error. @option{Wint-to-pointer-cast} is enabled by default.
6893 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6894 @opindex Wno-pointer-to-int-cast
6895 @opindex Wpointer-to-int-cast
6896 Suppress warnings from casts from a pointer to an integer type of a
6897 different size.
6899 @item -Winvalid-pch
6900 @opindex Winvalid-pch
6901 @opindex Wno-invalid-pch
6902 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6903 the search path but cannot be used.
6905 @item -Wlong-long
6906 @opindex Wlong-long
6907 @opindex Wno-long-long
6908 Warn if @code{long long} type is used.  This is enabled by either
6909 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6910 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6912 @item -Wvariadic-macros
6913 @opindex Wvariadic-macros
6914 @opindex Wno-variadic-macros
6915 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6916 alternate syntax is used in ISO C99 mode.  This is enabled by either
6917 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6918 messages, use @option{-Wno-variadic-macros}.
6920 @item -Wvarargs
6921 @opindex Wvarargs
6922 @opindex Wno-varargs
6923 Warn upon questionable usage of the macros used to handle variable
6924 arguments like @code{va_start}.  This is default.  To inhibit the
6925 warning messages, use @option{-Wno-varargs}.
6927 @item -Wvector-operation-performance
6928 @opindex Wvector-operation-performance
6929 @opindex Wno-vector-operation-performance
6930 Warn if vector operation is not implemented via SIMD capabilities of the
6931 architecture.  Mainly useful for the performance tuning.
6932 Vector operation can be implemented @code{piecewise}, which means that the
6933 scalar operation is performed on every vector element; 
6934 @code{in parallel}, which means that the vector operation is implemented
6935 using scalars of wider type, which normally is more performance efficient;
6936 and @code{as a single scalar}, which means that vector fits into a
6937 scalar type.
6939 @item -Wno-virtual-move-assign
6940 @opindex Wvirtual-move-assign
6941 @opindex Wno-virtual-move-assign
6942 Suppress warnings about inheriting from a virtual base with a
6943 non-trivial C++11 move assignment operator.  This is dangerous because
6944 if the virtual base is reachable along more than one path, it is
6945 moved multiple times, which can mean both objects end up in the
6946 moved-from state.  If the move assignment operator is written to avoid
6947 moving from a moved-from object, this warning can be disabled.
6949 @item -Wvla
6950 @opindex Wvla
6951 @opindex Wno-vla
6952 Warn if a variable-length array is used in the code.
6953 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6954 the variable-length array.
6956 @item -Wvla-larger-than=@var{n}
6957 If this option is used, the compiler will warn on uses of
6958 variable-length arrays where the size is either unbounded, or bounded
6959 by an argument that can be larger than @var{n} bytes.  This is similar
6960 to how @option{-Walloca-larger-than=@var{n}} works, but with
6961 variable-length arrays.
6963 Note that GCC may optimize small variable-length arrays of a known
6964 value into plain arrays, so this warning may not get triggered for
6965 such arrays.
6967 This warning is not enabled by @option{-Wall}, and is only active when
6968 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6970 See also @option{-Walloca-larger-than=@var{n}}.
6972 @item -Wvolatile-register-var
6973 @opindex Wvolatile-register-var
6974 @opindex Wno-volatile-register-var
6975 Warn if a register variable is declared volatile.  The volatile
6976 modifier does not inhibit all optimizations that may eliminate reads
6977 and/or writes to register variables.  This warning is enabled by
6978 @option{-Wall}.
6980 @item -Wdisabled-optimization
6981 @opindex Wdisabled-optimization
6982 @opindex Wno-disabled-optimization
6983 Warn if a requested optimization pass is disabled.  This warning does
6984 not generally indicate that there is anything wrong with your code; it
6985 merely indicates that GCC's optimizers are unable to handle the code
6986 effectively.  Often, the problem is that your code is too big or too
6987 complex; GCC refuses to optimize programs when the optimization
6988 itself is likely to take inordinate amounts of time.
6990 @item -Wpointer-sign @r{(C and Objective-C only)}
6991 @opindex Wpointer-sign
6992 @opindex Wno-pointer-sign
6993 Warn for pointer argument passing or assignment with different signedness.
6994 This option is only supported for C and Objective-C@.  It is implied by
6995 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6996 @option{-Wno-pointer-sign}.
6998 @item -Wstack-protector
6999 @opindex Wstack-protector
7000 @opindex Wno-stack-protector
7001 This option is only active when @option{-fstack-protector} is active.  It
7002 warns about functions that are not protected against stack smashing.
7004 @item -Woverlength-strings
7005 @opindex Woverlength-strings
7006 @opindex Wno-overlength-strings
7007 Warn about string constants that are longer than the ``minimum
7008 maximum'' length specified in the C standard.  Modern compilers
7009 generally allow string constants that are much longer than the
7010 standard's minimum limit, but very portable programs should avoid
7011 using longer strings.
7013 The limit applies @emph{after} string constant concatenation, and does
7014 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7015 C99, it was raised to 4095.  C++98 does not specify a normative
7016 minimum maximum, so we do not diagnose overlength strings in C++@.
7018 This option is implied by @option{-Wpedantic}, and can be disabled with
7019 @option{-Wno-overlength-strings}.
7021 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7022 @opindex Wunsuffixed-float-constants
7024 Issue a warning for any floating constant that does not have
7025 a suffix.  When used together with @option{-Wsystem-headers} it
7026 warns about such constants in system header files.  This can be useful
7027 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7028 from the decimal floating-point extension to C99.
7030 @item -Wno-designated-init @r{(C and Objective-C only)}
7031 Suppress warnings when a positional initializer is used to initialize
7032 a structure that has been marked with the @code{designated_init}
7033 attribute.
7035 @item -Whsa
7036 Issue a warning when HSAIL cannot be emitted for the compiled function or
7037 OpenMP construct.
7039 @end table
7041 @node Debugging Options
7042 @section Options for Debugging Your Program
7043 @cindex options, debugging
7044 @cindex debugging information options
7046 To tell GCC to emit extra information for use by a debugger, in almost 
7047 all cases you need only to add @option{-g} to your other options.
7049 GCC allows you to use @option{-g} with
7050 @option{-O}.  The shortcuts taken by optimized code may occasionally
7051 be surprising: some variables you declared may not exist
7052 at all; flow of control may briefly move where you did not expect it;
7053 some statements may not be executed because they compute constant
7054 results or their values are already at hand; some statements may
7055 execute in different places because they have been moved out of loops.
7056 Nevertheless it is possible to debug optimized output.  This makes
7057 it reasonable to use the optimizer for programs that might have bugs.
7059 If you are not using some other optimization option, consider
7060 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7061 With no @option{-O} option at all, some compiler passes that collect
7062 information useful for debugging do not run at all, so that
7063 @option{-Og} may result in a better debugging experience.
7065 @table @gcctabopt
7066 @item -g
7067 @opindex g
7068 Produce debugging information in the operating system's native format
7069 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7070 information.
7072 On most systems that use stabs format, @option{-g} enables use of extra
7073 debugging information that only GDB can use; this extra information
7074 makes debugging work better in GDB but probably makes other debuggers
7075 crash or
7076 refuse to read the program.  If you want to control for certain whether
7077 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7078 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7080 @item -ggdb
7081 @opindex ggdb
7082 Produce debugging information for use by GDB@.  This means to use the
7083 most expressive format available (DWARF, stabs, or the native format
7084 if neither of those are supported), including GDB extensions if at all
7085 possible.
7087 @item -gdwarf
7088 @itemx -gdwarf-@var{version}
7089 @opindex gdwarf
7090 Produce debugging information in DWARF format (if that is supported).
7091 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7092 for most targets is 4.  DWARF Version 5 is only experimental.
7094 Note that with DWARF Version 2, some ports require and always
7095 use some non-conflicting DWARF 3 extensions in the unwind tables.
7097 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7098 for maximum benefit.
7100 GCC no longer supports DWARF Version 1, which is substantially
7101 different than Version 2 and later.  For historical reasons, some
7102 other DWARF-related options such as
7103 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7104 in their names, but apply to all currently-supported versions of DWARF.
7106 @item -gstabs
7107 @opindex gstabs
7108 Produce debugging information in stabs format (if that is supported),
7109 without GDB extensions.  This is the format used by DBX on most BSD
7110 systems.  On MIPS, Alpha and System V Release 4 systems this option
7111 produces stabs debugging output that is not understood by DBX@.
7112 On System V Release 4 systems this option requires the GNU assembler.
7114 @item -gstabs+
7115 @opindex gstabs+
7116 Produce debugging information in stabs format (if that is supported),
7117 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7118 use of these extensions is likely to make other debuggers crash or
7119 refuse to read the program.
7121 @item -gxcoff
7122 @opindex gxcoff
7123 Produce debugging information in XCOFF format (if that is supported).
7124 This is the format used by the DBX debugger on IBM RS/6000 systems.
7126 @item -gxcoff+
7127 @opindex gxcoff+
7128 Produce debugging information in XCOFF format (if that is supported),
7129 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7130 use of these extensions is likely to make other debuggers crash or
7131 refuse to read the program, and may cause assemblers other than the GNU
7132 assembler (GAS) to fail with an error.
7134 @item -gvms
7135 @opindex gvms
7136 Produce debugging information in Alpha/VMS debug format (if that is
7137 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7139 @item -g@var{level}
7140 @itemx -ggdb@var{level}
7141 @itemx -gstabs@var{level}
7142 @itemx -gxcoff@var{level}
7143 @itemx -gvms@var{level}
7144 Request debugging information and also use @var{level} to specify how
7145 much information.  The default level is 2.
7147 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7148 @option{-g}.
7150 Level 1 produces minimal information, enough for making backtraces in
7151 parts of the program that you don't plan to debug.  This includes
7152 descriptions of functions and external variables, and line number
7153 tables, but no information about local variables.
7155 Level 3 includes extra information, such as all the macro definitions
7156 present in the program.  Some debuggers support macro expansion when
7157 you use @option{-g3}.
7159 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7160 confusion with @option{-gdwarf-@var{level}}.
7161 Instead use an additional @option{-g@var{level}} option to change the
7162 debug level for DWARF.
7164 @item -feliminate-unused-debug-symbols
7165 @opindex feliminate-unused-debug-symbols
7166 Produce debugging information in stabs format (if that is supported),
7167 for only symbols that are actually used.
7169 @item -femit-class-debug-always
7170 @opindex femit-class-debug-always
7171 Instead of emitting debugging information for a C++ class in only one
7172 object file, emit it in all object files using the class.  This option
7173 should be used only with debuggers that are unable to handle the way GCC
7174 normally emits debugging information for classes because using this
7175 option increases the size of debugging information by as much as a
7176 factor of two.
7178 @item -fno-merge-debug-strings
7179 @opindex fmerge-debug-strings
7180 @opindex fno-merge-debug-strings
7181 Direct the linker to not merge together strings in the debugging
7182 information that are identical in different object files.  Merging is
7183 not supported by all assemblers or linkers.  Merging decreases the size
7184 of the debug information in the output file at the cost of increasing
7185 link processing time.  Merging is enabled by default.
7187 @item -fdebug-prefix-map=@var{old}=@var{new}
7188 @opindex fdebug-prefix-map
7189 When compiling files residing in directory @file{@var{old}}, record
7190 debugging information describing them as if the files resided in
7191 directory @file{@var{new}} instead.  This can be used to replace a
7192 build-time path with an install-time path in the debug info.  It can
7193 also be used to change an absolute path to a relative path by using
7194 @file{.} for @var{new}.  This can give more reproducible builds, which
7195 are location independent, but may require an extra command to tell GDB
7196 where to find the source files. See also @option{-ffile-prefix-map}.
7198 @item -fvar-tracking
7199 @opindex fvar-tracking
7200 Run variable tracking pass.  It computes where variables are stored at each
7201 position in code.  Better debugging information is then generated
7202 (if the debugging information format supports this information).
7204 It is enabled by default when compiling with optimization (@option{-Os},
7205 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7206 the debug info format supports it.
7208 @item -fvar-tracking-assignments
7209 @opindex fvar-tracking-assignments
7210 @opindex fno-var-tracking-assignments
7211 Annotate assignments to user variables early in the compilation and
7212 attempt to carry the annotations over throughout the compilation all the
7213 way to the end, in an attempt to improve debug information while
7214 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7216 It can be enabled even if var-tracking is disabled, in which case
7217 annotations are created and maintained, but discarded at the end.
7218 By default, this flag is enabled together with @option{-fvar-tracking},
7219 except when selective scheduling is enabled.
7221 @item -gsplit-dwarf
7222 @opindex gsplit-dwarf
7223 Separate as much DWARF debugging information as possible into a
7224 separate output file with the extension @file{.dwo}.  This option allows
7225 the build system to avoid linking files with debug information.  To
7226 be useful, this option requires a debugger capable of reading @file{.dwo}
7227 files.
7229 @item -gpubnames
7230 @opindex gpubnames
7231 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7233 @item -ggnu-pubnames
7234 @opindex ggnu-pubnames
7235 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7236 suitable for conversion into a GDB@ index.  This option is only useful
7237 with a linker that can produce GDB@ index version 7.
7239 @item -fdebug-types-section
7240 @opindex fdebug-types-section
7241 @opindex fno-debug-types-section
7242 When using DWARF Version 4 or higher, type DIEs can be put into
7243 their own @code{.debug_types} section instead of making them part of the
7244 @code{.debug_info} section.  It is more efficient to put them in a separate
7245 comdat sections since the linker can then remove duplicates.
7246 But not all DWARF consumers support @code{.debug_types} sections yet
7247 and on some objects @code{.debug_types} produces larger instead of smaller
7248 debugging information.
7250 @item -grecord-gcc-switches
7251 @itemx -gno-record-gcc-switches
7252 @opindex grecord-gcc-switches
7253 @opindex gno-record-gcc-switches
7254 This switch causes the command-line options used to invoke the
7255 compiler that may affect code generation to be appended to the
7256 DW_AT_producer attribute in DWARF debugging information.  The options
7257 are concatenated with spaces separating them from each other and from
7258 the compiler version.  
7259 It is enabled by default.
7260 See also @option{-frecord-gcc-switches} for another
7261 way of storing compiler options into the object file.  
7263 @item -gstrict-dwarf
7264 @opindex gstrict-dwarf
7265 Disallow using extensions of later DWARF standard version than selected
7266 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7267 DWARF extensions from later standard versions is allowed.
7269 @item -gno-strict-dwarf
7270 @opindex gno-strict-dwarf
7271 Allow using extensions of later DWARF standard version than selected with
7272 @option{-gdwarf-@var{version}}.
7274 @item -gas-loc-support
7275 @opindex gas-loc-support
7276 Inform the compiler that the assembler supports @code{.loc} directives.
7277 It may then use them for the assembler to generate DWARF2+ line number
7278 tables.
7280 This is generally desirable, because assembler-generated line-number
7281 tables are a lot more compact than those the compiler can generate
7282 itself.
7284 This option will be enabled by default if, at GCC configure time, the
7285 assembler was found to support such directives.
7287 @item -gno-as-loc-support
7288 @opindex gno-as-loc-support
7289 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7290 line number tables are to be generated.
7292 @item gas-locview-support
7293 @opindex gas-locview-support
7294 Inform the compiler that the assembler supports @code{view} assignment
7295 and reset assertion checking in @code{.loc} directives.
7297 This option will be enabled by default if, at GCC configure time, the
7298 assembler was found to support them.
7300 @item gno-as-locview-support
7301 Force GCC to assign view numbers internally, if
7302 @option{-gvariable-location-views} are explicitly requested.
7304 @item -gcolumn-info
7305 @itemx -gno-column-info
7306 @opindex gcolumn-info
7307 @opindex gno-column-info
7308 Emit location column information into DWARF debugging information, rather
7309 than just file and line.
7310 This option is enabled by default.
7312 @item -gstatement-frontiers
7313 @itemx -gno-statement-frontiers
7314 @opindex gstatement-frontiers
7315 @opindex gno-statement-frontiers
7316 This option causes GCC to create markers in the internal representation
7317 at the beginning of statements, and to keep them roughly in place
7318 throughout compilation, using them to guide the output of @code{is_stmt}
7319 markers in the line number table.  This is enabled by default when
7320 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7321 @dots{}), and outputting DWARF 2 debug information at the normal level.
7323 @item -gvariable-location-views
7324 @itemx -gvariable-location-views=incompat5
7325 @itemx -gno-variable-location-views
7326 @opindex gvariable-location-views
7327 @opindex gvariable-location-views=incompat5
7328 @opindex gno-variable-location-views
7329 Augment variable location lists with progressive view numbers implied
7330 from the line number table.  This enables debug information consumers to
7331 inspect state at certain points of the program, even if no instructions
7332 associated with the corresponding source locations are present at that
7333 point.  If the assembler lacks support for view numbers in line number
7334 tables, this will cause the compiler to emit the line number table,
7335 which generally makes them somewhat less compact.  The augmented line
7336 number tables and location lists are fully backward-compatible, so they
7337 can be consumed by debug information consumers that are not aware of
7338 these augmentations, but they won't derive any benefit from them either.
7340 This is enabled by default when outputting DWARF 2 debug information at
7341 the normal level, as long as there is assembler support,
7342 @option{-fvar-tracking-assignments} is enabled and
7343 @option{-gstrict-dwarf} is not.  When assembler support is not
7344 available, this may still be enabled, but it will force GCC to output
7345 internal line number tables, and if
7346 @option{-ginternal-reset-location-views} is not enabled, that will most
7347 certainly lead to silently mismatching location views.
7349 There is a proposed representation for view numbers that is not backward
7350 compatible with the location list format introduced in DWARF 5, that can
7351 be enabled with @option{-gvariable-location-views=incompat5}.  This
7352 option may be removed in the future, is only provided as a reference
7353 implementation of the proposed representation.  Debug information
7354 consumers are not expected to support this extended format, and they
7355 would be rendered unable to decode location lists using it.
7357 @item -ginternal-reset-location-views
7358 @itemx -gnointernal-reset-location-views
7359 @opindex ginternal-reset-location-views
7360 @opindex gno-internal-reset-location-views
7361 Attempt to determine location views that can be omitted from location
7362 view lists.  This requires the compiler to have very accurate insn
7363 length estimates, which isn't always the case, and it may cause
7364 incorrect view lists to be generated silently when using an assembler
7365 that does not support location view lists.  The GNU assembler will flag
7366 any such error as a @code{view number mismatch}.  This is only enabled
7367 on ports that define a reliable estimation function.
7369 @item -ginline-points
7370 @itemx -gno-inline-points
7371 @opindex ginline-points
7372 @opindex gno-inline-points
7373 Generate extended debug information for inlined functions.  Location
7374 view tracking markers are inserted at inlined entry points, so that
7375 address and view numbers can be computed and output in debug
7376 information.  This can be enabled independently of location views, in
7377 which case the view numbers won't be output, but it can only be enabled
7378 along with statement frontiers, and it is only enabled by default if
7379 location views are enabled.
7381 @item -gz@r{[}=@var{type}@r{]}
7382 @opindex gz
7383 Produce compressed debug sections in DWARF format, if that is supported.
7384 If @var{type} is not given, the default type depends on the capabilities
7385 of the assembler and linker used.  @var{type} may be one of
7386 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7387 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7388 compression in traditional GNU format).  If the linker doesn't support
7389 writing compressed debug sections, the option is rejected.  Otherwise,
7390 if the assembler does not support them, @option{-gz} is silently ignored
7391 when producing object files.
7393 @item -femit-struct-debug-baseonly
7394 @opindex femit-struct-debug-baseonly
7395 Emit debug information for struct-like types
7396 only when the base name of the compilation source file
7397 matches the base name of file in which the struct is defined.
7399 This option substantially reduces the size of debugging information,
7400 but at significant potential loss in type information to the debugger.
7401 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7402 See @option{-femit-struct-debug-detailed} for more detailed control.
7404 This option works only with DWARF debug output.
7406 @item -femit-struct-debug-reduced
7407 @opindex femit-struct-debug-reduced
7408 Emit debug information for struct-like types
7409 only when the base name of the compilation source file
7410 matches the base name of file in which the type is defined,
7411 unless the struct is a template or defined in a system header.
7413 This option significantly reduces the size of debugging information,
7414 with some potential loss in type information to the debugger.
7415 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7416 See @option{-femit-struct-debug-detailed} for more detailed control.
7418 This option works only with DWARF debug output.
7420 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7421 @opindex femit-struct-debug-detailed
7422 Specify the struct-like types
7423 for which the compiler generates debug information.
7424 The intent is to reduce duplicate struct debug information
7425 between different object files within the same program.
7427 This option is a detailed version of
7428 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7429 which serves for most needs.
7431 A specification has the syntax@*
7432 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7434 The optional first word limits the specification to
7435 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7436 A struct type is used directly when it is the type of a variable, member.
7437 Indirect uses arise through pointers to structs.
7438 That is, when use of an incomplete struct is valid, the use is indirect.
7439 An example is
7440 @samp{struct one direct; struct two * indirect;}.
7442 The optional second word limits the specification to
7443 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7444 Generic structs are a bit complicated to explain.
7445 For C++, these are non-explicit specializations of template classes,
7446 or non-template classes within the above.
7447 Other programming languages have generics,
7448 but @option{-femit-struct-debug-detailed} does not yet implement them.
7450 The third word specifies the source files for those
7451 structs for which the compiler should emit debug information.
7452 The values @samp{none} and @samp{any} have the normal meaning.
7453 The value @samp{base} means that
7454 the base of name of the file in which the type declaration appears
7455 must match the base of the name of the main compilation file.
7456 In practice, this means that when compiling @file{foo.c}, debug information
7457 is generated for types declared in that file and @file{foo.h},
7458 but not other header files.
7459 The value @samp{sys} means those types satisfying @samp{base}
7460 or declared in system or compiler headers.
7462 You may need to experiment to determine the best settings for your application.
7464 The default is @option{-femit-struct-debug-detailed=all}.
7466 This option works only with DWARF debug output.
7468 @item -fno-dwarf2-cfi-asm
7469 @opindex fdwarf2-cfi-asm
7470 @opindex fno-dwarf2-cfi-asm
7471 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7472 instead of using GAS @code{.cfi_*} directives.
7474 @item -fno-eliminate-unused-debug-types
7475 @opindex feliminate-unused-debug-types
7476 @opindex fno-eliminate-unused-debug-types
7477 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7478 output for types that are nowhere used in the source file being compiled.
7479 Sometimes it is useful to have GCC emit debugging
7480 information for all types declared in a compilation
7481 unit, regardless of whether or not they are actually used
7482 in that compilation unit, for example 
7483 if, in the debugger, you want to cast a value to a type that is
7484 not actually used in your program (but is declared).  More often,
7485 however, this results in a significant amount of wasted space.
7486 @end table
7488 @node Optimize Options
7489 @section Options That Control Optimization
7490 @cindex optimize options
7491 @cindex options, optimization
7493 These options control various sorts of optimizations.
7495 Without any optimization option, the compiler's goal is to reduce the
7496 cost of compilation and to make debugging produce the expected
7497 results.  Statements are independent: if you stop the program with a
7498 breakpoint between statements, you can then assign a new value to any
7499 variable or change the program counter to any other statement in the
7500 function and get exactly the results you expect from the source
7501 code.
7503 Turning on optimization flags makes the compiler attempt to improve
7504 the performance and/or code size at the expense of compilation time
7505 and possibly the ability to debug the program.
7507 The compiler performs optimization based on the knowledge it has of the
7508 program.  Compiling multiple files at once to a single output file mode allows
7509 the compiler to use information gained from all of the files when compiling
7510 each of them.
7512 Not all optimizations are controlled directly by a flag.  Only
7513 optimizations that have a flag are listed in this section.
7515 Most optimizations are only enabled if an @option{-O} level is set on
7516 the command line.  Otherwise they are disabled, even if individual
7517 optimization flags are specified.
7519 Depending on the target and how GCC was configured, a slightly different
7520 set of optimizations may be enabled at each @option{-O} level than
7521 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7522 to find out the exact set of optimizations that are enabled at each level.
7523 @xref{Overall Options}, for examples.
7525 @table @gcctabopt
7526 @item -O
7527 @itemx -O1
7528 @opindex O
7529 @opindex O1
7530 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7531 more memory for a large function.
7533 With @option{-O}, the compiler tries to reduce code size and execution
7534 time, without performing any optimizations that take a great deal of
7535 compilation time.
7537 @option{-O} turns on the following optimization flags:
7538 @gccoptlist{
7539 -fauto-inc-dec @gol
7540 -fbranch-count-reg @gol
7541 -fcombine-stack-adjustments @gol
7542 -fcompare-elim @gol
7543 -fcprop-registers @gol
7544 -fdce @gol
7545 -fdefer-pop @gol
7546 -fdelayed-branch @gol
7547 -fdse @gol
7548 -fforward-propagate @gol
7549 -fguess-branch-probability @gol
7550 -fif-conversion2 @gol
7551 -fif-conversion @gol
7552 -finline-functions-called-once @gol
7553 -fipa-pure-const @gol
7554 -fipa-profile @gol
7555 -fipa-reference @gol
7556 -fmerge-constants @gol
7557 -fmove-loop-invariants @gol
7558 -fomit-frame-pointer @gol
7559 -freorder-blocks @gol
7560 -fshrink-wrap @gol
7561 -fshrink-wrap-separate @gol
7562 -fsplit-wide-types @gol
7563 -fssa-backprop @gol
7564 -fssa-phiopt @gol
7565 -ftree-bit-ccp @gol
7566 -ftree-ccp @gol
7567 -ftree-ch @gol
7568 -ftree-coalesce-vars @gol
7569 -ftree-copy-prop @gol
7570 -ftree-dce @gol
7571 -ftree-dominator-opts @gol
7572 -ftree-dse @gol
7573 -ftree-forwprop @gol
7574 -ftree-fre @gol
7575 -ftree-phiprop @gol
7576 -ftree-sink @gol
7577 -ftree-slsr @gol
7578 -ftree-sra @gol
7579 -ftree-pta @gol
7580 -ftree-ter @gol
7581 -funit-at-a-time}
7583 @item -O2
7584 @opindex O2
7585 Optimize even more.  GCC performs nearly all supported optimizations
7586 that do not involve a space-speed tradeoff.
7587 As compared to @option{-O}, this option increases both compilation time
7588 and the performance of the generated code.
7590 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7591 also turns on the following optimization flags:
7592 @gccoptlist{-fthread-jumps @gol
7593 -falign-functions  -falign-jumps @gol
7594 -falign-loops  -falign-labels @gol
7595 -fcaller-saves @gol
7596 -fcrossjumping @gol
7597 -fcse-follow-jumps  -fcse-skip-blocks @gol
7598 -fdelete-null-pointer-checks @gol
7599 -fdevirtualize -fdevirtualize-speculatively @gol
7600 -fexpensive-optimizations @gol
7601 -fgcse  -fgcse-lm  @gol
7602 -fhoist-adjacent-loads @gol
7603 -finline-small-functions @gol
7604 -findirect-inlining @gol
7605 -fipa-cp @gol
7606 -fipa-bit-cp @gol
7607 -fipa-vrp @gol
7608 -fipa-sra @gol
7609 -fipa-icf @gol
7610 -fisolate-erroneous-paths-dereference @gol
7611 -flra-remat @gol
7612 -foptimize-sibling-calls @gol
7613 -foptimize-strlen @gol
7614 -fpartial-inlining @gol
7615 -fpeephole2 @gol
7616 -freorder-blocks-algorithm=stc @gol
7617 -freorder-blocks-and-partition -freorder-functions @gol
7618 -frerun-cse-after-loop  @gol
7619 -fsched-interblock  -fsched-spec @gol
7620 -fschedule-insns  -fschedule-insns2 @gol
7621 -fstore-merging @gol
7622 -fstrict-aliasing @gol
7623 -ftree-builtin-call-dce @gol
7624 -ftree-switch-conversion -ftree-tail-merge @gol
7625 -fcode-hoisting @gol
7626 -ftree-pre @gol
7627 -ftree-vrp @gol
7628 -fipa-ra}
7630 Please note the warning under @option{-fgcse} about
7631 invoking @option{-O2} on programs that use computed gotos.
7633 @item -O3
7634 @opindex O3
7635 Optimize yet more.  @option{-O3} turns on all optimizations specified
7636 by @option{-O2} and also turns on the following optimization flags:
7637 @gccoptlist{-finline-functions @gol
7638 -funswitch-loops @gol
7639 -fpredictive-commoning @gol
7640 -fgcse-after-reload @gol
7641 -ftree-loop-vectorize @gol
7642 -ftree-loop-distribution @gol
7643 -ftree-loop-distribute-patterns @gol
7644 -floop-interchange @gol
7645 -fsplit-paths @gol
7646 -ftree-slp-vectorize @gol
7647 -fvect-cost-model @gol
7648 -ftree-partial-pre @gol
7649 -fpeel-loops @gol
7650 -fipa-cp-clone}
7652 @item -O0
7653 @opindex O0
7654 Reduce compilation time and make debugging produce the expected
7655 results.  This is the default.
7657 @item -Os
7658 @opindex Os
7659 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7660 do not typically increase code size.  It also performs further
7661 optimizations designed to reduce code size.
7663 @option{-Os} disables the following optimization flags:
7664 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7665 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7666 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7668 @item -Ofast
7669 @opindex Ofast
7670 Disregard strict standards compliance.  @option{-Ofast} enables all
7671 @option{-O3} optimizations.  It also enables optimizations that are not
7672 valid for all standard-compliant programs.
7673 It turns on @option{-ffast-math} and the Fortran-specific
7674 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7675 specified, and @option{-fno-protect-parens}.
7677 @item -Og
7678 @opindex Og
7679 Optimize debugging experience.  @option{-Og} enables optimizations
7680 that do not interfere with debugging. It should be the optimization
7681 level of choice for the standard edit-compile-debug cycle, offering
7682 a reasonable level of optimization while maintaining fast compilation
7683 and a good debugging experience.
7684 @end table
7686 If you use multiple @option{-O} options, with or without level numbers,
7687 the last such option is the one that is effective.
7689 Options of the form @option{-f@var{flag}} specify machine-independent
7690 flags.  Most flags have both positive and negative forms; the negative
7691 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7692 below, only one of the forms is listed---the one you typically 
7693 use.  You can figure out the other form by either removing @samp{no-}
7694 or adding it.
7696 The following options control specific optimizations.  They are either
7697 activated by @option{-O} options or are related to ones that are.  You
7698 can use the following flags in the rare cases when ``fine-tuning'' of
7699 optimizations to be performed is desired.
7701 @table @gcctabopt
7702 @item -fno-defer-pop
7703 @opindex fno-defer-pop
7704 Always pop the arguments to each function call as soon as that function
7705 returns.  For machines that must pop arguments after a function call,
7706 the compiler normally lets arguments accumulate on the stack for several
7707 function calls and pops them all at once.
7709 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7711 @item -fforward-propagate
7712 @opindex fforward-propagate
7713 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7714 instructions and checks if the result can be simplified.  If loop unrolling
7715 is active, two passes are performed and the second is scheduled after
7716 loop unrolling.
7718 This option is enabled by default at optimization levels @option{-O},
7719 @option{-O2}, @option{-O3}, @option{-Os}.
7721 @item -ffp-contract=@var{style}
7722 @opindex ffp-contract
7723 @option{-ffp-contract=off} disables floating-point expression contraction.
7724 @option{-ffp-contract=fast} enables floating-point expression contraction
7725 such as forming of fused multiply-add operations if the target has
7726 native support for them.
7727 @option{-ffp-contract=on} enables floating-point expression contraction
7728 if allowed by the language standard.  This is currently not implemented
7729 and treated equal to @option{-ffp-contract=off}.
7731 The default is @option{-ffp-contract=fast}.
7733 @item -fomit-frame-pointer
7734 @opindex fomit-frame-pointer
7735 Omit the frame pointer in functions that don't need one.  This avoids the
7736 instructions to save, set up and restore the frame pointer; on many targets
7737 it also makes an extra register available.
7739 On some targets this flag has no effect because the standard calling sequence
7740 always uses a frame pointer, so it cannot be omitted.
7742 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7743 is used in all functions.  Several targets always omit the frame pointer in
7744 leaf functions.
7746 Enabled by default at @option{-O} and higher.
7748 @item -foptimize-sibling-calls
7749 @opindex foptimize-sibling-calls
7750 Optimize sibling and tail recursive calls.
7752 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7754 @item -foptimize-strlen
7755 @opindex foptimize-strlen
7756 Optimize various standard C string functions (e.g. @code{strlen},
7757 @code{strchr} or @code{strcpy}) and
7758 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7760 Enabled at levels @option{-O2}, @option{-O3}.
7762 @item -fno-inline
7763 @opindex fno-inline
7764 Do not expand any functions inline apart from those marked with
7765 the @code{always_inline} attribute.  This is the default when not
7766 optimizing.
7768 Single functions can be exempted from inlining by marking them
7769 with the @code{noinline} attribute.
7771 @item -finline-small-functions
7772 @opindex finline-small-functions
7773 Integrate functions into their callers when their body is smaller than expected
7774 function call code (so overall size of program gets smaller).  The compiler
7775 heuristically decides which functions are simple enough to be worth integrating
7776 in this way.  This inlining applies to all functions, even those not declared
7777 inline.
7779 Enabled at level @option{-O2}.
7781 @item -findirect-inlining
7782 @opindex findirect-inlining
7783 Inline also indirect calls that are discovered to be known at compile
7784 time thanks to previous inlining.  This option has any effect only
7785 when inlining itself is turned on by the @option{-finline-functions}
7786 or @option{-finline-small-functions} options.
7788 Enabled at level @option{-O2}.
7790 @item -finline-functions
7791 @opindex finline-functions
7792 Consider all functions for inlining, even if they are not declared inline.
7793 The compiler heuristically decides which functions are worth integrating
7794 in this way.
7796 If all calls to a given function are integrated, and the function is
7797 declared @code{static}, then the function is normally not output as
7798 assembler code in its own right.
7800 Enabled at level @option{-O3}.
7802 @item -finline-functions-called-once
7803 @opindex finline-functions-called-once
7804 Consider all @code{static} functions called once for inlining into their
7805 caller even if they are not marked @code{inline}.  If a call to a given
7806 function is integrated, then the function is not output as assembler code
7807 in its own right.
7809 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7811 @item -fearly-inlining
7812 @opindex fearly-inlining
7813 Inline functions marked by @code{always_inline} and functions whose body seems
7814 smaller than the function call overhead early before doing
7815 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7816 makes profiling significantly cheaper and usually inlining faster on programs
7817 having large chains of nested wrapper functions.
7819 Enabled by default.
7821 @item -fipa-sra
7822 @opindex fipa-sra
7823 Perform interprocedural scalar replacement of aggregates, removal of
7824 unused parameters and replacement of parameters passed by reference
7825 by parameters passed by value.
7827 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7829 @item -finline-limit=@var{n}
7830 @opindex finline-limit
7831 By default, GCC limits the size of functions that can be inlined.  This flag
7832 allows coarse control of this limit.  @var{n} is the size of functions that
7833 can be inlined in number of pseudo instructions.
7835 Inlining is actually controlled by a number of parameters, which may be
7836 specified individually by using @option{--param @var{name}=@var{value}}.
7837 The @option{-finline-limit=@var{n}} option sets some of these parameters
7838 as follows:
7840 @table @gcctabopt
7841 @item max-inline-insns-single
7842 is set to @var{n}/2.
7843 @item max-inline-insns-auto
7844 is set to @var{n}/2.
7845 @end table
7847 See below for a documentation of the individual
7848 parameters controlling inlining and for the defaults of these parameters.
7850 @emph{Note:} there may be no value to @option{-finline-limit} that results
7851 in default behavior.
7853 @emph{Note:} pseudo instruction represents, in this particular context, an
7854 abstract measurement of function's size.  In no way does it represent a count
7855 of assembly instructions and as such its exact meaning might change from one
7856 release to an another.
7858 @item -fno-keep-inline-dllexport
7859 @opindex fno-keep-inline-dllexport
7860 This is a more fine-grained version of @option{-fkeep-inline-functions},
7861 which applies only to functions that are declared using the @code{dllexport}
7862 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7863 Functions}.
7865 @item -fkeep-inline-functions
7866 @opindex fkeep-inline-functions
7867 In C, emit @code{static} functions that are declared @code{inline}
7868 into the object file, even if the function has been inlined into all
7869 of its callers.  This switch does not affect functions using the
7870 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7871 inline functions into the object file.
7873 @item -fkeep-static-functions
7874 @opindex fkeep-static-functions
7875 Emit @code{static} functions into the object file, even if the function
7876 is never used.
7878 @item -fkeep-static-consts
7879 @opindex fkeep-static-consts
7880 Emit variables declared @code{static const} when optimization isn't turned
7881 on, even if the variables aren't referenced.
7883 GCC enables this option by default.  If you want to force the compiler to
7884 check if a variable is referenced, regardless of whether or not
7885 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7887 @item -fmerge-constants
7888 @opindex fmerge-constants
7889 Attempt to merge identical constants (string constants and floating-point
7890 constants) across compilation units.
7892 This option is the default for optimized compilation if the assembler and
7893 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7894 behavior.
7896 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7898 @item -fmerge-all-constants
7899 @opindex fmerge-all-constants
7900 Attempt to merge identical constants and identical variables.
7902 This option implies @option{-fmerge-constants}.  In addition to
7903 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7904 arrays or initialized constant variables with integral or floating-point
7905 types.  Languages like C or C++ require each variable, including multiple
7906 instances of the same variable in recursive calls, to have distinct locations,
7907 so using this option results in non-conforming
7908 behavior.
7910 @item -fmodulo-sched
7911 @opindex fmodulo-sched
7912 Perform swing modulo scheduling immediately before the first scheduling
7913 pass.  This pass looks at innermost loops and reorders their
7914 instructions by overlapping different iterations.
7916 @item -fmodulo-sched-allow-regmoves
7917 @opindex fmodulo-sched-allow-regmoves
7918 Perform more aggressive SMS-based modulo scheduling with register moves
7919 allowed.  By setting this flag certain anti-dependences edges are
7920 deleted, which triggers the generation of reg-moves based on the
7921 life-range analysis.  This option is effective only with
7922 @option{-fmodulo-sched} enabled.
7924 @item -fno-branch-count-reg
7925 @opindex fno-branch-count-reg
7926 Avoid running a pass scanning for opportunities to use ``decrement and
7927 branch'' instructions on a count register instead of generating sequences
7928 of instructions that decrement a register, compare it against zero, and
7929 then branch based upon the result.  This option is only meaningful on
7930 architectures that support such instructions, which include x86, PowerPC,
7931 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7932 doesn't remove the decrement and branch instructions from the generated
7933 instruction stream introduced by other optimization passes.
7935 Enabled by default at @option{-O1} and higher.
7937 The default is @option{-fbranch-count-reg}.
7939 @item -fno-function-cse
7940 @opindex fno-function-cse
7941 Do not put function addresses in registers; make each instruction that
7942 calls a constant function contain the function's address explicitly.
7944 This option results in less efficient code, but some strange hacks
7945 that alter the assembler output may be confused by the optimizations
7946 performed when this option is not used.
7948 The default is @option{-ffunction-cse}
7950 @item -fno-zero-initialized-in-bss
7951 @opindex fno-zero-initialized-in-bss
7952 If the target supports a BSS section, GCC by default puts variables that
7953 are initialized to zero into BSS@.  This can save space in the resulting
7954 code.
7956 This option turns off this behavior because some programs explicitly
7957 rely on variables going to the data section---e.g., so that the
7958 resulting executable can find the beginning of that section and/or make
7959 assumptions based on that.
7961 The default is @option{-fzero-initialized-in-bss}.
7963 @item -fthread-jumps
7964 @opindex fthread-jumps
7965 Perform optimizations that check to see if a jump branches to a
7966 location where another comparison subsumed by the first is found.  If
7967 so, the first branch is redirected to either the destination of the
7968 second branch or a point immediately following it, depending on whether
7969 the condition is known to be true or false.
7971 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7973 @item -fsplit-wide-types
7974 @opindex fsplit-wide-types
7975 When using a type that occupies multiple registers, such as @code{long
7976 long} on a 32-bit system, split the registers apart and allocate them
7977 independently.  This normally generates better code for those types,
7978 but may make debugging more difficult.
7980 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7981 @option{-Os}.
7983 @item -fcse-follow-jumps
7984 @opindex fcse-follow-jumps
7985 In common subexpression elimination (CSE), scan through jump instructions
7986 when the target of the jump is not reached by any other path.  For
7987 example, when CSE encounters an @code{if} statement with an
7988 @code{else} clause, CSE follows the jump when the condition
7989 tested is false.
7991 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7993 @item -fcse-skip-blocks
7994 @opindex fcse-skip-blocks
7995 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7996 follow jumps that conditionally skip over blocks.  When CSE
7997 encounters a simple @code{if} statement with no else clause,
7998 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7999 body of the @code{if}.
8001 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8003 @item -frerun-cse-after-loop
8004 @opindex frerun-cse-after-loop
8005 Re-run common subexpression elimination after loop optimizations are
8006 performed.
8008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8010 @item -fgcse
8011 @opindex fgcse
8012 Perform a global common subexpression elimination pass.
8013 This pass also performs global constant and copy propagation.
8015 @emph{Note:} When compiling a program using computed gotos, a GCC
8016 extension, you may get better run-time performance if you disable
8017 the global common subexpression elimination pass by adding
8018 @option{-fno-gcse} to the command line.
8020 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8022 @item -fgcse-lm
8023 @opindex fgcse-lm
8024 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8025 attempts to move loads that are only killed by stores into themselves.  This
8026 allows a loop containing a load/store sequence to be changed to a load outside
8027 the loop, and a copy/store within the loop.
8029 Enabled by default when @option{-fgcse} is enabled.
8031 @item -fgcse-sm
8032 @opindex fgcse-sm
8033 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8034 global common subexpression elimination.  This pass attempts to move
8035 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8036 loops containing a load/store sequence can be changed to a load before
8037 the loop and a store after the loop.
8039 Not enabled at any optimization level.
8041 @item -fgcse-las
8042 @opindex fgcse-las
8043 When @option{-fgcse-las} is enabled, the global common subexpression
8044 elimination pass eliminates redundant loads that come after stores to the
8045 same memory location (both partial and full redundancies).
8047 Not enabled at any optimization level.
8049 @item -fgcse-after-reload
8050 @opindex fgcse-after-reload
8051 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8052 pass is performed after reload.  The purpose of this pass is to clean up
8053 redundant spilling.
8055 @item -faggressive-loop-optimizations
8056 @opindex faggressive-loop-optimizations
8057 This option tells the loop optimizer to use language constraints to
8058 derive bounds for the number of iterations of a loop.  This assumes that
8059 loop code does not invoke undefined behavior by for example causing signed
8060 integer overflows or out-of-bound array accesses.  The bounds for the
8061 number of iterations of a loop are used to guide loop unrolling and peeling
8062 and loop exit test optimizations.
8063 This option is enabled by default.
8065 @item -funconstrained-commons
8066 @opindex funconstrained-commons
8067 This option tells the compiler that variables declared in common blocks
8068 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8069 prevents certain optimizations that depend on knowing the array bounds.
8071 @item -fcrossjumping
8072 @opindex fcrossjumping
8073 Perform cross-jumping transformation.
8074 This transformation unifies equivalent code and saves code size.  The
8075 resulting code may or may not perform better than without cross-jumping.
8077 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8079 @item -fauto-inc-dec
8080 @opindex fauto-inc-dec
8081 Combine increments or decrements of addresses with memory accesses.
8082 This pass is always skipped on architectures that do not have
8083 instructions to support this.  Enabled by default at @option{-O} and
8084 higher on architectures that support this.
8086 @item -fdce
8087 @opindex fdce
8088 Perform dead code elimination (DCE) on RTL@.
8089 Enabled by default at @option{-O} and higher.
8091 @item -fdse
8092 @opindex fdse
8093 Perform dead store elimination (DSE) on RTL@.
8094 Enabled by default at @option{-O} and higher.
8096 @item -fif-conversion
8097 @opindex fif-conversion
8098 Attempt to transform conditional jumps into branch-less equivalents.  This
8099 includes use of conditional moves, min, max, set flags and abs instructions, and
8100 some tricks doable by standard arithmetics.  The use of conditional execution
8101 on chips where it is available is controlled by @option{-fif-conversion2}.
8103 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8105 @item -fif-conversion2
8106 @opindex fif-conversion2
8107 Use conditional execution (where available) to transform conditional jumps into
8108 branch-less equivalents.
8110 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8112 @item -fdeclone-ctor-dtor
8113 @opindex fdeclone-ctor-dtor
8114 The C++ ABI requires multiple entry points for constructors and
8115 destructors: one for a base subobject, one for a complete object, and
8116 one for a virtual destructor that calls operator delete afterwards.
8117 For a hierarchy with virtual bases, the base and complete variants are
8118 clones, which means two copies of the function.  With this option, the
8119 base and complete variants are changed to be thunks that call a common
8120 implementation.
8122 Enabled by @option{-Os}.
8124 @item -fdelete-null-pointer-checks
8125 @opindex fdelete-null-pointer-checks
8126 Assume that programs cannot safely dereference null pointers, and that
8127 no code or data element resides at address zero.
8128 This option enables simple constant
8129 folding optimizations at all optimization levels.  In addition, other
8130 optimization passes in GCC use this flag to control global dataflow
8131 analyses that eliminate useless checks for null pointers; these assume
8132 that a memory access to address zero always results in a trap, so
8133 that if a pointer is checked after it has already been dereferenced,
8134 it cannot be null.
8136 Note however that in some environments this assumption is not true.
8137 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8138 for programs that depend on that behavior.
8140 This option is enabled by default on most targets.  On Nios II ELF, it
8141 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8143 Passes that use the dataflow information
8144 are enabled independently at different optimization levels.
8146 @item -fdevirtualize
8147 @opindex fdevirtualize
8148 Attempt to convert calls to virtual functions to direct calls.  This
8149 is done both within a procedure and interprocedurally as part of
8150 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8151 propagation (@option{-fipa-cp}).
8152 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8154 @item -fdevirtualize-speculatively
8155 @opindex fdevirtualize-speculatively
8156 Attempt to convert calls to virtual functions to speculative direct calls.
8157 Based on the analysis of the type inheritance graph, determine for a given call
8158 the set of likely targets. If the set is small, preferably of size 1, change
8159 the call into a conditional deciding between direct and indirect calls.  The
8160 speculative calls enable more optimizations, such as inlining.  When they seem
8161 useless after further optimization, they are converted back into original form.
8163 @item -fdevirtualize-at-ltrans
8164 @opindex fdevirtualize-at-ltrans
8165 Stream extra information needed for aggressive devirtualization when running
8166 the link-time optimizer in local transformation mode.  
8167 This option enables more devirtualization but
8168 significantly increases the size of streamed data. For this reason it is
8169 disabled by default.
8171 @item -fexpensive-optimizations
8172 @opindex fexpensive-optimizations
8173 Perform a number of minor optimizations that are relatively expensive.
8175 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8177 @item -free
8178 @opindex free
8179 Attempt to remove redundant extension instructions.  This is especially
8180 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8181 registers after writing to their lower 32-bit half.
8183 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8184 @option{-O3}, @option{-Os}.
8186 @item -fno-lifetime-dse
8187 @opindex fno-lifetime-dse
8188 In C++ the value of an object is only affected by changes within its
8189 lifetime: when the constructor begins, the object has an indeterminate
8190 value, and any changes during the lifetime of the object are dead when
8191 the object is destroyed.  Normally dead store elimination will take
8192 advantage of this; if your code relies on the value of the object
8193 storage persisting beyond the lifetime of the object, you can use this
8194 flag to disable this optimization.  To preserve stores before the
8195 constructor starts (e.g. because your operator new clears the object
8196 storage) but still treat the object as dead after the destructor you,
8197 can use @option{-flifetime-dse=1}.  The default behavior can be
8198 explicitly selected with @option{-flifetime-dse=2}.
8199 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8201 @item -flive-range-shrinkage
8202 @opindex flive-range-shrinkage
8203 Attempt to decrease register pressure through register live range
8204 shrinkage.  This is helpful for fast processors with small or moderate
8205 size register sets.
8207 @item -fira-algorithm=@var{algorithm}
8208 @opindex fira-algorithm
8209 Use the specified coloring algorithm for the integrated register
8210 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8211 specifies Chow's priority coloring, or @samp{CB}, which specifies
8212 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8213 for all architectures, but for those targets that do support it, it is
8214 the default because it generates better code.
8216 @item -fira-region=@var{region}
8217 @opindex fira-region
8218 Use specified regions for the integrated register allocator.  The
8219 @var{region} argument should be one of the following:
8221 @table @samp
8223 @item all
8224 Use all loops as register allocation regions.
8225 This can give the best results for machines with a small and/or
8226 irregular register set.
8228 @item mixed
8229 Use all loops except for loops with small register pressure 
8230 as the regions.  This value usually gives
8231 the best results in most cases and for most architectures,
8232 and is enabled by default when compiling with optimization for speed
8233 (@option{-O}, @option{-O2}, @dots{}).
8235 @item one
8236 Use all functions as a single region.  
8237 This typically results in the smallest code size, and is enabled by default for
8238 @option{-Os} or @option{-O0}.
8240 @end table
8242 @item -fira-hoist-pressure
8243 @opindex fira-hoist-pressure
8244 Use IRA to evaluate register pressure in the code hoisting pass for
8245 decisions to hoist expressions.  This option usually results in smaller
8246 code, but it can slow the compiler down.
8248 This option is enabled at level @option{-Os} for all targets.
8250 @item -fira-loop-pressure
8251 @opindex fira-loop-pressure
8252 Use IRA to evaluate register pressure in loops for decisions to move
8253 loop invariants.  This option usually results in generation
8254 of faster and smaller code on machines with large register files (>= 32
8255 registers), but it can slow the compiler down.
8257 This option is enabled at level @option{-O3} for some targets.
8259 @item -fno-ira-share-save-slots
8260 @opindex fno-ira-share-save-slots
8261 Disable sharing of stack slots used for saving call-used hard
8262 registers living through a call.  Each hard register gets a
8263 separate stack slot, and as a result function stack frames are
8264 larger.
8266 @item -fno-ira-share-spill-slots
8267 @opindex fno-ira-share-spill-slots
8268 Disable sharing of stack slots allocated for pseudo-registers.  Each
8269 pseudo-register that does not get a hard register gets a separate
8270 stack slot, and as a result function stack frames are larger.
8272 @item -flra-remat
8273 @opindex flra-remat
8274 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8275 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8276 values if it is profitable.
8278 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8280 @item -fdelayed-branch
8281 @opindex fdelayed-branch
8282 If supported for the target machine, attempt to reorder instructions
8283 to exploit instruction slots available after delayed branch
8284 instructions.
8286 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8288 @item -fschedule-insns
8289 @opindex fschedule-insns
8290 If supported for the target machine, attempt to reorder instructions to
8291 eliminate execution stalls due to required data being unavailable.  This
8292 helps machines that have slow floating point or memory load instructions
8293 by allowing other instructions to be issued until the result of the load
8294 or floating-point instruction is required.
8296 Enabled at levels @option{-O2}, @option{-O3}.
8298 @item -fschedule-insns2
8299 @opindex fschedule-insns2
8300 Similar to @option{-fschedule-insns}, but requests an additional pass of
8301 instruction scheduling after register allocation has been done.  This is
8302 especially useful on machines with a relatively small number of
8303 registers and where memory load instructions take more than one cycle.
8305 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8307 @item -fno-sched-interblock
8308 @opindex fno-sched-interblock
8309 Don't schedule instructions across basic blocks.  This is normally
8310 enabled by default when scheduling before register allocation, i.e.@:
8311 with @option{-fschedule-insns} or at @option{-O2} or higher.
8313 @item -fno-sched-spec
8314 @opindex fno-sched-spec
8315 Don't allow speculative motion of non-load instructions.  This is normally
8316 enabled by default when scheduling before register allocation, i.e.@:
8317 with @option{-fschedule-insns} or at @option{-O2} or higher.
8319 @item -fsched-pressure
8320 @opindex fsched-pressure
8321 Enable register pressure sensitive insn scheduling before register
8322 allocation.  This only makes sense when scheduling before register
8323 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8324 @option{-O2} or higher.  Usage of this option can improve the
8325 generated code and decrease its size by preventing register pressure
8326 increase above the number of available hard registers and subsequent
8327 spills in register allocation.
8329 @item -fsched-spec-load
8330 @opindex fsched-spec-load
8331 Allow speculative motion of some load instructions.  This only makes
8332 sense when scheduling before register allocation, i.e.@: with
8333 @option{-fschedule-insns} or at @option{-O2} or higher.
8335 @item -fsched-spec-load-dangerous
8336 @opindex fsched-spec-load-dangerous
8337 Allow speculative motion of more load instructions.  This only makes
8338 sense when scheduling before register allocation, i.e.@: with
8339 @option{-fschedule-insns} or at @option{-O2} or higher.
8341 @item -fsched-stalled-insns
8342 @itemx -fsched-stalled-insns=@var{n}
8343 @opindex fsched-stalled-insns
8344 Define how many insns (if any) can be moved prematurely from the queue
8345 of stalled insns into the ready list during the second scheduling pass.
8346 @option{-fno-sched-stalled-insns} means that no insns are moved
8347 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8348 on how many queued insns can be moved prematurely.
8349 @option{-fsched-stalled-insns} without a value is equivalent to
8350 @option{-fsched-stalled-insns=1}.
8352 @item -fsched-stalled-insns-dep
8353 @itemx -fsched-stalled-insns-dep=@var{n}
8354 @opindex fsched-stalled-insns-dep
8355 Define how many insn groups (cycles) are examined for a dependency
8356 on a stalled insn that is a candidate for premature removal from the queue
8357 of stalled insns.  This has an effect only during the second scheduling pass,
8358 and only if @option{-fsched-stalled-insns} is used.
8359 @option{-fno-sched-stalled-insns-dep} is equivalent to
8360 @option{-fsched-stalled-insns-dep=0}.
8361 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8362 @option{-fsched-stalled-insns-dep=1}.
8364 @item -fsched2-use-superblocks
8365 @opindex fsched2-use-superblocks
8366 When scheduling after register allocation, use superblock scheduling.
8367 This allows motion across basic block boundaries,
8368 resulting in faster schedules.  This option is experimental, as not all machine
8369 descriptions used by GCC model the CPU closely enough to avoid unreliable
8370 results from the algorithm.
8372 This only makes sense when scheduling after register allocation, i.e.@: with
8373 @option{-fschedule-insns2} or at @option{-O2} or higher.
8375 @item -fsched-group-heuristic
8376 @opindex fsched-group-heuristic
8377 Enable the group heuristic in the scheduler.  This heuristic favors
8378 the instruction that belongs to a schedule group.  This is enabled
8379 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8380 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8382 @item -fsched-critical-path-heuristic
8383 @opindex fsched-critical-path-heuristic
8384 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8385 instructions on the critical path.  This is enabled by default when
8386 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8387 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8389 @item -fsched-spec-insn-heuristic
8390 @opindex fsched-spec-insn-heuristic
8391 Enable the speculative instruction heuristic in the scheduler.  This
8392 heuristic favors speculative instructions with greater dependency weakness.
8393 This is enabled by default when scheduling is enabled, i.e.@:
8394 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8395 or at @option{-O2} or higher.
8397 @item -fsched-rank-heuristic
8398 @opindex fsched-rank-heuristic
8399 Enable the rank heuristic in the scheduler.  This heuristic favors
8400 the instruction belonging to a basic block with greater size or frequency.
8401 This is enabled by default when scheduling is enabled, i.e.@:
8402 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8403 at @option{-O2} or higher.
8405 @item -fsched-last-insn-heuristic
8406 @opindex fsched-last-insn-heuristic
8407 Enable the last-instruction heuristic in the scheduler.  This heuristic
8408 favors the instruction that is less dependent on the last instruction
8409 scheduled.  This is enabled by default when scheduling is enabled,
8410 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8411 at @option{-O2} or higher.
8413 @item -fsched-dep-count-heuristic
8414 @opindex fsched-dep-count-heuristic
8415 Enable the dependent-count heuristic in the scheduler.  This heuristic
8416 favors the instruction that has more instructions depending on it.
8417 This is enabled by default when scheduling is enabled, i.e.@:
8418 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8419 at @option{-O2} or higher.
8421 @item -freschedule-modulo-scheduled-loops
8422 @opindex freschedule-modulo-scheduled-loops
8423 Modulo scheduling is performed before traditional scheduling.  If a loop
8424 is modulo scheduled, later scheduling passes may change its schedule.  
8425 Use this option to control that behavior.
8427 @item -fselective-scheduling
8428 @opindex fselective-scheduling
8429 Schedule instructions using selective scheduling algorithm.  Selective
8430 scheduling runs instead of the first scheduler pass.
8432 @item -fselective-scheduling2
8433 @opindex fselective-scheduling2
8434 Schedule instructions using selective scheduling algorithm.  Selective
8435 scheduling runs instead of the second scheduler pass.
8437 @item -fsel-sched-pipelining
8438 @opindex fsel-sched-pipelining
8439 Enable software pipelining of innermost loops during selective scheduling.
8440 This option has no effect unless one of @option{-fselective-scheduling} or
8441 @option{-fselective-scheduling2} is turned on.
8443 @item -fsel-sched-pipelining-outer-loops
8444 @opindex fsel-sched-pipelining-outer-loops
8445 When pipelining loops during selective scheduling, also pipeline outer loops.
8446 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8448 @item -fsemantic-interposition
8449 @opindex fsemantic-interposition
8450 Some object formats, like ELF, allow interposing of symbols by the 
8451 dynamic linker.
8452 This means that for symbols exported from the DSO, the compiler cannot perform
8453 interprocedural propagation, inlining and other optimizations in anticipation
8454 that the function or variable in question may change. While this feature is
8455 useful, for example, to rewrite memory allocation functions by a debugging
8456 implementation, it is expensive in the terms of code quality.
8457 With @option{-fno-semantic-interposition} the compiler assumes that 
8458 if interposition happens for functions the overwriting function will have 
8459 precisely the same semantics (and side effects). 
8460 Similarly if interposition happens
8461 for variables, the constructor of the variable will be the same. The flag
8462 has no effect for functions explicitly declared inline 
8463 (where it is never allowed for interposition to change semantics) 
8464 and for symbols explicitly declared weak.
8466 @item -fshrink-wrap
8467 @opindex fshrink-wrap
8468 Emit function prologues only before parts of the function that need it,
8469 rather than at the top of the function.  This flag is enabled by default at
8470 @option{-O} and higher.
8472 @item -fshrink-wrap-separate
8473 @opindex fshrink-wrap-separate
8474 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8475 those parts are only executed when needed.
8476 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8477 is also turned on and the target supports this.
8479 @item -fcaller-saves
8480 @opindex fcaller-saves
8481 Enable allocation of values to registers that are clobbered by
8482 function calls, by emitting extra instructions to save and restore the
8483 registers around such calls.  Such allocation is done only when it
8484 seems to result in better code.
8486 This option is always enabled by default on certain machines, usually
8487 those which have no call-preserved registers to use instead.
8489 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8491 @item -fcombine-stack-adjustments
8492 @opindex fcombine-stack-adjustments
8493 Tracks stack adjustments (pushes and pops) and stack memory references
8494 and then tries to find ways to combine them.
8496 Enabled by default at @option{-O1} and higher.
8498 @item -fipa-ra
8499 @opindex fipa-ra
8500 Use caller save registers for allocation if those registers are not used by
8501 any called function.  In that case it is not necessary to save and restore
8502 them around calls.  This is only possible if called functions are part of
8503 same compilation unit as current function and they are compiled before it.
8505 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8506 is disabled if generated code will be instrumented for profiling
8507 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8508 exactly (this happens on targets that do not expose prologues
8509 and epilogues in RTL).
8511 @item -fconserve-stack
8512 @opindex fconserve-stack
8513 Attempt to minimize stack usage.  The compiler attempts to use less
8514 stack space, even if that makes the program slower.  This option
8515 implies setting the @option{large-stack-frame} parameter to 100
8516 and the @option{large-stack-frame-growth} parameter to 400.
8518 @item -ftree-reassoc
8519 @opindex ftree-reassoc
8520 Perform reassociation on trees.  This flag is enabled by default
8521 at @option{-O} and higher.
8523 @item -fcode-hoisting
8524 @opindex fcode-hoisting
8525 Perform code hoisting.  Code hoisting tries to move the
8526 evaluation of expressions executed on all paths to the function exit
8527 as early as possible.  This is especially useful as a code size
8528 optimization, but it often helps for code speed as well.
8529 This flag is enabled by default at @option{-O2} and higher.
8531 @item -ftree-pre
8532 @opindex ftree-pre
8533 Perform partial redundancy elimination (PRE) on trees.  This flag is
8534 enabled by default at @option{-O2} and @option{-O3}.
8536 @item -ftree-partial-pre
8537 @opindex ftree-partial-pre
8538 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8539 enabled by default at @option{-O3}.
8541 @item -ftree-forwprop
8542 @opindex ftree-forwprop
8543 Perform forward propagation on trees.  This flag is enabled by default
8544 at @option{-O} and higher.
8546 @item -ftree-fre
8547 @opindex ftree-fre
8548 Perform full redundancy elimination (FRE) on trees.  The difference
8549 between FRE and PRE is that FRE only considers expressions
8550 that are computed on all paths leading to the redundant computation.
8551 This analysis is faster than PRE, though it exposes fewer redundancies.
8552 This flag is enabled by default at @option{-O} and higher.
8554 @item -ftree-phiprop
8555 @opindex ftree-phiprop
8556 Perform hoisting of loads from conditional pointers on trees.  This
8557 pass is enabled by default at @option{-O} and higher.
8559 @item -fhoist-adjacent-loads
8560 @opindex fhoist-adjacent-loads
8561 Speculatively hoist loads from both branches of an if-then-else if the
8562 loads are from adjacent locations in the same structure and the target
8563 architecture has a conditional move instruction.  This flag is enabled
8564 by default at @option{-O2} and higher.
8566 @item -ftree-copy-prop
8567 @opindex ftree-copy-prop
8568 Perform copy propagation on trees.  This pass eliminates unnecessary
8569 copy operations.  This flag is enabled by default at @option{-O} and
8570 higher.
8572 @item -fipa-pure-const
8573 @opindex fipa-pure-const
8574 Discover which functions are pure or constant.
8575 Enabled by default at @option{-O} and higher.
8577 @item -fipa-reference
8578 @opindex fipa-reference
8579 Discover which static variables do not escape the
8580 compilation unit.
8581 Enabled by default at @option{-O} and higher.
8583 @item -fipa-pta
8584 @opindex fipa-pta
8585 Perform interprocedural pointer analysis and interprocedural modification
8586 and reference analysis.  This option can cause excessive memory and
8587 compile-time usage on large compilation units.  It is not enabled by
8588 default at any optimization level.
8590 @item -fipa-profile
8591 @opindex fipa-profile
8592 Perform interprocedural profile propagation.  The functions called only from
8593 cold functions are marked as cold. Also functions executed once (such as
8594 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8595 functions and loop less parts of functions executed once are then optimized for
8596 size.
8597 Enabled by default at @option{-O} and higher.
8599 @item -fipa-cp
8600 @opindex fipa-cp
8601 Perform interprocedural constant propagation.
8602 This optimization analyzes the program to determine when values passed
8603 to functions are constants and then optimizes accordingly.
8604 This optimization can substantially increase performance
8605 if the application has constants passed to functions.
8606 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8608 @item -fipa-cp-clone
8609 @opindex fipa-cp-clone
8610 Perform function cloning to make interprocedural constant propagation stronger.
8611 When enabled, interprocedural constant propagation performs function cloning
8612 when externally visible function can be called with constant arguments.
8613 Because this optimization can create multiple copies of functions,
8614 it may significantly increase code size
8615 (see @option{--param ipcp-unit-growth=@var{value}}).
8616 This flag is enabled by default at @option{-O3}.
8618 @item -fipa-bit-cp
8619 @opindex -fipa-bit-cp
8620 When enabled, perform interprocedural bitwise constant
8621 propagation. This flag is enabled by default at @option{-O2}. It
8622 requires that @option{-fipa-cp} is enabled.
8624 @item -fipa-vrp
8625 @opindex -fipa-vrp
8626 When enabled, perform interprocedural propagation of value
8627 ranges. This flag is enabled by default at @option{-O2}. It requires
8628 that @option{-fipa-cp} is enabled.
8630 @item -fipa-icf
8631 @opindex fipa-icf
8632 Perform Identical Code Folding for functions and read-only variables.
8633 The optimization reduces code size and may disturb unwind stacks by replacing
8634 a function by equivalent one with a different name. The optimization works
8635 more effectively with link-time optimization enabled.
8637 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8638 works on different levels and thus the optimizations are not same - there are
8639 equivalences that are found only by GCC and equivalences found only by Gold.
8641 This flag is enabled by default at @option{-O2} and @option{-Os}.
8643 @item -fisolate-erroneous-paths-dereference
8644 @opindex fisolate-erroneous-paths-dereference
8645 Detect paths that trigger erroneous or undefined behavior due to
8646 dereferencing a null pointer.  Isolate those paths from the main control
8647 flow and turn the statement with erroneous or undefined behavior into a trap.
8648 This flag is enabled by default at @option{-O2} and higher and depends on
8649 @option{-fdelete-null-pointer-checks} also being enabled.
8651 @item -fisolate-erroneous-paths-attribute
8652 @opindex fisolate-erroneous-paths-attribute
8653 Detect paths that trigger erroneous or undefined behavior due to a null value
8654 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8655 attribute.  Isolate those paths from the main control flow and turn the
8656 statement with erroneous or undefined behavior into a trap.  This is not
8657 currently enabled, but may be enabled by @option{-O2} in the future.
8659 @item -ftree-sink
8660 @opindex ftree-sink
8661 Perform forward store motion on trees.  This flag is
8662 enabled by default at @option{-O} and higher.
8664 @item -ftree-bit-ccp
8665 @opindex ftree-bit-ccp
8666 Perform sparse conditional bit constant propagation on trees and propagate
8667 pointer alignment information.
8668 This pass only operates on local scalar variables and is enabled by default
8669 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8671 @item -ftree-ccp
8672 @opindex ftree-ccp
8673 Perform sparse conditional constant propagation (CCP) on trees.  This
8674 pass only operates on local scalar variables and is enabled by default
8675 at @option{-O} and higher.
8677 @item -fssa-backprop
8678 @opindex fssa-backprop
8679 Propagate information about uses of a value up the definition chain
8680 in order to simplify the definitions.  For example, this pass strips
8681 sign operations if the sign of a value never matters.  The flag is
8682 enabled by default at @option{-O} and higher.
8684 @item -fssa-phiopt
8685 @opindex fssa-phiopt
8686 Perform pattern matching on SSA PHI nodes to optimize conditional
8687 code.  This pass is enabled by default at @option{-O} and higher.
8689 @item -ftree-switch-conversion
8690 @opindex ftree-switch-conversion
8691 Perform conversion of simple initializations in a switch to
8692 initializations from a scalar array.  This flag is enabled by default
8693 at @option{-O2} and higher.
8695 @item -ftree-tail-merge
8696 @opindex ftree-tail-merge
8697 Look for identical code sequences.  When found, replace one with a jump to the
8698 other.  This optimization is known as tail merging or cross jumping.  This flag
8699 is enabled by default at @option{-O2} and higher.  The compilation time
8700 in this pass can
8701 be limited using @option{max-tail-merge-comparisons} parameter and
8702 @option{max-tail-merge-iterations} parameter.
8704 @item -ftree-dce
8705 @opindex ftree-dce
8706 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8707 default at @option{-O} and higher.
8709 @item -ftree-builtin-call-dce
8710 @opindex ftree-builtin-call-dce
8711 Perform conditional dead code elimination (DCE) for calls to built-in functions
8712 that may set @code{errno} but are otherwise side-effect free.  This flag is
8713 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8714 specified.
8716 @item -ftree-dominator-opts
8717 @opindex ftree-dominator-opts
8718 Perform a variety of simple scalar cleanups (constant/copy
8719 propagation, redundancy elimination, range propagation and expression
8720 simplification) based on a dominator tree traversal.  This also
8721 performs jump threading (to reduce jumps to jumps). This flag is
8722 enabled by default at @option{-O} and higher.
8724 @item -ftree-dse
8725 @opindex ftree-dse
8726 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8727 a memory location that is later overwritten by another store without
8728 any intervening loads.  In this case the earlier store can be deleted.  This
8729 flag is enabled by default at @option{-O} and higher.
8731 @item -ftree-ch
8732 @opindex ftree-ch
8733 Perform loop header copying on trees.  This is beneficial since it increases
8734 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8735 is enabled by default at @option{-O} and higher.  It is not enabled
8736 for @option{-Os}, since it usually increases code size.
8738 @item -ftree-loop-optimize
8739 @opindex ftree-loop-optimize
8740 Perform loop optimizations on trees.  This flag is enabled by default
8741 at @option{-O} and higher.
8743 @item -ftree-loop-linear
8744 @itemx -floop-strip-mine
8745 @itemx -floop-block
8746 @opindex ftree-loop-linear
8747 @opindex floop-strip-mine
8748 @opindex floop-block
8749 Perform loop nest optimizations.  Same as
8750 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8751 to be configured with @option{--with-isl} to enable the Graphite loop
8752 transformation infrastructure.
8754 @item -fgraphite-identity
8755 @opindex fgraphite-identity
8756 Enable the identity transformation for graphite.  For every SCoP we generate
8757 the polyhedral representation and transform it back to gimple.  Using
8758 @option{-fgraphite-identity} we can check the costs or benefits of the
8759 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8760 are also performed by the code generator isl, like index splitting and
8761 dead code elimination in loops.
8763 @item -floop-nest-optimize
8764 @opindex floop-nest-optimize
8765 Enable the isl based loop nest optimizer.  This is a generic loop nest
8766 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8767 structure optimized for data-locality and parallelism.  This option
8768 is experimental.
8770 @item -floop-parallelize-all
8771 @opindex floop-parallelize-all
8772 Use the Graphite data dependence analysis to identify loops that can
8773 be parallelized.  Parallelize all the loops that can be analyzed to
8774 not contain loop carried dependences without checking that it is
8775 profitable to parallelize the loops.
8777 @item -ftree-coalesce-vars
8778 @opindex ftree-coalesce-vars
8779 While transforming the program out of the SSA representation, attempt to
8780 reduce copying by coalescing versions of different user-defined
8781 variables, instead of just compiler temporaries.  This may severely
8782 limit the ability to debug an optimized program compiled with
8783 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8784 prevents SSA coalescing of user variables.  This option is enabled by
8785 default if optimization is enabled, and it does very little otherwise.
8787 @item -ftree-loop-if-convert
8788 @opindex ftree-loop-if-convert
8789 Attempt to transform conditional jumps in the innermost loops to
8790 branch-less equivalents.  The intent is to remove control-flow from
8791 the innermost loops in order to improve the ability of the
8792 vectorization pass to handle these loops.  This is enabled by default
8793 if vectorization is enabled.
8795 @item -ftree-loop-distribution
8796 @opindex ftree-loop-distribution
8797 Perform loop distribution.  This flag can improve cache performance on
8798 big loop bodies and allow further loop optimizations, like
8799 parallelization or vectorization, to take place.  For example, the loop
8800 @smallexample
8801 DO I = 1, N
8802   A(I) = B(I) + C
8803   D(I) = E(I) * F
8804 ENDDO
8805 @end smallexample
8806 is transformed to
8807 @smallexample
8808 DO I = 1, N
8809    A(I) = B(I) + C
8810 ENDDO
8811 DO I = 1, N
8812    D(I) = E(I) * F
8813 ENDDO
8814 @end smallexample
8816 @item -ftree-loop-distribute-patterns
8817 @opindex ftree-loop-distribute-patterns
8818 Perform loop distribution of patterns that can be code generated with
8819 calls to a library.  This flag is enabled by default at @option{-O3}.
8821 This pass distributes the initialization loops and generates a call to
8822 memset zero.  For example, the loop
8823 @smallexample
8824 DO I = 1, N
8825   A(I) = 0
8826   B(I) = A(I) + I
8827 ENDDO
8828 @end smallexample
8829 is transformed to
8830 @smallexample
8831 DO I = 1, N
8832    A(I) = 0
8833 ENDDO
8834 DO I = 1, N
8835    B(I) = A(I) + I
8836 ENDDO
8837 @end smallexample
8838 and the initialization loop is transformed into a call to memset zero.
8840 @item -floop-interchange
8841 @opindex floop-interchange
8842 Perform loop interchange outside of graphite.  This flag can improve cache
8843 performance on loop nest and allow further loop optimizations, like
8844 vectorization, to take place.  For example, the loop
8845 @smallexample
8846 for (int i = 0; i < N; i++)
8847   for (int j = 0; j < N; j++)
8848     for (int k = 0; k < N; k++)
8849       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8850 @end smallexample
8851 is transformed to
8852 @smallexample
8853 for (int i = 0; i < N; i++)
8854   for (int k = 0; k < N; k++)
8855     for (int j = 0; j < N; j++)
8856       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8857 @end smallexample
8859 @item -ftree-loop-im
8860 @opindex ftree-loop-im
8861 Perform loop invariant motion on trees.  This pass moves only invariants that
8862 are hard to handle at RTL level (function calls, operations that expand to
8863 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8864 operands of conditions that are invariant out of the loop, so that we can use
8865 just trivial invariantness analysis in loop unswitching.  The pass also includes
8866 store motion.
8868 @item -ftree-loop-ivcanon
8869 @opindex ftree-loop-ivcanon
8870 Create a canonical counter for number of iterations in loops for which
8871 determining number of iterations requires complicated analysis.  Later
8872 optimizations then may determine the number easily.  Useful especially
8873 in connection with unrolling.
8875 @item -fivopts
8876 @opindex fivopts
8877 Perform induction variable optimizations (strength reduction, induction
8878 variable merging and induction variable elimination) on trees.
8880 @item -ftree-parallelize-loops=n
8881 @opindex ftree-parallelize-loops
8882 Parallelize loops, i.e., split their iteration space to run in n threads.
8883 This is only possible for loops whose iterations are independent
8884 and can be arbitrarily reordered.  The optimization is only
8885 profitable on multiprocessor machines, for loops that are CPU-intensive,
8886 rather than constrained e.g.@: by memory bandwidth.  This option
8887 implies @option{-pthread}, and thus is only supported on targets
8888 that have support for @option{-pthread}.
8890 @item -ftree-pta
8891 @opindex ftree-pta
8892 Perform function-local points-to analysis on trees.  This flag is
8893 enabled by default at @option{-O} and higher.
8895 @item -ftree-sra
8896 @opindex ftree-sra
8897 Perform scalar replacement of aggregates.  This pass replaces structure
8898 references with scalars to prevent committing structures to memory too
8899 early.  This flag is enabled by default at @option{-O} and higher.
8901 @item -fstore-merging
8902 @opindex fstore-merging
8903 Perform merging of narrow stores to consecutive memory addresses.  This pass
8904 merges contiguous stores of immediate values narrower than a word into fewer
8905 wider stores to reduce the number of instructions.  This is enabled by default
8906 at @option{-O2} and higher as well as @option{-Os}.
8908 @item -ftree-ter
8909 @opindex ftree-ter
8910 Perform temporary expression replacement during the SSA->normal phase.  Single
8911 use/single def temporaries are replaced at their use location with their
8912 defining expression.  This results in non-GIMPLE code, but gives the expanders
8913 much more complex trees to work on resulting in better RTL generation.  This is
8914 enabled by default at @option{-O} and higher.
8916 @item -ftree-slsr
8917 @opindex ftree-slsr
8918 Perform straight-line strength reduction on trees.  This recognizes related
8919 expressions involving multiplications and replaces them by less expensive
8920 calculations when possible.  This is enabled by default at @option{-O} and
8921 higher.
8923 @item -ftree-vectorize
8924 @opindex ftree-vectorize
8925 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8926 and @option{-ftree-slp-vectorize} if not explicitly specified.
8928 @item -ftree-loop-vectorize
8929 @opindex ftree-loop-vectorize
8930 Perform loop vectorization on trees. This flag is enabled by default at
8931 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8933 @item -ftree-slp-vectorize
8934 @opindex ftree-slp-vectorize
8935 Perform basic block vectorization on trees. This flag is enabled by default at
8936 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8938 @item -fvect-cost-model=@var{model}
8939 @opindex fvect-cost-model
8940 Alter the cost model used for vectorization.  The @var{model} argument
8941 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8942 With the @samp{unlimited} model the vectorized code-path is assumed
8943 to be profitable while with the @samp{dynamic} model a runtime check
8944 guards the vectorized code-path to enable it only for iteration
8945 counts that will likely execute faster than when executing the original
8946 scalar loop.  The @samp{cheap} model disables vectorization of
8947 loops where doing so would be cost prohibitive for example due to
8948 required runtime checks for data dependence or alignment but otherwise
8949 is equal to the @samp{dynamic} model.
8950 The default cost model depends on other optimization flags and is
8951 either @samp{dynamic} or @samp{cheap}.
8953 @item -fsimd-cost-model=@var{model}
8954 @opindex fsimd-cost-model
8955 Alter the cost model used for vectorization of loops marked with the OpenMP
8956 simd directive.  The @var{model} argument should be one of
8957 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8958 have the same meaning as described in @option{-fvect-cost-model} and by
8959 default a cost model defined with @option{-fvect-cost-model} is used.
8961 @item -ftree-vrp
8962 @opindex ftree-vrp
8963 Perform Value Range Propagation on trees.  This is similar to the
8964 constant propagation pass, but instead of values, ranges of values are
8965 propagated.  This allows the optimizers to remove unnecessary range
8966 checks like array bound checks and null pointer checks.  This is
8967 enabled by default at @option{-O2} and higher.  Null pointer check
8968 elimination is only done if @option{-fdelete-null-pointer-checks} is
8969 enabled.
8971 @item -fsplit-paths
8972 @opindex fsplit-paths
8973 Split paths leading to loop backedges.  This can improve dead code
8974 elimination and common subexpression elimination.  This is enabled by
8975 default at @option{-O2} and above.
8977 @item -fsplit-ivs-in-unroller
8978 @opindex fsplit-ivs-in-unroller
8979 Enables expression of values of induction variables in later iterations
8980 of the unrolled loop using the value in the first iteration.  This breaks
8981 long dependency chains, thus improving efficiency of the scheduling passes.
8983 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8984 same effect.  However, that is not reliable in cases where the loop body
8985 is more complicated than a single basic block.  It also does not work at all
8986 on some architectures due to restrictions in the CSE pass.
8988 This optimization is enabled by default.
8990 @item -fvariable-expansion-in-unroller
8991 @opindex fvariable-expansion-in-unroller
8992 With this option, the compiler creates multiple copies of some
8993 local variables when unrolling a loop, which can result in superior code.
8995 @item -fpartial-inlining
8996 @opindex fpartial-inlining
8997 Inline parts of functions.  This option has any effect only
8998 when inlining itself is turned on by the @option{-finline-functions}
8999 or @option{-finline-small-functions} options.
9001 Enabled at level @option{-O2}.
9003 @item -fpredictive-commoning
9004 @opindex fpredictive-commoning
9005 Perform predictive commoning optimization, i.e., reusing computations
9006 (especially memory loads and stores) performed in previous
9007 iterations of loops.
9009 This option is enabled at level @option{-O3}.
9011 @item -fprefetch-loop-arrays
9012 @opindex fprefetch-loop-arrays
9013 If supported by the target machine, generate instructions to prefetch
9014 memory to improve the performance of loops that access large arrays.
9016 This option may generate better or worse code; results are highly
9017 dependent on the structure of loops within the source code.
9019 Disabled at level @option{-Os}.
9021 @item -fno-printf-return-value
9022 @opindex fno-printf-return-value
9023 Do not substitute constants for known return value of formatted output
9024 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9025 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9026 transformation allows GCC to optimize or even eliminate branches based
9027 on the known return value of these functions called with arguments that
9028 are either constant, or whose values are known to be in a range that
9029 makes determining the exact return value possible.  For example, when
9030 @option{-fprintf-return-value} is in effect, both the branch and the
9031 body of the @code{if} statement (but not the call to @code{snprint})
9032 can be optimized away when @code{i} is a 32-bit or smaller integer
9033 because the return value is guaranteed to be at most 8.
9035 @smallexample
9036 char buf[9];
9037 if (snprintf (buf, "%08x", i) >= sizeof buf)
9038   @dots{}
9039 @end smallexample
9041 The @option{-fprintf-return-value} option relies on other optimizations
9042 and yields best results with @option{-O2}.  It works in tandem with the
9043 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
9044 The @option{-fprintf-return-value} option is enabled by default.
9046 @item -fno-peephole
9047 @itemx -fno-peephole2
9048 @opindex fno-peephole
9049 @opindex fno-peephole2
9050 Disable any machine-specific peephole optimizations.  The difference
9051 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9052 are implemented in the compiler; some targets use one, some use the
9053 other, a few use both.
9055 @option{-fpeephole} is enabled by default.
9056 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9058 @item -fno-guess-branch-probability
9059 @opindex fno-guess-branch-probability
9060 Do not guess branch probabilities using heuristics.
9062 GCC uses heuristics to guess branch probabilities if they are
9063 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9064 heuristics are based on the control flow graph.  If some branch probabilities
9065 are specified by @code{__builtin_expect}, then the heuristics are
9066 used to guess branch probabilities for the rest of the control flow graph,
9067 taking the @code{__builtin_expect} info into account.  The interactions
9068 between the heuristics and @code{__builtin_expect} can be complex, and in
9069 some cases, it may be useful to disable the heuristics so that the effects
9070 of @code{__builtin_expect} are easier to understand.
9072 The default is @option{-fguess-branch-probability} at levels
9073 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9075 @item -freorder-blocks
9076 @opindex freorder-blocks
9077 Reorder basic blocks in the compiled function in order to reduce number of
9078 taken branches and improve code locality.
9080 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9082 @item -freorder-blocks-algorithm=@var{algorithm}
9083 @opindex freorder-blocks-algorithm
9084 Use the specified algorithm for basic block reordering.  The
9085 @var{algorithm} argument can be @samp{simple}, which does not increase
9086 code size (except sometimes due to secondary effects like alignment),
9087 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9088 put all often executed code together, minimizing the number of branches
9089 executed by making extra copies of code.
9091 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9092 @samp{stc} at levels @option{-O2}, @option{-O3}.
9094 @item -freorder-blocks-and-partition
9095 @opindex freorder-blocks-and-partition
9096 In addition to reordering basic blocks in the compiled function, in order
9097 to reduce number of taken branches, partitions hot and cold basic blocks
9098 into separate sections of the assembly and @file{.o} files, to improve
9099 paging and cache locality performance.
9101 This optimization is automatically turned off in the presence of
9102 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9103 section attribute and on any architecture that does not support named
9104 sections.  When @option{-fsplit-stack} is used this option is not
9105 enabled by default (to avoid linker errors), but may be enabled
9106 explicitly (if using a working linker).
9108 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9110 @item -freorder-functions
9111 @opindex freorder-functions
9112 Reorder functions in the object file in order to
9113 improve code locality.  This is implemented by using special
9114 subsections @code{.text.hot} for most frequently executed functions and
9115 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9116 the linker so object file format must support named sections and linker must
9117 place them in a reasonable way.
9119 Also profile feedback must be available to make this option effective.  See
9120 @option{-fprofile-arcs} for details.
9122 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9124 @item -fstrict-aliasing
9125 @opindex fstrict-aliasing
9126 Allow the compiler to assume the strictest aliasing rules applicable to
9127 the language being compiled.  For C (and C++), this activates
9128 optimizations based on the type of expressions.  In particular, an
9129 object of one type is assumed never to reside at the same address as an
9130 object of a different type, unless the types are almost the same.  For
9131 example, an @code{unsigned int} can alias an @code{int}, but not a
9132 @code{void*} or a @code{double}.  A character type may alias any other
9133 type.
9135 @anchor{Type-punning}Pay special attention to code like this:
9136 @smallexample
9137 union a_union @{
9138   int i;
9139   double d;
9142 int f() @{
9143   union a_union t;
9144   t.d = 3.0;
9145   return t.i;
9147 @end smallexample
9148 The practice of reading from a different union member than the one most
9149 recently written to (called ``type-punning'') is common.  Even with
9150 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9151 is accessed through the union type.  So, the code above works as
9152 expected.  @xref{Structures unions enumerations and bit-fields
9153 implementation}.  However, this code might not:
9154 @smallexample
9155 int f() @{
9156   union a_union t;
9157   int* ip;
9158   t.d = 3.0;
9159   ip = &t.i;
9160   return *ip;
9162 @end smallexample
9164 Similarly, access by taking the address, casting the resulting pointer
9165 and dereferencing the result has undefined behavior, even if the cast
9166 uses a union type, e.g.:
9167 @smallexample
9168 int f() @{
9169   double d = 3.0;
9170   return ((union a_union *) &d)->i;
9172 @end smallexample
9174 The @option{-fstrict-aliasing} option is enabled at levels
9175 @option{-O2}, @option{-O3}, @option{-Os}.
9177 @item -falign-functions
9178 @itemx -falign-functions=@var{n}
9179 @opindex falign-functions
9180 Align the start of functions to the next power-of-two greater than
9181 @var{n}, skipping up to @var{n} bytes.  For instance,
9182 @option{-falign-functions=32} aligns functions to the next 32-byte
9183 boundary, but @option{-falign-functions=24} aligns to the next
9184 32-byte boundary only if this can be done by skipping 23 bytes or less.
9186 @option{-fno-align-functions} and @option{-falign-functions=1} are
9187 equivalent and mean that functions are not aligned.
9189 Some assemblers only support this flag when @var{n} is a power of two;
9190 in that case, it is rounded up.
9192 If @var{n} is not specified or is zero, use a machine-dependent default.
9193 The maximum allowed @var{n} option value is 65536.
9195 Enabled at levels @option{-O2}, @option{-O3}.
9197 @item -flimit-function-alignment
9198 If this option is enabled, the compiler tries to avoid unnecessarily
9199 overaligning functions. It attempts to instruct the assembler to align
9200 by the amount specified by @option{-falign-functions}, but not to
9201 skip more bytes than the size of the function.
9203 @item -falign-labels
9204 @itemx -falign-labels=@var{n}
9205 @opindex falign-labels
9206 Align all branch targets to a power-of-two boundary, skipping up to
9207 @var{n} bytes like @option{-falign-functions}.  This option can easily
9208 make code slower, because it must insert dummy operations for when the
9209 branch target is reached in the usual flow of the code.
9211 @option{-fno-align-labels} and @option{-falign-labels=1} are
9212 equivalent and mean that labels are not aligned.
9214 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9215 are greater than this value, then their values are used instead.
9217 If @var{n} is not specified or is zero, use a machine-dependent default
9218 which is very likely to be @samp{1}, meaning no alignment.
9219 The maximum allowed @var{n} option value is 65536.
9221 Enabled at levels @option{-O2}, @option{-O3}.
9223 @item -falign-loops
9224 @itemx -falign-loops=@var{n}
9225 @opindex falign-loops
9226 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9227 like @option{-falign-functions}.  If the loops are
9228 executed many times, this makes up for any execution of the dummy
9229 operations.
9231 @option{-fno-align-loops} and @option{-falign-loops=1} are
9232 equivalent and mean that loops are not aligned.
9233 The maximum allowed @var{n} option value is 65536.
9235 If @var{n} is not specified or is zero, use a machine-dependent default.
9237 Enabled at levels @option{-O2}, @option{-O3}.
9239 @item -falign-jumps
9240 @itemx -falign-jumps=@var{n}
9241 @opindex falign-jumps
9242 Align branch targets to a power-of-two boundary, for branch targets
9243 where the targets can only be reached by jumping, skipping up to @var{n}
9244 bytes like @option{-falign-functions}.  In this case, no dummy operations
9245 need be executed.
9247 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9248 equivalent and mean that loops are not aligned.
9250 If @var{n} is not specified or is zero, use a machine-dependent default.
9251 The maximum allowed @var{n} option value is 65536.
9253 Enabled at levels @option{-O2}, @option{-O3}.
9255 @item -funit-at-a-time
9256 @opindex funit-at-a-time
9257 This option is left for compatibility reasons. @option{-funit-at-a-time}
9258 has no effect, while @option{-fno-unit-at-a-time} implies
9259 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9261 Enabled by default.
9263 @item -fno-toplevel-reorder
9264 @opindex fno-toplevel-reorder
9265 Do not reorder top-level functions, variables, and @code{asm}
9266 statements.  Output them in the same order that they appear in the
9267 input file.  When this option is used, unreferenced static variables
9268 are not removed.  This option is intended to support existing code
9269 that relies on a particular ordering.  For new code, it is better to
9270 use attributes when possible.
9272 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9273 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9274 targets.
9276 @item -fweb
9277 @opindex fweb
9278 Constructs webs as commonly used for register allocation purposes and assign
9279 each web individual pseudo register.  This allows the register allocation pass
9280 to operate on pseudos directly, but also strengthens several other optimization
9281 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9282 however, make debugging impossible, since variables no longer stay in a
9283 ``home register''.
9285 Enabled by default with @option{-funroll-loops}.
9287 @item -fwhole-program
9288 @opindex fwhole-program
9289 Assume that the current compilation unit represents the whole program being
9290 compiled.  All public functions and variables with the exception of @code{main}
9291 and those merged by attribute @code{externally_visible} become static functions
9292 and in effect are optimized more aggressively by interprocedural optimizers.
9294 This option should not be used in combination with @option{-flto}.
9295 Instead relying on a linker plugin should provide safer and more precise
9296 information.
9298 @item -flto[=@var{n}]
9299 @opindex flto
9300 This option runs the standard link-time optimizer.  When invoked
9301 with source code, it generates GIMPLE (one of GCC's internal
9302 representations) and writes it to special ELF sections in the object
9303 file.  When the object files are linked together, all the function
9304 bodies are read from these ELF sections and instantiated as if they
9305 had been part of the same translation unit.
9307 To use the link-time optimizer, @option{-flto} and optimization
9308 options should be specified at compile time and during the final link.
9309 It is recommended that you compile all the files participating in the
9310 same link with the same options and also specify those options at
9311 link time.  
9312 For example:
9314 @smallexample
9315 gcc -c -O2 -flto foo.c
9316 gcc -c -O2 -flto bar.c
9317 gcc -o myprog -flto -O2 foo.o bar.o
9318 @end smallexample
9320 The first two invocations to GCC save a bytecode representation
9321 of GIMPLE into special ELF sections inside @file{foo.o} and
9322 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9323 @file{foo.o} and @file{bar.o}, merges the two files into a single
9324 internal image, and compiles the result as usual.  Since both
9325 @file{foo.o} and @file{bar.o} are merged into a single image, this
9326 causes all the interprocedural analyses and optimizations in GCC to
9327 work across the two files as if they were a single one.  This means,
9328 for example, that the inliner is able to inline functions in
9329 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9331 Another (simpler) way to enable link-time optimization is:
9333 @smallexample
9334 gcc -o myprog -flto -O2 foo.c bar.c
9335 @end smallexample
9337 The above generates bytecode for @file{foo.c} and @file{bar.c},
9338 merges them together into a single GIMPLE representation and optimizes
9339 them as usual to produce @file{myprog}.
9341 The only important thing to keep in mind is that to enable link-time
9342 optimizations you need to use the GCC driver to perform the link step.
9343 GCC then automatically performs link-time optimization if any of the
9344 objects involved were compiled with the @option{-flto} command-line option.  
9345 You generally
9346 should specify the optimization options to be used for link-time
9347 optimization though GCC tries to be clever at guessing an
9348 optimization level to use from the options used at compile time
9349 if you fail to specify one at link time.  You can always override
9350 the automatic decision to do link-time optimization
9351 by passing @option{-fno-lto} to the link command.
9353 To make whole program optimization effective, it is necessary to make
9354 certain whole program assumptions.  The compiler needs to know
9355 what functions and variables can be accessed by libraries and runtime
9356 outside of the link-time optimized unit.  When supported by the linker,
9357 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9358 to the compiler about used and externally visible symbols.  When
9359 the linker plugin is not available, @option{-fwhole-program} should be
9360 used to allow the compiler to make these assumptions, which leads
9361 to more aggressive optimization decisions.
9363 When @option{-fuse-linker-plugin} is not enabled, when a file is
9364 compiled with @option{-flto}, the generated object file is larger than
9365 a regular object file because it contains GIMPLE bytecodes and the usual
9366 final code (see @option{-ffat-lto-objects}.  This means that
9367 object files with LTO information can be linked as normal object
9368 files; if @option{-fno-lto} is passed to the linker, no
9369 interprocedural optimizations are applied.  Note that when
9370 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9371 but you cannot perform a regular, non-LTO link on them.
9373 Additionally, the optimization flags used to compile individual files
9374 are not necessarily related to those used at link time.  For instance,
9376 @smallexample
9377 gcc -c -O0 -ffat-lto-objects -flto foo.c
9378 gcc -c -O0 -ffat-lto-objects -flto bar.c
9379 gcc -o myprog -O3 foo.o bar.o
9380 @end smallexample
9382 This produces individual object files with unoptimized assembler
9383 code, but the resulting binary @file{myprog} is optimized at
9384 @option{-O3}.  If, instead, the final binary is generated with
9385 @option{-fno-lto}, then @file{myprog} is not optimized.
9387 When producing the final binary, GCC only
9388 applies link-time optimizations to those files that contain bytecode.
9389 Therefore, you can mix and match object files and libraries with
9390 GIMPLE bytecodes and final object code.  GCC automatically selects
9391 which files to optimize in LTO mode and which files to link without
9392 further processing.
9394 There are some code generation flags preserved by GCC when
9395 generating bytecodes, as they need to be used during the final link
9396 stage.  Generally options specified at link time override those
9397 specified at compile time.
9399 If you do not specify an optimization level option @option{-O} at
9400 link time, then GCC uses the highest optimization level 
9401 used when compiling the object files.
9403 Currently, the following options and their settings are taken from
9404 the first object file that explicitly specifies them: 
9405 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9406 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9407 and all the @option{-m} target flags.
9409 Certain ABI-changing flags are required to match in all compilation units,
9410 and trying to override this at link time with a conflicting value
9411 is ignored.  This includes options such as @option{-freg-struct-return}
9412 and @option{-fpcc-struct-return}. 
9414 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9415 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9416 are passed through to the link stage and merged conservatively for
9417 conflicting translation units.  Specifically
9418 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9419 precedence; and for example @option{-ffp-contract=off} takes precedence
9420 over @option{-ffp-contract=fast}.  You can override them at link time.
9422 If LTO encounters objects with C linkage declared with incompatible
9423 types in separate translation units to be linked together (undefined
9424 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9425 issued.  The behavior is still undefined at run time.  Similar
9426 diagnostics may be raised for other languages.
9428 Another feature of LTO is that it is possible to apply interprocedural
9429 optimizations on files written in different languages:
9431 @smallexample
9432 gcc -c -flto foo.c
9433 g++ -c -flto bar.cc
9434 gfortran -c -flto baz.f90
9435 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9436 @end smallexample
9438 Notice that the final link is done with @command{g++} to get the C++
9439 runtime libraries and @option{-lgfortran} is added to get the Fortran
9440 runtime libraries.  In general, when mixing languages in LTO mode, you
9441 should use the same link command options as when mixing languages in a
9442 regular (non-LTO) compilation.
9444 If object files containing GIMPLE bytecode are stored in a library archive, say
9445 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9446 are using a linker with plugin support.  To create static libraries suitable
9447 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9448 and @command{ranlib}; 
9449 to show the symbols of object files with GIMPLE bytecode, use
9450 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9451 and @command{nm} have been compiled with plugin support.  At link time, use the the
9452 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9453 the LTO optimization process:
9455 @smallexample
9456 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9457 @end smallexample
9459 With the linker plugin enabled, the linker extracts the needed
9460 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9461 to make them part of the aggregated GIMPLE image to be optimized.
9463 If you are not using a linker with plugin support and/or do not
9464 enable the linker plugin, then the objects inside @file{libfoo.a}
9465 are extracted and linked as usual, but they do not participate
9466 in the LTO optimization process.  In order to make a static library suitable
9467 for both LTO optimization and usual linkage, compile its object files with
9468 @option{-flto} @option{-ffat-lto-objects}.
9470 Link-time optimizations do not require the presence of the whole program to
9471 operate.  If the program does not require any symbols to be exported, it is
9472 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9473 the interprocedural optimizers to use more aggressive assumptions which may
9474 lead to improved optimization opportunities.
9475 Use of @option{-fwhole-program} is not needed when linker plugin is
9476 active (see @option{-fuse-linker-plugin}).
9478 The current implementation of LTO makes no
9479 attempt to generate bytecode that is portable between different
9480 types of hosts.  The bytecode files are versioned and there is a
9481 strict version check, so bytecode files generated in one version of
9482 GCC do not work with an older or newer version of GCC.
9484 Link-time optimization does not work well with generation of debugging
9485 information.  Combining @option{-flto} with
9486 @option{-g} is currently experimental and expected to produce unexpected
9487 results.
9489 If you specify the optional @var{n}, the optimization and code
9490 generation done at link time is executed in parallel using @var{n}
9491 parallel jobs by utilizing an installed @command{make} program.  The
9492 environment variable @env{MAKE} may be used to override the program
9493 used.  The default value for @var{n} is 1.
9495 You can also specify @option{-flto=jobserver} to use GNU make's
9496 job server mode to determine the number of parallel jobs. This
9497 is useful when the Makefile calling GCC is already executing in parallel.
9498 You must prepend a @samp{+} to the command recipe in the parent Makefile
9499 for this to work.  This option likely only works if @env{MAKE} is
9500 GNU make.
9502 @item -flto-partition=@var{alg}
9503 @opindex flto-partition
9504 Specify the partitioning algorithm used by the link-time optimizer.
9505 The value is either @samp{1to1} to specify a partitioning mirroring
9506 the original source files or @samp{balanced} to specify partitioning
9507 into equally sized chunks (whenever possible) or @samp{max} to create
9508 new partition for every symbol where possible.  Specifying @samp{none}
9509 as an algorithm disables partitioning and streaming completely. 
9510 The default value is @samp{balanced}. While @samp{1to1} can be used
9511 as an workaround for various code ordering issues, the @samp{max}
9512 partitioning is intended for internal testing only.
9513 The value @samp{one} specifies that exactly one partition should be
9514 used while the value @samp{none} bypasses partitioning and executes
9515 the link-time optimization step directly from the WPA phase.
9517 @item -flto-odr-type-merging
9518 @opindex flto-odr-type-merging
9519 Enable streaming of mangled types names of C++ types and their unification
9520 at link time.  This increases size of LTO object files, but enables
9521 diagnostics about One Definition Rule violations.
9523 @item -flto-compression-level=@var{n}
9524 @opindex flto-compression-level
9525 This option specifies the level of compression used for intermediate
9526 language written to LTO object files, and is only meaningful in
9527 conjunction with LTO mode (@option{-flto}).  Valid
9528 values are 0 (no compression) to 9 (maximum compression).  Values
9529 outside this range are clamped to either 0 or 9.  If the option is not
9530 given, a default balanced compression setting is used.
9532 @item -fuse-linker-plugin
9533 @opindex fuse-linker-plugin
9534 Enables the use of a linker plugin during link-time optimization.  This
9535 option relies on plugin support in the linker, which is available in gold
9536 or in GNU ld 2.21 or newer.
9538 This option enables the extraction of object files with GIMPLE bytecode out
9539 of library archives. This improves the quality of optimization by exposing
9540 more code to the link-time optimizer.  This information specifies what
9541 symbols can be accessed externally (by non-LTO object or during dynamic
9542 linking).  Resulting code quality improvements on binaries (and shared
9543 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9544 See @option{-flto} for a description of the effect of this flag and how to
9545 use it.
9547 This option is enabled by default when LTO support in GCC is enabled
9548 and GCC was configured for use with
9549 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9551 @item -ffat-lto-objects
9552 @opindex ffat-lto-objects
9553 Fat LTO objects are object files that contain both the intermediate language
9554 and the object code. This makes them usable for both LTO linking and normal
9555 linking. This option is effective only when compiling with @option{-flto}
9556 and is ignored at link time.
9558 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9559 requires the complete toolchain to be aware of LTO. It requires a linker with
9560 linker plugin support for basic functionality.  Additionally,
9561 @command{nm}, @command{ar} and @command{ranlib}
9562 need to support linker plugins to allow a full-featured build environment
9563 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9564 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9565 to these tools. With non fat LTO makefiles need to be modified to use them.
9567 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9568 support.
9570 @item -fcompare-elim
9571 @opindex fcompare-elim
9572 After register allocation and post-register allocation instruction splitting,
9573 identify arithmetic instructions that compute processor flags similar to a
9574 comparison operation based on that arithmetic.  If possible, eliminate the
9575 explicit comparison operation.
9577 This pass only applies to certain targets that cannot explicitly represent
9578 the comparison operation before register allocation is complete.
9580 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9582 @item -fcprop-registers
9583 @opindex fcprop-registers
9584 After register allocation and post-register allocation instruction splitting,
9585 perform a copy-propagation pass to try to reduce scheduling dependencies
9586 and occasionally eliminate the copy.
9588 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9590 @item -fprofile-correction
9591 @opindex fprofile-correction
9592 Profiles collected using an instrumented binary for multi-threaded programs may
9593 be inconsistent due to missed counter updates. When this option is specified,
9594 GCC uses heuristics to correct or smooth out such inconsistencies. By
9595 default, GCC emits an error message when an inconsistent profile is detected.
9597 @item -fprofile-use
9598 @itemx -fprofile-use=@var{path}
9599 @opindex fprofile-use
9600 Enable profile feedback-directed optimizations, 
9601 and the following optimizations
9602 which are generally profitable only with profile feedback available:
9603 @option{-fbranch-probabilities}, @option{-fvpt},
9604 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9605 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9607 Before you can use this option, you must first generate profiling information.
9608 @xref{Instrumentation Options}, for information about the
9609 @option{-fprofile-generate} option.
9611 By default, GCC emits an error message if the feedback profiles do not
9612 match the source code.  This error can be turned into a warning by using
9613 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9614 code.
9616 If @var{path} is specified, GCC looks at the @var{path} to find
9617 the profile feedback data files. See @option{-fprofile-dir}.
9619 @item -fauto-profile
9620 @itemx -fauto-profile=@var{path}
9621 @opindex fauto-profile
9622 Enable sampling-based feedback-directed optimizations, 
9623 and the following optimizations
9624 which are generally profitable only with profile feedback available:
9625 @option{-fbranch-probabilities}, @option{-fvpt},
9626 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9627 @option{-ftree-vectorize},
9628 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9629 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9630 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9632 @var{path} is the name of a file containing AutoFDO profile information.
9633 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9635 Producing an AutoFDO profile data file requires running your program
9636 with the @command{perf} utility on a supported GNU/Linux target system.
9637 For more information, see @uref{https://perf.wiki.kernel.org/}.
9639 E.g.
9640 @smallexample
9641 perf record -e br_inst_retired:near_taken -b -o perf.data \
9642     -- your_program
9643 @end smallexample
9645 Then use the @command{create_gcov} tool to convert the raw profile data
9646 to a format that can be used by GCC.@  You must also supply the 
9647 unstripped binary for your program to this tool.  
9648 See @uref{https://github.com/google/autofdo}.
9650 E.g.
9651 @smallexample
9652 create_gcov --binary=your_program.unstripped --profile=perf.data \
9653     --gcov=profile.afdo
9654 @end smallexample
9655 @end table
9657 The following options control compiler behavior regarding floating-point 
9658 arithmetic.  These options trade off between speed and
9659 correctness.  All must be specifically enabled.
9661 @table @gcctabopt
9662 @item -ffloat-store
9663 @opindex ffloat-store
9664 Do not store floating-point variables in registers, and inhibit other
9665 options that might change whether a floating-point value is taken from a
9666 register or memory.
9668 @cindex floating-point precision
9669 This option prevents undesirable excess precision on machines such as
9670 the 68000 where the floating registers (of the 68881) keep more
9671 precision than a @code{double} is supposed to have.  Similarly for the
9672 x86 architecture.  For most programs, the excess precision does only
9673 good, but a few programs rely on the precise definition of IEEE floating
9674 point.  Use @option{-ffloat-store} for such programs, after modifying
9675 them to store all pertinent intermediate computations into variables.
9677 @item -fexcess-precision=@var{style}
9678 @opindex fexcess-precision
9679 This option allows further control over excess precision on machines
9680 where floating-point operations occur in a format with more precision or
9681 range than the IEEE standard and interchange floating-point types.  By
9682 default, @option{-fexcess-precision=fast} is in effect; this means that
9683 operations may be carried out in a wider precision than the types specified
9684 in the source if that would result in faster code, and it is unpredictable
9685 when rounding to the types specified in the source code takes place.
9686 When compiling C, if @option{-fexcess-precision=standard} is specified then
9687 excess precision follows the rules specified in ISO C99; in particular,
9688 both casts and assignments cause values to be rounded to their
9689 semantic types (whereas @option{-ffloat-store} only affects
9690 assignments).  This option is enabled by default for C if a strict
9691 conformance option such as @option{-std=c99} is used.
9692 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9693 regardless of whether a strict conformance option is used.
9695 @opindex mfpmath
9696 @option{-fexcess-precision=standard} is not implemented for languages
9697 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9698 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9699 semantics apply without excess precision, and in the latter, rounding
9700 is unpredictable.
9702 @item -ffast-math
9703 @opindex ffast-math
9704 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9705 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9706 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9707 @option{-fexcess-precision=fast}.
9709 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9711 This option is not turned on by any @option{-O} option besides
9712 @option{-Ofast} since it can result in incorrect output for programs
9713 that depend on an exact implementation of IEEE or ISO rules/specifications
9714 for math functions. It may, however, yield faster code for programs
9715 that do not require the guarantees of these specifications.
9717 @item -fno-math-errno
9718 @opindex fno-math-errno
9719 Do not set @code{errno} after calling math functions that are executed
9720 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9721 IEEE exceptions for math error handling may want to use this flag
9722 for speed while maintaining IEEE arithmetic compatibility.
9724 This option is not turned on by any @option{-O} option since
9725 it can result in incorrect output for programs that depend on
9726 an exact implementation of IEEE or ISO rules/specifications for
9727 math functions. It may, however, yield faster code for programs
9728 that do not require the guarantees of these specifications.
9730 The default is @option{-fmath-errno}.
9732 On Darwin systems, the math library never sets @code{errno}.  There is
9733 therefore no reason for the compiler to consider the possibility that
9734 it might, and @option{-fno-math-errno} is the default.
9736 @item -funsafe-math-optimizations
9737 @opindex funsafe-math-optimizations
9739 Allow optimizations for floating-point arithmetic that (a) assume
9740 that arguments and results are valid and (b) may violate IEEE or
9741 ANSI standards.  When used at link time, it may include libraries
9742 or startup files that change the default FPU control word or other
9743 similar optimizations.
9745 This option is not turned on by any @option{-O} option since
9746 it can result in incorrect output for programs that depend on
9747 an exact implementation of IEEE or ISO rules/specifications for
9748 math functions. It may, however, yield faster code for programs
9749 that do not require the guarantees of these specifications.
9750 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9751 @option{-fassociative-math} and @option{-freciprocal-math}.
9753 The default is @option{-fno-unsafe-math-optimizations}.
9755 @item -fassociative-math
9756 @opindex fassociative-math
9758 Allow re-association of operands in series of floating-point operations.
9759 This violates the ISO C and C++ language standard by possibly changing
9760 computation result.  NOTE: re-ordering may change the sign of zero as
9761 well as ignore NaNs and inhibit or create underflow or overflow (and
9762 thus cannot be used on code that relies on rounding behavior like
9763 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9764 and thus may not be used when ordered comparisons are required.
9765 This option requires that both @option{-fno-signed-zeros} and
9766 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9767 much sense with @option{-frounding-math}. For Fortran the option
9768 is automatically enabled when both @option{-fno-signed-zeros} and
9769 @option{-fno-trapping-math} are in effect.
9771 The default is @option{-fno-associative-math}.
9773 @item -freciprocal-math
9774 @opindex freciprocal-math
9776 Allow the reciprocal of a value to be used instead of dividing by
9777 the value if this enables optimizations.  For example @code{x / y}
9778 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9779 is subject to common subexpression elimination.  Note that this loses
9780 precision and increases the number of flops operating on the value.
9782 The default is @option{-fno-reciprocal-math}.
9784 @item -ffinite-math-only
9785 @opindex ffinite-math-only
9786 Allow optimizations for floating-point arithmetic that assume
9787 that arguments and results are not NaNs or +-Infs.
9789 This option is not turned on by any @option{-O} option since
9790 it can result in incorrect output for programs that depend on
9791 an exact implementation of IEEE or ISO rules/specifications for
9792 math functions. It may, however, yield faster code for programs
9793 that do not require the guarantees of these specifications.
9795 The default is @option{-fno-finite-math-only}.
9797 @item -fno-signed-zeros
9798 @opindex fno-signed-zeros
9799 Allow optimizations for floating-point arithmetic that ignore the
9800 signedness of zero.  IEEE arithmetic specifies the behavior of
9801 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9802 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9803 This option implies that the sign of a zero result isn't significant.
9805 The default is @option{-fsigned-zeros}.
9807 @item -fno-trapping-math
9808 @opindex fno-trapping-math
9809 Compile code assuming that floating-point operations cannot generate
9810 user-visible traps.  These traps include division by zero, overflow,
9811 underflow, inexact result and invalid operation.  This option requires
9812 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9813 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9815 This option should never be turned on by any @option{-O} option since
9816 it can result in incorrect output for programs that depend on
9817 an exact implementation of IEEE or ISO rules/specifications for
9818 math functions.
9820 The default is @option{-ftrapping-math}.
9822 @item -frounding-math
9823 @opindex frounding-math
9824 Disable transformations and optimizations that assume default floating-point
9825 rounding behavior.  This is round-to-zero for all floating point
9826 to integer conversions, and round-to-nearest for all other arithmetic
9827 truncations.  This option should be specified for programs that change
9828 the FP rounding mode dynamically, or that may be executed with a
9829 non-default rounding mode.  This option disables constant folding of
9830 floating-point expressions at compile time (which may be affected by
9831 rounding mode) and arithmetic transformations that are unsafe in the
9832 presence of sign-dependent rounding modes.
9834 The default is @option{-fno-rounding-math}.
9836 This option is experimental and does not currently guarantee to
9837 disable all GCC optimizations that are affected by rounding mode.
9838 Future versions of GCC may provide finer control of this setting
9839 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9840 will be used to specify the default state for @code{FENV_ACCESS}.
9842 @item -fsignaling-nans
9843 @opindex fsignaling-nans
9844 Compile code assuming that IEEE signaling NaNs may generate user-visible
9845 traps during floating-point operations.  Setting this option disables
9846 optimizations that may change the number of exceptions visible with
9847 signaling NaNs.  This option implies @option{-ftrapping-math}.
9849 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9850 be defined.
9852 The default is @option{-fno-signaling-nans}.
9854 This option is experimental and does not currently guarantee to
9855 disable all GCC optimizations that affect signaling NaN behavior.
9857 @item -fno-fp-int-builtin-inexact
9858 @opindex fno-fp-int-builtin-inexact
9859 Do not allow the built-in functions @code{ceil}, @code{floor},
9860 @code{round} and @code{trunc}, and their @code{float} and @code{long
9861 double} variants, to generate code that raises the ``inexact''
9862 floating-point exception for noninteger arguments.  ISO C99 and C11
9863 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9864 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9865 functions to do so.
9867 The default is @option{-ffp-int-builtin-inexact}, allowing the
9868 exception to be raised.  This option does nothing unless
9869 @option{-ftrapping-math} is in effect.
9871 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9872 generate a call to a library function then the ``inexact'' exception
9873 may be raised if the library implementation does not follow TS 18661.
9875 @item -fsingle-precision-constant
9876 @opindex fsingle-precision-constant
9877 Treat floating-point constants as single precision instead of
9878 implicitly converting them to double-precision constants.
9880 @item -fcx-limited-range
9881 @opindex fcx-limited-range
9882 When enabled, this option states that a range reduction step is not
9883 needed when performing complex division.  Also, there is no checking
9884 whether the result of a complex multiplication or division is @code{NaN
9885 + I*NaN}, with an attempt to rescue the situation in that case.  The
9886 default is @option{-fno-cx-limited-range}, but is enabled by
9887 @option{-ffast-math}.
9889 This option controls the default setting of the ISO C99
9890 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9891 all languages.
9893 @item -fcx-fortran-rules
9894 @opindex fcx-fortran-rules
9895 Complex multiplication and division follow Fortran rules.  Range
9896 reduction is done as part of complex division, but there is no checking
9897 whether the result of a complex multiplication or division is @code{NaN
9898 + I*NaN}, with an attempt to rescue the situation in that case.
9900 The default is @option{-fno-cx-fortran-rules}.
9902 @end table
9904 The following options control optimizations that may improve
9905 performance, but are not enabled by any @option{-O} options.  This
9906 section includes experimental options that may produce broken code.
9908 @table @gcctabopt
9909 @item -fbranch-probabilities
9910 @opindex fbranch-probabilities
9911 After running a program compiled with @option{-fprofile-arcs}
9912 (@pxref{Instrumentation Options}),
9913 you can compile it a second time using
9914 @option{-fbranch-probabilities}, to improve optimizations based on
9915 the number of times each branch was taken.  When a program
9916 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9917 counts to a file called @file{@var{sourcename}.gcda} for each source
9918 file.  The information in this data file is very dependent on the
9919 structure of the generated code, so you must use the same source code
9920 and the same optimization options for both compilations.
9922 With @option{-fbranch-probabilities}, GCC puts a
9923 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9924 These can be used to improve optimization.  Currently, they are only
9925 used in one place: in @file{reorg.c}, instead of guessing which path a
9926 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9927 exactly determine which path is taken more often.
9929 @item -fprofile-values
9930 @opindex fprofile-values
9931 If combined with @option{-fprofile-arcs}, it adds code so that some
9932 data about values of expressions in the program is gathered.
9934 With @option{-fbranch-probabilities}, it reads back the data gathered
9935 from profiling values of expressions for usage in optimizations.
9937 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9939 @item -fprofile-reorder-functions
9940 @opindex fprofile-reorder-functions
9941 Function reordering based on profile instrumentation collects
9942 first time of execution of a function and orders these functions
9943 in ascending order.
9945 Enabled with @option{-fprofile-use}.
9947 @item -fvpt
9948 @opindex fvpt
9949 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9950 to add code to gather information about values of expressions.
9952 With @option{-fbranch-probabilities}, it reads back the data gathered
9953 and actually performs the optimizations based on them.
9954 Currently the optimizations include specialization of division operations
9955 using the knowledge about the value of the denominator.
9957 @item -frename-registers
9958 @opindex frename-registers
9959 Attempt to avoid false dependencies in scheduled code by making use
9960 of registers left over after register allocation.  This optimization
9961 most benefits processors with lots of registers.  Depending on the
9962 debug information format adopted by the target, however, it can
9963 make debugging impossible, since variables no longer stay in
9964 a ``home register''.
9966 Enabled by default with @option{-funroll-loops}.
9968 @item -fschedule-fusion
9969 @opindex fschedule-fusion
9970 Performs a target dependent pass over the instruction stream to schedule
9971 instructions of same type together because target machine can execute them
9972 more efficiently if they are adjacent to each other in the instruction flow.
9974 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9976 @item -ftracer
9977 @opindex ftracer
9978 Perform tail duplication to enlarge superblock size.  This transformation
9979 simplifies the control flow of the function allowing other optimizations to do
9980 a better job.
9982 Enabled with @option{-fprofile-use}.
9984 @item -funroll-loops
9985 @opindex funroll-loops
9986 Unroll loops whose number of iterations can be determined at compile time or
9987 upon entry to the loop.  @option{-funroll-loops} implies
9988 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9989 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9990 a small constant number of iterations).  This option makes code larger, and may
9991 or may not make it run faster.
9993 Enabled with @option{-fprofile-use}.
9995 @item -funroll-all-loops
9996 @opindex funroll-all-loops
9997 Unroll all loops, even if their number of iterations is uncertain when
9998 the loop is entered.  This usually makes programs run more slowly.
9999 @option{-funroll-all-loops} implies the same options as
10000 @option{-funroll-loops}.
10002 @item -fpeel-loops
10003 @opindex fpeel-loops
10004 Peels loops for which there is enough information that they do not
10005 roll much (from profile feedback or static analysis).  It also turns on
10006 complete loop peeling (i.e.@: complete removal of loops with small constant
10007 number of iterations).
10009 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10011 @item -fmove-loop-invariants
10012 @opindex fmove-loop-invariants
10013 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10014 at level @option{-O1}
10016 @item -fsplit-loops
10017 @opindex fsplit-loops
10018 Split a loop into two if it contains a condition that's always true
10019 for one side of the iteration space and false for the other.
10021 @item -funswitch-loops
10022 @opindex funswitch-loops
10023 Move branches with loop invariant conditions out of the loop, with duplicates
10024 of the loop on both branches (modified according to result of the condition).
10026 @item -floop-unroll-and-jam
10027 @opindex floop-unroll-and-jam
10028 Apply unroll and jam transformations on feasible loops.  In a loop
10029 nest this unrolls the outer loop by some factor and fuses the resulting
10030 multiple inner loops.
10032 @item -ffunction-sections
10033 @itemx -fdata-sections
10034 @opindex ffunction-sections
10035 @opindex fdata-sections
10036 Place each function or data item into its own section in the output
10037 file if the target supports arbitrary sections.  The name of the
10038 function or the name of the data item determines the section's name
10039 in the output file.
10041 Use these options on systems where the linker can perform optimizations to
10042 improve locality of reference in the instruction space.  Most systems using the
10043 ELF object format have linkers with such optimizations.  On AIX, the linker
10044 rearranges sections (CSECTs) based on the call graph.  The performance impact
10045 varies.
10047 Together with a linker garbage collection (linker @option{--gc-sections}
10048 option) these options may lead to smaller statically-linked executables (after
10049 stripping).
10051 On ELF/DWARF systems these options do not degenerate the quality of the debug
10052 information.  There could be issues with other object files/debug info formats.
10054 Only use these options when there are significant benefits from doing so.  When
10055 you specify these options, the assembler and linker create larger object and
10056 executable files and are also slower.  These options affect code generation.
10057 They prevent optimizations by the compiler and assembler using relative
10058 locations inside a translation unit since the locations are unknown until
10059 link time.  An example of such an optimization is relaxing calls to short call
10060 instructions.
10062 @item -fbranch-target-load-optimize
10063 @opindex fbranch-target-load-optimize
10064 Perform branch target register load optimization before prologue / epilogue
10065 threading.
10066 The use of target registers can typically be exposed only during reload,
10067 thus hoisting loads out of loops and doing inter-block scheduling needs
10068 a separate optimization pass.
10070 @item -fbranch-target-load-optimize2
10071 @opindex fbranch-target-load-optimize2
10072 Perform branch target register load optimization after prologue / epilogue
10073 threading.
10075 @item -fbtr-bb-exclusive
10076 @opindex fbtr-bb-exclusive
10077 When performing branch target register load optimization, don't reuse
10078 branch target registers within any basic block.
10080 @item -fstdarg-opt
10081 @opindex fstdarg-opt
10082 Optimize the prologue of variadic argument functions with respect to usage of
10083 those arguments.
10085 @item -fsection-anchors
10086 @opindex fsection-anchors
10087 Try to reduce the number of symbolic address calculations by using
10088 shared ``anchor'' symbols to address nearby objects.  This transformation
10089 can help to reduce the number of GOT entries and GOT accesses on some
10090 targets.
10092 For example, the implementation of the following function @code{foo}:
10094 @smallexample
10095 static int a, b, c;
10096 int foo (void) @{ return a + b + c; @}
10097 @end smallexample
10099 @noindent
10100 usually calculates the addresses of all three variables, but if you
10101 compile it with @option{-fsection-anchors}, it accesses the variables
10102 from a common anchor point instead.  The effect is similar to the
10103 following pseudocode (which isn't valid C):
10105 @smallexample
10106 int foo (void)
10108   register int *xr = &x;
10109   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10111 @end smallexample
10113 Not all targets support this option.
10115 @item --param @var{name}=@var{value}
10116 @opindex param
10117 In some places, GCC uses various constants to control the amount of
10118 optimization that is done.  For example, GCC does not inline functions
10119 that contain more than a certain number of instructions.  You can
10120 control some of these constants on the command line using the
10121 @option{--param} option.
10123 The names of specific parameters, and the meaning of the values, are
10124 tied to the internals of the compiler, and are subject to change
10125 without notice in future releases.
10127 In each case, the @var{value} is an integer.  The allowable choices for
10128 @var{name} are:
10130 @table @gcctabopt
10131 @item predictable-branch-outcome
10132 When branch is predicted to be taken with probability lower than this threshold
10133 (in percent), then it is considered well predictable. The default is 10.
10135 @item max-rtl-if-conversion-insns
10136 RTL if-conversion tries to remove conditional branches around a block and
10137 replace them with conditionally executed instructions.  This parameter
10138 gives the maximum number of instructions in a block which should be
10139 considered for if-conversion.  The default is 10, though the compiler will
10140 also use other heuristics to decide whether if-conversion is likely to be
10141 profitable.
10143 @item max-rtl-if-conversion-predictable-cost
10144 @itemx max-rtl-if-conversion-unpredictable-cost
10145 RTL if-conversion will try to remove conditional branches around a block
10146 and replace them with conditionally executed instructions.  These parameters
10147 give the maximum permissible cost for the sequence that would be generated
10148 by if-conversion depending on whether the branch is statically determined
10149 to be predictable or not.  The units for this parameter are the same as
10150 those for the GCC internal seq_cost metric.  The compiler will try to
10151 provide a reasonable default for this parameter using the BRANCH_COST
10152 target macro.
10154 @item max-crossjump-edges
10155 The maximum number of incoming edges to consider for cross-jumping.
10156 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10157 the number of edges incoming to each block.  Increasing values mean
10158 more aggressive optimization, making the compilation time increase with
10159 probably small improvement in executable size.
10161 @item min-crossjump-insns
10162 The minimum number of instructions that must be matched at the end
10163 of two blocks before cross-jumping is performed on them.  This
10164 value is ignored in the case where all instructions in the block being
10165 cross-jumped from are matched.  The default value is 5.
10167 @item max-grow-copy-bb-insns
10168 The maximum code size expansion factor when copying basic blocks
10169 instead of jumping.  The expansion is relative to a jump instruction.
10170 The default value is 8.
10172 @item max-goto-duplication-insns
10173 The maximum number of instructions to duplicate to a block that jumps
10174 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10175 passes, GCC factors computed gotos early in the compilation process,
10176 and unfactors them as late as possible.  Only computed jumps at the
10177 end of a basic blocks with no more than max-goto-duplication-insns are
10178 unfactored.  The default value is 8.
10180 @item max-delay-slot-insn-search
10181 The maximum number of instructions to consider when looking for an
10182 instruction to fill a delay slot.  If more than this arbitrary number of
10183 instructions are searched, the time savings from filling the delay slot
10184 are minimal, so stop searching.  Increasing values mean more
10185 aggressive optimization, making the compilation time increase with probably
10186 small improvement in execution time.
10188 @item max-delay-slot-live-search
10189 When trying to fill delay slots, the maximum number of instructions to
10190 consider when searching for a block with valid live register
10191 information.  Increasing this arbitrarily chosen value means more
10192 aggressive optimization, increasing the compilation time.  This parameter
10193 should be removed when the delay slot code is rewritten to maintain the
10194 control-flow graph.
10196 @item max-gcse-memory
10197 The approximate maximum amount of memory that can be allocated in
10198 order to perform the global common subexpression elimination
10199 optimization.  If more memory than specified is required, the
10200 optimization is not done.
10202 @item max-gcse-insertion-ratio
10203 If the ratio of expression insertions to deletions is larger than this value
10204 for any expression, then RTL PRE inserts or removes the expression and thus
10205 leaves partially redundant computations in the instruction stream.  The default value is 20.
10207 @item max-pending-list-length
10208 The maximum number of pending dependencies scheduling allows
10209 before flushing the current state and starting over.  Large functions
10210 with few branches or calls can create excessively large lists which
10211 needlessly consume memory and resources.
10213 @item max-modulo-backtrack-attempts
10214 The maximum number of backtrack attempts the scheduler should make
10215 when modulo scheduling a loop.  Larger values can exponentially increase
10216 compilation time.
10218 @item max-inline-insns-single
10219 Several parameters control the tree inliner used in GCC@.
10220 This number sets the maximum number of instructions (counted in GCC's
10221 internal representation) in a single function that the tree inliner
10222 considers for inlining.  This only affects functions declared
10223 inline and methods implemented in a class declaration (C++).
10224 The default value is 400.
10226 @item max-inline-insns-auto
10227 When you use @option{-finline-functions} (included in @option{-O3}),
10228 a lot of functions that would otherwise not be considered for inlining
10229 by the compiler are investigated.  To those functions, a different
10230 (more restrictive) limit compared to functions declared inline can
10231 be applied.
10232 The default value is 30.
10234 @item inline-min-speedup
10235 When estimated performance improvement of caller + callee runtime exceeds this
10236 threshold (in percent), the function can be inlined regardless of the limit on
10237 @option{--param max-inline-insns-single} and @option{--param
10238 max-inline-insns-auto}.
10239 The default value is 15.
10241 @item large-function-insns
10242 The limit specifying really large functions.  For functions larger than this
10243 limit after inlining, inlining is constrained by
10244 @option{--param large-function-growth}.  This parameter is useful primarily
10245 to avoid extreme compilation time caused by non-linear algorithms used by the
10246 back end.
10247 The default value is 2700.
10249 @item large-function-growth
10250 Specifies maximal growth of large function caused by inlining in percents.
10251 The default value is 100 which limits large function growth to 2.0 times
10252 the original size.
10254 @item large-unit-insns
10255 The limit specifying large translation unit.  Growth caused by inlining of
10256 units larger than this limit is limited by @option{--param inline-unit-growth}.
10257 For small units this might be too tight.
10258 For example, consider a unit consisting of function A
10259 that is inline and B that just calls A three times.  If B is small relative to
10260 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10261 large units consisting of small inlineable functions, however, the overall unit
10262 growth limit is needed to avoid exponential explosion of code size.  Thus for
10263 smaller units, the size is increased to @option{--param large-unit-insns}
10264 before applying @option{--param inline-unit-growth}.  The default is 10000.
10266 @item inline-unit-growth
10267 Specifies maximal overall growth of the compilation unit caused by inlining.
10268 The default value is 20 which limits unit growth to 1.2 times the original
10269 size. Cold functions (either marked cold via an attribute or by profile
10270 feedback) are not accounted into the unit size.
10272 @item ipcp-unit-growth
10273 Specifies maximal overall growth of the compilation unit caused by
10274 interprocedural constant propagation.  The default value is 10 which limits
10275 unit growth to 1.1 times the original size.
10277 @item large-stack-frame
10278 The limit specifying large stack frames.  While inlining the algorithm is trying
10279 to not grow past this limit too much.  The default value is 256 bytes.
10281 @item large-stack-frame-growth
10282 Specifies maximal growth of large stack frames caused by inlining in percents.
10283 The default value is 1000 which limits large stack frame growth to 11 times
10284 the original size.
10286 @item max-inline-insns-recursive
10287 @itemx max-inline-insns-recursive-auto
10288 Specifies the maximum number of instructions an out-of-line copy of a
10289 self-recursive inline
10290 function can grow into by performing recursive inlining.
10292 @option{--param max-inline-insns-recursive} applies to functions
10293 declared inline.
10294 For functions not declared inline, recursive inlining
10295 happens only when @option{-finline-functions} (included in @option{-O3}) is
10296 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10297 default value is 450.
10299 @item max-inline-recursive-depth
10300 @itemx max-inline-recursive-depth-auto
10301 Specifies the maximum recursion depth used for recursive inlining.
10303 @option{--param max-inline-recursive-depth} applies to functions
10304 declared inline.  For functions not declared inline, recursive inlining
10305 happens only when @option{-finline-functions} (included in @option{-O3}) is
10306 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10307 default value is 8.
10309 @item min-inline-recursive-probability
10310 Recursive inlining is profitable only for function having deep recursion
10311 in average and can hurt for function having little recursion depth by
10312 increasing the prologue size or complexity of function body to other
10313 optimizers.
10315 When profile feedback is available (see @option{-fprofile-generate}) the actual
10316 recursion depth can be guessed from the probability that function recurses
10317 via a given call expression.  This parameter limits inlining only to call
10318 expressions whose probability exceeds the given threshold (in percents).
10319 The default value is 10.
10321 @item early-inlining-insns
10322 Specify growth that the early inliner can make.  In effect it increases
10323 the amount of inlining for code having a large abstraction penalty.
10324 The default value is 14.
10326 @item max-early-inliner-iterations
10327 Limit of iterations of the early inliner.  This basically bounds
10328 the number of nested indirect calls the early inliner can resolve.
10329 Deeper chains are still handled by late inlining.
10331 @item comdat-sharing-probability
10332 Probability (in percent) that C++ inline function with comdat visibility
10333 are shared across multiple compilation units.  The default value is 20.
10335 @item profile-func-internal-id
10336 A parameter to control whether to use function internal id in profile
10337 database lookup. If the value is 0, the compiler uses an id that
10338 is based on function assembler name and filename, which makes old profile
10339 data more tolerant to source changes such as function reordering etc.
10340 The default value is 0.
10342 @item min-vect-loop-bound
10343 The minimum number of iterations under which loops are not vectorized
10344 when @option{-ftree-vectorize} is used.  The number of iterations after
10345 vectorization needs to be greater than the value specified by this option
10346 to allow vectorization.  The default value is 0.
10348 @item gcse-cost-distance-ratio
10349 Scaling factor in calculation of maximum distance an expression
10350 can be moved by GCSE optimizations.  This is currently supported only in the
10351 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10352 is with simple expressions, i.e., the expressions that have cost
10353 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10354 hoisting of simple expressions.  The default value is 10.
10356 @item gcse-unrestricted-cost
10357 Cost, roughly measured as the cost of a single typical machine
10358 instruction, at which GCSE optimizations do not constrain
10359 the distance an expression can travel.  This is currently
10360 supported only in the code hoisting pass.  The lesser the cost,
10361 the more aggressive code hoisting is.  Specifying 0 
10362 allows all expressions to travel unrestricted distances.
10363 The default value is 3.
10365 @item max-hoist-depth
10366 The depth of search in the dominator tree for expressions to hoist.
10367 This is used to avoid quadratic behavior in hoisting algorithm.
10368 The value of 0 does not limit on the search, but may slow down compilation
10369 of huge functions.  The default value is 30.
10371 @item max-tail-merge-comparisons
10372 The maximum amount of similar bbs to compare a bb with.  This is used to
10373 avoid quadratic behavior in tree tail merging.  The default value is 10.
10375 @item max-tail-merge-iterations
10376 The maximum amount of iterations of the pass over the function.  This is used to
10377 limit compilation time in tree tail merging.  The default value is 2.
10379 @item store-merging-allow-unaligned
10380 Allow the store merging pass to introduce unaligned stores if it is legal to
10381 do so.  The default value is 1.
10383 @item max-stores-to-merge
10384 The maximum number of stores to attempt to merge into wider stores in the store
10385 merging pass.  The minimum value is 2 and the default is 64.
10387 @item max-unrolled-insns
10388 The maximum number of instructions that a loop may have to be unrolled.
10389 If a loop is unrolled, this parameter also determines how many times
10390 the loop code is unrolled.
10392 @item max-average-unrolled-insns
10393 The maximum number of instructions biased by probabilities of their execution
10394 that a loop may have to be unrolled.  If a loop is unrolled,
10395 this parameter also determines how many times the loop code is unrolled.
10397 @item max-unroll-times
10398 The maximum number of unrollings of a single loop.
10400 @item max-peeled-insns
10401 The maximum number of instructions that a loop may have to be peeled.
10402 If a loop is peeled, this parameter also determines how many times
10403 the loop code is peeled.
10405 @item max-peel-times
10406 The maximum number of peelings of a single loop.
10408 @item max-peel-branches
10409 The maximum number of branches on the hot path through the peeled sequence.
10411 @item max-completely-peeled-insns
10412 The maximum number of insns of a completely peeled loop.
10414 @item max-completely-peel-times
10415 The maximum number of iterations of a loop to be suitable for complete peeling.
10417 @item max-completely-peel-loop-nest-depth
10418 The maximum depth of a loop nest suitable for complete peeling.
10420 @item max-unswitch-insns
10421 The maximum number of insns of an unswitched loop.
10423 @item max-unswitch-level
10424 The maximum number of branches unswitched in a single loop.
10426 @item max-loop-headers-insns
10427 The maximum number of insns in loop header duplicated by the copy loop headers
10428 pass.
10430 @item lim-expensive
10431 The minimum cost of an expensive expression in the loop invariant motion.
10433 @item iv-consider-all-candidates-bound
10434 Bound on number of candidates for induction variables, below which
10435 all candidates are considered for each use in induction variable
10436 optimizations.  If there are more candidates than this,
10437 only the most relevant ones are considered to avoid quadratic time complexity.
10439 @item iv-max-considered-uses
10440 The induction variable optimizations give up on loops that contain more
10441 induction variable uses.
10443 @item iv-always-prune-cand-set-bound
10444 If the number of candidates in the set is smaller than this value,
10445 always try to remove unnecessary ivs from the set
10446 when adding a new one.
10448 @item avg-loop-niter
10449 Average number of iterations of a loop.
10451 @item dse-max-object-size
10452 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10453 Larger values may result in larger compilation times.
10455 @item scev-max-expr-size
10456 Bound on size of expressions used in the scalar evolutions analyzer.
10457 Large expressions slow the analyzer.
10459 @item scev-max-expr-complexity
10460 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10461 Complex expressions slow the analyzer.
10463 @item max-tree-if-conversion-phi-args
10464 Maximum number of arguments in a PHI supported by TREE if conversion
10465 unless the loop is marked with simd pragma.
10467 @item vect-max-version-for-alignment-checks
10468 The maximum number of run-time checks that can be performed when
10469 doing loop versioning for alignment in the vectorizer.
10471 @item vect-max-version-for-alias-checks
10472 The maximum number of run-time checks that can be performed when
10473 doing loop versioning for alias in the vectorizer.
10475 @item vect-max-peeling-for-alignment
10476 The maximum number of loop peels to enhance access alignment
10477 for vectorizer. Value -1 means no limit.
10479 @item max-iterations-to-track
10480 The maximum number of iterations of a loop the brute-force algorithm
10481 for analysis of the number of iterations of the loop tries to evaluate.
10483 @item hot-bb-count-ws-permille
10484 A basic block profile count is considered hot if it contributes to 
10485 the given permillage (i.e. 0...1000) of the entire profiled execution.
10487 @item hot-bb-frequency-fraction
10488 Select fraction of the entry block frequency of executions of basic block in
10489 function given basic block needs to have to be considered hot.
10491 @item max-predicted-iterations
10492 The maximum number of loop iterations we predict statically.  This is useful
10493 in cases where a function contains a single loop with known bound and
10494 another loop with unknown bound.
10495 The known number of iterations is predicted correctly, while
10496 the unknown number of iterations average to roughly 10.  This means that the
10497 loop without bounds appears artificially cold relative to the other one.
10499 @item builtin-expect-probability
10500 Control the probability of the expression having the specified value. This
10501 parameter takes a percentage (i.e. 0 ... 100) as input.
10502 The default probability of 90 is obtained empirically.
10504 @item align-threshold
10506 Select fraction of the maximal frequency of executions of a basic block in
10507 a function to align the basic block.
10509 @item align-loop-iterations
10511 A loop expected to iterate at least the selected number of iterations is
10512 aligned.
10514 @item tracer-dynamic-coverage
10515 @itemx tracer-dynamic-coverage-feedback
10517 This value is used to limit superblock formation once the given percentage of
10518 executed instructions is covered.  This limits unnecessary code size
10519 expansion.
10521 The @option{tracer-dynamic-coverage-feedback} parameter
10522 is used only when profile
10523 feedback is available.  The real profiles (as opposed to statically estimated
10524 ones) are much less balanced allowing the threshold to be larger value.
10526 @item tracer-max-code-growth
10527 Stop tail duplication once code growth has reached given percentage.  This is
10528 a rather artificial limit, as most of the duplicates are eliminated later in
10529 cross jumping, so it may be set to much higher values than is the desired code
10530 growth.
10532 @item tracer-min-branch-ratio
10534 Stop reverse growth when the reverse probability of best edge is less than this
10535 threshold (in percent).
10537 @item tracer-min-branch-probability
10538 @itemx tracer-min-branch-probability-feedback
10540 Stop forward growth if the best edge has probability lower than this
10541 threshold.
10543 Similarly to @option{tracer-dynamic-coverage} two parameters are
10544 provided.  @option{tracer-min-branch-probability-feedback} is used for
10545 compilation with profile feedback and @option{tracer-min-branch-probability}
10546 compilation without.  The value for compilation with profile feedback
10547 needs to be more conservative (higher) in order to make tracer
10548 effective.
10550 @item stack-clash-protection-guard-size
10551 Specify the size of the operating system provided stack guard as
10552 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10553 Acceptable values are between 12 and 30.  Higher values may reduce the
10554 number of explicit probes, but a value larger than the operating system
10555 provided guard will leave code vulnerable to stack clash style attacks.
10557 @item stack-clash-protection-probe-interval
10558 Stack clash protection involves probing stack space as it is allocated.  This
10559 param controls the maximum distance between probes into the stack as 2 raised
10560 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10561 12.  Higher values may reduce the number of explicit probes, but a value
10562 larger than the operating system provided guard will leave code vulnerable to
10563 stack clash style attacks.
10565 @item max-cse-path-length
10567 The maximum number of basic blocks on path that CSE considers.
10568 The default is 10.
10570 @item max-cse-insns
10571 The maximum number of instructions CSE processes before flushing.
10572 The default is 1000.
10574 @item ggc-min-expand
10576 GCC uses a garbage collector to manage its own memory allocation.  This
10577 parameter specifies the minimum percentage by which the garbage
10578 collector's heap should be allowed to expand between collections.
10579 Tuning this may improve compilation speed; it has no effect on code
10580 generation.
10582 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10583 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10584 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10585 GCC is not able to calculate RAM on a particular platform, the lower
10586 bound of 30% is used.  Setting this parameter and
10587 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10588 every opportunity.  This is extremely slow, but can be useful for
10589 debugging.
10591 @item ggc-min-heapsize
10593 Minimum size of the garbage collector's heap before it begins bothering
10594 to collect garbage.  The first collection occurs after the heap expands
10595 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10596 tuning this may improve compilation speed, and has no effect on code
10597 generation.
10599 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10600 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10601 with a lower bound of 4096 (four megabytes) and an upper bound of
10602 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10603 particular platform, the lower bound is used.  Setting this parameter
10604 very large effectively disables garbage collection.  Setting this
10605 parameter and @option{ggc-min-expand} to zero causes a full collection
10606 to occur at every opportunity.
10608 @item max-reload-search-insns
10609 The maximum number of instruction reload should look backward for equivalent
10610 register.  Increasing values mean more aggressive optimization, making the
10611 compilation time increase with probably slightly better performance.
10612 The default value is 100.
10614 @item max-cselib-memory-locations
10615 The maximum number of memory locations cselib should take into account.
10616 Increasing values mean more aggressive optimization, making the compilation time
10617 increase with probably slightly better performance.  The default value is 500.
10619 @item max-sched-ready-insns
10620 The maximum number of instructions ready to be issued the scheduler should
10621 consider at any given time during the first scheduling pass.  Increasing
10622 values mean more thorough searches, making the compilation time increase
10623 with probably little benefit.  The default value is 100.
10625 @item max-sched-region-blocks
10626 The maximum number of blocks in a region to be considered for
10627 interblock scheduling.  The default value is 10.
10629 @item max-pipeline-region-blocks
10630 The maximum number of blocks in a region to be considered for
10631 pipelining in the selective scheduler.  The default value is 15.
10633 @item max-sched-region-insns
10634 The maximum number of insns in a region to be considered for
10635 interblock scheduling.  The default value is 100.
10637 @item max-pipeline-region-insns
10638 The maximum number of insns in a region to be considered for
10639 pipelining in the selective scheduler.  The default value is 200.
10641 @item min-spec-prob
10642 The minimum probability (in percents) of reaching a source block
10643 for interblock speculative scheduling.  The default value is 40.
10645 @item max-sched-extend-regions-iters
10646 The maximum number of iterations through CFG to extend regions.
10647 A value of 0 (the default) disables region extensions.
10649 @item max-sched-insn-conflict-delay
10650 The maximum conflict delay for an insn to be considered for speculative motion.
10651 The default value is 3.
10653 @item sched-spec-prob-cutoff
10654 The minimal probability of speculation success (in percents), so that
10655 speculative insns are scheduled.
10656 The default value is 40.
10658 @item sched-state-edge-prob-cutoff
10659 The minimum probability an edge must have for the scheduler to save its
10660 state across it.
10661 The default value is 10.
10663 @item sched-mem-true-dep-cost
10664 Minimal distance (in CPU cycles) between store and load targeting same
10665 memory locations.  The default value is 1.
10667 @item selsched-max-lookahead
10668 The maximum size of the lookahead window of selective scheduling.  It is a
10669 depth of search for available instructions.
10670 The default value is 50.
10672 @item selsched-max-sched-times
10673 The maximum number of times that an instruction is scheduled during
10674 selective scheduling.  This is the limit on the number of iterations
10675 through which the instruction may be pipelined.  The default value is 2.
10677 @item selsched-insns-to-rename
10678 The maximum number of best instructions in the ready list that are considered
10679 for renaming in the selective scheduler.  The default value is 2.
10681 @item sms-min-sc
10682 The minimum value of stage count that swing modulo scheduler
10683 generates.  The default value is 2.
10685 @item max-last-value-rtl
10686 The maximum size measured as number of RTLs that can be recorded in an expression
10687 in combiner for a pseudo register as last known value of that register.  The default
10688 is 10000.
10690 @item max-combine-insns
10691 The maximum number of instructions the RTL combiner tries to combine.
10692 The default value is 2 at @option{-Og} and 4 otherwise.
10694 @item integer-share-limit
10695 Small integer constants can use a shared data structure, reducing the
10696 compiler's memory usage and increasing its speed.  This sets the maximum
10697 value of a shared integer constant.  The default value is 256.
10699 @item ssp-buffer-size
10700 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10701 protection when @option{-fstack-protection} is used.
10703 @item min-size-for-stack-sharing
10704 The minimum size of variables taking part in stack slot sharing when not
10705 optimizing. The default value is 32.
10707 @item max-jump-thread-duplication-stmts
10708 Maximum number of statements allowed in a block that needs to be
10709 duplicated when threading jumps.
10711 @item max-fields-for-field-sensitive
10712 Maximum number of fields in a structure treated in
10713 a field sensitive manner during pointer analysis.  The default is zero
10714 for @option{-O0} and @option{-O1},
10715 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10717 @item prefetch-latency
10718 Estimate on average number of instructions that are executed before
10719 prefetch finishes.  The distance prefetched ahead is proportional
10720 to this constant.  Increasing this number may also lead to less
10721 streams being prefetched (see @option{simultaneous-prefetches}).
10723 @item simultaneous-prefetches
10724 Maximum number of prefetches that can run at the same time.
10726 @item l1-cache-line-size
10727 The size of cache line in L1 cache, in bytes.
10729 @item l1-cache-size
10730 The size of L1 cache, in kilobytes.
10732 @item l2-cache-size
10733 The size of L2 cache, in kilobytes.
10735 @item loop-interchange-max-num-stmts
10736 The maximum number of stmts in a loop to be interchanged.
10738 @item loop-interchange-stride-ratio
10739 The minimum ratio between stride of two loops for interchange to be profitable.
10741 @item min-insn-to-prefetch-ratio
10742 The minimum ratio between the number of instructions and the
10743 number of prefetches to enable prefetching in a loop.
10745 @item prefetch-min-insn-to-mem-ratio
10746 The minimum ratio between the number of instructions and the
10747 number of memory references to enable prefetching in a loop.
10749 @item use-canonical-types
10750 Whether the compiler should use the ``canonical'' type system.  By
10751 default, this should always be 1, which uses a more efficient internal
10752 mechanism for comparing types in C++ and Objective-C++.  However, if
10753 bugs in the canonical type system are causing compilation failures,
10754 set this value to 0 to disable canonical types.
10756 @item switch-conversion-max-branch-ratio
10757 Switch initialization conversion refuses to create arrays that are
10758 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10759 branches in the switch.
10761 @item max-partial-antic-length
10762 Maximum length of the partial antic set computed during the tree
10763 partial redundancy elimination optimization (@option{-ftree-pre}) when
10764 optimizing at @option{-O3} and above.  For some sorts of source code
10765 the enhanced partial redundancy elimination optimization can run away,
10766 consuming all of the memory available on the host machine.  This
10767 parameter sets a limit on the length of the sets that are computed,
10768 which prevents the runaway behavior.  Setting a value of 0 for
10769 this parameter allows an unlimited set length.
10771 @item sccvn-max-scc-size
10772 Maximum size of a strongly connected component (SCC) during SCCVN
10773 processing.  If this limit is hit, SCCVN processing for the whole
10774 function is not done and optimizations depending on it are
10775 disabled.  The default maximum SCC size is 10000.
10777 @item sccvn-max-alias-queries-per-access
10778 Maximum number of alias-oracle queries we perform when looking for
10779 redundancies for loads and stores.  If this limit is hit the search
10780 is aborted and the load or store is not considered redundant.  The
10781 number of queries is algorithmically limited to the number of
10782 stores on all paths from the load to the function entry.
10783 The default maximum number of queries is 1000.
10785 @item ira-max-loops-num
10786 IRA uses regional register allocation by default.  If a function
10787 contains more loops than the number given by this parameter, only at most
10788 the given number of the most frequently-executed loops form regions
10789 for regional register allocation.  The default value of the
10790 parameter is 100.
10792 @item ira-max-conflict-table-size 
10793 Although IRA uses a sophisticated algorithm to compress the conflict
10794 table, the table can still require excessive amounts of memory for
10795 huge functions.  If the conflict table for a function could be more
10796 than the size in MB given by this parameter, the register allocator
10797 instead uses a faster, simpler, and lower-quality
10798 algorithm that does not require building a pseudo-register conflict table.  
10799 The default value of the parameter is 2000.
10801 @item ira-loop-reserved-regs
10802 IRA can be used to evaluate more accurate register pressure in loops
10803 for decisions to move loop invariants (see @option{-O3}).  The number
10804 of available registers reserved for some other purposes is given
10805 by this parameter.  The default value of the parameter is 2, which is
10806 the minimal number of registers needed by typical instructions.
10807 This value is the best found from numerous experiments.
10809 @item lra-inheritance-ebb-probability-cutoff
10810 LRA tries to reuse values reloaded in registers in subsequent insns.
10811 This optimization is called inheritance.  EBB is used as a region to
10812 do this optimization.  The parameter defines a minimal fall-through
10813 edge probability in percentage used to add BB to inheritance EBB in
10814 LRA.  The default value of the parameter is 40.  The value was chosen
10815 from numerous runs of SPEC2000 on x86-64.
10817 @item loop-invariant-max-bbs-in-loop
10818 Loop invariant motion can be very expensive, both in compilation time and
10819 in amount of needed compile-time memory, with very large loops.  Loops
10820 with more basic blocks than this parameter won't have loop invariant
10821 motion optimization performed on them.  The default value of the
10822 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10824 @item loop-max-datarefs-for-datadeps
10825 Building data dependencies is expensive for very large loops.  This
10826 parameter limits the number of data references in loops that are
10827 considered for data dependence analysis.  These large loops are no
10828 handled by the optimizations using loop data dependencies.
10829 The default value is 1000.
10831 @item max-vartrack-size
10832 Sets a maximum number of hash table slots to use during variable
10833 tracking dataflow analysis of any function.  If this limit is exceeded
10834 with variable tracking at assignments enabled, analysis for that
10835 function is retried without it, after removing all debug insns from
10836 the function.  If the limit is exceeded even without debug insns, var
10837 tracking analysis is completely disabled for the function.  Setting
10838 the parameter to zero makes it unlimited.
10840 @item max-vartrack-expr-depth
10841 Sets a maximum number of recursion levels when attempting to map
10842 variable names or debug temporaries to value expressions.  This trades
10843 compilation time for more complete debug information.  If this is set too
10844 low, value expressions that are available and could be represented in
10845 debug information may end up not being used; setting this higher may
10846 enable the compiler to find more complex debug expressions, but compile
10847 time and memory use may grow.  The default is 12.
10849 @item max-debug-marker-count
10850 Sets a threshold on the number of debug markers (e.g. begin stmt
10851 markers) to avoid complexity explosion at inlining or expanding to RTL.
10852 If a function has more such gimple stmts than the set limit, such stmts
10853 will be dropped from the inlined copy of a function, and from its RTL
10854 expansion.  The default is 100000.
10856 @item min-nondebug-insn-uid
10857 Use uids starting at this parameter for nondebug insns.  The range below
10858 the parameter is reserved exclusively for debug insns created by
10859 @option{-fvar-tracking-assignments}, but debug insns may get
10860 (non-overlapping) uids above it if the reserved range is exhausted.
10862 @item ipa-sra-ptr-growth-factor
10863 IPA-SRA replaces a pointer to an aggregate with one or more new
10864 parameters only when their cumulative size is less or equal to
10865 @option{ipa-sra-ptr-growth-factor} times the size of the original
10866 pointer parameter.
10868 @item sra-max-scalarization-size-Ospeed
10869 @itemx sra-max-scalarization-size-Osize
10870 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10871 replace scalar parts of aggregates with uses of independent scalar
10872 variables.  These parameters control the maximum size, in storage units,
10873 of aggregate which is considered for replacement when compiling for
10874 speed
10875 (@option{sra-max-scalarization-size-Ospeed}) or size
10876 (@option{sra-max-scalarization-size-Osize}) respectively.
10878 @item tm-max-aggregate-size
10879 When making copies of thread-local variables in a transaction, this
10880 parameter specifies the size in bytes after which variables are
10881 saved with the logging functions as opposed to save/restore code
10882 sequence pairs.  This option only applies when using
10883 @option{-fgnu-tm}.
10885 @item graphite-max-nb-scop-params
10886 To avoid exponential effects in the Graphite loop transforms, the
10887 number of parameters in a Static Control Part (SCoP) is bounded.  The
10888 default value is 10 parameters, a value of zero can be used to lift
10889 the bound.  A variable whose value is unknown at compilation time and
10890 defined outside a SCoP is a parameter of the SCoP.
10892 @item loop-block-tile-size
10893 Loop blocking or strip mining transforms, enabled with
10894 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10895 loop in the loop nest by a given number of iterations.  The strip
10896 length can be changed using the @option{loop-block-tile-size}
10897 parameter.  The default value is 51 iterations.
10899 @item loop-unroll-jam-size
10900 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10901 default value is 4.
10903 @item loop-unroll-jam-depth
10904 Specify the dimension to be unrolled (counting from the most inner loop)
10905 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10907 @item ipa-cp-value-list-size
10908 IPA-CP attempts to track all possible values and types passed to a function's
10909 parameter in order to propagate them and perform devirtualization.
10910 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10911 stores per one formal parameter of a function.
10913 @item ipa-cp-eval-threshold
10914 IPA-CP calculates its own score of cloning profitability heuristics
10915 and performs those cloning opportunities with scores that exceed
10916 @option{ipa-cp-eval-threshold}.
10918 @item ipa-cp-recursion-penalty
10919 Percentage penalty the recursive functions will receive when they
10920 are evaluated for cloning.
10922 @item ipa-cp-single-call-penalty
10923 Percentage penalty functions containing a single call to another
10924 function will receive when they are evaluated for cloning.
10927 @item ipa-max-agg-items
10928 IPA-CP is also capable to propagate a number of scalar values passed
10929 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10930 number of such values per one parameter.
10932 @item ipa-cp-loop-hint-bonus
10933 When IPA-CP determines that a cloning candidate would make the number
10934 of iterations of a loop known, it adds a bonus of
10935 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10936 the candidate.
10938 @item ipa-cp-array-index-hint-bonus
10939 When IPA-CP determines that a cloning candidate would make the index of
10940 an array access known, it adds a bonus of
10941 @option{ipa-cp-array-index-hint-bonus} to the profitability
10942 score of the candidate.
10944 @item ipa-max-aa-steps
10945 During its analysis of function bodies, IPA-CP employs alias analysis
10946 in order to track values pointed to by function parameters.  In order
10947 not spend too much time analyzing huge functions, it gives up and
10948 consider all memory clobbered after examining
10949 @option{ipa-max-aa-steps} statements modifying memory.
10951 @item lto-partitions
10952 Specify desired number of partitions produced during WHOPR compilation.
10953 The number of partitions should exceed the number of CPUs used for compilation.
10954 The default value is 32.
10956 @item lto-min-partition
10957 Size of minimal partition for WHOPR (in estimated instructions).
10958 This prevents expenses of splitting very small programs into too many
10959 partitions.
10961 @item lto-max-partition
10962 Size of max partition for WHOPR (in estimated instructions).
10963 to provide an upper bound for individual size of partition.
10964 Meant to be used only with balanced partitioning.
10966 @item cxx-max-namespaces-for-diagnostic-help
10967 The maximum number of namespaces to consult for suggestions when C++
10968 name lookup fails for an identifier.  The default is 1000.
10970 @item sink-frequency-threshold
10971 The maximum relative execution frequency (in percents) of the target block
10972 relative to a statement's original block to allow statement sinking of a
10973 statement.  Larger numbers result in more aggressive statement sinking.
10974 The default value is 75.  A small positive adjustment is applied for
10975 statements with memory operands as those are even more profitable so sink.
10977 @item max-stores-to-sink
10978 The maximum number of conditional store pairs that can be sunk.  Set to 0
10979 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10980 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10982 @item allow-store-data-races
10983 Allow optimizers to introduce new data races on stores.
10984 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10985 at optimization level @option{-Ofast}.
10987 @item case-values-threshold
10988 The smallest number of different values for which it is best to use a
10989 jump-table instead of a tree of conditional branches.  If the value is
10990 0, use the default for the machine.  The default is 0.
10992 @item tree-reassoc-width
10993 Set the maximum number of instructions executed in parallel in
10994 reassociated tree. This parameter overrides target dependent
10995 heuristics used by default if has non zero value.
10997 @item sched-pressure-algorithm
10998 Choose between the two available implementations of
10999 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11000 and is the more likely to prevent instructions from being reordered.
11001 Algorithm 2 was designed to be a compromise between the relatively
11002 conservative approach taken by algorithm 1 and the rather aggressive
11003 approach taken by the default scheduler.  It relies more heavily on
11004 having a regular register file and accurate register pressure classes.
11005 See @file{haifa-sched.c} in the GCC sources for more details.
11007 The default choice depends on the target.
11009 @item max-slsr-cand-scan
11010 Set the maximum number of existing candidates that are considered when
11011 seeking a basis for a new straight-line strength reduction candidate.
11013 @item asan-globals
11014 Enable buffer overflow detection for global objects.  This kind
11015 of protection is enabled by default if you are using
11016 @option{-fsanitize=address} option.
11017 To disable global objects protection use @option{--param asan-globals=0}.
11019 @item asan-stack
11020 Enable buffer overflow detection for stack objects.  This kind of
11021 protection is enabled by default when using @option{-fsanitize=address}.
11022 To disable stack protection use @option{--param asan-stack=0} option.
11024 @item asan-instrument-reads
11025 Enable buffer overflow detection for memory reads.  This kind of
11026 protection is enabled by default when using @option{-fsanitize=address}.
11027 To disable memory reads protection use
11028 @option{--param asan-instrument-reads=0}.
11030 @item asan-instrument-writes
11031 Enable buffer overflow detection for memory writes.  This kind of
11032 protection is enabled by default when using @option{-fsanitize=address}.
11033 To disable memory writes protection use
11034 @option{--param asan-instrument-writes=0} option.
11036 @item asan-memintrin
11037 Enable detection for built-in functions.  This kind of protection
11038 is enabled by default when using @option{-fsanitize=address}.
11039 To disable built-in functions protection use
11040 @option{--param asan-memintrin=0}.
11042 @item asan-use-after-return
11043 Enable detection of use-after-return.  This kind of protection
11044 is enabled by default when using the @option{-fsanitize=address} option.
11045 To disable it use @option{--param asan-use-after-return=0}.
11047 Note: By default the check is disabled at run time.  To enable it,
11048 add @code{detect_stack_use_after_return=1} to the environment variable
11049 @env{ASAN_OPTIONS}.
11051 @item asan-instrumentation-with-call-threshold
11052 If number of memory accesses in function being instrumented
11053 is greater or equal to this number, use callbacks instead of inline checks.
11054 E.g. to disable inline code use
11055 @option{--param asan-instrumentation-with-call-threshold=0}.
11057 @item use-after-scope-direct-emission-threshold
11058 If the size of a local variable in bytes is smaller or equal to this
11059 number, directly poison (or unpoison) shadow memory instead of using
11060 run-time callbacks.  The default value is 256.
11062 @item chkp-max-ctor-size
11063 Static constructors generated by Pointer Bounds Checker may become very
11064 large and significantly increase compile time at optimization level
11065 @option{-O1} and higher.  This parameter is a maximum number of statements
11066 in a single generated constructor.  Default value is 5000.
11068 @item max-fsm-thread-path-insns
11069 Maximum number of instructions to copy when duplicating blocks on a
11070 finite state automaton jump thread path.  The default is 100.
11072 @item max-fsm-thread-length
11073 Maximum number of basic blocks on a finite state automaton jump thread
11074 path.  The default is 10.
11076 @item max-fsm-thread-paths
11077 Maximum number of new jump thread paths to create for a finite state
11078 automaton.  The default is 50.
11080 @item parloops-chunk-size
11081 Chunk size of omp schedule for loops parallelized by parloops.  The default
11082 is 0.
11084 @item parloops-schedule
11085 Schedule type of omp schedule for loops parallelized by parloops (static,
11086 dynamic, guided, auto, runtime).  The default is static.
11088 @item parloops-min-per-thread
11089 The minimum number of iterations per thread of an innermost parallelized
11090 loop for which the parallelized variant is prefered over the single threaded
11091 one.  The default is 100.  Note that for a parallelized loop nest the
11092 minimum number of iterations of the outermost loop per thread is two.
11094 @item max-ssa-name-query-depth
11095 Maximum depth of recursion when querying properties of SSA names in things
11096 like fold routines.  One level of recursion corresponds to following a
11097 use-def chain.
11099 @item hsa-gen-debug-stores
11100 Enable emission of special debug stores within HSA kernels which are
11101 then read and reported by libgomp plugin.  Generation of these stores
11102 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11103 enable it.
11105 @item max-speculative-devirt-maydefs
11106 The maximum number of may-defs we analyze when looking for a must-def
11107 specifying the dynamic type of an object that invokes a virtual call
11108 we may be able to devirtualize speculatively.
11110 @item max-vrp-switch-assertions
11111 The maximum number of assertions to add along the default edge of a switch
11112 statement during VRP.  The default is 10.
11114 @item unroll-jam-min-percent
11115 The minimum percentage of memory references that must be optimized
11116 away for the unroll-and-jam transformation to be considered profitable.
11118 @item unroll-jam-max-unroll
11119 The maximum number of times the outer loop should be unrolled by
11120 the unroll-and-jam transformation.
11121 @end table
11122 @end table
11124 @node Instrumentation Options
11125 @section Program Instrumentation Options
11126 @cindex instrumentation options
11127 @cindex program instrumentation options
11128 @cindex run-time error checking options
11129 @cindex profiling options
11130 @cindex options, program instrumentation
11131 @cindex options, run-time error checking
11132 @cindex options, profiling
11134 GCC supports a number of command-line options that control adding
11135 run-time instrumentation to the code it normally generates.  
11136 For example, one purpose of instrumentation is collect profiling
11137 statistics for use in finding program hot spots, code coverage
11138 analysis, or profile-guided optimizations.
11139 Another class of program instrumentation is adding run-time checking 
11140 to detect programming errors like invalid pointer
11141 dereferences or out-of-bounds array accesses, as well as deliberately
11142 hostile attacks such as stack smashing or C++ vtable hijacking.
11143 There is also a general hook which can be used to implement other
11144 forms of tracing or function-level instrumentation for debug or
11145 program analysis purposes.
11147 @table @gcctabopt
11148 @cindex @command{prof}
11149 @item -p
11150 @opindex p
11151 Generate extra code to write profile information suitable for the
11152 analysis program @command{prof}.  You must use this option when compiling
11153 the source files you want data about, and you must also use it when
11154 linking.
11156 @cindex @command{gprof}
11157 @item -pg
11158 @opindex pg
11159 Generate extra code to write profile information suitable for the
11160 analysis program @command{gprof}.  You must use this option when compiling
11161 the source files you want data about, and you must also use it when
11162 linking.
11164 @item -fprofile-arcs
11165 @opindex fprofile-arcs
11166 Add code so that program flow @dfn{arcs} are instrumented.  During
11167 execution the program records how many times each branch and call is
11168 executed and how many times it is taken or returns.  On targets that support
11169 constructors with priority support, profiling properly handles constructors,
11170 destructors and C++ constructors (and destructors) of classes which are used
11171 as a type of a global variable.
11173 When the compiled
11174 program exits it saves this data to a file called
11175 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11176 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11177 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11178 @var{auxname} is generated from the name of the output file, if
11179 explicitly specified and it is not the final executable, otherwise it is
11180 the basename of the source file.  In both cases any suffix is removed
11181 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11182 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11183 @xref{Cross-profiling}.
11185 @cindex @command{gcov}
11186 @item --coverage
11187 @opindex coverage
11189 This option is used to compile and link code instrumented for coverage
11190 analysis.  The option is a synonym for @option{-fprofile-arcs}
11191 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11192 linking).  See the documentation for those options for more details.
11194 @itemize
11196 @item
11197 Compile the source files with @option{-fprofile-arcs} plus optimization
11198 and code generation options.  For test coverage analysis, use the
11199 additional @option{-ftest-coverage} option.  You do not need to profile
11200 every source file in a program.
11202 @item
11203 Compile the source files additionally with @option{-fprofile-abs-path}
11204 to create absolute path names in the @file{.gcno} files.  This allows
11205 @command{gcov} to find the correct sources in projects where compilations
11206 occur with different working directories.
11208 @item
11209 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11210 (the latter implies the former).
11212 @item
11213 Run the program on a representative workload to generate the arc profile
11214 information.  This may be repeated any number of times.  You can run
11215 concurrent instances of your program, and provided that the file system
11216 supports locking, the data files will be correctly updated.  Unless
11217 a strict ISO C dialect option is in effect, @code{fork} calls are
11218 detected and correctly handled without double counting.
11220 @item
11221 For profile-directed optimizations, compile the source files again with
11222 the same optimization and code generation options plus
11223 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11224 Control Optimization}).
11226 @item
11227 For test coverage analysis, use @command{gcov} to produce human readable
11228 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11229 @command{gcov} documentation for further information.
11231 @end itemize
11233 With @option{-fprofile-arcs}, for each function of your program GCC
11234 creates a program flow graph, then finds a spanning tree for the graph.
11235 Only arcs that are not on the spanning tree have to be instrumented: the
11236 compiler adds code to count the number of times that these arcs are
11237 executed.  When an arc is the only exit or only entrance to a block, the
11238 instrumentation code can be added to the block; otherwise, a new basic
11239 block must be created to hold the instrumentation code.
11241 @need 2000
11242 @item -ftest-coverage
11243 @opindex ftest-coverage
11244 Produce a notes file that the @command{gcov} code-coverage utility
11245 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11246 show program coverage.  Each source file's note file is called
11247 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11248 above for a description of @var{auxname} and instructions on how to
11249 generate test coverage data.  Coverage data matches the source files
11250 more closely if you do not optimize.
11252 @item -fprofile-abs-path
11253 @opindex fprofile-abs-path
11254 Automatically convert relative source file names to absolute path names
11255 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11256 sources in projects where compilations occur with different working
11257 directories.
11259 @item -fprofile-dir=@var{path}
11260 @opindex fprofile-dir
11262 Set the directory to search for the profile data files in to @var{path}.
11263 This option affects only the profile data generated by
11264 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11265 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11266 and its related options.  Both absolute and relative paths can be used.
11267 By default, GCC uses the current directory as @var{path}, thus the
11268 profile data file appears in the same directory as the object file.
11270 @item -fprofile-generate
11271 @itemx -fprofile-generate=@var{path}
11272 @opindex fprofile-generate
11274 Enable options usually used for instrumenting application to produce
11275 profile useful for later recompilation with profile feedback based
11276 optimization.  You must use @option{-fprofile-generate} both when
11277 compiling and when linking your program.
11279 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11281 If @var{path} is specified, GCC looks at the @var{path} to find
11282 the profile feedback data files. See @option{-fprofile-dir}.
11284 To optimize the program based on the collected profile information, use
11285 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11287 @item -fprofile-update=@var{method}
11288 @opindex fprofile-update
11290 Alter the update method for an application instrumented for profile
11291 feedback based optimization.  The @var{method} argument should be one of
11292 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11293 The first one is useful for single-threaded applications,
11294 while the second one prevents profile corruption by emitting thread-safe code.
11296 @strong{Warning:} When an application does not properly join all threads
11297 (or creates an detached thread), a profile file can be still corrupted.
11299 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11300 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11301 automatically selects @samp{prefer-atomic} when @option{-pthread}
11302 is present in the command line.
11304 @item -fsanitize=address
11305 @opindex fsanitize=address
11306 Enable AddressSanitizer, a fast memory error detector.
11307 Memory access instructions are instrumented to detect
11308 out-of-bounds and use-after-free bugs.
11309 The option enables @option{-fsanitize-address-use-after-scope}.
11310 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11311 more details.  The run-time behavior can be influenced using the
11312 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11313 the available options are shown at startup of the instrumented program.  See
11314 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11315 for a list of supported options.
11316 The option cannot be combined with @option{-fsanitize=thread}
11317 and/or @option{-fcheck-pointer-bounds}.
11319 @item -fsanitize=kernel-address
11320 @opindex fsanitize=kernel-address
11321 Enable AddressSanitizer for Linux kernel.
11322 See @uref{https://github.com/google/kasan/wiki} for more details.
11323 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11325 @item -fsanitize=pointer-compare
11326 @opindex fsanitize=pointer-compare
11327 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11328 The option must be combined with either @option{-fsanitize=kernel-address} or
11329 @option{-fsanitize=address}
11330 The option cannot be combined with @option{-fsanitize=thread}
11331 and/or @option{-fcheck-pointer-bounds}.
11332 Note: By default the check is disabled at run time.  To enable it,
11333 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11334 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11335 invalid operation only when both pointers are non-null.
11337 @item -fsanitize=pointer-subtract
11338 @opindex fsanitize=pointer-subtract
11339 Instrument subtraction with pointer operands.
11340 The option must be combined with either @option{-fsanitize=kernel-address} or
11341 @option{-fsanitize=address}
11342 The option cannot be combined with @option{-fsanitize=thread}
11343 and/or @option{-fcheck-pointer-bounds}.
11344 Note: By default the check is disabled at run time.  To enable it,
11345 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11346 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11347 invalid operation only when both pointers are non-null.
11349 @item -fsanitize=thread
11350 @opindex fsanitize=thread
11351 Enable ThreadSanitizer, a fast data race detector.
11352 Memory access instructions are instrumented to detect
11353 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11354 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11355 environment variable; see
11356 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11357 supported options.
11358 The option cannot be combined with @option{-fsanitize=address},
11359 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11361 Note that sanitized atomic builtins cannot throw exceptions when
11362 operating on invalid memory addresses with non-call exceptions
11363 (@option{-fnon-call-exceptions}).
11365 @item -fsanitize=leak
11366 @opindex fsanitize=leak
11367 Enable LeakSanitizer, a memory leak detector.
11368 This option only matters for linking of executables and
11369 the executable is linked against a library that overrides @code{malloc}
11370 and other allocator functions.  See
11371 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11372 details.  The run-time behavior can be influenced using the
11373 @env{LSAN_OPTIONS} environment variable.
11374 The option cannot be combined with @option{-fsanitize=thread}.
11376 @item -fsanitize=undefined
11377 @opindex fsanitize=undefined
11378 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11379 Various computations are instrumented to detect undefined behavior
11380 at runtime.  Current suboptions are:
11382 @table @gcctabopt
11384 @item -fsanitize=shift
11385 @opindex fsanitize=shift
11386 This option enables checking that the result of a shift operation is
11387 not undefined.  Note that what exactly is considered undefined differs
11388 slightly between C and C++, as well as between ISO C90 and C99, etc.
11389 This option has two suboptions, @option{-fsanitize=shift-base} and
11390 @option{-fsanitize=shift-exponent}.
11392 @item -fsanitize=shift-exponent
11393 @opindex fsanitize=shift-exponent
11394 This option enables checking that the second argument of a shift operation
11395 is not negative and is smaller than the precision of the promoted first
11396 argument.
11398 @item -fsanitize=shift-base
11399 @opindex fsanitize=shift-base
11400 If the second argument of a shift operation is within range, check that the
11401 result of a shift operation is not undefined.  Note that what exactly is
11402 considered undefined differs slightly between C and C++, as well as between
11403 ISO C90 and C99, etc.
11405 @item -fsanitize=integer-divide-by-zero
11406 @opindex fsanitize=integer-divide-by-zero
11407 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11409 @item -fsanitize=unreachable
11410 @opindex fsanitize=unreachable
11411 With this option, the compiler turns the @code{__builtin_unreachable}
11412 call into a diagnostics message call instead.  When reaching the
11413 @code{__builtin_unreachable} call, the behavior is undefined.
11415 @item -fsanitize=vla-bound
11416 @opindex fsanitize=vla-bound
11417 This option instructs the compiler to check that the size of a variable
11418 length array is positive.
11420 @item -fsanitize=null
11421 @opindex fsanitize=null
11422 This option enables pointer checking.  Particularly, the application
11423 built with this option turned on will issue an error message when it
11424 tries to dereference a NULL pointer, or if a reference (possibly an
11425 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11426 on an object pointed by a NULL pointer.
11428 @item -fsanitize=return
11429 @opindex fsanitize=return
11430 This option enables return statement checking.  Programs
11431 built with this option turned on will issue an error message
11432 when the end of a non-void function is reached without actually
11433 returning a value.  This option works in C++ only.
11435 @item -fsanitize=signed-integer-overflow
11436 @opindex fsanitize=signed-integer-overflow
11437 This option enables signed integer overflow checking.  We check that
11438 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11439 does not overflow in the signed arithmetics.  Note, integer promotion
11440 rules must be taken into account.  That is, the following is not an
11441 overflow:
11442 @smallexample
11443 signed char a = SCHAR_MAX;
11444 a++;
11445 @end smallexample
11447 @item -fsanitize=bounds
11448 @opindex fsanitize=bounds
11449 This option enables instrumentation of array bounds.  Various out of bounds
11450 accesses are detected.  Flexible array members, flexible array member-like
11451 arrays, and initializers of variables with static storage are not instrumented.
11452 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11454 @item -fsanitize=bounds-strict
11455 @opindex fsanitize=bounds-strict
11456 This option enables strict instrumentation of array bounds.  Most out of bounds
11457 accesses are detected, including flexible array members and flexible array
11458 member-like arrays.  Initializers of variables with static storage are not
11459 instrumented.  The option cannot be combined
11460 with @option{-fcheck-pointer-bounds}.
11462 @item -fsanitize=alignment
11463 @opindex fsanitize=alignment
11465 This option enables checking of alignment of pointers when they are
11466 dereferenced, or when a reference is bound to insufficiently aligned target,
11467 or when a method or constructor is invoked on insufficiently aligned object.
11469 @item -fsanitize=object-size
11470 @opindex fsanitize=object-size
11471 This option enables instrumentation of memory references using the
11472 @code{__builtin_object_size} function.  Various out of bounds pointer
11473 accesses are detected.
11475 @item -fsanitize=float-divide-by-zero
11476 @opindex fsanitize=float-divide-by-zero
11477 Detect floating-point division by zero.  Unlike other similar options,
11478 @option{-fsanitize=float-divide-by-zero} is not enabled by
11479 @option{-fsanitize=undefined}, since floating-point division by zero can
11480 be a legitimate way of obtaining infinities and NaNs.
11482 @item -fsanitize=float-cast-overflow
11483 @opindex fsanitize=float-cast-overflow
11484 This option enables floating-point type to integer conversion checking.
11485 We check that the result of the conversion does not overflow.
11486 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11487 not enabled by @option{-fsanitize=undefined}.
11488 This option does not work well with @code{FE_INVALID} exceptions enabled.
11490 @item -fsanitize=nonnull-attribute
11491 @opindex fsanitize=nonnull-attribute
11493 This option enables instrumentation of calls, checking whether null values
11494 are not passed to arguments marked as requiring a non-null value by the
11495 @code{nonnull} function attribute.
11497 @item -fsanitize=returns-nonnull-attribute
11498 @opindex fsanitize=returns-nonnull-attribute
11500 This option enables instrumentation of return statements in functions
11501 marked with @code{returns_nonnull} function attribute, to detect returning
11502 of null values from such functions.
11504 @item -fsanitize=bool
11505 @opindex fsanitize=bool
11507 This option enables instrumentation of loads from bool.  If a value other
11508 than 0/1 is loaded, a run-time error is issued.
11510 @item -fsanitize=enum
11511 @opindex fsanitize=enum
11513 This option enables instrumentation of loads from an enum type.  If
11514 a value outside the range of values for the enum type is loaded,
11515 a run-time error is issued.
11517 @item -fsanitize=vptr
11518 @opindex fsanitize=vptr
11520 This option enables instrumentation of C++ member function calls, member
11521 accesses and some conversions between pointers to base and derived classes,
11522 to verify the referenced object has the correct dynamic type.
11524 @item -fsanitize=pointer-overflow
11525 @opindex fsanitize=pointer-overflow
11527 This option enables instrumentation of pointer arithmetics.  If the pointer
11528 arithmetics overflows, a run-time error is issued.
11530 @item -fsanitize=builtin
11531 @opindex fsanitize=builtin
11533 This option enables instrumentation of arguments to selected builtin
11534 functions.  If an invalid value is passed to such arguments, a run-time
11535 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11536 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11537 by this option.
11539 @end table
11541 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11542 @option{-fsanitize=undefined} gives a diagnostic message.
11543 This currently works only for the C family of languages.
11545 @item -fno-sanitize=all
11546 @opindex fno-sanitize=all
11548 This option disables all previously enabled sanitizers.
11549 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11550 together.
11552 @item -fasan-shadow-offset=@var{number}
11553 @opindex fasan-shadow-offset
11554 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11555 It is useful for experimenting with different shadow memory layouts in
11556 Kernel AddressSanitizer.
11558 @item -fsanitize-sections=@var{s1},@var{s2},...
11559 @opindex fsanitize-sections
11560 Sanitize global variables in selected user-defined sections.  @var{si} may
11561 contain wildcards.
11563 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11564 @opindex fsanitize-recover
11565 @opindex fno-sanitize-recover
11566 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11567 mentioned in comma-separated list of @var{opts}.  Enabling this option
11568 for a sanitizer component causes it to attempt to continue
11569 running the program as if no error happened.  This means multiple
11570 runtime errors can be reported in a single program run, and the exit
11571 code of the program may indicate success even when errors
11572 have been reported.  The @option{-fno-sanitize-recover=} option
11573 can be used to alter
11574 this behavior: only the first detected error is reported
11575 and program then exits with a non-zero exit code.
11577 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11578 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11579 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11580 @option{-fsanitize=bounds-strict},
11581 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11582 For these sanitizers error recovery is turned on by default,
11583 except @option{-fsanitize=address}, for which this feature is experimental.
11584 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11585 accepted, the former enables recovery for all sanitizers that support it,
11586 the latter disables recovery for all sanitizers that support it.
11588 Even if a recovery mode is turned on the compiler side, it needs to be also
11589 enabled on the runtime library side, otherwise the failures are still fatal.
11590 The runtime library defaults to @code{halt_on_error=0} for
11591 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11592 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11593 setting the @code{halt_on_error} flag in the corresponding environment variable.
11595 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11596 equivalent to specifying an @var{opts} list of:
11598 @smallexample
11599 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11600 @end smallexample
11602 @item -fsanitize-address-use-after-scope
11603 @opindex fsanitize-address-use-after-scope
11604 Enable sanitization of local variables to detect use-after-scope bugs.
11605 The option sets @option{-fstack-reuse} to @samp{none}.
11607 @item -fsanitize-undefined-trap-on-error
11608 @opindex fsanitize-undefined-trap-on-error
11609 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11610 report undefined behavior using @code{__builtin_trap} rather than
11611 a @code{libubsan} library routine.  The advantage of this is that the
11612 @code{libubsan} library is not needed and is not linked in, so this
11613 is usable even in freestanding environments.
11615 @item -fsanitize-coverage=trace-pc
11616 @opindex fsanitize-coverage=trace-pc
11617 Enable coverage-guided fuzzing code instrumentation.
11618 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11620 @item -fsanitize-coverage=trace-cmp
11621 @opindex fsanitize-coverage=trace-cmp
11622 Enable dataflow guided fuzzing code instrumentation.
11623 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11624 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11625 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11626 variable or @code{__sanitizer_cov_trace_const_cmp1},
11627 @code{__sanitizer_cov_trace_const_cmp2},
11628 @code{__sanitizer_cov_trace_const_cmp4} or
11629 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11630 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11631 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11632 @code{__sanitizer_cov_trace_switch} for switch statements.
11634 @item -fbounds-check
11635 @opindex fbounds-check
11636 For front ends that support it, generate additional code to check that
11637 indices used to access arrays are within the declared range.  This is
11638 currently only supported by the Fortran front end, where this option
11639 defaults to false.
11641 @item -fcheck-pointer-bounds
11642 @opindex fcheck-pointer-bounds
11643 @opindex fno-check-pointer-bounds
11644 @cindex Pointer Bounds Checker options
11645 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11646 is instrumented with checks of the pointer used for memory access against
11647 bounds associated with that pointer.  
11649 Currently there
11650 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11651 and @option{-mmpx} are required to enable this feature.  
11652 MPX-based instrumentation requires
11653 a runtime library to enable MPX in hardware and handle bounds
11654 violation signals.  By default when @option{-fcheck-pointer-bounds}
11655 and @option{-mmpx} options are used to link a program, the GCC driver
11656 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11657 Bounds checking on calls to dynamic libraries requires a linker
11658 with @option{-z bndplt} support; if GCC was configured with a linker
11659 without support for this option (including the Gold linker and older
11660 versions of ld), a warning is given if you link with @option{-mmpx}
11661 without also specifying @option{-static}, since the overall effectiveness
11662 of the bounds checking protection is reduced.
11663 See also @option{-static-libmpxwrappers}.
11665 MPX-based instrumentation
11666 may be used for debugging and also may be included in production code
11667 to increase program security.  Depending on usage, you may
11668 have different requirements for the runtime library.  The current version
11669 of the MPX runtime library is more oriented for use as a debugging
11670 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11671 also @option{-static-libmpx}.  The runtime library  behavior can be
11672 influenced using various @env{CHKP_RT_*} environment variables.  See
11673 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11674 for more details.
11676 Generated instrumentation may be controlled by various
11677 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11678 structure field attribute (@pxref{Type Attributes}) and
11679 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11680 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11681 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11682 Bounds Checker builtins}, for more information.
11684 @item -fchkp-check-incomplete-type
11685 @opindex fchkp-check-incomplete-type
11686 @opindex fno-chkp-check-incomplete-type
11687 Generate pointer bounds checks for variables with incomplete type.
11688 Enabled by default.
11690 @item -fchkp-narrow-bounds
11691 @opindex fchkp-narrow-bounds
11692 @opindex fno-chkp-narrow-bounds
11693 Controls bounds used by Pointer Bounds Checker for pointers to object
11694 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11695 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11696 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11698 @item -fchkp-first-field-has-own-bounds
11699 @opindex fchkp-first-field-has-own-bounds
11700 @opindex fno-chkp-first-field-has-own-bounds
11701 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11702 first field in the structure.  By default a pointer to the first field has
11703 the same bounds as a pointer to the whole structure.
11705 @item -fchkp-flexible-struct-trailing-arrays
11706 @opindex fchkp-flexible-struct-trailing-arrays
11707 @opindex fno-chkp-flexible-struct-trailing-arrays
11708 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11709 possibly flexible.  By default only array fields with zero length or that are
11710 marked with attribute bnd_variable_size are treated as flexible.
11712 @item -fchkp-narrow-to-innermost-array
11713 @opindex fchkp-narrow-to-innermost-array
11714 @opindex fno-chkp-narrow-to-innermost-array
11715 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11716 case of nested static array access.  By default this option is disabled and
11717 bounds of the outermost array are used.
11719 @item -fchkp-optimize
11720 @opindex fchkp-optimize
11721 @opindex fno-chkp-optimize
11722 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11723 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11725 @item -fchkp-use-fast-string-functions
11726 @opindex fchkp-use-fast-string-functions
11727 @opindex fno-chkp-use-fast-string-functions
11728 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11729 by Pointer Bounds Checker.  Disabled by default.
11731 @item -fchkp-use-nochk-string-functions
11732 @opindex fchkp-use-nochk-string-functions
11733 @opindex fno-chkp-use-nochk-string-functions
11734 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11735 by Pointer Bounds Checker.  Disabled by default.
11737 @item -fchkp-use-static-bounds
11738 @opindex fchkp-use-static-bounds
11739 @opindex fno-chkp-use-static-bounds
11740 Allow Pointer Bounds Checker to generate static bounds holding
11741 bounds of static variables.  Enabled by default.
11743 @item -fchkp-use-static-const-bounds
11744 @opindex fchkp-use-static-const-bounds
11745 @opindex fno-chkp-use-static-const-bounds
11746 Use statically-initialized bounds for constant bounds instead of
11747 generating them each time they are required.  By default enabled when
11748 @option{-fchkp-use-static-bounds} is enabled.
11750 @item -fchkp-treat-zero-dynamic-size-as-infinite
11751 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11752 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11753 With this option, objects with incomplete type whose
11754 dynamically-obtained size is zero are treated as having infinite size
11755 instead by Pointer Bounds
11756 Checker.  This option may be helpful if a program is linked with a library
11757 missing size information for some symbols.  Disabled by default.
11759 @item -fchkp-check-read
11760 @opindex fchkp-check-read
11761 @opindex fno-chkp-check-read
11762 Instructs Pointer Bounds Checker to generate checks for all read
11763 accesses to memory.  Enabled by default.
11765 @item -fchkp-check-write
11766 @opindex fchkp-check-write
11767 @opindex fno-chkp-check-write
11768 Instructs Pointer Bounds Checker to generate checks for all write
11769 accesses to memory.  Enabled by default.
11771 @item -fchkp-store-bounds
11772 @opindex fchkp-store-bounds
11773 @opindex fno-chkp-store-bounds
11774 Instructs Pointer Bounds Checker to generate bounds stores for
11775 pointer writes.  Enabled by default.
11777 @item -fchkp-instrument-calls
11778 @opindex fchkp-instrument-calls
11779 @opindex fno-chkp-instrument-calls
11780 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11781 Enabled by default.
11783 @item -fchkp-instrument-marked-only
11784 @opindex fchkp-instrument-marked-only
11785 @opindex fno-chkp-instrument-marked-only
11786 Instructs Pointer Bounds Checker to instrument only functions
11787 marked with the @code{bnd_instrument} attribute
11788 (@pxref{Function Attributes}).  Disabled by default.
11790 @item -fchkp-use-wrappers
11791 @opindex fchkp-use-wrappers
11792 @opindex fno-chkp-use-wrappers
11793 Allows Pointer Bounds Checker to replace calls to built-in functions
11794 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11795 is used to link a program, the GCC driver automatically links
11796 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11797 Enabled by default.
11799 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11800 @opindex fcf-protection
11801 Enable code instrumentation of control-flow transfers to increase
11802 program security by checking that target addresses of control-flow
11803 transfer instructions (such as indirect function call, function return,
11804 indirect jump) are valid.  This prevents diverting the flow of control
11805 to an unexpected target.  This is intended to protect against such
11806 threats as Return-oriented Programming (ROP), and similarly
11807 call/jmp-oriented programming (COP/JOP).
11809 The value @code{branch} tells the compiler to implement checking of
11810 validity of control-flow transfer at the point of indirect branch
11811 instructions, i.e. call/jmp instructions.  The value @code{return}
11812 implements checking of validity at the point of returning from a
11813 function.  The value @code{full} is an alias for specifying both
11814 @code{branch} and @code{return}. The value @code{none} turns off
11815 instrumentation.
11817 You can also use the @code{nocf_check} attribute to identify
11818 which functions and calls should be skipped from instrumentation
11819 (@pxref{Function Attributes}).
11821 Currently the x86 GNU/Linux target provides an implementation based
11822 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11823 for x86 is controlled by target-specific options @option{-mcet},
11824 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11826 @item -fstack-protector
11827 @opindex fstack-protector
11828 Emit extra code to check for buffer overflows, such as stack smashing
11829 attacks.  This is done by adding a guard variable to functions with
11830 vulnerable objects.  This includes functions that call @code{alloca}, and
11831 functions with buffers larger than 8 bytes.  The guards are initialized
11832 when a function is entered and then checked when the function exits.
11833 If a guard check fails, an error message is printed and the program exits.
11835 @item -fstack-protector-all
11836 @opindex fstack-protector-all
11837 Like @option{-fstack-protector} except that all functions are protected.
11839 @item -fstack-protector-strong
11840 @opindex fstack-protector-strong
11841 Like @option{-fstack-protector} but includes additional functions to
11842 be protected --- those that have local array definitions, or have
11843 references to local frame addresses.
11845 @item -fstack-protector-explicit
11846 @opindex fstack-protector-explicit
11847 Like @option{-fstack-protector} but only protects those functions which
11848 have the @code{stack_protect} attribute.
11850 @item -fstack-check
11851 @opindex fstack-check
11852 Generate code to verify that you do not go beyond the boundary of the
11853 stack.  You should specify this flag if you are running in an
11854 environment with multiple threads, but you only rarely need to specify it in
11855 a single-threaded environment since stack overflow is automatically
11856 detected on nearly all systems if there is only one stack.
11858 Note that this switch does not actually cause checking to be done; the
11859 operating system or the language runtime must do that.  The switch causes
11860 generation of code to ensure that they see the stack being extended.
11862 You can additionally specify a string parameter: @samp{no} means no
11863 checking, @samp{generic} means force the use of old-style checking,
11864 @samp{specific} means use the best checking method and is equivalent
11865 to bare @option{-fstack-check}.
11867 Old-style checking is a generic mechanism that requires no specific
11868 target support in the compiler but comes with the following drawbacks:
11870 @enumerate
11871 @item
11872 Modified allocation strategy for large objects: they are always
11873 allocated dynamically if their size exceeds a fixed threshold.  Note this
11874 may change the semantics of some code.
11876 @item
11877 Fixed limit on the size of the static frame of functions: when it is
11878 topped by a particular function, stack checking is not reliable and
11879 a warning is issued by the compiler.
11881 @item
11882 Inefficiency: because of both the modified allocation strategy and the
11883 generic implementation, code performance is hampered.
11884 @end enumerate
11886 Note that old-style stack checking is also the fallback method for
11887 @samp{specific} if no target support has been added in the compiler.
11889 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11890 and stack overflows.  @samp{specific} is an excellent choice when compiling
11891 Ada code.  It is not generally sufficient to protect against stack-clash
11892 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11894 @item -fstack-clash-protection
11895 @opindex fstack-clash-protection
11896 Generate code to prevent stack clash style attacks.  When this option is
11897 enabled, the compiler will only allocate one page of stack space at a time
11898 and each page is accessed immediately after allocation.  Thus, it prevents
11899 allocations from jumping over any stack guard page provided by the
11900 operating system.
11902 Most targets do not fully support stack clash protection.  However, on
11903 those targets @option{-fstack-clash-protection} will protect dynamic stack
11904 allocations.  @option{-fstack-clash-protection} may also provide limited
11905 protection for static stack allocations if the target supports
11906 @option{-fstack-check=specific}.
11908 @item -fstack-limit-register=@var{reg}
11909 @itemx -fstack-limit-symbol=@var{sym}
11910 @itemx -fno-stack-limit
11911 @opindex fstack-limit-register
11912 @opindex fstack-limit-symbol
11913 @opindex fno-stack-limit
11914 Generate code to ensure that the stack does not grow beyond a certain value,
11915 either the value of a register or the address of a symbol.  If a larger
11916 stack is required, a signal is raised at run time.  For most targets,
11917 the signal is raised before the stack overruns the boundary, so
11918 it is possible to catch the signal without taking special precautions.
11920 For instance, if the stack starts at absolute address @samp{0x80000000}
11921 and grows downwards, you can use the flags
11922 @option{-fstack-limit-symbol=__stack_limit} and
11923 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11924 of 128KB@.  Note that this may only work with the GNU linker.
11926 You can locally override stack limit checking by using the
11927 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11929 @item -fsplit-stack
11930 @opindex fsplit-stack
11931 Generate code to automatically split the stack before it overflows.
11932 The resulting program has a discontiguous stack which can only
11933 overflow if the program is unable to allocate any more memory.  This
11934 is most useful when running threaded programs, as it is no longer
11935 necessary to calculate a good stack size to use for each thread.  This
11936 is currently only implemented for the x86 targets running
11937 GNU/Linux.
11939 When code compiled with @option{-fsplit-stack} calls code compiled
11940 without @option{-fsplit-stack}, there may not be much stack space
11941 available for the latter code to run.  If compiling all code,
11942 including library code, with @option{-fsplit-stack} is not an option,
11943 then the linker can fix up these calls so that the code compiled
11944 without @option{-fsplit-stack} always has a large stack.  Support for
11945 this is implemented in the gold linker in GNU binutils release 2.21
11946 and later.
11948 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11949 @opindex fvtable-verify
11950 This option is only available when compiling C++ code.
11951 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11952 feature that verifies at run time, for every virtual call, that
11953 the vtable pointer through which the call is made is valid for the type of
11954 the object, and has not been corrupted or overwritten.  If an invalid vtable
11955 pointer is detected at run time, an error is reported and execution of the
11956 program is immediately halted.
11958 This option causes run-time data structures to be built at program startup,
11959 which are used for verifying the vtable pointers.  
11960 The options @samp{std} and @samp{preinit}
11961 control the timing of when these data structures are built.  In both cases the
11962 data structures are built before execution reaches @code{main}.  Using
11963 @option{-fvtable-verify=std} causes the data structures to be built after
11964 shared libraries have been loaded and initialized.
11965 @option{-fvtable-verify=preinit} causes them to be built before shared
11966 libraries have been loaded and initialized.
11968 If this option appears multiple times in the command line with different
11969 values specified, @samp{none} takes highest priority over both @samp{std} and
11970 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11972 @item -fvtv-debug
11973 @opindex fvtv-debug
11974 When used in conjunction with @option{-fvtable-verify=std} or 
11975 @option{-fvtable-verify=preinit}, causes debug versions of the 
11976 runtime functions for the vtable verification feature to be called.  
11977 This flag also causes the compiler to log information about which 
11978 vtable pointers it finds for each class.
11979 This information is written to a file named @file{vtv_set_ptr_data.log} 
11980 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11981 if that is defined or the current working directory otherwise.
11983 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11984 file, be sure to delete any existing one.
11986 @item -fvtv-counts
11987 @opindex fvtv-counts
11988 This is a debugging flag.  When used in conjunction with
11989 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11990 causes the compiler to keep track of the total number of virtual calls
11991 it encounters and the number of verifications it inserts.  It also
11992 counts the number of calls to certain run-time library functions
11993 that it inserts and logs this information for each compilation unit.
11994 The compiler writes this information to a file named
11995 @file{vtv_count_data.log} in the directory named by the environment
11996 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11997 directory otherwise.  It also counts the size of the vtable pointer sets
11998 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11999 in the same directory.
12001 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12002 files, be sure to delete any existing ones.
12004 @item -finstrument-functions
12005 @opindex finstrument-functions
12006 Generate instrumentation calls for entry and exit to functions.  Just
12007 after function entry and just before function exit, the following
12008 profiling functions are called with the address of the current
12009 function and its call site.  (On some platforms,
12010 @code{__builtin_return_address} does not work beyond the current
12011 function, so the call site information may not be available to the
12012 profiling functions otherwise.)
12014 @smallexample
12015 void __cyg_profile_func_enter (void *this_fn,
12016                                void *call_site);
12017 void __cyg_profile_func_exit  (void *this_fn,
12018                                void *call_site);
12019 @end smallexample
12021 The first argument is the address of the start of the current function,
12022 which may be looked up exactly in the symbol table.
12024 This instrumentation is also done for functions expanded inline in other
12025 functions.  The profiling calls indicate where, conceptually, the
12026 inline function is entered and exited.  This means that addressable
12027 versions of such functions must be available.  If all your uses of a
12028 function are expanded inline, this may mean an additional expansion of
12029 code size.  If you use @code{extern inline} in your C code, an
12030 addressable version of such functions must be provided.  (This is
12031 normally the case anyway, but if you get lucky and the optimizer always
12032 expands the functions inline, you might have gotten away without
12033 providing static copies.)
12035 A function may be given the attribute @code{no_instrument_function}, in
12036 which case this instrumentation is not done.  This can be used, for
12037 example, for the profiling functions listed above, high-priority
12038 interrupt routines, and any functions from which the profiling functions
12039 cannot safely be called (perhaps signal handlers, if the profiling
12040 routines generate output or allocate memory).
12042 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12043 @opindex finstrument-functions-exclude-file-list
12045 Set the list of functions that are excluded from instrumentation (see
12046 the description of @option{-finstrument-functions}).  If the file that
12047 contains a function definition matches with one of @var{file}, then
12048 that function is not instrumented.  The match is done on substrings:
12049 if the @var{file} parameter is a substring of the file name, it is
12050 considered to be a match.
12052 For example:
12054 @smallexample
12055 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12056 @end smallexample
12058 @noindent
12059 excludes any inline function defined in files whose pathnames
12060 contain @file{/bits/stl} or @file{include/sys}.
12062 If, for some reason, you want to include letter @samp{,} in one of
12063 @var{sym}, write @samp{\,}. For example,
12064 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12065 (note the single quote surrounding the option).
12067 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12068 @opindex finstrument-functions-exclude-function-list
12070 This is similar to @option{-finstrument-functions-exclude-file-list},
12071 but this option sets the list of function names to be excluded from
12072 instrumentation.  The function name to be matched is its user-visible
12073 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12074 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12075 match is done on substrings: if the @var{sym} parameter is a substring
12076 of the function name, it is considered to be a match.  For C99 and C++
12077 extended identifiers, the function name must be given in UTF-8, not
12078 using universal character names.
12080 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12081 @opindex fpatchable-function-entry
12082 Generate @var{N} NOPs right at the beginning
12083 of each function, with the function entry point before the @var{M}th NOP.
12084 If @var{M} is omitted, it defaults to @code{0} so the
12085 function entry points to the address just at the first NOP.
12086 The NOP instructions reserve extra space which can be used to patch in
12087 any desired instrumentation at run time, provided that the code segment
12088 is writable.  The amount of space is controllable indirectly via
12089 the number of NOPs; the NOP instruction used corresponds to the instruction
12090 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12091 is target-specific and may also depend on the architecture variant and/or
12092 other compilation options.
12094 For run-time identification, the starting addresses of these areas,
12095 which correspond to their respective function entries minus @var{M},
12096 are additionally collected in the @code{__patchable_function_entries}
12097 section of the resulting binary.
12099 Note that the value of @code{__attribute__ ((patchable_function_entry
12100 (N,M)))} takes precedence over command-line option
12101 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12102 the area size or to remove it completely on a single function.
12103 If @code{N=0}, no pad location is recorded.
12105 The NOP instructions are inserted at---and maybe before, depending on
12106 @var{M}---the function entry address, even before the prologue.
12108 @end table
12111 @node Preprocessor Options
12112 @section Options Controlling the Preprocessor
12113 @cindex preprocessor options
12114 @cindex options, preprocessor
12116 These options control the C preprocessor, which is run on each C source
12117 file before actual compilation.
12119 If you use the @option{-E} option, nothing is done except preprocessing.
12120 Some of these options make sense only together with @option{-E} because
12121 they cause the preprocessor output to be unsuitable for actual
12122 compilation.
12124 In addition to the options listed here, there are a number of options 
12125 to control search paths for include files documented in 
12126 @ref{Directory Options}.  
12127 Options to control preprocessor diagnostics are listed in 
12128 @ref{Warning Options}.
12130 @table @gcctabopt
12131 @include cppopts.texi
12133 @item -Wp,@var{option}
12134 @opindex Wp
12135 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12136 and pass @var{option} directly through to the preprocessor.  If
12137 @var{option} contains commas, it is split into multiple options at the
12138 commas.  However, many options are modified, translated or interpreted
12139 by the compiler driver before being passed to the preprocessor, and
12140 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12141 interface is undocumented and subject to change, so whenever possible
12142 you should avoid using @option{-Wp} and let the driver handle the
12143 options instead.
12145 @item -Xpreprocessor @var{option}
12146 @opindex Xpreprocessor
12147 Pass @var{option} as an option to the preprocessor.  You can use this to
12148 supply system-specific preprocessor options that GCC does not 
12149 recognize.
12151 If you want to pass an option that takes an argument, you must use
12152 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12154 @item -no-integrated-cpp
12155 @opindex no-integrated-cpp
12156 Perform preprocessing as a separate pass before compilation.
12157 By default, GCC performs preprocessing as an integrated part of
12158 input tokenization and parsing.
12159 If this option is provided, the appropriate language front end
12160 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12161 and Objective-C, respectively) is instead invoked twice,
12162 once for preprocessing only and once for actual compilation
12163 of the preprocessed input.
12164 This option may be useful in conjunction with the @option{-B} or
12165 @option{-wrapper} options to specify an alternate preprocessor or
12166 perform additional processing of the program source between
12167 normal preprocessing and compilation.
12169 @end table
12171 @node Assembler Options
12172 @section Passing Options to the Assembler
12174 @c prevent bad page break with this line
12175 You can pass options to the assembler.
12177 @table @gcctabopt
12178 @item -Wa,@var{option}
12179 @opindex Wa
12180 Pass @var{option} as an option to the assembler.  If @var{option}
12181 contains commas, it is split into multiple options at the commas.
12183 @item -Xassembler @var{option}
12184 @opindex Xassembler
12185 Pass @var{option} as an option to the assembler.  You can use this to
12186 supply system-specific assembler options that GCC does not
12187 recognize.
12189 If you want to pass an option that takes an argument, you must use
12190 @option{-Xassembler} twice, once for the option and once for the argument.
12192 @end table
12194 @node Link Options
12195 @section Options for Linking
12196 @cindex link options
12197 @cindex options, linking
12199 These options come into play when the compiler links object files into
12200 an executable output file.  They are meaningless if the compiler is
12201 not doing a link step.
12203 @table @gcctabopt
12204 @cindex file names
12205 @item @var{object-file-name}
12206 A file name that does not end in a special recognized suffix is
12207 considered to name an object file or library.  (Object files are
12208 distinguished from libraries by the linker according to the file
12209 contents.)  If linking is done, these object files are used as input
12210 to the linker.
12212 @item -c
12213 @itemx -S
12214 @itemx -E
12215 @opindex c
12216 @opindex S
12217 @opindex E
12218 If any of these options is used, then the linker is not run, and
12219 object file names should not be used as arguments.  @xref{Overall
12220 Options}.
12222 @item -fuse-ld=bfd
12223 @opindex fuse-ld=bfd
12224 Use the @command{bfd} linker instead of the default linker.
12226 @item -fuse-ld=gold
12227 @opindex fuse-ld=gold
12228 Use the @command{gold} linker instead of the default linker.
12230 @cindex Libraries
12231 @item -l@var{library}
12232 @itemx -l @var{library}
12233 @opindex l
12234 Search the library named @var{library} when linking.  (The second
12235 alternative with the library as a separate argument is only for
12236 POSIX compliance and is not recommended.)
12238 It makes a difference where in the command you write this option; the
12239 linker searches and processes libraries and object files in the order they
12240 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12241 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12242 to functions in @samp{z}, those functions may not be loaded.
12244 The linker searches a standard list of directories for the library,
12245 which is actually a file named @file{lib@var{library}.a}.  The linker
12246 then uses this file as if it had been specified precisely by name.
12248 The directories searched include several standard system directories
12249 plus any that you specify with @option{-L}.
12251 Normally the files found this way are library files---archive files
12252 whose members are object files.  The linker handles an archive file by
12253 scanning through it for members which define symbols that have so far
12254 been referenced but not defined.  But if the file that is found is an
12255 ordinary object file, it is linked in the usual fashion.  The only
12256 difference between using an @option{-l} option and specifying a file name
12257 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12258 and searches several directories.
12260 @item -lobjc
12261 @opindex lobjc
12262 You need this special case of the @option{-l} option in order to
12263 link an Objective-C or Objective-C++ program.
12265 @item -nostartfiles
12266 @opindex nostartfiles
12267 Do not use the standard system startup files when linking.
12268 The standard system libraries are used normally, unless @option{-nostdlib}
12269 or @option{-nodefaultlibs} is used.
12271 @item -nodefaultlibs
12272 @opindex nodefaultlibs
12273 Do not use the standard system libraries when linking.
12274 Only the libraries you specify are passed to the linker, and options
12275 specifying linkage of the system libraries, such as @option{-static-libgcc}
12276 or @option{-shared-libgcc}, are ignored.  
12277 The standard startup files are used normally, unless @option{-nostartfiles}
12278 is used.  
12280 The compiler may generate calls to @code{memcmp},
12281 @code{memset}, @code{memcpy} and @code{memmove}.
12282 These entries are usually resolved by entries in
12283 libc.  These entry points should be supplied through some other
12284 mechanism when this option is specified.
12286 @item -nostdlib
12287 @opindex nostdlib
12288 Do not use the standard system startup files or libraries when linking.
12289 No startup files and only the libraries you specify are passed to
12290 the linker, and options specifying linkage of the system libraries, such as
12291 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12293 The compiler may generate calls to @code{memcmp}, @code{memset},
12294 @code{memcpy} and @code{memmove}.
12295 These entries are usually resolved by entries in
12296 libc.  These entry points should be supplied through some other
12297 mechanism when this option is specified.
12299 @cindex @option{-lgcc}, use with @option{-nostdlib}
12300 @cindex @option{-nostdlib} and unresolved references
12301 @cindex unresolved references and @option{-nostdlib}
12302 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12303 @cindex @option{-nodefaultlibs} and unresolved references
12304 @cindex unresolved references and @option{-nodefaultlibs}
12305 One of the standard libraries bypassed by @option{-nostdlib} and
12306 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12307 which GCC uses to overcome shortcomings of particular machines, or special
12308 needs for some languages.
12309 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12310 Collection (GCC) Internals},
12311 for more discussion of @file{libgcc.a}.)
12312 In most cases, you need @file{libgcc.a} even when you want to avoid
12313 other standard libraries.  In other words, when you specify @option{-nostdlib}
12314 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12315 This ensures that you have no unresolved references to internal GCC
12316 library subroutines.
12317 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12318 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12319 GNU Compiler Collection (GCC) Internals}.)
12321 @item -pie
12322 @opindex pie
12323 Produce a dynamically linked position independent executable on targets
12324 that support it.  For predictable results, you must also specify the same
12325 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12326 or model suboptions) when you specify this linker option.
12328 @item -no-pie
12329 @opindex no-pie
12330 Don't produce a dynamically linked position independent executable.
12332 @item -static-pie
12333 @opindex static-pie
12334 Produce a static position independent executable on targets that support
12335 it.  A static position independent executable is similar to a static
12336 executable, but can be loaded at any address without a dynamic linker.
12337 For predictable results, you must also specify the same set of options
12338 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12339 suboptions) when you specify this linker option.
12341 @item -pthread
12342 @opindex pthread
12343 Link with the POSIX threads library.  This option is supported on 
12344 GNU/Linux targets, most other Unix derivatives, and also on 
12345 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12346 flags for the preprocessor, so it should be used consistently for both
12347 compilation and linking.
12349 @item -rdynamic
12350 @opindex rdynamic
12351 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12352 that support it. This instructs the linker to add all symbols, not
12353 only used ones, to the dynamic symbol table. This option is needed
12354 for some uses of @code{dlopen} or to allow obtaining backtraces
12355 from within a program.
12357 @item -s
12358 @opindex s
12359 Remove all symbol table and relocation information from the executable.
12361 @item -static
12362 @opindex static
12363 On systems that support dynamic linking, this overrides @option{-pie}
12364 and prevents linking with the shared libraries.  On other systems, this
12365 option has no effect.
12367 @item -shared
12368 @opindex shared
12369 Produce a shared object which can then be linked with other objects to
12370 form an executable.  Not all systems support this option.  For predictable
12371 results, you must also specify the same set of options used for compilation
12372 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12373 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12374 needs to build supplementary stub code for constructors to work.  On
12375 multi-libbed systems, @samp{gcc -shared} must select the correct support
12376 libraries to link against.  Failing to supply the correct flags may lead
12377 to subtle defects.  Supplying them in cases where they are not necessary
12378 is innocuous.}
12380 @item -shared-libgcc
12381 @itemx -static-libgcc
12382 @opindex shared-libgcc
12383 @opindex static-libgcc
12384 On systems that provide @file{libgcc} as a shared library, these options
12385 force the use of either the shared or static version, respectively.
12386 If no shared version of @file{libgcc} was built when the compiler was
12387 configured, these options have no effect.
12389 There are several situations in which an application should use the
12390 shared @file{libgcc} instead of the static version.  The most common
12391 of these is when the application wishes to throw and catch exceptions
12392 across different shared libraries.  In that case, each of the libraries
12393 as well as the application itself should use the shared @file{libgcc}.
12395 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12396  whenever you build a shared library or a main executable, because C++
12397  programs typically use exceptions, so this is the right thing to do.
12399 If, instead, you use the GCC driver to create shared libraries, you may
12400 find that they are not always linked with the shared @file{libgcc}.
12401 If GCC finds, at its configuration time, that you have a non-GNU linker
12402 or a GNU linker that does not support option @option{--eh-frame-hdr},
12403 it links the shared version of @file{libgcc} into shared libraries
12404 by default.  Otherwise, it takes advantage of the linker and optimizes
12405 away the linking with the shared version of @file{libgcc}, linking with
12406 the static version of libgcc by default.  This allows exceptions to
12407 propagate through such shared libraries, without incurring relocation
12408 costs at library load time.
12410 However, if a library or main executable is supposed to throw or catch
12411 exceptions, you must link it using the G++ driver, as appropriate
12412 for the languages used in the program, or using the option
12413 @option{-shared-libgcc}, such that it is linked with the shared
12414 @file{libgcc}.
12416 @item -static-libasan
12417 @opindex static-libasan
12418 When the @option{-fsanitize=address} option is used to link a program,
12419 the GCC driver automatically links against @option{libasan}.  If
12420 @file{libasan} is available as a shared library, and the @option{-static}
12421 option is not used, then this links against the shared version of
12422 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12423 driver to link @file{libasan} statically, without necessarily linking
12424 other libraries statically.
12426 @item -static-libtsan
12427 @opindex static-libtsan
12428 When the @option{-fsanitize=thread} option is used to link a program,
12429 the GCC driver automatically links against @option{libtsan}.  If
12430 @file{libtsan} is available as a shared library, and the @option{-static}
12431 option is not used, then this links against the shared version of
12432 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12433 driver to link @file{libtsan} statically, without necessarily linking
12434 other libraries statically.
12436 @item -static-liblsan
12437 @opindex static-liblsan
12438 When the @option{-fsanitize=leak} option is used to link a program,
12439 the GCC driver automatically links against @option{liblsan}.  If
12440 @file{liblsan} is available as a shared library, and the @option{-static}
12441 option is not used, then this links against the shared version of
12442 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12443 driver to link @file{liblsan} statically, without necessarily linking
12444 other libraries statically.
12446 @item -static-libubsan
12447 @opindex static-libubsan
12448 When the @option{-fsanitize=undefined} option is used to link a program,
12449 the GCC driver automatically links against @option{libubsan}.  If
12450 @file{libubsan} is available as a shared library, and the @option{-static}
12451 option is not used, then this links against the shared version of
12452 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12453 driver to link @file{libubsan} statically, without necessarily linking
12454 other libraries statically.
12456 @item -static-libmpx
12457 @opindex static-libmpx
12458 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12459 used to link a program, the GCC driver automatically links against
12460 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12461 and the @option{-static} option is not used, then this links against
12462 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12463 option directs the GCC driver to link @file{libmpx} statically,
12464 without necessarily linking other libraries statically.
12466 @item -static-libmpxwrappers
12467 @opindex static-libmpxwrappers
12468 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12469 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12470 GCC driver automatically links against @file{libmpxwrappers}.  If
12471 @file{libmpxwrappers} is available as a shared library, and the
12472 @option{-static} option is not used, then this links against the shared
12473 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12474 option directs the GCC driver to link @file{libmpxwrappers} statically,
12475 without necessarily linking other libraries statically.
12477 @item -static-libstdc++
12478 @opindex static-libstdc++
12479 When the @command{g++} program is used to link a C++ program, it
12480 normally automatically links against @option{libstdc++}.  If
12481 @file{libstdc++} is available as a shared library, and the
12482 @option{-static} option is not used, then this links against the
12483 shared version of @file{libstdc++}.  That is normally fine.  However, it
12484 is sometimes useful to freeze the version of @file{libstdc++} used by
12485 the program without going all the way to a fully static link.  The
12486 @option{-static-libstdc++} option directs the @command{g++} driver to
12487 link @file{libstdc++} statically, without necessarily linking other
12488 libraries statically.
12490 @item -symbolic
12491 @opindex symbolic
12492 Bind references to global symbols when building a shared object.  Warn
12493 about any unresolved references (unless overridden by the link editor
12494 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12495 this option.
12497 @item -T @var{script}
12498 @opindex T
12499 @cindex linker script
12500 Use @var{script} as the linker script.  This option is supported by most
12501 systems using the GNU linker.  On some targets, such as bare-board
12502 targets without an operating system, the @option{-T} option may be required
12503 when linking to avoid references to undefined symbols.
12505 @item -Xlinker @var{option}
12506 @opindex Xlinker
12507 Pass @var{option} as an option to the linker.  You can use this to
12508 supply system-specific linker options that GCC does not recognize.
12510 If you want to pass an option that takes a separate argument, you must use
12511 @option{-Xlinker} twice, once for the option and once for the argument.
12512 For example, to pass @option{-assert definitions}, you must write
12513 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12514 @option{-Xlinker "-assert definitions"}, because this passes the entire
12515 string as a single argument, which is not what the linker expects.
12517 When using the GNU linker, it is usually more convenient to pass
12518 arguments to linker options using the @option{@var{option}=@var{value}}
12519 syntax than as separate arguments.  For example, you can specify
12520 @option{-Xlinker -Map=output.map} rather than
12521 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12522 this syntax for command-line options.
12524 @item -Wl,@var{option}
12525 @opindex Wl
12526 Pass @var{option} as an option to the linker.  If @var{option} contains
12527 commas, it is split into multiple options at the commas.  You can use this
12528 syntax to pass an argument to the option.
12529 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12530 linker.  When using the GNU linker, you can also get the same effect with
12531 @option{-Wl,-Map=output.map}.
12533 @item -u @var{symbol}
12534 @opindex u
12535 Pretend the symbol @var{symbol} is undefined, to force linking of
12536 library modules to define it.  You can use @option{-u} multiple times with
12537 different symbols to force loading of additional library modules.
12539 @item -z @var{keyword}
12540 @opindex z
12541 @option{-z} is passed directly on to the linker along with the keyword
12542 @var{keyword}. See the section in the documentation of your linker for
12543 permitted values and their meanings.
12544 @end table
12546 @node Directory Options
12547 @section Options for Directory Search
12548 @cindex directory options
12549 @cindex options, directory search
12550 @cindex search path
12552 These options specify directories to search for header files, for
12553 libraries and for parts of the compiler:
12555 @table @gcctabopt
12556 @include cppdiropts.texi
12558 @item -iplugindir=@var{dir}
12559 @opindex iplugindir=
12560 Set the directory to search for plugins that are passed
12561 by @option{-fplugin=@var{name}} instead of
12562 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12563 to be used by the user, but only passed by the driver.
12565 @item -L@var{dir}
12566 @opindex L
12567 Add directory @var{dir} to the list of directories to be searched
12568 for @option{-l}.
12570 @item -B@var{prefix}
12571 @opindex B
12572 This option specifies where to find the executables, libraries,
12573 include files, and data files of the compiler itself.
12575 The compiler driver program runs one or more of the subprograms
12576 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12577 @var{prefix} as a prefix for each program it tries to run, both with and
12578 without @samp{@var{machine}/@var{version}/} for the corresponding target
12579 machine and compiler version.
12581 For each subprogram to be run, the compiler driver first tries the
12582 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12583 is not specified, the driver tries two standard prefixes, 
12584 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12585 those results in a file name that is found, the unmodified program
12586 name is searched for using the directories specified in your
12587 @env{PATH} environment variable.
12589 The compiler checks to see if the path provided by @option{-B}
12590 refers to a directory, and if necessary it adds a directory
12591 separator character at the end of the path.
12593 @option{-B} prefixes that effectively specify directory names also apply
12594 to libraries in the linker, because the compiler translates these
12595 options into @option{-L} options for the linker.  They also apply to
12596 include files in the preprocessor, because the compiler translates these
12597 options into @option{-isystem} options for the preprocessor.  In this case,
12598 the compiler appends @samp{include} to the prefix.
12600 The runtime support file @file{libgcc.a} can also be searched for using
12601 the @option{-B} prefix, if needed.  If it is not found there, the two
12602 standard prefixes above are tried, and that is all.  The file is left
12603 out of the link if it is not found by those means.
12605 Another way to specify a prefix much like the @option{-B} prefix is to use
12606 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12607 Variables}.
12609 As a special kludge, if the path provided by @option{-B} is
12610 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12611 9, then it is replaced by @file{[dir/]include}.  This is to help
12612 with boot-strapping the compiler.
12614 @item -no-canonical-prefixes
12615 @opindex no-canonical-prefixes
12616 Do not expand any symbolic links, resolve references to @samp{/../}
12617 or @samp{/./}, or make the path absolute when generating a relative
12618 prefix.
12620 @item --sysroot=@var{dir}
12621 @opindex sysroot
12622 Use @var{dir} as the logical root directory for headers and libraries.
12623 For example, if the compiler normally searches for headers in
12624 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12625 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12627 If you use both this option and the @option{-isysroot} option, then
12628 the @option{--sysroot} option applies to libraries, but the
12629 @option{-isysroot} option applies to header files.
12631 The GNU linker (beginning with version 2.16) has the necessary support
12632 for this option.  If your linker does not support this option, the
12633 header file aspect of @option{--sysroot} still works, but the
12634 library aspect does not.
12636 @item --no-sysroot-suffix
12637 @opindex no-sysroot-suffix
12638 For some targets, a suffix is added to the root directory specified
12639 with @option{--sysroot}, depending on the other options used, so that
12640 headers may for example be found in
12641 @file{@var{dir}/@var{suffix}/usr/include} instead of
12642 @file{@var{dir}/usr/include}.  This option disables the addition of
12643 such a suffix.
12645 @end table
12647 @node Code Gen Options
12648 @section Options for Code Generation Conventions
12649 @cindex code generation conventions
12650 @cindex options, code generation
12651 @cindex run-time options
12653 These machine-independent options control the interface conventions
12654 used in code generation.
12656 Most of them have both positive and negative forms; the negative form
12657 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12658 one of the forms is listed---the one that is not the default.  You
12659 can figure out the other form by either removing @samp{no-} or adding
12662 @table @gcctabopt
12663 @item -fstack-reuse=@var{reuse-level}
12664 @opindex fstack_reuse
12665 This option controls stack space reuse for user declared local/auto variables
12666 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12667 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12668 local variables and temporaries, @samp{named_vars} enables the reuse only for
12669 user defined local variables with names, and @samp{none} disables stack reuse
12670 completely. The default value is @samp{all}. The option is needed when the
12671 program extends the lifetime of a scoped local variable or a compiler generated
12672 temporary beyond the end point defined by the language.  When a lifetime of
12673 a variable ends, and if the variable lives in memory, the optimizing compiler
12674 has the freedom to reuse its stack space with other temporaries or scoped
12675 local variables whose live range does not overlap with it. Legacy code extending
12676 local lifetime is likely to break with the stack reuse optimization.
12678 For example,
12680 @smallexample
12681    int *p;
12682    @{
12683      int local1;
12685      p = &local1;
12686      local1 = 10;
12687      ....
12688    @}
12689    @{
12690       int local2;
12691       local2 = 20;
12692       ...
12693    @}
12695    if (*p == 10)  // out of scope use of local1
12696      @{
12698      @}
12699 @end smallexample
12701 Another example:
12702 @smallexample
12704    struct A
12705    @{
12706        A(int k) : i(k), j(k) @{ @}
12707        int i;
12708        int j;
12709    @};
12711    A *ap;
12713    void foo(const A& ar)
12714    @{
12715       ap = &ar;
12716    @}
12718    void bar()
12719    @{
12720       foo(A(10)); // temp object's lifetime ends when foo returns
12722       @{
12723         A a(20);
12724         ....
12725       @}
12726       ap->i+= 10;  // ap references out of scope temp whose space
12727                    // is reused with a. What is the value of ap->i?
12728    @}
12730 @end smallexample
12732 The lifetime of a compiler generated temporary is well defined by the C++
12733 standard. When a lifetime of a temporary ends, and if the temporary lives
12734 in memory, the optimizing compiler has the freedom to reuse its stack
12735 space with other temporaries or scoped local variables whose live range
12736 does not overlap with it. However some of the legacy code relies on
12737 the behavior of older compilers in which temporaries' stack space is
12738 not reused, the aggressive stack reuse can lead to runtime errors. This
12739 option is used to control the temporary stack reuse optimization.
12741 @item -ftrapv
12742 @opindex ftrapv
12743 This option generates traps for signed overflow on addition, subtraction,
12744 multiplication operations.
12745 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12746 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12747 @option{-fwrapv} being effective.  Note that only active options override, so
12748 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12749 results in @option{-ftrapv} being effective.
12751 @item -fwrapv
12752 @opindex fwrapv
12753 This option instructs the compiler to assume that signed arithmetic
12754 overflow of addition, subtraction and multiplication wraps around
12755 using twos-complement representation.  This flag enables some optimizations
12756 and disables others.
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-pointer
12764 @opindex fwrapv-pointer
12765 This option instructs the compiler to assume that pointer arithmetic
12766 overflow on addition and subtraction wraps around using twos-complement
12767 representation.  This flag disables some optimizations which assume
12768 pointer overflow is invalid.
12770 @item -fstrict-overflow
12771 @opindex fstrict-overflow
12772 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12773 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12775 @item -fexceptions
12776 @opindex fexceptions
12777 Enable exception handling.  Generates extra code needed to propagate
12778 exceptions.  For some targets, this implies GCC generates frame
12779 unwind information for all functions, which can produce significant data
12780 size overhead, although it does not affect execution.  If you do not
12781 specify this option, GCC enables it by default for languages like
12782 C++ that normally require exception handling, and disables it for
12783 languages like C that do not normally require it.  However, you may need
12784 to enable this option when compiling C code that needs to interoperate
12785 properly with exception handlers written in C++.  You may also wish to
12786 disable this option if you are compiling older C++ programs that don't
12787 use exception handling.
12789 @item -fnon-call-exceptions
12790 @opindex fnon-call-exceptions
12791 Generate code that allows trapping instructions to throw exceptions.
12792 Note that this requires platform-specific runtime support that does
12793 not exist everywhere.  Moreover, it only allows @emph{trapping}
12794 instructions to throw exceptions, i.e.@: memory references or floating-point
12795 instructions.  It does not allow exceptions to be thrown from
12796 arbitrary signal handlers such as @code{SIGALRM}.
12798 @item -fdelete-dead-exceptions
12799 @opindex fdelete-dead-exceptions
12800 Consider that instructions that may throw exceptions but don't otherwise
12801 contribute to the execution of the program can be optimized away.
12802 This option is enabled by default for the Ada front end, as permitted by
12803 the Ada language specification.
12804 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12806 @item -funwind-tables
12807 @opindex funwind-tables
12808 Similar to @option{-fexceptions}, except that it just generates any needed
12809 static data, but does not affect the generated code in any other way.
12810 You normally do not need to enable this option; instead, a language processor
12811 that needs this handling enables it on your behalf.
12813 @item -fasynchronous-unwind-tables
12814 @opindex fasynchronous-unwind-tables
12815 Generate unwind table in DWARF format, if supported by target machine.  The
12816 table is exact at each instruction boundary, so it can be used for stack
12817 unwinding from asynchronous events (such as debugger or garbage collector).
12819 @item -fno-gnu-unique
12820 @opindex fno-gnu-unique
12821 On systems with recent GNU assembler and C library, the C++ compiler
12822 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12823 of template static data members and static local variables in inline
12824 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12825 is necessary to avoid problems with a library used by two different
12826 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12827 therefore disagreeing with the other one about the binding of the
12828 symbol.  But this causes @code{dlclose} to be ignored for affected
12829 DSOs; if your program relies on reinitialization of a DSO via
12830 @code{dlclose} and @code{dlopen}, you can use
12831 @option{-fno-gnu-unique}.
12833 @item -fpcc-struct-return
12834 @opindex fpcc-struct-return
12835 Return ``short'' @code{struct} and @code{union} values in memory like
12836 longer ones, rather than in registers.  This convention is less
12837 efficient, but it has the advantage of allowing intercallability between
12838 GCC-compiled files and files compiled with other compilers, particularly
12839 the Portable C Compiler (pcc).
12841 The precise convention for returning structures in memory depends
12842 on the target configuration macros.
12844 Short structures and unions are those whose size and alignment match
12845 that of some integer type.
12847 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12848 switch is not binary compatible with code compiled with the
12849 @option{-freg-struct-return} switch.
12850 Use it to conform to a non-default application binary interface.
12852 @item -freg-struct-return
12853 @opindex freg-struct-return
12854 Return @code{struct} and @code{union} values in registers when possible.
12855 This is more efficient for small structures than
12856 @option{-fpcc-struct-return}.
12858 If you specify neither @option{-fpcc-struct-return} nor
12859 @option{-freg-struct-return}, GCC defaults to whichever convention is
12860 standard for the target.  If there is no standard convention, GCC
12861 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12862 the principal compiler.  In those cases, we can choose the standard, and
12863 we chose the more efficient register return alternative.
12865 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12866 switch is not binary compatible with code compiled with the
12867 @option{-fpcc-struct-return} switch.
12868 Use it to conform to a non-default application binary interface.
12870 @item -fshort-enums
12871 @opindex fshort-enums
12872 Allocate to an @code{enum} type only as many bytes as it needs for the
12873 declared range of possible values.  Specifically, the @code{enum} type
12874 is equivalent to the smallest integer type that has enough room.
12876 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12877 code that is not binary compatible with code generated without that switch.
12878 Use it to conform to a non-default application binary interface.
12880 @item -fshort-wchar
12881 @opindex fshort-wchar
12882 Override the underlying type for @code{wchar_t} to be @code{short
12883 unsigned int} instead of the default for the target.  This option is
12884 useful for building programs to run under WINE@.
12886 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12887 code that is not binary compatible with code generated without that switch.
12888 Use it to conform to a non-default application binary interface.
12890 @item -fno-common
12891 @opindex fno-common
12892 @cindex tentative definitions
12893 In C code, this option controls the placement of global variables 
12894 defined without an initializer, known as @dfn{tentative definitions} 
12895 in the C standard.  Tentative definitions are distinct from declarations 
12896 of a variable with the @code{extern} keyword, which do not allocate storage.
12898 Unix C compilers have traditionally allocated storage for
12899 uninitialized global variables in a common block.  This allows the
12900 linker to resolve all tentative definitions of the same variable
12901 in different compilation units to the same object, or to a non-tentative
12902 definition.  
12903 This is the behavior specified by @option{-fcommon}, and is the default for 
12904 GCC on most targets.  
12905 On the other hand, this behavior is not required by ISO
12906 C, and on some targets may carry a speed or code size penalty on
12907 variable references.
12909 The @option{-fno-common} option specifies that the compiler should instead
12910 place uninitialized global variables in the data section of the object file.
12911 This inhibits the merging of tentative definitions by the linker so
12912 you get a multiple-definition error if the same 
12913 variable is defined in more than one compilation unit.
12914 Compiling with @option{-fno-common} is useful on targets for which
12915 it provides better performance, or if you wish to verify that the
12916 program will work on other systems that always treat uninitialized
12917 variable definitions this way.
12919 @item -fno-ident
12920 @opindex fno-ident
12921 Ignore the @code{#ident} directive.
12923 @item -finhibit-size-directive
12924 @opindex finhibit-size-directive
12925 Don't output a @code{.size} assembler directive, or anything else that
12926 would cause trouble if the function is split in the middle, and the
12927 two halves are placed at locations far apart in memory.  This option is
12928 used when compiling @file{crtstuff.c}; you should not need to use it
12929 for anything else.
12931 @item -fverbose-asm
12932 @opindex fverbose-asm
12933 Put extra commentary information in the generated assembly code to
12934 make it more readable.  This option is generally only of use to those
12935 who actually need to read the generated assembly code (perhaps while
12936 debugging the compiler itself).
12938 @option{-fno-verbose-asm}, the default, causes the
12939 extra information to be omitted and is useful when comparing two assembler
12940 files.
12942 The added comments include:
12944 @itemize @bullet
12946 @item
12947 information on the compiler version and command-line options,
12949 @item
12950 the source code lines associated with the assembly instructions,
12951 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12953 @item
12954 hints on which high-level expressions correspond to
12955 the various assembly instruction operands.
12957 @end itemize
12959 For example, given this C source file:
12961 @smallexample
12962 int test (int n)
12964   int i;
12965   int total = 0;
12967   for (i = 0; i < n; i++)
12968     total += i * i;
12970   return total;
12972 @end smallexample
12974 compiling to (x86_64) assembly via @option{-S} and emitting the result
12975 direct to stdout via @option{-o} @option{-}
12977 @smallexample
12978 gcc -S test.c -fverbose-asm -Os -o -
12979 @end smallexample
12981 gives output similar to this:
12983 @smallexample
12984         .file   "test.c"
12985 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12986   [...snip...]
12987 # options passed:
12988   [...snip...]
12990         .text
12991         .globl  test
12992         .type   test, @@function
12993 test:
12994 .LFB0:
12995         .cfi_startproc
12996 # test.c:4:   int total = 0;
12997         xorl    %eax, %eax      # <retval>
12998 # test.c:6:   for (i = 0; i < n; i++)
12999         xorl    %edx, %edx      # i
13000 .L2:
13001 # test.c:6:   for (i = 0; i < n; i++)
13002         cmpl    %edi, %edx      # n, i
13003         jge     .L5     #,
13004 # test.c:7:     total += i * i;
13005         movl    %edx, %ecx      # i, tmp92
13006         imull   %edx, %ecx      # i, tmp92
13007 # test.c:6:   for (i = 0; i < n; i++)
13008         incl    %edx    # i
13009 # test.c:7:     total += i * i;
13010         addl    %ecx, %eax      # tmp92, <retval>
13011         jmp     .L2     #
13012 .L5:
13013 # test.c:10: @}
13014         ret
13015         .cfi_endproc
13016 .LFE0:
13017         .size   test, .-test
13018         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13019         .section        .note.GNU-stack,"",@@progbits
13020 @end smallexample
13022 The comments are intended for humans rather than machines and hence the
13023 precise format of the comments is subject to change.
13025 @item -frecord-gcc-switches
13026 @opindex frecord-gcc-switches
13027 This switch causes the command line used to invoke the
13028 compiler to be recorded into the object file that is being created.
13029 This switch is only implemented on some targets and the exact format
13030 of the recording is target and binary file format dependent, but it
13031 usually takes the form of a section containing ASCII text.  This
13032 switch is related to the @option{-fverbose-asm} switch, but that
13033 switch only records information in the assembler output file as
13034 comments, so it never reaches the object file.
13035 See also @option{-grecord-gcc-switches} for another
13036 way of storing compiler options into the object file.
13038 @item -fpic
13039 @opindex fpic
13040 @cindex global offset table
13041 @cindex PIC
13042 Generate position-independent code (PIC) suitable for use in a shared
13043 library, if supported for the target machine.  Such code accesses all
13044 constant addresses through a global offset table (GOT)@.  The dynamic
13045 loader resolves the GOT entries when the program starts (the dynamic
13046 loader is not part of GCC; it is part of the operating system).  If
13047 the GOT size for the linked executable exceeds a machine-specific
13048 maximum size, you get an error message from the linker indicating that
13049 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13050 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13051 on the m68k and RS/6000.  The x86 has no such limit.)
13053 Position-independent code requires special support, and therefore works
13054 only on certain machines.  For the x86, GCC supports PIC for System V
13055 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13056 position-independent.
13058 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13059 are defined to 1.
13061 @item -fPIC
13062 @opindex fPIC
13063 If supported for the target machine, emit position-independent code,
13064 suitable for dynamic linking and avoiding any limit on the size of the
13065 global offset table.  This option makes a difference on AArch64, m68k,
13066 PowerPC and SPARC@.
13068 Position-independent code requires special support, and therefore works
13069 only on certain machines.
13071 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13072 are defined to 2.
13074 @item -fpie
13075 @itemx -fPIE
13076 @opindex fpie
13077 @opindex fPIE
13078 These options are similar to @option{-fpic} and @option{-fPIC}, but
13079 generated position independent code can be only linked into executables.
13080 Usually these options are used when @option{-pie} GCC option is
13081 used during linking.
13083 @option{-fpie} and @option{-fPIE} both define the macros
13084 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13085 for @option{-fpie} and 2 for @option{-fPIE}.
13087 @item -fno-plt
13088 @opindex fno-plt
13089 Do not use the PLT for external function calls in position-independent code.
13090 Instead, load the callee address at call sites from the GOT and branch to it.
13091 This leads to more efficient code by eliminating PLT stubs and exposing
13092 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13093 PLT stubs expect the GOT pointer in a specific register, this gives more
13094 register allocation freedom to the compiler.
13095 Lazy binding requires use of the PLT; 
13096 with @option{-fno-plt} all external symbols are resolved at load time.
13098 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13099 through the PLT for specific external functions.
13101 In position-dependent code, a few targets also convert calls to
13102 functions that are marked to not use the PLT to use the GOT instead.
13104 @item -fno-jump-tables
13105 @opindex fno-jump-tables
13106 Do not use jump tables for switch statements even where it would be
13107 more efficient than other code generation strategies.  This option is
13108 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13109 building code that forms part of a dynamic linker and cannot
13110 reference the address of a jump table.  On some targets, jump tables
13111 do not require a GOT and this option is not needed.
13113 @item -ffixed-@var{reg}
13114 @opindex ffixed
13115 Treat the register named @var{reg} as a fixed register; generated code
13116 should never refer to it (except perhaps as a stack pointer, frame
13117 pointer or in some other fixed role).
13119 @var{reg} must be the name of a register.  The register names accepted
13120 are machine-specific and are defined in the @code{REGISTER_NAMES}
13121 macro in the machine description macro file.
13123 This flag does not have a negative form, because it specifies a
13124 three-way choice.
13126 @item -fcall-used-@var{reg}
13127 @opindex fcall-used
13128 Treat the register named @var{reg} as an allocable register that is
13129 clobbered by function calls.  It may be allocated for temporaries or
13130 variables that do not live across a call.  Functions compiled this way
13131 do not save and restore the register @var{reg}.
13133 It is an error to use this flag with the frame pointer or stack pointer.
13134 Use of this flag for other registers that have fixed pervasive roles in
13135 the machine's execution model produces disastrous results.
13137 This flag does not have a negative form, because it specifies a
13138 three-way choice.
13140 @item -fcall-saved-@var{reg}
13141 @opindex fcall-saved
13142 Treat the register named @var{reg} as an allocable register saved by
13143 functions.  It may be allocated even for temporaries or variables that
13144 live across a call.  Functions compiled this way save and restore
13145 the register @var{reg} if they use it.
13147 It is an error to use this flag with the frame pointer or stack pointer.
13148 Use of this flag for other registers that have fixed pervasive roles in
13149 the machine's execution model produces disastrous results.
13151 A different sort of disaster results from the use of this flag for
13152 a register in which function values may be returned.
13154 This flag does not have a negative form, because it specifies a
13155 three-way choice.
13157 @item -fpack-struct[=@var{n}]
13158 @opindex fpack-struct
13159 Without a value specified, pack all structure members together without
13160 holes.  When a value is specified (which must be a small power of two), pack
13161 structure members according to this value, representing the maximum
13162 alignment (that is, objects with default alignment requirements larger than
13163 this are output potentially unaligned at the next fitting location.
13165 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13166 code that is not binary compatible with code generated without that switch.
13167 Additionally, it makes the code suboptimal.
13168 Use it to conform to a non-default application binary interface.
13170 @item -fleading-underscore
13171 @opindex fleading-underscore
13172 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13173 change the way C symbols are represented in the object file.  One use
13174 is to help link with legacy assembly code.
13176 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13177 generate code that is not binary compatible with code generated without that
13178 switch.  Use it to conform to a non-default application binary interface.
13179 Not all targets provide complete support for this switch.
13181 @item -ftls-model=@var{model}
13182 @opindex ftls-model
13183 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13184 The @var{model} argument should be one of @samp{global-dynamic},
13185 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13186 Note that the choice is subject to optimization: the compiler may use
13187 a more efficient model for symbols not visible outside of the translation
13188 unit, or if @option{-fpic} is not given on the command line.
13190 The default without @option{-fpic} is @samp{initial-exec}; with
13191 @option{-fpic} the default is @samp{global-dynamic}.
13193 @item -ftrampolines
13194 @opindex ftrampolines
13195 For targets that normally need trampolines for nested functions, always
13196 generate them instead of using descriptors.  Otherwise, for targets that
13197 do not need them, like for example HP-PA or IA-64, do nothing.
13199 A trampoline is a small piece of code that is created at run time on the
13200 stack when the address of a nested function is taken, and is used to call
13201 the nested function indirectly.  Therefore, it requires the stack to be
13202 made executable in order for the program to work properly.
13204 @option{-fno-trampolines} is enabled by default on a language by language
13205 basis to let the compiler avoid generating them, if it computes that this
13206 is safe, and replace them with descriptors.  Descriptors are made up of data
13207 only, but the generated code must be prepared to deal with them.  As of this
13208 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13210 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13211 @option{-fno-trampolines} are not binary compatible if nested functions are
13212 present.  This option must therefore be used on a program-wide basis and be
13213 manipulated with extreme care.
13215 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13216 @opindex fvisibility
13217 Set the default ELF image symbol visibility to the specified option---all
13218 symbols are marked with this unless overridden within the code.
13219 Using this feature can very substantially improve linking and
13220 load times of shared object libraries, produce more optimized
13221 code, provide near-perfect API export and prevent symbol clashes.
13222 It is @strong{strongly} recommended that you use this in any shared objects
13223 you distribute.
13225 Despite the nomenclature, @samp{default} always means public; i.e.,
13226 available to be linked against from outside the shared object.
13227 @samp{protected} and @samp{internal} are pretty useless in real-world
13228 usage so the only other commonly used option is @samp{hidden}.
13229 The default if @option{-fvisibility} isn't specified is
13230 @samp{default}, i.e., make every symbol public.
13232 A good explanation of the benefits offered by ensuring ELF
13233 symbols have the correct visibility is given by ``How To Write
13234 Shared Libraries'' by Ulrich Drepper (which can be found at
13235 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13236 solution made possible by this option to marking things hidden when
13237 the default is public is to make the default hidden and mark things
13238 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13239 and @code{__attribute__ ((visibility("default")))} instead of
13240 @code{__declspec(dllexport)} you get almost identical semantics with
13241 identical syntax.  This is a great boon to those working with
13242 cross-platform projects.
13244 For those adding visibility support to existing code, you may find
13245 @code{#pragma GCC visibility} of use.  This works by you enclosing
13246 the declarations you wish to set visibility for with (for example)
13247 @code{#pragma GCC visibility push(hidden)} and
13248 @code{#pragma GCC visibility pop}.
13249 Bear in mind that symbol visibility should be viewed @strong{as
13250 part of the API interface contract} and thus all new code should
13251 always specify visibility when it is not the default; i.e., declarations
13252 only for use within the local DSO should @strong{always} be marked explicitly
13253 as hidden as so to avoid PLT indirection overheads---making this
13254 abundantly clear also aids readability and self-documentation of the code.
13255 Note that due to ISO C++ specification requirements, @code{operator new} and
13256 @code{operator delete} must always be of default visibility.
13258 Be aware that headers from outside your project, in particular system
13259 headers and headers from any other library you use, may not be
13260 expecting to be compiled with visibility other than the default.  You
13261 may need to explicitly say @code{#pragma GCC visibility push(default)}
13262 before including any such headers.
13264 @code{extern} declarations are not affected by @option{-fvisibility}, so
13265 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13266 no modifications.  However, this means that calls to @code{extern}
13267 functions with no explicit visibility use the PLT, so it is more
13268 effective to use @code{__attribute ((visibility))} and/or
13269 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13270 declarations should be treated as hidden.
13272 Note that @option{-fvisibility} does affect C++ vague linkage
13273 entities. This means that, for instance, an exception class that is
13274 be thrown between DSOs must be explicitly marked with default
13275 visibility so that the @samp{type_info} nodes are unified between
13276 the DSOs.
13278 An overview of these techniques, their benefits and how to use them
13279 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13281 @item -fstrict-volatile-bitfields
13282 @opindex fstrict-volatile-bitfields
13283 This option should be used if accesses to volatile bit-fields (or other
13284 structure fields, although the compiler usually honors those types
13285 anyway) should use a single access of the width of the
13286 field's type, aligned to a natural alignment if possible.  For
13287 example, targets with memory-mapped peripheral registers might require
13288 all such accesses to be 16 bits wide; with this flag you can
13289 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13290 is 16 bits on these targets) to force GCC to use 16-bit accesses
13291 instead of, perhaps, a more efficient 32-bit access.
13293 If this option is disabled, the compiler uses the most efficient
13294 instruction.  In the previous example, that might be a 32-bit load
13295 instruction, even though that accesses bytes that do not contain
13296 any portion of the bit-field, or memory-mapped registers unrelated to
13297 the one being updated.
13299 In some cases, such as when the @code{packed} attribute is applied to a 
13300 structure field, it may not be possible to access the field with a single
13301 read or write that is correctly aligned for the target machine.  In this
13302 case GCC falls back to generating multiple accesses rather than code that 
13303 will fault or truncate the result at run time.
13305 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13306 not allowed to touch non bit-field members.  It is therefore recommended
13307 to define all bits of the field's type as bit-field members.
13309 The default value of this option is determined by the application binary
13310 interface for the target processor.
13312 @item -fsync-libcalls
13313 @opindex fsync-libcalls
13314 This option controls whether any out-of-line instance of the @code{__sync}
13315 family of functions may be used to implement the C++11 @code{__atomic}
13316 family of functions.
13318 The default value of this option is enabled, thus the only useful form
13319 of the option is @option{-fno-sync-libcalls}.  This option is used in
13320 the implementation of the @file{libatomic} runtime library.
13322 @end table
13324 @node Developer Options
13325 @section GCC Developer Options
13326 @cindex developer options
13327 @cindex debugging GCC
13328 @cindex debug dump options
13329 @cindex dump options
13330 @cindex compilation statistics
13332 This section describes command-line options that are primarily of
13333 interest to GCC developers, including options to support compiler
13334 testing and investigation of compiler bugs and compile-time
13335 performance problems.  This includes options that produce debug dumps
13336 at various points in the compilation; that print statistics such as
13337 memory use and execution time; and that print information about GCC's
13338 configuration, such as where it searches for libraries.  You should
13339 rarely need to use any of these options for ordinary compilation and
13340 linking tasks.
13342 @table @gcctabopt
13344 @item -d@var{letters}
13345 @itemx -fdump-rtl-@var{pass}
13346 @itemx -fdump-rtl-@var{pass}=@var{filename}
13347 @opindex d
13348 @opindex fdump-rtl-@var{pass}
13349 Says to make debugging dumps during compilation at times specified by
13350 @var{letters}.  This is used for debugging the RTL-based passes of the
13351 compiler.  The file names for most of the dumps are made by appending
13352 a pass number and a word to the @var{dumpname}, and the files are
13353 created in the directory of the output file.  In case of
13354 @option{=@var{filename}} option, the dump is output on the given file
13355 instead of the pass numbered dump files.  Note that the pass number is
13356 assigned as passes are registered into the pass manager.  Most passes
13357 are registered in the order that they will execute and for these passes
13358 the number corresponds to the pass execution order.  However, passes
13359 registered by plugins, passes specific to compilation targets, or
13360 passes that are otherwise registered after all the other passes are
13361 numbered higher than a pass named "final", even if they are executed
13362 earlier.  @var{dumpname} is generated from the name of the output
13363 file if explicitly specified and not an executable, otherwise it is
13364 the basename of the source file.  
13366 Some @option{-d@var{letters}} switches have different meaning when
13367 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13368 for information about preprocessor-specific dump options.
13370 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13371 @option{-d} option @var{letters}.  Here are the possible
13372 letters for use in @var{pass} and @var{letters}, and their meanings:
13374 @table @gcctabopt
13376 @item -fdump-rtl-alignments
13377 @opindex fdump-rtl-alignments
13378 Dump after branch alignments have been computed.
13380 @item -fdump-rtl-asmcons
13381 @opindex fdump-rtl-asmcons
13382 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13384 @item -fdump-rtl-auto_inc_dec
13385 @opindex fdump-rtl-auto_inc_dec
13386 Dump after auto-inc-dec discovery.  This pass is only run on
13387 architectures that have auto inc or auto dec instructions.
13389 @item -fdump-rtl-barriers
13390 @opindex fdump-rtl-barriers
13391 Dump after cleaning up the barrier instructions.
13393 @item -fdump-rtl-bbpart
13394 @opindex fdump-rtl-bbpart
13395 Dump after partitioning hot and cold basic blocks.
13397 @item -fdump-rtl-bbro
13398 @opindex fdump-rtl-bbro
13399 Dump after block reordering.
13401 @item -fdump-rtl-btl1
13402 @itemx -fdump-rtl-btl2
13403 @opindex fdump-rtl-btl2
13404 @opindex fdump-rtl-btl2
13405 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13406 after the two branch
13407 target load optimization passes.
13409 @item -fdump-rtl-bypass
13410 @opindex fdump-rtl-bypass
13411 Dump after jump bypassing and control flow optimizations.
13413 @item -fdump-rtl-combine
13414 @opindex fdump-rtl-combine
13415 Dump after the RTL instruction combination pass.
13417 @item -fdump-rtl-compgotos
13418 @opindex fdump-rtl-compgotos
13419 Dump after duplicating the computed gotos.
13421 @item -fdump-rtl-ce1
13422 @itemx -fdump-rtl-ce2
13423 @itemx -fdump-rtl-ce3
13424 @opindex fdump-rtl-ce1
13425 @opindex fdump-rtl-ce2
13426 @opindex fdump-rtl-ce3
13427 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13428 @option{-fdump-rtl-ce3} enable dumping after the three
13429 if conversion passes.
13431 @item -fdump-rtl-cprop_hardreg
13432 @opindex fdump-rtl-cprop_hardreg
13433 Dump after hard register copy propagation.
13435 @item -fdump-rtl-csa
13436 @opindex fdump-rtl-csa
13437 Dump after combining stack adjustments.
13439 @item -fdump-rtl-cse1
13440 @itemx -fdump-rtl-cse2
13441 @opindex fdump-rtl-cse1
13442 @opindex fdump-rtl-cse2
13443 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13444 the two common subexpression elimination passes.
13446 @item -fdump-rtl-dce
13447 @opindex fdump-rtl-dce
13448 Dump after the standalone dead code elimination passes.
13450 @item -fdump-rtl-dbr
13451 @opindex fdump-rtl-dbr
13452 Dump after delayed branch scheduling.
13454 @item -fdump-rtl-dce1
13455 @itemx -fdump-rtl-dce2
13456 @opindex fdump-rtl-dce1
13457 @opindex fdump-rtl-dce2
13458 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13459 the two dead store elimination passes.
13461 @item -fdump-rtl-eh
13462 @opindex fdump-rtl-eh
13463 Dump after finalization of EH handling code.
13465 @item -fdump-rtl-eh_ranges
13466 @opindex fdump-rtl-eh_ranges
13467 Dump after conversion of EH handling range regions.
13469 @item -fdump-rtl-expand
13470 @opindex fdump-rtl-expand
13471 Dump after RTL generation.
13473 @item -fdump-rtl-fwprop1
13474 @itemx -fdump-rtl-fwprop2
13475 @opindex fdump-rtl-fwprop1
13476 @opindex fdump-rtl-fwprop2
13477 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13478 dumping after the two forward propagation passes.
13480 @item -fdump-rtl-gcse1
13481 @itemx -fdump-rtl-gcse2
13482 @opindex fdump-rtl-gcse1
13483 @opindex fdump-rtl-gcse2
13484 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13485 after global common subexpression elimination.
13487 @item -fdump-rtl-init-regs
13488 @opindex fdump-rtl-init-regs
13489 Dump after the initialization of the registers.
13491 @item -fdump-rtl-initvals
13492 @opindex fdump-rtl-initvals
13493 Dump after the computation of the initial value sets.
13495 @item -fdump-rtl-into_cfglayout
13496 @opindex fdump-rtl-into_cfglayout
13497 Dump after converting to cfglayout mode.
13499 @item -fdump-rtl-ira
13500 @opindex fdump-rtl-ira
13501 Dump after iterated register allocation.
13503 @item -fdump-rtl-jump
13504 @opindex fdump-rtl-jump
13505 Dump after the second jump optimization.
13507 @item -fdump-rtl-loop2
13508 @opindex fdump-rtl-loop2
13509 @option{-fdump-rtl-loop2} enables dumping after the rtl
13510 loop optimization passes.
13512 @item -fdump-rtl-mach
13513 @opindex fdump-rtl-mach
13514 Dump after performing the machine dependent reorganization pass, if that
13515 pass exists.
13517 @item -fdump-rtl-mode_sw
13518 @opindex fdump-rtl-mode_sw
13519 Dump after removing redundant mode switches.
13521 @item -fdump-rtl-rnreg
13522 @opindex fdump-rtl-rnreg
13523 Dump after register renumbering.
13525 @item -fdump-rtl-outof_cfglayout
13526 @opindex fdump-rtl-outof_cfglayout
13527 Dump after converting from cfglayout mode.
13529 @item -fdump-rtl-peephole2
13530 @opindex fdump-rtl-peephole2
13531 Dump after the peephole pass.
13533 @item -fdump-rtl-postreload
13534 @opindex fdump-rtl-postreload
13535 Dump after post-reload optimizations.
13537 @item -fdump-rtl-pro_and_epilogue
13538 @opindex fdump-rtl-pro_and_epilogue
13539 Dump after generating the function prologues and epilogues.
13541 @item -fdump-rtl-sched1
13542 @itemx -fdump-rtl-sched2
13543 @opindex fdump-rtl-sched1
13544 @opindex fdump-rtl-sched2
13545 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13546 after the basic block scheduling passes.
13548 @item -fdump-rtl-ree
13549 @opindex fdump-rtl-ree
13550 Dump after sign/zero extension elimination.
13552 @item -fdump-rtl-seqabstr
13553 @opindex fdump-rtl-seqabstr
13554 Dump after common sequence discovery.
13556 @item -fdump-rtl-shorten
13557 @opindex fdump-rtl-shorten
13558 Dump after shortening branches.
13560 @item -fdump-rtl-sibling
13561 @opindex fdump-rtl-sibling
13562 Dump after sibling call optimizations.
13564 @item -fdump-rtl-split1
13565 @itemx -fdump-rtl-split2
13566 @itemx -fdump-rtl-split3
13567 @itemx -fdump-rtl-split4
13568 @itemx -fdump-rtl-split5
13569 @opindex fdump-rtl-split1
13570 @opindex fdump-rtl-split2
13571 @opindex fdump-rtl-split3
13572 @opindex fdump-rtl-split4
13573 @opindex fdump-rtl-split5
13574 These options enable dumping after five rounds of
13575 instruction splitting.
13577 @item -fdump-rtl-sms
13578 @opindex fdump-rtl-sms
13579 Dump after modulo scheduling.  This pass is only run on some
13580 architectures.
13582 @item -fdump-rtl-stack
13583 @opindex fdump-rtl-stack
13584 Dump after conversion from GCC's ``flat register file'' registers to the
13585 x87's stack-like registers.  This pass is only run on x86 variants.
13587 @item -fdump-rtl-subreg1
13588 @itemx -fdump-rtl-subreg2
13589 @opindex fdump-rtl-subreg1
13590 @opindex fdump-rtl-subreg2
13591 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13592 the two subreg expansion passes.
13594 @item -fdump-rtl-unshare
13595 @opindex fdump-rtl-unshare
13596 Dump after all rtl has been unshared.
13598 @item -fdump-rtl-vartrack
13599 @opindex fdump-rtl-vartrack
13600 Dump after variable tracking.
13602 @item -fdump-rtl-vregs
13603 @opindex fdump-rtl-vregs
13604 Dump after converting virtual registers to hard registers.
13606 @item -fdump-rtl-web
13607 @opindex fdump-rtl-web
13608 Dump after live range splitting.
13610 @item -fdump-rtl-regclass
13611 @itemx -fdump-rtl-subregs_of_mode_init
13612 @itemx -fdump-rtl-subregs_of_mode_finish
13613 @itemx -fdump-rtl-dfinit
13614 @itemx -fdump-rtl-dfinish
13615 @opindex fdump-rtl-regclass
13616 @opindex fdump-rtl-subregs_of_mode_init
13617 @opindex fdump-rtl-subregs_of_mode_finish
13618 @opindex fdump-rtl-dfinit
13619 @opindex fdump-rtl-dfinish
13620 These dumps are defined but always produce empty files.
13622 @item -da
13623 @itemx -fdump-rtl-all
13624 @opindex da
13625 @opindex fdump-rtl-all
13626 Produce all the dumps listed above.
13628 @item -dA
13629 @opindex dA
13630 Annotate the assembler output with miscellaneous debugging information.
13632 @item -dD
13633 @opindex dD
13634 Dump all macro definitions, at the end of preprocessing, in addition to
13635 normal output.
13637 @item -dH
13638 @opindex dH
13639 Produce a core dump whenever an error occurs.
13641 @item -dp
13642 @opindex dp
13643 Annotate the assembler output with a comment indicating which
13644 pattern and alternative is used.  The length and cost of each instruction are
13645 also printed.
13647 @item -dP
13648 @opindex dP
13649 Dump the RTL in the assembler output as a comment before each instruction.
13650 Also turns on @option{-dp} annotation.
13652 @item -dx
13653 @opindex dx
13654 Just generate RTL for a function instead of compiling it.  Usually used
13655 with @option{-fdump-rtl-expand}.
13656 @end table
13658 @item -fdump-noaddr
13659 @opindex fdump-noaddr
13660 When doing debugging dumps, suppress address output.  This makes it more
13661 feasible to use diff on debugging dumps for compiler invocations with
13662 different compiler binaries and/or different
13663 text / bss / data / heap / stack / dso start locations.
13665 @item -freport-bug
13666 @opindex freport-bug
13667 Collect and dump debug information into a temporary file if an
13668 internal compiler error (ICE) occurs.
13670 @item -fdump-unnumbered
13671 @opindex fdump-unnumbered
13672 When doing debugging dumps, suppress instruction numbers and address output.
13673 This makes it more feasible to use diff on debugging dumps for compiler
13674 invocations with different options, in particular with and without
13675 @option{-g}.
13677 @item -fdump-unnumbered-links
13678 @opindex fdump-unnumbered-links
13679 When doing debugging dumps (see @option{-d} option above), suppress
13680 instruction numbers for the links to the previous and next instructions
13681 in a sequence.
13683 @item -fdump-ipa-@var{switch}
13684 @opindex fdump-ipa
13685 Control the dumping at various stages of inter-procedural analysis
13686 language tree to a file.  The file name is generated by appending a
13687 switch specific suffix to the source file name, and the file is created
13688 in the same directory as the output file.  The following dumps are
13689 possible:
13691 @table @samp
13692 @item all
13693 Enables all inter-procedural analysis dumps.
13695 @item cgraph
13696 Dumps information about call-graph optimization, unused function removal,
13697 and inlining decisions.
13699 @item inline
13700 Dump after function inlining.
13702 @end table
13704 @item -fdump-lang-all
13705 @itemx -fdump-lang-@var{switch}
13706 @itemx -fdump-lang-@var{switch}-@var{options}
13707 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13708 @opindex fdump-lang-all
13709 @opindex fdump-lang
13710 Control the dumping of language-specific information.  The @var{options}
13711 and @var{filename} portions behave as described in the
13712 @option{-fdump-tree} option.  The following @var{switch} values are
13713 accepted:
13715 @table @samp
13716 @item all
13718 Enable all language-specific dumps.
13720 @item class
13721 Dump class hierarchy information.  Virtual table information is emitted
13722 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13724 @item raw
13725 Dump the raw internal tree data.  This option is applicable to C++ only.
13727 @end table
13729 @item -fdump-passes
13730 @opindex fdump-passes
13731 Print on @file{stderr} the list of optimization passes that are turned
13732 on and off by the current command-line options.
13734 @item -fdump-statistics-@var{option}
13735 @opindex fdump-statistics
13736 Enable and control dumping of pass statistics in a separate file.  The
13737 file name is generated by appending a suffix ending in
13738 @samp{.statistics} to the source file name, and the file is created in
13739 the same directory as the output file.  If the @samp{-@var{option}}
13740 form is used, @samp{-stats} causes counters to be summed over the
13741 whole compilation unit while @samp{-details} dumps every event as
13742 the passes generate them.  The default with no option is to sum
13743 counters for each function compiled.
13745 @item -fdump-tree-all
13746 @itemx -fdump-tree-@var{switch}
13747 @itemx -fdump-tree-@var{switch}-@var{options}
13748 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13749 @opindex fdump-tree-all
13750 @opindex fdump-tree
13751 Control the dumping at various stages of processing the intermediate
13752 language tree to a file.  The file name is generated by appending a
13753 switch-specific suffix to the source file name, and the file is
13754 created in the same directory as the output file. In case of
13755 @option{=@var{filename}} option, the dump is output on the given file
13756 instead of the auto named dump files.  If the @samp{-@var{options}}
13757 form is used, @var{options} is a list of @samp{-} separated options
13758 which control the details of the dump.  Not all options are applicable
13759 to all dumps; those that are not meaningful are ignored.  The
13760 following options are available
13762 @table @samp
13763 @item address
13764 Print the address of each node.  Usually this is not meaningful as it
13765 changes according to the environment and source file.  Its primary use
13766 is for tying up a dump file with a debug environment.
13767 @item asmname
13768 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13769 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13770 use working backward from mangled names in the assembly file.
13771 @item slim
13772 When dumping front-end intermediate representations, inhibit dumping
13773 of members of a scope or body of a function merely because that scope
13774 has been reached.  Only dump such items when they are directly reachable
13775 by some other path.
13777 When dumping pretty-printed trees, this option inhibits dumping the
13778 bodies of control structures.
13780 When dumping RTL, print the RTL in slim (condensed) form instead of
13781 the default LISP-like representation.
13782 @item raw
13783 Print a raw representation of the tree.  By default, trees are
13784 pretty-printed into a C-like representation.
13785 @item details
13786 Enable more detailed dumps (not honored by every dump option). Also
13787 include information from the optimization passes.
13788 @item stats
13789 Enable dumping various statistics about the pass (not honored by every dump
13790 option).
13791 @item blocks
13792 Enable showing basic block boundaries (disabled in raw dumps).
13793 @item graph
13794 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13795 dump a representation of the control flow graph suitable for viewing with
13796 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13797 the file is pretty-printed as a subgraph, so that GraphViz can render them
13798 all in a single plot.
13800 This option currently only works for RTL dumps, and the RTL is always
13801 dumped in slim form.
13802 @item vops
13803 Enable showing virtual operands for every statement.
13804 @item lineno
13805 Enable showing line numbers for statements.
13806 @item uid
13807 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13808 @item verbose
13809 Enable showing the tree dump for each statement.
13810 @item eh
13811 Enable showing the EH region number holding each statement.
13812 @item scev
13813 Enable showing scalar evolution analysis details.
13814 @item optimized
13815 Enable showing optimization information (only available in certain
13816 passes).
13817 @item missed
13818 Enable showing missed optimization information (only available in certain
13819 passes).
13820 @item note
13821 Enable other detailed optimization information (only available in
13822 certain passes).
13823 @item =@var{filename}
13824 Instead of an auto named dump file, output into the given file
13825 name. The file names @file{stdout} and @file{stderr} are treated
13826 specially and are considered already open standard streams. For
13827 example,
13829 @smallexample
13830 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13831      -fdump-tree-pre=/dev/stderr file.c
13832 @end smallexample
13834 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13835 output on to @file{stderr}. If two conflicting dump filenames are
13836 given for the same pass, then the latter option overrides the earlier
13837 one.
13839 @item all
13840 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13841 and @option{lineno}.
13843 @item optall
13844 Turn on all optimization options, i.e., @option{optimized},
13845 @option{missed}, and @option{note}.
13846 @end table
13848 To determine what tree dumps are available or find the dump for a pass
13849 of interest follow the steps below.
13851 @enumerate
13852 @item
13853 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13854 look for a code that corresponds to the pass you are interested in.
13855 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13856 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13857 The number at the end distinguishes distinct invocations of the same pass.
13858 @item
13859 To enable the creation of the dump file, append the pass code to
13860 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13861 to enable the dump from the Early Value Range Propagation pass, invoke
13862 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13863 specify the name of the dump file.  If you don't specify one, GCC
13864 creates as described below.
13865 @item
13866 Find the pass dump in a file whose name is composed of three components
13867 separated by a period: the name of the source file GCC was invoked to
13868 compile, a numeric suffix indicating the pass number followed by the
13869 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13870 and finally the pass code.  For example, the Early VRP pass dump might
13871 be in a file named @file{myfile.c.038t.evrp} in the current working
13872 directory.  Note that the numeric codes are not stable and may change
13873 from one version of GCC to another.
13874 @end enumerate
13876 @item -fopt-info
13877 @itemx -fopt-info-@var{options}
13878 @itemx -fopt-info-@var{options}=@var{filename}
13879 @opindex fopt-info
13880 Controls optimization dumps from various optimization passes. If the
13881 @samp{-@var{options}} form is used, @var{options} is a list of
13882 @samp{-} separated option keywords to select the dump details and
13883 optimizations.  
13885 The @var{options} can be divided into two groups: options describing the
13886 verbosity of the dump, and options describing which optimizations
13887 should be included. The options from both the groups can be freely
13888 mixed as they are non-overlapping. However, in case of any conflicts,
13889 the later options override the earlier options on the command
13890 line. 
13892 The following options control the dump verbosity:
13894 @table @samp
13895 @item optimized
13896 Print information when an optimization is successfully applied. It is
13897 up to a pass to decide which information is relevant. For example, the
13898 vectorizer passes print the source location of loops which are
13899 successfully vectorized.
13900 @item missed
13901 Print information about missed optimizations. Individual passes
13902 control which information to include in the output. 
13903 @item note
13904 Print verbose information about optimizations, such as certain
13905 transformations, more detailed messages about decisions etc.
13906 @item all
13907 Print detailed optimization information. This includes
13908 @samp{optimized}, @samp{missed}, and @samp{note}.
13909 @end table
13911 One or more of the following option keywords can be used to describe a
13912 group of optimizations:
13914 @table @samp
13915 @item ipa
13916 Enable dumps from all interprocedural optimizations.
13917 @item loop
13918 Enable dumps from all loop optimizations.
13919 @item inline
13920 Enable dumps from all inlining optimizations.
13921 @item omp
13922 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13923 @item vec
13924 Enable dumps from all vectorization optimizations.
13925 @item optall
13926 Enable dumps from all optimizations. This is a superset of
13927 the optimization groups listed above.
13928 @end table
13930 If @var{options} is
13931 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13932 info about successful optimizations from all the passes.  
13934 If the @var{filename} is provided, then the dumps from all the
13935 applicable optimizations are concatenated into the @var{filename}.
13936 Otherwise the dump is output onto @file{stderr}. Though multiple
13937 @option{-fopt-info} options are accepted, only one of them can include
13938 a @var{filename}. If other filenames are provided then all but the
13939 first such option are ignored.
13941 Note that the output @var{filename} is overwritten
13942 in case of multiple translation units. If a combined output from
13943 multiple translation units is desired, @file{stderr} should be used
13944 instead.
13946 In the following example, the optimization info is output to
13947 @file{stderr}:
13949 @smallexample
13950 gcc -O3 -fopt-info
13951 @end smallexample
13953 This example:
13954 @smallexample
13955 gcc -O3 -fopt-info-missed=missed.all
13956 @end smallexample
13958 @noindent
13959 outputs missed optimization report from all the passes into
13960 @file{missed.all}, and this one:
13962 @smallexample
13963 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13964 @end smallexample
13966 @noindent
13967 prints information about missed optimization opportunities from
13968 vectorization passes on @file{stderr}.  
13969 Note that @option{-fopt-info-vec-missed} is equivalent to 
13970 @option{-fopt-info-missed-vec}.  The order of the optimization group
13971 names and message types listed after @option{-fopt-info} does not matter.
13973 As another example,
13974 @smallexample
13975 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13976 @end smallexample
13978 @noindent
13979 outputs information about missed optimizations as well as
13980 optimized locations from all the inlining passes into
13981 @file{inline.txt}.
13983 Finally, consider:
13985 @smallexample
13986 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13987 @end smallexample
13989 @noindent
13990 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13991 in conflict since only one output file is allowed. In this case, only
13992 the first option takes effect and the subsequent options are
13993 ignored. Thus only @file{vec.miss} is produced which contains
13994 dumps from the vectorizer about missed opportunities.
13996 @item -fsched-verbose=@var{n}
13997 @opindex fsched-verbose
13998 On targets that use instruction scheduling, this option controls the
13999 amount of debugging output the scheduler prints to the dump files.
14001 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14002 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14003 For @var{n} greater than one, it also output basic block probabilities,
14004 detailed ready list information and unit/insn info.  For @var{n} greater
14005 than two, it includes RTL at abort point, control-flow and regions info.
14006 And for @var{n} over four, @option{-fsched-verbose} also includes
14007 dependence info.
14011 @item -fenable-@var{kind}-@var{pass}
14012 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14013 @opindex fdisable-
14014 @opindex fenable-
14016 This is a set of options that are used to explicitly disable/enable
14017 optimization passes.  These options are intended for use for debugging GCC.
14018 Compiler users should use regular options for enabling/disabling
14019 passes instead.
14021 @table @gcctabopt
14023 @item -fdisable-ipa-@var{pass}
14024 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14025 statically invoked in the compiler multiple times, the pass name should be
14026 appended with a sequential number starting from 1.
14028 @item -fdisable-rtl-@var{pass}
14029 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14030 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14031 statically invoked in the compiler multiple times, the pass name should be
14032 appended with a sequential number starting from 1.  @var{range-list} is a 
14033 comma-separated list of function ranges or assembler names.  Each range is a number
14034 pair separated by a colon.  The range is inclusive in both ends.  If the range
14035 is trivial, the number pair can be simplified as a single number.  If the
14036 function's call graph node's @var{uid} falls within one of the specified ranges,
14037 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14038 function header of a dump file, and the pass names can be dumped by using
14039 option @option{-fdump-passes}.
14041 @item -fdisable-tree-@var{pass}
14042 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14043 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14044 option arguments.
14046 @item -fenable-ipa-@var{pass}
14047 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14048 statically invoked in the compiler multiple times, the pass name should be
14049 appended with a sequential number starting from 1.
14051 @item -fenable-rtl-@var{pass}
14052 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14053 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14054 description and examples.
14056 @item -fenable-tree-@var{pass}
14057 @itemx -fenable-tree-@var{pass}=@var{range-list}
14058 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14059 of option arguments.
14061 @end table
14063 Here are some examples showing uses of these options.
14065 @smallexample
14067 # disable ccp1 for all functions
14068    -fdisable-tree-ccp1
14069 # disable complete unroll for function whose cgraph node uid is 1
14070    -fenable-tree-cunroll=1
14071 # disable gcse2 for functions at the following ranges [1,1],
14072 # [300,400], and [400,1000]
14073 # disable gcse2 for functions foo and foo2
14074    -fdisable-rtl-gcse2=foo,foo2
14075 # disable early inlining
14076    -fdisable-tree-einline
14077 # disable ipa inlining
14078    -fdisable-ipa-inline
14079 # enable tree full unroll
14080    -fenable-tree-unroll
14082 @end smallexample
14084 @item -fchecking
14085 @itemx -fchecking=@var{n}
14086 @opindex fchecking
14087 @opindex fno-checking
14088 Enable internal consistency checking.  The default depends on
14089 the compiler configuration.  @option{-fchecking=2} enables further
14090 internal consistency checking that might affect code generation.
14092 @item -frandom-seed=@var{string}
14093 @opindex frandom-seed
14094 This option provides a seed that GCC uses in place of
14095 random numbers in generating certain symbol names
14096 that have to be different in every compiled file.  It is also used to
14097 place unique stamps in coverage data files and the object files that
14098 produce them.  You can use the @option{-frandom-seed} option to produce
14099 reproducibly identical object files.
14101 The @var{string} can either be a number (decimal, octal or hex) or an
14102 arbitrary string (in which case it's converted to a number by
14103 computing CRC32).
14105 The @var{string} should be different for every file you compile.
14107 @item -save-temps
14108 @itemx -save-temps=cwd
14109 @opindex save-temps
14110 Store the usual ``temporary'' intermediate files permanently; place them
14111 in the current directory and name them based on the source file.  Thus,
14112 compiling @file{foo.c} with @option{-c -save-temps} produces files
14113 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14114 preprocessed @file{foo.i} output file even though the compiler now
14115 normally uses an integrated preprocessor.
14117 When used in combination with the @option{-x} command-line option,
14118 @option{-save-temps} is sensible enough to avoid over writing an
14119 input source file with the same extension as an intermediate file.
14120 The corresponding intermediate file may be obtained by renaming the
14121 source file before using @option{-save-temps}.
14123 If you invoke GCC in parallel, compiling several different source
14124 files that share a common base name in different subdirectories or the
14125 same source file compiled for multiple output destinations, it is
14126 likely that the different parallel compilers will interfere with each
14127 other, and overwrite the temporary files.  For instance:
14129 @smallexample
14130 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14131 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14132 @end smallexample
14134 may result in @file{foo.i} and @file{foo.o} being written to
14135 simultaneously by both compilers.
14137 @item -save-temps=obj
14138 @opindex save-temps=obj
14139 Store the usual ``temporary'' intermediate files permanently.  If the
14140 @option{-o} option is used, the temporary files are based on the
14141 object file.  If the @option{-o} option is not used, the
14142 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14144 For example:
14146 @smallexample
14147 gcc -save-temps=obj -c foo.c
14148 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14149 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14150 @end smallexample
14152 @noindent
14153 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14154 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14155 @file{dir2/yfoobar.o}.
14157 @item -time@r{[}=@var{file}@r{]}
14158 @opindex time
14159 Report the CPU time taken by each subprocess in the compilation
14160 sequence.  For C source files, this is the compiler proper and assembler
14161 (plus the linker if linking is done).
14163 Without the specification of an output file, the output looks like this:
14165 @smallexample
14166 # cc1 0.12 0.01
14167 # as 0.00 0.01
14168 @end smallexample
14170 The first number on each line is the ``user time'', that is time spent
14171 executing the program itself.  The second number is ``system time'',
14172 time spent executing operating system routines on behalf of the program.
14173 Both numbers are in seconds.
14175 With the specification of an output file, the output is appended to the
14176 named file, and it looks like this:
14178 @smallexample
14179 0.12 0.01 cc1 @var{options}
14180 0.00 0.01 as @var{options}
14181 @end smallexample
14183 The ``user time'' and the ``system time'' are moved before the program
14184 name, and the options passed to the program are displayed, so that one
14185 can later tell what file was being compiled, and with which options.
14187 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14188 @opindex fdump-final-insns
14189 Dump the final internal representation (RTL) to @var{file}.  If the
14190 optional argument is omitted (or if @var{file} is @code{.}), the name
14191 of the dump file is determined by appending @code{.gkd} to the
14192 compilation output file name.
14194 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14195 @opindex fcompare-debug
14196 @opindex fno-compare-debug
14197 If no error occurs during compilation, run the compiler a second time,
14198 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14199 passed to the second compilation.  Dump the final internal
14200 representation in both compilations, and print an error if they differ.
14202 If the equal sign is omitted, the default @option{-gtoggle} is used.
14204 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14205 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14206 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14207 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14208 is used.
14210 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14211 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14212 of the final representation and the second compilation, preventing even
14213 @env{GCC_COMPARE_DEBUG} from taking effect.
14215 To verify full coverage during @option{-fcompare-debug} testing, set
14216 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14217 which GCC rejects as an invalid option in any actual compilation
14218 (rather than preprocessing, assembly or linking).  To get just a
14219 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14220 not overridden} will do.
14222 @item -fcompare-debug-second
14223 @opindex fcompare-debug-second
14224 This option is implicitly passed to the compiler for the second
14225 compilation requested by @option{-fcompare-debug}, along with options to
14226 silence warnings, and omitting other options that would cause
14227 side-effect compiler outputs to files or to the standard output.  Dump
14228 files and preserved temporary files are renamed so as to contain the
14229 @code{.gk} additional extension during the second compilation, to avoid
14230 overwriting those generated by the first.
14232 When this option is passed to the compiler driver, it causes the
14233 @emph{first} compilation to be skipped, which makes it useful for little
14234 other than debugging the compiler proper.
14236 @item -gtoggle
14237 @opindex gtoggle
14238 Turn off generation of debug info, if leaving out this option
14239 generates it, or turn it on at level 2 otherwise.  The position of this
14240 argument in the command line does not matter; it takes effect after all
14241 other options are processed, and it does so only once, no matter how
14242 many times it is given.  This is mainly intended to be used with
14243 @option{-fcompare-debug}.
14245 @item -fvar-tracking-assignments-toggle
14246 @opindex fvar-tracking-assignments-toggle
14247 @opindex fno-var-tracking-assignments-toggle
14248 Toggle @option{-fvar-tracking-assignments}, in the same way that
14249 @option{-gtoggle} toggles @option{-g}.
14251 @item -Q
14252 @opindex Q
14253 Makes the compiler print out each function name as it is compiled, and
14254 print some statistics about each pass when it finishes.
14256 @item -ftime-report
14257 @opindex ftime-report
14258 Makes the compiler print some statistics about the time consumed by each
14259 pass when it finishes.
14261 @item -ftime-report-details
14262 @opindex ftime-report-details
14263 Record the time consumed by infrastructure parts separately for each pass.
14265 @item -fira-verbose=@var{n}
14266 @opindex fira-verbose
14267 Control the verbosity of the dump file for the integrated register allocator.
14268 The default value is 5.  If the value @var{n} is greater or equal to 10,
14269 the dump output is sent to stderr using the same format as @var{n} minus 10.
14271 @item -flto-report
14272 @opindex flto-report
14273 Prints a report with internal details on the workings of the link-time
14274 optimizer.  The contents of this report vary from version to version.
14275 It is meant to be useful to GCC developers when processing object
14276 files in LTO mode (via @option{-flto}).
14278 Disabled by default.
14280 @item -flto-report-wpa
14281 @opindex flto-report-wpa
14282 Like @option{-flto-report}, but only print for the WPA phase of Link
14283 Time Optimization.
14285 @item -fmem-report
14286 @opindex fmem-report
14287 Makes the compiler print some statistics about permanent memory
14288 allocation when it finishes.
14290 @item -fmem-report-wpa
14291 @opindex fmem-report-wpa
14292 Makes the compiler print some statistics about permanent memory
14293 allocation for the WPA phase only.
14295 @item -fpre-ipa-mem-report
14296 @opindex fpre-ipa-mem-report
14297 @item -fpost-ipa-mem-report
14298 @opindex fpost-ipa-mem-report
14299 Makes the compiler print some statistics about permanent memory
14300 allocation before or after interprocedural optimization.
14302 @item -fprofile-report
14303 @opindex fprofile-report
14304 Makes the compiler print some statistics about consistency of the
14305 (estimated) profile and effect of individual passes.
14307 @item -fstack-usage
14308 @opindex fstack-usage
14309 Makes the compiler output stack usage information for the program, on a
14310 per-function basis.  The filename for the dump is made by appending
14311 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14312 the output file, if explicitly specified and it is not an executable,
14313 otherwise it is the basename of the source file.  An entry is made up
14314 of three fields:
14316 @itemize
14317 @item
14318 The name of the function.
14319 @item
14320 A number of bytes.
14321 @item
14322 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14323 @end itemize
14325 The qualifier @code{static} means that the function manipulates the stack
14326 statically: a fixed number of bytes are allocated for the frame on function
14327 entry and released on function exit; no stack adjustments are otherwise made
14328 in the function.  The second field is this fixed number of bytes.
14330 The qualifier @code{dynamic} means that the function manipulates the stack
14331 dynamically: in addition to the static allocation described above, stack
14332 adjustments are made in the body of the function, for example to push/pop
14333 arguments around function calls.  If the qualifier @code{bounded} is also
14334 present, the amount of these adjustments is bounded at compile time and
14335 the second field is an upper bound of the total amount of stack used by
14336 the function.  If it is not present, the amount of these adjustments is
14337 not bounded at compile time and the second field only represents the
14338 bounded part.
14340 @item -fstats
14341 @opindex fstats
14342 Emit statistics about front-end processing at the end of the compilation.
14343 This option is supported only by the C++ front end, and
14344 the information is generally only useful to the G++ development team.
14346 @item -fdbg-cnt-list
14347 @opindex fdbg-cnt-list
14348 Print the name and the counter upper bound for all debug counters.
14351 @item -fdbg-cnt=@var{counter-value-list}
14352 @opindex fdbg-cnt
14353 Set the internal debug counter upper bound.  @var{counter-value-list}
14354 is a comma-separated list of @var{name}:@var{value} pairs
14355 which sets the upper bound of each debug counter @var{name} to @var{value}.
14356 All debug counters have the initial upper bound of @code{UINT_MAX};
14357 thus @code{dbg_cnt} returns true always unless the upper bound
14358 is set by this option.
14359 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14360 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14362 @item -print-file-name=@var{library}
14363 @opindex print-file-name
14364 Print the full absolute name of the library file @var{library} that
14365 would be used when linking---and don't do anything else.  With this
14366 option, GCC does not compile or link anything; it just prints the
14367 file name.
14369 @item -print-multi-directory
14370 @opindex print-multi-directory
14371 Print the directory name corresponding to the multilib selected by any
14372 other switches present in the command line.  This directory is supposed
14373 to exist in @env{GCC_EXEC_PREFIX}.
14375 @item -print-multi-lib
14376 @opindex print-multi-lib
14377 Print the mapping from multilib directory names to compiler switches
14378 that enable them.  The directory name is separated from the switches by
14379 @samp{;}, and each switch starts with an @samp{@@} instead of the
14380 @samp{-}, without spaces between multiple switches.  This is supposed to
14381 ease shell processing.
14383 @item -print-multi-os-directory
14384 @opindex print-multi-os-directory
14385 Print the path to OS libraries for the selected
14386 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14387 present in the @file{lib} subdirectory and no multilibs are used, this is
14388 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14389 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14390 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14391 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14393 @item -print-multiarch
14394 @opindex print-multiarch
14395 Print the path to OS libraries for the selected multiarch,
14396 relative to some @file{lib} subdirectory.
14398 @item -print-prog-name=@var{program}
14399 @opindex print-prog-name
14400 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14402 @item -print-libgcc-file-name
14403 @opindex print-libgcc-file-name
14404 Same as @option{-print-file-name=libgcc.a}.
14406 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14407 but you do want to link with @file{libgcc.a}.  You can do:
14409 @smallexample
14410 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14411 @end smallexample
14413 @item -print-search-dirs
14414 @opindex print-search-dirs
14415 Print the name of the configured installation directory and a list of
14416 program and library directories @command{gcc} searches---and don't do anything else.
14418 This is useful when @command{gcc} prints the error message
14419 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14420 To resolve this you either need to put @file{cpp0} and the other compiler
14421 components where @command{gcc} expects to find them, or you can set the environment
14422 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14423 Don't forget the trailing @samp{/}.
14424 @xref{Environment Variables}.
14426 @item -print-sysroot
14427 @opindex print-sysroot
14428 Print the target sysroot directory that is used during
14429 compilation.  This is the target sysroot specified either at configure
14430 time or using the @option{--sysroot} option, possibly with an extra
14431 suffix that depends on compilation options.  If no target sysroot is
14432 specified, the option prints nothing.
14434 @item -print-sysroot-headers-suffix
14435 @opindex print-sysroot-headers-suffix
14436 Print the suffix added to the target sysroot when searching for
14437 headers, or give an error if the compiler is not configured with such
14438 a suffix---and don't do anything else.
14440 @item -dumpmachine
14441 @opindex dumpmachine
14442 Print the compiler's target machine (for example,
14443 @samp{i686-pc-linux-gnu})---and don't do anything else.
14445 @item -dumpversion
14446 @opindex dumpversion
14447 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14448 anything else.  This is the compiler version used in filesystem paths,
14449 specs, can be depending on how the compiler has been configured just
14450 a single number (major version), two numbers separated by dot (major and
14451 minor version) or three numbers separated by dots (major, minor and patchlevel
14452 version).
14454 @item -dumpfullversion
14455 @opindex dumpfullversion
14456 Print the full compiler version, always 3 numbers separated by dots,
14457 major, minor and patchlevel version.
14459 @item -dumpspecs
14460 @opindex dumpspecs
14461 Print the compiler's built-in specs---and don't do anything else.  (This
14462 is used when GCC itself is being built.)  @xref{Spec Files}.
14463 @end table
14465 @node Submodel Options
14466 @section Machine-Dependent Options
14467 @cindex submodel options
14468 @cindex specifying hardware config
14469 @cindex hardware models and configurations, specifying
14470 @cindex target-dependent options
14471 @cindex machine-dependent options
14473 Each target machine supported by GCC can have its own options---for
14474 example, to allow you to compile for a particular processor variant or
14475 ABI, or to control optimizations specific to that machine.  By
14476 convention, the names of machine-specific options start with
14477 @samp{-m}.
14479 Some configurations of the compiler also support additional target-specific
14480 options, usually for compatibility with other compilers on the same
14481 platform.
14483 @c This list is ordered alphanumerically by subsection name.
14484 @c It should be the same order and spelling as these options are listed
14485 @c in Machine Dependent Options
14487 @menu
14488 * AArch64 Options::
14489 * Adapteva Epiphany Options::
14490 * ARC Options::
14491 * ARM Options::
14492 * AVR Options::
14493 * Blackfin Options::
14494 * C6X Options::
14495 * CRIS Options::
14496 * CR16 Options::
14497 * Darwin Options::
14498 * DEC Alpha Options::
14499 * FR30 Options::
14500 * FT32 Options::
14501 * FRV Options::
14502 * GNU/Linux Options::
14503 * H8/300 Options::
14504 * HPPA Options::
14505 * IA-64 Options::
14506 * LM32 Options::
14507 * M32C Options::
14508 * M32R/D Options::
14509 * M680x0 Options::
14510 * MCore Options::
14511 * MeP Options::
14512 * MicroBlaze Options::
14513 * MIPS Options::
14514 * MMIX Options::
14515 * MN10300 Options::
14516 * Moxie Options::
14517 * MSP430 Options::
14518 * NDS32 Options::
14519 * Nios II Options::
14520 * Nvidia PTX Options::
14521 * PDP-11 Options::
14522 * picoChip Options::
14523 * PowerPC Options::
14524 * PowerPC SPE Options::
14525 * RISC-V Options::
14526 * RL78 Options::
14527 * RS/6000 and PowerPC Options::
14528 * RX Options::
14529 * S/390 and zSeries Options::
14530 * Score Options::
14531 * SH Options::
14532 * Solaris 2 Options::
14533 * SPARC Options::
14534 * SPU Options::
14535 * System V Options::
14536 * TILE-Gx Options::
14537 * TILEPro Options::
14538 * V850 Options::
14539 * VAX Options::
14540 * Visium Options::
14541 * VMS Options::
14542 * VxWorks Options::
14543 * x86 Options::
14544 * x86 Windows Options::
14545 * Xstormy16 Options::
14546 * Xtensa Options::
14547 * zSeries Options::
14548 @end menu
14550 @node AArch64 Options
14551 @subsection AArch64 Options
14552 @cindex AArch64 Options
14554 These options are defined for AArch64 implementations:
14556 @table @gcctabopt
14558 @item -mabi=@var{name}
14559 @opindex mabi
14560 Generate code for the specified data model.  Permissible values
14561 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14562 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14563 but long int and pointers are 64 bits.
14565 The default depends on the specific target configuration.  Note that
14566 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14567 entire program with the same ABI, and link with a compatible set of libraries.
14569 @item -mbig-endian
14570 @opindex mbig-endian
14571 Generate big-endian code.  This is the default when GCC is configured for an
14572 @samp{aarch64_be-*-*} target.
14574 @item -mgeneral-regs-only
14575 @opindex mgeneral-regs-only
14576 Generate code which uses only the general-purpose registers.  This will prevent
14577 the compiler from using floating-point and Advanced SIMD registers but will not
14578 impose any restrictions on the assembler.
14580 @item -mlittle-endian
14581 @opindex mlittle-endian
14582 Generate little-endian code.  This is the default when GCC is configured for an
14583 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14585 @item -mcmodel=tiny
14586 @opindex mcmodel=tiny
14587 Generate code for the tiny code model.  The program and its statically defined
14588 symbols must be within 1MB of each other.  Programs can be statically or
14589 dynamically linked.
14591 @item -mcmodel=small
14592 @opindex mcmodel=small
14593 Generate code for the small code model.  The program and its statically defined
14594 symbols must be within 4GB of each other.  Programs can be statically or
14595 dynamically linked.  This is the default code model.
14597 @item -mcmodel=large
14598 @opindex mcmodel=large
14599 Generate code for the large code model.  This makes no assumptions about
14600 addresses and sizes of sections.  Programs can be statically linked only.
14602 @item -mstrict-align
14603 @opindex mstrict-align
14604 Avoid generating memory accesses that may not be aligned on a natural object
14605 boundary as described in the architecture specification.
14607 @item -momit-leaf-frame-pointer
14608 @itemx -mno-omit-leaf-frame-pointer
14609 @opindex momit-leaf-frame-pointer
14610 @opindex mno-omit-leaf-frame-pointer
14611 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14612 default.
14614 @item -mtls-dialect=desc
14615 @opindex mtls-dialect=desc
14616 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14617 of TLS variables.  This is the default.
14619 @item -mtls-dialect=traditional
14620 @opindex mtls-dialect=traditional
14621 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14622 of TLS variables.
14624 @item -mtls-size=@var{size}
14625 @opindex mtls-size
14626 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14627 This option requires binutils 2.26 or newer.
14629 @item -mfix-cortex-a53-835769
14630 @itemx -mno-fix-cortex-a53-835769
14631 @opindex mfix-cortex-a53-835769
14632 @opindex mno-fix-cortex-a53-835769
14633 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14634 This involves inserting a NOP instruction between memory instructions and
14635 64-bit integer multiply-accumulate instructions.
14637 @item -mfix-cortex-a53-843419
14638 @itemx -mno-fix-cortex-a53-843419
14639 @opindex mfix-cortex-a53-843419
14640 @opindex mno-fix-cortex-a53-843419
14641 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14642 This erratum workaround is made at link time and this will only pass the
14643 corresponding flag to the linker.
14645 @item -mlow-precision-recip-sqrt
14646 @itemx -mno-low-precision-recip-sqrt
14647 @opindex mlow-precision-recip-sqrt
14648 @opindex mno-low-precision-recip-sqrt
14649 Enable or disable the reciprocal square root approximation.
14650 This option only has an effect if @option{-ffast-math} or
14651 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14652 precision of reciprocal square root results to about 16 bits for
14653 single precision and to 32 bits for double precision.
14655 @item -mlow-precision-sqrt
14656 @itemx -mno-low-precision-sqrt
14657 @opindex -mlow-precision-sqrt
14658 @opindex -mno-low-precision-sqrt
14659 Enable or disable the square root approximation.
14660 This option only has an effect if @option{-ffast-math} or
14661 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14662 precision of square root results to about 16 bits for
14663 single precision and to 32 bits for double precision.
14664 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14666 @item -mlow-precision-div
14667 @itemx -mno-low-precision-div
14668 @opindex -mlow-precision-div
14669 @opindex -mno-low-precision-div
14670 Enable or disable the division approximation.
14671 This option only has an effect if @option{-ffast-math} or
14672 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14673 precision of division results to about 16 bits for
14674 single precision and to 32 bits for double precision.
14676 @item -march=@var{name}
14677 @opindex march
14678 Specify the name of the target architecture and, optionally, one or
14679 more feature modifiers.  This option has the form
14680 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14682 The permissible values for @var{arch} are @samp{armv8-a},
14683 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14684 or @var{native}.
14686 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14687 support for the ARMv8.4-A architecture extensions.
14689 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14690 support for the ARMv8.3-A architecture extensions.
14692 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14693 support for the ARMv8.2-A architecture extensions.
14695 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14696 support for the ARMv8.1-A architecture extension.  In particular, it
14697 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14699 The value @samp{native} is available on native AArch64 GNU/Linux and
14700 causes the compiler to pick the architecture of the host system.  This
14701 option has no effect if the compiler is unable to recognize the
14702 architecture of the host system,
14704 The permissible values for @var{feature} are listed in the sub-section
14705 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14706 Feature Modifiers}.  Where conflicting feature modifiers are
14707 specified, the right-most feature is used.
14709 GCC uses @var{name} to determine what kind of instructions it can emit
14710 when generating assembly code.  If @option{-march} is specified
14711 without either of @option{-mtune} or @option{-mcpu} also being
14712 specified, the code is tuned to perform well across a range of target
14713 processors implementing the target architecture.
14715 @item -mtune=@var{name}
14716 @opindex mtune
14717 Specify the name of the target processor for which GCC should tune the
14718 performance of the code.  Permissible values for this option are:
14719 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14720 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14721 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14722 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14723 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14724 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14725 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14726 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14727 @samp{native}.
14729 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14730 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14731 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14732 big.LITTLE system.
14734 Additionally on native AArch64 GNU/Linux systems the value
14735 @samp{native} tunes performance to the host system.  This option has no effect
14736 if the compiler is unable to recognize the processor of the host system.
14738 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14739 are specified, the code is tuned to perform well across a range
14740 of target processors.
14742 This option cannot be suffixed by feature modifiers.
14744 @item -mcpu=@var{name}
14745 @opindex mcpu
14746 Specify the name of the target processor, optionally suffixed by one
14747 or more feature modifiers.  This option has the form
14748 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14749 the permissible values for @var{cpu} are the same as those available
14750 for @option{-mtune}.  The permissible values for @var{feature} are
14751 documented in the sub-section on
14752 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14753 Feature Modifiers}.  Where conflicting feature modifiers are
14754 specified, the right-most feature is used.
14756 GCC uses @var{name} to determine what kind of instructions it can emit when
14757 generating assembly code (as if by @option{-march}) and to determine
14758 the target processor for which to tune for performance (as if
14759 by @option{-mtune}).  Where this option is used in conjunction
14760 with @option{-march} or @option{-mtune}, those options take precedence
14761 over the appropriate part of this option.
14763 @item -moverride=@var{string}
14764 @opindex moverride
14765 Override tuning decisions made by the back-end in response to a
14766 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14767 for @var{string} in this option are not guaranteed to be consistent
14768 across releases.
14770 This option is only intended to be useful when developing GCC.
14772 @item -mverbose-cost-dump
14773 @opindex mverbose-cost-dump
14774 Enable verbose cost model dumping in the debug dump files.  This option is
14775 provided for use in debugging the compiler.
14777 @item -mpc-relative-literal-loads
14778 @itemx -mno-pc-relative-literal-loads
14779 @opindex mpc-relative-literal-loads
14780 @opindex mno-pc-relative-literal-loads
14781 Enable or disable PC-relative literal loads.  With this option literal pools are
14782 accessed using a single instruction and emitted after each function.  This
14783 limits the maximum size of functions to 1MB.  This is enabled by default for
14784 @option{-mcmodel=tiny}.
14786 @item -msign-return-address=@var{scope}
14787 @opindex msign-return-address
14788 Select the function scope on which return address signing will be applied.
14789 Permissible values are @samp{none}, which disables return address signing,
14790 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14791 functions, and @samp{all}, which enables pointer signing for all functions.  The
14792 default value is @samp{none}.
14794 @item -msve-vector-bits=@var{bits}
14795 @opindex msve-vector-bits
14796 Specify the number of bits in an SVE vector register.  This option only has
14797 an effect when SVE is enabled.
14799 GCC supports two forms of SVE code generation: ``vector-length
14800 agnostic'' output that works with any size of vector register and
14801 ``vector-length specific'' output that only works when the vector
14802 registers are a particular size.  Replacing @var{bits} with
14803 @samp{scalable} selects vector-length agnostic output while
14804 replacing it with a number selects vector-length specific output.
14805 The possible lengths in the latter case are: 128, 256, 512, 1024
14806 and 2048.  @samp{scalable} is the default.
14808 At present, @samp{-msve-vector-bits=128} produces the same output
14809 as @samp{-msve-vector-bits=scalable}.
14811 @end table
14813 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14814 @anchor{aarch64-feature-modifiers}
14815 @cindex @option{-march} feature modifiers
14816 @cindex @option{-mcpu} feature modifiers
14817 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14818 the following and their inverses @option{no@var{feature}}:
14820 @table @samp
14821 @item crc
14822 Enable CRC extension.  This is on by default for
14823 @option{-march=armv8.1-a}.
14824 @item crypto
14825 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14826 instructions.
14827 @item fp
14828 Enable floating-point instructions.  This is on by default for all possible
14829 values for options @option{-march} and @option{-mcpu}.
14830 @item simd
14831 Enable Advanced SIMD instructions.  This also enables floating-point
14832 instructions.  This is on by default for all possible values for options
14833 @option{-march} and @option{-mcpu}.
14834 @item sve
14835 Enable Scalable Vector Extension instructions.  This also enables Advanced
14836 SIMD and floating-point instructions.
14837 @item lse
14838 Enable Large System Extension instructions.  This is on by default for
14839 @option{-march=armv8.1-a}.
14840 @item rdma
14841 Enable Round Double Multiply Accumulate instructions.  This is on by default
14842 for @option{-march=armv8.1-a}.
14843 @item fp16
14844 Enable FP16 extension.  This also enables floating-point instructions.
14845 @item fp16fml
14846 Enable FP16 fmla extension.  This also enables FP16 extensions and
14847 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.
14849 @item rcpc
14850 Enable the RcPc extension.  This does not change code generation from GCC,
14851 but is passed on to the assembler, enabling inline asm statements to use
14852 instructions from the RcPc extension.
14853 @item dotprod
14854 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14855 @item aes
14856 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14857 SIMD instructions.
14858 @item sha2
14859 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14860 @item sha3
14861 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14862 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14863 @item sm4
14864 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14865 Use of this option with architectures prior to Armv8.2-A is not supported.
14867 @end table
14869 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14870 which implies @option{fp}.
14871 Conversely, @option{nofp} implies @option{nosimd}, which implies
14872 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14874 @node Adapteva Epiphany Options
14875 @subsection Adapteva Epiphany Options
14877 These @samp{-m} options are defined for Adapteva Epiphany:
14879 @table @gcctabopt
14880 @item -mhalf-reg-file
14881 @opindex mhalf-reg-file
14882 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14883 That allows code to run on hardware variants that lack these registers.
14885 @item -mprefer-short-insn-regs
14886 @opindex mprefer-short-insn-regs
14887 Preferentially allocate registers that allow short instruction generation.
14888 This can result in increased instruction count, so this may either reduce or
14889 increase overall code size.
14891 @item -mbranch-cost=@var{num}
14892 @opindex mbranch-cost
14893 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14894 This cost is only a heuristic and is not guaranteed to produce
14895 consistent results across releases.
14897 @item -mcmove
14898 @opindex mcmove
14899 Enable the generation of conditional moves.
14901 @item -mnops=@var{num}
14902 @opindex mnops
14903 Emit @var{num} NOPs before every other generated instruction.
14905 @item -mno-soft-cmpsf
14906 @opindex mno-soft-cmpsf
14907 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14908 and test the flags.  This is faster than a software comparison, but can
14909 get incorrect results in the presence of NaNs, or when two different small
14910 numbers are compared such that their difference is calculated as zero.
14911 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14912 software comparisons.
14914 @item -mstack-offset=@var{num}
14915 @opindex mstack-offset
14916 Set the offset between the top of the stack and the stack pointer.
14917 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14918 can be used by leaf functions without stack allocation.
14919 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14920 Note also that this option changes the ABI; compiling a program with a
14921 different stack offset than the libraries have been compiled with
14922 generally does not work.
14923 This option can be useful if you want to evaluate if a different stack
14924 offset would give you better code, but to actually use a different stack
14925 offset to build working programs, it is recommended to configure the
14926 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14928 @item -mno-round-nearest
14929 @opindex mno-round-nearest
14930 Make the scheduler assume that the rounding mode has been set to
14931 truncating.  The default is @option{-mround-nearest}.
14933 @item -mlong-calls
14934 @opindex mlong-calls
14935 If not otherwise specified by an attribute, assume all calls might be beyond
14936 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14937 function address into a register before performing a (otherwise direct) call.
14938 This is the default.
14940 @item -mshort-calls
14941 @opindex short-calls
14942 If not otherwise specified by an attribute, assume all direct calls are
14943 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14944 for direct calls.  The default is @option{-mlong-calls}.
14946 @item -msmall16
14947 @opindex msmall16
14948 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14949 apply to function addresses for which @option{-mlong-calls} semantics
14950 are in effect.
14952 @item -mfp-mode=@var{mode}
14953 @opindex mfp-mode
14954 Set the prevailing mode of the floating-point unit.
14955 This determines the floating-point mode that is provided and expected
14956 at function call and return time.  Making this mode match the mode you
14957 predominantly need at function start can make your programs smaller and
14958 faster by avoiding unnecessary mode switches.
14960 @var{mode} can be set to one the following values:
14962 @table @samp
14963 @item caller
14964 Any mode at function entry is valid, and retained or restored when
14965 the function returns, and when it calls other functions.
14966 This mode is useful for compiling libraries or other compilation units
14967 you might want to incorporate into different programs with different
14968 prevailing FPU modes, and the convenience of being able to use a single
14969 object file outweighs the size and speed overhead for any extra
14970 mode switching that might be needed, compared with what would be needed
14971 with a more specific choice of prevailing FPU mode.
14973 @item truncate
14974 This is the mode used for floating-point calculations with
14975 truncating (i.e.@: round towards zero) rounding mode.  That includes
14976 conversion from floating point to integer.
14978 @item round-nearest
14979 This is the mode used for floating-point calculations with
14980 round-to-nearest-or-even rounding mode.
14982 @item int
14983 This is the mode used to perform integer calculations in the FPU, e.g.@:
14984 integer multiply, or integer multiply-and-accumulate.
14985 @end table
14987 The default is @option{-mfp-mode=caller}
14989 @item -mnosplit-lohi
14990 @itemx -mno-postinc
14991 @itemx -mno-postmodify
14992 @opindex mnosplit-lohi
14993 @opindex mno-postinc
14994 @opindex mno-postmodify
14995 Code generation tweaks that disable, respectively, splitting of 32-bit
14996 loads, generation of post-increment addresses, and generation of
14997 post-modify addresses.  The defaults are @option{msplit-lohi},
14998 @option{-mpost-inc}, and @option{-mpost-modify}.
15000 @item -mnovect-double
15001 @opindex mno-vect-double
15002 Change the preferred SIMD mode to SImode.  The default is
15003 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15005 @item -max-vect-align=@var{num}
15006 @opindex max-vect-align
15007 The maximum alignment for SIMD vector mode types.
15008 @var{num} may be 4 or 8.  The default is 8.
15009 Note that this is an ABI change, even though many library function
15010 interfaces are unaffected if they don't use SIMD vector modes
15011 in places that affect size and/or alignment of relevant types.
15013 @item -msplit-vecmove-early
15014 @opindex msplit-vecmove-early
15015 Split vector moves into single word moves before reload.  In theory this
15016 can give better register allocation, but so far the reverse seems to be
15017 generally the case.
15019 @item -m1reg-@var{reg}
15020 @opindex m1reg-
15021 Specify a register to hold the constant @minus{}1, which makes loading small negative
15022 constants and certain bitmasks faster.
15023 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15024 which specify use of that register as a fixed register,
15025 and @samp{none}, which means that no register is used for this
15026 purpose.  The default is @option{-m1reg-none}.
15028 @end table
15030 @node ARC Options
15031 @subsection ARC Options
15032 @cindex ARC options
15034 The following options control the architecture variant for which code
15035 is being compiled:
15037 @c architecture variants
15038 @table @gcctabopt
15040 @item -mbarrel-shifter
15041 @opindex mbarrel-shifter
15042 Generate instructions supported by barrel shifter.  This is the default
15043 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15045 @item -mjli-always
15046 @opindex mjli-alawys
15047 Force to call a function using jli_s instruction.  This option is
15048 valid only for ARCv2 architecture.
15050 @item -mcpu=@var{cpu}
15051 @opindex mcpu
15052 Set architecture type, register usage, and instruction scheduling
15053 parameters for @var{cpu}.  There are also shortcut alias options
15054 available for backward compatibility and convenience.  Supported
15055 values for @var{cpu} are
15057 @table @samp
15058 @opindex mA6
15059 @opindex mARC600
15060 @item arc600
15061 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15063 @item arc601
15064 @opindex mARC601
15065 Compile for ARC601.  Alias: @option{-mARC601}.
15067 @item arc700
15068 @opindex mA7
15069 @opindex mARC700
15070 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15071 This is the default when configured with @option{--with-cpu=arc700}@.
15073 @item arcem
15074 Compile for ARC EM.
15076 @item archs
15077 Compile for ARC HS.
15079 @item em
15080 Compile for ARC EM CPU with no hardware extensions.
15082 @item em4
15083 Compile for ARC EM4 CPU.
15085 @item em4_dmips
15086 Compile for ARC EM4 DMIPS CPU.
15088 @item em4_fpus
15089 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15090 extension.
15092 @item em4_fpuda
15093 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15094 double assist instructions.
15096 @item hs
15097 Compile for ARC HS CPU with no hardware extensions except the atomic
15098 instructions.
15100 @item hs34
15101 Compile for ARC HS34 CPU.
15103 @item hs38
15104 Compile for ARC HS38 CPU.
15106 @item hs38_linux
15107 Compile for ARC HS38 CPU with all hardware extensions on.
15109 @item arc600_norm
15110 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15112 @item arc600_mul32x16
15113 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15114 instructions enabled.
15116 @item arc600_mul64
15117 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15118 instructions enabled.
15120 @item arc601_norm
15121 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15123 @item arc601_mul32x16
15124 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15125 instructions enabled.
15127 @item arc601_mul64
15128 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15129 instructions enabled.
15131 @item nps400
15132 Compile for ARC 700 on NPS400 chip.
15134 @item em_mini
15135 Compile for ARC EM minimalist configuration featuring reduced register
15136 set.
15138 @end table
15140 @item -mdpfp
15141 @opindex mdpfp
15142 @itemx -mdpfp-compact
15143 @opindex mdpfp-compact
15144 Generate double-precision FPX instructions, tuned for the compact
15145 implementation.
15147 @item -mdpfp-fast
15148 @opindex mdpfp-fast
15149 Generate double-precision FPX instructions, tuned for the fast
15150 implementation.
15152 @item -mno-dpfp-lrsr
15153 @opindex mno-dpfp-lrsr
15154 Disable @code{lr} and @code{sr} instructions from using FPX extension
15155 aux registers.
15157 @item -mea
15158 @opindex mea
15159 Generate extended arithmetic instructions.  Currently only
15160 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15161 supported.  This is always enabled for @option{-mcpu=ARC700}.
15163 @item -mno-mpy
15164 @opindex mno-mpy
15165 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15166 deprecated.
15168 @item -mmul32x16
15169 @opindex mmul32x16
15170 Generate 32x16-bit multiply and multiply-accumulate instructions.
15172 @item -mmul64
15173 @opindex mmul64
15174 Generate @code{mul64} and @code{mulu64} instructions.  
15175 Only valid for @option{-mcpu=ARC600}.
15177 @item -mnorm
15178 @opindex mnorm
15179 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15180 is in effect.
15182 @item -mspfp
15183 @opindex mspfp
15184 @itemx -mspfp-compact
15185 @opindex mspfp-compact
15186 Generate single-precision FPX instructions, tuned for the compact
15187 implementation.
15189 @item -mspfp-fast
15190 @opindex mspfp-fast
15191 Generate single-precision FPX instructions, tuned for the fast
15192 implementation.
15194 @item -msimd
15195 @opindex msimd
15196 Enable generation of ARC SIMD instructions via target-specific
15197 builtins.  Only valid for @option{-mcpu=ARC700}.
15199 @item -msoft-float
15200 @opindex msoft-float
15201 This option ignored; it is provided for compatibility purposes only.
15202 Software floating-point code is emitted by default, and this default
15203 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15204 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15205 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15207 @item -mswap
15208 @opindex mswap
15209 Generate @code{swap} instructions.
15211 @item -matomic
15212 @opindex matomic
15213 This enables use of the locked load/store conditional extension to implement
15214 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15215 EM cores.
15217 @item -mdiv-rem
15218 @opindex mdiv-rem
15219 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15221 @item -mcode-density
15222 @opindex mcode-density
15223 Enable code density instructions for ARC EM.  
15224 This option is on by default for ARC HS.
15226 @item -mll64
15227 @opindex mll64
15228 Enable double load/store operations for ARC HS cores.
15230 @item -mtp-regno=@var{regno}
15231 @opindex mtp-regno
15232 Specify thread pointer register number.
15234 @item -mmpy-option=@var{multo}
15235 @opindex mmpy-option
15236 Compile ARCv2 code with a multiplier design option.  You can specify 
15237 the option using either a string or numeric value for @var{multo}.  
15238 @samp{wlh1} is the default value.  The recognized values are:
15240 @table @samp
15241 @item 0
15242 @itemx none
15243 No multiplier available.
15245 @item 1
15246 @itemx w
15247 16x16 multiplier, fully pipelined.
15248 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15250 @item 2
15251 @itemx wlh1
15252 32x32 multiplier, fully
15253 pipelined (1 stage).  The following instructions are additionally
15254 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15256 @item 3
15257 @itemx wlh2
15258 32x32 multiplier, fully pipelined
15259 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15260 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15262 @item 4
15263 @itemx wlh3
15264 Two 16x16 multipliers, blocking,
15265 sequential.  The following instructions are additionally enabled: @code{mpy},
15266 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15268 @item 5
15269 @itemx wlh4
15270 One 16x16 multiplier, blocking,
15271 sequential.  The following instructions are additionally enabled: @code{mpy},
15272 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15274 @item 6
15275 @itemx wlh5
15276 One 32x4 multiplier, blocking,
15277 sequential.  The following instructions are additionally enabled: @code{mpy},
15278 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15280 @item 7
15281 @itemx plus_dmpy
15282 ARC HS SIMD support.
15284 @item 8
15285 @itemx plus_macd
15286 ARC HS SIMD support.
15288 @item 9
15289 @itemx plus_qmacw
15290 ARC HS SIMD support.
15292 @end table
15294 This option is only available for ARCv2 cores@.
15296 @item -mfpu=@var{fpu}
15297 @opindex mfpu
15298 Enables support for specific floating-point hardware extensions for ARCv2
15299 cores.  Supported values for @var{fpu} are:
15301 @table @samp
15303 @item fpus
15304 Enables support for single-precision floating-point hardware
15305 extensions@.
15307 @item fpud
15308 Enables support for double-precision floating-point hardware
15309 extensions.  The single-precision floating-point extension is also
15310 enabled.  Not available for ARC EM@.
15312 @item fpuda
15313 Enables support for double-precision floating-point hardware
15314 extensions using double-precision assist instructions.  The single-precision
15315 floating-point extension is also enabled.  This option is
15316 only available for ARC EM@.
15318 @item fpuda_div
15319 Enables support for double-precision floating-point hardware
15320 extensions using double-precision assist instructions.
15321 The single-precision floating-point, square-root, and divide 
15322 extensions are also enabled.  This option is
15323 only available for ARC EM@.
15325 @item fpuda_fma
15326 Enables support for double-precision floating-point hardware
15327 extensions using double-precision assist instructions.
15328 The single-precision floating-point and fused multiply and add 
15329 hardware extensions are also enabled.  This option is
15330 only available for ARC EM@.
15332 @item fpuda_all
15333 Enables support for double-precision floating-point hardware
15334 extensions using double-precision assist instructions.
15335 All single-precision floating-point hardware extensions are also
15336 enabled.  This option is only available for ARC EM@.
15338 @item fpus_div
15339 Enables support for single-precision floating-point, square-root and divide 
15340 hardware extensions@.
15342 @item fpud_div
15343 Enables support for double-precision floating-point, square-root and divide 
15344 hardware extensions.  This option
15345 includes option @samp{fpus_div}. Not available for ARC EM@.
15347 @item fpus_fma
15348 Enables support for single-precision floating-point and 
15349 fused multiply and add hardware extensions@.
15351 @item fpud_fma
15352 Enables support for double-precision floating-point and 
15353 fused multiply and add hardware extensions.  This option
15354 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15356 @item fpus_all
15357 Enables support for all single-precision floating-point hardware
15358 extensions@.
15360 @item fpud_all
15361 Enables support for all single- and double-precision floating-point
15362 hardware extensions.  Not available for ARC EM@.
15364 @end table
15366 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15367 @opindex mirq-ctrl-saved
15368 Specifies general-purposes registers that the processor automatically
15369 saves/restores on interrupt entry and exit.  @var{register-range} is
15370 specified as two registers separated by a dash.  The register range
15371 always starts with @code{r0}, the upper limit is @code{fp} register.
15372 @var{blink} and @var{lp_count} are optional.  This option is only
15373 valid for ARC EM and ARC HS cores.
15375 @item -mrgf-banked-regs=@var{number}
15376 @opindex mrgf-banked-regs
15377 Specifies the number of registers replicated in second register bank
15378 on entry to fast interrupt.  Fast interrupts are interrupts with the
15379 highest priority level P0.  These interrupts save only PC and STATUS32
15380 registers to avoid memory transactions during interrupt entry and exit
15381 sequences.  Use this option when you are using fast interrupts in an
15382 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15384 @item -mlpc-width=@var{width}
15385 @opindex mlpc-width
15386 Specify the width of the @code{lp_count} register.  Valid values for
15387 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15388 fixed to 32 bits.  If the width is less than 32, the compiler does not
15389 attempt to transform loops in your program to use the zero-delay loop
15390 mechanism unless it is known that the @code{lp_count} register can
15391 hold the required loop-counter value.  Depending on the width
15392 specified, the compiler and run-time library might continue to use the
15393 loop mechanism for various needs.  This option defines macro
15394 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15396 @item -mrf16
15397 @opindex mrf16
15398 This option instructs the compiler to generate code for a 16-entry
15399 register file.  This option defines the @code{__ARC_RF16__}
15400 preprocessor macro.
15402 @end table
15404 The following options are passed through to the assembler, and also
15405 define preprocessor macro symbols.
15407 @c Flags used by the assembler, but for which we define preprocessor
15408 @c macro symbols as well.
15409 @table @gcctabopt
15410 @item -mdsp-packa
15411 @opindex mdsp-packa
15412 Passed down to the assembler to enable the DSP Pack A extensions.
15413 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15414 deprecated.
15416 @item -mdvbf
15417 @opindex mdvbf
15418 Passed down to the assembler to enable the dual Viterbi butterfly
15419 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15420 option is deprecated.
15422 @c ARC700 4.10 extension instruction
15423 @item -mlock
15424 @opindex mlock
15425 Passed down to the assembler to enable the locked load/store
15426 conditional extension.  Also sets the preprocessor symbol
15427 @code{__Xlock}.
15429 @item -mmac-d16
15430 @opindex mmac-d16
15431 Passed down to the assembler.  Also sets the preprocessor symbol
15432 @code{__Xxmac_d16}.  This option is deprecated.
15434 @item -mmac-24
15435 @opindex mmac-24
15436 Passed down to the assembler.  Also sets the preprocessor symbol
15437 @code{__Xxmac_24}.  This option is deprecated.
15439 @c ARC700 4.10 extension instruction
15440 @item -mrtsc
15441 @opindex mrtsc
15442 Passed down to the assembler to enable the 64-bit time-stamp counter
15443 extension instruction.  Also sets the preprocessor symbol
15444 @code{__Xrtsc}.  This option is deprecated.
15446 @c ARC700 4.10 extension instruction
15447 @item -mswape
15448 @opindex mswape
15449 Passed down to the assembler to enable the swap byte ordering
15450 extension instruction.  Also sets the preprocessor symbol
15451 @code{__Xswape}.
15453 @item -mtelephony
15454 @opindex mtelephony
15455 Passed down to the assembler to enable dual- and single-operand
15456 instructions for telephony.  Also sets the preprocessor symbol
15457 @code{__Xtelephony}.  This option is deprecated.
15459 @item -mxy
15460 @opindex mxy
15461 Passed down to the assembler to enable the XY memory extension.  Also
15462 sets the preprocessor symbol @code{__Xxy}.
15464 @end table
15466 The following options control how the assembly code is annotated:
15468 @c Assembly annotation options
15469 @table @gcctabopt
15470 @item -misize
15471 @opindex misize
15472 Annotate assembler instructions with estimated addresses.
15474 @item -mannotate-align
15475 @opindex mannotate-align
15476 Explain what alignment considerations lead to the decision to make an
15477 instruction short or long.
15479 @end table
15481 The following options are passed through to the linker:
15483 @c options passed through to the linker
15484 @table @gcctabopt
15485 @item -marclinux
15486 @opindex marclinux
15487 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15488 This option is enabled by default in tool chains built for
15489 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15490 when profiling is not requested.
15492 @item -marclinux_prof
15493 @opindex marclinux_prof
15494 Passed through to the linker, to specify use of the
15495 @code{arclinux_prof} emulation.  This option is enabled by default in
15496 tool chains built for @w{@code{arc-linux-uclibc}} and
15497 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15499 @end table
15501 The following options control the semantics of generated code:
15503 @c semantically relevant code generation options
15504 @table @gcctabopt
15505 @item -mlong-calls
15506 @opindex mlong-calls
15507 Generate calls as register indirect calls, thus providing access
15508 to the full 32-bit address range.
15510 @item -mmedium-calls
15511 @opindex mmedium-calls
15512 Don't use less than 25-bit addressing range for calls, which is the
15513 offset available for an unconditional branch-and-link
15514 instruction.  Conditional execution of function calls is suppressed, to
15515 allow use of the 25-bit range, rather than the 21-bit range with
15516 conditional branch-and-link.  This is the default for tool chains built
15517 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15519 @item -G @var{num}
15520 @opindex G
15521 Put definitions of externally-visible data in a small data section if
15522 that data is no bigger than @var{num} bytes.  The default value of
15523 @var{num} is 4 for any ARC configuration, or 8 when we have double
15524 load/store operations.
15526 @item -mno-sdata
15527 @opindex mno-sdata
15528 Do not generate sdata references.  This is the default for tool chains
15529 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15530 targets.
15532 @item -mvolatile-cache
15533 @opindex mvolatile-cache
15534 Use ordinarily cached memory accesses for volatile references.  This is the
15535 default.
15537 @item -mno-volatile-cache
15538 @opindex mno-volatile-cache
15539 Enable cache bypass for volatile references.
15541 @end table
15543 The following options fine tune code generation:
15544 @c code generation tuning options
15545 @table @gcctabopt
15546 @item -malign-call
15547 @opindex malign-call
15548 Do alignment optimizations for call instructions.
15550 @item -mauto-modify-reg
15551 @opindex mauto-modify-reg
15552 Enable the use of pre/post modify with register displacement.
15554 @item -mbbit-peephole
15555 @opindex mbbit-peephole
15556 Enable bbit peephole2.
15558 @item -mno-brcc
15559 @opindex mno-brcc
15560 This option disables a target-specific pass in @file{arc_reorg} to
15561 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15562 It has no effect on
15563 generation of these instructions driven by the combiner pass.
15565 @item -mcase-vector-pcrel
15566 @opindex mcase-vector-pcrel
15567 Use PC-relative switch case tables to enable case table shortening.
15568 This is the default for @option{-Os}.
15570 @item -mcompact-casesi
15571 @opindex mcompact-casesi
15572 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15573 and only available for ARCv1 cores.
15575 @item -mno-cond-exec
15576 @opindex mno-cond-exec
15577 Disable the ARCompact-specific pass to generate conditional 
15578 execution instructions.
15580 Due to delay slot scheduling and interactions between operand numbers,
15581 literal sizes, instruction lengths, and the support for conditional execution,
15582 the target-independent pass to generate conditional execution is often lacking,
15583 so the ARC port has kept a special pass around that tries to find more
15584 conditional execution generation opportunities after register allocation,
15585 branch shortening, and delay slot scheduling have been done.  This pass
15586 generally, but not always, improves performance and code size, at the cost of
15587 extra compilation time, which is why there is an option to switch it off.
15588 If you have a problem with call instructions exceeding their allowable
15589 offset range because they are conditionalized, you should consider using
15590 @option{-mmedium-calls} instead.
15592 @item -mearly-cbranchsi
15593 @opindex mearly-cbranchsi
15594 Enable pre-reload use of the @code{cbranchsi} pattern.
15596 @item -mexpand-adddi
15597 @opindex mexpand-adddi
15598 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15599 @code{add.f}, @code{adc} etc.  This option is deprecated.
15601 @item -mindexed-loads
15602 @opindex mindexed-loads
15603 Enable the use of indexed loads.  This can be problematic because some
15604 optimizers then assume that indexed stores exist, which is not
15605 the case.
15607 @item -mlra
15608 @opindex mlra
15609 Enable Local Register Allocation.  This is still experimental for ARC,
15610 so by default the compiler uses standard reload
15611 (i.e. @option{-mno-lra}).
15613 @item -mlra-priority-none
15614 @opindex mlra-priority-none
15615 Don't indicate any priority for target registers.
15617 @item -mlra-priority-compact
15618 @opindex mlra-priority-compact
15619 Indicate target register priority for r0..r3 / r12..r15.
15621 @item -mlra-priority-noncompact
15622 @opindex mlra-priority-noncompact
15623 Reduce target register priority for r0..r3 / r12..r15.
15625 @item -mno-millicode
15626 @opindex mno-millicode
15627 When optimizing for size (using @option{-Os}), prologues and epilogues
15628 that have to save or restore a large number of registers are often
15629 shortened by using call to a special function in libgcc; this is
15630 referred to as a @emph{millicode} call.  As these calls can pose
15631 performance issues, and/or cause linking issues when linking in a
15632 nonstandard way, this option is provided to turn off millicode call
15633 generation.
15635 @item -mmixed-code
15636 @opindex mmixed-code
15637 Tweak register allocation to help 16-bit instruction generation.
15638 This generally has the effect of decreasing the average instruction size
15639 while increasing the instruction count.
15641 @item -mq-class
15642 @opindex mq-class
15643 Enable @samp{q} instruction alternatives.
15644 This is the default for @option{-Os}.
15646 @item -mRcq
15647 @opindex mRcq
15648 Enable @samp{Rcq} constraint handling.  
15649 Most short code generation depends on this.
15650 This is the default.
15652 @item -mRcw
15653 @opindex mRcw
15654 Enable @samp{Rcw} constraint handling.  
15655 Most ccfsm condexec mostly depends on this.
15656 This is the default.
15658 @item -msize-level=@var{level}
15659 @opindex msize-level
15660 Fine-tune size optimization with regards to instruction lengths and alignment.
15661 The recognized values for @var{level} are:
15662 @table @samp
15663 @item 0
15664 No size optimization.  This level is deprecated and treated like @samp{1}.
15666 @item 1
15667 Short instructions are used opportunistically.
15669 @item 2
15670 In addition, alignment of loops and of code after barriers are dropped.
15672 @item 3
15673 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15675 @end table
15677 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15678 the behavior when this is not set is equivalent to level @samp{1}.
15680 @item -mtune=@var{cpu}
15681 @opindex mtune
15682 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15683 by @option{-mcpu=}.
15685 Supported values for @var{cpu} are
15687 @table @samp
15688 @item ARC600
15689 Tune for ARC600 CPU.
15691 @item ARC601
15692 Tune for ARC601 CPU.
15694 @item ARC700
15695 Tune for ARC700 CPU with standard multiplier block.
15697 @item ARC700-xmac
15698 Tune for ARC700 CPU with XMAC block.
15700 @item ARC725D
15701 Tune for ARC725D CPU.
15703 @item ARC750D
15704 Tune for ARC750D CPU.
15706 @end table
15708 @item -mmultcost=@var{num}
15709 @opindex mmultcost
15710 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15711 normal instruction.
15713 @item -munalign-prob-threshold=@var{probability}
15714 @opindex munalign-prob-threshold
15715 Set probability threshold for unaligning branches.
15716 When tuning for @samp{ARC700} and optimizing for speed, branches without
15717 filled delay slot are preferably emitted unaligned and long, unless
15718 profiling indicates that the probability for the branch to be taken
15719 is below @var{probability}.  @xref{Cross-profiling}.
15720 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15722 @end table
15724 The following options are maintained for backward compatibility, but
15725 are now deprecated and will be removed in a future release:
15727 @c Deprecated options
15728 @table @gcctabopt
15730 @item -margonaut
15731 @opindex margonaut
15732 Obsolete FPX.
15734 @item -mbig-endian
15735 @opindex mbig-endian
15736 @itemx -EB
15737 @opindex EB
15738 Compile code for big-endian targets.  Use of these options is now
15739 deprecated.  Big-endian code is supported by configuring GCC to build
15740 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15741 for which big endian is the default.
15743 @item -mlittle-endian
15744 @opindex mlittle-endian
15745 @itemx -EL
15746 @opindex EL
15747 Compile code for little-endian targets.  Use of these options is now
15748 deprecated.  Little-endian code is supported by configuring GCC to build 
15749 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15750 for which little endian is the default.
15752 @item -mbarrel_shifter
15753 @opindex mbarrel_shifter
15754 Replaced by @option{-mbarrel-shifter}.
15756 @item -mdpfp_compact
15757 @opindex mdpfp_compact
15758 Replaced by @option{-mdpfp-compact}.
15760 @item -mdpfp_fast
15761 @opindex mdpfp_fast
15762 Replaced by @option{-mdpfp-fast}.
15764 @item -mdsp_packa
15765 @opindex mdsp_packa
15766 Replaced by @option{-mdsp-packa}.
15768 @item -mEA
15769 @opindex mEA
15770 Replaced by @option{-mea}.
15772 @item -mmac_24
15773 @opindex mmac_24
15774 Replaced by @option{-mmac-24}.
15776 @item -mmac_d16
15777 @opindex mmac_d16
15778 Replaced by @option{-mmac-d16}.
15780 @item -mspfp_compact
15781 @opindex mspfp_compact
15782 Replaced by @option{-mspfp-compact}.
15784 @item -mspfp_fast
15785 @opindex mspfp_fast
15786 Replaced by @option{-mspfp-fast}.
15788 @item -mtune=@var{cpu}
15789 @opindex mtune
15790 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15791 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15792 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15794 @item -multcost=@var{num}
15795 @opindex multcost
15796 Replaced by @option{-mmultcost}.
15798 @end table
15800 @node ARM Options
15801 @subsection ARM Options
15802 @cindex ARM options
15804 These @samp{-m} options are defined for the ARM port:
15806 @table @gcctabopt
15807 @item -mabi=@var{name}
15808 @opindex mabi
15809 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15810 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15812 @item -mapcs-frame
15813 @opindex mapcs-frame
15814 Generate a stack frame that is compliant with the ARM Procedure Call
15815 Standard for all functions, even if this is not strictly necessary for
15816 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15817 with this option causes the stack frames not to be generated for
15818 leaf functions.  The default is @option{-mno-apcs-frame}.
15819 This option is deprecated.
15821 @item -mapcs
15822 @opindex mapcs
15823 This is a synonym for @option{-mapcs-frame} and is deprecated.
15825 @ignore
15826 @c not currently implemented
15827 @item -mapcs-stack-check
15828 @opindex mapcs-stack-check
15829 Generate code to check the amount of stack space available upon entry to
15830 every function (that actually uses some stack space).  If there is
15831 insufficient space available then either the function
15832 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15833 called, depending upon the amount of stack space required.  The runtime
15834 system is required to provide these functions.  The default is
15835 @option{-mno-apcs-stack-check}, since this produces smaller code.
15837 @c not currently implemented
15838 @item -mapcs-reentrant
15839 @opindex mapcs-reentrant
15840 Generate reentrant, position-independent code.  The default is
15841 @option{-mno-apcs-reentrant}.
15842 @end ignore
15844 @item -mthumb-interwork
15845 @opindex mthumb-interwork
15846 Generate code that supports calling between the ARM and Thumb
15847 instruction sets.  Without this option, on pre-v5 architectures, the
15848 two instruction sets cannot be reliably used inside one program.  The
15849 default is @option{-mno-thumb-interwork}, since slightly larger code
15850 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15851 configurations this option is meaningless.
15853 @item -mno-sched-prolog
15854 @opindex mno-sched-prolog
15855 Prevent the reordering of instructions in the function prologue, or the
15856 merging of those instruction with the instructions in the function's
15857 body.  This means that all functions start with a recognizable set
15858 of instructions (or in fact one of a choice from a small set of
15859 different function prologues), and this information can be used to
15860 locate the start of functions inside an executable piece of code.  The
15861 default is @option{-msched-prolog}.
15863 @item -mfloat-abi=@var{name}
15864 @opindex mfloat-abi
15865 Specifies which floating-point ABI to use.  Permissible values
15866 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15868 Specifying @samp{soft} causes GCC to generate output containing
15869 library calls for floating-point operations.
15870 @samp{softfp} allows the generation of code using hardware floating-point
15871 instructions, but still uses the soft-float calling conventions.
15872 @samp{hard} allows generation of floating-point instructions
15873 and uses FPU-specific calling conventions.
15875 The default depends on the specific target configuration.  Note that
15876 the hard-float and soft-float ABIs are not link-compatible; you must
15877 compile your entire program with the same ABI, and link with a
15878 compatible set of libraries.
15880 @item -mlittle-endian
15881 @opindex mlittle-endian
15882 Generate code for a processor running in little-endian mode.  This is
15883 the default for all standard configurations.
15885 @item -mbig-endian
15886 @opindex mbig-endian
15887 Generate code for a processor running in big-endian mode; the default is
15888 to compile code for a little-endian processor.
15890 @item -mbe8
15891 @itemx -mbe32
15892 @opindex mbe8
15893 When linking a big-endian image select between BE8 and BE32 formats.
15894 The option has no effect for little-endian images and is ignored.  The
15895 default is dependent on the selected target architecture.  For ARMv6
15896 and later architectures the default is BE8, for older architectures
15897 the default is BE32.  BE32 format has been deprecated by ARM.
15899 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15900 @opindex march
15901 This specifies the name of the target ARM architecture.  GCC uses this
15902 name to determine what kind of instructions it can emit when generating
15903 assembly code.  This option can be used in conjunction with or instead
15904 of the @option{-mcpu=} option.
15906 Permissible names are:
15907 @samp{armv4t},
15908 @samp{armv5t}, @samp{armv5te},
15909 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15910 @samp{armv6z}, @samp{armv6zk},
15911 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15912 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15913 @samp{armv8.4-a},
15914 @samp{armv7-r},
15915 @samp{armv8-r},
15916 @samp{armv6-m}, @samp{armv6s-m},
15917 @samp{armv7-m}, @samp{armv7e-m},
15918 @samp{armv8-m.base}, @samp{armv8-m.main},
15919 @samp{iwmmxt} and @samp{iwmmxt2}.
15921 Additionally, the following architectures, which lack support for the
15922 Thumb execution state, are recognized but support is deprecated:
15923 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15924 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15926 Many of the architectures support extensions.  These can be added by
15927 appending @samp{+@var{extension}} to the architecture name.  Extension
15928 options are processed in order and capabilities accumulate.  An extension
15929 will also enable any necessary base extensions
15930 upon which it depends.  For example, the @samp{+crypto} extension
15931 will always enable the @samp{+simd} extension.  The exception to the
15932 additive construction is for extensions that are prefixed with
15933 @samp{+no@dots{}}: these extensions disable the specified option and
15934 any other extensions that may depend on the presence of that
15935 extension.
15937 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15938 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15939 entirely disabled by the @samp{+nofp} option that follows it.
15941 Most extension names are generically named, but have an effect that is
15942 dependent upon the architecture to which it is applied.  For example,
15943 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15944 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15945 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15946 variant for @samp{armv8-a}.
15948 The table below lists the supported extensions for each architecture.
15949 Architectures not mentioned do not support any extensions.
15951 @table @samp
15952 @item  armv5e
15953 @itemx armv5te
15954 @itemx armv6
15955 @itemx armv6j
15956 @itemx armv6k
15957 @itemx armv6kz
15958 @itemx armv6t2
15959 @itemx armv6z
15960 @itemx armv6zk
15961 @table @samp
15962 @item +fp
15963 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15964 used as an alias for this extension.
15966 @item +nofp
15967 Disable the floating-point instructions.
15968 @end table
15970 @item armv7
15971 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15972 @table @samp
15973 @item +fp
15974 The VFPv3 floating-point instructions, with 16 double-precision
15975 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15976 for this extension.  Note that floating-point is not supported by the
15977 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15978 ARMv7-R architectures.
15980 @item +nofp
15981 Disable the floating-point instructions.
15982 @end table
15984 @item armv7-a
15985 @table @samp
15986 @item +fp
15987 The VFPv3 floating-point instructions, with 16 double-precision
15988 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15989 for this extension.
15991 @item +simd
15992 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15993 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15994 for this extension.
15996 @item +vfpv3
15997 The VFPv3 floating-point instructions, with 32 double-precision
15998 registers.
16000 @item +vfpv3-d16-fp16
16001 The VFPv3 floating-point instructions, with 16 double-precision
16002 registers and the half-precision floating-point conversion operations.
16004 @item +vfpv3-fp16
16005 The VFPv3 floating-point instructions, with 32 double-precision
16006 registers and the half-precision floating-point conversion operations.
16008 @item +vfpv4-d16
16009 The VFPv4 floating-point instructions, with 16 double-precision
16010 registers.
16012 @item +vfpv4
16013 The VFPv4 floating-point instructions, with 32 double-precision
16014 registers.
16016 @item +neon-fp16
16017 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16018 the half-precision floating-point conversion operations.
16020 @item +neon-vfpv4
16021 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16023 @item +nosimd
16024 Disable the Advanced SIMD instructions (does not disable floating point).
16026 @item +nofp
16027 Disable the floating-point and Advanced SIMD instructions.
16028 @end table
16030 @item armv7ve
16031 The extended version of the ARMv7-A architecture with support for
16032 virtualization.
16033 @table @samp
16034 @item +fp
16035 The VFPv4 floating-point instructions, with 16 double-precision registers.
16036 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16038 @item +simd
16039 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16040 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16042 @item +vfpv3-d16
16043 The VFPv3 floating-point instructions, with 16 double-precision
16044 registers.
16046 @item +vfpv3
16047 The VFPv3 floating-point instructions, with 32 double-precision
16048 registers.
16050 @item +vfpv3-d16-fp16
16051 The VFPv3 floating-point instructions, with 16 double-precision
16052 registers and the half-precision floating-point conversion operations.
16054 @item +vfpv3-fp16
16055 The VFPv3 floating-point instructions, with 32 double-precision
16056 registers and the half-precision floating-point conversion operations.
16058 @item +vfpv4-d16
16059 The VFPv4 floating-point instructions, with 16 double-precision
16060 registers.
16062 @item +vfpv4
16063 The VFPv4 floating-point instructions, with 32 double-precision
16064 registers.
16066 @item +neon
16067 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16068 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16070 @item +neon-fp16
16071 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16072 the half-precision floating-point conversion operations.
16074 @item +nosimd
16075 Disable the Advanced SIMD instructions (does not disable floating point).
16077 @item +nofp
16078 Disable the floating-point and Advanced SIMD instructions.
16079 @end table
16081 @item armv8-a
16082 @table @samp
16083 @item +crc
16084 The Cyclic Redundancy Check (CRC) instructions.
16085 @item +simd
16086 The ARMv8-A Advanced SIMD and floating-point instructions.
16087 @item +crypto
16088 The cryptographic instructions.
16089 @item +nocrypto
16090 Disable the cryptographic instructions.
16091 @item +nofp
16092 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16093 @end table
16095 @item armv8.1-a
16096 @table @samp
16097 @item +simd
16098 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16100 @item +crypto
16101 The cryptographic instructions.  This also enables the Advanced SIMD and
16102 floating-point instructions.
16104 @item +nocrypto
16105 Disable the cryptographic instructions.
16107 @item +nofp
16108 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16109 @end table
16111 @item armv8.2-a
16112 @itemx armv8.3-a
16113 @table @samp
16114 @item +fp16
16115 The half-precision floating-point data processing instructions.
16116 This also enables the Advanced SIMD and floating-point instructions.
16118 @item +fp16fml
16119 The half-precision floating-point fmla extension.  This also enables
16120 the half-precision floating-point extension and Advanced SIMD and
16121 floating-point instructions.
16123 @item +simd
16124 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16126 @item +crypto
16127 The cryptographic instructions.  This also enables the Advanced SIMD and
16128 floating-point instructions.
16130 @item +dotprod
16131 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16133 @item +nocrypto
16134 Disable the cryptographic extension.
16136 @item +nofp
16137 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16138 @end table
16140 @item armv8.4-a
16141 @table @samp
16142 @item +fp16
16143 The half-precision floating-point data processing instructions.
16144 This also enables the Advanced SIMD and floating-point instructions as well
16145 as the Dot Product extension and the half-precision floating-point fmla
16146 extension.
16148 @item +simd
16149 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16150 Dot Product extension.
16152 @item +crypto
16153 The cryptographic instructions.  This also enables the Advanced SIMD and
16154 floating-point instructions as well as the Dot Product extension.
16156 @item +nocrypto
16157 Disable the cryptographic extension.
16159 @item +nofp
16160 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16161 @end table
16163 @item armv7-r
16164 @table @samp
16165 @item +fp.sp
16166 The single-precision VFPv3 floating-point instructions.  The extension
16167 @samp{+vfpv3xd} can be used as an alias for this extension.
16169 @item +fp
16170 The VFPv3 floating-point instructions with 16 double-precision registers.
16171 The extension +vfpv3-d16 can be used as an alias for this extension.
16173 @item +nofp
16174 Disable the floating-point extension.
16176 @item +idiv
16177 The ARM-state integer division instructions.
16179 @item +noidiv
16180 Disable the ARM-state integer division extension.
16181 @end table
16183 @item armv7e-m
16184 @table @samp
16185 @item +fp
16186 The single-precision VFPv4 floating-point instructions.
16188 @item +fpv5
16189 The single-precision FPv5 floating-point instructions.
16191 @item +fp.dp
16192 The single- and double-precision FPv5 floating-point instructions.
16194 @item +nofp
16195 Disable the floating-point extensions.
16196 @end table
16198 @item  armv8-m.main
16199 @table @samp
16200 @item +dsp
16201 The DSP instructions.
16203 @item +nodsp
16204 Disable the DSP extension.
16206 @item +fp
16207 The single-precision floating-point instructions.
16209 @item +fp.dp
16210 The single- and double-precision floating-point instructions.
16212 @item +nofp
16213 Disable the floating-point extension.
16214 @end table
16216 @item armv8-r
16217 @table @samp
16218 @item +crc
16219 The Cyclic Redundancy Check (CRC) instructions.
16220 @item +fp.sp
16221 The single-precision FPv5 floating-point instructions.
16222 @item +simd
16223 The ARMv8-A Advanced SIMD and floating-point instructions.
16224 @item +crypto
16225 The cryptographic instructions.
16226 @item +nocrypto
16227 Disable the cryptographic instructions.
16228 @item +nofp
16229 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16230 @end table
16232 @end table
16234 @option{-march=native} causes the compiler to auto-detect the architecture
16235 of the build computer.  At present, this feature is only supported on
16236 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16237 is unsuccessful the option has no effect.
16239 @item -mtune=@var{name}
16240 @opindex mtune
16241 This option specifies the name of the target ARM processor for
16242 which GCC should tune the performance of the code.
16243 For some ARM implementations better performance can be obtained by using
16244 this option.
16245 Permissible names are: @samp{arm2}, @samp{arm250},
16246 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16247 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16248 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16249 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16250 @samp{arm720},
16251 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16252 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16253 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16254 @samp{strongarm1110},
16255 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16256 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16257 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16258 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16259 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16260 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16261 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16262 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16263 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16264 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16265 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16266 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16267 @samp{cortex-r8}, @samp{cortex-r52},
16268 @samp{cortex-m33},
16269 @samp{cortex-m23},
16270 @samp{cortex-m7},
16271 @samp{cortex-m4},
16272 @samp{cortex-m3},
16273 @samp{cortex-m1},
16274 @samp{cortex-m0},
16275 @samp{cortex-m0plus},
16276 @samp{cortex-m1.small-multiply},
16277 @samp{cortex-m0.small-multiply},
16278 @samp{cortex-m0plus.small-multiply},
16279 @samp{exynos-m1},
16280 @samp{marvell-pj4},
16281 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16282 @samp{fa526}, @samp{fa626},
16283 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16284 @samp{xgene1}.
16286 Additionally, this option can specify that GCC should tune the performance
16287 of the code for a big.LITTLE system.  Permissible names are:
16288 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16289 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16290 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16291 @samp{cortex-a75.cortex-a55}.
16293 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16294 performance for a blend of processors within architecture @var{arch}.
16295 The aim is to generate code that run well on the current most popular
16296 processors, balancing between optimizations that benefit some CPUs in the
16297 range, and avoiding performance pitfalls of other CPUs.  The effects of
16298 this option may change in future GCC versions as CPU models come and go.
16300 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16301 the extension options do not affect the tuning of the generated code.
16303 @option{-mtune=native} causes the compiler to auto-detect the CPU
16304 of the build computer.  At present, this feature is only supported on
16305 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16306 unsuccessful the option has no effect.
16308 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16309 @opindex mcpu
16310 This specifies the name of the target ARM processor.  GCC uses this name
16311 to derive the name of the target ARM architecture (as if specified
16312 by @option{-march}) and the ARM processor type for which to tune for
16313 performance (as if specified by @option{-mtune}).  Where this option
16314 is used in conjunction with @option{-march} or @option{-mtune},
16315 those options take precedence over the appropriate part of this option.
16317 Many of the supported CPUs implement optional architectural
16318 extensions.  Where this is so the architectural extensions are
16319 normally enabled by default.  If implementations that lack the
16320 extension exist, then the extension syntax can be used to disable
16321 those extensions that have been omitted.  For floating-point and
16322 Advanced SIMD (Neon) instructions, the settings of the options
16323 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16324 floating-point and Advanced SIMD instructions will only be used if
16325 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16326 @option{-mfpu} other than @samp{auto} will override the available
16327 floating-point and SIMD extension instructions.
16329 For example, @samp{cortex-a9} can be found in three major
16330 configurations: integer only, with just a floating-point unit or with
16331 floating-point and Advanced SIMD.  The default is to enable all the
16332 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16333 be used to disable just the SIMD or both the SIMD and floating-point
16334 instructions respectively.
16336 Permissible names for this option are the same as those for
16337 @option{-mtune}.
16339 The following extension options are common to the listed CPUs:
16341 @table @samp
16342 @item +nodsp
16343 Disable the DSP instructions on @samp{cortex-m33}.
16345 @item  +nofp
16346 Disables the floating-point instructions on @samp{arm9e},
16347 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16348 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16349 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16350 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16351 Disables the floating-point and SIMD instructions on
16352 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16353 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16354 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16355 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16356 @samp{cortex-a53} and @samp{cortex-a55}.
16358 @item +nofp.dp
16359 Disables the double-precision component of the floating-point instructions
16360 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16362 @item +nosimd
16363 Disables the SIMD (but not floating-point) instructions on
16364 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16365 and @samp{cortex-a9}.
16367 @item +crypto
16368 Enables the cryptographic instructions on @samp{cortex-a32},
16369 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16370 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16371 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16372 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16373 @samp{cortex-a75.cortex-a55}.
16374 @end table
16376 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16377 VFPv3 with 16 double-precision registers.  It supports the following
16378 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16379 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16380 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16381 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16382 @option{-march=armv7-a}.
16384 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16385 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16386 See @option{-mtune} for more information.
16388 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16389 of the build computer.  At present, this feature is only supported on
16390 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16391 is unsuccessful the option has no effect.
16393 @item -mfpu=@var{name}
16394 @opindex mfpu
16395 This specifies what floating-point hardware (or hardware emulation) is
16396 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16397 @samp{vfpv3},
16398 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16399 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16400 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16401 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16402 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16403 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16404 is an alias for @samp{vfpv2}.
16406 The setting @samp{auto} is the default and is special.  It causes the
16407 compiler to select the floating-point and Advanced SIMD instructions
16408 based on the settings of @option{-mcpu} and @option{-march}.
16410 If the selected floating-point hardware includes the NEON extension
16411 (e.g. @option{-mfpu=neon}), note that floating-point
16412 operations are not generated by GCC's auto-vectorization pass unless
16413 @option{-funsafe-math-optimizations} is also specified.  This is
16414 because NEON hardware does not fully implement the IEEE 754 standard for
16415 floating-point arithmetic (in particular denormal values are treated as
16416 zero), so the use of NEON instructions may lead to a loss of precision.
16418 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}).
16420 @item -mfp16-format=@var{name}
16421 @opindex mfp16-format
16422 Specify the format of the @code{__fp16} half-precision floating-point type.
16423 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16424 the default is @samp{none}, in which case the @code{__fp16} type is not
16425 defined.  @xref{Half-Precision}, for more information.
16427 @item -mstructure-size-boundary=@var{n}
16428 @opindex mstructure-size-boundary
16429 The sizes of all structures and unions are rounded up to a multiple
16430 of the number of bits set by this option.  Permissible values are 8, 32
16431 and 64.  The default value varies for different toolchains.  For the COFF
16432 targeted toolchain the default value is 8.  A value of 64 is only allowed
16433 if the underlying ABI supports it.
16435 Specifying a larger number can produce faster, more efficient code, but
16436 can also increase the size of the program.  Different values are potentially
16437 incompatible.  Code compiled with one value cannot necessarily expect to
16438 work with code or libraries compiled with another value, if they exchange
16439 information using structures or unions.
16441 This option is deprecated.
16443 @item -mabort-on-noreturn
16444 @opindex mabort-on-noreturn
16445 Generate a call to the function @code{abort} at the end of a
16446 @code{noreturn} function.  It is executed if the function tries to
16447 return.
16449 @item -mlong-calls
16450 @itemx -mno-long-calls
16451 @opindex mlong-calls
16452 @opindex mno-long-calls
16453 Tells the compiler to perform function calls by first loading the
16454 address of the function into a register and then performing a subroutine
16455 call on this register.  This switch is needed if the target function
16456 lies outside of the 64-megabyte addressing range of the offset-based
16457 version of subroutine call instruction.
16459 Even if this switch is enabled, not all function calls are turned
16460 into long calls.  The heuristic is that static functions, functions
16461 that have the @code{short_call} attribute, functions that are inside
16462 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16463 definitions have already been compiled within the current compilation
16464 unit are not turned into long calls.  The exceptions to this rule are
16465 that weak function definitions, functions with the @code{long_call}
16466 attribute or the @code{section} attribute, and functions that are within
16467 the scope of a @code{#pragma long_calls} directive are always
16468 turned into long calls.
16470 This feature is not enabled by default.  Specifying
16471 @option{-mno-long-calls} restores the default behavior, as does
16472 placing the function calls within the scope of a @code{#pragma
16473 long_calls_off} directive.  Note these switches have no effect on how
16474 the compiler generates code to handle function calls via function
16475 pointers.
16477 @item -msingle-pic-base
16478 @opindex msingle-pic-base
16479 Treat the register used for PIC addressing as read-only, rather than
16480 loading it in the prologue for each function.  The runtime system is
16481 responsible for initializing this register with an appropriate value
16482 before execution begins.
16484 @item -mpic-register=@var{reg}
16485 @opindex mpic-register
16486 Specify the register to be used for PIC addressing.
16487 For standard PIC base case, the default is any suitable register
16488 determined by compiler.  For single PIC base case, the default is
16489 @samp{R9} if target is EABI based or stack-checking is enabled,
16490 otherwise the default is @samp{R10}.
16492 @item -mpic-data-is-text-relative
16493 @opindex mpic-data-is-text-relative
16494 Assume that the displacement between the text and data segments is fixed
16495 at static link time.  This permits using PC-relative addressing
16496 operations to access data known to be in the data segment.  For
16497 non-VxWorks RTP targets, this option is enabled by default.  When
16498 disabled on such targets, it will enable @option{-msingle-pic-base} by
16499 default.
16501 @item -mpoke-function-name
16502 @opindex mpoke-function-name
16503 Write the name of each function into the text section, directly
16504 preceding the function prologue.  The generated code is similar to this:
16506 @smallexample
16507      t0
16508          .ascii "arm_poke_function_name", 0
16509          .align
16510      t1
16511          .word 0xff000000 + (t1 - t0)
16512      arm_poke_function_name
16513          mov     ip, sp
16514          stmfd   sp!, @{fp, ip, lr, pc@}
16515          sub     fp, ip, #4
16516 @end smallexample
16518 When performing a stack backtrace, code can inspect the value of
16519 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16520 location @code{pc - 12} and the top 8 bits are set, then we know that
16521 there is a function name embedded immediately preceding this location
16522 and has length @code{((pc[-3]) & 0xff000000)}.
16524 @item -mthumb
16525 @itemx -marm
16526 @opindex marm
16527 @opindex mthumb
16529 Select between generating code that executes in ARM and Thumb
16530 states.  The default for most configurations is to generate code
16531 that executes in ARM state, but the default can be changed by
16532 configuring GCC with the @option{--with-mode=}@var{state}
16533 configure option.
16535 You can also override the ARM and Thumb mode for each function
16536 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16537 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16539 @item -mflip-thumb 
16540 @opindex mflip-thumb
16541 Switch ARM/Thumb modes on alternating functions.
16542 This option is provided for regression testing of mixed Thumb/ARM code
16543 generation, and is not intended for ordinary use in compiling code.
16545 @item -mtpcs-frame
16546 @opindex mtpcs-frame
16547 Generate a stack frame that is compliant with the Thumb Procedure Call
16548 Standard for all non-leaf functions.  (A leaf function is one that does
16549 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16551 @item -mtpcs-leaf-frame
16552 @opindex mtpcs-leaf-frame
16553 Generate a stack frame that is compliant with the Thumb Procedure Call
16554 Standard for all leaf functions.  (A leaf function is one that does
16555 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16557 @item -mcallee-super-interworking
16558 @opindex mcallee-super-interworking
16559 Gives all externally visible functions in the file being compiled an ARM
16560 instruction set header which switches to Thumb mode before executing the
16561 rest of the function.  This allows these functions to be called from
16562 non-interworking code.  This option is not valid in AAPCS configurations
16563 because interworking is enabled by default.
16565 @item -mcaller-super-interworking
16566 @opindex mcaller-super-interworking
16567 Allows calls via function pointers (including virtual functions) to
16568 execute correctly regardless of whether the target code has been
16569 compiled for interworking or not.  There is a small overhead in the cost
16570 of executing a function pointer if this option is enabled.  This option
16571 is not valid in AAPCS configurations because interworking is enabled
16572 by default.
16574 @item -mtp=@var{name}
16575 @opindex mtp
16576 Specify the access model for the thread local storage pointer.  The valid
16577 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16578 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16579 (supported in the arm6k architecture), and @samp{auto}, which uses the
16580 best available method for the selected processor.  The default setting is
16581 @samp{auto}.
16583 @item -mtls-dialect=@var{dialect}
16584 @opindex mtls-dialect
16585 Specify the dialect to use for accessing thread local storage.  Two
16586 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16587 @samp{gnu} dialect selects the original GNU scheme for supporting
16588 local and global dynamic TLS models.  The @samp{gnu2} dialect
16589 selects the GNU descriptor scheme, which provides better performance
16590 for shared libraries.  The GNU descriptor scheme is compatible with
16591 the original scheme, but does require new assembler, linker and
16592 library support.  Initial and local exec TLS models are unaffected by
16593 this option and always use the original scheme.
16595 @item -mword-relocations
16596 @opindex mword-relocations
16597 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16598 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16599 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16600 is specified.
16602 @item -mfix-cortex-m3-ldrd
16603 @opindex mfix-cortex-m3-ldrd
16604 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16605 with overlapping destination and base registers are used.  This option avoids
16606 generating these instructions.  This option is enabled by default when
16607 @option{-mcpu=cortex-m3} is specified.
16609 @item -munaligned-access
16610 @itemx -mno-unaligned-access
16611 @opindex munaligned-access
16612 @opindex mno-unaligned-access
16613 Enables (or disables) reading and writing of 16- and 32- bit values
16614 from addresses that are not 16- or 32- bit aligned.  By default
16615 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16616 ARMv8-M Baseline architectures, and enabled for all other
16617 architectures.  If unaligned access is not enabled then words in packed
16618 data structures are accessed a byte at a time.
16620 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16621 generated object file to either true or false, depending upon the
16622 setting of this option.  If unaligned access is enabled then the
16623 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16624 defined.
16626 @item -mneon-for-64bits
16627 @opindex mneon-for-64bits
16628 Enables using Neon to handle scalar 64-bits operations. This is
16629 disabled by default since the cost of moving data from core registers
16630 to Neon is high.
16632 @item -mslow-flash-data
16633 @opindex mslow-flash-data
16634 Assume loading data from flash is slower than fetching instruction.
16635 Therefore literal load is minimized for better performance.
16636 This option is only supported when compiling for ARMv7 M-profile and
16637 off by default.
16639 @item -masm-syntax-unified
16640 @opindex masm-syntax-unified
16641 Assume inline assembler is using unified asm syntax.  The default is
16642 currently off which implies divided syntax.  This option has no impact
16643 on Thumb2. However, this may change in future releases of GCC.
16644 Divided syntax should be considered deprecated.
16646 @item -mrestrict-it
16647 @opindex mrestrict-it
16648 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16649 IT blocks can only contain a single 16-bit instruction from a select
16650 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16652 @item -mprint-tune-info
16653 @opindex mprint-tune-info
16654 Print CPU tuning information as comment in assembler file.  This is
16655 an option used only for regression testing of the compiler and not
16656 intended for ordinary use in compiling code.  This option is disabled
16657 by default.
16659 @item -mverbose-cost-dump
16660 @opindex mverbose-cost-dump
16661 Enable verbose cost model dumping in the debug dump files.  This option is
16662 provided for use in debugging the compiler.
16664 @item -mpure-code
16665 @opindex mpure-code
16666 Do not allow constant data to be placed in code sections.
16667 Additionally, when compiling for ELF object format give all text sections the
16668 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16669 is only available when generating non-pic code for M-profile targets with the
16670 MOVT instruction.
16672 @item -mcmse
16673 @opindex mcmse
16674 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16675 Development Tools Engineering Specification", which can be found on
16676 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16677 @end table
16679 @node AVR Options
16680 @subsection AVR Options
16681 @cindex AVR Options
16683 These options are defined for AVR implementations:
16685 @table @gcctabopt
16686 @item -mmcu=@var{mcu}
16687 @opindex mmcu
16688 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16690 The default for this option is@tie{}@samp{avr2}.
16692 GCC supports the following AVR devices and ISAs:
16694 @include avr-mmcu.texi
16696 @item -mabsdata
16697 @opindex mabsdata
16699 Assume that all data in static storage can be accessed by LDS / STS
16700 instructions.  This option has only an effect on reduced Tiny devices like
16701 ATtiny40.  See also the @code{absdata}
16702 @ref{AVR Variable Attributes,variable attribute}.
16704 @item -maccumulate-args
16705 @opindex maccumulate-args
16706 Accumulate outgoing function arguments and acquire/release the needed
16707 stack space for outgoing function arguments once in function
16708 prologue/epilogue.  Without this option, outgoing arguments are pushed
16709 before calling a function and popped afterwards.
16711 Popping the arguments after the function call can be expensive on
16712 AVR so that accumulating the stack space might lead to smaller
16713 executables because arguments need not be removed from the
16714 stack after such a function call.
16716 This option can lead to reduced code size for functions that perform
16717 several calls to functions that get their arguments on the stack like
16718 calls to printf-like functions.
16720 @item -mbranch-cost=@var{cost}
16721 @opindex mbranch-cost
16722 Set the branch costs for conditional branch instructions to
16723 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16724 integers. The default branch cost is 0.
16726 @item -mcall-prologues
16727 @opindex mcall-prologues
16728 Functions prologues/epilogues are expanded as calls to appropriate
16729 subroutines.  Code size is smaller.
16731 @item -mgas-isr-prologues
16732 @opindex mgas-isr-prologues
16733 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16734 instruction supported by GNU Binutils.
16735 If this option is on, the feature can still be disabled for individual
16736 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16737 function attribute.  This feature is activated per default
16738 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16739 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16741 @item -mint8
16742 @opindex mint8
16743 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16744 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16745 and @code{long long} is 4 bytes.  Please note that this option does not
16746 conform to the C standards, but it results in smaller code
16747 size.
16749 @item -mmain-is-OS_task
16750 @opindex mmain-is-OS_task
16751 Do not save registers in @code{main}.  The effect is the same like
16752 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16753 to @code{main}. It is activated per default if optimization is on.
16755 @item -mn-flash=@var{num}
16756 @opindex mn-flash
16757 Assume that the flash memory has a size of 
16758 @var{num} times 64@tie{}KiB.
16760 @item -mno-interrupts
16761 @opindex mno-interrupts
16762 Generated code is not compatible with hardware interrupts.
16763 Code size is smaller.
16765 @item -mrelax
16766 @opindex mrelax
16767 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16768 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16769 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16770 the assembler's command line and the @option{--relax} option to the
16771 linker's command line.
16773 Jump relaxing is performed by the linker because jump offsets are not
16774 known before code is located. Therefore, the assembler code generated by the
16775 compiler is the same, but the instructions in the executable may
16776 differ from instructions in the assembler code.
16778 Relaxing must be turned on if linker stubs are needed, see the
16779 section on @code{EIND} and linker stubs below.
16781 @item -mrmw
16782 @opindex mrmw
16783 Assume that the device supports the Read-Modify-Write
16784 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16786 @item -mshort-calls
16787 @opindex mshort-calls
16789 Assume that @code{RJMP} and @code{RCALL} can target the whole
16790 program memory.
16792 This option is used internally for multilib selection.  It is
16793 not an optimization option, and you don't need to set it by hand.
16795 @item -msp8
16796 @opindex msp8
16797 Treat the stack pointer register as an 8-bit register,
16798 i.e.@: assume the high byte of the stack pointer is zero.
16799 In general, you don't need to set this option by hand.
16801 This option is used internally by the compiler to select and
16802 build multilibs for architectures @code{avr2} and @code{avr25}.
16803 These architectures mix devices with and without @code{SPH}.
16804 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16805 the compiler driver adds or removes this option from the compiler
16806 proper's command line, because the compiler then knows if the device
16807 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16808 register or not.
16810 @item -mstrict-X
16811 @opindex mstrict-X
16812 Use address register @code{X} in a way proposed by the hardware.  This means
16813 that @code{X} is only used in indirect, post-increment or
16814 pre-decrement addressing.
16816 Without this option, the @code{X} register may be used in the same way
16817 as @code{Y} or @code{Z} which then is emulated by additional
16818 instructions.  
16819 For example, loading a value with @code{X+const} addressing with a
16820 small non-negative @code{const < 64} to a register @var{Rn} is
16821 performed as
16823 @example
16824 adiw r26, const   ; X += const
16825 ld   @var{Rn}, X        ; @var{Rn} = *X
16826 sbiw r26, const   ; X -= const
16827 @end example
16829 @item -mtiny-stack
16830 @opindex mtiny-stack
16831 Only change the lower 8@tie{}bits of the stack pointer.
16833 @item -mfract-convert-truncate
16834 @opindex mfract-convert-truncate
16835 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16837 @item -nodevicelib
16838 @opindex nodevicelib
16839 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16841 @item -Waddr-space-convert
16842 @opindex Waddr-space-convert
16843 Warn about conversions between address spaces in the case where the
16844 resulting address space is not contained in the incoming address space.
16846 @item -Wmisspelled-isr
16847 @opindex Wmisspelled-isr
16848 Warn if the ISR is misspelled, i.e. without __vector prefix.
16849 Enabled by default.
16850 @end table
16852 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16853 @cindex @code{EIND}
16854 Pointers in the implementation are 16@tie{}bits wide.
16855 The address of a function or label is represented as word address so
16856 that indirect jumps and calls can target any code address in the
16857 range of 64@tie{}Ki words.
16859 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16860 bytes of program memory space, there is a special function register called
16861 @code{EIND} that serves as most significant part of the target address
16862 when @code{EICALL} or @code{EIJMP} instructions are used.
16864 Indirect jumps and calls on these devices are handled as follows by
16865 the compiler and are subject to some limitations:
16867 @itemize @bullet
16869 @item
16870 The compiler never sets @code{EIND}.
16872 @item
16873 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16874 instructions or might read @code{EIND} directly in order to emulate an
16875 indirect call/jump by means of a @code{RET} instruction.
16877 @item
16878 The compiler assumes that @code{EIND} never changes during the startup
16879 code or during the application. In particular, @code{EIND} is not
16880 saved/restored in function or interrupt service routine
16881 prologue/epilogue.
16883 @item
16884 For indirect calls to functions and computed goto, the linker
16885 generates @emph{stubs}. Stubs are jump pads sometimes also called
16886 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16887 The stub contains a direct jump to the desired address.
16889 @item
16890 Linker relaxation must be turned on so that the linker generates
16891 the stubs correctly in all situations. See the compiler option
16892 @option{-mrelax} and the linker option @option{--relax}.
16893 There are corner cases where the linker is supposed to generate stubs
16894 but aborts without relaxation and without a helpful error message.
16896 @item
16897 The default linker script is arranged for code with @code{EIND = 0}.
16898 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16899 linker script has to be used in order to place the sections whose
16900 name start with @code{.trampolines} into the segment where @code{EIND}
16901 points to.
16903 @item
16904 The startup code from libgcc never sets @code{EIND}.
16905 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16906 For the impact of AVR-LibC on @code{EIND}, see the
16907 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16909 @item
16910 It is legitimate for user-specific startup code to set up @code{EIND}
16911 early, for example by means of initialization code located in
16912 section @code{.init3}. Such code runs prior to general startup code
16913 that initializes RAM and calls constructors, but after the bit
16914 of startup code from AVR-LibC that sets @code{EIND} to the segment
16915 where the vector table is located.
16916 @example
16917 #include <avr/io.h>
16919 static void
16920 __attribute__((section(".init3"),naked,used,no_instrument_function))
16921 init3_set_eind (void)
16923   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16924                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16926 @end example
16928 @noindent
16929 The @code{__trampolines_start} symbol is defined in the linker script.
16931 @item
16932 Stubs are generated automatically by the linker if
16933 the following two conditions are met:
16934 @itemize @minus
16936 @item The address of a label is taken by means of the @code{gs} modifier
16937 (short for @emph{generate stubs}) like so:
16938 @example
16939 LDI r24, lo8(gs(@var{func}))
16940 LDI r25, hi8(gs(@var{func}))
16941 @end example
16942 @item The final location of that label is in a code segment
16943 @emph{outside} the segment where the stubs are located.
16944 @end itemize
16946 @item
16947 The compiler emits such @code{gs} modifiers for code labels in the
16948 following situations:
16949 @itemize @minus
16950 @item Taking address of a function or code label.
16951 @item Computed goto.
16952 @item If prologue-save function is used, see @option{-mcall-prologues}
16953 command-line option.
16954 @item Switch/case dispatch tables. If you do not want such dispatch
16955 tables you can specify the @option{-fno-jump-tables} command-line option.
16956 @item C and C++ constructors/destructors called during startup/shutdown.
16957 @item If the tools hit a @code{gs()} modifier explained above.
16958 @end itemize
16960 @item
16961 Jumping to non-symbolic addresses like so is @emph{not} supported:
16963 @example
16964 int main (void)
16966     /* Call function at word address 0x2 */
16967     return ((int(*)(void)) 0x2)();
16969 @end example
16971 Instead, a stub has to be set up, i.e.@: the function has to be called
16972 through a symbol (@code{func_4} in the example):
16974 @example
16975 int main (void)
16977     extern int func_4 (void);
16979     /* Call function at byte address 0x4 */
16980     return func_4();
16982 @end example
16984 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16985 Alternatively, @code{func_4} can be defined in the linker script.
16986 @end itemize
16988 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16989 @cindex @code{RAMPD}
16990 @cindex @code{RAMPX}
16991 @cindex @code{RAMPY}
16992 @cindex @code{RAMPZ}
16993 Some AVR devices support memories larger than the 64@tie{}KiB range
16994 that can be accessed with 16-bit pointers.  To access memory locations
16995 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16996 register is used as high part of the address:
16997 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16998 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16999 register, respectively, to get a wide address. Similarly,
17000 @code{RAMPD} is used together with direct addressing.
17002 @itemize
17003 @item
17004 The startup code initializes the @code{RAMP} special function
17005 registers with zero.
17007 @item
17008 If a @ref{AVR Named Address Spaces,named address space} other than
17009 generic or @code{__flash} is used, then @code{RAMPZ} is set
17010 as needed before the operation.
17012 @item
17013 If the device supports RAM larger than 64@tie{}KiB and the compiler
17014 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17015 is reset to zero after the operation.
17017 @item
17018 If the device comes with a specific @code{RAMP} register, the ISR
17019 prologue/epilogue saves/restores that SFR and initializes it with
17020 zero in case the ISR code might (implicitly) use it.
17022 @item
17023 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17024 If you use inline assembler to read from locations outside the
17025 16-bit address range and change one of the @code{RAMP} registers,
17026 you must reset it to zero after the access.
17028 @end itemize
17030 @subsubsection AVR Built-in Macros
17032 GCC defines several built-in macros so that the user code can test
17033 for the presence or absence of features.  Almost any of the following
17034 built-in macros are deduced from device capabilities and thus
17035 triggered by the @option{-mmcu=} command-line option.
17037 For even more AVR-specific built-in macros see
17038 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17040 @table @code
17042 @item __AVR_ARCH__
17043 Build-in macro that resolves to a decimal number that identifies the
17044 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17045 Possible values are:
17047 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17048 @code{4}, @code{5}, @code{51}, @code{6}
17050 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17051 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17053 respectively and
17055 @code{100},
17056 @code{102}, @code{103}, @code{104},
17057 @code{105}, @code{106}, @code{107}
17059 for @var{mcu}=@code{avrtiny},
17060 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17061 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17062 If @var{mcu} specifies a device, this built-in macro is set
17063 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17064 defined to @code{4}.
17066 @item __AVR_@var{Device}__
17067 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17068 the device's name. For example, @option{-mmcu=atmega8} defines the
17069 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17070 @code{__AVR_ATtiny261A__}, etc.
17072 The built-in macros' names follow
17073 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17074 the device name as from the AVR user manual. The difference between
17075 @var{Device} in the built-in macro and @var{device} in
17076 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17078 If @var{device} is not a device but only a core architecture like
17079 @samp{avr51}, this macro is not defined.
17081 @item __AVR_DEVICE_NAME__
17082 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17083 the device's name. For example, with @option{-mmcu=atmega8} the macro
17084 is defined to @code{atmega8}.
17086 If @var{device} is not a device but only a core architecture like
17087 @samp{avr51}, this macro is not defined.
17089 @item __AVR_XMEGA__
17090 The device / architecture belongs to the XMEGA family of devices.
17092 @item __AVR_HAVE_ELPM__
17093 The device has the @code{ELPM} instruction.
17095 @item __AVR_HAVE_ELPMX__
17096 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17097 R@var{n},Z+} instructions.
17099 @item __AVR_HAVE_MOVW__
17100 The device has the @code{MOVW} instruction to perform 16-bit
17101 register-register moves.
17103 @item __AVR_HAVE_LPMX__
17104 The device has the @code{LPM R@var{n},Z} and
17105 @code{LPM R@var{n},Z+} instructions.
17107 @item __AVR_HAVE_MUL__
17108 The device has a hardware multiplier. 
17110 @item __AVR_HAVE_JMP_CALL__
17111 The device has the @code{JMP} and @code{CALL} instructions.
17112 This is the case for devices with more than 8@tie{}KiB of program
17113 memory.
17115 @item __AVR_HAVE_EIJMP_EICALL__
17116 @itemx __AVR_3_BYTE_PC__
17117 The device has the @code{EIJMP} and @code{EICALL} instructions.
17118 This is the case for devices with more than 128@tie{}KiB of program memory.
17119 This also means that the program counter
17120 (PC) is 3@tie{}bytes wide.
17122 @item __AVR_2_BYTE_PC__
17123 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17124 with up to 128@tie{}KiB of program memory.
17126 @item __AVR_HAVE_8BIT_SP__
17127 @itemx __AVR_HAVE_16BIT_SP__
17128 The stack pointer (SP) register is treated as 8-bit respectively
17129 16-bit register by the compiler.
17130 The definition of these macros is affected by @option{-mtiny-stack}.
17132 @item __AVR_HAVE_SPH__
17133 @itemx __AVR_SP8__
17134 The device has the SPH (high part of stack pointer) special function
17135 register or has an 8-bit stack pointer, respectively.
17136 The definition of these macros is affected by @option{-mmcu=} and
17137 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17138 by @option{-msp8}.
17140 @item __AVR_HAVE_RAMPD__
17141 @itemx __AVR_HAVE_RAMPX__
17142 @itemx __AVR_HAVE_RAMPY__
17143 @itemx __AVR_HAVE_RAMPZ__
17144 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17145 @code{RAMPZ} special function register, respectively.
17147 @item __NO_INTERRUPTS__
17148 This macro reflects the @option{-mno-interrupts} command-line option.
17150 @item __AVR_ERRATA_SKIP__
17151 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17152 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17153 instructions because of a hardware erratum.  Skip instructions are
17154 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17155 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17156 set.
17158 @item __AVR_ISA_RMW__
17159 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17161 @item __AVR_SFR_OFFSET__=@var{offset}
17162 Instructions that can address I/O special function registers directly
17163 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17164 address as if addressed by an instruction to access RAM like @code{LD}
17165 or @code{STS}. This offset depends on the device architecture and has
17166 to be subtracted from the RAM address in order to get the
17167 respective I/O@tie{}address.
17169 @item __AVR_SHORT_CALLS__
17170 The @option{-mshort-calls} command line option is set.
17172 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17173 Some devices support reading from flash memory by means of @code{LD*}
17174 instructions.  The flash memory is seen in the data address space
17175 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17176 is not defined, this feature is not available.  If defined,
17177 the address space is linear and there is no need to put
17178 @code{.rodata} into RAM.  This is handled by the default linker
17179 description file, and is currently available for
17180 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17181 there is no need to use address spaces like @code{__flash} or
17182 features like attribute @code{progmem} and @code{pgm_read_*}.
17184 @item __WITH_AVRLIBC__
17185 The compiler is configured to be used together with AVR-Libc.
17186 See the @option{--with-avrlibc} configure option.
17188 @end table
17190 @node Blackfin Options
17191 @subsection Blackfin Options
17192 @cindex Blackfin Options
17194 @table @gcctabopt
17195 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17196 @opindex mcpu=
17197 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17198 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17199 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17200 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17201 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17202 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17203 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17204 @samp{bf561}, @samp{bf592}.
17206 The optional @var{sirevision} specifies the silicon revision of the target
17207 Blackfin processor.  Any workarounds available for the targeted silicon revision
17208 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17209 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17210 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17211 hexadecimal digits representing the major and minor numbers in the silicon
17212 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17213 is not defined.  If @var{sirevision} is @samp{any}, the
17214 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17215 If this optional @var{sirevision} is not used, GCC assumes the latest known
17216 silicon revision of the targeted Blackfin processor.
17218 GCC defines a preprocessor macro for the specified @var{cpu}.
17219 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17220 provided by libgloss to be linked in if @option{-msim} is not given.
17222 Without this option, @samp{bf532} is used as the processor by default.
17224 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17225 only the preprocessor macro is defined.
17227 @item -msim
17228 @opindex msim
17229 Specifies that the program will be run on the simulator.  This causes
17230 the simulator BSP provided by libgloss to be linked in.  This option
17231 has effect only for @samp{bfin-elf} toolchain.
17232 Certain other options, such as @option{-mid-shared-library} and
17233 @option{-mfdpic}, imply @option{-msim}.
17235 @item -momit-leaf-frame-pointer
17236 @opindex momit-leaf-frame-pointer
17237 Don't keep the frame pointer in a register for leaf functions.  This
17238 avoids the instructions to save, set up and restore frame pointers and
17239 makes an extra register available in leaf functions.
17241 @item -mspecld-anomaly
17242 @opindex mspecld-anomaly
17243 When enabled, the compiler ensures that the generated code does not
17244 contain speculative loads after jump instructions. If this option is used,
17245 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17247 @item -mno-specld-anomaly
17248 @opindex mno-specld-anomaly
17249 Don't generate extra code to prevent speculative loads from occurring.
17251 @item -mcsync-anomaly
17252 @opindex mcsync-anomaly
17253 When enabled, the compiler ensures that the generated code does not
17254 contain CSYNC or SSYNC instructions too soon after conditional branches.
17255 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17257 @item -mno-csync-anomaly
17258 @opindex mno-csync-anomaly
17259 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17260 occurring too soon after a conditional branch.
17262 @item -mlow-64k
17263 @opindex mlow-64k
17264 When enabled, the compiler is free to take advantage of the knowledge that
17265 the entire program fits into the low 64k of memory.
17267 @item -mno-low-64k
17268 @opindex mno-low-64k
17269 Assume that the program is arbitrarily large.  This is the default.
17271 @item -mstack-check-l1
17272 @opindex mstack-check-l1
17273 Do stack checking using information placed into L1 scratchpad memory by the
17274 uClinux kernel.
17276 @item -mid-shared-library
17277 @opindex mid-shared-library
17278 Generate code that supports shared libraries via the library ID method.
17279 This allows for execute in place and shared libraries in an environment
17280 without virtual memory management.  This option implies @option{-fPIC}.
17281 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17283 @item -mno-id-shared-library
17284 @opindex mno-id-shared-library
17285 Generate code that doesn't assume ID-based shared libraries are being used.
17286 This is the default.
17288 @item -mleaf-id-shared-library
17289 @opindex mleaf-id-shared-library
17290 Generate code that supports shared libraries via the library ID method,
17291 but assumes that this library or executable won't link against any other
17292 ID shared libraries.  That allows the compiler to use faster code for jumps
17293 and calls.
17295 @item -mno-leaf-id-shared-library
17296 @opindex mno-leaf-id-shared-library
17297 Do not assume that the code being compiled won't link against any ID shared
17298 libraries.  Slower code is generated for jump and call insns.
17300 @item -mshared-library-id=n
17301 @opindex mshared-library-id
17302 Specifies the identification number of the ID-based shared library being
17303 compiled.  Specifying a value of 0 generates more compact code; specifying
17304 other values forces the allocation of that number to the current
17305 library but is no more space- or time-efficient than omitting this option.
17307 @item -msep-data
17308 @opindex msep-data
17309 Generate code that allows the data segment to be located in a different
17310 area of memory from the text segment.  This allows for execute in place in
17311 an environment without virtual memory management by eliminating relocations
17312 against the text section.
17314 @item -mno-sep-data
17315 @opindex mno-sep-data
17316 Generate code that assumes that the data segment follows the text segment.
17317 This is the default.
17319 @item -mlong-calls
17320 @itemx -mno-long-calls
17321 @opindex mlong-calls
17322 @opindex mno-long-calls
17323 Tells the compiler to perform function calls by first loading the
17324 address of the function into a register and then performing a subroutine
17325 call on this register.  This switch is needed if the target function
17326 lies outside of the 24-bit addressing range of the offset-based
17327 version of subroutine call instruction.
17329 This feature is not enabled by default.  Specifying
17330 @option{-mno-long-calls} restores the default behavior.  Note these
17331 switches have no effect on how the compiler generates code to handle
17332 function calls via function pointers.
17334 @item -mfast-fp
17335 @opindex mfast-fp
17336 Link with the fast floating-point library. This library relaxes some of
17337 the IEEE floating-point standard's rules for checking inputs against
17338 Not-a-Number (NAN), in the interest of performance.
17340 @item -minline-plt
17341 @opindex minline-plt
17342 Enable inlining of PLT entries in function calls to functions that are
17343 not known to bind locally.  It has no effect without @option{-mfdpic}.
17345 @item -mmulticore
17346 @opindex mmulticore
17347 Build a standalone application for multicore Blackfin processors. 
17348 This option causes proper start files and link scripts supporting 
17349 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17350 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17352 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17353 selects the one-application-per-core programming model.  Without
17354 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17355 programming model is used. In this model, the main function of Core B
17356 should be named as @code{coreb_main}.
17358 If this option is not used, the single-core application programming
17359 model is used.
17361 @item -mcorea
17362 @opindex mcorea
17363 Build a standalone application for Core A of BF561 when using
17364 the one-application-per-core programming model. Proper start files
17365 and link scripts are used to support Core A, and the macro
17366 @code{__BFIN_COREA} is defined.
17367 This option can only be used in conjunction with @option{-mmulticore}.
17369 @item -mcoreb
17370 @opindex mcoreb
17371 Build a standalone application for Core B of BF561 when using
17372 the one-application-per-core programming model. Proper start files
17373 and link scripts are used to support Core B, and the macro
17374 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17375 should be used instead of @code{main}. 
17376 This option can only be used in conjunction with @option{-mmulticore}.
17378 @item -msdram
17379 @opindex msdram
17380 Build a standalone application for SDRAM. Proper start files and
17381 link scripts are used to put the application into SDRAM, and the macro
17382 @code{__BFIN_SDRAM} is defined.
17383 The loader should initialize SDRAM before loading the application.
17385 @item -micplb
17386 @opindex micplb
17387 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17388 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17389 are enabled; for standalone applications the default is off.
17390 @end table
17392 @node C6X Options
17393 @subsection C6X Options
17394 @cindex C6X Options
17396 @table @gcctabopt
17397 @item -march=@var{name}
17398 @opindex march
17399 This specifies the name of the target architecture.  GCC uses this
17400 name to determine what kind of instructions it can emit when generating
17401 assembly code.  Permissible names are: @samp{c62x},
17402 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17404 @item -mbig-endian
17405 @opindex mbig-endian
17406 Generate code for a big-endian target.
17408 @item -mlittle-endian
17409 @opindex mlittle-endian
17410 Generate code for a little-endian target.  This is the default.
17412 @item -msim
17413 @opindex msim
17414 Choose startup files and linker script suitable for the simulator.
17416 @item -msdata=default
17417 @opindex msdata=default
17418 Put small global and static data in the @code{.neardata} section,
17419 which is pointed to by register @code{B14}.  Put small uninitialized
17420 global and static data in the @code{.bss} section, which is adjacent
17421 to the @code{.neardata} section.  Put small read-only data into the
17422 @code{.rodata} section.  The corresponding sections used for large
17423 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17425 @item -msdata=all
17426 @opindex msdata=all
17427 Put all data, not just small objects, into the sections reserved for
17428 small data, and use addressing relative to the @code{B14} register to
17429 access them.
17431 @item -msdata=none
17432 @opindex msdata=none
17433 Make no use of the sections reserved for small data, and use absolute
17434 addresses to access all data.  Put all initialized global and static
17435 data in the @code{.fardata} section, and all uninitialized data in the
17436 @code{.far} section.  Put all constant data into the @code{.const}
17437 section.
17438 @end table
17440 @node CRIS Options
17441 @subsection CRIS Options
17442 @cindex CRIS Options
17444 These options are defined specifically for the CRIS ports.
17446 @table @gcctabopt
17447 @item -march=@var{architecture-type}
17448 @itemx -mcpu=@var{architecture-type}
17449 @opindex march
17450 @opindex mcpu
17451 Generate code for the specified architecture.  The choices for
17452 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17453 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17454 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17455 @samp{v10}.
17457 @item -mtune=@var{architecture-type}
17458 @opindex mtune
17459 Tune to @var{architecture-type} everything applicable about the generated
17460 code, except for the ABI and the set of available instructions.  The
17461 choices for @var{architecture-type} are the same as for
17462 @option{-march=@var{architecture-type}}.
17464 @item -mmax-stack-frame=@var{n}
17465 @opindex mmax-stack-frame
17466 Warn when the stack frame of a function exceeds @var{n} bytes.
17468 @item -metrax4
17469 @itemx -metrax100
17470 @opindex metrax4
17471 @opindex metrax100
17472 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17473 @option{-march=v3} and @option{-march=v8} respectively.
17475 @item -mmul-bug-workaround
17476 @itemx -mno-mul-bug-workaround
17477 @opindex mmul-bug-workaround
17478 @opindex mno-mul-bug-workaround
17479 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17480 models where it applies.  This option is active by default.
17482 @item -mpdebug
17483 @opindex mpdebug
17484 Enable CRIS-specific verbose debug-related information in the assembly
17485 code.  This option also has the effect of turning off the @samp{#NO_APP}
17486 formatted-code indicator to the assembler at the beginning of the
17487 assembly file.
17489 @item -mcc-init
17490 @opindex mcc-init
17491 Do not use condition-code results from previous instruction; always emit
17492 compare and test instructions before use of condition codes.
17494 @item -mno-side-effects
17495 @opindex mno-side-effects
17496 Do not emit instructions with side effects in addressing modes other than
17497 post-increment.
17499 @item -mstack-align
17500 @itemx -mno-stack-align
17501 @itemx -mdata-align
17502 @itemx -mno-data-align
17503 @itemx -mconst-align
17504 @itemx -mno-const-align
17505 @opindex mstack-align
17506 @opindex mno-stack-align
17507 @opindex mdata-align
17508 @opindex mno-data-align
17509 @opindex mconst-align
17510 @opindex mno-const-align
17511 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17512 stack frame, individual data and constants to be aligned for the maximum
17513 single data access size for the chosen CPU model.  The default is to
17514 arrange for 32-bit alignment.  ABI details such as structure layout are
17515 not affected by these options.
17517 @item -m32-bit
17518 @itemx -m16-bit
17519 @itemx -m8-bit
17520 @opindex m32-bit
17521 @opindex m16-bit
17522 @opindex m8-bit
17523 Similar to the stack- data- and const-align options above, these options
17524 arrange for stack frame, writable data and constants to all be 32-bit,
17525 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17527 @item -mno-prologue-epilogue
17528 @itemx -mprologue-epilogue
17529 @opindex mno-prologue-epilogue
17530 @opindex mprologue-epilogue
17531 With @option{-mno-prologue-epilogue}, the normal function prologue and
17532 epilogue which set up the stack frame are omitted and no return
17533 instructions or return sequences are generated in the code.  Use this
17534 option only together with visual inspection of the compiled code: no
17535 warnings or errors are generated when call-saved registers must be saved,
17536 or storage for local variables needs to be allocated.
17538 @item -mno-gotplt
17539 @itemx -mgotplt
17540 @opindex mno-gotplt
17541 @opindex mgotplt
17542 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17543 instruction sequences that load addresses for functions from the PLT part
17544 of the GOT rather than (traditional on other architectures) calls to the
17545 PLT@.  The default is @option{-mgotplt}.
17547 @item -melf
17548 @opindex melf
17549 Legacy no-op option only recognized with the cris-axis-elf and
17550 cris-axis-linux-gnu targets.
17552 @item -mlinux
17553 @opindex mlinux
17554 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17556 @item -sim
17557 @opindex sim
17558 This option, recognized for the cris-axis-elf, arranges
17559 to link with input-output functions from a simulator library.  Code,
17560 initialized data and zero-initialized data are allocated consecutively.
17562 @item -sim2
17563 @opindex sim2
17564 Like @option{-sim}, but pass linker options to locate initialized data at
17565 0x40000000 and zero-initialized data at 0x80000000.
17566 @end table
17568 @node CR16 Options
17569 @subsection CR16 Options
17570 @cindex CR16 Options
17572 These options are defined specifically for the CR16 ports.
17574 @table @gcctabopt
17576 @item -mmac
17577 @opindex mmac
17578 Enable the use of multiply-accumulate instructions. Disabled by default.
17580 @item -mcr16cplus
17581 @itemx -mcr16c
17582 @opindex mcr16cplus
17583 @opindex mcr16c
17584 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17585 is default.
17587 @item -msim
17588 @opindex msim
17589 Links the library libsim.a which is in compatible with simulator. Applicable
17590 to ELF compiler only.
17592 @item -mint32
17593 @opindex mint32
17594 Choose integer type as 32-bit wide.
17596 @item -mbit-ops
17597 @opindex mbit-ops
17598 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17600 @item -mdata-model=@var{model}
17601 @opindex mdata-model
17602 Choose a data model. The choices for @var{model} are @samp{near},
17603 @samp{far} or @samp{medium}. @samp{medium} is default.
17604 However, @samp{far} is not valid with @option{-mcr16c}, as the
17605 CR16C architecture does not support the far data model.
17606 @end table
17608 @node Darwin Options
17609 @subsection Darwin Options
17610 @cindex Darwin options
17612 These options are defined for all architectures running the Darwin operating
17613 system.
17615 FSF GCC on Darwin does not create ``fat'' object files; it creates
17616 an object file for the single architecture that GCC was built to
17617 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17618 @option{-arch} options are used; it does so by running the compiler or
17619 linker multiple times and joining the results together with
17620 @file{lipo}.
17622 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17623 @samp{i686}) is determined by the flags that specify the ISA
17624 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17625 @option{-force_cpusubtype_ALL} option can be used to override this.
17627 The Darwin tools vary in their behavior when presented with an ISA
17628 mismatch.  The assembler, @file{as}, only permits instructions to
17629 be used that are valid for the subtype of the file it is generating,
17630 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17631 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17632 and prints an error if asked to create a shared library with a less
17633 restrictive subtype than its input files (for instance, trying to put
17634 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17635 for executables, @command{ld}, quietly gives the executable the most
17636 restrictive subtype of any of its input files.
17638 @table @gcctabopt
17639 @item -F@var{dir}
17640 @opindex F
17641 Add the framework directory @var{dir} to the head of the list of
17642 directories to be searched for header files.  These directories are
17643 interleaved with those specified by @option{-I} options and are
17644 scanned in a left-to-right order.
17646 A framework directory is a directory with frameworks in it.  A
17647 framework is a directory with a @file{Headers} and/or
17648 @file{PrivateHeaders} directory contained directly in it that ends
17649 in @file{.framework}.  The name of a framework is the name of this
17650 directory excluding the @file{.framework}.  Headers associated with
17651 the framework are found in one of those two directories, with
17652 @file{Headers} being searched first.  A subframework is a framework
17653 directory that is in a framework's @file{Frameworks} directory.
17654 Includes of subframework headers can only appear in a header of a
17655 framework that contains the subframework, or in a sibling subframework
17656 header.  Two subframeworks are siblings if they occur in the same
17657 framework.  A subframework should not have the same name as a
17658 framework; a warning is issued if this is violated.  Currently a
17659 subframework cannot have subframeworks; in the future, the mechanism
17660 may be extended to support this.  The standard frameworks can be found
17661 in @file{/System/Library/Frameworks} and
17662 @file{/Library/Frameworks}.  An example include looks like
17663 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17664 the name of the framework and @file{header.h} is found in the
17665 @file{PrivateHeaders} or @file{Headers} directory.
17667 @item -iframework@var{dir}
17668 @opindex iframework
17669 Like @option{-F} except the directory is a treated as a system
17670 directory.  The main difference between this @option{-iframework} and
17671 @option{-F} is that with @option{-iframework} the compiler does not
17672 warn about constructs contained within header files found via
17673 @var{dir}.  This option is valid only for the C family of languages.
17675 @item -gused
17676 @opindex gused
17677 Emit debugging information for symbols that are used.  For stabs
17678 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17679 This is by default ON@.
17681 @item -gfull
17682 @opindex gfull
17683 Emit debugging information for all symbols and types.
17685 @item -mmacosx-version-min=@var{version}
17686 The earliest version of MacOS X that this executable will run on
17687 is @var{version}.  Typical values of @var{version} include @code{10.1},
17688 @code{10.2}, and @code{10.3.9}.
17690 If the compiler was built to use the system's headers by default,
17691 then the default for this option is the system version on which the
17692 compiler is running, otherwise the default is to make choices that
17693 are compatible with as many systems and code bases as possible.
17695 @item -mkernel
17696 @opindex mkernel
17697 Enable kernel development mode.  The @option{-mkernel} option sets
17698 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17699 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17700 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17701 applicable.  This mode also sets @option{-mno-altivec},
17702 @option{-msoft-float}, @option{-fno-builtin} and
17703 @option{-mlong-branch} for PowerPC targets.
17705 @item -mone-byte-bool
17706 @opindex mone-byte-bool
17707 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17708 By default @code{sizeof(bool)} is @code{4} when compiling for
17709 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17710 option has no effect on x86.
17712 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17713 to generate code that is not binary compatible with code generated
17714 without that switch.  Using this switch may require recompiling all
17715 other modules in a program, including system libraries.  Use this
17716 switch to conform to a non-default data model.
17718 @item -mfix-and-continue
17719 @itemx -ffix-and-continue
17720 @itemx -findirect-data
17721 @opindex mfix-and-continue
17722 @opindex ffix-and-continue
17723 @opindex findirect-data
17724 Generate code suitable for fast turnaround development, such as to
17725 allow GDB to dynamically load @file{.o} files into already-running
17726 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17727 are provided for backwards compatibility.
17729 @item -all_load
17730 @opindex all_load
17731 Loads all members of static archive libraries.
17732 See man ld(1) for more information.
17734 @item -arch_errors_fatal
17735 @opindex arch_errors_fatal
17736 Cause the errors having to do with files that have the wrong architecture
17737 to be fatal.
17739 @item -bind_at_load
17740 @opindex bind_at_load
17741 Causes the output file to be marked such that the dynamic linker will
17742 bind all undefined references when the file is loaded or launched.
17744 @item -bundle
17745 @opindex bundle
17746 Produce a Mach-o bundle format file.
17747 See man ld(1) for more information.
17749 @item -bundle_loader @var{executable}
17750 @opindex bundle_loader
17751 This option specifies the @var{executable} that will load the build
17752 output file being linked.  See man ld(1) for more information.
17754 @item -dynamiclib
17755 @opindex dynamiclib
17756 When passed this option, GCC produces a dynamic library instead of
17757 an executable when linking, using the Darwin @file{libtool} command.
17759 @item -force_cpusubtype_ALL
17760 @opindex force_cpusubtype_ALL
17761 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17762 one controlled by the @option{-mcpu} or @option{-march} option.
17764 @item -allowable_client  @var{client_name}
17765 @itemx -client_name
17766 @itemx -compatibility_version
17767 @itemx -current_version
17768 @itemx -dead_strip
17769 @itemx -dependency-file
17770 @itemx -dylib_file
17771 @itemx -dylinker_install_name
17772 @itemx -dynamic
17773 @itemx -exported_symbols_list
17774 @itemx -filelist
17775 @need 800
17776 @itemx -flat_namespace
17777 @itemx -force_flat_namespace
17778 @itemx -headerpad_max_install_names
17779 @itemx -image_base
17780 @itemx -init
17781 @itemx -install_name
17782 @itemx -keep_private_externs
17783 @itemx -multi_module
17784 @itemx -multiply_defined
17785 @itemx -multiply_defined_unused
17786 @need 800
17787 @itemx -noall_load
17788 @itemx -no_dead_strip_inits_and_terms
17789 @itemx -nofixprebinding
17790 @itemx -nomultidefs
17791 @itemx -noprebind
17792 @itemx -noseglinkedit
17793 @itemx -pagezero_size
17794 @itemx -prebind
17795 @itemx -prebind_all_twolevel_modules
17796 @itemx -private_bundle
17797 @need 800
17798 @itemx -read_only_relocs
17799 @itemx -sectalign
17800 @itemx -sectobjectsymbols
17801 @itemx -whyload
17802 @itemx -seg1addr
17803 @itemx -sectcreate
17804 @itemx -sectobjectsymbols
17805 @itemx -sectorder
17806 @itemx -segaddr
17807 @itemx -segs_read_only_addr
17808 @need 800
17809 @itemx -segs_read_write_addr
17810 @itemx -seg_addr_table
17811 @itemx -seg_addr_table_filename
17812 @itemx -seglinkedit
17813 @itemx -segprot
17814 @itemx -segs_read_only_addr
17815 @itemx -segs_read_write_addr
17816 @itemx -single_module
17817 @itemx -static
17818 @itemx -sub_library
17819 @need 800
17820 @itemx -sub_umbrella
17821 @itemx -twolevel_namespace
17822 @itemx -umbrella
17823 @itemx -undefined
17824 @itemx -unexported_symbols_list
17825 @itemx -weak_reference_mismatches
17826 @itemx -whatsloaded
17827 @opindex allowable_client
17828 @opindex client_name
17829 @opindex compatibility_version
17830 @opindex current_version
17831 @opindex dead_strip
17832 @opindex dependency-file
17833 @opindex dylib_file
17834 @opindex dylinker_install_name
17835 @opindex dynamic
17836 @opindex exported_symbols_list
17837 @opindex filelist
17838 @opindex flat_namespace
17839 @opindex force_flat_namespace
17840 @opindex headerpad_max_install_names
17841 @opindex image_base
17842 @opindex init
17843 @opindex install_name
17844 @opindex keep_private_externs
17845 @opindex multi_module
17846 @opindex multiply_defined
17847 @opindex multiply_defined_unused
17848 @opindex noall_load
17849 @opindex no_dead_strip_inits_and_terms
17850 @opindex nofixprebinding
17851 @opindex nomultidefs
17852 @opindex noprebind
17853 @opindex noseglinkedit
17854 @opindex pagezero_size
17855 @opindex prebind
17856 @opindex prebind_all_twolevel_modules
17857 @opindex private_bundle
17858 @opindex read_only_relocs
17859 @opindex sectalign
17860 @opindex sectobjectsymbols
17861 @opindex whyload
17862 @opindex seg1addr
17863 @opindex sectcreate
17864 @opindex sectobjectsymbols
17865 @opindex sectorder
17866 @opindex segaddr
17867 @opindex segs_read_only_addr
17868 @opindex segs_read_write_addr
17869 @opindex seg_addr_table
17870 @opindex seg_addr_table_filename
17871 @opindex seglinkedit
17872 @opindex segprot
17873 @opindex segs_read_only_addr
17874 @opindex segs_read_write_addr
17875 @opindex single_module
17876 @opindex static
17877 @opindex sub_library
17878 @opindex sub_umbrella
17879 @opindex twolevel_namespace
17880 @opindex umbrella
17881 @opindex undefined
17882 @opindex unexported_symbols_list
17883 @opindex weak_reference_mismatches
17884 @opindex whatsloaded
17885 These options are passed to the Darwin linker.  The Darwin linker man page
17886 describes them in detail.
17887 @end table
17889 @node DEC Alpha Options
17890 @subsection DEC Alpha Options
17892 These @samp{-m} options are defined for the DEC Alpha implementations:
17894 @table @gcctabopt
17895 @item -mno-soft-float
17896 @itemx -msoft-float
17897 @opindex mno-soft-float
17898 @opindex msoft-float
17899 Use (do not use) the hardware floating-point instructions for
17900 floating-point operations.  When @option{-msoft-float} is specified,
17901 functions in @file{libgcc.a} are used to perform floating-point
17902 operations.  Unless they are replaced by routines that emulate the
17903 floating-point operations, or compiled in such a way as to call such
17904 emulations routines, these routines issue floating-point
17905 operations.   If you are compiling for an Alpha without floating-point
17906 operations, you must ensure that the library is built so as not to call
17907 them.
17909 Note that Alpha implementations without floating-point operations are
17910 required to have floating-point registers.
17912 @item -mfp-reg
17913 @itemx -mno-fp-regs
17914 @opindex mfp-reg
17915 @opindex mno-fp-regs
17916 Generate code that uses (does not use) the floating-point register set.
17917 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17918 register set is not used, floating-point operands are passed in integer
17919 registers as if they were integers and floating-point results are passed
17920 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17921 so any function with a floating-point argument or return value called by code
17922 compiled with @option{-mno-fp-regs} must also be compiled with that
17923 option.
17925 A typical use of this option is building a kernel that does not use,
17926 and hence need not save and restore, any floating-point registers.
17928 @item -mieee
17929 @opindex mieee
17930 The Alpha architecture implements floating-point hardware optimized for
17931 maximum performance.  It is mostly compliant with the IEEE floating-point
17932 standard.  However, for full compliance, software assistance is
17933 required.  This option generates code fully IEEE-compliant code
17934 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17935 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17936 defined during compilation.  The resulting code is less efficient but is
17937 able to correctly support denormalized numbers and exceptional IEEE
17938 values such as not-a-number and plus/minus infinity.  Other Alpha
17939 compilers call this option @option{-ieee_with_no_inexact}.
17941 @item -mieee-with-inexact
17942 @opindex mieee-with-inexact
17943 This is like @option{-mieee} except the generated code also maintains
17944 the IEEE @var{inexact-flag}.  Turning on this option causes the
17945 generated code to implement fully-compliant IEEE math.  In addition to
17946 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17947 macro.  On some Alpha implementations the resulting code may execute
17948 significantly slower than the code generated by default.  Since there is
17949 very little code that depends on the @var{inexact-flag}, you should
17950 normally not specify this option.  Other Alpha compilers call this
17951 option @option{-ieee_with_inexact}.
17953 @item -mfp-trap-mode=@var{trap-mode}
17954 @opindex mfp-trap-mode
17955 This option controls what floating-point related traps are enabled.
17956 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17957 The trap mode can be set to one of four values:
17959 @table @samp
17960 @item n
17961 This is the default (normal) setting.  The only traps that are enabled
17962 are the ones that cannot be disabled in software (e.g., division by zero
17963 trap).
17965 @item u
17966 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17967 as well.
17969 @item su
17970 Like @samp{u}, but the instructions are marked to be safe for software
17971 completion (see Alpha architecture manual for details).
17973 @item sui
17974 Like @samp{su}, but inexact traps are enabled as well.
17975 @end table
17977 @item -mfp-rounding-mode=@var{rounding-mode}
17978 @opindex mfp-rounding-mode
17979 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17980 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17983 @table @samp
17984 @item n
17985 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17986 the nearest machine number or towards the even machine number in case
17987 of a tie.
17989 @item m
17990 Round towards minus infinity.
17992 @item c
17993 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17995 @item d
17996 Dynamic rounding mode.  A field in the floating-point control register
17997 (@var{fpcr}, see Alpha architecture reference manual) controls the
17998 rounding mode in effect.  The C library initializes this register for
17999 rounding towards plus infinity.  Thus, unless your program modifies the
18000 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18001 @end table
18003 @item -mtrap-precision=@var{trap-precision}
18004 @opindex mtrap-precision
18005 In the Alpha architecture, floating-point traps are imprecise.  This
18006 means without software assistance it is impossible to recover from a
18007 floating trap and program execution normally needs to be terminated.
18008 GCC can generate code that can assist operating system trap handlers
18009 in determining the exact location that caused a floating-point trap.
18010 Depending on the requirements of an application, different levels of
18011 precisions can be selected:
18013 @table @samp
18014 @item p
18015 Program precision.  This option is the default and means a trap handler
18016 can only identify which program caused a floating-point exception.
18018 @item f
18019 Function precision.  The trap handler can determine the function that
18020 caused a floating-point exception.
18022 @item i
18023 Instruction precision.  The trap handler can determine the exact
18024 instruction that caused a floating-point exception.
18025 @end table
18027 Other Alpha compilers provide the equivalent options called
18028 @option{-scope_safe} and @option{-resumption_safe}.
18030 @item -mieee-conformant
18031 @opindex mieee-conformant
18032 This option marks the generated code as IEEE conformant.  You must not
18033 use this option unless you also specify @option{-mtrap-precision=i} and either
18034 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18035 is to emit the line @samp{.eflag 48} in the function prologue of the
18036 generated assembly file.
18038 @item -mbuild-constants
18039 @opindex mbuild-constants
18040 Normally GCC examines a 32- or 64-bit integer constant to
18041 see if it can construct it from smaller constants in two or three
18042 instructions.  If it cannot, it outputs the constant as a literal and
18043 generates code to load it from the data segment at run time.
18045 Use this option to require GCC to construct @emph{all} integer constants
18046 using code, even if it takes more instructions (the maximum is six).
18048 You typically use this option to build a shared library dynamic
18049 loader.  Itself a shared library, it must relocate itself in memory
18050 before it can find the variables and constants in its own data segment.
18052 @item -mbwx
18053 @itemx -mno-bwx
18054 @itemx -mcix
18055 @itemx -mno-cix
18056 @itemx -mfix
18057 @itemx -mno-fix
18058 @itemx -mmax
18059 @itemx -mno-max
18060 @opindex mbwx
18061 @opindex mno-bwx
18062 @opindex mcix
18063 @opindex mno-cix
18064 @opindex mfix
18065 @opindex mno-fix
18066 @opindex mmax
18067 @opindex mno-max
18068 Indicate whether GCC should generate code to use the optional BWX,
18069 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18070 sets supported by the CPU type specified via @option{-mcpu=} option or that
18071 of the CPU on which GCC was built if none is specified.
18073 @item -mfloat-vax
18074 @itemx -mfloat-ieee
18075 @opindex mfloat-vax
18076 @opindex mfloat-ieee
18077 Generate code that uses (does not use) VAX F and G floating-point
18078 arithmetic instead of IEEE single and double precision.
18080 @item -mexplicit-relocs
18081 @itemx -mno-explicit-relocs
18082 @opindex mexplicit-relocs
18083 @opindex mno-explicit-relocs
18084 Older Alpha assemblers provided no way to generate symbol relocations
18085 except via assembler macros.  Use of these macros does not allow
18086 optimal instruction scheduling.  GNU binutils as of version 2.12
18087 supports a new syntax that allows the compiler to explicitly mark
18088 which relocations should apply to which instructions.  This option
18089 is mostly useful for debugging, as GCC detects the capabilities of
18090 the assembler when it is built and sets the default accordingly.
18092 @item -msmall-data
18093 @itemx -mlarge-data
18094 @opindex msmall-data
18095 @opindex mlarge-data
18096 When @option{-mexplicit-relocs} is in effect, static data is
18097 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18098 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18099 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18100 16-bit relocations off of the @code{$gp} register.  This limits the
18101 size of the small data area to 64KB, but allows the variables to be
18102 directly accessed via a single instruction.
18104 The default is @option{-mlarge-data}.  With this option the data area
18105 is limited to just below 2GB@.  Programs that require more than 2GB of
18106 data must use @code{malloc} or @code{mmap} to allocate the data in the
18107 heap instead of in the program's data segment.
18109 When generating code for shared libraries, @option{-fpic} implies
18110 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18112 @item -msmall-text
18113 @itemx -mlarge-text
18114 @opindex msmall-text
18115 @opindex mlarge-text
18116 When @option{-msmall-text} is used, the compiler assumes that the
18117 code of the entire program (or shared library) fits in 4MB, and is
18118 thus reachable with a branch instruction.  When @option{-msmall-data}
18119 is used, the compiler can assume that all local symbols share the
18120 same @code{$gp} value, and thus reduce the number of instructions
18121 required for a function call from 4 to 1.
18123 The default is @option{-mlarge-text}.
18125 @item -mcpu=@var{cpu_type}
18126 @opindex mcpu
18127 Set the instruction set and instruction scheduling parameters for
18128 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18129 style name or the corresponding chip number.  GCC supports scheduling
18130 parameters for the EV4, EV5 and EV6 family of processors and
18131 chooses the default values for the instruction set from the processor
18132 you specify.  If you do not specify a processor type, GCC defaults
18133 to the processor on which the compiler was built.
18135 Supported values for @var{cpu_type} are
18137 @table @samp
18138 @item ev4
18139 @itemx ev45
18140 @itemx 21064
18141 Schedules as an EV4 and has no instruction set extensions.
18143 @item ev5
18144 @itemx 21164
18145 Schedules as an EV5 and has no instruction set extensions.
18147 @item ev56
18148 @itemx 21164a
18149 Schedules as an EV5 and supports the BWX extension.
18151 @item pca56
18152 @itemx 21164pc
18153 @itemx 21164PC
18154 Schedules as an EV5 and supports the BWX and MAX extensions.
18156 @item ev6
18157 @itemx 21264
18158 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18160 @item ev67
18161 @itemx 21264a
18162 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18163 @end table
18165 Native toolchains also support the value @samp{native},
18166 which selects the best architecture option for the host processor.
18167 @option{-mcpu=native} has no effect if GCC does not recognize
18168 the processor.
18170 @item -mtune=@var{cpu_type}
18171 @opindex mtune
18172 Set only the instruction scheduling parameters for machine type
18173 @var{cpu_type}.  The instruction set is not changed.
18175 Native toolchains also support the value @samp{native},
18176 which selects the best architecture option for the host processor.
18177 @option{-mtune=native} has no effect if GCC does not recognize
18178 the processor.
18180 @item -mmemory-latency=@var{time}
18181 @opindex mmemory-latency
18182 Sets the latency the scheduler should assume for typical memory
18183 references as seen by the application.  This number is highly
18184 dependent on the memory access patterns used by the application
18185 and the size of the external cache on the machine.
18187 Valid options for @var{time} are
18189 @table @samp
18190 @item @var{number}
18191 A decimal number representing clock cycles.
18193 @item L1
18194 @itemx L2
18195 @itemx L3
18196 @itemx main
18197 The compiler contains estimates of the number of clock cycles for
18198 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18199 (also called Dcache, Scache, and Bcache), as well as to main memory.
18200 Note that L3 is only valid for EV5.
18202 @end table
18203 @end table
18205 @node FR30 Options
18206 @subsection FR30 Options
18207 @cindex FR30 Options
18209 These options are defined specifically for the FR30 port.
18211 @table @gcctabopt
18213 @item -msmall-model
18214 @opindex msmall-model
18215 Use the small address space model.  This can produce smaller code, but
18216 it does assume that all symbolic values and addresses fit into a
18217 20-bit range.
18219 @item -mno-lsim
18220 @opindex mno-lsim
18221 Assume that runtime support has been provided and so there is no need
18222 to include the simulator library (@file{libsim.a}) on the linker
18223 command line.
18225 @end table
18227 @node FT32 Options
18228 @subsection FT32 Options
18229 @cindex FT32 Options
18231 These options are defined specifically for the FT32 port.
18233 @table @gcctabopt
18235 @item -msim
18236 @opindex msim
18237 Specifies that the program will be run on the simulator.  This causes
18238 an alternate runtime startup and library to be linked.
18239 You must not use this option when generating programs that will run on
18240 real hardware; you must provide your own runtime library for whatever
18241 I/O functions are needed.
18243 @item -mlra
18244 @opindex mlra
18245 Enable Local Register Allocation.  This is still experimental for FT32,
18246 so by default the compiler uses standard reload.
18248 @item -mnodiv
18249 @opindex mnodiv
18250 Do not use div and mod instructions.
18252 @item -mft32b
18253 @opindex mft32b
18254 Enable use of the extended instructions of the FT32B processor.
18256 @item -mcompress
18257 @opindex mcompress
18258 Compress all code using the Ft32B code compression scheme.
18260 @item -mnopm
18261 @opindex  mnopm
18262 Do not generate code that reads program memory.
18264 @end table
18266 @node FRV Options
18267 @subsection FRV Options
18268 @cindex FRV Options
18270 @table @gcctabopt
18271 @item -mgpr-32
18272 @opindex mgpr-32
18274 Only use the first 32 general-purpose registers.
18276 @item -mgpr-64
18277 @opindex mgpr-64
18279 Use all 64 general-purpose registers.
18281 @item -mfpr-32
18282 @opindex mfpr-32
18284 Use only the first 32 floating-point registers.
18286 @item -mfpr-64
18287 @opindex mfpr-64
18289 Use all 64 floating-point registers.
18291 @item -mhard-float
18292 @opindex mhard-float
18294 Use hardware instructions for floating-point operations.
18296 @item -msoft-float
18297 @opindex msoft-float
18299 Use library routines for floating-point operations.
18301 @item -malloc-cc
18302 @opindex malloc-cc
18304 Dynamically allocate condition code registers.
18306 @item -mfixed-cc
18307 @opindex mfixed-cc
18309 Do not try to dynamically allocate condition code registers, only
18310 use @code{icc0} and @code{fcc0}.
18312 @item -mdword
18313 @opindex mdword
18315 Change ABI to use double word insns.
18317 @item -mno-dword
18318 @opindex mno-dword
18320 Do not use double word instructions.
18322 @item -mdouble
18323 @opindex mdouble
18325 Use floating-point double instructions.
18327 @item -mno-double
18328 @opindex mno-double
18330 Do not use floating-point double instructions.
18332 @item -mmedia
18333 @opindex mmedia
18335 Use media instructions.
18337 @item -mno-media
18338 @opindex mno-media
18340 Do not use media instructions.
18342 @item -mmuladd
18343 @opindex mmuladd
18345 Use multiply and add/subtract instructions.
18347 @item -mno-muladd
18348 @opindex mno-muladd
18350 Do not use multiply and add/subtract instructions.
18352 @item -mfdpic
18353 @opindex mfdpic
18355 Select the FDPIC ABI, which uses function descriptors to represent
18356 pointers to functions.  Without any PIC/PIE-related options, it
18357 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18358 assumes GOT entries and small data are within a 12-bit range from the
18359 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18360 are computed with 32 bits.
18361 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18363 @item -minline-plt
18364 @opindex minline-plt
18366 Enable inlining of PLT entries in function calls to functions that are
18367 not known to bind locally.  It has no effect without @option{-mfdpic}.
18368 It's enabled by default if optimizing for speed and compiling for
18369 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18370 optimization option such as @option{-O3} or above is present in the
18371 command line.
18373 @item -mTLS
18374 @opindex mTLS
18376 Assume a large TLS segment when generating thread-local code.
18378 @item -mtls
18379 @opindex mtls
18381 Do not assume a large TLS segment when generating thread-local code.
18383 @item -mgprel-ro
18384 @opindex mgprel-ro
18386 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18387 that is known to be in read-only sections.  It's enabled by default,
18388 except for @option{-fpic} or @option{-fpie}: even though it may help
18389 make the global offset table smaller, it trades 1 instruction for 4.
18390 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18391 one of which may be shared by multiple symbols, and it avoids the need
18392 for a GOT entry for the referenced symbol, so it's more likely to be a
18393 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18395 @item -multilib-library-pic
18396 @opindex multilib-library-pic
18398 Link with the (library, not FD) pic libraries.  It's implied by
18399 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18400 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18401 it explicitly.
18403 @item -mlinked-fp
18404 @opindex mlinked-fp
18406 Follow the EABI requirement of always creating a frame pointer whenever
18407 a stack frame is allocated.  This option is enabled by default and can
18408 be disabled with @option{-mno-linked-fp}.
18410 @item -mlong-calls
18411 @opindex mlong-calls
18413 Use indirect addressing to call functions outside the current
18414 compilation unit.  This allows the functions to be placed anywhere
18415 within the 32-bit address space.
18417 @item -malign-labels
18418 @opindex malign-labels
18420 Try to align labels to an 8-byte boundary by inserting NOPs into the
18421 previous packet.  This option only has an effect when VLIW packing
18422 is enabled.  It doesn't create new packets; it merely adds NOPs to
18423 existing ones.
18425 @item -mlibrary-pic
18426 @opindex mlibrary-pic
18428 Generate position-independent EABI code.
18430 @item -macc-4
18431 @opindex macc-4
18433 Use only the first four media accumulator registers.
18435 @item -macc-8
18436 @opindex macc-8
18438 Use all eight media accumulator registers.
18440 @item -mpack
18441 @opindex mpack
18443 Pack VLIW instructions.
18445 @item -mno-pack
18446 @opindex mno-pack
18448 Do not pack VLIW instructions.
18450 @item -mno-eflags
18451 @opindex mno-eflags
18453 Do not mark ABI switches in e_flags.
18455 @item -mcond-move
18456 @opindex mcond-move
18458 Enable the use of conditional-move instructions (default).
18460 This switch is mainly for debugging the compiler and will likely be removed
18461 in a future version.
18463 @item -mno-cond-move
18464 @opindex mno-cond-move
18466 Disable the use of conditional-move instructions.
18468 This switch is mainly for debugging the compiler and will likely be removed
18469 in a future version.
18471 @item -mscc
18472 @opindex mscc
18474 Enable the use of conditional set instructions (default).
18476 This switch is mainly for debugging the compiler and will likely be removed
18477 in a future version.
18479 @item -mno-scc
18480 @opindex mno-scc
18482 Disable the use of conditional set instructions.
18484 This switch is mainly for debugging the compiler and will likely be removed
18485 in a future version.
18487 @item -mcond-exec
18488 @opindex mcond-exec
18490 Enable the use of conditional execution (default).
18492 This switch is mainly for debugging the compiler and will likely be removed
18493 in a future version.
18495 @item -mno-cond-exec
18496 @opindex mno-cond-exec
18498 Disable the use of conditional execution.
18500 This switch is mainly for debugging the compiler and will likely be removed
18501 in a future version.
18503 @item -mvliw-branch
18504 @opindex mvliw-branch
18506 Run a pass to pack branches into VLIW instructions (default).
18508 This switch is mainly for debugging the compiler and will likely be removed
18509 in a future version.
18511 @item -mno-vliw-branch
18512 @opindex mno-vliw-branch
18514 Do not run a pass to pack branches into VLIW instructions.
18516 This switch is mainly for debugging the compiler and will likely be removed
18517 in a future version.
18519 @item -mmulti-cond-exec
18520 @opindex mmulti-cond-exec
18522 Enable optimization of @code{&&} and @code{||} in conditional execution
18523 (default).
18525 This switch is mainly for debugging the compiler and will likely be removed
18526 in a future version.
18528 @item -mno-multi-cond-exec
18529 @opindex mno-multi-cond-exec
18531 Disable optimization of @code{&&} and @code{||} in conditional execution.
18533 This switch is mainly for debugging the compiler and will likely be removed
18534 in a future version.
18536 @item -mnested-cond-exec
18537 @opindex mnested-cond-exec
18539 Enable nested conditional execution optimizations (default).
18541 This switch is mainly for debugging the compiler and will likely be removed
18542 in a future version.
18544 @item -mno-nested-cond-exec
18545 @opindex mno-nested-cond-exec
18547 Disable nested conditional execution optimizations.
18549 This switch is mainly for debugging the compiler and will likely be removed
18550 in a future version.
18552 @item -moptimize-membar
18553 @opindex moptimize-membar
18555 This switch removes redundant @code{membar} instructions from the
18556 compiler-generated code.  It is enabled by default.
18558 @item -mno-optimize-membar
18559 @opindex mno-optimize-membar
18561 This switch disables the automatic removal of redundant @code{membar}
18562 instructions from the generated code.
18564 @item -mtomcat-stats
18565 @opindex mtomcat-stats
18567 Cause gas to print out tomcat statistics.
18569 @item -mcpu=@var{cpu}
18570 @opindex mcpu
18572 Select the processor type for which to generate code.  Possible values are
18573 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18574 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18576 @end table
18578 @node GNU/Linux Options
18579 @subsection GNU/Linux Options
18581 These @samp{-m} options are defined for GNU/Linux targets:
18583 @table @gcctabopt
18584 @item -mglibc
18585 @opindex mglibc
18586 Use the GNU C library.  This is the default except
18587 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18588 @samp{*-*-linux-*android*} targets.
18590 @item -muclibc
18591 @opindex muclibc
18592 Use uClibc C library.  This is the default on
18593 @samp{*-*-linux-*uclibc*} targets.
18595 @item -mmusl
18596 @opindex mmusl
18597 Use the musl C library.  This is the default on
18598 @samp{*-*-linux-*musl*} targets.
18600 @item -mbionic
18601 @opindex mbionic
18602 Use Bionic C library.  This is the default on
18603 @samp{*-*-linux-*android*} targets.
18605 @item -mandroid
18606 @opindex mandroid
18607 Compile code compatible with Android platform.  This is the default on
18608 @samp{*-*-linux-*android*} targets.
18610 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18611 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18612 this option makes the GCC driver pass Android-specific options to the linker.
18613 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18614 to be defined.
18616 @item -tno-android-cc
18617 @opindex tno-android-cc
18618 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18619 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18620 @option{-fno-rtti} by default.
18622 @item -tno-android-ld
18623 @opindex tno-android-ld
18624 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18625 linking options to the linker.
18627 @end table
18629 @node H8/300 Options
18630 @subsection H8/300 Options
18632 These @samp{-m} options are defined for the H8/300 implementations:
18634 @table @gcctabopt
18635 @item -mrelax
18636 @opindex mrelax
18637 Shorten some address references at link time, when possible; uses the
18638 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18639 ld, Using ld}, for a fuller description.
18641 @item -mh
18642 @opindex mh
18643 Generate code for the H8/300H@.
18645 @item -ms
18646 @opindex ms
18647 Generate code for the H8S@.
18649 @item -mn
18650 @opindex mn
18651 Generate code for the H8S and H8/300H in the normal mode.  This switch
18652 must be used either with @option{-mh} or @option{-ms}.
18654 @item -ms2600
18655 @opindex ms2600
18656 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18658 @item -mexr
18659 @opindex mexr
18660 Extended registers are stored on stack before execution of function
18661 with monitor attribute. Default option is @option{-mexr}.
18662 This option is valid only for H8S targets.
18664 @item -mno-exr
18665 @opindex mno-exr
18666 Extended registers are not stored on stack before execution of function 
18667 with monitor attribute. Default option is @option{-mno-exr}. 
18668 This option is valid only for H8S targets.
18670 @item -mint32
18671 @opindex mint32
18672 Make @code{int} data 32 bits by default.
18674 @item -malign-300
18675 @opindex malign-300
18676 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18677 The default for the H8/300H and H8S is to align longs and floats on
18678 4-byte boundaries.
18679 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18680 This option has no effect on the H8/300.
18681 @end table
18683 @node HPPA Options
18684 @subsection HPPA Options
18685 @cindex HPPA Options
18687 These @samp{-m} options are defined for the HPPA family of computers:
18689 @table @gcctabopt
18690 @item -march=@var{architecture-type}
18691 @opindex march
18692 Generate code for the specified architecture.  The choices for
18693 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18694 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18695 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18696 architecture option for your machine.  Code compiled for lower numbered
18697 architectures runs on higher numbered architectures, but not the
18698 other way around.
18700 @item -mpa-risc-1-0
18701 @itemx -mpa-risc-1-1
18702 @itemx -mpa-risc-2-0
18703 @opindex mpa-risc-1-0
18704 @opindex mpa-risc-1-1
18705 @opindex mpa-risc-2-0
18706 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18708 @item -mcaller-copies
18709 @opindex mcaller-copies
18710 The caller copies function arguments passed by hidden reference.  This
18711 option should be used with care as it is not compatible with the default
18712 32-bit runtime.  However, only aggregates larger than eight bytes are
18713 passed by hidden reference and the option provides better compatibility
18714 with OpenMP.
18716 @item -mjump-in-delay
18717 @opindex mjump-in-delay
18718 This option is ignored and provided for compatibility purposes only.
18720 @item -mdisable-fpregs
18721 @opindex mdisable-fpregs
18722 Prevent floating-point registers from being used in any manner.  This is
18723 necessary for compiling kernels that perform lazy context switching of
18724 floating-point registers.  If you use this option and attempt to perform
18725 floating-point operations, the compiler aborts.
18727 @item -mdisable-indexing
18728 @opindex mdisable-indexing
18729 Prevent the compiler from using indexing address modes.  This avoids some
18730 rather obscure problems when compiling MIG generated code under MACH@.
18732 @item -mno-space-regs
18733 @opindex mno-space-regs
18734 Generate code that assumes the target has no space registers.  This allows
18735 GCC to generate faster indirect calls and use unscaled index address modes.
18737 Such code is suitable for level 0 PA systems and kernels.
18739 @item -mfast-indirect-calls
18740 @opindex mfast-indirect-calls
18741 Generate code that assumes calls never cross space boundaries.  This
18742 allows GCC to emit code that performs faster indirect calls.
18744 This option does not work in the presence of shared libraries or nested
18745 functions.
18747 @item -mfixed-range=@var{register-range}
18748 @opindex mfixed-range
18749 Generate code treating the given register range as fixed registers.
18750 A fixed register is one that the register allocator cannot use.  This is
18751 useful when compiling kernel code.  A register range is specified as
18752 two registers separated by a dash.  Multiple register ranges can be
18753 specified separated by a comma.
18755 @item -mlong-load-store
18756 @opindex mlong-load-store
18757 Generate 3-instruction load and store sequences as sometimes required by
18758 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18759 the HP compilers.
18761 @item -mportable-runtime
18762 @opindex mportable-runtime
18763 Use the portable calling conventions proposed by HP for ELF systems.
18765 @item -mgas
18766 @opindex mgas
18767 Enable the use of assembler directives only GAS understands.
18769 @item -mschedule=@var{cpu-type}
18770 @opindex mschedule
18771 Schedule code according to the constraints for the machine type
18772 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18773 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18774 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18775 proper scheduling option for your machine.  The default scheduling is
18776 @samp{8000}.
18778 @item -mlinker-opt
18779 @opindex mlinker-opt
18780 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18781 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18782 linkers in which they give bogus error messages when linking some programs.
18784 @item -msoft-float
18785 @opindex msoft-float
18786 Generate output containing library calls for floating point.
18787 @strong{Warning:} the requisite libraries are not available for all HPPA
18788 targets.  Normally the facilities of the machine's usual C compiler are
18789 used, but this cannot be done directly in cross-compilation.  You must make
18790 your own arrangements to provide suitable library functions for
18791 cross-compilation.
18793 @option{-msoft-float} changes the calling convention in the output file;
18794 therefore, it is only useful if you compile @emph{all} of a program with
18795 this option.  In particular, you need to compile @file{libgcc.a}, the
18796 library that comes with GCC, with @option{-msoft-float} in order for
18797 this to work.
18799 @item -msio
18800 @opindex msio
18801 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18802 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18803 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18804 options are available under HP-UX and HI-UX@.
18806 @item -mgnu-ld
18807 @opindex mgnu-ld
18808 Use options specific to GNU @command{ld}.
18809 This passes @option{-shared} to @command{ld} when
18810 building a shared library.  It is the default when GCC is configured,
18811 explicitly or implicitly, with the GNU linker.  This option does not
18812 affect which @command{ld} is called; it only changes what parameters
18813 are passed to that @command{ld}.
18814 The @command{ld} that is called is determined by the
18815 @option{--with-ld} configure option, GCC's program search path, and
18816 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18817 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18818 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18820 @item -mhp-ld
18821 @opindex mhp-ld
18822 Use options specific to HP @command{ld}.
18823 This passes @option{-b} to @command{ld} when building
18824 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18825 links.  It is the default when GCC is configured, explicitly or
18826 implicitly, with the HP linker.  This option does not affect
18827 which @command{ld} is called; it only changes what parameters are passed to that
18828 @command{ld}.
18829 The @command{ld} that is called is determined by the @option{--with-ld}
18830 configure option, GCC's program search path, and finally by the user's
18831 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18832 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18833 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18835 @item -mlong-calls
18836 @opindex mno-long-calls
18837 Generate code that uses long call sequences.  This ensures that a call
18838 is always able to reach linker generated stubs.  The default is to generate
18839 long calls only when the distance from the call site to the beginning
18840 of the function or translation unit, as the case may be, exceeds a
18841 predefined limit set by the branch type being used.  The limits for
18842 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18843 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18844 240,000 bytes.
18846 Distances are measured from the beginning of functions when using the
18847 @option{-ffunction-sections} option, or when using the @option{-mgas}
18848 and @option{-mno-portable-runtime} options together under HP-UX with
18849 the SOM linker.
18851 It is normally not desirable to use this option as it degrades
18852 performance.  However, it may be useful in large applications,
18853 particularly when partial linking is used to build the application.
18855 The types of long calls used depends on the capabilities of the
18856 assembler and linker, and the type of code being generated.  The
18857 impact on systems that support long absolute calls, and long pic
18858 symbol-difference or pc-relative calls should be relatively small.
18859 However, an indirect call is used on 32-bit ELF systems in pic code
18860 and it is quite long.
18862 @item -munix=@var{unix-std}
18863 @opindex march
18864 Generate compiler predefines and select a startfile for the specified
18865 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18866 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18867 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18868 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18869 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18870 and later.
18872 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18873 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18874 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18875 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18876 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18877 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18879 It is @emph{important} to note that this option changes the interfaces
18880 for various library routines.  It also affects the operational behavior
18881 of the C library.  Thus, @emph{extreme} care is needed in using this
18882 option.
18884 Library code that is intended to operate with more than one UNIX
18885 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18886 as appropriate.  Most GNU software doesn't provide this capability.
18888 @item -nolibdld
18889 @opindex nolibdld
18890 Suppress the generation of link options to search libdld.sl when the
18891 @option{-static} option is specified on HP-UX 10 and later.
18893 @item -static
18894 @opindex static
18895 The HP-UX implementation of setlocale in libc has a dependency on
18896 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18897 when the @option{-static} option is specified, special link options
18898 are needed to resolve this dependency.
18900 On HP-UX 10 and later, the GCC driver adds the necessary options to
18901 link with libdld.sl when the @option{-static} option is specified.
18902 This causes the resulting binary to be dynamic.  On the 64-bit port,
18903 the linkers generate dynamic binaries by default in any case.  The
18904 @option{-nolibdld} option can be used to prevent the GCC driver from
18905 adding these link options.
18907 @item -threads
18908 @opindex threads
18909 Add support for multithreading with the @dfn{dce thread} library
18910 under HP-UX@.  This option sets flags for both the preprocessor and
18911 linker.
18912 @end table
18914 @node IA-64 Options
18915 @subsection IA-64 Options
18916 @cindex IA-64 Options
18918 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18920 @table @gcctabopt
18921 @item -mbig-endian
18922 @opindex mbig-endian
18923 Generate code for a big-endian target.  This is the default for HP-UX@.
18925 @item -mlittle-endian
18926 @opindex mlittle-endian
18927 Generate code for a little-endian target.  This is the default for AIX5
18928 and GNU/Linux.
18930 @item -mgnu-as
18931 @itemx -mno-gnu-as
18932 @opindex mgnu-as
18933 @opindex mno-gnu-as
18934 Generate (or don't) code for the GNU assembler.  This is the default.
18935 @c Also, this is the default if the configure option @option{--with-gnu-as}
18936 @c is used.
18938 @item -mgnu-ld
18939 @itemx -mno-gnu-ld
18940 @opindex mgnu-ld
18941 @opindex mno-gnu-ld
18942 Generate (or don't) code for the GNU linker.  This is the default.
18943 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18944 @c is used.
18946 @item -mno-pic
18947 @opindex mno-pic
18948 Generate code that does not use a global pointer register.  The result
18949 is not position independent code, and violates the IA-64 ABI@.
18951 @item -mvolatile-asm-stop
18952 @itemx -mno-volatile-asm-stop
18953 @opindex mvolatile-asm-stop
18954 @opindex mno-volatile-asm-stop
18955 Generate (or don't) a stop bit immediately before and after volatile asm
18956 statements.
18958 @item -mregister-names
18959 @itemx -mno-register-names
18960 @opindex mregister-names
18961 @opindex mno-register-names
18962 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18963 the stacked registers.  This may make assembler output more readable.
18965 @item -mno-sdata
18966 @itemx -msdata
18967 @opindex mno-sdata
18968 @opindex msdata
18969 Disable (or enable) optimizations that use the small data section.  This may
18970 be useful for working around optimizer bugs.
18972 @item -mconstant-gp
18973 @opindex mconstant-gp
18974 Generate code that uses a single constant global pointer value.  This is
18975 useful when compiling kernel code.
18977 @item -mauto-pic
18978 @opindex mauto-pic
18979 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18980 This is useful when compiling firmware code.
18982 @item -minline-float-divide-min-latency
18983 @opindex minline-float-divide-min-latency
18984 Generate code for inline divides of floating-point values
18985 using the minimum latency algorithm.
18987 @item -minline-float-divide-max-throughput
18988 @opindex minline-float-divide-max-throughput
18989 Generate code for inline divides of floating-point values
18990 using the maximum throughput algorithm.
18992 @item -mno-inline-float-divide
18993 @opindex mno-inline-float-divide
18994 Do not generate inline code for divides of floating-point values.
18996 @item -minline-int-divide-min-latency
18997 @opindex minline-int-divide-min-latency
18998 Generate code for inline divides of integer values
18999 using the minimum latency algorithm.
19001 @item -minline-int-divide-max-throughput
19002 @opindex minline-int-divide-max-throughput
19003 Generate code for inline divides of integer values
19004 using the maximum throughput algorithm.
19006 @item -mno-inline-int-divide
19007 @opindex mno-inline-int-divide
19008 Do not generate inline code for divides of integer values.
19010 @item -minline-sqrt-min-latency
19011 @opindex minline-sqrt-min-latency
19012 Generate code for inline square roots
19013 using the minimum latency algorithm.
19015 @item -minline-sqrt-max-throughput
19016 @opindex minline-sqrt-max-throughput
19017 Generate code for inline square roots
19018 using the maximum throughput algorithm.
19020 @item -mno-inline-sqrt
19021 @opindex mno-inline-sqrt
19022 Do not generate inline code for @code{sqrt}.
19024 @item -mfused-madd
19025 @itemx -mno-fused-madd
19026 @opindex mfused-madd
19027 @opindex mno-fused-madd
19028 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19029 instructions.  The default is to use these instructions.
19031 @item -mno-dwarf2-asm
19032 @itemx -mdwarf2-asm
19033 @opindex mno-dwarf2-asm
19034 @opindex mdwarf2-asm
19035 Don't (or do) generate assembler code for the DWARF line number debugging
19036 info.  This may be useful when not using the GNU assembler.
19038 @item -mearly-stop-bits
19039 @itemx -mno-early-stop-bits
19040 @opindex mearly-stop-bits
19041 @opindex mno-early-stop-bits
19042 Allow stop bits to be placed earlier than immediately preceding the
19043 instruction that triggered the stop bit.  This can improve instruction
19044 scheduling, but does not always do so.
19046 @item -mfixed-range=@var{register-range}
19047 @opindex mfixed-range
19048 Generate code treating the given register range as fixed registers.
19049 A fixed register is one that the register allocator cannot use.  This is
19050 useful when compiling kernel code.  A register range is specified as
19051 two registers separated by a dash.  Multiple register ranges can be
19052 specified separated by a comma.
19054 @item -mtls-size=@var{tls-size}
19055 @opindex mtls-size
19056 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19059 @item -mtune=@var{cpu-type}
19060 @opindex mtune
19061 Tune the instruction scheduling for a particular CPU, Valid values are
19062 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19063 and @samp{mckinley}.
19065 @item -milp32
19066 @itemx -mlp64
19067 @opindex milp32
19068 @opindex mlp64
19069 Generate code for a 32-bit or 64-bit environment.
19070 The 32-bit environment sets int, long and pointer to 32 bits.
19071 The 64-bit environment sets int to 32 bits and long and pointer
19072 to 64 bits.  These are HP-UX specific flags.
19074 @item -mno-sched-br-data-spec
19075 @itemx -msched-br-data-spec
19076 @opindex mno-sched-br-data-spec
19077 @opindex msched-br-data-spec
19078 (Dis/En)able data speculative scheduling before reload.
19079 This results in generation of @code{ld.a} instructions and
19080 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19081 The default setting is disabled.
19083 @item -msched-ar-data-spec
19084 @itemx -mno-sched-ar-data-spec
19085 @opindex msched-ar-data-spec
19086 @opindex mno-sched-ar-data-spec
19087 (En/Dis)able data speculative scheduling after reload.
19088 This results in generation of @code{ld.a} instructions and
19089 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19090 The default setting is enabled.
19092 @item -mno-sched-control-spec
19093 @itemx -msched-control-spec
19094 @opindex mno-sched-control-spec
19095 @opindex msched-control-spec
19096 (Dis/En)able control speculative scheduling.  This feature is
19097 available only during region scheduling (i.e.@: before reload).
19098 This results in generation of the @code{ld.s} instructions and
19099 the corresponding check instructions @code{chk.s}.
19100 The default setting is disabled.
19102 @item -msched-br-in-data-spec
19103 @itemx -mno-sched-br-in-data-spec
19104 @opindex msched-br-in-data-spec
19105 @opindex mno-sched-br-in-data-spec
19106 (En/Dis)able speculative scheduling of the instructions that
19107 are dependent on the data speculative loads before reload.
19108 This is effective only with @option{-msched-br-data-spec} enabled.
19109 The default setting is enabled.
19111 @item -msched-ar-in-data-spec
19112 @itemx -mno-sched-ar-in-data-spec
19113 @opindex msched-ar-in-data-spec
19114 @opindex mno-sched-ar-in-data-spec
19115 (En/Dis)able speculative scheduling of the instructions that
19116 are dependent on the data speculative loads after reload.
19117 This is effective only with @option{-msched-ar-data-spec} enabled.
19118 The default setting is enabled.
19120 @item -msched-in-control-spec
19121 @itemx -mno-sched-in-control-spec
19122 @opindex msched-in-control-spec
19123 @opindex mno-sched-in-control-spec
19124 (En/Dis)able speculative scheduling of the instructions that
19125 are dependent on the control speculative loads.
19126 This is effective only with @option{-msched-control-spec} enabled.
19127 The default setting is enabled.
19129 @item -mno-sched-prefer-non-data-spec-insns
19130 @itemx -msched-prefer-non-data-spec-insns
19131 @opindex mno-sched-prefer-non-data-spec-insns
19132 @opindex msched-prefer-non-data-spec-insns
19133 If enabled, data-speculative instructions are chosen for schedule
19134 only if there are no other choices at the moment.  This makes
19135 the use of the data speculation much more conservative.
19136 The default setting is disabled.
19138 @item -mno-sched-prefer-non-control-spec-insns
19139 @itemx -msched-prefer-non-control-spec-insns
19140 @opindex mno-sched-prefer-non-control-spec-insns
19141 @opindex msched-prefer-non-control-spec-insns
19142 If enabled, control-speculative instructions are chosen for schedule
19143 only if there are no other choices at the moment.  This makes
19144 the use of the control speculation much more conservative.
19145 The default setting is disabled.
19147 @item -mno-sched-count-spec-in-critical-path
19148 @itemx -msched-count-spec-in-critical-path
19149 @opindex mno-sched-count-spec-in-critical-path
19150 @opindex msched-count-spec-in-critical-path
19151 If enabled, speculative dependencies are considered during
19152 computation of the instructions priorities.  This makes the use of the
19153 speculation a bit more conservative.
19154 The default setting is disabled.
19156 @item -msched-spec-ldc
19157 @opindex msched-spec-ldc
19158 Use a simple data speculation check.  This option is on by default.
19160 @item -msched-control-spec-ldc
19161 @opindex msched-spec-ldc
19162 Use a simple check for control speculation.  This option is on by default.
19164 @item -msched-stop-bits-after-every-cycle
19165 @opindex msched-stop-bits-after-every-cycle
19166 Place a stop bit after every cycle when scheduling.  This option is on
19167 by default.
19169 @item -msched-fp-mem-deps-zero-cost
19170 @opindex msched-fp-mem-deps-zero-cost
19171 Assume that floating-point stores and loads are not likely to cause a conflict
19172 when placed into the same instruction group.  This option is disabled by
19173 default.
19175 @item -msel-sched-dont-check-control-spec
19176 @opindex msel-sched-dont-check-control-spec
19177 Generate checks for control speculation in selective scheduling.
19178 This flag is disabled by default.
19180 @item -msched-max-memory-insns=@var{max-insns}
19181 @opindex msched-max-memory-insns
19182 Limit on the number of memory insns per instruction group, giving lower
19183 priority to subsequent memory insns attempting to schedule in the same
19184 instruction group. Frequently useful to prevent cache bank conflicts.
19185 The default value is 1.
19187 @item -msched-max-memory-insns-hard-limit
19188 @opindex msched-max-memory-insns-hard-limit
19189 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19190 disallowing more than that number in an instruction group.
19191 Otherwise, the limit is ``soft'', meaning that non-memory operations
19192 are preferred when the limit is reached, but memory operations may still
19193 be scheduled.
19195 @end table
19197 @node LM32 Options
19198 @subsection LM32 Options
19199 @cindex LM32 options
19201 These @option{-m} options are defined for the LatticeMico32 architecture:
19203 @table @gcctabopt
19204 @item -mbarrel-shift-enabled
19205 @opindex mbarrel-shift-enabled
19206 Enable barrel-shift instructions.
19208 @item -mdivide-enabled
19209 @opindex mdivide-enabled
19210 Enable divide and modulus instructions.
19212 @item -mmultiply-enabled
19213 @opindex multiply-enabled
19214 Enable multiply instructions.
19216 @item -msign-extend-enabled
19217 @opindex msign-extend-enabled
19218 Enable sign extend instructions.
19220 @item -muser-enabled
19221 @opindex muser-enabled
19222 Enable user-defined instructions.
19224 @end table
19226 @node M32C Options
19227 @subsection M32C Options
19228 @cindex M32C options
19230 @table @gcctabopt
19231 @item -mcpu=@var{name}
19232 @opindex mcpu=
19233 Select the CPU for which code is generated.  @var{name} may be one of
19234 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19235 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19236 the M32C/80 series.
19238 @item -msim
19239 @opindex msim
19240 Specifies that the program will be run on the simulator.  This causes
19241 an alternate runtime library to be linked in which supports, for
19242 example, file I/O@.  You must not use this option when generating
19243 programs that will run on real hardware; you must provide your own
19244 runtime library for whatever I/O functions are needed.
19246 @item -memregs=@var{number}
19247 @opindex memregs=
19248 Specifies the number of memory-based pseudo-registers GCC uses
19249 during code generation.  These pseudo-registers are used like real
19250 registers, so there is a tradeoff between GCC's ability to fit the
19251 code into available registers, and the performance penalty of using
19252 memory instead of registers.  Note that all modules in a program must
19253 be compiled with the same value for this option.  Because of that, you
19254 must not use this option with GCC's default runtime libraries.
19256 @end table
19258 @node M32R/D Options
19259 @subsection M32R/D Options
19260 @cindex M32R/D options
19262 These @option{-m} options are defined for Renesas M32R/D architectures:
19264 @table @gcctabopt
19265 @item -m32r2
19266 @opindex m32r2
19267 Generate code for the M32R/2@.
19269 @item -m32rx
19270 @opindex m32rx
19271 Generate code for the M32R/X@.
19273 @item -m32r
19274 @opindex m32r
19275 Generate code for the M32R@.  This is the default.
19277 @item -mmodel=small
19278 @opindex mmodel=small
19279 Assume all objects live in the lower 16MB of memory (so that their addresses
19280 can be loaded with the @code{ld24} instruction), and assume all subroutines
19281 are reachable with the @code{bl} instruction.
19282 This is the default.
19284 The addressability of a particular object can be set with the
19285 @code{model} attribute.
19287 @item -mmodel=medium
19288 @opindex mmodel=medium
19289 Assume objects may be anywhere in the 32-bit address space (the compiler
19290 generates @code{seth/add3} instructions to load their addresses), and
19291 assume all subroutines are reachable with the @code{bl} instruction.
19293 @item -mmodel=large
19294 @opindex mmodel=large
19295 Assume objects may be anywhere in the 32-bit address space (the compiler
19296 generates @code{seth/add3} instructions to load their addresses), and
19297 assume subroutines may not be reachable with the @code{bl} instruction
19298 (the compiler generates the much slower @code{seth/add3/jl}
19299 instruction sequence).
19301 @item -msdata=none
19302 @opindex msdata=none
19303 Disable use of the small data area.  Variables are put into
19304 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19305 @code{section} attribute has been specified).
19306 This is the default.
19308 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19309 Objects may be explicitly put in the small data area with the
19310 @code{section} attribute using one of these sections.
19312 @item -msdata=sdata
19313 @opindex msdata=sdata
19314 Put small global and static data in the small data area, but do not
19315 generate special code to reference them.
19317 @item -msdata=use
19318 @opindex msdata=use
19319 Put small global and static data in the small data area, and generate
19320 special instructions to reference them.
19322 @item -G @var{num}
19323 @opindex G
19324 @cindex smaller data references
19325 Put global and static objects less than or equal to @var{num} bytes
19326 into the small data or BSS sections instead of the normal data or BSS
19327 sections.  The default value of @var{num} is 8.
19328 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19329 for this option to have any effect.
19331 All modules should be compiled with the same @option{-G @var{num}} value.
19332 Compiling with different values of @var{num} may or may not work; if it
19333 doesn't the linker gives an error message---incorrect code is not
19334 generated.
19336 @item -mdebug
19337 @opindex mdebug
19338 Makes the M32R-specific code in the compiler display some statistics
19339 that might help in debugging programs.
19341 @item -malign-loops
19342 @opindex malign-loops
19343 Align all loops to a 32-byte boundary.
19345 @item -mno-align-loops
19346 @opindex mno-align-loops
19347 Do not enforce a 32-byte alignment for loops.  This is the default.
19349 @item -missue-rate=@var{number}
19350 @opindex missue-rate=@var{number}
19351 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19352 or 2.
19354 @item -mbranch-cost=@var{number}
19355 @opindex mbranch-cost=@var{number}
19356 @var{number} can only be 1 or 2.  If it is 1 then branches are
19357 preferred over conditional code, if it is 2, then the opposite applies.
19359 @item -mflush-trap=@var{number}
19360 @opindex mflush-trap=@var{number}
19361 Specifies the trap number to use to flush the cache.  The default is
19362 12.  Valid numbers are between 0 and 15 inclusive.
19364 @item -mno-flush-trap
19365 @opindex mno-flush-trap
19366 Specifies that the cache cannot be flushed by using a trap.
19368 @item -mflush-func=@var{name}
19369 @opindex mflush-func=@var{name}
19370 Specifies the name of the operating system function to call to flush
19371 the cache.  The default is @samp{_flush_cache}, but a function call
19372 is only used if a trap is not available.
19374 @item -mno-flush-func
19375 @opindex mno-flush-func
19376 Indicates that there is no OS function for flushing the cache.
19378 @end table
19380 @node M680x0 Options
19381 @subsection M680x0 Options
19382 @cindex M680x0 options
19384 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19385 The default settings depend on which architecture was selected when
19386 the compiler was configured; the defaults for the most common choices
19387 are given below.
19389 @table @gcctabopt
19390 @item -march=@var{arch}
19391 @opindex march
19392 Generate code for a specific M680x0 or ColdFire instruction set
19393 architecture.  Permissible values of @var{arch} for M680x0
19394 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19395 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19396 architectures are selected according to Freescale's ISA classification
19397 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19398 @samp{isab} and @samp{isac}.
19400 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19401 code for a ColdFire target.  The @var{arch} in this macro is one of the
19402 @option{-march} arguments given above.
19404 When used together, @option{-march} and @option{-mtune} select code
19405 that runs on a family of similar processors but that is optimized
19406 for a particular microarchitecture.
19408 @item -mcpu=@var{cpu}
19409 @opindex mcpu
19410 Generate code for a specific M680x0 or ColdFire processor.
19411 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19412 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19413 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19414 below, which also classifies the CPUs into families:
19416 @multitable @columnfractions 0.20 0.80
19417 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19418 @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}
19419 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19420 @item @samp{5206e} @tab @samp{5206e}
19421 @item @samp{5208} @tab @samp{5207} @samp{5208}
19422 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19423 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19424 @item @samp{5216} @tab @samp{5214} @samp{5216}
19425 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19426 @item @samp{5225} @tab @samp{5224} @samp{5225}
19427 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19428 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19429 @item @samp{5249} @tab @samp{5249}
19430 @item @samp{5250} @tab @samp{5250}
19431 @item @samp{5271} @tab @samp{5270} @samp{5271}
19432 @item @samp{5272} @tab @samp{5272}
19433 @item @samp{5275} @tab @samp{5274} @samp{5275}
19434 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19435 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19436 @item @samp{5307} @tab @samp{5307}
19437 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19438 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19439 @item @samp{5407} @tab @samp{5407}
19440 @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}
19441 @end multitable
19443 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19444 @var{arch} is compatible with @var{cpu}.  Other combinations of
19445 @option{-mcpu} and @option{-march} are rejected.
19447 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19448 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19449 where the value of @var{family} is given by the table above.
19451 @item -mtune=@var{tune}
19452 @opindex mtune
19453 Tune the code for a particular microarchitecture within the
19454 constraints set by @option{-march} and @option{-mcpu}.
19455 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19456 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19457 and @samp{cpu32}.  The ColdFire microarchitectures
19458 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19460 You can also use @option{-mtune=68020-40} for code that needs
19461 to run relatively well on 68020, 68030 and 68040 targets.
19462 @option{-mtune=68020-60} is similar but includes 68060 targets
19463 as well.  These two options select the same tuning decisions as
19464 @option{-m68020-40} and @option{-m68020-60} respectively.
19466 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19467 when tuning for 680x0 architecture @var{arch}.  It also defines
19468 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19469 option is used.  If GCC is tuning for a range of architectures,
19470 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19471 it defines the macros for every architecture in the range.
19473 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19474 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19475 of the arguments given above.
19477 @item -m68000
19478 @itemx -mc68000
19479 @opindex m68000
19480 @opindex mc68000
19481 Generate output for a 68000.  This is the default
19482 when the compiler is configured for 68000-based systems.
19483 It is equivalent to @option{-march=68000}.
19485 Use this option for microcontrollers with a 68000 or EC000 core,
19486 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19488 @item -m68010
19489 @opindex m68010
19490 Generate output for a 68010.  This is the default
19491 when the compiler is configured for 68010-based systems.
19492 It is equivalent to @option{-march=68010}.
19494 @item -m68020
19495 @itemx -mc68020
19496 @opindex m68020
19497 @opindex mc68020
19498 Generate output for a 68020.  This is the default
19499 when the compiler is configured for 68020-based systems.
19500 It is equivalent to @option{-march=68020}.
19502 @item -m68030
19503 @opindex m68030
19504 Generate output for a 68030.  This is the default when the compiler is
19505 configured for 68030-based systems.  It is equivalent to
19506 @option{-march=68030}.
19508 @item -m68040
19509 @opindex m68040
19510 Generate output for a 68040.  This is the default when the compiler is
19511 configured for 68040-based systems.  It is equivalent to
19512 @option{-march=68040}.
19514 This option inhibits the use of 68881/68882 instructions that have to be
19515 emulated by software on the 68040.  Use this option if your 68040 does not
19516 have code to emulate those instructions.
19518 @item -m68060
19519 @opindex m68060
19520 Generate output for a 68060.  This is the default when the compiler is
19521 configured for 68060-based systems.  It is equivalent to
19522 @option{-march=68060}.
19524 This option inhibits the use of 68020 and 68881/68882 instructions that
19525 have to be emulated by software on the 68060.  Use this option if your 68060
19526 does not have code to emulate those instructions.
19528 @item -mcpu32
19529 @opindex mcpu32
19530 Generate output for a CPU32.  This is the default
19531 when the compiler is configured for CPU32-based systems.
19532 It is equivalent to @option{-march=cpu32}.
19534 Use this option for microcontrollers with a
19535 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19536 68336, 68340, 68341, 68349 and 68360.
19538 @item -m5200
19539 @opindex m5200
19540 Generate output for a 520X ColdFire CPU@.  This is the default
19541 when the compiler is configured for 520X-based systems.
19542 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19543 in favor of that option.
19545 Use this option for microcontroller with a 5200 core, including
19546 the MCF5202, MCF5203, MCF5204 and MCF5206.
19548 @item -m5206e
19549 @opindex m5206e
19550 Generate output for a 5206e ColdFire CPU@.  The option is now
19551 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19553 @item -m528x
19554 @opindex m528x
19555 Generate output for a member of the ColdFire 528X family.
19556 The option is now deprecated in favor of the equivalent
19557 @option{-mcpu=528x}.
19559 @item -m5307
19560 @opindex m5307
19561 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19562 in favor of the equivalent @option{-mcpu=5307}.
19564 @item -m5407
19565 @opindex m5407
19566 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19567 in favor of the equivalent @option{-mcpu=5407}.
19569 @item -mcfv4e
19570 @opindex mcfv4e
19571 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19572 This includes use of hardware floating-point instructions.
19573 The option is equivalent to @option{-mcpu=547x}, and is now
19574 deprecated in favor of that option.
19576 @item -m68020-40
19577 @opindex m68020-40
19578 Generate output for a 68040, without using any of the new instructions.
19579 This results in code that can run relatively efficiently on either a
19580 68020/68881 or a 68030 or a 68040.  The generated code does use the
19581 68881 instructions that are emulated on the 68040.
19583 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19585 @item -m68020-60
19586 @opindex m68020-60
19587 Generate output for a 68060, without using any of the new instructions.
19588 This results in code that can run relatively efficiently on either a
19589 68020/68881 or a 68030 or a 68040.  The generated code does use the
19590 68881 instructions that are emulated on the 68060.
19592 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19594 @item -mhard-float
19595 @itemx -m68881
19596 @opindex mhard-float
19597 @opindex m68881
19598 Generate floating-point instructions.  This is the default for 68020
19599 and above, and for ColdFire devices that have an FPU@.  It defines the
19600 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19601 on ColdFire targets.
19603 @item -msoft-float
19604 @opindex msoft-float
19605 Do not generate floating-point instructions; use library calls instead.
19606 This is the default for 68000, 68010, and 68832 targets.  It is also
19607 the default for ColdFire devices that have no FPU.
19609 @item -mdiv
19610 @itemx -mno-div
19611 @opindex mdiv
19612 @opindex mno-div
19613 Generate (do not generate) ColdFire hardware divide and remainder
19614 instructions.  If @option{-march} is used without @option{-mcpu},
19615 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19616 architectures.  Otherwise, the default is taken from the target CPU
19617 (either the default CPU, or the one specified by @option{-mcpu}).  For
19618 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19619 @option{-mcpu=5206e}.
19621 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19623 @item -mshort
19624 @opindex mshort
19625 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19626 Additionally, parameters passed on the stack are also aligned to a
19627 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19629 @item -mno-short
19630 @opindex mno-short
19631 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19633 @item -mnobitfield
19634 @itemx -mno-bitfield
19635 @opindex mnobitfield
19636 @opindex mno-bitfield
19637 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19638 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19640 @item -mbitfield
19641 @opindex mbitfield
19642 Do use the bit-field instructions.  The @option{-m68020} option implies
19643 @option{-mbitfield}.  This is the default if you use a configuration
19644 designed for a 68020.
19646 @item -mrtd
19647 @opindex mrtd
19648 Use a different function-calling convention, in which functions
19649 that take a fixed number of arguments return with the @code{rtd}
19650 instruction, which pops their arguments while returning.  This
19651 saves one instruction in the caller since there is no need to pop
19652 the arguments there.
19654 This calling convention is incompatible with the one normally
19655 used on Unix, so you cannot use it if you need to call libraries
19656 compiled with the Unix compiler.
19658 Also, you must provide function prototypes for all functions that
19659 take variable numbers of arguments (including @code{printf});
19660 otherwise incorrect code is generated for calls to those
19661 functions.
19663 In addition, seriously incorrect code results if you call a
19664 function with too many arguments.  (Normally, extra arguments are
19665 harmlessly ignored.)
19667 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19668 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19670 @item -mno-rtd
19671 @opindex mno-rtd
19672 Do not use the calling conventions selected by @option{-mrtd}.
19673 This is the default.
19675 @item -malign-int
19676 @itemx -mno-align-int
19677 @opindex malign-int
19678 @opindex mno-align-int
19679 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19680 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19681 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19682 Aligning variables on 32-bit boundaries produces code that runs somewhat
19683 faster on processors with 32-bit busses at the expense of more memory.
19685 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19686 aligns structures containing the above types differently than
19687 most published application binary interface specifications for the m68k.
19689 @item -mpcrel
19690 @opindex mpcrel
19691 Use the pc-relative addressing mode of the 68000 directly, instead of
19692 using a global offset table.  At present, this option implies @option{-fpic},
19693 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19694 not presently supported with @option{-mpcrel}, though this could be supported for
19695 68020 and higher processors.
19697 @item -mno-strict-align
19698 @itemx -mstrict-align
19699 @opindex mno-strict-align
19700 @opindex mstrict-align
19701 Do not (do) assume that unaligned memory references are handled by
19702 the system.
19704 @item -msep-data
19705 Generate code that allows the data segment to be located in a different
19706 area of memory from the text segment.  This allows for execute-in-place in
19707 an environment without virtual memory management.  This option implies
19708 @option{-fPIC}.
19710 @item -mno-sep-data
19711 Generate code that assumes that the data segment follows the text segment.
19712 This is the default.
19714 @item -mid-shared-library
19715 Generate code that supports shared libraries via the library ID method.
19716 This allows for execute-in-place and shared libraries in an environment
19717 without virtual memory management.  This option implies @option{-fPIC}.
19719 @item -mno-id-shared-library
19720 Generate code that doesn't assume ID-based shared libraries are being used.
19721 This is the default.
19723 @item -mshared-library-id=n
19724 Specifies the identification number of the ID-based shared library being
19725 compiled.  Specifying a value of 0 generates more compact code; specifying
19726 other values forces the allocation of that number to the current
19727 library, but is no more space- or time-efficient than omitting this option.
19729 @item -mxgot
19730 @itemx -mno-xgot
19731 @opindex mxgot
19732 @opindex mno-xgot
19733 When generating position-independent code for ColdFire, generate code
19734 that works if the GOT has more than 8192 entries.  This code is
19735 larger and slower than code generated without this option.  On M680x0
19736 processors, this option is not needed; @option{-fPIC} suffices.
19738 GCC normally uses a single instruction to load values from the GOT@.
19739 While this is relatively efficient, it only works if the GOT
19740 is smaller than about 64k.  Anything larger causes the linker
19741 to report an error such as:
19743 @cindex relocation truncated to fit (ColdFire)
19744 @smallexample
19745 relocation truncated to fit: R_68K_GOT16O foobar
19746 @end smallexample
19748 If this happens, you should recompile your code with @option{-mxgot}.
19749 It should then work with very large GOTs.  However, code generated with
19750 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19751 the value of a global symbol.
19753 Note that some linkers, including newer versions of the GNU linker,
19754 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19755 you should only need to use @option{-mxgot} when compiling a single
19756 object file that accesses more than 8192 GOT entries.  Very few do.
19758 These options have no effect unless GCC is generating
19759 position-independent code.
19761 @item -mlong-jump-table-offsets
19762 @opindex mlong-jump-table-offsets
19763 Use 32-bit offsets in @code{switch} tables.  The default is to use
19764 16-bit offsets.
19766 @end table
19768 @node MCore Options
19769 @subsection MCore Options
19770 @cindex MCore options
19772 These are the @samp{-m} options defined for the Motorola M*Core
19773 processors.
19775 @table @gcctabopt
19777 @item -mhardlit
19778 @itemx -mno-hardlit
19779 @opindex mhardlit
19780 @opindex mno-hardlit
19781 Inline constants into the code stream if it can be done in two
19782 instructions or less.
19784 @item -mdiv
19785 @itemx -mno-div
19786 @opindex mdiv
19787 @opindex mno-div
19788 Use the divide instruction.  (Enabled by default).
19790 @item -mrelax-immediate
19791 @itemx -mno-relax-immediate
19792 @opindex mrelax-immediate
19793 @opindex mno-relax-immediate
19794 Allow arbitrary-sized immediates in bit operations.
19796 @item -mwide-bitfields
19797 @itemx -mno-wide-bitfields
19798 @opindex mwide-bitfields
19799 @opindex mno-wide-bitfields
19800 Always treat bit-fields as @code{int}-sized.
19802 @item -m4byte-functions
19803 @itemx -mno-4byte-functions
19804 @opindex m4byte-functions
19805 @opindex mno-4byte-functions
19806 Force all functions to be aligned to a 4-byte boundary.
19808 @item -mcallgraph-data
19809 @itemx -mno-callgraph-data
19810 @opindex mcallgraph-data
19811 @opindex mno-callgraph-data
19812 Emit callgraph information.
19814 @item -mslow-bytes
19815 @itemx -mno-slow-bytes
19816 @opindex mslow-bytes
19817 @opindex mno-slow-bytes
19818 Prefer word access when reading byte quantities.
19820 @item -mlittle-endian
19821 @itemx -mbig-endian
19822 @opindex mlittle-endian
19823 @opindex mbig-endian
19824 Generate code for a little-endian target.
19826 @item -m210
19827 @itemx -m340
19828 @opindex m210
19829 @opindex m340
19830 Generate code for the 210 processor.
19832 @item -mno-lsim
19833 @opindex mno-lsim
19834 Assume that runtime support has been provided and so omit the
19835 simulator library (@file{libsim.a)} from the linker command line.
19837 @item -mstack-increment=@var{size}
19838 @opindex mstack-increment
19839 Set the maximum amount for a single stack increment operation.  Large
19840 values can increase the speed of programs that contain functions
19841 that need a large amount of stack space, but they can also trigger a
19842 segmentation fault if the stack is extended too much.  The default
19843 value is 0x1000.
19845 @end table
19847 @node MeP Options
19848 @subsection MeP Options
19849 @cindex MeP options
19851 @table @gcctabopt
19853 @item -mabsdiff
19854 @opindex mabsdiff
19855 Enables the @code{abs} instruction, which is the absolute difference
19856 between two registers.
19858 @item -mall-opts
19859 @opindex mall-opts
19860 Enables all the optional instructions---average, multiply, divide, bit
19861 operations, leading zero, absolute difference, min/max, clip, and
19862 saturation.
19865 @item -maverage
19866 @opindex maverage
19867 Enables the @code{ave} instruction, which computes the average of two
19868 registers.
19870 @item -mbased=@var{n}
19871 @opindex mbased=
19872 Variables of size @var{n} bytes or smaller are placed in the
19873 @code{.based} section by default.  Based variables use the @code{$tp}
19874 register as a base register, and there is a 128-byte limit to the
19875 @code{.based} section.
19877 @item -mbitops
19878 @opindex mbitops
19879 Enables the bit operation instructions---bit test (@code{btstm}), set
19880 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19881 test-and-set (@code{tas}).
19883 @item -mc=@var{name}
19884 @opindex mc=
19885 Selects which section constant data is placed in.  @var{name} may
19886 be @samp{tiny}, @samp{near}, or @samp{far}.
19888 @item -mclip
19889 @opindex mclip
19890 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19891 useful unless you also provide @option{-mminmax}.
19893 @item -mconfig=@var{name}
19894 @opindex mconfig=
19895 Selects one of the built-in core configurations.  Each MeP chip has
19896 one or more modules in it; each module has a core CPU and a variety of
19897 coprocessors, optional instructions, and peripherals.  The
19898 @code{MeP-Integrator} tool, not part of GCC, provides these
19899 configurations through this option; using this option is the same as
19900 using all the corresponding command-line options.  The default
19901 configuration is @samp{default}.
19903 @item -mcop
19904 @opindex mcop
19905 Enables the coprocessor instructions.  By default, this is a 32-bit
19906 coprocessor.  Note that the coprocessor is normally enabled via the
19907 @option{-mconfig=} option.
19909 @item -mcop32
19910 @opindex mcop32
19911 Enables the 32-bit coprocessor's instructions.
19913 @item -mcop64
19914 @opindex mcop64
19915 Enables the 64-bit coprocessor's instructions.
19917 @item -mivc2
19918 @opindex mivc2
19919 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19921 @item -mdc
19922 @opindex mdc
19923 Causes constant variables to be placed in the @code{.near} section.
19925 @item -mdiv
19926 @opindex mdiv
19927 Enables the @code{div} and @code{divu} instructions.
19929 @item -meb
19930 @opindex meb
19931 Generate big-endian code.
19933 @item -mel
19934 @opindex mel
19935 Generate little-endian code.
19937 @item -mio-volatile
19938 @opindex mio-volatile
19939 Tells the compiler that any variable marked with the @code{io}
19940 attribute is to be considered volatile.
19942 @item -ml
19943 @opindex ml
19944 Causes variables to be assigned to the @code{.far} section by default.
19946 @item -mleadz
19947 @opindex mleadz
19948 Enables the @code{leadz} (leading zero) instruction.
19950 @item -mm
19951 @opindex mm
19952 Causes variables to be assigned to the @code{.near} section by default.
19954 @item -mminmax
19955 @opindex mminmax
19956 Enables the @code{min} and @code{max} instructions.
19958 @item -mmult
19959 @opindex mmult
19960 Enables the multiplication and multiply-accumulate instructions.
19962 @item -mno-opts
19963 @opindex mno-opts
19964 Disables all the optional instructions enabled by @option{-mall-opts}.
19966 @item -mrepeat
19967 @opindex mrepeat
19968 Enables the @code{repeat} and @code{erepeat} instructions, used for
19969 low-overhead looping.
19971 @item -ms
19972 @opindex ms
19973 Causes all variables to default to the @code{.tiny} section.  Note
19974 that there is a 65536-byte limit to this section.  Accesses to these
19975 variables use the @code{%gp} base register.
19977 @item -msatur
19978 @opindex msatur
19979 Enables the saturation instructions.  Note that the compiler does not
19980 currently generate these itself, but this option is included for
19981 compatibility with other tools, like @code{as}.
19983 @item -msdram
19984 @opindex msdram
19985 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19987 @item -msim
19988 @opindex msim
19989 Link the simulator run-time libraries.
19991 @item -msimnovec
19992 @opindex msimnovec
19993 Link the simulator runtime libraries, excluding built-in support
19994 for reset and exception vectors and tables.
19996 @item -mtf
19997 @opindex mtf
19998 Causes all functions to default to the @code{.far} section.  Without
19999 this option, functions default to the @code{.near} section.
20001 @item -mtiny=@var{n}
20002 @opindex mtiny=
20003 Variables that are @var{n} bytes or smaller are allocated to the
20004 @code{.tiny} section.  These variables use the @code{$gp} base
20005 register.  The default for this option is 4, but note that there's a
20006 65536-byte limit to the @code{.tiny} section.
20008 @end table
20010 @node MicroBlaze Options
20011 @subsection MicroBlaze Options
20012 @cindex MicroBlaze Options
20014 @table @gcctabopt
20016 @item -msoft-float
20017 @opindex msoft-float
20018 Use software emulation for floating point (default).
20020 @item -mhard-float
20021 @opindex mhard-float
20022 Use hardware floating-point instructions.
20024 @item -mmemcpy
20025 @opindex mmemcpy
20026 Do not optimize block moves, use @code{memcpy}.
20028 @item -mno-clearbss
20029 @opindex mno-clearbss
20030 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20032 @item -mcpu=@var{cpu-type}
20033 @opindex mcpu=
20034 Use features of, and schedule code for, the given CPU.
20035 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20036 where @var{X} is a major version, @var{YY} is the minor version, and
20037 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20038 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20040 @item -mxl-soft-mul
20041 @opindex mxl-soft-mul
20042 Use software multiply emulation (default).
20044 @item -mxl-soft-div
20045 @opindex mxl-soft-div
20046 Use software emulation for divides (default).
20048 @item -mxl-barrel-shift
20049 @opindex mxl-barrel-shift
20050 Use the hardware barrel shifter.
20052 @item -mxl-pattern-compare
20053 @opindex mxl-pattern-compare
20054 Use pattern compare instructions.
20056 @item -msmall-divides
20057 @opindex msmall-divides
20058 Use table lookup optimization for small signed integer divisions.
20060 @item -mxl-stack-check
20061 @opindex mxl-stack-check
20062 This option is deprecated.  Use @option{-fstack-check} instead.
20064 @item -mxl-gp-opt
20065 @opindex mxl-gp-opt
20066 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20068 @item -mxl-multiply-high
20069 @opindex mxl-multiply-high
20070 Use multiply high instructions for high part of 32x32 multiply.
20072 @item -mxl-float-convert
20073 @opindex mxl-float-convert
20074 Use hardware floating-point conversion instructions.
20076 @item -mxl-float-sqrt
20077 @opindex mxl-float-sqrt
20078 Use hardware floating-point square root instruction.
20080 @item -mbig-endian
20081 @opindex mbig-endian
20082 Generate code for a big-endian target.
20084 @item -mlittle-endian
20085 @opindex mlittle-endian
20086 Generate code for a little-endian target.
20088 @item -mxl-reorder
20089 @opindex mxl-reorder
20090 Use reorder instructions (swap and byte reversed load/store).
20092 @item -mxl-mode-@var{app-model}
20093 Select application model @var{app-model}.  Valid models are
20094 @table @samp
20095 @item executable
20096 normal executable (default), uses startup code @file{crt0.o}.
20098 @item xmdstub
20099 for use with Xilinx Microprocessor Debugger (XMD) based
20100 software intrusive debug agent called xmdstub. This uses startup file
20101 @file{crt1.o} and sets the start address of the program to 0x800.
20103 @item bootstrap
20104 for applications that are loaded using a bootloader.
20105 This model uses startup file @file{crt2.o} which does not contain a processor
20106 reset vector handler. This is suitable for transferring control on a
20107 processor reset to the bootloader rather than the application.
20109 @item novectors
20110 for applications that do not require any of the
20111 MicroBlaze vectors. This option may be useful for applications running
20112 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20113 @end table
20115 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20116 @option{-mxl-mode-@var{app-model}}.
20118 @end table
20120 @node MIPS Options
20121 @subsection MIPS Options
20122 @cindex MIPS options
20124 @table @gcctabopt
20126 @item -EB
20127 @opindex EB
20128 Generate big-endian code.
20130 @item -EL
20131 @opindex EL
20132 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20133 configurations.
20135 @item -march=@var{arch}
20136 @opindex march
20137 Generate code that runs on @var{arch}, which can be the name of a
20138 generic MIPS ISA, or the name of a particular processor.
20139 The ISA names are:
20140 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20141 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20142 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20143 @samp{mips64r5} and @samp{mips64r6}.
20144 The processor names are:
20145 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20146 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20147 @samp{5kc}, @samp{5kf},
20148 @samp{20kc},
20149 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20150 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20151 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20152 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20153 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20154 @samp{i6400},
20155 @samp{interaptiv},
20156 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20157 @samp{m4k},
20158 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20159 @samp{m5100}, @samp{m5101},
20160 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20161 @samp{orion},
20162 @samp{p5600},
20163 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20164 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20165 @samp{rm7000}, @samp{rm9000},
20166 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20167 @samp{sb1},
20168 @samp{sr71000},
20169 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20170 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20171 @samp{xlr} and @samp{xlp}.
20172 The special value @samp{from-abi} selects the
20173 most compatible architecture for the selected ABI (that is,
20174 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20176 The native Linux/GNU toolchain also supports the value @samp{native},
20177 which selects the best architecture option for the host processor.
20178 @option{-march=native} has no effect if GCC does not recognize
20179 the processor.
20181 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20182 (for example, @option{-march=r2k}).  Prefixes are optional, and
20183 @samp{vr} may be written @samp{r}.
20185 Names of the form @samp{@var{n}f2_1} refer to processors with
20186 FPUs clocked at half the rate of the core, names of the form
20187 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20188 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20189 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20190 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20191 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20192 accepted as synonyms for @samp{@var{n}f1_1}.
20194 GCC defines two macros based on the value of this option.  The first
20195 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20196 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20197 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20198 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20199 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20201 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20202 above.  In other words, it has the full prefix and does not
20203 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20204 the macro names the resolved architecture (either @code{"mips1"} or
20205 @code{"mips3"}).  It names the default architecture when no
20206 @option{-march} option is given.
20208 @item -mtune=@var{arch}
20209 @opindex mtune
20210 Optimize for @var{arch}.  Among other things, this option controls
20211 the way instructions are scheduled, and the perceived cost of arithmetic
20212 operations.  The list of @var{arch} values is the same as for
20213 @option{-march}.
20215 When this option is not used, GCC optimizes for the processor
20216 specified by @option{-march}.  By using @option{-march} and
20217 @option{-mtune} together, it is possible to generate code that
20218 runs on a family of processors, but optimize the code for one
20219 particular member of that family.
20221 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20222 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20223 @option{-march} ones described above.
20225 @item -mips1
20226 @opindex mips1
20227 Equivalent to @option{-march=mips1}.
20229 @item -mips2
20230 @opindex mips2
20231 Equivalent to @option{-march=mips2}.
20233 @item -mips3
20234 @opindex mips3
20235 Equivalent to @option{-march=mips3}.
20237 @item -mips4
20238 @opindex mips4
20239 Equivalent to @option{-march=mips4}.
20241 @item -mips32
20242 @opindex mips32
20243 Equivalent to @option{-march=mips32}.
20245 @item -mips32r3
20246 @opindex mips32r3
20247 Equivalent to @option{-march=mips32r3}.
20249 @item -mips32r5
20250 @opindex mips32r5
20251 Equivalent to @option{-march=mips32r5}.
20253 @item -mips32r6
20254 @opindex mips32r6
20255 Equivalent to @option{-march=mips32r6}.
20257 @item -mips64
20258 @opindex mips64
20259 Equivalent to @option{-march=mips64}.
20261 @item -mips64r2
20262 @opindex mips64r2
20263 Equivalent to @option{-march=mips64r2}.
20265 @item -mips64r3
20266 @opindex mips64r3
20267 Equivalent to @option{-march=mips64r3}.
20269 @item -mips64r5
20270 @opindex mips64r5
20271 Equivalent to @option{-march=mips64r5}.
20273 @item -mips64r6
20274 @opindex mips64r6
20275 Equivalent to @option{-march=mips64r6}.
20277 @item -mips16
20278 @itemx -mno-mips16
20279 @opindex mips16
20280 @opindex mno-mips16
20281 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20282 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20284 MIPS16 code generation can also be controlled on a per-function basis
20285 by means of @code{mips16} and @code{nomips16} attributes.
20286 @xref{Function Attributes}, for more information.
20288 @item -mflip-mips16
20289 @opindex mflip-mips16
20290 Generate MIPS16 code on alternating functions.  This option is provided
20291 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20292 not intended for ordinary use in compiling user code.
20294 @item -minterlink-compressed
20295 @itemx -mno-interlink-compressed
20296 @opindex minterlink-compressed
20297 @opindex mno-interlink-compressed
20298 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20299 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20301 For example, code using the standard ISA encoding cannot jump directly
20302 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20303 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20304 knows that the target of the jump is not compressed.
20306 @item -minterlink-mips16
20307 @itemx -mno-interlink-mips16
20308 @opindex minterlink-mips16
20309 @opindex mno-interlink-mips16
20310 Aliases of @option{-minterlink-compressed} and
20311 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20312 and are retained for backwards compatibility.
20314 @item -mabi=32
20315 @itemx -mabi=o64
20316 @itemx -mabi=n32
20317 @itemx -mabi=64
20318 @itemx -mabi=eabi
20319 @opindex mabi=32
20320 @opindex mabi=o64
20321 @opindex mabi=n32
20322 @opindex mabi=64
20323 @opindex mabi=eabi
20324 Generate code for the given ABI@.
20326 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20327 generates 64-bit code when you select a 64-bit architecture, but you
20328 can use @option{-mgp32} to get 32-bit code instead.
20330 For information about the O64 ABI, see
20331 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20333 GCC supports a variant of the o32 ABI in which floating-point registers
20334 are 64 rather than 32 bits wide.  You can select this combination with
20335 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20336 and @code{mfhc1} instructions and is therefore only supported for
20337 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20339 The register assignments for arguments and return values remain the
20340 same, but each scalar value is passed in a single 64-bit register
20341 rather than a pair of 32-bit registers.  For example, scalar
20342 floating-point values are returned in @samp{$f0} only, not a
20343 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20344 remains the same in that the even-numbered double-precision registers
20345 are saved.
20347 Two additional variants of the o32 ABI are supported to enable
20348 a transition from 32-bit to 64-bit registers.  These are FPXX
20349 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20350 The FPXX extension mandates that all code must execute correctly
20351 when run using 32-bit or 64-bit registers.  The code can be interlinked
20352 with either FP32 or FP64, but not both.
20353 The FP64A extension is similar to the FP64 extension but forbids the
20354 use of odd-numbered single-precision registers.  This can be used
20355 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20356 processors and allows both FP32 and FP64A code to interlink and
20357 run in the same process without changing FPU modes.
20359 @item -mabicalls
20360 @itemx -mno-abicalls
20361 @opindex mabicalls
20362 @opindex mno-abicalls
20363 Generate (do not generate) code that is suitable for SVR4-style
20364 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20365 systems.
20367 @item -mshared
20368 @itemx -mno-shared
20369 Generate (do not generate) code that is fully position-independent,
20370 and that can therefore be linked into shared libraries.  This option
20371 only affects @option{-mabicalls}.
20373 All @option{-mabicalls} code has traditionally been position-independent,
20374 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20375 as an extension, the GNU toolchain allows executables to use absolute
20376 accesses for locally-binding symbols.  It can also use shorter GP
20377 initialization sequences and generate direct calls to locally-defined
20378 functions.  This mode is selected by @option{-mno-shared}.
20380 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20381 objects that can only be linked by the GNU linker.  However, the option
20382 does not affect the ABI of the final executable; it only affects the ABI
20383 of relocatable objects.  Using @option{-mno-shared} generally makes
20384 executables both smaller and quicker.
20386 @option{-mshared} is the default.
20388 @item -mplt
20389 @itemx -mno-plt
20390 @opindex mplt
20391 @opindex mno-plt
20392 Assume (do not assume) that the static and dynamic linkers
20393 support PLTs and copy relocations.  This option only affects
20394 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20395 has no effect without @option{-msym32}.
20397 You can make @option{-mplt} the default by configuring
20398 GCC with @option{--with-mips-plt}.  The default is
20399 @option{-mno-plt} otherwise.
20401 @item -mxgot
20402 @itemx -mno-xgot
20403 @opindex mxgot
20404 @opindex mno-xgot
20405 Lift (do not lift) the usual restrictions on the size of the global
20406 offset table.
20408 GCC normally uses a single instruction to load values from the GOT@.
20409 While this is relatively efficient, it only works if the GOT
20410 is smaller than about 64k.  Anything larger causes the linker
20411 to report an error such as:
20413 @cindex relocation truncated to fit (MIPS)
20414 @smallexample
20415 relocation truncated to fit: R_MIPS_GOT16 foobar
20416 @end smallexample
20418 If this happens, you should recompile your code with @option{-mxgot}.
20419 This works with very large GOTs, although the code is also
20420 less efficient, since it takes three instructions to fetch the
20421 value of a global symbol.
20423 Note that some linkers can create multiple GOTs.  If you have such a
20424 linker, you should only need to use @option{-mxgot} when a single object
20425 file accesses more than 64k's worth of GOT entries.  Very few do.
20427 These options have no effect unless GCC is generating position
20428 independent code.
20430 @item -mgp32
20431 @opindex mgp32
20432 Assume that general-purpose registers are 32 bits wide.
20434 @item -mgp64
20435 @opindex mgp64
20436 Assume that general-purpose registers are 64 bits wide.
20438 @item -mfp32
20439 @opindex mfp32
20440 Assume that floating-point registers are 32 bits wide.
20442 @item -mfp64
20443 @opindex mfp64
20444 Assume that floating-point registers are 64 bits wide.
20446 @item -mfpxx
20447 @opindex mfpxx
20448 Do not assume the width of floating-point registers.
20450 @item -mhard-float
20451 @opindex mhard-float
20452 Use floating-point coprocessor instructions.
20454 @item -msoft-float
20455 @opindex msoft-float
20456 Do not use floating-point coprocessor instructions.  Implement
20457 floating-point calculations using library calls instead.
20459 @item -mno-float
20460 @opindex mno-float
20461 Equivalent to @option{-msoft-float}, but additionally asserts that the
20462 program being compiled does not perform any floating-point operations.
20463 This option is presently supported only by some bare-metal MIPS
20464 configurations, where it may select a special set of libraries
20465 that lack all floating-point support (including, for example, the
20466 floating-point @code{printf} formats).  
20467 If code compiled with @option{-mno-float} accidentally contains
20468 floating-point operations, it is likely to suffer a link-time
20469 or run-time failure.
20471 @item -msingle-float
20472 @opindex msingle-float
20473 Assume that the floating-point coprocessor only supports single-precision
20474 operations.
20476 @item -mdouble-float
20477 @opindex mdouble-float
20478 Assume that the floating-point coprocessor supports double-precision
20479 operations.  This is the default.
20481 @item -modd-spreg
20482 @itemx -mno-odd-spreg
20483 @opindex modd-spreg
20484 @opindex mno-odd-spreg
20485 Enable the use of odd-numbered single-precision floating-point registers
20486 for the o32 ABI.  This is the default for processors that are known to
20487 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20488 is set by default.
20490 @item -mabs=2008
20491 @itemx -mabs=legacy
20492 @opindex mabs=2008
20493 @opindex mabs=legacy
20494 These options control the treatment of the special not-a-number (NaN)
20495 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20496 @code{neg.@i{fmt}} machine instructions.
20498 By default or when @option{-mabs=legacy} is used the legacy
20499 treatment is selected.  In this case these instructions are considered
20500 arithmetic and avoided where correct operation is required and the
20501 input operand might be a NaN.  A longer sequence of instructions that
20502 manipulate the sign bit of floating-point datum manually is used
20503 instead unless the @option{-ffinite-math-only} option has also been
20504 specified.
20506 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20507 this case these instructions are considered non-arithmetic and therefore
20508 operating correctly in all cases, including in particular where the
20509 input operand is a NaN.  These instructions are therefore always used
20510 for the respective operations.
20512 @item -mnan=2008
20513 @itemx -mnan=legacy
20514 @opindex mnan=2008
20515 @opindex mnan=legacy
20516 These options control the encoding of the special not-a-number (NaN)
20517 IEEE 754 floating-point data.
20519 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20520 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20521 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20522 by the first bit of their trailing significand field being 1.
20524 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20525 this case qNaNs are denoted by the first bit of their trailing
20526 significand field being 1, whereas sNaNs are denoted by the first bit of
20527 their trailing significand field being 0.
20529 The default is @option{-mnan=legacy} unless GCC has been configured with
20530 @option{--with-nan=2008}.
20532 @item -mllsc
20533 @itemx -mno-llsc
20534 @opindex mllsc
20535 @opindex mno-llsc
20536 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20537 implement atomic memory built-in functions.  When neither option is
20538 specified, GCC uses the instructions if the target architecture
20539 supports them.
20541 @option{-mllsc} is useful if the runtime environment can emulate the
20542 instructions and @option{-mno-llsc} can be useful when compiling for
20543 nonstandard ISAs.  You can make either option the default by
20544 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20545 respectively.  @option{--with-llsc} is the default for some
20546 configurations; see the installation documentation for details.
20548 @item -mdsp
20549 @itemx -mno-dsp
20550 @opindex mdsp
20551 @opindex mno-dsp
20552 Use (do not use) revision 1 of the MIPS DSP ASE@.
20553 @xref{MIPS DSP Built-in Functions}.  This option defines the
20554 preprocessor macro @code{__mips_dsp}.  It also defines
20555 @code{__mips_dsp_rev} to 1.
20557 @item -mdspr2
20558 @itemx -mno-dspr2
20559 @opindex mdspr2
20560 @opindex mno-dspr2
20561 Use (do not use) revision 2 of the MIPS DSP ASE@.
20562 @xref{MIPS DSP Built-in Functions}.  This option defines the
20563 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20564 It also defines @code{__mips_dsp_rev} to 2.
20566 @item -msmartmips
20567 @itemx -mno-smartmips
20568 @opindex msmartmips
20569 @opindex mno-smartmips
20570 Use (do not use) the MIPS SmartMIPS ASE.
20572 @item -mpaired-single
20573 @itemx -mno-paired-single
20574 @opindex mpaired-single
20575 @opindex mno-paired-single
20576 Use (do not use) paired-single floating-point instructions.
20577 @xref{MIPS Paired-Single Support}.  This option requires
20578 hardware floating-point support to be enabled.
20580 @item -mdmx
20581 @itemx -mno-mdmx
20582 @opindex mdmx
20583 @opindex mno-mdmx
20584 Use (do not use) MIPS Digital Media Extension instructions.
20585 This option can only be used when generating 64-bit code and requires
20586 hardware floating-point support to be enabled.
20588 @item -mips3d
20589 @itemx -mno-mips3d
20590 @opindex mips3d
20591 @opindex mno-mips3d
20592 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20593 The option @option{-mips3d} implies @option{-mpaired-single}.
20595 @item -mmicromips
20596 @itemx -mno-micromips
20597 @opindex mmicromips
20598 @opindex mno-mmicromips
20599 Generate (do not generate) microMIPS code.
20601 MicroMIPS code generation can also be controlled on a per-function basis
20602 by means of @code{micromips} and @code{nomicromips} attributes.
20603 @xref{Function Attributes}, for more information.
20605 @item -mmt
20606 @itemx -mno-mt
20607 @opindex mmt
20608 @opindex mno-mt
20609 Use (do not use) MT Multithreading instructions.
20611 @item -mmcu
20612 @itemx -mno-mcu
20613 @opindex mmcu
20614 @opindex mno-mcu
20615 Use (do not use) the MIPS MCU ASE instructions.
20617 @item -meva
20618 @itemx -mno-eva
20619 @opindex meva
20620 @opindex mno-eva
20621 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20623 @item -mvirt
20624 @itemx -mno-virt
20625 @opindex mvirt
20626 @opindex mno-virt
20627 Use (do not use) the MIPS Virtualization (VZ) instructions.
20629 @item -mxpa
20630 @itemx -mno-xpa
20631 @opindex mxpa
20632 @opindex mno-xpa
20633 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20635 @item -mlong64
20636 @opindex mlong64
20637 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20638 an explanation of the default and the way that the pointer size is
20639 determined.
20641 @item -mlong32
20642 @opindex mlong32
20643 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20645 The default size of @code{int}s, @code{long}s and pointers depends on
20646 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20647 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20648 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20649 or the same size as integer registers, whichever is smaller.
20651 @item -msym32
20652 @itemx -mno-sym32
20653 @opindex msym32
20654 @opindex mno-sym32
20655 Assume (do not assume) that all symbols have 32-bit values, regardless
20656 of the selected ABI@.  This option is useful in combination with
20657 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20658 to generate shorter and faster references to symbolic addresses.
20660 @item -G @var{num}
20661 @opindex G
20662 Put definitions of externally-visible data in a small data section
20663 if that data is no bigger than @var{num} bytes.  GCC can then generate
20664 more efficient accesses to the data; see @option{-mgpopt} for details.
20666 The default @option{-G} option depends on the configuration.
20668 @item -mlocal-sdata
20669 @itemx -mno-local-sdata
20670 @opindex mlocal-sdata
20671 @opindex mno-local-sdata
20672 Extend (do not extend) the @option{-G} behavior to local data too,
20673 such as to static variables in C@.  @option{-mlocal-sdata} is the
20674 default for all configurations.
20676 If the linker complains that an application is using too much small data,
20677 you might want to try rebuilding the less performance-critical parts with
20678 @option{-mno-local-sdata}.  You might also want to build large
20679 libraries with @option{-mno-local-sdata}, so that the libraries leave
20680 more room for the main program.
20682 @item -mextern-sdata
20683 @itemx -mno-extern-sdata
20684 @opindex mextern-sdata
20685 @opindex mno-extern-sdata
20686 Assume (do not assume) that externally-defined data is in
20687 a small data section if the size of that data is within the @option{-G} limit.
20688 @option{-mextern-sdata} is the default for all configurations.
20690 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20691 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20692 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20693 is placed in a small data section.  If @var{Var} is defined by another
20694 module, you must either compile that module with a high-enough
20695 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20696 definition.  If @var{Var} is common, you must link the application
20697 with a high-enough @option{-G} setting.
20699 The easiest way of satisfying these restrictions is to compile
20700 and link every module with the same @option{-G} option.  However,
20701 you may wish to build a library that supports several different
20702 small data limits.  You can do this by compiling the library with
20703 the highest supported @option{-G} setting and additionally using
20704 @option{-mno-extern-sdata} to stop the library from making assumptions
20705 about externally-defined data.
20707 @item -mgpopt
20708 @itemx -mno-gpopt
20709 @opindex mgpopt
20710 @opindex mno-gpopt
20711 Use (do not use) GP-relative accesses for symbols that are known to be
20712 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20713 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20714 configurations.
20716 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20717 might not hold the value of @code{_gp}.  For example, if the code is
20718 part of a library that might be used in a boot monitor, programs that
20719 call boot monitor routines pass an unknown value in @code{$gp}.
20720 (In such situations, the boot monitor itself is usually compiled
20721 with @option{-G0}.)
20723 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20724 @option{-mno-extern-sdata}.
20726 @item -membedded-data
20727 @itemx -mno-embedded-data
20728 @opindex membedded-data
20729 @opindex mno-embedded-data
20730 Allocate variables to the read-only data section first if possible, then
20731 next in the small data section if possible, otherwise in data.  This gives
20732 slightly slower code than the default, but reduces the amount of RAM required
20733 when executing, and thus may be preferred for some embedded systems.
20735 @item -muninit-const-in-rodata
20736 @itemx -mno-uninit-const-in-rodata
20737 @opindex muninit-const-in-rodata
20738 @opindex mno-uninit-const-in-rodata
20739 Put uninitialized @code{const} variables in the read-only data section.
20740 This option is only meaningful in conjunction with @option{-membedded-data}.
20742 @item -mcode-readable=@var{setting}
20743 @opindex mcode-readable
20744 Specify whether GCC may generate code that reads from executable sections.
20745 There are three possible settings:
20747 @table @gcctabopt
20748 @item -mcode-readable=yes
20749 Instructions may freely access executable sections.  This is the
20750 default setting.
20752 @item -mcode-readable=pcrel
20753 MIPS16 PC-relative load instructions can access executable sections,
20754 but other instructions must not do so.  This option is useful on 4KSc
20755 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20756 It is also useful on processors that can be configured to have a dual
20757 instruction/data SRAM interface and that, like the M4K, automatically
20758 redirect PC-relative loads to the instruction RAM.
20760 @item -mcode-readable=no
20761 Instructions must not access executable sections.  This option can be
20762 useful on targets that are configured to have a dual instruction/data
20763 SRAM interface but that (unlike the M4K) do not automatically redirect
20764 PC-relative loads to the instruction RAM.
20765 @end table
20767 @item -msplit-addresses
20768 @itemx -mno-split-addresses
20769 @opindex msplit-addresses
20770 @opindex mno-split-addresses
20771 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20772 relocation operators.  This option has been superseded by
20773 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20775 @item -mexplicit-relocs
20776 @itemx -mno-explicit-relocs
20777 @opindex mexplicit-relocs
20778 @opindex mno-explicit-relocs
20779 Use (do not use) assembler relocation operators when dealing with symbolic
20780 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20781 is to use assembler macros instead.
20783 @option{-mexplicit-relocs} is the default if GCC was configured
20784 to use an assembler that supports relocation operators.
20786 @item -mcheck-zero-division
20787 @itemx -mno-check-zero-division
20788 @opindex mcheck-zero-division
20789 @opindex mno-check-zero-division
20790 Trap (do not trap) on integer division by zero.
20792 The default is @option{-mcheck-zero-division}.
20794 @item -mdivide-traps
20795 @itemx -mdivide-breaks
20796 @opindex mdivide-traps
20797 @opindex mdivide-breaks
20798 MIPS systems check for division by zero by generating either a
20799 conditional trap or a break instruction.  Using traps results in
20800 smaller code, but is only supported on MIPS II and later.  Also, some
20801 versions of the Linux kernel have a bug that prevents trap from
20802 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20803 allow conditional traps on architectures that support them and
20804 @option{-mdivide-breaks} to force the use of breaks.
20806 The default is usually @option{-mdivide-traps}, but this can be
20807 overridden at configure time using @option{--with-divide=breaks}.
20808 Divide-by-zero checks can be completely disabled using
20809 @option{-mno-check-zero-division}.
20811 @item -mload-store-pairs
20812 @itemx -mno-load-store-pairs
20813 @opindex mload-store-pairs
20814 @opindex mno-load-store-pairs
20815 Enable (disable) an optimization that pairs consecutive load or store
20816 instructions to enable load/store bonding.  This option is enabled by
20817 default but only takes effect when the selected architecture is known
20818 to support bonding.
20820 @item -mmemcpy
20821 @itemx -mno-memcpy
20822 @opindex mmemcpy
20823 @opindex mno-memcpy
20824 Force (do not force) the use of @code{memcpy} for non-trivial block
20825 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20826 most constant-sized copies.
20828 @item -mlong-calls
20829 @itemx -mno-long-calls
20830 @opindex mlong-calls
20831 @opindex mno-long-calls
20832 Disable (do not disable) use of the @code{jal} instruction.  Calling
20833 functions using @code{jal} is more efficient but requires the caller
20834 and callee to be in the same 256 megabyte segment.
20836 This option has no effect on abicalls code.  The default is
20837 @option{-mno-long-calls}.
20839 @item -mmad
20840 @itemx -mno-mad
20841 @opindex mmad
20842 @opindex mno-mad
20843 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20844 instructions, as provided by the R4650 ISA@.
20846 @item -mimadd
20847 @itemx -mno-imadd
20848 @opindex mimadd
20849 @opindex mno-imadd
20850 Enable (disable) use of the @code{madd} and @code{msub} integer
20851 instructions.  The default is @option{-mimadd} on architectures
20852 that support @code{madd} and @code{msub} except for the 74k 
20853 architecture where it was found to generate slower code.
20855 @item -mfused-madd
20856 @itemx -mno-fused-madd
20857 @opindex mfused-madd
20858 @opindex mno-fused-madd
20859 Enable (disable) use of the floating-point multiply-accumulate
20860 instructions, when they are available.  The default is
20861 @option{-mfused-madd}.
20863 On the R8000 CPU when multiply-accumulate instructions are used,
20864 the intermediate product is calculated to infinite precision
20865 and is not subject to the FCSR Flush to Zero bit.  This may be
20866 undesirable in some circumstances.  On other processors the result
20867 is numerically identical to the equivalent computation using
20868 separate multiply, add, subtract and negate instructions.
20870 @item -nocpp
20871 @opindex nocpp
20872 Tell the MIPS assembler to not run its preprocessor over user
20873 assembler files (with a @samp{.s} suffix) when assembling them.
20875 @item -mfix-24k
20876 @itemx -mno-fix-24k
20877 @opindex mfix-24k
20878 @opindex mno-fix-24k
20879 Work around the 24K E48 (lost data on stores during refill) errata.
20880 The workarounds are implemented by the assembler rather than by GCC@.
20882 @item -mfix-r4000
20883 @itemx -mno-fix-r4000
20884 @opindex mfix-r4000
20885 @opindex mno-fix-r4000
20886 Work around certain R4000 CPU errata:
20887 @itemize @minus
20888 @item
20889 A double-word or a variable shift may give an incorrect result if executed
20890 immediately after starting an integer division.
20891 @item
20892 A double-word or a variable shift may give an incorrect result if executed
20893 while an integer multiplication is in progress.
20894 @item
20895 An integer division may give an incorrect result if started in a delay slot
20896 of a taken branch or a jump.
20897 @end itemize
20899 @item -mfix-r4400
20900 @itemx -mno-fix-r4400
20901 @opindex mfix-r4400
20902 @opindex mno-fix-r4400
20903 Work around certain R4400 CPU errata:
20904 @itemize @minus
20905 @item
20906 A double-word or a variable shift may give an incorrect result if executed
20907 immediately after starting an integer division.
20908 @end itemize
20910 @item -mfix-r10000
20911 @itemx -mno-fix-r10000
20912 @opindex mfix-r10000
20913 @opindex mno-fix-r10000
20914 Work around certain R10000 errata:
20915 @itemize @minus
20916 @item
20917 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20918 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20919 @end itemize
20921 This option can only be used if the target architecture supports
20922 branch-likely instructions.  @option{-mfix-r10000} is the default when
20923 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20924 otherwise.
20926 @item -mfix-rm7000
20927 @itemx -mno-fix-rm7000
20928 @opindex mfix-rm7000
20929 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20930 workarounds are implemented by the assembler rather than by GCC@.
20932 @item -mfix-vr4120
20933 @itemx -mno-fix-vr4120
20934 @opindex mfix-vr4120
20935 Work around certain VR4120 errata:
20936 @itemize @minus
20937 @item
20938 @code{dmultu} does not always produce the correct result.
20939 @item
20940 @code{div} and @code{ddiv} do not always produce the correct result if one
20941 of the operands is negative.
20942 @end itemize
20943 The workarounds for the division errata rely on special functions in
20944 @file{libgcc.a}.  At present, these functions are only provided by
20945 the @code{mips64vr*-elf} configurations.
20947 Other VR4120 errata require a NOP to be inserted between certain pairs of
20948 instructions.  These errata are handled by the assembler, not by GCC itself.
20950 @item -mfix-vr4130
20951 @opindex mfix-vr4130
20952 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20953 workarounds are implemented by the assembler rather than by GCC,
20954 although GCC avoids using @code{mflo} and @code{mfhi} if the
20955 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20956 instructions are available instead.
20958 @item -mfix-sb1
20959 @itemx -mno-fix-sb1
20960 @opindex mfix-sb1
20961 Work around certain SB-1 CPU core errata.
20962 (This flag currently works around the SB-1 revision 2
20963 ``F1'' and ``F2'' floating-point errata.)
20965 @item -mr10k-cache-barrier=@var{setting}
20966 @opindex mr10k-cache-barrier
20967 Specify whether GCC should insert cache barriers to avoid the
20968 side-effects of speculation on R10K processors.
20970 In common with many processors, the R10K tries to predict the outcome
20971 of a conditional branch and speculatively executes instructions from
20972 the ``taken'' branch.  It later aborts these instructions if the
20973 predicted outcome is wrong.  However, on the R10K, even aborted
20974 instructions can have side effects.
20976 This problem only affects kernel stores and, depending on the system,
20977 kernel loads.  As an example, a speculatively-executed store may load
20978 the target memory into cache and mark the cache line as dirty, even if
20979 the store itself is later aborted.  If a DMA operation writes to the
20980 same area of memory before the ``dirty'' line is flushed, the cached
20981 data overwrites the DMA-ed data.  See the R10K processor manual
20982 for a full description, including other potential problems.
20984 One workaround is to insert cache barrier instructions before every memory
20985 access that might be speculatively executed and that might have side
20986 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20987 controls GCC's implementation of this workaround.  It assumes that
20988 aborted accesses to any byte in the following regions does not have
20989 side effects:
20991 @enumerate
20992 @item
20993 the memory occupied by the current function's stack frame;
20995 @item
20996 the memory occupied by an incoming stack argument;
20998 @item
20999 the memory occupied by an object with a link-time-constant address.
21000 @end enumerate
21002 It is the kernel's responsibility to ensure that speculative
21003 accesses to these regions are indeed safe.
21005 If the input program contains a function declaration such as:
21007 @smallexample
21008 void foo (void);
21009 @end smallexample
21011 then the implementation of @code{foo} must allow @code{j foo} and
21012 @code{jal foo} to be executed speculatively.  GCC honors this
21013 restriction for functions it compiles itself.  It expects non-GCC
21014 functions (such as hand-written assembly code) to do the same.
21016 The option has three forms:
21018 @table @gcctabopt
21019 @item -mr10k-cache-barrier=load-store
21020 Insert a cache barrier before a load or store that might be
21021 speculatively executed and that might have side effects even
21022 if aborted.
21024 @item -mr10k-cache-barrier=store
21025 Insert a cache barrier before a store that might be speculatively
21026 executed and that might have side effects even if aborted.
21028 @item -mr10k-cache-barrier=none
21029 Disable the insertion of cache barriers.  This is the default setting.
21030 @end table
21032 @item -mflush-func=@var{func}
21033 @itemx -mno-flush-func
21034 @opindex mflush-func
21035 Specifies the function to call to flush the I and D caches, or to not
21036 call any such function.  If called, the function must take the same
21037 arguments as the common @code{_flush_func}, that is, the address of the
21038 memory range for which the cache is being flushed, the size of the
21039 memory range, and the number 3 (to flush both caches).  The default
21040 depends on the target GCC was configured for, but commonly is either
21041 @code{_flush_func} or @code{__cpu_flush}.
21043 @item mbranch-cost=@var{num}
21044 @opindex mbranch-cost
21045 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21046 This cost is only a heuristic and is not guaranteed to produce
21047 consistent results across releases.  A zero cost redundantly selects
21048 the default, which is based on the @option{-mtune} setting.
21050 @item -mbranch-likely
21051 @itemx -mno-branch-likely
21052 @opindex mbranch-likely
21053 @opindex mno-branch-likely
21054 Enable or disable use of Branch Likely instructions, regardless of the
21055 default for the selected architecture.  By default, Branch Likely
21056 instructions may be generated if they are supported by the selected
21057 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21058 and processors that implement those architectures; for those, Branch
21059 Likely instructions are not be generated by default because the MIPS32
21060 and MIPS64 architectures specifically deprecate their use.
21062 @item -mcompact-branches=never
21063 @itemx -mcompact-branches=optimal
21064 @itemx -mcompact-branches=always
21065 @opindex mcompact-branches=never
21066 @opindex mcompact-branches=optimal
21067 @opindex mcompact-branches=always
21068 These options control which form of branches will be generated.  The
21069 default is @option{-mcompact-branches=optimal}.
21071 The @option{-mcompact-branches=never} option ensures that compact branch
21072 instructions will never be generated.
21074 The @option{-mcompact-branches=always} option ensures that a compact
21075 branch instruction will be generated if available.  If a compact branch
21076 instruction is not available, a delay slot form of the branch will be
21077 used instead.
21079 This option is supported from MIPS Release 6 onwards.
21081 The @option{-mcompact-branches=optimal} option will cause a delay slot
21082 branch to be used if one is available in the current ISA and the delay
21083 slot is successfully filled.  If the delay slot is not filled, a compact
21084 branch will be chosen if one is available.
21086 @item -mfp-exceptions
21087 @itemx -mno-fp-exceptions
21088 @opindex mfp-exceptions
21089 Specifies whether FP exceptions are enabled.  This affects how
21090 FP instructions are scheduled for some processors.
21091 The default is that FP exceptions are
21092 enabled.
21094 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21095 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21096 FP pipe.
21098 @item -mvr4130-align
21099 @itemx -mno-vr4130-align
21100 @opindex mvr4130-align
21101 The VR4130 pipeline is two-way superscalar, but can only issue two
21102 instructions together if the first one is 8-byte aligned.  When this
21103 option is enabled, GCC aligns pairs of instructions that it
21104 thinks should execute in parallel.
21106 This option only has an effect when optimizing for the VR4130.
21107 It normally makes code faster, but at the expense of making it bigger.
21108 It is enabled by default at optimization level @option{-O3}.
21110 @item -msynci
21111 @itemx -mno-synci
21112 @opindex msynci
21113 Enable (disable) generation of @code{synci} instructions on
21114 architectures that support it.  The @code{synci} instructions (if
21115 enabled) are generated when @code{__builtin___clear_cache} is
21116 compiled.
21118 This option defaults to @option{-mno-synci}, but the default can be
21119 overridden by configuring GCC with @option{--with-synci}.
21121 When compiling code for single processor systems, it is generally safe
21122 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21123 does not invalidate the instruction caches on all cores and may lead
21124 to undefined behavior.
21126 @item -mrelax-pic-calls
21127 @itemx -mno-relax-pic-calls
21128 @opindex mrelax-pic-calls
21129 Try to turn PIC calls that are normally dispatched via register
21130 @code{$25} into direct calls.  This is only possible if the linker can
21131 resolve the destination at link time and if the destination is within
21132 range for a direct call.
21134 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21135 an assembler and a linker that support the @code{.reloc} assembly
21136 directive and @option{-mexplicit-relocs} is in effect.  With
21137 @option{-mno-explicit-relocs}, this optimization can be performed by the
21138 assembler and the linker alone without help from the compiler.
21140 @item -mmcount-ra-address
21141 @itemx -mno-mcount-ra-address
21142 @opindex mmcount-ra-address
21143 @opindex mno-mcount-ra-address
21144 Emit (do not emit) code that allows @code{_mcount} to modify the
21145 calling function's return address.  When enabled, this option extends
21146 the usual @code{_mcount} interface with a new @var{ra-address}
21147 parameter, which has type @code{intptr_t *} and is passed in register
21148 @code{$12}.  @code{_mcount} can then modify the return address by
21149 doing both of the following:
21150 @itemize
21151 @item
21152 Returning the new address in register @code{$31}.
21153 @item
21154 Storing the new address in @code{*@var{ra-address}},
21155 if @var{ra-address} is nonnull.
21156 @end itemize
21158 The default is @option{-mno-mcount-ra-address}.
21160 @item -mframe-header-opt
21161 @itemx -mno-frame-header-opt
21162 @opindex mframe-header-opt
21163 Enable (disable) frame header optimization in the o32 ABI.  When using the
21164 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21165 function to write out register arguments.  When enabled, this optimization
21166 will suppress the allocation of the frame header if it can be determined that
21167 it is unused.
21169 This optimization is off by default at all optimization levels.
21171 @item -mlxc1-sxc1
21172 @itemx -mno-lxc1-sxc1
21173 @opindex mlxc1-sxc1
21174 When applicable, enable (disable) the generation of @code{lwxc1},
21175 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21177 @item -mmadd4
21178 @itemx -mno-madd4
21179 @opindex mmadd4
21180 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21181 @code{madd.d} and related instructions.  Enabled by default.
21183 @end table
21185 @node MMIX Options
21186 @subsection MMIX Options
21187 @cindex MMIX Options
21189 These options are defined for the MMIX:
21191 @table @gcctabopt
21192 @item -mlibfuncs
21193 @itemx -mno-libfuncs
21194 @opindex mlibfuncs
21195 @opindex mno-libfuncs
21196 Specify that intrinsic library functions are being compiled, passing all
21197 values in registers, no matter the size.
21199 @item -mepsilon
21200 @itemx -mno-epsilon
21201 @opindex mepsilon
21202 @opindex mno-epsilon
21203 Generate floating-point comparison instructions that compare with respect
21204 to the @code{rE} epsilon register.
21206 @item -mabi=mmixware
21207 @itemx -mabi=gnu
21208 @opindex mabi=mmixware
21209 @opindex mabi=gnu
21210 Generate code that passes function parameters and return values that (in
21211 the called function) are seen as registers @code{$0} and up, as opposed to
21212 the GNU ABI which uses global registers @code{$231} and up.
21214 @item -mzero-extend
21215 @itemx -mno-zero-extend
21216 @opindex mzero-extend
21217 @opindex mno-zero-extend
21218 When reading data from memory in sizes shorter than 64 bits, use (do not
21219 use) zero-extending load instructions by default, rather than
21220 sign-extending ones.
21222 @item -mknuthdiv
21223 @itemx -mno-knuthdiv
21224 @opindex mknuthdiv
21225 @opindex mno-knuthdiv
21226 Make the result of a division yielding a remainder have the same sign as
21227 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21228 remainder follows the sign of the dividend.  Both methods are
21229 arithmetically valid, the latter being almost exclusively used.
21231 @item -mtoplevel-symbols
21232 @itemx -mno-toplevel-symbols
21233 @opindex mtoplevel-symbols
21234 @opindex mno-toplevel-symbols
21235 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21236 code can be used with the @code{PREFIX} assembly directive.
21238 @item -melf
21239 @opindex melf
21240 Generate an executable in the ELF format, rather than the default
21241 @samp{mmo} format used by the @command{mmix} simulator.
21243 @item -mbranch-predict
21244 @itemx -mno-branch-predict
21245 @opindex mbranch-predict
21246 @opindex mno-branch-predict
21247 Use (do not use) the probable-branch instructions, when static branch
21248 prediction indicates a probable branch.
21250 @item -mbase-addresses
21251 @itemx -mno-base-addresses
21252 @opindex mbase-addresses
21253 @opindex mno-base-addresses
21254 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21255 base address automatically generates a request (handled by the assembler
21256 and the linker) for a constant to be set up in a global register.  The
21257 register is used for one or more base address requests within the range 0
21258 to 255 from the value held in the register.  The generally leads to short
21259 and fast code, but the number of different data items that can be
21260 addressed is limited.  This means that a program that uses lots of static
21261 data may require @option{-mno-base-addresses}.
21263 @item -msingle-exit
21264 @itemx -mno-single-exit
21265 @opindex msingle-exit
21266 @opindex mno-single-exit
21267 Force (do not force) generated code to have a single exit point in each
21268 function.
21269 @end table
21271 @node MN10300 Options
21272 @subsection MN10300 Options
21273 @cindex MN10300 options
21275 These @option{-m} options are defined for Matsushita MN10300 architectures:
21277 @table @gcctabopt
21278 @item -mmult-bug
21279 @opindex mmult-bug
21280 Generate code to avoid bugs in the multiply instructions for the MN10300
21281 processors.  This is the default.
21283 @item -mno-mult-bug
21284 @opindex mno-mult-bug
21285 Do not generate code to avoid bugs in the multiply instructions for the
21286 MN10300 processors.
21288 @item -mam33
21289 @opindex mam33
21290 Generate code using features specific to the AM33 processor.
21292 @item -mno-am33
21293 @opindex mno-am33
21294 Do not generate code using features specific to the AM33 processor.  This
21295 is the default.
21297 @item -mam33-2
21298 @opindex mam33-2
21299 Generate code using features specific to the AM33/2.0 processor.
21301 @item -mam34
21302 @opindex mam34
21303 Generate code using features specific to the AM34 processor.
21305 @item -mtune=@var{cpu-type}
21306 @opindex mtune
21307 Use the timing characteristics of the indicated CPU type when
21308 scheduling instructions.  This does not change the targeted processor
21309 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21310 @samp{am33-2} or @samp{am34}.
21312 @item -mreturn-pointer-on-d0
21313 @opindex mreturn-pointer-on-d0
21314 When generating a function that returns a pointer, return the pointer
21315 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21316 only in @code{a0}, and attempts to call such functions without a prototype
21317 result in errors.  Note that this option is on by default; use
21318 @option{-mno-return-pointer-on-d0} to disable it.
21320 @item -mno-crt0
21321 @opindex mno-crt0
21322 Do not link in the C run-time initialization object file.
21324 @item -mrelax
21325 @opindex mrelax
21326 Indicate to the linker that it should perform a relaxation optimization pass
21327 to shorten branches, calls and absolute memory addresses.  This option only
21328 has an effect when used on the command line for the final link step.
21330 This option makes symbolic debugging impossible.
21332 @item -mliw
21333 @opindex mliw
21334 Allow the compiler to generate @emph{Long Instruction Word}
21335 instructions if the target is the @samp{AM33} or later.  This is the
21336 default.  This option defines the preprocessor macro @code{__LIW__}.
21338 @item -mnoliw
21339 @opindex mnoliw
21340 Do not allow the compiler to generate @emph{Long Instruction Word}
21341 instructions.  This option defines the preprocessor macro
21342 @code{__NO_LIW__}.
21344 @item -msetlb
21345 @opindex msetlb
21346 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21347 instructions if the target is the @samp{AM33} or later.  This is the
21348 default.  This option defines the preprocessor macro @code{__SETLB__}.
21350 @item -mnosetlb
21351 @opindex mnosetlb
21352 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21353 instructions.  This option defines the preprocessor macro
21354 @code{__NO_SETLB__}.
21356 @end table
21358 @node Moxie Options
21359 @subsection Moxie Options
21360 @cindex Moxie Options
21362 @table @gcctabopt
21364 @item -meb
21365 @opindex meb
21366 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21367 configurations.
21369 @item -mel
21370 @opindex mel
21371 Generate little-endian code.
21373 @item -mmul.x
21374 @opindex mmul.x
21375 Generate mul.x and umul.x instructions.  This is the default for
21376 @samp{moxiebox-*-*} configurations.
21378 @item -mno-crt0
21379 @opindex mno-crt0
21380 Do not link in the C run-time initialization object file.
21382 @end table
21384 @node MSP430 Options
21385 @subsection MSP430 Options
21386 @cindex MSP430 Options
21388 These options are defined for the MSP430:
21390 @table @gcctabopt
21392 @item -masm-hex
21393 @opindex masm-hex
21394 Force assembly output to always use hex constants.  Normally such
21395 constants are signed decimals, but this option is available for
21396 testsuite and/or aesthetic purposes.
21398 @item -mmcu=
21399 @opindex mmcu=
21400 Select the MCU to target.  This is used to create a C preprocessor
21401 symbol based upon the MCU name, converted to upper case and pre- and
21402 post-fixed with @samp{__}.  This in turn is used by the
21403 @file{msp430.h} header file to select an MCU-specific supplementary
21404 header file.
21406 The option also sets the ISA to use.  If the MCU name is one that is
21407 known to only support the 430 ISA then that is selected, otherwise the
21408 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21409 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21410 name selects the 430X ISA.
21412 In addition an MCU-specific linker script is added to the linker
21413 command line.  The script's name is the name of the MCU with
21414 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21415 command line defines the C preprocessor symbol @code{__XXX__} and
21416 cause the linker to search for a script called @file{xxx.ld}.
21418 This option is also passed on to the assembler.
21420 @item -mwarn-mcu
21421 @itemx -mno-warn-mcu
21422 @opindex mwarn-mcu
21423 @opindex mno-warn-mcu
21424 This option enables or disables warnings about conflicts between the
21425 MCU name specified by the @option{-mmcu} option and the ISA set by the
21426 @option{-mcpu} option and/or the hardware multiply support set by the
21427 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21428 MCU names.  This option is on by default.
21430 @item -mcpu=
21431 @opindex mcpu=
21432 Specifies the ISA to use.  Accepted values are @samp{msp430},
21433 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21434 @option{-mmcu=} option should be used to select the ISA.
21436 @item -msim
21437 @opindex msim
21438 Link to the simulator runtime libraries and linker script.  Overrides
21439 any scripts that would be selected by the @option{-mmcu=} option.
21441 @item -mlarge
21442 @opindex mlarge
21443 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21445 @item -msmall
21446 @opindex msmall
21447 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21449 @item -mrelax
21450 @opindex mrelax
21451 This option is passed to the assembler and linker, and allows the
21452 linker to perform certain optimizations that cannot be done until
21453 the final link.
21455 @item mhwmult=
21456 @opindex mhwmult=
21457 Describes the type of hardware multiply supported by the target.
21458 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21459 for the original 16-bit-only multiply supported by early MCUs.
21460 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21461 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21462 A value of @samp{auto} can also be given.  This tells GCC to deduce
21463 the hardware multiply support based upon the MCU name provided by the
21464 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21465 the MCU name is not recognized then no hardware multiply support is
21466 assumed.  @code{auto} is the default setting.
21468 Hardware multiplies are normally performed by calling a library
21469 routine.  This saves space in the generated code.  When compiling at
21470 @option{-O3} or higher however the hardware multiplier is invoked
21471 inline.  This makes for bigger, but faster code.
21473 The hardware multiply routines disable interrupts whilst running and
21474 restore the previous interrupt state when they finish.  This makes
21475 them safe to use inside interrupt handlers as well as in normal code.
21477 @item -minrt
21478 @opindex minrt
21479 Enable the use of a minimum runtime environment - no static
21480 initializers or constructors.  This is intended for memory-constrained
21481 devices.  The compiler includes special symbols in some objects
21482 that tell the linker and runtime which code fragments are required.
21484 @item -mcode-region=
21485 @itemx -mdata-region=
21486 @opindex mcode-region
21487 @opindex mdata-region
21488 These options tell the compiler where to place functions and data that
21489 do not have one of the @code{lower}, @code{upper}, @code{either} or
21490 @code{section} attributes.  Possible values are @code{lower},
21491 @code{upper}, @code{either} or @code{any}.  The first three behave
21492 like the corresponding attribute.  The fourth possible value -
21493 @code{any} - is the default.  It leaves placement entirely up to the
21494 linker script and how it assigns the standard sections
21495 (@code{.text}, @code{.data}, etc) to the memory regions.
21497 @item -msilicon-errata=
21498 @opindex msilicon-errata
21499 This option passes on a request to assembler to enable the fixes for
21500 the named silicon errata.
21502 @item -msilicon-errata-warn=
21503 @opindex msilicon-errata-warn
21504 This option passes on a request to the assembler to enable warning
21505 messages when a silicon errata might need to be applied.
21507 @end table
21509 @node NDS32 Options
21510 @subsection NDS32 Options
21511 @cindex NDS32 Options
21513 These options are defined for NDS32 implementations:
21515 @table @gcctabopt
21517 @item -mbig-endian
21518 @opindex mbig-endian
21519 Generate code in big-endian mode.
21521 @item -mlittle-endian
21522 @opindex mlittle-endian
21523 Generate code in little-endian mode.
21525 @item -mreduced-regs
21526 @opindex mreduced-regs
21527 Use reduced-set registers for register allocation.
21529 @item -mfull-regs
21530 @opindex mfull-regs
21531 Use full-set registers for register allocation.
21533 @item -mcmov
21534 @opindex mcmov
21535 Generate conditional move instructions.
21537 @item -mno-cmov
21538 @opindex mno-cmov
21539 Do not generate conditional move instructions.
21541 @item -mext-perf
21542 @opindex mperf-ext
21543 Generate performance extension instructions.
21545 @item -mno-ext-perf
21546 @opindex mno-perf-ext
21547 Do not generate performance extension instructions.
21549 @item -mext-perf2
21550 @opindex mperf-ext
21551 Generate performance extension 2 instructions.
21553 @item -mno-ext-perf2
21554 @opindex mno-perf-ext
21555 Do not generate performance extension 2 instructions.
21557 @item -mext-string
21558 @opindex mperf-ext
21559 Generate string extension instructions.
21561 @item -mno-ext-string
21562 @opindex mno-perf-ext
21563 Do not generate string extension instructions.
21565 @item -mv3push
21566 @opindex mv3push
21567 Generate v3 push25/pop25 instructions.
21569 @item -mno-v3push
21570 @opindex mno-v3push
21571 Do not generate v3 push25/pop25 instructions.
21573 @item -m16-bit
21574 @opindex m16-bit
21575 Generate 16-bit instructions.
21577 @item -mno-16-bit
21578 @opindex mno-16-bit
21579 Do not generate 16-bit instructions.
21581 @item -misr-vector-size=@var{num}
21582 @opindex misr-vector-size
21583 Specify the size of each interrupt vector, which must be 4 or 16.
21585 @item -mcache-block-size=@var{num}
21586 @opindex mcache-block-size
21587 Specify the size of each cache block,
21588 which must be a power of 2 between 4 and 512.
21590 @item -march=@var{arch}
21591 @opindex march
21592 Specify the name of the target architecture.
21594 @item -mcmodel=@var{code-model}
21595 @opindex mcmodel
21596 Set the code model to one of
21597 @table @asis
21598 @item @samp{small}
21599 All the data and read-only data segments must be within 512KB addressing space.
21600 The text segment must be within 16MB addressing space.
21601 @item @samp{medium}
21602 The data segment must be within 512KB while the read-only data segment can be
21603 within 4GB addressing space.  The text segment should be still within 16MB
21604 addressing space.
21605 @item @samp{large}
21606 All the text and data segments can be within 4GB addressing space.
21607 @end table
21609 @item -mctor-dtor
21610 @opindex mctor-dtor
21611 Enable constructor/destructor feature.
21613 @item -mrelax
21614 @opindex mrelax
21615 Guide linker to relax instructions.
21617 @end table
21619 @node Nios II Options
21620 @subsection Nios II Options
21621 @cindex Nios II options
21622 @cindex Altera Nios II options
21624 These are the options defined for the Altera Nios II processor.
21626 @table @gcctabopt
21628 @item -G @var{num}
21629 @opindex G
21630 @cindex smaller data references
21631 Put global and static objects less than or equal to @var{num} bytes
21632 into the small data or BSS sections instead of the normal data or BSS
21633 sections.  The default value of @var{num} is 8.
21635 @item -mgpopt=@var{option}
21636 @itemx -mgpopt
21637 @itemx -mno-gpopt
21638 @opindex mgpopt
21639 @opindex mno-gpopt
21640 Generate (do not generate) GP-relative accesses.  The following 
21641 @var{option} names are recognized:
21643 @table @samp
21645 @item none
21646 Do not generate GP-relative accesses.
21648 @item local
21649 Generate GP-relative accesses for small data objects that are not 
21650 external, weak, or uninitialized common symbols.  
21651 Also use GP-relative addressing for objects that
21652 have been explicitly placed in a small data section via a @code{section}
21653 attribute.
21655 @item global
21656 As for @samp{local}, but also generate GP-relative accesses for
21657 small data objects that are external, weak, or common.  If you use this option,
21658 you must ensure that all parts of your program (including libraries) are
21659 compiled with the same @option{-G} setting.
21661 @item data
21662 Generate GP-relative accesses for all data objects in the program.  If you
21663 use this option, the entire data and BSS segments
21664 of your program must fit in 64K of memory and you must use an appropriate
21665 linker script to allocate them within the addressable range of the
21666 global pointer.
21668 @item all
21669 Generate GP-relative addresses for function pointers as well as data
21670 pointers.  If you use this option, the entire text, data, and BSS segments
21671 of your program must fit in 64K of memory and you must use an appropriate
21672 linker script to allocate them within the addressable range of the
21673 global pointer.
21675 @end table
21677 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21678 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21680 The default is @option{-mgpopt} except when @option{-fpic} or
21681 @option{-fPIC} is specified to generate position-independent code.
21682 Note that the Nios II ABI does not permit GP-relative accesses from
21683 shared libraries.
21685 You may need to specify @option{-mno-gpopt} explicitly when building
21686 programs that include large amounts of small data, including large
21687 GOT data sections.  In this case, the 16-bit offset for GP-relative
21688 addressing may not be large enough to allow access to the entire 
21689 small data section.
21691 @item -mgprel-sec=@var{regexp}
21692 @opindex mgprel-sec
21693 This option specifies additional section names that can be accessed via
21694 GP-relative addressing.  It is most useful in conjunction with 
21695 @code{section} attributes on variable declarations 
21696 (@pxref{Common Variable Attributes}) and a custom linker script.  
21697 The @var{regexp} is a POSIX Extended Regular Expression.
21699 This option does not affect the behavior of the @option{-G} option, and 
21700 and the specified sections are in addition to the standard @code{.sdata} 
21701 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21703 @item -mr0rel-sec=@var{regexp}
21704 @opindex mr0rel-sec
21705 This option specifies names of sections that can be accessed via a 
21706 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21707 of the 32-bit address space.  It is most useful in conjunction with 
21708 @code{section} attributes on variable declarations 
21709 (@pxref{Common Variable Attributes}) and a custom linker script.  
21710 The @var{regexp} is a POSIX Extended Regular Expression.
21712 In contrast to the use of GP-relative addressing for small data, 
21713 zero-based addressing is never generated by default and there are no 
21714 conventional section names used in standard linker scripts for sections
21715 in the low or high areas of memory.
21717 @item -mel
21718 @itemx -meb
21719 @opindex mel
21720 @opindex meb
21721 Generate little-endian (default) or big-endian (experimental) code,
21722 respectively.
21724 @item -march=@var{arch}
21725 @opindex march
21726 This specifies the name of the target Nios II architecture.  GCC uses this
21727 name to determine what kind of instructions it can emit when generating
21728 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21730 The preprocessor macro @code{__nios2_arch__} is available to programs,
21731 with value 1 or 2, indicating the targeted ISA level.
21733 @item -mbypass-cache
21734 @itemx -mno-bypass-cache
21735 @opindex mno-bypass-cache
21736 @opindex mbypass-cache
21737 Force all load and store instructions to always bypass cache by 
21738 using I/O variants of the instructions. The default is not to
21739 bypass the cache.
21741 @item -mno-cache-volatile 
21742 @itemx -mcache-volatile       
21743 @opindex mcache-volatile 
21744 @opindex mno-cache-volatile
21745 Volatile memory access bypass the cache using the I/O variants of 
21746 the load and store instructions. The default is not to bypass the cache.
21748 @item -mno-fast-sw-div
21749 @itemx -mfast-sw-div
21750 @opindex mno-fast-sw-div
21751 @opindex mfast-sw-div
21752 Do not use table-based fast divide for small numbers. The default 
21753 is to use the fast divide at @option{-O3} and above.
21755 @item -mno-hw-mul
21756 @itemx -mhw-mul
21757 @itemx -mno-hw-mulx
21758 @itemx -mhw-mulx
21759 @itemx -mno-hw-div
21760 @itemx -mhw-div
21761 @opindex mno-hw-mul
21762 @opindex mhw-mul
21763 @opindex mno-hw-mulx
21764 @opindex mhw-mulx
21765 @opindex mno-hw-div
21766 @opindex mhw-div
21767 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21768 instructions by the compiler. The default is to emit @code{mul}
21769 and not emit @code{div} and @code{mulx}.
21771 @item -mbmx
21772 @itemx -mno-bmx
21773 @itemx -mcdx
21774 @itemx -mno-cdx
21775 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21776 CDX (code density) instructions.  Enabling these instructions also
21777 requires @option{-march=r2}.  Since these instructions are optional
21778 extensions to the R2 architecture, the default is not to emit them.
21780 @item -mcustom-@var{insn}=@var{N}
21781 @itemx -mno-custom-@var{insn}
21782 @opindex mcustom-@var{insn}
21783 @opindex mno-custom-@var{insn}
21784 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21785 custom instruction with encoding @var{N} when generating code that uses 
21786 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21787 instruction 253 for single-precision floating-point add operations instead
21788 of the default behavior of using a library call.
21790 The following values of @var{insn} are supported.  Except as otherwise
21791 noted, floating-point operations are expected to be implemented with
21792 normal IEEE 754 semantics and correspond directly to the C operators or the
21793 equivalent GCC built-in functions (@pxref{Other Builtins}).
21795 Single-precision floating point:
21796 @table @asis
21798 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21799 Binary arithmetic operations.
21801 @item @samp{fnegs}
21802 Unary negation.
21804 @item @samp{fabss}
21805 Unary absolute value.
21807 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21808 Comparison operations.
21810 @item @samp{fmins}, @samp{fmaxs}
21811 Floating-point minimum and maximum.  These instructions are only
21812 generated if @option{-ffinite-math-only} is specified.
21814 @item @samp{fsqrts}
21815 Unary square root operation.
21817 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21818 Floating-point trigonometric and exponential functions.  These instructions
21819 are only generated if @option{-funsafe-math-optimizations} is also specified.
21821 @end table
21823 Double-precision floating point:
21824 @table @asis
21826 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21827 Binary arithmetic operations.
21829 @item @samp{fnegd}
21830 Unary negation.
21832 @item @samp{fabsd}
21833 Unary absolute value.
21835 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21836 Comparison operations.
21838 @item @samp{fmind}, @samp{fmaxd}
21839 Double-precision minimum and maximum.  These instructions are only
21840 generated if @option{-ffinite-math-only} is specified.
21842 @item @samp{fsqrtd}
21843 Unary square root operation.
21845 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21846 Double-precision trigonometric and exponential functions.  These instructions
21847 are only generated if @option{-funsafe-math-optimizations} is also specified.
21849 @end table
21851 Conversions:
21852 @table @asis
21853 @item @samp{fextsd}
21854 Conversion from single precision to double precision.
21856 @item @samp{ftruncds}
21857 Conversion from double precision to single precision.
21859 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21860 Conversion from floating point to signed or unsigned integer types, with
21861 truncation towards zero.
21863 @item @samp{round}
21864 Conversion from single-precision floating point to signed integer,
21865 rounding to the nearest integer and ties away from zero.
21866 This corresponds to the @code{__builtin_lroundf} function when
21867 @option{-fno-math-errno} is used.
21869 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21870 Conversion from signed or unsigned integer types to floating-point types.
21872 @end table
21874 In addition, all of the following transfer instructions for internal
21875 registers X and Y must be provided to use any of the double-precision
21876 floating-point instructions.  Custom instructions taking two
21877 double-precision source operands expect the first operand in the
21878 64-bit register X.  The other operand (or only operand of a unary
21879 operation) is given to the custom arithmetic instruction with the
21880 least significant half in source register @var{src1} and the most
21881 significant half in @var{src2}.  A custom instruction that returns a
21882 double-precision result returns the most significant 32 bits in the
21883 destination register and the other half in 32-bit register Y.  
21884 GCC automatically generates the necessary code sequences to write
21885 register X and/or read register Y when double-precision floating-point
21886 instructions are used.
21888 @table @asis
21890 @item @samp{fwrx}
21891 Write @var{src1} into the least significant half of X and @var{src2} into
21892 the most significant half of X.
21894 @item @samp{fwry}
21895 Write @var{src1} into Y.
21897 @item @samp{frdxhi}, @samp{frdxlo}
21898 Read the most or least (respectively) significant half of X and store it in
21899 @var{dest}.
21901 @item @samp{frdy}
21902 Read the value of Y and store it into @var{dest}.
21903 @end table
21905 Note that you can gain more local control over generation of Nios II custom
21906 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21907 and @code{target("no-custom-@var{insn}")} function attributes
21908 (@pxref{Function Attributes})
21909 or pragmas (@pxref{Function Specific Option Pragmas}).
21911 @item -mcustom-fpu-cfg=@var{name}
21912 @opindex mcustom-fpu-cfg
21914 This option enables a predefined, named set of custom instruction encodings
21915 (see @option{-mcustom-@var{insn}} above).  
21916 Currently, the following sets are defined:
21918 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21919 @gccoptlist{-mcustom-fmuls=252 @gol
21920 -mcustom-fadds=253 @gol
21921 -mcustom-fsubs=254 @gol
21922 -fsingle-precision-constant}
21924 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21925 @gccoptlist{-mcustom-fmuls=252 @gol
21926 -mcustom-fadds=253 @gol
21927 -mcustom-fsubs=254 @gol
21928 -mcustom-fdivs=255 @gol
21929 -fsingle-precision-constant}
21931 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21932 @gccoptlist{-mcustom-floatus=243 @gol
21933 -mcustom-fixsi=244 @gol
21934 -mcustom-floatis=245 @gol
21935 -mcustom-fcmpgts=246 @gol
21936 -mcustom-fcmples=249 @gol
21937 -mcustom-fcmpeqs=250 @gol
21938 -mcustom-fcmpnes=251 @gol
21939 -mcustom-fmuls=252 @gol
21940 -mcustom-fadds=253 @gol
21941 -mcustom-fsubs=254 @gol
21942 -mcustom-fdivs=255 @gol
21943 -fsingle-precision-constant}
21945 Custom instruction assignments given by individual
21946 @option{-mcustom-@var{insn}=} options override those given by
21947 @option{-mcustom-fpu-cfg=}, regardless of the
21948 order of the options on the command line.
21950 Note that you can gain more local control over selection of a FPU
21951 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21952 function attribute (@pxref{Function Attributes})
21953 or pragma (@pxref{Function Specific Option Pragmas}).
21955 @end table
21957 These additional @samp{-m} options are available for the Altera Nios II
21958 ELF (bare-metal) target:
21960 @table @gcctabopt
21962 @item -mhal
21963 @opindex mhal
21964 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21965 startup and termination code, and is typically used in conjunction with
21966 @option{-msys-crt0=} to specify the location of the alternate startup code
21967 provided by the HAL BSP.
21969 @item -msmallc
21970 @opindex msmallc
21971 Link with a limited version of the C library, @option{-lsmallc}, rather than
21972 Newlib.
21974 @item -msys-crt0=@var{startfile}
21975 @opindex msys-crt0
21976 @var{startfile} is the file name of the startfile (crt0) to use 
21977 when linking.  This option is only useful in conjunction with @option{-mhal}.
21979 @item -msys-lib=@var{systemlib}
21980 @opindex msys-lib
21981 @var{systemlib} is the library name of the library that provides
21982 low-level system calls required by the C library,
21983 e.g. @code{read} and @code{write}.
21984 This option is typically used to link with a library provided by a HAL BSP.
21986 @end table
21988 @node Nvidia PTX Options
21989 @subsection Nvidia PTX Options
21990 @cindex Nvidia PTX options
21991 @cindex nvptx options
21993 These options are defined for Nvidia PTX:
21995 @table @gcctabopt
21997 @item -m32
21998 @itemx -m64
21999 @opindex m32
22000 @opindex m64
22001 Generate code for 32-bit or 64-bit ABI.
22003 @item -mmainkernel
22004 @opindex mmainkernel
22005 Link in code for a __main kernel.  This is for stand-alone instead of
22006 offloading execution.
22008 @item -moptimize
22009 @opindex moptimize
22010 Apply partitioned execution optimizations.  This is the default when any
22011 level of optimization is selected.
22013 @item -msoft-stack
22014 @opindex msoft-stack
22015 Generate code that does not use @code{.local} memory
22016 directly for stack storage. Instead, a per-warp stack pointer is
22017 maintained explicitly. This enables variable-length stack allocation (with
22018 variable-length arrays or @code{alloca}), and when global memory is used for
22019 underlying storage, makes it possible to access automatic variables from other
22020 threads, or with atomic instructions. This code generation variant is used
22021 for OpenMP offloading, but the option is exposed on its own for the purpose
22022 of testing the compiler; to generate code suitable for linking into programs
22023 using OpenMP offloading, use option @option{-mgomp}.
22025 @item -muniform-simt
22026 @opindex muniform-simt
22027 Switch to code generation variant that allows to execute all threads in each
22028 warp, while maintaining memory state and side effects as if only one thread
22029 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22030 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22031 current lane index equals the master lane index), and the register being
22032 assigned is copied via a shuffle instruction from the master lane.  Outside of
22033 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22034 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22035 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22036 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22037 with current lane index to compute the master lane index.
22039 @item -mgomp
22040 @opindex mgomp
22041 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22042 @option{-muniform-simt} options, and selects corresponding multilib variant.
22044 @end table
22046 @node PDP-11 Options
22047 @subsection PDP-11 Options
22048 @cindex PDP-11 Options
22050 These options are defined for the PDP-11:
22052 @table @gcctabopt
22053 @item -mfpu
22054 @opindex mfpu
22055 Use hardware FPP floating point.  This is the default.  (FIS floating
22056 point on the PDP-11/40 is not supported.)
22058 @item -msoft-float
22059 @opindex msoft-float
22060 Do not use hardware floating point.
22062 @item -mac0
22063 @opindex mac0
22064 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22066 @item -mno-ac0
22067 @opindex mno-ac0
22068 Return floating-point results in memory.  This is the default.
22070 @item -m40
22071 @opindex m40
22072 Generate code for a PDP-11/40.
22074 @item -m45
22075 @opindex m45
22076 Generate code for a PDP-11/45.  This is the default.
22078 @item -m10
22079 @opindex m10
22080 Generate code for a PDP-11/10.
22082 @item -mbcopy-builtin
22083 @opindex mbcopy-builtin
22084 Use inline @code{movmemhi} patterns for copying memory.  This is the
22085 default.
22087 @item -mbcopy
22088 @opindex mbcopy
22089 Do not use inline @code{movmemhi} patterns for copying memory.
22091 @item -mint16
22092 @itemx -mno-int32
22093 @opindex mint16
22094 @opindex mno-int32
22095 Use 16-bit @code{int}.  This is the default.
22097 @item -mint32
22098 @itemx -mno-int16
22099 @opindex mint32
22100 @opindex mno-int16
22101 Use 32-bit @code{int}.
22103 @item -mfloat64
22104 @itemx -mno-float32
22105 @opindex mfloat64
22106 @opindex mno-float32
22107 Use 64-bit @code{float}.  This is the default.
22109 @item -mfloat32
22110 @itemx -mno-float64
22111 @opindex mfloat32
22112 @opindex mno-float64
22113 Use 32-bit @code{float}.
22115 @item -mabshi
22116 @opindex mabshi
22117 Use @code{abshi2} pattern.  This is the default.
22119 @item -mno-abshi
22120 @opindex mno-abshi
22121 Do not use @code{abshi2} pattern.
22123 @item -mbranch-expensive
22124 @opindex mbranch-expensive
22125 Pretend that branches are expensive.  This is for experimenting with
22126 code generation only.
22128 @item -mbranch-cheap
22129 @opindex mbranch-cheap
22130 Do not pretend that branches are expensive.  This is the default.
22132 @item -munix-asm
22133 @opindex munix-asm
22134 Use Unix assembler syntax.  This is the default when configured for
22135 @samp{pdp11-*-bsd}.
22137 @item -mdec-asm
22138 @opindex mdec-asm
22139 Use DEC assembler syntax.  This is the default when configured for any
22140 PDP-11 target other than @samp{pdp11-*-bsd}.
22141 @end table
22143 @node picoChip Options
22144 @subsection picoChip Options
22145 @cindex picoChip options
22147 These @samp{-m} options are defined for picoChip implementations:
22149 @table @gcctabopt
22151 @item -mae=@var{ae_type}
22152 @opindex mcpu
22153 Set the instruction set, register set, and instruction scheduling
22154 parameters for array element type @var{ae_type}.  Supported values
22155 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22157 @option{-mae=ANY} selects a completely generic AE type.  Code
22158 generated with this option runs on any of the other AE types.  The
22159 code is not as efficient as it would be if compiled for a specific
22160 AE type, and some types of operation (e.g., multiplication) do not
22161 work properly on all types of AE.
22163 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22164 for compiled code, and is the default.
22166 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22167 option may suffer from poor performance of byte (char) manipulation,
22168 since the DSP AE does not provide hardware support for byte load/stores.
22170 @item -msymbol-as-address
22171 Enable the compiler to directly use a symbol name as an address in a
22172 load/store instruction, without first loading it into a
22173 register.  Typically, the use of this option generates larger
22174 programs, which run faster than when the option isn't used.  However, the
22175 results vary from program to program, so it is left as a user option,
22176 rather than being permanently enabled.
22178 @item -mno-inefficient-warnings
22179 Disables warnings about the generation of inefficient code.  These
22180 warnings can be generated, for example, when compiling code that
22181 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22182 no hardware support for byte-level memory operations, so all byte
22183 load/stores must be synthesized from word load/store operations.  This is
22184 inefficient and a warning is generated to indicate
22185 that you should rewrite the code to avoid byte operations, or to target
22186 an AE type that has the necessary hardware support.  This option disables
22187 these warnings.
22189 @end table
22191 @node PowerPC Options
22192 @subsection PowerPC Options
22193 @cindex PowerPC options
22195 These are listed under @xref{RS/6000 and PowerPC Options}.
22197 @node PowerPC SPE Options
22198 @subsection PowerPC SPE Options
22199 @cindex PowerPC SPE options
22201 These @samp{-m} options are defined for PowerPC SPE:
22202 @table @gcctabopt
22203 @item -mmfcrf
22204 @itemx -mno-mfcrf
22205 @itemx -mpopcntb
22206 @itemx -mno-popcntb
22207 @opindex mmfcrf
22208 @opindex mno-mfcrf
22209 @opindex mpopcntb
22210 @opindex mno-popcntb
22211 You use these options to specify which instructions are available on the
22212 processor you are using.  The default value of these options is
22213 determined when configuring GCC@.  Specifying the
22214 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22215 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22216 rather than the options listed above.
22218 The @option{-mmfcrf} option allows GCC to generate the move from
22219 condition register field instruction implemented on the POWER4
22220 processor and other processors that support the PowerPC V2.01
22221 architecture.
22222 The @option{-mpopcntb} option allows GCC to generate the popcount and
22223 double-precision FP reciprocal estimate instruction implemented on the
22224 POWER5 processor and other processors that support the PowerPC V2.02
22225 architecture.
22227 @item -mcpu=@var{cpu_type}
22228 @opindex mcpu
22229 Set architecture type, register usage, and
22230 instruction scheduling parameters for machine type @var{cpu_type}.
22231 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22232 and @samp{native}.
22234 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22235 endian), with an appropriate, generic processor model assumed for
22236 scheduling purposes.
22238 Specifying @samp{native} as cpu type detects and selects the
22239 architecture option that corresponds to the host processor of the
22240 system performing the compilation.
22241 @option{-mcpu=native} has no effect if GCC does not recognize the
22242 processor.
22244 The other options specify a specific processor.  Code generated under
22245 those options runs best on that processor, and may not run at all on
22246 others.
22248 The @option{-mcpu} options automatically enable or disable the
22249 following options:
22251 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22252 -mpopcntb -mpopcntd @gol
22253 -msingle-float -mdouble-float @gol
22254 -mfloat128}
22256 The particular options set for any particular CPU varies between
22257 compiler versions, depending on what setting seems to produce optimal
22258 code for that CPU; it doesn't necessarily reflect the actual hardware's
22259 capabilities.  If you wish to set an individual option to a particular
22260 value, you may specify it after the @option{-mcpu} option, like
22261 @option{-mcpu=8548}.
22263 @item -mtune=@var{cpu_type}
22264 @opindex mtune
22265 Set the instruction scheduling parameters for machine type
22266 @var{cpu_type}, but do not set the architecture type or register usage,
22267 as @option{-mcpu=@var{cpu_type}} does.  The same
22268 values for @var{cpu_type} are used for @option{-mtune} as for
22269 @option{-mcpu}.  If both are specified, the code generated uses the
22270 architecture and registers set by @option{-mcpu}, but the
22271 scheduling parameters set by @option{-mtune}.
22273 @item -msecure-plt
22274 @opindex msecure-plt
22275 Generate code that allows @command{ld} and @command{ld.so}
22276 to build executables and shared
22277 libraries with non-executable @code{.plt} and @code{.got} sections.
22278 This is a PowerPC
22279 32-bit SYSV ABI option.
22281 @item -mbss-plt
22282 @opindex mbss-plt
22283 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22284 fills in, and
22285 requires @code{.plt} and @code{.got}
22286 sections that are both writable and executable.
22287 This is a PowerPC 32-bit SYSV ABI option.
22289 @item -misel
22290 @itemx -mno-isel
22291 @opindex misel
22292 @opindex mno-isel
22293 This switch enables or disables the generation of ISEL instructions.
22295 @item -misel=@var{yes/no}
22296 This switch has been deprecated.  Use @option{-misel} and
22297 @option{-mno-isel} instead.
22299 @item -mspe
22300 @itemx -mno-spe
22301 @opindex mspe
22302 @opindex mno-spe
22303 This switch enables or disables the generation of SPE simd
22304 instructions.
22306 @item -mspe=@var{yes/no}
22307 This option has been deprecated.  Use @option{-mspe} and
22308 @option{-mno-spe} instead.
22310 @item -mfloat128
22311 @itemx -mno-float128
22312 @opindex mfloat128
22313 @opindex mno-float128
22314 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22315 and use either software emulation for IEEE 128-bit floating point or
22316 hardware instructions.
22318 @item -mfloat-gprs=@var{yes/single/double/no}
22319 @itemx -mfloat-gprs
22320 @opindex mfloat-gprs
22321 This switch enables or disables the generation of floating-point
22322 operations on the general-purpose registers for architectures that
22323 support it.
22325 The argument @samp{yes} or @samp{single} enables the use of
22326 single-precision floating-point operations.
22328 The argument @samp{double} enables the use of single and
22329 double-precision floating-point operations.
22331 The argument @samp{no} disables floating-point operations on the
22332 general-purpose registers.
22334 This option is currently only available on the MPC854x.
22336 @item -mfull-toc
22337 @itemx -mno-fp-in-toc
22338 @itemx -mno-sum-in-toc
22339 @itemx -mminimal-toc
22340 @opindex mfull-toc
22341 @opindex mno-fp-in-toc
22342 @opindex mno-sum-in-toc
22343 @opindex mminimal-toc
22344 Modify generation of the TOC (Table Of Contents), which is created for
22345 every executable file.  The @option{-mfull-toc} option is selected by
22346 default.  In that case, GCC allocates at least one TOC entry for
22347 each unique non-automatic variable reference in your program.  GCC
22348 also places floating-point constants in the TOC@.  However, only
22349 16,384 entries are available in the TOC@.
22351 If you receive a linker error message that saying you have overflowed
22352 the available TOC space, you can reduce the amount of TOC space used
22353 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22354 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22355 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22356 generate code to calculate the sum of an address and a constant at
22357 run time instead of putting that sum into the TOC@.  You may specify one
22358 or both of these options.  Each causes GCC to produce very slightly
22359 slower and larger code at the expense of conserving TOC space.
22361 If you still run out of space in the TOC even when you specify both of
22362 these options, specify @option{-mminimal-toc} instead.  This option causes
22363 GCC to make only one TOC entry for every file.  When you specify this
22364 option, GCC produces code that is slower and larger but which
22365 uses extremely little TOC space.  You may wish to use this option
22366 only on files that contain less frequently-executed code.
22368 @item -maix32
22369 @opindex maix32
22370 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22372 @item -mxl-compat
22373 @itemx -mno-xl-compat
22374 @opindex mxl-compat
22375 @opindex mno-xl-compat
22376 Produce code that conforms more closely to IBM XL compiler semantics
22377 when using AIX-compatible ABI@.  Pass floating-point arguments to
22378 prototyped functions beyond the register save area (RSA) on the stack
22379 in addition to argument FPRs.  Do not assume that most significant
22380 double in 128-bit long double value is properly rounded when comparing
22381 values and converting to double.  Use XL symbol names for long double
22382 support routines.
22384 The AIX calling convention was extended but not initially documented to
22385 handle an obscure K&R C case of calling a function that takes the
22386 address of its arguments with fewer arguments than declared.  IBM XL
22387 compilers access floating-point arguments that do not fit in the
22388 RSA from the stack when a subroutine is compiled without
22389 optimization.  Because always storing floating-point arguments on the
22390 stack is inefficient and rarely needed, this option is not enabled by
22391 default and only is necessary when calling subroutines compiled by IBM
22392 XL compilers without optimization.
22394 @item -malign-natural
22395 @itemx -malign-power
22396 @opindex malign-natural
22397 @opindex malign-power
22398 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22399 @option{-malign-natural} overrides the ABI-defined alignment of larger
22400 types, such as floating-point doubles, on their natural size-based boundary.
22401 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22402 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22404 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22405 is not supported.
22407 @item -msoft-float
22408 @itemx -mhard-float
22409 @opindex msoft-float
22410 @opindex mhard-float
22411 Generate code that does not use (uses) the floating-point register set.
22412 Software floating-point emulation is provided if you use the
22413 @option{-msoft-float} option, and pass the option to GCC when linking.
22415 @item -msingle-float
22416 @itemx -mdouble-float
22417 @opindex msingle-float
22418 @opindex mdouble-float
22419 Generate code for single- or double-precision floating-point operations.
22420 @option{-mdouble-float} implies @option{-msingle-float}.
22422 @item -mmultiple
22423 @itemx -mno-multiple
22424 @opindex mmultiple
22425 @opindex mno-multiple
22426 Generate code that uses (does not use) the load multiple word
22427 instructions and the store multiple word instructions.  These
22428 instructions are generated by default on POWER systems, and not
22429 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22430 PowerPC systems, since those instructions do not work when the
22431 processor is in little-endian mode.  The exceptions are PPC740 and
22432 PPC750 which permit these instructions in little-endian mode.
22434 @item -mupdate
22435 @itemx -mno-update
22436 @opindex mupdate
22437 @opindex mno-update
22438 Generate code that uses (does not use) the load or store instructions
22439 that update the base register to the address of the calculated memory
22440 location.  These instructions are generated by default.  If you use
22441 @option{-mno-update}, there is a small window between the time that the
22442 stack pointer is updated and the address of the previous frame is
22443 stored, which means code that walks the stack frame across interrupts or
22444 signals may get corrupted data.
22446 @item -mavoid-indexed-addresses
22447 @itemx -mno-avoid-indexed-addresses
22448 @opindex mavoid-indexed-addresses
22449 @opindex mno-avoid-indexed-addresses
22450 Generate code that tries to avoid (not avoid) the use of indexed load
22451 or store instructions. These instructions can incur a performance
22452 penalty on Power6 processors in certain situations, such as when
22453 stepping through large arrays that cross a 16M boundary.  This option
22454 is enabled by default when targeting Power6 and disabled otherwise.
22456 @item -mfused-madd
22457 @itemx -mno-fused-madd
22458 @opindex mfused-madd
22459 @opindex mno-fused-madd
22460 Generate code that uses (does not use) the floating-point multiply and
22461 accumulate instructions.  These instructions are generated by default
22462 if hardware floating point is used.  The machine-dependent
22463 @option{-mfused-madd} option is now mapped to the machine-independent
22464 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22465 mapped to @option{-ffp-contract=off}.
22467 @item -mno-strict-align
22468 @itemx -mstrict-align
22469 @opindex mno-strict-align
22470 @opindex mstrict-align
22471 On System V.4 and embedded PowerPC systems do not (do) assume that
22472 unaligned memory references are handled by the system.
22474 @item -mrelocatable
22475 @itemx -mno-relocatable
22476 @opindex mrelocatable
22477 @opindex mno-relocatable
22478 Generate code that allows (does not allow) a static executable to be
22479 relocated to a different address at run time.  A simple embedded
22480 PowerPC system loader should relocate the entire contents of
22481 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22482 a table of 32-bit addresses generated by this option.  For this to
22483 work, all objects linked together must be compiled with
22484 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22485 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22487 @item -mrelocatable-lib
22488 @itemx -mno-relocatable-lib
22489 @opindex mrelocatable-lib
22490 @opindex mno-relocatable-lib
22491 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22492 @code{.fixup} section to allow static executables to be relocated at
22493 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22494 alignment of @option{-mrelocatable}.  Objects compiled with
22495 @option{-mrelocatable-lib} may be linked with objects compiled with
22496 any combination of the @option{-mrelocatable} options.
22498 @item -mno-toc
22499 @itemx -mtoc
22500 @opindex mno-toc
22501 @opindex mtoc
22502 On System V.4 and embedded PowerPC systems do not (do) assume that
22503 register 2 contains a pointer to a global area pointing to the addresses
22504 used in the program.
22506 @item -mlittle
22507 @itemx -mlittle-endian
22508 @opindex mlittle
22509 @opindex mlittle-endian
22510 On System V.4 and embedded PowerPC systems compile code for the
22511 processor in little-endian mode.  The @option{-mlittle-endian} option is
22512 the same as @option{-mlittle}.
22514 @item -mbig
22515 @itemx -mbig-endian
22516 @opindex mbig
22517 @opindex mbig-endian
22518 On System V.4 and embedded PowerPC systems compile code for the
22519 processor in big-endian mode.  The @option{-mbig-endian} option is
22520 the same as @option{-mbig}.
22522 @item -mdynamic-no-pic
22523 @opindex mdynamic-no-pic
22524 On Darwin and Mac OS X systems, compile code so that it is not
22525 relocatable, but that its external references are relocatable.  The
22526 resulting code is suitable for applications, but not shared
22527 libraries.
22529 @item -msingle-pic-base
22530 @opindex msingle-pic-base
22531 Treat the register used for PIC addressing as read-only, rather than
22532 loading it in the prologue for each function.  The runtime system is
22533 responsible for initializing this register with an appropriate value
22534 before execution begins.
22536 @item -mprioritize-restricted-insns=@var{priority}
22537 @opindex mprioritize-restricted-insns
22538 This option controls the priority that is assigned to
22539 dispatch-slot restricted instructions during the second scheduling
22540 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22541 or @samp{2} to assign no, highest, or second-highest (respectively)
22542 priority to dispatch-slot restricted
22543 instructions.
22545 @item -msched-costly-dep=@var{dependence_type}
22546 @opindex msched-costly-dep
22547 This option controls which dependences are considered costly
22548 by the target during instruction scheduling.  The argument
22549 @var{dependence_type} takes one of the following values:
22551 @table @asis
22552 @item @samp{no}
22553 No dependence is costly.
22555 @item @samp{all}
22556 All dependences are costly.
22558 @item @samp{true_store_to_load}
22559 A true dependence from store to load is costly.
22561 @item @samp{store_to_load}
22562 Any dependence from store to load is costly.
22564 @item @var{number}
22565 Any dependence for which the latency is greater than or equal to
22566 @var{number} is costly.
22567 @end table
22569 @item -minsert-sched-nops=@var{scheme}
22570 @opindex minsert-sched-nops
22571 This option controls which NOP insertion scheme is used during
22572 the second scheduling pass.  The argument @var{scheme} takes one of the
22573 following values:
22575 @table @asis
22576 @item @samp{no}
22577 Don't insert NOPs.
22579 @item @samp{pad}
22580 Pad with NOPs any dispatch group that has vacant issue slots,
22581 according to the scheduler's grouping.
22583 @item @samp{regroup_exact}
22584 Insert NOPs to force costly dependent insns into
22585 separate groups.  Insert exactly as many NOPs as needed to force an insn
22586 to a new group, according to the estimated processor grouping.
22588 @item @var{number}
22589 Insert NOPs to force costly dependent insns into
22590 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22591 @end table
22593 @item -mcall-sysv
22594 @opindex mcall-sysv
22595 On System V.4 and embedded PowerPC systems compile code using calling
22596 conventions that adhere to the March 1995 draft of the System V
22597 Application Binary Interface, PowerPC processor supplement.  This is the
22598 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22600 @item -mcall-sysv-eabi
22601 @itemx -mcall-eabi
22602 @opindex mcall-sysv-eabi
22603 @opindex mcall-eabi
22604 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22606 @item -mcall-sysv-noeabi
22607 @opindex mcall-sysv-noeabi
22608 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22610 @item -mcall-aixdesc
22611 @opindex m
22612 On System V.4 and embedded PowerPC systems compile code for the AIX
22613 operating system.
22615 @item -mcall-linux
22616 @opindex mcall-linux
22617 On System V.4 and embedded PowerPC systems compile code for the
22618 Linux-based GNU system.
22620 @item -mcall-freebsd
22621 @opindex mcall-freebsd
22622 On System V.4 and embedded PowerPC systems compile code for the
22623 FreeBSD operating system.
22625 @item -mcall-netbsd
22626 @opindex mcall-netbsd
22627 On System V.4 and embedded PowerPC systems compile code for the
22628 NetBSD operating system.
22630 @item -mcall-openbsd
22631 @opindex mcall-netbsd
22632 On System V.4 and embedded PowerPC systems compile code for the
22633 OpenBSD operating system.
22635 @item -maix-struct-return
22636 @opindex maix-struct-return
22637 Return all structures in memory (as specified by the AIX ABI)@.
22639 @item -msvr4-struct-return
22640 @opindex msvr4-struct-return
22641 Return structures smaller than 8 bytes in registers (as specified by the
22642 SVR4 ABI)@.
22644 @item -mabi=@var{abi-type}
22645 @opindex mabi
22646 Extend the current ABI with a particular extension, or remove such extension.
22647 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22648 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22649 @samp{elfv1}, @samp{elfv2}@.
22651 @item -mabi=spe
22652 @opindex mabi=spe
22653 Extend the current ABI with SPE ABI extensions.  This does not change
22654 the default ABI, instead it adds the SPE ABI extensions to the current
22655 ABI@.
22657 @item -mabi=no-spe
22658 @opindex mabi=no-spe
22659 Disable Book-E SPE ABI extensions for the current ABI@.
22661 @item -mabi=ibmlongdouble
22662 @opindex mabi=ibmlongdouble
22663 Change the current ABI to use IBM extended-precision long double.
22664 This is not likely to work if your system defaults to using IEEE
22665 extended-precision long double.  If you change the long double type
22666 from IEEE extended-precision, the compiler will issue a warning unless
22667 you use the @option{-Wno-psabi} option.
22669 @item -mabi=ieeelongdouble
22670 @opindex mabi=ieeelongdouble
22671 Change the current ABI to use IEEE extended-precision long double.
22672 This is not likely to work if your system defaults to using IBM
22673 extended-precision long double.  If you change the long double type
22674 from IBM extended-precision, the compiler will issue a warning unless
22675 you use the @option{-Wno-psabi} option.
22677 @item -mabi=elfv1
22678 @opindex mabi=elfv1
22679 Change the current ABI to use the ELFv1 ABI.
22680 This is the default ABI for big-endian PowerPC 64-bit Linux.
22681 Overriding the default ABI requires special system support and is
22682 likely to fail in spectacular ways.
22684 @item -mabi=elfv2
22685 @opindex mabi=elfv2
22686 Change the current ABI to use the ELFv2 ABI.
22687 This is the default ABI for little-endian PowerPC 64-bit Linux.
22688 Overriding the default ABI requires special system support and is
22689 likely to fail in spectacular ways.
22691 @item -mgnu-attribute
22692 @itemx -mno-gnu-attribute
22693 @opindex mgnu-attribute
22694 @opindex mno-gnu-attribute
22695 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22696 .gnu.attributes section that specify ABI variations in function
22697 parameters or return values.
22699 @item -mprototype
22700 @itemx -mno-prototype
22701 @opindex mprototype
22702 @opindex mno-prototype
22703 On System V.4 and embedded PowerPC systems assume that all calls to
22704 variable argument functions are properly prototyped.  Otherwise, the
22705 compiler must insert an instruction before every non-prototyped call to
22706 set or clear bit 6 of the condition code register (@code{CR}) to
22707 indicate whether floating-point values are passed in the floating-point
22708 registers in case the function takes variable arguments.  With
22709 @option{-mprototype}, only calls to prototyped variable argument functions
22710 set or clear the bit.
22712 @item -msim
22713 @opindex msim
22714 On embedded PowerPC systems, assume that the startup module is called
22715 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22716 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22717 configurations.
22719 @item -mmvme
22720 @opindex mmvme
22721 On embedded PowerPC systems, assume that the startup module is called
22722 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22723 @file{libc.a}.
22725 @item -mads
22726 @opindex mads
22727 On embedded PowerPC systems, assume that the startup module is called
22728 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22729 @file{libc.a}.
22731 @item -myellowknife
22732 @opindex myellowknife
22733 On embedded PowerPC systems, assume that the startup module is called
22734 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22735 @file{libc.a}.
22737 @item -mvxworks
22738 @opindex mvxworks
22739 On System V.4 and embedded PowerPC systems, specify that you are
22740 compiling for a VxWorks system.
22742 @item -memb
22743 @opindex memb
22744 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22745 header to indicate that @samp{eabi} extended relocations are used.
22747 @item -meabi
22748 @itemx -mno-eabi
22749 @opindex meabi
22750 @opindex mno-eabi
22751 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22752 Embedded Applications Binary Interface (EABI), which is a set of
22753 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22754 means that the stack is aligned to an 8-byte boundary, a function
22755 @code{__eabi} is called from @code{main} to set up the EABI
22756 environment, and the @option{-msdata} option can use both @code{r2} and
22757 @code{r13} to point to two separate small data areas.  Selecting
22758 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22759 no EABI initialization function is called from @code{main}, and the
22760 @option{-msdata} option only uses @code{r13} to point to a single
22761 small data area.  The @option{-meabi} option is on by default if you
22762 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22764 @item -msdata=eabi
22765 @opindex msdata=eabi
22766 On System V.4 and embedded PowerPC systems, put small initialized
22767 @code{const} global and static data in the @code{.sdata2} section, which
22768 is pointed to by register @code{r2}.  Put small initialized
22769 non-@code{const} global and static data in the @code{.sdata} section,
22770 which is pointed to by register @code{r13}.  Put small uninitialized
22771 global and static data in the @code{.sbss} section, which is adjacent to
22772 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22773 incompatible with the @option{-mrelocatable} option.  The
22774 @option{-msdata=eabi} option also sets the @option{-memb} option.
22776 @item -msdata=sysv
22777 @opindex msdata=sysv
22778 On System V.4 and embedded PowerPC systems, put small global and static
22779 data in the @code{.sdata} section, which is pointed to by register
22780 @code{r13}.  Put small uninitialized global and static data in the
22781 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22782 The @option{-msdata=sysv} option is incompatible with the
22783 @option{-mrelocatable} option.
22785 @item -msdata=default
22786 @itemx -msdata
22787 @opindex msdata=default
22788 @opindex msdata
22789 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22790 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22791 same as @option{-msdata=sysv}.
22793 @item -msdata=data
22794 @opindex msdata=data
22795 On System V.4 and embedded PowerPC systems, put small global
22796 data in the @code{.sdata} section.  Put small uninitialized global
22797 data in the @code{.sbss} section.  Do not use register @code{r13}
22798 to address small data however.  This is the default behavior unless
22799 other @option{-msdata} options are used.
22801 @item -msdata=none
22802 @itemx -mno-sdata
22803 @opindex msdata=none
22804 @opindex mno-sdata
22805 On embedded PowerPC systems, put all initialized global and static data
22806 in the @code{.data} section, and all uninitialized data in the
22807 @code{.bss} section.
22809 @item -mblock-move-inline-limit=@var{num}
22810 @opindex mblock-move-inline-limit
22811 Inline all block moves (such as calls to @code{memcpy} or structure
22812 copies) less than or equal to @var{num} bytes.  The minimum value for
22813 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22814 targets.  The default value is target-specific.
22816 @item -G @var{num}
22817 @opindex G
22818 @cindex smaller data references (PowerPC)
22819 @cindex .sdata/.sdata2 references (PowerPC)
22820 On embedded PowerPC systems, put global and static items less than or
22821 equal to @var{num} bytes into the small data or BSS sections instead of
22822 the normal data or BSS section.  By default, @var{num} is 8.  The
22823 @option{-G @var{num}} switch is also passed to the linker.
22824 All modules should be compiled with the same @option{-G @var{num}} value.
22826 @item -mregnames
22827 @itemx -mno-regnames
22828 @opindex mregnames
22829 @opindex mno-regnames
22830 On System V.4 and embedded PowerPC systems do (do not) emit register
22831 names in the assembly language output using symbolic forms.
22833 @item -mlongcall
22834 @itemx -mno-longcall
22835 @opindex mlongcall
22836 @opindex mno-longcall
22837 By default assume that all calls are far away so that a longer and more
22838 expensive calling sequence is required.  This is required for calls
22839 farther than 32 megabytes (33,554,432 bytes) from the current location.
22840 A short call is generated if the compiler knows
22841 the call cannot be that far away.  This setting can be overridden by
22842 the @code{shortcall} function attribute, or by @code{#pragma
22843 longcall(0)}.
22845 Some linkers are capable of detecting out-of-range calls and generating
22846 glue code on the fly.  On these systems, long calls are unnecessary and
22847 generate slower code.  As of this writing, the AIX linker can do this,
22848 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22849 to the GNU linker for 32-bit PowerPC systems as well.
22851 In the future, GCC may ignore all longcall specifications
22852 when the linker is known to generate glue.
22854 @item -mtls-markers
22855 @itemx -mno-tls-markers
22856 @opindex mtls-markers
22857 @opindex mno-tls-markers
22858 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22859 specifying the function argument.  The relocation allows the linker to
22860 reliably associate function call with argument setup instructions for
22861 TLS optimization, which in turn allows GCC to better schedule the
22862 sequence.
22864 @item -mrecip
22865 @itemx -mno-recip
22866 @opindex mrecip
22867 This option enables use of the reciprocal estimate and
22868 reciprocal square root estimate instructions with additional
22869 Newton-Raphson steps to increase precision instead of doing a divide or
22870 square root and divide for floating-point arguments.  You should use
22871 the @option{-ffast-math} option when using @option{-mrecip} (or at
22872 least @option{-funsafe-math-optimizations},
22873 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22874 @option{-fno-trapping-math}).  Note that while the throughput of the
22875 sequence is generally higher than the throughput of the non-reciprocal
22876 instruction, the precision of the sequence can be decreased by up to 2
22877 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22878 roots.
22880 @item -mrecip=@var{opt}
22881 @opindex mrecip=opt
22882 This option controls which reciprocal estimate instructions
22883 may be used.  @var{opt} is a comma-separated list of options, which may
22884 be preceded by a @code{!} to invert the option:
22886 @table @samp
22888 @item all
22889 Enable all estimate instructions.
22891 @item default
22892 Enable the default instructions, equivalent to @option{-mrecip}.
22894 @item none
22895 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22897 @item div
22898 Enable the reciprocal approximation instructions for both
22899 single and double precision.
22901 @item divf
22902 Enable the single-precision reciprocal approximation instructions.
22904 @item divd
22905 Enable the double-precision reciprocal approximation instructions.
22907 @item rsqrt
22908 Enable the reciprocal square root approximation instructions for both
22909 single and double precision.
22911 @item rsqrtf
22912 Enable the single-precision reciprocal square root approximation instructions.
22914 @item rsqrtd
22915 Enable the double-precision reciprocal square root approximation instructions.
22917 @end table
22919 So, for example, @option{-mrecip=all,!rsqrtd} enables
22920 all of the reciprocal estimate instructions, except for the
22921 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22922 which handle the double-precision reciprocal square root calculations.
22924 @item -mrecip-precision
22925 @itemx -mno-recip-precision
22926 @opindex mrecip-precision
22927 Assume (do not assume) that the reciprocal estimate instructions
22928 provide higher-precision estimates than is mandated by the PowerPC
22929 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22930 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22931 The double-precision square root estimate instructions are not generated by
22932 default on low-precision machines, since they do not provide an
22933 estimate that converges after three steps.
22935 @item -mpointers-to-nested-functions
22936 @itemx -mno-pointers-to-nested-functions
22937 @opindex mpointers-to-nested-functions
22938 Generate (do not generate) code to load up the static chain register
22939 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22940 systems where a function pointer points to a 3-word descriptor giving
22941 the function address, TOC value to be loaded in register @code{r2}, and
22942 static chain value to be loaded in register @code{r11}.  The
22943 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22944 call through pointers to nested functions or pointers
22945 to functions compiled in other languages that use the static chain if
22946 you use @option{-mno-pointers-to-nested-functions}.
22948 @item -msave-toc-indirect
22949 @itemx -mno-save-toc-indirect
22950 @opindex msave-toc-indirect
22951 Generate (do not generate) code to save the TOC value in the reserved
22952 stack location in the function prologue if the function calls through
22953 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22954 saved in the prologue, it is saved just before the call through the
22955 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22957 @item -mcompat-align-parm
22958 @itemx -mno-compat-align-parm
22959 @opindex mcompat-align-parm
22960 Generate (do not generate) code to pass structure parameters with a
22961 maximum alignment of 64 bits, for compatibility with older versions
22962 of GCC.
22964 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22965 structure parameter on a 128-bit boundary when that structure contained
22966 a member requiring 128-bit alignment.  This is corrected in more
22967 recent versions of GCC.  This option may be used to generate code
22968 that is compatible with functions compiled with older versions of
22969 GCC.
22971 The @option{-mno-compat-align-parm} option is the default.
22973 @item -mstack-protector-guard=@var{guard}
22974 @itemx -mstack-protector-guard-reg=@var{reg}
22975 @itemx -mstack-protector-guard-offset=@var{offset}
22976 @itemx -mstack-protector-guard-symbol=@var{symbol}
22977 @opindex mstack-protector-guard
22978 @opindex mstack-protector-guard-reg
22979 @opindex mstack-protector-guard-offset
22980 @opindex mstack-protector-guard-symbol
22981 Generate stack protection code using canary at @var{guard}.  Supported
22982 locations are @samp{global} for global canary or @samp{tls} for per-thread
22983 canary in the TLS block (the default with GNU libc version 2.4 or later).
22985 With the latter choice the options
22986 @option{-mstack-protector-guard-reg=@var{reg}} and
22987 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22988 which register to use as base register for reading the canary, and from what
22989 offset from that base register. The default for those is as specified in the
22990 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22991 the offset with a symbol reference to a canary in the TLS block.
22992 @end table
22995 @node RISC-V Options
22996 @subsection RISC-V Options
22997 @cindex RISC-V Options
22999 These command-line options are defined for RISC-V targets:
23001 @table @gcctabopt
23002 @item -mbranch-cost=@var{n}
23003 @opindex mbranch-cost
23004 Set the cost of branches to roughly @var{n} instructions.
23006 @item -mplt
23007 @itemx -mno-plt
23008 @opindex plt
23009 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23010 non-PIC.  The default is @option{-mplt}.
23012 @item -mabi=@var{ABI-string}
23013 @opindex mabi
23014 Specify integer and floating-point calling convention.  @var{ABI-string}
23015 contains two parts: the size of integer types and the registers used for
23016 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23017 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23018 32-bit), and that floating-point values up to 64 bits wide are passed in F
23019 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23020 allows the compiler to generate code that uses the F and D extensions but only
23021 allows floating-point values up to 32 bits long to be passed in registers; or
23022 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23023 passed in registers.
23025 The default for this argument is system dependent, users who want a specific
23026 calling convention should specify one explicitly.  The valid calling
23027 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23028 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23029 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23030 invalid because the ABI requires 64-bit values be passed in F registers, but F
23031 registers are only 32 bits wide.
23033 @item -mfdiv
23034 @itemx -mno-fdiv
23035 @opindex mfdiv
23036 Do or don't use hardware floating-point divide and square root instructions.
23037 This requires the F or D extensions for floating-point registers.  The default
23038 is to use them if the specified architecture has these instructions.
23040 @item -mdiv
23041 @itemx -mno-div
23042 @opindex mdiv
23043 Do or don't use hardware instructions for integer division.  This requires the
23044 M extension.  The default is to use them if the specified architecture has
23045 these instructions.
23047 @item -march=@var{ISA-string}
23048 @opindex march
23049 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23050 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23052 @item -mtune=@var{processor-string}
23053 @opindex mtune
23054 Optimize the output for the given processor, specified by microarchitecture
23055 name.
23057 @item -mpreferred-stack-boundary=@var{num}
23058 @opindex mpreferred-stack-boundary
23059 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23060 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23061 the default is 4 (16 bytes or 128-bits).
23063 @strong{Warning:} If you use this switch, then you must build all modules with
23064 the same value, including any libraries.  This includes the system libraries
23065 and startup modules.
23067 @item -msmall-data-limit=@var{n}
23068 @opindex msmall-data-limit
23069 Put global and static data smaller than @var{n} bytes into a special section
23070 (on some targets).
23072 @item -msave-restore
23073 @itemx -mno-save-restore
23074 @opindex msave-restore
23075 Do or don't use smaller but slower prologue and epilogue code that uses
23076 library function calls.  The default is to use fast inline prologues and
23077 epilogues.
23079 @item -mstrict-align
23080 @itemx -mno-strict-align
23081 @opindex mstrict-align
23082 Do not or do generate unaligned memory accesses.  The default is set depending
23083 on whether the processor we are optimizing for supports fast unaligned access
23084 or not.
23086 @item -mcmodel=medlow
23087 @opindex mcmodel=medlow
23088 Generate code for the medium-low code model. The program and its statically
23089 defined symbols must lie within a single 2 GiB address range and must lie
23090 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23091 statically or dynamically linked. This is the default code model.
23093 @item -mcmodel=medany
23094 @opindex mcmodel=medany
23095 Generate code for the medium-any code model. The program and its statically
23096 defined symbols must be within any single 2 GiB address range. Programs can be
23097 statically or dynamically linked.
23099 @item -mexplicit-relocs
23100 @itemx -mno-exlicit-relocs
23101 Use or do not use assembler relocation operators when dealing with symbolic
23102 addresses.  The alternative is to use assembler macros instead, which may
23103 limit optimization.
23105 @end table
23107 @node RL78 Options
23108 @subsection RL78 Options
23109 @cindex RL78 Options
23111 @table @gcctabopt
23113 @item -msim
23114 @opindex msim
23115 Links in additional target libraries to support operation within a
23116 simulator.
23118 @item -mmul=none
23119 @itemx -mmul=g10
23120 @itemx -mmul=g13
23121 @itemx -mmul=g14
23122 @itemx -mmul=rl78
23123 @opindex mmul
23124 Specifies the type of hardware multiplication and division support to
23125 be used.  The simplest is @code{none}, which uses software for both
23126 multiplication and division.  This is the default.  The @code{g13}
23127 value is for the hardware multiply/divide peripheral found on the
23128 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23129 the multiplication and division instructions supported by the RL78/G14
23130 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23131 the value @code{mg10} is an alias for @code{none}.
23133 In addition a C preprocessor macro is defined, based upon the setting
23134 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23135 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23137 @item -mcpu=g10
23138 @itemx -mcpu=g13
23139 @itemx -mcpu=g14
23140 @itemx -mcpu=rl78
23141 @opindex mcpu
23142 Specifies the RL78 core to target.  The default is the G14 core, also
23143 known as an S3 core or just RL78.  The G13 or S2 core does not have
23144 multiply or divide instructions, instead it uses a hardware peripheral
23145 for these operations.  The G10 or S1 core does not have register
23146 banks, so it uses a different calling convention.
23148 If this option is set it also selects the type of hardware multiply
23149 support to use, unless this is overridden by an explicit
23150 @option{-mmul=none} option on the command line.  Thus specifying
23151 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23152 peripheral and specifying @option{-mcpu=g10} disables the use of
23153 hardware multiplications altogether.
23155 Note, although the RL78/G14 core is the default target, specifying
23156 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23157 change the behavior of the toolchain since it also enables G14
23158 hardware multiply support.  If these options are not specified on the
23159 command line then software multiplication routines will be used even
23160 though the code targets the RL78 core.  This is for backwards
23161 compatibility with older toolchains which did not have hardware
23162 multiply and divide support.
23164 In addition a C preprocessor macro is defined, based upon the setting
23165 of this option.  Possible values are: @code{__RL78_G10__},
23166 @code{__RL78_G13__} or @code{__RL78_G14__}.
23168 @item -mg10
23169 @itemx -mg13
23170 @itemx -mg14
23171 @itemx -mrl78
23172 @opindex mg10
23173 @opindex mg13
23174 @opindex mg14
23175 @opindex mrl78
23176 These are aliases for the corresponding @option{-mcpu=} option.  They
23177 are provided for backwards compatibility.
23179 @item -mallregs
23180 @opindex mallregs
23181 Allow the compiler to use all of the available registers.  By default
23182 registers @code{r24..r31} are reserved for use in interrupt handlers.
23183 With this option enabled these registers can be used in ordinary
23184 functions as well.
23186 @item -m64bit-doubles
23187 @itemx -m32bit-doubles
23188 @opindex m64bit-doubles
23189 @opindex m32bit-doubles
23190 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23191 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23192 @option{-m32bit-doubles}.
23194 @item -msave-mduc-in-interrupts
23195 @itemx -mno-save-mduc-in-interrupts
23196 @opindex msave-mduc-in-interrupts
23197 @opindex mno-save-mduc-in-interrupts
23198 Specifies that interrupt handler functions should preserve the
23199 MDUC registers.  This is only necessary if normal code might use
23200 the MDUC registers, for example because it performs multiplication
23201 and division operations.  The default is to ignore the MDUC registers
23202 as this makes the interrupt handlers faster.  The target option -mg13
23203 needs to be passed for this to work as this feature is only available
23204 on the G13 target (S2 core).  The MDUC registers will only be saved
23205 if the interrupt handler performs a multiplication or division
23206 operation or it calls another function.
23208 @end table
23210 @node RS/6000 and PowerPC Options
23211 @subsection IBM RS/6000 and PowerPC Options
23212 @cindex RS/6000 and PowerPC Options
23213 @cindex IBM RS/6000 and PowerPC Options
23215 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23216 @table @gcctabopt
23217 @item -mpowerpc-gpopt
23218 @itemx -mno-powerpc-gpopt
23219 @itemx -mpowerpc-gfxopt
23220 @itemx -mno-powerpc-gfxopt
23221 @need 800
23222 @itemx -mpowerpc64
23223 @itemx -mno-powerpc64
23224 @itemx -mmfcrf
23225 @itemx -mno-mfcrf
23226 @itemx -mpopcntb
23227 @itemx -mno-popcntb
23228 @itemx -mpopcntd
23229 @itemx -mno-popcntd
23230 @itemx -mfprnd
23231 @itemx -mno-fprnd
23232 @need 800
23233 @itemx -mcmpb
23234 @itemx -mno-cmpb
23235 @itemx -mmfpgpr
23236 @itemx -mno-mfpgpr
23237 @itemx -mhard-dfp
23238 @itemx -mno-hard-dfp
23239 @opindex mpowerpc-gpopt
23240 @opindex mno-powerpc-gpopt
23241 @opindex mpowerpc-gfxopt
23242 @opindex mno-powerpc-gfxopt
23243 @opindex mpowerpc64
23244 @opindex mno-powerpc64
23245 @opindex mmfcrf
23246 @opindex mno-mfcrf
23247 @opindex mpopcntb
23248 @opindex mno-popcntb
23249 @opindex mpopcntd
23250 @opindex mno-popcntd
23251 @opindex mfprnd
23252 @opindex mno-fprnd
23253 @opindex mcmpb
23254 @opindex mno-cmpb
23255 @opindex mmfpgpr
23256 @opindex mno-mfpgpr
23257 @opindex mhard-dfp
23258 @opindex mno-hard-dfp
23259 You use these options to specify which instructions are available on the
23260 processor you are using.  The default value of these options is
23261 determined when configuring GCC@.  Specifying the
23262 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23263 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23264 rather than the options listed above.
23266 Specifying @option{-mpowerpc-gpopt} allows
23267 GCC to use the optional PowerPC architecture instructions in the
23268 General Purpose group, including floating-point square root.  Specifying
23269 @option{-mpowerpc-gfxopt} allows GCC to
23270 use the optional PowerPC architecture instructions in the Graphics
23271 group, including floating-point select.
23273 The @option{-mmfcrf} option allows GCC to generate the move from
23274 condition register field instruction implemented on the POWER4
23275 processor and other processors that support the PowerPC V2.01
23276 architecture.
23277 The @option{-mpopcntb} option allows GCC to generate the popcount and
23278 double-precision FP reciprocal estimate instruction implemented on the
23279 POWER5 processor and other processors that support the PowerPC V2.02
23280 architecture.
23281 The @option{-mpopcntd} option allows GCC to generate the popcount
23282 instruction implemented on the POWER7 processor and other processors
23283 that support the PowerPC V2.06 architecture.
23284 The @option{-mfprnd} option allows GCC to generate the FP round to
23285 integer instructions implemented on the POWER5+ processor and other
23286 processors that support the PowerPC V2.03 architecture.
23287 The @option{-mcmpb} option allows GCC to generate the compare bytes
23288 instruction implemented on the POWER6 processor and other processors
23289 that support the PowerPC V2.05 architecture.
23290 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23291 general-purpose register instructions implemented on the POWER6X
23292 processor and other processors that support the extended PowerPC V2.05
23293 architecture.
23294 The @option{-mhard-dfp} option allows GCC to generate the decimal
23295 floating-point instructions implemented on some POWER processors.
23297 The @option{-mpowerpc64} option allows GCC to generate the additional
23298 64-bit instructions that are found in the full PowerPC64 architecture
23299 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23300 @option{-mno-powerpc64}.
23302 @item -mcpu=@var{cpu_type}
23303 @opindex mcpu
23304 Set architecture type, register usage, and
23305 instruction scheduling parameters for machine type @var{cpu_type}.
23306 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23307 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23308 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23309 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23310 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23311 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23312 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23313 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23314 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23315 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23316 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23317 @samp{rs64}, and @samp{native}.
23319 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23320 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23321 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23322 architecture machine types, with an appropriate, generic processor
23323 model assumed for scheduling purposes.
23325 Specifying @samp{native} as cpu type detects and selects the
23326 architecture option that corresponds to the host processor of the
23327 system performing the compilation.
23328 @option{-mcpu=native} has no effect if GCC does not recognize the
23329 processor.
23331 The other options specify a specific processor.  Code generated under
23332 those options runs best on that processor, and may not run at all on
23333 others.
23335 The @option{-mcpu} options automatically enable or disable the
23336 following options:
23338 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23339 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23340 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
23341 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23342 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
23343 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23345 The particular options set for any particular CPU varies between
23346 compiler versions, depending on what setting seems to produce optimal
23347 code for that CPU; it doesn't necessarily reflect the actual hardware's
23348 capabilities.  If you wish to set an individual option to a particular
23349 value, you may specify it after the @option{-mcpu} option, like
23350 @option{-mcpu=970 -mno-altivec}.
23352 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23353 not enabled or disabled by the @option{-mcpu} option at present because
23354 AIX does not have full support for these options.  You may still
23355 enable or disable them individually if you're sure it'll work in your
23356 environment.
23358 @item -mtune=@var{cpu_type}
23359 @opindex mtune
23360 Set the instruction scheduling parameters for machine type
23361 @var{cpu_type}, but do not set the architecture type or register usage,
23362 as @option{-mcpu=@var{cpu_type}} does.  The same
23363 values for @var{cpu_type} are used for @option{-mtune} as for
23364 @option{-mcpu}.  If both are specified, the code generated uses the
23365 architecture and registers set by @option{-mcpu}, but the
23366 scheduling parameters set by @option{-mtune}.
23368 @item -mcmodel=small
23369 @opindex mcmodel=small
23370 Generate PowerPC64 code for the small model: The TOC is limited to
23371 64k.
23373 @item -mcmodel=medium
23374 @opindex mcmodel=medium
23375 Generate PowerPC64 code for the medium model: The TOC and other static
23376 data may be up to a total of 4G in size.  This is the default for 64-bit
23377 Linux.
23379 @item -mcmodel=large
23380 @opindex mcmodel=large
23381 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23382 in size.  Other data and code is only limited by the 64-bit address
23383 space.
23385 @item -maltivec
23386 @itemx -mno-altivec
23387 @opindex maltivec
23388 @opindex mno-altivec
23389 Generate code that uses (does not use) AltiVec instructions, and also
23390 enable the use of built-in functions that allow more direct access to
23391 the AltiVec instruction set.  You may also need to set
23392 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23393 enhancements.
23395 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23396 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23397 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23398 match array element order corresponding to the endianness of the
23399 target.  That is, element zero identifies the leftmost element in a
23400 vector register when targeting a big-endian platform, and identifies
23401 the rightmost element in a vector register when targeting a
23402 little-endian platform.
23404 @item -maltivec=be
23405 @opindex maltivec=be
23406 Generate AltiVec instructions using big-endian element order,
23407 regardless of whether the target is big- or little-endian.  This is
23408 the default when targeting a big-endian platform.  Using this option
23409 is currently deprecated.  Support for this feature will be removed in
23410 GCC 9.
23412 The element order is used to interpret element numbers in AltiVec
23413 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23414 @code{vec_insert}.  By default, these match array element order
23415 corresponding to the endianness for the target.
23417 @item -maltivec=le
23418 @opindex maltivec=le
23419 Generate AltiVec instructions using little-endian element order,
23420 regardless of whether the target is big- or little-endian.  This is
23421 the default when targeting a little-endian platform.  This option is
23422 currently ignored when targeting a big-endian platform.
23424 The element order is used to interpret element numbers in AltiVec
23425 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23426 @code{vec_insert}.  By default, these match array element order
23427 corresponding to the endianness for the target.
23429 @item -mvrsave
23430 @itemx -mno-vrsave
23431 @opindex mvrsave
23432 @opindex mno-vrsave
23433 Generate VRSAVE instructions when generating AltiVec code.
23435 @item -msecure-plt
23436 @opindex msecure-plt
23437 Generate code that allows @command{ld} and @command{ld.so}
23438 to build executables and shared
23439 libraries with non-executable @code{.plt} and @code{.got} sections.
23440 This is a PowerPC
23441 32-bit SYSV ABI option.
23443 @item -mbss-plt
23444 @opindex mbss-plt
23445 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23446 fills in, and
23447 requires @code{.plt} and @code{.got}
23448 sections that are both writable and executable.
23449 This is a PowerPC 32-bit SYSV ABI option.
23451 @item -misel
23452 @itemx -mno-isel
23453 @opindex misel
23454 @opindex mno-isel
23455 This switch enables or disables the generation of ISEL instructions.
23457 @item -misel=@var{yes/no}
23458 This switch has been deprecated.  Use @option{-misel} and
23459 @option{-mno-isel} instead.
23461 @item -mpaired
23462 @itemx -mno-paired
23463 @opindex mpaired
23464 @opindex mno-paired
23465 This switch enables or disables the generation of PAIRED simd
23466 instructions.
23468 @item -mvsx
23469 @itemx -mno-vsx
23470 @opindex mvsx
23471 @opindex mno-vsx
23472 Generate code that uses (does not use) vector/scalar (VSX)
23473 instructions, and also enable the use of built-in functions that allow
23474 more direct access to the VSX instruction set.
23476 @item -mcrypto
23477 @itemx -mno-crypto
23478 @opindex mcrypto
23479 @opindex mno-crypto
23480 Enable the use (disable) of the built-in functions that allow direct
23481 access to the cryptographic instructions that were added in version
23482 2.07 of the PowerPC ISA.
23484 @item -mdirect-move
23485 @itemx -mno-direct-move
23486 @opindex mdirect-move
23487 @opindex mno-direct-move
23488 Generate code that uses (does not use) the instructions to move data
23489 between the general purpose registers and the vector/scalar (VSX)
23490 registers that were added in version 2.07 of the PowerPC ISA.
23492 @item -mhtm
23493 @itemx -mno-htm
23494 @opindex mhtm
23495 @opindex mno-htm
23496 Enable (disable) the use of the built-in functions that allow direct
23497 access to the Hardware Transactional Memory (HTM) instructions that
23498 were added in version 2.07 of the PowerPC ISA.
23500 @item -mpower8-fusion
23501 @itemx -mno-power8-fusion
23502 @opindex mpower8-fusion
23503 @opindex mno-power8-fusion
23504 Generate code that keeps (does not keeps) some integer operations
23505 adjacent so that the instructions can be fused together on power8 and
23506 later processors.
23508 @item -mpower8-vector
23509 @itemx -mno-power8-vector
23510 @opindex mpower8-vector
23511 @opindex mno-power8-vector
23512 Generate code that uses (does not use) the vector and scalar
23513 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23514 enable the use of built-in functions that allow more direct access to
23515 the vector instructions.
23517 @item -mquad-memory
23518 @itemx -mno-quad-memory
23519 @opindex mquad-memory
23520 @opindex mno-quad-memory
23521 Generate code that uses (does not use) the non-atomic quad word memory
23522 instructions.  The @option{-mquad-memory} option requires use of
23523 64-bit mode.
23525 @item -mquad-memory-atomic
23526 @itemx -mno-quad-memory-atomic
23527 @opindex mquad-memory-atomic
23528 @opindex mno-quad-memory-atomic
23529 Generate code that uses (does not use) the atomic quad word memory
23530 instructions.  The @option{-mquad-memory-atomic} option requires use of
23531 64-bit mode.
23533 @item -mfloat128
23534 @itemx -mno-float128
23535 @opindex mfloat128
23536 @opindex mno-float128
23537 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23538 and use either software emulation for IEEE 128-bit floating point or
23539 hardware instructions.
23541 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23542 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23543 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23544 floating point support only works on PowerPC Linux systems.
23546 The default for @option{-mfloat128} is enabled on PowerPC Linux
23547 systems using the VSX instruction set, and disabled on other systems.
23549 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23550 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23551 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23552 floating point instructions.  Otherwise, if you do not specify to
23553 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23554 system, IEEE 128-bit floating point will be done with software
23555 emulation.
23557 @item -mfloat128-hardware
23558 @itemx -mno-float128-hardware
23559 @opindex mfloat128-hardware
23560 @opindex mno-float128-hardware
23561 Enable/disable using ISA 3.0 hardware instructions to support the
23562 @var{__float128} data type.
23564 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23565 Linux systems using the ISA 3.0 instruction set, and disabled on other
23566 systems.
23568 @item -m32
23569 @itemx -m64
23570 @opindex m32
23571 @opindex m64
23572 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23573 targets (including GNU/Linux).  The 32-bit environment sets int, long
23574 and pointer to 32 bits and generates code that runs on any PowerPC
23575 variant.  The 64-bit environment sets int to 32 bits and long and
23576 pointer to 64 bits, and generates code for PowerPC64, as for
23577 @option{-mpowerpc64}.
23579 @item -mfull-toc
23580 @itemx -mno-fp-in-toc
23581 @itemx -mno-sum-in-toc
23582 @itemx -mminimal-toc
23583 @opindex mfull-toc
23584 @opindex mno-fp-in-toc
23585 @opindex mno-sum-in-toc
23586 @opindex mminimal-toc
23587 Modify generation of the TOC (Table Of Contents), which is created for
23588 every executable file.  The @option{-mfull-toc} option is selected by
23589 default.  In that case, GCC allocates at least one TOC entry for
23590 each unique non-automatic variable reference in your program.  GCC
23591 also places floating-point constants in the TOC@.  However, only
23592 16,384 entries are available in the TOC@.
23594 If you receive a linker error message that saying you have overflowed
23595 the available TOC space, you can reduce the amount of TOC space used
23596 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23597 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23598 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23599 generate code to calculate the sum of an address and a constant at
23600 run time instead of putting that sum into the TOC@.  You may specify one
23601 or both of these options.  Each causes GCC to produce very slightly
23602 slower and larger code at the expense of conserving TOC space.
23604 If you still run out of space in the TOC even when you specify both of
23605 these options, specify @option{-mminimal-toc} instead.  This option causes
23606 GCC to make only one TOC entry for every file.  When you specify this
23607 option, GCC produces code that is slower and larger but which
23608 uses extremely little TOC space.  You may wish to use this option
23609 only on files that contain less frequently-executed code.
23611 @item -maix64
23612 @itemx -maix32
23613 @opindex maix64
23614 @opindex maix32
23615 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23616 @code{long} type, and the infrastructure needed to support them.
23617 Specifying @option{-maix64} implies @option{-mpowerpc64},
23618 while @option{-maix32} disables the 64-bit ABI and
23619 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23621 @item -mxl-compat
23622 @itemx -mno-xl-compat
23623 @opindex mxl-compat
23624 @opindex mno-xl-compat
23625 Produce code that conforms more closely to IBM XL compiler semantics
23626 when using AIX-compatible ABI@.  Pass floating-point arguments to
23627 prototyped functions beyond the register save area (RSA) on the stack
23628 in addition to argument FPRs.  Do not assume that most significant
23629 double in 128-bit long double value is properly rounded when comparing
23630 values and converting to double.  Use XL symbol names for long double
23631 support routines.
23633 The AIX calling convention was extended but not initially documented to
23634 handle an obscure K&R C case of calling a function that takes the
23635 address of its arguments with fewer arguments than declared.  IBM XL
23636 compilers access floating-point arguments that do not fit in the
23637 RSA from the stack when a subroutine is compiled without
23638 optimization.  Because always storing floating-point arguments on the
23639 stack is inefficient and rarely needed, this option is not enabled by
23640 default and only is necessary when calling subroutines compiled by IBM
23641 XL compilers without optimization.
23643 @item -mpe
23644 @opindex mpe
23645 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23646 application written to use message passing with special startup code to
23647 enable the application to run.  The system must have PE installed in the
23648 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23649 must be overridden with the @option{-specs=} option to specify the
23650 appropriate directory location.  The Parallel Environment does not
23651 support threads, so the @option{-mpe} option and the @option{-pthread}
23652 option are incompatible.
23654 @item -malign-natural
23655 @itemx -malign-power
23656 @opindex malign-natural
23657 @opindex malign-power
23658 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23659 @option{-malign-natural} overrides the ABI-defined alignment of larger
23660 types, such as floating-point doubles, on their natural size-based boundary.
23661 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23662 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23664 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23665 is not supported.
23667 @item -msoft-float
23668 @itemx -mhard-float
23669 @opindex msoft-float
23670 @opindex mhard-float
23671 Generate code that does not use (uses) the floating-point register set.
23672 Software floating-point emulation is provided if you use the
23673 @option{-msoft-float} option, and pass the option to GCC when linking.
23675 @item -msingle-float
23676 @itemx -mdouble-float
23677 @opindex msingle-float
23678 @opindex mdouble-float
23679 Generate code for single- or double-precision floating-point operations.
23680 @option{-mdouble-float} implies @option{-msingle-float}.
23682 @item -msimple-fpu
23683 @opindex msimple-fpu
23684 Do not generate @code{sqrt} and @code{div} instructions for hardware
23685 floating-point unit.
23687 @item -mfpu=@var{name}
23688 @opindex mfpu
23689 Specify type of floating-point unit.  Valid values for @var{name} are
23690 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
23691 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
23692 @samp{sp_full} (equivalent to @option{-msingle-float}),
23693 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
23695 @item -mxilinx-fpu
23696 @opindex mxilinx-fpu
23697 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
23699 @item -mmultiple
23700 @itemx -mno-multiple
23701 @opindex mmultiple
23702 @opindex mno-multiple
23703 Generate code that uses (does not use) the load multiple word
23704 instructions and the store multiple word instructions.  These
23705 instructions are generated by default on POWER systems, and not
23706 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23707 PowerPC systems, since those instructions do not work when the
23708 processor is in little-endian mode.  The exceptions are PPC740 and
23709 PPC750 which permit these instructions in little-endian mode.
23711 @item -mupdate
23712 @itemx -mno-update
23713 @opindex mupdate
23714 @opindex mno-update
23715 Generate code that uses (does not use) the load or store instructions
23716 that update the base register to the address of the calculated memory
23717 location.  These instructions are generated by default.  If you use
23718 @option{-mno-update}, there is a small window between the time that the
23719 stack pointer is updated and the address of the previous frame is
23720 stored, which means code that walks the stack frame across interrupts or
23721 signals may get corrupted data.
23723 @item -mavoid-indexed-addresses
23724 @itemx -mno-avoid-indexed-addresses
23725 @opindex mavoid-indexed-addresses
23726 @opindex mno-avoid-indexed-addresses
23727 Generate code that tries to avoid (not avoid) the use of indexed load
23728 or store instructions. These instructions can incur a performance
23729 penalty on Power6 processors in certain situations, such as when
23730 stepping through large arrays that cross a 16M boundary.  This option
23731 is enabled by default when targeting Power6 and disabled otherwise.
23733 @item -mfused-madd
23734 @itemx -mno-fused-madd
23735 @opindex mfused-madd
23736 @opindex mno-fused-madd
23737 Generate code that uses (does not use) the floating-point multiply and
23738 accumulate instructions.  These instructions are generated by default
23739 if hardware floating point is used.  The machine-dependent
23740 @option{-mfused-madd} option is now mapped to the machine-independent
23741 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23742 mapped to @option{-ffp-contract=off}.
23744 @item -mmulhw
23745 @itemx -mno-mulhw
23746 @opindex mmulhw
23747 @opindex mno-mulhw
23748 Generate code that uses (does not use) the half-word multiply and
23749 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23750 These instructions are generated by default when targeting those
23751 processors.
23753 @item -mdlmzb
23754 @itemx -mno-dlmzb
23755 @opindex mdlmzb
23756 @opindex mno-dlmzb
23757 Generate code that uses (does not use) the string-search @samp{dlmzb}
23758 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23759 generated by default when targeting those processors.
23761 @item -mno-bit-align
23762 @itemx -mbit-align
23763 @opindex mno-bit-align
23764 @opindex mbit-align
23765 On System V.4 and embedded PowerPC systems do not (do) force structures
23766 and unions that contain bit-fields to be aligned to the base type of the
23767 bit-field.
23769 For example, by default a structure containing nothing but 8
23770 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23771 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23772 the structure is aligned to a 1-byte boundary and is 1 byte in
23773 size.
23775 @item -mno-strict-align
23776 @itemx -mstrict-align
23777 @opindex mno-strict-align
23778 @opindex mstrict-align
23779 On System V.4 and embedded PowerPC systems do not (do) assume that
23780 unaligned memory references are handled by the system.
23782 @item -mrelocatable
23783 @itemx -mno-relocatable
23784 @opindex mrelocatable
23785 @opindex mno-relocatable
23786 Generate code that allows (does not allow) a static executable to be
23787 relocated to a different address at run time.  A simple embedded
23788 PowerPC system loader should relocate the entire contents of
23789 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23790 a table of 32-bit addresses generated by this option.  For this to
23791 work, all objects linked together must be compiled with
23792 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23793 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23795 @item -mrelocatable-lib
23796 @itemx -mno-relocatable-lib
23797 @opindex mrelocatable-lib
23798 @opindex mno-relocatable-lib
23799 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23800 @code{.fixup} section to allow static executables to be relocated at
23801 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23802 alignment of @option{-mrelocatable}.  Objects compiled with
23803 @option{-mrelocatable-lib} may be linked with objects compiled with
23804 any combination of the @option{-mrelocatable} options.
23806 @item -mno-toc
23807 @itemx -mtoc
23808 @opindex mno-toc
23809 @opindex mtoc
23810 On System V.4 and embedded PowerPC systems do not (do) assume that
23811 register 2 contains a pointer to a global area pointing to the addresses
23812 used in the program.
23814 @item -mlittle
23815 @itemx -mlittle-endian
23816 @opindex mlittle
23817 @opindex mlittle-endian
23818 On System V.4 and embedded PowerPC systems compile code for the
23819 processor in little-endian mode.  The @option{-mlittle-endian} option is
23820 the same as @option{-mlittle}.
23822 @item -mbig
23823 @itemx -mbig-endian
23824 @opindex mbig
23825 @opindex mbig-endian
23826 On System V.4 and embedded PowerPC systems compile code for the
23827 processor in big-endian mode.  The @option{-mbig-endian} option is
23828 the same as @option{-mbig}.
23830 @item -mdynamic-no-pic
23831 @opindex mdynamic-no-pic
23832 On Darwin and Mac OS X systems, compile code so that it is not
23833 relocatable, but that its external references are relocatable.  The
23834 resulting code is suitable for applications, but not shared
23835 libraries.
23837 @item -msingle-pic-base
23838 @opindex msingle-pic-base
23839 Treat the register used for PIC addressing as read-only, rather than
23840 loading it in the prologue for each function.  The runtime system is
23841 responsible for initializing this register with an appropriate value
23842 before execution begins.
23844 @item -mprioritize-restricted-insns=@var{priority}
23845 @opindex mprioritize-restricted-insns
23846 This option controls the priority that is assigned to
23847 dispatch-slot restricted instructions during the second scheduling
23848 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23849 or @samp{2} to assign no, highest, or second-highest (respectively) 
23850 priority to dispatch-slot restricted
23851 instructions.
23853 @item -msched-costly-dep=@var{dependence_type}
23854 @opindex msched-costly-dep
23855 This option controls which dependences are considered costly
23856 by the target during instruction scheduling.  The argument
23857 @var{dependence_type} takes one of the following values:
23859 @table @asis
23860 @item @samp{no}
23861 No dependence is costly.
23863 @item @samp{all}
23864 All dependences are costly.
23866 @item @samp{true_store_to_load}
23867 A true dependence from store to load is costly.
23869 @item @samp{store_to_load}
23870 Any dependence from store to load is costly.
23872 @item @var{number}
23873 Any dependence for which the latency is greater than or equal to 
23874 @var{number} is costly.
23875 @end table
23877 @item -minsert-sched-nops=@var{scheme}
23878 @opindex minsert-sched-nops
23879 This option controls which NOP insertion scheme is used during
23880 the second scheduling pass.  The argument @var{scheme} takes one of the
23881 following values:
23883 @table @asis
23884 @item @samp{no}
23885 Don't insert NOPs.
23887 @item @samp{pad}
23888 Pad with NOPs any dispatch group that has vacant issue slots,
23889 according to the scheduler's grouping.
23891 @item @samp{regroup_exact}
23892 Insert NOPs to force costly dependent insns into
23893 separate groups.  Insert exactly as many NOPs as needed to force an insn
23894 to a new group, according to the estimated processor grouping.
23896 @item @var{number}
23897 Insert NOPs to force costly dependent insns into
23898 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23899 @end table
23901 @item -mcall-sysv
23902 @opindex mcall-sysv
23903 On System V.4 and embedded PowerPC systems compile code using calling
23904 conventions that adhere to the March 1995 draft of the System V
23905 Application Binary Interface, PowerPC processor supplement.  This is the
23906 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23908 @item -mcall-sysv-eabi
23909 @itemx -mcall-eabi
23910 @opindex mcall-sysv-eabi
23911 @opindex mcall-eabi
23912 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23914 @item -mcall-sysv-noeabi
23915 @opindex mcall-sysv-noeabi
23916 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23918 @item -mcall-aixdesc
23919 @opindex m
23920 On System V.4 and embedded PowerPC systems compile code for the AIX
23921 operating system.
23923 @item -mcall-linux
23924 @opindex mcall-linux
23925 On System V.4 and embedded PowerPC systems compile code for the
23926 Linux-based GNU system.
23928 @item -mcall-freebsd
23929 @opindex mcall-freebsd
23930 On System V.4 and embedded PowerPC systems compile code for the
23931 FreeBSD operating system.
23933 @item -mcall-netbsd
23934 @opindex mcall-netbsd
23935 On System V.4 and embedded PowerPC systems compile code for the
23936 NetBSD operating system.
23938 @item -mcall-openbsd
23939 @opindex mcall-netbsd
23940 On System V.4 and embedded PowerPC systems compile code for the
23941 OpenBSD operating system.
23943 @item -maix-struct-return
23944 @opindex maix-struct-return
23945 Return all structures in memory (as specified by the AIX ABI)@.
23947 @item -msvr4-struct-return
23948 @opindex msvr4-struct-return
23949 Return structures smaller than 8 bytes in registers (as specified by the
23950 SVR4 ABI)@.
23952 @item -mabi=@var{abi-type}
23953 @opindex mabi
23954 Extend the current ABI with a particular extension, or remove such extension.
23955 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23956 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23957 @samp{elfv1}, @samp{elfv2}@.
23959 @item -mabi=spe
23960 @opindex mabi=spe
23961 Extend the current ABI with SPE ABI extensions.  This does not change
23962 the default ABI, instead it adds the SPE ABI extensions to the current
23963 ABI@.
23965 @item -mabi=no-spe
23966 @opindex mabi=no-spe
23967 Disable Book-E SPE ABI extensions for the current ABI@.
23969 @item -mabi=ibmlongdouble
23970 @opindex mabi=ibmlongdouble
23971 Change the current ABI to use IBM extended-precision long double.
23972 This is not likely to work if your system defaults to using IEEE
23973 extended-precision long double.  If you change the long double type
23974 from IEEE extended-precision, the compiler will issue a warning unless
23975 you use the @option{-Wno-psabi} option.
23977 @item -mabi=ieeelongdouble
23978 @opindex mabi=ieeelongdouble
23979 Change the current ABI to use IEEE extended-precision long double.
23980 This is not likely to work if your system defaults to using IBM
23981 extended-precision long double.  If you change the long double type
23982 from IBM extended-precision, the compiler will issue a warning unless
23983 you use the @option{-Wno-psabi} option.
23985 @item -mabi=elfv1
23986 @opindex mabi=elfv1
23987 Change the current ABI to use the ELFv1 ABI.
23988 This is the default ABI for big-endian PowerPC 64-bit Linux.
23989 Overriding the default ABI requires special system support and is
23990 likely to fail in spectacular ways.
23992 @item -mabi=elfv2
23993 @opindex mabi=elfv2
23994 Change the current ABI to use the ELFv2 ABI.
23995 This is the default ABI for little-endian PowerPC 64-bit Linux.
23996 Overriding the default ABI requires special system support and is
23997 likely to fail in spectacular ways.
23999 @item -mgnu-attribute
24000 @itemx -mno-gnu-attribute
24001 @opindex mgnu-attribute
24002 @opindex mno-gnu-attribute
24003 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24004 .gnu.attributes section that specify ABI variations in function
24005 parameters or return values.
24007 @item -mprototype
24008 @itemx -mno-prototype
24009 @opindex mprototype
24010 @opindex mno-prototype
24011 On System V.4 and embedded PowerPC systems assume that all calls to
24012 variable argument functions are properly prototyped.  Otherwise, the
24013 compiler must insert an instruction before every non-prototyped call to
24014 set or clear bit 6 of the condition code register (@code{CR}) to
24015 indicate whether floating-point values are passed in the floating-point
24016 registers in case the function takes variable arguments.  With
24017 @option{-mprototype}, only calls to prototyped variable argument functions
24018 set or clear the bit.
24020 @item -msim
24021 @opindex msim
24022 On embedded PowerPC systems, assume that the startup module is called
24023 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24024 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24025 configurations.
24027 @item -mmvme
24028 @opindex mmvme
24029 On embedded PowerPC systems, assume that the startup module is called
24030 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24031 @file{libc.a}.
24033 @item -mads
24034 @opindex mads
24035 On embedded PowerPC systems, assume that the startup module is called
24036 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24037 @file{libc.a}.
24039 @item -myellowknife
24040 @opindex myellowknife
24041 On embedded PowerPC systems, assume that the startup module is called
24042 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24043 @file{libc.a}.
24045 @item -mvxworks
24046 @opindex mvxworks
24047 On System V.4 and embedded PowerPC systems, specify that you are
24048 compiling for a VxWorks system.
24050 @item -memb
24051 @opindex memb
24052 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24053 header to indicate that @samp{eabi} extended relocations are used.
24055 @item -meabi
24056 @itemx -mno-eabi
24057 @opindex meabi
24058 @opindex mno-eabi
24059 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24060 Embedded Applications Binary Interface (EABI), which is a set of
24061 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24062 means that the stack is aligned to an 8-byte boundary, a function
24063 @code{__eabi} is called from @code{main} to set up the EABI
24064 environment, and the @option{-msdata} option can use both @code{r2} and
24065 @code{r13} to point to two separate small data areas.  Selecting
24066 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24067 no EABI initialization function is called from @code{main}, and the
24068 @option{-msdata} option only uses @code{r13} to point to a single
24069 small data area.  The @option{-meabi} option is on by default if you
24070 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24072 @item -msdata=eabi
24073 @opindex msdata=eabi
24074 On System V.4 and embedded PowerPC systems, put small initialized
24075 @code{const} global and static data in the @code{.sdata2} section, which
24076 is pointed to by register @code{r2}.  Put small initialized
24077 non-@code{const} global and static data in the @code{.sdata} section,
24078 which is pointed to by register @code{r13}.  Put small uninitialized
24079 global and static data in the @code{.sbss} section, which is adjacent to
24080 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24081 incompatible with the @option{-mrelocatable} option.  The
24082 @option{-msdata=eabi} option also sets the @option{-memb} option.
24084 @item -msdata=sysv
24085 @opindex msdata=sysv
24086 On System V.4 and embedded PowerPC systems, put small global and static
24087 data in the @code{.sdata} section, which is pointed to by register
24088 @code{r13}.  Put small uninitialized global and static data in the
24089 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24090 The @option{-msdata=sysv} option is incompatible with the
24091 @option{-mrelocatable} option.
24093 @item -msdata=default
24094 @itemx -msdata
24095 @opindex msdata=default
24096 @opindex msdata
24097 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24098 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24099 same as @option{-msdata=sysv}.
24101 @item -msdata=data
24102 @opindex msdata=data
24103 On System V.4 and embedded PowerPC systems, put small global
24104 data in the @code{.sdata} section.  Put small uninitialized global
24105 data in the @code{.sbss} section.  Do not use register @code{r13}
24106 to address small data however.  This is the default behavior unless
24107 other @option{-msdata} options are used.
24109 @item -msdata=none
24110 @itemx -mno-sdata
24111 @opindex msdata=none
24112 @opindex mno-sdata
24113 On embedded PowerPC systems, put all initialized global and static data
24114 in the @code{.data} section, and all uninitialized data in the
24115 @code{.bss} section.
24117 @item -mreadonly-in-sdata
24118 @itemx -mreadonly-in-sdata
24119 @opindex mreadonly-in-sdata
24120 @opindex mno-readonly-in-sdata
24121 Put read-only objects in the @code{.sdata} section as well.  This is the
24122 default.
24124 @item -mblock-move-inline-limit=@var{num}
24125 @opindex mblock-move-inline-limit
24126 Inline all block moves (such as calls to @code{memcpy} or structure
24127 copies) less than or equal to @var{num} bytes.  The minimum value for
24128 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24129 targets.  The default value is target-specific.
24131 @item -G @var{num}
24132 @opindex G
24133 @cindex smaller data references (PowerPC)
24134 @cindex .sdata/.sdata2 references (PowerPC)
24135 On embedded PowerPC systems, put global and static items less than or
24136 equal to @var{num} bytes into the small data or BSS sections instead of
24137 the normal data or BSS section.  By default, @var{num} is 8.  The
24138 @option{-G @var{num}} switch is also passed to the linker.
24139 All modules should be compiled with the same @option{-G @var{num}} value.
24141 @item -mregnames
24142 @itemx -mno-regnames
24143 @opindex mregnames
24144 @opindex mno-regnames
24145 On System V.4 and embedded PowerPC systems do (do not) emit register
24146 names in the assembly language output using symbolic forms.
24148 @item -mlongcall
24149 @itemx -mno-longcall
24150 @opindex mlongcall
24151 @opindex mno-longcall
24152 By default assume that all calls are far away so that a longer and more
24153 expensive calling sequence is required.  This is required for calls
24154 farther than 32 megabytes (33,554,432 bytes) from the current location.
24155 A short call is generated if the compiler knows
24156 the call cannot be that far away.  This setting can be overridden by
24157 the @code{shortcall} function attribute, or by @code{#pragma
24158 longcall(0)}.
24160 Some linkers are capable of detecting out-of-range calls and generating
24161 glue code on the fly.  On these systems, long calls are unnecessary and
24162 generate slower code.  As of this writing, the AIX linker can do this,
24163 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24164 to the GNU linker for 32-bit PowerPC systems as well.
24166 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24167 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24168 addresses represent the callee and the branch island.  The
24169 Darwin/PPC linker prefers the first address and generates a @code{bl
24170 callee} if the PPC @code{bl} instruction reaches the callee directly;
24171 otherwise, the linker generates @code{bl L42} to call the branch
24172 island.  The branch island is appended to the body of the
24173 calling function; it computes the full 32-bit address of the callee
24174 and jumps to it.
24176 On Mach-O (Darwin) systems, this option directs the compiler emit to
24177 the glue for every direct call, and the Darwin linker decides whether
24178 to use or discard it.
24180 In the future, GCC may ignore all longcall specifications
24181 when the linker is known to generate glue.
24183 @item -mtls-markers
24184 @itemx -mno-tls-markers
24185 @opindex mtls-markers
24186 @opindex mno-tls-markers
24187 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24188 specifying the function argument.  The relocation allows the linker to
24189 reliably associate function call with argument setup instructions for
24190 TLS optimization, which in turn allows GCC to better schedule the
24191 sequence.
24193 @item -mrecip
24194 @itemx -mno-recip
24195 @opindex mrecip
24196 This option enables use of the reciprocal estimate and
24197 reciprocal square root estimate instructions with additional
24198 Newton-Raphson steps to increase precision instead of doing a divide or
24199 square root and divide for floating-point arguments.  You should use
24200 the @option{-ffast-math} option when using @option{-mrecip} (or at
24201 least @option{-funsafe-math-optimizations},
24202 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24203 @option{-fno-trapping-math}).  Note that while the throughput of the
24204 sequence is generally higher than the throughput of the non-reciprocal
24205 instruction, the precision of the sequence can be decreased by up to 2
24206 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24207 roots.
24209 @item -mrecip=@var{opt}
24210 @opindex mrecip=opt
24211 This option controls which reciprocal estimate instructions
24212 may be used.  @var{opt} is a comma-separated list of options, which may
24213 be preceded by a @code{!} to invert the option:
24215 @table @samp
24217 @item all
24218 Enable all estimate instructions.
24220 @item default 
24221 Enable the default instructions, equivalent to @option{-mrecip}.
24223 @item none 
24224 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24226 @item div 
24227 Enable the reciprocal approximation instructions for both 
24228 single and double precision.
24230 @item divf 
24231 Enable the single-precision reciprocal approximation instructions.
24233 @item divd 
24234 Enable the double-precision reciprocal approximation instructions.
24236 @item rsqrt 
24237 Enable the reciprocal square root approximation instructions for both
24238 single and double precision.
24240 @item rsqrtf 
24241 Enable the single-precision reciprocal square root approximation instructions.
24243 @item rsqrtd 
24244 Enable the double-precision reciprocal square root approximation instructions.
24246 @end table
24248 So, for example, @option{-mrecip=all,!rsqrtd} enables
24249 all of the reciprocal estimate instructions, except for the
24250 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24251 which handle the double-precision reciprocal square root calculations.
24253 @item -mrecip-precision
24254 @itemx -mno-recip-precision
24255 @opindex mrecip-precision
24256 Assume (do not assume) that the reciprocal estimate instructions
24257 provide higher-precision estimates than is mandated by the PowerPC
24258 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24259 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24260 The double-precision square root estimate instructions are not generated by
24261 default on low-precision machines, since they do not provide an
24262 estimate that converges after three steps.
24264 @item -mveclibabi=@var{type}
24265 @opindex mveclibabi
24266 Specifies the ABI type to use for vectorizing intrinsics using an
24267 external library.  The only type supported at present is @samp{mass},
24268 which specifies to use IBM's Mathematical Acceleration Subsystem
24269 (MASS) libraries for vectorizing intrinsics using external libraries.
24270 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24271 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24272 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24273 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24274 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24275 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24276 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24277 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24278 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24279 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24280 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24281 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24282 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24283 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24284 for power7.  Both @option{-ftree-vectorize} and
24285 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24286 libraries must be specified at link time.
24288 @item -mfriz
24289 @itemx -mno-friz
24290 @opindex mfriz
24291 Generate (do not generate) the @code{friz} instruction when the
24292 @option{-funsafe-math-optimizations} option is used to optimize
24293 rounding of floating-point values to 64-bit integer and back to floating
24294 point.  The @code{friz} instruction does not return the same value if
24295 the floating-point number is too large to fit in an integer.
24297 @item -mpointers-to-nested-functions
24298 @itemx -mno-pointers-to-nested-functions
24299 @opindex mpointers-to-nested-functions
24300 Generate (do not generate) code to load up the static chain register
24301 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24302 systems where a function pointer points to a 3-word descriptor giving
24303 the function address, TOC value to be loaded in register @code{r2}, and
24304 static chain value to be loaded in register @code{r11}.  The
24305 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24306 call through pointers to nested functions or pointers
24307 to functions compiled in other languages that use the static chain if
24308 you use @option{-mno-pointers-to-nested-functions}.
24310 @item -msave-toc-indirect
24311 @itemx -mno-save-toc-indirect
24312 @opindex msave-toc-indirect
24313 Generate (do not generate) code to save the TOC value in the reserved
24314 stack location in the function prologue if the function calls through
24315 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24316 saved in the prologue, it is saved just before the call through the
24317 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24319 @item -mcompat-align-parm
24320 @itemx -mno-compat-align-parm
24321 @opindex mcompat-align-parm
24322 Generate (do not generate) code to pass structure parameters with a
24323 maximum alignment of 64 bits, for compatibility with older versions
24324 of GCC.
24326 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24327 structure parameter on a 128-bit boundary when that structure contained
24328 a member requiring 128-bit alignment.  This is corrected in more
24329 recent versions of GCC.  This option may be used to generate code
24330 that is compatible with functions compiled with older versions of
24331 GCC.
24333 The @option{-mno-compat-align-parm} option is the default.
24335 @item -mstack-protector-guard=@var{guard}
24336 @itemx -mstack-protector-guard-reg=@var{reg}
24337 @itemx -mstack-protector-guard-offset=@var{offset}
24338 @itemx -mstack-protector-guard-symbol=@var{symbol}
24339 @opindex mstack-protector-guard
24340 @opindex mstack-protector-guard-reg
24341 @opindex mstack-protector-guard-offset
24342 @opindex mstack-protector-guard-symbol
24343 Generate stack protection code using canary at @var{guard}.  Supported
24344 locations are @samp{global} for global canary or @samp{tls} for per-thread
24345 canary in the TLS block (the default with GNU libc version 2.4 or later).
24347 With the latter choice the options
24348 @option{-mstack-protector-guard-reg=@var{reg}} and
24349 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24350 which register to use as base register for reading the canary, and from what
24351 offset from that base register. The default for those is as specified in the
24352 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24353 the offset with a symbol reference to a canary in the TLS block.
24354 @end table
24356 @node RX Options
24357 @subsection RX Options
24358 @cindex RX Options
24360 These command-line options are defined for RX targets:
24362 @table @gcctabopt
24363 @item -m64bit-doubles
24364 @itemx -m32bit-doubles
24365 @opindex m64bit-doubles
24366 @opindex m32bit-doubles
24367 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24368 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24369 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24370 works on 32-bit values, which is why the default is
24371 @option{-m32bit-doubles}.
24373 @item -fpu
24374 @itemx -nofpu
24375 @opindex fpu
24376 @opindex nofpu
24377 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24378 floating-point hardware.  The default is enabled for the RX600
24379 series and disabled for the RX200 series.
24381 Floating-point instructions are only generated for 32-bit floating-point 
24382 values, however, so the FPU hardware is not used for doubles if the
24383 @option{-m64bit-doubles} option is used.
24385 @emph{Note} If the @option{-fpu} option is enabled then
24386 @option{-funsafe-math-optimizations} is also enabled automatically.
24387 This is because the RX FPU instructions are themselves unsafe.
24389 @item -mcpu=@var{name}
24390 @opindex mcpu
24391 Selects the type of RX CPU to be targeted.  Currently three types are
24392 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24393 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24395 The only difference between @samp{RX600} and @samp{RX610} is that the
24396 @samp{RX610} does not support the @code{MVTIPL} instruction.
24398 The @samp{RX200} series does not have a hardware floating-point unit
24399 and so @option{-nofpu} is enabled by default when this type is
24400 selected.
24402 @item -mbig-endian-data
24403 @itemx -mlittle-endian-data
24404 @opindex mbig-endian-data
24405 @opindex mlittle-endian-data
24406 Store data (but not code) in the big-endian format.  The default is
24407 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24408 format.
24410 @item -msmall-data-limit=@var{N}
24411 @opindex msmall-data-limit
24412 Specifies the maximum size in bytes of global and static variables
24413 which can be placed into the small data area.  Using the small data
24414 area can lead to smaller and faster code, but the size of area is
24415 limited and it is up to the programmer to ensure that the area does
24416 not overflow.  Also when the small data area is used one of the RX's
24417 registers (usually @code{r13}) is reserved for use pointing to this
24418 area, so it is no longer available for use by the compiler.  This
24419 could result in slower and/or larger code if variables are pushed onto
24420 the stack instead of being held in this register.
24422 Note, common variables (variables that have not been initialized) and
24423 constants are not placed into the small data area as they are assigned
24424 to other sections in the output executable.
24426 The default value is zero, which disables this feature.  Note, this
24427 feature is not enabled by default with higher optimization levels
24428 (@option{-O2} etc) because of the potentially detrimental effects of
24429 reserving a register.  It is up to the programmer to experiment and
24430 discover whether this feature is of benefit to their program.  See the
24431 description of the @option{-mpid} option for a description of how the
24432 actual register to hold the small data area pointer is chosen.
24434 @item -msim
24435 @itemx -mno-sim
24436 @opindex msim
24437 @opindex mno-sim
24438 Use the simulator runtime.  The default is to use the libgloss
24439 board-specific runtime.
24441 @item -mas100-syntax
24442 @itemx -mno-as100-syntax
24443 @opindex mas100-syntax
24444 @opindex mno-as100-syntax
24445 When generating assembler output use a syntax that is compatible with
24446 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24447 assembler, but it has some restrictions so it is not generated by default.
24449 @item -mmax-constant-size=@var{N}
24450 @opindex mmax-constant-size
24451 Specifies the maximum size, in bytes, of a constant that can be used as
24452 an operand in a RX instruction.  Although the RX instruction set does
24453 allow constants of up to 4 bytes in length to be used in instructions,
24454 a longer value equates to a longer instruction.  Thus in some
24455 circumstances it can be beneficial to restrict the size of constants
24456 that are used in instructions.  Constants that are too big are instead
24457 placed into a constant pool and referenced via register indirection.
24459 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24460 or 4 means that constants of any size are allowed.
24462 @item -mrelax
24463 @opindex mrelax
24464 Enable linker relaxation.  Linker relaxation is a process whereby the
24465 linker attempts to reduce the size of a program by finding shorter
24466 versions of various instructions.  Disabled by default.
24468 @item -mint-register=@var{N}
24469 @opindex mint-register
24470 Specify the number of registers to reserve for fast interrupt handler
24471 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24472 means that register @code{r13} is reserved for the exclusive use
24473 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24474 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24475 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24476 A value of 0, the default, does not reserve any registers.
24478 @item -msave-acc-in-interrupts
24479 @opindex msave-acc-in-interrupts
24480 Specifies that interrupt handler functions should preserve the
24481 accumulator register.  This is only necessary if normal code might use
24482 the accumulator register, for example because it performs 64-bit
24483 multiplications.  The default is to ignore the accumulator as this
24484 makes the interrupt handlers faster.
24486 @item -mpid
24487 @itemx -mno-pid
24488 @opindex mpid
24489 @opindex mno-pid
24490 Enables the generation of position independent data.  When enabled any
24491 access to constant data is done via an offset from a base address
24492 held in a register.  This allows the location of constant data to be
24493 determined at run time without requiring the executable to be
24494 relocated, which is a benefit to embedded applications with tight
24495 memory constraints.  Data that can be modified is not affected by this
24496 option.
24498 Note, using this feature reserves a register, usually @code{r13}, for
24499 the constant data base address.  This can result in slower and/or
24500 larger code, especially in complicated functions.
24502 The actual register chosen to hold the constant data base address
24503 depends upon whether the @option{-msmall-data-limit} and/or the
24504 @option{-mint-register} command-line options are enabled.  Starting
24505 with register @code{r13} and proceeding downwards, registers are
24506 allocated first to satisfy the requirements of @option{-mint-register},
24507 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24508 is possible for the small data area register to be @code{r8} if both
24509 @option{-mint-register=4} and @option{-mpid} are specified on the
24510 command line.
24512 By default this feature is not enabled.  The default can be restored
24513 via the @option{-mno-pid} command-line option.
24515 @item -mno-warn-multiple-fast-interrupts
24516 @itemx -mwarn-multiple-fast-interrupts
24517 @opindex mno-warn-multiple-fast-interrupts
24518 @opindex mwarn-multiple-fast-interrupts
24519 Prevents GCC from issuing a warning message if it finds more than one
24520 fast interrupt handler when it is compiling a file.  The default is to
24521 issue a warning for each extra fast interrupt handler found, as the RX
24522 only supports one such interrupt.
24524 @item -mallow-string-insns
24525 @itemx -mno-allow-string-insns
24526 @opindex mallow-string-insns
24527 @opindex mno-allow-string-insns
24528 Enables or disables the use of the string manipulation instructions
24529 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24530 @code{SWHILE} and also the @code{RMPA} instruction.  These
24531 instructions may prefetch data, which is not safe to do if accessing
24532 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24533 for more information).
24535 The default is to allow these instructions, but it is not possible for
24536 GCC to reliably detect all circumstances where a string instruction
24537 might be used to access an I/O register, so their use cannot be
24538 disabled automatically.  Instead it is reliant upon the programmer to
24539 use the @option{-mno-allow-string-insns} option if their program
24540 accesses I/O space.
24542 When the instructions are enabled GCC defines the C preprocessor
24543 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24544 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24546 @item -mjsr
24547 @itemx -mno-jsr
24548 @opindex mjsr
24549 @opindex mno-jsr
24550 Use only (or not only) @code{JSR} instructions to access functions.
24551 This option can be used when code size exceeds the range of @code{BSR}
24552 instructions.  Note that @option{-mno-jsr} does not mean to not use
24553 @code{JSR} but instead means that any type of branch may be used.
24554 @end table
24556 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24557 has special significance to the RX port when used with the
24558 @code{interrupt} function attribute.  This attribute indicates a
24559 function intended to process fast interrupts.  GCC ensures
24560 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24561 and/or @code{r13} and only provided that the normal use of the
24562 corresponding registers have been restricted via the
24563 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24564 options.
24566 @node S/390 and zSeries Options
24567 @subsection S/390 and zSeries Options
24568 @cindex S/390 and zSeries Options
24570 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24572 @table @gcctabopt
24573 @item -mhard-float
24574 @itemx -msoft-float
24575 @opindex mhard-float
24576 @opindex msoft-float
24577 Use (do not use) the hardware floating-point instructions and registers
24578 for floating-point operations.  When @option{-msoft-float} is specified,
24579 functions in @file{libgcc.a} are used to perform floating-point
24580 operations.  When @option{-mhard-float} is specified, the compiler
24581 generates IEEE floating-point instructions.  This is the default.
24583 @item -mhard-dfp
24584 @itemx -mno-hard-dfp
24585 @opindex mhard-dfp
24586 @opindex mno-hard-dfp
24587 Use (do not use) the hardware decimal-floating-point instructions for
24588 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24589 specified, functions in @file{libgcc.a} are used to perform
24590 decimal-floating-point operations.  When @option{-mhard-dfp} is
24591 specified, the compiler generates decimal-floating-point hardware
24592 instructions.  This is the default for @option{-march=z9-ec} or higher.
24594 @item -mlong-double-64
24595 @itemx -mlong-double-128
24596 @opindex mlong-double-64
24597 @opindex mlong-double-128
24598 These switches control the size of @code{long double} type. A size
24599 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24600 type. This is the default.
24602 @item -mbackchain
24603 @itemx -mno-backchain
24604 @opindex mbackchain
24605 @opindex mno-backchain
24606 Store (do not store) the address of the caller's frame as backchain pointer
24607 into the callee's stack frame.
24608 A backchain may be needed to allow debugging using tools that do not understand
24609 DWARF call frame information.
24610 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24611 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24612 the backchain is placed into the topmost word of the 96/160 byte register
24613 save area.
24615 In general, code compiled with @option{-mbackchain} is call-compatible with
24616 code compiled with @option{-mmo-backchain}; however, use of the backchain
24617 for debugging purposes usually requires that the whole binary is built with
24618 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24619 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24620 to build a linux kernel use @option{-msoft-float}.
24622 The default is to not maintain the backchain.
24624 @item -mpacked-stack
24625 @itemx -mno-packed-stack
24626 @opindex mpacked-stack
24627 @opindex mno-packed-stack
24628 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24629 specified, the compiler uses the all fields of the 96/160 byte register save
24630 area only for their default purpose; unused fields still take up stack space.
24631 When @option{-mpacked-stack} is specified, register save slots are densely
24632 packed at the top of the register save area; unused space is reused for other
24633 purposes, allowing for more efficient use of the available stack space.
24634 However, when @option{-mbackchain} is also in effect, the topmost word of
24635 the save area is always used to store the backchain, and the return address
24636 register is always saved two words below the backchain.
24638 As long as the stack frame backchain is not used, code generated with
24639 @option{-mpacked-stack} is call-compatible with code generated with
24640 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24641 S/390 or zSeries generated code that uses the stack frame backchain at run
24642 time, not just for debugging purposes.  Such code is not call-compatible
24643 with code compiled with @option{-mpacked-stack}.  Also, note that the
24644 combination of @option{-mbackchain},
24645 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24646 to build a linux kernel use @option{-msoft-float}.
24648 The default is to not use the packed stack layout.
24650 @item -msmall-exec
24651 @itemx -mno-small-exec
24652 @opindex msmall-exec
24653 @opindex mno-small-exec
24654 Generate (or do not generate) code using the @code{bras} instruction
24655 to do subroutine calls.
24656 This only works reliably if the total executable size does not
24657 exceed 64k.  The default is to use the @code{basr} instruction instead,
24658 which does not have this limitation.
24660 @item -m64
24661 @itemx -m31
24662 @opindex m64
24663 @opindex m31
24664 When @option{-m31} is specified, generate code compliant to the
24665 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24666 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24667 particular to generate 64-bit instructions.  For the @samp{s390}
24668 targets, the default is @option{-m31}, while the @samp{s390x}
24669 targets default to @option{-m64}.
24671 @item -mzarch
24672 @itemx -mesa
24673 @opindex mzarch
24674 @opindex mesa
24675 When @option{-mzarch} is specified, generate code using the
24676 instructions available on z/Architecture.
24677 When @option{-mesa} is specified, generate code using the
24678 instructions available on ESA/390.  Note that @option{-mesa} is
24679 not possible with @option{-m64}.
24680 When generating code compliant to the GNU/Linux for S/390 ABI,
24681 the default is @option{-mesa}.  When generating code compliant
24682 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24684 @item -mhtm
24685 @itemx -mno-htm
24686 @opindex mhtm
24687 @opindex mno-htm
24688 The @option{-mhtm} option enables a set of builtins making use of
24689 instructions available with the transactional execution facility
24690 introduced with the IBM zEnterprise EC12 machine generation
24691 @ref{S/390 System z Built-in Functions}.
24692 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24694 @item -mvx
24695 @itemx -mno-vx
24696 @opindex mvx
24697 @opindex mno-vx
24698 When @option{-mvx} is specified, generate code using the instructions
24699 available with the vector extension facility introduced with the IBM
24700 z13 machine generation.
24701 This option changes the ABI for some vector type values with regard to
24702 alignment and calling conventions.  In case vector type values are
24703 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24704 command will be added to mark the resulting binary with the ABI used.
24705 @option{-mvx} is enabled by default when using @option{-march=z13}.
24707 @item -mzvector
24708 @itemx -mno-zvector
24709 @opindex mzvector
24710 @opindex mno-zvector
24711 The @option{-mzvector} option enables vector language extensions and
24712 builtins using instructions available with the vector extension
24713 facility introduced with the IBM z13 machine generation.
24714 This option adds support for @samp{vector} to be used as a keyword to
24715 define vector type variables and arguments.  @samp{vector} is only
24716 available when GNU extensions are enabled.  It will not be expanded
24717 when requesting strict standard compliance e.g. with @option{-std=c99}.
24718 In addition to the GCC low-level builtins @option{-mzvector} enables
24719 a set of builtins added for compatibility with AltiVec-style
24720 implementations like Power and Cell.  In order to make use of these
24721 builtins the header file @file{vecintrin.h} needs to be included.
24722 @option{-mzvector} is disabled by default.
24724 @item -mmvcle
24725 @itemx -mno-mvcle
24726 @opindex mmvcle
24727 @opindex mno-mvcle
24728 Generate (or do not generate) code using the @code{mvcle} instruction
24729 to perform block moves.  When @option{-mno-mvcle} is specified,
24730 use a @code{mvc} loop instead.  This is the default unless optimizing for
24731 size.
24733 @item -mdebug
24734 @itemx -mno-debug
24735 @opindex mdebug
24736 @opindex mno-debug
24737 Print (or do not print) additional debug information when compiling.
24738 The default is to not print debug information.
24740 @item -march=@var{cpu-type}
24741 @opindex march
24742 Generate code that runs on @var{cpu-type}, which is the name of a
24743 system representing a certain processor type.  Possible values for
24744 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24745 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24746 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24747 @samp{native}.
24749 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24750 @samp{g6} are deprecated and will be removed with future releases.
24752 Specifying @samp{native} as cpu type can be used to select the best
24753 architecture option for the host processor.
24754 @option{-march=native} has no effect if GCC does not recognize the
24755 processor.
24757 @item -mtune=@var{cpu-type}
24758 @opindex mtune
24759 Tune to @var{cpu-type} everything applicable about the generated code,
24760 except for the ABI and the set of available instructions.
24761 The list of @var{cpu-type} values is the same as for @option{-march}.
24762 The default is the value used for @option{-march}.
24764 @item -mtpf-trace
24765 @itemx -mno-tpf-trace
24766 @opindex mtpf-trace
24767 @opindex mno-tpf-trace
24768 Generate code that adds (does not add) in TPF OS specific branches to trace
24769 routines in the operating system.  This option is off by default, even
24770 when compiling for the TPF OS@.
24772 @item -mfused-madd
24773 @itemx -mno-fused-madd
24774 @opindex mfused-madd
24775 @opindex mno-fused-madd
24776 Generate code that uses (does not use) the floating-point multiply and
24777 accumulate instructions.  These instructions are generated by default if
24778 hardware floating point is used.
24780 @item -mwarn-framesize=@var{framesize}
24781 @opindex mwarn-framesize
24782 Emit a warning if the current function exceeds the given frame size.  Because
24783 this is a compile-time check it doesn't need to be a real problem when the program
24784 runs.  It is intended to identify functions that most probably cause
24785 a stack overflow.  It is useful to be used in an environment with limited stack
24786 size e.g.@: the linux kernel.
24788 @item -mwarn-dynamicstack
24789 @opindex mwarn-dynamicstack
24790 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24791 arrays.  This is generally a bad idea with a limited stack size.
24793 @item -mstack-guard=@var{stack-guard}
24794 @itemx -mstack-size=@var{stack-size}
24795 @opindex mstack-guard
24796 @opindex mstack-size
24797 If these options are provided the S/390 back end emits additional instructions in
24798 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24799 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24800 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24801 the frame size of the compiled function is chosen.
24802 These options are intended to be used to help debugging stack overflow problems.
24803 The additionally emitted code causes only little overhead and hence can also be
24804 used in production-like systems without greater performance degradation.  The given
24805 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24806 @var{stack-guard} without exceeding 64k.
24807 In order to be efficient the extra code makes the assumption that the stack starts
24808 at an address aligned to the value given by @var{stack-size}.
24809 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24811 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24812 @opindex mhotpatch
24813 If the hotpatch option is enabled, a ``hot-patching'' function
24814 prologue is generated for all functions in the compilation unit.
24815 The funtion label is prepended with the given number of two-byte
24816 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24817 the label, 2 * @var{post-halfwords} bytes are appended, using the
24818 largest NOP like instructions the architecture allows (maximum
24819 1000000).
24821 If both arguments are zero, hotpatching is disabled.
24823 This option can be overridden for individual functions with the
24824 @code{hotpatch} attribute.
24825 @end table
24827 @node Score Options
24828 @subsection Score Options
24829 @cindex Score Options
24831 These options are defined for Score implementations:
24833 @table @gcctabopt
24834 @item -meb
24835 @opindex meb
24836 Compile code for big-endian mode.  This is the default.
24838 @item -mel
24839 @opindex mel
24840 Compile code for little-endian mode.
24842 @item -mnhwloop
24843 @opindex mnhwloop
24844 Disable generation of @code{bcnz} instructions.
24846 @item -muls
24847 @opindex muls
24848 Enable generation of unaligned load and store instructions.
24850 @item -mmac
24851 @opindex mmac
24852 Enable the use of multiply-accumulate instructions. Disabled by default.
24854 @item -mscore5
24855 @opindex mscore5
24856 Specify the SCORE5 as the target architecture.
24858 @item -mscore5u
24859 @opindex mscore5u
24860 Specify the SCORE5U of the target architecture.
24862 @item -mscore7
24863 @opindex mscore7
24864 Specify the SCORE7 as the target architecture. This is the default.
24866 @item -mscore7d
24867 @opindex mscore7d
24868 Specify the SCORE7D as the target architecture.
24869 @end table
24871 @node SH Options
24872 @subsection SH Options
24874 These @samp{-m} options are defined for the SH implementations:
24876 @table @gcctabopt
24877 @item -m1
24878 @opindex m1
24879 Generate code for the SH1.
24881 @item -m2
24882 @opindex m2
24883 Generate code for the SH2.
24885 @item -m2e
24886 Generate code for the SH2e.
24888 @item -m2a-nofpu
24889 @opindex m2a-nofpu
24890 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24891 that the floating-point unit is not used.
24893 @item -m2a-single-only
24894 @opindex m2a-single-only
24895 Generate code for the SH2a-FPU, in such a way that no double-precision
24896 floating-point operations are used.
24898 @item -m2a-single
24899 @opindex m2a-single
24900 Generate code for the SH2a-FPU assuming the floating-point unit is in
24901 single-precision mode by default.
24903 @item -m2a
24904 @opindex m2a
24905 Generate code for the SH2a-FPU assuming the floating-point unit is in
24906 double-precision mode by default.
24908 @item -m3
24909 @opindex m3
24910 Generate code for the SH3.
24912 @item -m3e
24913 @opindex m3e
24914 Generate code for the SH3e.
24916 @item -m4-nofpu
24917 @opindex m4-nofpu
24918 Generate code for the SH4 without a floating-point unit.
24920 @item -m4-single-only
24921 @opindex m4-single-only
24922 Generate code for the SH4 with a floating-point unit that only
24923 supports single-precision arithmetic.
24925 @item -m4-single
24926 @opindex m4-single
24927 Generate code for the SH4 assuming the floating-point unit is in
24928 single-precision mode by default.
24930 @item -m4
24931 @opindex m4
24932 Generate code for the SH4.
24934 @item -m4-100
24935 @opindex m4-100
24936 Generate code for SH4-100.
24938 @item -m4-100-nofpu
24939 @opindex m4-100-nofpu
24940 Generate code for SH4-100 in such a way that the
24941 floating-point unit is not used.
24943 @item -m4-100-single
24944 @opindex m4-100-single
24945 Generate code for SH4-100 assuming the floating-point unit is in
24946 single-precision mode by default.
24948 @item -m4-100-single-only
24949 @opindex m4-100-single-only
24950 Generate code for SH4-100 in such a way that no double-precision
24951 floating-point operations are used.
24953 @item -m4-200
24954 @opindex m4-200
24955 Generate code for SH4-200.
24957 @item -m4-200-nofpu
24958 @opindex m4-200-nofpu
24959 Generate code for SH4-200 without in such a way that the
24960 floating-point unit is not used.
24962 @item -m4-200-single
24963 @opindex m4-200-single
24964 Generate code for SH4-200 assuming the floating-point unit is in
24965 single-precision mode by default.
24967 @item -m4-200-single-only
24968 @opindex m4-200-single-only
24969 Generate code for SH4-200 in such a way that no double-precision
24970 floating-point operations are used.
24972 @item -m4-300
24973 @opindex m4-300
24974 Generate code for SH4-300.
24976 @item -m4-300-nofpu
24977 @opindex m4-300-nofpu
24978 Generate code for SH4-300 without in such a way that the
24979 floating-point unit is not used.
24981 @item -m4-300-single
24982 @opindex m4-300-single
24983 Generate code for SH4-300 in such a way that no double-precision
24984 floating-point operations are used.
24986 @item -m4-300-single-only
24987 @opindex m4-300-single-only
24988 Generate code for SH4-300 in such a way that no double-precision
24989 floating-point operations are used.
24991 @item -m4-340
24992 @opindex m4-340
24993 Generate code for SH4-340 (no MMU, no FPU).
24995 @item -m4-500
24996 @opindex m4-500
24997 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24998 assembler.
25000 @item -m4a-nofpu
25001 @opindex m4a-nofpu
25002 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25003 floating-point unit is not used.
25005 @item -m4a-single-only
25006 @opindex m4a-single-only
25007 Generate code for the SH4a, in such a way that no double-precision
25008 floating-point operations are used.
25010 @item -m4a-single
25011 @opindex m4a-single
25012 Generate code for the SH4a assuming the floating-point unit is in
25013 single-precision mode by default.
25015 @item -m4a
25016 @opindex m4a
25017 Generate code for the SH4a.
25019 @item -m4al
25020 @opindex m4al
25021 Same as @option{-m4a-nofpu}, except that it implicitly passes
25022 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25023 instructions at the moment.
25025 @item -mb
25026 @opindex mb
25027 Compile code for the processor in big-endian mode.
25029 @item -ml
25030 @opindex ml
25031 Compile code for the processor in little-endian mode.
25033 @item -mdalign
25034 @opindex mdalign
25035 Align doubles at 64-bit boundaries.  Note that this changes the calling
25036 conventions, and thus some functions from the standard C library do
25037 not work unless you recompile it first with @option{-mdalign}.
25039 @item -mrelax
25040 @opindex mrelax
25041 Shorten some address references at link time, when possible; uses the
25042 linker option @option{-relax}.
25044 @item -mbigtable
25045 @opindex mbigtable
25046 Use 32-bit offsets in @code{switch} tables.  The default is to use
25047 16-bit offsets.
25049 @item -mbitops
25050 @opindex mbitops
25051 Enable the use of bit manipulation instructions on SH2A.
25053 @item -mfmovd
25054 @opindex mfmovd
25055 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25056 alignment constraints.
25058 @item -mrenesas
25059 @opindex mrenesas
25060 Comply with the calling conventions defined by Renesas.
25062 @item -mno-renesas
25063 @opindex mno-renesas
25064 Comply with the calling conventions defined for GCC before the Renesas
25065 conventions were available.  This option is the default for all
25066 targets of the SH toolchain.
25068 @item -mnomacsave
25069 @opindex mnomacsave
25070 Mark the @code{MAC} register as call-clobbered, even if
25071 @option{-mrenesas} is given.
25073 @item -mieee
25074 @itemx -mno-ieee
25075 @opindex mieee
25076 @opindex mno-ieee
25077 Control the IEEE compliance of floating-point comparisons, which affects the
25078 handling of cases where the result of a comparison is unordered.  By default
25079 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25080 enabled @option{-mno-ieee} is implicitly set, which results in faster
25081 floating-point greater-equal and less-equal comparisons.  The implicit settings
25082 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25084 @item -minline-ic_invalidate
25085 @opindex minline-ic_invalidate
25086 Inline code to invalidate instruction cache entries after setting up
25087 nested function trampolines.
25088 This option has no effect if @option{-musermode} is in effect and the selected
25089 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25090 instruction.
25091 If the selected code generation option does not allow the use of the @code{icbi}
25092 instruction, and @option{-musermode} is not in effect, the inlined code
25093 manipulates the instruction cache address array directly with an associative
25094 write.  This not only requires privileged mode at run time, but it also
25095 fails if the cache line had been mapped via the TLB and has become unmapped.
25097 @item -misize
25098 @opindex misize
25099 Dump instruction size and location in the assembly code.
25101 @item -mpadstruct
25102 @opindex mpadstruct
25103 This option is deprecated.  It pads structures to multiple of 4 bytes,
25104 which is incompatible with the SH ABI@.
25106 @item -matomic-model=@var{model}
25107 @opindex matomic-model=@var{model}
25108 Sets the model of atomic operations and additional parameters as a comma
25109 separated list.  For details on the atomic built-in functions see
25110 @ref{__atomic Builtins}.  The following models and parameters are supported:
25112 @table @samp
25114 @item none
25115 Disable compiler generated atomic sequences and emit library calls for atomic
25116 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25118 @item soft-gusa
25119 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25120 built-in functions.  The generated atomic sequences require additional support
25121 from the interrupt/exception handling code of the system and are only suitable
25122 for SH3* and SH4* single-core systems.  This option is enabled by default when
25123 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25124 this option also partially utilizes the hardware atomic instructions
25125 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25126 @samp{strict} is specified.  
25128 @item soft-tcb
25129 Generate software atomic sequences that use a variable in the thread control
25130 block.  This is a variation of the gUSA sequences which can also be used on
25131 SH1* and SH2* targets.  The generated atomic sequences require additional
25132 support from the interrupt/exception handling code of the system and are only
25133 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25134 parameter has to be specified as well.
25136 @item soft-imask
25137 Generate software atomic sequences that temporarily disable interrupts by
25138 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25139 in privileged mode and is only suitable for single-core systems.  Additional
25140 support from the interrupt/exception handling code of the system is not
25141 required.  This model is enabled by default when the target is
25142 @code{sh*-*-linux*} and SH1* or SH2*.
25144 @item hard-llcs
25145 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25146 instructions only.  This is only available on SH4A and is suitable for
25147 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25148 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25149 Code compiled with this option is also compatible with other software
25150 atomic model interrupt/exception handling systems if executed on an SH4A
25151 system.  Additional support from the interrupt/exception handling code of the
25152 system is not required for this model.
25154 @item gbr-offset=
25155 This parameter specifies the offset in bytes of the variable in the thread
25156 control block structure that should be used by the generated atomic sequences
25157 when the @samp{soft-tcb} model has been selected.  For other models this
25158 parameter is ignored.  The specified value must be an integer multiple of four
25159 and in the range 0-1020.
25161 @item strict
25162 This parameter prevents mixed usage of multiple atomic models, even if they
25163 are compatible, and makes the compiler generate atomic sequences of the
25164 specified model only.
25166 @end table
25168 @item -mtas
25169 @opindex mtas
25170 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25171 Notice that depending on the particular hardware and software configuration
25172 this can degrade overall performance due to the operand cache line flushes
25173 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25174 processors the @code{tas.b} instruction must be used with caution since it
25175 can result in data corruption for certain cache configurations.
25177 @item -mprefergot
25178 @opindex mprefergot
25179 When generating position-independent code, emit function calls using
25180 the Global Offset Table instead of the Procedure Linkage Table.
25182 @item -musermode
25183 @itemx -mno-usermode
25184 @opindex musermode
25185 @opindex mno-usermode
25186 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25187 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25188 inlined code would not work in user mode.  @option{-musermode} is the default
25189 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25190 @option{-musermode} has no effect, since there is no user mode.
25192 @item -multcost=@var{number}
25193 @opindex multcost=@var{number}
25194 Set the cost to assume for a multiply insn.
25196 @item -mdiv=@var{strategy}
25197 @opindex mdiv=@var{strategy}
25198 Set the division strategy to be used for integer division operations.
25199 @var{strategy} can be one of: 
25201 @table @samp
25203 @item call-div1
25204 Calls a library function that uses the single-step division instruction
25205 @code{div1} to perform the operation.  Division by zero calculates an
25206 unspecified result and does not trap.  This is the default except for SH4,
25207 SH2A and SHcompact.
25209 @item call-fp
25210 Calls a library function that performs the operation in double precision
25211 floating point.  Division by zero causes a floating-point exception.  This is
25212 the default for SHcompact with FPU.  Specifying this for targets that do not
25213 have a double precision FPU defaults to @code{call-div1}.
25215 @item call-table
25216 Calls a library function that uses a lookup table for small divisors and
25217 the @code{div1} instruction with case distinction for larger divisors.  Division
25218 by zero calculates an unspecified result and does not trap.  This is the default
25219 for SH4.  Specifying this for targets that do not have dynamic shift
25220 instructions defaults to @code{call-div1}.
25222 @end table
25224 When a division strategy has not been specified the default strategy is
25225 selected based on the current target.  For SH2A the default strategy is to
25226 use the @code{divs} and @code{divu} instructions instead of library function
25227 calls.
25229 @item -maccumulate-outgoing-args
25230 @opindex maccumulate-outgoing-args
25231 Reserve space once for outgoing arguments in the function prologue rather
25232 than around each call.  Generally beneficial for performance and size.  Also
25233 needed for unwinding to avoid changing the stack frame around conditional code.
25235 @item -mdivsi3_libfunc=@var{name}
25236 @opindex mdivsi3_libfunc=@var{name}
25237 Set the name of the library function used for 32-bit signed division to
25238 @var{name}.
25239 This only affects the name used in the @samp{call} division strategies, and
25240 the compiler still expects the same sets of input/output/clobbered registers as
25241 if this option were not present.
25243 @item -mfixed-range=@var{register-range}
25244 @opindex mfixed-range
25245 Generate code treating the given register range as fixed registers.
25246 A fixed register is one that the register allocator can not use.  This is
25247 useful when compiling kernel code.  A register range is specified as
25248 two registers separated by a dash.  Multiple register ranges can be
25249 specified separated by a comma.
25251 @item -mbranch-cost=@var{num}
25252 @opindex mbranch-cost=@var{num}
25253 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25254 make the compiler try to generate more branch-free code if possible.  
25255 If not specified the value is selected depending on the processor type that
25256 is being compiled for.
25258 @item -mzdcbranch
25259 @itemx -mno-zdcbranch
25260 @opindex mzdcbranch
25261 @opindex mno-zdcbranch
25262 Assume (do not assume) that zero displacement conditional branch instructions
25263 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25264 compiler prefers zero displacement branch code sequences.  This is
25265 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25266 disabled by specifying @option{-mno-zdcbranch}.
25268 @item -mcbranch-force-delay-slot
25269 @opindex mcbranch-force-delay-slot
25270 Force the usage of delay slots for conditional branches, which stuffs the delay
25271 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25272 this option is disabled.  It can be enabled to work around hardware bugs as
25273 found in the original SH7055.
25275 @item -mfused-madd
25276 @itemx -mno-fused-madd
25277 @opindex mfused-madd
25278 @opindex mno-fused-madd
25279 Generate code that uses (does not use) the floating-point multiply and
25280 accumulate instructions.  These instructions are generated by default
25281 if hardware floating point is used.  The machine-dependent
25282 @option{-mfused-madd} option is now mapped to the machine-independent
25283 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25284 mapped to @option{-ffp-contract=off}.
25286 @item -mfsca
25287 @itemx -mno-fsca
25288 @opindex mfsca
25289 @opindex mno-fsca
25290 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25291 and cosine approximations.  The option @option{-mfsca} must be used in
25292 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25293 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25294 approximations even if @option{-funsafe-math-optimizations} is in effect.
25296 @item -mfsrra
25297 @itemx -mno-fsrra
25298 @opindex mfsrra
25299 @opindex mno-fsrra
25300 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25301 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25302 in combination with @option{-funsafe-math-optimizations} and
25303 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25304 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25305 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25306 in effect.
25308 @item -mpretend-cmove
25309 @opindex mpretend-cmove
25310 Prefer zero-displacement conditional branches for conditional move instruction
25311 patterns.  This can result in faster code on the SH4 processor.
25313 @item -mfdpic
25314 @opindex fdpic
25315 Generate code using the FDPIC ABI.
25317 @end table
25319 @node Solaris 2 Options
25320 @subsection Solaris 2 Options
25321 @cindex Solaris 2 options
25323 These @samp{-m} options are supported on Solaris 2:
25325 @table @gcctabopt
25326 @item -mclear-hwcap
25327 @opindex mclear-hwcap
25328 @option{-mclear-hwcap} tells the compiler to remove the hardware
25329 capabilities generated by the Solaris assembler.  This is only necessary
25330 when object files use ISA extensions not supported by the current
25331 machine, but check at runtime whether or not to use them.
25333 @item -mimpure-text
25334 @opindex mimpure-text
25335 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25336 the compiler to not pass @option{-z text} to the linker when linking a
25337 shared object.  Using this option, you can link position-dependent
25338 code into a shared object.
25340 @option{-mimpure-text} suppresses the ``relocations remain against
25341 allocatable but non-writable sections'' linker error message.
25342 However, the necessary relocations trigger copy-on-write, and the
25343 shared object is not actually shared across processes.  Instead of
25344 using @option{-mimpure-text}, you should compile all source code with
25345 @option{-fpic} or @option{-fPIC}.
25347 @end table
25349 These switches are supported in addition to the above on Solaris 2:
25351 @table @gcctabopt
25352 @item -pthreads
25353 @opindex pthreads
25354 This is a synonym for @option{-pthread}.
25355 @end table
25357 @node SPARC Options
25358 @subsection SPARC Options
25359 @cindex SPARC options
25361 These @samp{-m} options are supported on the SPARC:
25363 @table @gcctabopt
25364 @item -mno-app-regs
25365 @itemx -mapp-regs
25366 @opindex mno-app-regs
25367 @opindex mapp-regs
25368 Specify @option{-mapp-regs} to generate output using the global registers
25369 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25370 global register 1, each global register 2 through 4 is then treated as an
25371 allocable register that is clobbered by function calls.  This is the default.
25373 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25374 specify @option{-mno-app-regs}.  You should compile libraries and system
25375 software with this option.
25377 @item -mflat
25378 @itemx -mno-flat
25379 @opindex mflat
25380 @opindex mno-flat
25381 With @option{-mflat}, the compiler does not generate save/restore instructions
25382 and uses a ``flat'' or single register window model.  This model is compatible
25383 with the regular register window model.  The local registers and the input
25384 registers (0--5) are still treated as ``call-saved'' registers and are
25385 saved on the stack as needed.
25387 With @option{-mno-flat} (the default), the compiler generates save/restore
25388 instructions (except for leaf functions).  This is the normal operating mode.
25390 @item -mfpu
25391 @itemx -mhard-float
25392 @opindex mfpu
25393 @opindex mhard-float
25394 Generate output containing floating-point instructions.  This is the
25395 default.
25397 @item -mno-fpu
25398 @itemx -msoft-float
25399 @opindex mno-fpu
25400 @opindex msoft-float
25401 Generate output containing library calls for floating point.
25402 @strong{Warning:} the requisite libraries are not available for all SPARC
25403 targets.  Normally the facilities of the machine's usual C compiler are
25404 used, but this cannot be done directly in cross-compilation.  You must make
25405 your own arrangements to provide suitable library functions for
25406 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25407 @samp{sparclite-*-*} do provide software floating-point support.
25409 @option{-msoft-float} changes the calling convention in the output file;
25410 therefore, it is only useful if you compile @emph{all} of a program with
25411 this option.  In particular, you need to compile @file{libgcc.a}, the
25412 library that comes with GCC, with @option{-msoft-float} in order for
25413 this to work.
25415 @item -mhard-quad-float
25416 @opindex mhard-quad-float
25417 Generate output containing quad-word (long double) floating-point
25418 instructions.
25420 @item -msoft-quad-float
25421 @opindex msoft-quad-float
25422 Generate output containing library calls for quad-word (long double)
25423 floating-point instructions.  The functions called are those specified
25424 in the SPARC ABI@.  This is the default.
25426 As of this writing, there are no SPARC implementations that have hardware
25427 support for the quad-word floating-point instructions.  They all invoke
25428 a trap handler for one of these instructions, and then the trap handler
25429 emulates the effect of the instruction.  Because of the trap handler overhead,
25430 this is much slower than calling the ABI library routines.  Thus the
25431 @option{-msoft-quad-float} option is the default.
25433 @item -mno-unaligned-doubles
25434 @itemx -munaligned-doubles
25435 @opindex mno-unaligned-doubles
25436 @opindex munaligned-doubles
25437 Assume that doubles have 8-byte alignment.  This is the default.
25439 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25440 alignment only if they are contained in another type, or if they have an
25441 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25442 Specifying this option avoids some rare compatibility problems with code
25443 generated by other compilers.  It is not the default because it results
25444 in a performance loss, especially for floating-point code.
25446 @item -muser-mode
25447 @itemx -mno-user-mode
25448 @opindex muser-mode
25449 @opindex mno-user-mode
25450 Do not generate code that can only run in supervisor mode.  This is relevant
25451 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25452 is the default.
25454 @item -mfaster-structs
25455 @itemx -mno-faster-structs
25456 @opindex mfaster-structs
25457 @opindex mno-faster-structs
25458 With @option{-mfaster-structs}, the compiler assumes that structures
25459 should have 8-byte alignment.  This enables the use of pairs of
25460 @code{ldd} and @code{std} instructions for copies in structure
25461 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25462 However, the use of this changed alignment directly violates the SPARC
25463 ABI@.  Thus, it's intended only for use on targets where the developer
25464 acknowledges that their resulting code is not directly in line with
25465 the rules of the ABI@.
25467 @item -mstd-struct-return
25468 @itemx -mno-std-struct-return
25469 @opindex mstd-struct-return
25470 @opindex mno-std-struct-return
25471 With @option{-mstd-struct-return}, the compiler generates checking code
25472 in functions returning structures or unions to detect size mismatches
25473 between the two sides of function calls, as per the 32-bit ABI@.
25475 The default is @option{-mno-std-struct-return}.  This option has no effect
25476 in 64-bit mode.
25478 @item -mlra
25479 @itemx -mno-lra
25480 @opindex mlra
25481 @opindex mno-lra
25482 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25483 so @option{-mno-lra} needs to be passed to get old Reload.
25485 @item -mcpu=@var{cpu_type}
25486 @opindex mcpu
25487 Set the instruction set, register set, and instruction scheduling parameters
25488 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25489 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25490 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25491 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25492 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25493 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25495 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25496 which selects the best architecture option for the host processor.
25497 @option{-mcpu=native} has no effect if GCC does not recognize
25498 the processor.
25500 Default instruction scheduling parameters are used for values that select
25501 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25502 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25504 Here is a list of each supported architecture and their supported
25505 implementations.
25507 @table @asis
25508 @item v7
25509 cypress, leon3v7
25511 @item v8
25512 supersparc, hypersparc, leon, leon3
25514 @item sparclite
25515 f930, f934, sparclite86x
25517 @item sparclet
25518 tsc701
25520 @item v9
25521 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25522 niagara7, m8
25523 @end table
25525 By default (unless configured otherwise), GCC generates code for the V7
25526 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25527 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25528 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25529 SPARCStation 1, 2, IPX etc.
25531 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25532 architecture.  The only difference from V7 code is that the compiler emits
25533 the integer multiply and integer divide instructions which exist in SPARC-V8
25534 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25535 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25536 2000 series.
25538 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25539 the SPARC architecture.  This adds the integer multiply, integer divide step
25540 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25541 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25542 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25543 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25544 MB86934 chip, which is the more recent SPARClite with FPU@.
25546 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25547 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25548 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25549 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25550 optimizes it for the TEMIC SPARClet chip.
25552 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25553 architecture.  This adds 64-bit integer and floating-point move instructions,
25554 3 additional floating-point condition code registers and conditional move
25555 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25556 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25557 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25558 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25559 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25560 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25561 additionally optimizes it for Sun UltraSPARC T2 chips. With
25562 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25563 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25564 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25565 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25566 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25567 additionally optimizes it for Oracle M8 chips.
25569 @item -mtune=@var{cpu_type}
25570 @opindex mtune
25571 Set the instruction scheduling parameters for machine type
25572 @var{cpu_type}, but do not set the instruction set or register set that the
25573 option @option{-mcpu=@var{cpu_type}} does.
25575 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25576 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25577 that select a particular CPU implementation.  Those are
25578 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25579 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25580 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25581 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25582 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25583 and GNU/Linux toolchains, @samp{native} can also be used.
25585 @item -mv8plus
25586 @itemx -mno-v8plus
25587 @opindex mv8plus
25588 @opindex mno-v8plus
25589 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25590 difference from the V8 ABI is that the global and out registers are
25591 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25592 mode for all SPARC-V9 processors.
25594 @item -mvis
25595 @itemx -mno-vis
25596 @opindex mvis
25597 @opindex mno-vis
25598 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25599 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25601 @item -mvis2
25602 @itemx -mno-vis2
25603 @opindex mvis2
25604 @opindex mno-vis2
25605 With @option{-mvis2}, GCC generates code that takes advantage of
25606 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25607 default is @option{-mvis2} when targeting a cpu that supports such
25608 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25609 also sets @option{-mvis}.
25611 @item -mvis3
25612 @itemx -mno-vis3
25613 @opindex mvis3
25614 @opindex mno-vis3
25615 With @option{-mvis3}, GCC generates code that takes advantage of
25616 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25617 default is @option{-mvis3} when targeting a cpu that supports such
25618 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25619 also sets @option{-mvis2} and @option{-mvis}.
25621 @item -mvis4
25622 @itemx -mno-vis4
25623 @opindex mvis4
25624 @opindex mno-vis4
25625 With @option{-mvis4}, GCC generates code that takes advantage of
25626 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25627 default is @option{-mvis4} when targeting a cpu that supports such
25628 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25629 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25631 @item -mvis4b
25632 @itemx -mno-vis4b
25633 @opindex mvis4b
25634 @opindex mno-vis4b
25635 With @option{-mvis4b}, GCC generates code that takes advantage of
25636 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25637 the additional VIS instructions introduced in the Oracle SPARC
25638 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25639 cpu that supports such instructions, such as m8 and later.  Setting
25640 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25641 @option{-mvis2} and @option{-mvis}.
25643 @item -mcbcond
25644 @itemx -mno-cbcond
25645 @opindex mcbcond
25646 @opindex mno-cbcond
25647 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25648 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25649 when targeting a CPU that supports such instructions, such as Niagara-4 and
25650 later.
25652 @item -mfmaf
25653 @itemx -mno-fmaf
25654 @opindex mfmaf
25655 @opindex mno-fmaf
25656 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25657 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25658 when targeting a CPU that supports such instructions, such as Niagara-3 and
25659 later.
25661 @item -mfsmuld
25662 @itemx -mno-fsmuld
25663 @opindex mfsmuld
25664 @opindex mno-fsmuld
25665 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25666 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25667 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25668 or V9 with FPU except @option{-mcpu=leon}.
25670 @item -mpopc
25671 @itemx -mno-popc
25672 @opindex mpopc
25673 @opindex mno-popc
25674 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25675 Population Count instruction.  The default is @option{-mpopc}
25676 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25677 later.
25679 @item -msubxc
25680 @itemx -mno-subxc
25681 @opindex msubxc
25682 @opindex mno-subxc
25683 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25684 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25685 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25686 later.
25688 @item -mfix-at697f
25689 @opindex mfix-at697f
25690 Enable the documented workaround for the single erratum of the Atmel AT697F
25691 processor (which corresponds to erratum #13 of the AT697E processor).
25693 @item -mfix-ut699
25694 @opindex mfix-ut699
25695 Enable the documented workarounds for the floating-point errata and the data
25696 cache nullify errata of the UT699 processor.
25698 @item -mfix-ut700
25699 @opindex mfix-ut700
25700 Enable the documented workaround for the back-to-back store errata of
25701 the UT699E/UT700 processor.
25703 @item -mfix-gr712rc
25704 @opindex mfix-gr712rc
25705 Enable the documented workaround for the back-to-back store errata of
25706 the GR712RC processor.
25707 @end table
25709 These @samp{-m} options are supported in addition to the above
25710 on SPARC-V9 processors in 64-bit environments:
25712 @table @gcctabopt
25713 @item -m32
25714 @itemx -m64
25715 @opindex m32
25716 @opindex m64
25717 Generate code for a 32-bit or 64-bit environment.
25718 The 32-bit environment sets int, long and pointer to 32 bits.
25719 The 64-bit environment sets int to 32 bits and long and pointer
25720 to 64 bits.
25722 @item -mcmodel=@var{which}
25723 @opindex mcmodel
25724 Set the code model to one of
25726 @table @samp
25727 @item medlow
25728 The Medium/Low code model: 64-bit addresses, programs
25729 must be linked in the low 32 bits of memory.  Programs can be statically
25730 or dynamically linked.
25732 @item medmid
25733 The Medium/Middle code model: 64-bit addresses, programs
25734 must be linked in the low 44 bits of memory, the text and data segments must
25735 be less than 2GB in size and the data segment must be located within 2GB of
25736 the text segment.
25738 @item medany
25739 The Medium/Anywhere code model: 64-bit addresses, programs
25740 may be linked anywhere in memory, the text and data segments must be less
25741 than 2GB in size and the data segment must be located within 2GB of the
25742 text segment.
25744 @item embmedany
25745 The Medium/Anywhere code model for embedded systems:
25746 64-bit addresses, the text and data segments must be less than 2GB in
25747 size, both starting anywhere in memory (determined at link time).  The
25748 global register %g4 points to the base of the data segment.  Programs
25749 are statically linked and PIC is not supported.
25750 @end table
25752 @item -mmemory-model=@var{mem-model}
25753 @opindex mmemory-model
25754 Set the memory model in force on the processor to one of
25756 @table @samp
25757 @item default
25758 The default memory model for the processor and operating system.
25760 @item rmo
25761 Relaxed Memory Order
25763 @item pso
25764 Partial Store Order
25766 @item tso
25767 Total Store Order
25769 @item sc
25770 Sequential Consistency
25771 @end table
25773 These memory models are formally defined in Appendix D of the SPARC-V9
25774 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25776 @item -mstack-bias
25777 @itemx -mno-stack-bias
25778 @opindex mstack-bias
25779 @opindex mno-stack-bias
25780 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25781 frame pointer if present, are offset by @minus{}2047 which must be added back
25782 when making stack frame references.  This is the default in 64-bit mode.
25783 Otherwise, assume no such offset is present.
25784 @end table
25786 @node SPU Options
25787 @subsection SPU Options
25788 @cindex SPU options
25790 These @samp{-m} options are supported on the SPU:
25792 @table @gcctabopt
25793 @item -mwarn-reloc
25794 @itemx -merror-reloc
25795 @opindex mwarn-reloc
25796 @opindex merror-reloc
25798 The loader for SPU does not handle dynamic relocations.  By default, GCC
25799 gives an error when it generates code that requires a dynamic
25800 relocation.  @option{-mno-error-reloc} disables the error,
25801 @option{-mwarn-reloc} generates a warning instead.
25803 @item -msafe-dma
25804 @itemx -munsafe-dma
25805 @opindex msafe-dma
25806 @opindex munsafe-dma
25808 Instructions that initiate or test completion of DMA must not be
25809 reordered with respect to loads and stores of the memory that is being
25810 accessed.
25811 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25812 memory accesses, but that can lead to inefficient code in places where the
25813 memory is known to not change.  Rather than mark the memory as volatile,
25814 you can use @option{-msafe-dma} to tell the compiler to treat
25815 the DMA instructions as potentially affecting all memory.  
25817 @item -mbranch-hints
25818 @opindex mbranch-hints
25820 By default, GCC generates a branch hint instruction to avoid
25821 pipeline stalls for always-taken or probably-taken branches.  A hint
25822 is not generated closer than 8 instructions away from its branch.
25823 There is little reason to disable them, except for debugging purposes,
25824 or to make an object a little bit smaller.
25826 @item -msmall-mem
25827 @itemx -mlarge-mem
25828 @opindex msmall-mem
25829 @opindex mlarge-mem
25831 By default, GCC generates code assuming that addresses are never larger
25832 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25833 a full 32-bit address.
25835 @item -mstdmain
25836 @opindex mstdmain
25838 By default, GCC links against startup code that assumes the SPU-style
25839 main function interface (which has an unconventional parameter list).
25840 With @option{-mstdmain}, GCC links your program against startup
25841 code that assumes a C99-style interface to @code{main}, including a
25842 local copy of @code{argv} strings.
25844 @item -mfixed-range=@var{register-range}
25845 @opindex mfixed-range
25846 Generate code treating the given register range as fixed registers.
25847 A fixed register is one that the register allocator cannot use.  This is
25848 useful when compiling kernel code.  A register range is specified as
25849 two registers separated by a dash.  Multiple register ranges can be
25850 specified separated by a comma.
25852 @item -mea32
25853 @itemx -mea64
25854 @opindex mea32
25855 @opindex mea64
25856 Compile code assuming that pointers to the PPU address space accessed
25857 via the @code{__ea} named address space qualifier are either 32 or 64
25858 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25859 all object code in an executable must be compiled with the same setting.
25861 @item -maddress-space-conversion
25862 @itemx -mno-address-space-conversion
25863 @opindex maddress-space-conversion
25864 @opindex mno-address-space-conversion
25865 Allow/disallow treating the @code{__ea} address space as superset
25866 of the generic address space.  This enables explicit type casts
25867 between @code{__ea} and generic pointer as well as implicit
25868 conversions of generic pointers to @code{__ea} pointers.  The
25869 default is to allow address space pointer conversions.
25871 @item -mcache-size=@var{cache-size}
25872 @opindex mcache-size
25873 This option controls the version of libgcc that the compiler links to an
25874 executable and selects a software-managed cache for accessing variables
25875 in the @code{__ea} address space with a particular cache size.  Possible
25876 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25877 and @samp{128}.  The default cache size is 64KB.
25879 @item -matomic-updates
25880 @itemx -mno-atomic-updates
25881 @opindex matomic-updates
25882 @opindex mno-atomic-updates
25883 This option controls the version of libgcc that the compiler links to an
25884 executable and selects whether atomic updates to the software-managed
25885 cache of PPU-side variables are used.  If you use atomic updates, changes
25886 to a PPU variable from SPU code using the @code{__ea} named address space
25887 qualifier do not interfere with changes to other PPU variables residing
25888 in the same cache line from PPU code.  If you do not use atomic updates,
25889 such interference may occur; however, writing back cache lines is
25890 more efficient.  The default behavior is to use atomic updates.
25892 @item -mdual-nops
25893 @itemx -mdual-nops=@var{n}
25894 @opindex mdual-nops
25895 By default, GCC inserts NOPs to increase dual issue when it expects
25896 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25897 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25898 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25900 @item -mhint-max-nops=@var{n}
25901 @opindex mhint-max-nops
25902 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25903 be at least 8 instructions away from the branch it is affecting.  GCC
25904 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25905 generate the branch hint.
25907 @item -mhint-max-distance=@var{n}
25908 @opindex mhint-max-distance
25909 The encoding of the branch hint instruction limits the hint to be within
25910 256 instructions of the branch it is affecting.  By default, GCC makes
25911 sure it is within 125.
25913 @item -msafe-hints
25914 @opindex msafe-hints
25915 Work around a hardware bug that causes the SPU to stall indefinitely.
25916 By default, GCC inserts the @code{hbrp} instruction to make sure
25917 this stall won't happen.
25919 @end table
25921 @node System V Options
25922 @subsection Options for System V
25924 These additional options are available on System V Release 4 for
25925 compatibility with other compilers on those systems:
25927 @table @gcctabopt
25928 @item -G
25929 @opindex G
25930 Create a shared object.
25931 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25933 @item -Qy
25934 @opindex Qy
25935 Identify the versions of each tool used by the compiler, in a
25936 @code{.ident} assembler directive in the output.
25938 @item -Qn
25939 @opindex Qn
25940 Refrain from adding @code{.ident} directives to the output file (this is
25941 the default).
25943 @item -YP,@var{dirs}
25944 @opindex YP
25945 Search the directories @var{dirs}, and no others, for libraries
25946 specified with @option{-l}.
25948 @item -Ym,@var{dir}
25949 @opindex Ym
25950 Look in the directory @var{dir} to find the M4 preprocessor.
25951 The assembler uses this option.
25952 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25953 @c the generic assembler that comes with Solaris takes just -Ym.
25954 @end table
25956 @node TILE-Gx Options
25957 @subsection TILE-Gx Options
25958 @cindex TILE-Gx options
25960 These @samp{-m} options are supported on the TILE-Gx:
25962 @table @gcctabopt
25963 @item -mcmodel=small
25964 @opindex mcmodel=small
25965 Generate code for the small model.  The distance for direct calls is
25966 limited to 500M in either direction.  PC-relative addresses are 32
25967 bits.  Absolute addresses support the full address range.
25969 @item -mcmodel=large
25970 @opindex mcmodel=large
25971 Generate code for the large model.  There is no limitation on call
25972 distance, pc-relative addresses, or absolute addresses.
25974 @item -mcpu=@var{name}
25975 @opindex mcpu
25976 Selects the type of CPU to be targeted.  Currently the only supported
25977 type is @samp{tilegx}.
25979 @item -m32
25980 @itemx -m64
25981 @opindex m32
25982 @opindex m64
25983 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25984 environment sets int, long, and pointer to 32 bits.  The 64-bit
25985 environment sets int to 32 bits and long and pointer to 64 bits.
25987 @item -mbig-endian
25988 @itemx -mlittle-endian
25989 @opindex mbig-endian
25990 @opindex mlittle-endian
25991 Generate code in big/little endian mode, respectively.
25992 @end table
25994 @node TILEPro Options
25995 @subsection TILEPro Options
25996 @cindex TILEPro options
25998 These @samp{-m} options are supported on the TILEPro:
26000 @table @gcctabopt
26001 @item -mcpu=@var{name}
26002 @opindex mcpu
26003 Selects the type of CPU to be targeted.  Currently the only supported
26004 type is @samp{tilepro}.
26006 @item -m32
26007 @opindex m32
26008 Generate code for a 32-bit environment, which sets int, long, and
26009 pointer to 32 bits.  This is the only supported behavior so the flag
26010 is essentially ignored.
26011 @end table
26013 @node V850 Options
26014 @subsection V850 Options
26015 @cindex V850 Options
26017 These @samp{-m} options are defined for V850 implementations:
26019 @table @gcctabopt
26020 @item -mlong-calls
26021 @itemx -mno-long-calls
26022 @opindex mlong-calls
26023 @opindex mno-long-calls
26024 Treat all calls as being far away (near).  If calls are assumed to be
26025 far away, the compiler always loads the function's address into a
26026 register, and calls indirect through the pointer.
26028 @item -mno-ep
26029 @itemx -mep
26030 @opindex mno-ep
26031 @opindex mep
26032 Do not optimize (do optimize) basic blocks that use the same index
26033 pointer 4 or more times to copy pointer into the @code{ep} register, and
26034 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26035 option is on by default if you optimize.
26037 @item -mno-prolog-function
26038 @itemx -mprolog-function
26039 @opindex mno-prolog-function
26040 @opindex mprolog-function
26041 Do not use (do use) external functions to save and restore registers
26042 at the prologue and epilogue of a function.  The external functions
26043 are slower, but use less code space if more than one function saves
26044 the same number of registers.  The @option{-mprolog-function} option
26045 is on by default if you optimize.
26047 @item -mspace
26048 @opindex mspace
26049 Try to make the code as small as possible.  At present, this just turns
26050 on the @option{-mep} and @option{-mprolog-function} options.
26052 @item -mtda=@var{n}
26053 @opindex mtda
26054 Put static or global variables whose size is @var{n} bytes or less into
26055 the tiny data area that register @code{ep} points to.  The tiny data
26056 area can hold up to 256 bytes in total (128 bytes for byte references).
26058 @item -msda=@var{n}
26059 @opindex msda
26060 Put static or global variables whose size is @var{n} bytes or less into
26061 the small data area that register @code{gp} points to.  The small data
26062 area can hold up to 64 kilobytes.
26064 @item -mzda=@var{n}
26065 @opindex mzda
26066 Put static or global variables whose size is @var{n} bytes or less into
26067 the first 32 kilobytes of memory.
26069 @item -mv850
26070 @opindex mv850
26071 Specify that the target processor is the V850.
26073 @item -mv850e3v5
26074 @opindex mv850e3v5
26075 Specify that the target processor is the V850E3V5.  The preprocessor
26076 constant @code{__v850e3v5__} is defined if this option is used.
26078 @item -mv850e2v4
26079 @opindex mv850e2v4
26080 Specify that the target processor is the V850E3V5.  This is an alias for
26081 the @option{-mv850e3v5} option.
26083 @item -mv850e2v3
26084 @opindex mv850e2v3
26085 Specify that the target processor is the V850E2V3.  The preprocessor
26086 constant @code{__v850e2v3__} is defined if this option is used.
26088 @item -mv850e2
26089 @opindex mv850e2
26090 Specify that the target processor is the V850E2.  The preprocessor
26091 constant @code{__v850e2__} is defined if this option is used.
26093 @item -mv850e1
26094 @opindex mv850e1
26095 Specify that the target processor is the V850E1.  The preprocessor
26096 constants @code{__v850e1__} and @code{__v850e__} are defined if
26097 this option is used.
26099 @item -mv850es
26100 @opindex mv850es
26101 Specify that the target processor is the V850ES.  This is an alias for
26102 the @option{-mv850e1} option.
26104 @item -mv850e
26105 @opindex mv850e
26106 Specify that the target processor is the V850E@.  The preprocessor
26107 constant @code{__v850e__} is defined if this option is used.
26109 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26110 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26111 are defined then a default target processor is chosen and the
26112 relevant @samp{__v850*__} preprocessor constant is defined.
26114 The preprocessor constants @code{__v850} and @code{__v851__} are always
26115 defined, regardless of which processor variant is the target.
26117 @item -mdisable-callt
26118 @itemx -mno-disable-callt
26119 @opindex mdisable-callt
26120 @opindex mno-disable-callt
26121 This option suppresses generation of the @code{CALLT} instruction for the
26122 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26123 architecture.
26125 This option is enabled by default when the RH850 ABI is
26126 in use (see @option{-mrh850-abi}), and disabled by default when the
26127 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26128 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26130 @item -mrelax
26131 @itemx -mno-relax
26132 @opindex mrelax
26133 @opindex mno-relax
26134 Pass on (or do not pass on) the @option{-mrelax} command-line option
26135 to the assembler.
26137 @item -mlong-jumps
26138 @itemx -mno-long-jumps
26139 @opindex mlong-jumps
26140 @opindex mno-long-jumps
26141 Disable (or re-enable) the generation of PC-relative jump instructions.
26143 @item -msoft-float
26144 @itemx -mhard-float
26145 @opindex msoft-float
26146 @opindex mhard-float
26147 Disable (or re-enable) the generation of hardware floating point
26148 instructions.  This option is only significant when the target
26149 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26150 instructions are being generated then the C preprocessor symbol
26151 @code{__FPU_OK__} is defined, otherwise the symbol
26152 @code{__NO_FPU__} is defined.
26154 @item -mloop
26155 @opindex mloop
26156 Enables the use of the e3v5 LOOP instruction.  The use of this
26157 instruction is not enabled by default when the e3v5 architecture is
26158 selected because its use is still experimental.
26160 @item -mrh850-abi
26161 @itemx -mghs
26162 @opindex mrh850-abi
26163 @opindex mghs
26164 Enables support for the RH850 version of the V850 ABI.  This is the
26165 default.  With this version of the ABI the following rules apply:
26167 @itemize
26168 @item
26169 Integer sized structures and unions are returned via a memory pointer
26170 rather than a register.
26172 @item
26173 Large structures and unions (more than 8 bytes in size) are passed by
26174 value.
26176 @item
26177 Functions are aligned to 16-bit boundaries.
26179 @item
26180 The @option{-m8byte-align} command-line option is supported.
26182 @item
26183 The @option{-mdisable-callt} command-line option is enabled by
26184 default.  The @option{-mno-disable-callt} command-line option is not
26185 supported.
26186 @end itemize
26188 When this version of the ABI is enabled the C preprocessor symbol
26189 @code{__V850_RH850_ABI__} is defined.
26191 @item -mgcc-abi
26192 @opindex mgcc-abi
26193 Enables support for the old GCC version of the V850 ABI.  With this
26194 version of the ABI the following rules apply:
26196 @itemize
26197 @item
26198 Integer sized structures and unions are returned in register @code{r10}.
26200 @item
26201 Large structures and unions (more than 8 bytes in size) are passed by
26202 reference.
26204 @item
26205 Functions are aligned to 32-bit boundaries, unless optimizing for
26206 size.
26208 @item
26209 The @option{-m8byte-align} command-line option is not supported.
26211 @item
26212 The @option{-mdisable-callt} command-line option is supported but not
26213 enabled by default.
26214 @end itemize
26216 When this version of the ABI is enabled the C preprocessor symbol
26217 @code{__V850_GCC_ABI__} is defined.
26219 @item -m8byte-align
26220 @itemx -mno-8byte-align
26221 @opindex m8byte-align
26222 @opindex mno-8byte-align
26223 Enables support for @code{double} and @code{long long} types to be
26224 aligned on 8-byte boundaries.  The default is to restrict the
26225 alignment of all objects to at most 4-bytes.  When
26226 @option{-m8byte-align} is in effect the C preprocessor symbol
26227 @code{__V850_8BYTE_ALIGN__} is defined.
26229 @item -mbig-switch
26230 @opindex mbig-switch
26231 Generate code suitable for big switch tables.  Use this option only if
26232 the assembler/linker complain about out of range branches within a switch
26233 table.
26235 @item -mapp-regs
26236 @opindex mapp-regs
26237 This option causes r2 and r5 to be used in the code generated by
26238 the compiler.  This setting is the default.
26240 @item -mno-app-regs
26241 @opindex mno-app-regs
26242 This option causes r2 and r5 to be treated as fixed registers.
26244 @end table
26246 @node VAX Options
26247 @subsection VAX Options
26248 @cindex VAX options
26250 These @samp{-m} options are defined for the VAX:
26252 @table @gcctabopt
26253 @item -munix
26254 @opindex munix
26255 Do not output certain jump instructions (@code{aobleq} and so on)
26256 that the Unix assembler for the VAX cannot handle across long
26257 ranges.
26259 @item -mgnu
26260 @opindex mgnu
26261 Do output those jump instructions, on the assumption that the
26262 GNU assembler is being used.
26264 @item -mg
26265 @opindex mg
26266 Output code for G-format floating-point numbers instead of D-format.
26267 @end table
26269 @node Visium Options
26270 @subsection Visium Options
26271 @cindex Visium options
26273 @table @gcctabopt
26275 @item -mdebug
26276 @opindex mdebug
26277 A program which performs file I/O and is destined to run on an MCM target
26278 should be linked with this option.  It causes the libraries libc.a and
26279 libdebug.a to be linked.  The program should be run on the target under
26280 the control of the GDB remote debugging stub.
26282 @item -msim
26283 @opindex msim
26284 A program which performs file I/O and is destined to run on the simulator
26285 should be linked with option.  This causes libraries libc.a and libsim.a to
26286 be linked.
26288 @item -mfpu
26289 @itemx -mhard-float
26290 @opindex mfpu
26291 @opindex mhard-float
26292 Generate code containing floating-point instructions.  This is the
26293 default.
26295 @item -mno-fpu
26296 @itemx -msoft-float
26297 @opindex mno-fpu
26298 @opindex msoft-float
26299 Generate code containing library calls for floating-point.
26301 @option{-msoft-float} changes the calling convention in the output file;
26302 therefore, it is only useful if you compile @emph{all} of a program with
26303 this option.  In particular, you need to compile @file{libgcc.a}, the
26304 library that comes with GCC, with @option{-msoft-float} in order for
26305 this to work.
26307 @item -mcpu=@var{cpu_type}
26308 @opindex mcpu
26309 Set the instruction set, register set, and instruction scheduling parameters
26310 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26311 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26313 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26315 By default (unless configured otherwise), GCC generates code for the GR5
26316 variant of the Visium architecture.  
26318 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26319 architecture.  The only difference from GR5 code is that the compiler will
26320 generate block move instructions.
26322 @item -mtune=@var{cpu_type}
26323 @opindex mtune
26324 Set the instruction scheduling parameters for machine type @var{cpu_type},
26325 but do not set the instruction set or register set that the option
26326 @option{-mcpu=@var{cpu_type}} would.
26328 @item -msv-mode
26329 @opindex msv-mode
26330 Generate code for the supervisor mode, where there are no restrictions on
26331 the access to general registers.  This is the default.
26333 @item -muser-mode
26334 @opindex muser-mode
26335 Generate code for the user mode, where the access to some general registers
26336 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26337 mode; on the GR6, only registers r29 to r31 are affected.
26338 @end table
26340 @node VMS Options
26341 @subsection VMS Options
26343 These @samp{-m} options are defined for the VMS implementations:
26345 @table @gcctabopt
26346 @item -mvms-return-codes
26347 @opindex mvms-return-codes
26348 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26349 condition (e.g.@ error) codes.
26351 @item -mdebug-main=@var{prefix}
26352 @opindex mdebug-main=@var{prefix}
26353 Flag the first routine whose name starts with @var{prefix} as the main
26354 routine for the debugger.
26356 @item -mmalloc64
26357 @opindex mmalloc64
26358 Default to 64-bit memory allocation routines.
26360 @item -mpointer-size=@var{size}
26361 @opindex mpointer-size=@var{size}
26362 Set the default size of pointers. Possible options for @var{size} are
26363 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26364 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26365 The later option disables @code{pragma pointer_size}.
26366 @end table
26368 @node VxWorks Options
26369 @subsection VxWorks Options
26370 @cindex VxWorks Options
26372 The options in this section are defined for all VxWorks targets.
26373 Options specific to the target hardware are listed with the other
26374 options for that target.
26376 @table @gcctabopt
26377 @item -mrtp
26378 @opindex mrtp
26379 GCC can generate code for both VxWorks kernels and real time processes
26380 (RTPs).  This option switches from the former to the latter.  It also
26381 defines the preprocessor macro @code{__RTP__}.
26383 @item -non-static
26384 @opindex non-static
26385 Link an RTP executable against shared libraries rather than static
26386 libraries.  The options @option{-static} and @option{-shared} can
26387 also be used for RTPs (@pxref{Link Options}); @option{-static}
26388 is the default.
26390 @item -Bstatic
26391 @itemx -Bdynamic
26392 @opindex Bstatic
26393 @opindex Bdynamic
26394 These options are passed down to the linker.  They are defined for
26395 compatibility with Diab.
26397 @item -Xbind-lazy
26398 @opindex Xbind-lazy
26399 Enable lazy binding of function calls.  This option is equivalent to
26400 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26402 @item -Xbind-now
26403 @opindex Xbind-now
26404 Disable lazy binding of function calls.  This option is the default and
26405 is defined for compatibility with Diab.
26406 @end table
26408 @node x86 Options
26409 @subsection x86 Options
26410 @cindex x86 Options
26412 These @samp{-m} options are defined for the x86 family of computers.
26414 @table @gcctabopt
26416 @item -march=@var{cpu-type}
26417 @opindex march
26418 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26419 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26420 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26421 to generate code that may not run at all on processors other than the one
26422 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26423 @option{-mtune=@var{cpu-type}}.
26425 The choices for @var{cpu-type} are:
26427 @table @samp
26428 @item native
26429 This selects the CPU to generate code for at compilation time by determining
26430 the processor type of the compiling machine.  Using @option{-march=native}
26431 enables all instruction subsets supported by the local machine (hence
26432 the result might not run on different machines).  Using @option{-mtune=native}
26433 produces code optimized for the local machine under the constraints
26434 of the selected instruction set.  
26436 @item i386
26437 Original Intel i386 CPU@.
26439 @item i486
26440 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26442 @item i586
26443 @itemx pentium
26444 Intel Pentium CPU with no MMX support.
26446 @item lakemont
26447 Intel Lakemont MCU, based on Intel Pentium CPU.
26449 @item pentium-mmx
26450 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26452 @item pentiumpro
26453 Intel Pentium Pro CPU@.
26455 @item i686
26456 When used with @option{-march}, the Pentium Pro
26457 instruction set is used, so the code runs on all i686 family chips.
26458 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26460 @item pentium2
26461 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26462 support.
26464 @item pentium3
26465 @itemx pentium3m
26466 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26467 set support.
26469 @item pentium-m
26470 Intel Pentium M; low-power version of Intel Pentium III CPU
26471 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26473 @item pentium4
26474 @itemx pentium4m
26475 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26477 @item prescott
26478 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26479 set support.
26481 @item nocona
26482 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26483 SSE2 and SSE3 instruction set support.
26485 @item core2
26486 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26487 instruction set support.
26489 @item nehalem
26490 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26491 SSE4.1, SSE4.2 and POPCNT instruction set support.
26493 @item westmere
26494 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26495 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26497 @item sandybridge
26498 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26499 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26501 @item ivybridge
26502 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26503 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26504 instruction set support.
26506 @item haswell
26507 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26508 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26509 BMI, BMI2 and F16C instruction set support.
26511 @item broadwell
26512 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26513 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26514 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26516 @item skylake
26517 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26518 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26519 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26520 XSAVES instruction set support.
26522 @item bonnell
26523 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26524 instruction set support.
26526 @item silvermont
26527 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26528 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26530 @item knl
26531 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26532 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26533 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26534 AVX512CD instruction set support.
26536 @item knm
26537 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26538 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26539 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26540 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26542 @item skylake-avx512
26543 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26544 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26545 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26546 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26548 @item cannonlake
26549 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26550 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26551 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26552 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26553 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
26555 @item Icelake
26556 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26557 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26558 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26559 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26560 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26561 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26563 @item k6
26564 AMD K6 CPU with MMX instruction set support.
26566 @item k6-2
26567 @itemx k6-3
26568 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26570 @item athlon
26571 @itemx athlon-tbird
26572 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26573 support.
26575 @item athlon-4
26576 @itemx athlon-xp
26577 @itemx athlon-mp
26578 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26579 instruction set support.
26581 @item k8
26582 @itemx opteron
26583 @itemx athlon64
26584 @itemx athlon-fx
26585 Processors based on the AMD K8 core with x86-64 instruction set support,
26586 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26587 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26588 instruction set extensions.)
26590 @item k8-sse3
26591 @itemx opteron-sse3
26592 @itemx athlon64-sse3
26593 Improved versions of AMD K8 cores with SSE3 instruction set support.
26595 @item amdfam10
26596 @itemx barcelona
26597 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26598 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26599 instruction set extensions.)
26601 @item bdver1
26602 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26603 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26604 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26605 @item bdver2
26606 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26607 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26608 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26609 extensions.)
26610 @item bdver3
26611 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26612 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26613 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26614 64-bit instruction set extensions.
26615 @item bdver4
26616 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26617 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26618 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26619 SSE4.2, ABM and 64-bit instruction set extensions.
26621 @item znver1
26622 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26623 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26624 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26625 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26626 instruction set extensions.
26628 @item btver1
26629 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26630 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26631 instruction set extensions.)
26633 @item btver2
26634 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26635 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26636 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26638 @item winchip-c6
26639 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26640 set support.
26642 @item winchip2
26643 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26644 instruction set support.
26646 @item c3
26647 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26648 (No scheduling is implemented for this chip.)
26650 @item c3-2
26651 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26652 (No scheduling is implemented for this chip.)
26654 @item c7
26655 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26656 (No scheduling is implemented for this chip.)
26658 @item samuel-2
26659 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26660 (No scheduling is implemented for this chip.)
26662 @item nehemiah
26663 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26664 (No scheduling is implemented for this chip.)
26666 @item esther
26667 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26668 (No scheduling is implemented for this chip.)
26670 @item eden-x2
26671 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26672 (No scheduling is implemented for this chip.)
26674 @item eden-x4
26675 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26676 AVX and AVX2 instruction set support.
26677 (No scheduling is implemented for this chip.)
26679 @item nano
26680 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26681 instruction set support.
26682 (No scheduling is implemented for this chip.)
26684 @item nano-1000
26685 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26686 instruction set support.
26687 (No scheduling is implemented for this chip.)
26689 @item nano-2000
26690 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26691 instruction set support.
26692 (No scheduling is implemented for this chip.)
26694 @item nano-3000
26695 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26696 instruction set support.
26697 (No scheduling is implemented for this chip.)
26699 @item nano-x2
26700 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26701 instruction set support.
26702 (No scheduling is implemented for this chip.)
26704 @item nano-x4
26705 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26706 instruction set support.
26707 (No scheduling is implemented for this chip.)
26709 @item geode
26710 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26711 @end table
26713 @item -mtune=@var{cpu-type}
26714 @opindex mtune
26715 Tune to @var{cpu-type} everything applicable about the generated code, except
26716 for the ABI and the set of available instructions.  
26717 While picking a specific @var{cpu-type} schedules things appropriately
26718 for that particular chip, the compiler does not generate any code that
26719 cannot run on the default machine type unless you use a
26720 @option{-march=@var{cpu-type}} option.
26721 For example, if GCC is configured for i686-pc-linux-gnu
26722 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26723 but still runs on i686 machines.
26725 The choices for @var{cpu-type} are the same as for @option{-march}.
26726 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26728 @table @samp
26729 @item generic
26730 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26731 If you know the CPU on which your code will run, then you should use
26732 the corresponding @option{-mtune} or @option{-march} option instead of
26733 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26734 of your application will have, then you should use this option.
26736 As new processors are deployed in the marketplace, the behavior of this
26737 option will change.  Therefore, if you upgrade to a newer version of
26738 GCC, code generation controlled by this option will change to reflect
26739 the processors
26740 that are most common at the time that version of GCC is released.
26742 There is no @option{-march=generic} option because @option{-march}
26743 indicates the instruction set the compiler can use, and there is no
26744 generic instruction set applicable to all processors.  In contrast,
26745 @option{-mtune} indicates the processor (or, in this case, collection of
26746 processors) for which the code is optimized.
26748 @item intel
26749 Produce code optimized for the most current Intel processors, which are
26750 Haswell and Silvermont for this version of GCC.  If you know the CPU
26751 on which your code will run, then you should use the corresponding
26752 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26753 But, if you want your application performs better on both Haswell and
26754 Silvermont, then you should use this option.
26756 As new Intel processors are deployed in the marketplace, the behavior of
26757 this option will change.  Therefore, if you upgrade to a newer version of
26758 GCC, code generation controlled by this option will change to reflect
26759 the most current Intel processors at the time that version of GCC is
26760 released.
26762 There is no @option{-march=intel} option because @option{-march} indicates
26763 the instruction set the compiler can use, and there is no common
26764 instruction set applicable to all processors.  In contrast,
26765 @option{-mtune} indicates the processor (or, in this case, collection of
26766 processors) for which the code is optimized.
26767 @end table
26769 @item -mcpu=@var{cpu-type}
26770 @opindex mcpu
26771 A deprecated synonym for @option{-mtune}.
26773 @item -mfpmath=@var{unit}
26774 @opindex mfpmath
26775 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26776 for @var{unit} are:
26778 @table @samp
26779 @item 387
26780 Use the standard 387 floating-point coprocessor present on the majority of chips and
26781 emulated otherwise.  Code compiled with this option runs almost everywhere.
26782 The temporary results are computed in 80-bit precision instead of the precision
26783 specified by the type, resulting in slightly different results compared to most
26784 of other chips.  See @option{-ffloat-store} for more detailed description.
26786 This is the default choice for non-Darwin x86-32 targets.
26788 @item sse
26789 Use scalar floating-point instructions present in the SSE instruction set.
26790 This instruction set is supported by Pentium III and newer chips,
26791 and in the AMD line
26792 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26793 instruction set supports only single-precision arithmetic, thus the double and
26794 extended-precision arithmetic are still done using 387.  A later version, present
26795 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26796 arithmetic too.
26798 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26799 or @option{-msse2} switches to enable SSE extensions and make this option
26800 effective.  For the x86-64 compiler, these extensions are enabled by default.
26802 The resulting code should be considerably faster in the majority of cases and avoid
26803 the numerical instability problems of 387 code, but may break some existing
26804 code that expects temporaries to be 80 bits.
26806 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26807 and the default choice for x86-32 targets with the SSE2 instruction set
26808 when @option{-ffast-math} is enabled.
26810 @item sse,387
26811 @itemx sse+387
26812 @itemx both
26813 Attempt to utilize both instruction sets at once.  This effectively doubles the
26814 amount of available registers, and on chips with separate execution units for
26815 387 and SSE the execution resources too.  Use this option with care, as it is
26816 still experimental, because the GCC register allocator does not model separate
26817 functional units well, resulting in unstable performance.
26818 @end table
26820 @item -masm=@var{dialect}
26821 @opindex masm=@var{dialect}
26822 Output assembly instructions using selected @var{dialect}.  Also affects
26823 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26824 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26825 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26826 not support @samp{intel}.
26828 @item -mieee-fp
26829 @itemx -mno-ieee-fp
26830 @opindex mieee-fp
26831 @opindex mno-ieee-fp
26832 Control whether or not the compiler uses IEEE floating-point
26833 comparisons.  These correctly handle the case where the result of a
26834 comparison is unordered.
26836 @item -m80387
26837 @itemx -mhard-float
26838 @opindex 80387
26839 @opindex mhard-float
26840 Generate output containing 80387 instructions for floating point.
26842 @item -mno-80387
26843 @itemx -msoft-float
26844 @opindex no-80387
26845 @opindex msoft-float
26846 Generate output containing library calls for floating point.
26848 @strong{Warning:} the requisite libraries are not part of GCC@.
26849 Normally the facilities of the machine's usual C compiler are used, but
26850 this cannot be done directly in cross-compilation.  You must make your
26851 own arrangements to provide suitable library functions for
26852 cross-compilation.
26854 On machines where a function returns floating-point results in the 80387
26855 register stack, some floating-point opcodes may be emitted even if
26856 @option{-msoft-float} is used.
26858 @item -mno-fp-ret-in-387
26859 @opindex mno-fp-ret-in-387
26860 Do not use the FPU registers for return values of functions.
26862 The usual calling convention has functions return values of types
26863 @code{float} and @code{double} in an FPU register, even if there
26864 is no FPU@.  The idea is that the operating system should emulate
26865 an FPU@.
26867 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26868 in ordinary CPU registers instead.
26870 @item -mno-fancy-math-387
26871 @opindex mno-fancy-math-387
26872 Some 387 emulators do not support the @code{sin}, @code{cos} and
26873 @code{sqrt} instructions for the 387.  Specify this option to avoid
26874 generating those instructions.  This option is the default on
26875 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26876 indicates that the target CPU always has an FPU and so the
26877 instruction does not need emulation.  These
26878 instructions are not generated unless you also use the
26879 @option{-funsafe-math-optimizations} switch.
26881 @item -malign-double
26882 @itemx -mno-align-double
26883 @opindex malign-double
26884 @opindex mno-align-double
26885 Control whether GCC aligns @code{double}, @code{long double}, and
26886 @code{long long} variables on a two-word boundary or a one-word
26887 boundary.  Aligning @code{double} variables on a two-word boundary
26888 produces code that runs somewhat faster on a Pentium at the
26889 expense of more memory.
26891 On x86-64, @option{-malign-double} is enabled by default.
26893 @strong{Warning:} if you use the @option{-malign-double} switch,
26894 structures containing the above types are aligned differently than
26895 the published application binary interface specifications for the x86-32
26896 and are not binary compatible with structures in code compiled
26897 without that switch.
26899 @item -m96bit-long-double
26900 @itemx -m128bit-long-double
26901 @opindex m96bit-long-double
26902 @opindex m128bit-long-double
26903 These switches control the size of @code{long double} type.  The x86-32
26904 application binary interface specifies the size to be 96 bits,
26905 so @option{-m96bit-long-double} is the default in 32-bit mode.
26907 Modern architectures (Pentium and newer) prefer @code{long double}
26908 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26909 conforming to the ABI, this is not possible.  So specifying
26910 @option{-m128bit-long-double} aligns @code{long double}
26911 to a 16-byte boundary by padding the @code{long double} with an additional
26912 32-bit zero.
26914 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26915 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26917 Notice that neither of these options enable any extra precision over the x87
26918 standard of 80 bits for a @code{long double}.
26920 @strong{Warning:} if you override the default value for your target ABI, this
26921 changes the size of 
26922 structures and arrays containing @code{long double} variables,
26923 as well as modifying the function calling convention for functions taking
26924 @code{long double}.  Hence they are not binary-compatible
26925 with code compiled without that switch.
26927 @item -mlong-double-64
26928 @itemx -mlong-double-80
26929 @itemx -mlong-double-128
26930 @opindex mlong-double-64
26931 @opindex mlong-double-80
26932 @opindex mlong-double-128
26933 These switches control the size of @code{long double} type. A size
26934 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26935 type. This is the default for 32-bit Bionic C library.  A size
26936 of 128 bits makes the @code{long double} type equivalent to the
26937 @code{__float128} type. This is the default for 64-bit Bionic C library.
26939 @strong{Warning:} if you override the default value for your target ABI, this
26940 changes the size of
26941 structures and arrays containing @code{long double} variables,
26942 as well as modifying the function calling convention for functions taking
26943 @code{long double}.  Hence they are not binary-compatible
26944 with code compiled without that switch.
26946 @item -malign-data=@var{type}
26947 @opindex malign-data
26948 Control how GCC aligns variables.  Supported values for @var{type} are
26949 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26950 and earlier, @samp{abi} uses alignment value as specified by the
26951 psABI, and @samp{cacheline} uses increased alignment value to match
26952 the cache line size.  @samp{compat} is the default.
26954 @item -mlarge-data-threshold=@var{threshold}
26955 @opindex mlarge-data-threshold
26956 When @option{-mcmodel=medium} is specified, data objects larger than
26957 @var{threshold} are placed in the large data section.  This value must be the
26958 same across all objects linked into the binary, and defaults to 65535.
26960 @item -mrtd
26961 @opindex mrtd
26962 Use a different function-calling convention, in which functions that
26963 take a fixed number of arguments return with the @code{ret @var{num}}
26964 instruction, which pops their arguments while returning.  This saves one
26965 instruction in the caller since there is no need to pop the arguments
26966 there.
26968 You can specify that an individual function is called with this calling
26969 sequence with the function attribute @code{stdcall}.  You can also
26970 override the @option{-mrtd} option by using the function attribute
26971 @code{cdecl}.  @xref{Function Attributes}.
26973 @strong{Warning:} this calling convention is incompatible with the one
26974 normally used on Unix, so you cannot use it if you need to call
26975 libraries compiled with the Unix compiler.
26977 Also, you must provide function prototypes for all functions that
26978 take variable numbers of arguments (including @code{printf});
26979 otherwise incorrect code is generated for calls to those
26980 functions.
26982 In addition, seriously incorrect code results if you call a
26983 function with too many arguments.  (Normally, extra arguments are
26984 harmlessly ignored.)
26986 @item -mregparm=@var{num}
26987 @opindex mregparm
26988 Control how many registers are used to pass integer arguments.  By
26989 default, no registers are used to pass arguments, and at most 3
26990 registers can be used.  You can control this behavior for a specific
26991 function by using the function attribute @code{regparm}.
26992 @xref{Function Attributes}.
26994 @strong{Warning:} if you use this switch, and
26995 @var{num} is nonzero, then you must build all modules with the same
26996 value, including any libraries.  This includes the system libraries and
26997 startup modules.
26999 @item -msseregparm
27000 @opindex msseregparm
27001 Use SSE register passing conventions for float and double arguments
27002 and return values.  You can control this behavior for a specific
27003 function by using the function attribute @code{sseregparm}.
27004 @xref{Function Attributes}.
27006 @strong{Warning:} if you use this switch then you must build all
27007 modules with the same value, including any libraries.  This includes
27008 the system libraries and startup modules.
27010 @item -mvect8-ret-in-mem
27011 @opindex mvect8-ret-in-mem
27012 Return 8-byte vectors in memory instead of MMX registers.  This is the
27013 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27014 Studio compilers until version 12.  Later compiler versions (starting
27015 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27016 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27017 you need to remain compatible with existing code produced by those
27018 previous compiler versions or older versions of GCC@.
27020 @item -mpc32
27021 @itemx -mpc64
27022 @itemx -mpc80
27023 @opindex mpc32
27024 @opindex mpc64
27025 @opindex mpc80
27027 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27028 is specified, the significands of results of floating-point operations are
27029 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27030 significands of results of floating-point operations to 53 bits (double
27031 precision) and @option{-mpc80} rounds the significands of results of
27032 floating-point operations to 64 bits (extended double precision), which is
27033 the default.  When this option is used, floating-point operations in higher
27034 precisions are not available to the programmer without setting the FPU
27035 control word explicitly.
27037 Setting the rounding of floating-point operations to less than the default
27038 80 bits can speed some programs by 2% or more.  Note that some mathematical
27039 libraries assume that extended-precision (80-bit) floating-point operations
27040 are enabled by default; routines in such libraries could suffer significant
27041 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27042 when this option is used to set the precision to less than extended precision.
27044 @item -mstackrealign
27045 @opindex mstackrealign
27046 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27047 option generates an alternate prologue and epilogue that realigns the
27048 run-time stack if necessary.  This supports mixing legacy codes that keep
27049 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27050 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27051 applicable to individual functions.
27053 @item -mpreferred-stack-boundary=@var{num}
27054 @opindex mpreferred-stack-boundary
27055 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27056 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27057 the default is 4 (16 bytes or 128 bits).
27059 @strong{Warning:} When generating code for the x86-64 architecture with
27060 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27061 used to keep the stack boundary aligned to 8 byte boundary.  Since
27062 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27063 intended to be used in controlled environment where stack space is
27064 important limitation.  This option leads to wrong code when functions
27065 compiled with 16 byte stack alignment (such as functions from a standard
27066 library) are called with misaligned stack.  In this case, SSE
27067 instructions may lead to misaligned memory access traps.  In addition,
27068 variable arguments are handled incorrectly for 16 byte aligned
27069 objects (including x87 long double and __int128), leading to wrong
27070 results.  You must build all modules with
27071 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27072 includes the system libraries and startup modules.
27074 @item -mincoming-stack-boundary=@var{num}
27075 @opindex mincoming-stack-boundary
27076 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27077 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27078 the one specified by @option{-mpreferred-stack-boundary} is used.
27080 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27081 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27082 suffer significant run time performance penalties.  On Pentium III, the
27083 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27084 properly if it is not 16-byte aligned.
27086 To ensure proper alignment of this values on the stack, the stack boundary
27087 must be as aligned as that required by any value stored on the stack.
27088 Further, every function must be generated such that it keeps the stack
27089 aligned.  Thus calling a function compiled with a higher preferred
27090 stack boundary from a function compiled with a lower preferred stack
27091 boundary most likely misaligns the stack.  It is recommended that
27092 libraries that use callbacks always use the default setting.
27094 This extra alignment does consume extra stack space, and generally
27095 increases code size.  Code that is sensitive to stack space usage, such
27096 as embedded systems and operating system kernels, may want to reduce the
27097 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27099 @need 200
27100 @item -mmmx
27101 @opindex mmmx
27102 @need 200
27103 @itemx -msse
27104 @opindex msse
27105 @need 200
27106 @itemx -msse2
27107 @opindex msse2
27108 @need 200
27109 @itemx -msse3
27110 @opindex msse3
27111 @need 200
27112 @itemx -mssse3
27113 @opindex mssse3
27114 @need 200
27115 @itemx -msse4
27116 @opindex msse4
27117 @need 200
27118 @itemx -msse4a
27119 @opindex msse4a
27120 @need 200
27121 @itemx -msse4.1
27122 @opindex msse4.1
27123 @need 200
27124 @itemx -msse4.2
27125 @opindex msse4.2
27126 @need 200
27127 @itemx -mavx
27128 @opindex mavx
27129 @need 200
27130 @itemx -mavx2
27131 @opindex mavx2
27132 @need 200
27133 @itemx -mavx512f
27134 @opindex mavx512f
27135 @need 200
27136 @itemx -mavx512pf
27137 @opindex mavx512pf
27138 @need 200
27139 @itemx -mavx512er
27140 @opindex mavx512er
27141 @need 200
27142 @itemx -mavx512cd
27143 @opindex mavx512cd
27144 @need 200
27145 @itemx -mavx512vl
27146 @opindex mavx512vl
27147 @need 200
27148 @itemx -mavx512bw
27149 @opindex mavx512bw
27150 @need 200
27151 @itemx -mavx512dq
27152 @opindex mavx512dq
27153 @need 200
27154 @itemx -mavx512ifma
27155 @opindex mavx512ifma
27156 @need 200
27157 @itemx -mavx512vbmi
27158 @opindex mavx512vbmi
27159 @need 200
27160 @itemx -msha
27161 @opindex msha
27162 @need 200
27163 @itemx -maes
27164 @opindex maes
27165 @need 200
27166 @itemx -mpclmul
27167 @opindex mpclmul
27168 @need 200
27169 @itemx -mclfushopt
27170 @opindex mclfushopt
27171 @need 200
27172 @itemx -mfsgsbase
27173 @opindex mfsgsbase
27174 @need 200
27175 @itemx -mrdrnd
27176 @opindex mrdrnd
27177 @need 200
27178 @itemx -mf16c
27179 @opindex mf16c
27180 @need 200
27181 @itemx -mfma
27182 @opindex mfma
27183 @need 200
27184 @itemx -mpconfig
27185 @opindex mpconfig
27186 @need 200
27187 @itemx -mwbnoinvd
27188 @opindex mwbnoinvd
27189 @need 200
27190 @itemx -mfma4
27191 @opindex mfma4
27192 @need 200
27193 @itemx -mprefetchwt1
27194 @opindex mprefetchwt1
27195 @need 200
27196 @itemx -mxop
27197 @opindex mxop
27198 @need 200
27199 @itemx -mlwp
27200 @opindex mlwp
27201 @need 200
27202 @itemx -m3dnow
27203 @opindex m3dnow
27204 @need 200
27205 @itemx -m3dnowa
27206 @opindex m3dnowa
27207 @need 200
27208 @itemx -mpopcnt
27209 @opindex mpopcnt
27210 @need 200
27211 @itemx -mabm
27212 @opindex mabm
27213 @need 200
27214 @itemx -mbmi
27215 @opindex mbmi
27216 @need 200
27217 @itemx -mbmi2
27218 @need 200
27219 @itemx -mlzcnt
27220 @opindex mlzcnt
27221 @need 200
27222 @itemx -mfxsr
27223 @opindex mfxsr
27224 @need 200
27225 @itemx -mxsave
27226 @opindex mxsave
27227 @need 200
27228 @itemx -mxsaveopt
27229 @opindex mxsaveopt
27230 @need 200
27231 @itemx -mxsavec
27232 @opindex mxsavec
27233 @need 200
27234 @itemx -mxsaves
27235 @opindex mxsaves
27236 @need 200
27237 @itemx -mrtm
27238 @opindex mrtm
27239 @need 200
27240 @itemx -mtbm
27241 @opindex mtbm
27242 @need 200
27243 @itemx -mmpx
27244 @opindex mmpx
27245 @need 200
27246 @itemx -mmwaitx
27247 @opindex mmwaitx
27248 @need 200
27249 @itemx -mclzero
27250 @opindex mclzero
27251 @need 200
27252 @itemx -mpku
27253 @opindex mpku
27254 @need 200
27255 @itemx -mcet
27256 @opindex mcet
27257 @need 200
27258 @itemx -mavx512vbmi2
27259 @opindex mavx512vbmi2
27260 @need 200
27261 @itemx -mgfni
27262 @opindex mgfni
27263 @need 200
27264 @itemx -mvaes
27265 @opindex mvaes
27266 @need 200
27267 @itemx -mvpclmulqdq
27268 @opindex mvpclmulqdq
27269 @need 200
27270 @itemx -mavx512bitalg
27271 @opindex mavx512bitalg
27272 @need 200
27273 @itemx -mavx512vpopcntdq
27274 @opindex mavx512vpopcntdq
27275 These switches enable the use of instructions in the MMX, SSE,
27276 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27277 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27278 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
27279 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27280 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
27281 extended instruction sets.
27282 Each has a corresponding @option{-mno-} option to disable use of these
27283 instructions.
27285 These extensions are also available as built-in functions: see
27286 @ref{x86 Built-in Functions}, for details of the functions enabled and
27287 disabled by these switches.
27289 To generate SSE/SSE2 instructions automatically from floating-point
27290 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27292 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27293 generates new AVX instructions or AVX equivalence for all SSEx instructions
27294 when needed.
27296 These options enable GCC to use these extended instructions in
27297 generated code, even without @option{-mfpmath=sse}.  Applications that
27298 perform run-time CPU detection must compile separate files for each
27299 supported architecture, using the appropriate flags.  In particular,
27300 the file containing the CPU detection code should be compiled without
27301 these options.
27303 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
27304 options.  The @option{-mibt} option enables indirect branch tracking support
27305 and the @option{-mshstk} option enables shadow stack support from
27306 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
27307 a number of built-in functions for fine-grained control in a CET-based
27308 application.  See @xref{x86 Built-in Functions}, for more information.
27310 @item -mdump-tune-features
27311 @opindex mdump-tune-features
27312 This option instructs GCC to dump the names of the x86 performance 
27313 tuning features and default settings. The names can be used in 
27314 @option{-mtune-ctrl=@var{feature-list}}.
27316 @item -mtune-ctrl=@var{feature-list}
27317 @opindex mtune-ctrl=@var{feature-list}
27318 This option is used to do fine grain control of x86 code generation features.
27319 @var{feature-list} is a comma separated list of @var{feature} names. See also
27320 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27321 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27322 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27323 developers. Using it may lead to code paths not covered by testing and can
27324 potentially result in compiler ICEs or runtime errors.
27326 @item -mno-default
27327 @opindex mno-default
27328 This option instructs GCC to turn off all tunable features. See also 
27329 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27331 @item -mcld
27332 @opindex mcld
27333 This option instructs GCC to emit a @code{cld} instruction in the prologue
27334 of functions that use string instructions.  String instructions depend on
27335 the DF flag to select between autoincrement or autodecrement mode.  While the
27336 ABI specifies the DF flag to be cleared on function entry, some operating
27337 systems violate this specification by not clearing the DF flag in their
27338 exception dispatchers.  The exception handler can be invoked with the DF flag
27339 set, which leads to wrong direction mode when string instructions are used.
27340 This option can be enabled by default on 32-bit x86 targets by configuring
27341 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27342 instructions can be suppressed with the @option{-mno-cld} compiler option
27343 in this case.
27345 @item -mvzeroupper
27346 @opindex mvzeroupper
27347 This option instructs GCC to emit a @code{vzeroupper} instruction
27348 before a transfer of control flow out of the function to minimize
27349 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27350 intrinsics.
27352 @item -mprefer-avx128
27353 @opindex mprefer-avx128
27354 This option instructs GCC to use 128-bit AVX instructions instead of
27355 256-bit AVX instructions in the auto-vectorizer.
27357 @item -mprefer-vector-width=@var{opt}
27358 @opindex mprefer-vector-width
27359 This option instructs GCC to use @var{opt}-bit vector width in instructions
27360 instead of default on the selected platform.
27362 @table @samp
27363 @item none
27364 No extra limitations applied to GCC other than defined by the selected platform.
27366 @item 128
27367 Prefer 128-bit vector width for instructions.
27369 @item 256
27370 Prefer 256-bit vector width for instructions.
27372 @item 512
27373 Prefer 512-bit vector width for instructions.
27374 @end table
27376 @item -mcx16
27377 @opindex mcx16
27378 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27379 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27380 objects.  This is useful for atomic updates of data structures exceeding one
27381 machine word in size.  The compiler uses this instruction to implement
27382 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27383 128-bit integers, a library call is always used.
27385 @item -msahf
27386 @opindex msahf
27387 This option enables generation of @code{SAHF} instructions in 64-bit code.
27388 Early Intel Pentium 4 CPUs with Intel 64 support,
27389 prior to the introduction of Pentium 4 G1 step in December 2005,
27390 lacked the @code{LAHF} and @code{SAHF} instructions
27391 which are supported by AMD64.
27392 These are load and store instructions, respectively, for certain status flags.
27393 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27394 @code{drem}, and @code{remainder} built-in functions;
27395 see @ref{Other Builtins} for details.
27397 @item -mmovbe
27398 @opindex mmovbe
27399 This option enables use of the @code{movbe} instruction to implement
27400 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27402 @item -mibt
27403 @opindex mibt
27404 This option tells the compiler to use indirect branch tracking support
27405 (for indirect calls and jumps) from x86 Control-flow Enforcement
27406 Technology (CET).  The option has effect only if the
27407 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
27408 is specified. The option @option{-mibt} is on by default when the
27409 @code{-mcet} option is specified.
27411 @item -mshstk
27412 @opindex mshstk
27413 This option tells the compiler to use shadow stack support (return
27414 address tracking) from x86 Control-flow Enforcement Technology (CET).
27415 The option has effect only if the @option{-fcf-protection=full} or
27416 @option{-fcf-protection=return} option is specified.  The option
27417 @option{-mshstk} is on by default when the @option{-mcet} option is
27418 specified.
27420 @item -mcrc32
27421 @opindex mcrc32
27422 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27423 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27424 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27426 @item -mrecip
27427 @opindex mrecip
27428 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27429 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27430 with an additional Newton-Raphson step
27431 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27432 (and their vectorized
27433 variants) for single-precision floating-point arguments.  These instructions
27434 are generated only when @option{-funsafe-math-optimizations} is enabled
27435 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27436 Note that while the throughput of the sequence is higher than the throughput
27437 of the non-reciprocal instruction, the precision of the sequence can be
27438 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27440 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27441 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27442 combination), and doesn't need @option{-mrecip}.
27444 Also note that GCC emits the above sequence with additional Newton-Raphson step
27445 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27446 already with @option{-ffast-math} (or the above option combination), and
27447 doesn't need @option{-mrecip}.
27449 @item -mrecip=@var{opt}
27450 @opindex mrecip=opt
27451 This option controls which reciprocal estimate instructions
27452 may be used.  @var{opt} is a comma-separated list of options, which may
27453 be preceded by a @samp{!} to invert the option:
27455 @table @samp
27456 @item all
27457 Enable all estimate instructions.
27459 @item default
27460 Enable the default instructions, equivalent to @option{-mrecip}.
27462 @item none
27463 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27465 @item div
27466 Enable the approximation for scalar division.
27468 @item vec-div
27469 Enable the approximation for vectorized division.
27471 @item sqrt
27472 Enable the approximation for scalar square root.
27474 @item vec-sqrt
27475 Enable the approximation for vectorized square root.
27476 @end table
27478 So, for example, @option{-mrecip=all,!sqrt} enables
27479 all of the reciprocal approximations, except for square root.
27481 @item -mveclibabi=@var{type}
27482 @opindex mveclibabi
27483 Specifies the ABI type to use for vectorizing intrinsics using an
27484 external library.  Supported values for @var{type} are @samp{svml} 
27485 for the Intel short
27486 vector math library and @samp{acml} for the AMD math core library.
27487 To use this option, both @option{-ftree-vectorize} and
27488 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27489 ABI-compatible library must be specified at link time.
27491 GCC currently emits calls to @code{vmldExp2},
27492 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27493 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27494 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27495 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27496 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27497 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27498 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27499 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27500 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27501 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27502 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27503 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27504 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27505 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27506 when @option{-mveclibabi=acml} is used.  
27508 @item -mabi=@var{name}
27509 @opindex mabi
27510 Generate code for the specified calling convention.  Permissible values
27511 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27512 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27513 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27514 You can control this behavior for specific functions by
27515 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27516 @xref{Function Attributes}.
27518 @item -mforce-indirect-call
27519 @opindex mforce-indirect-call
27520 Force all calls to functions to be indirect. This is useful
27521 when using Intel Processor Trace where it generates more precise timing
27522 information for function calls.
27524 @item -mcall-ms2sysv-xlogues
27525 @opindex mcall-ms2sysv-xlogues
27526 @opindex mno-call-ms2sysv-xlogues
27527 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27528 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27529 default, the code for saving and restoring these registers is emitted inline,
27530 resulting in fairly lengthy prologues and epilogues.  Using
27531 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27532 use stubs in the static portion of libgcc to perform these saves and restores,
27533 thus reducing function size at the cost of a few extra instructions.
27535 @item -mtls-dialect=@var{type}
27536 @opindex mtls-dialect
27537 Generate code to access thread-local storage using the @samp{gnu} or
27538 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27539 @samp{gnu2} is more efficient, but it may add compile- and run-time
27540 requirements that cannot be satisfied on all systems.
27542 @item -mpush-args
27543 @itemx -mno-push-args
27544 @opindex mpush-args
27545 @opindex mno-push-args
27546 Use PUSH operations to store outgoing parameters.  This method is shorter
27547 and usually equally fast as method using SUB/MOV operations and is enabled
27548 by default.  In some cases disabling it may improve performance because of
27549 improved scheduling and reduced dependencies.
27551 @item -maccumulate-outgoing-args
27552 @opindex maccumulate-outgoing-args
27553 If enabled, the maximum amount of space required for outgoing arguments is
27554 computed in the function prologue.  This is faster on most modern CPUs
27555 because of reduced dependencies, improved scheduling and reduced stack usage
27556 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27557 increase in code size.  This switch implies @option{-mno-push-args}.
27559 @item -mthreads
27560 @opindex mthreads
27561 Support thread-safe exception handling on MinGW.  Programs that rely
27562 on thread-safe exception handling must compile and link all code with the
27563 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27564 @option{-D_MT}; when linking, it links in a special thread helper library
27565 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27567 @item -mms-bitfields
27568 @itemx -mno-ms-bitfields
27569 @opindex mms-bitfields
27570 @opindex mno-ms-bitfields
27572 Enable/disable bit-field layout compatible with the native Microsoft
27573 Windows compiler.  
27575 If @code{packed} is used on a structure, or if bit-fields are used,
27576 it may be that the Microsoft ABI lays out the structure differently
27577 than the way GCC normally does.  Particularly when moving packed
27578 data between functions compiled with GCC and the native Microsoft compiler
27579 (either via function call or as data in a file), it may be necessary to access
27580 either format.
27582 This option is enabled by default for Microsoft Windows
27583 targets.  This behavior can also be controlled locally by use of variable
27584 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27585 and @ref{x86 Type Attributes}.
27587 The Microsoft structure layout algorithm is fairly simple with the exception
27588 of the bit-field packing.  
27589 The padding and alignment of members of structures and whether a bit-field 
27590 can straddle a storage-unit boundary are determine by these rules:
27592 @enumerate
27593 @item Structure members are stored sequentially in the order in which they are
27594 declared: the first member has the lowest memory address and the last member
27595 the highest.
27597 @item Every data object has an alignment requirement.  The alignment requirement
27598 for all data except structures, unions, and arrays is either the size of the
27599 object or the current packing size (specified with either the
27600 @code{aligned} attribute or the @code{pack} pragma),
27601 whichever is less.  For structures, unions, and arrays,
27602 the alignment requirement is the largest alignment requirement of its members.
27603 Every object is allocated an offset so that:
27605 @smallexample
27606 offset % alignment_requirement == 0
27607 @end smallexample
27609 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27610 unit if the integral types are the same size and if the next bit-field fits
27611 into the current allocation unit without crossing the boundary imposed by the
27612 common alignment requirements of the bit-fields.
27613 @end enumerate
27615 MSVC interprets zero-length bit-fields in the following ways:
27617 @enumerate
27618 @item If a zero-length bit-field is inserted between two bit-fields that
27619 are normally coalesced, the bit-fields are not coalesced.
27621 For example:
27623 @smallexample
27624 struct
27625  @{
27626    unsigned long bf_1 : 12;
27627    unsigned long : 0;
27628    unsigned long bf_2 : 12;
27629  @} t1;
27630 @end smallexample
27632 @noindent
27633 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27634 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27636 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27637 alignment of the zero-length bit-field is greater than the member that follows it,
27638 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27640 For example:
27642 @smallexample
27643 struct
27644  @{
27645    char foo : 4;
27646    short : 0;
27647    char bar;
27648  @} t2;
27650 struct
27651  @{
27652    char foo : 4;
27653    short : 0;
27654    double bar;
27655  @} t3;
27656 @end smallexample
27658 @noindent
27659 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27660 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27661 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27662 of the structure.
27664 Taking this into account, it is important to note the following:
27666 @enumerate
27667 @item If a zero-length bit-field follows a normal bit-field, the type of the
27668 zero-length bit-field may affect the alignment of the structure as whole. For
27669 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27670 normal bit-field, and is of type short.
27672 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27673 still affect the alignment of the structure:
27675 @smallexample
27676 struct
27677  @{
27678    char foo : 6;
27679    long : 0;
27680  @} t4;
27681 @end smallexample
27683 @noindent
27684 Here, @code{t4} takes up 4 bytes.
27685 @end enumerate
27687 @item Zero-length bit-fields following non-bit-field members are ignored:
27689 @smallexample
27690 struct
27691  @{
27692    char foo;
27693    long : 0;
27694    char bar;
27695  @} t5;
27696 @end smallexample
27698 @noindent
27699 Here, @code{t5} takes up 2 bytes.
27700 @end enumerate
27703 @item -mno-align-stringops
27704 @opindex mno-align-stringops
27705 Do not align the destination of inlined string operations.  This switch reduces
27706 code size and improves performance in case the destination is already aligned,
27707 but GCC doesn't know about it.
27709 @item -minline-all-stringops
27710 @opindex minline-all-stringops
27711 By default GCC inlines string operations only when the destination is 
27712 known to be aligned to least a 4-byte boundary.  
27713 This enables more inlining and increases code
27714 size, but may improve performance of code that depends on fast
27715 @code{memcpy}, @code{strlen},
27716 and @code{memset} for short lengths.
27718 @item -minline-stringops-dynamically
27719 @opindex minline-stringops-dynamically
27720 For string operations of unknown size, use run-time checks with
27721 inline code for small blocks and a library call for large blocks.
27723 @item -mstringop-strategy=@var{alg}
27724 @opindex mstringop-strategy=@var{alg}
27725 Override the internal decision heuristic for the particular algorithm to use
27726 for inlining string operations.  The allowed values for @var{alg} are:
27728 @table @samp
27729 @item rep_byte
27730 @itemx rep_4byte
27731 @itemx rep_8byte
27732 Expand using i386 @code{rep} prefix of the specified size.
27734 @item byte_loop
27735 @itemx loop
27736 @itemx unrolled_loop
27737 Expand into an inline loop.
27739 @item libcall
27740 Always use a library call.
27741 @end table
27743 @item -mmemcpy-strategy=@var{strategy}
27744 @opindex mmemcpy-strategy=@var{strategy}
27745 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27746 should be inlined and what inline algorithm to use when the expected size
27747 of the copy operation is known. @var{strategy} 
27748 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27749 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27750 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27751 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27752 in the list must be specified in increasing order.  The minimal byte size for 
27753 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27754 preceding range.
27756 @item -mmemset-strategy=@var{strategy}
27757 @opindex mmemset-strategy=@var{strategy}
27758 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27759 @code{__builtin_memset} expansion.
27761 @item -momit-leaf-frame-pointer
27762 @opindex momit-leaf-frame-pointer
27763 Don't keep the frame pointer in a register for leaf functions.  This
27764 avoids the instructions to save, set up, and restore frame pointers and
27765 makes an extra register available in leaf functions.  The option
27766 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27767 which might make debugging harder.
27769 @item -mtls-direct-seg-refs
27770 @itemx -mno-tls-direct-seg-refs
27771 @opindex mtls-direct-seg-refs
27772 Controls whether TLS variables may be accessed with offsets from the
27773 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27774 or whether the thread base pointer must be added.  Whether or not this
27775 is valid depends on the operating system, and whether it maps the
27776 segment to cover the entire TLS area.
27778 For systems that use the GNU C Library, the default is on.
27780 @item -msse2avx
27781 @itemx -mno-sse2avx
27782 @opindex msse2avx
27783 Specify that the assembler should encode SSE instructions with VEX
27784 prefix.  The option @option{-mavx} turns this on by default.
27786 @item -mfentry
27787 @itemx -mno-fentry
27788 @opindex mfentry
27789 If profiling is active (@option{-pg}), put the profiling
27790 counter call before the prologue.
27791 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27792 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27794 @item -mrecord-mcount
27795 @itemx -mno-record-mcount
27796 @opindex mrecord-mcount
27797 If profiling is active (@option{-pg}), generate a __mcount_loc section
27798 that contains pointers to each profiling call. This is useful for
27799 automatically patching and out calls.
27801 @item -mnop-mcount
27802 @itemx -mno-nop-mcount
27803 @opindex mnop-mcount
27804 If profiling is active (@option{-pg}), generate the calls to
27805 the profiling functions as NOPs. This is useful when they
27806 should be patched in later dynamically. This is likely only
27807 useful together with @option{-mrecord-mcount}.
27809 @item -mskip-rax-setup
27810 @itemx -mno-skip-rax-setup
27811 @opindex mskip-rax-setup
27812 When generating code for the x86-64 architecture with SSE extensions
27813 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27814 register when there are no variable arguments passed in vector registers.
27816 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27817 saving vector registers on stack when passing variable arguments, the
27818 impacts of this option are callees may waste some stack space,
27819 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27820 those issues, regardless the RAX register value.
27822 @item -m8bit-idiv
27823 @itemx -mno-8bit-idiv
27824 @opindex m8bit-idiv
27825 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27826 much faster than 32-bit/64-bit integer divide.  This option generates a
27827 run-time check.  If both dividend and divisor are within range of 0
27828 to 255, 8-bit unsigned integer divide is used instead of
27829 32-bit/64-bit integer divide.
27831 @item -mavx256-split-unaligned-load
27832 @itemx -mavx256-split-unaligned-store
27833 @opindex mavx256-split-unaligned-load
27834 @opindex mavx256-split-unaligned-store
27835 Split 32-byte AVX unaligned load and store.
27837 @item -mstack-protector-guard=@var{guard}
27838 @itemx -mstack-protector-guard-reg=@var{reg}
27839 @itemx -mstack-protector-guard-offset=@var{offset}
27840 @opindex mstack-protector-guard
27841 @opindex mstack-protector-guard-reg
27842 @opindex mstack-protector-guard-offset
27843 Generate stack protection code using canary at @var{guard}.  Supported
27844 locations are @samp{global} for global canary or @samp{tls} for per-thread
27845 canary in the TLS block (the default).  This option has effect only when
27846 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27848 With the latter choice the options
27849 @option{-mstack-protector-guard-reg=@var{reg}} and
27850 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27851 which segment register (@code{%fs} or @code{%gs}) to use as base register
27852 for reading the canary, and from what offset from that base register.
27853 The default for those is as specified in the relevant ABI.
27855 @item -mmitigate-rop
27856 @opindex mmitigate-rop
27857 Try to avoid generating code sequences that contain unintended return
27858 opcodes, to mitigate against certain forms of attack. At the moment,
27859 this option is limited in what it can do and should not be relied
27860 on to provide serious protection.
27862 @item -mgeneral-regs-only
27863 @opindex mgeneral-regs-only
27864 Generate code that uses only the general-purpose registers.  This
27865 prevents the compiler from using floating-point, vector, mask and bound
27866 registers.
27868 @item -mindirect-branch=@var{choice}
27869 @opindex -mindirect-branch
27870 Convert indirect call and jump with @var{choice}.  The default is
27871 @samp{keep}, which keeps indirect call and jump unmodified.
27872 @samp{thunk} converts indirect call and jump to call and return thunk.
27873 @samp{thunk-inline} converts indirect call and jump to inlined call
27874 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27875 to external call and return thunk provided in a separate object file.
27876 You can control this behavior for a specific function by using the
27877 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27879 Note that @option{-mcmodel=large} is incompatible with
27880 @option{-mindirect-branch=thunk} nor
27881 @option{-mindirect-branch=thunk-extern} since the thunk function may
27882 not be reachable in large code model.
27884 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27885 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27886 since the external thunk can not be modified to disable control-flow
27887 check.
27889 @item -mfunction-return=@var{choice}
27890 @opindex -mfunction-return
27891 Convert function return with @var{choice}.  The default is @samp{keep},
27892 which keeps function return unmodified.  @samp{thunk} converts function
27893 return to call and return thunk.  @samp{thunk-inline} converts function
27894 return to inlined call and return thunk.  @samp{thunk-extern} converts
27895 function return to external call and return thunk provided in a separate
27896 object file.  You can control this behavior for a specific function by
27897 using the function attribute @code{function_return}.
27898 @xref{Function Attributes}.
27900 Note that @option{-mcmodel=large} is incompatible with
27901 @option{-mfunction-return=thunk} nor
27902 @option{-mfunction-return=thunk-extern} since the thunk function may
27903 not be reachable in large code model.
27906 @item -mindirect-branch-register
27907 @opindex -mindirect-branch-register
27908 Force indirect call and jump via register.
27910 @end table
27912 These @samp{-m} switches are supported in addition to the above
27913 on x86-64 processors in 64-bit environments.
27915 @table @gcctabopt
27916 @item -m32
27917 @itemx -m64
27918 @itemx -mx32
27919 @itemx -m16
27920 @itemx -miamcu
27921 @opindex m32
27922 @opindex m64
27923 @opindex mx32
27924 @opindex m16
27925 @opindex miamcu
27926 Generate code for a 16-bit, 32-bit or 64-bit environment.
27927 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27928 to 32 bits, and
27929 generates code that runs on any i386 system.
27931 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27932 types to 64 bits, and generates code for the x86-64 architecture.
27933 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27934 and @option{-mdynamic-no-pic} options.
27936 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27937 to 32 bits, and
27938 generates code for the x86-64 architecture.
27940 The @option{-m16} option is the same as @option{-m32}, except for that
27941 it outputs the @code{.code16gcc} assembly directive at the beginning of
27942 the assembly output so that the binary can run in 16-bit mode.
27944 The @option{-miamcu} option generates code which conforms to Intel MCU
27945 psABI.  It requires the @option{-m32} option to be turned on.
27947 @item -mno-red-zone
27948 @opindex mno-red-zone
27949 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27950 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27951 stack pointer that is not modified by signal or interrupt handlers
27952 and therefore can be used for temporary data without adjusting the stack
27953 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27955 @item -mcmodel=small
27956 @opindex mcmodel=small
27957 Generate code for the small code model: the program and its symbols must
27958 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27959 Programs can be statically or dynamically linked.  This is the default
27960 code model.
27962 @item -mcmodel=kernel
27963 @opindex mcmodel=kernel
27964 Generate code for the kernel code model.  The kernel runs in the
27965 negative 2 GB of the address space.
27966 This model has to be used for Linux kernel code.
27968 @item -mcmodel=medium
27969 @opindex mcmodel=medium
27970 Generate code for the medium model: the program is linked in the lower 2
27971 GB of the address space.  Small symbols are also placed there.  Symbols
27972 with sizes larger than @option{-mlarge-data-threshold} are put into
27973 large data or BSS sections and can be located above 2GB.  Programs can
27974 be statically or dynamically linked.
27976 @item -mcmodel=large
27977 @opindex mcmodel=large
27978 Generate code for the large model.  This model makes no assumptions
27979 about addresses and sizes of sections.
27981 @item -maddress-mode=long
27982 @opindex maddress-mode=long
27983 Generate code for long address mode.  This is only supported for 64-bit
27984 and x32 environments.  It is the default address mode for 64-bit
27985 environments.
27987 @item -maddress-mode=short
27988 @opindex maddress-mode=short
27989 Generate code for short address mode.  This is only supported for 32-bit
27990 and x32 environments.  It is the default address mode for 32-bit and
27991 x32 environments.
27992 @end table
27994 @node x86 Windows Options
27995 @subsection x86 Windows Options
27996 @cindex x86 Windows Options
27997 @cindex Windows Options for x86
27999 These additional options are available for Microsoft Windows targets:
28001 @table @gcctabopt
28002 @item -mconsole
28003 @opindex mconsole
28004 This option
28005 specifies that a console application is to be generated, by
28006 instructing the linker to set the PE header subsystem type
28007 required for console applications.
28008 This option is available for Cygwin and MinGW targets and is
28009 enabled by default on those targets.
28011 @item -mdll
28012 @opindex mdll
28013 This option is available for Cygwin and MinGW targets.  It
28014 specifies that a DLL---a dynamic link library---is to be
28015 generated, enabling the selection of the required runtime
28016 startup object and entry point.
28018 @item -mnop-fun-dllimport
28019 @opindex mnop-fun-dllimport
28020 This option is available for Cygwin and MinGW targets.  It
28021 specifies that the @code{dllimport} attribute should be ignored.
28023 @item -mthread
28024 @opindex mthread
28025 This option is available for MinGW targets. It specifies
28026 that MinGW-specific thread support is to be used.
28028 @item -municode
28029 @opindex municode
28030 This option is available for MinGW-w64 targets.  It causes
28031 the @code{UNICODE} preprocessor macro to be predefined, and
28032 chooses Unicode-capable runtime startup code.
28034 @item -mwin32
28035 @opindex mwin32
28036 This option is available for Cygwin and MinGW targets.  It
28037 specifies that the typical Microsoft Windows predefined macros are to
28038 be set in the pre-processor, but does not influence the choice
28039 of runtime library/startup code.
28041 @item -mwindows
28042 @opindex mwindows
28043 This option is available for Cygwin and MinGW targets.  It
28044 specifies that a GUI application is to be generated by
28045 instructing the linker to set the PE header subsystem type
28046 appropriately.
28048 @item -fno-set-stack-executable
28049 @opindex fno-set-stack-executable
28050 This option is available for MinGW targets. It specifies that
28051 the executable flag for the stack used by nested functions isn't
28052 set. This is necessary for binaries running in kernel mode of
28053 Microsoft Windows, as there the User32 API, which is used to set executable
28054 privileges, isn't available.
28056 @item -fwritable-relocated-rdata
28057 @opindex fno-writable-relocated-rdata
28058 This option is available for MinGW and Cygwin targets.  It specifies
28059 that relocated-data in read-only section is put into the @code{.data}
28060 section.  This is a necessary for older runtimes not supporting
28061 modification of @code{.rdata} sections for pseudo-relocation.
28063 @item -mpe-aligned-commons
28064 @opindex mpe-aligned-commons
28065 This option is available for Cygwin and MinGW targets.  It
28066 specifies that the GNU extension to the PE file format that
28067 permits the correct alignment of COMMON variables should be
28068 used when generating code.  It is enabled by default if
28069 GCC detects that the target assembler found during configuration
28070 supports the feature.
28071 @end table
28073 See also under @ref{x86 Options} for standard options.
28075 @node Xstormy16 Options
28076 @subsection Xstormy16 Options
28077 @cindex Xstormy16 Options
28079 These options are defined for Xstormy16:
28081 @table @gcctabopt
28082 @item -msim
28083 @opindex msim
28084 Choose startup files and linker script suitable for the simulator.
28085 @end table
28087 @node Xtensa Options
28088 @subsection Xtensa Options
28089 @cindex Xtensa Options
28091 These options are supported for Xtensa targets:
28093 @table @gcctabopt
28094 @item -mconst16
28095 @itemx -mno-const16
28096 @opindex mconst16
28097 @opindex mno-const16
28098 Enable or disable use of @code{CONST16} instructions for loading
28099 constant values.  The @code{CONST16} instruction is currently not a
28100 standard option from Tensilica.  When enabled, @code{CONST16}
28101 instructions are always used in place of the standard @code{L32R}
28102 instructions.  The use of @code{CONST16} is enabled by default only if
28103 the @code{L32R} instruction is not available.
28105 @item -mfused-madd
28106 @itemx -mno-fused-madd
28107 @opindex mfused-madd
28108 @opindex mno-fused-madd
28109 Enable or disable use of fused multiply/add and multiply/subtract
28110 instructions in the floating-point option.  This has no effect if the
28111 floating-point option is not also enabled.  Disabling fused multiply/add
28112 and multiply/subtract instructions forces the compiler to use separate
28113 instructions for the multiply and add/subtract operations.  This may be
28114 desirable in some cases where strict IEEE 754-compliant results are
28115 required: the fused multiply add/subtract instructions do not round the
28116 intermediate result, thereby producing results with @emph{more} bits of
28117 precision than specified by the IEEE standard.  Disabling fused multiply
28118 add/subtract instructions also ensures that the program output is not
28119 sensitive to the compiler's ability to combine multiply and add/subtract
28120 operations.
28122 @item -mserialize-volatile
28123 @itemx -mno-serialize-volatile
28124 @opindex mserialize-volatile
28125 @opindex mno-serialize-volatile
28126 When this option is enabled, GCC inserts @code{MEMW} instructions before
28127 @code{volatile} memory references to guarantee sequential consistency.
28128 The default is @option{-mserialize-volatile}.  Use
28129 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28131 @item -mforce-no-pic
28132 @opindex mforce-no-pic
28133 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28134 position-independent code (PIC), this option disables PIC for compiling
28135 kernel code.
28137 @item -mtext-section-literals
28138 @itemx -mno-text-section-literals
28139 @opindex mtext-section-literals
28140 @opindex mno-text-section-literals
28141 These options control the treatment of literal pools.  The default is
28142 @option{-mno-text-section-literals}, which places literals in a separate
28143 section in the output file.  This allows the literal pool to be placed
28144 in a data RAM/ROM, and it also allows the linker to combine literal
28145 pools from separate object files to remove redundant literals and
28146 improve code size.  With @option{-mtext-section-literals}, the literals
28147 are interspersed in the text section in order to keep them as close as
28148 possible to their references.  This may be necessary for large assembly
28149 files.  Literals for each function are placed right before that function.
28151 @item -mauto-litpools
28152 @itemx -mno-auto-litpools
28153 @opindex mauto-litpools
28154 @opindex mno-auto-litpools
28155 These options control the treatment of literal pools.  The default is
28156 @option{-mno-auto-litpools}, which places literals in a separate
28157 section in the output file unless @option{-mtext-section-literals} is
28158 used.  With @option{-mauto-litpools} the literals are interspersed in
28159 the text section by the assembler.  Compiler does not produce explicit
28160 @code{.literal} directives and loads literals into registers with
28161 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28162 do relaxation and place literals as necessary.  This option allows
28163 assembler to create several literal pools per function and assemble
28164 very big functions, which may not be possible with
28165 @option{-mtext-section-literals}.
28167 @item -mtarget-align
28168 @itemx -mno-target-align
28169 @opindex mtarget-align
28170 @opindex mno-target-align
28171 When this option is enabled, GCC instructs the assembler to
28172 automatically align instructions to reduce branch penalties at the
28173 expense of some code density.  The assembler attempts to widen density
28174 instructions to align branch targets and the instructions following call
28175 instructions.  If there are not enough preceding safe density
28176 instructions to align a target, no widening is performed.  The
28177 default is @option{-mtarget-align}.  These options do not affect the
28178 treatment of auto-aligned instructions like @code{LOOP}, which the
28179 assembler always aligns, either by widening density instructions or
28180 by inserting NOP instructions.
28182 @item -mlongcalls
28183 @itemx -mno-longcalls
28184 @opindex mlongcalls
28185 @opindex mno-longcalls
28186 When this option is enabled, GCC instructs the assembler to translate
28187 direct calls to indirect calls unless it can determine that the target
28188 of a direct call is in the range allowed by the call instruction.  This
28189 translation typically occurs for calls to functions in other source
28190 files.  Specifically, the assembler translates a direct @code{CALL}
28191 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28192 The default is @option{-mno-longcalls}.  This option should be used in
28193 programs where the call target can potentially be out of range.  This
28194 option is implemented in the assembler, not the compiler, so the
28195 assembly code generated by GCC still shows direct call
28196 instructions---look at the disassembled object code to see the actual
28197 instructions.  Note that the assembler uses an indirect call for
28198 every cross-file call, not just those that really are out of range.
28199 @end table
28201 @node zSeries Options
28202 @subsection zSeries Options
28203 @cindex zSeries options
28205 These are listed under @xref{S/390 and zSeries Options}.
28208 @c man end
28210 @node Spec Files
28211 @section Specifying Subprocesses and the Switches to Pass to Them
28212 @cindex Spec Files
28214 @command{gcc} is a driver program.  It performs its job by invoking a
28215 sequence of other programs to do the work of compiling, assembling and
28216 linking.  GCC interprets its command-line parameters and uses these to
28217 deduce which programs it should invoke, and which command-line options
28218 it ought to place on their command lines.  This behavior is controlled
28219 by @dfn{spec strings}.  In most cases there is one spec string for each
28220 program that GCC can invoke, but a few programs have multiple spec
28221 strings to control their behavior.  The spec strings built into GCC can
28222 be overridden by using the @option{-specs=} command-line switch to specify
28223 a spec file.
28225 @dfn{Spec files} are plain-text files that are used to construct spec
28226 strings.  They consist of a sequence of directives separated by blank
28227 lines.  The type of directive is determined by the first non-whitespace
28228 character on the line, which can be one of the following:
28230 @table @code
28231 @item %@var{command}
28232 Issues a @var{command} to the spec file processor.  The commands that can
28233 appear here are:
28235 @table @code
28236 @item %include <@var{file}>
28237 @cindex @code{%include}
28238 Search for @var{file} and insert its text at the current point in the
28239 specs file.
28241 @item %include_noerr <@var{file}>
28242 @cindex @code{%include_noerr}
28243 Just like @samp{%include}, but do not generate an error message if the include
28244 file cannot be found.
28246 @item %rename @var{old_name} @var{new_name}
28247 @cindex @code{%rename}
28248 Rename the spec string @var{old_name} to @var{new_name}.
28250 @end table
28252 @item *[@var{spec_name}]:
28253 This tells the compiler to create, override or delete the named spec
28254 string.  All lines after this directive up to the next directive or
28255 blank line are considered to be the text for the spec string.  If this
28256 results in an empty string then the spec is deleted.  (Or, if the
28257 spec did not exist, then nothing happens.)  Otherwise, if the spec
28258 does not currently exist a new spec is created.  If the spec does
28259 exist then its contents are overridden by the text of this
28260 directive, unless the first character of that text is the @samp{+}
28261 character, in which case the text is appended to the spec.
28263 @item [@var{suffix}]:
28264 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28265 and up to the next directive or blank line are considered to make up the
28266 spec string for the indicated suffix.  When the compiler encounters an
28267 input file with the named suffix, it processes the spec string in
28268 order to work out how to compile that file.  For example:
28270 @smallexample
28271 .ZZ:
28272 z-compile -input %i
28273 @end smallexample
28275 This says that any input file whose name ends in @samp{.ZZ} should be
28276 passed to the program @samp{z-compile}, which should be invoked with the
28277 command-line switch @option{-input} and with the result of performing the
28278 @samp{%i} substitution.  (See below.)
28280 As an alternative to providing a spec string, the text following a
28281 suffix directive can be one of the following:
28283 @table @code
28284 @item @@@var{language}
28285 This says that the suffix is an alias for a known @var{language}.  This is
28286 similar to using the @option{-x} command-line switch to GCC to specify a
28287 language explicitly.  For example:
28289 @smallexample
28290 .ZZ:
28291 @@c++
28292 @end smallexample
28294 Says that .ZZ files are, in fact, C++ source files.
28296 @item #@var{name}
28297 This causes an error messages saying:
28299 @smallexample
28300 @var{name} compiler not installed on this system.
28301 @end smallexample
28302 @end table
28304 GCC already has an extensive list of suffixes built into it.
28305 This directive adds an entry to the end of the list of suffixes, but
28306 since the list is searched from the end backwards, it is effectively
28307 possible to override earlier entries using this technique.
28309 @end table
28311 GCC has the following spec strings built into it.  Spec files can
28312 override these strings or create their own.  Note that individual
28313 targets can also add their own spec strings to this list.
28315 @smallexample
28316 asm          Options to pass to the assembler
28317 asm_final    Options to pass to the assembler post-processor
28318 cpp          Options to pass to the C preprocessor
28319 cc1          Options to pass to the C compiler
28320 cc1plus      Options to pass to the C++ compiler
28321 endfile      Object files to include at the end of the link
28322 link         Options to pass to the linker
28323 lib          Libraries to include on the command line to the linker
28324 libgcc       Decides which GCC support library to pass to the linker
28325 linker       Sets the name of the linker
28326 predefines   Defines to be passed to the C preprocessor
28327 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28328              by default
28329 startfile    Object files to include at the start of the link
28330 @end smallexample
28332 Here is a small example of a spec file:
28334 @smallexample
28335 %rename lib                 old_lib
28337 *lib:
28338 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28339 @end smallexample
28341 This example renames the spec called @samp{lib} to @samp{old_lib} and
28342 then overrides the previous definition of @samp{lib} with a new one.
28343 The new definition adds in some extra command-line options before
28344 including the text of the old definition.
28346 @dfn{Spec strings} are a list of command-line options to be passed to their
28347 corresponding program.  In addition, the spec strings can contain
28348 @samp{%}-prefixed sequences to substitute variable text or to
28349 conditionally insert text into the command line.  Using these constructs
28350 it is possible to generate quite complex command lines.
28352 Here is a table of all defined @samp{%}-sequences for spec
28353 strings.  Note that spaces are not generated automatically around the
28354 results of expanding these sequences.  Therefore you can concatenate them
28355 together or combine them with constant text in a single argument.
28357 @table @code
28358 @item %%
28359 Substitute one @samp{%} into the program name or argument.
28361 @item %i
28362 Substitute the name of the input file being processed.
28364 @item %b
28365 Substitute the basename of the input file being processed.
28366 This is the substring up to (and not including) the last period
28367 and not including the directory.
28369 @item %B
28370 This is the same as @samp{%b}, but include the file suffix (text after
28371 the last period).
28373 @item %d
28374 Marks the argument containing or following the @samp{%d} as a
28375 temporary file name, so that that file is deleted if GCC exits
28376 successfully.  Unlike @samp{%g}, this contributes no text to the
28377 argument.
28379 @item %g@var{suffix}
28380 Substitute a file name that has suffix @var{suffix} and is chosen
28381 once per compilation, and mark the argument in the same way as
28382 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28383 name is now chosen in a way that is hard to predict even when previously
28384 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28385 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28386 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28387 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28388 was simply substituted with a file name chosen once per compilation,
28389 without regard to any appended suffix (which was therefore treated
28390 just like ordinary text), making such attacks more likely to succeed.
28392 @item %u@var{suffix}
28393 Like @samp{%g}, but generates a new temporary file name
28394 each time it appears instead of once per compilation.
28396 @item %U@var{suffix}
28397 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28398 new one if there is no such last file name.  In the absence of any
28399 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28400 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28401 involves the generation of two distinct file names, one
28402 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28403 simply substituted with a file name chosen for the previous @samp{%u},
28404 without regard to any appended suffix.
28406 @item %j@var{suffix}
28407 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28408 writable, and if @option{-save-temps} is not used; 
28409 otherwise, substitute the name
28410 of a temporary file, just like @samp{%u}.  This temporary file is not
28411 meant for communication between processes, but rather as a junk
28412 disposal mechanism.
28414 @item %|@var{suffix}
28415 @itemx %m@var{suffix}
28416 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28417 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28418 all.  These are the two most common ways to instruct a program that it
28419 should read from standard input or write to standard output.  If you
28420 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28421 construct: see for example @file{f/lang-specs.h}.
28423 @item %.@var{SUFFIX}
28424 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28425 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28426 terminated by the next space or %.
28428 @item %w
28429 Marks the argument containing or following the @samp{%w} as the
28430 designated output file of this compilation.  This puts the argument
28431 into the sequence of arguments that @samp{%o} substitutes.
28433 @item %o
28434 Substitutes the names of all the output files, with spaces
28435 automatically placed around them.  You should write spaces
28436 around the @samp{%o} as well or the results are undefined.
28437 @samp{%o} is for use in the specs for running the linker.
28438 Input files whose names have no recognized suffix are not compiled
28439 at all, but they are included among the output files, so they are
28440 linked.
28442 @item %O
28443 Substitutes the suffix for object files.  Note that this is
28444 handled specially when it immediately follows @samp{%g, %u, or %U},
28445 because of the need for those to form complete file names.  The
28446 handling is such that @samp{%O} is treated exactly as if it had already
28447 been substituted, except that @samp{%g, %u, and %U} do not currently
28448 support additional @var{suffix} characters following @samp{%O} as they do
28449 following, for example, @samp{.o}.
28451 @item %p
28452 Substitutes the standard macro predefinitions for the
28453 current target machine.  Use this when running @command{cpp}.
28455 @item %P
28456 Like @samp{%p}, but puts @samp{__} before and after the name of each
28457 predefined macro, except for macros that start with @samp{__} or with
28458 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28461 @item %I
28462 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28463 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28464 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28465 and @option{-imultilib} as necessary.
28467 @item %s
28468 Current argument is the name of a library or startup file of some sort.
28469 Search for that file in a standard list of directories and substitute
28470 the full name found.  The current working directory is included in the
28471 list of directories scanned.
28473 @item %T
28474 Current argument is the name of a linker script.  Search for that file
28475 in the current list of directories to scan for libraries. If the file
28476 is located insert a @option{--script} option into the command line
28477 followed by the full path name found.  If the file is not found then
28478 generate an error message.  Note: the current working directory is not
28479 searched.
28481 @item %e@var{str}
28482 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28483 Use this when inconsistent options are detected.
28485 @item %(@var{name})
28486 Substitute the contents of spec string @var{name} at this point.
28488 @item %x@{@var{option}@}
28489 Accumulate an option for @samp{%X}.
28491 @item %X
28492 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28493 spec string.
28495 @item %Y
28496 Output the accumulated assembler options specified by @option{-Wa}.
28498 @item %Z
28499 Output the accumulated preprocessor options specified by @option{-Wp}.
28501 @item %a
28502 Process the @code{asm} spec.  This is used to compute the
28503 switches to be passed to the assembler.
28505 @item %A
28506 Process the @code{asm_final} spec.  This is a spec string for
28507 passing switches to an assembler post-processor, if such a program is
28508 needed.
28510 @item %l
28511 Process the @code{link} spec.  This is the spec for computing the
28512 command line passed to the linker.  Typically it makes use of the
28513 @samp{%L %G %S %D and %E} sequences.
28515 @item %D
28516 Dump out a @option{-L} option for each directory that GCC believes might
28517 contain startup files.  If the target supports multilibs then the
28518 current multilib directory is prepended to each of these paths.
28520 @item %L
28521 Process the @code{lib} spec.  This is a spec string for deciding which
28522 libraries are included on the command line to the linker.
28524 @item %G
28525 Process the @code{libgcc} spec.  This is a spec string for deciding
28526 which GCC support library is included on the command line to the linker.
28528 @item %S
28529 Process the @code{startfile} spec.  This is a spec for deciding which
28530 object files are the first ones passed to the linker.  Typically
28531 this might be a file named @file{crt0.o}.
28533 @item %E
28534 Process the @code{endfile} spec.  This is a spec string that specifies
28535 the last object files that are passed to the linker.
28537 @item %C
28538 Process the @code{cpp} spec.  This is used to construct the arguments
28539 to be passed to the C preprocessor.
28541 @item %1
28542 Process the @code{cc1} spec.  This is used to construct the options to be
28543 passed to the actual C compiler (@command{cc1}).
28545 @item %2
28546 Process the @code{cc1plus} spec.  This is used to construct the options to be
28547 passed to the actual C++ compiler (@command{cc1plus}).
28549 @item %*
28550 Substitute the variable part of a matched option.  See below.
28551 Note that each comma in the substituted string is replaced by
28552 a single space.
28554 @item %<S
28555 Remove all occurrences of @code{-S} from the command line.  Note---this
28556 command is position dependent.  @samp{%} commands in the spec string
28557 before this one see @code{-S}, @samp{%} commands in the spec string
28558 after this one do not.
28560 @item %:@var{function}(@var{args})
28561 Call the named function @var{function}, passing it @var{args}.
28562 @var{args} is first processed as a nested spec string, then split
28563 into an argument vector in the usual fashion.  The function returns
28564 a string which is processed as if it had appeared literally as part
28565 of the current spec.
28567 The following built-in spec functions are provided:
28569 @table @code
28570 @item @code{getenv}
28571 The @code{getenv} spec function takes two arguments: an environment
28572 variable name and a string.  If the environment variable is not
28573 defined, a fatal error is issued.  Otherwise, the return value is the
28574 value of the environment variable concatenated with the string.  For
28575 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28577 @smallexample
28578 %:getenv(TOPDIR /include)
28579 @end smallexample
28581 expands to @file{/path/to/top/include}.
28583 @item @code{if-exists}
28584 The @code{if-exists} spec function takes one argument, an absolute
28585 pathname to a file.  If the file exists, @code{if-exists} returns the
28586 pathname.  Here is a small example of its usage:
28588 @smallexample
28589 *startfile:
28590 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28591 @end smallexample
28593 @item @code{if-exists-else}
28594 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28595 spec function, except that it takes two arguments.  The first argument is
28596 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28597 returns the pathname.  If it does not exist, it returns the second argument.
28598 This way, @code{if-exists-else} can be used to select one file or another,
28599 based on the existence of the first.  Here is a small example of its usage:
28601 @smallexample
28602 *startfile:
28603 crt0%O%s %:if-exists(crti%O%s) \
28604 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28605 @end smallexample
28607 @item @code{replace-outfile}
28608 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28609 first argument in the outfiles array and replaces it with the second argument.  Here
28610 is a small example of its usage:
28612 @smallexample
28613 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28614 @end smallexample
28616 @item @code{remove-outfile}
28617 The @code{remove-outfile} spec function takes one argument.  It looks for the
28618 first argument in the outfiles array and removes it.  Here is a small example
28619 its usage:
28621 @smallexample
28622 %:remove-outfile(-lm)
28623 @end smallexample
28625 @item @code{pass-through-libs}
28626 The @code{pass-through-libs} spec function takes any number of arguments.  It
28627 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28628 assumes are the names of linker input library archive files) and returns a
28629 result containing all the found arguments each prepended by
28630 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28631 intended to be passed to the LTO linker plugin.
28633 @smallexample
28634 %:pass-through-libs(%G %L %G)
28635 @end smallexample
28637 @item @code{print-asm-header}
28638 The @code{print-asm-header} function takes no arguments and simply
28639 prints a banner like:
28641 @smallexample
28642 Assembler options
28643 =================
28645 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28646 @end smallexample
28648 It is used to separate compiler options from assembler options
28649 in the @option{--target-help} output.
28650 @end table
28652 @item %@{S@}
28653 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28654 If that switch is not specified, this substitutes nothing.  Note that
28655 the leading dash is omitted when specifying this option, and it is
28656 automatically inserted if the substitution is performed.  Thus the spec
28657 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28658 and outputs the command-line option @option{-foo}.
28660 @item %W@{S@}
28661 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28662 deleted on failure.
28664 @item %@{S*@}
28665 Substitutes all the switches specified to GCC whose names start
28666 with @code{-S}, but which also take an argument.  This is used for
28667 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28668 GCC considers @option{-o foo} as being
28669 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28670 text, including the space.  Thus two arguments are generated.
28672 @item %@{S*&T*@}
28673 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28674 (the order of @code{S} and @code{T} in the spec is not significant).
28675 There can be any number of ampersand-separated variables; for each the
28676 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28678 @item %@{S:X@}
28679 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28681 @item %@{!S:X@}
28682 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28684 @item %@{S*:X@}
28685 Substitutes @code{X} if one or more switches whose names start with
28686 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28687 once, no matter how many such switches appeared.  However, if @code{%*}
28688 appears somewhere in @code{X}, then @code{X} is substituted once
28689 for each matching switch, with the @code{%*} replaced by the part of
28690 that switch matching the @code{*}.
28692 If @code{%*} appears as the last part of a spec sequence then a space
28693 is added after the end of the last substitution.  If there is more
28694 text in the sequence, however, then a space is not generated.  This
28695 allows the @code{%*} substitution to be used as part of a larger
28696 string.  For example, a spec string like this:
28698 @smallexample
28699 %@{mcu=*:--script=%*/memory.ld@}
28700 @end smallexample
28702 @noindent
28703 when matching an option like @option{-mcu=newchip} produces:
28705 @smallexample
28706 --script=newchip/memory.ld
28707 @end smallexample
28709 @item %@{.S:X@}
28710 Substitutes @code{X}, if processing a file with suffix @code{S}.
28712 @item %@{!.S:X@}
28713 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28715 @item %@{,S:X@}
28716 Substitutes @code{X}, if processing a file for language @code{S}.
28718 @item %@{!,S:X@}
28719 Substitutes @code{X}, if not processing a file for language @code{S}.
28721 @item %@{S|P:X@}
28722 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28723 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28724 @code{*} sequences as well, although they have a stronger binding than
28725 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28726 alternatives must be starred, and only the first matching alternative
28727 is substituted.
28729 For example, a spec string like this:
28731 @smallexample
28732 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28733 @end smallexample
28735 @noindent
28736 outputs the following command-line options from the following input
28737 command-line options:
28739 @smallexample
28740 fred.c        -foo -baz
28741 jim.d         -bar -boggle
28742 -d fred.c     -foo -baz -boggle
28743 -d jim.d      -bar -baz -boggle
28744 @end smallexample
28746 @item %@{S:X; T:Y; :D@}
28748 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28749 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28750 be as many clauses as you need.  This may be combined with @code{.},
28751 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28754 @end table
28756 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28757 or similar construct can use a backslash to ignore the special meaning
28758 of the character following it, thus allowing literal matching of a
28759 character that is otherwise specially treated.  For example,
28760 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28761 @option{-std=iso9899:1999} option is given.
28763 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28764 construct may contain other nested @samp{%} constructs or spaces, or
28765 even newlines.  They are processed as usual, as described above.
28766 Trailing white space in @code{X} is ignored.  White space may also
28767 appear anywhere on the left side of the colon in these constructs,
28768 except between @code{.} or @code{*} and the corresponding word.
28770 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28771 handled specifically in these constructs.  If another value of
28772 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28773 @option{-W} switch is found later in the command line, the earlier
28774 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28775 just one letter, which passes all matching options.
28777 The character @samp{|} at the beginning of the predicate text is used to
28778 indicate that a command should be piped to the following command, but
28779 only if @option{-pipe} is specified.
28781 It is built into GCC which switches take arguments and which do not.
28782 (You might think it would be useful to generalize this to allow each
28783 compiler's spec to say which switches take arguments.  But this cannot
28784 be done in a consistent fashion.  GCC cannot even decide which input
28785 files have been specified without knowing which switches take arguments,
28786 and it must know which input files to compile in order to tell which
28787 compilers to run).
28789 GCC also knows implicitly that arguments starting in @option{-l} are to be
28790 treated as compiler output files, and passed to the linker in their
28791 proper position among the other output files.
28793 @node Environment Variables
28794 @section Environment Variables Affecting GCC
28795 @cindex environment variables
28797 @c man begin ENVIRONMENT
28798 This section describes several environment variables that affect how GCC
28799 operates.  Some of them work by specifying directories or prefixes to use
28800 when searching for various kinds of files.  Some are used to specify other
28801 aspects of the compilation environment.
28803 Note that you can also specify places to search using options such as
28804 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28805 take precedence over places specified using environment variables, which
28806 in turn take precedence over those specified by the configuration of GCC@.
28807 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28808 GNU Compiler Collection (GCC) Internals}.
28810 @table @env
28811 @item LANG
28812 @itemx LC_CTYPE
28813 @c @itemx LC_COLLATE
28814 @itemx LC_MESSAGES
28815 @c @itemx LC_MONETARY
28816 @c @itemx LC_NUMERIC
28817 @c @itemx LC_TIME
28818 @itemx LC_ALL
28819 @findex LANG
28820 @findex LC_CTYPE
28821 @c @findex LC_COLLATE
28822 @findex LC_MESSAGES
28823 @c @findex LC_MONETARY
28824 @c @findex LC_NUMERIC
28825 @c @findex LC_TIME
28826 @findex LC_ALL
28827 @cindex locale
28828 These environment variables control the way that GCC uses
28829 localization information which allows GCC to work with different
28830 national conventions.  GCC inspects the locale categories
28831 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28832 so.  These locale categories can be set to any value supported by your
28833 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28834 Kingdom encoded in UTF-8.
28836 The @env{LC_CTYPE} environment variable specifies character
28837 classification.  GCC uses it to determine the character boundaries in
28838 a string; this is needed for some multibyte encodings that contain quote
28839 and escape characters that are otherwise interpreted as a string
28840 end or escape.
28842 The @env{LC_MESSAGES} environment variable specifies the language to
28843 use in diagnostic messages.
28845 If the @env{LC_ALL} environment variable is set, it overrides the value
28846 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28847 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28848 environment variable.  If none of these variables are set, GCC
28849 defaults to traditional C English behavior.
28851 @item TMPDIR
28852 @findex TMPDIR
28853 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28854 files.  GCC uses temporary files to hold the output of one stage of
28855 compilation which is to be used as input to the next stage: for example,
28856 the output of the preprocessor, which is the input to the compiler
28857 proper.
28859 @item GCC_COMPARE_DEBUG
28860 @findex GCC_COMPARE_DEBUG
28861 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28862 @option{-fcompare-debug} to the compiler driver.  See the documentation
28863 of this option for more details.
28865 @item GCC_EXEC_PREFIX
28866 @findex GCC_EXEC_PREFIX
28867 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28868 names of the subprograms executed by the compiler.  No slash is added
28869 when this prefix is combined with the name of a subprogram, but you can
28870 specify a prefix that ends with a slash if you wish.
28872 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28873 an appropriate prefix to use based on the pathname it is invoked with.
28875 If GCC cannot find the subprogram using the specified prefix, it
28876 tries looking in the usual places for the subprogram.
28878 The default value of @env{GCC_EXEC_PREFIX} is
28879 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28880 the installed compiler. In many cases @var{prefix} is the value
28881 of @code{prefix} when you ran the @file{configure} script.
28883 Other prefixes specified with @option{-B} take precedence over this prefix.
28885 This prefix is also used for finding files such as @file{crt0.o} that are
28886 used for linking.
28888 In addition, the prefix is used in an unusual way in finding the
28889 directories to search for header files.  For each of the standard
28890 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28891 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28892 replacing that beginning with the specified prefix to produce an
28893 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28894 @file{foo/bar} just before it searches the standard directory 
28895 @file{/usr/local/lib/bar}.
28896 If a standard directory begins with the configured
28897 @var{prefix} then the value of @var{prefix} is replaced by
28898 @env{GCC_EXEC_PREFIX} when looking for header files.
28900 @item COMPILER_PATH
28901 @findex COMPILER_PATH
28902 The value of @env{COMPILER_PATH} is a colon-separated list of
28903 directories, much like @env{PATH}.  GCC tries the directories thus
28904 specified when searching for subprograms, if it cannot find the
28905 subprograms using @env{GCC_EXEC_PREFIX}.
28907 @item LIBRARY_PATH
28908 @findex LIBRARY_PATH
28909 The value of @env{LIBRARY_PATH} is a colon-separated list of
28910 directories, much like @env{PATH}.  When configured as a native compiler,
28911 GCC tries the directories thus specified when searching for special
28912 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28913 using GCC also uses these directories when searching for ordinary
28914 libraries for the @option{-l} option (but directories specified with
28915 @option{-L} come first).
28917 @item LANG
28918 @findex LANG
28919 @cindex locale definition
28920 This variable is used to pass locale information to the compiler.  One way in
28921 which this information is used is to determine the character set to be used
28922 when character literals, string literals and comments are parsed in C and C++.
28923 When the compiler is configured to allow multibyte characters,
28924 the following values for @env{LANG} are recognized:
28926 @table @samp
28927 @item C-JIS
28928 Recognize JIS characters.
28929 @item C-SJIS
28930 Recognize SJIS characters.
28931 @item C-EUCJP
28932 Recognize EUCJP characters.
28933 @end table
28935 If @env{LANG} is not defined, or if it has some other value, then the
28936 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28937 recognize and translate multibyte characters.
28938 @end table
28940 @noindent
28941 Some additional environment variables affect the behavior of the
28942 preprocessor.
28944 @include cppenv.texi
28946 @c man end
28948 @node Precompiled Headers
28949 @section Using Precompiled Headers
28950 @cindex precompiled headers
28951 @cindex speed of compilation
28953 Often large projects have many header files that are included in every
28954 source file.  The time the compiler takes to process these header files
28955 over and over again can account for nearly all of the time required to
28956 build the project.  To make builds faster, GCC allows you to
28957 @dfn{precompile} a header file.
28959 To create a precompiled header file, simply compile it as you would any
28960 other file, if necessary using the @option{-x} option to make the driver
28961 treat it as a C or C++ header file.  You may want to use a
28962 tool like @command{make} to keep the precompiled header up-to-date when
28963 the headers it contains change.
28965 A precompiled header file is searched for when @code{#include} is
28966 seen in the compilation.  As it searches for the included file
28967 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28968 compiler looks for a precompiled header in each directory just before it
28969 looks for the include file in that directory.  The name searched for is
28970 the name specified in the @code{#include} with @samp{.gch} appended.  If
28971 the precompiled header file cannot be used, it is ignored.
28973 For instance, if you have @code{#include "all.h"}, and you have
28974 @file{all.h.gch} in the same directory as @file{all.h}, then the
28975 precompiled header file is used if possible, and the original
28976 header is used otherwise.
28978 Alternatively, you might decide to put the precompiled header file in a
28979 directory and use @option{-I} to ensure that directory is searched
28980 before (or instead of) the directory containing the original header.
28981 Then, if you want to check that the precompiled header file is always
28982 used, you can put a file of the same name as the original header in this
28983 directory containing an @code{#error} command.
28985 This also works with @option{-include}.  So yet another way to use
28986 precompiled headers, good for projects not designed with precompiled
28987 header files in mind, is to simply take most of the header files used by
28988 a project, include them from another header file, precompile that header
28989 file, and @option{-include} the precompiled header.  If the header files
28990 have guards against multiple inclusion, they are skipped because
28991 they've already been included (in the precompiled header).
28993 If you need to precompile the same header file for different
28994 languages, targets, or compiler options, you can instead make a
28995 @emph{directory} named like @file{all.h.gch}, and put each precompiled
28996 header in the directory, perhaps using @option{-o}.  It doesn't matter
28997 what you call the files in the directory; every precompiled header in
28998 the directory is considered.  The first precompiled header
28999 encountered in the directory that is valid for this compilation is
29000 used; they're searched in no particular order.
29002 There are many other possibilities, limited only by your imagination,
29003 good sense, and the constraints of your build system.
29005 A precompiled header file can be used only when these conditions apply:
29007 @itemize
29008 @item
29009 Only one precompiled header can be used in a particular compilation.
29011 @item
29012 A precompiled header cannot be used once the first C token is seen.  You
29013 can have preprocessor directives before a precompiled header; you cannot
29014 include a precompiled header from inside another header.
29016 @item
29017 The precompiled header file must be produced for the same language as
29018 the current compilation.  You cannot use a C precompiled header for a C++
29019 compilation.
29021 @item
29022 The precompiled header file must have been produced by the same compiler
29023 binary as the current compilation is using.
29025 @item
29026 Any macros defined before the precompiled header is included must
29027 either be defined in the same way as when the precompiled header was
29028 generated, or must not affect the precompiled header, which usually
29029 means that they don't appear in the precompiled header at all.
29031 The @option{-D} option is one way to define a macro before a
29032 precompiled header is included; using a @code{#define} can also do it.
29033 There are also some options that define macros implicitly, like
29034 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29035 defined this way.
29037 @item If debugging information is output when using the precompiled
29038 header, using @option{-g} or similar, the same kind of debugging information
29039 must have been output when building the precompiled header.  However,
29040 a precompiled header built using @option{-g} can be used in a compilation
29041 when no debugging information is being output.
29043 @item The same @option{-m} options must generally be used when building
29044 and using the precompiled header.  @xref{Submodel Options},
29045 for any cases where this rule is relaxed.
29047 @item Each of the following options must be the same when building and using
29048 the precompiled header:
29050 @gccoptlist{-fexceptions}
29052 @item
29053 Some other command-line options starting with @option{-f},
29054 @option{-p}, or @option{-O} must be defined in the same way as when
29055 the precompiled header was generated.  At present, it's not clear
29056 which options are safe to change and which are not; the safest choice
29057 is to use exactly the same options when generating and using the
29058 precompiled header.  The following are known to be safe:
29060 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29061 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29062 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29063 -pedantic-errors}
29065 @end itemize
29067 For all of these except the last, the compiler automatically
29068 ignores the precompiled header if the conditions aren't met.  If you
29069 find an option combination that doesn't work and doesn't cause the
29070 precompiled header to be ignored, please consider filing a bug report,
29071 see @ref{Bugs}.
29073 If you do use differing options when generating and using the
29074 precompiled header, the actual behavior is a mixture of the
29075 behavior for the options.  For instance, if you use @option{-g} to
29076 generate the precompiled header but not when using it, you may or may
29077 not get debugging information for routines in the precompiled header.