2018-06-22 Paul Thomas <pault@gcc.gnu.org>
[official-gcc.git] / gcc / doc / invoke.texi
blob9bb1a4910b2a3f1e65ddbf0fbf347cf25b71021b
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 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor -Wdeprecated-copy  -Wliteral-suffix @gol
217 -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  -Wc++17-compat  @gol
271 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
272 -Wchar-subscripts  -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 @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 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
463 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
464 -fstack-protector-explicit  -fstack-check @gol
465 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
466 -fno-stack-limit  -fsplit-stack @gol
467 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
468 -fvtv-counts  -fvtv-debug @gol
469 -finstrument-functions @gol
470 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
471 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
473 @item Preprocessor Options
474 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
475 @gccoptlist{-A@var{question}=@var{answer} @gol
476 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
477 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
478 -dD  -dI  -dM  -dN  -dU @gol
479 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
480 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
481 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
482 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
483 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
484 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
485 -H  -imacros @var{file}  -include @var{file} @gol
486 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
487 -no-integrated-cpp  -P  -pthread  -remap @gol
488 -traditional  -traditional-cpp  -trigraphs @gol
489 -U@var{macro}  -undef  @gol
490 -Wp,@var{option}  -Xpreprocessor @var{option}}
492 @item Assembler Options
493 @xref{Assembler Options,,Passing Options to the Assembler}.
494 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
496 @item Linker Options
497 @xref{Link Options,,Options for Linking}.
498 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
499 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
500 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
501 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
502 -shared  -shared-libgcc  -symbolic @gol
503 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
504 -u @var{symbol}  -z @var{keyword}}
506 @item Directory Options
507 @xref{Directory Options,,Options for Directory Search}.
508 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
509 -idirafter @var{dir} @gol
510 -imacros @var{file}  -imultilib @var{dir} @gol
511 -iplugindir=@var{dir}  -iprefix @var{file} @gol
512 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
513 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
514 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
515 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
517 @item Code Generation Options
518 @xref{Code Gen Options,,Options for Code Generation Conventions}.
519 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
520 -ffixed-@var{reg}  -fexceptions @gol
521 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
522 -fasynchronous-unwind-tables @gol
523 -fno-gnu-unique @gol
524 -finhibit-size-directive  -fno-common  -fno-ident @gol
525 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
526 -fno-jump-tables @gol
527 -frecord-gcc-switches @gol
528 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
529 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
530 -fleading-underscore  -ftls-model=@var{model} @gol
531 -fstack-reuse=@var{reuse_level} @gol
532 -ftrampolines  -ftrapv  -fwrapv @gol
533 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
534 -fstrict-volatile-bitfields  -fsync-libcalls}
536 @item Developer Options
537 @xref{Developer Options,,GCC Developer Options}.
538 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
539 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
540 -fdbg-cnt=@var{counter-value-list} @gol
541 -fdisable-ipa-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass_name} @gol
543 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
544 -fdisable-tree-@var{pass_name} @gol
545 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
546 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
547 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
548 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
549 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
550 -fdump-lang-all @gol
551 -fdump-lang-@var{switch} @gol
552 -fdump-lang-@var{switch}-@var{options} @gol
553 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
554 -fdump-passes @gol
555 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
556 -fdump-statistics @gol
557 -fdump-tree-all @gol
558 -fdump-tree-@var{switch} @gol
559 -fdump-tree-@var{switch}-@var{options} @gol
560 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
561 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
562 -fenable-@var{kind}-@var{pass} @gol
563 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
564 -fira-verbose=@var{n} @gol
565 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
566 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
567 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
568 -fprofile-report @gol
569 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
570 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
571 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
572 -fvar-tracking-assignments-toggle  -gtoggle @gol
573 -print-file-name=@var{library}  -print-libgcc-file-name @gol
574 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
575 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
576 -print-sysroot  -print-sysroot-headers-suffix @gol
577 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
579 @item Machine-Dependent Options
580 @xref{Submodel Options,,Machine-Dependent Options}.
581 @c This list is ordered alphanumerically by subsection name.
582 @c Try and put the significant identifier (CPU or system) first,
583 @c so users have a clue at guessing where the ones they want will be.
585 @emph{AArch64 Options}
586 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
587 -mgeneral-regs-only @gol
588 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
589 -mstrict-align -mno-strict-align @gol
590 -momit-leaf-frame-pointer @gol
591 -mtls-dialect=desc  -mtls-dialect=traditional @gol
592 -mtls-size=@var{size} @gol
593 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
594 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
595 -mpc-relative-literal-loads @gol
596 -msign-return-address=@var{scope} @gol
597 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
598 -moverride=@var{string}  -mverbose-cost-dump}
600 @emph{Adapteva Epiphany Options}
601 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
602 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
603 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
604 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
605 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
606 -msplit-vecmove-early  -m1reg-@var{reg}}
608 @emph{ARC Options}
609 @gccoptlist{-mbarrel-shifter -mjli-always @gol
610 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
611 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
612 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
613 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
614 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
615 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
616 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
617 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
618 -mvolatile-cache  -mtp-regno=@var{regno} @gol
619 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
620 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
621 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
622 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
623 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
624 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
625 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
626 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16}
628 @emph{ARM Options}
629 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
630 -mabi=@var{name} @gol
631 -mapcs-stack-check  -mno-apcs-stack-check @gol
632 -mapcs-reentrant  -mno-apcs-reentrant @gol
633 -msched-prolog  -mno-sched-prolog @gol
634 -mlittle-endian  -mbig-endian @gol
635 -mbe8 -mbe32 @gol
636 -mfloat-abi=@var{name} @gol
637 -mfp16-format=@var{name}
638 -mthumb-interwork  -mno-thumb-interwork @gol
639 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
640 -mtune=@var{name}  -mprint-tune-info @gol
641 -mstructure-size-boundary=@var{n} @gol
642 -mabort-on-noreturn @gol
643 -mlong-calls  -mno-long-calls @gol
644 -msingle-pic-base  -mno-single-pic-base @gol
645 -mpic-register=@var{reg} @gol
646 -mnop-fun-dllimport @gol
647 -mpoke-function-name @gol
648 -mthumb  -marm  -mflip-thumb @gol
649 -mtpcs-frame  -mtpcs-leaf-frame @gol
650 -mcaller-super-interworking  -mcallee-super-interworking @gol
651 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
652 -mword-relocations @gol
653 -mfix-cortex-m3-ldrd @gol
654 -munaligned-access @gol
655 -mneon-for-64bits @gol
656 -mslow-flash-data @gol
657 -masm-syntax-unified @gol
658 -mrestrict-it @gol
659 -mverbose-cost-dump @gol
660 -mpure-code @gol
661 -mcmse}
663 @emph{AVR Options}
664 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
665 -mbranch-cost=@var{cost} @gol
666 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
667 -mn_flash=@var{size}  -mno-interrupts @gol
668 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
669 -mfract-convert-truncate @gol
670 -mshort-calls  -nodevicelib @gol
671 -Waddr-space-convert  -Wmisspelled-isr}
673 @emph{Blackfin Options}
674 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
675 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
676 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
677 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
678 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
679 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
680 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
681 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
682 -micplb}
684 @emph{C6X Options}
685 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
686 -msim  -msdata=@var{sdata-type}}
688 @emph{CRIS Options}
689 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
690 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
691 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
692 -mstack-align  -mdata-align  -mconst-align @gol
693 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
694 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
695 -mmul-bug-workaround  -mno-mul-bug-workaround}
697 @emph{CR16 Options}
698 @gccoptlist{-mmac @gol
699 -mcr16cplus  -mcr16c @gol
700 -msim  -mint32  -mbit-ops
701 -mdata-model=@var{model}}
703 @emph{Darwin Options}
704 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
705 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
706 -client_name  -compatibility_version  -current_version @gol
707 -dead_strip @gol
708 -dependency-file  -dylib_file  -dylinker_install_name @gol
709 -dynamic  -dynamiclib  -exported_symbols_list @gol
710 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
711 -force_flat_namespace  -headerpad_max_install_names @gol
712 -iframework @gol
713 -image_base  -init  -install_name  -keep_private_externs @gol
714 -multi_module  -multiply_defined  -multiply_defined_unused @gol
715 -noall_load   -no_dead_strip_inits_and_terms @gol
716 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
717 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
718 -private_bundle  -read_only_relocs  -sectalign @gol
719 -sectobjectsymbols  -whyload  -seg1addr @gol
720 -sectcreate  -sectobjectsymbols  -sectorder @gol
721 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
722 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
723 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
724 -single_module  -static  -sub_library  -sub_umbrella @gol
725 -twolevel_namespace  -umbrella  -undefined @gol
726 -unexported_symbols_list  -weak_reference_mismatches @gol
727 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
728 -mkernel  -mone-byte-bool}
730 @emph{DEC Alpha Options}
731 @gccoptlist{-mno-fp-regs  -msoft-float @gol
732 -mieee  -mieee-with-inexact  -mieee-conformant @gol
733 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
734 -mtrap-precision=@var{mode}  -mbuild-constants @gol
735 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
736 -mbwx  -mmax  -mfix  -mcix @gol
737 -mfloat-vax  -mfloat-ieee @gol
738 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
739 -msmall-text  -mlarge-text @gol
740 -mmemory-latency=@var{time}}
742 @emph{FR30 Options}
743 @gccoptlist{-msmall-model  -mno-lsim}
745 @emph{FT32 Options}
746 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
748 @emph{FRV Options}
749 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
750 -mhard-float  -msoft-float @gol
751 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
752 -mdouble  -mno-double @gol
753 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
754 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
755 -mlinked-fp  -mlong-calls  -malign-labels @gol
756 -mlibrary-pic  -macc-4  -macc-8 @gol
757 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
758 -moptimize-membar  -mno-optimize-membar @gol
759 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
760 -mvliw-branch  -mno-vliw-branch @gol
761 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
762 -mno-nested-cond-exec  -mtomcat-stats @gol
763 -mTLS  -mtls @gol
764 -mcpu=@var{cpu}}
766 @emph{GNU/Linux Options}
767 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
768 -tno-android-cc  -tno-android-ld}
770 @emph{H8/300 Options}
771 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
773 @emph{HPPA Options}
774 @gccoptlist{-march=@var{architecture-type} @gol
775 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
776 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
777 -mfixed-range=@var{register-range} @gol
778 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
779 -mlong-load-store  -mno-disable-fpregs @gol
780 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
781 -mno-jump-in-delay  -mno-long-load-store @gol
782 -mno-portable-runtime  -mno-soft-float @gol
783 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
784 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
785 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
786 -munix=@var{unix-std}  -nolibdld  -static  -threads}
788 @emph{IA-64 Options}
789 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
790 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
791 -mconstant-gp  -mauto-pic  -mfused-madd @gol
792 -minline-float-divide-min-latency @gol
793 -minline-float-divide-max-throughput @gol
794 -mno-inline-float-divide @gol
795 -minline-int-divide-min-latency @gol
796 -minline-int-divide-max-throughput  @gol
797 -mno-inline-int-divide @gol
798 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
799 -mno-inline-sqrt @gol
800 -mdwarf2-asm  -mearly-stop-bits @gol
801 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
802 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
803 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
804 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
805 -msched-spec-ldc  -msched-spec-control-ldc @gol
806 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
807 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
808 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
809 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
811 @emph{LM32 Options}
812 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
813 -msign-extend-enabled  -muser-enabled}
815 @emph{M32R/D Options}
816 @gccoptlist{-m32r2  -m32rx  -m32r @gol
817 -mdebug @gol
818 -malign-loops  -mno-align-loops @gol
819 -missue-rate=@var{number} @gol
820 -mbranch-cost=@var{number} @gol
821 -mmodel=@var{code-size-model-type} @gol
822 -msdata=@var{sdata-type} @gol
823 -mno-flush-func  -mflush-func=@var{name} @gol
824 -mno-flush-trap  -mflush-trap=@var{number} @gol
825 -G @var{num}}
827 @emph{M32C Options}
828 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
830 @emph{M680x0 Options}
831 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
832 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
833 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
834 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
835 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
836 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
837 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
838 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
839 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
841 @emph{MCore Options}
842 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
843 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
844 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
845 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
846 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
848 @emph{MeP Options}
849 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
850 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
851 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
852 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
853 -mtiny=@var{n}}
855 @emph{MicroBlaze Options}
856 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
857 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
858 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
859 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
860 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}
861 -mpic-data-is-text-relative}
863 @emph{MIPS Options}
864 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
865 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
866 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
867 -mips16  -mno-mips16  -mflip-mips16 @gol
868 -minterlink-compressed  -mno-interlink-compressed @gol
869 -minterlink-mips16  -mno-interlink-mips16 @gol
870 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
871 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
872 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
873 -mno-float  -msingle-float  -mdouble-float @gol
874 -modd-spreg  -mno-odd-spreg @gol
875 -mabs=@var{mode}  -mnan=@var{encoding} @gol
876 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
877 -mmcu  -mmno-mcu @gol
878 -meva  -mno-eva @gol
879 -mvirt  -mno-virt @gol
880 -mxpa  -mno-xpa @gol
881 -mcrc -mno-crc @gol
882 -mginv -mno-ginv @gol
883 -mmicromips  -mno-micromips @gol
884 -mmsa  -mno-msa @gol
885 -mfpu=@var{fpu-type} @gol
886 -msmartmips  -mno-smartmips @gol
887 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
888 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
889 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
890 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
891 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
892 -membedded-data  -mno-embedded-data @gol
893 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
894 -mcode-readable=@var{setting} @gol
895 -msplit-addresses  -mno-split-addresses @gol
896 -mexplicit-relocs  -mno-explicit-relocs @gol
897 -mcheck-zero-division  -mno-check-zero-division @gol
898 -mdivide-traps  -mdivide-breaks @gol
899 -mload-store-pairs  -mno-load-store-pairs @gol
900 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
901 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
902 -mfix-24k  -mno-fix-24k @gol
903 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
904 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
905 -mfix-vr4120  -mno-fix-vr4120 @gol
906 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
907 -mflush-func=@var{func}  -mno-flush-func @gol
908 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
909 -mcompact-branches=@var{policy} @gol
910 -mfp-exceptions  -mno-fp-exceptions @gol
911 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
912 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
913 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
914 -mframe-header-opt  -mno-frame-header-opt}
916 @emph{MMIX Options}
917 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
918 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
919 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
920 -mno-base-addresses  -msingle-exit  -mno-single-exit}
922 @emph{MN10300 Options}
923 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
924 -mno-am33  -mam33  -mam33-2  -mam34 @gol
925 -mtune=@var{cpu-type} @gol
926 -mreturn-pointer-on-d0 @gol
927 -mno-crt0  -mrelax  -mliw  -msetlb}
929 @emph{Moxie Options}
930 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
932 @emph{MSP430 Options}
933 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
934 -mwarn-mcu @gol
935 -mcode-region=  -mdata-region= @gol
936 -msilicon-errata=  -msilicon-errata-warn= @gol
937 -mhwmult=  -minrt}
939 @emph{NDS32 Options}
940 @gccoptlist{-mbig-endian  -mlittle-endian @gol
941 -mreduced-regs  -mfull-regs @gol
942 -mcmov  -mno-cmov @gol
943 -mext-perf  -mno-ext-perf @gol
944 -mext-perf2  -mno-ext-perf2 @gol
945 -mext-string  -mno-ext-string @gol
946 -mv3push  -mno-v3push @gol
947 -m16bit  -mno-16bit @gol
948 -misr-vector-size=@var{num} @gol
949 -mcache-block-size=@var{num} @gol
950 -march=@var{arch} @gol
951 -mcmodel=@var{code-model} @gol
952 -mctor-dtor  -mrelax}
954 @emph{Nios II Options}
955 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
956 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
957 -mel  -meb @gol
958 -mno-bypass-cache  -mbypass-cache @gol
959 -mno-cache-volatile  -mcache-volatile @gol
960 -mno-fast-sw-div  -mfast-sw-div @gol
961 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
962 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
963 -mcustom-fpu-cfg=@var{name} @gol
964 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
965 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
967 @emph{Nvidia PTX Options}
968 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
970 @emph{PDP-11 Options}
971 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
972 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
973 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
974 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
975 -mbranch-expensive  -mbranch-cheap @gol
976 -munix-asm  -mdec-asm}
978 @emph{picoChip Options}
979 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
980 -msymbol-as-address  -mno-inefficient-warnings}
982 @emph{PowerPC Options}
983 See RS/6000 and PowerPC Options.
985 @emph{PowerPC SPE Options}
986 @gccoptlist{-mcpu=@var{cpu-type} @gol
987 -mtune=@var{cpu-type} @gol
988 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
989 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
990 -m32  -mxl-compat  -mno-xl-compat @gol
991 -malign-power  -malign-natural @gol
992 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
993 -msingle-float  -mdouble-float @gol
994 -mupdate  -mno-update @gol
995 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
996 -mstrict-align  -mno-strict-align  -mrelocatable @gol
997 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
998 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
999 -msingle-pic-base @gol
1000 -mprioritize-restricted-insns=@var{priority} @gol
1001 -msched-costly-dep=@var{dependence_type} @gol
1002 -minsert-sched-nops=@var{scheme} @gol
1003 -mcall-sysv  -mcall-netbsd @gol
1004 -maix-struct-return  -msvr4-struct-return @gol
1005 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1006 -mblock-move-inline-limit=@var{num} @gol
1007 -misel  -mno-isel @gol
1008 -misel=yes  -misel=no @gol
1009 -mspe  -mno-spe @gol
1010 -mspe=yes  -mspe=no @gol
1011 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1012 -mprototype  -mno-prototype @gol
1013 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1014 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1015 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1016 -mno-recip-precision @gol
1017 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1018 -msave-toc-indirect  -mno-save-toc-indirect @gol
1019 -mcompat-align-parm  -mno-compat-align-parm @gol
1020 -mfloat128  -mno-float128 @gol
1021 -mgnu-attribute  -mno-gnu-attribute @gol
1022 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1023 -mstack-protector-guard-offset=@var{offset}}
1025 @emph{RISC-V Options}
1026 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1027 -mplt  -mno-plt @gol
1028 -mabi=@var{ABI-string} @gol
1029 -mfdiv  -mno-fdiv @gol
1030 -mdiv  -mno-div @gol
1031 -march=@var{ISA-string} @gol
1032 -mtune=@var{processor-string} @gol
1033 -mpreferred-stack-boundary=@var{num} @gol
1034 -msmall-data-limit=@var{N-bytes} @gol
1035 -msave-restore  -mno-save-restore @gol
1036 -mstrict-align -mno-strict-align @gol
1037 -mcmodel=medlow -mcmodel=medany @gol
1038 -mexplicit-relocs  -mno-explicit-relocs @gol
1039 -mrelax -mno-relax @gol}
1041 @emph{RL78 Options}
1042 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1043 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1044 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1046 @emph{RS/6000 and PowerPC Options}
1047 @gccoptlist{-mcpu=@var{cpu-type} @gol
1048 -mtune=@var{cpu-type} @gol
1049 -mcmodel=@var{code-model} @gol
1050 -mpowerpc64 @gol
1051 -maltivec  -mno-altivec @gol
1052 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1053 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1054 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1055 -mfprnd  -mno-fprnd @gol
1056 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1057 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1058 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1059 -malign-power  -malign-natural @gol
1060 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1061 -mupdate  -mno-update @gol
1062 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1063 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1064 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1065 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1066 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1067 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1068 -mprioritize-restricted-insns=@var{priority} @gol
1069 -msched-costly-dep=@var{dependence_type} @gol
1070 -minsert-sched-nops=@var{scheme} @gol
1071 -mcall-aixdesc  -mcall-eabi  -mcall-freebsd  @gol
1072 -mcall-linux  -mcall-netbsd  -mcall-openbsd  @gol
1073 -mcall-sysv  -mcall-sysv-eabi  -mcall-sysv-noeabi @gol
1074 -mtraceback=@var{traceback_type} @gol
1075 -maix-struct-return  -msvr4-struct-return @gol
1076 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1077 -mblock-move-inline-limit=@var{num} @gol
1078 -mblock-compare-inline-limit=@var{num} @gol
1079 -mblock-compare-inline-loop-limit=@var{num} @gol
1080 -mstring-compare-inline-limit=@var{num} @gol
1081 -misel  -mno-isel @gol
1082 -misel=yes  -misel=no @gol
1083 -mvrsave  -mno-vrsave @gol
1084 -mmulhw  -mno-mulhw @gol
1085 -mdlmzb  -mno-dlmzb @gol
1086 -mprototype  -mno-prototype @gol
1087 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1088 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1089 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1090 -mno-recip-precision @gol
1091 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1092 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1093 -msave-toc-indirect  -mno-save-toc-indirect @gol
1094 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1095 -mcrypto  -mno-crypto  -mhtm  -mno-htm @gol
1096 -mquad-memory  -mno-quad-memory @gol
1097 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1098 -mcompat-align-parm  -mno-compat-align-parm @gol
1099 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1100 -mgnu-attribute  -mno-gnu-attribute @gol
1101 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1102 -mstack-protector-guard-offset=@var{offset}}
1104 @emph{RX Options}
1105 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1106 -mcpu=@gol
1107 -mbig-endian-data  -mlittle-endian-data @gol
1108 -msmall-data @gol
1109 -msim  -mno-sim@gol
1110 -mas100-syntax  -mno-as100-syntax@gol
1111 -mrelax@gol
1112 -mmax-constant-size=@gol
1113 -mint-register=@gol
1114 -mpid@gol
1115 -mallow-string-insns  -mno-allow-string-insns@gol
1116 -mjsr@gol
1117 -mno-warn-multiple-fast-interrupts@gol
1118 -msave-acc-in-interrupts}
1120 @emph{S/390 and zSeries Options}
1121 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1122 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1123 -mlong-double-64  -mlong-double-128 @gol
1124 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1125 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1126 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1127 -mhtm  -mvx  -mzvector @gol
1128 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1129 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1130 -mhotpatch=@var{halfwords},@var{halfwords}}
1132 @emph{Score Options}
1133 @gccoptlist{-meb  -mel @gol
1134 -mnhwloop @gol
1135 -muls @gol
1136 -mmac @gol
1137 -mscore5  -mscore5u  -mscore7  -mscore7d}
1139 @emph{SH Options}
1140 @gccoptlist{-m1  -m2  -m2e @gol
1141 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1142 -m3  -m3e @gol
1143 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1144 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1145 -mb  -ml  -mdalign  -mrelax @gol
1146 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1147 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1148 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1149 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1150 -maccumulate-outgoing-args @gol
1151 -matomic-model=@var{atomic-model} @gol
1152 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1153 -mcbranch-force-delay-slot @gol
1154 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1155 -mpretend-cmove  -mtas}
1157 @emph{Solaris 2 Options}
1158 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1159 -pthreads}
1161 @emph{SPARC Options}
1162 @gccoptlist{-mcpu=@var{cpu-type} @gol
1163 -mtune=@var{cpu-type} @gol
1164 -mcmodel=@var{code-model} @gol
1165 -mmemory-model=@var{mem-model} @gol
1166 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1167 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1168 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1169 -mhard-quad-float  -msoft-quad-float @gol
1170 -mstack-bias  -mno-stack-bias @gol
1171 -mstd-struct-return  -mno-std-struct-return @gol
1172 -munaligned-doubles  -mno-unaligned-doubles @gol
1173 -muser-mode  -mno-user-mode @gol
1174 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1175 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1176 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1177 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1178 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1179 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1180 -mlra  -mno-lra}
1182 @emph{SPU Options}
1183 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1184 -msafe-dma  -munsafe-dma @gol
1185 -mbranch-hints @gol
1186 -msmall-mem  -mlarge-mem  -mstdmain @gol
1187 -mfixed-range=@var{register-range} @gol
1188 -mea32  -mea64 @gol
1189 -maddress-space-conversion  -mno-address-space-conversion @gol
1190 -mcache-size=@var{cache-size} @gol
1191 -matomic-updates  -mno-atomic-updates}
1193 @emph{System V Options}
1194 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1196 @emph{TILE-Gx Options}
1197 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1198 -mcmodel=@var{code-model}}
1200 @emph{TILEPro Options}
1201 @gccoptlist{-mcpu=@var{cpu}  -m32}
1203 @emph{V850 Options}
1204 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1205 -mprolog-function  -mno-prolog-function  -mspace @gol
1206 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1207 -mapp-regs  -mno-app-regs @gol
1208 -mdisable-callt  -mno-disable-callt @gol
1209 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1210 -mv850e  -mv850  -mv850e3v5 @gol
1211 -mloop @gol
1212 -mrelax @gol
1213 -mlong-jumps @gol
1214 -msoft-float @gol
1215 -mhard-float @gol
1216 -mgcc-abi @gol
1217 -mrh850-abi @gol
1218 -mbig-switch}
1220 @emph{VAX Options}
1221 @gccoptlist{-mg  -mgnu  -munix}
1223 @emph{Visium Options}
1224 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1225 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1227 @emph{VMS Options}
1228 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1229 -mpointer-size=@var{size}}
1231 @emph{VxWorks Options}
1232 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1233 -Xbind-lazy  -Xbind-now}
1235 @emph{x86 Options}
1236 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1237 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1238 -mfpmath=@var{unit} @gol
1239 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1240 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1241 -mno-wide-multiply  -mrtd  -malign-double @gol
1242 -mpreferred-stack-boundary=@var{num} @gol
1243 -mincoming-stack-boundary=@var{num} @gol
1244 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1245 -mrecip  -mrecip=@var{opt} @gol
1246 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1247 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1248 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1249 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1250 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1251 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1252 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1253 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp @gol
1254 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  -mwaitpkg @gol
1255 -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1256 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq
1257 -mcldemote @gol
1258 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1259 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1260 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1261 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1262 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1263 -mregparm=@var{num}  -msseregparm @gol
1264 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1265 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1266 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1267 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1268 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1269 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1270 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1271 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1272 -mstack-protector-guard-reg=@var{reg} @gol
1273 -mstack-protector-guard-offset=@var{offset} @gol
1274 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1275 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1276 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1277 -mindirect-branch-register}
1279 @emph{x86 Windows Options}
1280 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1281 -mnop-fun-dllimport  -mthread @gol
1282 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1284 @emph{Xstormy16 Options}
1285 @gccoptlist{-msim}
1287 @emph{Xtensa Options}
1288 @gccoptlist{-mconst16  -mno-const16 @gol
1289 -mfused-madd  -mno-fused-madd @gol
1290 -mforce-no-pic @gol
1291 -mserialize-volatile  -mno-serialize-volatile @gol
1292 -mtext-section-literals  -mno-text-section-literals @gol
1293 -mauto-litpools  -mno-auto-litpools @gol
1294 -mtarget-align  -mno-target-align @gol
1295 -mlongcalls  -mno-longcalls}
1297 @emph{zSeries Options}
1298 See S/390 and zSeries Options.
1299 @end table
1302 @node Overall Options
1303 @section Options Controlling the Kind of Output
1305 Compilation can involve up to four stages: preprocessing, compilation
1306 proper, assembly and linking, always in that order.  GCC is capable of
1307 preprocessing and compiling several files either into several
1308 assembler input files, or into one assembler input file; then each
1309 assembler input file produces an object file, and linking combines all
1310 the object files (those newly compiled, and those specified as input)
1311 into an executable file.
1313 @cindex file name suffix
1314 For any given input file, the file name suffix determines what kind of
1315 compilation is done:
1317 @table @gcctabopt
1318 @item @var{file}.c
1319 C source code that must be preprocessed.
1321 @item @var{file}.i
1322 C source code that should not be preprocessed.
1324 @item @var{file}.ii
1325 C++ source code that should not be preprocessed.
1327 @item @var{file}.m
1328 Objective-C source code.  Note that you must link with the @file{libobjc}
1329 library to make an Objective-C program work.
1331 @item @var{file}.mi
1332 Objective-C source code that should not be preprocessed.
1334 @item @var{file}.mm
1335 @itemx @var{file}.M
1336 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1337 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1338 to a literal capital M@.
1340 @item @var{file}.mii
1341 Objective-C++ source code that should not be preprocessed.
1343 @item @var{file}.h
1344 C, C++, Objective-C or Objective-C++ header file to be turned into a
1345 precompiled header (default), or C, C++ header file to be turned into an
1346 Ada spec (via the @option{-fdump-ada-spec} switch).
1348 @item @var{file}.cc
1349 @itemx @var{file}.cp
1350 @itemx @var{file}.cxx
1351 @itemx @var{file}.cpp
1352 @itemx @var{file}.CPP
1353 @itemx @var{file}.c++
1354 @itemx @var{file}.C
1355 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1356 the last two letters must both be literally @samp{x}.  Likewise,
1357 @samp{.C} refers to a literal capital C@.
1359 @item @var{file}.mm
1360 @itemx @var{file}.M
1361 Objective-C++ source code that must be preprocessed.
1363 @item @var{file}.mii
1364 Objective-C++ source code that should not be preprocessed.
1366 @item @var{file}.hh
1367 @itemx @var{file}.H
1368 @itemx @var{file}.hp
1369 @itemx @var{file}.hxx
1370 @itemx @var{file}.hpp
1371 @itemx @var{file}.HPP
1372 @itemx @var{file}.h++
1373 @itemx @var{file}.tcc
1374 C++ header file to be turned into a precompiled header or Ada spec.
1376 @item @var{file}.f
1377 @itemx @var{file}.for
1378 @itemx @var{file}.ftn
1379 Fixed form Fortran source code that should not be preprocessed.
1381 @item @var{file}.F
1382 @itemx @var{file}.FOR
1383 @itemx @var{file}.fpp
1384 @itemx @var{file}.FPP
1385 @itemx @var{file}.FTN
1386 Fixed form Fortran source code that must be preprocessed (with the traditional
1387 preprocessor).
1389 @item @var{file}.f90
1390 @itemx @var{file}.f95
1391 @itemx @var{file}.f03
1392 @itemx @var{file}.f08
1393 Free form Fortran source code that should not be preprocessed.
1395 @item @var{file}.F90
1396 @itemx @var{file}.F95
1397 @itemx @var{file}.F03
1398 @itemx @var{file}.F08
1399 Free form Fortran source code that must be preprocessed (with the
1400 traditional preprocessor).
1402 @item @var{file}.go
1403 Go source code.
1405 @item @var{file}.brig
1406 BRIG files (binary representation of HSAIL).
1408 @item @var{file}.ads
1409 Ada source code file that contains a library unit declaration (a
1410 declaration of a package, subprogram, or generic, or a generic
1411 instantiation), or a library unit renaming declaration (a package,
1412 generic, or subprogram renaming declaration).  Such files are also
1413 called @dfn{specs}.
1415 @item @var{file}.adb
1416 Ada source code file containing a library unit body (a subprogram or
1417 package body).  Such files are also called @dfn{bodies}.
1419 @c GCC also knows about some suffixes for languages not yet included:
1420 @c Pascal:
1421 @c @var{file}.p
1422 @c @var{file}.pas
1423 @c Ratfor:
1424 @c @var{file}.r
1426 @item @var{file}.s
1427 Assembler code.
1429 @item @var{file}.S
1430 @itemx @var{file}.sx
1431 Assembler code that must be preprocessed.
1433 @item @var{other}
1434 An object file to be fed straight into linking.
1435 Any file name with no recognized suffix is treated this way.
1436 @end table
1438 @opindex x
1439 You can specify the input language explicitly with the @option{-x} option:
1441 @table @gcctabopt
1442 @item -x @var{language}
1443 Specify explicitly the @var{language} for the following input files
1444 (rather than letting the compiler choose a default based on the file
1445 name suffix).  This option applies to all following input files until
1446 the next @option{-x} option.  Possible values for @var{language} are:
1447 @smallexample
1448 c  c-header  cpp-output
1449 c++  c++-header  c++-cpp-output
1450 objective-c  objective-c-header  objective-c-cpp-output
1451 objective-c++ objective-c++-header objective-c++-cpp-output
1452 assembler  assembler-with-cpp
1454 f77  f77-cpp-input f95  f95-cpp-input
1456 brig
1457 @end smallexample
1459 @item -x none
1460 Turn off any specification of a language, so that subsequent files are
1461 handled according to their file name suffixes (as they are if @option{-x}
1462 has not been used at all).
1463 @end table
1465 If you only want some of the stages of compilation, you can use
1466 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1467 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1468 @command{gcc} is to stop.  Note that some combinations (for example,
1469 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1471 @table @gcctabopt
1472 @item -c
1473 @opindex c
1474 Compile or assemble the source files, but do not link.  The linking
1475 stage simply is not done.  The ultimate output is in the form of an
1476 object file for each source file.
1478 By default, the object file name for a source file is made by replacing
1479 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1481 Unrecognized input files, not requiring compilation or assembly, are
1482 ignored.
1484 @item -S
1485 @opindex S
1486 Stop after the stage of compilation proper; do not assemble.  The output
1487 is in the form of an assembler code file for each non-assembler input
1488 file specified.
1490 By default, the assembler file name for a source file is made by
1491 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1493 Input files that don't require compilation are ignored.
1495 @item -E
1496 @opindex E
1497 Stop after the preprocessing stage; do not run the compiler proper.  The
1498 output is in the form of preprocessed source code, which is sent to the
1499 standard output.
1501 Input files that don't require preprocessing are ignored.
1503 @cindex output file option
1504 @item -o @var{file}
1505 @opindex o
1506 Place output in file @var{file}.  This applies to whatever
1507 sort of output is being produced, whether it be an executable file,
1508 an object file, an assembler file or preprocessed C code.
1510 If @option{-o} is not specified, the default is to put an executable
1511 file in @file{a.out}, the object file for
1512 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1513 assembler file in @file{@var{source}.s}, a precompiled header file in
1514 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1515 standard output.
1517 @item -v
1518 @opindex v
1519 Print (on standard error output) the commands executed to run the stages
1520 of compilation.  Also print the version number of the compiler driver
1521 program and of the preprocessor and the compiler proper.
1523 @item -###
1524 @opindex ###
1525 Like @option{-v} except the commands are not executed and arguments
1526 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1527 This is useful for shell scripts to capture the driver-generated command lines.
1529 @item --help
1530 @opindex help
1531 Print (on the standard output) a description of the command-line options
1532 understood by @command{gcc}.  If the @option{-v} option is also specified
1533 then @option{--help} is also passed on to the various processes
1534 invoked by @command{gcc}, so that they can display the command-line options
1535 they accept.  If the @option{-Wextra} option has also been specified
1536 (prior to the @option{--help} option), then command-line options that
1537 have no documentation associated with them are also displayed.
1539 @item --target-help
1540 @opindex target-help
1541 Print (on the standard output) a description of target-specific command-line
1542 options for each tool.  For some targets extra target-specific
1543 information may also be printed.
1545 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1546 Print (on the standard output) a description of the command-line
1547 options understood by the compiler that fit into all specified classes
1548 and qualifiers.  These are the supported classes:
1550 @table @asis
1551 @item @samp{optimizers}
1552 Display all of the optimization options supported by the
1553 compiler.
1555 @item @samp{warnings}
1556 Display all of the options controlling warning messages
1557 produced by the compiler.
1559 @item @samp{target}
1560 Display target-specific options.  Unlike the
1561 @option{--target-help} option however, target-specific options of the
1562 linker and assembler are not displayed.  This is because those
1563 tools do not currently support the extended @option{--help=} syntax.
1565 @item @samp{params}
1566 Display the values recognized by the @option{--param}
1567 option.
1569 @item @var{language}
1570 Display the options supported for @var{language}, where
1571 @var{language} is the name of one of the languages supported in this
1572 version of GCC@.
1574 @item @samp{common}
1575 Display the options that are common to all languages.
1576 @end table
1578 These are the supported qualifiers:
1580 @table @asis
1581 @item @samp{undocumented}
1582 Display only those options that are undocumented.
1584 @item @samp{joined}
1585 Display options taking an argument that appears after an equal
1586 sign in the same continuous piece of text, such as:
1587 @samp{--help=target}.
1589 @item @samp{separate}
1590 Display options taking an argument that appears as a separate word
1591 following the original option, such as: @samp{-o output-file}.
1592 @end table
1594 Thus for example to display all the undocumented target-specific
1595 switches supported by the compiler, use:
1597 @smallexample
1598 --help=target,undocumented
1599 @end smallexample
1601 The sense of a qualifier can be inverted by prefixing it with the
1602 @samp{^} character, so for example to display all binary warning
1603 options (i.e., ones that are either on or off and that do not take an
1604 argument) that have a description, use:
1606 @smallexample
1607 --help=warnings,^joined,^undocumented
1608 @end smallexample
1610 The argument to @option{--help=} should not consist solely of inverted
1611 qualifiers.
1613 Combining several classes is possible, although this usually
1614 restricts the output so much that there is nothing to display.  One
1615 case where it does work, however, is when one of the classes is
1616 @var{target}.  For example, to display all the target-specific
1617 optimization options, use:
1619 @smallexample
1620 --help=target,optimizers
1621 @end smallexample
1623 The @option{--help=} option can be repeated on the command line.  Each
1624 successive use displays its requested class of options, skipping
1625 those that have already been displayed.
1627 If the @option{-Q} option appears on the command line before the
1628 @option{--help=} option, then the descriptive text displayed by
1629 @option{--help=} is changed.  Instead of describing the displayed
1630 options, an indication is given as to whether the option is enabled,
1631 disabled or set to a specific value (assuming that the compiler
1632 knows this at the point where the @option{--help=} option is used).
1634 Here is a truncated example from the ARM port of @command{gcc}:
1636 @smallexample
1637   % gcc -Q -mabi=2 --help=target -c
1638   The following options are target specific:
1639   -mabi=                                2
1640   -mabort-on-noreturn                   [disabled]
1641   -mapcs                                [disabled]
1642 @end smallexample
1644 The output is sensitive to the effects of previous command-line
1645 options, so for example it is possible to find out which optimizations
1646 are enabled at @option{-O2} by using:
1648 @smallexample
1649 -Q -O2 --help=optimizers
1650 @end smallexample
1652 Alternatively you can discover which binary optimizations are enabled
1653 by @option{-O3} by using:
1655 @smallexample
1656 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1657 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1658 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1659 @end smallexample
1661 @item --version
1662 @opindex version
1663 Display the version number and copyrights of the invoked GCC@.
1665 @item -pass-exit-codes
1666 @opindex pass-exit-codes
1667 Normally the @command{gcc} program exits with the code of 1 if any
1668 phase of the compiler returns a non-success return code.  If you specify
1669 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1670 the numerically highest error produced by any phase returning an error
1671 indication.  The C, C++, and Fortran front ends return 4 if an internal
1672 compiler error is encountered.
1674 @item -pipe
1675 @opindex pipe
1676 Use pipes rather than temporary files for communication between the
1677 various stages of compilation.  This fails to work on some systems where
1678 the assembler is unable to read from a pipe; but the GNU assembler has
1679 no trouble.
1681 @item -specs=@var{file}
1682 @opindex specs
1683 Process @var{file} after the compiler reads in the standard @file{specs}
1684 file, in order to override the defaults which the @command{gcc} driver
1685 program uses when determining what switches to pass to @command{cc1},
1686 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1687 @option{-specs=@var{file}} can be specified on the command line, and they
1688 are processed in order, from left to right.  @xref{Spec Files}, for
1689 information about the format of the @var{file}.
1691 @item -wrapper
1692 @opindex wrapper
1693 Invoke all subcommands under a wrapper program.  The name of the
1694 wrapper program and its parameters are passed as a comma separated
1695 list.
1697 @smallexample
1698 gcc -c t.c -wrapper gdb,--args
1699 @end smallexample
1701 @noindent
1702 This invokes all subprograms of @command{gcc} under
1703 @samp{gdb --args}, thus the invocation of @command{cc1} is
1704 @samp{gdb --args cc1 @dots{}}.
1706 @item -ffile-prefix-map=@var{old}=@var{new}
1707 @opindex ffile-prefix-map
1708 When compiling files residing in directory @file{@var{old}}, record
1709 any references to them in the result of the compilation as if the
1710 files resided in directory @file{@var{new}} instead.  Specifying this
1711 option is equivalent to specifying all the individual
1712 @option{-f*-prefix-map} options.  This can be used to make reproducible
1713 builds that are location independent.  See also
1714 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1716 @item -fplugin=@var{name}.so
1717 @opindex fplugin
1718 Load the plugin code in file @var{name}.so, assumed to be a
1719 shared object to be dlopen'd by the compiler.  The base name of
1720 the shared object file is used to identify the plugin for the
1721 purposes of argument parsing (See
1722 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1723 Each plugin should define the callback functions specified in the
1724 Plugins API.
1726 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1727 @opindex fplugin-arg
1728 Define an argument called @var{key} with a value of @var{value}
1729 for the plugin called @var{name}.
1731 @item -fdump-ada-spec@r{[}-slim@r{]}
1732 @opindex fdump-ada-spec
1733 For C and C++ source and include files, generate corresponding Ada specs.
1734 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1735 GNAT User's Guide}, which provides detailed documentation on this feature.
1737 @item -fada-spec-parent=@var{unit}
1738 @opindex fada-spec-parent
1739 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1740 Ada specs as child units of parent @var{unit}.
1742 @item -fdump-go-spec=@var{file}
1743 @opindex fdump-go-spec
1744 For input files in any language, generate corresponding Go
1745 declarations in @var{file}.  This generates Go @code{const},
1746 @code{type}, @code{var}, and @code{func} declarations which may be a
1747 useful way to start writing a Go interface to code written in some
1748 other language.
1750 @include @value{srcdir}/../libiberty/at-file.texi
1751 @end table
1753 @node Invoking G++
1754 @section Compiling C++ Programs
1756 @cindex suffixes for C++ source
1757 @cindex C++ source file suffixes
1758 C++ source files conventionally use one of the suffixes @samp{.C},
1759 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1760 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1761 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1762 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1763 files with these names and compiles them as C++ programs even if you
1764 call the compiler the same way as for compiling C programs (usually
1765 with the name @command{gcc}).
1767 @findex g++
1768 @findex c++
1769 However, the use of @command{gcc} does not add the C++ library.
1770 @command{g++} is a program that calls GCC and automatically specifies linking
1771 against the C++ library.  It treats @samp{.c},
1772 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1773 files unless @option{-x} is used.  This program is also useful when
1774 precompiling a C header file with a @samp{.h} extension for use in C++
1775 compilations.  On many systems, @command{g++} is also installed with
1776 the name @command{c++}.
1778 @cindex invoking @command{g++}
1779 When you compile C++ programs, you may specify many of the same
1780 command-line options that you use for compiling programs in any
1781 language; or command-line options meaningful for C and related
1782 languages; or options that are meaningful only for C++ programs.
1783 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1784 explanations of options for languages related to C@.
1785 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1786 explanations of options that are meaningful only for C++ programs.
1788 @node C Dialect Options
1789 @section Options Controlling C Dialect
1790 @cindex dialect options
1791 @cindex language dialect options
1792 @cindex options, dialect
1794 The following options control the dialect of C (or languages derived
1795 from C, such as C++, Objective-C and Objective-C++) that the compiler
1796 accepts:
1798 @table @gcctabopt
1799 @cindex ANSI support
1800 @cindex ISO support
1801 @item -ansi
1802 @opindex ansi
1803 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1804 equivalent to @option{-std=c++98}.
1806 This turns off certain features of GCC that are incompatible with ISO
1807 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1808 such as the @code{asm} and @code{typeof} keywords, and
1809 predefined macros such as @code{unix} and @code{vax} that identify the
1810 type of system you are using.  It also enables the undesirable and
1811 rarely used ISO trigraph feature.  For the C compiler,
1812 it disables recognition of C++ style @samp{//} comments as well as
1813 the @code{inline} keyword.
1815 The alternate keywords @code{__asm__}, @code{__extension__},
1816 @code{__inline__} and @code{__typeof__} continue to work despite
1817 @option{-ansi}.  You would not want to use them in an ISO C program, of
1818 course, but it is useful to put them in header files that might be included
1819 in compilations done with @option{-ansi}.  Alternate predefined macros
1820 such as @code{__unix__} and @code{__vax__} are also available, with or
1821 without @option{-ansi}.
1823 The @option{-ansi} option does not cause non-ISO programs to be
1824 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1825 addition to @option{-ansi}.  @xref{Warning Options}.
1827 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1828 option is used.  Some header files may notice this macro and refrain
1829 from declaring certain functions or defining certain macros that the
1830 ISO standard doesn't call for; this is to avoid interfering with any
1831 programs that might use these names for other things.
1833 Functions that are normally built in but do not have semantics
1834 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1835 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1836 built-in functions provided by GCC}, for details of the functions
1837 affected.
1839 @item -std=
1840 @opindex std
1841 Determine the language standard. @xref{Standards,,Language Standards
1842 Supported by GCC}, for details of these standard versions.  This option
1843 is currently only supported when compiling C or C++.
1845 The compiler can accept several base standards, such as @samp{c90} or
1846 @samp{c++98}, and GNU dialects of those standards, such as
1847 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1848 compiler accepts all programs following that standard plus those
1849 using GNU extensions that do not contradict it.  For example,
1850 @option{-std=c90} turns off certain features of GCC that are
1851 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1852 keywords, but not other GNU extensions that do not have a meaning in
1853 ISO C90, such as omitting the middle term of a @code{?:}
1854 expression. On the other hand, when a GNU dialect of a standard is
1855 specified, all features supported by the compiler are enabled, even when
1856 those features change the meaning of the base standard.  As a result, some
1857 strict-conforming programs may be rejected.  The particular standard
1858 is used by @option{-Wpedantic} to identify which features are GNU
1859 extensions given that version of the standard. For example
1860 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1861 comments, while @option{-std=gnu99 -Wpedantic} does not.
1863 A value for this option must be provided; possible values are
1865 @table @samp
1866 @item c90
1867 @itemx c89
1868 @itemx iso9899:1990
1869 Support all ISO C90 programs (certain GNU extensions that conflict
1870 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1872 @item iso9899:199409
1873 ISO C90 as modified in amendment 1.
1875 @item c99
1876 @itemx c9x
1877 @itemx iso9899:1999
1878 @itemx iso9899:199x
1879 ISO C99.  This standard is substantially completely supported, modulo
1880 bugs and floating-point issues
1881 (mainly but not entirely relating to optional C99 features from
1882 Annexes F and G).  See
1883 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1884 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1886 @item c11
1887 @itemx c1x
1888 @itemx iso9899:2011
1889 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1890 substantially completely supported, modulo bugs, floating-point issues
1891 (mainly but not entirely relating to optional C11 features from
1892 Annexes F and G) and the optional Annexes K (Bounds-checking
1893 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1895 @item c17
1896 @itemx c18
1897 @itemx iso9899:2017
1898 @itemx iso9899:2018
1899 ISO C17, the 2017 revision of the ISO C standard (expected to be
1900 published in 2018).  This standard is
1901 same as C11 except for corrections of defects (all of which are also
1902 applied with @option{-std=c11}) and a new value of
1903 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1905 @item gnu90
1906 @itemx gnu89
1907 GNU dialect of ISO C90 (including some C99 features).
1909 @item gnu99
1910 @itemx gnu9x
1911 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1913 @item gnu11
1914 @itemx gnu1x
1915 GNU dialect of ISO C11.
1916 The name @samp{gnu1x} is deprecated.
1918 @item gnu17
1919 @itemx gnu18
1920 GNU dialect of ISO C17.  This is the default for C code.
1922 @item c++98
1923 @itemx c++03
1924 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1925 additional defect reports. Same as @option{-ansi} for C++ code.
1927 @item gnu++98
1928 @itemx gnu++03
1929 GNU dialect of @option{-std=c++98}.
1931 @item c++11
1932 @itemx c++0x
1933 The 2011 ISO C++ standard plus amendments.
1934 The name @samp{c++0x} is deprecated.
1936 @item gnu++11
1937 @itemx gnu++0x
1938 GNU dialect of @option{-std=c++11}.
1939 The name @samp{gnu++0x} is deprecated.
1941 @item c++14
1942 @itemx c++1y
1943 The 2014 ISO C++ standard plus amendments.
1944 The name @samp{c++1y} is deprecated.
1946 @item gnu++14
1947 @itemx gnu++1y
1948 GNU dialect of @option{-std=c++14}.
1949 This is the default for C++ code.
1950 The name @samp{gnu++1y} is deprecated.
1952 @item c++17
1953 @itemx c++1z
1954 The 2017 ISO C++ standard plus amendments.
1955 The name @samp{c++1z} is deprecated.
1957 @item gnu++17
1958 @itemx gnu++1z
1959 GNU dialect of @option{-std=c++17}.
1960 The name @samp{gnu++1z} is deprecated.
1962 @item c++2a
1963 The next revision of the ISO C++ standard, tentatively planned for
1964 2020.  Support is highly experimental, and will almost certainly
1965 change in incompatible ways in future releases.
1967 @item gnu++2a
1968 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1969 and will almost certainly change in incompatible ways in future
1970 releases.
1971 @end table
1973 @item -fgnu89-inline
1974 @opindex fgnu89-inline
1975 The option @option{-fgnu89-inline} tells GCC to use the traditional
1976 GNU semantics for @code{inline} functions when in C99 mode.
1977 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1978 Using this option is roughly equivalent to adding the
1979 @code{gnu_inline} function attribute to all inline functions
1980 (@pxref{Function Attributes}).
1982 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1983 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1984 specifies the default behavior).
1985 This option is not supported in @option{-std=c90} or
1986 @option{-std=gnu90} mode.
1988 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1989 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1990 in effect for @code{inline} functions.  @xref{Common Predefined
1991 Macros,,,cpp,The C Preprocessor}.
1993 @item -fpermitted-flt-eval-methods=@var{style}
1994 @opindex fpermitted-flt-eval-methods
1995 @opindex fpermitted-flt-eval-methods=c11
1996 @opindex fpermitted-flt-eval-methods=ts-18661-3
1997 ISO/IEC TS 18661-3 defines new permissible values for
1998 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1999 a semantic type that is an interchange or extended format should be
2000 evaluated to the precision and range of that type.  These new values are
2001 a superset of those permitted under C99/C11, which does not specify the
2002 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2003 conforming to C11 may not have been written expecting the possibility of
2004 the new values.
2006 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2007 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2008 or the extended set of values specified in ISO/IEC TS 18661-3.
2010 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2012 The default when in a standards compliant mode (@option{-std=c11} or similar)
2013 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2014 dialect (@option{-std=gnu11} or similar) is
2015 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2017 @item -aux-info @var{filename}
2018 @opindex aux-info
2019 Output to the given filename prototyped declarations for all functions
2020 declared and/or defined in a translation unit, including those in header
2021 files.  This option is silently ignored in any language other than C@.
2023 Besides declarations, the file indicates, in comments, the origin of
2024 each declaration (source file and line), whether the declaration was
2025 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2026 @samp{O} for old, respectively, in the first character after the line
2027 number and the colon), and whether it came from a declaration or a
2028 definition (@samp{C} or @samp{F}, respectively, in the following
2029 character).  In the case of function definitions, a K&R-style list of
2030 arguments followed by their declarations is also provided, inside
2031 comments, after the declaration.
2033 @item -fallow-parameterless-variadic-functions
2034 @opindex fallow-parameterless-variadic-functions
2035 Accept variadic functions without named parameters.
2037 Although it is possible to define such a function, this is not very
2038 useful as it is not possible to read the arguments.  This is only
2039 supported for C as this construct is allowed by C++.
2041 @item -fno-asm
2042 @opindex fno-asm
2043 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2044 keyword, so that code can use these words as identifiers.  You can use
2045 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2046 instead.  @option{-ansi} implies @option{-fno-asm}.
2048 In C++, this switch only affects the @code{typeof} keyword, since
2049 @code{asm} and @code{inline} are standard keywords.  You may want to
2050 use the @option{-fno-gnu-keywords} flag instead, which has the same
2051 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2052 switch only affects the @code{asm} and @code{typeof} keywords, since
2053 @code{inline} is a standard keyword in ISO C99.
2055 @item -fno-builtin
2056 @itemx -fno-builtin-@var{function}
2057 @opindex fno-builtin
2058 @cindex built-in functions
2059 Don't recognize built-in functions that do not begin with
2060 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2061 functions provided by GCC}, for details of the functions affected,
2062 including those which are not built-in functions when @option{-ansi} or
2063 @option{-std} options for strict ISO C conformance are used because they
2064 do not have an ISO standard meaning.
2066 GCC normally generates special code to handle certain built-in functions
2067 more efficiently; for instance, calls to @code{alloca} may become single
2068 instructions which adjust the stack directly, and calls to @code{memcpy}
2069 may become inline copy loops.  The resulting code is often both smaller
2070 and faster, but since the function calls no longer appear as such, you
2071 cannot set a breakpoint on those calls, nor can you change the behavior
2072 of the functions by linking with a different library.  In addition,
2073 when a function is recognized as a built-in function, GCC may use
2074 information about that function to warn about problems with calls to
2075 that function, or to generate more efficient code, even if the
2076 resulting code still contains calls to that function.  For example,
2077 warnings are given with @option{-Wformat} for bad calls to
2078 @code{printf} when @code{printf} is built in and @code{strlen} is
2079 known not to modify global memory.
2081 With the @option{-fno-builtin-@var{function}} option
2082 only the built-in function @var{function} is
2083 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2084 function is named that is not built-in in this version of GCC, this
2085 option is ignored.  There is no corresponding
2086 @option{-fbuiltin-@var{function}} option; if you wish to enable
2087 built-in functions selectively when using @option{-fno-builtin} or
2088 @option{-ffreestanding}, you may define macros such as:
2090 @smallexample
2091 #define abs(n)          __builtin_abs ((n))
2092 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2093 @end smallexample
2095 @item -fgimple
2096 @opindex fgimple
2098 Enable parsing of function definitions marked with @code{__GIMPLE}.
2099 This is an experimental feature that allows unit testing of GIMPLE
2100 passes.
2102 @item -fhosted
2103 @opindex fhosted
2104 @cindex hosted environment
2106 Assert that compilation targets a hosted environment.  This implies
2107 @option{-fbuiltin}.  A hosted environment is one in which the
2108 entire standard library is available, and in which @code{main} has a return
2109 type of @code{int}.  Examples are nearly everything except a kernel.
2110 This is equivalent to @option{-fno-freestanding}.
2112 @item -ffreestanding
2113 @opindex ffreestanding
2114 @cindex hosted environment
2116 Assert that compilation targets a freestanding environment.  This
2117 implies @option{-fno-builtin}.  A freestanding environment
2118 is one in which the standard library may not exist, and program startup may
2119 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2120 This is equivalent to @option{-fno-hosted}.
2122 @xref{Standards,,Language Standards Supported by GCC}, for details of
2123 freestanding and hosted environments.
2125 @item -fopenacc
2126 @opindex fopenacc
2127 @cindex OpenACC accelerator programming
2128 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2129 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2130 compiler generates accelerated code according to the OpenACC Application
2131 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2132 implies @option{-pthread}, and thus is only supported on targets that
2133 have support for @option{-pthread}.
2135 @item -fopenacc-dim=@var{geom}
2136 @opindex fopenacc-dim
2137 @cindex OpenACC accelerator programming
2138 Specify default compute dimensions for parallel offload regions that do
2139 not explicitly specify.  The @var{geom} value is a triple of
2140 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2141 can be omitted, to use a target-specific default value.
2143 @item -fopenmp
2144 @opindex fopenmp
2145 @cindex OpenMP parallel
2146 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2147 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2148 compiler generates parallel code according to the OpenMP Application
2149 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2150 implies @option{-pthread}, and thus is only supported on targets that
2151 have support for @option{-pthread}. @option{-fopenmp} implies
2152 @option{-fopenmp-simd}.
2154 @item -fopenmp-simd
2155 @opindex fopenmp-simd
2156 @cindex OpenMP SIMD
2157 @cindex SIMD
2158 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2159 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2160 are ignored.
2162 @item -fgnu-tm
2163 @opindex fgnu-tm
2164 When the option @option{-fgnu-tm} is specified, the compiler
2165 generates code for the Linux variant of Intel's current Transactional
2166 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2167 an experimental feature whose interface may change in future versions
2168 of GCC, as the official specification changes.  Please note that not
2169 all architectures are supported for this feature.
2171 For more information on GCC's support for transactional memory,
2172 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2173 Transactional Memory Library}.
2175 Note that the transactional memory feature is not supported with
2176 non-call exceptions (@option{-fnon-call-exceptions}).
2178 @item -fms-extensions
2179 @opindex fms-extensions
2180 Accept some non-standard constructs used in Microsoft header files.
2182 In C++ code, this allows member names in structures to be similar
2183 to previous types declarations.
2185 @smallexample
2186 typedef int UOW;
2187 struct ABC @{
2188   UOW UOW;
2190 @end smallexample
2192 Some cases of unnamed fields in structures and unions are only
2193 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2194 fields within structs/unions}, for details.
2196 Note that this option is off for all targets but x86 
2197 targets using ms-abi.
2199 @item -fplan9-extensions
2200 @opindex fplan9-extensions
2201 Accept some non-standard constructs used in Plan 9 code.
2203 This enables @option{-fms-extensions}, permits passing pointers to
2204 structures with anonymous fields to functions that expect pointers to
2205 elements of the type of the field, and permits referring to anonymous
2206 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2207 struct/union fields within structs/unions}, for details.  This is only
2208 supported for C, not C++.
2210 @item -fcond-mismatch
2211 @opindex fcond-mismatch
2212 Allow conditional expressions with mismatched types in the second and
2213 third arguments.  The value of such an expression is void.  This option
2214 is not supported for C++.
2216 @item -flax-vector-conversions
2217 @opindex flax-vector-conversions
2218 Allow implicit conversions between vectors with differing numbers of
2219 elements and/or incompatible element types.  This option should not be
2220 used for new code.
2222 @item -funsigned-char
2223 @opindex funsigned-char
2224 Let the type @code{char} be unsigned, like @code{unsigned char}.
2226 Each kind of machine has a default for what @code{char} should
2227 be.  It is either like @code{unsigned char} by default or like
2228 @code{signed char} by default.
2230 Ideally, a portable program should always use @code{signed char} or
2231 @code{unsigned char} when it depends on the signedness of an object.
2232 But many programs have been written to use plain @code{char} and
2233 expect it to be signed, or expect it to be unsigned, depending on the
2234 machines they were written for.  This option, and its inverse, let you
2235 make such a program work with the opposite default.
2237 The type @code{char} is always a distinct type from each of
2238 @code{signed char} or @code{unsigned char}, even though its behavior
2239 is always just like one of those two.
2241 @item -fsigned-char
2242 @opindex fsigned-char
2243 Let the type @code{char} be signed, like @code{signed char}.
2245 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2246 the negative form of @option{-funsigned-char}.  Likewise, the option
2247 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2249 @item -fsigned-bitfields
2250 @itemx -funsigned-bitfields
2251 @itemx -fno-signed-bitfields
2252 @itemx -fno-unsigned-bitfields
2253 @opindex fsigned-bitfields
2254 @opindex funsigned-bitfields
2255 @opindex fno-signed-bitfields
2256 @opindex fno-unsigned-bitfields
2257 These options control whether a bit-field is signed or unsigned, when the
2258 declaration does not use either @code{signed} or @code{unsigned}.  By
2259 default, such a bit-field is signed, because this is consistent: the
2260 basic integer types such as @code{int} are signed types.
2262 @item -fsso-struct=@var{endianness}
2263 @opindex fsso-struct
2264 Set the default scalar storage order of structures and unions to the
2265 specified endianness.  The accepted values are @samp{big-endian},
2266 @samp{little-endian} and @samp{native} for the native endianness of
2267 the target (the default).  This option is not supported for C++.
2269 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2270 code that is not binary compatible with code generated without it if the
2271 specified endianness is not the native endianness of the target.
2272 @end table
2274 @node C++ Dialect Options
2275 @section Options Controlling C++ Dialect
2277 @cindex compiler options, C++
2278 @cindex C++ options, command-line
2279 @cindex options, C++
2280 This section describes the command-line options that are only meaningful
2281 for C++ programs.  You can also use most of the GNU compiler options
2282 regardless of what language your program is in.  For example, you
2283 might compile a file @file{firstClass.C} like this:
2285 @smallexample
2286 g++ -g -fstrict-enums -O -c firstClass.C
2287 @end smallexample
2289 @noindent
2290 In this example, only @option{-fstrict-enums} is an option meant
2291 only for C++ programs; you can use the other options with any
2292 language supported by GCC@.
2294 Some options for compiling C programs, such as @option{-std}, are also
2295 relevant for C++ programs.
2296 @xref{C Dialect Options,,Options Controlling C Dialect}.
2298 Here is a list of options that are @emph{only} for compiling C++ programs:
2300 @table @gcctabopt
2302 @item -fabi-version=@var{n}
2303 @opindex fabi-version
2304 Use version @var{n} of the C++ ABI@.  The default is version 0.
2306 Version 0 refers to the version conforming most closely to
2307 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2308 will change in different versions of G++ as ABI bugs are fixed.
2310 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2312 Version 2 is the version of the C++ ABI that first appeared in G++
2313 3.4, and was the default through G++ 4.9.
2315 Version 3 corrects an error in mangling a constant address as a
2316 template argument.
2318 Version 4, which first appeared in G++ 4.5, implements a standard
2319 mangling for vector types.
2321 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2322 attribute const/volatile on function pointer types, decltype of a
2323 plain decl, and use of a function parameter in the declaration of
2324 another parameter.
2326 Version 6, which first appeared in G++ 4.7, corrects the promotion
2327 behavior of C++11 scoped enums and the mangling of template argument
2328 packs, const/static_cast, prefix ++ and --, and a class scope function
2329 used as a template argument.
2331 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2332 builtin type and corrects the mangling of lambdas in default argument
2333 scope.
2335 Version 8, which first appeared in G++ 4.9, corrects the substitution
2336 behavior of function types with function-cv-qualifiers.
2338 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2339 @code{nullptr_t}.
2341 Version 10, which first appeared in G++ 6.1, adds mangling of
2342 attributes that affect type identity, such as ia32 calling convention
2343 attributes (e.g. @samp{stdcall}).
2345 Version 11, which first appeared in G++ 7, corrects the mangling of
2346 sizeof... expressions and operator names.  For multiple entities with
2347 the same name within a function, that are declared in different scopes,
2348 the mangling now changes starting with the twelfth occurrence.  It also
2349 implies @option{-fnew-inheriting-ctors}.
2351 Version 12, which first appeared in G++ 8, corrects the calling
2352 conventions for empty classes on the x86_64 target and for classes
2353 with only deleted copy/move constructors.  It accidentally changes the
2354 calling convention for classes with a deleted copy constructor and a
2355 trivial move constructor.
2357 Version 13, which first appeared in G++ 8.2, fixes the accidental
2358 change in version 12.
2360 See also @option{-Wabi}.
2362 @item -fabi-compat-version=@var{n}
2363 @opindex fabi-compat-version
2364 On targets that support strong aliases, G++
2365 works around mangling changes by creating an alias with the correct
2366 mangled name when defining a symbol with an incorrect mangled name.
2367 This switch specifies which ABI version to use for the alias.
2369 With @option{-fabi-version=0} (the default), this defaults to 11 (GCC 7
2370 compatibility).  If another ABI version is explicitly selected, this
2371 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2372 use @option{-fabi-compat-version=2}.
2374 If this option is not provided but @option{-Wabi=@var{n}} is, that
2375 version is used for compatibility aliases.  If this option is provided
2376 along with @option{-Wabi} (without the version), the version from this
2377 option is used for the warning.
2379 @item -fno-access-control
2380 @opindex fno-access-control
2381 Turn off all access checking.  This switch is mainly useful for working
2382 around bugs in the access control code.
2384 @item -faligned-new
2385 @opindex faligned-new
2386 Enable support for C++17 @code{new} of types that require more
2387 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2388 numeric argument such as @code{-faligned-new=32} can be used to
2389 specify how much alignment (in bytes) is provided by that function,
2390 but few users will need to override the default of
2391 @code{alignof(std::max_align_t)}.
2393 This flag is enabled by default for @option{-std=c++17}.
2395 @item -fcheck-new
2396 @opindex fcheck-new
2397 Check that the pointer returned by @code{operator new} is non-null
2398 before attempting to modify the storage allocated.  This check is
2399 normally unnecessary because the C++ standard specifies that
2400 @code{operator new} only returns @code{0} if it is declared
2401 @code{throw()}, in which case the compiler always checks the
2402 return value even without this option.  In all other cases, when
2403 @code{operator new} has a non-empty exception specification, memory
2404 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2405 @samp{new (nothrow)}.
2407 @item -fconcepts
2408 @opindex fconcepts
2409 Enable support for the C++ Extensions for Concepts Technical
2410 Specification, ISO 19217 (2015), which allows code like
2412 @smallexample
2413 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2414 template <Addable T> T add (T a, T b) @{ return a + b; @}
2415 @end smallexample
2417 @item -fconstexpr-depth=@var{n}
2418 @opindex fconstexpr-depth
2419 Set the maximum nested evaluation depth for C++11 constexpr functions
2420 to @var{n}.  A limit is needed to detect endless recursion during
2421 constant expression evaluation.  The minimum specified by the standard
2422 is 512.
2424 @item -fconstexpr-loop-limit=@var{n}
2425 @opindex fconstexpr-loop-limit
2426 Set the maximum number of iterations for a loop in C++14 constexpr functions
2427 to @var{n}.  A limit is needed to detect infinite loops during
2428 constant expression evaluation.  The default is 262144 (1<<18).
2430 @item -fdeduce-init-list
2431 @opindex fdeduce-init-list
2432 Enable deduction of a template type parameter as
2433 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2435 @smallexample
2436 template <class T> auto forward(T t) -> decltype (realfn (t))
2438   return realfn (t);
2441 void f()
2443   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2445 @end smallexample
2447 This deduction was implemented as a possible extension to the
2448 originally proposed semantics for the C++11 standard, but was not part
2449 of the final standard, so it is disabled by default.  This option is
2450 deprecated, and may be removed in a future version of G++.
2452 @item -fno-elide-constructors
2453 @opindex fno-elide-constructors
2454 The C++ standard allows an implementation to omit creating a temporary
2455 that is only used to initialize another object of the same type.
2456 Specifying this option disables that optimization, and forces G++ to
2457 call the copy constructor in all cases.  This option also causes G++
2458 to call trivial member functions which otherwise would be expanded inline.
2460 In C++17, the compiler is required to omit these temporaries, but this
2461 option still affects trivial member functions.
2463 @item -fno-enforce-eh-specs
2464 @opindex fno-enforce-eh-specs
2465 Don't generate code to check for violation of exception specifications
2466 at run time.  This option violates the C++ standard, but may be useful
2467 for reducing code size in production builds, much like defining
2468 @code{NDEBUG}.  This does not give user code permission to throw
2469 exceptions in violation of the exception specifications; the compiler
2470 still optimizes based on the specifications, so throwing an
2471 unexpected exception results in undefined behavior at run time.
2473 @item -fextern-tls-init
2474 @itemx -fno-extern-tls-init
2475 @opindex fextern-tls-init
2476 @opindex fno-extern-tls-init
2477 The C++11 and OpenMP standards allow @code{thread_local} and
2478 @code{threadprivate} variables to have dynamic (runtime)
2479 initialization.  To support this, any use of such a variable goes
2480 through a wrapper function that performs any necessary initialization.
2481 When the use and definition of the variable are in the same
2482 translation unit, this overhead can be optimized away, but when the
2483 use is in a different translation unit there is significant overhead
2484 even if the variable doesn't actually need dynamic initialization.  If
2485 the programmer can be sure that no use of the variable in a
2486 non-defining TU needs to trigger dynamic initialization (either
2487 because the variable is statically initialized, or a use of the
2488 variable in the defining TU will be executed before any uses in
2489 another TU), they can avoid this overhead with the
2490 @option{-fno-extern-tls-init} option.
2492 On targets that support symbol aliases, the default is
2493 @option{-fextern-tls-init}.  On targets that do not support symbol
2494 aliases, the default is @option{-fno-extern-tls-init}.
2496 @item -fno-gnu-keywords
2497 @opindex fno-gnu-keywords
2498 Do not recognize @code{typeof} as a keyword, so that code can use this
2499 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2500 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2501 @option{-std=c++98}, @option{-std=c++11}, etc.
2503 @item -fno-implicit-templates
2504 @opindex fno-implicit-templates
2505 Never emit code for non-inline templates that are instantiated
2506 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2507 @xref{Template Instantiation}, for more information.
2509 @item -fno-implicit-inline-templates
2510 @opindex fno-implicit-inline-templates
2511 Don't emit code for implicit instantiations of inline templates, either.
2512 The default is to handle inlines differently so that compiles with and
2513 without optimization need the same set of explicit instantiations.
2515 @item -fno-implement-inlines
2516 @opindex fno-implement-inlines
2517 To save space, do not emit out-of-line copies of inline functions
2518 controlled by @code{#pragma implementation}.  This causes linker
2519 errors if these functions are not inlined everywhere they are called.
2521 @item -fms-extensions
2522 @opindex fms-extensions
2523 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2524 int and getting a pointer to member function via non-standard syntax.
2526 @item -fnew-inheriting-ctors
2527 @opindex fnew-inheriting-ctors
2528 Enable the P0136 adjustment to the semantics of C++11 constructor
2529 inheritance.  This is part of C++17 but also considered to be a Defect
2530 Report against C++11 and C++14.  This flag is enabled by default
2531 unless @option{-fabi-version=10} or lower is specified.
2533 @item -fnew-ttp-matching
2534 @opindex fnew-ttp-matching
2535 Enable the P0522 resolution to Core issue 150, template template
2536 parameters and default arguments: this allows a template with default
2537 template arguments as an argument for a template template parameter
2538 with fewer template parameters.  This flag is enabled by default for
2539 @option{-std=c++17}.
2541 @item -fno-nonansi-builtins
2542 @opindex fno-nonansi-builtins
2543 Disable built-in declarations of functions that are not mandated by
2544 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2545 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2547 @item -fnothrow-opt
2548 @opindex fnothrow-opt
2549 Treat a @code{throw()} exception specification as if it were a
2550 @code{noexcept} specification to reduce or eliminate the text size
2551 overhead relative to a function with no exception specification.  If
2552 the function has local variables of types with non-trivial
2553 destructors, the exception specification actually makes the
2554 function smaller because the EH cleanups for those variables can be
2555 optimized away.  The semantic effect is that an exception thrown out of
2556 a function with such an exception specification results in a call
2557 to @code{terminate} rather than @code{unexpected}.
2559 @item -fno-operator-names
2560 @opindex fno-operator-names
2561 Do not treat the operator name keywords @code{and}, @code{bitand},
2562 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2563 synonyms as keywords.
2565 @item -fno-optional-diags
2566 @opindex fno-optional-diags
2567 Disable diagnostics that the standard says a compiler does not need to
2568 issue.  Currently, the only such diagnostic issued by G++ is the one for
2569 a name having multiple meanings within a class.
2571 @item -fpermissive
2572 @opindex fpermissive
2573 Downgrade some diagnostics about nonconformant code from errors to
2574 warnings.  Thus, using @option{-fpermissive} allows some
2575 nonconforming code to compile.
2577 @item -fno-pretty-templates
2578 @opindex fno-pretty-templates
2579 When an error message refers to a specialization of a function
2580 template, the compiler normally prints the signature of the
2581 template followed by the template arguments and any typedefs or
2582 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2583 rather than @code{void f(int)}) so that it's clear which template is
2584 involved.  When an error message refers to a specialization of a class
2585 template, the compiler omits any template arguments that match
2586 the default template arguments for that template.  If either of these
2587 behaviors make it harder to understand the error message rather than
2588 easier, you can use @option{-fno-pretty-templates} to disable them.
2590 @item -frepo
2591 @opindex frepo
2592 Enable automatic template instantiation at link time.  This option also
2593 implies @option{-fno-implicit-templates}.  @xref{Template
2594 Instantiation}, for more information.
2596 @item -fno-rtti
2597 @opindex fno-rtti
2598 Disable generation of information about every class with virtual
2599 functions for use by the C++ run-time type identification features
2600 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2601 of the language, you can save some space by using this flag.  Note that
2602 exception handling uses the same information, but G++ generates it as
2603 needed. The @code{dynamic_cast} operator can still be used for casts that
2604 do not require run-time type information, i.e.@: casts to @code{void *} or to
2605 unambiguous base classes.
2607 @item -fsized-deallocation
2608 @opindex fsized-deallocation
2609 Enable the built-in global declarations
2610 @smallexample
2611 void operator delete (void *, std::size_t) noexcept;
2612 void operator delete[] (void *, std::size_t) noexcept;
2613 @end smallexample
2614 as introduced in C++14.  This is useful for user-defined replacement
2615 deallocation functions that, for example, use the size of the object
2616 to make deallocation faster.  Enabled by default under
2617 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2618 warns about places that might want to add a definition.
2620 @item -fstrict-enums
2621 @opindex fstrict-enums
2622 Allow the compiler to optimize using the assumption that a value of
2623 enumerated type can only be one of the values of the enumeration (as
2624 defined in the C++ standard; basically, a value that can be
2625 represented in the minimum number of bits needed to represent all the
2626 enumerators).  This assumption may not be valid if the program uses a
2627 cast to convert an arbitrary integer value to the enumerated type.
2629 @item -fstrong-eval-order
2630 @opindex fstrong-eval-order
2631 Evaluate member access, array subscripting, and shift expressions in
2632 left-to-right order, and evaluate assignment in right-to-left order,
2633 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2634 @option{-fstrong-eval-order=some} enables just the ordering of member
2635 access and shift expressions, and is the default without
2636 @option{-std=c++17}.
2638 @item -ftemplate-backtrace-limit=@var{n}
2639 @opindex ftemplate-backtrace-limit
2640 Set the maximum number of template instantiation notes for a single
2641 warning or error to @var{n}.  The default value is 10.
2643 @item -ftemplate-depth=@var{n}
2644 @opindex ftemplate-depth
2645 Set the maximum instantiation depth for template classes to @var{n}.
2646 A limit on the template instantiation depth is needed to detect
2647 endless recursions during template class instantiation.  ANSI/ISO C++
2648 conforming programs must not rely on a maximum depth greater than 17
2649 (changed to 1024 in C++11).  The default value is 900, as the compiler
2650 can run out of stack space before hitting 1024 in some situations.
2652 @item -fno-threadsafe-statics
2653 @opindex fno-threadsafe-statics
2654 Do not emit the extra code to use the routines specified in the C++
2655 ABI for thread-safe initialization of local statics.  You can use this
2656 option to reduce code size slightly in code that doesn't need to be
2657 thread-safe.
2659 @item -fuse-cxa-atexit
2660 @opindex fuse-cxa-atexit
2661 Register destructors for objects with static storage duration with the
2662 @code{__cxa_atexit} function rather than the @code{atexit} function.
2663 This option is required for fully standards-compliant handling of static
2664 destructors, but only works if your C library supports
2665 @code{__cxa_atexit}.
2667 @item -fno-use-cxa-get-exception-ptr
2668 @opindex fno-use-cxa-get-exception-ptr
2669 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2670 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2671 if the runtime routine is not available.
2673 @item -fvisibility-inlines-hidden
2674 @opindex fvisibility-inlines-hidden
2675 This switch declares that the user does not attempt to compare
2676 pointers to inline functions or methods where the addresses of the two functions
2677 are taken in different shared objects.
2679 The effect of this is that GCC may, effectively, mark inline methods with
2680 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2681 appear in the export table of a DSO and do not require a PLT indirection
2682 when used within the DSO@.  Enabling this option can have a dramatic effect
2683 on load and link times of a DSO as it massively reduces the size of the
2684 dynamic export table when the library makes heavy use of templates.
2686 The behavior of this switch is not quite the same as marking the
2687 methods as hidden directly, because it does not affect static variables
2688 local to the function or cause the compiler to deduce that
2689 the function is defined in only one shared object.
2691 You may mark a method as having a visibility explicitly to negate the
2692 effect of the switch for that method.  For example, if you do want to
2693 compare pointers to a particular inline method, you might mark it as
2694 having default visibility.  Marking the enclosing class with explicit
2695 visibility has no effect.
2697 Explicitly instantiated inline methods are unaffected by this option
2698 as their linkage might otherwise cross a shared library boundary.
2699 @xref{Template Instantiation}.
2701 @item -fvisibility-ms-compat
2702 @opindex fvisibility-ms-compat
2703 This flag attempts to use visibility settings to make GCC's C++
2704 linkage model compatible with that of Microsoft Visual Studio.
2706 The flag makes these changes to GCC's linkage model:
2708 @enumerate
2709 @item
2710 It sets the default visibility to @code{hidden}, like
2711 @option{-fvisibility=hidden}.
2713 @item
2714 Types, but not their members, are not hidden by default.
2716 @item
2717 The One Definition Rule is relaxed for types without explicit
2718 visibility specifications that are defined in more than one
2719 shared object: those declarations are permitted if they are
2720 permitted when this option is not used.
2721 @end enumerate
2723 In new code it is better to use @option{-fvisibility=hidden} and
2724 export those classes that are intended to be externally visible.
2725 Unfortunately it is possible for code to rely, perhaps accidentally,
2726 on the Visual Studio behavior.
2728 Among the consequences of these changes are that static data members
2729 of the same type with the same name but defined in different shared
2730 objects are different, so changing one does not change the other;
2731 and that pointers to function members defined in different shared
2732 objects may not compare equal.  When this flag is given, it is a
2733 violation of the ODR to define types with the same name differently.
2735 @item -fno-weak
2736 @opindex fno-weak
2737 Do not use weak symbol support, even if it is provided by the linker.
2738 By default, G++ uses weak symbols if they are available.  This
2739 option exists only for testing, and should not be used by end-users;
2740 it results in inferior code and has no benefits.  This option may
2741 be removed in a future release of G++.
2743 @item -nostdinc++
2744 @opindex nostdinc++
2745 Do not search for header files in the standard directories specific to
2746 C++, but do still search the other standard directories.  (This option
2747 is used when building the C++ library.)
2748 @end table
2750 In addition, these optimization, warning, and code generation options
2751 have meanings only for C++ programs:
2753 @table @gcctabopt
2754 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2755 @opindex Wabi
2756 @opindex Wno-abi
2757 Warn when G++ it generates code that is probably not compatible with
2758 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2759 ABI with each major release, normally @option{-Wabi} will warn only if
2760 there is a check added later in a release series for an ABI issue
2761 discovered since the initial release.  @option{-Wabi} will warn about
2762 more things if an older ABI version is selected (with
2763 @option{-fabi-version=@var{n}}).
2765 @option{-Wabi} can also be used with an explicit version number to
2766 warn about compatibility with a particular @option{-fabi-version}
2767 level, e.g. @option{-Wabi=2} to warn about changes relative to
2768 @option{-fabi-version=2}.
2770 If an explicit version number is provided and
2771 @option{-fabi-compat-version} is not specified, the version number
2772 from this option is used for compatibility aliases.  If no explicit
2773 version number is provided with this option, but
2774 @option{-fabi-compat-version} is specified, that version number is
2775 used for ABI warnings.
2777 Although an effort has been made to warn about
2778 all such cases, there are probably some cases that are not warned about,
2779 even though G++ is generating incompatible code.  There may also be
2780 cases where warnings are emitted even though the code that is generated
2781 is compatible.
2783 You should rewrite your code to avoid these warnings if you are
2784 concerned about the fact that code generated by G++ may not be binary
2785 compatible with code generated by other compilers.
2787 Known incompatibilities in @option{-fabi-version=2} (which was the
2788 default from GCC 3.4 to 4.9) include:
2790 @itemize @bullet
2792 @item
2793 A template with a non-type template parameter of reference type was
2794 mangled incorrectly:
2795 @smallexample
2796 extern int N;
2797 template <int &> struct S @{@};
2798 void n (S<N>) @{2@}
2799 @end smallexample
2801 This was fixed in @option{-fabi-version=3}.
2803 @item
2804 SIMD vector types declared using @code{__attribute ((vector_size))} were
2805 mangled in a non-standard way that does not allow for overloading of
2806 functions taking vectors of different sizes.
2808 The mangling was changed in @option{-fabi-version=4}.
2810 @item
2811 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2812 qualifiers, and @code{decltype} of a plain declaration was folded away.
2814 These mangling issues were fixed in @option{-fabi-version=5}.
2816 @item
2817 Scoped enumerators passed as arguments to a variadic function are
2818 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2819 On most targets this does not actually affect the parameter passing
2820 ABI, as there is no way to pass an argument smaller than @code{int}.
2822 Also, the ABI changed the mangling of template argument packs,
2823 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2824 a class scope function used as a template argument.
2826 These issues were corrected in @option{-fabi-version=6}.
2828 @item
2829 Lambdas in default argument scope were mangled incorrectly, and the
2830 ABI changed the mangling of @code{nullptr_t}.
2832 These issues were corrected in @option{-fabi-version=7}.
2834 @item
2835 When mangling a function type with function-cv-qualifiers, the
2836 un-qualified function type was incorrectly treated as a substitution
2837 candidate.
2839 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2841 @item
2842 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2843 unaligned accesses.  Note that this did not affect the ABI of a
2844 function with a @code{nullptr_t} parameter, as parameters have a
2845 minimum alignment.
2847 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2849 @item
2850 Target-specific attributes that affect the identity of a type, such as
2851 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2852 did not affect the mangled name, leading to name collisions when
2853 function pointers were used as template arguments.
2855 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2857 @end itemize
2859 It also warns about psABI-related changes.  The known psABI changes at this
2860 point include:
2862 @itemize @bullet
2864 @item
2865 For SysV/x86-64, unions with @code{long double} members are 
2866 passed in memory as specified in psABI.  For example:
2868 @smallexample
2869 union U @{
2870   long double ld;
2871   int i;
2873 @end smallexample
2875 @noindent
2876 @code{union U} is always passed in memory.
2878 @end itemize
2880 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2881 @opindex Wabi-tag
2882 @opindex -Wabi-tag
2883 Warn when a type with an ABI tag is used in a context that does not
2884 have that ABI tag.  See @ref{C++ Attributes} for more information
2885 about ABI tags.
2887 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2888 @opindex Wctor-dtor-privacy
2889 @opindex Wno-ctor-dtor-privacy
2890 Warn when a class seems unusable because all the constructors or
2891 destructors in that class are private, and it has neither friends nor
2892 public static member functions.  Also warn if there are no non-private
2893 methods, and there's at least one private member function that isn't
2894 a constructor or destructor.
2896 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2897 @opindex Wdelete-non-virtual-dtor
2898 @opindex Wno-delete-non-virtual-dtor
2899 Warn when @code{delete} is used to destroy an instance of a class that
2900 has virtual functions and non-virtual destructor. It is unsafe to delete
2901 an instance of a derived class through a pointer to a base class if the
2902 base class does not have a virtual destructor.  This warning is enabled
2903 by @option{-Wall}.
2905 @item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
2906 @opindex Wdeprecated-copy
2907 @opindex Wno-deprecated-copy
2908 Warn that the implicit declaration of a copy constructor or copy
2909 assignment operator is deprecated if the class has a user-provided
2910 copy constructor, copy assignment operator, or destructor, in C++11
2911 and up.  This warning is enabled by @option{-Wall}.
2913 @item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)}
2914 @opindex Winit-list-lifetime
2915 @opindex Wno-init-list-lifetime
2916 Do not warn about uses of @code{std::initializer_list} that are likely
2917 to result in dangling pointers.  Since the underlying array for an
2918 @code{initializer_list} is handled like a normal C++ temporary object,
2919 it is easy to inadvertently keep a pointer to the array past the end
2920 of the array's lifetime.  For example:
2922 @itemize @bullet
2923 @item
2924 If a function returns a temporary @code{initializer_list}, or a local
2925 @code{initializer_list} variable, the array's lifetime ends at the end
2926 of the return statement, so the value returned has a dangling pointer.
2928 @item
2929 If a new-expression creates an @code{initializer_list}, the array only
2930 lives until the end of the enclosing full-expression, so the
2931 @code{initializer_list} in the heap has a dangling pointer.
2933 @item
2934 When an @code{initializer_list} variable is assigned from a
2935 brace-enclosed initializer list, the temporary array created for the
2936 right side of the assignment only lives until the end of the
2937 full-expression, so at the next statement the @code{initializer_list}
2938 variable has a dangling pointer.
2940 @smallexample
2941 // li's initial underlying array lives as long as li
2942 std::initializer_list<int> li = @{ 1,2,3 @};
2943 // assignment changes li to point to a temporary array
2944 li = @{ 4, 5 @};
2945 // now the temporary is gone and li has a dangling pointer
2946 int i = li.begin()[0] // undefined behavior
2947 @end smallexample
2949 @item
2950 When a list constructor stores the @code{begin} pointer from the
2951 @code{initializer_list} argument, this doesn't extend the lifetime of
2952 the array, so if a class variable is constructed from a temporary
2953 @code{initializer_list}, the pointer is left dangling by the end of
2954 the variable declaration statement.
2956 @end itemize
2958 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2959 @opindex Wliteral-suffix
2960 @opindex Wno-literal-suffix
2961 Warn when a string or character literal is followed by a ud-suffix which does
2962 not begin with an underscore.  As a conforming extension, GCC treats such
2963 suffixes as separate preprocessing tokens in order to maintain backwards
2964 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2965 For example:
2967 @smallexample
2968 #define __STDC_FORMAT_MACROS
2969 #include <inttypes.h>
2970 #include <stdio.h>
2972 int main() @{
2973   int64_t i64 = 123;
2974   printf("My int64: %" PRId64"\n", i64);
2976 @end smallexample
2978 In this case, @code{PRId64} is treated as a separate preprocessing token.
2980 Additionally, warn when a user-defined literal operator is declared with
2981 a literal suffix identifier that doesn't begin with an underscore. Literal
2982 suffix identifiers that don't begin with an underscore are reserved for
2983 future standardization.
2985 This warning is enabled by default.
2987 @item -Wlto-type-mismatch
2988 @opindex Wlto-type-mismatch
2989 @opindex Wno-lto-type-mismatch
2991 During the link-time optimization warn about type mismatches in
2992 global declarations from different compilation units.
2993 Requires @option{-flto} to be enabled.  Enabled by default.
2995 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2996 @opindex Wnarrowing
2997 @opindex Wno-narrowing
2998 For C++11 and later standards, narrowing conversions are diagnosed by default,
2999 as required by the standard.  A narrowing conversion from a constant produces
3000 an error, and a narrowing conversion from a non-constant produces a warning,
3001 but @option{-Wno-narrowing} suppresses the diagnostic.
3002 Note that this does not affect the meaning of well-formed code;
3003 narrowing conversions are still considered ill-formed in SFINAE contexts.
3005 With @option{-Wnarrowing} in C++98, warn when a narrowing
3006 conversion prohibited by C++11 occurs within
3007 @samp{@{ @}}, e.g.
3009 @smallexample
3010 int i = @{ 2.2 @}; // error: narrowing from double to int
3011 @end smallexample
3013 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
3015 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
3016 @opindex Wnoexcept
3017 @opindex Wno-noexcept
3018 Warn when a noexcept-expression evaluates to false because of a call
3019 to a function that does not have a non-throwing exception
3020 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
3021 the compiler to never throw an exception.
3023 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
3024 @opindex Wnoexcept-type
3025 @opindex Wno-noexcept-type
3026 Warn if the C++17 feature making @code{noexcept} part of a function
3027 type changes the mangled name of a symbol relative to C++14.  Enabled
3028 by @option{-Wabi} and @option{-Wc++17-compat}.
3030 As an example:
3032 @smallexample
3033 template <class T> void f(T t) @{ t(); @};
3034 void g() noexcept;
3035 void h() @{ f(g); @} 
3036 @end smallexample
3038 @noindent
3039 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
3040 C++17 it calls @code{f<void(*)()noexcept>}.
3042 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3043 @opindex Wclass-memaccess
3044 @opindex Wno-class-memaccess
3045 Warn when the destination of a call to a raw memory function such as
3046 @code{memset} or @code{memcpy} is an object of class type, and when writing
3047 into such an object might bypass the class non-trivial or deleted constructor
3048 or copy assignment, violate const-correctness or encapsulation, or corrupt
3049 virtual table pointers.  Modifying the representation of such objects may
3050 violate invariants maintained by member functions of the class.  For example,
3051 the call to @code{memset} below is undefined because it modifies a non-trivial
3052 class object and is, therefore, diagnosed.  The safe way to either initialize
3053 or clear the storage of objects of such types is by using the appropriate
3054 constructor or assignment operator, if one is available.
3055 @smallexample
3056 std::string str = "abc";
3057 memset (&str, 0, sizeof str);
3058 @end smallexample
3059 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3060 Explicitly casting the pointer to the class object to @code{void *} or
3061 to a type that can be safely accessed by the raw memory function suppresses
3062 the warning.
3064 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3065 @opindex Wnon-virtual-dtor
3066 @opindex Wno-non-virtual-dtor
3067 Warn when a class has virtual functions and an accessible non-virtual
3068 destructor itself or in an accessible polymorphic base class, in which
3069 case it is possible but unsafe to delete an instance of a derived
3070 class through a pointer to the class itself or base class.  This
3071 warning is automatically enabled if @option{-Weffc++} is specified.
3073 @item -Wregister @r{(C++ and Objective-C++ only)}
3074 @opindex Wregister
3075 @opindex Wno-register
3076 Warn on uses of the @code{register} storage class specifier, except
3077 when it is part of the GNU @ref{Explicit Register Variables} extension.
3078 The use of the @code{register} keyword as storage class specifier has
3079 been deprecated in C++11 and removed in C++17.
3080 Enabled by default with @option{-std=c++17}.
3082 @item -Wreorder @r{(C++ and Objective-C++ only)}
3083 @opindex Wreorder
3084 @opindex Wno-reorder
3085 @cindex reordering, warning
3086 @cindex warning for reordering of member initializers
3087 Warn when the order of member initializers given in the code does not
3088 match the order in which they must be executed.  For instance:
3090 @smallexample
3091 struct A @{
3092   int i;
3093   int j;
3094   A(): j (0), i (1) @{ @}
3096 @end smallexample
3098 @noindent
3099 The compiler rearranges the member initializers for @code{i}
3100 and @code{j} to match the declaration order of the members, emitting
3101 a warning to that effect.  This warning is enabled by @option{-Wall}.
3103 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3104 @opindex fext-numeric-literals
3105 @opindex fno-ext-numeric-literals
3106 Accept imaginary, fixed-point, or machine-defined
3107 literal number suffixes as GNU extensions.
3108 When this option is turned off these suffixes are treated
3109 as C++11 user-defined literal numeric suffixes.
3110 This is on by default for all pre-C++11 dialects and all GNU dialects:
3111 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3112 @option{-std=gnu++14}.
3113 This option is off by default
3114 for ISO C++11 onwards (@option{-std=c++11}, ...).
3115 @end table
3117 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3119 @table @gcctabopt
3120 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3121 @opindex Weffc++
3122 @opindex Wno-effc++
3123 Warn about violations of the following style guidelines from Scott Meyers'
3124 @cite{Effective C++} series of books:
3126 @itemize @bullet
3127 @item
3128 Define a copy constructor and an assignment operator for classes
3129 with dynamically-allocated memory.
3131 @item
3132 Prefer initialization to assignment in constructors.
3134 @item
3135 Have @code{operator=} return a reference to @code{*this}.
3137 @item
3138 Don't try to return a reference when you must return an object.
3140 @item
3141 Distinguish between prefix and postfix forms of increment and
3142 decrement operators.
3144 @item
3145 Never overload @code{&&}, @code{||}, or @code{,}.
3147 @end itemize
3149 This option also enables @option{-Wnon-virtual-dtor}, which is also
3150 one of the effective C++ recommendations.  However, the check is
3151 extended to warn about the lack of virtual destructor in accessible
3152 non-polymorphic bases classes too.
3154 When selecting this option, be aware that the standard library
3155 headers do not obey all of these guidelines; use @samp{grep -v}
3156 to filter out those warnings.
3158 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3159 @opindex Wstrict-null-sentinel
3160 @opindex Wno-strict-null-sentinel
3161 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3162 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3163 to @code{__null}.  Although it is a null pointer constant rather than a
3164 null pointer, it is guaranteed to be of the same size as a pointer.
3165 But this use is not portable across different compilers.
3167 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3168 @opindex Wno-non-template-friend
3169 @opindex Wnon-template-friend
3170 Disable warnings when non-template friend functions are declared
3171 within a template.  In very old versions of GCC that predate implementation
3172 of the ISO standard, declarations such as 
3173 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3174 could be interpreted as a particular specialization of a template
3175 function; the warning exists to diagnose compatibility problems, 
3176 and is enabled by default.
3178 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3179 @opindex Wold-style-cast
3180 @opindex Wno-old-style-cast
3181 Warn if an old-style (C-style) cast to a non-void type is used within
3182 a C++ program.  The new-style casts (@code{dynamic_cast},
3183 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3184 less vulnerable to unintended effects and much easier to search for.
3186 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3187 @opindex Woverloaded-virtual
3188 @opindex Wno-overloaded-virtual
3189 @cindex overloaded virtual function, warning
3190 @cindex warning for overloaded virtual function
3191 Warn when a function declaration hides virtual functions from a
3192 base class.  For example, in:
3194 @smallexample
3195 struct A @{
3196   virtual void f();
3199 struct B: public A @{
3200   void f(int);
3202 @end smallexample
3204 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3205 like:
3207 @smallexample
3208 B* b;
3209 b->f();
3210 @end smallexample
3212 @noindent
3213 fails to compile.
3215 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3216 @opindex Wno-pmf-conversions
3217 @opindex Wpmf-conversions
3218 Disable the diagnostic for converting a bound pointer to member function
3219 to a plain pointer.
3221 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3222 @opindex Wsign-promo
3223 @opindex Wno-sign-promo
3224 Warn when overload resolution chooses a promotion from unsigned or
3225 enumerated type to a signed type, over a conversion to an unsigned type of
3226 the same size.  Previous versions of G++ tried to preserve
3227 unsignedness, but the standard mandates the current behavior.
3229 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3230 @opindex Wtemplates
3231 @opindex Wno-templates
3232 Warn when a primary template declaration is encountered.  Some coding
3233 rules disallow templates, and this may be used to enforce that rule.
3234 The warning is inactive inside a system header file, such as the STL, so
3235 one can still use the STL.  One may also instantiate or specialize
3236 templates.
3238 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3239 @opindex Wmultiple-inheritance
3240 @opindex Wno-multiple-inheritance
3241 Warn when a class is defined with multiple direct base classes.  Some
3242 coding rules disallow multiple inheritance, and this may be used to
3243 enforce that rule.  The warning is inactive inside a system header file,
3244 such as the STL, so one can still use the STL.  One may also define
3245 classes that indirectly use multiple inheritance.
3247 @item -Wvirtual-inheritance
3248 @opindex Wvirtual-inheritance
3249 @opindex Wno-virtual-inheritance
3250 Warn when a class is defined with a virtual direct base class.  Some
3251 coding rules disallow multiple inheritance, and this may be used to
3252 enforce that rule.  The warning is inactive inside a system header file,
3253 such as the STL, so one can still use the STL.  One may also define
3254 classes that indirectly use virtual inheritance.
3256 @item -Wnamespaces
3257 @opindex Wnamespaces
3258 @opindex Wno-namespaces
3259 Warn when a namespace definition is opened.  Some coding rules disallow
3260 namespaces, and this may be used to enforce that rule.  The warning is
3261 inactive inside a system header file, such as the STL, so one can still
3262 use the STL.  One may also use using directives and qualified names.
3264 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3265 @opindex Wterminate
3266 @opindex Wno-terminate
3267 Disable the warning about a throw-expression that will immediately
3268 result in a call to @code{terminate}.
3269 @end table
3271 @node Objective-C and Objective-C++ Dialect Options
3272 @section Options Controlling Objective-C and Objective-C++ Dialects
3274 @cindex compiler options, Objective-C and Objective-C++
3275 @cindex Objective-C and Objective-C++ options, command-line
3276 @cindex options, Objective-C and Objective-C++
3277 (NOTE: This manual does not describe the Objective-C and Objective-C++
3278 languages themselves.  @xref{Standards,,Language Standards
3279 Supported by GCC}, for references.)
3281 This section describes the command-line options that are only meaningful
3282 for Objective-C and Objective-C++ programs.  You can also use most of
3283 the language-independent GNU compiler options.
3284 For example, you might compile a file @file{some_class.m} like this:
3286 @smallexample
3287 gcc -g -fgnu-runtime -O -c some_class.m
3288 @end smallexample
3290 @noindent
3291 In this example, @option{-fgnu-runtime} is an option meant only for
3292 Objective-C and Objective-C++ programs; you can use the other options with
3293 any language supported by GCC@.
3295 Note that since Objective-C is an extension of the C language, Objective-C
3296 compilations may also use options specific to the C front-end (e.g.,
3297 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3298 C++-specific options (e.g., @option{-Wabi}).
3300 Here is a list of options that are @emph{only} for compiling Objective-C
3301 and Objective-C++ programs:
3303 @table @gcctabopt
3304 @item -fconstant-string-class=@var{class-name}
3305 @opindex fconstant-string-class
3306 Use @var{class-name} as the name of the class to instantiate for each
3307 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3308 class name is @code{NXConstantString} if the GNU runtime is being used, and
3309 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3310 @option{-fconstant-cfstrings} option, if also present, overrides the
3311 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3312 to be laid out as constant CoreFoundation strings.
3314 @item -fgnu-runtime
3315 @opindex fgnu-runtime
3316 Generate object code compatible with the standard GNU Objective-C
3317 runtime.  This is the default for most types of systems.
3319 @item -fnext-runtime
3320 @opindex fnext-runtime
3321 Generate output compatible with the NeXT runtime.  This is the default
3322 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3323 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3324 used.
3326 @item -fno-nil-receivers
3327 @opindex fno-nil-receivers
3328 Assume that all Objective-C message dispatches (@code{[receiver
3329 message:arg]}) in this translation unit ensure that the receiver is
3330 not @code{nil}.  This allows for more efficient entry points in the
3331 runtime to be used.  This option is only available in conjunction with
3332 the NeXT runtime and ABI version 0 or 1.
3334 @item -fobjc-abi-version=@var{n}
3335 @opindex fobjc-abi-version
3336 Use version @var{n} of the Objective-C ABI for the selected runtime.
3337 This option is currently supported only for the NeXT runtime.  In that
3338 case, Version 0 is the traditional (32-bit) ABI without support for
3339 properties and other Objective-C 2.0 additions.  Version 1 is the
3340 traditional (32-bit) ABI with support for properties and other
3341 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3342 nothing is specified, the default is Version 0 on 32-bit target
3343 machines, and Version 2 on 64-bit target machines.
3345 @item -fobjc-call-cxx-cdtors
3346 @opindex fobjc-call-cxx-cdtors
3347 For each Objective-C class, check if any of its instance variables is a
3348 C++ object with a non-trivial default constructor.  If so, synthesize a
3349 special @code{- (id) .cxx_construct} instance method which runs
3350 non-trivial default constructors on any such instance variables, in order,
3351 and then return @code{self}.  Similarly, check if any instance variable
3352 is a C++ object with a non-trivial destructor, and if so, synthesize a
3353 special @code{- (void) .cxx_destruct} method which runs
3354 all such default destructors, in reverse order.
3356 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3357 methods thusly generated only operate on instance variables
3358 declared in the current Objective-C class, and not those inherited
3359 from superclasses.  It is the responsibility of the Objective-C
3360 runtime to invoke all such methods in an object's inheritance
3361 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3362 by the runtime immediately after a new object instance is allocated;
3363 the @code{- (void) .cxx_destruct} methods are invoked immediately
3364 before the runtime deallocates an object instance.
3366 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3367 support for invoking the @code{- (id) .cxx_construct} and
3368 @code{- (void) .cxx_destruct} methods.
3370 @item -fobjc-direct-dispatch
3371 @opindex fobjc-direct-dispatch
3372 Allow fast jumps to the message dispatcher.  On Darwin this is
3373 accomplished via the comm page.
3375 @item -fobjc-exceptions
3376 @opindex fobjc-exceptions
3377 Enable syntactic support for structured exception handling in
3378 Objective-C, similar to what is offered by C++.  This option
3379 is required to use the Objective-C keywords @code{@@try},
3380 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3381 @code{@@synchronized}.  This option is available with both the GNU
3382 runtime and the NeXT runtime (but not available in conjunction with
3383 the NeXT runtime on Mac OS X 10.2 and earlier).
3385 @item -fobjc-gc
3386 @opindex fobjc-gc
3387 Enable garbage collection (GC) in Objective-C and Objective-C++
3388 programs.  This option is only available with the NeXT runtime; the
3389 GNU runtime has a different garbage collection implementation that
3390 does not require special compiler flags.
3392 @item -fobjc-nilcheck
3393 @opindex fobjc-nilcheck
3394 For the NeXT runtime with version 2 of the ABI, check for a nil
3395 receiver in method invocations before doing the actual method call.
3396 This is the default and can be disabled using
3397 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3398 checked for nil in this way no matter what this flag is set to.
3399 Currently this flag does nothing when the GNU runtime, or an older
3400 version of the NeXT runtime ABI, is used.
3402 @item -fobjc-std=objc1
3403 @opindex fobjc-std
3404 Conform to the language syntax of Objective-C 1.0, the language
3405 recognized by GCC 4.0.  This only affects the Objective-C additions to
3406 the C/C++ language; it does not affect conformance to C/C++ standards,
3407 which is controlled by the separate C/C++ dialect option flags.  When
3408 this option is used with the Objective-C or Objective-C++ compiler,
3409 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3410 This is useful if you need to make sure that your Objective-C code can
3411 be compiled with older versions of GCC@.
3413 @item -freplace-objc-classes
3414 @opindex freplace-objc-classes
3415 Emit a special marker instructing @command{ld(1)} not to statically link in
3416 the resulting object file, and allow @command{dyld(1)} to load it in at
3417 run time instead.  This is used in conjunction with the Fix-and-Continue
3418 debugging mode, where the object file in question may be recompiled and
3419 dynamically reloaded in the course of program execution, without the need
3420 to restart the program itself.  Currently, Fix-and-Continue functionality
3421 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3422 and later.
3424 @item -fzero-link
3425 @opindex fzero-link
3426 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3427 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3428 compile time) with static class references that get initialized at load time,
3429 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3430 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3431 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3432 for individual class implementations to be modified during program execution.
3433 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3434 regardless of command-line options.
3436 @item -fno-local-ivars
3437 @opindex fno-local-ivars
3438 @opindex flocal-ivars
3439 By default instance variables in Objective-C can be accessed as if
3440 they were local variables from within the methods of the class they're
3441 declared in.  This can lead to shadowing between instance variables
3442 and other variables declared either locally inside a class method or
3443 globally with the same name.  Specifying the @option{-fno-local-ivars}
3444 flag disables this behavior thus avoiding variable shadowing issues.
3446 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3447 @opindex fivar-visibility
3448 Set the default instance variable visibility to the specified option
3449 so that instance variables declared outside the scope of any access
3450 modifier directives default to the specified visibility.
3452 @item -gen-decls
3453 @opindex gen-decls
3454 Dump interface declarations for all classes seen in the source file to a
3455 file named @file{@var{sourcename}.decl}.
3457 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3458 @opindex Wassign-intercept
3459 @opindex Wno-assign-intercept
3460 Warn whenever an Objective-C assignment is being intercepted by the
3461 garbage collector.
3463 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3464 @opindex Wno-protocol
3465 @opindex Wprotocol
3466 If a class is declared to implement a protocol, a warning is issued for
3467 every method in the protocol that is not implemented by the class.  The
3468 default behavior is to issue a warning for every method not explicitly
3469 implemented in the class, even if a method implementation is inherited
3470 from the superclass.  If you use the @option{-Wno-protocol} option, then
3471 methods inherited from the superclass are considered to be implemented,
3472 and no warning is issued for them.
3474 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3475 @opindex Wselector
3476 @opindex Wno-selector
3477 Warn if multiple methods of different types for the same selector are
3478 found during compilation.  The check is performed on the list of methods
3479 in the final stage of compilation.  Additionally, a check is performed
3480 for each selector appearing in a @code{@@selector(@dots{})}
3481 expression, and a corresponding method for that selector has been found
3482 during compilation.  Because these checks scan the method table only at
3483 the end of compilation, these warnings are not produced if the final
3484 stage of compilation is not reached, for example because an error is
3485 found during compilation, or because the @option{-fsyntax-only} option is
3486 being used.
3488 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3489 @opindex Wstrict-selector-match
3490 @opindex Wno-strict-selector-match
3491 Warn if multiple methods with differing argument and/or return types are
3492 found for a given selector when attempting to send a message using this
3493 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3494 is off (which is the default behavior), the compiler omits such warnings
3495 if any differences found are confined to types that share the same size
3496 and alignment.
3498 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3499 @opindex Wundeclared-selector
3500 @opindex Wno-undeclared-selector
3501 Warn if a @code{@@selector(@dots{})} expression referring to an
3502 undeclared selector is found.  A selector is considered undeclared if no
3503 method with that name has been declared before the
3504 @code{@@selector(@dots{})} expression, either explicitly in an
3505 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3506 an @code{@@implementation} section.  This option always performs its
3507 checks as soon as a @code{@@selector(@dots{})} expression is found,
3508 while @option{-Wselector} only performs its checks in the final stage of
3509 compilation.  This also enforces the coding style convention
3510 that methods and selectors must be declared before being used.
3512 @item -print-objc-runtime-info
3513 @opindex print-objc-runtime-info
3514 Generate C header describing the largest structure that is passed by
3515 value, if any.
3517 @end table
3519 @node Diagnostic Message Formatting Options
3520 @section Options to Control Diagnostic Messages Formatting
3521 @cindex options to control diagnostics formatting
3522 @cindex diagnostic messages
3523 @cindex message formatting
3525 Traditionally, diagnostic messages have been formatted irrespective of
3526 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3527 options described below
3528 to control the formatting algorithm for diagnostic messages, 
3529 e.g.@: how many characters per line, how often source location
3530 information should be reported.  Note that some language front ends may not
3531 honor these options.
3533 @table @gcctabopt
3534 @item -fmessage-length=@var{n}
3535 @opindex fmessage-length
3536 Try to format error messages so that they fit on lines of about
3537 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3538 done; each error message appears on a single line.  This is the
3539 default for all front ends.
3541 Note - this option also affects the display of the @samp{#error} and
3542 @samp{#warning} pre-processor directives, and the @samp{deprecated}
3543 function/type/variable attribute.  It does not however affect the
3544 @samp{pragma GCC warning} and @samp{pragma GCC error} pragmas.
3546 @item -fdiagnostics-show-location=once
3547 @opindex fdiagnostics-show-location
3548 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3549 reporter to emit source location information @emph{once}; that is, in
3550 case the message is too long to fit on a single physical line and has to
3551 be wrapped, the source location won't be emitted (as prefix) again,
3552 over and over, in subsequent continuation lines.  This is the default
3553 behavior.
3555 @item -fdiagnostics-show-location=every-line
3556 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3557 messages reporter to emit the same source location information (as
3558 prefix) for physical lines that result from the process of breaking
3559 a message which is too long to fit on a single line.
3561 @item -fdiagnostics-color[=@var{WHEN}]
3562 @itemx -fno-diagnostics-color
3563 @opindex fdiagnostics-color
3564 @cindex highlight, color
3565 @vindex GCC_COLORS @r{environment variable}
3566 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3567 or @samp{auto}.  The default depends on how the compiler has been configured,
3568 it can be any of the above @var{WHEN} options or also @samp{never}
3569 if @env{GCC_COLORS} environment variable isn't present in the environment,
3570 and @samp{auto} otherwise.
3571 @samp{auto} means to use color only when the standard error is a terminal.
3572 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3573 aliases for @option{-fdiagnostics-color=always} and
3574 @option{-fdiagnostics-color=never}, respectively.
3576 The colors are defined by the environment variable @env{GCC_COLORS}.
3577 Its value is a colon-separated list of capabilities and Select Graphic
3578 Rendition (SGR) substrings. SGR commands are interpreted by the
3579 terminal or terminal emulator.  (See the section in the documentation
3580 of your text terminal for permitted values and their meanings as
3581 character attributes.)  These substring values are integers in decimal
3582 representation and can be concatenated with semicolons.
3583 Common values to concatenate include
3584 @samp{1} for bold,
3585 @samp{4} for underline,
3586 @samp{5} for blink,
3587 @samp{7} for inverse,
3588 @samp{39} for default foreground color,
3589 @samp{30} to @samp{37} for foreground colors,
3590 @samp{90} to @samp{97} for 16-color mode foreground colors,
3591 @samp{38;5;0} to @samp{38;5;255}
3592 for 88-color and 256-color modes foreground colors,
3593 @samp{49} for default background color,
3594 @samp{40} to @samp{47} for background colors,
3595 @samp{100} to @samp{107} for 16-color mode background colors,
3596 and @samp{48;5;0} to @samp{48;5;255}
3597 for 88-color and 256-color modes background colors.
3599 The default @env{GCC_COLORS} is
3600 @smallexample
3601 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3602 quote=01:fixit-insert=32:fixit-delete=31:\
3603 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3604 type-diff=01;32
3605 @end smallexample
3606 @noindent
3607 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3608 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3609 @samp{01} is bold, and @samp{31} is red.
3610 Setting @env{GCC_COLORS} to the empty string disables colors.
3611 Supported capabilities are as follows.
3613 @table @code
3614 @item error=
3615 @vindex error GCC_COLORS @r{capability}
3616 SGR substring for error: markers.
3618 @item warning=
3619 @vindex warning GCC_COLORS @r{capability}
3620 SGR substring for warning: markers.
3622 @item note=
3623 @vindex note GCC_COLORS @r{capability}
3624 SGR substring for note: markers.
3626 @item range1=
3627 @vindex range1 GCC_COLORS @r{capability}
3628 SGR substring for first additional range.
3630 @item range2=
3631 @vindex range2 GCC_COLORS @r{capability}
3632 SGR substring for second additional range.
3634 @item locus=
3635 @vindex locus GCC_COLORS @r{capability}
3636 SGR substring for location information, @samp{file:line} or
3637 @samp{file:line:column} etc.
3639 @item quote=
3640 @vindex quote GCC_COLORS @r{capability}
3641 SGR substring for information printed within quotes.
3643 @item fixit-insert=
3644 @vindex fixit-insert GCC_COLORS @r{capability}
3645 SGR substring for fix-it hints suggesting text to
3646 be inserted or replaced.
3648 @item fixit-delete=
3649 @vindex fixit-delete GCC_COLORS @r{capability}
3650 SGR substring for fix-it hints suggesting text to
3651 be deleted.
3653 @item diff-filename=
3654 @vindex diff-filename GCC_COLORS @r{capability}
3655 SGR substring for filename headers within generated patches.
3657 @item diff-hunk=
3658 @vindex diff-hunk GCC_COLORS @r{capability}
3659 SGR substring for the starts of hunks within generated patches.
3661 @item diff-delete=
3662 @vindex diff-delete GCC_COLORS @r{capability}
3663 SGR substring for deleted lines within generated patches.
3665 @item diff-insert=
3666 @vindex diff-insert GCC_COLORS @r{capability}
3667 SGR substring for inserted lines within generated patches.
3669 @item type-diff=
3670 @vindex type-diff GCC_COLORS @r{capability}
3671 SGR substring for highlighting mismatching types within template
3672 arguments in the C++ frontend.
3673 @end table
3675 @item -fno-diagnostics-show-option
3676 @opindex fno-diagnostics-show-option
3677 @opindex fdiagnostics-show-option
3678 By default, each diagnostic emitted includes text indicating the
3679 command-line option that directly controls the diagnostic (if such an
3680 option is known to the diagnostic machinery).  Specifying the
3681 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3683 @item -fno-diagnostics-show-caret
3684 @opindex fno-diagnostics-show-caret
3685 @opindex fdiagnostics-show-caret
3686 By default, each diagnostic emitted includes the original source line
3687 and a caret @samp{^} indicating the column.  This option suppresses this
3688 information.  The source line is truncated to @var{n} characters, if
3689 the @option{-fmessage-length=n} option is given.  When the output is done
3690 to the terminal, the width is limited to the width given by the
3691 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3693 @item -fdiagnostics-parseable-fixits
3694 @opindex fdiagnostics-parseable-fixits
3695 Emit fix-it hints in a machine-parseable format, suitable for consumption
3696 by IDEs.  For each fix-it, a line will be printed after the relevant
3697 diagnostic, starting with the string ``fix-it:''.  For example:
3699 @smallexample
3700 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3701 @end smallexample
3703 The location is expressed as a half-open range, expressed as a count of
3704 bytes, starting at byte 1 for the initial column.  In the above example,
3705 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3706 given string:
3708 @smallexample
3709 00000000011111111112222222222
3710 12345678901234567890123456789
3711   gtk_widget_showall (dlg);
3712   ^^^^^^^^^^^^^^^^^^
3713   gtk_widget_show_all
3714 @end smallexample
3716 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3717 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3718 (e.g. vertical tab as ``\013'').
3720 An empty replacement string indicates that the given range is to be removed.
3721 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3722 be inserted at the given position.
3724 @item -fdiagnostics-generate-patch
3725 @opindex fdiagnostics-generate-patch
3726 Print fix-it hints to stderr in unified diff format, after any diagnostics
3727 are printed.  For example:
3729 @smallexample
3730 --- test.c
3731 +++ test.c
3732 @@ -42,5 +42,5 @@
3734  void show_cb(GtkDialog *dlg)
3735  @{
3736 -  gtk_widget_showall(dlg);
3737 +  gtk_widget_show_all(dlg);
3738  @}
3740 @end smallexample
3742 The diff may or may not be colorized, following the same rules
3743 as for diagnostics (see @option{-fdiagnostics-color}).
3745 @item -fdiagnostics-show-template-tree
3746 @opindex fdiagnostics-show-template-tree
3748 In the C++ frontend, when printing diagnostics showing mismatching
3749 template types, such as:
3751 @smallexample
3752   could not convert 'std::map<int, std::vector<double> >()'
3753     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3754 @end smallexample
3756 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3757 tree-like structure showing the common and differing parts of the types,
3758 such as:
3760 @smallexample
3761   map<
3762     [...],
3763     vector<
3764       [double != float]>>
3765 @end smallexample
3767 The parts that differ are highlighted with color (``double'' and
3768 ``float'' in this case).
3770 @item -fno-elide-type
3771 @opindex fno-elide-type
3772 @opindex felide-type
3773 By default when the C++ frontend prints diagnostics showing mismatching
3774 template types, common parts of the types are printed as ``[...]'' to
3775 simplify the error message.  For example:
3777 @smallexample
3778   could not convert 'std::map<int, std::vector<double> >()'
3779     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3780 @end smallexample
3782 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3783 This flag also affects the output of the
3784 @option{-fdiagnostics-show-template-tree} flag.
3786 @item -fno-show-column
3787 @opindex fno-show-column
3788 Do not print column numbers in diagnostics.  This may be necessary if
3789 diagnostics are being scanned by a program that does not understand the
3790 column numbers, such as @command{dejagnu}.
3792 @end table
3794 @node Warning Options
3795 @section Options to Request or Suppress Warnings
3796 @cindex options to control warnings
3797 @cindex warning messages
3798 @cindex messages, warning
3799 @cindex suppressing warnings
3801 Warnings are diagnostic messages that report constructions that
3802 are not inherently erroneous but that are risky or suggest there
3803 may have been an error.
3805 The following language-independent options do not enable specific
3806 warnings but control the kinds of diagnostics produced by GCC@.
3808 @table @gcctabopt
3809 @cindex syntax checking
3810 @item -fsyntax-only
3811 @opindex fsyntax-only
3812 Check the code for syntax errors, but don't do anything beyond that.
3814 @item -fmax-errors=@var{n}
3815 @opindex fmax-errors
3816 Limits the maximum number of error messages to @var{n}, at which point
3817 GCC bails out rather than attempting to continue processing the source
3818 code.  If @var{n} is 0 (the default), there is no limit on the number
3819 of error messages produced.  If @option{-Wfatal-errors} is also
3820 specified, then @option{-Wfatal-errors} takes precedence over this
3821 option.
3823 @item -w
3824 @opindex w
3825 Inhibit all warning messages.
3827 @item -Werror
3828 @opindex Werror
3829 @opindex Wno-error
3830 Make all warnings into errors.
3832 @item -Werror=
3833 @opindex Werror=
3834 @opindex Wno-error=
3835 Make the specified warning into an error.  The specifier for a warning
3836 is appended; for example @option{-Werror=switch} turns the warnings
3837 controlled by @option{-Wswitch} into errors.  This switch takes a
3838 negative form, to be used to negate @option{-Werror} for specific
3839 warnings; for example @option{-Wno-error=switch} makes
3840 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3841 is in effect.
3843 The warning message for each controllable warning includes the
3844 option that controls the warning.  That option can then be used with
3845 @option{-Werror=} and @option{-Wno-error=} as described above.
3846 (Printing of the option in the warning message can be disabled using the
3847 @option{-fno-diagnostics-show-option} flag.)
3849 Note that specifying @option{-Werror=}@var{foo} automatically implies
3850 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3851 imply anything.
3853 @item -Wfatal-errors
3854 @opindex Wfatal-errors
3855 @opindex Wno-fatal-errors
3856 This option causes the compiler to abort compilation on the first error
3857 occurred rather than trying to keep going and printing further error
3858 messages.
3860 @end table
3862 You can request many specific warnings with options beginning with
3863 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3864 implicit declarations.  Each of these specific warning options also
3865 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3866 example, @option{-Wno-implicit}.  This manual lists only one of the
3867 two forms, whichever is not the default.  For further
3868 language-specific options also refer to @ref{C++ Dialect Options} and
3869 @ref{Objective-C and Objective-C++ Dialect Options}.
3871 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3872 options, such as @option{-Wunused}, which may turn on further options,
3873 such as @option{-Wunused-value}. The combined effect of positive and
3874 negative forms is that more specific options have priority over less
3875 specific ones, independently of their position in the command-line. For
3876 options of the same specificity, the last one takes effect. Options
3877 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3878 as if they appeared at the end of the command-line.
3880 When an unrecognized warning option is requested (e.g.,
3881 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3882 that the option is not recognized.  However, if the @option{-Wno-} form
3883 is used, the behavior is slightly different: no diagnostic is
3884 produced for @option{-Wno-unknown-warning} unless other diagnostics
3885 are being produced.  This allows the use of new @option{-Wno-} options
3886 with old compilers, but if something goes wrong, the compiler
3887 warns that an unrecognized option is present.
3889 @table @gcctabopt
3890 @item -Wpedantic
3891 @itemx -pedantic
3892 @opindex pedantic
3893 @opindex Wpedantic
3894 @opindex Wno-pedantic
3895 Issue all the warnings demanded by strict ISO C and ISO C++;
3896 reject all programs that use forbidden extensions, and some other
3897 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3898 version of the ISO C standard specified by any @option{-std} option used.
3900 Valid ISO C and ISO C++ programs should compile properly with or without
3901 this option (though a rare few require @option{-ansi} or a
3902 @option{-std} option specifying the required version of ISO C)@.  However,
3903 without this option, certain GNU extensions and traditional C and C++
3904 features are supported as well.  With this option, they are rejected.
3906 @option{-Wpedantic} does not cause warning messages for use of the
3907 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3908 warnings are also disabled in the expression that follows
3909 @code{__extension__}.  However, only system header files should use
3910 these escape routes; application programs should avoid them.
3911 @xref{Alternate Keywords}.
3913 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3914 C conformance.  They soon find that it does not do quite what they want:
3915 it finds some non-ISO practices, but not all---only those for which
3916 ISO C @emph{requires} a diagnostic, and some others for which
3917 diagnostics have been added.
3919 A feature to report any failure to conform to ISO C might be useful in
3920 some instances, but would require considerable additional work and would
3921 be quite different from @option{-Wpedantic}.  We don't have plans to
3922 support such a feature in the near future.
3924 Where the standard specified with @option{-std} represents a GNU
3925 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3926 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3927 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3928 where they are required by the base standard.  (It does not make sense
3929 for such warnings to be given only for features not in the specified GNU
3930 C dialect, since by definition the GNU dialects of C include all
3931 features the compiler supports with the given option, and there would be
3932 nothing to warn about.)
3934 @item -pedantic-errors
3935 @opindex pedantic-errors
3936 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3937 requires a diagnostic, in some cases where there is undefined behavior
3938 at compile-time and in some other cases that do not prevent compilation
3939 of programs that are valid according to the standard. This is not
3940 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3941 by this option and not enabled by the latter and vice versa.
3943 @item -Wall
3944 @opindex Wall
3945 @opindex Wno-all
3946 This enables all the warnings about constructions that some users
3947 consider questionable, and that are easy to avoid (or modify to
3948 prevent the warning), even in conjunction with macros.  This also
3949 enables some language-specific warnings described in @ref{C++ Dialect
3950 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3952 @option{-Wall} turns on the following warning flags:
3954 @gccoptlist{-Waddress   @gol
3955 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3956 -Wbool-compare  @gol
3957 -Wbool-operation  @gol
3958 -Wc++11-compat  -Wc++14-compat  @gol
3959 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3960 -Wchar-subscripts  @gol
3961 -Wcomment  @gol
3962 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3963 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3964 -Wformat   @gol
3965 -Wint-in-bool-context  @gol
3966 -Wimplicit @r{(C and Objective-C only)} @gol
3967 -Wimplicit-int @r{(C and Objective-C only)} @gol
3968 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3969 -Winit-self @r{(only for C++)} @gol
3970 -Wlogical-not-parentheses @gol
3971 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3972 -Wmaybe-uninitialized @gol
3973 -Wmemset-elt-size @gol
3974 -Wmemset-transposed-args @gol
3975 -Wmisleading-indentation @r{(only for C/C++)} @gol
3976 -Wmissing-attributes @gol
3977 -Wmissing-braces @r{(only for C/ObjC)} @gol
3978 -Wmultistatement-macros  @gol
3979 -Wnarrowing @r{(only for C++)}  @gol
3980 -Wnonnull  @gol
3981 -Wnonnull-compare  @gol
3982 -Wopenmp-simd @gol
3983 -Wparentheses  @gol
3984 -Wpointer-sign  @gol
3985 -Wreorder   @gol
3986 -Wrestrict   @gol
3987 -Wreturn-type  @gol
3988 -Wsequence-point  @gol
3989 -Wsign-compare @r{(only in C++)}  @gol
3990 -Wsizeof-pointer-div @gol
3991 -Wsizeof-pointer-memaccess @gol
3992 -Wstrict-aliasing  @gol
3993 -Wstrict-overflow=1  @gol
3994 -Wswitch  @gol
3995 -Wtautological-compare  @gol
3996 -Wtrigraphs  @gol
3997 -Wuninitialized  @gol
3998 -Wunknown-pragmas  @gol
3999 -Wunused-function  @gol
4000 -Wunused-label     @gol
4001 -Wunused-value     @gol
4002 -Wunused-variable  @gol
4003 -Wvolatile-register-var @gol
4006 Note that some warning flags are not implied by @option{-Wall}.  Some of
4007 them warn about constructions that users generally do not consider
4008 questionable, but which occasionally you might wish to check for;
4009 others warn about constructions that are necessary or hard to avoid in
4010 some cases, and there is no simple way to modify the code to suppress
4011 the warning. Some of them are enabled by @option{-Wextra} but many of
4012 them must be enabled individually.
4014 @item -Wextra
4015 @opindex W
4016 @opindex Wextra
4017 @opindex Wno-extra
4018 This enables some extra warning flags that are not enabled by
4019 @option{-Wall}. (This option used to be called @option{-W}.  The older
4020 name is still supported, but the newer name is more descriptive.)
4022 @gccoptlist{-Wclobbered  @gol
4023 -Wcast-function-type  @gol
4024 -Wempty-body  @gol
4025 -Wignored-qualifiers @gol
4026 -Wimplicit-fallthrough=3 @gol
4027 -Wmissing-field-initializers  @gol
4028 -Wmissing-parameter-type @r{(C only)}  @gol
4029 -Wold-style-declaration @r{(C only)}  @gol
4030 -Woverride-init  @gol
4031 -Wsign-compare @r{(C only)} @gol
4032 -Wtype-limits  @gol
4033 -Wuninitialized  @gol
4034 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
4035 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
4036 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
4039 The option @option{-Wextra} also prints warning messages for the
4040 following cases:
4042 @itemize @bullet
4044 @item
4045 A pointer is compared against integer zero with @code{<}, @code{<=},
4046 @code{>}, or @code{>=}.
4048 @item
4049 (C++ only) An enumerator and a non-enumerator both appear in a
4050 conditional expression.
4052 @item
4053 (C++ only) Ambiguous virtual bases.
4055 @item
4056 (C++ only) Subscripting an array that has been declared @code{register}.
4058 @item
4059 (C++ only) Taking the address of a variable that has been declared
4060 @code{register}.
4062 @item
4063 (C++ only) A base class is not initialized in the copy constructor
4064 of a derived class.
4066 @end itemize
4068 @item -Wchar-subscripts
4069 @opindex Wchar-subscripts
4070 @opindex Wno-char-subscripts
4071 Warn if an array subscript has type @code{char}.  This is a common cause
4072 of error, as programmers often forget that this type is signed on some
4073 machines.
4074 This warning is enabled by @option{-Wall}.
4076 @item -Wchkp
4077 @opindex Wchkp
4078 @opindex Wno-chkp
4079 Warn about an invalid memory access that is found by Pointer Bounds Checker
4080 (@option{-fcheck-pointer-bounds}).
4082 @item -Wno-coverage-mismatch
4083 @opindex Wno-coverage-mismatch
4084 @opindex Wcoverage-mismatch
4085 Warn if feedback profiles do not match when using the
4086 @option{-fprofile-use} option.
4087 If a source file is changed between compiling with @option{-fprofile-gen} and
4088 with @option{-fprofile-use}, the files with the profile feedback can fail
4089 to match the source file and GCC cannot use the profile feedback
4090 information.  By default, this warning is enabled and is treated as an
4091 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4092 warning or @option{-Wno-error=coverage-mismatch} can be used to
4093 disable the error.  Disabling the error for this warning can result in
4094 poorly optimized code and is useful only in the
4095 case of very minor changes such as bug fixes to an existing code-base.
4096 Completely disabling the warning is not recommended.
4098 @item -Wno-cpp
4099 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4101 Suppress warning messages emitted by @code{#warning} directives.
4103 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4104 @opindex Wdouble-promotion
4105 @opindex Wno-double-promotion
4106 Give a warning when a value of type @code{float} is implicitly
4107 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4108 floating-point unit implement @code{float} in hardware, but emulate
4109 @code{double} in software.  On such a machine, doing computations
4110 using @code{double} values is much more expensive because of the
4111 overhead required for software emulation.
4113 It is easy to accidentally do computations with @code{double} because
4114 floating-point literals are implicitly of type @code{double}.  For
4115 example, in:
4116 @smallexample
4117 @group
4118 float area(float radius)
4120    return 3.14159 * radius * radius;
4122 @end group
4123 @end smallexample
4124 the compiler performs the entire computation with @code{double}
4125 because the floating-point literal is a @code{double}.
4127 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4128 @opindex Wduplicate-decl-specifier
4129 @opindex Wno-duplicate-decl-specifier
4130 Warn if a declaration has duplicate @code{const}, @code{volatile},
4131 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4132 @option{-Wall}.
4134 @item -Wformat
4135 @itemx -Wformat=@var{n}
4136 @opindex Wformat
4137 @opindex Wno-format
4138 @opindex ffreestanding
4139 @opindex fno-builtin
4140 @opindex Wformat=
4141 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4142 the arguments supplied have types appropriate to the format string
4143 specified, and that the conversions specified in the format string make
4144 sense.  This includes standard functions, and others specified by format
4145 attributes (@pxref{Function Attributes}), in the @code{printf},
4146 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4147 not in the C standard) families (or other target-specific families).
4148 Which functions are checked without format attributes having been
4149 specified depends on the standard version selected, and such checks of
4150 functions without the attribute specified are disabled by
4151 @option{-ffreestanding} or @option{-fno-builtin}.
4153 The formats are checked against the format features supported by GNU
4154 libc version 2.2.  These include all ISO C90 and C99 features, as well
4155 as features from the Single Unix Specification and some BSD and GNU
4156 extensions.  Other library implementations may not support all these
4157 features; GCC does not support warning about features that go beyond a
4158 particular library's limitations.  However, if @option{-Wpedantic} is used
4159 with @option{-Wformat}, warnings are given about format features not
4160 in the selected standard version (but not for @code{strfmon} formats,
4161 since those are not in any version of the C standard).  @xref{C Dialect
4162 Options,,Options Controlling C Dialect}.
4164 @table @gcctabopt
4165 @item -Wformat=1
4166 @itemx -Wformat
4167 @opindex Wformat
4168 @opindex Wformat=1
4169 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4170 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4171 @option{-Wformat} also checks for null format arguments for several
4172 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4173 aspects of this level of format checking can be disabled by the
4174 options: @option{-Wno-format-contains-nul},
4175 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4176 @option{-Wformat} is enabled by @option{-Wall}.
4178 @item -Wno-format-contains-nul
4179 @opindex Wno-format-contains-nul
4180 @opindex Wformat-contains-nul
4181 If @option{-Wformat} is specified, do not warn about format strings that
4182 contain NUL bytes.
4184 @item -Wno-format-extra-args
4185 @opindex Wno-format-extra-args
4186 @opindex Wformat-extra-args
4187 If @option{-Wformat} is specified, do not warn about excess arguments to a
4188 @code{printf} or @code{scanf} format function.  The C standard specifies
4189 that such arguments are ignored.
4191 Where the unused arguments lie between used arguments that are
4192 specified with @samp{$} operand number specifications, normally
4193 warnings are still given, since the implementation could not know what
4194 type to pass to @code{va_arg} to skip the unused arguments.  However,
4195 in the case of @code{scanf} formats, this option suppresses the
4196 warning if the unused arguments are all pointers, since the Single
4197 Unix Specification says that such unused arguments are allowed.
4199 @item -Wformat-overflow
4200 @itemx -Wformat-overflow=@var{level}
4201 @opindex Wformat-overflow
4202 @opindex Wno-format-overflow
4203 Warn about calls to formatted input/output functions such as @code{sprintf}
4204 and @code{vsprintf} that might overflow the destination buffer.  When the
4205 exact number of bytes written by a format directive cannot be determined
4206 at compile-time it is estimated based on heuristics that depend on the
4207 @var{level} argument and on optimization.  While enabling optimization
4208 will in most cases improve the accuracy of the warning, it may also
4209 result in false positives.
4211 @table @gcctabopt
4212 @item -Wformat-overflow
4213 @itemx -Wformat-overflow=1
4214 @opindex Wformat-overflow
4215 @opindex Wno-format-overflow
4216 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4217 employs a conservative approach that warns only about calls that most
4218 likely overflow the buffer.  At this level, numeric arguments to format
4219 directives with unknown values are assumed to have the value of one, and
4220 strings of unknown length to be empty.  Numeric arguments that are known
4221 to be bounded to a subrange of their type, or string arguments whose output
4222 is bounded either by their directive's precision or by a finite set of
4223 string literals, are assumed to take on the value within the range that
4224 results in the most bytes on output.  For example, the call to @code{sprintf}
4225 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4226 the terminating NUL character (@code{'\0'}) appended by the function
4227 to the destination buffer will be written past its end.  Increasing
4228 the size of the buffer by a single byte is sufficient to avoid the
4229 warning, though it may not be sufficient to avoid the overflow.
4231 @smallexample
4232 void f (int a, int b)
4234   char buf [13];
4235   sprintf (buf, "a = %i, b = %i\n", a, b);
4237 @end smallexample
4239 @item -Wformat-overflow=2
4240 Level @var{2} warns also about calls that might overflow the destination
4241 buffer given an argument of sufficient length or magnitude.  At level
4242 @var{2}, unknown numeric arguments are assumed to have the minimum
4243 representable value for signed types with a precision greater than 1, and
4244 the maximum representable value otherwise.  Unknown string arguments whose
4245 length cannot be assumed to be bounded either by the directive's precision,
4246 or by a finite set of string literals they may evaluate to, or the character
4247 array they may point to, are assumed to be 1 character long.
4249 At level @var{2}, the call in the example above is again diagnosed, but
4250 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4251 @code{%i} directive will write some of its digits beyond the end of
4252 the destination buffer.  To make the call safe regardless of the values
4253 of the two variables, the size of the destination buffer must be increased
4254 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4255 an informational note following the warning.
4257 An alternative to increasing the size of the destination buffer is to
4258 constrain the range of formatted values.  The maximum length of string
4259 arguments can be bounded by specifying the precision in the format
4260 directive.  When numeric arguments of format directives can be assumed
4261 to be bounded by less than the precision of their type, choosing
4262 an appropriate length modifier to the format specifier will reduce
4263 the required buffer size.  For example, if @var{a} and @var{b} in the
4264 example above can be assumed to be within the precision of
4265 the @code{short int} type then using either the @code{%hi} format
4266 directive or casting the argument to @code{short} reduces the maximum
4267 required size of the buffer to 24 bytes.
4269 @smallexample
4270 void f (int a, int b)
4272   char buf [23];
4273   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4275 @end smallexample
4276 @end table
4278 @item -Wno-format-zero-length
4279 @opindex Wno-format-zero-length
4280 @opindex Wformat-zero-length
4281 If @option{-Wformat} is specified, do not warn about zero-length formats.
4282 The C standard specifies that zero-length formats are allowed.
4285 @item -Wformat=2
4286 @opindex Wformat=2
4287 Enable @option{-Wformat} plus additional format checks.  Currently
4288 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4289 -Wformat-y2k}.
4291 @item -Wformat-nonliteral
4292 @opindex Wformat-nonliteral
4293 @opindex Wno-format-nonliteral
4294 If @option{-Wformat} is specified, also warn if the format string is not a
4295 string literal and so cannot be checked, unless the format function
4296 takes its format arguments as a @code{va_list}.
4298 @item -Wformat-security
4299 @opindex Wformat-security
4300 @opindex Wno-format-security
4301 If @option{-Wformat} is specified, also warn about uses of format
4302 functions that represent possible security problems.  At present, this
4303 warns about calls to @code{printf} and @code{scanf} functions where the
4304 format string is not a string literal and there are no format arguments,
4305 as in @code{printf (foo);}.  This may be a security hole if the format
4306 string came from untrusted input and contains @samp{%n}.  (This is
4307 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4308 in future warnings may be added to @option{-Wformat-security} that are not
4309 included in @option{-Wformat-nonliteral}.)
4311 @item -Wformat-signedness
4312 @opindex Wformat-signedness
4313 @opindex Wno-format-signedness
4314 If @option{-Wformat} is specified, also warn if the format string
4315 requires an unsigned argument and the argument is signed and vice versa.
4317 @item -Wformat-truncation
4318 @itemx -Wformat-truncation=@var{level}
4319 @opindex Wformat-truncation
4320 @opindex Wno-format-truncation
4321 Warn about calls to formatted input/output functions such as @code{snprintf}
4322 and @code{vsnprintf} that might result in output truncation.  When the exact
4323 number of bytes written by a format directive cannot be determined at
4324 compile-time it is estimated based on heuristics that depend on
4325 the @var{level} argument and on optimization.  While enabling optimization
4326 will in most cases improve the accuracy of the warning, it may also result
4327 in false positives.  Except as noted otherwise, the option uses the same
4328 logic @option{-Wformat-overflow}.
4330 @table @gcctabopt
4331 @item -Wformat-truncation
4332 @itemx -Wformat-truncation=1
4333 @opindex Wformat-truncation
4334 @opindex Wno-format-truncation
4335 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4336 employs a conservative approach that warns only about calls to bounded
4337 functions whose return value is unused and that will most likely result
4338 in output truncation.
4340 @item -Wformat-truncation=2
4341 Level @var{2} warns also about calls to bounded functions whose return
4342 value is used and that might result in truncation given an argument of
4343 sufficient length or magnitude.
4344 @end table
4346 @item -Wformat-y2k
4347 @opindex Wformat-y2k
4348 @opindex Wno-format-y2k
4349 If @option{-Wformat} is specified, also warn about @code{strftime}
4350 formats that may yield only a two-digit year.
4351 @end table
4353 @item -Wnonnull
4354 @opindex Wnonnull
4355 @opindex Wno-nonnull
4356 Warn about passing a null pointer for arguments marked as
4357 requiring a non-null value by the @code{nonnull} function attribute.
4359 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4360 can be disabled with the @option{-Wno-nonnull} option.
4362 @item -Wnonnull-compare
4363 @opindex Wnonnull-compare
4364 @opindex Wno-nonnull-compare
4365 Warn when comparing an argument marked with the @code{nonnull}
4366 function attribute against null inside the function.
4368 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4369 can be disabled with the @option{-Wno-nonnull-compare} option.
4371 @item -Wnull-dereference
4372 @opindex Wnull-dereference
4373 @opindex Wno-null-dereference
4374 Warn if the compiler detects paths that trigger erroneous or
4375 undefined behavior due to dereferencing a null pointer.  This option
4376 is only active when @option{-fdelete-null-pointer-checks} is active,
4377 which is enabled by optimizations in most targets.  The precision of
4378 the warnings depends on the optimization options used.
4380 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4381 @opindex Winit-self
4382 @opindex Wno-init-self
4383 Warn about uninitialized variables that are initialized with themselves.
4384 Note this option can only be used with the @option{-Wuninitialized} option.
4386 For example, GCC warns about @code{i} being uninitialized in the
4387 following snippet only when @option{-Winit-self} has been specified:
4388 @smallexample
4389 @group
4390 int f()
4392   int i = i;
4393   return i;
4395 @end group
4396 @end smallexample
4398 This warning is enabled by @option{-Wall} in C++.
4400 @item -Wimplicit-int @r{(C and Objective-C only)}
4401 @opindex Wimplicit-int
4402 @opindex Wno-implicit-int
4403 Warn when a declaration does not specify a type.
4404 This warning is enabled by @option{-Wall}.
4406 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4407 @opindex Wimplicit-function-declaration
4408 @opindex Wno-implicit-function-declaration
4409 Give a warning whenever a function is used before being declared. In
4410 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4411 enabled by default and it is made into an error by
4412 @option{-pedantic-errors}. This warning is also enabled by
4413 @option{-Wall}.
4415 @item -Wimplicit @r{(C and Objective-C only)}
4416 @opindex Wimplicit
4417 @opindex Wno-implicit
4418 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4419 This warning is enabled by @option{-Wall}.
4421 @item -Wimplicit-fallthrough
4422 @opindex Wimplicit-fallthrough
4423 @opindex Wno-implicit-fallthrough
4424 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4425 and @option{-Wno-implicit-fallthrough} is the same as
4426 @option{-Wimplicit-fallthrough=0}.
4428 @item -Wimplicit-fallthrough=@var{n}
4429 @opindex Wimplicit-fallthrough=
4430 Warn when a switch case falls through.  For example:
4432 @smallexample
4433 @group
4434 switch (cond)
4435   @{
4436   case 1:
4437     a = 1;
4438     break;
4439   case 2:
4440     a = 2;
4441   case 3:
4442     a = 3;
4443     break;
4444   @}
4445 @end group
4446 @end smallexample
4448 This warning does not warn when the last statement of a case cannot
4449 fall through, e.g. when there is a return statement or a call to function
4450 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4451 also takes into account control flow statements, such as ifs, and only
4452 warns when appropriate.  E.g.@:
4454 @smallexample
4455 @group
4456 switch (cond)
4457   @{
4458   case 1:
4459     if (i > 3) @{
4460       bar (5);
4461       break;
4462     @} else if (i < 1) @{
4463       bar (0);
4464     @} else
4465       return;
4466   default:
4467     @dots{}
4468   @}
4469 @end group
4470 @end smallexample
4472 Since there are occasions where a switch case fall through is desirable,
4473 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4474 to be used along with a null statement to suppress this warning that
4475 would normally occur:
4477 @smallexample
4478 @group
4479 switch (cond)
4480   @{
4481   case 1:
4482     bar (0);
4483     __attribute__ ((fallthrough));
4484   default:
4485     @dots{}
4486   @}
4487 @end group
4488 @end smallexample
4490 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4491 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4492 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4493 Instead of these attributes, it is also possible to add a fallthrough comment
4494 to silence the warning.  The whole body of the C or C++ style comment should
4495 match the given regular expressions listed below.  The option argument @var{n}
4496 specifies what kind of comments are accepted:
4498 @itemize @bullet
4500 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4502 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4503 expression, any comment is used as fallthrough comment.
4505 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4506 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4508 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4509 following regular expressions:
4511 @itemize @bullet
4513 @item @code{-fallthrough}
4515 @item @code{@@fallthrough@@}
4517 @item @code{lint -fallthrough[ \t]*}
4519 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4521 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4523 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4525 @end itemize
4527 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4528 following regular expressions:
4530 @itemize @bullet
4532 @item @code{-fallthrough}
4534 @item @code{@@fallthrough@@}
4536 @item @code{lint -fallthrough[ \t]*}
4538 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4540 @end itemize
4542 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4543 fallthrough comments, only attributes disable the warning.
4545 @end itemize
4547 The comment needs to be followed after optional whitespace and other comments
4548 by @code{case} or @code{default} keywords or by a user label that precedes some
4549 @code{case} or @code{default} label.
4551 @smallexample
4552 @group
4553 switch (cond)
4554   @{
4555   case 1:
4556     bar (0);
4557     /* FALLTHRU */
4558   default:
4559     @dots{}
4560   @}
4561 @end group
4562 @end smallexample
4564 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4566 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4567 @opindex Wif-not-aligned
4568 @opindex Wno-if-not-aligned
4569 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4570 should be issued.  This is is enabled by default.
4571 Use @option{-Wno-if-not-aligned} to disable it.
4573 @item -Wignored-qualifiers @r{(C and C++ only)}
4574 @opindex Wignored-qualifiers
4575 @opindex Wno-ignored-qualifiers
4576 Warn if the return type of a function has a type qualifier
4577 such as @code{const}.  For ISO C such a type qualifier has no effect,
4578 since the value returned by a function is not an lvalue.
4579 For C++, the warning is only emitted for scalar types or @code{void}.
4580 ISO C prohibits qualified @code{void} return types on function
4581 definitions, so such return types always receive a warning
4582 even without this option.
4584 This warning is also enabled by @option{-Wextra}.
4586 @item -Wignored-attributes @r{(C and C++ only)}
4587 @opindex Wignored-attributes
4588 @opindex Wno-ignored-attributes
4589 Warn when an attribute is ignored.  This is different from the
4590 @option{-Wattributes} option in that it warns whenever the compiler decides
4591 to drop an attribute, not that the attribute is either unknown, used in a
4592 wrong place, etc.  This warning is enabled by default.
4594 @item -Wmain
4595 @opindex Wmain
4596 @opindex Wno-main
4597 Warn if the type of @code{main} is suspicious.  @code{main} should be
4598 a function with external linkage, returning int, taking either zero
4599 arguments, two, or three arguments of appropriate types.  This warning
4600 is enabled by default in C++ and is enabled by either @option{-Wall}
4601 or @option{-Wpedantic}.
4603 @item -Wmisleading-indentation @r{(C and C++ only)}
4604 @opindex Wmisleading-indentation
4605 @opindex Wno-misleading-indentation
4606 Warn when the indentation of the code does not reflect the block structure.
4607 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4608 @code{for} clauses with a guarded statement that does not use braces,
4609 followed by an unguarded statement with the same indentation.
4611 In the following example, the call to ``bar'' is misleadingly indented as
4612 if it were guarded by the ``if'' conditional.
4614 @smallexample
4615   if (some_condition ())
4616     foo ();
4617     bar ();  /* Gotcha: this is not guarded by the "if".  */
4618 @end smallexample
4620 In the case of mixed tabs and spaces, the warning uses the
4621 @option{-ftabstop=} option to determine if the statements line up
4622 (defaulting to 8).
4624 The warning is not issued for code involving multiline preprocessor logic
4625 such as the following example.
4627 @smallexample
4628   if (flagA)
4629     foo (0);
4630 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4631   if (flagB)
4632 #endif
4633     foo (1);
4634 @end smallexample
4636 The warning is not issued after a @code{#line} directive, since this
4637 typically indicates autogenerated code, and no assumptions can be made
4638 about the layout of the file that the directive references.
4640 This warning is enabled by @option{-Wall} in C and C++.
4642 @item -Wmissing-attributes
4643 @opindex Wmissing-attributes
4644 @opindex Wno-missing-attributes
4645 Warn when a declaration of a function is missing one or more attributes
4646 that a related function is declared with and whose absence may adversely
4647 affect the correctness or efficiency of generated code.  For example, in
4648 C++, the warning is issued when an explicit specialization of a primary
4649 template declared with attribute @code{alloc_align}, @code{alloc_size},
4650 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4651 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4652 @code{error}, and @code{warning} suppress the warning.
4653 (@pxref{Function Attributes}).
4655 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4657 For example, since the declaration of the primary function template
4658 below makes use of both attribute @code{malloc} and @code{alloc_size}
4659 the declaration of the explicit specialization of the template is
4660 diagnosed because it is missing one of the attributes.
4662 @smallexample
4663 template <class T>
4664 T* __attribute__ ((malloc, alloc_size (1)))
4665 allocate (size_t);
4667 template <>
4668 void* __attribute__ ((malloc))   // missing alloc_size
4669 allocate<void> (size_t);
4670 @end smallexample
4672 @item -Wmissing-braces
4673 @opindex Wmissing-braces
4674 @opindex Wno-missing-braces
4675 Warn if an aggregate or union initializer is not fully bracketed.  In
4676 the following example, the initializer for @code{a} is not fully
4677 bracketed, but that for @code{b} is fully bracketed.  This warning is
4678 enabled by @option{-Wall} in C.
4680 @smallexample
4681 int a[2][2] = @{ 0, 1, 2, 3 @};
4682 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4683 @end smallexample
4685 This warning is enabled by @option{-Wall}.
4687 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4688 @opindex Wmissing-include-dirs
4689 @opindex Wno-missing-include-dirs
4690 Warn if a user-supplied include directory does not exist.
4692 @item -Wmultistatement-macros
4693 @opindex Wmultistatement-macros
4694 @opindex Wno-multistatement-macros
4695 Warn about unsafe multiple statement macros that appear to be guarded
4696 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4697 @code{while}, in which only the first statement is actually guarded after
4698 the macro is expanded.
4700 For example:
4702 @smallexample
4703 #define DOIT x++; y++
4704 if (c)
4705   DOIT;
4706 @end smallexample
4708 will increment @code{y} unconditionally, not just when @code{c} holds.
4709 The can usually be fixed by wrapping the macro in a do-while loop:
4710 @smallexample
4711 #define DOIT do @{ x++; y++; @} while (0)
4712 if (c)
4713   DOIT;
4714 @end smallexample
4716 This warning is enabled by @option{-Wall} in C and C++.
4718 @item -Wparentheses
4719 @opindex Wparentheses
4720 @opindex Wno-parentheses
4721 Warn if parentheses are omitted in certain contexts, such
4722 as when there is an assignment in a context where a truth value
4723 is expected, or when operators are nested whose precedence people
4724 often get confused about.
4726 Also warn if a comparison like @code{x<=y<=z} appears; this is
4727 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4728 interpretation from that of ordinary mathematical notation.
4730 Also warn for dangerous uses of the GNU extension to
4731 @code{?:} with omitted middle operand. When the condition
4732 in the @code{?}: operator is a boolean expression, the omitted value is
4733 always 1.  Often programmers expect it to be a value computed
4734 inside the conditional expression instead.
4736 For C++ this also warns for some cases of unnecessary parentheses in
4737 declarations, which can indicate an attempt at a function call instead
4738 of a declaration:
4739 @smallexample
4741   // Declares a local variable called mymutex.
4742   std::unique_lock<std::mutex> (mymutex);
4743   // User meant std::unique_lock<std::mutex> lock (mymutex);
4745 @end smallexample
4747 This warning is enabled by @option{-Wall}.
4749 @item -Wsequence-point
4750 @opindex Wsequence-point
4751 @opindex Wno-sequence-point
4752 Warn about code that may have undefined semantics because of violations
4753 of sequence point rules in the C and C++ standards.
4755 The C and C++ standards define the order in which expressions in a C/C++
4756 program are evaluated in terms of @dfn{sequence points}, which represent
4757 a partial ordering between the execution of parts of the program: those
4758 executed before the sequence point, and those executed after it.  These
4759 occur after the evaluation of a full expression (one which is not part
4760 of a larger expression), after the evaluation of the first operand of a
4761 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4762 function is called (but after the evaluation of its arguments and the
4763 expression denoting the called function), and in certain other places.
4764 Other than as expressed by the sequence point rules, the order of
4765 evaluation of subexpressions of an expression is not specified.  All
4766 these rules describe only a partial order rather than a total order,
4767 since, for example, if two functions are called within one expression
4768 with no sequence point between them, the order in which the functions
4769 are called is not specified.  However, the standards committee have
4770 ruled that function calls do not overlap.
4772 It is not specified when between sequence points modifications to the
4773 values of objects take effect.  Programs whose behavior depends on this
4774 have undefined behavior; the C and C++ standards specify that ``Between
4775 the previous and next sequence point an object shall have its stored
4776 value modified at most once by the evaluation of an expression.
4777 Furthermore, the prior value shall be read only to determine the value
4778 to be stored.''.  If a program breaks these rules, the results on any
4779 particular implementation are entirely unpredictable.
4781 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4782 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4783 diagnosed by this option, and it may give an occasional false positive
4784 result, but in general it has been found fairly effective at detecting
4785 this sort of problem in programs.
4787 The C++17 standard will define the order of evaluation of operands in
4788 more cases: in particular it requires that the right-hand side of an
4789 assignment be evaluated before the left-hand side, so the above
4790 examples are no longer undefined.  But this warning will still warn
4791 about them, to help people avoid writing code that is undefined in C
4792 and earlier revisions of C++.
4794 The standard is worded confusingly, therefore there is some debate
4795 over the precise meaning of the sequence point rules in subtle cases.
4796 Links to discussions of the problem, including proposed formal
4797 definitions, may be found on the GCC readings page, at
4798 @uref{http://gcc.gnu.org/@/readings.html}.
4800 This warning is enabled by @option{-Wall} for C and C++.
4802 @item -Wno-return-local-addr
4803 @opindex Wno-return-local-addr
4804 @opindex Wreturn-local-addr
4805 Do not warn about returning a pointer (or in C++, a reference) to a
4806 variable that goes out of scope after the function returns.
4808 @item -Wreturn-type
4809 @opindex Wreturn-type
4810 @opindex Wno-return-type
4811 Warn whenever a function is defined with a return type that defaults
4812 to @code{int}.  Also warn about any @code{return} statement with no
4813 return value in a function whose return type is not @code{void}
4814 (falling off the end of the function body is considered returning
4815 without a value).
4817 For C only, warn about a @code{return} statement with an expression in a
4818 function whose return type is @code{void}, unless the expression type is
4819 also @code{void}.  As a GNU extension, the latter case is accepted
4820 without a warning unless @option{-Wpedantic} is used.
4822 For C++, a function without return type always produces a diagnostic
4823 message, even when @option{-Wno-return-type} is specified.  The only
4824 exceptions are @code{main} and functions defined in system headers.
4826 This warning is enabled by default for C++ and is enabled by @option{-Wall}.
4828 @item -Wshift-count-negative
4829 @opindex Wshift-count-negative
4830 @opindex Wno-shift-count-negative
4831 Warn if shift count is negative. This warning is enabled by default.
4833 @item -Wshift-count-overflow
4834 @opindex Wshift-count-overflow
4835 @opindex Wno-shift-count-overflow
4836 Warn if shift count >= width of type. This warning is enabled by default.
4838 @item -Wshift-negative-value
4839 @opindex Wshift-negative-value
4840 @opindex Wno-shift-negative-value
4841 Warn if left shifting a negative value.  This warning is enabled by
4842 @option{-Wextra} in C99 and C++11 modes (and newer).
4844 @item -Wshift-overflow
4845 @itemx -Wshift-overflow=@var{n}
4846 @opindex Wshift-overflow
4847 @opindex Wno-shift-overflow
4848 Warn about left shift overflows.  This warning is enabled by
4849 default in C99 and C++11 modes (and newer).
4851 @table @gcctabopt
4852 @item -Wshift-overflow=1
4853 This is the warning level of @option{-Wshift-overflow} and is enabled
4854 by default in C99 and C++11 modes (and newer).  This warning level does
4855 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4856 an overflow is still rejected in contexts where an integer constant expression
4857 is required.)
4859 @item -Wshift-overflow=2
4860 This warning level also warns about left-shifting 1 into the sign bit,
4861 unless C++14 mode is active.
4862 @end table
4864 @item -Wswitch
4865 @opindex Wswitch
4866 @opindex Wno-switch
4867 Warn whenever a @code{switch} statement has an index of enumerated type
4868 and lacks a @code{case} for one or more of the named codes of that
4869 enumeration.  (The presence of a @code{default} label prevents this
4870 warning.)  @code{case} labels outside the enumeration range also
4871 provoke warnings when this option is used (even if there is a
4872 @code{default} label).
4873 This warning is enabled by @option{-Wall}.
4875 @item -Wswitch-default
4876 @opindex Wswitch-default
4877 @opindex Wno-switch-default
4878 Warn whenever a @code{switch} statement does not have a @code{default}
4879 case.
4881 @item -Wswitch-enum
4882 @opindex Wswitch-enum
4883 @opindex Wno-switch-enum
4884 Warn whenever a @code{switch} statement has an index of enumerated type
4885 and lacks a @code{case} for one or more of the named codes of that
4886 enumeration.  @code{case} labels outside the enumeration range also
4887 provoke warnings when this option is used.  The only difference
4888 between @option{-Wswitch} and this option is that this option gives a
4889 warning about an omitted enumeration code even if there is a
4890 @code{default} label.
4892 @item -Wswitch-bool
4893 @opindex Wswitch-bool
4894 @opindex Wno-switch-bool
4895 Warn whenever a @code{switch} statement has an index of boolean type
4896 and the case values are outside the range of a boolean type.
4897 It is possible to suppress this warning by casting the controlling
4898 expression to a type other than @code{bool}.  For example:
4899 @smallexample
4900 @group
4901 switch ((int) (a == 4))
4902   @{
4903   @dots{}
4904   @}
4905 @end group
4906 @end smallexample
4907 This warning is enabled by default for C and C++ programs.
4909 @item -Wswitch-unreachable
4910 @opindex Wswitch-unreachable
4911 @opindex Wno-switch-unreachable
4912 Warn whenever a @code{switch} statement contains statements between the
4913 controlling expression and the first case label, which will never be
4914 executed.  For example:
4915 @smallexample
4916 @group
4917 switch (cond)
4918   @{
4919    i = 15;
4920   @dots{}
4921    case 5:
4922   @dots{}
4923   @}
4924 @end group
4925 @end smallexample
4926 @option{-Wswitch-unreachable} does not warn if the statement between the
4927 controlling expression and the first case label is just a declaration:
4928 @smallexample
4929 @group
4930 switch (cond)
4931   @{
4932    int i;
4933   @dots{}
4934    case 5:
4935    i = 5;
4936   @dots{}
4937   @}
4938 @end group
4939 @end smallexample
4940 This warning is enabled by default for C and C++ programs.
4942 @item -Wsync-nand @r{(C and C++ only)}
4943 @opindex Wsync-nand
4944 @opindex Wno-sync-nand
4945 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4946 built-in functions are used.  These functions changed semantics in GCC 4.4.
4948 @item -Wunused-but-set-parameter
4949 @opindex Wunused-but-set-parameter
4950 @opindex Wno-unused-but-set-parameter
4951 Warn whenever a function parameter is assigned to, but otherwise unused
4952 (aside from its declaration).
4954 To suppress this warning use the @code{unused} attribute
4955 (@pxref{Variable Attributes}).
4957 This warning is also enabled by @option{-Wunused} together with
4958 @option{-Wextra}.
4960 @item -Wunused-but-set-variable
4961 @opindex Wunused-but-set-variable
4962 @opindex Wno-unused-but-set-variable
4963 Warn whenever a local variable is assigned to, but otherwise unused
4964 (aside from its declaration).
4965 This warning is enabled by @option{-Wall}.
4967 To suppress this warning use the @code{unused} attribute
4968 (@pxref{Variable Attributes}).
4970 This warning is also enabled by @option{-Wunused}, which is enabled
4971 by @option{-Wall}.
4973 @item -Wunused-function
4974 @opindex Wunused-function
4975 @opindex Wno-unused-function
4976 Warn whenever a static function is declared but not defined or a
4977 non-inline static function is unused.
4978 This warning is enabled by @option{-Wall}.
4980 @item -Wunused-label
4981 @opindex Wunused-label
4982 @opindex Wno-unused-label
4983 Warn whenever a label is declared but not used.
4984 This warning is enabled by @option{-Wall}.
4986 To suppress this warning use the @code{unused} attribute
4987 (@pxref{Variable Attributes}).
4989 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4990 @opindex Wunused-local-typedefs
4991 @opindex Wno-unused-local-typedefs
4992 Warn when a typedef locally defined in a function is not used.
4993 This warning is enabled by @option{-Wall}.
4995 @item -Wunused-parameter
4996 @opindex Wunused-parameter
4997 @opindex Wno-unused-parameter
4998 Warn whenever a function parameter is unused aside from its declaration.
5000 To suppress this warning use the @code{unused} attribute
5001 (@pxref{Variable Attributes}).
5003 @item -Wno-unused-result
5004 @opindex Wunused-result
5005 @opindex Wno-unused-result
5006 Do not warn if a caller of a function marked with attribute
5007 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
5008 its return value. The default is @option{-Wunused-result}.
5010 @item -Wunused-variable
5011 @opindex Wunused-variable
5012 @opindex Wno-unused-variable
5013 Warn whenever a local or static variable is unused aside from its
5014 declaration. This option implies @option{-Wunused-const-variable=1} for C,
5015 but not for C++. This warning is enabled by @option{-Wall}.
5017 To suppress this warning use the @code{unused} attribute
5018 (@pxref{Variable Attributes}).
5020 @item -Wunused-const-variable
5021 @itemx -Wunused-const-variable=@var{n}
5022 @opindex Wunused-const-variable
5023 @opindex Wno-unused-const-variable
5024 Warn whenever a constant static variable is unused aside from its declaration.
5025 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
5026 for C, but not for C++. In C this declares variable storage, but in C++ this
5027 is not an error since const variables take the place of @code{#define}s.
5029 To suppress this warning use the @code{unused} attribute
5030 (@pxref{Variable Attributes}).
5032 @table @gcctabopt
5033 @item -Wunused-const-variable=1
5034 This is the warning level that is enabled by @option{-Wunused-variable} for
5035 C.  It warns only about unused static const variables defined in the main
5036 compilation unit, but not about static const variables declared in any
5037 header included.
5039 @item -Wunused-const-variable=2
5040 This warning level also warns for unused constant static variables in
5041 headers (excluding system headers).  This is the warning level of
5042 @option{-Wunused-const-variable} and must be explicitly requested since
5043 in C++ this isn't an error and in C it might be harder to clean up all
5044 headers included.
5045 @end table
5047 @item -Wunused-value
5048 @opindex Wunused-value
5049 @opindex Wno-unused-value
5050 Warn whenever a statement computes a result that is explicitly not
5051 used. To suppress this warning cast the unused expression to
5052 @code{void}. This includes an expression-statement or the left-hand
5053 side of a comma expression that contains no side effects. For example,
5054 an expression such as @code{x[i,j]} causes a warning, while
5055 @code{x[(void)i,j]} does not.
5057 This warning is enabled by @option{-Wall}.
5059 @item -Wunused
5060 @opindex Wunused
5061 @opindex Wno-unused
5062 All the above @option{-Wunused} options combined.
5064 In order to get a warning about an unused function parameter, you must
5065 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5066 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5068 @item -Wuninitialized
5069 @opindex Wuninitialized
5070 @opindex Wno-uninitialized
5071 Warn if an automatic variable is used without first being initialized
5072 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5073 warn if a non-static reference or non-static @code{const} member
5074 appears in a class without constructors.
5076 If you want to warn about code that uses the uninitialized value of the
5077 variable in its own initializer, use the @option{-Winit-self} option.
5079 These warnings occur for individual uninitialized or clobbered
5080 elements of structure, union or array variables as well as for
5081 variables that are uninitialized or clobbered as a whole.  They do
5082 not occur for variables or elements declared @code{volatile}.  Because
5083 these warnings depend on optimization, the exact variables or elements
5084 for which there are warnings depends on the precise optimization
5085 options and version of GCC used.
5087 Note that there may be no warning about a variable that is used only
5088 to compute a value that itself is never used, because such
5089 computations may be deleted by data flow analysis before the warnings
5090 are printed.
5092 @item -Winvalid-memory-model
5093 @opindex Winvalid-memory-model
5094 @opindex Wno-invalid-memory-model
5095 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5096 and the C11 atomic generic functions with a memory consistency argument
5097 that is either invalid for the operation or outside the range of values
5098 of the @code{memory_order} enumeration.  For example, since the
5099 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5100 defined for the relaxed, release, and sequentially consistent memory
5101 orders the following code is diagnosed:
5103 @smallexample
5104 void store (int *i)
5106   __atomic_store_n (i, 0, memory_order_consume);
5108 @end smallexample
5110 @option{-Winvalid-memory-model} is enabled by default.
5112 @item -Wmaybe-uninitialized
5113 @opindex Wmaybe-uninitialized
5114 @opindex Wno-maybe-uninitialized
5115 For an automatic (i.e.@ local) variable, if there exists a path from the
5116 function entry to a use of the variable that is initialized, but there exist
5117 some other paths for which the variable is not initialized, the compiler
5118 emits a warning if it cannot prove the uninitialized paths are not
5119 executed at run time.
5121 These warnings are only possible in optimizing compilation, because otherwise
5122 GCC does not keep track of the state of variables.
5124 These warnings are made optional because GCC may not be able to determine when
5125 the code is correct in spite of appearing to have an error.  Here is one
5126 example of how this can happen:
5128 @smallexample
5129 @group
5131   int x;
5132   switch (y)
5133     @{
5134     case 1: x = 1;
5135       break;
5136     case 2: x = 4;
5137       break;
5138     case 3: x = 5;
5139     @}
5140   foo (x);
5142 @end group
5143 @end smallexample
5145 @noindent
5146 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5147 always initialized, but GCC doesn't know this. To suppress the
5148 warning, you need to provide a default case with assert(0) or
5149 similar code.
5151 @cindex @code{longjmp} warnings
5152 This option also warns when a non-volatile automatic variable might be
5153 changed by a call to @code{longjmp}.
5154 The compiler sees only the calls to @code{setjmp}.  It cannot know
5155 where @code{longjmp} will be called; in fact, a signal handler could
5156 call it at any point in the code.  As a result, you may get a warning
5157 even when there is in fact no problem because @code{longjmp} cannot
5158 in fact be called at the place that would cause a problem.
5160 Some spurious warnings can be avoided if you declare all the functions
5161 you use that never return as @code{noreturn}.  @xref{Function
5162 Attributes}.
5164 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5166 @item -Wunknown-pragmas
5167 @opindex Wunknown-pragmas
5168 @opindex Wno-unknown-pragmas
5169 @cindex warning for unknown pragmas
5170 @cindex unknown pragmas, warning
5171 @cindex pragmas, warning of unknown
5172 Warn when a @code{#pragma} directive is encountered that is not understood by 
5173 GCC@.  If this command-line option is used, warnings are even issued
5174 for unknown pragmas in system header files.  This is not the case if
5175 the warnings are only enabled by the @option{-Wall} command-line option.
5177 @item -Wno-pragmas
5178 @opindex Wno-pragmas
5179 @opindex Wpragmas
5180 Do not warn about misuses of pragmas, such as incorrect parameters,
5181 invalid syntax, or conflicts between pragmas.  See also
5182 @option{-Wunknown-pragmas}.
5184 @item -Wstrict-aliasing
5185 @opindex Wstrict-aliasing
5186 @opindex Wno-strict-aliasing
5187 This option is only active when @option{-fstrict-aliasing} is active.
5188 It warns about code that might break the strict aliasing rules that the
5189 compiler is using for optimization.  The warning does not catch all
5190 cases, but does attempt to catch the more common pitfalls.  It is
5191 included in @option{-Wall}.
5192 It is equivalent to @option{-Wstrict-aliasing=3}
5194 @item -Wstrict-aliasing=n
5195 @opindex Wstrict-aliasing=n
5196 This option is only active when @option{-fstrict-aliasing} is active.
5197 It warns about code that might break the strict aliasing rules that the
5198 compiler is using for optimization.
5199 Higher levels correspond to higher accuracy (fewer false positives).
5200 Higher levels also correspond to more effort, similar to the way @option{-O} 
5201 works.
5202 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5204 Level 1: Most aggressive, quick, least accurate.
5205 Possibly useful when higher levels
5206 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5207 false negatives.  However, it has many false positives.
5208 Warns for all pointer conversions between possibly incompatible types,
5209 even if never dereferenced.  Runs in the front end only.
5211 Level 2: Aggressive, quick, not too precise.
5212 May still have many false positives (not as many as level 1 though),
5213 and few false negatives (but possibly more than level 1).
5214 Unlike level 1, it only warns when an address is taken.  Warns about
5215 incomplete types.  Runs in the front end only.
5217 Level 3 (default for @option{-Wstrict-aliasing}):
5218 Should have very few false positives and few false
5219 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5220 Takes care of the common pun+dereference pattern in the front end:
5221 @code{*(int*)&some_float}.
5222 If optimization is enabled, it also runs in the back end, where it deals
5223 with multiple statement cases using flow-sensitive points-to information.
5224 Only warns when the converted pointer is dereferenced.
5225 Does not warn about incomplete types.
5227 @item -Wstrict-overflow
5228 @itemx -Wstrict-overflow=@var{n}
5229 @opindex Wstrict-overflow
5230 @opindex Wno-strict-overflow
5231 This option is only active when signed overflow is undefined.
5232 It warns about cases where the compiler optimizes based on the
5233 assumption that signed overflow does not occur.  Note that it does not
5234 warn about all cases where the code might overflow: it only warns
5235 about cases where the compiler implements some optimization.  Thus
5236 this warning depends on the optimization level.
5238 An optimization that assumes that signed overflow does not occur is
5239 perfectly safe if the values of the variables involved are such that
5240 overflow never does, in fact, occur.  Therefore this warning can
5241 easily give a false positive: a warning about code that is not
5242 actually a problem.  To help focus on important issues, several
5243 warning levels are defined.  No warnings are issued for the use of
5244 undefined signed overflow when estimating how many iterations a loop
5245 requires, in particular when determining whether a loop will be
5246 executed at all.
5248 @table @gcctabopt
5249 @item -Wstrict-overflow=1
5250 Warn about cases that are both questionable and easy to avoid.  For
5251 example the compiler simplifies
5252 @code{x + 1 > x} to @code{1}.  This level of
5253 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5254 are not, and must be explicitly requested.
5256 @item -Wstrict-overflow=2
5257 Also warn about other cases where a comparison is simplified to a
5258 constant.  For example: @code{abs (x) >= 0}.  This can only be
5259 simplified when signed integer overflow is undefined, because
5260 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5261 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5262 @option{-Wstrict-overflow=2}.
5264 @item -Wstrict-overflow=3
5265 Also warn about other cases where a comparison is simplified.  For
5266 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5268 @item -Wstrict-overflow=4
5269 Also warn about other simplifications not covered by the above cases.
5270 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5272 @item -Wstrict-overflow=5
5273 Also warn about cases where the compiler reduces the magnitude of a
5274 constant involved in a comparison.  For example: @code{x + 2 > y} is
5275 simplified to @code{x + 1 >= y}.  This is reported only at the
5276 highest warning level because this simplification applies to many
5277 comparisons, so this warning level gives a very large number of
5278 false positives.
5279 @end table
5281 @item -Wstringop-overflow
5282 @itemx -Wstringop-overflow=@var{type}
5283 @opindex Wstringop-overflow
5284 @opindex Wno-stringop-overflow
5285 Warn for calls to string manipulation functions such as @code{memcpy} and
5286 @code{strcpy} that are determined to overflow the destination buffer.  The
5287 optional argument is one greater than the type of Object Size Checking to
5288 perform to determine the size of the destination.  @xref{Object Size Checking}.
5289 The argument is meaningful only for functions that operate on character arrays
5290 but not for raw memory functions like @code{memcpy} which always make use
5291 of Object Size type-0.  The option also warns for calls that specify a size
5292 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5293 The option produces the best results with optimization enabled but can detect
5294 a small subset of simple buffer overflows even without optimization in
5295 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5296 correspond to the standard functions.  In any case, the option warns about
5297 just a subset of buffer overflows detected by the corresponding overflow
5298 checking built-ins.  For example, the option will issue a warning for
5299 the @code{strcpy} call below because it copies at least 5 characters
5300 (the string @code{"blue"} including the terminating NUL) into the buffer
5301 of size 4.
5303 @smallexample
5304 enum Color @{ blue, purple, yellow @};
5305 const char* f (enum Color clr)
5307   static char buf [4];
5308   const char *str;
5309   switch (clr)
5310     @{
5311       case blue: str = "blue"; break;
5312       case purple: str = "purple"; break;
5313       case yellow: str = "yellow"; break;
5314     @}
5316   return strcpy (buf, str);   // warning here
5318 @end smallexample
5320 Option @option{-Wstringop-overflow=2} is enabled by default.
5322 @table @gcctabopt
5323 @item -Wstringop-overflow
5324 @itemx -Wstringop-overflow=1
5325 @opindex Wstringop-overflow
5326 @opindex Wno-stringop-overflow
5327 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5328 to determine the sizes of destination objects.  This is the default setting
5329 of the option.  At this setting the option will not warn for writes past
5330 the end of subobjects of larger objects accessed by pointers unless the
5331 size of the largest surrounding object is known.  When the destination may
5332 be one of several objects it is assumed to be the largest one of them.  On
5333 Linux systems, when optimization is enabled at this setting the option warns
5334 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5335 a non-zero value.
5337 @item -Wstringop-overflow=2
5338 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5339 to determine the sizes of destination objects.  At this setting the option
5340 will warn about overflows when writing to members of the largest complete
5341 objects whose exact size is known.  It will, however, not warn for excessive
5342 writes to the same members of unknown objects referenced by pointers since
5343 they may point to arrays containing unknown numbers of elements.
5345 @item -Wstringop-overflow=3
5346 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5347 to determine the sizes of destination objects.  At this setting the option
5348 warns about overflowing the smallest object or data member.  This is the
5349 most restrictive setting of the option that may result in warnings for safe
5350 code.
5352 @item -Wstringop-overflow=4
5353 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5354 to determine the sizes of destination objects.  At this setting the option
5355 will warn about overflowing any data members, and when the destination is
5356 one of several objects it uses the size of the largest of them to decide
5357 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5358 setting of the option may result in warnings for benign code.
5359 @end table
5361 @item -Wstringop-truncation
5362 @opindex Wstringop-truncation
5363 @opindex Wno-stringop-truncation
5364 Warn for calls to bounded string manipulation functions such as @code{strncat},
5365 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5366 or leave the destination unchanged.
5368 In the following example, the call to @code{strncat} specifies a bound that
5369 is less than the length of the source string.  As a result, the copy of
5370 the source will be truncated and so the call is diagnosed.  To avoid the
5371 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5373 @smallexample
5374 void append (char *buf, size_t bufsize)
5376   strncat (buf, ".txt", 3);
5378 @end smallexample
5380 As another example, the following call to @code{strncpy} results in copying
5381 to @code{d} just the characters preceding the terminating NUL, without
5382 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5383 necessarily a NUL-terminated string is a common mistake, and so the call
5384 is diagnosed.  To avoid the warning when the result is not expected to be
5385 NUL-terminated, call @code{memcpy} instead.
5387 @smallexample
5388 void copy (char *d, const char *s)
5390   strncpy (d, s, strlen (s));
5392 @end smallexample
5394 In the following example, the call to @code{strncpy} specifies the size
5395 of the destination buffer as the bound.  If the length of the source
5396 string is equal to or greater than this size the result of the copy will
5397 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5398 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5399 element of the buffer to @code{NUL}.
5401 @smallexample
5402 void copy (const char *s)
5404   char buf[80];
5405   strncpy (buf, s, sizeof buf);
5406   @dots{}
5408 @end smallexample
5410 In situations where a character array is intended to store a sequence
5411 of bytes with no terminating @code{NUL} such an array may be annotated
5412 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5413 however, are not suitable arguments to functions that expect
5414 @code{NUL}-terminated strings.  To help detect accidental misuses of
5415 such arrays GCC issues warnings unless it can prove that the use is
5416 safe.  @xref{Common Variable Attributes}.
5418 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5419 @opindex Wsuggest-attribute=
5420 @opindex Wno-suggest-attribute=
5421 Warn for cases where adding an attribute may be beneficial. The
5422 attributes currently supported are listed below.
5424 @table @gcctabopt
5425 @item -Wsuggest-attribute=pure
5426 @itemx -Wsuggest-attribute=const
5427 @itemx -Wsuggest-attribute=noreturn
5428 @itemx -Wsuggest-attribute=malloc
5429 @opindex Wsuggest-attribute=pure
5430 @opindex Wno-suggest-attribute=pure
5431 @opindex Wsuggest-attribute=const
5432 @opindex Wno-suggest-attribute=const
5433 @opindex Wsuggest-attribute=noreturn
5434 @opindex Wno-suggest-attribute=noreturn
5435 @opindex Wsuggest-attribute=malloc
5436 @opindex Wno-suggest-attribute=malloc
5438 Warn about functions that might be candidates for attributes
5439 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5440 only warns for functions visible in other compilation units or (in the case of
5441 @code{pure} and @code{const}) if it cannot prove that the function returns
5442 normally. A function returns normally if it doesn't contain an infinite loop or
5443 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5444 requires option @option{-fipa-pure-const}, which is enabled by default at
5445 @option{-O} and higher.  Higher optimization levels improve the accuracy
5446 of the analysis.
5448 @item -Wsuggest-attribute=format
5449 @itemx -Wmissing-format-attribute
5450 @opindex Wsuggest-attribute=format
5451 @opindex Wmissing-format-attribute
5452 @opindex Wno-suggest-attribute=format
5453 @opindex Wno-missing-format-attribute
5454 @opindex Wformat
5455 @opindex Wno-format
5457 Warn about function pointers that might be candidates for @code{format}
5458 attributes.  Note these are only possible candidates, not absolute ones.
5459 GCC guesses that function pointers with @code{format} attributes that
5460 are used in assignment, initialization, parameter passing or return
5461 statements should have a corresponding @code{format} attribute in the
5462 resulting type.  I.e.@: the left-hand side of the assignment or
5463 initialization, the type of the parameter variable, or the return type
5464 of the containing function respectively should also have a @code{format}
5465 attribute to avoid the warning.
5467 GCC also warns about function definitions that might be
5468 candidates for @code{format} attributes.  Again, these are only
5469 possible candidates.  GCC guesses that @code{format} attributes
5470 might be appropriate for any function that calls a function like
5471 @code{vprintf} or @code{vscanf}, but this might not always be the
5472 case, and some functions for which @code{format} attributes are
5473 appropriate may not be detected.
5475 @item -Wsuggest-attribute=cold
5476 @opindex Wsuggest-attribute=cold
5477 @opindex Wno-suggest-attribute=cold
5479 Warn about functions that might be candidates for @code{cold} attribute.  This
5480 is based on static detection and generally will only warn about functions which
5481 always leads to a call to another @code{cold} function such as wrappers of
5482 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5483 @end table
5485 @item -Wsuggest-final-types
5486 @opindex Wno-suggest-final-types
5487 @opindex Wsuggest-final-types
5488 Warn about types with virtual methods where code quality would be improved
5489 if the type were declared with the C++11 @code{final} specifier, 
5490 or, if possible,
5491 declared in an anonymous namespace. This allows GCC to more aggressively
5492 devirtualize the polymorphic calls. This warning is more effective with link
5493 time optimization, where the information about the class hierarchy graph is
5494 more complete.
5496 @item -Wsuggest-final-methods
5497 @opindex Wno-suggest-final-methods
5498 @opindex Wsuggest-final-methods
5499 Warn about virtual methods where code quality would be improved if the method
5500 were declared with the C++11 @code{final} specifier, 
5501 or, if possible, its type were
5502 declared in an anonymous namespace or with the @code{final} specifier.
5503 This warning is
5504 more effective with link-time optimization, where the information about the
5505 class hierarchy graph is more complete. It is recommended to first consider
5506 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5507 annotations.
5509 @item -Wsuggest-override
5510 Warn about overriding virtual functions that are not marked with the override
5511 keyword.
5513 @item -Walloc-zero
5514 @opindex Wno-alloc-zero
5515 @opindex Walloc-zero
5516 Warn about calls to allocation functions decorated with attribute
5517 @code{alloc_size} that specify zero bytes, including those to the built-in
5518 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5519 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5520 when called with a zero size differs among implementations (and in the case
5521 of @code{realloc} has been deprecated) relying on it may result in subtle
5522 portability bugs and should be avoided.
5524 @item -Walloc-size-larger-than=@var{n}
5525 @opindex Walloc-size-larger-than=@var{n}
5526 @opindex Wno-alloc-size-larger-than
5527 Warn about calls to functions decorated with attribute @code{alloc_size}
5528 that attempt to allocate objects larger than the specified number of bytes,
5529 or where the result of the size computation in an integer type with infinite
5530 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n} is
5531 treated as an integer with infinite precision and may end in one of
5532 the standard suffixes designating a multiple of bytes such as @code{kB} and
5533 @code{KiB} for kilobyte and kibibyte, respectively, @code{MB} and @code{MiB}
5534 for megabyte and mebibyte, and so on.
5535 @option{-Walloc-size-larger-than=}@var{PTRDIFF_MAX} is enabled by default.
5536 Warnings controlled by the option can be disabled either by specifying
5537 @var{n} of @var{SIZE_MAX} or more or by @option{-Wno-alloc-size-larger-than}.
5538 @xref{Function Attributes}.
5540 @item -Walloca
5541 @opindex Wno-alloca
5542 @opindex Walloca
5543 This option warns on all uses of @code{alloca} in the source.
5545 @item -Walloca-larger-than=@var{n}
5546 This option warns on calls to @code{alloca} that are not bounded by a
5547 controlling predicate limiting its argument of integer type to at most
5548 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5549 Arguments of non-integer types are considered unbounded even if they
5550 appear to be constrained to the expected range.
5552 For example, a bounded case of @code{alloca} could be:
5554 @smallexample
5555 void func (size_t n)
5557   void *p;
5558   if (n <= 1000)
5559     p = alloca (n);
5560   else
5561     p = malloc (n);
5562   f (p);
5564 @end smallexample
5566 In the above example, passing @code{-Walloca-larger-than=1000} would not
5567 issue a warning because the call to @code{alloca} is known to be at most
5568 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5569 the compiler would emit a warning.
5571 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5572 controlling predicate constraining its integer argument.  For example:
5574 @smallexample
5575 void func ()
5577   void *p = alloca (n);
5578   f (p);
5580 @end smallexample
5582 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5583 a warning, but this time because of the lack of bounds checking.
5585 Note, that even seemingly correct code involving signed integers could
5586 cause a warning:
5588 @smallexample
5589 void func (signed int n)
5591   if (n < 500)
5592     @{
5593       p = alloca (n);
5594       f (p);
5595     @}
5597 @end smallexample
5599 In the above example, @var{n} could be negative, causing a larger than
5600 expected argument to be implicitly cast into the @code{alloca} call.
5602 This option also warns when @code{alloca} is used in a loop.
5604 This warning is not enabled by @option{-Wall}, and is only active when
5605 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5607 See also @option{-Wvla-larger-than=@var{n}}.
5609 @item -Warray-bounds
5610 @itemx -Warray-bounds=@var{n}
5611 @opindex Wno-array-bounds
5612 @opindex Warray-bounds
5613 This option is only active when @option{-ftree-vrp} is active
5614 (default for @option{-O2} and above). It warns about subscripts to arrays
5615 that are always out of bounds. This warning is enabled by @option{-Wall}.
5617 @table @gcctabopt
5618 @item -Warray-bounds=1
5619 This is the warning level of @option{-Warray-bounds} and is enabled
5620 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5622 @item -Warray-bounds=2
5623 This warning level also warns about out of bounds access for
5624 arrays at the end of a struct and for arrays accessed through
5625 pointers. This warning level may give a larger number of
5626 false positives and is deactivated by default.
5627 @end table
5629 @item -Wattribute-alias
5630 Warn about declarations using the @code{alias} and similar attributes whose
5631 target is incompatible with the type of the alias.  @xref{Function Attributes,
5632 ,Declaring Attributes of Functions}.
5634 @item -Wbool-compare
5635 @opindex Wno-bool-compare
5636 @opindex Wbool-compare
5637 Warn about boolean expression compared with an integer value different from
5638 @code{true}/@code{false}.  For instance, the following comparison is
5639 always false:
5640 @smallexample
5641 int n = 5;
5642 @dots{}
5643 if ((n > 1) == 2) @{ @dots{} @}
5644 @end smallexample
5645 This warning is enabled by @option{-Wall}.
5647 @item -Wbool-operation
5648 @opindex Wno-bool-operation
5649 @opindex Wbool-operation
5650 Warn about suspicious operations on expressions of a boolean type.  For
5651 instance, bitwise negation of a boolean is very likely a bug in the program.
5652 For C, this warning also warns about incrementing or decrementing a boolean,
5653 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5654 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5656 This warning is enabled by @option{-Wall}.
5658 @item -Wduplicated-branches
5659 @opindex Wno-duplicated-branches
5660 @opindex Wduplicated-branches
5661 Warn when an if-else has identical branches.  This warning detects cases like
5662 @smallexample
5663 if (p != NULL)
5664   return 0;
5665 else
5666   return 0;
5667 @end smallexample
5668 It doesn't warn when both branches contain just a null statement.  This warning
5669 also warn for conditional operators:
5670 @smallexample
5671   int i = x ? *p : *p;
5672 @end smallexample
5674 @item -Wduplicated-cond
5675 @opindex Wno-duplicated-cond
5676 @opindex Wduplicated-cond
5677 Warn about duplicated conditions in an if-else-if chain.  For instance,
5678 warn for the following code:
5679 @smallexample
5680 if (p->q != NULL) @{ @dots{} @}
5681 else if (p->q != NULL) @{ @dots{} @}
5682 @end smallexample
5684 @item -Wframe-address
5685 @opindex Wno-frame-address
5686 @opindex Wframe-address
5687 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5688 is called with an argument greater than 0.  Such calls may return indeterminate
5689 values or crash the program.  The warning is included in @option{-Wall}.
5691 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5692 @opindex Wno-discarded-qualifiers
5693 @opindex Wdiscarded-qualifiers
5694 Do not warn if type qualifiers on pointers are being discarded.
5695 Typically, the compiler warns if a @code{const char *} variable is
5696 passed to a function that takes a @code{char *} parameter.  This option
5697 can be used to suppress such a warning.
5699 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5700 @opindex Wno-discarded-array-qualifiers
5701 @opindex Wdiscarded-array-qualifiers
5702 Do not warn if type qualifiers on arrays which are pointer targets
5703 are being discarded. Typically, the compiler warns if a
5704 @code{const int (*)[]} variable is passed to a function that
5705 takes a @code{int (*)[]} parameter.  This option can be used to
5706 suppress such a warning.
5708 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5709 @opindex Wno-incompatible-pointer-types
5710 @opindex Wincompatible-pointer-types
5711 Do not warn when there is a conversion between pointers that have incompatible
5712 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5713 which warns for pointer argument passing or assignment with different
5714 signedness.
5716 @item -Wno-int-conversion @r{(C and Objective-C only)}
5717 @opindex Wno-int-conversion
5718 @opindex Wint-conversion
5719 Do not warn about incompatible integer to pointer and pointer to integer
5720 conversions.  This warning is about implicit conversions; for explicit
5721 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5722 @option{-Wno-pointer-to-int-cast} may be used.
5724 @item -Wno-div-by-zero
5725 @opindex Wno-div-by-zero
5726 @opindex Wdiv-by-zero
5727 Do not warn about compile-time integer division by zero.  Floating-point
5728 division by zero is not warned about, as it can be a legitimate way of
5729 obtaining infinities and NaNs.
5731 @item -Wsystem-headers
5732 @opindex Wsystem-headers
5733 @opindex Wno-system-headers
5734 @cindex warnings from system headers
5735 @cindex system headers, warnings from
5736 Print warning messages for constructs found in system header files.
5737 Warnings from system headers are normally suppressed, on the assumption
5738 that they usually do not indicate real problems and would only make the
5739 compiler output harder to read.  Using this command-line option tells
5740 GCC to emit warnings from system headers as if they occurred in user
5741 code.  However, note that using @option{-Wall} in conjunction with this
5742 option does @emph{not} warn about unknown pragmas in system
5743 headers---for that, @option{-Wunknown-pragmas} must also be used.
5745 @item -Wtautological-compare
5746 @opindex Wtautological-compare
5747 @opindex Wno-tautological-compare
5748 Warn if a self-comparison always evaluates to true or false.  This
5749 warning detects various mistakes such as:
5750 @smallexample
5751 int i = 1;
5752 @dots{}
5753 if (i > i) @{ @dots{} @}
5754 @end smallexample
5756 This warning also warns about bitwise comparisons that always evaluate
5757 to true or false, for instance:
5758 @smallexample
5759 if ((a & 16) == 10) @{ @dots{} @}
5760 @end smallexample
5761 will always be false.
5763 This warning is enabled by @option{-Wall}.
5765 @item -Wtrampolines
5766 @opindex Wtrampolines
5767 @opindex Wno-trampolines
5768 Warn about trampolines generated for pointers to nested functions.
5769 A trampoline is a small piece of data or code that is created at run
5770 time on the stack when the address of a nested function is taken, and is
5771 used to call the nested function indirectly.  For some targets, it is
5772 made up of data only and thus requires no special treatment.  But, for
5773 most targets, it is made up of code and thus requires the stack to be
5774 made executable in order for the program to work properly.
5776 @item -Wfloat-equal
5777 @opindex Wfloat-equal
5778 @opindex Wno-float-equal
5779 Warn if floating-point values are used in equality comparisons.
5781 The idea behind this is that sometimes it is convenient (for the
5782 programmer) to consider floating-point values as approximations to
5783 infinitely precise real numbers.  If you are doing this, then you need
5784 to compute (by analyzing the code, or in some other way) the maximum or
5785 likely maximum error that the computation introduces, and allow for it
5786 when performing comparisons (and when producing output, but that's a
5787 different problem).  In particular, instead of testing for equality, you
5788 should check to see whether the two values have ranges that overlap; and
5789 this is done with the relational operators, so equality comparisons are
5790 probably mistaken.
5792 @item -Wtraditional @r{(C and Objective-C only)}
5793 @opindex Wtraditional
5794 @opindex Wno-traditional
5795 Warn about certain constructs that behave differently in traditional and
5796 ISO C@.  Also warn about ISO C constructs that have no traditional C
5797 equivalent, and/or problematic constructs that should be avoided.
5799 @itemize @bullet
5800 @item
5801 Macro parameters that appear within string literals in the macro body.
5802 In traditional C macro replacement takes place within string literals,
5803 but in ISO C it does not.
5805 @item
5806 In traditional C, some preprocessor directives did not exist.
5807 Traditional preprocessors only considered a line to be a directive
5808 if the @samp{#} appeared in column 1 on the line.  Therefore
5809 @option{-Wtraditional} warns about directives that traditional C
5810 understands but ignores because the @samp{#} does not appear as the
5811 first character on the line.  It also suggests you hide directives like
5812 @code{#pragma} not understood by traditional C by indenting them.  Some
5813 traditional implementations do not recognize @code{#elif}, so this option
5814 suggests avoiding it altogether.
5816 @item
5817 A function-like macro that appears without arguments.
5819 @item
5820 The unary plus operator.
5822 @item
5823 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5824 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5825 constants.)  Note, these suffixes appear in macros defined in the system
5826 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5827 Use of these macros in user code might normally lead to spurious
5828 warnings, however GCC's integrated preprocessor has enough context to
5829 avoid warning in these cases.
5831 @item
5832 A function declared external in one block and then used after the end of
5833 the block.
5835 @item
5836 A @code{switch} statement has an operand of type @code{long}.
5838 @item
5839 A non-@code{static} function declaration follows a @code{static} one.
5840 This construct is not accepted by some traditional C compilers.
5842 @item
5843 The ISO type of an integer constant has a different width or
5844 signedness from its traditional type.  This warning is only issued if
5845 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5846 typically represent bit patterns, are not warned about.
5848 @item
5849 Usage of ISO string concatenation is detected.
5851 @item
5852 Initialization of automatic aggregates.
5854 @item
5855 Identifier conflicts with labels.  Traditional C lacks a separate
5856 namespace for labels.
5858 @item
5859 Initialization of unions.  If the initializer is zero, the warning is
5860 omitted.  This is done under the assumption that the zero initializer in
5861 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5862 initializer warnings and relies on default initialization to zero in the
5863 traditional C case.
5865 @item
5866 Conversions by prototypes between fixed/floating-point values and vice
5867 versa.  The absence of these prototypes when compiling with traditional
5868 C causes serious problems.  This is a subset of the possible
5869 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5871 @item
5872 Use of ISO C style function definitions.  This warning intentionally is
5873 @emph{not} issued for prototype declarations or variadic functions
5874 because these ISO C features appear in your code when using
5875 libiberty's traditional C compatibility macros, @code{PARAMS} and
5876 @code{VPARAMS}.  This warning is also bypassed for nested functions
5877 because that feature is already a GCC extension and thus not relevant to
5878 traditional C compatibility.
5879 @end itemize
5881 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5882 @opindex Wtraditional-conversion
5883 @opindex Wno-traditional-conversion
5884 Warn if a prototype causes a type conversion that is different from what
5885 would happen to the same argument in the absence of a prototype.  This
5886 includes conversions of fixed point to floating and vice versa, and
5887 conversions changing the width or signedness of a fixed-point argument
5888 except when the same as the default promotion.
5890 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5891 @opindex Wdeclaration-after-statement
5892 @opindex Wno-declaration-after-statement
5893 Warn when a declaration is found after a statement in a block.  This
5894 construct, known from C++, was introduced with ISO C99 and is by default
5895 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5897 @item -Wshadow
5898 @opindex Wshadow
5899 @opindex Wno-shadow
5900 Warn whenever a local variable or type declaration shadows another
5901 variable, parameter, type, class member (in C++), or instance variable
5902 (in Objective-C) or whenever a built-in function is shadowed. Note
5903 that in C++, the compiler warns if a local variable shadows an
5904 explicit typedef, but not if it shadows a struct/class/enum.
5905 Same as @option{-Wshadow=global}.
5907 @item -Wno-shadow-ivar @r{(Objective-C only)}
5908 @opindex Wno-shadow-ivar
5909 @opindex Wshadow-ivar
5910 Do not warn whenever a local variable shadows an instance variable in an
5911 Objective-C method.
5913 @item -Wshadow=global
5914 @opindex Wshadow=local
5915 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5917 @item -Wshadow=local
5918 @opindex Wshadow=local
5919 Warn when a local variable shadows another local variable or parameter.
5920 This warning is enabled by @option{-Wshadow=global}.
5922 @item -Wshadow=compatible-local
5923 @opindex Wshadow=compatible-local
5924 Warn when a local variable shadows another local variable or parameter
5925 whose type is compatible with that of the shadowing variable. In C++,
5926 type compatibility here means the type of the shadowing variable can be
5927 converted to that of the shadowed variable. The creation of this flag
5928 (in addition to @option{-Wshadow=local}) is based on the idea that when
5929 a local variable shadows another one of incompatible type, it is most
5930 likely intentional, not a bug or typo, as shown in the following example:
5932 @smallexample
5933 @group
5934 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5936   for (int i = 0; i < N; ++i)
5937   @{
5938     ...
5939   @}
5940   ...
5942 @end group
5943 @end smallexample
5945 Since the two variable @code{i} in the example above have incompatible types,
5946 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5947 Because their types are incompatible, if a programmer accidentally uses one
5948 in place of the other, type checking will catch that and emit an error or
5949 warning. So not warning (about shadowing) in this case will not lead to
5950 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5951 possibly reduce the number of warnings triggered by intentional shadowing.
5953 This warning is enabled by @option{-Wshadow=local}.
5955 @item -Wlarger-than=@var{len}
5956 @opindex Wlarger-than=@var{len}
5957 @opindex Wlarger-than-@var{len}
5958 Warn whenever an object of larger than @var{len} bytes is defined.
5960 @item -Wframe-larger-than=@var{len}
5961 @opindex Wframe-larger-than=@var{len}
5962 @opindex Wframe-larger-than
5963 Warn if the size of a function frame is larger than @var{len} bytes.
5964 The computation done to determine the stack frame size is approximate
5965 and not conservative.
5966 The actual requirements may be somewhat greater than @var{len}
5967 even if you do not get a warning.  In addition, any space allocated
5968 via @code{alloca}, variable-length arrays, or related constructs
5969 is not included by the compiler when determining
5970 whether or not to issue a warning.
5972 @item -Wno-free-nonheap-object
5973 @opindex Wno-free-nonheap-object
5974 @opindex Wfree-nonheap-object
5975 Do not warn when attempting to free an object that was not allocated
5976 on the heap.
5978 @item -Wstack-usage=@var{len}
5979 @opindex Wstack-usage
5980 @opindex Wno-stack-usage
5981 Warn if the stack usage of a function might be larger than @var{len} bytes.
5982 The computation done to determine the stack usage is conservative.
5983 Any space allocated via @code{alloca}, variable-length arrays, or related
5984 constructs is included by the compiler when determining whether or not to
5985 issue a warning.
5987 The message is in keeping with the output of @option{-fstack-usage}.
5989 @itemize
5990 @item
5991 If the stack usage is fully static but exceeds the specified amount, it's:
5993 @smallexample
5994   warning: stack usage is 1120 bytes
5995 @end smallexample
5996 @item
5997 If the stack usage is (partly) dynamic but bounded, it's:
5999 @smallexample
6000   warning: stack usage might be 1648 bytes
6001 @end smallexample
6002 @item
6003 If the stack usage is (partly) dynamic and not bounded, it's:
6005 @smallexample
6006   warning: stack usage might be unbounded
6007 @end smallexample
6008 @end itemize
6010 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
6011 @opindex Wno-pedantic-ms-format
6012 @opindex Wpedantic-ms-format
6013 When used in combination with @option{-Wformat}
6014 and @option{-pedantic} without GNU extensions, this option
6015 disables the warnings about non-ISO @code{printf} / @code{scanf} format
6016 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
6017 which depend on the MS runtime.
6019 @item -Waligned-new
6020 @opindex Waligned-new
6021 @opindex Wno-aligned-new
6022 Warn about a new-expression of a type that requires greater alignment
6023 than the @code{alignof(std::max_align_t)} but uses an allocation
6024 function without an explicit alignment parameter. This option is
6025 enabled by @option{-Wall}.
6027 Normally this only warns about global allocation functions, but
6028 @option{-Waligned-new=all} also warns about class member allocation
6029 functions.
6031 @item -Wplacement-new
6032 @itemx -Wplacement-new=@var{n}
6033 @opindex Wplacement-new
6034 @opindex Wno-placement-new
6035 Warn about placement new expressions with undefined behavior, such as
6036 constructing an object in a buffer that is smaller than the type of
6037 the object.  For example, the placement new expression below is diagnosed
6038 because it attempts to construct an array of 64 integers in a buffer only
6039 64 bytes large.
6040 @smallexample
6041 char buf [64];
6042 new (buf) int[64];
6043 @end smallexample
6044 This warning is enabled by default.
6046 @table @gcctabopt
6047 @item -Wplacement-new=1
6048 This is the default warning level of @option{-Wplacement-new}.  At this
6049 level the warning is not issued for some strictly undefined constructs that
6050 GCC allows as extensions for compatibility with legacy code.  For example,
6051 the following @code{new} expression is not diagnosed at this level even
6052 though it has undefined behavior according to the C++ standard because
6053 it writes past the end of the one-element array.
6054 @smallexample
6055 struct S @{ int n, a[1]; @};
6056 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6057 new (s->a)int [32]();
6058 @end smallexample
6060 @item -Wplacement-new=2
6061 At this level, in addition to diagnosing all the same constructs as at level
6062 1, a diagnostic is also issued for placement new expressions that construct
6063 an object in the last member of structure whose type is an array of a single
6064 element and whose size is less than the size of the object being constructed.
6065 While the previous example would be diagnosed, the following construct makes
6066 use of the flexible member array extension to avoid the warning at level 2.
6067 @smallexample
6068 struct S @{ int n, a[]; @};
6069 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6070 new (s->a)int [32]();
6071 @end smallexample
6073 @end table
6075 @item -Wpointer-arith
6076 @opindex Wpointer-arith
6077 @opindex Wno-pointer-arith
6078 Warn about anything that depends on the ``size of'' a function type or
6079 of @code{void}.  GNU C assigns these types a size of 1, for
6080 convenience in calculations with @code{void *} pointers and pointers
6081 to functions.  In C++, warn also when an arithmetic operation involves
6082 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6084 @item -Wpointer-compare
6085 @opindex Wpointer-compare
6086 @opindex Wno-pointer-compare
6087 Warn if a pointer is compared with a zero character constant.  This usually
6088 means that the pointer was meant to be dereferenced.  For example:
6090 @smallexample
6091 const char *p = foo ();
6092 if (p == '\0')
6093   return 42;
6094 @end smallexample
6096 Note that the code above is invalid in C++11.
6098 This warning is enabled by default.
6100 @item -Wtype-limits
6101 @opindex Wtype-limits
6102 @opindex Wno-type-limits
6103 Warn if a comparison is always true or always false due to the limited
6104 range of the data type, but do not warn for constant expressions.  For
6105 example, warn if an unsigned variable is compared against zero with
6106 @code{<} or @code{>=}.  This warning is also enabled by
6107 @option{-Wextra}.
6109 @include cppwarnopts.texi
6111 @item -Wbad-function-cast @r{(C and Objective-C only)}
6112 @opindex Wbad-function-cast
6113 @opindex Wno-bad-function-cast
6114 Warn when a function call is cast to a non-matching type.
6115 For example, warn if a call to a function returning an integer type 
6116 is cast to a pointer type.
6118 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6119 @opindex Wc90-c99-compat
6120 @opindex Wno-c90-c99-compat
6121 Warn about features not present in ISO C90, but present in ISO C99.
6122 For instance, warn about use of variable length arrays, @code{long long}
6123 type, @code{bool} type, compound literals, designated initializers, and so
6124 on.  This option is independent of the standards mode.  Warnings are disabled
6125 in the expression that follows @code{__extension__}.
6127 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6128 @opindex Wc99-c11-compat
6129 @opindex Wno-c99-c11-compat
6130 Warn about features not present in ISO C99, but present in ISO C11.
6131 For instance, warn about use of anonymous structures and unions,
6132 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6133 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6134 and so on.  This option is independent of the standards mode.  Warnings are
6135 disabled in the expression that follows @code{__extension__}.
6137 @item -Wc++-compat @r{(C and Objective-C only)}
6138 @opindex Wc++-compat
6139 @opindex Wno-c++-compat
6140 Warn about ISO C constructs that are outside of the common subset of
6141 ISO C and ISO C++, e.g.@: request for implicit conversion from
6142 @code{void *} to a pointer to non-@code{void} type.
6144 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6145 @opindex Wc++11-compat
6146 @opindex Wno-c++11-compat
6147 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6148 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6149 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6150 enabled by @option{-Wall}.
6152 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6153 @opindex Wc++14-compat
6154 @opindex Wno-c++14-compat
6155 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6156 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6158 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6159 @opindex Wc++17-compat
6160 @opindex Wno-c++17-compat
6161 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6162 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6164 @item -Wcast-qual
6165 @opindex Wcast-qual
6166 @opindex Wno-cast-qual
6167 Warn whenever a pointer is cast so as to remove a type qualifier from
6168 the target type.  For example, warn if a @code{const char *} is cast
6169 to an ordinary @code{char *}.
6171 Also warn when making a cast that introduces a type qualifier in an
6172 unsafe way.  For example, casting @code{char **} to @code{const char **}
6173 is unsafe, as in this example:
6175 @smallexample
6176   /* p is char ** value.  */
6177   const char **q = (const char **) p;
6178   /* Assignment of readonly string to const char * is OK.  */
6179   *q = "string";
6180   /* Now char** pointer points to read-only memory.  */
6181   **p = 'b';
6182 @end smallexample
6184 @item -Wcast-align
6185 @opindex Wcast-align
6186 @opindex Wno-cast-align
6187 Warn whenever a pointer is cast such that the required alignment of the
6188 target is increased.  For example, warn if a @code{char *} is cast to
6189 an @code{int *} on machines where integers can only be accessed at
6190 two- or four-byte boundaries.
6192 @item -Wcast-align=strict
6193 @opindex Wcast-align=strict
6194 Warn whenever a pointer is cast such that the required alignment of the
6195 target is increased.  For example, warn if a @code{char *} is cast to
6196 an @code{int *} regardless of the target machine.
6198 @item -Wcast-function-type
6199 @opindex Wcast-function-type
6200 @opindex Wno-cast-function-type
6201 Warn when a function pointer is cast to an incompatible function pointer.
6202 In a cast involving function types with a variable argument list only
6203 the types of initial arguments that are provided are considered.
6204 Any parameter of pointer-type matches any other pointer-type.  Any benign
6205 differences in integral types are ignored, like @code{int} vs. @code{long}
6206 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6207 type @code{void (*) (void)} is special and matches everything, which can
6208 be used to suppress this warning.
6209 In a cast involving pointer to member types this warning warns whenever
6210 the type cast is changing the pointer to member type.
6211 This warning is enabled by @option{-Wextra}.
6213 @item -Wwrite-strings
6214 @opindex Wwrite-strings
6215 @opindex Wno-write-strings
6216 When compiling C, give string constants the type @code{const
6217 char[@var{length}]} so that copying the address of one into a
6218 non-@code{const} @code{char *} pointer produces a warning.  These
6219 warnings help you find at compile time code that can try to write
6220 into a string constant, but only if you have been very careful about
6221 using @code{const} in declarations and prototypes.  Otherwise, it is
6222 just a nuisance. This is why we did not make @option{-Wall} request
6223 these warnings.
6225 When compiling C++, warn about the deprecated conversion from string
6226 literals to @code{char *}.  This warning is enabled by default for C++
6227 programs.
6229 @item -Wcatch-value
6230 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6231 @opindex Wcatch-value
6232 @opindex Wno-catch-value
6233 Warn about catch handlers that do not catch via reference.
6234 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6235 warn about polymorphic class types that are caught by value.
6236 With @option{-Wcatch-value=2} warn about all class types that are caught
6237 by value. With @option{-Wcatch-value=3} warn about all types that are
6238 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6240 @item -Wclobbered
6241 @opindex Wclobbered
6242 @opindex Wno-clobbered
6243 Warn for variables that might be changed by @code{longjmp} or
6244 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6246 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6247 @opindex Wconditionally-supported
6248 @opindex Wno-conditionally-supported
6249 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6251 @item -Wconversion
6252 @opindex Wconversion
6253 @opindex Wno-conversion
6254 Warn for implicit conversions that may alter a value. This includes
6255 conversions between real and integer, like @code{abs (x)} when
6256 @code{x} is @code{double}; conversions between signed and unsigned,
6257 like @code{unsigned ui = -1}; and conversions to smaller types, like
6258 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6259 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6260 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6261 conversions between signed and unsigned integers can be disabled by
6262 using @option{-Wno-sign-conversion}.
6264 For C++, also warn for confusing overload resolution for user-defined
6265 conversions; and conversions that never use a type conversion
6266 operator: conversions to @code{void}, the same type, a base class or a
6267 reference to them. Warnings about conversions between signed and
6268 unsigned integers are disabled by default in C++ unless
6269 @option{-Wsign-conversion} is explicitly enabled.
6271 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6272 @opindex Wconversion-null
6273 @opindex Wno-conversion-null
6274 Do not warn for conversions between @code{NULL} and non-pointer
6275 types. @option{-Wconversion-null} is enabled by default.
6277 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6278 @opindex Wzero-as-null-pointer-constant
6279 @opindex Wno-zero-as-null-pointer-constant
6280 Warn when a literal @samp{0} is used as null pointer constant.  This can
6281 be useful to facilitate the conversion to @code{nullptr} in C++11.
6283 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6284 @opindex Wsubobject-linkage
6285 @opindex Wno-subobject-linkage
6286 Warn if a class type has a base or a field whose type uses the anonymous
6287 namespace or depends on a type with no linkage.  If a type A depends on
6288 a type B with no or internal linkage, defining it in multiple
6289 translation units would be an ODR violation because the meaning of B
6290 is different in each translation unit.  If A only appears in a single
6291 translation unit, the best way to silence the warning is to give it
6292 internal linkage by putting it in an anonymous namespace as well.  The
6293 compiler doesn't give this warning for types defined in the main .C
6294 file, as those are unlikely to have multiple definitions.
6295 @option{-Wsubobject-linkage} is enabled by default.
6297 @item -Wdangling-else
6298 @opindex Wdangling-else
6299 @opindex Wno-dangling-else
6300 Warn about constructions where there may be confusion to which
6301 @code{if} statement an @code{else} branch belongs.  Here is an example of
6302 such a case:
6304 @smallexample
6305 @group
6307   if (a)
6308     if (b)
6309       foo ();
6310   else
6311     bar ();
6313 @end group
6314 @end smallexample
6316 In C/C++, every @code{else} branch belongs to the innermost possible
6317 @code{if} statement, which in this example is @code{if (b)}.  This is
6318 often not what the programmer expected, as illustrated in the above
6319 example by indentation the programmer chose.  When there is the
6320 potential for this confusion, GCC issues a warning when this flag
6321 is specified.  To eliminate the warning, add explicit braces around
6322 the innermost @code{if} statement so there is no way the @code{else}
6323 can belong to the enclosing @code{if}.  The resulting code
6324 looks like this:
6326 @smallexample
6327 @group
6329   if (a)
6330     @{
6331       if (b)
6332         foo ();
6333       else
6334         bar ();
6335     @}
6337 @end group
6338 @end smallexample
6340 This warning is enabled by @option{-Wparentheses}.
6342 @item -Wdate-time
6343 @opindex Wdate-time
6344 @opindex Wno-date-time
6345 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6346 are encountered as they might prevent bit-wise-identical reproducible
6347 compilations.
6349 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6350 @opindex Wdelete-incomplete
6351 @opindex Wno-delete-incomplete
6352 Warn when deleting a pointer to incomplete type, which may cause
6353 undefined behavior at runtime.  This warning is enabled by default.
6355 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6356 @opindex Wuseless-cast
6357 @opindex Wno-useless-cast
6358 Warn when an expression is casted to its own type.
6360 @item -Wempty-body
6361 @opindex Wempty-body
6362 @opindex Wno-empty-body
6363 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6364 while} statement.  This warning is also enabled by @option{-Wextra}.
6366 @item -Wenum-compare
6367 @opindex Wenum-compare
6368 @opindex Wno-enum-compare
6369 Warn about a comparison between values of different enumerated types.
6370 In C++ enumerated type mismatches in conditional expressions are also
6371 diagnosed and the warning is enabled by default.  In C this warning is 
6372 enabled by @option{-Wall}.
6374 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6375 @opindex Wextra-semi
6376 @opindex Wno-extra-semi
6377 Warn about redundant semicolon after in-class function definition.
6379 @item -Wjump-misses-init @r{(C, Objective-C only)}
6380 @opindex Wjump-misses-init
6381 @opindex Wno-jump-misses-init
6382 Warn if a @code{goto} statement or a @code{switch} statement jumps
6383 forward across the initialization of a variable, or jumps backward to a
6384 label after the variable has been initialized.  This only warns about
6385 variables that are initialized when they are declared.  This warning is
6386 only supported for C and Objective-C; in C++ this sort of branch is an
6387 error in any case.
6389 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6390 can be disabled with the @option{-Wno-jump-misses-init} option.
6392 @item -Wsign-compare
6393 @opindex Wsign-compare
6394 @opindex Wno-sign-compare
6395 @cindex warning for comparison of signed and unsigned values
6396 @cindex comparison of signed and unsigned values, warning
6397 @cindex signed and unsigned values, comparison warning
6398 Warn when a comparison between signed and unsigned values could produce
6399 an incorrect result when the signed value is converted to unsigned.
6400 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6401 also enabled by @option{-Wextra}.
6403 @item -Wsign-conversion
6404 @opindex Wsign-conversion
6405 @opindex Wno-sign-conversion
6406 Warn for implicit conversions that may change the sign of an integer
6407 value, like assigning a signed integer expression to an unsigned
6408 integer variable. An explicit cast silences the warning. In C, this
6409 option is enabled also by @option{-Wconversion}.
6411 @item -Wfloat-conversion
6412 @opindex Wfloat-conversion
6413 @opindex Wno-float-conversion
6414 Warn for implicit conversions that reduce the precision of a real value.
6415 This includes conversions from real to integer, and from higher precision
6416 real to lower precision real values.  This option is also enabled by
6417 @option{-Wconversion}.
6419 @item -Wno-scalar-storage-order
6420 @opindex -Wno-scalar-storage-order
6421 @opindex -Wscalar-storage-order
6422 Do not warn on suspicious constructs involving reverse scalar storage order.
6424 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6425 @opindex Wsized-deallocation
6426 @opindex Wno-sized-deallocation
6427 Warn about a definition of an unsized deallocation function
6428 @smallexample
6429 void operator delete (void *) noexcept;
6430 void operator delete[] (void *) noexcept;
6431 @end smallexample
6432 without a definition of the corresponding sized deallocation function
6433 @smallexample
6434 void operator delete (void *, std::size_t) noexcept;
6435 void operator delete[] (void *, std::size_t) noexcept;
6436 @end smallexample
6437 or vice versa.  Enabled by @option{-Wextra} along with
6438 @option{-fsized-deallocation}.
6440 @item -Wsizeof-pointer-div
6441 @opindex Wsizeof-pointer-div
6442 @opindex Wno-sizeof-pointer-div
6443 Warn for suspicious divisions of two sizeof expressions that divide
6444 the pointer size by the element size, which is the usual way to compute
6445 the array size but won't work out correctly with pointers.  This warning
6446 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6447 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6449 @item -Wsizeof-pointer-memaccess
6450 @opindex Wsizeof-pointer-memaccess
6451 @opindex Wno-sizeof-pointer-memaccess
6452 Warn for suspicious length parameters to certain string and memory built-in
6453 functions if the argument uses @code{sizeof}.  This warning triggers for
6454 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6455 an array, but a pointer, and suggests a possible fix, or about
6456 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6457 also warns about calls to bounded string copy functions like @code{strncat}
6458 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6459 the source array.  For example, in the following function the call to
6460 @code{strncat} specifies the size of the source string as the bound.  That
6461 is almost certainly a mistake and so the call is diagnosed.
6462 @smallexample
6463 void make_file (const char *name)
6465   char path[PATH_MAX];
6466   strncpy (path, name, sizeof path - 1);
6467   strncat (path, ".text", sizeof ".text");
6468   @dots{}
6470 @end smallexample
6472 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6474 @item -Wsizeof-array-argument
6475 @opindex Wsizeof-array-argument
6476 @opindex Wno-sizeof-array-argument
6477 Warn when the @code{sizeof} operator is applied to a parameter that is
6478 declared as an array in a function definition.  This warning is enabled by
6479 default for C and C++ programs.
6481 @item -Wmemset-elt-size
6482 @opindex Wmemset-elt-size
6483 @opindex Wno-memset-elt-size
6484 Warn for suspicious calls to the @code{memset} built-in function, if the
6485 first argument references an array, and the third argument is a number
6486 equal to the number of elements, but not equal to the size of the array
6487 in memory.  This indicates that the user has omitted a multiplication by
6488 the element size.  This warning is enabled by @option{-Wall}.
6490 @item -Wmemset-transposed-args
6491 @opindex Wmemset-transposed-args
6492 @opindex Wno-memset-transposed-args
6493 Warn for suspicious calls to the @code{memset} built-in function, if the
6494 second argument is not zero and the third argument is zero.  This warns e.g.@
6495 about @code{memset (buf, sizeof buf, 0)} where most probably
6496 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6497 is only emitted if the third argument is literal zero.  If it is some
6498 expression that is folded to zero, a cast of zero to some type, etc., 
6499 it is far less likely that the user has mistakenly exchanged the arguments 
6500 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6502 @item -Waddress
6503 @opindex Waddress
6504 @opindex Wno-address
6505 Warn about suspicious uses of memory addresses. These include using
6506 the address of a function in a conditional expression, such as
6507 @code{void func(void); if (func)}, and comparisons against the memory
6508 address of a string literal, such as @code{if (x == "abc")}.  Such
6509 uses typically indicate a programmer error: the address of a function
6510 always evaluates to true, so their use in a conditional usually
6511 indicate that the programmer forgot the parentheses in a function
6512 call; and comparisons against string literals result in unspecified
6513 behavior and are not portable in C, so they usually indicate that the
6514 programmer intended to use @code{strcmp}.  This warning is enabled by
6515 @option{-Wall}.
6517 @item -Wlogical-op
6518 @opindex Wlogical-op
6519 @opindex Wno-logical-op
6520 Warn about suspicious uses of logical operators in expressions.
6521 This includes using logical operators in contexts where a
6522 bit-wise operator is likely to be expected.  Also warns when
6523 the operands of a logical operator are the same:
6524 @smallexample
6525 extern int a;
6526 if (a < 0 && a < 0) @{ @dots{} @}
6527 @end smallexample
6529 @item -Wlogical-not-parentheses
6530 @opindex Wlogical-not-parentheses
6531 @opindex Wno-logical-not-parentheses
6532 Warn about logical not used on the left hand side operand of a comparison.
6533 This option does not warn if the right operand is considered to be a boolean
6534 expression.  Its purpose is to detect suspicious code like the following:
6535 @smallexample
6536 int a;
6537 @dots{}
6538 if (!a > 1) @{ @dots{} @}
6539 @end smallexample
6541 It is possible to suppress the warning by wrapping the LHS into
6542 parentheses:
6543 @smallexample
6544 if ((!a) > 1) @{ @dots{} @}
6545 @end smallexample
6547 This warning is enabled by @option{-Wall}.
6549 @item -Waggregate-return
6550 @opindex Waggregate-return
6551 @opindex Wno-aggregate-return
6552 Warn if any functions that return structures or unions are defined or
6553 called.  (In languages where you can return an array, this also elicits
6554 a warning.)
6556 @item -Wno-aggressive-loop-optimizations
6557 @opindex Wno-aggressive-loop-optimizations
6558 @opindex Waggressive-loop-optimizations
6559 Warn if in a loop with constant number of iterations the compiler detects
6560 undefined behavior in some statement during one or more of the iterations.
6562 @item -Wno-attributes
6563 @opindex Wno-attributes
6564 @opindex Wattributes
6565 Do not warn if an unexpected @code{__attribute__} is used, such as
6566 unrecognized attributes, function attributes applied to variables,
6567 etc.  This does not stop errors for incorrect use of supported
6568 attributes.
6570 @item -Wno-builtin-declaration-mismatch
6571 @opindex Wno-builtin-declaration-mismatch
6572 @opindex Wbuiltin-declaration-mismatch
6573 Warn if a built-in function is declared with the wrong signature or 
6574 as non-function.
6575 This warning is enabled by default.
6577 @item -Wno-builtin-macro-redefined
6578 @opindex Wno-builtin-macro-redefined
6579 @opindex Wbuiltin-macro-redefined
6580 Do not warn if certain built-in macros are redefined.  This suppresses
6581 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6582 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6584 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6585 @opindex Wstrict-prototypes
6586 @opindex Wno-strict-prototypes
6587 Warn if a function is declared or defined without specifying the
6588 argument types.  (An old-style function definition is permitted without
6589 a warning if preceded by a declaration that specifies the argument
6590 types.)
6592 @item -Wold-style-declaration @r{(C and Objective-C only)}
6593 @opindex Wold-style-declaration
6594 @opindex Wno-old-style-declaration
6595 Warn for obsolescent usages, according to the C Standard, in a
6596 declaration. For example, warn if storage-class specifiers like
6597 @code{static} are not the first things in a declaration.  This warning
6598 is also enabled by @option{-Wextra}.
6600 @item -Wold-style-definition @r{(C and Objective-C only)}
6601 @opindex Wold-style-definition
6602 @opindex Wno-old-style-definition
6603 Warn if an old-style function definition is used.  A warning is given
6604 even if there is a previous prototype.
6606 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6607 @opindex Wmissing-parameter-type
6608 @opindex Wno-missing-parameter-type
6609 A function parameter is declared without a type specifier in K&R-style
6610 functions:
6612 @smallexample
6613 void foo(bar) @{ @}
6614 @end smallexample
6616 This warning is also enabled by @option{-Wextra}.
6618 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6619 @opindex Wmissing-prototypes
6620 @opindex Wno-missing-prototypes
6621 Warn if a global function is defined without a previous prototype
6622 declaration.  This warning is issued even if the definition itself
6623 provides a prototype.  Use this option to detect global functions
6624 that do not have a matching prototype declaration in a header file.
6625 This option is not valid for C++ because all function declarations
6626 provide prototypes and a non-matching declaration declares an
6627 overload rather than conflict with an earlier declaration.
6628 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6630 @item -Wmissing-declarations
6631 @opindex Wmissing-declarations
6632 @opindex Wno-missing-declarations
6633 Warn if a global function is defined without a previous declaration.
6634 Do so even if the definition itself provides a prototype.
6635 Use this option to detect global functions that are not declared in
6636 header files.  In C, no warnings are issued for functions with previous
6637 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6638 missing prototypes.  In C++, no warnings are issued for function templates,
6639 or for inline functions, or for functions in anonymous namespaces.
6641 @item -Wmissing-field-initializers
6642 @opindex Wmissing-field-initializers
6643 @opindex Wno-missing-field-initializers
6644 @opindex W
6645 @opindex Wextra
6646 @opindex Wno-extra
6647 Warn if a structure's initializer has some fields missing.  For
6648 example, the following code causes such a warning, because
6649 @code{x.h} is implicitly zero:
6651 @smallexample
6652 struct s @{ int f, g, h; @};
6653 struct s x = @{ 3, 4 @};
6654 @end smallexample
6656 This option does not warn about designated initializers, so the following
6657 modification does not trigger a warning:
6659 @smallexample
6660 struct s @{ int f, g, h; @};
6661 struct s x = @{ .f = 3, .g = 4 @};
6662 @end smallexample
6664 In C this option does not warn about the universal zero initializer
6665 @samp{@{ 0 @}}:
6667 @smallexample
6668 struct s @{ int f, g, h; @};
6669 struct s x = @{ 0 @};
6670 @end smallexample
6672 Likewise, in C++ this option does not warn about the empty @{ @}
6673 initializer, for example:
6675 @smallexample
6676 struct s @{ int f, g, h; @};
6677 s x = @{ @};
6678 @end smallexample
6680 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6681 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6683 @item -Wno-multichar
6684 @opindex Wno-multichar
6685 @opindex Wmultichar
6686 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6687 Usually they indicate a typo in the user's code, as they have
6688 implementation-defined values, and should not be used in portable code.
6690 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6691 @opindex Wnormalized=
6692 @opindex Wnormalized
6693 @opindex Wno-normalized
6694 @cindex NFC
6695 @cindex NFKC
6696 @cindex character set, input normalization
6697 In ISO C and ISO C++, two identifiers are different if they are
6698 different sequences of characters.  However, sometimes when characters
6699 outside the basic ASCII character set are used, you can have two
6700 different character sequences that look the same.  To avoid confusion,
6701 the ISO 10646 standard sets out some @dfn{normalization rules} which
6702 when applied ensure that two sequences that look the same are turned into
6703 the same sequence.  GCC can warn you if you are using identifiers that
6704 have not been normalized; this option controls that warning.
6706 There are four levels of warning supported by GCC@.  The default is
6707 @option{-Wnormalized=nfc}, which warns about any identifier that is
6708 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6709 recommended form for most uses.  It is equivalent to
6710 @option{-Wnormalized}.
6712 Unfortunately, there are some characters allowed in identifiers by
6713 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6714 identifiers.  That is, there's no way to use these symbols in portable
6715 ISO C or C++ and have all your identifiers in NFC@.
6716 @option{-Wnormalized=id} suppresses the warning for these characters.
6717 It is hoped that future versions of the standards involved will correct
6718 this, which is why this option is not the default.
6720 You can switch the warning off for all characters by writing
6721 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6722 only do this if you are using some other normalization scheme (like
6723 ``D''), because otherwise you can easily create bugs that are
6724 literally impossible to see.
6726 Some characters in ISO 10646 have distinct meanings but look identical
6727 in some fonts or display methodologies, especially once formatting has
6728 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6729 LETTER N'', displays just like a regular @code{n} that has been
6730 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6731 normalization scheme to convert all these into a standard form as
6732 well, and GCC warns if your code is not in NFKC if you use
6733 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6734 about every identifier that contains the letter O because it might be
6735 confused with the digit 0, and so is not the default, but may be
6736 useful as a local coding convention if the programming environment 
6737 cannot be fixed to display these characters distinctly.
6739 @item -Wno-deprecated
6740 @opindex Wno-deprecated
6741 @opindex Wdeprecated
6742 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6744 @item -Wno-deprecated-declarations
6745 @opindex Wno-deprecated-declarations
6746 @opindex Wdeprecated-declarations
6747 Do not warn about uses of functions (@pxref{Function Attributes}),
6748 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6749 Attributes}) marked as deprecated by using the @code{deprecated}
6750 attribute.
6752 @item -Wno-overflow
6753 @opindex Wno-overflow
6754 @opindex Woverflow
6755 Do not warn about compile-time overflow in constant expressions.
6757 @item -Wno-odr
6758 @opindex Wno-odr
6759 @opindex Wodr
6760 Warn about One Definition Rule violations during link-time optimization.
6761 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6763 @item -Wopenmp-simd
6764 @opindex Wopenmp-simd
6765 @opindex Wno-openmp-simd
6766 Warn if the vectorizer cost model overrides the OpenMP
6767 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6768 option can be used to relax the cost model.
6770 @item -Woverride-init @r{(C and Objective-C only)}
6771 @opindex Woverride-init
6772 @opindex Wno-override-init
6773 @opindex W
6774 @opindex Wextra
6775 @opindex Wno-extra
6776 Warn if an initialized field without side effects is overridden when
6777 using designated initializers (@pxref{Designated Inits, , Designated
6778 Initializers}).
6780 This warning is included in @option{-Wextra}.  To get other
6781 @option{-Wextra} warnings without this one, use @option{-Wextra
6782 -Wno-override-init}.
6784 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6785 @opindex Woverride-init-side-effects
6786 @opindex Wno-override-init-side-effects
6787 Warn if an initialized field with side effects is overridden when
6788 using designated initializers (@pxref{Designated Inits, , Designated
6789 Initializers}).  This warning is enabled by default.
6791 @item -Wpacked
6792 @opindex Wpacked
6793 @opindex Wno-packed
6794 Warn if a structure is given the packed attribute, but the packed
6795 attribute has no effect on the layout or size of the structure.
6796 Such structures may be mis-aligned for little benefit.  For
6797 instance, in this code, the variable @code{f.x} in @code{struct bar}
6798 is misaligned even though @code{struct bar} does not itself
6799 have the packed attribute:
6801 @smallexample
6802 @group
6803 struct foo @{
6804   int x;
6805   char a, b, c, d;
6806 @} __attribute__((packed));
6807 struct bar @{
6808   char z;
6809   struct foo f;
6811 @end group
6812 @end smallexample
6814 @item -Wpacked-bitfield-compat
6815 @opindex Wpacked-bitfield-compat
6816 @opindex Wno-packed-bitfield-compat
6817 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6818 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6819 the change can lead to differences in the structure layout.  GCC
6820 informs you when the offset of such a field has changed in GCC 4.4.
6821 For example there is no longer a 4-bit padding between field @code{a}
6822 and @code{b} in this structure:
6824 @smallexample
6825 struct foo
6827   char a:4;
6828   char b:8;
6829 @} __attribute__ ((packed));
6830 @end smallexample
6832 This warning is enabled by default.  Use
6833 @option{-Wno-packed-bitfield-compat} to disable this warning.
6835 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6836 @opindex Wpacked-not-aligned
6837 @opindex Wno-packed-not-aligned
6838 Warn if a structure field with explicitly specified alignment in a
6839 packed struct or union is misaligned.  For example, a warning will
6840 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6841 'struct S' is less than 8}, in this code:
6843 @smallexample
6844 @group
6845 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6846 struct __attribute__ ((packed)) S @{
6847   struct S8 s8;
6849 @end group
6850 @end smallexample
6852 This warning is enabled by @option{-Wall}.
6854 @item -Wpadded
6855 @opindex Wpadded
6856 @opindex Wno-padded
6857 Warn if padding is included in a structure, either to align an element
6858 of the structure or to align the whole structure.  Sometimes when this
6859 happens it is possible to rearrange the fields of the structure to
6860 reduce the padding and so make the structure smaller.
6862 @item -Wredundant-decls
6863 @opindex Wredundant-decls
6864 @opindex Wno-redundant-decls
6865 Warn if anything is declared more than once in the same scope, even in
6866 cases where multiple declaration is valid and changes nothing.
6868 @item -Wno-restrict
6869 @opindex Wrestrict
6870 @opindex Wno-restrict
6871 Warn when an object referenced by a @code{restrict}-qualified parameter
6872 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6873 argument, or when copies between such objects overlap.  For example,
6874 the call to the @code{strcpy} function below attempts to truncate the string
6875 by replacing its initial characters with the last four.  However, because
6876 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6877 the call is diagnosed.
6879 @smallexample
6880 void foo (void)
6882   char a[] = "abcd1234";
6883   strcpy (a, a + 4);
6884   @dots{}
6886 @end smallexample
6887 The @option{-Wrestrict} option detects some instances of simple overlap
6888 even without optimization but works best at @option{-O2} and above.  It
6889 is included in @option{-Wall}.
6891 @item -Wnested-externs @r{(C and Objective-C only)}
6892 @opindex Wnested-externs
6893 @opindex Wno-nested-externs
6894 Warn if an @code{extern} declaration is encountered within a function.
6896 @item -Wno-inherited-variadic-ctor
6897 @opindex Winherited-variadic-ctor
6898 @opindex Wno-inherited-variadic-ctor
6899 Suppress warnings about use of C++11 inheriting constructors when the
6900 base class inherited from has a C variadic constructor; the warning is
6901 on by default because the ellipsis is not inherited.
6903 @item -Winline
6904 @opindex Winline
6905 @opindex Wno-inline
6906 Warn if a function that is declared as inline cannot be inlined.
6907 Even with this option, the compiler does not warn about failures to
6908 inline functions declared in system headers.
6910 The compiler uses a variety of heuristics to determine whether or not
6911 to inline a function.  For example, the compiler takes into account
6912 the size of the function being inlined and the amount of inlining
6913 that has already been done in the current function.  Therefore,
6914 seemingly insignificant changes in the source program can cause the
6915 warnings produced by @option{-Winline} to appear or disappear.
6917 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6918 @opindex Wno-invalid-offsetof
6919 @opindex Winvalid-offsetof
6920 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6921 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6922 to a non-standard-layout type is undefined.  In existing C++ implementations,
6923 however, @code{offsetof} typically gives meaningful results.
6924 This flag is for users who are aware that they are
6925 writing nonportable code and who have deliberately chosen to ignore the
6926 warning about it.
6928 The restrictions on @code{offsetof} may be relaxed in a future version
6929 of the C++ standard.
6931 @item -Wint-in-bool-context
6932 @opindex Wint-in-bool-context
6933 @opindex Wno-int-in-bool-context
6934 Warn for suspicious use of integer values where boolean values are expected,
6935 such as conditional expressions (?:) using non-boolean integer constants in
6936 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6937 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6938 for all kinds of multiplications regardless of the data type.
6939 This warning is enabled by @option{-Wall}.
6941 @item -Wno-int-to-pointer-cast
6942 @opindex Wno-int-to-pointer-cast
6943 @opindex Wint-to-pointer-cast
6944 Suppress warnings from casts to pointer type of an integer of a
6945 different size. In C++, casting to a pointer type of smaller size is
6946 an error. @option{Wint-to-pointer-cast} is enabled by default.
6949 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6950 @opindex Wno-pointer-to-int-cast
6951 @opindex Wpointer-to-int-cast
6952 Suppress warnings from casts from a pointer to an integer type of a
6953 different size.
6955 @item -Winvalid-pch
6956 @opindex Winvalid-pch
6957 @opindex Wno-invalid-pch
6958 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6959 the search path but cannot be used.
6961 @item -Wlong-long
6962 @opindex Wlong-long
6963 @opindex Wno-long-long
6964 Warn if @code{long long} type is used.  This is enabled by either
6965 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6966 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6968 @item -Wvariadic-macros
6969 @opindex Wvariadic-macros
6970 @opindex Wno-variadic-macros
6971 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6972 alternate syntax is used in ISO C99 mode.  This is enabled by either
6973 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6974 messages, use @option{-Wno-variadic-macros}.
6976 @item -Wvarargs
6977 @opindex Wvarargs
6978 @opindex Wno-varargs
6979 Warn upon questionable usage of the macros used to handle variable
6980 arguments like @code{va_start}.  This is default.  To inhibit the
6981 warning messages, use @option{-Wno-varargs}.
6983 @item -Wvector-operation-performance
6984 @opindex Wvector-operation-performance
6985 @opindex Wno-vector-operation-performance
6986 Warn if vector operation is not implemented via SIMD capabilities of the
6987 architecture.  Mainly useful for the performance tuning.
6988 Vector operation can be implemented @code{piecewise}, which means that the
6989 scalar operation is performed on every vector element; 
6990 @code{in parallel}, which means that the vector operation is implemented
6991 using scalars of wider type, which normally is more performance efficient;
6992 and @code{as a single scalar}, which means that vector fits into a
6993 scalar type.
6995 @item -Wno-virtual-move-assign
6996 @opindex Wvirtual-move-assign
6997 @opindex Wno-virtual-move-assign
6998 Suppress warnings about inheriting from a virtual base with a
6999 non-trivial C++11 move assignment operator.  This is dangerous because
7000 if the virtual base is reachable along more than one path, it is
7001 moved multiple times, which can mean both objects end up in the
7002 moved-from state.  If the move assignment operator is written to avoid
7003 moving from a moved-from object, this warning can be disabled.
7005 @item -Wvla
7006 @opindex Wvla
7007 @opindex Wno-vla
7008 Warn if a variable-length array is used in the code.
7009 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
7010 the variable-length array.
7012 @item -Wvla-larger-than=@var{n}
7013 If this option is used, the compiler will warn on uses of
7014 variable-length arrays where the size is either unbounded, or bounded
7015 by an argument that can be larger than @var{n} bytes.  This is similar
7016 to how @option{-Walloca-larger-than=@var{n}} works, but with
7017 variable-length arrays.
7019 Note that GCC may optimize small variable-length arrays of a known
7020 value into plain arrays, so this warning may not get triggered for
7021 such arrays.
7023 This warning is not enabled by @option{-Wall}, and is only active when
7024 @option{-ftree-vrp} is active (default for @option{-O2} and above).
7026 See also @option{-Walloca-larger-than=@var{n}}.
7028 @item -Wvolatile-register-var
7029 @opindex Wvolatile-register-var
7030 @opindex Wno-volatile-register-var
7031 Warn if a register variable is declared volatile.  The volatile
7032 modifier does not inhibit all optimizations that may eliminate reads
7033 and/or writes to register variables.  This warning is enabled by
7034 @option{-Wall}.
7036 @item -Wdisabled-optimization
7037 @opindex Wdisabled-optimization
7038 @opindex Wno-disabled-optimization
7039 Warn if a requested optimization pass is disabled.  This warning does
7040 not generally indicate that there is anything wrong with your code; it
7041 merely indicates that GCC's optimizers are unable to handle the code
7042 effectively.  Often, the problem is that your code is too big or too
7043 complex; GCC refuses to optimize programs when the optimization
7044 itself is likely to take inordinate amounts of time.
7046 @item -Wpointer-sign @r{(C and Objective-C only)}
7047 @opindex Wpointer-sign
7048 @opindex Wno-pointer-sign
7049 Warn for pointer argument passing or assignment with different signedness.
7050 This option is only supported for C and Objective-C@.  It is implied by
7051 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
7052 @option{-Wno-pointer-sign}.
7054 @item -Wstack-protector
7055 @opindex Wstack-protector
7056 @opindex Wno-stack-protector
7057 This option is only active when @option{-fstack-protector} is active.  It
7058 warns about functions that are not protected against stack smashing.
7060 @item -Woverlength-strings
7061 @opindex Woverlength-strings
7062 @opindex Wno-overlength-strings
7063 Warn about string constants that are longer than the ``minimum
7064 maximum'' length specified in the C standard.  Modern compilers
7065 generally allow string constants that are much longer than the
7066 standard's minimum limit, but very portable programs should avoid
7067 using longer strings.
7069 The limit applies @emph{after} string constant concatenation, and does
7070 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7071 C99, it was raised to 4095.  C++98 does not specify a normative
7072 minimum maximum, so we do not diagnose overlength strings in C++@.
7074 This option is implied by @option{-Wpedantic}, and can be disabled with
7075 @option{-Wno-overlength-strings}.
7077 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7078 @opindex Wunsuffixed-float-constants
7079 @opindex Wno-unsuffixed-float-constants
7081 Issue a warning for any floating constant that does not have
7082 a suffix.  When used together with @option{-Wsystem-headers} it
7083 warns about such constants in system header files.  This can be useful
7084 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7085 from the decimal floating-point extension to C99.
7087 @item -Wno-designated-init @r{(C and Objective-C only)}
7088 Suppress warnings when a positional initializer is used to initialize
7089 a structure that has been marked with the @code{designated_init}
7090 attribute.
7092 @item -Whsa
7093 Issue a warning when HSAIL cannot be emitted for the compiled function or
7094 OpenMP construct.
7096 @end table
7098 @node Debugging Options
7099 @section Options for Debugging Your Program
7100 @cindex options, debugging
7101 @cindex debugging information options
7103 To tell GCC to emit extra information for use by a debugger, in almost 
7104 all cases you need only to add @option{-g} to your other options.
7106 GCC allows you to use @option{-g} with
7107 @option{-O}.  The shortcuts taken by optimized code may occasionally
7108 be surprising: some variables you declared may not exist
7109 at all; flow of control may briefly move where you did not expect it;
7110 some statements may not be executed because they compute constant
7111 results or their values are already at hand; some statements may
7112 execute in different places because they have been moved out of loops.
7113 Nevertheless it is possible to debug optimized output.  This makes
7114 it reasonable to use the optimizer for programs that might have bugs.
7116 If you are not using some other optimization option, consider
7117 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7118 With no @option{-O} option at all, some compiler passes that collect
7119 information useful for debugging do not run at all, so that
7120 @option{-Og} may result in a better debugging experience.
7122 @table @gcctabopt
7123 @item -g
7124 @opindex g
7125 Produce debugging information in the operating system's native format
7126 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7127 information.
7129 On most systems that use stabs format, @option{-g} enables use of extra
7130 debugging information that only GDB can use; this extra information
7131 makes debugging work better in GDB but probably makes other debuggers
7132 crash or
7133 refuse to read the program.  If you want to control for certain whether
7134 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7135 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7137 @item -ggdb
7138 @opindex ggdb
7139 Produce debugging information for use by GDB@.  This means to use the
7140 most expressive format available (DWARF, stabs, or the native format
7141 if neither of those are supported), including GDB extensions if at all
7142 possible.
7144 @item -gdwarf
7145 @itemx -gdwarf-@var{version}
7146 @opindex gdwarf
7147 Produce debugging information in DWARF format (if that is supported).
7148 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7149 for most targets is 4.  DWARF Version 5 is only experimental.
7151 Note that with DWARF Version 2, some ports require and always
7152 use some non-conflicting DWARF 3 extensions in the unwind tables.
7154 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7155 for maximum benefit.
7157 GCC no longer supports DWARF Version 1, which is substantially
7158 different than Version 2 and later.  For historical reasons, some
7159 other DWARF-related options such as
7160 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7161 in their names, but apply to all currently-supported versions of DWARF.
7163 @item -gstabs
7164 @opindex gstabs
7165 Produce debugging information in stabs format (if that is supported),
7166 without GDB extensions.  This is the format used by DBX on most BSD
7167 systems.  On MIPS, Alpha and System V Release 4 systems this option
7168 produces stabs debugging output that is not understood by DBX@.
7169 On System V Release 4 systems this option requires the GNU assembler.
7171 @item -gstabs+
7172 @opindex gstabs+
7173 Produce debugging information in stabs format (if that is supported),
7174 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7175 use of these extensions is likely to make other debuggers crash or
7176 refuse to read the program.
7178 @item -gxcoff
7179 @opindex gxcoff
7180 Produce debugging information in XCOFF format (if that is supported).
7181 This is the format used by the DBX debugger on IBM RS/6000 systems.
7183 @item -gxcoff+
7184 @opindex gxcoff+
7185 Produce debugging information in XCOFF format (if that is supported),
7186 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7187 use of these extensions is likely to make other debuggers crash or
7188 refuse to read the program, and may cause assemblers other than the GNU
7189 assembler (GAS) to fail with an error.
7191 @item -gvms
7192 @opindex gvms
7193 Produce debugging information in Alpha/VMS debug format (if that is
7194 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7196 @item -g@var{level}
7197 @itemx -ggdb@var{level}
7198 @itemx -gstabs@var{level}
7199 @itemx -gxcoff@var{level}
7200 @itemx -gvms@var{level}
7201 Request debugging information and also use @var{level} to specify how
7202 much information.  The default level is 2.
7204 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7205 @option{-g}.
7207 Level 1 produces minimal information, enough for making backtraces in
7208 parts of the program that you don't plan to debug.  This includes
7209 descriptions of functions and external variables, and line number
7210 tables, but no information about local variables.
7212 Level 3 includes extra information, such as all the macro definitions
7213 present in the program.  Some debuggers support macro expansion when
7214 you use @option{-g3}.
7216 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7217 confusion with @option{-gdwarf-@var{level}}.
7218 Instead use an additional @option{-g@var{level}} option to change the
7219 debug level for DWARF.
7221 @item -feliminate-unused-debug-symbols
7222 @opindex feliminate-unused-debug-symbols
7223 Produce debugging information in stabs format (if that is supported),
7224 for only symbols that are actually used.
7226 @item -femit-class-debug-always
7227 @opindex femit-class-debug-always
7228 Instead of emitting debugging information for a C++ class in only one
7229 object file, emit it in all object files using the class.  This option
7230 should be used only with debuggers that are unable to handle the way GCC
7231 normally emits debugging information for classes because using this
7232 option increases the size of debugging information by as much as a
7233 factor of two.
7235 @item -fno-merge-debug-strings
7236 @opindex fmerge-debug-strings
7237 @opindex fno-merge-debug-strings
7238 Direct the linker to not merge together strings in the debugging
7239 information that are identical in different object files.  Merging is
7240 not supported by all assemblers or linkers.  Merging decreases the size
7241 of the debug information in the output file at the cost of increasing
7242 link processing time.  Merging is enabled by default.
7244 @item -fdebug-prefix-map=@var{old}=@var{new}
7245 @opindex fdebug-prefix-map
7246 When compiling files residing in directory @file{@var{old}}, record
7247 debugging information describing them as if the files resided in
7248 directory @file{@var{new}} instead.  This can be used to replace a
7249 build-time path with an install-time path in the debug info.  It can
7250 also be used to change an absolute path to a relative path by using
7251 @file{.} for @var{new}.  This can give more reproducible builds, which
7252 are location independent, but may require an extra command to tell GDB
7253 where to find the source files. See also @option{-ffile-prefix-map}.
7255 @item -fvar-tracking
7256 @opindex fvar-tracking
7257 Run variable tracking pass.  It computes where variables are stored at each
7258 position in code.  Better debugging information is then generated
7259 (if the debugging information format supports this information).
7261 It is enabled by default when compiling with optimization (@option{-Os},
7262 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7263 the debug info format supports it.
7265 @item -fvar-tracking-assignments
7266 @opindex fvar-tracking-assignments
7267 @opindex fno-var-tracking-assignments
7268 Annotate assignments to user variables early in the compilation and
7269 attempt to carry the annotations over throughout the compilation all the
7270 way to the end, in an attempt to improve debug information while
7271 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7273 It can be enabled even if var-tracking is disabled, in which case
7274 annotations are created and maintained, but discarded at the end.
7275 By default, this flag is enabled together with @option{-fvar-tracking},
7276 except when selective scheduling is enabled.
7278 @item -gsplit-dwarf
7279 @opindex gsplit-dwarf
7280 Separate as much DWARF debugging information as possible into a
7281 separate output file with the extension @file{.dwo}.  This option allows
7282 the build system to avoid linking files with debug information.  To
7283 be useful, this option requires a debugger capable of reading @file{.dwo}
7284 files.
7286 @item -gpubnames
7287 @opindex gpubnames
7288 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7290 @item -ggnu-pubnames
7291 @opindex ggnu-pubnames
7292 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7293 suitable for conversion into a GDB@ index.  This option is only useful
7294 with a linker that can produce GDB@ index version 7.
7296 @item -fdebug-types-section
7297 @opindex fdebug-types-section
7298 @opindex fno-debug-types-section
7299 When using DWARF Version 4 or higher, type DIEs can be put into
7300 their own @code{.debug_types} section instead of making them part of the
7301 @code{.debug_info} section.  It is more efficient to put them in a separate
7302 comdat section since the linker can then remove duplicates.
7303 But not all DWARF consumers support @code{.debug_types} sections yet
7304 and on some objects @code{.debug_types} produces larger instead of smaller
7305 debugging information.
7307 @item -grecord-gcc-switches
7308 @itemx -gno-record-gcc-switches
7309 @opindex grecord-gcc-switches
7310 @opindex gno-record-gcc-switches
7311 This switch causes the command-line options used to invoke the
7312 compiler that may affect code generation to be appended to the
7313 DW_AT_producer attribute in DWARF debugging information.  The options
7314 are concatenated with spaces separating them from each other and from
7315 the compiler version.  
7316 It is enabled by default.
7317 See also @option{-frecord-gcc-switches} for another
7318 way of storing compiler options into the object file.  
7320 @item -gstrict-dwarf
7321 @opindex gstrict-dwarf
7322 Disallow using extensions of later DWARF standard version than selected
7323 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7324 DWARF extensions from later standard versions is allowed.
7326 @item -gno-strict-dwarf
7327 @opindex gno-strict-dwarf
7328 Allow using extensions of later DWARF standard version than selected with
7329 @option{-gdwarf-@var{version}}.
7331 @item -gas-loc-support
7332 @opindex gas-loc-support
7333 Inform the compiler that the assembler supports @code{.loc} directives.
7334 It may then use them for the assembler to generate DWARF2+ line number
7335 tables.
7337 This is generally desirable, because assembler-generated line-number
7338 tables are a lot more compact than those the compiler can generate
7339 itself.
7341 This option will be enabled by default if, at GCC configure time, the
7342 assembler was found to support such directives.
7344 @item -gno-as-loc-support
7345 @opindex gno-as-loc-support
7346 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7347 line number tables are to be generated.
7349 @item gas-locview-support
7350 @opindex gas-locview-support
7351 Inform the compiler that the assembler supports @code{view} assignment
7352 and reset assertion checking in @code{.loc} directives.
7354 This option will be enabled by default if, at GCC configure time, the
7355 assembler was found to support them.
7357 @item gno-as-locview-support
7358 Force GCC to assign view numbers internally, if
7359 @option{-gvariable-location-views} are explicitly requested.
7361 @item -gcolumn-info
7362 @itemx -gno-column-info
7363 @opindex gcolumn-info
7364 @opindex gno-column-info
7365 Emit location column information into DWARF debugging information, rather
7366 than just file and line.
7367 This option is enabled by default.
7369 @item -gstatement-frontiers
7370 @itemx -gno-statement-frontiers
7371 @opindex gstatement-frontiers
7372 @opindex gno-statement-frontiers
7373 This option causes GCC to create markers in the internal representation
7374 at the beginning of statements, and to keep them roughly in place
7375 throughout compilation, using them to guide the output of @code{is_stmt}
7376 markers in the line number table.  This is enabled by default when
7377 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7378 @dots{}), and outputting DWARF 2 debug information at the normal level.
7380 @item -gvariable-location-views
7381 @itemx -gvariable-location-views=incompat5
7382 @itemx -gno-variable-location-views
7383 @opindex gvariable-location-views
7384 @opindex gvariable-location-views=incompat5
7385 @opindex gno-variable-location-views
7386 Augment variable location lists with progressive view numbers implied
7387 from the line number table.  This enables debug information consumers to
7388 inspect state at certain points of the program, even if no instructions
7389 associated with the corresponding source locations are present at that
7390 point.  If the assembler lacks support for view numbers in line number
7391 tables, this will cause the compiler to emit the line number table,
7392 which generally makes them somewhat less compact.  The augmented line
7393 number tables and location lists are fully backward-compatible, so they
7394 can be consumed by debug information consumers that are not aware of
7395 these augmentations, but they won't derive any benefit from them either.
7397 This is enabled by default when outputting DWARF 2 debug information at
7398 the normal level, as long as there is assembler support,
7399 @option{-fvar-tracking-assignments} is enabled and
7400 @option{-gstrict-dwarf} is not.  When assembler support is not
7401 available, this may still be enabled, but it will force GCC to output
7402 internal line number tables, and if
7403 @option{-ginternal-reset-location-views} is not enabled, that will most
7404 certainly lead to silently mismatching location views.
7406 There is a proposed representation for view numbers that is not backward
7407 compatible with the location list format introduced in DWARF 5, that can
7408 be enabled with @option{-gvariable-location-views=incompat5}.  This
7409 option may be removed in the future, is only provided as a reference
7410 implementation of the proposed representation.  Debug information
7411 consumers are not expected to support this extended format, and they
7412 would be rendered unable to decode location lists using it.
7414 @item -ginternal-reset-location-views
7415 @itemx -gnointernal-reset-location-views
7416 @opindex ginternal-reset-location-views
7417 @opindex gno-internal-reset-location-views
7418 Attempt to determine location views that can be omitted from location
7419 view lists.  This requires the compiler to have very accurate insn
7420 length estimates, which isn't always the case, and it may cause
7421 incorrect view lists to be generated silently when using an assembler
7422 that does not support location view lists.  The GNU assembler will flag
7423 any such error as a @code{view number mismatch}.  This is only enabled
7424 on ports that define a reliable estimation function.
7426 @item -ginline-points
7427 @itemx -gno-inline-points
7428 @opindex ginline-points
7429 @opindex gno-inline-points
7430 Generate extended debug information for inlined functions.  Location
7431 view tracking markers are inserted at inlined entry points, so that
7432 address and view numbers can be computed and output in debug
7433 information.  This can be enabled independently of location views, in
7434 which case the view numbers won't be output, but it can only be enabled
7435 along with statement frontiers, and it is only enabled by default if
7436 location views are enabled.
7438 @item -gz@r{[}=@var{type}@r{]}
7439 @opindex gz
7440 Produce compressed debug sections in DWARF format, if that is supported.
7441 If @var{type} is not given, the default type depends on the capabilities
7442 of the assembler and linker used.  @var{type} may be one of
7443 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7444 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7445 compression in traditional GNU format).  If the linker doesn't support
7446 writing compressed debug sections, the option is rejected.  Otherwise,
7447 if the assembler does not support them, @option{-gz} is silently ignored
7448 when producing object files.
7450 @item -femit-struct-debug-baseonly
7451 @opindex femit-struct-debug-baseonly
7452 Emit debug information for struct-like types
7453 only when the base name of the compilation source file
7454 matches the base name of file in which the struct is defined.
7456 This option substantially reduces the size of debugging information,
7457 but at significant potential loss in type information to the debugger.
7458 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7459 See @option{-femit-struct-debug-detailed} for more detailed control.
7461 This option works only with DWARF debug output.
7463 @item -femit-struct-debug-reduced
7464 @opindex femit-struct-debug-reduced
7465 Emit debug information for struct-like types
7466 only when the base name of the compilation source file
7467 matches the base name of file in which the type is defined,
7468 unless the struct is a template or defined in a system header.
7470 This option significantly reduces the size of debugging information,
7471 with some potential loss in type information to the debugger.
7472 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7473 See @option{-femit-struct-debug-detailed} for more detailed control.
7475 This option works only with DWARF debug output.
7477 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7478 @opindex femit-struct-debug-detailed
7479 Specify the struct-like types
7480 for which the compiler generates debug information.
7481 The intent is to reduce duplicate struct debug information
7482 between different object files within the same program.
7484 This option is a detailed version of
7485 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7486 which serves for most needs.
7488 A specification has the syntax@*
7489 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7491 The optional first word limits the specification to
7492 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7493 A struct type is used directly when it is the type of a variable, member.
7494 Indirect uses arise through pointers to structs.
7495 That is, when use of an incomplete struct is valid, the use is indirect.
7496 An example is
7497 @samp{struct one direct; struct two * indirect;}.
7499 The optional second word limits the specification to
7500 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7501 Generic structs are a bit complicated to explain.
7502 For C++, these are non-explicit specializations of template classes,
7503 or non-template classes within the above.
7504 Other programming languages have generics,
7505 but @option{-femit-struct-debug-detailed} does not yet implement them.
7507 The third word specifies the source files for those
7508 structs for which the compiler should emit debug information.
7509 The values @samp{none} and @samp{any} have the normal meaning.
7510 The value @samp{base} means that
7511 the base of name of the file in which the type declaration appears
7512 must match the base of the name of the main compilation file.
7513 In practice, this means that when compiling @file{foo.c}, debug information
7514 is generated for types declared in that file and @file{foo.h},
7515 but not other header files.
7516 The value @samp{sys} means those types satisfying @samp{base}
7517 or declared in system or compiler headers.
7519 You may need to experiment to determine the best settings for your application.
7521 The default is @option{-femit-struct-debug-detailed=all}.
7523 This option works only with DWARF debug output.
7525 @item -fno-dwarf2-cfi-asm
7526 @opindex fdwarf2-cfi-asm
7527 @opindex fno-dwarf2-cfi-asm
7528 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7529 instead of using GAS @code{.cfi_*} directives.
7531 @item -fno-eliminate-unused-debug-types
7532 @opindex feliminate-unused-debug-types
7533 @opindex fno-eliminate-unused-debug-types
7534 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7535 output for types that are nowhere used in the source file being compiled.
7536 Sometimes it is useful to have GCC emit debugging
7537 information for all types declared in a compilation
7538 unit, regardless of whether or not they are actually used
7539 in that compilation unit, for example 
7540 if, in the debugger, you want to cast a value to a type that is
7541 not actually used in your program (but is declared).  More often,
7542 however, this results in a significant amount of wasted space.
7543 @end table
7545 @node Optimize Options
7546 @section Options That Control Optimization
7547 @cindex optimize options
7548 @cindex options, optimization
7550 These options control various sorts of optimizations.
7552 Without any optimization option, the compiler's goal is to reduce the
7553 cost of compilation and to make debugging produce the expected
7554 results.  Statements are independent: if you stop the program with a
7555 breakpoint between statements, you can then assign a new value to any
7556 variable or change the program counter to any other statement in the
7557 function and get exactly the results you expect from the source
7558 code.
7560 Turning on optimization flags makes the compiler attempt to improve
7561 the performance and/or code size at the expense of compilation time
7562 and possibly the ability to debug the program.
7564 The compiler performs optimization based on the knowledge it has of the
7565 program.  Compiling multiple files at once to a single output file mode allows
7566 the compiler to use information gained from all of the files when compiling
7567 each of them.
7569 Not all optimizations are controlled directly by a flag.  Only
7570 optimizations that have a flag are listed in this section.
7572 Most optimizations are only enabled if an @option{-O} level is set on
7573 the command line.  Otherwise they are disabled, even if individual
7574 optimization flags are specified.
7576 Depending on the target and how GCC was configured, a slightly different
7577 set of optimizations may be enabled at each @option{-O} level than
7578 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7579 to find out the exact set of optimizations that are enabled at each level.
7580 @xref{Overall Options}, for examples.
7582 @table @gcctabopt
7583 @item -O
7584 @itemx -O1
7585 @opindex O
7586 @opindex O1
7587 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7588 more memory for a large function.
7590 With @option{-O}, the compiler tries to reduce code size and execution
7591 time, without performing any optimizations that take a great deal of
7592 compilation time.
7594 @option{-O} turns on the following optimization flags:
7595 @gccoptlist{
7596 -fauto-inc-dec @gol
7597 -fbranch-count-reg @gol
7598 -fcombine-stack-adjustments @gol
7599 -fcompare-elim @gol
7600 -fcprop-registers @gol
7601 -fdce @gol
7602 -fdefer-pop @gol
7603 -fdelayed-branch @gol
7604 -fdse @gol
7605 -fforward-propagate @gol
7606 -fguess-branch-probability @gol
7607 -fif-conversion2 @gol
7608 -fif-conversion @gol
7609 -finline-functions-called-once @gol
7610 -fipa-pure-const @gol
7611 -fipa-profile @gol
7612 -fipa-reference @gol
7613 -fmerge-constants @gol
7614 -fmove-loop-invariants @gol
7615 -fomit-frame-pointer @gol
7616 -freorder-blocks @gol
7617 -fshrink-wrap @gol
7618 -fshrink-wrap-separate @gol
7619 -fsplit-wide-types @gol
7620 -fssa-backprop @gol
7621 -fssa-phiopt @gol
7622 -ftree-bit-ccp @gol
7623 -ftree-ccp @gol
7624 -ftree-ch @gol
7625 -ftree-coalesce-vars @gol
7626 -ftree-copy-prop @gol
7627 -ftree-dce @gol
7628 -ftree-dominator-opts @gol
7629 -ftree-dse @gol
7630 -ftree-forwprop @gol
7631 -ftree-fre @gol
7632 -ftree-phiprop @gol
7633 -ftree-sink @gol
7634 -ftree-slsr @gol
7635 -ftree-sra @gol
7636 -ftree-pta @gol
7637 -ftree-ter @gol
7638 -funit-at-a-time}
7640 @item -O2
7641 @opindex O2
7642 Optimize even more.  GCC performs nearly all supported optimizations
7643 that do not involve a space-speed tradeoff.
7644 As compared to @option{-O}, this option increases both compilation time
7645 and the performance of the generated code.
7647 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7648 also turns on the following optimization flags:
7649 @gccoptlist{-fthread-jumps @gol
7650 -falign-functions  -falign-jumps @gol
7651 -falign-loops  -falign-labels @gol
7652 -fcaller-saves @gol
7653 -fcrossjumping @gol
7654 -fcse-follow-jumps  -fcse-skip-blocks @gol
7655 -fdelete-null-pointer-checks @gol
7656 -fdevirtualize -fdevirtualize-speculatively @gol
7657 -fexpensive-optimizations @gol
7658 -fgcse  -fgcse-lm  @gol
7659 -fhoist-adjacent-loads @gol
7660 -finline-small-functions @gol
7661 -findirect-inlining @gol
7662 -fipa-cp @gol
7663 -fipa-bit-cp @gol
7664 -fipa-vrp @gol
7665 -fipa-sra @gol
7666 -fipa-icf @gol
7667 -fisolate-erroneous-paths-dereference @gol
7668 -flra-remat @gol
7669 -foptimize-sibling-calls @gol
7670 -foptimize-strlen @gol
7671 -fpartial-inlining @gol
7672 -fpeephole2 @gol
7673 -freorder-blocks-algorithm=stc @gol
7674 -freorder-blocks-and-partition -freorder-functions @gol
7675 -frerun-cse-after-loop  @gol
7676 -fsched-interblock  -fsched-spec @gol
7677 -fschedule-insns  -fschedule-insns2 @gol
7678 -fstore-merging @gol
7679 -fstrict-aliasing @gol
7680 -ftree-builtin-call-dce @gol
7681 -ftree-switch-conversion -ftree-tail-merge @gol
7682 -fcode-hoisting @gol
7683 -ftree-pre @gol
7684 -ftree-vrp @gol
7685 -fipa-ra}
7687 Please note the warning under @option{-fgcse} about
7688 invoking @option{-O2} on programs that use computed gotos.
7690 @item -O3
7691 @opindex O3
7692 Optimize yet more.  @option{-O3} turns on all optimizations specified
7693 by @option{-O2} and also turns on the following optimization flags:
7694 @gccoptlist{-finline-functions @gol
7695 -funswitch-loops @gol
7696 -fpredictive-commoning @gol
7697 -fgcse-after-reload @gol
7698 -ftree-loop-vectorize @gol
7699 -ftree-loop-distribution @gol
7700 -ftree-loop-distribute-patterns @gol
7701 -floop-interchange @gol
7702 -floop-unroll-and-jam @gol
7703 -fsplit-paths @gol
7704 -ftree-slp-vectorize @gol
7705 -fvect-cost-model @gol
7706 -ftree-partial-pre @gol
7707 -fpeel-loops @gol
7708 -fipa-cp-clone}
7710 @item -O0
7711 @opindex O0
7712 Reduce compilation time and make debugging produce the expected
7713 results.  This is the default.
7715 @item -Os
7716 @opindex Os
7717 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7718 do not typically increase code size.  It also performs further
7719 optimizations designed to reduce code size.
7721 @option{-Os} disables the following optimization flags:
7722 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7723 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7724 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7726 @item -Ofast
7727 @opindex Ofast
7728 Disregard strict standards compliance.  @option{-Ofast} enables all
7729 @option{-O3} optimizations.  It also enables optimizations that are not
7730 valid for all standard-compliant programs.
7731 It turns on @option{-ffast-math} and the Fortran-specific
7732 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7733 specified, and @option{-fno-protect-parens}.
7735 @item -Og
7736 @opindex Og
7737 Optimize debugging experience.  @option{-Og} enables optimizations
7738 that do not interfere with debugging. It should be the optimization
7739 level of choice for the standard edit-compile-debug cycle, offering
7740 a reasonable level of optimization while maintaining fast compilation
7741 and a good debugging experience.
7742 @end table
7744 If you use multiple @option{-O} options, with or without level numbers,
7745 the last such option is the one that is effective.
7747 Options of the form @option{-f@var{flag}} specify machine-independent
7748 flags.  Most flags have both positive and negative forms; the negative
7749 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7750 below, only one of the forms is listed---the one you typically 
7751 use.  You can figure out the other form by either removing @samp{no-}
7752 or adding it.
7754 The following options control specific optimizations.  They are either
7755 activated by @option{-O} options or are related to ones that are.  You
7756 can use the following flags in the rare cases when ``fine-tuning'' of
7757 optimizations to be performed is desired.
7759 @table @gcctabopt
7760 @item -fno-defer-pop
7761 @opindex fno-defer-pop
7762 Always pop the arguments to each function call as soon as that function
7763 returns.  For machines that must pop arguments after a function call,
7764 the compiler normally lets arguments accumulate on the stack for several
7765 function calls and pops them all at once.
7767 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7769 @item -fforward-propagate
7770 @opindex fforward-propagate
7771 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7772 instructions and checks if the result can be simplified.  If loop unrolling
7773 is active, two passes are performed and the second is scheduled after
7774 loop unrolling.
7776 This option is enabled by default at optimization levels @option{-O},
7777 @option{-O2}, @option{-O3}, @option{-Os}.
7779 @item -ffp-contract=@var{style}
7780 @opindex ffp-contract
7781 @option{-ffp-contract=off} disables floating-point expression contraction.
7782 @option{-ffp-contract=fast} enables floating-point expression contraction
7783 such as forming of fused multiply-add operations if the target has
7784 native support for them.
7785 @option{-ffp-contract=on} enables floating-point expression contraction
7786 if allowed by the language standard.  This is currently not implemented
7787 and treated equal to @option{-ffp-contract=off}.
7789 The default is @option{-ffp-contract=fast}.
7791 @item -fomit-frame-pointer
7792 @opindex fomit-frame-pointer
7793 Omit the frame pointer in functions that don't need one.  This avoids the
7794 instructions to save, set up and restore the frame pointer; on many targets
7795 it also makes an extra register available.
7797 On some targets this flag has no effect because the standard calling sequence
7798 always uses a frame pointer, so it cannot be omitted.
7800 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7801 is used in all functions.  Several targets always omit the frame pointer in
7802 leaf functions.
7804 Enabled by default at @option{-O} and higher.
7806 @item -foptimize-sibling-calls
7807 @opindex foptimize-sibling-calls
7808 Optimize sibling and tail recursive calls.
7810 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7812 @item -foptimize-strlen
7813 @opindex foptimize-strlen
7814 Optimize various standard C string functions (e.g. @code{strlen},
7815 @code{strchr} or @code{strcpy}) and
7816 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7818 Enabled at levels @option{-O2}, @option{-O3}.
7820 @item -fno-inline
7821 @opindex fno-inline
7822 Do not expand any functions inline apart from those marked with
7823 the @code{always_inline} attribute.  This is the default when not
7824 optimizing.
7826 Single functions can be exempted from inlining by marking them
7827 with the @code{noinline} attribute.
7829 @item -finline-small-functions
7830 @opindex finline-small-functions
7831 Integrate functions into their callers when their body is smaller than expected
7832 function call code (so overall size of program gets smaller).  The compiler
7833 heuristically decides which functions are simple enough to be worth integrating
7834 in this way.  This inlining applies to all functions, even those not declared
7835 inline.
7837 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7839 @item -findirect-inlining
7840 @opindex findirect-inlining
7841 Inline also indirect calls that are discovered to be known at compile
7842 time thanks to previous inlining.  This option has any effect only
7843 when inlining itself is turned on by the @option{-finline-functions}
7844 or @option{-finline-small-functions} options.
7846 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7848 @item -finline-functions
7849 @opindex finline-functions
7850 Consider all functions for inlining, even if they are not declared inline.
7851 The compiler heuristically decides which functions are worth integrating
7852 in this way.
7854 If all calls to a given function are integrated, and the function is
7855 declared @code{static}, then the function is normally not output as
7856 assembler code in its own right.
7858 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7860 @item -finline-functions-called-once
7861 @opindex finline-functions-called-once
7862 Consider all @code{static} functions called once for inlining into their
7863 caller even if they are not marked @code{inline}.  If a call to a given
7864 function is integrated, then the function is not output as assembler code
7865 in its own right.
7867 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7869 @item -fearly-inlining
7870 @opindex fearly-inlining
7871 Inline functions marked by @code{always_inline} and functions whose body seems
7872 smaller than the function call overhead early before doing
7873 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7874 makes profiling significantly cheaper and usually inlining faster on programs
7875 having large chains of nested wrapper functions.
7877 Enabled by default.
7879 @item -fipa-sra
7880 @opindex fipa-sra
7881 Perform interprocedural scalar replacement of aggregates, removal of
7882 unused parameters and replacement of parameters passed by reference
7883 by parameters passed by value.
7885 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7887 @item -finline-limit=@var{n}
7888 @opindex finline-limit
7889 By default, GCC limits the size of functions that can be inlined.  This flag
7890 allows coarse control of this limit.  @var{n} is the size of functions that
7891 can be inlined in number of pseudo instructions.
7893 Inlining is actually controlled by a number of parameters, which may be
7894 specified individually by using @option{--param @var{name}=@var{value}}.
7895 The @option{-finline-limit=@var{n}} option sets some of these parameters
7896 as follows:
7898 @table @gcctabopt
7899 @item max-inline-insns-single
7900 is set to @var{n}/2.
7901 @item max-inline-insns-auto
7902 is set to @var{n}/2.
7903 @end table
7905 See below for a documentation of the individual
7906 parameters controlling inlining and for the defaults of these parameters.
7908 @emph{Note:} there may be no value to @option{-finline-limit} that results
7909 in default behavior.
7911 @emph{Note:} pseudo instruction represents, in this particular context, an
7912 abstract measurement of function's size.  In no way does it represent a count
7913 of assembly instructions and as such its exact meaning might change from one
7914 release to an another.
7916 @item -fno-keep-inline-dllexport
7917 @opindex fno-keep-inline-dllexport
7918 This is a more fine-grained version of @option{-fkeep-inline-functions},
7919 which applies only to functions that are declared using the @code{dllexport}
7920 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7921 Functions}.
7923 @item -fkeep-inline-functions
7924 @opindex fkeep-inline-functions
7925 In C, emit @code{static} functions that are declared @code{inline}
7926 into the object file, even if the function has been inlined into all
7927 of its callers.  This switch does not affect functions using the
7928 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7929 inline functions into the object file.
7931 @item -fkeep-static-functions
7932 @opindex fkeep-static-functions
7933 Emit @code{static} functions into the object file, even if the function
7934 is never used.
7936 @item -fkeep-static-consts
7937 @opindex fkeep-static-consts
7938 Emit variables declared @code{static const} when optimization isn't turned
7939 on, even if the variables aren't referenced.
7941 GCC enables this option by default.  If you want to force the compiler to
7942 check if a variable is referenced, regardless of whether or not
7943 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7945 @item -fmerge-constants
7946 @opindex fmerge-constants
7947 Attempt to merge identical constants (string constants and floating-point
7948 constants) across compilation units.
7950 This option is the default for optimized compilation if the assembler and
7951 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7952 behavior.
7954 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7956 @item -fmerge-all-constants
7957 @opindex fmerge-all-constants
7958 Attempt to merge identical constants and identical variables.
7960 This option implies @option{-fmerge-constants}.  In addition to
7961 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7962 arrays or initialized constant variables with integral or floating-point
7963 types.  Languages like C or C++ require each variable, including multiple
7964 instances of the same variable in recursive calls, to have distinct locations,
7965 so using this option results in non-conforming
7966 behavior.
7968 @item -fmodulo-sched
7969 @opindex fmodulo-sched
7970 Perform swing modulo scheduling immediately before the first scheduling
7971 pass.  This pass looks at innermost loops and reorders their
7972 instructions by overlapping different iterations.
7974 @item -fmodulo-sched-allow-regmoves
7975 @opindex fmodulo-sched-allow-regmoves
7976 Perform more aggressive SMS-based modulo scheduling with register moves
7977 allowed.  By setting this flag certain anti-dependences edges are
7978 deleted, which triggers the generation of reg-moves based on the
7979 life-range analysis.  This option is effective only with
7980 @option{-fmodulo-sched} enabled.
7982 @item -fno-branch-count-reg
7983 @opindex fno-branch-count-reg
7984 Avoid running a pass scanning for opportunities to use ``decrement and
7985 branch'' instructions on a count register instead of generating sequences
7986 of instructions that decrement a register, compare it against zero, and
7987 then branch based upon the result.  This option is only meaningful on
7988 architectures that support such instructions, which include x86, PowerPC,
7989 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7990 doesn't remove the decrement and branch instructions from the generated
7991 instruction stream introduced by other optimization passes.
7993 Enabled by default at @option{-O1} and higher.
7995 The default is @option{-fbranch-count-reg}.
7997 @item -fno-function-cse
7998 @opindex fno-function-cse
7999 Do not put function addresses in registers; make each instruction that
8000 calls a constant function contain the function's address explicitly.
8002 This option results in less efficient code, but some strange hacks
8003 that alter the assembler output may be confused by the optimizations
8004 performed when this option is not used.
8006 The default is @option{-ffunction-cse}
8008 @item -fno-zero-initialized-in-bss
8009 @opindex fno-zero-initialized-in-bss
8010 If the target supports a BSS section, GCC by default puts variables that
8011 are initialized to zero into BSS@.  This can save space in the resulting
8012 code.
8014 This option turns off this behavior because some programs explicitly
8015 rely on variables going to the data section---e.g., so that the
8016 resulting executable can find the beginning of that section and/or make
8017 assumptions based on that.
8019 The default is @option{-fzero-initialized-in-bss}.
8021 @item -fthread-jumps
8022 @opindex fthread-jumps
8023 Perform optimizations that check to see if a jump branches to a
8024 location where another comparison subsumed by the first is found.  If
8025 so, the first branch is redirected to either the destination of the
8026 second branch or a point immediately following it, depending on whether
8027 the condition is known to be true or false.
8029 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8031 @item -fsplit-wide-types
8032 @opindex fsplit-wide-types
8033 When using a type that occupies multiple registers, such as @code{long
8034 long} on a 32-bit system, split the registers apart and allocate them
8035 independently.  This normally generates better code for those types,
8036 but may make debugging more difficult.
8038 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8039 @option{-Os}.
8041 @item -fcse-follow-jumps
8042 @opindex fcse-follow-jumps
8043 In common subexpression elimination (CSE), scan through jump instructions
8044 when the target of the jump is not reached by any other path.  For
8045 example, when CSE encounters an @code{if} statement with an
8046 @code{else} clause, CSE follows the jump when the condition
8047 tested is false.
8049 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8051 @item -fcse-skip-blocks
8052 @opindex fcse-skip-blocks
8053 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8054 follow jumps that conditionally skip over blocks.  When CSE
8055 encounters a simple @code{if} statement with no else clause,
8056 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8057 body of the @code{if}.
8059 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8061 @item -frerun-cse-after-loop
8062 @opindex frerun-cse-after-loop
8063 Re-run common subexpression elimination after loop optimizations are
8064 performed.
8066 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8068 @item -fgcse
8069 @opindex fgcse
8070 Perform a global common subexpression elimination pass.
8071 This pass also performs global constant and copy propagation.
8073 @emph{Note:} When compiling a program using computed gotos, a GCC
8074 extension, you may get better run-time performance if you disable
8075 the global common subexpression elimination pass by adding
8076 @option{-fno-gcse} to the command line.
8078 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8080 @item -fgcse-lm
8081 @opindex fgcse-lm
8082 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8083 attempts to move loads that are only killed by stores into themselves.  This
8084 allows a loop containing a load/store sequence to be changed to a load outside
8085 the loop, and a copy/store within the loop.
8087 Enabled by default when @option{-fgcse} is enabled.
8089 @item -fgcse-sm
8090 @opindex fgcse-sm
8091 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8092 global common subexpression elimination.  This pass attempts to move
8093 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8094 loops containing a load/store sequence can be changed to a load before
8095 the loop and a store after the loop.
8097 Not enabled at any optimization level.
8099 @item -fgcse-las
8100 @opindex fgcse-las
8101 When @option{-fgcse-las} is enabled, the global common subexpression
8102 elimination pass eliminates redundant loads that come after stores to the
8103 same memory location (both partial and full redundancies).
8105 Not enabled at any optimization level.
8107 @item -fgcse-after-reload
8108 @opindex fgcse-after-reload
8109 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8110 pass is performed after reload.  The purpose of this pass is to clean up
8111 redundant spilling.
8113 @item -faggressive-loop-optimizations
8114 @opindex faggressive-loop-optimizations
8115 This option tells the loop optimizer to use language constraints to
8116 derive bounds for the number of iterations of a loop.  This assumes that
8117 loop code does not invoke undefined behavior by for example causing signed
8118 integer overflows or out-of-bound array accesses.  The bounds for the
8119 number of iterations of a loop are used to guide loop unrolling and peeling
8120 and loop exit test optimizations.
8121 This option is enabled by default.
8123 @item -funconstrained-commons
8124 @opindex funconstrained-commons
8125 This option tells the compiler that variables declared in common blocks
8126 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8127 prevents certain optimizations that depend on knowing the array bounds.
8129 @item -fcrossjumping
8130 @opindex fcrossjumping
8131 Perform cross-jumping transformation.
8132 This transformation unifies equivalent code and saves code size.  The
8133 resulting code may or may not perform better than without cross-jumping.
8135 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8137 @item -fauto-inc-dec
8138 @opindex fauto-inc-dec
8139 Combine increments or decrements of addresses with memory accesses.
8140 This pass is always skipped on architectures that do not have
8141 instructions to support this.  Enabled by default at @option{-O} and
8142 higher on architectures that support this.
8144 @item -fdce
8145 @opindex fdce
8146 Perform dead code elimination (DCE) on RTL@.
8147 Enabled by default at @option{-O} and higher.
8149 @item -fdse
8150 @opindex fdse
8151 Perform dead store elimination (DSE) on RTL@.
8152 Enabled by default at @option{-O} and higher.
8154 @item -fif-conversion
8155 @opindex fif-conversion
8156 Attempt to transform conditional jumps into branch-less equivalents.  This
8157 includes use of conditional moves, min, max, set flags and abs instructions, and
8158 some tricks doable by standard arithmetics.  The use of conditional execution
8159 on chips where it is available is controlled by @option{-fif-conversion2}.
8161 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8163 @item -fif-conversion2
8164 @opindex fif-conversion2
8165 Use conditional execution (where available) to transform conditional jumps into
8166 branch-less equivalents.
8168 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8170 @item -fdeclone-ctor-dtor
8171 @opindex fdeclone-ctor-dtor
8172 The C++ ABI requires multiple entry points for constructors and
8173 destructors: one for a base subobject, one for a complete object, and
8174 one for a virtual destructor that calls operator delete afterwards.
8175 For a hierarchy with virtual bases, the base and complete variants are
8176 clones, which means two copies of the function.  With this option, the
8177 base and complete variants are changed to be thunks that call a common
8178 implementation.
8180 Enabled by @option{-Os}.
8182 @item -fdelete-null-pointer-checks
8183 @opindex fdelete-null-pointer-checks
8184 Assume that programs cannot safely dereference null pointers, and that
8185 no code or data element resides at address zero.
8186 This option enables simple constant
8187 folding optimizations at all optimization levels.  In addition, other
8188 optimization passes in GCC use this flag to control global dataflow
8189 analyses that eliminate useless checks for null pointers; these assume
8190 that a memory access to address zero always results in a trap, so
8191 that if a pointer is checked after it has already been dereferenced,
8192 it cannot be null.
8194 Note however that in some environments this assumption is not true.
8195 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8196 for programs that depend on that behavior.
8198 This option is enabled by default on most targets.  On Nios II ELF, it
8199 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8201 Passes that use the dataflow information
8202 are enabled independently at different optimization levels.
8204 @item -fdevirtualize
8205 @opindex fdevirtualize
8206 Attempt to convert calls to virtual functions to direct calls.  This
8207 is done both within a procedure and interprocedurally as part of
8208 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8209 propagation (@option{-fipa-cp}).
8210 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8212 @item -fdevirtualize-speculatively
8213 @opindex fdevirtualize-speculatively
8214 Attempt to convert calls to virtual functions to speculative direct calls.
8215 Based on the analysis of the type inheritance graph, determine for a given call
8216 the set of likely targets. If the set is small, preferably of size 1, change
8217 the call into a conditional deciding between direct and indirect calls.  The
8218 speculative calls enable more optimizations, such as inlining.  When they seem
8219 useless after further optimization, they are converted back into original form.
8221 @item -fdevirtualize-at-ltrans
8222 @opindex fdevirtualize-at-ltrans
8223 Stream extra information needed for aggressive devirtualization when running
8224 the link-time optimizer in local transformation mode.  
8225 This option enables more devirtualization but
8226 significantly increases the size of streamed data. For this reason it is
8227 disabled by default.
8229 @item -fexpensive-optimizations
8230 @opindex fexpensive-optimizations
8231 Perform a number of minor optimizations that are relatively expensive.
8233 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8235 @item -free
8236 @opindex free
8237 Attempt to remove redundant extension instructions.  This is especially
8238 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8239 registers after writing to their lower 32-bit half.
8241 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8242 @option{-O3}, @option{-Os}.
8244 @item -fno-lifetime-dse
8245 @opindex fno-lifetime-dse
8246 In C++ the value of an object is only affected by changes within its
8247 lifetime: when the constructor begins, the object has an indeterminate
8248 value, and any changes during the lifetime of the object are dead when
8249 the object is destroyed.  Normally dead store elimination will take
8250 advantage of this; if your code relies on the value of the object
8251 storage persisting beyond the lifetime of the object, you can use this
8252 flag to disable this optimization.  To preserve stores before the
8253 constructor starts (e.g. because your operator new clears the object
8254 storage) but still treat the object as dead after the destructor you,
8255 can use @option{-flifetime-dse=1}.  The default behavior can be
8256 explicitly selected with @option{-flifetime-dse=2}.
8257 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8259 @item -flive-range-shrinkage
8260 @opindex flive-range-shrinkage
8261 Attempt to decrease register pressure through register live range
8262 shrinkage.  This is helpful for fast processors with small or moderate
8263 size register sets.
8265 @item -fira-algorithm=@var{algorithm}
8266 @opindex fira-algorithm
8267 Use the specified coloring algorithm for the integrated register
8268 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8269 specifies Chow's priority coloring, or @samp{CB}, which specifies
8270 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8271 for all architectures, but for those targets that do support it, it is
8272 the default because it generates better code.
8274 @item -fira-region=@var{region}
8275 @opindex fira-region
8276 Use specified regions for the integrated register allocator.  The
8277 @var{region} argument should be one of the following:
8279 @table @samp
8281 @item all
8282 Use all loops as register allocation regions.
8283 This can give the best results for machines with a small and/or
8284 irregular register set.
8286 @item mixed
8287 Use all loops except for loops with small register pressure 
8288 as the regions.  This value usually gives
8289 the best results in most cases and for most architectures,
8290 and is enabled by default when compiling with optimization for speed
8291 (@option{-O}, @option{-O2}, @dots{}).
8293 @item one
8294 Use all functions as a single region.  
8295 This typically results in the smallest code size, and is enabled by default for
8296 @option{-Os} or @option{-O0}.
8298 @end table
8300 @item -fira-hoist-pressure
8301 @opindex fira-hoist-pressure
8302 Use IRA to evaluate register pressure in the code hoisting pass for
8303 decisions to hoist expressions.  This option usually results in smaller
8304 code, but it can slow the compiler down.
8306 This option is enabled at level @option{-Os} for all targets.
8308 @item -fira-loop-pressure
8309 @opindex fira-loop-pressure
8310 Use IRA to evaluate register pressure in loops for decisions to move
8311 loop invariants.  This option usually results in generation
8312 of faster and smaller code on machines with large register files (>= 32
8313 registers), but it can slow the compiler down.
8315 This option is enabled at level @option{-O3} for some targets.
8317 @item -fno-ira-share-save-slots
8318 @opindex fno-ira-share-save-slots
8319 Disable sharing of stack slots used for saving call-used hard
8320 registers living through a call.  Each hard register gets a
8321 separate stack slot, and as a result function stack frames are
8322 larger.
8324 @item -fno-ira-share-spill-slots
8325 @opindex fno-ira-share-spill-slots
8326 Disable sharing of stack slots allocated for pseudo-registers.  Each
8327 pseudo-register that does not get a hard register gets a separate
8328 stack slot, and as a result function stack frames are larger.
8330 @item -flra-remat
8331 @opindex flra-remat
8332 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8333 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8334 values if it is profitable.
8336 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8338 @item -fdelayed-branch
8339 @opindex fdelayed-branch
8340 If supported for the target machine, attempt to reorder instructions
8341 to exploit instruction slots available after delayed branch
8342 instructions.
8344 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8346 @item -fschedule-insns
8347 @opindex fschedule-insns
8348 If supported for the target machine, attempt to reorder instructions to
8349 eliminate execution stalls due to required data being unavailable.  This
8350 helps machines that have slow floating point or memory load instructions
8351 by allowing other instructions to be issued until the result of the load
8352 or floating-point instruction is required.
8354 Enabled at levels @option{-O2}, @option{-O3}.
8356 @item -fschedule-insns2
8357 @opindex fschedule-insns2
8358 Similar to @option{-fschedule-insns}, but requests an additional pass of
8359 instruction scheduling after register allocation has been done.  This is
8360 especially useful on machines with a relatively small number of
8361 registers and where memory load instructions take more than one cycle.
8363 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8365 @item -fno-sched-interblock
8366 @opindex fno-sched-interblock
8367 Don't schedule instructions across basic blocks.  This is normally
8368 enabled by default when scheduling before register allocation, i.e.@:
8369 with @option{-fschedule-insns} or at @option{-O2} or higher.
8371 @item -fno-sched-spec
8372 @opindex fno-sched-spec
8373 Don't allow speculative motion of non-load instructions.  This is normally
8374 enabled by default when scheduling before register allocation, i.e.@:
8375 with @option{-fschedule-insns} or at @option{-O2} or higher.
8377 @item -fsched-pressure
8378 @opindex fsched-pressure
8379 Enable register pressure sensitive insn scheduling before register
8380 allocation.  This only makes sense when scheduling before register
8381 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8382 @option{-O2} or higher.  Usage of this option can improve the
8383 generated code and decrease its size by preventing register pressure
8384 increase above the number of available hard registers and subsequent
8385 spills in register allocation.
8387 @item -fsched-spec-load
8388 @opindex fsched-spec-load
8389 Allow speculative motion of some load instructions.  This only makes
8390 sense when scheduling before register allocation, i.e.@: with
8391 @option{-fschedule-insns} or at @option{-O2} or higher.
8393 @item -fsched-spec-load-dangerous
8394 @opindex fsched-spec-load-dangerous
8395 Allow speculative motion of more load instructions.  This only makes
8396 sense when scheduling before register allocation, i.e.@: with
8397 @option{-fschedule-insns} or at @option{-O2} or higher.
8399 @item -fsched-stalled-insns
8400 @itemx -fsched-stalled-insns=@var{n}
8401 @opindex fsched-stalled-insns
8402 Define how many insns (if any) can be moved prematurely from the queue
8403 of stalled insns into the ready list during the second scheduling pass.
8404 @option{-fno-sched-stalled-insns} means that no insns are moved
8405 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8406 on how many queued insns can be moved prematurely.
8407 @option{-fsched-stalled-insns} without a value is equivalent to
8408 @option{-fsched-stalled-insns=1}.
8410 @item -fsched-stalled-insns-dep
8411 @itemx -fsched-stalled-insns-dep=@var{n}
8412 @opindex fsched-stalled-insns-dep
8413 Define how many insn groups (cycles) are examined for a dependency
8414 on a stalled insn that is a candidate for premature removal from the queue
8415 of stalled insns.  This has an effect only during the second scheduling pass,
8416 and only if @option{-fsched-stalled-insns} is used.
8417 @option{-fno-sched-stalled-insns-dep} is equivalent to
8418 @option{-fsched-stalled-insns-dep=0}.
8419 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8420 @option{-fsched-stalled-insns-dep=1}.
8422 @item -fsched2-use-superblocks
8423 @opindex fsched2-use-superblocks
8424 When scheduling after register allocation, use superblock scheduling.
8425 This allows motion across basic block boundaries,
8426 resulting in faster schedules.  This option is experimental, as not all machine
8427 descriptions used by GCC model the CPU closely enough to avoid unreliable
8428 results from the algorithm.
8430 This only makes sense when scheduling after register allocation, i.e.@: with
8431 @option{-fschedule-insns2} or at @option{-O2} or higher.
8433 @item -fsched-group-heuristic
8434 @opindex fsched-group-heuristic
8435 Enable the group heuristic in the scheduler.  This heuristic favors
8436 the instruction that belongs to a schedule group.  This is enabled
8437 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8438 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8440 @item -fsched-critical-path-heuristic
8441 @opindex fsched-critical-path-heuristic
8442 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8443 instructions on the critical path.  This is enabled by default when
8444 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8445 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8447 @item -fsched-spec-insn-heuristic
8448 @opindex fsched-spec-insn-heuristic
8449 Enable the speculative instruction heuristic in the scheduler.  This
8450 heuristic favors speculative instructions with greater dependency weakness.
8451 This is enabled by default when scheduling is enabled, i.e.@:
8452 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8453 or at @option{-O2} or higher.
8455 @item -fsched-rank-heuristic
8456 @opindex fsched-rank-heuristic
8457 Enable the rank heuristic in the scheduler.  This heuristic favors
8458 the instruction belonging to a basic block with greater size or frequency.
8459 This is enabled by default when scheduling is enabled, i.e.@:
8460 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8461 at @option{-O2} or higher.
8463 @item -fsched-last-insn-heuristic
8464 @opindex fsched-last-insn-heuristic
8465 Enable the last-instruction heuristic in the scheduler.  This heuristic
8466 favors the instruction that is less dependent on the last instruction
8467 scheduled.  This is enabled by default when scheduling is enabled,
8468 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8469 at @option{-O2} or higher.
8471 @item -fsched-dep-count-heuristic
8472 @opindex fsched-dep-count-heuristic
8473 Enable the dependent-count heuristic in the scheduler.  This heuristic
8474 favors the instruction that has more instructions depending on it.
8475 This is enabled by default when scheduling is enabled, i.e.@:
8476 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8477 at @option{-O2} or higher.
8479 @item -freschedule-modulo-scheduled-loops
8480 @opindex freschedule-modulo-scheduled-loops
8481 Modulo scheduling is performed before traditional scheduling.  If a loop
8482 is modulo scheduled, later scheduling passes may change its schedule.  
8483 Use this option to control that behavior.
8485 @item -fselective-scheduling
8486 @opindex fselective-scheduling
8487 Schedule instructions using selective scheduling algorithm.  Selective
8488 scheduling runs instead of the first scheduler pass.
8490 @item -fselective-scheduling2
8491 @opindex fselective-scheduling2
8492 Schedule instructions using selective scheduling algorithm.  Selective
8493 scheduling runs instead of the second scheduler pass.
8495 @item -fsel-sched-pipelining
8496 @opindex fsel-sched-pipelining
8497 Enable software pipelining of innermost loops during selective scheduling.
8498 This option has no effect unless one of @option{-fselective-scheduling} or
8499 @option{-fselective-scheduling2} is turned on.
8501 @item -fsel-sched-pipelining-outer-loops
8502 @opindex fsel-sched-pipelining-outer-loops
8503 When pipelining loops during selective scheduling, also pipeline outer loops.
8504 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8506 @item -fsemantic-interposition
8507 @opindex fsemantic-interposition
8508 Some object formats, like ELF, allow interposing of symbols by the 
8509 dynamic linker.
8510 This means that for symbols exported from the DSO, the compiler cannot perform
8511 interprocedural propagation, inlining and other optimizations in anticipation
8512 that the function or variable in question may change. While this feature is
8513 useful, for example, to rewrite memory allocation functions by a debugging
8514 implementation, it is expensive in the terms of code quality.
8515 With @option{-fno-semantic-interposition} the compiler assumes that 
8516 if interposition happens for functions the overwriting function will have 
8517 precisely the same semantics (and side effects). 
8518 Similarly if interposition happens
8519 for variables, the constructor of the variable will be the same. The flag
8520 has no effect for functions explicitly declared inline 
8521 (where it is never allowed for interposition to change semantics) 
8522 and for symbols explicitly declared weak.
8524 @item -fshrink-wrap
8525 @opindex fshrink-wrap
8526 Emit function prologues only before parts of the function that need it,
8527 rather than at the top of the function.  This flag is enabled by default at
8528 @option{-O} and higher.
8530 @item -fshrink-wrap-separate
8531 @opindex fshrink-wrap-separate
8532 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8533 those parts are only executed when needed.
8534 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8535 is also turned on and the target supports this.
8537 @item -fcaller-saves
8538 @opindex fcaller-saves
8539 Enable allocation of values to registers that are clobbered by
8540 function calls, by emitting extra instructions to save and restore the
8541 registers around such calls.  Such allocation is done only when it
8542 seems to result in better code.
8544 This option is always enabled by default on certain machines, usually
8545 those which have no call-preserved registers to use instead.
8547 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8549 @item -fcombine-stack-adjustments
8550 @opindex fcombine-stack-adjustments
8551 Tracks stack adjustments (pushes and pops) and stack memory references
8552 and then tries to find ways to combine them.
8554 Enabled by default at @option{-O1} and higher.
8556 @item -fipa-ra
8557 @opindex fipa-ra
8558 Use caller save registers for allocation if those registers are not used by
8559 any called function.  In that case it is not necessary to save and restore
8560 them around calls.  This is only possible if called functions are part of
8561 same compilation unit as current function and they are compiled before it.
8563 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8564 is disabled if generated code will be instrumented for profiling
8565 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8566 exactly (this happens on targets that do not expose prologues
8567 and epilogues in RTL).
8569 @item -fconserve-stack
8570 @opindex fconserve-stack
8571 Attempt to minimize stack usage.  The compiler attempts to use less
8572 stack space, even if that makes the program slower.  This option
8573 implies setting the @option{large-stack-frame} parameter to 100
8574 and the @option{large-stack-frame-growth} parameter to 400.
8576 @item -ftree-reassoc
8577 @opindex ftree-reassoc
8578 Perform reassociation on trees.  This flag is enabled by default
8579 at @option{-O} and higher.
8581 @item -fcode-hoisting
8582 @opindex fcode-hoisting
8583 Perform code hoisting.  Code hoisting tries to move the
8584 evaluation of expressions executed on all paths to the function exit
8585 as early as possible.  This is especially useful as a code size
8586 optimization, but it often helps for code speed as well.
8587 This flag is enabled by default at @option{-O2} and higher.
8589 @item -ftree-pre
8590 @opindex ftree-pre
8591 Perform partial redundancy elimination (PRE) on trees.  This flag is
8592 enabled by default at @option{-O2} and @option{-O3}.
8594 @item -ftree-partial-pre
8595 @opindex ftree-partial-pre
8596 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8597 enabled by default at @option{-O3}.
8599 @item -ftree-forwprop
8600 @opindex ftree-forwprop
8601 Perform forward propagation on trees.  This flag is enabled by default
8602 at @option{-O} and higher.
8604 @item -ftree-fre
8605 @opindex ftree-fre
8606 Perform full redundancy elimination (FRE) on trees.  The difference
8607 between FRE and PRE is that FRE only considers expressions
8608 that are computed on all paths leading to the redundant computation.
8609 This analysis is faster than PRE, though it exposes fewer redundancies.
8610 This flag is enabled by default at @option{-O} and higher.
8612 @item -ftree-phiprop
8613 @opindex ftree-phiprop
8614 Perform hoisting of loads from conditional pointers on trees.  This
8615 pass is enabled by default at @option{-O} and higher.
8617 @item -fhoist-adjacent-loads
8618 @opindex fhoist-adjacent-loads
8619 Speculatively hoist loads from both branches of an if-then-else if the
8620 loads are from adjacent locations in the same structure and the target
8621 architecture has a conditional move instruction.  This flag is enabled
8622 by default at @option{-O2} and higher.
8624 @item -ftree-copy-prop
8625 @opindex ftree-copy-prop
8626 Perform copy propagation on trees.  This pass eliminates unnecessary
8627 copy operations.  This flag is enabled by default at @option{-O} and
8628 higher.
8630 @item -fipa-pure-const
8631 @opindex fipa-pure-const
8632 Discover which functions are pure or constant.
8633 Enabled by default at @option{-O} and higher.
8635 @item -fipa-reference
8636 @opindex fipa-reference
8637 Discover which static variables do not escape the
8638 compilation unit.
8639 Enabled by default at @option{-O} and higher.
8641 @item -fipa-pta
8642 @opindex fipa-pta
8643 Perform interprocedural pointer analysis and interprocedural modification
8644 and reference analysis.  This option can cause excessive memory and
8645 compile-time usage on large compilation units.  It is not enabled by
8646 default at any optimization level.
8648 @item -fipa-profile
8649 @opindex fipa-profile
8650 Perform interprocedural profile propagation.  The functions called only from
8651 cold functions are marked as cold. Also functions executed once (such as
8652 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8653 functions and loop less parts of functions executed once are then optimized for
8654 size.
8655 Enabled by default at @option{-O} and higher.
8657 @item -fipa-cp
8658 @opindex fipa-cp
8659 Perform interprocedural constant propagation.
8660 This optimization analyzes the program to determine when values passed
8661 to functions are constants and then optimizes accordingly.
8662 This optimization can substantially increase performance
8663 if the application has constants passed to functions.
8664 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8666 @item -fipa-cp-clone
8667 @opindex fipa-cp-clone
8668 Perform function cloning to make interprocedural constant propagation stronger.
8669 When enabled, interprocedural constant propagation performs function cloning
8670 when externally visible function can be called with constant arguments.
8671 Because this optimization can create multiple copies of functions,
8672 it may significantly increase code size
8673 (see @option{--param ipcp-unit-growth=@var{value}}).
8674 This flag is enabled by default at @option{-O3}.
8676 @item -fipa-bit-cp
8677 @opindex -fipa-bit-cp
8678 When enabled, perform interprocedural bitwise constant
8679 propagation. This flag is enabled by default at @option{-O2}. It
8680 requires that @option{-fipa-cp} is enabled.
8682 @item -fipa-vrp
8683 @opindex -fipa-vrp
8684 When enabled, perform interprocedural propagation of value
8685 ranges. This flag is enabled by default at @option{-O2}. It requires
8686 that @option{-fipa-cp} is enabled.
8688 @item -fipa-icf
8689 @opindex fipa-icf
8690 Perform Identical Code Folding for functions and read-only variables.
8691 The optimization reduces code size and may disturb unwind stacks by replacing
8692 a function by equivalent one with a different name. The optimization works
8693 more effectively with link-time optimization enabled.
8695 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8696 works on different levels and thus the optimizations are not same - there are
8697 equivalences that are found only by GCC and equivalences found only by Gold.
8699 This flag is enabled by default at @option{-O2} and @option{-Os}.
8701 @item -fisolate-erroneous-paths-dereference
8702 @opindex fisolate-erroneous-paths-dereference
8703 Detect paths that trigger erroneous or undefined behavior due to
8704 dereferencing a null pointer.  Isolate those paths from the main control
8705 flow and turn the statement with erroneous or undefined behavior into a trap.
8706 This flag is enabled by default at @option{-O2} and higher and depends on
8707 @option{-fdelete-null-pointer-checks} also being enabled.
8709 @item -fisolate-erroneous-paths-attribute
8710 @opindex fisolate-erroneous-paths-attribute
8711 Detect paths that trigger erroneous or undefined behavior due to a null value
8712 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8713 attribute.  Isolate those paths from the main control flow and turn the
8714 statement with erroneous or undefined behavior into a trap.  This is not
8715 currently enabled, but may be enabled by @option{-O2} in the future.
8717 @item -ftree-sink
8718 @opindex ftree-sink
8719 Perform forward store motion on trees.  This flag is
8720 enabled by default at @option{-O} and higher.
8722 @item -ftree-bit-ccp
8723 @opindex ftree-bit-ccp
8724 Perform sparse conditional bit constant propagation on trees and propagate
8725 pointer alignment information.
8726 This pass only operates on local scalar variables and is enabled by default
8727 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8729 @item -ftree-ccp
8730 @opindex ftree-ccp
8731 Perform sparse conditional constant propagation (CCP) on trees.  This
8732 pass only operates on local scalar variables and is enabled by default
8733 at @option{-O} and higher.
8735 @item -fssa-backprop
8736 @opindex fssa-backprop
8737 Propagate information about uses of a value up the definition chain
8738 in order to simplify the definitions.  For example, this pass strips
8739 sign operations if the sign of a value never matters.  The flag is
8740 enabled by default at @option{-O} and higher.
8742 @item -fssa-phiopt
8743 @opindex fssa-phiopt
8744 Perform pattern matching on SSA PHI nodes to optimize conditional
8745 code.  This pass is enabled by default at @option{-O} and higher.
8747 @item -ftree-switch-conversion
8748 @opindex ftree-switch-conversion
8749 Perform conversion of simple initializations in a switch to
8750 initializations from a scalar array.  This flag is enabled by default
8751 at @option{-O2} and higher.
8753 @item -ftree-tail-merge
8754 @opindex ftree-tail-merge
8755 Look for identical code sequences.  When found, replace one with a jump to the
8756 other.  This optimization is known as tail merging or cross jumping.  This flag
8757 is enabled by default at @option{-O2} and higher.  The compilation time
8758 in this pass can
8759 be limited using @option{max-tail-merge-comparisons} parameter and
8760 @option{max-tail-merge-iterations} parameter.
8762 @item -ftree-dce
8763 @opindex ftree-dce
8764 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8765 default at @option{-O} and higher.
8767 @item -ftree-builtin-call-dce
8768 @opindex ftree-builtin-call-dce
8769 Perform conditional dead code elimination (DCE) for calls to built-in functions
8770 that may set @code{errno} but are otherwise free of side effects.  This flag is
8771 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8772 specified.
8774 @item -ftree-dominator-opts
8775 @opindex ftree-dominator-opts
8776 Perform a variety of simple scalar cleanups (constant/copy
8777 propagation, redundancy elimination, range propagation and expression
8778 simplification) based on a dominator tree traversal.  This also
8779 performs jump threading (to reduce jumps to jumps). This flag is
8780 enabled by default at @option{-O} and higher.
8782 @item -ftree-dse
8783 @opindex ftree-dse
8784 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8785 a memory location that is later overwritten by another store without
8786 any intervening loads.  In this case the earlier store can be deleted.  This
8787 flag is enabled by default at @option{-O} and higher.
8789 @item -ftree-ch
8790 @opindex ftree-ch
8791 Perform loop header copying on trees.  This is beneficial since it increases
8792 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8793 is enabled by default at @option{-O} and higher.  It is not enabled
8794 for @option{-Os}, since it usually increases code size.
8796 @item -ftree-loop-optimize
8797 @opindex ftree-loop-optimize
8798 Perform loop optimizations on trees.  This flag is enabled by default
8799 at @option{-O} and higher.
8801 @item -ftree-loop-linear
8802 @itemx -floop-strip-mine
8803 @itemx -floop-block
8804 @opindex ftree-loop-linear
8805 @opindex floop-strip-mine
8806 @opindex floop-block
8807 Perform loop nest optimizations.  Same as
8808 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8809 to be configured with @option{--with-isl} to enable the Graphite loop
8810 transformation infrastructure.
8812 @item -fgraphite-identity
8813 @opindex fgraphite-identity
8814 Enable the identity transformation for graphite.  For every SCoP we generate
8815 the polyhedral representation and transform it back to gimple.  Using
8816 @option{-fgraphite-identity} we can check the costs or benefits of the
8817 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8818 are also performed by the code generator isl, like index splitting and
8819 dead code elimination in loops.
8821 @item -floop-nest-optimize
8822 @opindex floop-nest-optimize
8823 Enable the isl based loop nest optimizer.  This is a generic loop nest
8824 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8825 structure optimized for data-locality and parallelism.  This option
8826 is experimental.
8828 @item -floop-parallelize-all
8829 @opindex floop-parallelize-all
8830 Use the Graphite data dependence analysis to identify loops that can
8831 be parallelized.  Parallelize all the loops that can be analyzed to
8832 not contain loop carried dependences without checking that it is
8833 profitable to parallelize the loops.
8835 @item -ftree-coalesce-vars
8836 @opindex ftree-coalesce-vars
8837 While transforming the program out of the SSA representation, attempt to
8838 reduce copying by coalescing versions of different user-defined
8839 variables, instead of just compiler temporaries.  This may severely
8840 limit the ability to debug an optimized program compiled with
8841 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8842 prevents SSA coalescing of user variables.  This option is enabled by
8843 default if optimization is enabled, and it does very little otherwise.
8845 @item -ftree-loop-if-convert
8846 @opindex ftree-loop-if-convert
8847 Attempt to transform conditional jumps in the innermost loops to
8848 branch-less equivalents.  The intent is to remove control-flow from
8849 the innermost loops in order to improve the ability of the
8850 vectorization pass to handle these loops.  This is enabled by default
8851 if vectorization is enabled.
8853 @item -ftree-loop-distribution
8854 @opindex ftree-loop-distribution
8855 Perform loop distribution.  This flag can improve cache performance on
8856 big loop bodies and allow further loop optimizations, like
8857 parallelization or vectorization, to take place.  For example, the loop
8858 @smallexample
8859 DO I = 1, N
8860   A(I) = B(I) + C
8861   D(I) = E(I) * F
8862 ENDDO
8863 @end smallexample
8864 is transformed to
8865 @smallexample
8866 DO I = 1, N
8867    A(I) = B(I) + C
8868 ENDDO
8869 DO I = 1, N
8870    D(I) = E(I) * F
8871 ENDDO
8872 @end smallexample
8874 @item -ftree-loop-distribute-patterns
8875 @opindex ftree-loop-distribute-patterns
8876 Perform loop distribution of patterns that can be code generated with
8877 calls to a library.  This flag is enabled by default at @option{-O3}.
8879 This pass distributes the initialization loops and generates a call to
8880 memset zero.  For example, the loop
8881 @smallexample
8882 DO I = 1, N
8883   A(I) = 0
8884   B(I) = A(I) + I
8885 ENDDO
8886 @end smallexample
8887 is transformed to
8888 @smallexample
8889 DO I = 1, N
8890    A(I) = 0
8891 ENDDO
8892 DO I = 1, N
8893    B(I) = A(I) + I
8894 ENDDO
8895 @end smallexample
8896 and the initialization loop is transformed into a call to memset zero.
8898 @item -floop-interchange
8899 @opindex floop-interchange
8900 Perform loop interchange outside of graphite.  This flag can improve cache
8901 performance on loop nest and allow further loop optimizations, like
8902 vectorization, to take place.  For example, the loop
8903 @smallexample
8904 for (int i = 0; i < N; i++)
8905   for (int j = 0; j < N; j++)
8906     for (int k = 0; k < N; k++)
8907       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8908 @end smallexample
8909 is transformed to
8910 @smallexample
8911 for (int i = 0; i < N; i++)
8912   for (int k = 0; k < N; k++)
8913     for (int j = 0; j < N; j++)
8914       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8915 @end smallexample
8916 This flag is enabled by default at @option{-O3}.
8918 @item -floop-unroll-and-jam
8919 @opindex floop-unroll-and-jam
8920 Apply unroll and jam transformations on feasible loops.  In a loop
8921 nest this unrolls the outer loop by some factor and fuses the resulting
8922 multiple inner loops.  This flag is enabled by default at @option{-O3}.
8924 @item -ftree-loop-im
8925 @opindex ftree-loop-im
8926 Perform loop invariant motion on trees.  This pass moves only invariants that
8927 are hard to handle at RTL level (function calls, operations that expand to
8928 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8929 operands of conditions that are invariant out of the loop, so that we can use
8930 just trivial invariantness analysis in loop unswitching.  The pass also includes
8931 store motion.
8933 @item -ftree-loop-ivcanon
8934 @opindex ftree-loop-ivcanon
8935 Create a canonical counter for number of iterations in loops for which
8936 determining number of iterations requires complicated analysis.  Later
8937 optimizations then may determine the number easily.  Useful especially
8938 in connection with unrolling.
8940 @item -fivopts
8941 @opindex fivopts
8942 Perform induction variable optimizations (strength reduction, induction
8943 variable merging and induction variable elimination) on trees.
8945 @item -ftree-parallelize-loops=n
8946 @opindex ftree-parallelize-loops
8947 Parallelize loops, i.e., split their iteration space to run in n threads.
8948 This is only possible for loops whose iterations are independent
8949 and can be arbitrarily reordered.  The optimization is only
8950 profitable on multiprocessor machines, for loops that are CPU-intensive,
8951 rather than constrained e.g.@: by memory bandwidth.  This option
8952 implies @option{-pthread}, and thus is only supported on targets
8953 that have support for @option{-pthread}.
8955 @item -ftree-pta
8956 @opindex ftree-pta
8957 Perform function-local points-to analysis on trees.  This flag is
8958 enabled by default at @option{-O} and higher.
8960 @item -ftree-sra
8961 @opindex ftree-sra
8962 Perform scalar replacement of aggregates.  This pass replaces structure
8963 references with scalars to prevent committing structures to memory too
8964 early.  This flag is enabled by default at @option{-O} and higher.
8966 @item -fstore-merging
8967 @opindex fstore-merging
8968 Perform merging of narrow stores to consecutive memory addresses.  This pass
8969 merges contiguous stores of immediate values narrower than a word into fewer
8970 wider stores to reduce the number of instructions.  This is enabled by default
8971 at @option{-O2} and higher as well as @option{-Os}.
8973 @item -ftree-ter
8974 @opindex ftree-ter
8975 Perform temporary expression replacement during the SSA->normal phase.  Single
8976 use/single def temporaries are replaced at their use location with their
8977 defining expression.  This results in non-GIMPLE code, but gives the expanders
8978 much more complex trees to work on resulting in better RTL generation.  This is
8979 enabled by default at @option{-O} and higher.
8981 @item -ftree-slsr
8982 @opindex ftree-slsr
8983 Perform straight-line strength reduction on trees.  This recognizes related
8984 expressions involving multiplications and replaces them by less expensive
8985 calculations when possible.  This is enabled by default at @option{-O} and
8986 higher.
8988 @item -ftree-vectorize
8989 @opindex ftree-vectorize
8990 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8991 and @option{-ftree-slp-vectorize} if not explicitly specified.
8993 @item -ftree-loop-vectorize
8994 @opindex ftree-loop-vectorize
8995 Perform loop vectorization on trees. This flag is enabled by default at
8996 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8998 @item -ftree-slp-vectorize
8999 @opindex ftree-slp-vectorize
9000 Perform basic block vectorization on trees. This flag is enabled by default at
9001 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9003 @item -fvect-cost-model=@var{model}
9004 @opindex fvect-cost-model
9005 Alter the cost model used for vectorization.  The @var{model} argument
9006 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
9007 With the @samp{unlimited} model the vectorized code-path is assumed
9008 to be profitable while with the @samp{dynamic} model a runtime check
9009 guards the vectorized code-path to enable it only for iteration
9010 counts that will likely execute faster than when executing the original
9011 scalar loop.  The @samp{cheap} model disables vectorization of
9012 loops where doing so would be cost prohibitive for example due to
9013 required runtime checks for data dependence or alignment but otherwise
9014 is equal to the @samp{dynamic} model.
9015 The default cost model depends on other optimization flags and is
9016 either @samp{dynamic} or @samp{cheap}.
9018 @item -fsimd-cost-model=@var{model}
9019 @opindex fsimd-cost-model
9020 Alter the cost model used for vectorization of loops marked with the OpenMP
9021 simd directive.  The @var{model} argument should be one of
9022 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9023 have the same meaning as described in @option{-fvect-cost-model} and by
9024 default a cost model defined with @option{-fvect-cost-model} is used.
9026 @item -ftree-vrp
9027 @opindex ftree-vrp
9028 Perform Value Range Propagation on trees.  This is similar to the
9029 constant propagation pass, but instead of values, ranges of values are
9030 propagated.  This allows the optimizers to remove unnecessary range
9031 checks like array bound checks and null pointer checks.  This is
9032 enabled by default at @option{-O2} and higher.  Null pointer check
9033 elimination is only done if @option{-fdelete-null-pointer-checks} is
9034 enabled.
9036 @item -fsplit-paths
9037 @opindex fsplit-paths
9038 Split paths leading to loop backedges.  This can improve dead code
9039 elimination and common subexpression elimination.  This is enabled by
9040 default at @option{-O2} and above.
9042 @item -fsplit-ivs-in-unroller
9043 @opindex fsplit-ivs-in-unroller
9044 Enables expression of values of induction variables in later iterations
9045 of the unrolled loop using the value in the first iteration.  This breaks
9046 long dependency chains, thus improving efficiency of the scheduling passes.
9048 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9049 same effect.  However, that is not reliable in cases where the loop body
9050 is more complicated than a single basic block.  It also does not work at all
9051 on some architectures due to restrictions in the CSE pass.
9053 This optimization is enabled by default.
9055 @item -fvariable-expansion-in-unroller
9056 @opindex fvariable-expansion-in-unroller
9057 With this option, the compiler creates multiple copies of some
9058 local variables when unrolling a loop, which can result in superior code.
9060 @item -fpartial-inlining
9061 @opindex fpartial-inlining
9062 Inline parts of functions.  This option has any effect only
9063 when inlining itself is turned on by the @option{-finline-functions}
9064 or @option{-finline-small-functions} options.
9066 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9068 @item -fpredictive-commoning
9069 @opindex fpredictive-commoning
9070 Perform predictive commoning optimization, i.e., reusing computations
9071 (especially memory loads and stores) performed in previous
9072 iterations of loops.
9074 This option is enabled at level @option{-O3}.
9076 @item -fprefetch-loop-arrays
9077 @opindex fprefetch-loop-arrays
9078 If supported by the target machine, generate instructions to prefetch
9079 memory to improve the performance of loops that access large arrays.
9081 This option may generate better or worse code; results are highly
9082 dependent on the structure of loops within the source code.
9084 Disabled at level @option{-Os}.
9086 @item -fno-printf-return-value
9087 @opindex fno-printf-return-value
9088 Do not substitute constants for known return value of formatted output
9089 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9090 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9091 transformation allows GCC to optimize or even eliminate branches based
9092 on the known return value of these functions called with arguments that
9093 are either constant, or whose values are known to be in a range that
9094 makes determining the exact return value possible.  For example, when
9095 @option{-fprintf-return-value} is in effect, both the branch and the
9096 body of the @code{if} statement (but not the call to @code{snprint})
9097 can be optimized away when @code{i} is a 32-bit or smaller integer
9098 because the return value is guaranteed to be at most 8.
9100 @smallexample
9101 char buf[9];
9102 if (snprintf (buf, "%08x", i) >= sizeof buf)
9103   @dots{}
9104 @end smallexample
9106 The @option{-fprintf-return-value} option relies on other optimizations
9107 and yields best results with @option{-O2} and above.  It works in tandem
9108 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9109 options.  The @option{-fprintf-return-value} option is enabled by default.
9111 @item -fno-peephole
9112 @itemx -fno-peephole2
9113 @opindex fno-peephole
9114 @opindex fno-peephole2
9115 Disable any machine-specific peephole optimizations.  The difference
9116 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9117 are implemented in the compiler; some targets use one, some use the
9118 other, a few use both.
9120 @option{-fpeephole} is enabled by default.
9121 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9123 @item -fno-guess-branch-probability
9124 @opindex fno-guess-branch-probability
9125 Do not guess branch probabilities using heuristics.
9127 GCC uses heuristics to guess branch probabilities if they are
9128 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9129 heuristics are based on the control flow graph.  If some branch probabilities
9130 are specified by @code{__builtin_expect}, then the heuristics are
9131 used to guess branch probabilities for the rest of the control flow graph,
9132 taking the @code{__builtin_expect} info into account.  The interactions
9133 between the heuristics and @code{__builtin_expect} can be complex, and in
9134 some cases, it may be useful to disable the heuristics so that the effects
9135 of @code{__builtin_expect} are easier to understand.
9137 The default is @option{-fguess-branch-probability} at levels
9138 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9140 @item -freorder-blocks
9141 @opindex freorder-blocks
9142 Reorder basic blocks in the compiled function in order to reduce number of
9143 taken branches and improve code locality.
9145 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9147 @item -freorder-blocks-algorithm=@var{algorithm}
9148 @opindex freorder-blocks-algorithm
9149 Use the specified algorithm for basic block reordering.  The
9150 @var{algorithm} argument can be @samp{simple}, which does not increase
9151 code size (except sometimes due to secondary effects like alignment),
9152 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9153 put all often executed code together, minimizing the number of branches
9154 executed by making extra copies of code.
9156 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9157 @samp{stc} at levels @option{-O2}, @option{-O3}.
9159 @item -freorder-blocks-and-partition
9160 @opindex freorder-blocks-and-partition
9161 In addition to reordering basic blocks in the compiled function, in order
9162 to reduce number of taken branches, partitions hot and cold basic blocks
9163 into separate sections of the assembly and @file{.o} files, to improve
9164 paging and cache locality performance.
9166 This optimization is automatically turned off in the presence of
9167 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9168 section attribute and on any architecture that does not support named
9169 sections.  When @option{-fsplit-stack} is used this option is not
9170 enabled by default (to avoid linker errors), but may be enabled
9171 explicitly (if using a working linker).
9173 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9175 @item -freorder-functions
9176 @opindex freorder-functions
9177 Reorder functions in the object file in order to
9178 improve code locality.  This is implemented by using special
9179 subsections @code{.text.hot} for most frequently executed functions and
9180 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9181 the linker so object file format must support named sections and linker must
9182 place them in a reasonable way.
9184 Also profile feedback must be available to make this option effective.  See
9185 @option{-fprofile-arcs} for details.
9187 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9189 @item -fstrict-aliasing
9190 @opindex fstrict-aliasing
9191 Allow the compiler to assume the strictest aliasing rules applicable to
9192 the language being compiled.  For C (and C++), this activates
9193 optimizations based on the type of expressions.  In particular, an
9194 object of one type is assumed never to reside at the same address as an
9195 object of a different type, unless the types are almost the same.  For
9196 example, an @code{unsigned int} can alias an @code{int}, but not a
9197 @code{void*} or a @code{double}.  A character type may alias any other
9198 type.
9200 @anchor{Type-punning}Pay special attention to code like this:
9201 @smallexample
9202 union a_union @{
9203   int i;
9204   double d;
9207 int f() @{
9208   union a_union t;
9209   t.d = 3.0;
9210   return t.i;
9212 @end smallexample
9213 The practice of reading from a different union member than the one most
9214 recently written to (called ``type-punning'') is common.  Even with
9215 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9216 is accessed through the union type.  So, the code above works as
9217 expected.  @xref{Structures unions enumerations and bit-fields
9218 implementation}.  However, this code might not:
9219 @smallexample
9220 int f() @{
9221   union a_union t;
9222   int* ip;
9223   t.d = 3.0;
9224   ip = &t.i;
9225   return *ip;
9227 @end smallexample
9229 Similarly, access by taking the address, casting the resulting pointer
9230 and dereferencing the result has undefined behavior, even if the cast
9231 uses a union type, e.g.:
9232 @smallexample
9233 int f() @{
9234   double d = 3.0;
9235   return ((union a_union *) &d)->i;
9237 @end smallexample
9239 The @option{-fstrict-aliasing} option is enabled at levels
9240 @option{-O2}, @option{-O3}, @option{-Os}.
9242 @item -falign-functions
9243 @itemx -falign-functions=@var{n}
9244 @opindex falign-functions
9245 Align the start of functions to the next power-of-two greater than
9246 @var{n}, skipping up to @var{n} bytes.  For instance,
9247 @option{-falign-functions=32} aligns functions to the next 32-byte
9248 boundary, but @option{-falign-functions=24} aligns to the next
9249 32-byte boundary only if this can be done by skipping 23 bytes or less.
9251 @option{-fno-align-functions} and @option{-falign-functions=1} are
9252 equivalent and mean that functions are not aligned.
9254 Some assemblers only support this flag when @var{n} is a power of two;
9255 in that case, it is rounded up.
9257 If @var{n} is not specified or is zero, use a machine-dependent default.
9258 The maximum allowed @var{n} option value is 65536.
9260 Enabled at levels @option{-O2}, @option{-O3}.
9262 @item -flimit-function-alignment
9263 If this option is enabled, the compiler tries to avoid unnecessarily
9264 overaligning functions. It attempts to instruct the assembler to align
9265 by the amount specified by @option{-falign-functions}, but not to
9266 skip more bytes than the size of the function.
9268 @item -falign-labels
9269 @itemx -falign-labels=@var{n}
9270 @opindex falign-labels
9271 Align all branch targets to a power-of-two boundary, skipping up to
9272 @var{n} bytes like @option{-falign-functions}.  This option can easily
9273 make code slower, because it must insert dummy operations for when the
9274 branch target is reached in the usual flow of the code.
9276 @option{-fno-align-labels} and @option{-falign-labels=1} are
9277 equivalent and mean that labels are not aligned.
9279 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9280 are greater than this value, then their values are used instead.
9282 If @var{n} is not specified or is zero, use a machine-dependent default
9283 which is very likely to be @samp{1}, meaning no alignment.
9284 The maximum allowed @var{n} option value is 65536.
9286 Enabled at levels @option{-O2}, @option{-O3}.
9288 @item -falign-loops
9289 @itemx -falign-loops=@var{n}
9290 @opindex falign-loops
9291 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9292 like @option{-falign-functions}.  If the loops are
9293 executed many times, this makes up for any execution of the dummy
9294 operations.
9296 @option{-fno-align-loops} and @option{-falign-loops=1} are
9297 equivalent and mean that loops are not aligned.
9298 The maximum allowed @var{n} option value is 65536.
9300 If @var{n} is not specified or is zero, use a machine-dependent default.
9302 Enabled at levels @option{-O2}, @option{-O3}.
9304 @item -falign-jumps
9305 @itemx -falign-jumps=@var{n}
9306 @opindex falign-jumps
9307 Align branch targets to a power-of-two boundary, for branch targets
9308 where the targets can only be reached by jumping, skipping up to @var{n}
9309 bytes like @option{-falign-functions}.  In this case, no dummy operations
9310 need be executed.
9312 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9313 equivalent and mean that loops are not aligned.
9315 If @var{n} is not specified or is zero, use a machine-dependent default.
9316 The maximum allowed @var{n} option value is 65536.
9318 Enabled at levels @option{-O2}, @option{-O3}.
9320 @item -funit-at-a-time
9321 @opindex funit-at-a-time
9322 This option is left for compatibility reasons. @option{-funit-at-a-time}
9323 has no effect, while @option{-fno-unit-at-a-time} implies
9324 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9326 Enabled by default.
9328 @item -fno-toplevel-reorder
9329 @opindex fno-toplevel-reorder
9330 Do not reorder top-level functions, variables, and @code{asm}
9331 statements.  Output them in the same order that they appear in the
9332 input file.  When this option is used, unreferenced static variables
9333 are not removed.  This option is intended to support existing code
9334 that relies on a particular ordering.  For new code, it is better to
9335 use attributes when possible.
9337 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9338 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9339 targets.
9341 @item -fweb
9342 @opindex fweb
9343 Constructs webs as commonly used for register allocation purposes and assign
9344 each web individual pseudo register.  This allows the register allocation pass
9345 to operate on pseudos directly, but also strengthens several other optimization
9346 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9347 however, make debugging impossible, since variables no longer stay in a
9348 ``home register''.
9350 Enabled by default with @option{-funroll-loops}.
9352 @item -fwhole-program
9353 @opindex fwhole-program
9354 Assume that the current compilation unit represents the whole program being
9355 compiled.  All public functions and variables with the exception of @code{main}
9356 and those merged by attribute @code{externally_visible} become static functions
9357 and in effect are optimized more aggressively by interprocedural optimizers.
9359 This option should not be used in combination with @option{-flto}.
9360 Instead relying on a linker plugin should provide safer and more precise
9361 information.
9363 @item -flto[=@var{n}]
9364 @opindex flto
9365 This option runs the standard link-time optimizer.  When invoked
9366 with source code, it generates GIMPLE (one of GCC's internal
9367 representations) and writes it to special ELF sections in the object
9368 file.  When the object files are linked together, all the function
9369 bodies are read from these ELF sections and instantiated as if they
9370 had been part of the same translation unit.
9372 To use the link-time optimizer, @option{-flto} and optimization
9373 options should be specified at compile time and during the final link.
9374 It is recommended that you compile all the files participating in the
9375 same link with the same options and also specify those options at
9376 link time.  
9377 For example:
9379 @smallexample
9380 gcc -c -O2 -flto foo.c
9381 gcc -c -O2 -flto bar.c
9382 gcc -o myprog -flto -O2 foo.o bar.o
9383 @end smallexample
9385 The first two invocations to GCC save a bytecode representation
9386 of GIMPLE into special ELF sections inside @file{foo.o} and
9387 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9388 @file{foo.o} and @file{bar.o}, merges the two files into a single
9389 internal image, and compiles the result as usual.  Since both
9390 @file{foo.o} and @file{bar.o} are merged into a single image, this
9391 causes all the interprocedural analyses and optimizations in GCC to
9392 work across the two files as if they were a single one.  This means,
9393 for example, that the inliner is able to inline functions in
9394 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9396 Another (simpler) way to enable link-time optimization is:
9398 @smallexample
9399 gcc -o myprog -flto -O2 foo.c bar.c
9400 @end smallexample
9402 The above generates bytecode for @file{foo.c} and @file{bar.c},
9403 merges them together into a single GIMPLE representation and optimizes
9404 them as usual to produce @file{myprog}.
9406 The only important thing to keep in mind is that to enable link-time
9407 optimizations you need to use the GCC driver to perform the link step.
9408 GCC then automatically performs link-time optimization if any of the
9409 objects involved were compiled with the @option{-flto} command-line option.  
9410 You generally
9411 should specify the optimization options to be used for link-time
9412 optimization though GCC tries to be clever at guessing an
9413 optimization level to use from the options used at compile time
9414 if you fail to specify one at link time.  You can always override
9415 the automatic decision to do link-time optimization
9416 by passing @option{-fno-lto} to the link command.
9418 To make whole program optimization effective, it is necessary to make
9419 certain whole program assumptions.  The compiler needs to know
9420 what functions and variables can be accessed by libraries and runtime
9421 outside of the link-time optimized unit.  When supported by the linker,
9422 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9423 to the compiler about used and externally visible symbols.  When
9424 the linker plugin is not available, @option{-fwhole-program} should be
9425 used to allow the compiler to make these assumptions, which leads
9426 to more aggressive optimization decisions.
9428 When @option{-fuse-linker-plugin} is not enabled, when a file is
9429 compiled with @option{-flto}, the generated object file is larger than
9430 a regular object file because it contains GIMPLE bytecodes and the usual
9431 final code (see @option{-ffat-lto-objects}.  This means that
9432 object files with LTO information can be linked as normal object
9433 files; if @option{-fno-lto} is passed to the linker, no
9434 interprocedural optimizations are applied.  Note that when
9435 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9436 but you cannot perform a regular, non-LTO link on them.
9438 Additionally, the optimization flags used to compile individual files
9439 are not necessarily related to those used at link time.  For instance,
9441 @smallexample
9442 gcc -c -O0 -ffat-lto-objects -flto foo.c
9443 gcc -c -O0 -ffat-lto-objects -flto bar.c
9444 gcc -o myprog -O3 foo.o bar.o
9445 @end smallexample
9447 This produces individual object files with unoptimized assembler
9448 code, but the resulting binary @file{myprog} is optimized at
9449 @option{-O3}.  If, instead, the final binary is generated with
9450 @option{-fno-lto}, then @file{myprog} is not optimized.
9452 When producing the final binary, GCC only
9453 applies link-time optimizations to those files that contain bytecode.
9454 Therefore, you can mix and match object files and libraries with
9455 GIMPLE bytecodes and final object code.  GCC automatically selects
9456 which files to optimize in LTO mode and which files to link without
9457 further processing.
9459 There are some code generation flags preserved by GCC when
9460 generating bytecodes, as they need to be used during the final link
9461 stage.  Generally options specified at link time override those
9462 specified at compile time.
9464 If you do not specify an optimization level option @option{-O} at
9465 link time, then GCC uses the highest optimization level 
9466 used when compiling the object files.
9468 Currently, the following options and their settings are taken from
9469 the first object file that explicitly specifies them: 
9470 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9471 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9472 and all the @option{-m} target flags.
9474 Certain ABI-changing flags are required to match in all compilation units,
9475 and trying to override this at link time with a conflicting value
9476 is ignored.  This includes options such as @option{-freg-struct-return}
9477 and @option{-fpcc-struct-return}. 
9479 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9480 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9481 are passed through to the link stage and merged conservatively for
9482 conflicting translation units.  Specifically
9483 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9484 precedence; and for example @option{-ffp-contract=off} takes precedence
9485 over @option{-ffp-contract=fast}.  You can override them at link time.
9487 If LTO encounters objects with C linkage declared with incompatible
9488 types in separate translation units to be linked together (undefined
9489 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9490 issued.  The behavior is still undefined at run time.  Similar
9491 diagnostics may be raised for other languages.
9493 Another feature of LTO is that it is possible to apply interprocedural
9494 optimizations on files written in different languages:
9496 @smallexample
9497 gcc -c -flto foo.c
9498 g++ -c -flto bar.cc
9499 gfortran -c -flto baz.f90
9500 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9501 @end smallexample
9503 Notice that the final link is done with @command{g++} to get the C++
9504 runtime libraries and @option{-lgfortran} is added to get the Fortran
9505 runtime libraries.  In general, when mixing languages in LTO mode, you
9506 should use the same link command options as when mixing languages in a
9507 regular (non-LTO) compilation.
9509 If object files containing GIMPLE bytecode are stored in a library archive, say
9510 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9511 are using a linker with plugin support.  To create static libraries suitable
9512 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9513 and @command{ranlib}; 
9514 to show the symbols of object files with GIMPLE bytecode, use
9515 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9516 and @command{nm} have been compiled with plugin support.  At link time, use the the
9517 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9518 the LTO optimization process:
9520 @smallexample
9521 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9522 @end smallexample
9524 With the linker plugin enabled, the linker extracts the needed
9525 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9526 to make them part of the aggregated GIMPLE image to be optimized.
9528 If you are not using a linker with plugin support and/or do not
9529 enable the linker plugin, then the objects inside @file{libfoo.a}
9530 are extracted and linked as usual, but they do not participate
9531 in the LTO optimization process.  In order to make a static library suitable
9532 for both LTO optimization and usual linkage, compile its object files with
9533 @option{-flto} @option{-ffat-lto-objects}.
9535 Link-time optimizations do not require the presence of the whole program to
9536 operate.  If the program does not require any symbols to be exported, it is
9537 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9538 the interprocedural optimizers to use more aggressive assumptions which may
9539 lead to improved optimization opportunities.
9540 Use of @option{-fwhole-program} is not needed when linker plugin is
9541 active (see @option{-fuse-linker-plugin}).
9543 The current implementation of LTO makes no
9544 attempt to generate bytecode that is portable between different
9545 types of hosts.  The bytecode files are versioned and there is a
9546 strict version check, so bytecode files generated in one version of
9547 GCC do not work with an older or newer version of GCC.
9549 Link-time optimization does not work well with generation of debugging
9550 information on systems other than those using a combination of ELF and
9551 DWARF.
9553 If you specify the optional @var{n}, the optimization and code
9554 generation done at link time is executed in parallel using @var{n}
9555 parallel jobs by utilizing an installed @command{make} program.  The
9556 environment variable @env{MAKE} may be used to override the program
9557 used.  The default value for @var{n} is 1.
9559 You can also specify @option{-flto=jobserver} to use GNU make's
9560 job server mode to determine the number of parallel jobs. This
9561 is useful when the Makefile calling GCC is already executing in parallel.
9562 You must prepend a @samp{+} to the command recipe in the parent Makefile
9563 for this to work.  This option likely only works if @env{MAKE} is
9564 GNU make.
9566 @item -flto-partition=@var{alg}
9567 @opindex flto-partition
9568 Specify the partitioning algorithm used by the link-time optimizer.
9569 The value is either @samp{1to1} to specify a partitioning mirroring
9570 the original source files or @samp{balanced} to specify partitioning
9571 into equally sized chunks (whenever possible) or @samp{max} to create
9572 new partition for every symbol where possible.  Specifying @samp{none}
9573 as an algorithm disables partitioning and streaming completely. 
9574 The default value is @samp{balanced}. While @samp{1to1} can be used
9575 as an workaround for various code ordering issues, the @samp{max}
9576 partitioning is intended for internal testing only.
9577 The value @samp{one} specifies that exactly one partition should be
9578 used while the value @samp{none} bypasses partitioning and executes
9579 the link-time optimization step directly from the WPA phase.
9581 @item -flto-odr-type-merging
9582 @opindex flto-odr-type-merging
9583 Enable streaming of mangled types names of C++ types and their unification
9584 at link time.  This increases size of LTO object files, but enables
9585 diagnostics about One Definition Rule violations.
9587 @item -flto-compression-level=@var{n}
9588 @opindex flto-compression-level
9589 This option specifies the level of compression used for intermediate
9590 language written to LTO object files, and is only meaningful in
9591 conjunction with LTO mode (@option{-flto}).  Valid
9592 values are 0 (no compression) to 9 (maximum compression).  Values
9593 outside this range are clamped to either 0 or 9.  If the option is not
9594 given, a default balanced compression setting is used.
9596 @item -fuse-linker-plugin
9597 @opindex fuse-linker-plugin
9598 Enables the use of a linker plugin during link-time optimization.  This
9599 option relies on plugin support in the linker, which is available in gold
9600 or in GNU ld 2.21 or newer.
9602 This option enables the extraction of object files with GIMPLE bytecode out
9603 of library archives. This improves the quality of optimization by exposing
9604 more code to the link-time optimizer.  This information specifies what
9605 symbols can be accessed externally (by non-LTO object or during dynamic
9606 linking).  Resulting code quality improvements on binaries (and shared
9607 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9608 See @option{-flto} for a description of the effect of this flag and how to
9609 use it.
9611 This option is enabled by default when LTO support in GCC is enabled
9612 and GCC was configured for use with
9613 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9615 @item -ffat-lto-objects
9616 @opindex ffat-lto-objects
9617 Fat LTO objects are object files that contain both the intermediate language
9618 and the object code. This makes them usable for both LTO linking and normal
9619 linking. This option is effective only when compiling with @option{-flto}
9620 and is ignored at link time.
9622 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9623 requires the complete toolchain to be aware of LTO. It requires a linker with
9624 linker plugin support for basic functionality.  Additionally,
9625 @command{nm}, @command{ar} and @command{ranlib}
9626 need to support linker plugins to allow a full-featured build environment
9627 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9628 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9629 to these tools. With non fat LTO makefiles need to be modified to use them.
9631 Note that modern binutils provide plugin auto-load mechanism.
9632 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9633 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9634 @command{gcc-ranlib}).
9636 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9637 support.
9639 @item -fcompare-elim
9640 @opindex fcompare-elim
9641 After register allocation and post-register allocation instruction splitting,
9642 identify arithmetic instructions that compute processor flags similar to a
9643 comparison operation based on that arithmetic.  If possible, eliminate the
9644 explicit comparison operation.
9646 This pass only applies to certain targets that cannot explicitly represent
9647 the comparison operation before register allocation is complete.
9649 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9651 @item -fcprop-registers
9652 @opindex fcprop-registers
9653 After register allocation and post-register allocation instruction splitting,
9654 perform a copy-propagation pass to try to reduce scheduling dependencies
9655 and occasionally eliminate the copy.
9657 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9659 @item -fprofile-correction
9660 @opindex fprofile-correction
9661 Profiles collected using an instrumented binary for multi-threaded programs may
9662 be inconsistent due to missed counter updates. When this option is specified,
9663 GCC uses heuristics to correct or smooth out such inconsistencies. By
9664 default, GCC emits an error message when an inconsistent profile is detected.
9666 @item -fprofile-use
9667 @itemx -fprofile-use=@var{path}
9668 @opindex fprofile-use
9669 Enable profile feedback-directed optimizations, 
9670 and the following optimizations
9671 which are generally profitable only with profile feedback available:
9672 @option{-fbranch-probabilities}, @option{-fvpt},
9673 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9674 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9676 Before you can use this option, you must first generate profiling information.
9677 @xref{Instrumentation Options}, for information about the
9678 @option{-fprofile-generate} option.
9680 By default, GCC emits an error message if the feedback profiles do not
9681 match the source code.  This error can be turned into a warning by using
9682 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9683 code.
9685 If @var{path} is specified, GCC looks at the @var{path} to find
9686 the profile feedback data files. See @option{-fprofile-dir}.
9688 @item -fauto-profile
9689 @itemx -fauto-profile=@var{path}
9690 @opindex fauto-profile
9691 Enable sampling-based feedback-directed optimizations, 
9692 and the following optimizations
9693 which are generally profitable only with profile feedback available:
9694 @option{-fbranch-probabilities}, @option{-fvpt},
9695 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9696 @option{-ftree-vectorize},
9697 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9698 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9699 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9701 @var{path} is the name of a file containing AutoFDO profile information.
9702 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9704 Producing an AutoFDO profile data file requires running your program
9705 with the @command{perf} utility on a supported GNU/Linux target system.
9706 For more information, see @uref{https://perf.wiki.kernel.org/}.
9708 E.g.
9709 @smallexample
9710 perf record -e br_inst_retired:near_taken -b -o perf.data \
9711     -- your_program
9712 @end smallexample
9714 Then use the @command{create_gcov} tool to convert the raw profile data
9715 to a format that can be used by GCC.@  You must also supply the 
9716 unstripped binary for your program to this tool.  
9717 See @uref{https://github.com/google/autofdo}.
9719 E.g.
9720 @smallexample
9721 create_gcov --binary=your_program.unstripped --profile=perf.data \
9722     --gcov=profile.afdo
9723 @end smallexample
9724 @end table
9726 The following options control compiler behavior regarding floating-point 
9727 arithmetic.  These options trade off between speed and
9728 correctness.  All must be specifically enabled.
9730 @table @gcctabopt
9731 @item -ffloat-store
9732 @opindex ffloat-store
9733 Do not store floating-point variables in registers, and inhibit other
9734 options that might change whether a floating-point value is taken from a
9735 register or memory.
9737 @cindex floating-point precision
9738 This option prevents undesirable excess precision on machines such as
9739 the 68000 where the floating registers (of the 68881) keep more
9740 precision than a @code{double} is supposed to have.  Similarly for the
9741 x86 architecture.  For most programs, the excess precision does only
9742 good, but a few programs rely on the precise definition of IEEE floating
9743 point.  Use @option{-ffloat-store} for such programs, after modifying
9744 them to store all pertinent intermediate computations into variables.
9746 @item -fexcess-precision=@var{style}
9747 @opindex fexcess-precision
9748 This option allows further control over excess precision on machines
9749 where floating-point operations occur in a format with more precision or
9750 range than the IEEE standard and interchange floating-point types.  By
9751 default, @option{-fexcess-precision=fast} is in effect; this means that
9752 operations may be carried out in a wider precision than the types specified
9753 in the source if that would result in faster code, and it is unpredictable
9754 when rounding to the types specified in the source code takes place.
9755 When compiling C, if @option{-fexcess-precision=standard} is specified then
9756 excess precision follows the rules specified in ISO C99; in particular,
9757 both casts and assignments cause values to be rounded to their
9758 semantic types (whereas @option{-ffloat-store} only affects
9759 assignments).  This option is enabled by default for C if a strict
9760 conformance option such as @option{-std=c99} is used.
9761 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9762 regardless of whether a strict conformance option is used.
9764 @opindex mfpmath
9765 @option{-fexcess-precision=standard} is not implemented for languages
9766 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9767 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9768 semantics apply without excess precision, and in the latter, rounding
9769 is unpredictable.
9771 @item -ffast-math
9772 @opindex ffast-math
9773 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9774 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9775 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9776 @option{-fexcess-precision=fast}.
9778 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9780 This option is not turned on by any @option{-O} option besides
9781 @option{-Ofast} since it can result in incorrect output for programs
9782 that depend on an exact implementation of IEEE or ISO rules/specifications
9783 for math functions. It may, however, yield faster code for programs
9784 that do not require the guarantees of these specifications.
9786 @item -fno-math-errno
9787 @opindex fno-math-errno
9788 Do not set @code{errno} after calling math functions that are executed
9789 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9790 IEEE exceptions for math error handling may want to use this flag
9791 for speed while maintaining IEEE arithmetic compatibility.
9793 This option is not turned on by any @option{-O} option since
9794 it can result in incorrect output for programs that depend on
9795 an exact implementation of IEEE or ISO rules/specifications for
9796 math functions. It may, however, yield faster code for programs
9797 that do not require the guarantees of these specifications.
9799 The default is @option{-fmath-errno}.
9801 On Darwin systems, the math library never sets @code{errno}.  There is
9802 therefore no reason for the compiler to consider the possibility that
9803 it might, and @option{-fno-math-errno} is the default.
9805 @item -funsafe-math-optimizations
9806 @opindex funsafe-math-optimizations
9808 Allow optimizations for floating-point arithmetic that (a) assume
9809 that arguments and results are valid and (b) may violate IEEE or
9810 ANSI standards.  When used at link time, it may include libraries
9811 or startup files that change the default FPU control word or other
9812 similar optimizations.
9814 This option is not turned on by any @option{-O} option since
9815 it can result in incorrect output for programs that depend on
9816 an exact implementation of IEEE or ISO rules/specifications for
9817 math functions. It may, however, yield faster code for programs
9818 that do not require the guarantees of these specifications.
9819 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9820 @option{-fassociative-math} and @option{-freciprocal-math}.
9822 The default is @option{-fno-unsafe-math-optimizations}.
9824 @item -fassociative-math
9825 @opindex fassociative-math
9827 Allow re-association of operands in series of floating-point operations.
9828 This violates the ISO C and C++ language standard by possibly changing
9829 computation result.  NOTE: re-ordering may change the sign of zero as
9830 well as ignore NaNs and inhibit or create underflow or overflow (and
9831 thus cannot be used on code that relies on rounding behavior like
9832 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9833 and thus may not be used when ordered comparisons are required.
9834 This option requires that both @option{-fno-signed-zeros} and
9835 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9836 much sense with @option{-frounding-math}. For Fortran the option
9837 is automatically enabled when both @option{-fno-signed-zeros} and
9838 @option{-fno-trapping-math} are in effect.
9840 The default is @option{-fno-associative-math}.
9842 @item -freciprocal-math
9843 @opindex freciprocal-math
9845 Allow the reciprocal of a value to be used instead of dividing by
9846 the value if this enables optimizations.  For example @code{x / y}
9847 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9848 is subject to common subexpression elimination.  Note that this loses
9849 precision and increases the number of flops operating on the value.
9851 The default is @option{-fno-reciprocal-math}.
9853 @item -ffinite-math-only
9854 @opindex ffinite-math-only
9855 Allow optimizations for floating-point arithmetic that assume
9856 that arguments and results are not NaNs or +-Infs.
9858 This option is not turned on by any @option{-O} option since
9859 it can result in incorrect output for programs that depend on
9860 an exact implementation of IEEE or ISO rules/specifications for
9861 math functions. It may, however, yield faster code for programs
9862 that do not require the guarantees of these specifications.
9864 The default is @option{-fno-finite-math-only}.
9866 @item -fno-signed-zeros
9867 @opindex fno-signed-zeros
9868 Allow optimizations for floating-point arithmetic that ignore the
9869 signedness of zero.  IEEE arithmetic specifies the behavior of
9870 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9871 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9872 This option implies that the sign of a zero result isn't significant.
9874 The default is @option{-fsigned-zeros}.
9876 @item -fno-trapping-math
9877 @opindex fno-trapping-math
9878 Compile code assuming that floating-point operations cannot generate
9879 user-visible traps.  These traps include division by zero, overflow,
9880 underflow, inexact result and invalid operation.  This option requires
9881 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9882 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9884 This option should never be turned on by any @option{-O} option since
9885 it can result in incorrect output for programs that depend on
9886 an exact implementation of IEEE or ISO rules/specifications for
9887 math functions.
9889 The default is @option{-ftrapping-math}.
9891 @item -frounding-math
9892 @opindex frounding-math
9893 Disable transformations and optimizations that assume default floating-point
9894 rounding behavior.  This is round-to-zero for all floating point
9895 to integer conversions, and round-to-nearest for all other arithmetic
9896 truncations.  This option should be specified for programs that change
9897 the FP rounding mode dynamically, or that may be executed with a
9898 non-default rounding mode.  This option disables constant folding of
9899 floating-point expressions at compile time (which may be affected by
9900 rounding mode) and arithmetic transformations that are unsafe in the
9901 presence of sign-dependent rounding modes.
9903 The default is @option{-fno-rounding-math}.
9905 This option is experimental and does not currently guarantee to
9906 disable all GCC optimizations that are affected by rounding mode.
9907 Future versions of GCC may provide finer control of this setting
9908 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9909 will be used to specify the default state for @code{FENV_ACCESS}.
9911 @item -fsignaling-nans
9912 @opindex fsignaling-nans
9913 Compile code assuming that IEEE signaling NaNs may generate user-visible
9914 traps during floating-point operations.  Setting this option disables
9915 optimizations that may change the number of exceptions visible with
9916 signaling NaNs.  This option implies @option{-ftrapping-math}.
9918 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9919 be defined.
9921 The default is @option{-fno-signaling-nans}.
9923 This option is experimental and does not currently guarantee to
9924 disable all GCC optimizations that affect signaling NaN behavior.
9926 @item -fno-fp-int-builtin-inexact
9927 @opindex fno-fp-int-builtin-inexact
9928 Do not allow the built-in functions @code{ceil}, @code{floor},
9929 @code{round} and @code{trunc}, and their @code{float} and @code{long
9930 double} variants, to generate code that raises the ``inexact''
9931 floating-point exception for noninteger arguments.  ISO C99 and C11
9932 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9933 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9934 functions to do so.
9936 The default is @option{-ffp-int-builtin-inexact}, allowing the
9937 exception to be raised.  This option does nothing unless
9938 @option{-ftrapping-math} is in effect.
9940 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9941 generate a call to a library function then the ``inexact'' exception
9942 may be raised if the library implementation does not follow TS 18661.
9944 @item -fsingle-precision-constant
9945 @opindex fsingle-precision-constant
9946 Treat floating-point constants as single precision instead of
9947 implicitly converting them to double-precision constants.
9949 @item -fcx-limited-range
9950 @opindex fcx-limited-range
9951 When enabled, this option states that a range reduction step is not
9952 needed when performing complex division.  Also, there is no checking
9953 whether the result of a complex multiplication or division is @code{NaN
9954 + I*NaN}, with an attempt to rescue the situation in that case.  The
9955 default is @option{-fno-cx-limited-range}, but is enabled by
9956 @option{-ffast-math}.
9958 This option controls the default setting of the ISO C99
9959 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9960 all languages.
9962 @item -fcx-fortran-rules
9963 @opindex fcx-fortran-rules
9964 Complex multiplication and division follow Fortran rules.  Range
9965 reduction is done as part of complex division, but there is no checking
9966 whether the result of a complex multiplication or division is @code{NaN
9967 + I*NaN}, with an attempt to rescue the situation in that case.
9969 The default is @option{-fno-cx-fortran-rules}.
9971 @end table
9973 The following options control optimizations that may improve
9974 performance, but are not enabled by any @option{-O} options.  This
9975 section includes experimental options that may produce broken code.
9977 @table @gcctabopt
9978 @item -fbranch-probabilities
9979 @opindex fbranch-probabilities
9980 After running a program compiled with @option{-fprofile-arcs}
9981 (@pxref{Instrumentation Options}),
9982 you can compile it a second time using
9983 @option{-fbranch-probabilities}, to improve optimizations based on
9984 the number of times each branch was taken.  When a program
9985 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9986 counts to a file called @file{@var{sourcename}.gcda} for each source
9987 file.  The information in this data file is very dependent on the
9988 structure of the generated code, so you must use the same source code
9989 and the same optimization options for both compilations.
9991 With @option{-fbranch-probabilities}, GCC puts a
9992 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9993 These can be used to improve optimization.  Currently, they are only
9994 used in one place: in @file{reorg.c}, instead of guessing which path a
9995 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9996 exactly determine which path is taken more often.
9998 @item -fprofile-values
9999 @opindex fprofile-values
10000 If combined with @option{-fprofile-arcs}, it adds code so that some
10001 data about values of expressions in the program is gathered.
10003 With @option{-fbranch-probabilities}, it reads back the data gathered
10004 from profiling values of expressions for usage in optimizations.
10006 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
10008 @item -fprofile-reorder-functions
10009 @opindex fprofile-reorder-functions
10010 Function reordering based on profile instrumentation collects
10011 first time of execution of a function and orders these functions
10012 in ascending order.
10014 Enabled with @option{-fprofile-use}.
10016 @item -fvpt
10017 @opindex fvpt
10018 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10019 to add code to gather information about values of expressions.
10021 With @option{-fbranch-probabilities}, it reads back the data gathered
10022 and actually performs the optimizations based on them.
10023 Currently the optimizations include specialization of division operations
10024 using the knowledge about the value of the denominator.
10026 @item -frename-registers
10027 @opindex frename-registers
10028 Attempt to avoid false dependencies in scheduled code by making use
10029 of registers left over after register allocation.  This optimization
10030 most benefits processors with lots of registers.  Depending on the
10031 debug information format adopted by the target, however, it can
10032 make debugging impossible, since variables no longer stay in
10033 a ``home register''.
10035 Enabled by default with @option{-funroll-loops}.
10037 @item -fschedule-fusion
10038 @opindex fschedule-fusion
10039 Performs a target dependent pass over the instruction stream to schedule
10040 instructions of same type together because target machine can execute them
10041 more efficiently if they are adjacent to each other in the instruction flow.
10043 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10045 @item -ftracer
10046 @opindex ftracer
10047 Perform tail duplication to enlarge superblock size.  This transformation
10048 simplifies the control flow of the function allowing other optimizations to do
10049 a better job.
10051 Enabled with @option{-fprofile-use}.
10053 @item -funroll-loops
10054 @opindex funroll-loops
10055 Unroll loops whose number of iterations can be determined at compile time or
10056 upon entry to the loop.  @option{-funroll-loops} implies
10057 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10058 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10059 a small constant number of iterations).  This option makes code larger, and may
10060 or may not make it run faster.
10062 Enabled with @option{-fprofile-use}.
10064 @item -funroll-all-loops
10065 @opindex funroll-all-loops
10066 Unroll all loops, even if their number of iterations is uncertain when
10067 the loop is entered.  This usually makes programs run more slowly.
10068 @option{-funroll-all-loops} implies the same options as
10069 @option{-funroll-loops}.
10071 @item -fpeel-loops
10072 @opindex fpeel-loops
10073 Peels loops for which there is enough information that they do not
10074 roll much (from profile feedback or static analysis).  It also turns on
10075 complete loop peeling (i.e.@: complete removal of loops with small constant
10076 number of iterations).
10078 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10080 @item -fmove-loop-invariants
10081 @opindex fmove-loop-invariants
10082 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10083 at level @option{-O1}
10085 @item -fsplit-loops
10086 @opindex fsplit-loops
10087 Split a loop into two if it contains a condition that's always true
10088 for one side of the iteration space and false for the other.
10090 @item -funswitch-loops
10091 @opindex funswitch-loops
10092 Move branches with loop invariant conditions out of the loop, with duplicates
10093 of the loop on both branches (modified according to result of the condition).
10095 @item -ffunction-sections
10096 @itemx -fdata-sections
10097 @opindex ffunction-sections
10098 @opindex fdata-sections
10099 Place each function or data item into its own section in the output
10100 file if the target supports arbitrary sections.  The name of the
10101 function or the name of the data item determines the section's name
10102 in the output file.
10104 Use these options on systems where the linker can perform optimizations to
10105 improve locality of reference in the instruction space.  Most systems using the
10106 ELF object format have linkers with such optimizations.  On AIX, the linker
10107 rearranges sections (CSECTs) based on the call graph.  The performance impact
10108 varies.
10110 Together with a linker garbage collection (linker @option{--gc-sections}
10111 option) these options may lead to smaller statically-linked executables (after
10112 stripping).
10114 On ELF/DWARF systems these options do not degenerate the quality of the debug
10115 information.  There could be issues with other object files/debug info formats.
10117 Only use these options when there are significant benefits from doing so.  When
10118 you specify these options, the assembler and linker create larger object and
10119 executable files and are also slower.  These options affect code generation.
10120 They prevent optimizations by the compiler and assembler using relative
10121 locations inside a translation unit since the locations are unknown until
10122 link time.  An example of such an optimization is relaxing calls to short call
10123 instructions.
10125 @item -fbranch-target-load-optimize
10126 @opindex fbranch-target-load-optimize
10127 Perform branch target register load optimization before prologue / epilogue
10128 threading.
10129 The use of target registers can typically be exposed only during reload,
10130 thus hoisting loads out of loops and doing inter-block scheduling needs
10131 a separate optimization pass.
10133 @item -fbranch-target-load-optimize2
10134 @opindex fbranch-target-load-optimize2
10135 Perform branch target register load optimization after prologue / epilogue
10136 threading.
10138 @item -fbtr-bb-exclusive
10139 @opindex fbtr-bb-exclusive
10140 When performing branch target register load optimization, don't reuse
10141 branch target registers within any basic block.
10143 @item -fstdarg-opt
10144 @opindex fstdarg-opt
10145 Optimize the prologue of variadic argument functions with respect to usage of
10146 those arguments.
10148 @item -fsection-anchors
10149 @opindex fsection-anchors
10150 Try to reduce the number of symbolic address calculations by using
10151 shared ``anchor'' symbols to address nearby objects.  This transformation
10152 can help to reduce the number of GOT entries and GOT accesses on some
10153 targets.
10155 For example, the implementation of the following function @code{foo}:
10157 @smallexample
10158 static int a, b, c;
10159 int foo (void) @{ return a + b + c; @}
10160 @end smallexample
10162 @noindent
10163 usually calculates the addresses of all three variables, but if you
10164 compile it with @option{-fsection-anchors}, it accesses the variables
10165 from a common anchor point instead.  The effect is similar to the
10166 following pseudocode (which isn't valid C):
10168 @smallexample
10169 int foo (void)
10171   register int *xr = &x;
10172   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10174 @end smallexample
10176 Not all targets support this option.
10178 @item --param @var{name}=@var{value}
10179 @opindex param
10180 In some places, GCC uses various constants to control the amount of
10181 optimization that is done.  For example, GCC does not inline functions
10182 that contain more than a certain number of instructions.  You can
10183 control some of these constants on the command line using the
10184 @option{--param} option.
10186 The names of specific parameters, and the meaning of the values, are
10187 tied to the internals of the compiler, and are subject to change
10188 without notice in future releases.
10190 In each case, the @var{value} is an integer.  The allowable choices for
10191 @var{name} are:
10193 @table @gcctabopt
10194 @item predictable-branch-outcome
10195 When branch is predicted to be taken with probability lower than this threshold
10196 (in percent), then it is considered well predictable. The default is 10.
10198 @item max-rtl-if-conversion-insns
10199 RTL if-conversion tries to remove conditional branches around a block and
10200 replace them with conditionally executed instructions.  This parameter
10201 gives the maximum number of instructions in a block which should be
10202 considered for if-conversion.  The default is 10, though the compiler will
10203 also use other heuristics to decide whether if-conversion is likely to be
10204 profitable.
10206 @item max-rtl-if-conversion-predictable-cost
10207 @itemx max-rtl-if-conversion-unpredictable-cost
10208 RTL if-conversion will try to remove conditional branches around a block
10209 and replace them with conditionally executed instructions.  These parameters
10210 give the maximum permissible cost for the sequence that would be generated
10211 by if-conversion depending on whether the branch is statically determined
10212 to be predictable or not.  The units for this parameter are the same as
10213 those for the GCC internal seq_cost metric.  The compiler will try to
10214 provide a reasonable default for this parameter using the BRANCH_COST
10215 target macro.
10217 @item max-crossjump-edges
10218 The maximum number of incoming edges to consider for cross-jumping.
10219 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10220 the number of edges incoming to each block.  Increasing values mean
10221 more aggressive optimization, making the compilation time increase with
10222 probably small improvement in executable size.
10224 @item min-crossjump-insns
10225 The minimum number of instructions that must be matched at the end
10226 of two blocks before cross-jumping is performed on them.  This
10227 value is ignored in the case where all instructions in the block being
10228 cross-jumped from are matched.  The default value is 5.
10230 @item max-grow-copy-bb-insns
10231 The maximum code size expansion factor when copying basic blocks
10232 instead of jumping.  The expansion is relative to a jump instruction.
10233 The default value is 8.
10235 @item max-goto-duplication-insns
10236 The maximum number of instructions to duplicate to a block that jumps
10237 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10238 passes, GCC factors computed gotos early in the compilation process,
10239 and unfactors them as late as possible.  Only computed jumps at the
10240 end of a basic blocks with no more than max-goto-duplication-insns are
10241 unfactored.  The default value is 8.
10243 @item max-delay-slot-insn-search
10244 The maximum number of instructions to consider when looking for an
10245 instruction to fill a delay slot.  If more than this arbitrary number of
10246 instructions are searched, the time savings from filling the delay slot
10247 are minimal, so stop searching.  Increasing values mean more
10248 aggressive optimization, making the compilation time increase with probably
10249 small improvement in execution time.
10251 @item max-delay-slot-live-search
10252 When trying to fill delay slots, the maximum number of instructions to
10253 consider when searching for a block with valid live register
10254 information.  Increasing this arbitrarily chosen value means more
10255 aggressive optimization, increasing the compilation time.  This parameter
10256 should be removed when the delay slot code is rewritten to maintain the
10257 control-flow graph.
10259 @item max-gcse-memory
10260 The approximate maximum amount of memory that can be allocated in
10261 order to perform the global common subexpression elimination
10262 optimization.  If more memory than specified is required, the
10263 optimization is not done.
10265 @item max-gcse-insertion-ratio
10266 If the ratio of expression insertions to deletions is larger than this value
10267 for any expression, then RTL PRE inserts or removes the expression and thus
10268 leaves partially redundant computations in the instruction stream.  The default value is 20.
10270 @item max-pending-list-length
10271 The maximum number of pending dependencies scheduling allows
10272 before flushing the current state and starting over.  Large functions
10273 with few branches or calls can create excessively large lists which
10274 needlessly consume memory and resources.
10276 @item max-modulo-backtrack-attempts
10277 The maximum number of backtrack attempts the scheduler should make
10278 when modulo scheduling a loop.  Larger values can exponentially increase
10279 compilation time.
10281 @item max-inline-insns-single
10282 Several parameters control the tree inliner used in GCC@.
10283 This number sets the maximum number of instructions (counted in GCC's
10284 internal representation) in a single function that the tree inliner
10285 considers for inlining.  This only affects functions declared
10286 inline and methods implemented in a class declaration (C++).
10287 The default value is 400.
10289 @item max-inline-insns-auto
10290 When you use @option{-finline-functions} (included in @option{-O3}),
10291 a lot of functions that would otherwise not be considered for inlining
10292 by the compiler are investigated.  To those functions, a different
10293 (more restrictive) limit compared to functions declared inline can
10294 be applied.
10295 The default value is 30.
10297 @item inline-min-speedup
10298 When estimated performance improvement of caller + callee runtime exceeds this
10299 threshold (in percent), the function can be inlined regardless of the limit on
10300 @option{--param max-inline-insns-single} and @option{--param
10301 max-inline-insns-auto}.
10302 The default value is 15.
10304 @item large-function-insns
10305 The limit specifying really large functions.  For functions larger than this
10306 limit after inlining, inlining is constrained by
10307 @option{--param large-function-growth}.  This parameter is useful primarily
10308 to avoid extreme compilation time caused by non-linear algorithms used by the
10309 back end.
10310 The default value is 2700.
10312 @item large-function-growth
10313 Specifies maximal growth of large function caused by inlining in percents.
10314 The default value is 100 which limits large function growth to 2.0 times
10315 the original size.
10317 @item large-unit-insns
10318 The limit specifying large translation unit.  Growth caused by inlining of
10319 units larger than this limit is limited by @option{--param inline-unit-growth}.
10320 For small units this might be too tight.
10321 For example, consider a unit consisting of function A
10322 that is inline and B that just calls A three times.  If B is small relative to
10323 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10324 large units consisting of small inlineable functions, however, the overall unit
10325 growth limit is needed to avoid exponential explosion of code size.  Thus for
10326 smaller units, the size is increased to @option{--param large-unit-insns}
10327 before applying @option{--param inline-unit-growth}.  The default is 10000.
10329 @item inline-unit-growth
10330 Specifies maximal overall growth of the compilation unit caused by inlining.
10331 The default value is 20 which limits unit growth to 1.2 times the original
10332 size. Cold functions (either marked cold via an attribute or by profile
10333 feedback) are not accounted into the unit size.
10335 @item ipcp-unit-growth
10336 Specifies maximal overall growth of the compilation unit caused by
10337 interprocedural constant propagation.  The default value is 10 which limits
10338 unit growth to 1.1 times the original size.
10340 @item large-stack-frame
10341 The limit specifying large stack frames.  While inlining the algorithm is trying
10342 to not grow past this limit too much.  The default value is 256 bytes.
10344 @item large-stack-frame-growth
10345 Specifies maximal growth of large stack frames caused by inlining in percents.
10346 The default value is 1000 which limits large stack frame growth to 11 times
10347 the original size.
10349 @item max-inline-insns-recursive
10350 @itemx max-inline-insns-recursive-auto
10351 Specifies the maximum number of instructions an out-of-line copy of a
10352 self-recursive inline
10353 function can grow into by performing recursive inlining.
10355 @option{--param max-inline-insns-recursive} applies to functions
10356 declared inline.
10357 For functions not declared inline, recursive inlining
10358 happens only when @option{-finline-functions} (included in @option{-O3}) is
10359 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10360 default value is 450.
10362 @item max-inline-recursive-depth
10363 @itemx max-inline-recursive-depth-auto
10364 Specifies the maximum recursion depth used for recursive inlining.
10366 @option{--param max-inline-recursive-depth} applies to functions
10367 declared inline.  For functions not declared inline, recursive inlining
10368 happens only when @option{-finline-functions} (included in @option{-O3}) is
10369 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10370 default value is 8.
10372 @item min-inline-recursive-probability
10373 Recursive inlining is profitable only for function having deep recursion
10374 in average and can hurt for function having little recursion depth by
10375 increasing the prologue size or complexity of function body to other
10376 optimizers.
10378 When profile feedback is available (see @option{-fprofile-generate}) the actual
10379 recursion depth can be guessed from the probability that function recurses
10380 via a given call expression.  This parameter limits inlining only to call
10381 expressions whose probability exceeds the given threshold (in percents).
10382 The default value is 10.
10384 @item early-inlining-insns
10385 Specify growth that the early inliner can make.  In effect it increases
10386 the amount of inlining for code having a large abstraction penalty.
10387 The default value is 14.
10389 @item max-early-inliner-iterations
10390 Limit of iterations of the early inliner.  This basically bounds
10391 the number of nested indirect calls the early inliner can resolve.
10392 Deeper chains are still handled by late inlining.
10394 @item comdat-sharing-probability
10395 Probability (in percent) that C++ inline function with comdat visibility
10396 are shared across multiple compilation units.  The default value is 20.
10398 @item profile-func-internal-id
10399 A parameter to control whether to use function internal id in profile
10400 database lookup. If the value is 0, the compiler uses an id that
10401 is based on function assembler name and filename, which makes old profile
10402 data more tolerant to source changes such as function reordering etc.
10403 The default value is 0.
10405 @item min-vect-loop-bound
10406 The minimum number of iterations under which loops are not vectorized
10407 when @option{-ftree-vectorize} is used.  The number of iterations after
10408 vectorization needs to be greater than the value specified by this option
10409 to allow vectorization.  The default value is 0.
10411 @item gcse-cost-distance-ratio
10412 Scaling factor in calculation of maximum distance an expression
10413 can be moved by GCSE optimizations.  This is currently supported only in the
10414 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10415 is with simple expressions, i.e., the expressions that have cost
10416 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10417 hoisting of simple expressions.  The default value is 10.
10419 @item gcse-unrestricted-cost
10420 Cost, roughly measured as the cost of a single typical machine
10421 instruction, at which GCSE optimizations do not constrain
10422 the distance an expression can travel.  This is currently
10423 supported only in the code hoisting pass.  The lesser the cost,
10424 the more aggressive code hoisting is.  Specifying 0 
10425 allows all expressions to travel unrestricted distances.
10426 The default value is 3.
10428 @item max-hoist-depth
10429 The depth of search in the dominator tree for expressions to hoist.
10430 This is used to avoid quadratic behavior in hoisting algorithm.
10431 The value of 0 does not limit on the search, but may slow down compilation
10432 of huge functions.  The default value is 30.
10434 @item max-tail-merge-comparisons
10435 The maximum amount of similar bbs to compare a bb with.  This is used to
10436 avoid quadratic behavior in tree tail merging.  The default value is 10.
10438 @item max-tail-merge-iterations
10439 The maximum amount of iterations of the pass over the function.  This is used to
10440 limit compilation time in tree tail merging.  The default value is 2.
10442 @item store-merging-allow-unaligned
10443 Allow the store merging pass to introduce unaligned stores if it is legal to
10444 do so.  The default value is 1.
10446 @item max-stores-to-merge
10447 The maximum number of stores to attempt to merge into wider stores in the store
10448 merging pass.  The minimum value is 2 and the default is 64.
10450 @item max-unrolled-insns
10451 The maximum number of instructions that a loop may have to be unrolled.
10452 If a loop is unrolled, this parameter also determines how many times
10453 the loop code is unrolled.
10455 @item max-average-unrolled-insns
10456 The maximum number of instructions biased by probabilities of their execution
10457 that a loop may have to be unrolled.  If a loop is unrolled,
10458 this parameter also determines how many times the loop code is unrolled.
10460 @item max-unroll-times
10461 The maximum number of unrollings of a single loop.
10463 @item max-peeled-insns
10464 The maximum number of instructions that a loop may have to be peeled.
10465 If a loop is peeled, this parameter also determines how many times
10466 the loop code is peeled.
10468 @item max-peel-times
10469 The maximum number of peelings of a single loop.
10471 @item max-peel-branches
10472 The maximum number of branches on the hot path through the peeled sequence.
10474 @item max-completely-peeled-insns
10475 The maximum number of insns of a completely peeled loop.
10477 @item max-completely-peel-times
10478 The maximum number of iterations of a loop to be suitable for complete peeling.
10480 @item max-completely-peel-loop-nest-depth
10481 The maximum depth of a loop nest suitable for complete peeling.
10483 @item max-unswitch-insns
10484 The maximum number of insns of an unswitched loop.
10486 @item max-unswitch-level
10487 The maximum number of branches unswitched in a single loop.
10489 @item max-loop-headers-insns
10490 The maximum number of insns in loop header duplicated by the copy loop headers
10491 pass.
10493 @item lim-expensive
10494 The minimum cost of an expensive expression in the loop invariant motion.
10496 @item iv-consider-all-candidates-bound
10497 Bound on number of candidates for induction variables, below which
10498 all candidates are considered for each use in induction variable
10499 optimizations.  If there are more candidates than this,
10500 only the most relevant ones are considered to avoid quadratic time complexity.
10502 @item iv-max-considered-uses
10503 The induction variable optimizations give up on loops that contain more
10504 induction variable uses.
10506 @item iv-always-prune-cand-set-bound
10507 If the number of candidates in the set is smaller than this value,
10508 always try to remove unnecessary ivs from the set
10509 when adding a new one.
10511 @item avg-loop-niter
10512 Average number of iterations of a loop.
10514 @item dse-max-object-size
10515 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10516 Larger values may result in larger compilation times.
10518 @item dse-max-alias-queries-per-store
10519 Maximum number of queries into the alias oracle per store.
10520 Larger values result in larger compilation times and may result in more
10521 removed dead stores.
10523 @item scev-max-expr-size
10524 Bound on size of expressions used in the scalar evolutions analyzer.
10525 Large expressions slow the analyzer.
10527 @item scev-max-expr-complexity
10528 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10529 Complex expressions slow the analyzer.
10531 @item max-tree-if-conversion-phi-args
10532 Maximum number of arguments in a PHI supported by TREE if conversion
10533 unless the loop is marked with simd pragma.
10535 @item vect-max-version-for-alignment-checks
10536 The maximum number of run-time checks that can be performed when
10537 doing loop versioning for alignment in the vectorizer.
10539 @item vect-max-version-for-alias-checks
10540 The maximum number of run-time checks that can be performed when
10541 doing loop versioning for alias in the vectorizer.
10543 @item vect-max-peeling-for-alignment
10544 The maximum number of loop peels to enhance access alignment
10545 for vectorizer. Value -1 means no limit.
10547 @item max-iterations-to-track
10548 The maximum number of iterations of a loop the brute-force algorithm
10549 for analysis of the number of iterations of the loop tries to evaluate.
10551 @item hot-bb-count-ws-permille
10552 A basic block profile count is considered hot if it contributes to 
10553 the given permillage (i.e. 0...1000) of the entire profiled execution.
10555 @item hot-bb-frequency-fraction
10556 Select fraction of the entry block frequency of executions of basic block in
10557 function given basic block needs to have to be considered hot.
10559 @item max-predicted-iterations
10560 The maximum number of loop iterations we predict statically.  This is useful
10561 in cases where a function contains a single loop with known bound and
10562 another loop with unknown bound.
10563 The known number of iterations is predicted correctly, while
10564 the unknown number of iterations average to roughly 10.  This means that the
10565 loop without bounds appears artificially cold relative to the other one.
10567 @item builtin-expect-probability
10568 Control the probability of the expression having the specified value. This
10569 parameter takes a percentage (i.e. 0 ... 100) as input.
10570 The default probability of 90 is obtained empirically.
10572 @item align-threshold
10574 Select fraction of the maximal frequency of executions of a basic block in
10575 a function to align the basic block.
10577 @item align-loop-iterations
10579 A loop expected to iterate at least the selected number of iterations is
10580 aligned.
10582 @item tracer-dynamic-coverage
10583 @itemx tracer-dynamic-coverage-feedback
10585 This value is used to limit superblock formation once the given percentage of
10586 executed instructions is covered.  This limits unnecessary code size
10587 expansion.
10589 The @option{tracer-dynamic-coverage-feedback} parameter
10590 is used only when profile
10591 feedback is available.  The real profiles (as opposed to statically estimated
10592 ones) are much less balanced allowing the threshold to be larger value.
10594 @item tracer-max-code-growth
10595 Stop tail duplication once code growth has reached given percentage.  This is
10596 a rather artificial limit, as most of the duplicates are eliminated later in
10597 cross jumping, so it may be set to much higher values than is the desired code
10598 growth.
10600 @item tracer-min-branch-ratio
10602 Stop reverse growth when the reverse probability of best edge is less than this
10603 threshold (in percent).
10605 @item tracer-min-branch-probability
10606 @itemx tracer-min-branch-probability-feedback
10608 Stop forward growth if the best edge has probability lower than this
10609 threshold.
10611 Similarly to @option{tracer-dynamic-coverage} two parameters are
10612 provided.  @option{tracer-min-branch-probability-feedback} is used for
10613 compilation with profile feedback and @option{tracer-min-branch-probability}
10614 compilation without.  The value for compilation with profile feedback
10615 needs to be more conservative (higher) in order to make tracer
10616 effective.
10618 @item stack-clash-protection-guard-size
10619 Specify the size of the operating system provided stack guard as
10620 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10621 Acceptable values are between 12 and 30.  Higher values may reduce the
10622 number of explicit probes, but a value larger than the operating system
10623 provided guard will leave code vulnerable to stack clash style attacks.
10625 @item stack-clash-protection-probe-interval
10626 Stack clash protection involves probing stack space as it is allocated.  This
10627 param controls the maximum distance between probes into the stack as 2 raised
10628 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10629 12.  Higher values may reduce the number of explicit probes, but a value
10630 larger than the operating system provided guard will leave code vulnerable to
10631 stack clash style attacks.
10633 @item max-cse-path-length
10635 The maximum number of basic blocks on path that CSE considers.
10636 The default is 10.
10638 @item max-cse-insns
10639 The maximum number of instructions CSE processes before flushing.
10640 The default is 1000.
10642 @item ggc-min-expand
10644 GCC uses a garbage collector to manage its own memory allocation.  This
10645 parameter specifies the minimum percentage by which the garbage
10646 collector's heap should be allowed to expand between collections.
10647 Tuning this may improve compilation speed; it has no effect on code
10648 generation.
10650 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10651 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10652 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10653 GCC is not able to calculate RAM on a particular platform, the lower
10654 bound of 30% is used.  Setting this parameter and
10655 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10656 every opportunity.  This is extremely slow, but can be useful for
10657 debugging.
10659 @item ggc-min-heapsize
10661 Minimum size of the garbage collector's heap before it begins bothering
10662 to collect garbage.  The first collection occurs after the heap expands
10663 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10664 tuning this may improve compilation speed, and has no effect on code
10665 generation.
10667 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10668 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10669 with a lower bound of 4096 (four megabytes) and an upper bound of
10670 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10671 particular platform, the lower bound is used.  Setting this parameter
10672 very large effectively disables garbage collection.  Setting this
10673 parameter and @option{ggc-min-expand} to zero causes a full collection
10674 to occur at every opportunity.
10676 @item max-reload-search-insns
10677 The maximum number of instruction reload should look backward for equivalent
10678 register.  Increasing values mean more aggressive optimization, making the
10679 compilation time increase with probably slightly better performance.
10680 The default value is 100.
10682 @item max-cselib-memory-locations
10683 The maximum number of memory locations cselib should take into account.
10684 Increasing values mean more aggressive optimization, making the compilation time
10685 increase with probably slightly better performance.  The default value is 500.
10687 @item max-sched-ready-insns
10688 The maximum number of instructions ready to be issued the scheduler should
10689 consider at any given time during the first scheduling pass.  Increasing
10690 values mean more thorough searches, making the compilation time increase
10691 with probably little benefit.  The default value is 100.
10693 @item max-sched-region-blocks
10694 The maximum number of blocks in a region to be considered for
10695 interblock scheduling.  The default value is 10.
10697 @item max-pipeline-region-blocks
10698 The maximum number of blocks in a region to be considered for
10699 pipelining in the selective scheduler.  The default value is 15.
10701 @item max-sched-region-insns
10702 The maximum number of insns in a region to be considered for
10703 interblock scheduling.  The default value is 100.
10705 @item max-pipeline-region-insns
10706 The maximum number of insns in a region to be considered for
10707 pipelining in the selective scheduler.  The default value is 200.
10709 @item min-spec-prob
10710 The minimum probability (in percents) of reaching a source block
10711 for interblock speculative scheduling.  The default value is 40.
10713 @item max-sched-extend-regions-iters
10714 The maximum number of iterations through CFG to extend regions.
10715 A value of 0 (the default) disables region extensions.
10717 @item max-sched-insn-conflict-delay
10718 The maximum conflict delay for an insn to be considered for speculative motion.
10719 The default value is 3.
10721 @item sched-spec-prob-cutoff
10722 The minimal probability of speculation success (in percents), so that
10723 speculative insns are scheduled.
10724 The default value is 40.
10726 @item sched-state-edge-prob-cutoff
10727 The minimum probability an edge must have for the scheduler to save its
10728 state across it.
10729 The default value is 10.
10731 @item sched-mem-true-dep-cost
10732 Minimal distance (in CPU cycles) between store and load targeting same
10733 memory locations.  The default value is 1.
10735 @item selsched-max-lookahead
10736 The maximum size of the lookahead window of selective scheduling.  It is a
10737 depth of search for available instructions.
10738 The default value is 50.
10740 @item selsched-max-sched-times
10741 The maximum number of times that an instruction is scheduled during
10742 selective scheduling.  This is the limit on the number of iterations
10743 through which the instruction may be pipelined.  The default value is 2.
10745 @item selsched-insns-to-rename
10746 The maximum number of best instructions in the ready list that are considered
10747 for renaming in the selective scheduler.  The default value is 2.
10749 @item sms-min-sc
10750 The minimum value of stage count that swing modulo scheduler
10751 generates.  The default value is 2.
10753 @item max-last-value-rtl
10754 The maximum size measured as number of RTLs that can be recorded in an expression
10755 in combiner for a pseudo register as last known value of that register.  The default
10756 is 10000.
10758 @item max-combine-insns
10759 The maximum number of instructions the RTL combiner tries to combine.
10760 The default value is 2 at @option{-Og} and 4 otherwise.
10762 @item integer-share-limit
10763 Small integer constants can use a shared data structure, reducing the
10764 compiler's memory usage and increasing its speed.  This sets the maximum
10765 value of a shared integer constant.  The default value is 256.
10767 @item ssp-buffer-size
10768 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10769 protection when @option{-fstack-protection} is used.
10771 @item min-size-for-stack-sharing
10772 The minimum size of variables taking part in stack slot sharing when not
10773 optimizing. The default value is 32.
10775 @item max-jump-thread-duplication-stmts
10776 Maximum number of statements allowed in a block that needs to be
10777 duplicated when threading jumps.
10779 @item max-fields-for-field-sensitive
10780 Maximum number of fields in a structure treated in
10781 a field sensitive manner during pointer analysis.  The default is zero
10782 for @option{-O0} and @option{-O1},
10783 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10785 @item prefetch-latency
10786 Estimate on average number of instructions that are executed before
10787 prefetch finishes.  The distance prefetched ahead is proportional
10788 to this constant.  Increasing this number may also lead to less
10789 streams being prefetched (see @option{simultaneous-prefetches}).
10791 @item simultaneous-prefetches
10792 Maximum number of prefetches that can run at the same time.
10794 @item l1-cache-line-size
10795 The size of cache line in L1 cache, in bytes.
10797 @item l1-cache-size
10798 The size of L1 cache, in kilobytes.
10800 @item l2-cache-size
10801 The size of L2 cache, in kilobytes.
10803 @item prefetch-dynamic-strides
10804 Whether the loop array prefetch pass should issue software prefetch hints
10805 for strides that are non-constant.  In some cases this may be
10806 beneficial, though the fact the stride is non-constant may make it
10807 hard to predict when there is clear benefit to issuing these hints.
10809 Set to 1, the default, if the prefetch hints should be issued for non-constant
10810 strides.  Set to 0 if prefetch hints should be issued only for strides that
10811 are known to be constant and below @option{prefetch-minimum-stride}.
10813 @item prefetch-minimum-stride
10814 Minimum constant stride, in bytes, to start using prefetch hints for.  If
10815 the stride is less than this threshold, prefetch hints will not be issued.
10817 This setting is useful for processors that have hardware prefetchers, in
10818 which case there may be conflicts between the hardware prefetchers and
10819 the software prefetchers.  If the hardware prefetchers have a maximum
10820 stride they can handle, it should be used here to improve the use of
10821 software prefetchers.
10823 A value of -1, the default, means we don't have a threshold and therefore
10824 prefetch hints can be issued for any constant stride.
10826 This setting is only useful for strides that are known and constant.
10828 @item loop-interchange-max-num-stmts
10829 The maximum number of stmts in a loop to be interchanged.
10831 @item loop-interchange-stride-ratio
10832 The minimum ratio between stride of two loops for interchange to be profitable.
10834 @item min-insn-to-prefetch-ratio
10835 The minimum ratio between the number of instructions and the
10836 number of prefetches to enable prefetching in a loop.
10838 @item prefetch-min-insn-to-mem-ratio
10839 The minimum ratio between the number of instructions and the
10840 number of memory references to enable prefetching in a loop.
10842 @item use-canonical-types
10843 Whether the compiler should use the ``canonical'' type system.  By
10844 default, this should always be 1, which uses a more efficient internal
10845 mechanism for comparing types in C++ and Objective-C++.  However, if
10846 bugs in the canonical type system are causing compilation failures,
10847 set this value to 0 to disable canonical types.
10849 @item switch-conversion-max-branch-ratio
10850 Switch initialization conversion refuses to create arrays that are
10851 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10852 branches in the switch.
10854 @item max-partial-antic-length
10855 Maximum length of the partial antic set computed during the tree
10856 partial redundancy elimination optimization (@option{-ftree-pre}) when
10857 optimizing at @option{-O3} and above.  For some sorts of source code
10858 the enhanced partial redundancy elimination optimization can run away,
10859 consuming all of the memory available on the host machine.  This
10860 parameter sets a limit on the length of the sets that are computed,
10861 which prevents the runaway behavior.  Setting a value of 0 for
10862 this parameter allows an unlimited set length.
10864 @item sccvn-max-scc-size
10865 Maximum size of a strongly connected component (SCC) during SCCVN
10866 processing.  If this limit is hit, SCCVN processing for the whole
10867 function is not done and optimizations depending on it are
10868 disabled.  The default maximum SCC size is 10000.
10870 @item sccvn-max-alias-queries-per-access
10871 Maximum number of alias-oracle queries we perform when looking for
10872 redundancies for loads and stores.  If this limit is hit the search
10873 is aborted and the load or store is not considered redundant.  The
10874 number of queries is algorithmically limited to the number of
10875 stores on all paths from the load to the function entry.
10876 The default maximum number of queries is 1000.
10878 @item ira-max-loops-num
10879 IRA uses regional register allocation by default.  If a function
10880 contains more loops than the number given by this parameter, only at most
10881 the given number of the most frequently-executed loops form regions
10882 for regional register allocation.  The default value of the
10883 parameter is 100.
10885 @item ira-max-conflict-table-size 
10886 Although IRA uses a sophisticated algorithm to compress the conflict
10887 table, the table can still require excessive amounts of memory for
10888 huge functions.  If the conflict table for a function could be more
10889 than the size in MB given by this parameter, the register allocator
10890 instead uses a faster, simpler, and lower-quality
10891 algorithm that does not require building a pseudo-register conflict table.  
10892 The default value of the parameter is 2000.
10894 @item ira-loop-reserved-regs
10895 IRA can be used to evaluate more accurate register pressure in loops
10896 for decisions to move loop invariants (see @option{-O3}).  The number
10897 of available registers reserved for some other purposes is given
10898 by this parameter.  The default value of the parameter is 2, which is
10899 the minimal number of registers needed by typical instructions.
10900 This value is the best found from numerous experiments.
10902 @item lra-inheritance-ebb-probability-cutoff
10903 LRA tries to reuse values reloaded in registers in subsequent insns.
10904 This optimization is called inheritance.  EBB is used as a region to
10905 do this optimization.  The parameter defines a minimal fall-through
10906 edge probability in percentage used to add BB to inheritance EBB in
10907 LRA.  The default value of the parameter is 40.  The value was chosen
10908 from numerous runs of SPEC2000 on x86-64.
10910 @item loop-invariant-max-bbs-in-loop
10911 Loop invariant motion can be very expensive, both in compilation time and
10912 in amount of needed compile-time memory, with very large loops.  Loops
10913 with more basic blocks than this parameter won't have loop invariant
10914 motion optimization performed on them.  The default value of the
10915 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10917 @item loop-max-datarefs-for-datadeps
10918 Building data dependencies is expensive for very large loops.  This
10919 parameter limits the number of data references in loops that are
10920 considered for data dependence analysis.  These large loops are no
10921 handled by the optimizations using loop data dependencies.
10922 The default value is 1000.
10924 @item max-vartrack-size
10925 Sets a maximum number of hash table slots to use during variable
10926 tracking dataflow analysis of any function.  If this limit is exceeded
10927 with variable tracking at assignments enabled, analysis for that
10928 function is retried without it, after removing all debug insns from
10929 the function.  If the limit is exceeded even without debug insns, var
10930 tracking analysis is completely disabled for the function.  Setting
10931 the parameter to zero makes it unlimited.
10933 @item max-vartrack-expr-depth
10934 Sets a maximum number of recursion levels when attempting to map
10935 variable names or debug temporaries to value expressions.  This trades
10936 compilation time for more complete debug information.  If this is set too
10937 low, value expressions that are available and could be represented in
10938 debug information may end up not being used; setting this higher may
10939 enable the compiler to find more complex debug expressions, but compile
10940 time and memory use may grow.  The default is 12.
10942 @item max-debug-marker-count
10943 Sets a threshold on the number of debug markers (e.g. begin stmt
10944 markers) to avoid complexity explosion at inlining or expanding to RTL.
10945 If a function has more such gimple stmts than the set limit, such stmts
10946 will be dropped from the inlined copy of a function, and from its RTL
10947 expansion.  The default is 100000.
10949 @item min-nondebug-insn-uid
10950 Use uids starting at this parameter for nondebug insns.  The range below
10951 the parameter is reserved exclusively for debug insns created by
10952 @option{-fvar-tracking-assignments}, but debug insns may get
10953 (non-overlapping) uids above it if the reserved range is exhausted.
10955 @item ipa-sra-ptr-growth-factor
10956 IPA-SRA replaces a pointer to an aggregate with one or more new
10957 parameters only when their cumulative size is less or equal to
10958 @option{ipa-sra-ptr-growth-factor} times the size of the original
10959 pointer parameter.
10961 @item sra-max-scalarization-size-Ospeed
10962 @itemx sra-max-scalarization-size-Osize
10963 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10964 replace scalar parts of aggregates with uses of independent scalar
10965 variables.  These parameters control the maximum size, in storage units,
10966 of aggregate which is considered for replacement when compiling for
10967 speed
10968 (@option{sra-max-scalarization-size-Ospeed}) or size
10969 (@option{sra-max-scalarization-size-Osize}) respectively.
10971 @item tm-max-aggregate-size
10972 When making copies of thread-local variables in a transaction, this
10973 parameter specifies the size in bytes after which variables are
10974 saved with the logging functions as opposed to save/restore code
10975 sequence pairs.  This option only applies when using
10976 @option{-fgnu-tm}.
10978 @item graphite-max-nb-scop-params
10979 To avoid exponential effects in the Graphite loop transforms, the
10980 number of parameters in a Static Control Part (SCoP) is bounded.  The
10981 default value is 10 parameters, a value of zero can be used to lift
10982 the bound.  A variable whose value is unknown at compilation time and
10983 defined outside a SCoP is a parameter of the SCoP.
10985 @item loop-block-tile-size
10986 Loop blocking or strip mining transforms, enabled with
10987 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10988 loop in the loop nest by a given number of iterations.  The strip
10989 length can be changed using the @option{loop-block-tile-size}
10990 parameter.  The default value is 51 iterations.
10992 @item loop-unroll-jam-size
10993 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10994 default value is 4.
10996 @item loop-unroll-jam-depth
10997 Specify the dimension to be unrolled (counting from the most inner loop)
10998 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
11000 @item ipa-cp-value-list-size
11001 IPA-CP attempts to track all possible values and types passed to a function's
11002 parameter in order to propagate them and perform devirtualization.
11003 @option{ipa-cp-value-list-size} is the maximum number of values and types it
11004 stores per one formal parameter of a function.
11006 @item ipa-cp-eval-threshold
11007 IPA-CP calculates its own score of cloning profitability heuristics
11008 and performs those cloning opportunities with scores that exceed
11009 @option{ipa-cp-eval-threshold}.
11011 @item ipa-cp-recursion-penalty
11012 Percentage penalty the recursive functions will receive when they
11013 are evaluated for cloning.
11015 @item ipa-cp-single-call-penalty
11016 Percentage penalty functions containing a single call to another
11017 function will receive when they are evaluated for cloning.
11020 @item ipa-max-agg-items
11021 IPA-CP is also capable to propagate a number of scalar values passed
11022 in an aggregate. @option{ipa-max-agg-items} controls the maximum
11023 number of such values per one parameter.
11025 @item ipa-cp-loop-hint-bonus
11026 When IPA-CP determines that a cloning candidate would make the number
11027 of iterations of a loop known, it adds a bonus of
11028 @option{ipa-cp-loop-hint-bonus} to the profitability score of
11029 the candidate.
11031 @item ipa-cp-array-index-hint-bonus
11032 When IPA-CP determines that a cloning candidate would make the index of
11033 an array access known, it adds a bonus of
11034 @option{ipa-cp-array-index-hint-bonus} to the profitability
11035 score of the candidate.
11037 @item ipa-max-aa-steps
11038 During its analysis of function bodies, IPA-CP employs alias analysis
11039 in order to track values pointed to by function parameters.  In order
11040 not spend too much time analyzing huge functions, it gives up and
11041 consider all memory clobbered after examining
11042 @option{ipa-max-aa-steps} statements modifying memory.
11044 @item lto-partitions
11045 Specify desired number of partitions produced during WHOPR compilation.
11046 The number of partitions should exceed the number of CPUs used for compilation.
11047 The default value is 32.
11049 @item lto-min-partition
11050 Size of minimal partition for WHOPR (in estimated instructions).
11051 This prevents expenses of splitting very small programs into too many
11052 partitions.
11054 @item lto-max-partition
11055 Size of max partition for WHOPR (in estimated instructions).
11056 to provide an upper bound for individual size of partition.
11057 Meant to be used only with balanced partitioning.
11059 @item cxx-max-namespaces-for-diagnostic-help
11060 The maximum number of namespaces to consult for suggestions when C++
11061 name lookup fails for an identifier.  The default is 1000.
11063 @item sink-frequency-threshold
11064 The maximum relative execution frequency (in percents) of the target block
11065 relative to a statement's original block to allow statement sinking of a
11066 statement.  Larger numbers result in more aggressive statement sinking.
11067 The default value is 75.  A small positive adjustment is applied for
11068 statements with memory operands as those are even more profitable so sink.
11070 @item max-stores-to-sink
11071 The maximum number of conditional store pairs that can be sunk.  Set to 0
11072 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11073 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11075 @item allow-store-data-races
11076 Allow optimizers to introduce new data races on stores.
11077 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11078 at optimization level @option{-Ofast}.
11080 @item case-values-threshold
11081 The smallest number of different values for which it is best to use a
11082 jump-table instead of a tree of conditional branches.  If the value is
11083 0, use the default for the machine.  The default is 0.
11085 @item tree-reassoc-width
11086 Set the maximum number of instructions executed in parallel in
11087 reassociated tree. This parameter overrides target dependent
11088 heuristics used by default if has non zero value.
11090 @item sched-pressure-algorithm
11091 Choose between the two available implementations of
11092 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11093 and is the more likely to prevent instructions from being reordered.
11094 Algorithm 2 was designed to be a compromise between the relatively
11095 conservative approach taken by algorithm 1 and the rather aggressive
11096 approach taken by the default scheduler.  It relies more heavily on
11097 having a regular register file and accurate register pressure classes.
11098 See @file{haifa-sched.c} in the GCC sources for more details.
11100 The default choice depends on the target.
11102 @item max-slsr-cand-scan
11103 Set the maximum number of existing candidates that are considered when
11104 seeking a basis for a new straight-line strength reduction candidate.
11106 @item asan-globals
11107 Enable buffer overflow detection for global objects.  This kind
11108 of protection is enabled by default if you are using
11109 @option{-fsanitize=address} option.
11110 To disable global objects protection use @option{--param asan-globals=0}.
11112 @item asan-stack
11113 Enable buffer overflow detection for stack objects.  This kind of
11114 protection is enabled by default when using @option{-fsanitize=address}.
11115 To disable stack protection use @option{--param asan-stack=0} option.
11117 @item asan-instrument-reads
11118 Enable buffer overflow detection for memory reads.  This kind of
11119 protection is enabled by default when using @option{-fsanitize=address}.
11120 To disable memory reads protection use
11121 @option{--param asan-instrument-reads=0}.
11123 @item asan-instrument-writes
11124 Enable buffer overflow detection for memory writes.  This kind of
11125 protection is enabled by default when using @option{-fsanitize=address}.
11126 To disable memory writes protection use
11127 @option{--param asan-instrument-writes=0} option.
11129 @item asan-memintrin
11130 Enable detection for built-in functions.  This kind of protection
11131 is enabled by default when using @option{-fsanitize=address}.
11132 To disable built-in functions protection use
11133 @option{--param asan-memintrin=0}.
11135 @item asan-use-after-return
11136 Enable detection of use-after-return.  This kind of protection
11137 is enabled by default when using the @option{-fsanitize=address} option.
11138 To disable it use @option{--param asan-use-after-return=0}.
11140 Note: By default the check is disabled at run time.  To enable it,
11141 add @code{detect_stack_use_after_return=1} to the environment variable
11142 @env{ASAN_OPTIONS}.
11144 @item asan-instrumentation-with-call-threshold
11145 If number of memory accesses in function being instrumented
11146 is greater or equal to this number, use callbacks instead of inline checks.
11147 E.g. to disable inline code use
11148 @option{--param asan-instrumentation-with-call-threshold=0}.
11150 @item use-after-scope-direct-emission-threshold
11151 If the size of a local variable in bytes is smaller or equal to this
11152 number, directly poison (or unpoison) shadow memory instead of using
11153 run-time callbacks.  The default value is 256.
11155 @item max-fsm-thread-path-insns
11156 Maximum number of instructions to copy when duplicating blocks on a
11157 finite state automaton jump thread path.  The default is 100.
11159 @item max-fsm-thread-length
11160 Maximum number of basic blocks on a finite state automaton jump thread
11161 path.  The default is 10.
11163 @item max-fsm-thread-paths
11164 Maximum number of new jump thread paths to create for a finite state
11165 automaton.  The default is 50.
11167 @item parloops-chunk-size
11168 Chunk size of omp schedule for loops parallelized by parloops.  The default
11169 is 0.
11171 @item parloops-schedule
11172 Schedule type of omp schedule for loops parallelized by parloops (static,
11173 dynamic, guided, auto, runtime).  The default is static.
11175 @item parloops-min-per-thread
11176 The minimum number of iterations per thread of an innermost parallelized
11177 loop for which the parallelized variant is prefered over the single threaded
11178 one.  The default is 100.  Note that for a parallelized loop nest the
11179 minimum number of iterations of the outermost loop per thread is two.
11181 @item max-ssa-name-query-depth
11182 Maximum depth of recursion when querying properties of SSA names in things
11183 like fold routines.  One level of recursion corresponds to following a
11184 use-def chain.
11186 @item hsa-gen-debug-stores
11187 Enable emission of special debug stores within HSA kernels which are
11188 then read and reported by libgomp plugin.  Generation of these stores
11189 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11190 enable it.
11192 @item max-speculative-devirt-maydefs
11193 The maximum number of may-defs we analyze when looking for a must-def
11194 specifying the dynamic type of an object that invokes a virtual call
11195 we may be able to devirtualize speculatively.
11197 @item max-vrp-switch-assertions
11198 The maximum number of assertions to add along the default edge of a switch
11199 statement during VRP.  The default is 10.
11201 @item unroll-jam-min-percent
11202 The minimum percentage of memory references that must be optimized
11203 away for the unroll-and-jam transformation to be considered profitable.
11205 @item unroll-jam-max-unroll
11206 The maximum number of times the outer loop should be unrolled by
11207 the unroll-and-jam transformation.
11208 @end table
11209 @end table
11211 @node Instrumentation Options
11212 @section Program Instrumentation Options
11213 @cindex instrumentation options
11214 @cindex program instrumentation options
11215 @cindex run-time error checking options
11216 @cindex profiling options
11217 @cindex options, program instrumentation
11218 @cindex options, run-time error checking
11219 @cindex options, profiling
11221 GCC supports a number of command-line options that control adding
11222 run-time instrumentation to the code it normally generates.  
11223 For example, one purpose of instrumentation is collect profiling
11224 statistics for use in finding program hot spots, code coverage
11225 analysis, or profile-guided optimizations.
11226 Another class of program instrumentation is adding run-time checking 
11227 to detect programming errors like invalid pointer
11228 dereferences or out-of-bounds array accesses, as well as deliberately
11229 hostile attacks such as stack smashing or C++ vtable hijacking.
11230 There is also a general hook which can be used to implement other
11231 forms of tracing or function-level instrumentation for debug or
11232 program analysis purposes.
11234 @table @gcctabopt
11235 @cindex @command{prof}
11236 @item -p
11237 @opindex p
11238 Generate extra code to write profile information suitable for the
11239 analysis program @command{prof}.  You must use this option when compiling
11240 the source files you want data about, and you must also use it when
11241 linking.
11243 @cindex @command{gprof}
11244 @item -pg
11245 @opindex pg
11246 Generate extra code to write profile information suitable for the
11247 analysis program @command{gprof}.  You must use this option when compiling
11248 the source files you want data about, and you must also use it when
11249 linking.
11251 @item -fprofile-arcs
11252 @opindex fprofile-arcs
11253 Add code so that program flow @dfn{arcs} are instrumented.  During
11254 execution the program records how many times each branch and call is
11255 executed and how many times it is taken or returns.  On targets that support
11256 constructors with priority support, profiling properly handles constructors,
11257 destructors and C++ constructors (and destructors) of classes which are used
11258 as a type of a global variable.
11260 When the compiled
11261 program exits it saves this data to a file called
11262 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11263 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11264 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11265 @var{auxname} is generated from the name of the output file, if
11266 explicitly specified and it is not the final executable, otherwise it is
11267 the basename of the source file.  In both cases any suffix is removed
11268 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11269 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11270 @xref{Cross-profiling}.
11272 @cindex @command{gcov}
11273 @item --coverage
11274 @opindex coverage
11276 This option is used to compile and link code instrumented for coverage
11277 analysis.  The option is a synonym for @option{-fprofile-arcs}
11278 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11279 linking).  See the documentation for those options for more details.
11281 @itemize
11283 @item
11284 Compile the source files with @option{-fprofile-arcs} plus optimization
11285 and code generation options.  For test coverage analysis, use the
11286 additional @option{-ftest-coverage} option.  You do not need to profile
11287 every source file in a program.
11289 @item
11290 Compile the source files additionally with @option{-fprofile-abs-path}
11291 to create absolute path names in the @file{.gcno} files.  This allows
11292 @command{gcov} to find the correct sources in projects where compilations
11293 occur with different working directories.
11295 @item
11296 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11297 (the latter implies the former).
11299 @item
11300 Run the program on a representative workload to generate the arc profile
11301 information.  This may be repeated any number of times.  You can run
11302 concurrent instances of your program, and provided that the file system
11303 supports locking, the data files will be correctly updated.  Unless
11304 a strict ISO C dialect option is in effect, @code{fork} calls are
11305 detected and correctly handled without double counting.
11307 @item
11308 For profile-directed optimizations, compile the source files again with
11309 the same optimization and code generation options plus
11310 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11311 Control Optimization}).
11313 @item
11314 For test coverage analysis, use @command{gcov} to produce human readable
11315 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11316 @command{gcov} documentation for further information.
11318 @end itemize
11320 With @option{-fprofile-arcs}, for each function of your program GCC
11321 creates a program flow graph, then finds a spanning tree for the graph.
11322 Only arcs that are not on the spanning tree have to be instrumented: the
11323 compiler adds code to count the number of times that these arcs are
11324 executed.  When an arc is the only exit or only entrance to a block, the
11325 instrumentation code can be added to the block; otherwise, a new basic
11326 block must be created to hold the instrumentation code.
11328 @need 2000
11329 @item -ftest-coverage
11330 @opindex ftest-coverage
11331 Produce a notes file that the @command{gcov} code-coverage utility
11332 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11333 show program coverage.  Each source file's note file is called
11334 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11335 above for a description of @var{auxname} and instructions on how to
11336 generate test coverage data.  Coverage data matches the source files
11337 more closely if you do not optimize.
11339 @item -fprofile-abs-path
11340 @opindex fprofile-abs-path
11341 Automatically convert relative source file names to absolute path names
11342 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11343 sources in projects where compilations occur with different working
11344 directories.
11346 @item -fprofile-dir=@var{path}
11347 @opindex fprofile-dir
11349 Set the directory to search for the profile data files in to @var{path}.
11350 This option affects only the profile data generated by
11351 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11352 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11353 and its related options.  Both absolute and relative paths can be used.
11354 By default, GCC uses the current directory as @var{path}, thus the
11355 profile data file appears in the same directory as the object file.
11357 When an executable is run in a massive parallel environment, it is recommended
11358 to save profile to different folders.  That can be done with variables
11359 in @var{path} that are exported during run-time:
11361 @table @gcctabopt
11363 @item %p
11364 process ID.
11366 @item %q@{VAR@}
11367 value of environment variable @var{VAR}
11369 @end table
11371 @item -fprofile-generate
11372 @itemx -fprofile-generate=@var{path}
11373 @opindex fprofile-generate
11375 Enable options usually used for instrumenting application to produce
11376 profile useful for later recompilation with profile feedback based
11377 optimization.  You must use @option{-fprofile-generate} both when
11378 compiling and when linking your program.
11380 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11382 If @var{path} is specified, GCC looks at the @var{path} to find
11383 the profile feedback data files. See @option{-fprofile-dir}.
11385 To optimize the program based on the collected profile information, use
11386 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11388 @item -fprofile-update=@var{method}
11389 @opindex fprofile-update
11391 Alter the update method for an application instrumented for profile
11392 feedback based optimization.  The @var{method} argument should be one of
11393 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11394 The first one is useful for single-threaded applications,
11395 while the second one prevents profile corruption by emitting thread-safe code.
11397 @strong{Warning:} When an application does not properly join all threads
11398 (or creates an detached thread), a profile file can be still corrupted.
11400 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11401 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11402 automatically selects @samp{prefer-atomic} when @option{-pthread}
11403 is present in the command line.
11405 @item -fsanitize=address
11406 @opindex fsanitize=address
11407 Enable AddressSanitizer, a fast memory error detector.
11408 Memory access instructions are instrumented to detect
11409 out-of-bounds and use-after-free bugs.
11410 The option enables @option{-fsanitize-address-use-after-scope}.
11411 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11412 more details.  The run-time behavior can be influenced using the
11413 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11414 the available options are shown at startup of the instrumented program.  See
11415 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11416 for a list of supported options.
11417 The option cannot be combined with @option{-fsanitize=thread}.
11419 @item -fsanitize=kernel-address
11420 @opindex fsanitize=kernel-address
11421 Enable AddressSanitizer for Linux kernel.
11422 See @uref{https://github.com/google/kasan/wiki} for more details.
11424 @item -fsanitize=pointer-compare
11425 @opindex fsanitize=pointer-compare
11426 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11427 The option must be combined with either @option{-fsanitize=kernel-address} or
11428 @option{-fsanitize=address}
11429 The option cannot be combined with @option{-fsanitize=thread}.
11430 Note: By default the check is disabled at run time.  To enable it,
11431 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11432 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11433 invalid operation only when both pointers are non-null.
11435 @item -fsanitize=pointer-subtract
11436 @opindex fsanitize=pointer-subtract
11437 Instrument subtraction with pointer operands.
11438 The option must be combined with either @option{-fsanitize=kernel-address} or
11439 @option{-fsanitize=address}
11440 The option cannot be combined with @option{-fsanitize=thread}.
11441 Note: By default the check is disabled at run time.  To enable it,
11442 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11443 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11444 invalid operation only when both pointers are non-null.
11446 @item -fsanitize=thread
11447 @opindex fsanitize=thread
11448 Enable ThreadSanitizer, a fast data race detector.
11449 Memory access instructions are instrumented to detect
11450 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11451 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11452 environment variable; see
11453 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11454 supported options.
11455 The option cannot be combined with @option{-fsanitize=address},
11456 @option{-fsanitize=leak}.
11458 Note that sanitized atomic builtins cannot throw exceptions when
11459 operating on invalid memory addresses with non-call exceptions
11460 (@option{-fnon-call-exceptions}).
11462 @item -fsanitize=leak
11463 @opindex fsanitize=leak
11464 Enable LeakSanitizer, a memory leak detector.
11465 This option only matters for linking of executables and
11466 the executable is linked against a library that overrides @code{malloc}
11467 and other allocator functions.  See
11468 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11469 details.  The run-time behavior can be influenced using the
11470 @env{LSAN_OPTIONS} environment variable.
11471 The option cannot be combined with @option{-fsanitize=thread}.
11473 @item -fsanitize=undefined
11474 @opindex fsanitize=undefined
11475 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11476 Various computations are instrumented to detect undefined behavior
11477 at runtime.  Current suboptions are:
11479 @table @gcctabopt
11481 @item -fsanitize=shift
11482 @opindex fsanitize=shift
11483 This option enables checking that the result of a shift operation is
11484 not undefined.  Note that what exactly is considered undefined differs
11485 slightly between C and C++, as well as between ISO C90 and C99, etc.
11486 This option has two suboptions, @option{-fsanitize=shift-base} and
11487 @option{-fsanitize=shift-exponent}.
11489 @item -fsanitize=shift-exponent
11490 @opindex fsanitize=shift-exponent
11491 This option enables checking that the second argument of a shift operation
11492 is not negative and is smaller than the precision of the promoted first
11493 argument.
11495 @item -fsanitize=shift-base
11496 @opindex fsanitize=shift-base
11497 If the second argument of a shift operation is within range, check that the
11498 result of a shift operation is not undefined.  Note that what exactly is
11499 considered undefined differs slightly between C and C++, as well as between
11500 ISO C90 and C99, etc.
11502 @item -fsanitize=integer-divide-by-zero
11503 @opindex fsanitize=integer-divide-by-zero
11504 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11506 @item -fsanitize=unreachable
11507 @opindex fsanitize=unreachable
11508 With this option, the compiler turns the @code{__builtin_unreachable}
11509 call into a diagnostics message call instead.  When reaching the
11510 @code{__builtin_unreachable} call, the behavior is undefined.
11512 @item -fsanitize=vla-bound
11513 @opindex fsanitize=vla-bound
11514 This option instructs the compiler to check that the size of a variable
11515 length array is positive.
11517 @item -fsanitize=null
11518 @opindex fsanitize=null
11519 This option enables pointer checking.  Particularly, the application
11520 built with this option turned on will issue an error message when it
11521 tries to dereference a NULL pointer, or if a reference (possibly an
11522 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11523 on an object pointed by a NULL pointer.
11525 @item -fsanitize=return
11526 @opindex fsanitize=return
11527 This option enables return statement checking.  Programs
11528 built with this option turned on will issue an error message
11529 when the end of a non-void function is reached without actually
11530 returning a value.  This option works in C++ only.
11532 @item -fsanitize=signed-integer-overflow
11533 @opindex fsanitize=signed-integer-overflow
11534 This option enables signed integer overflow checking.  We check that
11535 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11536 does not overflow in the signed arithmetics.  Note, integer promotion
11537 rules must be taken into account.  That is, the following is not an
11538 overflow:
11539 @smallexample
11540 signed char a = SCHAR_MAX;
11541 a++;
11542 @end smallexample
11544 @item -fsanitize=bounds
11545 @opindex fsanitize=bounds
11546 This option enables instrumentation of array bounds.  Various out of bounds
11547 accesses are detected.  Flexible array members, flexible array member-like
11548 arrays, and initializers of variables with static storage are not instrumented.
11550 @item -fsanitize=bounds-strict
11551 @opindex fsanitize=bounds-strict
11552 This option enables strict instrumentation of array bounds.  Most out of bounds
11553 accesses are detected, including flexible array members and flexible array
11554 member-like arrays.  Initializers of variables with static storage are not
11555 instrumented.
11557 @item -fsanitize=alignment
11558 @opindex fsanitize=alignment
11560 This option enables checking of alignment of pointers when they are
11561 dereferenced, or when a reference is bound to insufficiently aligned target,
11562 or when a method or constructor is invoked on insufficiently aligned object.
11564 @item -fsanitize=object-size
11565 @opindex fsanitize=object-size
11566 This option enables instrumentation of memory references using the
11567 @code{__builtin_object_size} function.  Various out of bounds pointer
11568 accesses are detected.
11570 @item -fsanitize=float-divide-by-zero
11571 @opindex fsanitize=float-divide-by-zero
11572 Detect floating-point division by zero.  Unlike other similar options,
11573 @option{-fsanitize=float-divide-by-zero} is not enabled by
11574 @option{-fsanitize=undefined}, since floating-point division by zero can
11575 be a legitimate way of obtaining infinities and NaNs.
11577 @item -fsanitize=float-cast-overflow
11578 @opindex fsanitize=float-cast-overflow
11579 This option enables floating-point type to integer conversion checking.
11580 We check that the result of the conversion does not overflow.
11581 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11582 not enabled by @option{-fsanitize=undefined}.
11583 This option does not work well with @code{FE_INVALID} exceptions enabled.
11585 @item -fsanitize=nonnull-attribute
11586 @opindex fsanitize=nonnull-attribute
11588 This option enables instrumentation of calls, checking whether null values
11589 are not passed to arguments marked as requiring a non-null value by the
11590 @code{nonnull} function attribute.
11592 @item -fsanitize=returns-nonnull-attribute
11593 @opindex fsanitize=returns-nonnull-attribute
11595 This option enables instrumentation of return statements in functions
11596 marked with @code{returns_nonnull} function attribute, to detect returning
11597 of null values from such functions.
11599 @item -fsanitize=bool
11600 @opindex fsanitize=bool
11602 This option enables instrumentation of loads from bool.  If a value other
11603 than 0/1 is loaded, a run-time error is issued.
11605 @item -fsanitize=enum
11606 @opindex fsanitize=enum
11608 This option enables instrumentation of loads from an enum type.  If
11609 a value outside the range of values for the enum type is loaded,
11610 a run-time error is issued.
11612 @item -fsanitize=vptr
11613 @opindex fsanitize=vptr
11615 This option enables instrumentation of C++ member function calls, member
11616 accesses and some conversions between pointers to base and derived classes,
11617 to verify the referenced object has the correct dynamic type.
11619 @item -fsanitize=pointer-overflow
11620 @opindex fsanitize=pointer-overflow
11622 This option enables instrumentation of pointer arithmetics.  If the pointer
11623 arithmetics overflows, a run-time error is issued.
11625 @item -fsanitize=builtin
11626 @opindex fsanitize=builtin
11628 This option enables instrumentation of arguments to selected builtin
11629 functions.  If an invalid value is passed to such arguments, a run-time
11630 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11631 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11632 by this option.
11634 @end table
11636 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11637 @option{-fsanitize=undefined} gives a diagnostic message.
11638 This currently works only for the C family of languages.
11640 @item -fno-sanitize=all
11641 @opindex fno-sanitize=all
11643 This option disables all previously enabled sanitizers.
11644 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11645 together.
11647 @item -fasan-shadow-offset=@var{number}
11648 @opindex fasan-shadow-offset
11649 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11650 It is useful for experimenting with different shadow memory layouts in
11651 Kernel AddressSanitizer.
11653 @item -fsanitize-sections=@var{s1},@var{s2},...
11654 @opindex fsanitize-sections
11655 Sanitize global variables in selected user-defined sections.  @var{si} may
11656 contain wildcards.
11658 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11659 @opindex fsanitize-recover
11660 @opindex fno-sanitize-recover
11661 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11662 mentioned in comma-separated list of @var{opts}.  Enabling this option
11663 for a sanitizer component causes it to attempt to continue
11664 running the program as if no error happened.  This means multiple
11665 runtime errors can be reported in a single program run, and the exit
11666 code of the program may indicate success even when errors
11667 have been reported.  The @option{-fno-sanitize-recover=} option
11668 can be used to alter
11669 this behavior: only the first detected error is reported
11670 and program then exits with a non-zero exit code.
11672 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11673 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11674 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11675 @option{-fsanitize=bounds-strict},
11676 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11677 For these sanitizers error recovery is turned on by default,
11678 except @option{-fsanitize=address}, for which this feature is experimental.
11679 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11680 accepted, the former enables recovery for all sanitizers that support it,
11681 the latter disables recovery for all sanitizers that support it.
11683 Even if a recovery mode is turned on the compiler side, it needs to be also
11684 enabled on the runtime library side, otherwise the failures are still fatal.
11685 The runtime library defaults to @code{halt_on_error=0} for
11686 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11687 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11688 setting the @code{halt_on_error} flag in the corresponding environment variable.
11690 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11691 equivalent to specifying an @var{opts} list of:
11693 @smallexample
11694 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11695 @end smallexample
11697 @item -fsanitize-address-use-after-scope
11698 @opindex fsanitize-address-use-after-scope
11699 Enable sanitization of local variables to detect use-after-scope bugs.
11700 The option sets @option{-fstack-reuse} to @samp{none}.
11702 @item -fsanitize-undefined-trap-on-error
11703 @opindex fsanitize-undefined-trap-on-error
11704 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11705 report undefined behavior using @code{__builtin_trap} rather than
11706 a @code{libubsan} library routine.  The advantage of this is that the
11707 @code{libubsan} library is not needed and is not linked in, so this
11708 is usable even in freestanding environments.
11710 @item -fsanitize-coverage=trace-pc
11711 @opindex fsanitize-coverage=trace-pc
11712 Enable coverage-guided fuzzing code instrumentation.
11713 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11715 @item -fsanitize-coverage=trace-cmp
11716 @opindex fsanitize-coverage=trace-cmp
11717 Enable dataflow guided fuzzing code instrumentation.
11718 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11719 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11720 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11721 variable or @code{__sanitizer_cov_trace_const_cmp1},
11722 @code{__sanitizer_cov_trace_const_cmp2},
11723 @code{__sanitizer_cov_trace_const_cmp4} or
11724 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11725 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11726 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11727 @code{__sanitizer_cov_trace_switch} for switch statements.
11729 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11730 @opindex fcf-protection
11731 Enable code instrumentation of control-flow transfers to increase
11732 program security by checking that target addresses of control-flow
11733 transfer instructions (such as indirect function call, function return,
11734 indirect jump) are valid.  This prevents diverting the flow of control
11735 to an unexpected target.  This is intended to protect against such
11736 threats as Return-oriented Programming (ROP), and similarly
11737 call/jmp-oriented programming (COP/JOP).
11739 The value @code{branch} tells the compiler to implement checking of
11740 validity of control-flow transfer at the point of indirect branch
11741 instructions, i.e. call/jmp instructions.  The value @code{return}
11742 implements checking of validity at the point of returning from a
11743 function.  The value @code{full} is an alias for specifying both
11744 @code{branch} and @code{return}. The value @code{none} turns off
11745 instrumentation.
11747 The macro @code{__CET__} is defined when @option{-fcf-protection} is
11748 used.  The first bit of @code{__CET__} is set to 1 for the value
11749 @code{branch} and the second bit of @code{__CET__} is set to 1 for
11750 the @code{return}.
11752 You can also use the @code{nocf_check} attribute to identify
11753 which functions and calls should be skipped from instrumentation
11754 (@pxref{Function Attributes}).
11756 Currently the x86 GNU/Linux target provides an implementation based
11757 on Intel Control-flow Enforcement Technology (CET).
11759 @item -fstack-protector
11760 @opindex fstack-protector
11761 Emit extra code to check for buffer overflows, such as stack smashing
11762 attacks.  This is done by adding a guard variable to functions with
11763 vulnerable objects.  This includes functions that call @code{alloca}, and
11764 functions with buffers larger than 8 bytes.  The guards are initialized
11765 when a function is entered and then checked when the function exits.
11766 If a guard check fails, an error message is printed and the program exits.
11768 @item -fstack-protector-all
11769 @opindex fstack-protector-all
11770 Like @option{-fstack-protector} except that all functions are protected.
11772 @item -fstack-protector-strong
11773 @opindex fstack-protector-strong
11774 Like @option{-fstack-protector} but includes additional functions to
11775 be protected --- those that have local array definitions, or have
11776 references to local frame addresses.
11778 @item -fstack-protector-explicit
11779 @opindex fstack-protector-explicit
11780 Like @option{-fstack-protector} but only protects those functions which
11781 have the @code{stack_protect} attribute.
11783 @item -fstack-check
11784 @opindex fstack-check
11785 Generate code to verify that you do not go beyond the boundary of the
11786 stack.  You should specify this flag if you are running in an
11787 environment with multiple threads, but you only rarely need to specify it in
11788 a single-threaded environment since stack overflow is automatically
11789 detected on nearly all systems if there is only one stack.
11791 Note that this switch does not actually cause checking to be done; the
11792 operating system or the language runtime must do that.  The switch causes
11793 generation of code to ensure that they see the stack being extended.
11795 You can additionally specify a string parameter: @samp{no} means no
11796 checking, @samp{generic} means force the use of old-style checking,
11797 @samp{specific} means use the best checking method and is equivalent
11798 to bare @option{-fstack-check}.
11800 Old-style checking is a generic mechanism that requires no specific
11801 target support in the compiler but comes with the following drawbacks:
11803 @enumerate
11804 @item
11805 Modified allocation strategy for large objects: they are always
11806 allocated dynamically if their size exceeds a fixed threshold.  Note this
11807 may change the semantics of some code.
11809 @item
11810 Fixed limit on the size of the static frame of functions: when it is
11811 topped by a particular function, stack checking is not reliable and
11812 a warning is issued by the compiler.
11814 @item
11815 Inefficiency: because of both the modified allocation strategy and the
11816 generic implementation, code performance is hampered.
11817 @end enumerate
11819 Note that old-style stack checking is also the fallback method for
11820 @samp{specific} if no target support has been added in the compiler.
11822 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11823 and stack overflows.  @samp{specific} is an excellent choice when compiling
11824 Ada code.  It is not generally sufficient to protect against stack-clash
11825 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11827 @item -fstack-clash-protection
11828 @opindex fstack-clash-protection
11829 Generate code to prevent stack clash style attacks.  When this option is
11830 enabled, the compiler will only allocate one page of stack space at a time
11831 and each page is accessed immediately after allocation.  Thus, it prevents
11832 allocations from jumping over any stack guard page provided by the
11833 operating system.
11835 Most targets do not fully support stack clash protection.  However, on
11836 those targets @option{-fstack-clash-protection} will protect dynamic stack
11837 allocations.  @option{-fstack-clash-protection} may also provide limited
11838 protection for static stack allocations if the target supports
11839 @option{-fstack-check=specific}.
11841 @item -fstack-limit-register=@var{reg}
11842 @itemx -fstack-limit-symbol=@var{sym}
11843 @itemx -fno-stack-limit
11844 @opindex fstack-limit-register
11845 @opindex fstack-limit-symbol
11846 @opindex fno-stack-limit
11847 Generate code to ensure that the stack does not grow beyond a certain value,
11848 either the value of a register or the address of a symbol.  If a larger
11849 stack is required, a signal is raised at run time.  For most targets,
11850 the signal is raised before the stack overruns the boundary, so
11851 it is possible to catch the signal without taking special precautions.
11853 For instance, if the stack starts at absolute address @samp{0x80000000}
11854 and grows downwards, you can use the flags
11855 @option{-fstack-limit-symbol=__stack_limit} and
11856 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11857 of 128KB@.  Note that this may only work with the GNU linker.
11859 You can locally override stack limit checking by using the
11860 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11862 @item -fsplit-stack
11863 @opindex fsplit-stack
11864 Generate code to automatically split the stack before it overflows.
11865 The resulting program has a discontiguous stack which can only
11866 overflow if the program is unable to allocate any more memory.  This
11867 is most useful when running threaded programs, as it is no longer
11868 necessary to calculate a good stack size to use for each thread.  This
11869 is currently only implemented for the x86 targets running
11870 GNU/Linux.
11872 When code compiled with @option{-fsplit-stack} calls code compiled
11873 without @option{-fsplit-stack}, there may not be much stack space
11874 available for the latter code to run.  If compiling all code,
11875 including library code, with @option{-fsplit-stack} is not an option,
11876 then the linker can fix up these calls so that the code compiled
11877 without @option{-fsplit-stack} always has a large stack.  Support for
11878 this is implemented in the gold linker in GNU binutils release 2.21
11879 and later.
11881 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11882 @opindex fvtable-verify
11883 This option is only available when compiling C++ code.
11884 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11885 feature that verifies at run time, for every virtual call, that
11886 the vtable pointer through which the call is made is valid for the type of
11887 the object, and has not been corrupted or overwritten.  If an invalid vtable
11888 pointer is detected at run time, an error is reported and execution of the
11889 program is immediately halted.
11891 This option causes run-time data structures to be built at program startup,
11892 which are used for verifying the vtable pointers.  
11893 The options @samp{std} and @samp{preinit}
11894 control the timing of when these data structures are built.  In both cases the
11895 data structures are built before execution reaches @code{main}.  Using
11896 @option{-fvtable-verify=std} causes the data structures to be built after
11897 shared libraries have been loaded and initialized.
11898 @option{-fvtable-verify=preinit} causes them to be built before shared
11899 libraries have been loaded and initialized.
11901 If this option appears multiple times in the command line with different
11902 values specified, @samp{none} takes highest priority over both @samp{std} and
11903 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11905 @item -fvtv-debug
11906 @opindex fvtv-debug
11907 When used in conjunction with @option{-fvtable-verify=std} or 
11908 @option{-fvtable-verify=preinit}, causes debug versions of the 
11909 runtime functions for the vtable verification feature to be called.  
11910 This flag also causes the compiler to log information about which 
11911 vtable pointers it finds for each class.
11912 This information is written to a file named @file{vtv_set_ptr_data.log} 
11913 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11914 if that is defined or the current working directory otherwise.
11916 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11917 file, be sure to delete any existing one.
11919 @item -fvtv-counts
11920 @opindex fvtv-counts
11921 This is a debugging flag.  When used in conjunction with
11922 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11923 causes the compiler to keep track of the total number of virtual calls
11924 it encounters and the number of verifications it inserts.  It also
11925 counts the number of calls to certain run-time library functions
11926 that it inserts and logs this information for each compilation unit.
11927 The compiler writes this information to a file named
11928 @file{vtv_count_data.log} in the directory named by the environment
11929 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11930 directory otherwise.  It also counts the size of the vtable pointer sets
11931 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11932 in the same directory.
11934 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11935 files, be sure to delete any existing ones.
11937 @item -finstrument-functions
11938 @opindex finstrument-functions
11939 Generate instrumentation calls for entry and exit to functions.  Just
11940 after function entry and just before function exit, the following
11941 profiling functions are called with the address of the current
11942 function and its call site.  (On some platforms,
11943 @code{__builtin_return_address} does not work beyond the current
11944 function, so the call site information may not be available to the
11945 profiling functions otherwise.)
11947 @smallexample
11948 void __cyg_profile_func_enter (void *this_fn,
11949                                void *call_site);
11950 void __cyg_profile_func_exit  (void *this_fn,
11951                                void *call_site);
11952 @end smallexample
11954 The first argument is the address of the start of the current function,
11955 which may be looked up exactly in the symbol table.
11957 This instrumentation is also done for functions expanded inline in other
11958 functions.  The profiling calls indicate where, conceptually, the
11959 inline function is entered and exited.  This means that addressable
11960 versions of such functions must be available.  If all your uses of a
11961 function are expanded inline, this may mean an additional expansion of
11962 code size.  If you use @code{extern inline} in your C code, an
11963 addressable version of such functions must be provided.  (This is
11964 normally the case anyway, but if you get lucky and the optimizer always
11965 expands the functions inline, you might have gotten away without
11966 providing static copies.)
11968 A function may be given the attribute @code{no_instrument_function}, in
11969 which case this instrumentation is not done.  This can be used, for
11970 example, for the profiling functions listed above, high-priority
11971 interrupt routines, and any functions from which the profiling functions
11972 cannot safely be called (perhaps signal handlers, if the profiling
11973 routines generate output or allocate memory).
11975 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11976 @opindex finstrument-functions-exclude-file-list
11978 Set the list of functions that are excluded from instrumentation (see
11979 the description of @option{-finstrument-functions}).  If the file that
11980 contains a function definition matches with one of @var{file}, then
11981 that function is not instrumented.  The match is done on substrings:
11982 if the @var{file} parameter is a substring of the file name, it is
11983 considered to be a match.
11985 For example:
11987 @smallexample
11988 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11989 @end smallexample
11991 @noindent
11992 excludes any inline function defined in files whose pathnames
11993 contain @file{/bits/stl} or @file{include/sys}.
11995 If, for some reason, you want to include letter @samp{,} in one of
11996 @var{sym}, write @samp{\,}. For example,
11997 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11998 (note the single quote surrounding the option).
12000 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12001 @opindex finstrument-functions-exclude-function-list
12003 This is similar to @option{-finstrument-functions-exclude-file-list},
12004 but this option sets the list of function names to be excluded from
12005 instrumentation.  The function name to be matched is its user-visible
12006 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12007 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12008 match is done on substrings: if the @var{sym} parameter is a substring
12009 of the function name, it is considered to be a match.  For C99 and C++
12010 extended identifiers, the function name must be given in UTF-8, not
12011 using universal character names.
12013 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12014 @opindex fpatchable-function-entry
12015 Generate @var{N} NOPs right at the beginning
12016 of each function, with the function entry point before the @var{M}th NOP.
12017 If @var{M} is omitted, it defaults to @code{0} so the
12018 function entry points to the address just at the first NOP.
12019 The NOP instructions reserve extra space which can be used to patch in
12020 any desired instrumentation at run time, provided that the code segment
12021 is writable.  The amount of space is controllable indirectly via
12022 the number of NOPs; the NOP instruction used corresponds to the instruction
12023 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12024 is target-specific and may also depend on the architecture variant and/or
12025 other compilation options.
12027 For run-time identification, the starting addresses of these areas,
12028 which correspond to their respective function entries minus @var{M},
12029 are additionally collected in the @code{__patchable_function_entries}
12030 section of the resulting binary.
12032 Note that the value of @code{__attribute__ ((patchable_function_entry
12033 (N,M)))} takes precedence over command-line option
12034 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12035 the area size or to remove it completely on a single function.
12036 If @code{N=0}, no pad location is recorded.
12038 The NOP instructions are inserted at---and maybe before, depending on
12039 @var{M}---the function entry address, even before the prologue.
12041 @end table
12044 @node Preprocessor Options
12045 @section Options Controlling the Preprocessor
12046 @cindex preprocessor options
12047 @cindex options, preprocessor
12049 These options control the C preprocessor, which is run on each C source
12050 file before actual compilation.
12052 If you use the @option{-E} option, nothing is done except preprocessing.
12053 Some of these options make sense only together with @option{-E} because
12054 they cause the preprocessor output to be unsuitable for actual
12055 compilation.
12057 In addition to the options listed here, there are a number of options 
12058 to control search paths for include files documented in 
12059 @ref{Directory Options}.  
12060 Options to control preprocessor diagnostics are listed in 
12061 @ref{Warning Options}.
12063 @table @gcctabopt
12064 @include cppopts.texi
12066 @item -Wp,@var{option}
12067 @opindex Wp
12068 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12069 and pass @var{option} directly through to the preprocessor.  If
12070 @var{option} contains commas, it is split into multiple options at the
12071 commas.  However, many options are modified, translated or interpreted
12072 by the compiler driver before being passed to the preprocessor, and
12073 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12074 interface is undocumented and subject to change, so whenever possible
12075 you should avoid using @option{-Wp} and let the driver handle the
12076 options instead.
12078 @item -Xpreprocessor @var{option}
12079 @opindex Xpreprocessor
12080 Pass @var{option} as an option to the preprocessor.  You can use this to
12081 supply system-specific preprocessor options that GCC does not 
12082 recognize.
12084 If you want to pass an option that takes an argument, you must use
12085 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12087 @item -no-integrated-cpp
12088 @opindex no-integrated-cpp
12089 Perform preprocessing as a separate pass before compilation.
12090 By default, GCC performs preprocessing as an integrated part of
12091 input tokenization and parsing.
12092 If this option is provided, the appropriate language front end
12093 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12094 and Objective-C, respectively) is instead invoked twice,
12095 once for preprocessing only and once for actual compilation
12096 of the preprocessed input.
12097 This option may be useful in conjunction with the @option{-B} or
12098 @option{-wrapper} options to specify an alternate preprocessor or
12099 perform additional processing of the program source between
12100 normal preprocessing and compilation.
12102 @end table
12104 @node Assembler Options
12105 @section Passing Options to the Assembler
12107 @c prevent bad page break with this line
12108 You can pass options to the assembler.
12110 @table @gcctabopt
12111 @item -Wa,@var{option}
12112 @opindex Wa
12113 Pass @var{option} as an option to the assembler.  If @var{option}
12114 contains commas, it is split into multiple options at the commas.
12116 @item -Xassembler @var{option}
12117 @opindex Xassembler
12118 Pass @var{option} as an option to the assembler.  You can use this to
12119 supply system-specific assembler options that GCC does not
12120 recognize.
12122 If you want to pass an option that takes an argument, you must use
12123 @option{-Xassembler} twice, once for the option and once for the argument.
12125 @end table
12127 @node Link Options
12128 @section Options for Linking
12129 @cindex link options
12130 @cindex options, linking
12132 These options come into play when the compiler links object files into
12133 an executable output file.  They are meaningless if the compiler is
12134 not doing a link step.
12136 @table @gcctabopt
12137 @cindex file names
12138 @item @var{object-file-name}
12139 A file name that does not end in a special recognized suffix is
12140 considered to name an object file or library.  (Object files are
12141 distinguished from libraries by the linker according to the file
12142 contents.)  If linking is done, these object files are used as input
12143 to the linker.
12145 @item -c
12146 @itemx -S
12147 @itemx -E
12148 @opindex c
12149 @opindex S
12150 @opindex E
12151 If any of these options is used, then the linker is not run, and
12152 object file names should not be used as arguments.  @xref{Overall
12153 Options}.
12155 @item -flinker-output=@var{type}
12156 @opindex -flinker-output
12157 This option controls the code generation of the link time optimizer.  By
12158 default the linker output is determined by the linker plugin automatically. For
12159 debugging the compiler and in the case of incremental linking to non-lto object
12160 file is desired, it may be useful to control the type manually.
12162 If @var{type} is @samp{exec} the code generation is configured to produce static
12163 binary. In this case @option{-fpic} and @option{-fpie} are both disabled.
12165 If @var{type} is @samp{dyn} the code generation is configured to produce shared
12166 library. In this case @option{-fpic} or @option{-fPIC} is preserved, but not
12167 enabled automatically.  This makes it possible to build shared libraries without
12168 position independent code on architectures this is possible, i.e. on x86.
12170 If @var{type} is @samp{pie} the code generation is configured to produce
12171 @option{-fpie} executable. This result in similar optimizations as @samp{exec}
12172 except that @option{-fpie} is not disabled if specified at compilation time.
12174 If @var{type} is @samp{rel} the compiler assumes that incremental linking is
12175 done.  The sections containing intermediate code for link-time optimization are
12176 merged, pre-optimized, and output to the resulting object file. In addition, if
12177 @option{-ffat-lto-objects} is specified the binary code is produced for future
12178 non-lto linking. The object file produced by incremental linking will be smaller
12179 than a static library produced from the same object files.  At link-time the
12180 result of incremental linking will also load faster to compiler than a static
12181 library assuming that majority of objects in the library are used.
12183 Finally @samp{nolto-rel} configure compiler to for incremental linking where
12184 code generation is forced, final binary is produced and the intermediate code
12185 for later link-time optimization is stripped. When multiple object files are
12186 linked together the resulting code will be optimized better than with link time
12187 optimizations disabled (for example, the cross-module inlining will happen),
12188 most of benefits of whole program optimizations are however lost. 
12190 During the incremental link (by @option{-r}) the linker plugin will default to
12191 @option{rel}. With current interfaces to GNU Binutils it is however not
12192 possible to link incrementally LTO objects and non-LTO objects into a single
12193 mixed object file.  In the case any of object files in incremental link can not
12194 be used for link-time optimization the linker plugin will output warning and
12195 use @samp{nolto-rel}. To maintain the whole program optimization it is
12196 recommended to link such objects into static library instead. Alternatively it
12197 is possible to use H.J. Lu's binutils with support for mixed objects.
12199 @item -fuse-ld=bfd
12200 @opindex fuse-ld=bfd
12201 Use the @command{bfd} linker instead of the default linker.
12203 @item -fuse-ld=gold
12204 @opindex fuse-ld=gold
12205 Use the @command{gold} linker instead of the default linker.
12207 @cindex Libraries
12208 @item -l@var{library}
12209 @itemx -l @var{library}
12210 @opindex l
12211 Search the library named @var{library} when linking.  (The second
12212 alternative with the library as a separate argument is only for
12213 POSIX compliance and is not recommended.)
12215 It makes a difference where in the command you write this option; the
12216 linker searches and processes libraries and object files in the order they
12217 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12218 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12219 to functions in @samp{z}, those functions may not be loaded.
12221 The linker searches a standard list of directories for the library,
12222 which is actually a file named @file{lib@var{library}.a}.  The linker
12223 then uses this file as if it had been specified precisely by name.
12225 The directories searched include several standard system directories
12226 plus any that you specify with @option{-L}.
12228 Normally the files found this way are library files---archive files
12229 whose members are object files.  The linker handles an archive file by
12230 scanning through it for members which define symbols that have so far
12231 been referenced but not defined.  But if the file that is found is an
12232 ordinary object file, it is linked in the usual fashion.  The only
12233 difference between using an @option{-l} option and specifying a file name
12234 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12235 and searches several directories.
12237 @item -lobjc
12238 @opindex lobjc
12239 You need this special case of the @option{-l} option in order to
12240 link an Objective-C or Objective-C++ program.
12242 @item -nostartfiles
12243 @opindex nostartfiles
12244 Do not use the standard system startup files when linking.
12245 The standard system libraries are used normally, unless @option{-nostdlib}
12246 or @option{-nodefaultlibs} is used.
12248 @item -nodefaultlibs
12249 @opindex nodefaultlibs
12250 Do not use the standard system libraries when linking.
12251 Only the libraries you specify are passed to the linker, and options
12252 specifying linkage of the system libraries, such as @option{-static-libgcc}
12253 or @option{-shared-libgcc}, are ignored.  
12254 The standard startup files are used normally, unless @option{-nostartfiles}
12255 is used.  
12257 The compiler may generate calls to @code{memcmp},
12258 @code{memset}, @code{memcpy} and @code{memmove}.
12259 These entries are usually resolved by entries in
12260 libc.  These entry points should be supplied through some other
12261 mechanism when this option is specified.
12263 @item -nostdlib
12264 @opindex nostdlib
12265 Do not use the standard system startup files or libraries when linking.
12266 No startup files and only the libraries you specify are passed to
12267 the linker, and options specifying linkage of the system libraries, such as
12268 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12270 The compiler may generate calls to @code{memcmp}, @code{memset},
12271 @code{memcpy} and @code{memmove}.
12272 These entries are usually resolved by entries in
12273 libc.  These entry points should be supplied through some other
12274 mechanism when this option is specified.
12276 @cindex @option{-lgcc}, use with @option{-nostdlib}
12277 @cindex @option{-nostdlib} and unresolved references
12278 @cindex unresolved references and @option{-nostdlib}
12279 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12280 @cindex @option{-nodefaultlibs} and unresolved references
12281 @cindex unresolved references and @option{-nodefaultlibs}
12282 One of the standard libraries bypassed by @option{-nostdlib} and
12283 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12284 which GCC uses to overcome shortcomings of particular machines, or special
12285 needs for some languages.
12286 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12287 Collection (GCC) Internals},
12288 for more discussion of @file{libgcc.a}.)
12289 In most cases, you need @file{libgcc.a} even when you want to avoid
12290 other standard libraries.  In other words, when you specify @option{-nostdlib}
12291 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12292 This ensures that you have no unresolved references to internal GCC
12293 library subroutines.
12294 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12295 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12296 GNU Compiler Collection (GCC) Internals}.)
12298 @item -pie
12299 @opindex pie
12300 Produce a dynamically linked position independent executable on targets
12301 that support it.  For predictable results, you must also specify the same
12302 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12303 or model suboptions) when you specify this linker option.
12305 @item -no-pie
12306 @opindex no-pie
12307 Don't produce a dynamically linked position independent executable.
12309 @item -static-pie
12310 @opindex static-pie
12311 Produce a static position independent executable on targets that support
12312 it.  A static position independent executable is similar to a static
12313 executable, but can be loaded at any address without a dynamic linker.
12314 For predictable results, you must also specify the same set of options
12315 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12316 suboptions) when you specify this linker option.
12318 @item -pthread
12319 @opindex pthread
12320 Link with the POSIX threads library.  This option is supported on 
12321 GNU/Linux targets, most other Unix derivatives, and also on 
12322 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12323 flags for the preprocessor, so it should be used consistently for both
12324 compilation and linking.
12326 @item -rdynamic
12327 @opindex rdynamic
12328 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12329 that support it. This instructs the linker to add all symbols, not
12330 only used ones, to the dynamic symbol table. This option is needed
12331 for some uses of @code{dlopen} or to allow obtaining backtraces
12332 from within a program.
12334 @item -s
12335 @opindex s
12336 Remove all symbol table and relocation information from the executable.
12338 @item -static
12339 @opindex static
12340 On systems that support dynamic linking, this overrides @option{-pie}
12341 and prevents linking with the shared libraries.  On other systems, this
12342 option has no effect.
12344 @item -shared
12345 @opindex shared
12346 Produce a shared object which can then be linked with other objects to
12347 form an executable.  Not all systems support this option.  For predictable
12348 results, you must also specify the same set of options used for compilation
12349 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12350 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12351 needs to build supplementary stub code for constructors to work.  On
12352 multi-libbed systems, @samp{gcc -shared} must select the correct support
12353 libraries to link against.  Failing to supply the correct flags may lead
12354 to subtle defects.  Supplying them in cases where they are not necessary
12355 is innocuous.}
12357 @item -shared-libgcc
12358 @itemx -static-libgcc
12359 @opindex shared-libgcc
12360 @opindex static-libgcc
12361 On systems that provide @file{libgcc} as a shared library, these options
12362 force the use of either the shared or static version, respectively.
12363 If no shared version of @file{libgcc} was built when the compiler was
12364 configured, these options have no effect.
12366 There are several situations in which an application should use the
12367 shared @file{libgcc} instead of the static version.  The most common
12368 of these is when the application wishes to throw and catch exceptions
12369 across different shared libraries.  In that case, each of the libraries
12370 as well as the application itself should use the shared @file{libgcc}.
12372 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12373  whenever you build a shared library or a main executable, because C++
12374  programs typically use exceptions, so this is the right thing to do.
12376 If, instead, you use the GCC driver to create shared libraries, you may
12377 find that they are not always linked with the shared @file{libgcc}.
12378 If GCC finds, at its configuration time, that you have a non-GNU linker
12379 or a GNU linker that does not support option @option{--eh-frame-hdr},
12380 it links the shared version of @file{libgcc} into shared libraries
12381 by default.  Otherwise, it takes advantage of the linker and optimizes
12382 away the linking with the shared version of @file{libgcc}, linking with
12383 the static version of libgcc by default.  This allows exceptions to
12384 propagate through such shared libraries, without incurring relocation
12385 costs at library load time.
12387 However, if a library or main executable is supposed to throw or catch
12388 exceptions, you must link it using the G++ driver, as appropriate
12389 for the languages used in the program, or using the option
12390 @option{-shared-libgcc}, such that it is linked with the shared
12391 @file{libgcc}.
12393 @item -static-libasan
12394 @opindex static-libasan
12395 When the @option{-fsanitize=address} option is used to link a program,
12396 the GCC driver automatically links against @option{libasan}.  If
12397 @file{libasan} is available as a shared library, and the @option{-static}
12398 option is not used, then this links against the shared version of
12399 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12400 driver to link @file{libasan} statically, without necessarily linking
12401 other libraries statically.
12403 @item -static-libtsan
12404 @opindex static-libtsan
12405 When the @option{-fsanitize=thread} option is used to link a program,
12406 the GCC driver automatically links against @option{libtsan}.  If
12407 @file{libtsan} is available as a shared library, and the @option{-static}
12408 option is not used, then this links against the shared version of
12409 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12410 driver to link @file{libtsan} statically, without necessarily linking
12411 other libraries statically.
12413 @item -static-liblsan
12414 @opindex static-liblsan
12415 When the @option{-fsanitize=leak} option is used to link a program,
12416 the GCC driver automatically links against @option{liblsan}.  If
12417 @file{liblsan} is available as a shared library, and the @option{-static}
12418 option is not used, then this links against the shared version of
12419 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12420 driver to link @file{liblsan} statically, without necessarily linking
12421 other libraries statically.
12423 @item -static-libubsan
12424 @opindex static-libubsan
12425 When the @option{-fsanitize=undefined} option is used to link a program,
12426 the GCC driver automatically links against @option{libubsan}.  If
12427 @file{libubsan} is available as a shared library, and the @option{-static}
12428 option is not used, then this links against the shared version of
12429 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12430 driver to link @file{libubsan} statically, without necessarily linking
12431 other libraries statically.
12433 @item -static-libstdc++
12434 @opindex static-libstdc++
12435 When the @command{g++} program is used to link a C++ program, it
12436 normally automatically links against @option{libstdc++}.  If
12437 @file{libstdc++} is available as a shared library, and the
12438 @option{-static} option is not used, then this links against the
12439 shared version of @file{libstdc++}.  That is normally fine.  However, it
12440 is sometimes useful to freeze the version of @file{libstdc++} used by
12441 the program without going all the way to a fully static link.  The
12442 @option{-static-libstdc++} option directs the @command{g++} driver to
12443 link @file{libstdc++} statically, without necessarily linking other
12444 libraries statically.
12446 @item -symbolic
12447 @opindex symbolic
12448 Bind references to global symbols when building a shared object.  Warn
12449 about any unresolved references (unless overridden by the link editor
12450 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12451 this option.
12453 @item -T @var{script}
12454 @opindex T
12455 @cindex linker script
12456 Use @var{script} as the linker script.  This option is supported by most
12457 systems using the GNU linker.  On some targets, such as bare-board
12458 targets without an operating system, the @option{-T} option may be required
12459 when linking to avoid references to undefined symbols.
12461 @item -Xlinker @var{option}
12462 @opindex Xlinker
12463 Pass @var{option} as an option to the linker.  You can use this to
12464 supply system-specific linker options that GCC does not recognize.
12466 If you want to pass an option that takes a separate argument, you must use
12467 @option{-Xlinker} twice, once for the option and once for the argument.
12468 For example, to pass @option{-assert definitions}, you must write
12469 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12470 @option{-Xlinker "-assert definitions"}, because this passes the entire
12471 string as a single argument, which is not what the linker expects.
12473 When using the GNU linker, it is usually more convenient to pass
12474 arguments to linker options using the @option{@var{option}=@var{value}}
12475 syntax than as separate arguments.  For example, you can specify
12476 @option{-Xlinker -Map=output.map} rather than
12477 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12478 this syntax for command-line options.
12480 @item -Wl,@var{option}
12481 @opindex Wl
12482 Pass @var{option} as an option to the linker.  If @var{option} contains
12483 commas, it is split into multiple options at the commas.  You can use this
12484 syntax to pass an argument to the option.
12485 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12486 linker.  When using the GNU linker, you can also get the same effect with
12487 @option{-Wl,-Map=output.map}.
12489 @item -u @var{symbol}
12490 @opindex u
12491 Pretend the symbol @var{symbol} is undefined, to force linking of
12492 library modules to define it.  You can use @option{-u} multiple times with
12493 different symbols to force loading of additional library modules.
12495 @item -z @var{keyword}
12496 @opindex z
12497 @option{-z} is passed directly on to the linker along with the keyword
12498 @var{keyword}. See the section in the documentation of your linker for
12499 permitted values and their meanings.
12500 @end table
12502 @node Directory Options
12503 @section Options for Directory Search
12504 @cindex directory options
12505 @cindex options, directory search
12506 @cindex search path
12508 These options specify directories to search for header files, for
12509 libraries and for parts of the compiler:
12511 @table @gcctabopt
12512 @include cppdiropts.texi
12514 @item -iplugindir=@var{dir}
12515 @opindex iplugindir=
12516 Set the directory to search for plugins that are passed
12517 by @option{-fplugin=@var{name}} instead of
12518 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12519 to be used by the user, but only passed by the driver.
12521 @item -L@var{dir}
12522 @opindex L
12523 Add directory @var{dir} to the list of directories to be searched
12524 for @option{-l}.
12526 @item -B@var{prefix}
12527 @opindex B
12528 This option specifies where to find the executables, libraries,
12529 include files, and data files of the compiler itself.
12531 The compiler driver program runs one or more of the subprograms
12532 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12533 @var{prefix} as a prefix for each program it tries to run, both with and
12534 without @samp{@var{machine}/@var{version}/} for the corresponding target
12535 machine and compiler version.
12537 For each subprogram to be run, the compiler driver first tries the
12538 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12539 is not specified, the driver tries two standard prefixes, 
12540 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12541 those results in a file name that is found, the unmodified program
12542 name is searched for using the directories specified in your
12543 @env{PATH} environment variable.
12545 The compiler checks to see if the path provided by @option{-B}
12546 refers to a directory, and if necessary it adds a directory
12547 separator character at the end of the path.
12549 @option{-B} prefixes that effectively specify directory names also apply
12550 to libraries in the linker, because the compiler translates these
12551 options into @option{-L} options for the linker.  They also apply to
12552 include files in the preprocessor, because the compiler translates these
12553 options into @option{-isystem} options for the preprocessor.  In this case,
12554 the compiler appends @samp{include} to the prefix.
12556 The runtime support file @file{libgcc.a} can also be searched for using
12557 the @option{-B} prefix, if needed.  If it is not found there, the two
12558 standard prefixes above are tried, and that is all.  The file is left
12559 out of the link if it is not found by those means.
12561 Another way to specify a prefix much like the @option{-B} prefix is to use
12562 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12563 Variables}.
12565 As a special kludge, if the path provided by @option{-B} is
12566 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12567 9, then it is replaced by @file{[dir/]include}.  This is to help
12568 with boot-strapping the compiler.
12570 @item -no-canonical-prefixes
12571 @opindex no-canonical-prefixes
12572 Do not expand any symbolic links, resolve references to @samp{/../}
12573 or @samp{/./}, or make the path absolute when generating a relative
12574 prefix.
12576 @item --sysroot=@var{dir}
12577 @opindex sysroot
12578 Use @var{dir} as the logical root directory for headers and libraries.
12579 For example, if the compiler normally searches for headers in
12580 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12581 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12583 If you use both this option and the @option{-isysroot} option, then
12584 the @option{--sysroot} option applies to libraries, but the
12585 @option{-isysroot} option applies to header files.
12587 The GNU linker (beginning with version 2.16) has the necessary support
12588 for this option.  If your linker does not support this option, the
12589 header file aspect of @option{--sysroot} still works, but the
12590 library aspect does not.
12592 @item --no-sysroot-suffix
12593 @opindex no-sysroot-suffix
12594 For some targets, a suffix is added to the root directory specified
12595 with @option{--sysroot}, depending on the other options used, so that
12596 headers may for example be found in
12597 @file{@var{dir}/@var{suffix}/usr/include} instead of
12598 @file{@var{dir}/usr/include}.  This option disables the addition of
12599 such a suffix.
12601 @end table
12603 @node Code Gen Options
12604 @section Options for Code Generation Conventions
12605 @cindex code generation conventions
12606 @cindex options, code generation
12607 @cindex run-time options
12609 These machine-independent options control the interface conventions
12610 used in code generation.
12612 Most of them have both positive and negative forms; the negative form
12613 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12614 one of the forms is listed---the one that is not the default.  You
12615 can figure out the other form by either removing @samp{no-} or adding
12618 @table @gcctabopt
12619 @item -fstack-reuse=@var{reuse-level}
12620 @opindex fstack_reuse
12621 This option controls stack space reuse for user declared local/auto variables
12622 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12623 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12624 local variables and temporaries, @samp{named_vars} enables the reuse only for
12625 user defined local variables with names, and @samp{none} disables stack reuse
12626 completely. The default value is @samp{all}. The option is needed when the
12627 program extends the lifetime of a scoped local variable or a compiler generated
12628 temporary beyond the end point defined by the language.  When a lifetime of
12629 a variable ends, and if the variable lives in memory, the optimizing compiler
12630 has the freedom to reuse its stack space with other temporaries or scoped
12631 local variables whose live range does not overlap with it. Legacy code extending
12632 local lifetime is likely to break with the stack reuse optimization.
12634 For example,
12636 @smallexample
12637    int *p;
12638    @{
12639      int local1;
12641      p = &local1;
12642      local1 = 10;
12643      ....
12644    @}
12645    @{
12646       int local2;
12647       local2 = 20;
12648       ...
12649    @}
12651    if (*p == 10)  // out of scope use of local1
12652      @{
12654      @}
12655 @end smallexample
12657 Another example:
12658 @smallexample
12660    struct A
12661    @{
12662        A(int k) : i(k), j(k) @{ @}
12663        int i;
12664        int j;
12665    @};
12667    A *ap;
12669    void foo(const A& ar)
12670    @{
12671       ap = &ar;
12672    @}
12674    void bar()
12675    @{
12676       foo(A(10)); // temp object's lifetime ends when foo returns
12678       @{
12679         A a(20);
12680         ....
12681       @}
12682       ap->i+= 10;  // ap references out of scope temp whose space
12683                    // is reused with a. What is the value of ap->i?
12684    @}
12686 @end smallexample
12688 The lifetime of a compiler generated temporary is well defined by the C++
12689 standard. When a lifetime of a temporary ends, and if the temporary lives
12690 in memory, the optimizing compiler has the freedom to reuse its stack
12691 space with other temporaries or scoped local variables whose live range
12692 does not overlap with it. However some of the legacy code relies on
12693 the behavior of older compilers in which temporaries' stack space is
12694 not reused, the aggressive stack reuse can lead to runtime errors. This
12695 option is used to control the temporary stack reuse optimization.
12697 @item -ftrapv
12698 @opindex ftrapv
12699 This option generates traps for signed overflow on addition, subtraction,
12700 multiplication operations.
12701 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12702 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12703 @option{-fwrapv} being effective.  Note that only active options override, so
12704 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12705 results in @option{-ftrapv} being effective.
12707 @item -fwrapv
12708 @opindex fwrapv
12709 This option instructs the compiler to assume that signed arithmetic
12710 overflow of addition, subtraction and multiplication wraps around
12711 using twos-complement representation.  This flag enables some optimizations
12712 and disables others.
12713 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12714 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12715 @option{-fwrapv} being effective.  Note that only active options override, so
12716 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12717 results in @option{-ftrapv} being effective.
12719 @item -fwrapv-pointer
12720 @opindex fwrapv-pointer
12721 This option instructs the compiler to assume that pointer arithmetic
12722 overflow on addition and subtraction wraps around using twos-complement
12723 representation.  This flag disables some optimizations which assume
12724 pointer overflow is invalid.
12726 @item -fstrict-overflow
12727 @opindex fstrict-overflow
12728 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12729 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12731 @item -fexceptions
12732 @opindex fexceptions
12733 Enable exception handling.  Generates extra code needed to propagate
12734 exceptions.  For some targets, this implies GCC generates frame
12735 unwind information for all functions, which can produce significant data
12736 size overhead, although it does not affect execution.  If you do not
12737 specify this option, GCC enables it by default for languages like
12738 C++ that normally require exception handling, and disables it for
12739 languages like C that do not normally require it.  However, you may need
12740 to enable this option when compiling C code that needs to interoperate
12741 properly with exception handlers written in C++.  You may also wish to
12742 disable this option if you are compiling older C++ programs that don't
12743 use exception handling.
12745 @item -fnon-call-exceptions
12746 @opindex fnon-call-exceptions
12747 Generate code that allows trapping instructions to throw exceptions.
12748 Note that this requires platform-specific runtime support that does
12749 not exist everywhere.  Moreover, it only allows @emph{trapping}
12750 instructions to throw exceptions, i.e.@: memory references or floating-point
12751 instructions.  It does not allow exceptions to be thrown from
12752 arbitrary signal handlers such as @code{SIGALRM}.
12754 @item -fdelete-dead-exceptions
12755 @opindex fdelete-dead-exceptions
12756 Consider that instructions that may throw exceptions but don't otherwise
12757 contribute to the execution of the program can be optimized away.
12758 This option is enabled by default for the Ada front end, as permitted by
12759 the Ada language specification.
12760 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12762 @item -funwind-tables
12763 @opindex funwind-tables
12764 Similar to @option{-fexceptions}, except that it just generates any needed
12765 static data, but does not affect the generated code in any other way.
12766 You normally do not need to enable this option; instead, a language processor
12767 that needs this handling enables it on your behalf.
12769 @item -fasynchronous-unwind-tables
12770 @opindex fasynchronous-unwind-tables
12771 Generate unwind table in DWARF format, if supported by target machine.  The
12772 table is exact at each instruction boundary, so it can be used for stack
12773 unwinding from asynchronous events (such as debugger or garbage collector).
12775 @item -fno-gnu-unique
12776 @opindex fno-gnu-unique
12777 On systems with recent GNU assembler and C library, the C++ compiler
12778 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12779 of template static data members and static local variables in inline
12780 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12781 is necessary to avoid problems with a library used by two different
12782 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12783 therefore disagreeing with the other one about the binding of the
12784 symbol.  But this causes @code{dlclose} to be ignored for affected
12785 DSOs; if your program relies on reinitialization of a DSO via
12786 @code{dlclose} and @code{dlopen}, you can use
12787 @option{-fno-gnu-unique}.
12789 @item -fpcc-struct-return
12790 @opindex fpcc-struct-return
12791 Return ``short'' @code{struct} and @code{union} values in memory like
12792 longer ones, rather than in registers.  This convention is less
12793 efficient, but it has the advantage of allowing intercallability between
12794 GCC-compiled files and files compiled with other compilers, particularly
12795 the Portable C Compiler (pcc).
12797 The precise convention for returning structures in memory depends
12798 on the target configuration macros.
12800 Short structures and unions are those whose size and alignment match
12801 that of some integer type.
12803 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12804 switch is not binary compatible with code compiled with the
12805 @option{-freg-struct-return} switch.
12806 Use it to conform to a non-default application binary interface.
12808 @item -freg-struct-return
12809 @opindex freg-struct-return
12810 Return @code{struct} and @code{union} values in registers when possible.
12811 This is more efficient for small structures than
12812 @option{-fpcc-struct-return}.
12814 If you specify neither @option{-fpcc-struct-return} nor
12815 @option{-freg-struct-return}, GCC defaults to whichever convention is
12816 standard for the target.  If there is no standard convention, GCC
12817 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12818 the principal compiler.  In those cases, we can choose the standard, and
12819 we chose the more efficient register return alternative.
12821 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12822 switch is not binary compatible with code compiled with the
12823 @option{-fpcc-struct-return} switch.
12824 Use it to conform to a non-default application binary interface.
12826 @item -fshort-enums
12827 @opindex fshort-enums
12828 Allocate to an @code{enum} type only as many bytes as it needs for the
12829 declared range of possible values.  Specifically, the @code{enum} type
12830 is equivalent to the smallest integer type that has enough room.
12832 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12833 code that is not binary compatible with code generated without that switch.
12834 Use it to conform to a non-default application binary interface.
12836 @item -fshort-wchar
12837 @opindex fshort-wchar
12838 Override the underlying type for @code{wchar_t} to be @code{short
12839 unsigned int} instead of the default for the target.  This option is
12840 useful for building programs to run under WINE@.
12842 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12843 code that is not binary compatible with code generated without that switch.
12844 Use it to conform to a non-default application binary interface.
12846 @item -fno-common
12847 @opindex fno-common
12848 @cindex tentative definitions
12849 In C code, this option controls the placement of global variables 
12850 defined without an initializer, known as @dfn{tentative definitions} 
12851 in the C standard.  Tentative definitions are distinct from declarations 
12852 of a variable with the @code{extern} keyword, which do not allocate storage.
12854 Unix C compilers have traditionally allocated storage for
12855 uninitialized global variables in a common block.  This allows the
12856 linker to resolve all tentative definitions of the same variable
12857 in different compilation units to the same object, or to a non-tentative
12858 definition.  
12859 This is the behavior specified by @option{-fcommon}, and is the default for 
12860 GCC on most targets.  
12861 On the other hand, this behavior is not required by ISO
12862 C, and on some targets may carry a speed or code size penalty on
12863 variable references.
12865 The @option{-fno-common} option specifies that the compiler should instead
12866 place uninitialized global variables in the data section of the object file.
12867 This inhibits the merging of tentative definitions by the linker so
12868 you get a multiple-definition error if the same 
12869 variable is defined in more than one compilation unit.
12870 Compiling with @option{-fno-common} is useful on targets for which
12871 it provides better performance, or if you wish to verify that the
12872 program will work on other systems that always treat uninitialized
12873 variable definitions this way.
12875 @item -fno-ident
12876 @opindex fno-ident
12877 Ignore the @code{#ident} directive.
12879 @item -finhibit-size-directive
12880 @opindex finhibit-size-directive
12881 Don't output a @code{.size} assembler directive, or anything else that
12882 would cause trouble if the function is split in the middle, and the
12883 two halves are placed at locations far apart in memory.  This option is
12884 used when compiling @file{crtstuff.c}; you should not need to use it
12885 for anything else.
12887 @item -fverbose-asm
12888 @opindex fverbose-asm
12889 Put extra commentary information in the generated assembly code to
12890 make it more readable.  This option is generally only of use to those
12891 who actually need to read the generated assembly code (perhaps while
12892 debugging the compiler itself).
12894 @option{-fno-verbose-asm}, the default, causes the
12895 extra information to be omitted and is useful when comparing two assembler
12896 files.
12898 The added comments include:
12900 @itemize @bullet
12902 @item
12903 information on the compiler version and command-line options,
12905 @item
12906 the source code lines associated with the assembly instructions,
12907 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12909 @item
12910 hints on which high-level expressions correspond to
12911 the various assembly instruction operands.
12913 @end itemize
12915 For example, given this C source file:
12917 @smallexample
12918 int test (int n)
12920   int i;
12921   int total = 0;
12923   for (i = 0; i < n; i++)
12924     total += i * i;
12926   return total;
12928 @end smallexample
12930 compiling to (x86_64) assembly via @option{-S} and emitting the result
12931 direct to stdout via @option{-o} @option{-}
12933 @smallexample
12934 gcc -S test.c -fverbose-asm -Os -o -
12935 @end smallexample
12937 gives output similar to this:
12939 @smallexample
12940         .file   "test.c"
12941 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12942   [...snip...]
12943 # options passed:
12944   [...snip...]
12946         .text
12947         .globl  test
12948         .type   test, @@function
12949 test:
12950 .LFB0:
12951         .cfi_startproc
12952 # test.c:4:   int total = 0;
12953         xorl    %eax, %eax      # <retval>
12954 # test.c:6:   for (i = 0; i < n; i++)
12955         xorl    %edx, %edx      # i
12956 .L2:
12957 # test.c:6:   for (i = 0; i < n; i++)
12958         cmpl    %edi, %edx      # n, i
12959         jge     .L5     #,
12960 # test.c:7:     total += i * i;
12961         movl    %edx, %ecx      # i, tmp92
12962         imull   %edx, %ecx      # i, tmp92
12963 # test.c:6:   for (i = 0; i < n; i++)
12964         incl    %edx    # i
12965 # test.c:7:     total += i * i;
12966         addl    %ecx, %eax      # tmp92, <retval>
12967         jmp     .L2     #
12968 .L5:
12969 # test.c:10: @}
12970         ret
12971         .cfi_endproc
12972 .LFE0:
12973         .size   test, .-test
12974         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12975         .section        .note.GNU-stack,"",@@progbits
12976 @end smallexample
12978 The comments are intended for humans rather than machines and hence the
12979 precise format of the comments is subject to change.
12981 @item -frecord-gcc-switches
12982 @opindex frecord-gcc-switches
12983 This switch causes the command line used to invoke the
12984 compiler to be recorded into the object file that is being created.
12985 This switch is only implemented on some targets and the exact format
12986 of the recording is target and binary file format dependent, but it
12987 usually takes the form of a section containing ASCII text.  This
12988 switch is related to the @option{-fverbose-asm} switch, but that
12989 switch only records information in the assembler output file as
12990 comments, so it never reaches the object file.
12991 See also @option{-grecord-gcc-switches} for another
12992 way of storing compiler options into the object file.
12994 @item -fpic
12995 @opindex fpic
12996 @cindex global offset table
12997 @cindex PIC
12998 Generate position-independent code (PIC) suitable for use in a shared
12999 library, if supported for the target machine.  Such code accesses all
13000 constant addresses through a global offset table (GOT)@.  The dynamic
13001 loader resolves the GOT entries when the program starts (the dynamic
13002 loader is not part of GCC; it is part of the operating system).  If
13003 the GOT size for the linked executable exceeds a machine-specific
13004 maximum size, you get an error message from the linker indicating that
13005 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13006 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13007 on the m68k and RS/6000.  The x86 has no such limit.)
13009 Position-independent code requires special support, and therefore works
13010 only on certain machines.  For the x86, GCC supports PIC for System V
13011 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13012 position-independent.
13014 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13015 are defined to 1.
13017 @item -fPIC
13018 @opindex fPIC
13019 If supported for the target machine, emit position-independent code,
13020 suitable for dynamic linking and avoiding any limit on the size of the
13021 global offset table.  This option makes a difference on AArch64, m68k,
13022 PowerPC and SPARC@.
13024 Position-independent code requires special support, and therefore works
13025 only on certain machines.
13027 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13028 are defined to 2.
13030 @item -fpie
13031 @itemx -fPIE
13032 @opindex fpie
13033 @opindex fPIE
13034 These options are similar to @option{-fpic} and @option{-fPIC}, but the
13035 generated position-independent code can be only linked into executables.
13036 Usually these options are used to compile code that will be linked using
13037 the @option{-pie} GCC option.
13039 @option{-fpie} and @option{-fPIE} both define the macros
13040 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13041 for @option{-fpie} and 2 for @option{-fPIE}.
13043 @item -fno-plt
13044 @opindex fno-plt
13045 Do not use the PLT for external function calls in position-independent code.
13046 Instead, load the callee address at call sites from the GOT and branch to it.
13047 This leads to more efficient code by eliminating PLT stubs and exposing
13048 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13049 PLT stubs expect the GOT pointer in a specific register, this gives more
13050 register allocation freedom to the compiler.
13051 Lazy binding requires use of the PLT; 
13052 with @option{-fno-plt} all external symbols are resolved at load time.
13054 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13055 through the PLT for specific external functions.
13057 In position-dependent code, a few targets also convert calls to
13058 functions that are marked to not use the PLT to use the GOT instead.
13060 @item -fno-jump-tables
13061 @opindex fno-jump-tables
13062 Do not use jump tables for switch statements even where it would be
13063 more efficient than other code generation strategies.  This option is
13064 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13065 building code that forms part of a dynamic linker and cannot
13066 reference the address of a jump table.  On some targets, jump tables
13067 do not require a GOT and this option is not needed.
13069 @item -ffixed-@var{reg}
13070 @opindex ffixed
13071 Treat the register named @var{reg} as a fixed register; generated code
13072 should never refer to it (except perhaps as a stack pointer, frame
13073 pointer or in some other fixed role).
13075 @var{reg} must be the name of a register.  The register names accepted
13076 are machine-specific and are defined in the @code{REGISTER_NAMES}
13077 macro in the machine description macro file.
13079 This flag does not have a negative form, because it specifies a
13080 three-way choice.
13082 @item -fcall-used-@var{reg}
13083 @opindex fcall-used
13084 Treat the register named @var{reg} as an allocable register that is
13085 clobbered by function calls.  It may be allocated for temporaries or
13086 variables that do not live across a call.  Functions compiled this way
13087 do not save and restore the register @var{reg}.
13089 It is an error to use this flag with the frame pointer or stack pointer.
13090 Use of this flag for other registers that have fixed pervasive roles in
13091 the machine's execution model produces disastrous results.
13093 This flag does not have a negative form, because it specifies a
13094 three-way choice.
13096 @item -fcall-saved-@var{reg}
13097 @opindex fcall-saved
13098 Treat the register named @var{reg} as an allocable register saved by
13099 functions.  It may be allocated even for temporaries or variables that
13100 live across a call.  Functions compiled this way save and restore
13101 the register @var{reg} if they use it.
13103 It is an error to use this flag with the frame pointer or stack pointer.
13104 Use of this flag for other registers that have fixed pervasive roles in
13105 the machine's execution model produces disastrous results.
13107 A different sort of disaster results from the use of this flag for
13108 a register in which function values may be returned.
13110 This flag does not have a negative form, because it specifies a
13111 three-way choice.
13113 @item -fpack-struct[=@var{n}]
13114 @opindex fpack-struct
13115 Without a value specified, pack all structure members together without
13116 holes.  When a value is specified (which must be a small power of two), pack
13117 structure members according to this value, representing the maximum
13118 alignment (that is, objects with default alignment requirements larger than
13119 this are output potentially unaligned at the next fitting location.
13121 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13122 code that is not binary compatible with code generated without that switch.
13123 Additionally, it makes the code suboptimal.
13124 Use it to conform to a non-default application binary interface.
13126 @item -fleading-underscore
13127 @opindex fleading-underscore
13128 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13129 change the way C symbols are represented in the object file.  One use
13130 is to help link with legacy assembly code.
13132 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13133 generate code that is not binary compatible with code generated without that
13134 switch.  Use it to conform to a non-default application binary interface.
13135 Not all targets provide complete support for this switch.
13137 @item -ftls-model=@var{model}
13138 @opindex ftls-model
13139 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13140 The @var{model} argument should be one of @samp{global-dynamic},
13141 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13142 Note that the choice is subject to optimization: the compiler may use
13143 a more efficient model for symbols not visible outside of the translation
13144 unit, or if @option{-fpic} is not given on the command line.
13146 The default without @option{-fpic} is @samp{initial-exec}; with
13147 @option{-fpic} the default is @samp{global-dynamic}.
13149 @item -ftrampolines
13150 @opindex ftrampolines
13151 For targets that normally need trampolines for nested functions, always
13152 generate them instead of using descriptors.  Otherwise, for targets that
13153 do not need them, like for example HP-PA or IA-64, do nothing.
13155 A trampoline is a small piece of code that is created at run time on the
13156 stack when the address of a nested function is taken, and is used to call
13157 the nested function indirectly.  Therefore, it requires the stack to be
13158 made executable in order for the program to work properly.
13160 @option{-fno-trampolines} is enabled by default on a language by language
13161 basis to let the compiler avoid generating them, if it computes that this
13162 is safe, and replace them with descriptors.  Descriptors are made up of data
13163 only, but the generated code must be prepared to deal with them.  As of this
13164 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13166 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13167 @option{-fno-trampolines} are not binary compatible if nested functions are
13168 present.  This option must therefore be used on a program-wide basis and be
13169 manipulated with extreme care.
13171 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13172 @opindex fvisibility
13173 Set the default ELF image symbol visibility to the specified option---all
13174 symbols are marked with this unless overridden within the code.
13175 Using this feature can very substantially improve linking and
13176 load times of shared object libraries, produce more optimized
13177 code, provide near-perfect API export and prevent symbol clashes.
13178 It is @strong{strongly} recommended that you use this in any shared objects
13179 you distribute.
13181 Despite the nomenclature, @samp{default} always means public; i.e.,
13182 available to be linked against from outside the shared object.
13183 @samp{protected} and @samp{internal} are pretty useless in real-world
13184 usage so the only other commonly used option is @samp{hidden}.
13185 The default if @option{-fvisibility} isn't specified is
13186 @samp{default}, i.e., make every symbol public.
13188 A good explanation of the benefits offered by ensuring ELF
13189 symbols have the correct visibility is given by ``How To Write
13190 Shared Libraries'' by Ulrich Drepper (which can be found at
13191 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13192 solution made possible by this option to marking things hidden when
13193 the default is public is to make the default hidden and mark things
13194 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13195 and @code{__attribute__ ((visibility("default")))} instead of
13196 @code{__declspec(dllexport)} you get almost identical semantics with
13197 identical syntax.  This is a great boon to those working with
13198 cross-platform projects.
13200 For those adding visibility support to existing code, you may find
13201 @code{#pragma GCC visibility} of use.  This works by you enclosing
13202 the declarations you wish to set visibility for with (for example)
13203 @code{#pragma GCC visibility push(hidden)} and
13204 @code{#pragma GCC visibility pop}.
13205 Bear in mind that symbol visibility should be viewed @strong{as
13206 part of the API interface contract} and thus all new code should
13207 always specify visibility when it is not the default; i.e., declarations
13208 only for use within the local DSO should @strong{always} be marked explicitly
13209 as hidden as so to avoid PLT indirection overheads---making this
13210 abundantly clear also aids readability and self-documentation of the code.
13211 Note that due to ISO C++ specification requirements, @code{operator new} and
13212 @code{operator delete} must always be of default visibility.
13214 Be aware that headers from outside your project, in particular system
13215 headers and headers from any other library you use, may not be
13216 expecting to be compiled with visibility other than the default.  You
13217 may need to explicitly say @code{#pragma GCC visibility push(default)}
13218 before including any such headers.
13220 @code{extern} declarations are not affected by @option{-fvisibility}, so
13221 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13222 no modifications.  However, this means that calls to @code{extern}
13223 functions with no explicit visibility use the PLT, so it is more
13224 effective to use @code{__attribute ((visibility))} and/or
13225 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13226 declarations should be treated as hidden.
13228 Note that @option{-fvisibility} does affect C++ vague linkage
13229 entities. This means that, for instance, an exception class that is
13230 be thrown between DSOs must be explicitly marked with default
13231 visibility so that the @samp{type_info} nodes are unified between
13232 the DSOs.
13234 An overview of these techniques, their benefits and how to use them
13235 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13237 @item -fstrict-volatile-bitfields
13238 @opindex fstrict-volatile-bitfields
13239 This option should be used if accesses to volatile bit-fields (or other
13240 structure fields, although the compiler usually honors those types
13241 anyway) should use a single access of the width of the
13242 field's type, aligned to a natural alignment if possible.  For
13243 example, targets with memory-mapped peripheral registers might require
13244 all such accesses to be 16 bits wide; with this flag you can
13245 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13246 is 16 bits on these targets) to force GCC to use 16-bit accesses
13247 instead of, perhaps, a more efficient 32-bit access.
13249 If this option is disabled, the compiler uses the most efficient
13250 instruction.  In the previous example, that might be a 32-bit load
13251 instruction, even though that accesses bytes that do not contain
13252 any portion of the bit-field, or memory-mapped registers unrelated to
13253 the one being updated.
13255 In some cases, such as when the @code{packed} attribute is applied to a 
13256 structure field, it may not be possible to access the field with a single
13257 read or write that is correctly aligned for the target machine.  In this
13258 case GCC falls back to generating multiple accesses rather than code that 
13259 will fault or truncate the result at run time.
13261 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13262 not allowed to touch non bit-field members.  It is therefore recommended
13263 to define all bits of the field's type as bit-field members.
13265 The default value of this option is determined by the application binary
13266 interface for the target processor.
13268 @item -fsync-libcalls
13269 @opindex fsync-libcalls
13270 This option controls whether any out-of-line instance of the @code{__sync}
13271 family of functions may be used to implement the C++11 @code{__atomic}
13272 family of functions.
13274 The default value of this option is enabled, thus the only useful form
13275 of the option is @option{-fno-sync-libcalls}.  This option is used in
13276 the implementation of the @file{libatomic} runtime library.
13278 @end table
13280 @node Developer Options
13281 @section GCC Developer Options
13282 @cindex developer options
13283 @cindex debugging GCC
13284 @cindex debug dump options
13285 @cindex dump options
13286 @cindex compilation statistics
13288 This section describes command-line options that are primarily of
13289 interest to GCC developers, including options to support compiler
13290 testing and investigation of compiler bugs and compile-time
13291 performance problems.  This includes options that produce debug dumps
13292 at various points in the compilation; that print statistics such as
13293 memory use and execution time; and that print information about GCC's
13294 configuration, such as where it searches for libraries.  You should
13295 rarely need to use any of these options for ordinary compilation and
13296 linking tasks.
13298 Many developer options that cause GCC to dump output to a file take an
13299 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
13300 or @samp{-} to dump to standard output, and @samp{stderr} for standard
13301 error.
13303 If @samp{=@var{filename}} is omitted, a default dump file name is
13304 constructed by concatenating the base dump file name, a pass number,
13305 phase letter, and pass name.  The base dump file name is the name of
13306 output file produced by the compiler if explicitly specified and not
13307 an executable; otherwise it is the source file name.
13308 The pass number is determined by the order passes are registered with
13309 the compiler's pass manager. 
13310 This is generally the same as the order of execution, but passes
13311 registered by plugins, target-specific passes, or passes that are
13312 otherwise registered late are numbered higher than the pass named
13313 @samp{final}, even if they are executed earlier.  The phase letter is
13314 one of @samp{i} (inter-procedural analysis), @samp{l}
13315 (language-specific), @samp{r} (RTL), or @samp{t} (tree). 
13316 The files are created in the directory of the output file. 
13318 @table @gcctabopt
13320 @item -d@var{letters}
13321 @itemx -fdump-rtl-@var{pass}
13322 @itemx -fdump-rtl-@var{pass}=@var{filename}
13323 @opindex d
13324 @opindex fdump-rtl-@var{pass}
13325 Says to make debugging dumps during compilation at times specified by
13326 @var{letters}.  This is used for debugging the RTL-based passes of the
13327 compiler.
13329 Some @option{-d@var{letters}} switches have different meaning when
13330 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13331 for information about preprocessor-specific dump options.
13333 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13334 @option{-d} option @var{letters}.  Here are the possible
13335 letters for use in @var{pass} and @var{letters}, and their meanings:
13337 @table @gcctabopt
13339 @item -fdump-rtl-alignments
13340 @opindex fdump-rtl-alignments
13341 Dump after branch alignments have been computed.
13343 @item -fdump-rtl-asmcons
13344 @opindex fdump-rtl-asmcons
13345 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13347 @item -fdump-rtl-auto_inc_dec
13348 @opindex fdump-rtl-auto_inc_dec
13349 Dump after auto-inc-dec discovery.  This pass is only run on
13350 architectures that have auto inc or auto dec instructions.
13352 @item -fdump-rtl-barriers
13353 @opindex fdump-rtl-barriers
13354 Dump after cleaning up the barrier instructions.
13356 @item -fdump-rtl-bbpart
13357 @opindex fdump-rtl-bbpart
13358 Dump after partitioning hot and cold basic blocks.
13360 @item -fdump-rtl-bbro
13361 @opindex fdump-rtl-bbro
13362 Dump after block reordering.
13364 @item -fdump-rtl-btl1
13365 @itemx -fdump-rtl-btl2
13366 @opindex fdump-rtl-btl2
13367 @opindex fdump-rtl-btl2
13368 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13369 after the two branch
13370 target load optimization passes.
13372 @item -fdump-rtl-bypass
13373 @opindex fdump-rtl-bypass
13374 Dump after jump bypassing and control flow optimizations.
13376 @item -fdump-rtl-combine
13377 @opindex fdump-rtl-combine
13378 Dump after the RTL instruction combination pass.
13380 @item -fdump-rtl-compgotos
13381 @opindex fdump-rtl-compgotos
13382 Dump after duplicating the computed gotos.
13384 @item -fdump-rtl-ce1
13385 @itemx -fdump-rtl-ce2
13386 @itemx -fdump-rtl-ce3
13387 @opindex fdump-rtl-ce1
13388 @opindex fdump-rtl-ce2
13389 @opindex fdump-rtl-ce3
13390 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13391 @option{-fdump-rtl-ce3} enable dumping after the three
13392 if conversion passes.
13394 @item -fdump-rtl-cprop_hardreg
13395 @opindex fdump-rtl-cprop_hardreg
13396 Dump after hard register copy propagation.
13398 @item -fdump-rtl-csa
13399 @opindex fdump-rtl-csa
13400 Dump after combining stack adjustments.
13402 @item -fdump-rtl-cse1
13403 @itemx -fdump-rtl-cse2
13404 @opindex fdump-rtl-cse1
13405 @opindex fdump-rtl-cse2
13406 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13407 the two common subexpression elimination passes.
13409 @item -fdump-rtl-dce
13410 @opindex fdump-rtl-dce
13411 Dump after the standalone dead code elimination passes.
13413 @item -fdump-rtl-dbr
13414 @opindex fdump-rtl-dbr
13415 Dump after delayed branch scheduling.
13417 @item -fdump-rtl-dce1
13418 @itemx -fdump-rtl-dce2
13419 @opindex fdump-rtl-dce1
13420 @opindex fdump-rtl-dce2
13421 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13422 the two dead store elimination passes.
13424 @item -fdump-rtl-eh
13425 @opindex fdump-rtl-eh
13426 Dump after finalization of EH handling code.
13428 @item -fdump-rtl-eh_ranges
13429 @opindex fdump-rtl-eh_ranges
13430 Dump after conversion of EH handling range regions.
13432 @item -fdump-rtl-expand
13433 @opindex fdump-rtl-expand
13434 Dump after RTL generation.
13436 @item -fdump-rtl-fwprop1
13437 @itemx -fdump-rtl-fwprop2
13438 @opindex fdump-rtl-fwprop1
13439 @opindex fdump-rtl-fwprop2
13440 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13441 dumping after the two forward propagation passes.
13443 @item -fdump-rtl-gcse1
13444 @itemx -fdump-rtl-gcse2
13445 @opindex fdump-rtl-gcse1
13446 @opindex fdump-rtl-gcse2
13447 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13448 after global common subexpression elimination.
13450 @item -fdump-rtl-init-regs
13451 @opindex fdump-rtl-init-regs
13452 Dump after the initialization of the registers.
13454 @item -fdump-rtl-initvals
13455 @opindex fdump-rtl-initvals
13456 Dump after the computation of the initial value sets.
13458 @item -fdump-rtl-into_cfglayout
13459 @opindex fdump-rtl-into_cfglayout
13460 Dump after converting to cfglayout mode.
13462 @item -fdump-rtl-ira
13463 @opindex fdump-rtl-ira
13464 Dump after iterated register allocation.
13466 @item -fdump-rtl-jump
13467 @opindex fdump-rtl-jump
13468 Dump after the second jump optimization.
13470 @item -fdump-rtl-loop2
13471 @opindex fdump-rtl-loop2
13472 @option{-fdump-rtl-loop2} enables dumping after the rtl
13473 loop optimization passes.
13475 @item -fdump-rtl-mach
13476 @opindex fdump-rtl-mach
13477 Dump after performing the machine dependent reorganization pass, if that
13478 pass exists.
13480 @item -fdump-rtl-mode_sw
13481 @opindex fdump-rtl-mode_sw
13482 Dump after removing redundant mode switches.
13484 @item -fdump-rtl-rnreg
13485 @opindex fdump-rtl-rnreg
13486 Dump after register renumbering.
13488 @item -fdump-rtl-outof_cfglayout
13489 @opindex fdump-rtl-outof_cfglayout
13490 Dump after converting from cfglayout mode.
13492 @item -fdump-rtl-peephole2
13493 @opindex fdump-rtl-peephole2
13494 Dump after the peephole pass.
13496 @item -fdump-rtl-postreload
13497 @opindex fdump-rtl-postreload
13498 Dump after post-reload optimizations.
13500 @item -fdump-rtl-pro_and_epilogue
13501 @opindex fdump-rtl-pro_and_epilogue
13502 Dump after generating the function prologues and epilogues.
13504 @item -fdump-rtl-sched1
13505 @itemx -fdump-rtl-sched2
13506 @opindex fdump-rtl-sched1
13507 @opindex fdump-rtl-sched2
13508 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13509 after the basic block scheduling passes.
13511 @item -fdump-rtl-ree
13512 @opindex fdump-rtl-ree
13513 Dump after sign/zero extension elimination.
13515 @item -fdump-rtl-seqabstr
13516 @opindex fdump-rtl-seqabstr
13517 Dump after common sequence discovery.
13519 @item -fdump-rtl-shorten
13520 @opindex fdump-rtl-shorten
13521 Dump after shortening branches.
13523 @item -fdump-rtl-sibling
13524 @opindex fdump-rtl-sibling
13525 Dump after sibling call optimizations.
13527 @item -fdump-rtl-split1
13528 @itemx -fdump-rtl-split2
13529 @itemx -fdump-rtl-split3
13530 @itemx -fdump-rtl-split4
13531 @itemx -fdump-rtl-split5
13532 @opindex fdump-rtl-split1
13533 @opindex fdump-rtl-split2
13534 @opindex fdump-rtl-split3
13535 @opindex fdump-rtl-split4
13536 @opindex fdump-rtl-split5
13537 These options enable dumping after five rounds of
13538 instruction splitting.
13540 @item -fdump-rtl-sms
13541 @opindex fdump-rtl-sms
13542 Dump after modulo scheduling.  This pass is only run on some
13543 architectures.
13545 @item -fdump-rtl-stack
13546 @opindex fdump-rtl-stack
13547 Dump after conversion from GCC's ``flat register file'' registers to the
13548 x87's stack-like registers.  This pass is only run on x86 variants.
13550 @item -fdump-rtl-subreg1
13551 @itemx -fdump-rtl-subreg2
13552 @opindex fdump-rtl-subreg1
13553 @opindex fdump-rtl-subreg2
13554 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13555 the two subreg expansion passes.
13557 @item -fdump-rtl-unshare
13558 @opindex fdump-rtl-unshare
13559 Dump after all rtl has been unshared.
13561 @item -fdump-rtl-vartrack
13562 @opindex fdump-rtl-vartrack
13563 Dump after variable tracking.
13565 @item -fdump-rtl-vregs
13566 @opindex fdump-rtl-vregs
13567 Dump after converting virtual registers to hard registers.
13569 @item -fdump-rtl-web
13570 @opindex fdump-rtl-web
13571 Dump after live range splitting.
13573 @item -fdump-rtl-regclass
13574 @itemx -fdump-rtl-subregs_of_mode_init
13575 @itemx -fdump-rtl-subregs_of_mode_finish
13576 @itemx -fdump-rtl-dfinit
13577 @itemx -fdump-rtl-dfinish
13578 @opindex fdump-rtl-regclass
13579 @opindex fdump-rtl-subregs_of_mode_init
13580 @opindex fdump-rtl-subregs_of_mode_finish
13581 @opindex fdump-rtl-dfinit
13582 @opindex fdump-rtl-dfinish
13583 These dumps are defined but always produce empty files.
13585 @item -da
13586 @itemx -fdump-rtl-all
13587 @opindex da
13588 @opindex fdump-rtl-all
13589 Produce all the dumps listed above.
13591 @item -dA
13592 @opindex dA
13593 Annotate the assembler output with miscellaneous debugging information.
13595 @item -dD
13596 @opindex dD
13597 Dump all macro definitions, at the end of preprocessing, in addition to
13598 normal output.
13600 @item -dH
13601 @opindex dH
13602 Produce a core dump whenever an error occurs.
13604 @item -dp
13605 @opindex dp
13606 Annotate the assembler output with a comment indicating which
13607 pattern and alternative is used.  The length and cost of each instruction are
13608 also printed.
13610 @item -dP
13611 @opindex dP
13612 Dump the RTL in the assembler output as a comment before each instruction.
13613 Also turns on @option{-dp} annotation.
13615 @item -dx
13616 @opindex dx
13617 Just generate RTL for a function instead of compiling it.  Usually used
13618 with @option{-fdump-rtl-expand}.
13619 @end table
13621 @item -fdump-noaddr
13622 @opindex fdump-noaddr
13623 When doing debugging dumps, suppress address output.  This makes it more
13624 feasible to use diff on debugging dumps for compiler invocations with
13625 different compiler binaries and/or different
13626 text / bss / data / heap / stack / dso start locations.
13628 @item -freport-bug
13629 @opindex freport-bug
13630 Collect and dump debug information into a temporary file if an
13631 internal compiler error (ICE) occurs.
13633 @item -fdump-unnumbered
13634 @opindex fdump-unnumbered
13635 When doing debugging dumps, suppress instruction numbers and address output.
13636 This makes it more feasible to use diff on debugging dumps for compiler
13637 invocations with different options, in particular with and without
13638 @option{-g}.
13640 @item -fdump-unnumbered-links
13641 @opindex fdump-unnumbered-links
13642 When doing debugging dumps (see @option{-d} option above), suppress
13643 instruction numbers for the links to the previous and next instructions
13644 in a sequence.
13646 @item -fdump-ipa-@var{switch}
13647 @opindex fdump-ipa
13648 Control the dumping at various stages of inter-procedural analysis
13649 language tree to a file.  The file name is generated by appending a
13650 switch specific suffix to the source file name, and the file is created
13651 in the same directory as the output file.  The following dumps are
13652 possible:
13654 @table @samp
13655 @item all
13656 Enables all inter-procedural analysis dumps.
13658 @item cgraph
13659 Dumps information about call-graph optimization, unused function removal,
13660 and inlining decisions.
13662 @item inline
13663 Dump after function inlining.
13665 @end table
13667 @item -fdump-lang-all
13668 @itemx -fdump-lang-@var{switch}
13669 @itemx -fdump-lang-@var{switch}-@var{options}
13670 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13671 @opindex fdump-lang-all
13672 @opindex fdump-lang
13673 Control the dumping of language-specific information.  The @var{options}
13674 and @var{filename} portions behave as described in the
13675 @option{-fdump-tree} option.  The following @var{switch} values are
13676 accepted:
13678 @table @samp
13679 @item all
13681 Enable all language-specific dumps.
13683 @item class
13684 Dump class hierarchy information.  Virtual table information is emitted
13685 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13687 @item raw
13688 Dump the raw internal tree data.  This option is applicable to C++ only.
13690 @end table
13692 @item -fdump-passes
13693 @opindex fdump-passes
13694 Print on @file{stderr} the list of optimization passes that are turned
13695 on and off by the current command-line options.
13697 @item -fdump-statistics-@var{option}
13698 @opindex fdump-statistics
13699 Enable and control dumping of pass statistics in a separate file.  The
13700 file name is generated by appending a suffix ending in
13701 @samp{.statistics} to the source file name, and the file is created in
13702 the same directory as the output file.  If the @samp{-@var{option}}
13703 form is used, @samp{-stats} causes counters to be summed over the
13704 whole compilation unit while @samp{-details} dumps every event as
13705 the passes generate them.  The default with no option is to sum
13706 counters for each function compiled.
13708 @item -fdump-tree-all
13709 @itemx -fdump-tree-@var{switch}
13710 @itemx -fdump-tree-@var{switch}-@var{options}
13711 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13712 @opindex fdump-tree-all
13713 @opindex fdump-tree
13714 Control the dumping at various stages of processing the intermediate
13715 language tree to a file.  If the @samp{-@var{options}}
13716 form is used, @var{options} is a list of @samp{-} separated options
13717 which control the details of the dump.  Not all options are applicable
13718 to all dumps; those that are not meaningful are ignored.  The
13719 following options are available
13721 @table @samp
13722 @item address
13723 Print the address of each node.  Usually this is not meaningful as it
13724 changes according to the environment and source file.  Its primary use
13725 is for tying up a dump file with a debug environment.
13726 @item asmname
13727 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13728 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13729 use working backward from mangled names in the assembly file.
13730 @item slim
13731 When dumping front-end intermediate representations, inhibit dumping
13732 of members of a scope or body of a function merely because that scope
13733 has been reached.  Only dump such items when they are directly reachable
13734 by some other path.
13736 When dumping pretty-printed trees, this option inhibits dumping the
13737 bodies of control structures.
13739 When dumping RTL, print the RTL in slim (condensed) form instead of
13740 the default LISP-like representation.
13741 @item raw
13742 Print a raw representation of the tree.  By default, trees are
13743 pretty-printed into a C-like representation.
13744 @item details
13745 Enable more detailed dumps (not honored by every dump option). Also
13746 include information from the optimization passes.
13747 @item stats
13748 Enable dumping various statistics about the pass (not honored by every dump
13749 option).
13750 @item blocks
13751 Enable showing basic block boundaries (disabled in raw dumps).
13752 @item graph
13753 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13754 dump a representation of the control flow graph suitable for viewing with
13755 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13756 the file is pretty-printed as a subgraph, so that GraphViz can render them
13757 all in a single plot.
13759 This option currently only works for RTL dumps, and the RTL is always
13760 dumped in slim form.
13761 @item vops
13762 Enable showing virtual operands for every statement.
13763 @item lineno
13764 Enable showing line numbers for statements.
13765 @item uid
13766 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13767 @item verbose
13768 Enable showing the tree dump for each statement.
13769 @item eh
13770 Enable showing the EH region number holding each statement.
13771 @item scev
13772 Enable showing scalar evolution analysis details.
13773 @item optimized
13774 Enable showing optimization information (only available in certain
13775 passes).
13776 @item missed
13777 Enable showing missed optimization information (only available in certain
13778 passes).
13779 @item note
13780 Enable other detailed optimization information (only available in
13781 certain passes).
13782 @item all
13783 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13784 and @option{lineno}.
13785 @item optall
13786 Turn on all optimization options, i.e., @option{optimized},
13787 @option{missed}, and @option{note}.
13788 @end table
13790 To determine what tree dumps are available or find the dump for a pass
13791 of interest follow the steps below.
13793 @enumerate
13794 @item
13795 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13796 look for a code that corresponds to the pass you are interested in.
13797 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13798 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13799 The number at the end distinguishes distinct invocations of the same pass.
13800 @item
13801 To enable the creation of the dump file, append the pass code to
13802 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13803 to enable the dump from the Early Value Range Propagation pass, invoke
13804 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13805 specify the name of the dump file.  If you don't specify one, GCC
13806 creates as described below.
13807 @item
13808 Find the pass dump in a file whose name is composed of three components
13809 separated by a period: the name of the source file GCC was invoked to
13810 compile, a numeric suffix indicating the pass number followed by the
13811 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13812 and finally the pass code.  For example, the Early VRP pass dump might
13813 be in a file named @file{myfile.c.038t.evrp} in the current working
13814 directory.  Note that the numeric codes are not stable and may change
13815 from one version of GCC to another.
13816 @end enumerate
13818 @item -fopt-info
13819 @itemx -fopt-info-@var{options}
13820 @itemx -fopt-info-@var{options}=@var{filename}
13821 @opindex fopt-info
13822 Controls optimization dumps from various optimization passes. If the
13823 @samp{-@var{options}} form is used, @var{options} is a list of
13824 @samp{-} separated option keywords to select the dump details and
13825 optimizations.  
13827 The @var{options} can be divided into two groups: options describing the
13828 verbosity of the dump, and options describing which optimizations
13829 should be included. The options from both the groups can be freely
13830 mixed as they are non-overlapping. However, in case of any conflicts,
13831 the later options override the earlier options on the command
13832 line. 
13834 The following options control the dump verbosity:
13836 @table @samp
13837 @item optimized
13838 Print information when an optimization is successfully applied. It is
13839 up to a pass to decide which information is relevant. For example, the
13840 vectorizer passes print the source location of loops which are
13841 successfully vectorized.
13842 @item missed
13843 Print information about missed optimizations. Individual passes
13844 control which information to include in the output. 
13845 @item note
13846 Print verbose information about optimizations, such as certain
13847 transformations, more detailed messages about decisions etc.
13848 @item all
13849 Print detailed optimization information. This includes
13850 @samp{optimized}, @samp{missed}, and @samp{note}.
13851 @end table
13853 One or more of the following option keywords can be used to describe a
13854 group of optimizations:
13856 @table @samp
13857 @item ipa
13858 Enable dumps from all interprocedural optimizations.
13859 @item loop
13860 Enable dumps from all loop optimizations.
13861 @item inline
13862 Enable dumps from all inlining optimizations.
13863 @item omp
13864 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13865 @item vec
13866 Enable dumps from all vectorization optimizations.
13867 @item optall
13868 Enable dumps from all optimizations. This is a superset of
13869 the optimization groups listed above.
13870 @end table
13872 If @var{options} is
13873 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13874 info about successful optimizations from all the passes.  
13876 If the @var{filename} is provided, then the dumps from all the
13877 applicable optimizations are concatenated into the @var{filename}.
13878 Otherwise the dump is output onto @file{stderr}. Though multiple
13879 @option{-fopt-info} options are accepted, only one of them can include
13880 a @var{filename}. If other filenames are provided then all but the
13881 first such option are ignored.
13883 Note that the output @var{filename} is overwritten
13884 in case of multiple translation units. If a combined output from
13885 multiple translation units is desired, @file{stderr} should be used
13886 instead.
13888 In the following example, the optimization info is output to
13889 @file{stderr}:
13891 @smallexample
13892 gcc -O3 -fopt-info
13893 @end smallexample
13895 This example:
13896 @smallexample
13897 gcc -O3 -fopt-info-missed=missed.all
13898 @end smallexample
13900 @noindent
13901 outputs missed optimization report from all the passes into
13902 @file{missed.all}, and this one:
13904 @smallexample
13905 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13906 @end smallexample
13908 @noindent
13909 prints information about missed optimization opportunities from
13910 vectorization passes on @file{stderr}.  
13911 Note that @option{-fopt-info-vec-missed} is equivalent to 
13912 @option{-fopt-info-missed-vec}.  The order of the optimization group
13913 names and message types listed after @option{-fopt-info} does not matter.
13915 As another example,
13916 @smallexample
13917 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13918 @end smallexample
13920 @noindent
13921 outputs information about missed optimizations as well as
13922 optimized locations from all the inlining passes into
13923 @file{inline.txt}.
13925 Finally, consider:
13927 @smallexample
13928 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13929 @end smallexample
13931 @noindent
13932 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13933 in conflict since only one output file is allowed. In this case, only
13934 the first option takes effect and the subsequent options are
13935 ignored. Thus only @file{vec.miss} is produced which contains
13936 dumps from the vectorizer about missed opportunities.
13938 @item -fsched-verbose=@var{n}
13939 @opindex fsched-verbose
13940 On targets that use instruction scheduling, this option controls the
13941 amount of debugging output the scheduler prints to the dump files.
13943 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13944 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13945 For @var{n} greater than one, it also output basic block probabilities,
13946 detailed ready list information and unit/insn info.  For @var{n} greater
13947 than two, it includes RTL at abort point, control-flow and regions info.
13948 And for @var{n} over four, @option{-fsched-verbose} also includes
13949 dependence info.
13953 @item -fenable-@var{kind}-@var{pass}
13954 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13955 @opindex fdisable-
13956 @opindex fenable-
13958 This is a set of options that are used to explicitly disable/enable
13959 optimization passes.  These options are intended for use for debugging GCC.
13960 Compiler users should use regular options for enabling/disabling
13961 passes instead.
13963 @table @gcctabopt
13965 @item -fdisable-ipa-@var{pass}
13966 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13967 statically invoked in the compiler multiple times, the pass name should be
13968 appended with a sequential number starting from 1.
13970 @item -fdisable-rtl-@var{pass}
13971 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13972 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13973 statically invoked in the compiler multiple times, the pass name should be
13974 appended with a sequential number starting from 1.  @var{range-list} is a 
13975 comma-separated list of function ranges or assembler names.  Each range is a number
13976 pair separated by a colon.  The range is inclusive in both ends.  If the range
13977 is trivial, the number pair can be simplified as a single number.  If the
13978 function's call graph node's @var{uid} falls within one of the specified ranges,
13979 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13980 function header of a dump file, and the pass names can be dumped by using
13981 option @option{-fdump-passes}.
13983 @item -fdisable-tree-@var{pass}
13984 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13985 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13986 option arguments.
13988 @item -fenable-ipa-@var{pass}
13989 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13990 statically invoked in the compiler multiple times, the pass name should be
13991 appended with a sequential number starting from 1.
13993 @item -fenable-rtl-@var{pass}
13994 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13995 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13996 description and examples.
13998 @item -fenable-tree-@var{pass}
13999 @itemx -fenable-tree-@var{pass}=@var{range-list}
14000 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14001 of option arguments.
14003 @end table
14005 Here are some examples showing uses of these options.
14007 @smallexample
14009 # disable ccp1 for all functions
14010    -fdisable-tree-ccp1
14011 # disable complete unroll for function whose cgraph node uid is 1
14012    -fenable-tree-cunroll=1
14013 # disable gcse2 for functions at the following ranges [1,1],
14014 # [300,400], and [400,1000]
14015 # disable gcse2 for functions foo and foo2
14016    -fdisable-rtl-gcse2=foo,foo2
14017 # disable early inlining
14018    -fdisable-tree-einline
14019 # disable ipa inlining
14020    -fdisable-ipa-inline
14021 # enable tree full unroll
14022    -fenable-tree-unroll
14024 @end smallexample
14026 @item -fchecking
14027 @itemx -fchecking=@var{n}
14028 @opindex fchecking
14029 @opindex fno-checking
14030 Enable internal consistency checking.  The default depends on
14031 the compiler configuration.  @option{-fchecking=2} enables further
14032 internal consistency checking that might affect code generation.
14034 @item -frandom-seed=@var{string}
14035 @opindex frandom-seed
14036 This option provides a seed that GCC uses in place of
14037 random numbers in generating certain symbol names
14038 that have to be different in every compiled file.  It is also used to
14039 place unique stamps in coverage data files and the object files that
14040 produce them.  You can use the @option{-frandom-seed} option to produce
14041 reproducibly identical object files.
14043 The @var{string} can either be a number (decimal, octal or hex) or an
14044 arbitrary string (in which case it's converted to a number by
14045 computing CRC32).
14047 The @var{string} should be different for every file you compile.
14049 @item -save-temps
14050 @itemx -save-temps=cwd
14051 @opindex save-temps
14052 Store the usual ``temporary'' intermediate files permanently; place them
14053 in the current directory and name them based on the source file.  Thus,
14054 compiling @file{foo.c} with @option{-c -save-temps} produces files
14055 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14056 preprocessed @file{foo.i} output file even though the compiler now
14057 normally uses an integrated preprocessor.
14059 When used in combination with the @option{-x} command-line option,
14060 @option{-save-temps} is sensible enough to avoid over writing an
14061 input source file with the same extension as an intermediate file.
14062 The corresponding intermediate file may be obtained by renaming the
14063 source file before using @option{-save-temps}.
14065 If you invoke GCC in parallel, compiling several different source
14066 files that share a common base name in different subdirectories or the
14067 same source file compiled for multiple output destinations, it is
14068 likely that the different parallel compilers will interfere with each
14069 other, and overwrite the temporary files.  For instance:
14071 @smallexample
14072 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14073 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14074 @end smallexample
14076 may result in @file{foo.i} and @file{foo.o} being written to
14077 simultaneously by both compilers.
14079 @item -save-temps=obj
14080 @opindex save-temps=obj
14081 Store the usual ``temporary'' intermediate files permanently.  If the
14082 @option{-o} option is used, the temporary files are based on the
14083 object file.  If the @option{-o} option is not used, the
14084 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14086 For example:
14088 @smallexample
14089 gcc -save-temps=obj -c foo.c
14090 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14091 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14092 @end smallexample
14094 @noindent
14095 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14096 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14097 @file{dir2/yfoobar.o}.
14099 @item -time@r{[}=@var{file}@r{]}
14100 @opindex time
14101 Report the CPU time taken by each subprocess in the compilation
14102 sequence.  For C source files, this is the compiler proper and assembler
14103 (plus the linker if linking is done).
14105 Without the specification of an output file, the output looks like this:
14107 @smallexample
14108 # cc1 0.12 0.01
14109 # as 0.00 0.01
14110 @end smallexample
14112 The first number on each line is the ``user time'', that is time spent
14113 executing the program itself.  The second number is ``system time'',
14114 time spent executing operating system routines on behalf of the program.
14115 Both numbers are in seconds.
14117 With the specification of an output file, the output is appended to the
14118 named file, and it looks like this:
14120 @smallexample
14121 0.12 0.01 cc1 @var{options}
14122 0.00 0.01 as @var{options}
14123 @end smallexample
14125 The ``user time'' and the ``system time'' are moved before the program
14126 name, and the options passed to the program are displayed, so that one
14127 can later tell what file was being compiled, and with which options.
14129 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14130 @opindex fdump-final-insns
14131 Dump the final internal representation (RTL) to @var{file}.  If the
14132 optional argument is omitted (or if @var{file} is @code{.}), the name
14133 of the dump file is determined by appending @code{.gkd} to the
14134 compilation output file name.
14136 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14137 @opindex fcompare-debug
14138 @opindex fno-compare-debug
14139 If no error occurs during compilation, run the compiler a second time,
14140 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14141 passed to the second compilation.  Dump the final internal
14142 representation in both compilations, and print an error if they differ.
14144 If the equal sign is omitted, the default @option{-gtoggle} is used.
14146 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14147 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14148 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14149 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14150 is used.
14152 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14153 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14154 of the final representation and the second compilation, preventing even
14155 @env{GCC_COMPARE_DEBUG} from taking effect.
14157 To verify full coverage during @option{-fcompare-debug} testing, set
14158 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14159 which GCC rejects as an invalid option in any actual compilation
14160 (rather than preprocessing, assembly or linking).  To get just a
14161 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14162 not overridden} will do.
14164 @item -fcompare-debug-second
14165 @opindex fcompare-debug-second
14166 This option is implicitly passed to the compiler for the second
14167 compilation requested by @option{-fcompare-debug}, along with options to
14168 silence warnings, and omitting other options that would cause the compiler
14169 to produce output to files or to standard output as a side effect.  Dump
14170 files and preserved temporary files are renamed so as to contain the
14171 @code{.gk} additional extension during the second compilation, to avoid
14172 overwriting those generated by the first.
14174 When this option is passed to the compiler driver, it causes the
14175 @emph{first} compilation to be skipped, which makes it useful for little
14176 other than debugging the compiler proper.
14178 @item -gtoggle
14179 @opindex gtoggle
14180 Turn off generation of debug info, if leaving out this option
14181 generates it, or turn it on at level 2 otherwise.  The position of this
14182 argument in the command line does not matter; it takes effect after all
14183 other options are processed, and it does so only once, no matter how
14184 many times it is given.  This is mainly intended to be used with
14185 @option{-fcompare-debug}.
14187 @item -fvar-tracking-assignments-toggle
14188 @opindex fvar-tracking-assignments-toggle
14189 @opindex fno-var-tracking-assignments-toggle
14190 Toggle @option{-fvar-tracking-assignments}, in the same way that
14191 @option{-gtoggle} toggles @option{-g}.
14193 @item -Q
14194 @opindex Q
14195 Makes the compiler print out each function name as it is compiled, and
14196 print some statistics about each pass when it finishes.
14198 @item -ftime-report
14199 @opindex ftime-report
14200 Makes the compiler print some statistics about the time consumed by each
14201 pass when it finishes.
14203 @item -ftime-report-details
14204 @opindex ftime-report-details
14205 Record the time consumed by infrastructure parts separately for each pass.
14207 @item -fira-verbose=@var{n}
14208 @opindex fira-verbose
14209 Control the verbosity of the dump file for the integrated register allocator.
14210 The default value is 5.  If the value @var{n} is greater or equal to 10,
14211 the dump output is sent to stderr using the same format as @var{n} minus 10.
14213 @item -flto-report
14214 @opindex flto-report
14215 Prints a report with internal details on the workings of the link-time
14216 optimizer.  The contents of this report vary from version to version.
14217 It is meant to be useful to GCC developers when processing object
14218 files in LTO mode (via @option{-flto}).
14220 Disabled by default.
14222 @item -flto-report-wpa
14223 @opindex flto-report-wpa
14224 Like @option{-flto-report}, but only print for the WPA phase of Link
14225 Time Optimization.
14227 @item -fmem-report
14228 @opindex fmem-report
14229 Makes the compiler print some statistics about permanent memory
14230 allocation when it finishes.
14232 @item -fmem-report-wpa
14233 @opindex fmem-report-wpa
14234 Makes the compiler print some statistics about permanent memory
14235 allocation for the WPA phase only.
14237 @item -fpre-ipa-mem-report
14238 @opindex fpre-ipa-mem-report
14239 @item -fpost-ipa-mem-report
14240 @opindex fpost-ipa-mem-report
14241 Makes the compiler print some statistics about permanent memory
14242 allocation before or after interprocedural optimization.
14244 @item -fprofile-report
14245 @opindex fprofile-report
14246 Makes the compiler print some statistics about consistency of the
14247 (estimated) profile and effect of individual passes.
14249 @item -fstack-usage
14250 @opindex fstack-usage
14251 Makes the compiler output stack usage information for the program, on a
14252 per-function basis.  The filename for the dump is made by appending
14253 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14254 the output file, if explicitly specified and it is not an executable,
14255 otherwise it is the basename of the source file.  An entry is made up
14256 of three fields:
14258 @itemize
14259 @item
14260 The name of the function.
14261 @item
14262 A number of bytes.
14263 @item
14264 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14265 @end itemize
14267 The qualifier @code{static} means that the function manipulates the stack
14268 statically: a fixed number of bytes are allocated for the frame on function
14269 entry and released on function exit; no stack adjustments are otherwise made
14270 in the function.  The second field is this fixed number of bytes.
14272 The qualifier @code{dynamic} means that the function manipulates the stack
14273 dynamically: in addition to the static allocation described above, stack
14274 adjustments are made in the body of the function, for example to push/pop
14275 arguments around function calls.  If the qualifier @code{bounded} is also
14276 present, the amount of these adjustments is bounded at compile time and
14277 the second field is an upper bound of the total amount of stack used by
14278 the function.  If it is not present, the amount of these adjustments is
14279 not bounded at compile time and the second field only represents the
14280 bounded part.
14282 @item -fstats
14283 @opindex fstats
14284 Emit statistics about front-end processing at the end of the compilation.
14285 This option is supported only by the C++ front end, and
14286 the information is generally only useful to the G++ development team.
14288 @item -fdbg-cnt-list
14289 @opindex fdbg-cnt-list
14290 Print the name and the counter upper bound for all debug counters.
14293 @item -fdbg-cnt=@var{counter-value-list}
14294 @opindex fdbg-cnt
14295 Set the internal debug counter lower and upper bound.  @var{counter-value-list}
14296 is a comma-separated list of @var{name}:@var{lower_bound}:@var{upper_bound}
14297 tuples which sets the lower and the upper bound of each debug
14298 counter @var{name}.  The @var{lower_bound} is optional and is zero
14299 initialized if not set.
14300 All debug counters have the initial upper bound of @code{UINT_MAX};
14301 thus @code{dbg_cnt} returns true always unless the upper bound
14302 is set by this option.
14303 For example, with @option{-fdbg-cnt=dce:2:4,tail_call:10},
14304 @code{dbg_cnt(dce)} returns true only for third and fourth invocation.
14305 For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
14307 @item -print-file-name=@var{library}
14308 @opindex print-file-name
14309 Print the full absolute name of the library file @var{library} that
14310 would be used when linking---and don't do anything else.  With this
14311 option, GCC does not compile or link anything; it just prints the
14312 file name.
14314 @item -print-multi-directory
14315 @opindex print-multi-directory
14316 Print the directory name corresponding to the multilib selected by any
14317 other switches present in the command line.  This directory is supposed
14318 to exist in @env{GCC_EXEC_PREFIX}.
14320 @item -print-multi-lib
14321 @opindex print-multi-lib
14322 Print the mapping from multilib directory names to compiler switches
14323 that enable them.  The directory name is separated from the switches by
14324 @samp{;}, and each switch starts with an @samp{@@} instead of the
14325 @samp{-}, without spaces between multiple switches.  This is supposed to
14326 ease shell processing.
14328 @item -print-multi-os-directory
14329 @opindex print-multi-os-directory
14330 Print the path to OS libraries for the selected
14331 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14332 present in the @file{lib} subdirectory and no multilibs are used, this is
14333 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14334 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14335 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14336 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14338 @item -print-multiarch
14339 @opindex print-multiarch
14340 Print the path to OS libraries for the selected multiarch,
14341 relative to some @file{lib} subdirectory.
14343 @item -print-prog-name=@var{program}
14344 @opindex print-prog-name
14345 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14347 @item -print-libgcc-file-name
14348 @opindex print-libgcc-file-name
14349 Same as @option{-print-file-name=libgcc.a}.
14351 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14352 but you do want to link with @file{libgcc.a}.  You can do:
14354 @smallexample
14355 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14356 @end smallexample
14358 @item -print-search-dirs
14359 @opindex print-search-dirs
14360 Print the name of the configured installation directory and a list of
14361 program and library directories @command{gcc} searches---and don't do anything else.
14363 This is useful when @command{gcc} prints the error message
14364 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14365 To resolve this you either need to put @file{cpp0} and the other compiler
14366 components where @command{gcc} expects to find them, or you can set the environment
14367 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14368 Don't forget the trailing @samp{/}.
14369 @xref{Environment Variables}.
14371 @item -print-sysroot
14372 @opindex print-sysroot
14373 Print the target sysroot directory that is used during
14374 compilation.  This is the target sysroot specified either at configure
14375 time or using the @option{--sysroot} option, possibly with an extra
14376 suffix that depends on compilation options.  If no target sysroot is
14377 specified, the option prints nothing.
14379 @item -print-sysroot-headers-suffix
14380 @opindex print-sysroot-headers-suffix
14381 Print the suffix added to the target sysroot when searching for
14382 headers, or give an error if the compiler is not configured with such
14383 a suffix---and don't do anything else.
14385 @item -dumpmachine
14386 @opindex dumpmachine
14387 Print the compiler's target machine (for example,
14388 @samp{i686-pc-linux-gnu})---and don't do anything else.
14390 @item -dumpversion
14391 @opindex dumpversion
14392 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14393 anything else.  This is the compiler version used in filesystem paths,
14394 specs, can be depending on how the compiler has been configured just
14395 a single number (major version), two numbers separated by dot (major and
14396 minor version) or three numbers separated by dots (major, minor and patchlevel
14397 version).
14399 @item -dumpfullversion
14400 @opindex dumpfullversion
14401 Print the full compiler version, always 3 numbers separated by dots,
14402 major, minor and patchlevel version.
14404 @item -dumpspecs
14405 @opindex dumpspecs
14406 Print the compiler's built-in specs---and don't do anything else.  (This
14407 is used when GCC itself is being built.)  @xref{Spec Files}.
14408 @end table
14410 @node Submodel Options
14411 @section Machine-Dependent Options
14412 @cindex submodel options
14413 @cindex specifying hardware config
14414 @cindex hardware models and configurations, specifying
14415 @cindex target-dependent options
14416 @cindex machine-dependent options
14418 Each target machine supported by GCC can have its own options---for
14419 example, to allow you to compile for a particular processor variant or
14420 ABI, or to control optimizations specific to that machine.  By
14421 convention, the names of machine-specific options start with
14422 @samp{-m}.
14424 Some configurations of the compiler also support additional target-specific
14425 options, usually for compatibility with other compilers on the same
14426 platform.
14428 @c This list is ordered alphanumerically by subsection name.
14429 @c It should be the same order and spelling as these options are listed
14430 @c in Machine Dependent Options
14432 @menu
14433 * AArch64 Options::
14434 * Adapteva Epiphany Options::
14435 * ARC Options::
14436 * ARM Options::
14437 * AVR Options::
14438 * Blackfin Options::
14439 * C6X Options::
14440 * CRIS Options::
14441 * CR16 Options::
14442 * Darwin Options::
14443 * DEC Alpha Options::
14444 * FR30 Options::
14445 * FT32 Options::
14446 * FRV Options::
14447 * GNU/Linux Options::
14448 * H8/300 Options::
14449 * HPPA Options::
14450 * IA-64 Options::
14451 * LM32 Options::
14452 * M32C Options::
14453 * M32R/D Options::
14454 * M680x0 Options::
14455 * MCore Options::
14456 * MeP Options::
14457 * MicroBlaze Options::
14458 * MIPS Options::
14459 * MMIX Options::
14460 * MN10300 Options::
14461 * Moxie Options::
14462 * MSP430 Options::
14463 * NDS32 Options::
14464 * Nios II Options::
14465 * Nvidia PTX Options::
14466 * PDP-11 Options::
14467 * picoChip Options::
14468 * PowerPC Options::
14469 * PowerPC SPE Options::
14470 * RISC-V Options::
14471 * RL78 Options::
14472 * RS/6000 and PowerPC Options::
14473 * RX Options::
14474 * S/390 and zSeries Options::
14475 * Score Options::
14476 * SH Options::
14477 * Solaris 2 Options::
14478 * SPARC Options::
14479 * SPU Options::
14480 * System V Options::
14481 * TILE-Gx Options::
14482 * TILEPro Options::
14483 * V850 Options::
14484 * VAX Options::
14485 * Visium Options::
14486 * VMS Options::
14487 * VxWorks Options::
14488 * x86 Options::
14489 * x86 Windows Options::
14490 * Xstormy16 Options::
14491 * Xtensa Options::
14492 * zSeries Options::
14493 @end menu
14495 @node AArch64 Options
14496 @subsection AArch64 Options
14497 @cindex AArch64 Options
14499 These options are defined for AArch64 implementations:
14501 @table @gcctabopt
14503 @item -mabi=@var{name}
14504 @opindex mabi
14505 Generate code for the specified data model.  Permissible values
14506 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14507 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14508 but long int and pointers are 64 bits.
14510 The default depends on the specific target configuration.  Note that
14511 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14512 entire program with the same ABI, and link with a compatible set of libraries.
14514 @item -mbig-endian
14515 @opindex mbig-endian
14516 Generate big-endian code.  This is the default when GCC is configured for an
14517 @samp{aarch64_be-*-*} target.
14519 @item -mgeneral-regs-only
14520 @opindex mgeneral-regs-only
14521 Generate code which uses only the general-purpose registers.  This will prevent
14522 the compiler from using floating-point and Advanced SIMD registers but will not
14523 impose any restrictions on the assembler.
14525 @item -mlittle-endian
14526 @opindex mlittle-endian
14527 Generate little-endian code.  This is the default when GCC is configured for an
14528 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14530 @item -mcmodel=tiny
14531 @opindex mcmodel=tiny
14532 Generate code for the tiny code model.  The program and its statically defined
14533 symbols must be within 1MB of each other.  Programs can be statically or
14534 dynamically linked.
14536 @item -mcmodel=small
14537 @opindex mcmodel=small
14538 Generate code for the small code model.  The program and its statically defined
14539 symbols must be within 4GB of each other.  Programs can be statically or
14540 dynamically linked.  This is the default code model.
14542 @item -mcmodel=large
14543 @opindex mcmodel=large
14544 Generate code for the large code model.  This makes no assumptions about
14545 addresses and sizes of sections.  Programs can be statically linked only.
14547 @item -mstrict-align
14548 @itemx -mno-strict-align
14549 @opindex mstrict-align
14550 @opindex mno-strict-align
14551 Avoid or allow generating memory accesses that may not be aligned on a natural
14552 object boundary as described in the architecture specification.
14554 @item -momit-leaf-frame-pointer
14555 @itemx -mno-omit-leaf-frame-pointer
14556 @opindex momit-leaf-frame-pointer
14557 @opindex mno-omit-leaf-frame-pointer
14558 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14559 default.
14561 @item -mtls-dialect=desc
14562 @opindex mtls-dialect=desc
14563 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14564 of TLS variables.  This is the default.
14566 @item -mtls-dialect=traditional
14567 @opindex mtls-dialect=traditional
14568 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14569 of TLS variables.
14571 @item -mtls-size=@var{size}
14572 @opindex mtls-size
14573 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14574 This option requires binutils 2.26 or newer.
14576 @item -mfix-cortex-a53-835769
14577 @itemx -mno-fix-cortex-a53-835769
14578 @opindex mfix-cortex-a53-835769
14579 @opindex mno-fix-cortex-a53-835769
14580 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14581 This involves inserting a NOP instruction between memory instructions and
14582 64-bit integer multiply-accumulate instructions.
14584 @item -mfix-cortex-a53-843419
14585 @itemx -mno-fix-cortex-a53-843419
14586 @opindex mfix-cortex-a53-843419
14587 @opindex mno-fix-cortex-a53-843419
14588 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14589 This erratum workaround is made at link time and this will only pass the
14590 corresponding flag to the linker.
14592 @item -mlow-precision-recip-sqrt
14593 @itemx -mno-low-precision-recip-sqrt
14594 @opindex mlow-precision-recip-sqrt
14595 @opindex mno-low-precision-recip-sqrt
14596 Enable or disable the reciprocal square root approximation.
14597 This option only has an effect if @option{-ffast-math} or
14598 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14599 precision of reciprocal square root results to about 16 bits for
14600 single precision and to 32 bits for double precision.
14602 @item -mlow-precision-sqrt
14603 @itemx -mno-low-precision-sqrt
14604 @opindex -mlow-precision-sqrt
14605 @opindex -mno-low-precision-sqrt
14606 Enable or disable the square root approximation.
14607 This option only has an effect if @option{-ffast-math} or
14608 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14609 precision of square root results to about 16 bits for
14610 single precision and to 32 bits for double precision.
14611 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14613 @item -mlow-precision-div
14614 @itemx -mno-low-precision-div
14615 @opindex -mlow-precision-div
14616 @opindex -mno-low-precision-div
14617 Enable or disable the division approximation.
14618 This option only has an effect if @option{-ffast-math} or
14619 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14620 precision of division results to about 16 bits for
14621 single precision and to 32 bits for double precision.
14623 @item -march=@var{name}
14624 @opindex march
14625 Specify the name of the target architecture and, optionally, one or
14626 more feature modifiers.  This option has the form
14627 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14629 The permissible values for @var{arch} are @samp{armv8-a},
14630 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14631 or @var{native}.
14633 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14634 support for the ARMv8.4-A architecture extensions.
14636 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14637 support for the ARMv8.3-A architecture extensions.
14639 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14640 support for the ARMv8.2-A architecture extensions.
14642 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14643 support for the ARMv8.1-A architecture extension.  In particular, it
14644 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14646 The value @samp{native} is available on native AArch64 GNU/Linux and
14647 causes the compiler to pick the architecture of the host system.  This
14648 option has no effect if the compiler is unable to recognize the
14649 architecture of the host system,
14651 The permissible values for @var{feature} are listed in the sub-section
14652 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14653 Feature Modifiers}.  Where conflicting feature modifiers are
14654 specified, the right-most feature is used.
14656 GCC uses @var{name} to determine what kind of instructions it can emit
14657 when generating assembly code.  If @option{-march} is specified
14658 without either of @option{-mtune} or @option{-mcpu} also being
14659 specified, the code is tuned to perform well across a range of target
14660 processors implementing the target architecture.
14662 @item -mtune=@var{name}
14663 @opindex mtune
14664 Specify the name of the target processor for which GCC should tune the
14665 performance of the code.  Permissible values for this option are:
14666 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14667 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14668 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14669 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14670 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14671 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14672 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14673 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14674 @samp{native}.
14676 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14677 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14678 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14679 big.LITTLE system.
14681 Additionally on native AArch64 GNU/Linux systems the value
14682 @samp{native} tunes performance to the host system.  This option has no effect
14683 if the compiler is unable to recognize the processor of the host system.
14685 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14686 are specified, the code is tuned to perform well across a range
14687 of target processors.
14689 This option cannot be suffixed by feature modifiers.
14691 @item -mcpu=@var{name}
14692 @opindex mcpu
14693 Specify the name of the target processor, optionally suffixed by one
14694 or more feature modifiers.  This option has the form
14695 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14696 the permissible values for @var{cpu} are the same as those available
14697 for @option{-mtune}.  The permissible values for @var{feature} are
14698 documented in the sub-section on
14699 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14700 Feature Modifiers}.  Where conflicting feature modifiers are
14701 specified, the right-most feature is used.
14703 GCC uses @var{name} to determine what kind of instructions it can emit when
14704 generating assembly code (as if by @option{-march}) and to determine
14705 the target processor for which to tune for performance (as if
14706 by @option{-mtune}).  Where this option is used in conjunction
14707 with @option{-march} or @option{-mtune}, those options take precedence
14708 over the appropriate part of this option.
14710 @item -moverride=@var{string}
14711 @opindex moverride
14712 Override tuning decisions made by the back-end in response to a
14713 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14714 for @var{string} in this option are not guaranteed to be consistent
14715 across releases.
14717 This option is only intended to be useful when developing GCC.
14719 @item -mverbose-cost-dump
14720 @opindex mverbose-cost-dump
14721 Enable verbose cost model dumping in the debug dump files.  This option is
14722 provided for use in debugging the compiler.
14724 @item -mpc-relative-literal-loads
14725 @itemx -mno-pc-relative-literal-loads
14726 @opindex mpc-relative-literal-loads
14727 @opindex mno-pc-relative-literal-loads
14728 Enable or disable PC-relative literal loads.  With this option literal pools are
14729 accessed using a single instruction and emitted after each function.  This
14730 limits the maximum size of functions to 1MB.  This is enabled by default for
14731 @option{-mcmodel=tiny}.
14733 @item -msign-return-address=@var{scope}
14734 @opindex msign-return-address
14735 Select the function scope on which return address signing will be applied.
14736 Permissible values are @samp{none}, which disables return address signing,
14737 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14738 functions, and @samp{all}, which enables pointer signing for all functions.  The
14739 default value is @samp{none}.
14741 @item -msve-vector-bits=@var{bits}
14742 @opindex msve-vector-bits
14743 Specify the number of bits in an SVE vector register.  This option only has
14744 an effect when SVE is enabled.
14746 GCC supports two forms of SVE code generation: ``vector-length
14747 agnostic'' output that works with any size of vector register and
14748 ``vector-length specific'' output that only works when the vector
14749 registers are a particular size.  Replacing @var{bits} with
14750 @samp{scalable} selects vector-length agnostic output while
14751 replacing it with a number selects vector-length specific output.
14752 The possible lengths in the latter case are: 128, 256, 512, 1024
14753 and 2048.  @samp{scalable} is the default.
14755 At present, @samp{-msve-vector-bits=128} produces the same output
14756 as @samp{-msve-vector-bits=scalable}.
14758 @end table
14760 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14761 @anchor{aarch64-feature-modifiers}
14762 @cindex @option{-march} feature modifiers
14763 @cindex @option{-mcpu} feature modifiers
14764 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14765 the following and their inverses @option{no@var{feature}}:
14767 @table @samp
14768 @item crc
14769 Enable CRC extension.  This is on by default for
14770 @option{-march=armv8.1-a}.
14771 @item crypto
14772 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14773 instructions.
14774 @item fp
14775 Enable floating-point instructions.  This is on by default for all possible
14776 values for options @option{-march} and @option{-mcpu}.
14777 @item simd
14778 Enable Advanced SIMD instructions.  This also enables floating-point
14779 instructions.  This is on by default for all possible values for options
14780 @option{-march} and @option{-mcpu}.
14781 @item sve
14782 Enable Scalable Vector Extension instructions.  This also enables Advanced
14783 SIMD and floating-point instructions.
14784 @item lse
14785 Enable Large System Extension instructions.  This is on by default for
14786 @option{-march=armv8.1-a}.
14787 @item rdma
14788 Enable Round Double Multiply Accumulate instructions.  This is on by default
14789 for @option{-march=armv8.1-a}.
14790 @item fp16
14791 Enable FP16 extension.  This also enables floating-point instructions.
14792 @item fp16fml
14793 Enable FP16 fmla extension.  This also enables FP16 extensions and
14794 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.
14796 @item rcpc
14797 Enable the RcPc extension.  This does not change code generation from GCC,
14798 but is passed on to the assembler, enabling inline asm statements to use
14799 instructions from the RcPc extension.
14800 @item dotprod
14801 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14802 @item aes
14803 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14804 SIMD instructions.
14805 @item sha2
14806 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14807 @item sha3
14808 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14809 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14810 @item sm4
14811 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14812 Use of this option with architectures prior to Armv8.2-A is not supported.
14814 @end table
14816 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14817 which implies @option{fp}.
14818 Conversely, @option{nofp} implies @option{nosimd}, which implies
14819 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14821 @node Adapteva Epiphany Options
14822 @subsection Adapteva Epiphany Options
14824 These @samp{-m} options are defined for Adapteva Epiphany:
14826 @table @gcctabopt
14827 @item -mhalf-reg-file
14828 @opindex mhalf-reg-file
14829 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14830 That allows code to run on hardware variants that lack these registers.
14832 @item -mprefer-short-insn-regs
14833 @opindex mprefer-short-insn-regs
14834 Preferentially allocate registers that allow short instruction generation.
14835 This can result in increased instruction count, so this may either reduce or
14836 increase overall code size.
14838 @item -mbranch-cost=@var{num}
14839 @opindex mbranch-cost
14840 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14841 This cost is only a heuristic and is not guaranteed to produce
14842 consistent results across releases.
14844 @item -mcmove
14845 @opindex mcmove
14846 Enable the generation of conditional moves.
14848 @item -mnops=@var{num}
14849 @opindex mnops
14850 Emit @var{num} NOPs before every other generated instruction.
14852 @item -mno-soft-cmpsf
14853 @opindex mno-soft-cmpsf
14854 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14855 and test the flags.  This is faster than a software comparison, but can
14856 get incorrect results in the presence of NaNs, or when two different small
14857 numbers are compared such that their difference is calculated as zero.
14858 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14859 software comparisons.
14861 @item -mstack-offset=@var{num}
14862 @opindex mstack-offset
14863 Set the offset between the top of the stack and the stack pointer.
14864 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14865 can be used by leaf functions without stack allocation.
14866 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14867 Note also that this option changes the ABI; compiling a program with a
14868 different stack offset than the libraries have been compiled with
14869 generally does not work.
14870 This option can be useful if you want to evaluate if a different stack
14871 offset would give you better code, but to actually use a different stack
14872 offset to build working programs, it is recommended to configure the
14873 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14875 @item -mno-round-nearest
14876 @opindex mno-round-nearest
14877 Make the scheduler assume that the rounding mode has been set to
14878 truncating.  The default is @option{-mround-nearest}.
14880 @item -mlong-calls
14881 @opindex mlong-calls
14882 If not otherwise specified by an attribute, assume all calls might be beyond
14883 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14884 function address into a register before performing a (otherwise direct) call.
14885 This is the default.
14887 @item -mshort-calls
14888 @opindex short-calls
14889 If not otherwise specified by an attribute, assume all direct calls are
14890 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14891 for direct calls.  The default is @option{-mlong-calls}.
14893 @item -msmall16
14894 @opindex msmall16
14895 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14896 apply to function addresses for which @option{-mlong-calls} semantics
14897 are in effect.
14899 @item -mfp-mode=@var{mode}
14900 @opindex mfp-mode
14901 Set the prevailing mode of the floating-point unit.
14902 This determines the floating-point mode that is provided and expected
14903 at function call and return time.  Making this mode match the mode you
14904 predominantly need at function start can make your programs smaller and
14905 faster by avoiding unnecessary mode switches.
14907 @var{mode} can be set to one the following values:
14909 @table @samp
14910 @item caller
14911 Any mode at function entry is valid, and retained or restored when
14912 the function returns, and when it calls other functions.
14913 This mode is useful for compiling libraries or other compilation units
14914 you might want to incorporate into different programs with different
14915 prevailing FPU modes, and the convenience of being able to use a single
14916 object file outweighs the size and speed overhead for any extra
14917 mode switching that might be needed, compared with what would be needed
14918 with a more specific choice of prevailing FPU mode.
14920 @item truncate
14921 This is the mode used for floating-point calculations with
14922 truncating (i.e.@: round towards zero) rounding mode.  That includes
14923 conversion from floating point to integer.
14925 @item round-nearest
14926 This is the mode used for floating-point calculations with
14927 round-to-nearest-or-even rounding mode.
14929 @item int
14930 This is the mode used to perform integer calculations in the FPU, e.g.@:
14931 integer multiply, or integer multiply-and-accumulate.
14932 @end table
14934 The default is @option{-mfp-mode=caller}
14936 @item -mnosplit-lohi
14937 @itemx -mno-postinc
14938 @itemx -mno-postmodify
14939 @opindex mnosplit-lohi
14940 @opindex mno-postinc
14941 @opindex mno-postmodify
14942 Code generation tweaks that disable, respectively, splitting of 32-bit
14943 loads, generation of post-increment addresses, and generation of
14944 post-modify addresses.  The defaults are @option{msplit-lohi},
14945 @option{-mpost-inc}, and @option{-mpost-modify}.
14947 @item -mnovect-double
14948 @opindex mno-vect-double
14949 Change the preferred SIMD mode to SImode.  The default is
14950 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14952 @item -max-vect-align=@var{num}
14953 @opindex max-vect-align
14954 The maximum alignment for SIMD vector mode types.
14955 @var{num} may be 4 or 8.  The default is 8.
14956 Note that this is an ABI change, even though many library function
14957 interfaces are unaffected if they don't use SIMD vector modes
14958 in places that affect size and/or alignment of relevant types.
14960 @item -msplit-vecmove-early
14961 @opindex msplit-vecmove-early
14962 Split vector moves into single word moves before reload.  In theory this
14963 can give better register allocation, but so far the reverse seems to be
14964 generally the case.
14966 @item -m1reg-@var{reg}
14967 @opindex m1reg-
14968 Specify a register to hold the constant @minus{}1, which makes loading small negative
14969 constants and certain bitmasks faster.
14970 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14971 which specify use of that register as a fixed register,
14972 and @samp{none}, which means that no register is used for this
14973 purpose.  The default is @option{-m1reg-none}.
14975 @end table
14977 @node ARC Options
14978 @subsection ARC Options
14979 @cindex ARC options
14981 The following options control the architecture variant for which code
14982 is being compiled:
14984 @c architecture variants
14985 @table @gcctabopt
14987 @item -mbarrel-shifter
14988 @opindex mbarrel-shifter
14989 Generate instructions supported by barrel shifter.  This is the default
14990 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14992 @item -mjli-always
14993 @opindex mjli-alawys
14994 Force to call a function using jli_s instruction.  This option is
14995 valid only for ARCv2 architecture.
14997 @item -mcpu=@var{cpu}
14998 @opindex mcpu
14999 Set architecture type, register usage, and instruction scheduling
15000 parameters for @var{cpu}.  There are also shortcut alias options
15001 available for backward compatibility and convenience.  Supported
15002 values for @var{cpu} are
15004 @table @samp
15005 @opindex mA6
15006 @opindex mARC600
15007 @item arc600
15008 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15010 @item arc601
15011 @opindex mARC601
15012 Compile for ARC601.  Alias: @option{-mARC601}.
15014 @item arc700
15015 @opindex mA7
15016 @opindex mARC700
15017 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15018 This is the default when configured with @option{--with-cpu=arc700}@.
15020 @item arcem
15021 Compile for ARC EM.
15023 @item archs
15024 Compile for ARC HS.
15026 @item em
15027 Compile for ARC EM CPU with no hardware extensions.
15029 @item em4
15030 Compile for ARC EM4 CPU.
15032 @item em4_dmips
15033 Compile for ARC EM4 DMIPS CPU.
15035 @item em4_fpus
15036 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15037 extension.
15039 @item em4_fpuda
15040 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15041 double assist instructions.
15043 @item hs
15044 Compile for ARC HS CPU with no hardware extensions except the atomic
15045 instructions.
15047 @item hs34
15048 Compile for ARC HS34 CPU.
15050 @item hs38
15051 Compile for ARC HS38 CPU.
15053 @item hs38_linux
15054 Compile for ARC HS38 CPU with all hardware extensions on.
15056 @item arc600_norm
15057 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15059 @item arc600_mul32x16
15060 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15061 instructions enabled.
15063 @item arc600_mul64
15064 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15065 instructions enabled.
15067 @item arc601_norm
15068 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15070 @item arc601_mul32x16
15071 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15072 instructions enabled.
15074 @item arc601_mul64
15075 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15076 instructions enabled.
15078 @item nps400
15079 Compile for ARC 700 on NPS400 chip.
15081 @item em_mini
15082 Compile for ARC EM minimalist configuration featuring reduced register
15083 set.
15085 @end table
15087 @item -mdpfp
15088 @opindex mdpfp
15089 @itemx -mdpfp-compact
15090 @opindex mdpfp-compact
15091 Generate double-precision FPX instructions, tuned for the compact
15092 implementation.
15094 @item -mdpfp-fast
15095 @opindex mdpfp-fast
15096 Generate double-precision FPX instructions, tuned for the fast
15097 implementation.
15099 @item -mno-dpfp-lrsr
15100 @opindex mno-dpfp-lrsr
15101 Disable @code{lr} and @code{sr} instructions from using FPX extension
15102 aux registers.
15104 @item -mea
15105 @opindex mea
15106 Generate extended arithmetic instructions.  Currently only
15107 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15108 supported.  This is always enabled for @option{-mcpu=ARC700}.
15110 @item -mno-mpy
15111 @opindex mno-mpy
15112 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15113 deprecated.
15115 @item -mmul32x16
15116 @opindex mmul32x16
15117 Generate 32x16-bit multiply and multiply-accumulate instructions.
15119 @item -mmul64
15120 @opindex mmul64
15121 Generate @code{mul64} and @code{mulu64} instructions.  
15122 Only valid for @option{-mcpu=ARC600}.
15124 @item -mnorm
15125 @opindex mnorm
15126 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15127 is in effect.
15129 @item -mspfp
15130 @opindex mspfp
15131 @itemx -mspfp-compact
15132 @opindex mspfp-compact
15133 Generate single-precision FPX instructions, tuned for the compact
15134 implementation.
15136 @item -mspfp-fast
15137 @opindex mspfp-fast
15138 Generate single-precision FPX instructions, tuned for the fast
15139 implementation.
15141 @item -msimd
15142 @opindex msimd
15143 Enable generation of ARC SIMD instructions via target-specific
15144 builtins.  Only valid for @option{-mcpu=ARC700}.
15146 @item -msoft-float
15147 @opindex msoft-float
15148 This option ignored; it is provided for compatibility purposes only.
15149 Software floating-point code is emitted by default, and this default
15150 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15151 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15152 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15154 @item -mswap
15155 @opindex mswap
15156 Generate @code{swap} instructions.
15158 @item -matomic
15159 @opindex matomic
15160 This enables use of the locked load/store conditional extension to implement
15161 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15162 EM cores.
15164 @item -mdiv-rem
15165 @opindex mdiv-rem
15166 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15168 @item -mcode-density
15169 @opindex mcode-density
15170 Enable code density instructions for ARC EM.  
15171 This option is on by default for ARC HS.
15173 @item -mll64
15174 @opindex mll64
15175 Enable double load/store operations for ARC HS cores.
15177 @item -mtp-regno=@var{regno}
15178 @opindex mtp-regno
15179 Specify thread pointer register number.
15181 @item -mmpy-option=@var{multo}
15182 @opindex mmpy-option
15183 Compile ARCv2 code with a multiplier design option.  You can specify 
15184 the option using either a string or numeric value for @var{multo}.  
15185 @samp{wlh1} is the default value.  The recognized values are:
15187 @table @samp
15188 @item 0
15189 @itemx none
15190 No multiplier available.
15192 @item 1
15193 @itemx w
15194 16x16 multiplier, fully pipelined.
15195 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15197 @item 2
15198 @itemx wlh1
15199 32x32 multiplier, fully
15200 pipelined (1 stage).  The following instructions are additionally
15201 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15203 @item 3
15204 @itemx wlh2
15205 32x32 multiplier, fully pipelined
15206 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15207 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15209 @item 4
15210 @itemx wlh3
15211 Two 16x16 multipliers, blocking,
15212 sequential.  The following instructions are additionally enabled: @code{mpy},
15213 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15215 @item 5
15216 @itemx wlh4
15217 One 16x16 multiplier, blocking,
15218 sequential.  The following instructions are additionally enabled: @code{mpy},
15219 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15221 @item 6
15222 @itemx wlh5
15223 One 32x4 multiplier, blocking,
15224 sequential.  The following instructions are additionally enabled: @code{mpy},
15225 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15227 @item 7
15228 @itemx plus_dmpy
15229 ARC HS SIMD support.
15231 @item 8
15232 @itemx plus_macd
15233 ARC HS SIMD support.
15235 @item 9
15236 @itemx plus_qmacw
15237 ARC HS SIMD support.
15239 @end table
15241 This option is only available for ARCv2 cores@.
15243 @item -mfpu=@var{fpu}
15244 @opindex mfpu
15245 Enables support for specific floating-point hardware extensions for ARCv2
15246 cores.  Supported values for @var{fpu} are:
15248 @table @samp
15250 @item fpus
15251 Enables support for single-precision floating-point hardware
15252 extensions@.
15254 @item fpud
15255 Enables support for double-precision floating-point hardware
15256 extensions.  The single-precision floating-point extension is also
15257 enabled.  Not available for ARC EM@.
15259 @item fpuda
15260 Enables support for double-precision floating-point hardware
15261 extensions using double-precision assist instructions.  The single-precision
15262 floating-point extension is also enabled.  This option is
15263 only available for ARC EM@.
15265 @item fpuda_div
15266 Enables support for double-precision floating-point hardware
15267 extensions using double-precision assist instructions.
15268 The single-precision floating-point, square-root, and divide 
15269 extensions are also enabled.  This option is
15270 only available for ARC EM@.
15272 @item fpuda_fma
15273 Enables support for double-precision floating-point hardware
15274 extensions using double-precision assist instructions.
15275 The single-precision floating-point and fused multiply and add 
15276 hardware extensions are also enabled.  This option is
15277 only available for ARC EM@.
15279 @item fpuda_all
15280 Enables support for double-precision floating-point hardware
15281 extensions using double-precision assist instructions.
15282 All single-precision floating-point hardware extensions are also
15283 enabled.  This option is only available for ARC EM@.
15285 @item fpus_div
15286 Enables support for single-precision floating-point, square-root and divide 
15287 hardware extensions@.
15289 @item fpud_div
15290 Enables support for double-precision floating-point, square-root and divide 
15291 hardware extensions.  This option
15292 includes option @samp{fpus_div}. Not available for ARC EM@.
15294 @item fpus_fma
15295 Enables support for single-precision floating-point and 
15296 fused multiply and add hardware extensions@.
15298 @item fpud_fma
15299 Enables support for double-precision floating-point and 
15300 fused multiply and add hardware extensions.  This option
15301 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15303 @item fpus_all
15304 Enables support for all single-precision floating-point hardware
15305 extensions@.
15307 @item fpud_all
15308 Enables support for all single- and double-precision floating-point
15309 hardware extensions.  Not available for ARC EM@.
15311 @end table
15313 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15314 @opindex mirq-ctrl-saved
15315 Specifies general-purposes registers that the processor automatically
15316 saves/restores on interrupt entry and exit.  @var{register-range} is
15317 specified as two registers separated by a dash.  The register range
15318 always starts with @code{r0}, the upper limit is @code{fp} register.
15319 @var{blink} and @var{lp_count} are optional.  This option is only
15320 valid for ARC EM and ARC HS cores.
15322 @item -mrgf-banked-regs=@var{number}
15323 @opindex mrgf-banked-regs
15324 Specifies the number of registers replicated in second register bank
15325 on entry to fast interrupt.  Fast interrupts are interrupts with the
15326 highest priority level P0.  These interrupts save only PC and STATUS32
15327 registers to avoid memory transactions during interrupt entry and exit
15328 sequences.  Use this option when you are using fast interrupts in an
15329 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15331 @item -mlpc-width=@var{width}
15332 @opindex mlpc-width
15333 Specify the width of the @code{lp_count} register.  Valid values for
15334 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15335 fixed to 32 bits.  If the width is less than 32, the compiler does not
15336 attempt to transform loops in your program to use the zero-delay loop
15337 mechanism unless it is known that the @code{lp_count} register can
15338 hold the required loop-counter value.  Depending on the width
15339 specified, the compiler and run-time library might continue to use the
15340 loop mechanism for various needs.  This option defines macro
15341 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15343 @item -mrf16
15344 @opindex mrf16
15345 This option instructs the compiler to generate code for a 16-entry
15346 register file.  This option defines the @code{__ARC_RF16__}
15347 preprocessor macro.
15349 @end table
15351 The following options are passed through to the assembler, and also
15352 define preprocessor macro symbols.
15354 @c Flags used by the assembler, but for which we define preprocessor
15355 @c macro symbols as well.
15356 @table @gcctabopt
15357 @item -mdsp-packa
15358 @opindex mdsp-packa
15359 Passed down to the assembler to enable the DSP Pack A extensions.
15360 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15361 deprecated.
15363 @item -mdvbf
15364 @opindex mdvbf
15365 Passed down to the assembler to enable the dual Viterbi butterfly
15366 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15367 option is deprecated.
15369 @c ARC700 4.10 extension instruction
15370 @item -mlock
15371 @opindex mlock
15372 Passed down to the assembler to enable the locked load/store
15373 conditional extension.  Also sets the preprocessor symbol
15374 @code{__Xlock}.
15376 @item -mmac-d16
15377 @opindex mmac-d16
15378 Passed down to the assembler.  Also sets the preprocessor symbol
15379 @code{__Xxmac_d16}.  This option is deprecated.
15381 @item -mmac-24
15382 @opindex mmac-24
15383 Passed down to the assembler.  Also sets the preprocessor symbol
15384 @code{__Xxmac_24}.  This option is deprecated.
15386 @c ARC700 4.10 extension instruction
15387 @item -mrtsc
15388 @opindex mrtsc
15389 Passed down to the assembler to enable the 64-bit time-stamp counter
15390 extension instruction.  Also sets the preprocessor symbol
15391 @code{__Xrtsc}.  This option is deprecated.
15393 @c ARC700 4.10 extension instruction
15394 @item -mswape
15395 @opindex mswape
15396 Passed down to the assembler to enable the swap byte ordering
15397 extension instruction.  Also sets the preprocessor symbol
15398 @code{__Xswape}.
15400 @item -mtelephony
15401 @opindex mtelephony
15402 Passed down to the assembler to enable dual- and single-operand
15403 instructions for telephony.  Also sets the preprocessor symbol
15404 @code{__Xtelephony}.  This option is deprecated.
15406 @item -mxy
15407 @opindex mxy
15408 Passed down to the assembler to enable the XY memory extension.  Also
15409 sets the preprocessor symbol @code{__Xxy}.
15411 @end table
15413 The following options control how the assembly code is annotated:
15415 @c Assembly annotation options
15416 @table @gcctabopt
15417 @item -misize
15418 @opindex misize
15419 Annotate assembler instructions with estimated addresses.
15421 @item -mannotate-align
15422 @opindex mannotate-align
15423 Explain what alignment considerations lead to the decision to make an
15424 instruction short or long.
15426 @end table
15428 The following options are passed through to the linker:
15430 @c options passed through to the linker
15431 @table @gcctabopt
15432 @item -marclinux
15433 @opindex marclinux
15434 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15435 This option is enabled by default in tool chains built for
15436 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15437 when profiling is not requested.
15439 @item -marclinux_prof
15440 @opindex marclinux_prof
15441 Passed through to the linker, to specify use of the
15442 @code{arclinux_prof} emulation.  This option is enabled by default in
15443 tool chains built for @w{@code{arc-linux-uclibc}} and
15444 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15446 @end table
15448 The following options control the semantics of generated code:
15450 @c semantically relevant code generation options
15451 @table @gcctabopt
15452 @item -mlong-calls
15453 @opindex mlong-calls
15454 Generate calls as register indirect calls, thus providing access
15455 to the full 32-bit address range.
15457 @item -mmedium-calls
15458 @opindex mmedium-calls
15459 Don't use less than 25-bit addressing range for calls, which is the
15460 offset available for an unconditional branch-and-link
15461 instruction.  Conditional execution of function calls is suppressed, to
15462 allow use of the 25-bit range, rather than the 21-bit range with
15463 conditional branch-and-link.  This is the default for tool chains built
15464 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15466 @item -G @var{num}
15467 @opindex G
15468 Put definitions of externally-visible data in a small data section if
15469 that data is no bigger than @var{num} bytes.  The default value of
15470 @var{num} is 4 for any ARC configuration, or 8 when we have double
15471 load/store operations.
15473 @item -mno-sdata
15474 @opindex mno-sdata
15475 Do not generate sdata references.  This is the default for tool chains
15476 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15477 targets.
15479 @item -mvolatile-cache
15480 @opindex mvolatile-cache
15481 Use ordinarily cached memory accesses for volatile references.  This is the
15482 default.
15484 @item -mno-volatile-cache
15485 @opindex mno-volatile-cache
15486 Enable cache bypass for volatile references.
15488 @end table
15490 The following options fine tune code generation:
15491 @c code generation tuning options
15492 @table @gcctabopt
15493 @item -malign-call
15494 @opindex malign-call
15495 Do alignment optimizations for call instructions.
15497 @item -mauto-modify-reg
15498 @opindex mauto-modify-reg
15499 Enable the use of pre/post modify with register displacement.
15501 @item -mbbit-peephole
15502 @opindex mbbit-peephole
15503 Enable bbit peephole2.
15505 @item -mno-brcc
15506 @opindex mno-brcc
15507 This option disables a target-specific pass in @file{arc_reorg} to
15508 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15509 It has no effect on
15510 generation of these instructions driven by the combiner pass.
15512 @item -mcase-vector-pcrel
15513 @opindex mcase-vector-pcrel
15514 Use PC-relative switch case tables to enable case table shortening.
15515 This is the default for @option{-Os}.
15517 @item -mcompact-casesi
15518 @opindex mcompact-casesi
15519 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15520 and only available for ARCv1 cores.
15522 @item -mno-cond-exec
15523 @opindex mno-cond-exec
15524 Disable the ARCompact-specific pass to generate conditional 
15525 execution instructions.
15527 Due to delay slot scheduling and interactions between operand numbers,
15528 literal sizes, instruction lengths, and the support for conditional execution,
15529 the target-independent pass to generate conditional execution is often lacking,
15530 so the ARC port has kept a special pass around that tries to find more
15531 conditional execution generation opportunities after register allocation,
15532 branch shortening, and delay slot scheduling have been done.  This pass
15533 generally, but not always, improves performance and code size, at the cost of
15534 extra compilation time, which is why there is an option to switch it off.
15535 If you have a problem with call instructions exceeding their allowable
15536 offset range because they are conditionalized, you should consider using
15537 @option{-mmedium-calls} instead.
15539 @item -mearly-cbranchsi
15540 @opindex mearly-cbranchsi
15541 Enable pre-reload use of the @code{cbranchsi} pattern.
15543 @item -mexpand-adddi
15544 @opindex mexpand-adddi
15545 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15546 @code{add.f}, @code{adc} etc.  This option is deprecated.
15548 @item -mindexed-loads
15549 @opindex mindexed-loads
15550 Enable the use of indexed loads.  This can be problematic because some
15551 optimizers then assume that indexed stores exist, which is not
15552 the case.
15554 @item -mlra
15555 @opindex mlra
15556 Enable Local Register Allocation.  This is still experimental for ARC,
15557 so by default the compiler uses standard reload
15558 (i.e. @option{-mno-lra}).
15560 @item -mlra-priority-none
15561 @opindex mlra-priority-none
15562 Don't indicate any priority for target registers.
15564 @item -mlra-priority-compact
15565 @opindex mlra-priority-compact
15566 Indicate target register priority for r0..r3 / r12..r15.
15568 @item -mlra-priority-noncompact
15569 @opindex mlra-priority-noncompact
15570 Reduce target register priority for r0..r3 / r12..r15.
15572 @item -mno-millicode
15573 @opindex mno-millicode
15574 When optimizing for size (using @option{-Os}), prologues and epilogues
15575 that have to save or restore a large number of registers are often
15576 shortened by using call to a special function in libgcc; this is
15577 referred to as a @emph{millicode} call.  As these calls can pose
15578 performance issues, and/or cause linking issues when linking in a
15579 nonstandard way, this option is provided to turn off millicode call
15580 generation.
15582 @item -mmixed-code
15583 @opindex mmixed-code
15584 Tweak register allocation to help 16-bit instruction generation.
15585 This generally has the effect of decreasing the average instruction size
15586 while increasing the instruction count.
15588 @item -mq-class
15589 @opindex mq-class
15590 Enable @samp{q} instruction alternatives.
15591 This is the default for @option{-Os}.
15593 @item -mRcq
15594 @opindex mRcq
15595 Enable @samp{Rcq} constraint handling.  
15596 Most short code generation depends on this.
15597 This is the default.
15599 @item -mRcw
15600 @opindex mRcw
15601 Enable @samp{Rcw} constraint handling.  
15602 Most ccfsm condexec mostly depends on this.
15603 This is the default.
15605 @item -msize-level=@var{level}
15606 @opindex msize-level
15607 Fine-tune size optimization with regards to instruction lengths and alignment.
15608 The recognized values for @var{level} are:
15609 @table @samp
15610 @item 0
15611 No size optimization.  This level is deprecated and treated like @samp{1}.
15613 @item 1
15614 Short instructions are used opportunistically.
15616 @item 2
15617 In addition, alignment of loops and of code after barriers are dropped.
15619 @item 3
15620 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15622 @end table
15624 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15625 the behavior when this is not set is equivalent to level @samp{1}.
15627 @item -mtune=@var{cpu}
15628 @opindex mtune
15629 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15630 by @option{-mcpu=}.
15632 Supported values for @var{cpu} are
15634 @table @samp
15635 @item ARC600
15636 Tune for ARC600 CPU.
15638 @item ARC601
15639 Tune for ARC601 CPU.
15641 @item ARC700
15642 Tune for ARC700 CPU with standard multiplier block.
15644 @item ARC700-xmac
15645 Tune for ARC700 CPU with XMAC block.
15647 @item ARC725D
15648 Tune for ARC725D CPU.
15650 @item ARC750D
15651 Tune for ARC750D CPU.
15653 @end table
15655 @item -mmultcost=@var{num}
15656 @opindex mmultcost
15657 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15658 normal instruction.
15660 @item -munalign-prob-threshold=@var{probability}
15661 @opindex munalign-prob-threshold
15662 Set probability threshold for unaligning branches.
15663 When tuning for @samp{ARC700} and optimizing for speed, branches without
15664 filled delay slot are preferably emitted unaligned and long, unless
15665 profiling indicates that the probability for the branch to be taken
15666 is below @var{probability}.  @xref{Cross-profiling}.
15667 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15669 @end table
15671 The following options are maintained for backward compatibility, but
15672 are now deprecated and will be removed in a future release:
15674 @c Deprecated options
15675 @table @gcctabopt
15677 @item -margonaut
15678 @opindex margonaut
15679 Obsolete FPX.
15681 @item -mbig-endian
15682 @opindex mbig-endian
15683 @itemx -EB
15684 @opindex EB
15685 Compile code for big-endian targets.  Use of these options is now
15686 deprecated.  Big-endian code is supported by configuring GCC to build
15687 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15688 for which big endian is the default.
15690 @item -mlittle-endian
15691 @opindex mlittle-endian
15692 @itemx -EL
15693 @opindex EL
15694 Compile code for little-endian targets.  Use of these options is now
15695 deprecated.  Little-endian code is supported by configuring GCC to build 
15696 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15697 for which little endian is the default.
15699 @item -mbarrel_shifter
15700 @opindex mbarrel_shifter
15701 Replaced by @option{-mbarrel-shifter}.
15703 @item -mdpfp_compact
15704 @opindex mdpfp_compact
15705 Replaced by @option{-mdpfp-compact}.
15707 @item -mdpfp_fast
15708 @opindex mdpfp_fast
15709 Replaced by @option{-mdpfp-fast}.
15711 @item -mdsp_packa
15712 @opindex mdsp_packa
15713 Replaced by @option{-mdsp-packa}.
15715 @item -mEA
15716 @opindex mEA
15717 Replaced by @option{-mea}.
15719 @item -mmac_24
15720 @opindex mmac_24
15721 Replaced by @option{-mmac-24}.
15723 @item -mmac_d16
15724 @opindex mmac_d16
15725 Replaced by @option{-mmac-d16}.
15727 @item -mspfp_compact
15728 @opindex mspfp_compact
15729 Replaced by @option{-mspfp-compact}.
15731 @item -mspfp_fast
15732 @opindex mspfp_fast
15733 Replaced by @option{-mspfp-fast}.
15735 @item -mtune=@var{cpu}
15736 @opindex mtune
15737 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15738 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15739 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15741 @item -multcost=@var{num}
15742 @opindex multcost
15743 Replaced by @option{-mmultcost}.
15745 @end table
15747 @node ARM Options
15748 @subsection ARM Options
15749 @cindex ARM options
15751 These @samp{-m} options are defined for the ARM port:
15753 @table @gcctabopt
15754 @item -mabi=@var{name}
15755 @opindex mabi
15756 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15757 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15759 @item -mapcs-frame
15760 @opindex mapcs-frame
15761 Generate a stack frame that is compliant with the ARM Procedure Call
15762 Standard for all functions, even if this is not strictly necessary for
15763 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15764 with this option causes the stack frames not to be generated for
15765 leaf functions.  The default is @option{-mno-apcs-frame}.
15766 This option is deprecated.
15768 @item -mapcs
15769 @opindex mapcs
15770 This is a synonym for @option{-mapcs-frame} and is deprecated.
15772 @ignore
15773 @c not currently implemented
15774 @item -mapcs-stack-check
15775 @opindex mapcs-stack-check
15776 Generate code to check the amount of stack space available upon entry to
15777 every function (that actually uses some stack space).  If there is
15778 insufficient space available then either the function
15779 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15780 called, depending upon the amount of stack space required.  The runtime
15781 system is required to provide these functions.  The default is
15782 @option{-mno-apcs-stack-check}, since this produces smaller code.
15784 @c not currently implemented
15785 @item -mapcs-reentrant
15786 @opindex mapcs-reentrant
15787 Generate reentrant, position-independent code.  The default is
15788 @option{-mno-apcs-reentrant}.
15789 @end ignore
15791 @item -mthumb-interwork
15792 @opindex mthumb-interwork
15793 Generate code that supports calling between the ARM and Thumb
15794 instruction sets.  Without this option, on pre-v5 architectures, the
15795 two instruction sets cannot be reliably used inside one program.  The
15796 default is @option{-mno-thumb-interwork}, since slightly larger code
15797 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15798 configurations this option is meaningless.
15800 @item -mno-sched-prolog
15801 @opindex mno-sched-prolog
15802 Prevent the reordering of instructions in the function prologue, or the
15803 merging of those instruction with the instructions in the function's
15804 body.  This means that all functions start with a recognizable set
15805 of instructions (or in fact one of a choice from a small set of
15806 different function prologues), and this information can be used to
15807 locate the start of functions inside an executable piece of code.  The
15808 default is @option{-msched-prolog}.
15810 @item -mfloat-abi=@var{name}
15811 @opindex mfloat-abi
15812 Specifies which floating-point ABI to use.  Permissible values
15813 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15815 Specifying @samp{soft} causes GCC to generate output containing
15816 library calls for floating-point operations.
15817 @samp{softfp} allows the generation of code using hardware floating-point
15818 instructions, but still uses the soft-float calling conventions.
15819 @samp{hard} allows generation of floating-point instructions
15820 and uses FPU-specific calling conventions.
15822 The default depends on the specific target configuration.  Note that
15823 the hard-float and soft-float ABIs are not link-compatible; you must
15824 compile your entire program with the same ABI, and link with a
15825 compatible set of libraries.
15827 @item -mlittle-endian
15828 @opindex mlittle-endian
15829 Generate code for a processor running in little-endian mode.  This is
15830 the default for all standard configurations.
15832 @item -mbig-endian
15833 @opindex mbig-endian
15834 Generate code for a processor running in big-endian mode; the default is
15835 to compile code for a little-endian processor.
15837 @item -mbe8
15838 @itemx -mbe32
15839 @opindex mbe8
15840 When linking a big-endian image select between BE8 and BE32 formats.
15841 The option has no effect for little-endian images and is ignored.  The
15842 default is dependent on the selected target architecture.  For ARMv6
15843 and later architectures the default is BE8, for older architectures
15844 the default is BE32.  BE32 format has been deprecated by ARM.
15846 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15847 @opindex march
15848 This specifies the name of the target ARM architecture.  GCC uses this
15849 name to determine what kind of instructions it can emit when generating
15850 assembly code.  This option can be used in conjunction with or instead
15851 of the @option{-mcpu=} option.
15853 Permissible names are:
15854 @samp{armv4t},
15855 @samp{armv5t}, @samp{armv5te},
15856 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15857 @samp{armv6z}, @samp{armv6zk},
15858 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15859 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15860 @samp{armv8.4-a},
15861 @samp{armv7-r},
15862 @samp{armv8-r},
15863 @samp{armv6-m}, @samp{armv6s-m},
15864 @samp{armv7-m}, @samp{armv7e-m},
15865 @samp{armv8-m.base}, @samp{armv8-m.main},
15866 @samp{iwmmxt} and @samp{iwmmxt2}.
15868 Additionally, the following architectures, which lack support for the
15869 Thumb execution state, are recognized but support is deprecated: @samp{armv4}.
15871 Many of the architectures support extensions.  These can be added by
15872 appending @samp{+@var{extension}} to the architecture name.  Extension
15873 options are processed in order and capabilities accumulate.  An extension
15874 will also enable any necessary base extensions
15875 upon which it depends.  For example, the @samp{+crypto} extension
15876 will always enable the @samp{+simd} extension.  The exception to the
15877 additive construction is for extensions that are prefixed with
15878 @samp{+no@dots{}}: these extensions disable the specified option and
15879 any other extensions that may depend on the presence of that
15880 extension.
15882 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15883 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15884 entirely disabled by the @samp{+nofp} option that follows it.
15886 Most extension names are generically named, but have an effect that is
15887 dependent upon the architecture to which it is applied.  For example,
15888 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15889 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15890 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15891 variant for @samp{armv8-a}.
15893 The table below lists the supported extensions for each architecture.
15894 Architectures not mentioned do not support any extensions.
15896 @table @samp
15897 @item armv5te
15898 @itemx armv6
15899 @itemx armv6j
15900 @itemx armv6k
15901 @itemx armv6kz
15902 @itemx armv6t2
15903 @itemx armv6z
15904 @itemx armv6zk
15905 @table @samp
15906 @item +fp
15907 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15908 used as an alias for this extension.
15910 @item +nofp
15911 Disable the floating-point instructions.
15912 @end table
15914 @item armv7
15915 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15916 @table @samp
15917 @item +fp
15918 The VFPv3 floating-point instructions, with 16 double-precision
15919 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15920 for this extension.  Note that floating-point is not supported by the
15921 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15922 ARMv7-R architectures.
15924 @item +nofp
15925 Disable the floating-point instructions.
15926 @end table
15928 @item armv7-a
15929 @table @samp
15930 @item +fp
15931 The VFPv3 floating-point instructions, with 16 double-precision
15932 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15933 for this extension.
15935 @item +simd
15936 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15937 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15938 for this extension.
15940 @item +vfpv3
15941 The VFPv3 floating-point instructions, with 32 double-precision
15942 registers.
15944 @item +vfpv3-d16-fp16
15945 The VFPv3 floating-point instructions, with 16 double-precision
15946 registers and the half-precision floating-point conversion operations.
15948 @item +vfpv3-fp16
15949 The VFPv3 floating-point instructions, with 32 double-precision
15950 registers and the half-precision floating-point conversion operations.
15952 @item +vfpv4-d16
15953 The VFPv4 floating-point instructions, with 16 double-precision
15954 registers.
15956 @item +vfpv4
15957 The VFPv4 floating-point instructions, with 32 double-precision
15958 registers.
15960 @item +neon-fp16
15961 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15962 the half-precision floating-point conversion operations.
15964 @item +neon-vfpv4
15965 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15967 @item +nosimd
15968 Disable the Advanced SIMD instructions (does not disable floating point).
15970 @item +nofp
15971 Disable the floating-point and Advanced SIMD instructions.
15972 @end table
15974 @item armv7ve
15975 The extended version of the ARMv7-A architecture with support for
15976 virtualization.
15977 @table @samp
15978 @item +fp
15979 The VFPv4 floating-point instructions, with 16 double-precision registers.
15980 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15982 @item +simd
15983 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15984 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15986 @item +vfpv3-d16
15987 The VFPv3 floating-point instructions, with 16 double-precision
15988 registers.
15990 @item +vfpv3
15991 The VFPv3 floating-point instructions, with 32 double-precision
15992 registers.
15994 @item +vfpv3-d16-fp16
15995 The VFPv3 floating-point instructions, with 16 double-precision
15996 registers and the half-precision floating-point conversion operations.
15998 @item +vfpv3-fp16
15999 The VFPv3 floating-point instructions, with 32 double-precision
16000 registers and the half-precision floating-point conversion operations.
16002 @item +vfpv4-d16
16003 The VFPv4 floating-point instructions, with 16 double-precision
16004 registers.
16006 @item +vfpv4
16007 The VFPv4 floating-point instructions, with 32 double-precision
16008 registers.
16010 @item +neon
16011 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16012 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16014 @item +neon-fp16
16015 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16016 the half-precision floating-point conversion operations.
16018 @item +nosimd
16019 Disable the Advanced SIMD instructions (does not disable floating point).
16021 @item +nofp
16022 Disable the floating-point and Advanced SIMD instructions.
16023 @end table
16025 @item armv8-a
16026 @table @samp
16027 @item +crc
16028 The Cyclic Redundancy Check (CRC) instructions.
16029 @item +simd
16030 The ARMv8-A Advanced SIMD and floating-point instructions.
16031 @item +crypto
16032 The cryptographic instructions.
16033 @item +nocrypto
16034 Disable the cryptographic instructions.
16035 @item +nofp
16036 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16037 @end table
16039 @item armv8.1-a
16040 @table @samp
16041 @item +simd
16042 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16044 @item +crypto
16045 The cryptographic instructions.  This also enables the Advanced SIMD and
16046 floating-point instructions.
16048 @item +nocrypto
16049 Disable the cryptographic instructions.
16051 @item +nofp
16052 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16053 @end table
16055 @item armv8.2-a
16056 @itemx armv8.3-a
16057 @table @samp
16058 @item +fp16
16059 The half-precision floating-point data processing instructions.
16060 This also enables the Advanced SIMD and floating-point instructions.
16062 @item +fp16fml
16063 The half-precision floating-point fmla extension.  This also enables
16064 the half-precision floating-point extension and Advanced SIMD and
16065 floating-point instructions.
16067 @item +simd
16068 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16070 @item +crypto
16071 The cryptographic instructions.  This also enables the Advanced SIMD and
16072 floating-point instructions.
16074 @item +dotprod
16075 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16077 @item +nocrypto
16078 Disable the cryptographic extension.
16080 @item +nofp
16081 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16082 @end table
16084 @item armv8.4-a
16085 @table @samp
16086 @item +fp16
16087 The half-precision floating-point data processing instructions.
16088 This also enables the Advanced SIMD and floating-point instructions as well
16089 as the Dot Product extension and the half-precision floating-point fmla
16090 extension.
16092 @item +simd
16093 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16094 Dot Product extension.
16096 @item +crypto
16097 The cryptographic instructions.  This also enables the Advanced SIMD and
16098 floating-point instructions as well as the Dot Product extension.
16100 @item +nocrypto
16101 Disable the cryptographic extension.
16103 @item +nofp
16104 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16105 @end table
16107 @item armv7-r
16108 @table @samp
16109 @item +fp.sp
16110 The single-precision VFPv3 floating-point instructions.  The extension
16111 @samp{+vfpv3xd} can be used as an alias for this extension.
16113 @item +fp
16114 The VFPv3 floating-point instructions with 16 double-precision registers.
16115 The extension +vfpv3-d16 can be used as an alias for this extension.
16117 @item +nofp
16118 Disable the floating-point extension.
16120 @item +idiv
16121 The ARM-state integer division instructions.
16123 @item +noidiv
16124 Disable the ARM-state integer division extension.
16125 @end table
16127 @item armv7e-m
16128 @table @samp
16129 @item +fp
16130 The single-precision VFPv4 floating-point instructions.
16132 @item +fpv5
16133 The single-precision FPv5 floating-point instructions.
16135 @item +fp.dp
16136 The single- and double-precision FPv5 floating-point instructions.
16138 @item +nofp
16139 Disable the floating-point extensions.
16140 @end table
16142 @item  armv8-m.main
16143 @table @samp
16144 @item +dsp
16145 The DSP instructions.
16147 @item +nodsp
16148 Disable the DSP extension.
16150 @item +fp
16151 The single-precision floating-point instructions.
16153 @item +fp.dp
16154 The single- and double-precision floating-point instructions.
16156 @item +nofp
16157 Disable the floating-point extension.
16158 @end table
16160 @item armv8-r
16161 @table @samp
16162 @item +crc
16163 The Cyclic Redundancy Check (CRC) instructions.
16164 @item +fp.sp
16165 The single-precision FPv5 floating-point instructions.
16166 @item +simd
16167 The ARMv8-A Advanced SIMD and floating-point instructions.
16168 @item +crypto
16169 The cryptographic instructions.
16170 @item +nocrypto
16171 Disable the cryptographic instructions.
16172 @item +nofp
16173 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16174 @end table
16176 @end table
16178 @option{-march=native} causes the compiler to auto-detect the architecture
16179 of the build computer.  At present, this feature is only supported on
16180 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16181 is unsuccessful the option has no effect.
16183 @item -mtune=@var{name}
16184 @opindex mtune
16185 This option specifies the name of the target ARM processor for
16186 which GCC should tune the performance of the code.
16187 For some ARM implementations better performance can be obtained by using
16188 this option.
16189 Permissible names are: @samp{arm2}, @samp{arm250},
16190 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16191 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16192 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16193 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16194 @samp{arm720},
16195 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16196 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16197 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16198 @samp{strongarm1110},
16199 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16200 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16201 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16202 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16203 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16204 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16205 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16206 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16207 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16208 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16209 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16210 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16211 @samp{cortex-r8}, @samp{cortex-r52},
16212 @samp{cortex-m33},
16213 @samp{cortex-m23},
16214 @samp{cortex-m7},
16215 @samp{cortex-m4},
16216 @samp{cortex-m3},
16217 @samp{cortex-m1},
16218 @samp{cortex-m0},
16219 @samp{cortex-m0plus},
16220 @samp{cortex-m1.small-multiply},
16221 @samp{cortex-m0.small-multiply},
16222 @samp{cortex-m0plus.small-multiply},
16223 @samp{exynos-m1},
16224 @samp{marvell-pj4},
16225 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16226 @samp{fa526}, @samp{fa626},
16227 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16228 @samp{xgene1}.
16230 Additionally, this option can specify that GCC should tune the performance
16231 of the code for a big.LITTLE system.  Permissible names are:
16232 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16233 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16234 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16235 @samp{cortex-a75.cortex-a55}.
16237 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16238 performance for a blend of processors within architecture @var{arch}.
16239 The aim is to generate code that run well on the current most popular
16240 processors, balancing between optimizations that benefit some CPUs in the
16241 range, and avoiding performance pitfalls of other CPUs.  The effects of
16242 this option may change in future GCC versions as CPU models come and go.
16244 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16245 the extension options do not affect the tuning of the generated code.
16247 @option{-mtune=native} causes the compiler to auto-detect the CPU
16248 of the build computer.  At present, this feature is only supported on
16249 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16250 unsuccessful the option has no effect.
16252 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16253 @opindex mcpu
16254 This specifies the name of the target ARM processor.  GCC uses this name
16255 to derive the name of the target ARM architecture (as if specified
16256 by @option{-march}) and the ARM processor type for which to tune for
16257 performance (as if specified by @option{-mtune}).  Where this option
16258 is used in conjunction with @option{-march} or @option{-mtune},
16259 those options take precedence over the appropriate part of this option.
16261 Many of the supported CPUs implement optional architectural
16262 extensions.  Where this is so the architectural extensions are
16263 normally enabled by default.  If implementations that lack the
16264 extension exist, then the extension syntax can be used to disable
16265 those extensions that have been omitted.  For floating-point and
16266 Advanced SIMD (Neon) instructions, the settings of the options
16267 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16268 floating-point and Advanced SIMD instructions will only be used if
16269 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16270 @option{-mfpu} other than @samp{auto} will override the available
16271 floating-point and SIMD extension instructions.
16273 For example, @samp{cortex-a9} can be found in three major
16274 configurations: integer only, with just a floating-point unit or with
16275 floating-point and Advanced SIMD.  The default is to enable all the
16276 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16277 be used to disable just the SIMD or both the SIMD and floating-point
16278 instructions respectively.
16280 Permissible names for this option are the same as those for
16281 @option{-mtune}.
16283 The following extension options are common to the listed CPUs:
16285 @table @samp
16286 @item +nodsp
16287 Disable the DSP instructions on @samp{cortex-m33}.
16289 @item  +nofp
16290 Disables the floating-point instructions on @samp{arm9e},
16291 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16292 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16293 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16294 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16295 Disables the floating-point and SIMD instructions on
16296 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16297 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16298 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16299 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16300 @samp{cortex-a53} and @samp{cortex-a55}.
16302 @item +nofp.dp
16303 Disables the double-precision component of the floating-point instructions
16304 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16306 @item +nosimd
16307 Disables the SIMD (but not floating-point) instructions on
16308 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16309 and @samp{cortex-a9}.
16311 @item +crypto
16312 Enables the cryptographic instructions on @samp{cortex-a32},
16313 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16314 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16315 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16316 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16317 @samp{cortex-a75.cortex-a55}.
16318 @end table
16320 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16321 VFPv3 with 16 double-precision registers.  It supports the following
16322 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16323 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16324 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16325 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16326 @option{-march=armv7-a}.
16328 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16329 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16330 See @option{-mtune} for more information.
16332 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16333 of the build computer.  At present, this feature is only supported on
16334 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16335 is unsuccessful the option has no effect.
16337 @item -mfpu=@var{name}
16338 @opindex mfpu
16339 This specifies what floating-point hardware (or hardware emulation) is
16340 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16341 @samp{vfpv3},
16342 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16343 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16344 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16345 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16346 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16347 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16348 is an alias for @samp{vfpv2}.
16350 The setting @samp{auto} is the default and is special.  It causes the
16351 compiler to select the floating-point and Advanced SIMD instructions
16352 based on the settings of @option{-mcpu} and @option{-march}.
16354 If the selected floating-point hardware includes the NEON extension
16355 (e.g. @option{-mfpu=neon}), note that floating-point
16356 operations are not generated by GCC's auto-vectorization pass unless
16357 @option{-funsafe-math-optimizations} is also specified.  This is
16358 because NEON hardware does not fully implement the IEEE 754 standard for
16359 floating-point arithmetic (in particular denormal values are treated as
16360 zero), so the use of NEON instructions may lead to a loss of precision.
16362 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}).
16364 @item -mfp16-format=@var{name}
16365 @opindex mfp16-format
16366 Specify the format of the @code{__fp16} half-precision floating-point type.
16367 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16368 the default is @samp{none}, in which case the @code{__fp16} type is not
16369 defined.  @xref{Half-Precision}, for more information.
16371 @item -mstructure-size-boundary=@var{n}
16372 @opindex mstructure-size-boundary
16373 The sizes of all structures and unions are rounded up to a multiple
16374 of the number of bits set by this option.  Permissible values are 8, 32
16375 and 64.  The default value varies for different toolchains.  For the COFF
16376 targeted toolchain the default value is 8.  A value of 64 is only allowed
16377 if the underlying ABI supports it.
16379 Specifying a larger number can produce faster, more efficient code, but
16380 can also increase the size of the program.  Different values are potentially
16381 incompatible.  Code compiled with one value cannot necessarily expect to
16382 work with code or libraries compiled with another value, if they exchange
16383 information using structures or unions.
16385 This option is deprecated.
16387 @item -mabort-on-noreturn
16388 @opindex mabort-on-noreturn
16389 Generate a call to the function @code{abort} at the end of a
16390 @code{noreturn} function.  It is executed if the function tries to
16391 return.
16393 @item -mlong-calls
16394 @itemx -mno-long-calls
16395 @opindex mlong-calls
16396 @opindex mno-long-calls
16397 Tells the compiler to perform function calls by first loading the
16398 address of the function into a register and then performing a subroutine
16399 call on this register.  This switch is needed if the target function
16400 lies outside of the 64-megabyte addressing range of the offset-based
16401 version of subroutine call instruction.
16403 Even if this switch is enabled, not all function calls are turned
16404 into long calls.  The heuristic is that static functions, functions
16405 that have the @code{short_call} attribute, functions that are inside
16406 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16407 definitions have already been compiled within the current compilation
16408 unit are not turned into long calls.  The exceptions to this rule are
16409 that weak function definitions, functions with the @code{long_call}
16410 attribute or the @code{section} attribute, and functions that are within
16411 the scope of a @code{#pragma long_calls} directive are always
16412 turned into long calls.
16414 This feature is not enabled by default.  Specifying
16415 @option{-mno-long-calls} restores the default behavior, as does
16416 placing the function calls within the scope of a @code{#pragma
16417 long_calls_off} directive.  Note these switches have no effect on how
16418 the compiler generates code to handle function calls via function
16419 pointers.
16421 @item -msingle-pic-base
16422 @opindex msingle-pic-base
16423 Treat the register used for PIC addressing as read-only, rather than
16424 loading it in the prologue for each function.  The runtime system is
16425 responsible for initializing this register with an appropriate value
16426 before execution begins.
16428 @item -mpic-register=@var{reg}
16429 @opindex mpic-register
16430 Specify the register to be used for PIC addressing.
16431 For standard PIC base case, the default is any suitable register
16432 determined by compiler.  For single PIC base case, the default is
16433 @samp{R9} if target is EABI based or stack-checking is enabled,
16434 otherwise the default is @samp{R10}.
16436 @item -mpic-data-is-text-relative
16437 @opindex mpic-data-is-text-relative
16438 Assume that the displacement between the text and data segments is fixed
16439 at static link time.  This permits using PC-relative addressing
16440 operations to access data known to be in the data segment.  For
16441 non-VxWorks RTP targets, this option is enabled by default.  When
16442 disabled on such targets, it will enable @option{-msingle-pic-base} by
16443 default.
16445 @item -mpoke-function-name
16446 @opindex mpoke-function-name
16447 Write the name of each function into the text section, directly
16448 preceding the function prologue.  The generated code is similar to this:
16450 @smallexample
16451      t0
16452          .ascii "arm_poke_function_name", 0
16453          .align
16454      t1
16455          .word 0xff000000 + (t1 - t0)
16456      arm_poke_function_name
16457          mov     ip, sp
16458          stmfd   sp!, @{fp, ip, lr, pc@}
16459          sub     fp, ip, #4
16460 @end smallexample
16462 When performing a stack backtrace, code can inspect the value of
16463 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16464 location @code{pc - 12} and the top 8 bits are set, then we know that
16465 there is a function name embedded immediately preceding this location
16466 and has length @code{((pc[-3]) & 0xff000000)}.
16468 @item -mthumb
16469 @itemx -marm
16470 @opindex marm
16471 @opindex mthumb
16473 Select between generating code that executes in ARM and Thumb
16474 states.  The default for most configurations is to generate code
16475 that executes in ARM state, but the default can be changed by
16476 configuring GCC with the @option{--with-mode=}@var{state}
16477 configure option.
16479 You can also override the ARM and Thumb mode for each function
16480 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16481 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16483 @item -mflip-thumb 
16484 @opindex mflip-thumb
16485 Switch ARM/Thumb modes on alternating functions.
16486 This option is provided for regression testing of mixed Thumb/ARM code
16487 generation, and is not intended for ordinary use in compiling code.
16489 @item -mtpcs-frame
16490 @opindex mtpcs-frame
16491 Generate a stack frame that is compliant with the Thumb Procedure Call
16492 Standard for all non-leaf functions.  (A leaf function is one that does
16493 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16495 @item -mtpcs-leaf-frame
16496 @opindex mtpcs-leaf-frame
16497 Generate a stack frame that is compliant with the Thumb Procedure Call
16498 Standard for all leaf functions.  (A leaf function is one that does
16499 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16501 @item -mcallee-super-interworking
16502 @opindex mcallee-super-interworking
16503 Gives all externally visible functions in the file being compiled an ARM
16504 instruction set header which switches to Thumb mode before executing the
16505 rest of the function.  This allows these functions to be called from
16506 non-interworking code.  This option is not valid in AAPCS configurations
16507 because interworking is enabled by default.
16509 @item -mcaller-super-interworking
16510 @opindex mcaller-super-interworking
16511 Allows calls via function pointers (including virtual functions) to
16512 execute correctly regardless of whether the target code has been
16513 compiled for interworking or not.  There is a small overhead in the cost
16514 of executing a function pointer if this option is enabled.  This option
16515 is not valid in AAPCS configurations because interworking is enabled
16516 by default.
16518 @item -mtp=@var{name}
16519 @opindex mtp
16520 Specify the access model for the thread local storage pointer.  The valid
16521 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16522 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16523 (supported in the arm6k architecture), and @samp{auto}, which uses the
16524 best available method for the selected processor.  The default setting is
16525 @samp{auto}.
16527 @item -mtls-dialect=@var{dialect}
16528 @opindex mtls-dialect
16529 Specify the dialect to use for accessing thread local storage.  Two
16530 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16531 @samp{gnu} dialect selects the original GNU scheme for supporting
16532 local and global dynamic TLS models.  The @samp{gnu2} dialect
16533 selects the GNU descriptor scheme, which provides better performance
16534 for shared libraries.  The GNU descriptor scheme is compatible with
16535 the original scheme, but does require new assembler, linker and
16536 library support.  Initial and local exec TLS models are unaffected by
16537 this option and always use the original scheme.
16539 @item -mword-relocations
16540 @opindex mword-relocations
16541 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16542 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16543 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16544 is specified.
16546 @item -mfix-cortex-m3-ldrd
16547 @opindex mfix-cortex-m3-ldrd
16548 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16549 with overlapping destination and base registers are used.  This option avoids
16550 generating these instructions.  This option is enabled by default when
16551 @option{-mcpu=cortex-m3} is specified.
16553 @item -munaligned-access
16554 @itemx -mno-unaligned-access
16555 @opindex munaligned-access
16556 @opindex mno-unaligned-access
16557 Enables (or disables) reading and writing of 16- and 32- bit values
16558 from addresses that are not 16- or 32- bit aligned.  By default
16559 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16560 ARMv8-M Baseline architectures, and enabled for all other
16561 architectures.  If unaligned access is not enabled then words in packed
16562 data structures are accessed a byte at a time.
16564 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16565 generated object file to either true or false, depending upon the
16566 setting of this option.  If unaligned access is enabled then the
16567 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16568 defined.
16570 @item -mneon-for-64bits
16571 @opindex mneon-for-64bits
16572 Enables using Neon to handle scalar 64-bits operations. This is
16573 disabled by default since the cost of moving data from core registers
16574 to Neon is high.
16576 @item -mslow-flash-data
16577 @opindex mslow-flash-data
16578 Assume loading data from flash is slower than fetching instruction.
16579 Therefore literal load is minimized for better performance.
16580 This option is only supported when compiling for ARMv7 M-profile and
16581 off by default.
16583 @item -masm-syntax-unified
16584 @opindex masm-syntax-unified
16585 Assume inline assembler is using unified asm syntax.  The default is
16586 currently off which implies divided syntax.  This option has no impact
16587 on Thumb2. However, this may change in future releases of GCC.
16588 Divided syntax should be considered deprecated.
16590 @item -mrestrict-it
16591 @opindex mrestrict-it
16592 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16593 IT blocks can only contain a single 16-bit instruction from a select
16594 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16596 @item -mprint-tune-info
16597 @opindex mprint-tune-info
16598 Print CPU tuning information as comment in assembler file.  This is
16599 an option used only for regression testing of the compiler and not
16600 intended for ordinary use in compiling code.  This option is disabled
16601 by default.
16603 @item -mverbose-cost-dump
16604 @opindex mverbose-cost-dump
16605 Enable verbose cost model dumping in the debug dump files.  This option is
16606 provided for use in debugging the compiler.
16608 @item -mpure-code
16609 @opindex mpure-code
16610 Do not allow constant data to be placed in code sections.
16611 Additionally, when compiling for ELF object format give all text sections the
16612 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16613 is only available when generating non-pic code for M-profile targets with the
16614 MOVT instruction.
16616 @item -mcmse
16617 @opindex mcmse
16618 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16619 Development Tools Engineering Specification", which can be found on
16620 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16621 @end table
16623 @node AVR Options
16624 @subsection AVR Options
16625 @cindex AVR Options
16627 These options are defined for AVR implementations:
16629 @table @gcctabopt
16630 @item -mmcu=@var{mcu}
16631 @opindex mmcu
16632 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16634 The default for this option is@tie{}@samp{avr2}.
16636 GCC supports the following AVR devices and ISAs:
16638 @include avr-mmcu.texi
16640 @item -mabsdata
16641 @opindex mabsdata
16643 Assume that all data in static storage can be accessed by LDS / STS
16644 instructions.  This option has only an effect on reduced Tiny devices like
16645 ATtiny40.  See also the @code{absdata}
16646 @ref{AVR Variable Attributes,variable attribute}.
16648 @item -maccumulate-args
16649 @opindex maccumulate-args
16650 Accumulate outgoing function arguments and acquire/release the needed
16651 stack space for outgoing function arguments once in function
16652 prologue/epilogue.  Without this option, outgoing arguments are pushed
16653 before calling a function and popped afterwards.
16655 Popping the arguments after the function call can be expensive on
16656 AVR so that accumulating the stack space might lead to smaller
16657 executables because arguments need not be removed from the
16658 stack after such a function call.
16660 This option can lead to reduced code size for functions that perform
16661 several calls to functions that get their arguments on the stack like
16662 calls to printf-like functions.
16664 @item -mbranch-cost=@var{cost}
16665 @opindex mbranch-cost
16666 Set the branch costs for conditional branch instructions to
16667 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16668 integers. The default branch cost is 0.
16670 @item -mcall-prologues
16671 @opindex mcall-prologues
16672 Functions prologues/epilogues are expanded as calls to appropriate
16673 subroutines.  Code size is smaller.
16675 @item -mgas-isr-prologues
16676 @opindex mgas-isr-prologues
16677 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16678 instruction supported by GNU Binutils.
16679 If this option is on, the feature can still be disabled for individual
16680 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16681 function attribute.  This feature is activated per default
16682 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16683 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16685 @item -mint8
16686 @opindex mint8
16687 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16688 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16689 and @code{long long} is 4 bytes.  Please note that this option does not
16690 conform to the C standards, but it results in smaller code
16691 size.
16693 @item -mmain-is-OS_task
16694 @opindex mmain-is-OS_task
16695 Do not save registers in @code{main}.  The effect is the same like
16696 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16697 to @code{main}. It is activated per default if optimization is on.
16699 @item -mn-flash=@var{num}
16700 @opindex mn-flash
16701 Assume that the flash memory has a size of 
16702 @var{num} times 64@tie{}KiB.
16704 @item -mno-interrupts
16705 @opindex mno-interrupts
16706 Generated code is not compatible with hardware interrupts.
16707 Code size is smaller.
16709 @item -mrelax
16710 @opindex mrelax
16711 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16712 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16713 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16714 the assembler's command line and the @option{--relax} option to the
16715 linker's command line.
16717 Jump relaxing is performed by the linker because jump offsets are not
16718 known before code is located. Therefore, the assembler code generated by the
16719 compiler is the same, but the instructions in the executable may
16720 differ from instructions in the assembler code.
16722 Relaxing must be turned on if linker stubs are needed, see the
16723 section on @code{EIND} and linker stubs below.
16725 @item -mrmw
16726 @opindex mrmw
16727 Assume that the device supports the Read-Modify-Write
16728 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16730 @item -mshort-calls
16731 @opindex mshort-calls
16733 Assume that @code{RJMP} and @code{RCALL} can target the whole
16734 program memory.
16736 This option is used internally for multilib selection.  It is
16737 not an optimization option, and you don't need to set it by hand.
16739 @item -msp8
16740 @opindex msp8
16741 Treat the stack pointer register as an 8-bit register,
16742 i.e.@: assume the high byte of the stack pointer is zero.
16743 In general, you don't need to set this option by hand.
16745 This option is used internally by the compiler to select and
16746 build multilibs for architectures @code{avr2} and @code{avr25}.
16747 These architectures mix devices with and without @code{SPH}.
16748 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16749 the compiler driver adds or removes this option from the compiler
16750 proper's command line, because the compiler then knows if the device
16751 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16752 register or not.
16754 @item -mstrict-X
16755 @opindex mstrict-X
16756 Use address register @code{X} in a way proposed by the hardware.  This means
16757 that @code{X} is only used in indirect, post-increment or
16758 pre-decrement addressing.
16760 Without this option, the @code{X} register may be used in the same way
16761 as @code{Y} or @code{Z} which then is emulated by additional
16762 instructions.  
16763 For example, loading a value with @code{X+const} addressing with a
16764 small non-negative @code{const < 64} to a register @var{Rn} is
16765 performed as
16767 @example
16768 adiw r26, const   ; X += const
16769 ld   @var{Rn}, X        ; @var{Rn} = *X
16770 sbiw r26, const   ; X -= const
16771 @end example
16773 @item -mtiny-stack
16774 @opindex mtiny-stack
16775 Only change the lower 8@tie{}bits of the stack pointer.
16777 @item -mfract-convert-truncate
16778 @opindex mfract-convert-truncate
16779 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16781 @item -nodevicelib
16782 @opindex nodevicelib
16783 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16785 @item -Waddr-space-convert
16786 @opindex Waddr-space-convert
16787 @opindex Wno-addr-space-convert
16788 Warn about conversions between address spaces in the case where the
16789 resulting address space is not contained in the incoming address space.
16791 @item -Wmisspelled-isr
16792 @opindex Wmisspelled-isr
16793 @opindex Wno-misspelled-isr
16794 Warn if the ISR is misspelled, i.e. without __vector prefix.
16795 Enabled by default.
16796 @end table
16798 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16799 @cindex @code{EIND}
16800 Pointers in the implementation are 16@tie{}bits wide.
16801 The address of a function or label is represented as word address so
16802 that indirect jumps and calls can target any code address in the
16803 range of 64@tie{}Ki words.
16805 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16806 bytes of program memory space, there is a special function register called
16807 @code{EIND} that serves as most significant part of the target address
16808 when @code{EICALL} or @code{EIJMP} instructions are used.
16810 Indirect jumps and calls on these devices are handled as follows by
16811 the compiler and are subject to some limitations:
16813 @itemize @bullet
16815 @item
16816 The compiler never sets @code{EIND}.
16818 @item
16819 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16820 instructions or might read @code{EIND} directly in order to emulate an
16821 indirect call/jump by means of a @code{RET} instruction.
16823 @item
16824 The compiler assumes that @code{EIND} never changes during the startup
16825 code or during the application. In particular, @code{EIND} is not
16826 saved/restored in function or interrupt service routine
16827 prologue/epilogue.
16829 @item
16830 For indirect calls to functions and computed goto, the linker
16831 generates @emph{stubs}. Stubs are jump pads sometimes also called
16832 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16833 The stub contains a direct jump to the desired address.
16835 @item
16836 Linker relaxation must be turned on so that the linker generates
16837 the stubs correctly in all situations. See the compiler option
16838 @option{-mrelax} and the linker option @option{--relax}.
16839 There are corner cases where the linker is supposed to generate stubs
16840 but aborts without relaxation and without a helpful error message.
16842 @item
16843 The default linker script is arranged for code with @code{EIND = 0}.
16844 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16845 linker script has to be used in order to place the sections whose
16846 name start with @code{.trampolines} into the segment where @code{EIND}
16847 points to.
16849 @item
16850 The startup code from libgcc never sets @code{EIND}.
16851 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16852 For the impact of AVR-LibC on @code{EIND}, see the
16853 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16855 @item
16856 It is legitimate for user-specific startup code to set up @code{EIND}
16857 early, for example by means of initialization code located in
16858 section @code{.init3}. Such code runs prior to general startup code
16859 that initializes RAM and calls constructors, but after the bit
16860 of startup code from AVR-LibC that sets @code{EIND} to the segment
16861 where the vector table is located.
16862 @example
16863 #include <avr/io.h>
16865 static void
16866 __attribute__((section(".init3"),naked,used,no_instrument_function))
16867 init3_set_eind (void)
16869   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16870                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16872 @end example
16874 @noindent
16875 The @code{__trampolines_start} symbol is defined in the linker script.
16877 @item
16878 Stubs are generated automatically by the linker if
16879 the following two conditions are met:
16880 @itemize @minus
16882 @item The address of a label is taken by means of the @code{gs} modifier
16883 (short for @emph{generate stubs}) like so:
16884 @example
16885 LDI r24, lo8(gs(@var{func}))
16886 LDI r25, hi8(gs(@var{func}))
16887 @end example
16888 @item The final location of that label is in a code segment
16889 @emph{outside} the segment where the stubs are located.
16890 @end itemize
16892 @item
16893 The compiler emits such @code{gs} modifiers for code labels in the
16894 following situations:
16895 @itemize @minus
16896 @item Taking address of a function or code label.
16897 @item Computed goto.
16898 @item If prologue-save function is used, see @option{-mcall-prologues}
16899 command-line option.
16900 @item Switch/case dispatch tables. If you do not want such dispatch
16901 tables you can specify the @option{-fno-jump-tables} command-line option.
16902 @item C and C++ constructors/destructors called during startup/shutdown.
16903 @item If the tools hit a @code{gs()} modifier explained above.
16904 @end itemize
16906 @item
16907 Jumping to non-symbolic addresses like so is @emph{not} supported:
16909 @example
16910 int main (void)
16912     /* Call function at word address 0x2 */
16913     return ((int(*)(void)) 0x2)();
16915 @end example
16917 Instead, a stub has to be set up, i.e.@: the function has to be called
16918 through a symbol (@code{func_4} in the example):
16920 @example
16921 int main (void)
16923     extern int func_4 (void);
16925     /* Call function at byte address 0x4 */
16926     return func_4();
16928 @end example
16930 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16931 Alternatively, @code{func_4} can be defined in the linker script.
16932 @end itemize
16934 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16935 @cindex @code{RAMPD}
16936 @cindex @code{RAMPX}
16937 @cindex @code{RAMPY}
16938 @cindex @code{RAMPZ}
16939 Some AVR devices support memories larger than the 64@tie{}KiB range
16940 that can be accessed with 16-bit pointers.  To access memory locations
16941 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16942 register is used as high part of the address:
16943 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16944 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16945 register, respectively, to get a wide address. Similarly,
16946 @code{RAMPD} is used together with direct addressing.
16948 @itemize
16949 @item
16950 The startup code initializes the @code{RAMP} special function
16951 registers with zero.
16953 @item
16954 If a @ref{AVR Named Address Spaces,named address space} other than
16955 generic or @code{__flash} is used, then @code{RAMPZ} is set
16956 as needed before the operation.
16958 @item
16959 If the device supports RAM larger than 64@tie{}KiB and the compiler
16960 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16961 is reset to zero after the operation.
16963 @item
16964 If the device comes with a specific @code{RAMP} register, the ISR
16965 prologue/epilogue saves/restores that SFR and initializes it with
16966 zero in case the ISR code might (implicitly) use it.
16968 @item
16969 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16970 If you use inline assembler to read from locations outside the
16971 16-bit address range and change one of the @code{RAMP} registers,
16972 you must reset it to zero after the access.
16974 @end itemize
16976 @subsubsection AVR Built-in Macros
16978 GCC defines several built-in macros so that the user code can test
16979 for the presence or absence of features.  Almost any of the following
16980 built-in macros are deduced from device capabilities and thus
16981 triggered by the @option{-mmcu=} command-line option.
16983 For even more AVR-specific built-in macros see
16984 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16986 @table @code
16988 @item __AVR_ARCH__
16989 Build-in macro that resolves to a decimal number that identifies the
16990 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16991 Possible values are:
16993 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16994 @code{4}, @code{5}, @code{51}, @code{6}
16996 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16997 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16999 respectively and
17001 @code{100},
17002 @code{102}, @code{103}, @code{104},
17003 @code{105}, @code{106}, @code{107}
17005 for @var{mcu}=@code{avrtiny},
17006 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17007 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17008 If @var{mcu} specifies a device, this built-in macro is set
17009 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17010 defined to @code{4}.
17012 @item __AVR_@var{Device}__
17013 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17014 the device's name. For example, @option{-mmcu=atmega8} defines the
17015 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17016 @code{__AVR_ATtiny261A__}, etc.
17018 The built-in macros' names follow
17019 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17020 the device name as from the AVR user manual. The difference between
17021 @var{Device} in the built-in macro and @var{device} in
17022 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17024 If @var{device} is not a device but only a core architecture like
17025 @samp{avr51}, this macro is not defined.
17027 @item __AVR_DEVICE_NAME__
17028 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17029 the device's name. For example, with @option{-mmcu=atmega8} the macro
17030 is defined to @code{atmega8}.
17032 If @var{device} is not a device but only a core architecture like
17033 @samp{avr51}, this macro is not defined.
17035 @item __AVR_XMEGA__
17036 The device / architecture belongs to the XMEGA family of devices.
17038 @item __AVR_HAVE_ELPM__
17039 The device has the @code{ELPM} instruction.
17041 @item __AVR_HAVE_ELPMX__
17042 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17043 R@var{n},Z+} instructions.
17045 @item __AVR_HAVE_MOVW__
17046 The device has the @code{MOVW} instruction to perform 16-bit
17047 register-register moves.
17049 @item __AVR_HAVE_LPMX__
17050 The device has the @code{LPM R@var{n},Z} and
17051 @code{LPM R@var{n},Z+} instructions.
17053 @item __AVR_HAVE_MUL__
17054 The device has a hardware multiplier. 
17056 @item __AVR_HAVE_JMP_CALL__
17057 The device has the @code{JMP} and @code{CALL} instructions.
17058 This is the case for devices with more than 8@tie{}KiB of program
17059 memory.
17061 @item __AVR_HAVE_EIJMP_EICALL__
17062 @itemx __AVR_3_BYTE_PC__
17063 The device has the @code{EIJMP} and @code{EICALL} instructions.
17064 This is the case for devices with more than 128@tie{}KiB of program memory.
17065 This also means that the program counter
17066 (PC) is 3@tie{}bytes wide.
17068 @item __AVR_2_BYTE_PC__
17069 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17070 with up to 128@tie{}KiB of program memory.
17072 @item __AVR_HAVE_8BIT_SP__
17073 @itemx __AVR_HAVE_16BIT_SP__
17074 The stack pointer (SP) register is treated as 8-bit respectively
17075 16-bit register by the compiler.
17076 The definition of these macros is affected by @option{-mtiny-stack}.
17078 @item __AVR_HAVE_SPH__
17079 @itemx __AVR_SP8__
17080 The device has the SPH (high part of stack pointer) special function
17081 register or has an 8-bit stack pointer, respectively.
17082 The definition of these macros is affected by @option{-mmcu=} and
17083 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17084 by @option{-msp8}.
17086 @item __AVR_HAVE_RAMPD__
17087 @itemx __AVR_HAVE_RAMPX__
17088 @itemx __AVR_HAVE_RAMPY__
17089 @itemx __AVR_HAVE_RAMPZ__
17090 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17091 @code{RAMPZ} special function register, respectively.
17093 @item __NO_INTERRUPTS__
17094 This macro reflects the @option{-mno-interrupts} command-line option.
17096 @item __AVR_ERRATA_SKIP__
17097 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17098 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17099 instructions because of a hardware erratum.  Skip instructions are
17100 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17101 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17102 set.
17104 @item __AVR_ISA_RMW__
17105 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17107 @item __AVR_SFR_OFFSET__=@var{offset}
17108 Instructions that can address I/O special function registers directly
17109 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17110 address as if addressed by an instruction to access RAM like @code{LD}
17111 or @code{STS}. This offset depends on the device architecture and has
17112 to be subtracted from the RAM address in order to get the
17113 respective I/O@tie{}address.
17115 @item __AVR_SHORT_CALLS__
17116 The @option{-mshort-calls} command line option is set.
17118 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17119 Some devices support reading from flash memory by means of @code{LD*}
17120 instructions.  The flash memory is seen in the data address space
17121 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17122 is not defined, this feature is not available.  If defined,
17123 the address space is linear and there is no need to put
17124 @code{.rodata} into RAM.  This is handled by the default linker
17125 description file, and is currently available for
17126 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17127 there is no need to use address spaces like @code{__flash} or
17128 features like attribute @code{progmem} and @code{pgm_read_*}.
17130 @item __WITH_AVRLIBC__
17131 The compiler is configured to be used together with AVR-Libc.
17132 See the @option{--with-avrlibc} configure option.
17134 @end table
17136 @node Blackfin Options
17137 @subsection Blackfin Options
17138 @cindex Blackfin Options
17140 @table @gcctabopt
17141 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17142 @opindex mcpu=
17143 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17144 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17145 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17146 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17147 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17148 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17149 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17150 @samp{bf561}, @samp{bf592}.
17152 The optional @var{sirevision} specifies the silicon revision of the target
17153 Blackfin processor.  Any workarounds available for the targeted silicon revision
17154 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17155 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17156 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17157 hexadecimal digits representing the major and minor numbers in the silicon
17158 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17159 is not defined.  If @var{sirevision} is @samp{any}, the
17160 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17161 If this optional @var{sirevision} is not used, GCC assumes the latest known
17162 silicon revision of the targeted Blackfin processor.
17164 GCC defines a preprocessor macro for the specified @var{cpu}.
17165 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17166 provided by libgloss to be linked in if @option{-msim} is not given.
17168 Without this option, @samp{bf532} is used as the processor by default.
17170 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17171 only the preprocessor macro is defined.
17173 @item -msim
17174 @opindex msim
17175 Specifies that the program will be run on the simulator.  This causes
17176 the simulator BSP provided by libgloss to be linked in.  This option
17177 has effect only for @samp{bfin-elf} toolchain.
17178 Certain other options, such as @option{-mid-shared-library} and
17179 @option{-mfdpic}, imply @option{-msim}.
17181 @item -momit-leaf-frame-pointer
17182 @opindex momit-leaf-frame-pointer
17183 Don't keep the frame pointer in a register for leaf functions.  This
17184 avoids the instructions to save, set up and restore frame pointers and
17185 makes an extra register available in leaf functions.
17187 @item -mspecld-anomaly
17188 @opindex mspecld-anomaly
17189 When enabled, the compiler ensures that the generated code does not
17190 contain speculative loads after jump instructions. If this option is used,
17191 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17193 @item -mno-specld-anomaly
17194 @opindex mno-specld-anomaly
17195 Don't generate extra code to prevent speculative loads from occurring.
17197 @item -mcsync-anomaly
17198 @opindex mcsync-anomaly
17199 When enabled, the compiler ensures that the generated code does not
17200 contain CSYNC or SSYNC instructions too soon after conditional branches.
17201 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17203 @item -mno-csync-anomaly
17204 @opindex mno-csync-anomaly
17205 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17206 occurring too soon after a conditional branch.
17208 @item -mlow-64k
17209 @opindex mlow-64k
17210 When enabled, the compiler is free to take advantage of the knowledge that
17211 the entire program fits into the low 64k of memory.
17213 @item -mno-low-64k
17214 @opindex mno-low-64k
17215 Assume that the program is arbitrarily large.  This is the default.
17217 @item -mstack-check-l1
17218 @opindex mstack-check-l1
17219 Do stack checking using information placed into L1 scratchpad memory by the
17220 uClinux kernel.
17222 @item -mid-shared-library
17223 @opindex mid-shared-library
17224 Generate code that supports shared libraries via the library ID method.
17225 This allows for execute in place and shared libraries in an environment
17226 without virtual memory management.  This option implies @option{-fPIC}.
17227 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17229 @item -mno-id-shared-library
17230 @opindex mno-id-shared-library
17231 Generate code that doesn't assume ID-based shared libraries are being used.
17232 This is the default.
17234 @item -mleaf-id-shared-library
17235 @opindex mleaf-id-shared-library
17236 Generate code that supports shared libraries via the library ID method,
17237 but assumes that this library or executable won't link against any other
17238 ID shared libraries.  That allows the compiler to use faster code for jumps
17239 and calls.
17241 @item -mno-leaf-id-shared-library
17242 @opindex mno-leaf-id-shared-library
17243 Do not assume that the code being compiled won't link against any ID shared
17244 libraries.  Slower code is generated for jump and call insns.
17246 @item -mshared-library-id=n
17247 @opindex mshared-library-id
17248 Specifies the identification number of the ID-based shared library being
17249 compiled.  Specifying a value of 0 generates more compact code; specifying
17250 other values forces the allocation of that number to the current
17251 library but is no more space- or time-efficient than omitting this option.
17253 @item -msep-data
17254 @opindex msep-data
17255 Generate code that allows the data segment to be located in a different
17256 area of memory from the text segment.  This allows for execute in place in
17257 an environment without virtual memory management by eliminating relocations
17258 against the text section.
17260 @item -mno-sep-data
17261 @opindex mno-sep-data
17262 Generate code that assumes that the data segment follows the text segment.
17263 This is the default.
17265 @item -mlong-calls
17266 @itemx -mno-long-calls
17267 @opindex mlong-calls
17268 @opindex mno-long-calls
17269 Tells the compiler to perform function calls by first loading the
17270 address of the function into a register and then performing a subroutine
17271 call on this register.  This switch is needed if the target function
17272 lies outside of the 24-bit addressing range of the offset-based
17273 version of subroutine call instruction.
17275 This feature is not enabled by default.  Specifying
17276 @option{-mno-long-calls} restores the default behavior.  Note these
17277 switches have no effect on how the compiler generates code to handle
17278 function calls via function pointers.
17280 @item -mfast-fp
17281 @opindex mfast-fp
17282 Link with the fast floating-point library. This library relaxes some of
17283 the IEEE floating-point standard's rules for checking inputs against
17284 Not-a-Number (NAN), in the interest of performance.
17286 @item -minline-plt
17287 @opindex minline-plt
17288 Enable inlining of PLT entries in function calls to functions that are
17289 not known to bind locally.  It has no effect without @option{-mfdpic}.
17291 @item -mmulticore
17292 @opindex mmulticore
17293 Build a standalone application for multicore Blackfin processors. 
17294 This option causes proper start files and link scripts supporting 
17295 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17296 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17298 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17299 selects the one-application-per-core programming model.  Without
17300 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17301 programming model is used. In this model, the main function of Core B
17302 should be named as @code{coreb_main}.
17304 If this option is not used, the single-core application programming
17305 model is used.
17307 @item -mcorea
17308 @opindex mcorea
17309 Build a standalone application for Core A of BF561 when using
17310 the one-application-per-core programming model. Proper start files
17311 and link scripts are used to support Core A, and the macro
17312 @code{__BFIN_COREA} is defined.
17313 This option can only be used in conjunction with @option{-mmulticore}.
17315 @item -mcoreb
17316 @opindex mcoreb
17317 Build a standalone application for Core B of BF561 when using
17318 the one-application-per-core programming model. Proper start files
17319 and link scripts are used to support Core B, and the macro
17320 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17321 should be used instead of @code{main}. 
17322 This option can only be used in conjunction with @option{-mmulticore}.
17324 @item -msdram
17325 @opindex msdram
17326 Build a standalone application for SDRAM. Proper start files and
17327 link scripts are used to put the application into SDRAM, and the macro
17328 @code{__BFIN_SDRAM} is defined.
17329 The loader should initialize SDRAM before loading the application.
17331 @item -micplb
17332 @opindex micplb
17333 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17334 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17335 are enabled; for standalone applications the default is off.
17336 @end table
17338 @node C6X Options
17339 @subsection C6X Options
17340 @cindex C6X Options
17342 @table @gcctabopt
17343 @item -march=@var{name}
17344 @opindex march
17345 This specifies the name of the target architecture.  GCC uses this
17346 name to determine what kind of instructions it can emit when generating
17347 assembly code.  Permissible names are: @samp{c62x},
17348 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17350 @item -mbig-endian
17351 @opindex mbig-endian
17352 Generate code for a big-endian target.
17354 @item -mlittle-endian
17355 @opindex mlittle-endian
17356 Generate code for a little-endian target.  This is the default.
17358 @item -msim
17359 @opindex msim
17360 Choose startup files and linker script suitable for the simulator.
17362 @item -msdata=default
17363 @opindex msdata=default
17364 Put small global and static data in the @code{.neardata} section,
17365 which is pointed to by register @code{B14}.  Put small uninitialized
17366 global and static data in the @code{.bss} section, which is adjacent
17367 to the @code{.neardata} section.  Put small read-only data into the
17368 @code{.rodata} section.  The corresponding sections used for large
17369 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17371 @item -msdata=all
17372 @opindex msdata=all
17373 Put all data, not just small objects, into the sections reserved for
17374 small data, and use addressing relative to the @code{B14} register to
17375 access them.
17377 @item -msdata=none
17378 @opindex msdata=none
17379 Make no use of the sections reserved for small data, and use absolute
17380 addresses to access all data.  Put all initialized global and static
17381 data in the @code{.fardata} section, and all uninitialized data in the
17382 @code{.far} section.  Put all constant data into the @code{.const}
17383 section.
17384 @end table
17386 @node CRIS Options
17387 @subsection CRIS Options
17388 @cindex CRIS Options
17390 These options are defined specifically for the CRIS ports.
17392 @table @gcctabopt
17393 @item -march=@var{architecture-type}
17394 @itemx -mcpu=@var{architecture-type}
17395 @opindex march
17396 @opindex mcpu
17397 Generate code for the specified architecture.  The choices for
17398 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17399 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17400 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17401 @samp{v10}.
17403 @item -mtune=@var{architecture-type}
17404 @opindex mtune
17405 Tune to @var{architecture-type} everything applicable about the generated
17406 code, except for the ABI and the set of available instructions.  The
17407 choices for @var{architecture-type} are the same as for
17408 @option{-march=@var{architecture-type}}.
17410 @item -mmax-stack-frame=@var{n}
17411 @opindex mmax-stack-frame
17412 Warn when the stack frame of a function exceeds @var{n} bytes.
17414 @item -metrax4
17415 @itemx -metrax100
17416 @opindex metrax4
17417 @opindex metrax100
17418 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17419 @option{-march=v3} and @option{-march=v8} respectively.
17421 @item -mmul-bug-workaround
17422 @itemx -mno-mul-bug-workaround
17423 @opindex mmul-bug-workaround
17424 @opindex mno-mul-bug-workaround
17425 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17426 models where it applies.  This option is active by default.
17428 @item -mpdebug
17429 @opindex mpdebug
17430 Enable CRIS-specific verbose debug-related information in the assembly
17431 code.  This option also has the effect of turning off the @samp{#NO_APP}
17432 formatted-code indicator to the assembler at the beginning of the
17433 assembly file.
17435 @item -mcc-init
17436 @opindex mcc-init
17437 Do not use condition-code results from previous instruction; always emit
17438 compare and test instructions before use of condition codes.
17440 @item -mno-side-effects
17441 @opindex mno-side-effects
17442 Do not emit instructions with side effects in addressing modes other than
17443 post-increment.
17445 @item -mstack-align
17446 @itemx -mno-stack-align
17447 @itemx -mdata-align
17448 @itemx -mno-data-align
17449 @itemx -mconst-align
17450 @itemx -mno-const-align
17451 @opindex mstack-align
17452 @opindex mno-stack-align
17453 @opindex mdata-align
17454 @opindex mno-data-align
17455 @opindex mconst-align
17456 @opindex mno-const-align
17457 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17458 stack frame, individual data and constants to be aligned for the maximum
17459 single data access size for the chosen CPU model.  The default is to
17460 arrange for 32-bit alignment.  ABI details such as structure layout are
17461 not affected by these options.
17463 @item -m32-bit
17464 @itemx -m16-bit
17465 @itemx -m8-bit
17466 @opindex m32-bit
17467 @opindex m16-bit
17468 @opindex m8-bit
17469 Similar to the stack- data- and const-align options above, these options
17470 arrange for stack frame, writable data and constants to all be 32-bit,
17471 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17473 @item -mno-prologue-epilogue
17474 @itemx -mprologue-epilogue
17475 @opindex mno-prologue-epilogue
17476 @opindex mprologue-epilogue
17477 With @option{-mno-prologue-epilogue}, the normal function prologue and
17478 epilogue which set up the stack frame are omitted and no return
17479 instructions or return sequences are generated in the code.  Use this
17480 option only together with visual inspection of the compiled code: no
17481 warnings or errors are generated when call-saved registers must be saved,
17482 or storage for local variables needs to be allocated.
17484 @item -mno-gotplt
17485 @itemx -mgotplt
17486 @opindex mno-gotplt
17487 @opindex mgotplt
17488 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17489 instruction sequences that load addresses for functions from the PLT part
17490 of the GOT rather than (traditional on other architectures) calls to the
17491 PLT@.  The default is @option{-mgotplt}.
17493 @item -melf
17494 @opindex melf
17495 Legacy no-op option only recognized with the cris-axis-elf and
17496 cris-axis-linux-gnu targets.
17498 @item -mlinux
17499 @opindex mlinux
17500 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17502 @item -sim
17503 @opindex sim
17504 This option, recognized for the cris-axis-elf, arranges
17505 to link with input-output functions from a simulator library.  Code,
17506 initialized data and zero-initialized data are allocated consecutively.
17508 @item -sim2
17509 @opindex sim2
17510 Like @option{-sim}, but pass linker options to locate initialized data at
17511 0x40000000 and zero-initialized data at 0x80000000.
17512 @end table
17514 @node CR16 Options
17515 @subsection CR16 Options
17516 @cindex CR16 Options
17518 These options are defined specifically for the CR16 ports.
17520 @table @gcctabopt
17522 @item -mmac
17523 @opindex mmac
17524 Enable the use of multiply-accumulate instructions. Disabled by default.
17526 @item -mcr16cplus
17527 @itemx -mcr16c
17528 @opindex mcr16cplus
17529 @opindex mcr16c
17530 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17531 is default.
17533 @item -msim
17534 @opindex msim
17535 Links the library libsim.a which is in compatible with simulator. Applicable
17536 to ELF compiler only.
17538 @item -mint32
17539 @opindex mint32
17540 Choose integer type as 32-bit wide.
17542 @item -mbit-ops
17543 @opindex mbit-ops
17544 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17546 @item -mdata-model=@var{model}
17547 @opindex mdata-model
17548 Choose a data model. The choices for @var{model} are @samp{near},
17549 @samp{far} or @samp{medium}. @samp{medium} is default.
17550 However, @samp{far} is not valid with @option{-mcr16c}, as the
17551 CR16C architecture does not support the far data model.
17552 @end table
17554 @node Darwin Options
17555 @subsection Darwin Options
17556 @cindex Darwin options
17558 These options are defined for all architectures running the Darwin operating
17559 system.
17561 FSF GCC on Darwin does not create ``fat'' object files; it creates
17562 an object file for the single architecture that GCC was built to
17563 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17564 @option{-arch} options are used; it does so by running the compiler or
17565 linker multiple times and joining the results together with
17566 @file{lipo}.
17568 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17569 @samp{i686}) is determined by the flags that specify the ISA
17570 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17571 @option{-force_cpusubtype_ALL} option can be used to override this.
17573 The Darwin tools vary in their behavior when presented with an ISA
17574 mismatch.  The assembler, @file{as}, only permits instructions to
17575 be used that are valid for the subtype of the file it is generating,
17576 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17577 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17578 and prints an error if asked to create a shared library with a less
17579 restrictive subtype than its input files (for instance, trying to put
17580 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17581 for executables, @command{ld}, quietly gives the executable the most
17582 restrictive subtype of any of its input files.
17584 @table @gcctabopt
17585 @item -F@var{dir}
17586 @opindex F
17587 Add the framework directory @var{dir} to the head of the list of
17588 directories to be searched for header files.  These directories are
17589 interleaved with those specified by @option{-I} options and are
17590 scanned in a left-to-right order.
17592 A framework directory is a directory with frameworks in it.  A
17593 framework is a directory with a @file{Headers} and/or
17594 @file{PrivateHeaders} directory contained directly in it that ends
17595 in @file{.framework}.  The name of a framework is the name of this
17596 directory excluding the @file{.framework}.  Headers associated with
17597 the framework are found in one of those two directories, with
17598 @file{Headers} being searched first.  A subframework is a framework
17599 directory that is in a framework's @file{Frameworks} directory.
17600 Includes of subframework headers can only appear in a header of a
17601 framework that contains the subframework, or in a sibling subframework
17602 header.  Two subframeworks are siblings if they occur in the same
17603 framework.  A subframework should not have the same name as a
17604 framework; a warning is issued if this is violated.  Currently a
17605 subframework cannot have subframeworks; in the future, the mechanism
17606 may be extended to support this.  The standard frameworks can be found
17607 in @file{/System/Library/Frameworks} and
17608 @file{/Library/Frameworks}.  An example include looks like
17609 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17610 the name of the framework and @file{header.h} is found in the
17611 @file{PrivateHeaders} or @file{Headers} directory.
17613 @item -iframework@var{dir}
17614 @opindex iframework
17615 Like @option{-F} except the directory is a treated as a system
17616 directory.  The main difference between this @option{-iframework} and
17617 @option{-F} is that with @option{-iframework} the compiler does not
17618 warn about constructs contained within header files found via
17619 @var{dir}.  This option is valid only for the C family of languages.
17621 @item -gused
17622 @opindex gused
17623 Emit debugging information for symbols that are used.  For stabs
17624 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17625 This is by default ON@.
17627 @item -gfull
17628 @opindex gfull
17629 Emit debugging information for all symbols and types.
17631 @item -mmacosx-version-min=@var{version}
17632 The earliest version of MacOS X that this executable will run on
17633 is @var{version}.  Typical values of @var{version} include @code{10.1},
17634 @code{10.2}, and @code{10.3.9}.
17636 If the compiler was built to use the system's headers by default,
17637 then the default for this option is the system version on which the
17638 compiler is running, otherwise the default is to make choices that
17639 are compatible with as many systems and code bases as possible.
17641 @item -mkernel
17642 @opindex mkernel
17643 Enable kernel development mode.  The @option{-mkernel} option sets
17644 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17645 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17646 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17647 applicable.  This mode also sets @option{-mno-altivec},
17648 @option{-msoft-float}, @option{-fno-builtin} and
17649 @option{-mlong-branch} for PowerPC targets.
17651 @item -mone-byte-bool
17652 @opindex mone-byte-bool
17653 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17654 By default @code{sizeof(bool)} is @code{4} when compiling for
17655 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17656 option has no effect on x86.
17658 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17659 to generate code that is not binary compatible with code generated
17660 without that switch.  Using this switch may require recompiling all
17661 other modules in a program, including system libraries.  Use this
17662 switch to conform to a non-default data model.
17664 @item -mfix-and-continue
17665 @itemx -ffix-and-continue
17666 @itemx -findirect-data
17667 @opindex mfix-and-continue
17668 @opindex ffix-and-continue
17669 @opindex findirect-data
17670 Generate code suitable for fast turnaround development, such as to
17671 allow GDB to dynamically load @file{.o} files into already-running
17672 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17673 are provided for backwards compatibility.
17675 @item -all_load
17676 @opindex all_load
17677 Loads all members of static archive libraries.
17678 See man ld(1) for more information.
17680 @item -arch_errors_fatal
17681 @opindex arch_errors_fatal
17682 Cause the errors having to do with files that have the wrong architecture
17683 to be fatal.
17685 @item -bind_at_load
17686 @opindex bind_at_load
17687 Causes the output file to be marked such that the dynamic linker will
17688 bind all undefined references when the file is loaded or launched.
17690 @item -bundle
17691 @opindex bundle
17692 Produce a Mach-o bundle format file.
17693 See man ld(1) for more information.
17695 @item -bundle_loader @var{executable}
17696 @opindex bundle_loader
17697 This option specifies the @var{executable} that will load the build
17698 output file being linked.  See man ld(1) for more information.
17700 @item -dynamiclib
17701 @opindex dynamiclib
17702 When passed this option, GCC produces a dynamic library instead of
17703 an executable when linking, using the Darwin @file{libtool} command.
17705 @item -force_cpusubtype_ALL
17706 @opindex force_cpusubtype_ALL
17707 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17708 one controlled by the @option{-mcpu} or @option{-march} option.
17710 @item -allowable_client  @var{client_name}
17711 @itemx -client_name
17712 @itemx -compatibility_version
17713 @itemx -current_version
17714 @itemx -dead_strip
17715 @itemx -dependency-file
17716 @itemx -dylib_file
17717 @itemx -dylinker_install_name
17718 @itemx -dynamic
17719 @itemx -exported_symbols_list
17720 @itemx -filelist
17721 @need 800
17722 @itemx -flat_namespace
17723 @itemx -force_flat_namespace
17724 @itemx -headerpad_max_install_names
17725 @itemx -image_base
17726 @itemx -init
17727 @itemx -install_name
17728 @itemx -keep_private_externs
17729 @itemx -multi_module
17730 @itemx -multiply_defined
17731 @itemx -multiply_defined_unused
17732 @need 800
17733 @itemx -noall_load
17734 @itemx -no_dead_strip_inits_and_terms
17735 @itemx -nofixprebinding
17736 @itemx -nomultidefs
17737 @itemx -noprebind
17738 @itemx -noseglinkedit
17739 @itemx -pagezero_size
17740 @itemx -prebind
17741 @itemx -prebind_all_twolevel_modules
17742 @itemx -private_bundle
17743 @need 800
17744 @itemx -read_only_relocs
17745 @itemx -sectalign
17746 @itemx -sectobjectsymbols
17747 @itemx -whyload
17748 @itemx -seg1addr
17749 @itemx -sectcreate
17750 @itemx -sectobjectsymbols
17751 @itemx -sectorder
17752 @itemx -segaddr
17753 @itemx -segs_read_only_addr
17754 @need 800
17755 @itemx -segs_read_write_addr
17756 @itemx -seg_addr_table
17757 @itemx -seg_addr_table_filename
17758 @itemx -seglinkedit
17759 @itemx -segprot
17760 @itemx -segs_read_only_addr
17761 @itemx -segs_read_write_addr
17762 @itemx -single_module
17763 @itemx -static
17764 @itemx -sub_library
17765 @need 800
17766 @itemx -sub_umbrella
17767 @itemx -twolevel_namespace
17768 @itemx -umbrella
17769 @itemx -undefined
17770 @itemx -unexported_symbols_list
17771 @itemx -weak_reference_mismatches
17772 @itemx -whatsloaded
17773 @opindex allowable_client
17774 @opindex client_name
17775 @opindex compatibility_version
17776 @opindex current_version
17777 @opindex dead_strip
17778 @opindex dependency-file
17779 @opindex dylib_file
17780 @opindex dylinker_install_name
17781 @opindex dynamic
17782 @opindex exported_symbols_list
17783 @opindex filelist
17784 @opindex flat_namespace
17785 @opindex force_flat_namespace
17786 @opindex headerpad_max_install_names
17787 @opindex image_base
17788 @opindex init
17789 @opindex install_name
17790 @opindex keep_private_externs
17791 @opindex multi_module
17792 @opindex multiply_defined
17793 @opindex multiply_defined_unused
17794 @opindex noall_load
17795 @opindex no_dead_strip_inits_and_terms
17796 @opindex nofixprebinding
17797 @opindex nomultidefs
17798 @opindex noprebind
17799 @opindex noseglinkedit
17800 @opindex pagezero_size
17801 @opindex prebind
17802 @opindex prebind_all_twolevel_modules
17803 @opindex private_bundle
17804 @opindex read_only_relocs
17805 @opindex sectalign
17806 @opindex sectobjectsymbols
17807 @opindex whyload
17808 @opindex seg1addr
17809 @opindex sectcreate
17810 @opindex sectobjectsymbols
17811 @opindex sectorder
17812 @opindex segaddr
17813 @opindex segs_read_only_addr
17814 @opindex segs_read_write_addr
17815 @opindex seg_addr_table
17816 @opindex seg_addr_table_filename
17817 @opindex seglinkedit
17818 @opindex segprot
17819 @opindex segs_read_only_addr
17820 @opindex segs_read_write_addr
17821 @opindex single_module
17822 @opindex static
17823 @opindex sub_library
17824 @opindex sub_umbrella
17825 @opindex twolevel_namespace
17826 @opindex umbrella
17827 @opindex undefined
17828 @opindex unexported_symbols_list
17829 @opindex weak_reference_mismatches
17830 @opindex whatsloaded
17831 These options are passed to the Darwin linker.  The Darwin linker man page
17832 describes them in detail.
17833 @end table
17835 @node DEC Alpha Options
17836 @subsection DEC Alpha Options
17838 These @samp{-m} options are defined for the DEC Alpha implementations:
17840 @table @gcctabopt
17841 @item -mno-soft-float
17842 @itemx -msoft-float
17843 @opindex mno-soft-float
17844 @opindex msoft-float
17845 Use (do not use) the hardware floating-point instructions for
17846 floating-point operations.  When @option{-msoft-float} is specified,
17847 functions in @file{libgcc.a} are used to perform floating-point
17848 operations.  Unless they are replaced by routines that emulate the
17849 floating-point operations, or compiled in such a way as to call such
17850 emulations routines, these routines issue floating-point
17851 operations.   If you are compiling for an Alpha without floating-point
17852 operations, you must ensure that the library is built so as not to call
17853 them.
17855 Note that Alpha implementations without floating-point operations are
17856 required to have floating-point registers.
17858 @item -mfp-reg
17859 @itemx -mno-fp-regs
17860 @opindex mfp-reg
17861 @opindex mno-fp-regs
17862 Generate code that uses (does not use) the floating-point register set.
17863 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17864 register set is not used, floating-point operands are passed in integer
17865 registers as if they were integers and floating-point results are passed
17866 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17867 so any function with a floating-point argument or return value called by code
17868 compiled with @option{-mno-fp-regs} must also be compiled with that
17869 option.
17871 A typical use of this option is building a kernel that does not use,
17872 and hence need not save and restore, any floating-point registers.
17874 @item -mieee
17875 @opindex mieee
17876 The Alpha architecture implements floating-point hardware optimized for
17877 maximum performance.  It is mostly compliant with the IEEE floating-point
17878 standard.  However, for full compliance, software assistance is
17879 required.  This option generates code fully IEEE-compliant code
17880 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17881 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17882 defined during compilation.  The resulting code is less efficient but is
17883 able to correctly support denormalized numbers and exceptional IEEE
17884 values such as not-a-number and plus/minus infinity.  Other Alpha
17885 compilers call this option @option{-ieee_with_no_inexact}.
17887 @item -mieee-with-inexact
17888 @opindex mieee-with-inexact
17889 This is like @option{-mieee} except the generated code also maintains
17890 the IEEE @var{inexact-flag}.  Turning on this option causes the
17891 generated code to implement fully-compliant IEEE math.  In addition to
17892 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17893 macro.  On some Alpha implementations the resulting code may execute
17894 significantly slower than the code generated by default.  Since there is
17895 very little code that depends on the @var{inexact-flag}, you should
17896 normally not specify this option.  Other Alpha compilers call this
17897 option @option{-ieee_with_inexact}.
17899 @item -mfp-trap-mode=@var{trap-mode}
17900 @opindex mfp-trap-mode
17901 This option controls what floating-point related traps are enabled.
17902 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17903 The trap mode can be set to one of four values:
17905 @table @samp
17906 @item n
17907 This is the default (normal) setting.  The only traps that are enabled
17908 are the ones that cannot be disabled in software (e.g., division by zero
17909 trap).
17911 @item u
17912 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17913 as well.
17915 @item su
17916 Like @samp{u}, but the instructions are marked to be safe for software
17917 completion (see Alpha architecture manual for details).
17919 @item sui
17920 Like @samp{su}, but inexact traps are enabled as well.
17921 @end table
17923 @item -mfp-rounding-mode=@var{rounding-mode}
17924 @opindex mfp-rounding-mode
17925 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17926 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17929 @table @samp
17930 @item n
17931 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17932 the nearest machine number or towards the even machine number in case
17933 of a tie.
17935 @item m
17936 Round towards minus infinity.
17938 @item c
17939 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17941 @item d
17942 Dynamic rounding mode.  A field in the floating-point control register
17943 (@var{fpcr}, see Alpha architecture reference manual) controls the
17944 rounding mode in effect.  The C library initializes this register for
17945 rounding towards plus infinity.  Thus, unless your program modifies the
17946 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17947 @end table
17949 @item -mtrap-precision=@var{trap-precision}
17950 @opindex mtrap-precision
17951 In the Alpha architecture, floating-point traps are imprecise.  This
17952 means without software assistance it is impossible to recover from a
17953 floating trap and program execution normally needs to be terminated.
17954 GCC can generate code that can assist operating system trap handlers
17955 in determining the exact location that caused a floating-point trap.
17956 Depending on the requirements of an application, different levels of
17957 precisions can be selected:
17959 @table @samp
17960 @item p
17961 Program precision.  This option is the default and means a trap handler
17962 can only identify which program caused a floating-point exception.
17964 @item f
17965 Function precision.  The trap handler can determine the function that
17966 caused a floating-point exception.
17968 @item i
17969 Instruction precision.  The trap handler can determine the exact
17970 instruction that caused a floating-point exception.
17971 @end table
17973 Other Alpha compilers provide the equivalent options called
17974 @option{-scope_safe} and @option{-resumption_safe}.
17976 @item -mieee-conformant
17977 @opindex mieee-conformant
17978 This option marks the generated code as IEEE conformant.  You must not
17979 use this option unless you also specify @option{-mtrap-precision=i} and either
17980 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17981 is to emit the line @samp{.eflag 48} in the function prologue of the
17982 generated assembly file.
17984 @item -mbuild-constants
17985 @opindex mbuild-constants
17986 Normally GCC examines a 32- or 64-bit integer constant to
17987 see if it can construct it from smaller constants in two or three
17988 instructions.  If it cannot, it outputs the constant as a literal and
17989 generates code to load it from the data segment at run time.
17991 Use this option to require GCC to construct @emph{all} integer constants
17992 using code, even if it takes more instructions (the maximum is six).
17994 You typically use this option to build a shared library dynamic
17995 loader.  Itself a shared library, it must relocate itself in memory
17996 before it can find the variables and constants in its own data segment.
17998 @item -mbwx
17999 @itemx -mno-bwx
18000 @itemx -mcix
18001 @itemx -mno-cix
18002 @itemx -mfix
18003 @itemx -mno-fix
18004 @itemx -mmax
18005 @itemx -mno-max
18006 @opindex mbwx
18007 @opindex mno-bwx
18008 @opindex mcix
18009 @opindex mno-cix
18010 @opindex mfix
18011 @opindex mno-fix
18012 @opindex mmax
18013 @opindex mno-max
18014 Indicate whether GCC should generate code to use the optional BWX,
18015 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18016 sets supported by the CPU type specified via @option{-mcpu=} option or that
18017 of the CPU on which GCC was built if none is specified.
18019 @item -mfloat-vax
18020 @itemx -mfloat-ieee
18021 @opindex mfloat-vax
18022 @opindex mfloat-ieee
18023 Generate code that uses (does not use) VAX F and G floating-point
18024 arithmetic instead of IEEE single and double precision.
18026 @item -mexplicit-relocs
18027 @itemx -mno-explicit-relocs
18028 @opindex mexplicit-relocs
18029 @opindex mno-explicit-relocs
18030 Older Alpha assemblers provided no way to generate symbol relocations
18031 except via assembler macros.  Use of these macros does not allow
18032 optimal instruction scheduling.  GNU binutils as of version 2.12
18033 supports a new syntax that allows the compiler to explicitly mark
18034 which relocations should apply to which instructions.  This option
18035 is mostly useful for debugging, as GCC detects the capabilities of
18036 the assembler when it is built and sets the default accordingly.
18038 @item -msmall-data
18039 @itemx -mlarge-data
18040 @opindex msmall-data
18041 @opindex mlarge-data
18042 When @option{-mexplicit-relocs} is in effect, static data is
18043 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18044 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18045 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18046 16-bit relocations off of the @code{$gp} register.  This limits the
18047 size of the small data area to 64KB, but allows the variables to be
18048 directly accessed via a single instruction.
18050 The default is @option{-mlarge-data}.  With this option the data area
18051 is limited to just below 2GB@.  Programs that require more than 2GB of
18052 data must use @code{malloc} or @code{mmap} to allocate the data in the
18053 heap instead of in the program's data segment.
18055 When generating code for shared libraries, @option{-fpic} implies
18056 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18058 @item -msmall-text
18059 @itemx -mlarge-text
18060 @opindex msmall-text
18061 @opindex mlarge-text
18062 When @option{-msmall-text} is used, the compiler assumes that the
18063 code of the entire program (or shared library) fits in 4MB, and is
18064 thus reachable with a branch instruction.  When @option{-msmall-data}
18065 is used, the compiler can assume that all local symbols share the
18066 same @code{$gp} value, and thus reduce the number of instructions
18067 required for a function call from 4 to 1.
18069 The default is @option{-mlarge-text}.
18071 @item -mcpu=@var{cpu_type}
18072 @opindex mcpu
18073 Set the instruction set and instruction scheduling parameters for
18074 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18075 style name or the corresponding chip number.  GCC supports scheduling
18076 parameters for the EV4, EV5 and EV6 family of processors and
18077 chooses the default values for the instruction set from the processor
18078 you specify.  If you do not specify a processor type, GCC defaults
18079 to the processor on which the compiler was built.
18081 Supported values for @var{cpu_type} are
18083 @table @samp
18084 @item ev4
18085 @itemx ev45
18086 @itemx 21064
18087 Schedules as an EV4 and has no instruction set extensions.
18089 @item ev5
18090 @itemx 21164
18091 Schedules as an EV5 and has no instruction set extensions.
18093 @item ev56
18094 @itemx 21164a
18095 Schedules as an EV5 and supports the BWX extension.
18097 @item pca56
18098 @itemx 21164pc
18099 @itemx 21164PC
18100 Schedules as an EV5 and supports the BWX and MAX extensions.
18102 @item ev6
18103 @itemx 21264
18104 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18106 @item ev67
18107 @itemx 21264a
18108 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18109 @end table
18111 Native toolchains also support the value @samp{native},
18112 which selects the best architecture option for the host processor.
18113 @option{-mcpu=native} has no effect if GCC does not recognize
18114 the processor.
18116 @item -mtune=@var{cpu_type}
18117 @opindex mtune
18118 Set only the instruction scheduling parameters for machine type
18119 @var{cpu_type}.  The instruction set is not changed.
18121 Native toolchains also support the value @samp{native},
18122 which selects the best architecture option for the host processor.
18123 @option{-mtune=native} has no effect if GCC does not recognize
18124 the processor.
18126 @item -mmemory-latency=@var{time}
18127 @opindex mmemory-latency
18128 Sets the latency the scheduler should assume for typical memory
18129 references as seen by the application.  This number is highly
18130 dependent on the memory access patterns used by the application
18131 and the size of the external cache on the machine.
18133 Valid options for @var{time} are
18135 @table @samp
18136 @item @var{number}
18137 A decimal number representing clock cycles.
18139 @item L1
18140 @itemx L2
18141 @itemx L3
18142 @itemx main
18143 The compiler contains estimates of the number of clock cycles for
18144 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18145 (also called Dcache, Scache, and Bcache), as well as to main memory.
18146 Note that L3 is only valid for EV5.
18148 @end table
18149 @end table
18151 @node FR30 Options
18152 @subsection FR30 Options
18153 @cindex FR30 Options
18155 These options are defined specifically for the FR30 port.
18157 @table @gcctabopt
18159 @item -msmall-model
18160 @opindex msmall-model
18161 Use the small address space model.  This can produce smaller code, but
18162 it does assume that all symbolic values and addresses fit into a
18163 20-bit range.
18165 @item -mno-lsim
18166 @opindex mno-lsim
18167 Assume that runtime support has been provided and so there is no need
18168 to include the simulator library (@file{libsim.a}) on the linker
18169 command line.
18171 @end table
18173 @node FT32 Options
18174 @subsection FT32 Options
18175 @cindex FT32 Options
18177 These options are defined specifically for the FT32 port.
18179 @table @gcctabopt
18181 @item -msim
18182 @opindex msim
18183 Specifies that the program will be run on the simulator.  This causes
18184 an alternate runtime startup and library to be linked.
18185 You must not use this option when generating programs that will run on
18186 real hardware; you must provide your own runtime library for whatever
18187 I/O functions are needed.
18189 @item -mlra
18190 @opindex mlra
18191 Enable Local Register Allocation.  This is still experimental for FT32,
18192 so by default the compiler uses standard reload.
18194 @item -mnodiv
18195 @opindex mnodiv
18196 Do not use div and mod instructions.
18198 @item -mft32b
18199 @opindex mft32b
18200 Enable use of the extended instructions of the FT32B processor.
18202 @item -mcompress
18203 @opindex mcompress
18204 Compress all code using the Ft32B code compression scheme.
18206 @item -mnopm
18207 @opindex  mnopm
18208 Do not generate code that reads program memory.
18210 @end table
18212 @node FRV Options
18213 @subsection FRV Options
18214 @cindex FRV Options
18216 @table @gcctabopt
18217 @item -mgpr-32
18218 @opindex mgpr-32
18220 Only use the first 32 general-purpose registers.
18222 @item -mgpr-64
18223 @opindex mgpr-64
18225 Use all 64 general-purpose registers.
18227 @item -mfpr-32
18228 @opindex mfpr-32
18230 Use only the first 32 floating-point registers.
18232 @item -mfpr-64
18233 @opindex mfpr-64
18235 Use all 64 floating-point registers.
18237 @item -mhard-float
18238 @opindex mhard-float
18240 Use hardware instructions for floating-point operations.
18242 @item -msoft-float
18243 @opindex msoft-float
18245 Use library routines for floating-point operations.
18247 @item -malloc-cc
18248 @opindex malloc-cc
18250 Dynamically allocate condition code registers.
18252 @item -mfixed-cc
18253 @opindex mfixed-cc
18255 Do not try to dynamically allocate condition code registers, only
18256 use @code{icc0} and @code{fcc0}.
18258 @item -mdword
18259 @opindex mdword
18261 Change ABI to use double word insns.
18263 @item -mno-dword
18264 @opindex mno-dword
18266 Do not use double word instructions.
18268 @item -mdouble
18269 @opindex mdouble
18271 Use floating-point double instructions.
18273 @item -mno-double
18274 @opindex mno-double
18276 Do not use floating-point double instructions.
18278 @item -mmedia
18279 @opindex mmedia
18281 Use media instructions.
18283 @item -mno-media
18284 @opindex mno-media
18286 Do not use media instructions.
18288 @item -mmuladd
18289 @opindex mmuladd
18291 Use multiply and add/subtract instructions.
18293 @item -mno-muladd
18294 @opindex mno-muladd
18296 Do not use multiply and add/subtract instructions.
18298 @item -mfdpic
18299 @opindex mfdpic
18301 Select the FDPIC ABI, which uses function descriptors to represent
18302 pointers to functions.  Without any PIC/PIE-related options, it
18303 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18304 assumes GOT entries and small data are within a 12-bit range from the
18305 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18306 are computed with 32 bits.
18307 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18309 @item -minline-plt
18310 @opindex minline-plt
18312 Enable inlining of PLT entries in function calls to functions that are
18313 not known to bind locally.  It has no effect without @option{-mfdpic}.
18314 It's enabled by default if optimizing for speed and compiling for
18315 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18316 optimization option such as @option{-O3} or above is present in the
18317 command line.
18319 @item -mTLS
18320 @opindex mTLS
18322 Assume a large TLS segment when generating thread-local code.
18324 @item -mtls
18325 @opindex mtls
18327 Do not assume a large TLS segment when generating thread-local code.
18329 @item -mgprel-ro
18330 @opindex mgprel-ro
18332 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18333 that is known to be in read-only sections.  It's enabled by default,
18334 except for @option{-fpic} or @option{-fpie}: even though it may help
18335 make the global offset table smaller, it trades 1 instruction for 4.
18336 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18337 one of which may be shared by multiple symbols, and it avoids the need
18338 for a GOT entry for the referenced symbol, so it's more likely to be a
18339 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18341 @item -multilib-library-pic
18342 @opindex multilib-library-pic
18344 Link with the (library, not FD) pic libraries.  It's implied by
18345 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18346 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18347 it explicitly.
18349 @item -mlinked-fp
18350 @opindex mlinked-fp
18352 Follow the EABI requirement of always creating a frame pointer whenever
18353 a stack frame is allocated.  This option is enabled by default and can
18354 be disabled with @option{-mno-linked-fp}.
18356 @item -mlong-calls
18357 @opindex mlong-calls
18359 Use indirect addressing to call functions outside the current
18360 compilation unit.  This allows the functions to be placed anywhere
18361 within the 32-bit address space.
18363 @item -malign-labels
18364 @opindex malign-labels
18366 Try to align labels to an 8-byte boundary by inserting NOPs into the
18367 previous packet.  This option only has an effect when VLIW packing
18368 is enabled.  It doesn't create new packets; it merely adds NOPs to
18369 existing ones.
18371 @item -mlibrary-pic
18372 @opindex mlibrary-pic
18374 Generate position-independent EABI code.
18376 @item -macc-4
18377 @opindex macc-4
18379 Use only the first four media accumulator registers.
18381 @item -macc-8
18382 @opindex macc-8
18384 Use all eight media accumulator registers.
18386 @item -mpack
18387 @opindex mpack
18389 Pack VLIW instructions.
18391 @item -mno-pack
18392 @opindex mno-pack
18394 Do not pack VLIW instructions.
18396 @item -mno-eflags
18397 @opindex mno-eflags
18399 Do not mark ABI switches in e_flags.
18401 @item -mcond-move
18402 @opindex mcond-move
18404 Enable the use of conditional-move instructions (default).
18406 This switch is mainly for debugging the compiler and will likely be removed
18407 in a future version.
18409 @item -mno-cond-move
18410 @opindex mno-cond-move
18412 Disable the use of conditional-move instructions.
18414 This switch is mainly for debugging the compiler and will likely be removed
18415 in a future version.
18417 @item -mscc
18418 @opindex mscc
18420 Enable the use of conditional set instructions (default).
18422 This switch is mainly for debugging the compiler and will likely be removed
18423 in a future version.
18425 @item -mno-scc
18426 @opindex mno-scc
18428 Disable the use of conditional set instructions.
18430 This switch is mainly for debugging the compiler and will likely be removed
18431 in a future version.
18433 @item -mcond-exec
18434 @opindex mcond-exec
18436 Enable the use of conditional execution (default).
18438 This switch is mainly for debugging the compiler and will likely be removed
18439 in a future version.
18441 @item -mno-cond-exec
18442 @opindex mno-cond-exec
18444 Disable the use of conditional execution.
18446 This switch is mainly for debugging the compiler and will likely be removed
18447 in a future version.
18449 @item -mvliw-branch
18450 @opindex mvliw-branch
18452 Run a pass to pack branches into VLIW instructions (default).
18454 This switch is mainly for debugging the compiler and will likely be removed
18455 in a future version.
18457 @item -mno-vliw-branch
18458 @opindex mno-vliw-branch
18460 Do not run a pass to pack branches into VLIW instructions.
18462 This switch is mainly for debugging the compiler and will likely be removed
18463 in a future version.
18465 @item -mmulti-cond-exec
18466 @opindex mmulti-cond-exec
18468 Enable optimization of @code{&&} and @code{||} in conditional execution
18469 (default).
18471 This switch is mainly for debugging the compiler and will likely be removed
18472 in a future version.
18474 @item -mno-multi-cond-exec
18475 @opindex mno-multi-cond-exec
18477 Disable optimization of @code{&&} and @code{||} in conditional execution.
18479 This switch is mainly for debugging the compiler and will likely be removed
18480 in a future version.
18482 @item -mnested-cond-exec
18483 @opindex mnested-cond-exec
18485 Enable nested conditional execution optimizations (default).
18487 This switch is mainly for debugging the compiler and will likely be removed
18488 in a future version.
18490 @item -mno-nested-cond-exec
18491 @opindex mno-nested-cond-exec
18493 Disable nested conditional execution optimizations.
18495 This switch is mainly for debugging the compiler and will likely be removed
18496 in a future version.
18498 @item -moptimize-membar
18499 @opindex moptimize-membar
18501 This switch removes redundant @code{membar} instructions from the
18502 compiler-generated code.  It is enabled by default.
18504 @item -mno-optimize-membar
18505 @opindex mno-optimize-membar
18507 This switch disables the automatic removal of redundant @code{membar}
18508 instructions from the generated code.
18510 @item -mtomcat-stats
18511 @opindex mtomcat-stats
18513 Cause gas to print out tomcat statistics.
18515 @item -mcpu=@var{cpu}
18516 @opindex mcpu
18518 Select the processor type for which to generate code.  Possible values are
18519 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18520 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18522 @end table
18524 @node GNU/Linux Options
18525 @subsection GNU/Linux Options
18527 These @samp{-m} options are defined for GNU/Linux targets:
18529 @table @gcctabopt
18530 @item -mglibc
18531 @opindex mglibc
18532 Use the GNU C library.  This is the default except
18533 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18534 @samp{*-*-linux-*android*} targets.
18536 @item -muclibc
18537 @opindex muclibc
18538 Use uClibc C library.  This is the default on
18539 @samp{*-*-linux-*uclibc*} targets.
18541 @item -mmusl
18542 @opindex mmusl
18543 Use the musl C library.  This is the default on
18544 @samp{*-*-linux-*musl*} targets.
18546 @item -mbionic
18547 @opindex mbionic
18548 Use Bionic C library.  This is the default on
18549 @samp{*-*-linux-*android*} targets.
18551 @item -mandroid
18552 @opindex mandroid
18553 Compile code compatible with Android platform.  This is the default on
18554 @samp{*-*-linux-*android*} targets.
18556 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18557 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18558 this option makes the GCC driver pass Android-specific options to the linker.
18559 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18560 to be defined.
18562 @item -tno-android-cc
18563 @opindex tno-android-cc
18564 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18565 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18566 @option{-fno-rtti} by default.
18568 @item -tno-android-ld
18569 @opindex tno-android-ld
18570 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18571 linking options to the linker.
18573 @end table
18575 @node H8/300 Options
18576 @subsection H8/300 Options
18578 These @samp{-m} options are defined for the H8/300 implementations:
18580 @table @gcctabopt
18581 @item -mrelax
18582 @opindex mrelax
18583 Shorten some address references at link time, when possible; uses the
18584 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18585 ld, Using ld}, for a fuller description.
18587 @item -mh
18588 @opindex mh
18589 Generate code for the H8/300H@.
18591 @item -ms
18592 @opindex ms
18593 Generate code for the H8S@.
18595 @item -mn
18596 @opindex mn
18597 Generate code for the H8S and H8/300H in the normal mode.  This switch
18598 must be used either with @option{-mh} or @option{-ms}.
18600 @item -ms2600
18601 @opindex ms2600
18602 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18604 @item -mexr
18605 @opindex mexr
18606 Extended registers are stored on stack before execution of function
18607 with monitor attribute. Default option is @option{-mexr}.
18608 This option is valid only for H8S targets.
18610 @item -mno-exr
18611 @opindex mno-exr
18612 Extended registers are not stored on stack before execution of function 
18613 with monitor attribute. Default option is @option{-mno-exr}. 
18614 This option is valid only for H8S targets.
18616 @item -mint32
18617 @opindex mint32
18618 Make @code{int} data 32 bits by default.
18620 @item -malign-300
18621 @opindex malign-300
18622 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18623 The default for the H8/300H and H8S is to align longs and floats on
18624 4-byte boundaries.
18625 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18626 This option has no effect on the H8/300.
18627 @end table
18629 @node HPPA Options
18630 @subsection HPPA Options
18631 @cindex HPPA Options
18633 These @samp{-m} options are defined for the HPPA family of computers:
18635 @table @gcctabopt
18636 @item -march=@var{architecture-type}
18637 @opindex march
18638 Generate code for the specified architecture.  The choices for
18639 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18640 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18641 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18642 architecture option for your machine.  Code compiled for lower numbered
18643 architectures runs on higher numbered architectures, but not the
18644 other way around.
18646 @item -mpa-risc-1-0
18647 @itemx -mpa-risc-1-1
18648 @itemx -mpa-risc-2-0
18649 @opindex mpa-risc-1-0
18650 @opindex mpa-risc-1-1
18651 @opindex mpa-risc-2-0
18652 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18654 @item -mcaller-copies
18655 @opindex mcaller-copies
18656 The caller copies function arguments passed by hidden reference.  This
18657 option should be used with care as it is not compatible with the default
18658 32-bit runtime.  However, only aggregates larger than eight bytes are
18659 passed by hidden reference and the option provides better compatibility
18660 with OpenMP.
18662 @item -mjump-in-delay
18663 @opindex mjump-in-delay
18664 This option is ignored and provided for compatibility purposes only.
18666 @item -mdisable-fpregs
18667 @opindex mdisable-fpregs
18668 Prevent floating-point registers from being used in any manner.  This is
18669 necessary for compiling kernels that perform lazy context switching of
18670 floating-point registers.  If you use this option and attempt to perform
18671 floating-point operations, the compiler aborts.
18673 @item -mdisable-indexing
18674 @opindex mdisable-indexing
18675 Prevent the compiler from using indexing address modes.  This avoids some
18676 rather obscure problems when compiling MIG generated code under MACH@.
18678 @item -mno-space-regs
18679 @opindex mno-space-regs
18680 Generate code that assumes the target has no space registers.  This allows
18681 GCC to generate faster indirect calls and use unscaled index address modes.
18683 Such code is suitable for level 0 PA systems and kernels.
18685 @item -mfast-indirect-calls
18686 @opindex mfast-indirect-calls
18687 Generate code that assumes calls never cross space boundaries.  This
18688 allows GCC to emit code that performs faster indirect calls.
18690 This option does not work in the presence of shared libraries or nested
18691 functions.
18693 @item -mfixed-range=@var{register-range}
18694 @opindex mfixed-range
18695 Generate code treating the given register range as fixed registers.
18696 A fixed register is one that the register allocator cannot use.  This is
18697 useful when compiling kernel code.  A register range is specified as
18698 two registers separated by a dash.  Multiple register ranges can be
18699 specified separated by a comma.
18701 @item -mlong-load-store
18702 @opindex mlong-load-store
18703 Generate 3-instruction load and store sequences as sometimes required by
18704 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18705 the HP compilers.
18707 @item -mportable-runtime
18708 @opindex mportable-runtime
18709 Use the portable calling conventions proposed by HP for ELF systems.
18711 @item -mgas
18712 @opindex mgas
18713 Enable the use of assembler directives only GAS understands.
18715 @item -mschedule=@var{cpu-type}
18716 @opindex mschedule
18717 Schedule code according to the constraints for the machine type
18718 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18719 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18720 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18721 proper scheduling option for your machine.  The default scheduling is
18722 @samp{8000}.
18724 @item -mlinker-opt
18725 @opindex mlinker-opt
18726 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18727 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18728 linkers in which they give bogus error messages when linking some programs.
18730 @item -msoft-float
18731 @opindex msoft-float
18732 Generate output containing library calls for floating point.
18733 @strong{Warning:} the requisite libraries are not available for all HPPA
18734 targets.  Normally the facilities of the machine's usual C compiler are
18735 used, but this cannot be done directly in cross-compilation.  You must make
18736 your own arrangements to provide suitable library functions for
18737 cross-compilation.
18739 @option{-msoft-float} changes the calling convention in the output file;
18740 therefore, it is only useful if you compile @emph{all} of a program with
18741 this option.  In particular, you need to compile @file{libgcc.a}, the
18742 library that comes with GCC, with @option{-msoft-float} in order for
18743 this to work.
18745 @item -msio
18746 @opindex msio
18747 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18748 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18749 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18750 options are available under HP-UX and HI-UX@.
18752 @item -mgnu-ld
18753 @opindex mgnu-ld
18754 Use options specific to GNU @command{ld}.
18755 This passes @option{-shared} to @command{ld} when
18756 building a shared library.  It is the default when GCC is configured,
18757 explicitly or implicitly, with the GNU linker.  This option does not
18758 affect which @command{ld} is called; it only changes what parameters
18759 are passed to that @command{ld}.
18760 The @command{ld} that is called is determined by the
18761 @option{--with-ld} configure option, GCC's program search path, and
18762 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18763 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18764 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18766 @item -mhp-ld
18767 @opindex mhp-ld
18768 Use options specific to HP @command{ld}.
18769 This passes @option{-b} to @command{ld} when building
18770 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18771 links.  It is the default when GCC is configured, explicitly or
18772 implicitly, with the HP linker.  This option does not affect
18773 which @command{ld} is called; it only changes what parameters are passed to that
18774 @command{ld}.
18775 The @command{ld} that is called is determined by the @option{--with-ld}
18776 configure option, GCC's program search path, and finally by the user's
18777 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18778 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18779 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18781 @item -mlong-calls
18782 @opindex mno-long-calls
18783 Generate code that uses long call sequences.  This ensures that a call
18784 is always able to reach linker generated stubs.  The default is to generate
18785 long calls only when the distance from the call site to the beginning
18786 of the function or translation unit, as the case may be, exceeds a
18787 predefined limit set by the branch type being used.  The limits for
18788 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18789 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18790 240,000 bytes.
18792 Distances are measured from the beginning of functions when using the
18793 @option{-ffunction-sections} option, or when using the @option{-mgas}
18794 and @option{-mno-portable-runtime} options together under HP-UX with
18795 the SOM linker.
18797 It is normally not desirable to use this option as it degrades
18798 performance.  However, it may be useful in large applications,
18799 particularly when partial linking is used to build the application.
18801 The types of long calls used depends on the capabilities of the
18802 assembler and linker, and the type of code being generated.  The
18803 impact on systems that support long absolute calls, and long pic
18804 symbol-difference or pc-relative calls should be relatively small.
18805 However, an indirect call is used on 32-bit ELF systems in pic code
18806 and it is quite long.
18808 @item -munix=@var{unix-std}
18809 @opindex march
18810 Generate compiler predefines and select a startfile for the specified
18811 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18812 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18813 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18814 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18815 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18816 and later.
18818 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18819 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18820 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18821 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18822 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18823 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18825 It is @emph{important} to note that this option changes the interfaces
18826 for various library routines.  It also affects the operational behavior
18827 of the C library.  Thus, @emph{extreme} care is needed in using this
18828 option.
18830 Library code that is intended to operate with more than one UNIX
18831 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18832 as appropriate.  Most GNU software doesn't provide this capability.
18834 @item -nolibdld
18835 @opindex nolibdld
18836 Suppress the generation of link options to search libdld.sl when the
18837 @option{-static} option is specified on HP-UX 10 and later.
18839 @item -static
18840 @opindex static
18841 The HP-UX implementation of setlocale in libc has a dependency on
18842 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18843 when the @option{-static} option is specified, special link options
18844 are needed to resolve this dependency.
18846 On HP-UX 10 and later, the GCC driver adds the necessary options to
18847 link with libdld.sl when the @option{-static} option is specified.
18848 This causes the resulting binary to be dynamic.  On the 64-bit port,
18849 the linkers generate dynamic binaries by default in any case.  The
18850 @option{-nolibdld} option can be used to prevent the GCC driver from
18851 adding these link options.
18853 @item -threads
18854 @opindex threads
18855 Add support for multithreading with the @dfn{dce thread} library
18856 under HP-UX@.  This option sets flags for both the preprocessor and
18857 linker.
18858 @end table
18860 @node IA-64 Options
18861 @subsection IA-64 Options
18862 @cindex IA-64 Options
18864 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18866 @table @gcctabopt
18867 @item -mbig-endian
18868 @opindex mbig-endian
18869 Generate code for a big-endian target.  This is the default for HP-UX@.
18871 @item -mlittle-endian
18872 @opindex mlittle-endian
18873 Generate code for a little-endian target.  This is the default for AIX5
18874 and GNU/Linux.
18876 @item -mgnu-as
18877 @itemx -mno-gnu-as
18878 @opindex mgnu-as
18879 @opindex mno-gnu-as
18880 Generate (or don't) code for the GNU assembler.  This is the default.
18881 @c Also, this is the default if the configure option @option{--with-gnu-as}
18882 @c is used.
18884 @item -mgnu-ld
18885 @itemx -mno-gnu-ld
18886 @opindex mgnu-ld
18887 @opindex mno-gnu-ld
18888 Generate (or don't) code for the GNU linker.  This is the default.
18889 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18890 @c is used.
18892 @item -mno-pic
18893 @opindex mno-pic
18894 Generate code that does not use a global pointer register.  The result
18895 is not position independent code, and violates the IA-64 ABI@.
18897 @item -mvolatile-asm-stop
18898 @itemx -mno-volatile-asm-stop
18899 @opindex mvolatile-asm-stop
18900 @opindex mno-volatile-asm-stop
18901 Generate (or don't) a stop bit immediately before and after volatile asm
18902 statements.
18904 @item -mregister-names
18905 @itemx -mno-register-names
18906 @opindex mregister-names
18907 @opindex mno-register-names
18908 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18909 the stacked registers.  This may make assembler output more readable.
18911 @item -mno-sdata
18912 @itemx -msdata
18913 @opindex mno-sdata
18914 @opindex msdata
18915 Disable (or enable) optimizations that use the small data section.  This may
18916 be useful for working around optimizer bugs.
18918 @item -mconstant-gp
18919 @opindex mconstant-gp
18920 Generate code that uses a single constant global pointer value.  This is
18921 useful when compiling kernel code.
18923 @item -mauto-pic
18924 @opindex mauto-pic
18925 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18926 This is useful when compiling firmware code.
18928 @item -minline-float-divide-min-latency
18929 @opindex minline-float-divide-min-latency
18930 Generate code for inline divides of floating-point values
18931 using the minimum latency algorithm.
18933 @item -minline-float-divide-max-throughput
18934 @opindex minline-float-divide-max-throughput
18935 Generate code for inline divides of floating-point values
18936 using the maximum throughput algorithm.
18938 @item -mno-inline-float-divide
18939 @opindex mno-inline-float-divide
18940 Do not generate inline code for divides of floating-point values.
18942 @item -minline-int-divide-min-latency
18943 @opindex minline-int-divide-min-latency
18944 Generate code for inline divides of integer values
18945 using the minimum latency algorithm.
18947 @item -minline-int-divide-max-throughput
18948 @opindex minline-int-divide-max-throughput
18949 Generate code for inline divides of integer values
18950 using the maximum throughput algorithm.
18952 @item -mno-inline-int-divide
18953 @opindex mno-inline-int-divide
18954 Do not generate inline code for divides of integer values.
18956 @item -minline-sqrt-min-latency
18957 @opindex minline-sqrt-min-latency
18958 Generate code for inline square roots
18959 using the minimum latency algorithm.
18961 @item -minline-sqrt-max-throughput
18962 @opindex minline-sqrt-max-throughput
18963 Generate code for inline square roots
18964 using the maximum throughput algorithm.
18966 @item -mno-inline-sqrt
18967 @opindex mno-inline-sqrt
18968 Do not generate inline code for @code{sqrt}.
18970 @item -mfused-madd
18971 @itemx -mno-fused-madd
18972 @opindex mfused-madd
18973 @opindex mno-fused-madd
18974 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18975 instructions.  The default is to use these instructions.
18977 @item -mno-dwarf2-asm
18978 @itemx -mdwarf2-asm
18979 @opindex mno-dwarf2-asm
18980 @opindex mdwarf2-asm
18981 Don't (or do) generate assembler code for the DWARF line number debugging
18982 info.  This may be useful when not using the GNU assembler.
18984 @item -mearly-stop-bits
18985 @itemx -mno-early-stop-bits
18986 @opindex mearly-stop-bits
18987 @opindex mno-early-stop-bits
18988 Allow stop bits to be placed earlier than immediately preceding the
18989 instruction that triggered the stop bit.  This can improve instruction
18990 scheduling, but does not always do so.
18992 @item -mfixed-range=@var{register-range}
18993 @opindex mfixed-range
18994 Generate code treating the given register range as fixed registers.
18995 A fixed register is one that the register allocator cannot use.  This is
18996 useful when compiling kernel code.  A register range is specified as
18997 two registers separated by a dash.  Multiple register ranges can be
18998 specified separated by a comma.
19000 @item -mtls-size=@var{tls-size}
19001 @opindex mtls-size
19002 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19005 @item -mtune=@var{cpu-type}
19006 @opindex mtune
19007 Tune the instruction scheduling for a particular CPU, Valid values are
19008 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19009 and @samp{mckinley}.
19011 @item -milp32
19012 @itemx -mlp64
19013 @opindex milp32
19014 @opindex mlp64
19015 Generate code for a 32-bit or 64-bit environment.
19016 The 32-bit environment sets int, long and pointer to 32 bits.
19017 The 64-bit environment sets int to 32 bits and long and pointer
19018 to 64 bits.  These are HP-UX specific flags.
19020 @item -mno-sched-br-data-spec
19021 @itemx -msched-br-data-spec
19022 @opindex mno-sched-br-data-spec
19023 @opindex msched-br-data-spec
19024 (Dis/En)able data speculative scheduling before reload.
19025 This results in generation of @code{ld.a} instructions and
19026 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19027 The default setting is disabled.
19029 @item -msched-ar-data-spec
19030 @itemx -mno-sched-ar-data-spec
19031 @opindex msched-ar-data-spec
19032 @opindex mno-sched-ar-data-spec
19033 (En/Dis)able data speculative scheduling after reload.
19034 This results in generation of @code{ld.a} instructions and
19035 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19036 The default setting is enabled.
19038 @item -mno-sched-control-spec
19039 @itemx -msched-control-spec
19040 @opindex mno-sched-control-spec
19041 @opindex msched-control-spec
19042 (Dis/En)able control speculative scheduling.  This feature is
19043 available only during region scheduling (i.e.@: before reload).
19044 This results in generation of the @code{ld.s} instructions and
19045 the corresponding check instructions @code{chk.s}.
19046 The default setting is disabled.
19048 @item -msched-br-in-data-spec
19049 @itemx -mno-sched-br-in-data-spec
19050 @opindex msched-br-in-data-spec
19051 @opindex mno-sched-br-in-data-spec
19052 (En/Dis)able speculative scheduling of the instructions that
19053 are dependent on the data speculative loads before reload.
19054 This is effective only with @option{-msched-br-data-spec} enabled.
19055 The default setting is enabled.
19057 @item -msched-ar-in-data-spec
19058 @itemx -mno-sched-ar-in-data-spec
19059 @opindex msched-ar-in-data-spec
19060 @opindex mno-sched-ar-in-data-spec
19061 (En/Dis)able speculative scheduling of the instructions that
19062 are dependent on the data speculative loads after reload.
19063 This is effective only with @option{-msched-ar-data-spec} enabled.
19064 The default setting is enabled.
19066 @item -msched-in-control-spec
19067 @itemx -mno-sched-in-control-spec
19068 @opindex msched-in-control-spec
19069 @opindex mno-sched-in-control-spec
19070 (En/Dis)able speculative scheduling of the instructions that
19071 are dependent on the control speculative loads.
19072 This is effective only with @option{-msched-control-spec} enabled.
19073 The default setting is enabled.
19075 @item -mno-sched-prefer-non-data-spec-insns
19076 @itemx -msched-prefer-non-data-spec-insns
19077 @opindex mno-sched-prefer-non-data-spec-insns
19078 @opindex msched-prefer-non-data-spec-insns
19079 If enabled, data-speculative instructions are chosen for schedule
19080 only if there are no other choices at the moment.  This makes
19081 the use of the data speculation much more conservative.
19082 The default setting is disabled.
19084 @item -mno-sched-prefer-non-control-spec-insns
19085 @itemx -msched-prefer-non-control-spec-insns
19086 @opindex mno-sched-prefer-non-control-spec-insns
19087 @opindex msched-prefer-non-control-spec-insns
19088 If enabled, control-speculative instructions are chosen for schedule
19089 only if there are no other choices at the moment.  This makes
19090 the use of the control speculation much more conservative.
19091 The default setting is disabled.
19093 @item -mno-sched-count-spec-in-critical-path
19094 @itemx -msched-count-spec-in-critical-path
19095 @opindex mno-sched-count-spec-in-critical-path
19096 @opindex msched-count-spec-in-critical-path
19097 If enabled, speculative dependencies are considered during
19098 computation of the instructions priorities.  This makes the use of the
19099 speculation a bit more conservative.
19100 The default setting is disabled.
19102 @item -msched-spec-ldc
19103 @opindex msched-spec-ldc
19104 Use a simple data speculation check.  This option is on by default.
19106 @item -msched-control-spec-ldc
19107 @opindex msched-spec-ldc
19108 Use a simple check for control speculation.  This option is on by default.
19110 @item -msched-stop-bits-after-every-cycle
19111 @opindex msched-stop-bits-after-every-cycle
19112 Place a stop bit after every cycle when scheduling.  This option is on
19113 by default.
19115 @item -msched-fp-mem-deps-zero-cost
19116 @opindex msched-fp-mem-deps-zero-cost
19117 Assume that floating-point stores and loads are not likely to cause a conflict
19118 when placed into the same instruction group.  This option is disabled by
19119 default.
19121 @item -msel-sched-dont-check-control-spec
19122 @opindex msel-sched-dont-check-control-spec
19123 Generate checks for control speculation in selective scheduling.
19124 This flag is disabled by default.
19126 @item -msched-max-memory-insns=@var{max-insns}
19127 @opindex msched-max-memory-insns
19128 Limit on the number of memory insns per instruction group, giving lower
19129 priority to subsequent memory insns attempting to schedule in the same
19130 instruction group. Frequently useful to prevent cache bank conflicts.
19131 The default value is 1.
19133 @item -msched-max-memory-insns-hard-limit
19134 @opindex msched-max-memory-insns-hard-limit
19135 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19136 disallowing more than that number in an instruction group.
19137 Otherwise, the limit is ``soft'', meaning that non-memory operations
19138 are preferred when the limit is reached, but memory operations may still
19139 be scheduled.
19141 @end table
19143 @node LM32 Options
19144 @subsection LM32 Options
19145 @cindex LM32 options
19147 These @option{-m} options are defined for the LatticeMico32 architecture:
19149 @table @gcctabopt
19150 @item -mbarrel-shift-enabled
19151 @opindex mbarrel-shift-enabled
19152 Enable barrel-shift instructions.
19154 @item -mdivide-enabled
19155 @opindex mdivide-enabled
19156 Enable divide and modulus instructions.
19158 @item -mmultiply-enabled
19159 @opindex multiply-enabled
19160 Enable multiply instructions.
19162 @item -msign-extend-enabled
19163 @opindex msign-extend-enabled
19164 Enable sign extend instructions.
19166 @item -muser-enabled
19167 @opindex muser-enabled
19168 Enable user-defined instructions.
19170 @end table
19172 @node M32C Options
19173 @subsection M32C Options
19174 @cindex M32C options
19176 @table @gcctabopt
19177 @item -mcpu=@var{name}
19178 @opindex mcpu=
19179 Select the CPU for which code is generated.  @var{name} may be one of
19180 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19181 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19182 the M32C/80 series.
19184 @item -msim
19185 @opindex msim
19186 Specifies that the program will be run on the simulator.  This causes
19187 an alternate runtime library to be linked in which supports, for
19188 example, file I/O@.  You must not use this option when generating
19189 programs that will run on real hardware; you must provide your own
19190 runtime library for whatever I/O functions are needed.
19192 @item -memregs=@var{number}
19193 @opindex memregs=
19194 Specifies the number of memory-based pseudo-registers GCC uses
19195 during code generation.  These pseudo-registers are used like real
19196 registers, so there is a tradeoff between GCC's ability to fit the
19197 code into available registers, and the performance penalty of using
19198 memory instead of registers.  Note that all modules in a program must
19199 be compiled with the same value for this option.  Because of that, you
19200 must not use this option with GCC's default runtime libraries.
19202 @end table
19204 @node M32R/D Options
19205 @subsection M32R/D Options
19206 @cindex M32R/D options
19208 These @option{-m} options are defined for Renesas M32R/D architectures:
19210 @table @gcctabopt
19211 @item -m32r2
19212 @opindex m32r2
19213 Generate code for the M32R/2@.
19215 @item -m32rx
19216 @opindex m32rx
19217 Generate code for the M32R/X@.
19219 @item -m32r
19220 @opindex m32r
19221 Generate code for the M32R@.  This is the default.
19223 @item -mmodel=small
19224 @opindex mmodel=small
19225 Assume all objects live in the lower 16MB of memory (so that their addresses
19226 can be loaded with the @code{ld24} instruction), and assume all subroutines
19227 are reachable with the @code{bl} instruction.
19228 This is the default.
19230 The addressability of a particular object can be set with the
19231 @code{model} attribute.
19233 @item -mmodel=medium
19234 @opindex mmodel=medium
19235 Assume objects may be anywhere in the 32-bit address space (the compiler
19236 generates @code{seth/add3} instructions to load their addresses), and
19237 assume all subroutines are reachable with the @code{bl} instruction.
19239 @item -mmodel=large
19240 @opindex mmodel=large
19241 Assume objects may be anywhere in the 32-bit address space (the compiler
19242 generates @code{seth/add3} instructions to load their addresses), and
19243 assume subroutines may not be reachable with the @code{bl} instruction
19244 (the compiler generates the much slower @code{seth/add3/jl}
19245 instruction sequence).
19247 @item -msdata=none
19248 @opindex msdata=none
19249 Disable use of the small data area.  Variables are put into
19250 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19251 @code{section} attribute has been specified).
19252 This is the default.
19254 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19255 Objects may be explicitly put in the small data area with the
19256 @code{section} attribute using one of these sections.
19258 @item -msdata=sdata
19259 @opindex msdata=sdata
19260 Put small global and static data in the small data area, but do not
19261 generate special code to reference them.
19263 @item -msdata=use
19264 @opindex msdata=use
19265 Put small global and static data in the small data area, and generate
19266 special instructions to reference them.
19268 @item -G @var{num}
19269 @opindex G
19270 @cindex smaller data references
19271 Put global and static objects less than or equal to @var{num} bytes
19272 into the small data or BSS sections instead of the normal data or BSS
19273 sections.  The default value of @var{num} is 8.
19274 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19275 for this option to have any effect.
19277 All modules should be compiled with the same @option{-G @var{num}} value.
19278 Compiling with different values of @var{num} may or may not work; if it
19279 doesn't the linker gives an error message---incorrect code is not
19280 generated.
19282 @item -mdebug
19283 @opindex mdebug
19284 Makes the M32R-specific code in the compiler display some statistics
19285 that might help in debugging programs.
19287 @item -malign-loops
19288 @opindex malign-loops
19289 Align all loops to a 32-byte boundary.
19291 @item -mno-align-loops
19292 @opindex mno-align-loops
19293 Do not enforce a 32-byte alignment for loops.  This is the default.
19295 @item -missue-rate=@var{number}
19296 @opindex missue-rate=@var{number}
19297 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19298 or 2.
19300 @item -mbranch-cost=@var{number}
19301 @opindex mbranch-cost=@var{number}
19302 @var{number} can only be 1 or 2.  If it is 1 then branches are
19303 preferred over conditional code, if it is 2, then the opposite applies.
19305 @item -mflush-trap=@var{number}
19306 @opindex mflush-trap=@var{number}
19307 Specifies the trap number to use to flush the cache.  The default is
19308 12.  Valid numbers are between 0 and 15 inclusive.
19310 @item -mno-flush-trap
19311 @opindex mno-flush-trap
19312 Specifies that the cache cannot be flushed by using a trap.
19314 @item -mflush-func=@var{name}
19315 @opindex mflush-func=@var{name}
19316 Specifies the name of the operating system function to call to flush
19317 the cache.  The default is @samp{_flush_cache}, but a function call
19318 is only used if a trap is not available.
19320 @item -mno-flush-func
19321 @opindex mno-flush-func
19322 Indicates that there is no OS function for flushing the cache.
19324 @end table
19326 @node M680x0 Options
19327 @subsection M680x0 Options
19328 @cindex M680x0 options
19330 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19331 The default settings depend on which architecture was selected when
19332 the compiler was configured; the defaults for the most common choices
19333 are given below.
19335 @table @gcctabopt
19336 @item -march=@var{arch}
19337 @opindex march
19338 Generate code for a specific M680x0 or ColdFire instruction set
19339 architecture.  Permissible values of @var{arch} for M680x0
19340 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19341 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19342 architectures are selected according to Freescale's ISA classification
19343 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19344 @samp{isab} and @samp{isac}.
19346 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19347 code for a ColdFire target.  The @var{arch} in this macro is one of the
19348 @option{-march} arguments given above.
19350 When used together, @option{-march} and @option{-mtune} select code
19351 that runs on a family of similar processors but that is optimized
19352 for a particular microarchitecture.
19354 @item -mcpu=@var{cpu}
19355 @opindex mcpu
19356 Generate code for a specific M680x0 or ColdFire processor.
19357 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19358 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19359 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19360 below, which also classifies the CPUs into families:
19362 @multitable @columnfractions 0.20 0.80
19363 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19364 @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}
19365 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19366 @item @samp{5206e} @tab @samp{5206e}
19367 @item @samp{5208} @tab @samp{5207} @samp{5208}
19368 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19369 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19370 @item @samp{5216} @tab @samp{5214} @samp{5216}
19371 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19372 @item @samp{5225} @tab @samp{5224} @samp{5225}
19373 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19374 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19375 @item @samp{5249} @tab @samp{5249}
19376 @item @samp{5250} @tab @samp{5250}
19377 @item @samp{5271} @tab @samp{5270} @samp{5271}
19378 @item @samp{5272} @tab @samp{5272}
19379 @item @samp{5275} @tab @samp{5274} @samp{5275}
19380 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19381 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19382 @item @samp{5307} @tab @samp{5307}
19383 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19384 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19385 @item @samp{5407} @tab @samp{5407}
19386 @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}
19387 @end multitable
19389 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19390 @var{arch} is compatible with @var{cpu}.  Other combinations of
19391 @option{-mcpu} and @option{-march} are rejected.
19393 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19394 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19395 where the value of @var{family} is given by the table above.
19397 @item -mtune=@var{tune}
19398 @opindex mtune
19399 Tune the code for a particular microarchitecture within the
19400 constraints set by @option{-march} and @option{-mcpu}.
19401 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19402 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19403 and @samp{cpu32}.  The ColdFire microarchitectures
19404 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19406 You can also use @option{-mtune=68020-40} for code that needs
19407 to run relatively well on 68020, 68030 and 68040 targets.
19408 @option{-mtune=68020-60} is similar but includes 68060 targets
19409 as well.  These two options select the same tuning decisions as
19410 @option{-m68020-40} and @option{-m68020-60} respectively.
19412 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19413 when tuning for 680x0 architecture @var{arch}.  It also defines
19414 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19415 option is used.  If GCC is tuning for a range of architectures,
19416 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19417 it defines the macros for every architecture in the range.
19419 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19420 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19421 of the arguments given above.
19423 @item -m68000
19424 @itemx -mc68000
19425 @opindex m68000
19426 @opindex mc68000
19427 Generate output for a 68000.  This is the default
19428 when the compiler is configured for 68000-based systems.
19429 It is equivalent to @option{-march=68000}.
19431 Use this option for microcontrollers with a 68000 or EC000 core,
19432 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19434 @item -m68010
19435 @opindex m68010
19436 Generate output for a 68010.  This is the default
19437 when the compiler is configured for 68010-based systems.
19438 It is equivalent to @option{-march=68010}.
19440 @item -m68020
19441 @itemx -mc68020
19442 @opindex m68020
19443 @opindex mc68020
19444 Generate output for a 68020.  This is the default
19445 when the compiler is configured for 68020-based systems.
19446 It is equivalent to @option{-march=68020}.
19448 @item -m68030
19449 @opindex m68030
19450 Generate output for a 68030.  This is the default when the compiler is
19451 configured for 68030-based systems.  It is equivalent to
19452 @option{-march=68030}.
19454 @item -m68040
19455 @opindex m68040
19456 Generate output for a 68040.  This is the default when the compiler is
19457 configured for 68040-based systems.  It is equivalent to
19458 @option{-march=68040}.
19460 This option inhibits the use of 68881/68882 instructions that have to be
19461 emulated by software on the 68040.  Use this option if your 68040 does not
19462 have code to emulate those instructions.
19464 @item -m68060
19465 @opindex m68060
19466 Generate output for a 68060.  This is the default when the compiler is
19467 configured for 68060-based systems.  It is equivalent to
19468 @option{-march=68060}.
19470 This option inhibits the use of 68020 and 68881/68882 instructions that
19471 have to be emulated by software on the 68060.  Use this option if your 68060
19472 does not have code to emulate those instructions.
19474 @item -mcpu32
19475 @opindex mcpu32
19476 Generate output for a CPU32.  This is the default
19477 when the compiler is configured for CPU32-based systems.
19478 It is equivalent to @option{-march=cpu32}.
19480 Use this option for microcontrollers with a
19481 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19482 68336, 68340, 68341, 68349 and 68360.
19484 @item -m5200
19485 @opindex m5200
19486 Generate output for a 520X ColdFire CPU@.  This is the default
19487 when the compiler is configured for 520X-based systems.
19488 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19489 in favor of that option.
19491 Use this option for microcontroller with a 5200 core, including
19492 the MCF5202, MCF5203, MCF5204 and MCF5206.
19494 @item -m5206e
19495 @opindex m5206e
19496 Generate output for a 5206e ColdFire CPU@.  The option is now
19497 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19499 @item -m528x
19500 @opindex m528x
19501 Generate output for a member of the ColdFire 528X family.
19502 The option is now deprecated in favor of the equivalent
19503 @option{-mcpu=528x}.
19505 @item -m5307
19506 @opindex m5307
19507 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19508 in favor of the equivalent @option{-mcpu=5307}.
19510 @item -m5407
19511 @opindex m5407
19512 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19513 in favor of the equivalent @option{-mcpu=5407}.
19515 @item -mcfv4e
19516 @opindex mcfv4e
19517 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19518 This includes use of hardware floating-point instructions.
19519 The option is equivalent to @option{-mcpu=547x}, and is now
19520 deprecated in favor of that option.
19522 @item -m68020-40
19523 @opindex m68020-40
19524 Generate output for a 68040, without using any of the new instructions.
19525 This results in code that can run relatively efficiently on either a
19526 68020/68881 or a 68030 or a 68040.  The generated code does use the
19527 68881 instructions that are emulated on the 68040.
19529 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19531 @item -m68020-60
19532 @opindex m68020-60
19533 Generate output for a 68060, without using any of the new instructions.
19534 This results in code that can run relatively efficiently on either a
19535 68020/68881 or a 68030 or a 68040.  The generated code does use the
19536 68881 instructions that are emulated on the 68060.
19538 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19540 @item -mhard-float
19541 @itemx -m68881
19542 @opindex mhard-float
19543 @opindex m68881
19544 Generate floating-point instructions.  This is the default for 68020
19545 and above, and for ColdFire devices that have an FPU@.  It defines the
19546 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19547 on ColdFire targets.
19549 @item -msoft-float
19550 @opindex msoft-float
19551 Do not generate floating-point instructions; use library calls instead.
19552 This is the default for 68000, 68010, and 68832 targets.  It is also
19553 the default for ColdFire devices that have no FPU.
19555 @item -mdiv
19556 @itemx -mno-div
19557 @opindex mdiv
19558 @opindex mno-div
19559 Generate (do not generate) ColdFire hardware divide and remainder
19560 instructions.  If @option{-march} is used without @option{-mcpu},
19561 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19562 architectures.  Otherwise, the default is taken from the target CPU
19563 (either the default CPU, or the one specified by @option{-mcpu}).  For
19564 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19565 @option{-mcpu=5206e}.
19567 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19569 @item -mshort
19570 @opindex mshort
19571 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19572 Additionally, parameters passed on the stack are also aligned to a
19573 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19575 @item -mno-short
19576 @opindex mno-short
19577 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19579 @item -mnobitfield
19580 @itemx -mno-bitfield
19581 @opindex mnobitfield
19582 @opindex mno-bitfield
19583 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19584 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19586 @item -mbitfield
19587 @opindex mbitfield
19588 Do use the bit-field instructions.  The @option{-m68020} option implies
19589 @option{-mbitfield}.  This is the default if you use a configuration
19590 designed for a 68020.
19592 @item -mrtd
19593 @opindex mrtd
19594 Use a different function-calling convention, in which functions
19595 that take a fixed number of arguments return with the @code{rtd}
19596 instruction, which pops their arguments while returning.  This
19597 saves one instruction in the caller since there is no need to pop
19598 the arguments there.
19600 This calling convention is incompatible with the one normally
19601 used on Unix, so you cannot use it if you need to call libraries
19602 compiled with the Unix compiler.
19604 Also, you must provide function prototypes for all functions that
19605 take variable numbers of arguments (including @code{printf});
19606 otherwise incorrect code is generated for calls to those
19607 functions.
19609 In addition, seriously incorrect code results if you call a
19610 function with too many arguments.  (Normally, extra arguments are
19611 harmlessly ignored.)
19613 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19614 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19616 @item -mno-rtd
19617 @opindex mno-rtd
19618 Do not use the calling conventions selected by @option{-mrtd}.
19619 This is the default.
19621 @item -malign-int
19622 @itemx -mno-align-int
19623 @opindex malign-int
19624 @opindex mno-align-int
19625 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19626 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19627 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19628 Aligning variables on 32-bit boundaries produces code that runs somewhat
19629 faster on processors with 32-bit busses at the expense of more memory.
19631 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19632 aligns structures containing the above types differently than
19633 most published application binary interface specifications for the m68k.
19635 @item -mpcrel
19636 @opindex mpcrel
19637 Use the pc-relative addressing mode of the 68000 directly, instead of
19638 using a global offset table.  At present, this option implies @option{-fpic},
19639 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19640 not presently supported with @option{-mpcrel}, though this could be supported for
19641 68020 and higher processors.
19643 @item -mno-strict-align
19644 @itemx -mstrict-align
19645 @opindex mno-strict-align
19646 @opindex mstrict-align
19647 Do not (do) assume that unaligned memory references are handled by
19648 the system.
19650 @item -msep-data
19651 Generate code that allows the data segment to be located in a different
19652 area of memory from the text segment.  This allows for execute-in-place in
19653 an environment without virtual memory management.  This option implies
19654 @option{-fPIC}.
19656 @item -mno-sep-data
19657 Generate code that assumes that the data segment follows the text segment.
19658 This is the default.
19660 @item -mid-shared-library
19661 Generate code that supports shared libraries via the library ID method.
19662 This allows for execute-in-place and shared libraries in an environment
19663 without virtual memory management.  This option implies @option{-fPIC}.
19665 @item -mno-id-shared-library
19666 Generate code that doesn't assume ID-based shared libraries are being used.
19667 This is the default.
19669 @item -mshared-library-id=n
19670 Specifies the identification number of the ID-based shared library being
19671 compiled.  Specifying a value of 0 generates more compact code; specifying
19672 other values forces the allocation of that number to the current
19673 library, but is no more space- or time-efficient than omitting this option.
19675 @item -mxgot
19676 @itemx -mno-xgot
19677 @opindex mxgot
19678 @opindex mno-xgot
19679 When generating position-independent code for ColdFire, generate code
19680 that works if the GOT has more than 8192 entries.  This code is
19681 larger and slower than code generated without this option.  On M680x0
19682 processors, this option is not needed; @option{-fPIC} suffices.
19684 GCC normally uses a single instruction to load values from the GOT@.
19685 While this is relatively efficient, it only works if the GOT
19686 is smaller than about 64k.  Anything larger causes the linker
19687 to report an error such as:
19689 @cindex relocation truncated to fit (ColdFire)
19690 @smallexample
19691 relocation truncated to fit: R_68K_GOT16O foobar
19692 @end smallexample
19694 If this happens, you should recompile your code with @option{-mxgot}.
19695 It should then work with very large GOTs.  However, code generated with
19696 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19697 the value of a global symbol.
19699 Note that some linkers, including newer versions of the GNU linker,
19700 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19701 you should only need to use @option{-mxgot} when compiling a single
19702 object file that accesses more than 8192 GOT entries.  Very few do.
19704 These options have no effect unless GCC is generating
19705 position-independent code.
19707 @item -mlong-jump-table-offsets
19708 @opindex mlong-jump-table-offsets
19709 Use 32-bit offsets in @code{switch} tables.  The default is to use
19710 16-bit offsets.
19712 @end table
19714 @node MCore Options
19715 @subsection MCore Options
19716 @cindex MCore options
19718 These are the @samp{-m} options defined for the Motorola M*Core
19719 processors.
19721 @table @gcctabopt
19723 @item -mhardlit
19724 @itemx -mno-hardlit
19725 @opindex mhardlit
19726 @opindex mno-hardlit
19727 Inline constants into the code stream if it can be done in two
19728 instructions or less.
19730 @item -mdiv
19731 @itemx -mno-div
19732 @opindex mdiv
19733 @opindex mno-div
19734 Use the divide instruction.  (Enabled by default).
19736 @item -mrelax-immediate
19737 @itemx -mno-relax-immediate
19738 @opindex mrelax-immediate
19739 @opindex mno-relax-immediate
19740 Allow arbitrary-sized immediates in bit operations.
19742 @item -mwide-bitfields
19743 @itemx -mno-wide-bitfields
19744 @opindex mwide-bitfields
19745 @opindex mno-wide-bitfields
19746 Always treat bit-fields as @code{int}-sized.
19748 @item -m4byte-functions
19749 @itemx -mno-4byte-functions
19750 @opindex m4byte-functions
19751 @opindex mno-4byte-functions
19752 Force all functions to be aligned to a 4-byte boundary.
19754 @item -mcallgraph-data
19755 @itemx -mno-callgraph-data
19756 @opindex mcallgraph-data
19757 @opindex mno-callgraph-data
19758 Emit callgraph information.
19760 @item -mslow-bytes
19761 @itemx -mno-slow-bytes
19762 @opindex mslow-bytes
19763 @opindex mno-slow-bytes
19764 Prefer word access when reading byte quantities.
19766 @item -mlittle-endian
19767 @itemx -mbig-endian
19768 @opindex mlittle-endian
19769 @opindex mbig-endian
19770 Generate code for a little-endian target.
19772 @item -m210
19773 @itemx -m340
19774 @opindex m210
19775 @opindex m340
19776 Generate code for the 210 processor.
19778 @item -mno-lsim
19779 @opindex mno-lsim
19780 Assume that runtime support has been provided and so omit the
19781 simulator library (@file{libsim.a)} from the linker command line.
19783 @item -mstack-increment=@var{size}
19784 @opindex mstack-increment
19785 Set the maximum amount for a single stack increment operation.  Large
19786 values can increase the speed of programs that contain functions
19787 that need a large amount of stack space, but they can also trigger a
19788 segmentation fault if the stack is extended too much.  The default
19789 value is 0x1000.
19791 @end table
19793 @node MeP Options
19794 @subsection MeP Options
19795 @cindex MeP options
19797 @table @gcctabopt
19799 @item -mabsdiff
19800 @opindex mabsdiff
19801 Enables the @code{abs} instruction, which is the absolute difference
19802 between two registers.
19804 @item -mall-opts
19805 @opindex mall-opts
19806 Enables all the optional instructions---average, multiply, divide, bit
19807 operations, leading zero, absolute difference, min/max, clip, and
19808 saturation.
19811 @item -maverage
19812 @opindex maverage
19813 Enables the @code{ave} instruction, which computes the average of two
19814 registers.
19816 @item -mbased=@var{n}
19817 @opindex mbased=
19818 Variables of size @var{n} bytes or smaller are placed in the
19819 @code{.based} section by default.  Based variables use the @code{$tp}
19820 register as a base register, and there is a 128-byte limit to the
19821 @code{.based} section.
19823 @item -mbitops
19824 @opindex mbitops
19825 Enables the bit operation instructions---bit test (@code{btstm}), set
19826 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19827 test-and-set (@code{tas}).
19829 @item -mc=@var{name}
19830 @opindex mc=
19831 Selects which section constant data is placed in.  @var{name} may
19832 be @samp{tiny}, @samp{near}, or @samp{far}.
19834 @item -mclip
19835 @opindex mclip
19836 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19837 useful unless you also provide @option{-mminmax}.
19839 @item -mconfig=@var{name}
19840 @opindex mconfig=
19841 Selects one of the built-in core configurations.  Each MeP chip has
19842 one or more modules in it; each module has a core CPU and a variety of
19843 coprocessors, optional instructions, and peripherals.  The
19844 @code{MeP-Integrator} tool, not part of GCC, provides these
19845 configurations through this option; using this option is the same as
19846 using all the corresponding command-line options.  The default
19847 configuration is @samp{default}.
19849 @item -mcop
19850 @opindex mcop
19851 Enables the coprocessor instructions.  By default, this is a 32-bit
19852 coprocessor.  Note that the coprocessor is normally enabled via the
19853 @option{-mconfig=} option.
19855 @item -mcop32
19856 @opindex mcop32
19857 Enables the 32-bit coprocessor's instructions.
19859 @item -mcop64
19860 @opindex mcop64
19861 Enables the 64-bit coprocessor's instructions.
19863 @item -mivc2
19864 @opindex mivc2
19865 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19867 @item -mdc
19868 @opindex mdc
19869 Causes constant variables to be placed in the @code{.near} section.
19871 @item -mdiv
19872 @opindex mdiv
19873 Enables the @code{div} and @code{divu} instructions.
19875 @item -meb
19876 @opindex meb
19877 Generate big-endian code.
19879 @item -mel
19880 @opindex mel
19881 Generate little-endian code.
19883 @item -mio-volatile
19884 @opindex mio-volatile
19885 Tells the compiler that any variable marked with the @code{io}
19886 attribute is to be considered volatile.
19888 @item -ml
19889 @opindex ml
19890 Causes variables to be assigned to the @code{.far} section by default.
19892 @item -mleadz
19893 @opindex mleadz
19894 Enables the @code{leadz} (leading zero) instruction.
19896 @item -mm
19897 @opindex mm
19898 Causes variables to be assigned to the @code{.near} section by default.
19900 @item -mminmax
19901 @opindex mminmax
19902 Enables the @code{min} and @code{max} instructions.
19904 @item -mmult
19905 @opindex mmult
19906 Enables the multiplication and multiply-accumulate instructions.
19908 @item -mno-opts
19909 @opindex mno-opts
19910 Disables all the optional instructions enabled by @option{-mall-opts}.
19912 @item -mrepeat
19913 @opindex mrepeat
19914 Enables the @code{repeat} and @code{erepeat} instructions, used for
19915 low-overhead looping.
19917 @item -ms
19918 @opindex ms
19919 Causes all variables to default to the @code{.tiny} section.  Note
19920 that there is a 65536-byte limit to this section.  Accesses to these
19921 variables use the @code{%gp} base register.
19923 @item -msatur
19924 @opindex msatur
19925 Enables the saturation instructions.  Note that the compiler does not
19926 currently generate these itself, but this option is included for
19927 compatibility with other tools, like @code{as}.
19929 @item -msdram
19930 @opindex msdram
19931 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19933 @item -msim
19934 @opindex msim
19935 Link the simulator run-time libraries.
19937 @item -msimnovec
19938 @opindex msimnovec
19939 Link the simulator runtime libraries, excluding built-in support
19940 for reset and exception vectors and tables.
19942 @item -mtf
19943 @opindex mtf
19944 Causes all functions to default to the @code{.far} section.  Without
19945 this option, functions default to the @code{.near} section.
19947 @item -mtiny=@var{n}
19948 @opindex mtiny=
19949 Variables that are @var{n} bytes or smaller are allocated to the
19950 @code{.tiny} section.  These variables use the @code{$gp} base
19951 register.  The default for this option is 4, but note that there's a
19952 65536-byte limit to the @code{.tiny} section.
19954 @end table
19956 @node MicroBlaze Options
19957 @subsection MicroBlaze Options
19958 @cindex MicroBlaze Options
19960 @table @gcctabopt
19962 @item -msoft-float
19963 @opindex msoft-float
19964 Use software emulation for floating point (default).
19966 @item -mhard-float
19967 @opindex mhard-float
19968 Use hardware floating-point instructions.
19970 @item -mmemcpy
19971 @opindex mmemcpy
19972 Do not optimize block moves, use @code{memcpy}.
19974 @item -mno-clearbss
19975 @opindex mno-clearbss
19976 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19978 @item -mcpu=@var{cpu-type}
19979 @opindex mcpu=
19980 Use features of, and schedule code for, the given CPU.
19981 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19982 where @var{X} is a major version, @var{YY} is the minor version, and
19983 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19984 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19986 @item -mxl-soft-mul
19987 @opindex mxl-soft-mul
19988 Use software multiply emulation (default).
19990 @item -mxl-soft-div
19991 @opindex mxl-soft-div
19992 Use software emulation for divides (default).
19994 @item -mxl-barrel-shift
19995 @opindex mxl-barrel-shift
19996 Use the hardware barrel shifter.
19998 @item -mxl-pattern-compare
19999 @opindex mxl-pattern-compare
20000 Use pattern compare instructions.
20002 @item -msmall-divides
20003 @opindex msmall-divides
20004 Use table lookup optimization for small signed integer divisions.
20006 @item -mxl-stack-check
20007 @opindex mxl-stack-check
20008 This option is deprecated.  Use @option{-fstack-check} instead.
20010 @item -mxl-gp-opt
20011 @opindex mxl-gp-opt
20012 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20014 @item -mxl-multiply-high
20015 @opindex mxl-multiply-high
20016 Use multiply high instructions for high part of 32x32 multiply.
20018 @item -mxl-float-convert
20019 @opindex mxl-float-convert
20020 Use hardware floating-point conversion instructions.
20022 @item -mxl-float-sqrt
20023 @opindex mxl-float-sqrt
20024 Use hardware floating-point square root instruction.
20026 @item -mbig-endian
20027 @opindex mbig-endian
20028 Generate code for a big-endian target.
20030 @item -mlittle-endian
20031 @opindex mlittle-endian
20032 Generate code for a little-endian target.
20034 @item -mxl-reorder
20035 @opindex mxl-reorder
20036 Use reorder instructions (swap and byte reversed load/store).
20038 @item -mxl-mode-@var{app-model}
20039 Select application model @var{app-model}.  Valid models are
20040 @table @samp
20041 @item executable
20042 normal executable (default), uses startup code @file{crt0.o}.
20044 @item -mpic-data-is-text-relative
20045 @opindex mpic-data-is-text-relative
20046 Assume that the displacement between the text and data segments is fixed
20047 at static link time.  This allows data to be referenced by offset from start of
20048 text address instead of GOT since PC-relative addressing is not supported.
20050 @item xmdstub
20051 for use with Xilinx Microprocessor Debugger (XMD) based
20052 software intrusive debug agent called xmdstub. This uses startup file
20053 @file{crt1.o} and sets the start address of the program to 0x800.
20055 @item bootstrap
20056 for applications that are loaded using a bootloader.
20057 This model uses startup file @file{crt2.o} which does not contain a processor
20058 reset vector handler. This is suitable for transferring control on a
20059 processor reset to the bootloader rather than the application.
20061 @item novectors
20062 for applications that do not require any of the
20063 MicroBlaze vectors. This option may be useful for applications running
20064 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20065 @end table
20067 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20068 @option{-mxl-mode-@var{app-model}}.
20070 @end table
20072 @node MIPS Options
20073 @subsection MIPS Options
20074 @cindex MIPS options
20076 @table @gcctabopt
20078 @item -EB
20079 @opindex EB
20080 Generate big-endian code.
20082 @item -EL
20083 @opindex EL
20084 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20085 configurations.
20087 @item -march=@var{arch}
20088 @opindex march
20089 Generate code that runs on @var{arch}, which can be the name of a
20090 generic MIPS ISA, or the name of a particular processor.
20091 The ISA names are:
20092 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20093 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20094 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20095 @samp{mips64r5} and @samp{mips64r6}.
20096 The processor names are:
20097 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20098 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20099 @samp{5kc}, @samp{5kf},
20100 @samp{20kc},
20101 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20102 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20103 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20104 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20105 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20106 @samp{i6400}, @samp{i6500},
20107 @samp{interaptiv},
20108 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20109 @samp{m4k},
20110 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20111 @samp{m5100}, @samp{m5101},
20112 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20113 @samp{orion},
20114 @samp{p5600}, @samp{p6600},
20115 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20116 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20117 @samp{rm7000}, @samp{rm9000},
20118 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20119 @samp{sb1},
20120 @samp{sr71000},
20121 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20122 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20123 @samp{xlr} and @samp{xlp}.
20124 The special value @samp{from-abi} selects the
20125 most compatible architecture for the selected ABI (that is,
20126 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20128 The native Linux/GNU toolchain also supports the value @samp{native},
20129 which selects the best architecture option for the host processor.
20130 @option{-march=native} has no effect if GCC does not recognize
20131 the processor.
20133 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20134 (for example, @option{-march=r2k}).  Prefixes are optional, and
20135 @samp{vr} may be written @samp{r}.
20137 Names of the form @samp{@var{n}f2_1} refer to processors with
20138 FPUs clocked at half the rate of the core, names of the form
20139 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20140 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20141 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20142 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20143 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20144 accepted as synonyms for @samp{@var{n}f1_1}.
20146 GCC defines two macros based on the value of this option.  The first
20147 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20148 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20149 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20150 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20151 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20153 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20154 above.  In other words, it has the full prefix and does not
20155 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20156 the macro names the resolved architecture (either @code{"mips1"} or
20157 @code{"mips3"}).  It names the default architecture when no
20158 @option{-march} option is given.
20160 @item -mtune=@var{arch}
20161 @opindex mtune
20162 Optimize for @var{arch}.  Among other things, this option controls
20163 the way instructions are scheduled, and the perceived cost of arithmetic
20164 operations.  The list of @var{arch} values is the same as for
20165 @option{-march}.
20167 When this option is not used, GCC optimizes for the processor
20168 specified by @option{-march}.  By using @option{-march} and
20169 @option{-mtune} together, it is possible to generate code that
20170 runs on a family of processors, but optimize the code for one
20171 particular member of that family.
20173 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20174 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20175 @option{-march} ones described above.
20177 @item -mips1
20178 @opindex mips1
20179 Equivalent to @option{-march=mips1}.
20181 @item -mips2
20182 @opindex mips2
20183 Equivalent to @option{-march=mips2}.
20185 @item -mips3
20186 @opindex mips3
20187 Equivalent to @option{-march=mips3}.
20189 @item -mips4
20190 @opindex mips4
20191 Equivalent to @option{-march=mips4}.
20193 @item -mips32
20194 @opindex mips32
20195 Equivalent to @option{-march=mips32}.
20197 @item -mips32r3
20198 @opindex mips32r3
20199 Equivalent to @option{-march=mips32r3}.
20201 @item -mips32r5
20202 @opindex mips32r5
20203 Equivalent to @option{-march=mips32r5}.
20205 @item -mips32r6
20206 @opindex mips32r6
20207 Equivalent to @option{-march=mips32r6}.
20209 @item -mips64
20210 @opindex mips64
20211 Equivalent to @option{-march=mips64}.
20213 @item -mips64r2
20214 @opindex mips64r2
20215 Equivalent to @option{-march=mips64r2}.
20217 @item -mips64r3
20218 @opindex mips64r3
20219 Equivalent to @option{-march=mips64r3}.
20221 @item -mips64r5
20222 @opindex mips64r5
20223 Equivalent to @option{-march=mips64r5}.
20225 @item -mips64r6
20226 @opindex mips64r6
20227 Equivalent to @option{-march=mips64r6}.
20229 @item -mips16
20230 @itemx -mno-mips16
20231 @opindex mips16
20232 @opindex mno-mips16
20233 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20234 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20236 MIPS16 code generation can also be controlled on a per-function basis
20237 by means of @code{mips16} and @code{nomips16} attributes.
20238 @xref{Function Attributes}, for more information.
20240 @item -mflip-mips16
20241 @opindex mflip-mips16
20242 Generate MIPS16 code on alternating functions.  This option is provided
20243 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20244 not intended for ordinary use in compiling user code.
20246 @item -minterlink-compressed
20247 @itemx -mno-interlink-compressed
20248 @opindex minterlink-compressed
20249 @opindex mno-interlink-compressed
20250 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20251 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20253 For example, code using the standard ISA encoding cannot jump directly
20254 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20255 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20256 knows that the target of the jump is not compressed.
20258 @item -minterlink-mips16
20259 @itemx -mno-interlink-mips16
20260 @opindex minterlink-mips16
20261 @opindex mno-interlink-mips16
20262 Aliases of @option{-minterlink-compressed} and
20263 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20264 and are retained for backwards compatibility.
20266 @item -mabi=32
20267 @itemx -mabi=o64
20268 @itemx -mabi=n32
20269 @itemx -mabi=64
20270 @itemx -mabi=eabi
20271 @opindex mabi=32
20272 @opindex mabi=o64
20273 @opindex mabi=n32
20274 @opindex mabi=64
20275 @opindex mabi=eabi
20276 Generate code for the given ABI@.
20278 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20279 generates 64-bit code when you select a 64-bit architecture, but you
20280 can use @option{-mgp32} to get 32-bit code instead.
20282 For information about the O64 ABI, see
20283 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20285 GCC supports a variant of the o32 ABI in which floating-point registers
20286 are 64 rather than 32 bits wide.  You can select this combination with
20287 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20288 and @code{mfhc1} instructions and is therefore only supported for
20289 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20291 The register assignments for arguments and return values remain the
20292 same, but each scalar value is passed in a single 64-bit register
20293 rather than a pair of 32-bit registers.  For example, scalar
20294 floating-point values are returned in @samp{$f0} only, not a
20295 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20296 remains the same in that the even-numbered double-precision registers
20297 are saved.
20299 Two additional variants of the o32 ABI are supported to enable
20300 a transition from 32-bit to 64-bit registers.  These are FPXX
20301 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20302 The FPXX extension mandates that all code must execute correctly
20303 when run using 32-bit or 64-bit registers.  The code can be interlinked
20304 with either FP32 or FP64, but not both.
20305 The FP64A extension is similar to the FP64 extension but forbids the
20306 use of odd-numbered single-precision registers.  This can be used
20307 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20308 processors and allows both FP32 and FP64A code to interlink and
20309 run in the same process without changing FPU modes.
20311 @item -mabicalls
20312 @itemx -mno-abicalls
20313 @opindex mabicalls
20314 @opindex mno-abicalls
20315 Generate (do not generate) code that is suitable for SVR4-style
20316 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20317 systems.
20319 @item -mshared
20320 @itemx -mno-shared
20321 Generate (do not generate) code that is fully position-independent,
20322 and that can therefore be linked into shared libraries.  This option
20323 only affects @option{-mabicalls}.
20325 All @option{-mabicalls} code has traditionally been position-independent,
20326 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20327 as an extension, the GNU toolchain allows executables to use absolute
20328 accesses for locally-binding symbols.  It can also use shorter GP
20329 initialization sequences and generate direct calls to locally-defined
20330 functions.  This mode is selected by @option{-mno-shared}.
20332 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20333 objects that can only be linked by the GNU linker.  However, the option
20334 does not affect the ABI of the final executable; it only affects the ABI
20335 of relocatable objects.  Using @option{-mno-shared} generally makes
20336 executables both smaller and quicker.
20338 @option{-mshared} is the default.
20340 @item -mplt
20341 @itemx -mno-plt
20342 @opindex mplt
20343 @opindex mno-plt
20344 Assume (do not assume) that the static and dynamic linkers
20345 support PLTs and copy relocations.  This option only affects
20346 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20347 has no effect without @option{-msym32}.
20349 You can make @option{-mplt} the default by configuring
20350 GCC with @option{--with-mips-plt}.  The default is
20351 @option{-mno-plt} otherwise.
20353 @item -mxgot
20354 @itemx -mno-xgot
20355 @opindex mxgot
20356 @opindex mno-xgot
20357 Lift (do not lift) the usual restrictions on the size of the global
20358 offset table.
20360 GCC normally uses a single instruction to load values from the GOT@.
20361 While this is relatively efficient, it only works if the GOT
20362 is smaller than about 64k.  Anything larger causes the linker
20363 to report an error such as:
20365 @cindex relocation truncated to fit (MIPS)
20366 @smallexample
20367 relocation truncated to fit: R_MIPS_GOT16 foobar
20368 @end smallexample
20370 If this happens, you should recompile your code with @option{-mxgot}.
20371 This works with very large GOTs, although the code is also
20372 less efficient, since it takes three instructions to fetch the
20373 value of a global symbol.
20375 Note that some linkers can create multiple GOTs.  If you have such a
20376 linker, you should only need to use @option{-mxgot} when a single object
20377 file accesses more than 64k's worth of GOT entries.  Very few do.
20379 These options have no effect unless GCC is generating position
20380 independent code.
20382 @item -mgp32
20383 @opindex mgp32
20384 Assume that general-purpose registers are 32 bits wide.
20386 @item -mgp64
20387 @opindex mgp64
20388 Assume that general-purpose registers are 64 bits wide.
20390 @item -mfp32
20391 @opindex mfp32
20392 Assume that floating-point registers are 32 bits wide.
20394 @item -mfp64
20395 @opindex mfp64
20396 Assume that floating-point registers are 64 bits wide.
20398 @item -mfpxx
20399 @opindex mfpxx
20400 Do not assume the width of floating-point registers.
20402 @item -mhard-float
20403 @opindex mhard-float
20404 Use floating-point coprocessor instructions.
20406 @item -msoft-float
20407 @opindex msoft-float
20408 Do not use floating-point coprocessor instructions.  Implement
20409 floating-point calculations using library calls instead.
20411 @item -mno-float
20412 @opindex mno-float
20413 Equivalent to @option{-msoft-float}, but additionally asserts that the
20414 program being compiled does not perform any floating-point operations.
20415 This option is presently supported only by some bare-metal MIPS
20416 configurations, where it may select a special set of libraries
20417 that lack all floating-point support (including, for example, the
20418 floating-point @code{printf} formats).  
20419 If code compiled with @option{-mno-float} accidentally contains
20420 floating-point operations, it is likely to suffer a link-time
20421 or run-time failure.
20423 @item -msingle-float
20424 @opindex msingle-float
20425 Assume that the floating-point coprocessor only supports single-precision
20426 operations.
20428 @item -mdouble-float
20429 @opindex mdouble-float
20430 Assume that the floating-point coprocessor supports double-precision
20431 operations.  This is the default.
20433 @item -modd-spreg
20434 @itemx -mno-odd-spreg
20435 @opindex modd-spreg
20436 @opindex mno-odd-spreg
20437 Enable the use of odd-numbered single-precision floating-point registers
20438 for the o32 ABI.  This is the default for processors that are known to
20439 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20440 is set by default.
20442 @item -mabs=2008
20443 @itemx -mabs=legacy
20444 @opindex mabs=2008
20445 @opindex mabs=legacy
20446 These options control the treatment of the special not-a-number (NaN)
20447 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20448 @code{neg.@i{fmt}} machine instructions.
20450 By default or when @option{-mabs=legacy} is used the legacy
20451 treatment is selected.  In this case these instructions are considered
20452 arithmetic and avoided where correct operation is required and the
20453 input operand might be a NaN.  A longer sequence of instructions that
20454 manipulate the sign bit of floating-point datum manually is used
20455 instead unless the @option{-ffinite-math-only} option has also been
20456 specified.
20458 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20459 this case these instructions are considered non-arithmetic and therefore
20460 operating correctly in all cases, including in particular where the
20461 input operand is a NaN.  These instructions are therefore always used
20462 for the respective operations.
20464 @item -mnan=2008
20465 @itemx -mnan=legacy
20466 @opindex mnan=2008
20467 @opindex mnan=legacy
20468 These options control the encoding of the special not-a-number (NaN)
20469 IEEE 754 floating-point data.
20471 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20472 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20473 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20474 by the first bit of their trailing significand field being 1.
20476 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20477 this case qNaNs are denoted by the first bit of their trailing
20478 significand field being 1, whereas sNaNs are denoted by the first bit of
20479 their trailing significand field being 0.
20481 The default is @option{-mnan=legacy} unless GCC has been configured with
20482 @option{--with-nan=2008}.
20484 @item -mllsc
20485 @itemx -mno-llsc
20486 @opindex mllsc
20487 @opindex mno-llsc
20488 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20489 implement atomic memory built-in functions.  When neither option is
20490 specified, GCC uses the instructions if the target architecture
20491 supports them.
20493 @option{-mllsc} is useful if the runtime environment can emulate the
20494 instructions and @option{-mno-llsc} can be useful when compiling for
20495 nonstandard ISAs.  You can make either option the default by
20496 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20497 respectively.  @option{--with-llsc} is the default for some
20498 configurations; see the installation documentation for details.
20500 @item -mdsp
20501 @itemx -mno-dsp
20502 @opindex mdsp
20503 @opindex mno-dsp
20504 Use (do not use) revision 1 of the MIPS DSP ASE@.
20505 @xref{MIPS DSP Built-in Functions}.  This option defines the
20506 preprocessor macro @code{__mips_dsp}.  It also defines
20507 @code{__mips_dsp_rev} to 1.
20509 @item -mdspr2
20510 @itemx -mno-dspr2
20511 @opindex mdspr2
20512 @opindex mno-dspr2
20513 Use (do not use) revision 2 of the MIPS DSP ASE@.
20514 @xref{MIPS DSP Built-in Functions}.  This option defines the
20515 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20516 It also defines @code{__mips_dsp_rev} to 2.
20518 @item -msmartmips
20519 @itemx -mno-smartmips
20520 @opindex msmartmips
20521 @opindex mno-smartmips
20522 Use (do not use) the MIPS SmartMIPS ASE.
20524 @item -mpaired-single
20525 @itemx -mno-paired-single
20526 @opindex mpaired-single
20527 @opindex mno-paired-single
20528 Use (do not use) paired-single floating-point instructions.
20529 @xref{MIPS Paired-Single Support}.  This option requires
20530 hardware floating-point support to be enabled.
20532 @item -mdmx
20533 @itemx -mno-mdmx
20534 @opindex mdmx
20535 @opindex mno-mdmx
20536 Use (do not use) MIPS Digital Media Extension instructions.
20537 This option can only be used when generating 64-bit code and requires
20538 hardware floating-point support to be enabled.
20540 @item -mips3d
20541 @itemx -mno-mips3d
20542 @opindex mips3d
20543 @opindex mno-mips3d
20544 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20545 The option @option{-mips3d} implies @option{-mpaired-single}.
20547 @item -mmicromips
20548 @itemx -mno-micromips
20549 @opindex mmicromips
20550 @opindex mno-mmicromips
20551 Generate (do not generate) microMIPS code.
20553 MicroMIPS code generation can also be controlled on a per-function basis
20554 by means of @code{micromips} and @code{nomicromips} attributes.
20555 @xref{Function Attributes}, for more information.
20557 @item -mmt
20558 @itemx -mno-mt
20559 @opindex mmt
20560 @opindex mno-mt
20561 Use (do not use) MT Multithreading instructions.
20563 @item -mmcu
20564 @itemx -mno-mcu
20565 @opindex mmcu
20566 @opindex mno-mcu
20567 Use (do not use) the MIPS MCU ASE instructions.
20569 @item -meva
20570 @itemx -mno-eva
20571 @opindex meva
20572 @opindex mno-eva
20573 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20575 @item -mvirt
20576 @itemx -mno-virt
20577 @opindex mvirt
20578 @opindex mno-virt
20579 Use (do not use) the MIPS Virtualization (VZ) instructions.
20581 @item -mxpa
20582 @itemx -mno-xpa
20583 @opindex mxpa
20584 @opindex mno-xpa
20585 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20587 @item -mcrc
20588 @itemx -mno-crc
20589 @opindex mcrc
20590 @opindex mno-crc
20591 Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
20593 @item -mginv
20594 @itemx -mno-ginv
20595 @opindex mginv
20596 @opindex mno-ginv
20597 Use (do not use) the MIPS Global INValidate (GINV) instructions.
20599 @item -mlong64
20600 @opindex mlong64
20601 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20602 an explanation of the default and the way that the pointer size is
20603 determined.
20605 @item -mlong32
20606 @opindex mlong32
20607 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20609 The default size of @code{int}s, @code{long}s and pointers depends on
20610 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20611 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20612 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20613 or the same size as integer registers, whichever is smaller.
20615 @item -msym32
20616 @itemx -mno-sym32
20617 @opindex msym32
20618 @opindex mno-sym32
20619 Assume (do not assume) that all symbols have 32-bit values, regardless
20620 of the selected ABI@.  This option is useful in combination with
20621 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20622 to generate shorter and faster references to symbolic addresses.
20624 @item -G @var{num}
20625 @opindex G
20626 Put definitions of externally-visible data in a small data section
20627 if that data is no bigger than @var{num} bytes.  GCC can then generate
20628 more efficient accesses to the data; see @option{-mgpopt} for details.
20630 The default @option{-G} option depends on the configuration.
20632 @item -mlocal-sdata
20633 @itemx -mno-local-sdata
20634 @opindex mlocal-sdata
20635 @opindex mno-local-sdata
20636 Extend (do not extend) the @option{-G} behavior to local data too,
20637 such as to static variables in C@.  @option{-mlocal-sdata} is the
20638 default for all configurations.
20640 If the linker complains that an application is using too much small data,
20641 you might want to try rebuilding the less performance-critical parts with
20642 @option{-mno-local-sdata}.  You might also want to build large
20643 libraries with @option{-mno-local-sdata}, so that the libraries leave
20644 more room for the main program.
20646 @item -mextern-sdata
20647 @itemx -mno-extern-sdata
20648 @opindex mextern-sdata
20649 @opindex mno-extern-sdata
20650 Assume (do not assume) that externally-defined data is in
20651 a small data section if the size of that data is within the @option{-G} limit.
20652 @option{-mextern-sdata} is the default for all configurations.
20654 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20655 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20656 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20657 is placed in a small data section.  If @var{Var} is defined by another
20658 module, you must either compile that module with a high-enough
20659 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20660 definition.  If @var{Var} is common, you must link the application
20661 with a high-enough @option{-G} setting.
20663 The easiest way of satisfying these restrictions is to compile
20664 and link every module with the same @option{-G} option.  However,
20665 you may wish to build a library that supports several different
20666 small data limits.  You can do this by compiling the library with
20667 the highest supported @option{-G} setting and additionally using
20668 @option{-mno-extern-sdata} to stop the library from making assumptions
20669 about externally-defined data.
20671 @item -mgpopt
20672 @itemx -mno-gpopt
20673 @opindex mgpopt
20674 @opindex mno-gpopt
20675 Use (do not use) GP-relative accesses for symbols that are known to be
20676 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20677 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20678 configurations.
20680 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20681 might not hold the value of @code{_gp}.  For example, if the code is
20682 part of a library that might be used in a boot monitor, programs that
20683 call boot monitor routines pass an unknown value in @code{$gp}.
20684 (In such situations, the boot monitor itself is usually compiled
20685 with @option{-G0}.)
20687 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20688 @option{-mno-extern-sdata}.
20690 @item -membedded-data
20691 @itemx -mno-embedded-data
20692 @opindex membedded-data
20693 @opindex mno-embedded-data
20694 Allocate variables to the read-only data section first if possible, then
20695 next in the small data section if possible, otherwise in data.  This gives
20696 slightly slower code than the default, but reduces the amount of RAM required
20697 when executing, and thus may be preferred for some embedded systems.
20699 @item -muninit-const-in-rodata
20700 @itemx -mno-uninit-const-in-rodata
20701 @opindex muninit-const-in-rodata
20702 @opindex mno-uninit-const-in-rodata
20703 Put uninitialized @code{const} variables in the read-only data section.
20704 This option is only meaningful in conjunction with @option{-membedded-data}.
20706 @item -mcode-readable=@var{setting}
20707 @opindex mcode-readable
20708 Specify whether GCC may generate code that reads from executable sections.
20709 There are three possible settings:
20711 @table @gcctabopt
20712 @item -mcode-readable=yes
20713 Instructions may freely access executable sections.  This is the
20714 default setting.
20716 @item -mcode-readable=pcrel
20717 MIPS16 PC-relative load instructions can access executable sections,
20718 but other instructions must not do so.  This option is useful on 4KSc
20719 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20720 It is also useful on processors that can be configured to have a dual
20721 instruction/data SRAM interface and that, like the M4K, automatically
20722 redirect PC-relative loads to the instruction RAM.
20724 @item -mcode-readable=no
20725 Instructions must not access executable sections.  This option can be
20726 useful on targets that are configured to have a dual instruction/data
20727 SRAM interface but that (unlike the M4K) do not automatically redirect
20728 PC-relative loads to the instruction RAM.
20729 @end table
20731 @item -msplit-addresses
20732 @itemx -mno-split-addresses
20733 @opindex msplit-addresses
20734 @opindex mno-split-addresses
20735 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20736 relocation operators.  This option has been superseded by
20737 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20739 @item -mexplicit-relocs
20740 @itemx -mno-explicit-relocs
20741 @opindex mexplicit-relocs
20742 @opindex mno-explicit-relocs
20743 Use (do not use) assembler relocation operators when dealing with symbolic
20744 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20745 is to use assembler macros instead.
20747 @option{-mexplicit-relocs} is the default if GCC was configured
20748 to use an assembler that supports relocation operators.
20750 @item -mcheck-zero-division
20751 @itemx -mno-check-zero-division
20752 @opindex mcheck-zero-division
20753 @opindex mno-check-zero-division
20754 Trap (do not trap) on integer division by zero.
20756 The default is @option{-mcheck-zero-division}.
20758 @item -mdivide-traps
20759 @itemx -mdivide-breaks
20760 @opindex mdivide-traps
20761 @opindex mdivide-breaks
20762 MIPS systems check for division by zero by generating either a
20763 conditional trap or a break instruction.  Using traps results in
20764 smaller code, but is only supported on MIPS II and later.  Also, some
20765 versions of the Linux kernel have a bug that prevents trap from
20766 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20767 allow conditional traps on architectures that support them and
20768 @option{-mdivide-breaks} to force the use of breaks.
20770 The default is usually @option{-mdivide-traps}, but this can be
20771 overridden at configure time using @option{--with-divide=breaks}.
20772 Divide-by-zero checks can be completely disabled using
20773 @option{-mno-check-zero-division}.
20775 @item -mload-store-pairs
20776 @itemx -mno-load-store-pairs
20777 @opindex mload-store-pairs
20778 @opindex mno-load-store-pairs
20779 Enable (disable) an optimization that pairs consecutive load or store
20780 instructions to enable load/store bonding.  This option is enabled by
20781 default but only takes effect when the selected architecture is known
20782 to support bonding.
20784 @item -mmemcpy
20785 @itemx -mno-memcpy
20786 @opindex mmemcpy
20787 @opindex mno-memcpy
20788 Force (do not force) the use of @code{memcpy} for non-trivial block
20789 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20790 most constant-sized copies.
20792 @item -mlong-calls
20793 @itemx -mno-long-calls
20794 @opindex mlong-calls
20795 @opindex mno-long-calls
20796 Disable (do not disable) use of the @code{jal} instruction.  Calling
20797 functions using @code{jal} is more efficient but requires the caller
20798 and callee to be in the same 256 megabyte segment.
20800 This option has no effect on abicalls code.  The default is
20801 @option{-mno-long-calls}.
20803 @item -mmad
20804 @itemx -mno-mad
20805 @opindex mmad
20806 @opindex mno-mad
20807 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20808 instructions, as provided by the R4650 ISA@.
20810 @item -mimadd
20811 @itemx -mno-imadd
20812 @opindex mimadd
20813 @opindex mno-imadd
20814 Enable (disable) use of the @code{madd} and @code{msub} integer
20815 instructions.  The default is @option{-mimadd} on architectures
20816 that support @code{madd} and @code{msub} except for the 74k 
20817 architecture where it was found to generate slower code.
20819 @item -mfused-madd
20820 @itemx -mno-fused-madd
20821 @opindex mfused-madd
20822 @opindex mno-fused-madd
20823 Enable (disable) use of the floating-point multiply-accumulate
20824 instructions, when they are available.  The default is
20825 @option{-mfused-madd}.
20827 On the R8000 CPU when multiply-accumulate instructions are used,
20828 the intermediate product is calculated to infinite precision
20829 and is not subject to the FCSR Flush to Zero bit.  This may be
20830 undesirable in some circumstances.  On other processors the result
20831 is numerically identical to the equivalent computation using
20832 separate multiply, add, subtract and negate instructions.
20834 @item -nocpp
20835 @opindex nocpp
20836 Tell the MIPS assembler to not run its preprocessor over user
20837 assembler files (with a @samp{.s} suffix) when assembling them.
20839 @item -mfix-24k
20840 @itemx -mno-fix-24k
20841 @opindex mfix-24k
20842 @opindex mno-fix-24k
20843 Work around the 24K E48 (lost data on stores during refill) errata.
20844 The workarounds are implemented by the assembler rather than by GCC@.
20846 @item -mfix-r4000
20847 @itemx -mno-fix-r4000
20848 @opindex mfix-r4000
20849 @opindex mno-fix-r4000
20850 Work around certain R4000 CPU errata:
20851 @itemize @minus
20852 @item
20853 A double-word or a variable shift may give an incorrect result if executed
20854 immediately after starting an integer division.
20855 @item
20856 A double-word or a variable shift may give an incorrect result if executed
20857 while an integer multiplication is in progress.
20858 @item
20859 An integer division may give an incorrect result if started in a delay slot
20860 of a taken branch or a jump.
20861 @end itemize
20863 @item -mfix-r4400
20864 @itemx -mno-fix-r4400
20865 @opindex mfix-r4400
20866 @opindex mno-fix-r4400
20867 Work around certain R4400 CPU errata:
20868 @itemize @minus
20869 @item
20870 A double-word or a variable shift may give an incorrect result if executed
20871 immediately after starting an integer division.
20872 @end itemize
20874 @item -mfix-r10000
20875 @itemx -mno-fix-r10000
20876 @opindex mfix-r10000
20877 @opindex mno-fix-r10000
20878 Work around certain R10000 errata:
20879 @itemize @minus
20880 @item
20881 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20882 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20883 @end itemize
20885 This option can only be used if the target architecture supports
20886 branch-likely instructions.  @option{-mfix-r10000} is the default when
20887 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20888 otherwise.
20890 @item -mfix-rm7000
20891 @itemx -mno-fix-rm7000
20892 @opindex mfix-rm7000
20893 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20894 workarounds are implemented by the assembler rather than by GCC@.
20896 @item -mfix-vr4120
20897 @itemx -mno-fix-vr4120
20898 @opindex mfix-vr4120
20899 Work around certain VR4120 errata:
20900 @itemize @minus
20901 @item
20902 @code{dmultu} does not always produce the correct result.
20903 @item
20904 @code{div} and @code{ddiv} do not always produce the correct result if one
20905 of the operands is negative.
20906 @end itemize
20907 The workarounds for the division errata rely on special functions in
20908 @file{libgcc.a}.  At present, these functions are only provided by
20909 the @code{mips64vr*-elf} configurations.
20911 Other VR4120 errata require a NOP to be inserted between certain pairs of
20912 instructions.  These errata are handled by the assembler, not by GCC itself.
20914 @item -mfix-vr4130
20915 @opindex mfix-vr4130
20916 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20917 workarounds are implemented by the assembler rather than by GCC,
20918 although GCC avoids using @code{mflo} and @code{mfhi} if the
20919 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20920 instructions are available instead.
20922 @item -mfix-sb1
20923 @itemx -mno-fix-sb1
20924 @opindex mfix-sb1
20925 Work around certain SB-1 CPU core errata.
20926 (This flag currently works around the SB-1 revision 2
20927 ``F1'' and ``F2'' floating-point errata.)
20929 @item -mr10k-cache-barrier=@var{setting}
20930 @opindex mr10k-cache-barrier
20931 Specify whether GCC should insert cache barriers to avoid the
20932 side effects of speculation on R10K processors.
20934 In common with many processors, the R10K tries to predict the outcome
20935 of a conditional branch and speculatively executes instructions from
20936 the ``taken'' branch.  It later aborts these instructions if the
20937 predicted outcome is wrong.  However, on the R10K, even aborted
20938 instructions can have side effects.
20940 This problem only affects kernel stores and, depending on the system,
20941 kernel loads.  As an example, a speculatively-executed store may load
20942 the target memory into cache and mark the cache line as dirty, even if
20943 the store itself is later aborted.  If a DMA operation writes to the
20944 same area of memory before the ``dirty'' line is flushed, the cached
20945 data overwrites the DMA-ed data.  See the R10K processor manual
20946 for a full description, including other potential problems.
20948 One workaround is to insert cache barrier instructions before every memory
20949 access that might be speculatively executed and that might have side
20950 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20951 controls GCC's implementation of this workaround.  It assumes that
20952 aborted accesses to any byte in the following regions does not have
20953 side effects:
20955 @enumerate
20956 @item
20957 the memory occupied by the current function's stack frame;
20959 @item
20960 the memory occupied by an incoming stack argument;
20962 @item
20963 the memory occupied by an object with a link-time-constant address.
20964 @end enumerate
20966 It is the kernel's responsibility to ensure that speculative
20967 accesses to these regions are indeed safe.
20969 If the input program contains a function declaration such as:
20971 @smallexample
20972 void foo (void);
20973 @end smallexample
20975 then the implementation of @code{foo} must allow @code{j foo} and
20976 @code{jal foo} to be executed speculatively.  GCC honors this
20977 restriction for functions it compiles itself.  It expects non-GCC
20978 functions (such as hand-written assembly code) to do the same.
20980 The option has three forms:
20982 @table @gcctabopt
20983 @item -mr10k-cache-barrier=load-store
20984 Insert a cache barrier before a load or store that might be
20985 speculatively executed and that might have side effects even
20986 if aborted.
20988 @item -mr10k-cache-barrier=store
20989 Insert a cache barrier before a store that might be speculatively
20990 executed and that might have side effects even if aborted.
20992 @item -mr10k-cache-barrier=none
20993 Disable the insertion of cache barriers.  This is the default setting.
20994 @end table
20996 @item -mflush-func=@var{func}
20997 @itemx -mno-flush-func
20998 @opindex mflush-func
20999 Specifies the function to call to flush the I and D caches, or to not
21000 call any such function.  If called, the function must take the same
21001 arguments as the common @code{_flush_func}, that is, the address of the
21002 memory range for which the cache is being flushed, the size of the
21003 memory range, and the number 3 (to flush both caches).  The default
21004 depends on the target GCC was configured for, but commonly is either
21005 @code{_flush_func} or @code{__cpu_flush}.
21007 @item mbranch-cost=@var{num}
21008 @opindex mbranch-cost
21009 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21010 This cost is only a heuristic and is not guaranteed to produce
21011 consistent results across releases.  A zero cost redundantly selects
21012 the default, which is based on the @option{-mtune} setting.
21014 @item -mbranch-likely
21015 @itemx -mno-branch-likely
21016 @opindex mbranch-likely
21017 @opindex mno-branch-likely
21018 Enable or disable use of Branch Likely instructions, regardless of the
21019 default for the selected architecture.  By default, Branch Likely
21020 instructions may be generated if they are supported by the selected
21021 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21022 and processors that implement those architectures; for those, Branch
21023 Likely instructions are not be generated by default because the MIPS32
21024 and MIPS64 architectures specifically deprecate their use.
21026 @item -mcompact-branches=never
21027 @itemx -mcompact-branches=optimal
21028 @itemx -mcompact-branches=always
21029 @opindex mcompact-branches=never
21030 @opindex mcompact-branches=optimal
21031 @opindex mcompact-branches=always
21032 These options control which form of branches will be generated.  The
21033 default is @option{-mcompact-branches=optimal}.
21035 The @option{-mcompact-branches=never} option ensures that compact branch
21036 instructions will never be generated.
21038 The @option{-mcompact-branches=always} option ensures that a compact
21039 branch instruction will be generated if available.  If a compact branch
21040 instruction is not available, a delay slot form of the branch will be
21041 used instead.
21043 This option is supported from MIPS Release 6 onwards.
21045 The @option{-mcompact-branches=optimal} option will cause a delay slot
21046 branch to be used if one is available in the current ISA and the delay
21047 slot is successfully filled.  If the delay slot is not filled, a compact
21048 branch will be chosen if one is available.
21050 @item -mfp-exceptions
21051 @itemx -mno-fp-exceptions
21052 @opindex mfp-exceptions
21053 Specifies whether FP exceptions are enabled.  This affects how
21054 FP instructions are scheduled for some processors.
21055 The default is that FP exceptions are
21056 enabled.
21058 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21059 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21060 FP pipe.
21062 @item -mvr4130-align
21063 @itemx -mno-vr4130-align
21064 @opindex mvr4130-align
21065 The VR4130 pipeline is two-way superscalar, but can only issue two
21066 instructions together if the first one is 8-byte aligned.  When this
21067 option is enabled, GCC aligns pairs of instructions that it
21068 thinks should execute in parallel.
21070 This option only has an effect when optimizing for the VR4130.
21071 It normally makes code faster, but at the expense of making it bigger.
21072 It is enabled by default at optimization level @option{-O3}.
21074 @item -msynci
21075 @itemx -mno-synci
21076 @opindex msynci
21077 Enable (disable) generation of @code{synci} instructions on
21078 architectures that support it.  The @code{synci} instructions (if
21079 enabled) are generated when @code{__builtin___clear_cache} is
21080 compiled.
21082 This option defaults to @option{-mno-synci}, but the default can be
21083 overridden by configuring GCC with @option{--with-synci}.
21085 When compiling code for single processor systems, it is generally safe
21086 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21087 does not invalidate the instruction caches on all cores and may lead
21088 to undefined behavior.
21090 @item -mrelax-pic-calls
21091 @itemx -mno-relax-pic-calls
21092 @opindex mrelax-pic-calls
21093 Try to turn PIC calls that are normally dispatched via register
21094 @code{$25} into direct calls.  This is only possible if the linker can
21095 resolve the destination at link time and if the destination is within
21096 range for a direct call.
21098 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21099 an assembler and a linker that support the @code{.reloc} assembly
21100 directive and @option{-mexplicit-relocs} is in effect.  With
21101 @option{-mno-explicit-relocs}, this optimization can be performed by the
21102 assembler and the linker alone without help from the compiler.
21104 @item -mmcount-ra-address
21105 @itemx -mno-mcount-ra-address
21106 @opindex mmcount-ra-address
21107 @opindex mno-mcount-ra-address
21108 Emit (do not emit) code that allows @code{_mcount} to modify the
21109 calling function's return address.  When enabled, this option extends
21110 the usual @code{_mcount} interface with a new @var{ra-address}
21111 parameter, which has type @code{intptr_t *} and is passed in register
21112 @code{$12}.  @code{_mcount} can then modify the return address by
21113 doing both of the following:
21114 @itemize
21115 @item
21116 Returning the new address in register @code{$31}.
21117 @item
21118 Storing the new address in @code{*@var{ra-address}},
21119 if @var{ra-address} is nonnull.
21120 @end itemize
21122 The default is @option{-mno-mcount-ra-address}.
21124 @item -mframe-header-opt
21125 @itemx -mno-frame-header-opt
21126 @opindex mframe-header-opt
21127 Enable (disable) frame header optimization in the o32 ABI.  When using the
21128 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21129 function to write out register arguments.  When enabled, this optimization
21130 will suppress the allocation of the frame header if it can be determined that
21131 it is unused.
21133 This optimization is off by default at all optimization levels.
21135 @item -mlxc1-sxc1
21136 @itemx -mno-lxc1-sxc1
21137 @opindex mlxc1-sxc1
21138 When applicable, enable (disable) the generation of @code{lwxc1},
21139 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21141 @item -mmadd4
21142 @itemx -mno-madd4
21143 @opindex mmadd4
21144 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21145 @code{madd.d} and related instructions.  Enabled by default.
21147 @end table
21149 @node MMIX Options
21150 @subsection MMIX Options
21151 @cindex MMIX Options
21153 These options are defined for the MMIX:
21155 @table @gcctabopt
21156 @item -mlibfuncs
21157 @itemx -mno-libfuncs
21158 @opindex mlibfuncs
21159 @opindex mno-libfuncs
21160 Specify that intrinsic library functions are being compiled, passing all
21161 values in registers, no matter the size.
21163 @item -mepsilon
21164 @itemx -mno-epsilon
21165 @opindex mepsilon
21166 @opindex mno-epsilon
21167 Generate floating-point comparison instructions that compare with respect
21168 to the @code{rE} epsilon register.
21170 @item -mabi=mmixware
21171 @itemx -mabi=gnu
21172 @opindex mabi=mmixware
21173 @opindex mabi=gnu
21174 Generate code that passes function parameters and return values that (in
21175 the called function) are seen as registers @code{$0} and up, as opposed to
21176 the GNU ABI which uses global registers @code{$231} and up.
21178 @item -mzero-extend
21179 @itemx -mno-zero-extend
21180 @opindex mzero-extend
21181 @opindex mno-zero-extend
21182 When reading data from memory in sizes shorter than 64 bits, use (do not
21183 use) zero-extending load instructions by default, rather than
21184 sign-extending ones.
21186 @item -mknuthdiv
21187 @itemx -mno-knuthdiv
21188 @opindex mknuthdiv
21189 @opindex mno-knuthdiv
21190 Make the result of a division yielding a remainder have the same sign as
21191 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21192 remainder follows the sign of the dividend.  Both methods are
21193 arithmetically valid, the latter being almost exclusively used.
21195 @item -mtoplevel-symbols
21196 @itemx -mno-toplevel-symbols
21197 @opindex mtoplevel-symbols
21198 @opindex mno-toplevel-symbols
21199 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21200 code can be used with the @code{PREFIX} assembly directive.
21202 @item -melf
21203 @opindex melf
21204 Generate an executable in the ELF format, rather than the default
21205 @samp{mmo} format used by the @command{mmix} simulator.
21207 @item -mbranch-predict
21208 @itemx -mno-branch-predict
21209 @opindex mbranch-predict
21210 @opindex mno-branch-predict
21211 Use (do not use) the probable-branch instructions, when static branch
21212 prediction indicates a probable branch.
21214 @item -mbase-addresses
21215 @itemx -mno-base-addresses
21216 @opindex mbase-addresses
21217 @opindex mno-base-addresses
21218 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21219 base address automatically generates a request (handled by the assembler
21220 and the linker) for a constant to be set up in a global register.  The
21221 register is used for one or more base address requests within the range 0
21222 to 255 from the value held in the register.  The generally leads to short
21223 and fast code, but the number of different data items that can be
21224 addressed is limited.  This means that a program that uses lots of static
21225 data may require @option{-mno-base-addresses}.
21227 @item -msingle-exit
21228 @itemx -mno-single-exit
21229 @opindex msingle-exit
21230 @opindex mno-single-exit
21231 Force (do not force) generated code to have a single exit point in each
21232 function.
21233 @end table
21235 @node MN10300 Options
21236 @subsection MN10300 Options
21237 @cindex MN10300 options
21239 These @option{-m} options are defined for Matsushita MN10300 architectures:
21241 @table @gcctabopt
21242 @item -mmult-bug
21243 @opindex mmult-bug
21244 Generate code to avoid bugs in the multiply instructions for the MN10300
21245 processors.  This is the default.
21247 @item -mno-mult-bug
21248 @opindex mno-mult-bug
21249 Do not generate code to avoid bugs in the multiply instructions for the
21250 MN10300 processors.
21252 @item -mam33
21253 @opindex mam33
21254 Generate code using features specific to the AM33 processor.
21256 @item -mno-am33
21257 @opindex mno-am33
21258 Do not generate code using features specific to the AM33 processor.  This
21259 is the default.
21261 @item -mam33-2
21262 @opindex mam33-2
21263 Generate code using features specific to the AM33/2.0 processor.
21265 @item -mam34
21266 @opindex mam34
21267 Generate code using features specific to the AM34 processor.
21269 @item -mtune=@var{cpu-type}
21270 @opindex mtune
21271 Use the timing characteristics of the indicated CPU type when
21272 scheduling instructions.  This does not change the targeted processor
21273 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21274 @samp{am33-2} or @samp{am34}.
21276 @item -mreturn-pointer-on-d0
21277 @opindex mreturn-pointer-on-d0
21278 When generating a function that returns a pointer, return the pointer
21279 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21280 only in @code{a0}, and attempts to call such functions without a prototype
21281 result in errors.  Note that this option is on by default; use
21282 @option{-mno-return-pointer-on-d0} to disable it.
21284 @item -mno-crt0
21285 @opindex mno-crt0
21286 Do not link in the C run-time initialization object file.
21288 @item -mrelax
21289 @opindex mrelax
21290 Indicate to the linker that it should perform a relaxation optimization pass
21291 to shorten branches, calls and absolute memory addresses.  This option only
21292 has an effect when used on the command line for the final link step.
21294 This option makes symbolic debugging impossible.
21296 @item -mliw
21297 @opindex mliw
21298 Allow the compiler to generate @emph{Long Instruction Word}
21299 instructions if the target is the @samp{AM33} or later.  This is the
21300 default.  This option defines the preprocessor macro @code{__LIW__}.
21302 @item -mnoliw
21303 @opindex mnoliw
21304 Do not allow the compiler to generate @emph{Long Instruction Word}
21305 instructions.  This option defines the preprocessor macro
21306 @code{__NO_LIW__}.
21308 @item -msetlb
21309 @opindex msetlb
21310 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21311 instructions if the target is the @samp{AM33} or later.  This is the
21312 default.  This option defines the preprocessor macro @code{__SETLB__}.
21314 @item -mnosetlb
21315 @opindex mnosetlb
21316 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21317 instructions.  This option defines the preprocessor macro
21318 @code{__NO_SETLB__}.
21320 @end table
21322 @node Moxie Options
21323 @subsection Moxie Options
21324 @cindex Moxie Options
21326 @table @gcctabopt
21328 @item -meb
21329 @opindex meb
21330 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21331 configurations.
21333 @item -mel
21334 @opindex mel
21335 Generate little-endian code.
21337 @item -mmul.x
21338 @opindex mmul.x
21339 Generate mul.x and umul.x instructions.  This is the default for
21340 @samp{moxiebox-*-*} configurations.
21342 @item -mno-crt0
21343 @opindex mno-crt0
21344 Do not link in the C run-time initialization object file.
21346 @end table
21348 @node MSP430 Options
21349 @subsection MSP430 Options
21350 @cindex MSP430 Options
21352 These options are defined for the MSP430:
21354 @table @gcctabopt
21356 @item -masm-hex
21357 @opindex masm-hex
21358 Force assembly output to always use hex constants.  Normally such
21359 constants are signed decimals, but this option is available for
21360 testsuite and/or aesthetic purposes.
21362 @item -mmcu=
21363 @opindex mmcu=
21364 Select the MCU to target.  This is used to create a C preprocessor
21365 symbol based upon the MCU name, converted to upper case and pre- and
21366 post-fixed with @samp{__}.  This in turn is used by the
21367 @file{msp430.h} header file to select an MCU-specific supplementary
21368 header file.
21370 The option also sets the ISA to use.  If the MCU name is one that is
21371 known to only support the 430 ISA then that is selected, otherwise the
21372 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21373 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21374 name selects the 430X ISA.
21376 In addition an MCU-specific linker script is added to the linker
21377 command line.  The script's name is the name of the MCU with
21378 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21379 command line defines the C preprocessor symbol @code{__XXX__} and
21380 cause the linker to search for a script called @file{xxx.ld}.
21382 This option is also passed on to the assembler.
21384 @item -mwarn-mcu
21385 @itemx -mno-warn-mcu
21386 @opindex mwarn-mcu
21387 @opindex mno-warn-mcu
21388 This option enables or disables warnings about conflicts between the
21389 MCU name specified by the @option{-mmcu} option and the ISA set by the
21390 @option{-mcpu} option and/or the hardware multiply support set by the
21391 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21392 MCU names.  This option is on by default.
21394 @item -mcpu=
21395 @opindex mcpu=
21396 Specifies the ISA to use.  Accepted values are @samp{msp430},
21397 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21398 @option{-mmcu=} option should be used to select the ISA.
21400 @item -msim
21401 @opindex msim
21402 Link to the simulator runtime libraries and linker script.  Overrides
21403 any scripts that would be selected by the @option{-mmcu=} option.
21405 @item -mlarge
21406 @opindex mlarge
21407 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21409 @item -msmall
21410 @opindex msmall
21411 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21413 @item -mrelax
21414 @opindex mrelax
21415 This option is passed to the assembler and linker, and allows the
21416 linker to perform certain optimizations that cannot be done until
21417 the final link.
21419 @item mhwmult=
21420 @opindex mhwmult=
21421 Describes the type of hardware multiply supported by the target.
21422 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21423 for the original 16-bit-only multiply supported by early MCUs.
21424 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21425 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21426 A value of @samp{auto} can also be given.  This tells GCC to deduce
21427 the hardware multiply support based upon the MCU name provided by the
21428 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21429 the MCU name is not recognized then no hardware multiply support is
21430 assumed.  @code{auto} is the default setting.
21432 Hardware multiplies are normally performed by calling a library
21433 routine.  This saves space in the generated code.  When compiling at
21434 @option{-O3} or higher however the hardware multiplier is invoked
21435 inline.  This makes for bigger, but faster code.
21437 The hardware multiply routines disable interrupts whilst running and
21438 restore the previous interrupt state when they finish.  This makes
21439 them safe to use inside interrupt handlers as well as in normal code.
21441 @item -minrt
21442 @opindex minrt
21443 Enable the use of a minimum runtime environment - no static
21444 initializers or constructors.  This is intended for memory-constrained
21445 devices.  The compiler includes special symbols in some objects
21446 that tell the linker and runtime which code fragments are required.
21448 @item -mcode-region=
21449 @itemx -mdata-region=
21450 @opindex mcode-region
21451 @opindex mdata-region
21452 These options tell the compiler where to place functions and data that
21453 do not have one of the @code{lower}, @code{upper}, @code{either} or
21454 @code{section} attributes.  Possible values are @code{lower},
21455 @code{upper}, @code{either} or @code{any}.  The first three behave
21456 like the corresponding attribute.  The fourth possible value -
21457 @code{any} - is the default.  It leaves placement entirely up to the
21458 linker script and how it assigns the standard sections
21459 (@code{.text}, @code{.data}, etc) to the memory regions.
21461 @item -msilicon-errata=
21462 @opindex msilicon-errata
21463 This option passes on a request to assembler to enable the fixes for
21464 the named silicon errata.
21466 @item -msilicon-errata-warn=
21467 @opindex msilicon-errata-warn
21468 This option passes on a request to the assembler to enable warning
21469 messages when a silicon errata might need to be applied.
21471 @end table
21473 @node NDS32 Options
21474 @subsection NDS32 Options
21475 @cindex NDS32 Options
21477 These options are defined for NDS32 implementations:
21479 @table @gcctabopt
21481 @item -mbig-endian
21482 @opindex mbig-endian
21483 Generate code in big-endian mode.
21485 @item -mlittle-endian
21486 @opindex mlittle-endian
21487 Generate code in little-endian mode.
21489 @item -mreduced-regs
21490 @opindex mreduced-regs
21491 Use reduced-set registers for register allocation.
21493 @item -mfull-regs
21494 @opindex mfull-regs
21495 Use full-set registers for register allocation.
21497 @item -mcmov
21498 @opindex mcmov
21499 Generate conditional move instructions.
21501 @item -mno-cmov
21502 @opindex mno-cmov
21503 Do not generate conditional move instructions.
21505 @item -mext-perf
21506 @opindex mperf-ext
21507 Generate performance extension instructions.
21509 @item -mno-ext-perf
21510 @opindex mno-perf-ext
21511 Do not generate performance extension instructions.
21513 @item -mext-perf2
21514 @opindex mperf-ext
21515 Generate performance extension 2 instructions.
21517 @item -mno-ext-perf2
21518 @opindex mno-perf-ext
21519 Do not generate performance extension 2 instructions.
21521 @item -mext-string
21522 @opindex mperf-ext
21523 Generate string extension instructions.
21525 @item -mno-ext-string
21526 @opindex mno-perf-ext
21527 Do not generate string extension instructions.
21529 @item -mv3push
21530 @opindex mv3push
21531 Generate v3 push25/pop25 instructions.
21533 @item -mno-v3push
21534 @opindex mno-v3push
21535 Do not generate v3 push25/pop25 instructions.
21537 @item -m16-bit
21538 @opindex m16-bit
21539 Generate 16-bit instructions.
21541 @item -mno-16-bit
21542 @opindex mno-16-bit
21543 Do not generate 16-bit instructions.
21545 @item -misr-vector-size=@var{num}
21546 @opindex misr-vector-size
21547 Specify the size of each interrupt vector, which must be 4 or 16.
21549 @item -mcache-block-size=@var{num}
21550 @opindex mcache-block-size
21551 Specify the size of each cache block,
21552 which must be a power of 2 between 4 and 512.
21554 @item -march=@var{arch}
21555 @opindex march
21556 Specify the name of the target architecture.
21558 @item -mcmodel=@var{code-model}
21559 @opindex mcmodel
21560 Set the code model to one of
21561 @table @asis
21562 @item @samp{small}
21563 All the data and read-only data segments must be within 512KB addressing space.
21564 The text segment must be within 16MB addressing space.
21565 @item @samp{medium}
21566 The data segment must be within 512KB while the read-only data segment can be
21567 within 4GB addressing space.  The text segment should be still within 16MB
21568 addressing space.
21569 @item @samp{large}
21570 All the text and data segments can be within 4GB addressing space.
21571 @end table
21573 @item -mctor-dtor
21574 @opindex mctor-dtor
21575 Enable constructor/destructor feature.
21577 @item -mrelax
21578 @opindex mrelax
21579 Guide linker to relax instructions.
21581 @end table
21583 @node Nios II Options
21584 @subsection Nios II Options
21585 @cindex Nios II options
21586 @cindex Altera Nios II options
21588 These are the options defined for the Altera Nios II processor.
21590 @table @gcctabopt
21592 @item -G @var{num}
21593 @opindex G
21594 @cindex smaller data references
21595 Put global and static objects less than or equal to @var{num} bytes
21596 into the small data or BSS sections instead of the normal data or BSS
21597 sections.  The default value of @var{num} is 8.
21599 @item -mgpopt=@var{option}
21600 @itemx -mgpopt
21601 @itemx -mno-gpopt
21602 @opindex mgpopt
21603 @opindex mno-gpopt
21604 Generate (do not generate) GP-relative accesses.  The following 
21605 @var{option} names are recognized:
21607 @table @samp
21609 @item none
21610 Do not generate GP-relative accesses.
21612 @item local
21613 Generate GP-relative accesses for small data objects that are not 
21614 external, weak, or uninitialized common symbols.  
21615 Also use GP-relative addressing for objects that
21616 have been explicitly placed in a small data section via a @code{section}
21617 attribute.
21619 @item global
21620 As for @samp{local}, but also generate GP-relative accesses for
21621 small data objects that are external, weak, or common.  If you use this option,
21622 you must ensure that all parts of your program (including libraries) are
21623 compiled with the same @option{-G} setting.
21625 @item data
21626 Generate GP-relative accesses for all data objects in the program.  If you
21627 use this option, the entire data and BSS segments
21628 of your program must fit in 64K of memory and you must use an appropriate
21629 linker script to allocate them within the addressable range of the
21630 global pointer.
21632 @item all
21633 Generate GP-relative addresses for function pointers as well as data
21634 pointers.  If you use this option, the entire text, data, and BSS segments
21635 of your program must fit in 64K of memory and you must use an appropriate
21636 linker script to allocate them within the addressable range of the
21637 global pointer.
21639 @end table
21641 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21642 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21644 The default is @option{-mgpopt} except when @option{-fpic} or
21645 @option{-fPIC} is specified to generate position-independent code.
21646 Note that the Nios II ABI does not permit GP-relative accesses from
21647 shared libraries.
21649 You may need to specify @option{-mno-gpopt} explicitly when building
21650 programs that include large amounts of small data, including large
21651 GOT data sections.  In this case, the 16-bit offset for GP-relative
21652 addressing may not be large enough to allow access to the entire 
21653 small data section.
21655 @item -mgprel-sec=@var{regexp}
21656 @opindex mgprel-sec
21657 This option specifies additional section names that can be accessed via
21658 GP-relative addressing.  It is most useful in conjunction with 
21659 @code{section} attributes on variable declarations 
21660 (@pxref{Common Variable Attributes}) and a custom linker script.  
21661 The @var{regexp} is a POSIX Extended Regular Expression.
21663 This option does not affect the behavior of the @option{-G} option, and 
21664 and the specified sections are in addition to the standard @code{.sdata} 
21665 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21667 @item -mr0rel-sec=@var{regexp}
21668 @opindex mr0rel-sec
21669 This option specifies names of sections that can be accessed via a 
21670 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21671 of the 32-bit address space.  It is most useful in conjunction with 
21672 @code{section} attributes on variable declarations 
21673 (@pxref{Common Variable Attributes}) and a custom linker script.  
21674 The @var{regexp} is a POSIX Extended Regular Expression.
21676 In contrast to the use of GP-relative addressing for small data, 
21677 zero-based addressing is never generated by default and there are no 
21678 conventional section names used in standard linker scripts for sections
21679 in the low or high areas of memory.
21681 @item -mel
21682 @itemx -meb
21683 @opindex mel
21684 @opindex meb
21685 Generate little-endian (default) or big-endian (experimental) code,
21686 respectively.
21688 @item -march=@var{arch}
21689 @opindex march
21690 This specifies the name of the target Nios II architecture.  GCC uses this
21691 name to determine what kind of instructions it can emit when generating
21692 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21694 The preprocessor macro @code{__nios2_arch__} is available to programs,
21695 with value 1 or 2, indicating the targeted ISA level.
21697 @item -mbypass-cache
21698 @itemx -mno-bypass-cache
21699 @opindex mno-bypass-cache
21700 @opindex mbypass-cache
21701 Force all load and store instructions to always bypass cache by 
21702 using I/O variants of the instructions. The default is not to
21703 bypass the cache.
21705 @item -mno-cache-volatile 
21706 @itemx -mcache-volatile       
21707 @opindex mcache-volatile 
21708 @opindex mno-cache-volatile
21709 Volatile memory access bypass the cache using the I/O variants of 
21710 the load and store instructions. The default is not to bypass the cache.
21712 @item -mno-fast-sw-div
21713 @itemx -mfast-sw-div
21714 @opindex mno-fast-sw-div
21715 @opindex mfast-sw-div
21716 Do not use table-based fast divide for small numbers. The default 
21717 is to use the fast divide at @option{-O3} and above.
21719 @item -mno-hw-mul
21720 @itemx -mhw-mul
21721 @itemx -mno-hw-mulx
21722 @itemx -mhw-mulx
21723 @itemx -mno-hw-div
21724 @itemx -mhw-div
21725 @opindex mno-hw-mul
21726 @opindex mhw-mul
21727 @opindex mno-hw-mulx
21728 @opindex mhw-mulx
21729 @opindex mno-hw-div
21730 @opindex mhw-div
21731 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21732 instructions by the compiler. The default is to emit @code{mul}
21733 and not emit @code{div} and @code{mulx}.
21735 @item -mbmx
21736 @itemx -mno-bmx
21737 @itemx -mcdx
21738 @itemx -mno-cdx
21739 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21740 CDX (code density) instructions.  Enabling these instructions also
21741 requires @option{-march=r2}.  Since these instructions are optional
21742 extensions to the R2 architecture, the default is not to emit them.
21744 @item -mcustom-@var{insn}=@var{N}
21745 @itemx -mno-custom-@var{insn}
21746 @opindex mcustom-@var{insn}
21747 @opindex mno-custom-@var{insn}
21748 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21749 custom instruction with encoding @var{N} when generating code that uses 
21750 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21751 instruction 253 for single-precision floating-point add operations instead
21752 of the default behavior of using a library call.
21754 The following values of @var{insn} are supported.  Except as otherwise
21755 noted, floating-point operations are expected to be implemented with
21756 normal IEEE 754 semantics and correspond directly to the C operators or the
21757 equivalent GCC built-in functions (@pxref{Other Builtins}).
21759 Single-precision floating point:
21760 @table @asis
21762 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21763 Binary arithmetic operations.
21765 @item @samp{fnegs}
21766 Unary negation.
21768 @item @samp{fabss}
21769 Unary absolute value.
21771 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21772 Comparison operations.
21774 @item @samp{fmins}, @samp{fmaxs}
21775 Floating-point minimum and maximum.  These instructions are only
21776 generated if @option{-ffinite-math-only} is specified.
21778 @item @samp{fsqrts}
21779 Unary square root operation.
21781 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21782 Floating-point trigonometric and exponential functions.  These instructions
21783 are only generated if @option{-funsafe-math-optimizations} is also specified.
21785 @end table
21787 Double-precision floating point:
21788 @table @asis
21790 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21791 Binary arithmetic operations.
21793 @item @samp{fnegd}
21794 Unary negation.
21796 @item @samp{fabsd}
21797 Unary absolute value.
21799 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21800 Comparison operations.
21802 @item @samp{fmind}, @samp{fmaxd}
21803 Double-precision minimum and maximum.  These instructions are only
21804 generated if @option{-ffinite-math-only} is specified.
21806 @item @samp{fsqrtd}
21807 Unary square root operation.
21809 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21810 Double-precision trigonometric and exponential functions.  These instructions
21811 are only generated if @option{-funsafe-math-optimizations} is also specified.
21813 @end table
21815 Conversions:
21816 @table @asis
21817 @item @samp{fextsd}
21818 Conversion from single precision to double precision.
21820 @item @samp{ftruncds}
21821 Conversion from double precision to single precision.
21823 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21824 Conversion from floating point to signed or unsigned integer types, with
21825 truncation towards zero.
21827 @item @samp{round}
21828 Conversion from single-precision floating point to signed integer,
21829 rounding to the nearest integer and ties away from zero.
21830 This corresponds to the @code{__builtin_lroundf} function when
21831 @option{-fno-math-errno} is used.
21833 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21834 Conversion from signed or unsigned integer types to floating-point types.
21836 @end table
21838 In addition, all of the following transfer instructions for internal
21839 registers X and Y must be provided to use any of the double-precision
21840 floating-point instructions.  Custom instructions taking two
21841 double-precision source operands expect the first operand in the
21842 64-bit register X.  The other operand (or only operand of a unary
21843 operation) is given to the custom arithmetic instruction with the
21844 least significant half in source register @var{src1} and the most
21845 significant half in @var{src2}.  A custom instruction that returns a
21846 double-precision result returns the most significant 32 bits in the
21847 destination register and the other half in 32-bit register Y.  
21848 GCC automatically generates the necessary code sequences to write
21849 register X and/or read register Y when double-precision floating-point
21850 instructions are used.
21852 @table @asis
21854 @item @samp{fwrx}
21855 Write @var{src1} into the least significant half of X and @var{src2} into
21856 the most significant half of X.
21858 @item @samp{fwry}
21859 Write @var{src1} into Y.
21861 @item @samp{frdxhi}, @samp{frdxlo}
21862 Read the most or least (respectively) significant half of X and store it in
21863 @var{dest}.
21865 @item @samp{frdy}
21866 Read the value of Y and store it into @var{dest}.
21867 @end table
21869 Note that you can gain more local control over generation of Nios II custom
21870 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21871 and @code{target("no-custom-@var{insn}")} function attributes
21872 (@pxref{Function Attributes})
21873 or pragmas (@pxref{Function Specific Option Pragmas}).
21875 @item -mcustom-fpu-cfg=@var{name}
21876 @opindex mcustom-fpu-cfg
21878 This option enables a predefined, named set of custom instruction encodings
21879 (see @option{-mcustom-@var{insn}} above).  
21880 Currently, the following sets are defined:
21882 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21883 @gccoptlist{-mcustom-fmuls=252 @gol
21884 -mcustom-fadds=253 @gol
21885 -mcustom-fsubs=254 @gol
21886 -fsingle-precision-constant}
21888 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21889 @gccoptlist{-mcustom-fmuls=252 @gol
21890 -mcustom-fadds=253 @gol
21891 -mcustom-fsubs=254 @gol
21892 -mcustom-fdivs=255 @gol
21893 -fsingle-precision-constant}
21895 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21896 @gccoptlist{-mcustom-floatus=243 @gol
21897 -mcustom-fixsi=244 @gol
21898 -mcustom-floatis=245 @gol
21899 -mcustom-fcmpgts=246 @gol
21900 -mcustom-fcmples=249 @gol
21901 -mcustom-fcmpeqs=250 @gol
21902 -mcustom-fcmpnes=251 @gol
21903 -mcustom-fmuls=252 @gol
21904 -mcustom-fadds=253 @gol
21905 -mcustom-fsubs=254 @gol
21906 -mcustom-fdivs=255 @gol
21907 -fsingle-precision-constant}
21909 Custom instruction assignments given by individual
21910 @option{-mcustom-@var{insn}=} options override those given by
21911 @option{-mcustom-fpu-cfg=}, regardless of the
21912 order of the options on the command line.
21914 Note that you can gain more local control over selection of a FPU
21915 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21916 function attribute (@pxref{Function Attributes})
21917 or pragma (@pxref{Function Specific Option Pragmas}).
21919 @end table
21921 These additional @samp{-m} options are available for the Altera Nios II
21922 ELF (bare-metal) target:
21924 @table @gcctabopt
21926 @item -mhal
21927 @opindex mhal
21928 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21929 startup and termination code, and is typically used in conjunction with
21930 @option{-msys-crt0=} to specify the location of the alternate startup code
21931 provided by the HAL BSP.
21933 @item -msmallc
21934 @opindex msmallc
21935 Link with a limited version of the C library, @option{-lsmallc}, rather than
21936 Newlib.
21938 @item -msys-crt0=@var{startfile}
21939 @opindex msys-crt0
21940 @var{startfile} is the file name of the startfile (crt0) to use 
21941 when linking.  This option is only useful in conjunction with @option{-mhal}.
21943 @item -msys-lib=@var{systemlib}
21944 @opindex msys-lib
21945 @var{systemlib} is the library name of the library that provides
21946 low-level system calls required by the C library,
21947 e.g. @code{read} and @code{write}.
21948 This option is typically used to link with a library provided by a HAL BSP.
21950 @end table
21952 @node Nvidia PTX Options
21953 @subsection Nvidia PTX Options
21954 @cindex Nvidia PTX options
21955 @cindex nvptx options
21957 These options are defined for Nvidia PTX:
21959 @table @gcctabopt
21961 @item -m32
21962 @itemx -m64
21963 @opindex m32
21964 @opindex m64
21965 Generate code for 32-bit or 64-bit ABI.
21967 @item -mmainkernel
21968 @opindex mmainkernel
21969 Link in code for a __main kernel.  This is for stand-alone instead of
21970 offloading execution.
21972 @item -moptimize
21973 @opindex moptimize
21974 Apply partitioned execution optimizations.  This is the default when any
21975 level of optimization is selected.
21977 @item -msoft-stack
21978 @opindex msoft-stack
21979 Generate code that does not use @code{.local} memory
21980 directly for stack storage. Instead, a per-warp stack pointer is
21981 maintained explicitly. This enables variable-length stack allocation (with
21982 variable-length arrays or @code{alloca}), and when global memory is used for
21983 underlying storage, makes it possible to access automatic variables from other
21984 threads, or with atomic instructions. This code generation variant is used
21985 for OpenMP offloading, but the option is exposed on its own for the purpose
21986 of testing the compiler; to generate code suitable for linking into programs
21987 using OpenMP offloading, use option @option{-mgomp}.
21989 @item -muniform-simt
21990 @opindex muniform-simt
21991 Switch to code generation variant that allows to execute all threads in each
21992 warp, while maintaining memory state and side effects as if only one thread
21993 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21994 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21995 current lane index equals the master lane index), and the register being
21996 assigned is copied via a shuffle instruction from the master lane.  Outside of
21997 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21998 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21999 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22000 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22001 with current lane index to compute the master lane index.
22003 @item -mgomp
22004 @opindex mgomp
22005 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22006 @option{-muniform-simt} options, and selects corresponding multilib variant.
22008 @end table
22010 @node PDP-11 Options
22011 @subsection PDP-11 Options
22012 @cindex PDP-11 Options
22014 These options are defined for the PDP-11:
22016 @table @gcctabopt
22017 @item -mfpu
22018 @opindex mfpu
22019 Use hardware FPP floating point.  This is the default.  (FIS floating
22020 point on the PDP-11/40 is not supported.)
22022 @item -msoft-float
22023 @opindex msoft-float
22024 Do not use hardware floating point.
22026 @item -mac0
22027 @opindex mac0
22028 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22030 @item -mno-ac0
22031 @opindex mno-ac0
22032 Return floating-point results in memory.  This is the default.
22034 @item -m40
22035 @opindex m40
22036 Generate code for a PDP-11/40.
22038 @item -m45
22039 @opindex m45
22040 Generate code for a PDP-11/45.  This is the default.
22042 @item -m10
22043 @opindex m10
22044 Generate code for a PDP-11/10.
22046 @item -mbcopy-builtin
22047 @opindex mbcopy-builtin
22048 Use inline @code{movmemhi} patterns for copying memory.  This is the
22049 default.
22051 @item -mbcopy
22052 @opindex mbcopy
22053 Do not use inline @code{movmemhi} patterns for copying memory.
22055 @item -mint16
22056 @itemx -mno-int32
22057 @opindex mint16
22058 @opindex mno-int32
22059 Use 16-bit @code{int}.  This is the default.
22061 @item -mint32
22062 @itemx -mno-int16
22063 @opindex mint32
22064 @opindex mno-int16
22065 Use 32-bit @code{int}.
22067 @item -mfloat64
22068 @itemx -mno-float32
22069 @opindex mfloat64
22070 @opindex mno-float32
22071 Use 64-bit @code{float}.  This is the default.
22073 @item -mfloat32
22074 @itemx -mno-float64
22075 @opindex mfloat32
22076 @opindex mno-float64
22077 Use 32-bit @code{float}.
22079 @item -mabshi
22080 @opindex mabshi
22081 Use @code{abshi2} pattern.  This is the default.
22083 @item -mno-abshi
22084 @opindex mno-abshi
22085 Do not use @code{abshi2} pattern.
22087 @item -mbranch-expensive
22088 @opindex mbranch-expensive
22089 Pretend that branches are expensive.  This is for experimenting with
22090 code generation only.
22092 @item -mbranch-cheap
22093 @opindex mbranch-cheap
22094 Do not pretend that branches are expensive.  This is the default.
22096 @item -munix-asm
22097 @opindex munix-asm
22098 Use Unix assembler syntax.  This is the default when configured for
22099 @samp{pdp11-*-bsd}.
22101 @item -mdec-asm
22102 @opindex mdec-asm
22103 Use DEC assembler syntax.  This is the default when configured for any
22104 PDP-11 target other than @samp{pdp11-*-bsd}.
22105 @end table
22107 @node picoChip Options
22108 @subsection picoChip Options
22109 @cindex picoChip options
22111 These @samp{-m} options are defined for picoChip implementations:
22113 @table @gcctabopt
22115 @item -mae=@var{ae_type}
22116 @opindex mcpu
22117 Set the instruction set, register set, and instruction scheduling
22118 parameters for array element type @var{ae_type}.  Supported values
22119 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22121 @option{-mae=ANY} selects a completely generic AE type.  Code
22122 generated with this option runs on any of the other AE types.  The
22123 code is not as efficient as it would be if compiled for a specific
22124 AE type, and some types of operation (e.g., multiplication) do not
22125 work properly on all types of AE.
22127 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22128 for compiled code, and is the default.
22130 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22131 option may suffer from poor performance of byte (char) manipulation,
22132 since the DSP AE does not provide hardware support for byte load/stores.
22134 @item -msymbol-as-address
22135 Enable the compiler to directly use a symbol name as an address in a
22136 load/store instruction, without first loading it into a
22137 register.  Typically, the use of this option generates larger
22138 programs, which run faster than when the option isn't used.  However, the
22139 results vary from program to program, so it is left as a user option,
22140 rather than being permanently enabled.
22142 @item -mno-inefficient-warnings
22143 Disables warnings about the generation of inefficient code.  These
22144 warnings can be generated, for example, when compiling code that
22145 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22146 no hardware support for byte-level memory operations, so all byte
22147 load/stores must be synthesized from word load/store operations.  This is
22148 inefficient and a warning is generated to indicate
22149 that you should rewrite the code to avoid byte operations, or to target
22150 an AE type that has the necessary hardware support.  This option disables
22151 these warnings.
22153 @end table
22155 @node PowerPC Options
22156 @subsection PowerPC Options
22157 @cindex PowerPC options
22159 These are listed under @xref{RS/6000 and PowerPC Options}.
22161 @node PowerPC SPE Options
22162 @subsection PowerPC SPE Options
22163 @cindex PowerPC SPE options
22165 These @samp{-m} options are defined for PowerPC SPE:
22166 @table @gcctabopt
22167 @item -mmfcrf
22168 @itemx -mno-mfcrf
22169 @itemx -mpopcntb
22170 @itemx -mno-popcntb
22171 @opindex mmfcrf
22172 @opindex mno-mfcrf
22173 @opindex mpopcntb
22174 @opindex mno-popcntb
22175 You use these options to specify which instructions are available on the
22176 processor you are using.  The default value of these options is
22177 determined when configuring GCC@.  Specifying the
22178 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22179 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22180 rather than the options listed above.
22182 The @option{-mmfcrf} option allows GCC to generate the move from
22183 condition register field instruction implemented on the POWER4
22184 processor and other processors that support the PowerPC V2.01
22185 architecture.
22186 The @option{-mpopcntb} option allows GCC to generate the popcount and
22187 double-precision FP reciprocal estimate instruction implemented on the
22188 POWER5 processor and other processors that support the PowerPC V2.02
22189 architecture.
22191 @item -mcpu=@var{cpu_type}
22192 @opindex mcpu
22193 Set architecture type, register usage, and
22194 instruction scheduling parameters for machine type @var{cpu_type}.
22195 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22196 and @samp{native}.
22198 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22199 endian), with an appropriate, generic processor model assumed for
22200 scheduling purposes.
22202 Specifying @samp{native} as cpu type detects and selects the
22203 architecture option that corresponds to the host processor of the
22204 system performing the compilation.
22205 @option{-mcpu=native} has no effect if GCC does not recognize the
22206 processor.
22208 The other options specify a specific processor.  Code generated under
22209 those options runs best on that processor, and may not run at all on
22210 others.
22212 The @option{-mcpu} options automatically enable or disable the
22213 following options:
22215 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22216 -mpopcntb -mpopcntd @gol
22217 -msingle-float -mdouble-float @gol
22218 -mfloat128}
22220 The particular options set for any particular CPU varies between
22221 compiler versions, depending on what setting seems to produce optimal
22222 code for that CPU; it doesn't necessarily reflect the actual hardware's
22223 capabilities.  If you wish to set an individual option to a particular
22224 value, you may specify it after the @option{-mcpu} option, like
22225 @option{-mcpu=8548}.
22227 @item -mtune=@var{cpu_type}
22228 @opindex mtune
22229 Set the instruction scheduling parameters for machine type
22230 @var{cpu_type}, but do not set the architecture type or register usage,
22231 as @option{-mcpu=@var{cpu_type}} does.  The same
22232 values for @var{cpu_type} are used for @option{-mtune} as for
22233 @option{-mcpu}.  If both are specified, the code generated uses the
22234 architecture and registers set by @option{-mcpu}, but the
22235 scheduling parameters set by @option{-mtune}.
22237 @item -msecure-plt
22238 @opindex msecure-plt
22239 Generate code that allows @command{ld} and @command{ld.so}
22240 to build executables and shared
22241 libraries with non-executable @code{.plt} and @code{.got} sections.
22242 This is a PowerPC
22243 32-bit SYSV ABI option.
22245 @item -mbss-plt
22246 @opindex mbss-plt
22247 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22248 fills in, and
22249 requires @code{.plt} and @code{.got}
22250 sections that are both writable and executable.
22251 This is a PowerPC 32-bit SYSV ABI option.
22253 @item -misel
22254 @itemx -mno-isel
22255 @opindex misel
22256 @opindex mno-isel
22257 This switch enables or disables the generation of ISEL instructions.
22259 @item -misel=@var{yes/no}
22260 This switch has been deprecated.  Use @option{-misel} and
22261 @option{-mno-isel} instead.
22263 @item -mspe
22264 @itemx -mno-spe
22265 @opindex mspe
22266 @opindex mno-spe
22267 This switch enables or disables the generation of SPE simd
22268 instructions.
22270 @item -mspe=@var{yes/no}
22271 This option has been deprecated.  Use @option{-mspe} and
22272 @option{-mno-spe} instead.
22274 @item -mfloat128
22275 @itemx -mno-float128
22276 @opindex mfloat128
22277 @opindex mno-float128
22278 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22279 and use either software emulation for IEEE 128-bit floating point or
22280 hardware instructions.
22282 @item -mfloat-gprs=@var{yes/single/double/no}
22283 @itemx -mfloat-gprs
22284 @opindex mfloat-gprs
22285 This switch enables or disables the generation of floating-point
22286 operations on the general-purpose registers for architectures that
22287 support it.
22289 The argument @samp{yes} or @samp{single} enables the use of
22290 single-precision floating-point operations.
22292 The argument @samp{double} enables the use of single and
22293 double-precision floating-point operations.
22295 The argument @samp{no} disables floating-point operations on the
22296 general-purpose registers.
22298 This option is currently only available on the MPC854x.
22300 @item -mfull-toc
22301 @itemx -mno-fp-in-toc
22302 @itemx -mno-sum-in-toc
22303 @itemx -mminimal-toc
22304 @opindex mfull-toc
22305 @opindex mno-fp-in-toc
22306 @opindex mno-sum-in-toc
22307 @opindex mminimal-toc
22308 Modify generation of the TOC (Table Of Contents), which is created for
22309 every executable file.  The @option{-mfull-toc} option is selected by
22310 default.  In that case, GCC allocates at least one TOC entry for
22311 each unique non-automatic variable reference in your program.  GCC
22312 also places floating-point constants in the TOC@.  However, only
22313 16,384 entries are available in the TOC@.
22315 If you receive a linker error message that saying you have overflowed
22316 the available TOC space, you can reduce the amount of TOC space used
22317 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22318 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22319 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22320 generate code to calculate the sum of an address and a constant at
22321 run time instead of putting that sum into the TOC@.  You may specify one
22322 or both of these options.  Each causes GCC to produce very slightly
22323 slower and larger code at the expense of conserving TOC space.
22325 If you still run out of space in the TOC even when you specify both of
22326 these options, specify @option{-mminimal-toc} instead.  This option causes
22327 GCC to make only one TOC entry for every file.  When you specify this
22328 option, GCC produces code that is slower and larger but which
22329 uses extremely little TOC space.  You may wish to use this option
22330 only on files that contain less frequently-executed code.
22332 @item -maix32
22333 @opindex maix32
22334 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22336 @item -mxl-compat
22337 @itemx -mno-xl-compat
22338 @opindex mxl-compat
22339 @opindex mno-xl-compat
22340 Produce code that conforms more closely to IBM XL compiler semantics
22341 when using AIX-compatible ABI@.  Pass floating-point arguments to
22342 prototyped functions beyond the register save area (RSA) on the stack
22343 in addition to argument FPRs.  Do not assume that most significant
22344 double in 128-bit long double value is properly rounded when comparing
22345 values and converting to double.  Use XL symbol names for long double
22346 support routines.
22348 The AIX calling convention was extended but not initially documented to
22349 handle an obscure K&R C case of calling a function that takes the
22350 address of its arguments with fewer arguments than declared.  IBM XL
22351 compilers access floating-point arguments that do not fit in the
22352 RSA from the stack when a subroutine is compiled without
22353 optimization.  Because always storing floating-point arguments on the
22354 stack is inefficient and rarely needed, this option is not enabled by
22355 default and only is necessary when calling subroutines compiled by IBM
22356 XL compilers without optimization.
22358 @item -malign-natural
22359 @itemx -malign-power
22360 @opindex malign-natural
22361 @opindex malign-power
22362 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22363 @option{-malign-natural} overrides the ABI-defined alignment of larger
22364 types, such as floating-point doubles, on their natural size-based boundary.
22365 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22366 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22368 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22369 is not supported.
22371 @item -msoft-float
22372 @itemx -mhard-float
22373 @opindex msoft-float
22374 @opindex mhard-float
22375 Generate code that does not use (uses) the floating-point register set.
22376 Software floating-point emulation is provided if you use the
22377 @option{-msoft-float} option, and pass the option to GCC when linking.
22379 @item -msingle-float
22380 @itemx -mdouble-float
22381 @opindex msingle-float
22382 @opindex mdouble-float
22383 Generate code for single- or double-precision floating-point operations.
22384 @option{-mdouble-float} implies @option{-msingle-float}.
22386 @item -mmultiple
22387 @itemx -mno-multiple
22388 @opindex mmultiple
22389 @opindex mno-multiple
22390 Generate code that uses (does not use) the load multiple word
22391 instructions and the store multiple word instructions.  These
22392 instructions are generated by default on POWER systems, and not
22393 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22394 PowerPC systems, since those instructions do not work when the
22395 processor is in little-endian mode.  The exceptions are PPC740 and
22396 PPC750 which permit these instructions in little-endian mode.
22398 @item -mupdate
22399 @itemx -mno-update
22400 @opindex mupdate
22401 @opindex mno-update
22402 Generate code that uses (does not use) the load or store instructions
22403 that update the base register to the address of the calculated memory
22404 location.  These instructions are generated by default.  If you use
22405 @option{-mno-update}, there is a small window between the time that the
22406 stack pointer is updated and the address of the previous frame is
22407 stored, which means code that walks the stack frame across interrupts or
22408 signals may get corrupted data.
22410 @item -mavoid-indexed-addresses
22411 @itemx -mno-avoid-indexed-addresses
22412 @opindex mavoid-indexed-addresses
22413 @opindex mno-avoid-indexed-addresses
22414 Generate code that tries to avoid (not avoid) the use of indexed load
22415 or store instructions. These instructions can incur a performance
22416 penalty on Power6 processors in certain situations, such as when
22417 stepping through large arrays that cross a 16M boundary.  This option
22418 is enabled by default when targeting Power6 and disabled otherwise.
22420 @item -mfused-madd
22421 @itemx -mno-fused-madd
22422 @opindex mfused-madd
22423 @opindex mno-fused-madd
22424 Generate code that uses (does not use) the floating-point multiply and
22425 accumulate instructions.  These instructions are generated by default
22426 if hardware floating point is used.  The machine-dependent
22427 @option{-mfused-madd} option is now mapped to the machine-independent
22428 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22429 mapped to @option{-ffp-contract=off}.
22431 @item -mno-strict-align
22432 @itemx -mstrict-align
22433 @opindex mno-strict-align
22434 @opindex mstrict-align
22435 On System V.4 and embedded PowerPC systems do not (do) assume that
22436 unaligned memory references are handled by the system.
22438 @item -mrelocatable
22439 @itemx -mno-relocatable
22440 @opindex mrelocatable
22441 @opindex mno-relocatable
22442 Generate code that allows (does not allow) a static executable to be
22443 relocated to a different address at run time.  A simple embedded
22444 PowerPC system loader should relocate the entire contents of
22445 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22446 a table of 32-bit addresses generated by this option.  For this to
22447 work, all objects linked together must be compiled with
22448 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22449 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22451 @item -mrelocatable-lib
22452 @itemx -mno-relocatable-lib
22453 @opindex mrelocatable-lib
22454 @opindex mno-relocatable-lib
22455 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22456 @code{.fixup} section to allow static executables to be relocated at
22457 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22458 alignment of @option{-mrelocatable}.  Objects compiled with
22459 @option{-mrelocatable-lib} may be linked with objects compiled with
22460 any combination of the @option{-mrelocatable} options.
22462 @item -mno-toc
22463 @itemx -mtoc
22464 @opindex mno-toc
22465 @opindex mtoc
22466 On System V.4 and embedded PowerPC systems do not (do) assume that
22467 register 2 contains a pointer to a global area pointing to the addresses
22468 used in the program.
22470 @item -mlittle
22471 @itemx -mlittle-endian
22472 @opindex mlittle
22473 @opindex mlittle-endian
22474 On System V.4 and embedded PowerPC systems compile code for the
22475 processor in little-endian mode.  The @option{-mlittle-endian} option is
22476 the same as @option{-mlittle}.
22478 @item -mbig
22479 @itemx -mbig-endian
22480 @opindex mbig
22481 @opindex mbig-endian
22482 On System V.4 and embedded PowerPC systems compile code for the
22483 processor in big-endian mode.  The @option{-mbig-endian} option is
22484 the same as @option{-mbig}.
22486 @item -mdynamic-no-pic
22487 @opindex mdynamic-no-pic
22488 On Darwin and Mac OS X systems, compile code so that it is not
22489 relocatable, but that its external references are relocatable.  The
22490 resulting code is suitable for applications, but not shared
22491 libraries.
22493 @item -msingle-pic-base
22494 @opindex msingle-pic-base
22495 Treat the register used for PIC addressing as read-only, rather than
22496 loading it in the prologue for each function.  The runtime system is
22497 responsible for initializing this register with an appropriate value
22498 before execution begins.
22500 @item -mprioritize-restricted-insns=@var{priority}
22501 @opindex mprioritize-restricted-insns
22502 This option controls the priority that is assigned to
22503 dispatch-slot restricted instructions during the second scheduling
22504 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22505 or @samp{2} to assign no, highest, or second-highest (respectively)
22506 priority to dispatch-slot restricted
22507 instructions.
22509 @item -msched-costly-dep=@var{dependence_type}
22510 @opindex msched-costly-dep
22511 This option controls which dependences are considered costly
22512 by the target during instruction scheduling.  The argument
22513 @var{dependence_type} takes one of the following values:
22515 @table @asis
22516 @item @samp{no}
22517 No dependence is costly.
22519 @item @samp{all}
22520 All dependences are costly.
22522 @item @samp{true_store_to_load}
22523 A true dependence from store to load is costly.
22525 @item @samp{store_to_load}
22526 Any dependence from store to load is costly.
22528 @item @var{number}
22529 Any dependence for which the latency is greater than or equal to
22530 @var{number} is costly.
22531 @end table
22533 @item -minsert-sched-nops=@var{scheme}
22534 @opindex minsert-sched-nops
22535 This option controls which NOP insertion scheme is used during
22536 the second scheduling pass.  The argument @var{scheme} takes one of the
22537 following values:
22539 @table @asis
22540 @item @samp{no}
22541 Don't insert NOPs.
22543 @item @samp{pad}
22544 Pad with NOPs any dispatch group that has vacant issue slots,
22545 according to the scheduler's grouping.
22547 @item @samp{regroup_exact}
22548 Insert NOPs to force costly dependent insns into
22549 separate groups.  Insert exactly as many NOPs as needed to force an insn
22550 to a new group, according to the estimated processor grouping.
22552 @item @var{number}
22553 Insert NOPs to force costly dependent insns into
22554 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22555 @end table
22557 @item -mcall-sysv
22558 @opindex mcall-sysv
22559 On System V.4 and embedded PowerPC systems compile code using calling
22560 conventions that adhere to the March 1995 draft of the System V
22561 Application Binary Interface, PowerPC processor supplement.  This is the
22562 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22564 @item -mcall-sysv-eabi
22565 @itemx -mcall-eabi
22566 @opindex mcall-sysv-eabi
22567 @opindex mcall-eabi
22568 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22570 @item -mcall-sysv-noeabi
22571 @opindex mcall-sysv-noeabi
22572 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22574 @item -mcall-aixdesc
22575 @opindex m
22576 On System V.4 and embedded PowerPC systems compile code for the AIX
22577 operating system.
22579 @item -mcall-linux
22580 @opindex mcall-linux
22581 On System V.4 and embedded PowerPC systems compile code for the
22582 Linux-based GNU system.
22584 @item -mcall-freebsd
22585 @opindex mcall-freebsd
22586 On System V.4 and embedded PowerPC systems compile code for the
22587 FreeBSD operating system.
22589 @item -mcall-netbsd
22590 @opindex mcall-netbsd
22591 On System V.4 and embedded PowerPC systems compile code for the
22592 NetBSD operating system.
22594 @item -mcall-openbsd
22595 @opindex mcall-netbsd
22596 On System V.4 and embedded PowerPC systems compile code for the
22597 OpenBSD operating system.
22599 @item -maix-struct-return
22600 @opindex maix-struct-return
22601 Return all structures in memory (as specified by the AIX ABI)@.
22603 @item -msvr4-struct-return
22604 @opindex msvr4-struct-return
22605 Return structures smaller than 8 bytes in registers (as specified by the
22606 SVR4 ABI)@.
22608 @item -mabi=@var{abi-type}
22609 @opindex mabi
22610 Extend the current ABI with a particular extension, or remove such extension.
22611 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22612 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22613 @samp{elfv1}, @samp{elfv2}@.
22615 @item -mabi=spe
22616 @opindex mabi=spe
22617 Extend the current ABI with SPE ABI extensions.  This does not change
22618 the default ABI, instead it adds the SPE ABI extensions to the current
22619 ABI@.
22621 @item -mabi=no-spe
22622 @opindex mabi=no-spe
22623 Disable Book-E SPE ABI extensions for the current ABI@.
22625 @item -mabi=ibmlongdouble
22626 @opindex mabi=ibmlongdouble
22627 Change the current ABI to use IBM extended-precision long double.
22628 This is not likely to work if your system defaults to using IEEE
22629 extended-precision long double.  If you change the long double type
22630 from IEEE extended-precision, the compiler will issue a warning unless
22631 you use the @option{-Wno-psabi} option.
22633 @item -mabi=ieeelongdouble
22634 @opindex mabi=ieeelongdouble
22635 Change the current ABI to use IEEE extended-precision long double.
22636 This is not likely to work if your system defaults to using IBM
22637 extended-precision long double.  If you change the long double type
22638 from IBM extended-precision, the compiler will issue a warning unless
22639 you use the @option{-Wno-psabi} option.
22641 @item -mabi=elfv1
22642 @opindex mabi=elfv1
22643 Change the current ABI to use the ELFv1 ABI.
22644 This is the default ABI for big-endian PowerPC 64-bit Linux.
22645 Overriding the default ABI requires special system support and is
22646 likely to fail in spectacular ways.
22648 @item -mabi=elfv2
22649 @opindex mabi=elfv2
22650 Change the current ABI to use the ELFv2 ABI.
22651 This is the default ABI for little-endian PowerPC 64-bit Linux.
22652 Overriding the default ABI requires special system support and is
22653 likely to fail in spectacular ways.
22655 @item -mgnu-attribute
22656 @itemx -mno-gnu-attribute
22657 @opindex mgnu-attribute
22658 @opindex mno-gnu-attribute
22659 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22660 .gnu.attributes section that specify ABI variations in function
22661 parameters or return values.
22663 @item -mprototype
22664 @itemx -mno-prototype
22665 @opindex mprototype
22666 @opindex mno-prototype
22667 On System V.4 and embedded PowerPC systems assume that all calls to
22668 variable argument functions are properly prototyped.  Otherwise, the
22669 compiler must insert an instruction before every non-prototyped call to
22670 set or clear bit 6 of the condition code register (@code{CR}) to
22671 indicate whether floating-point values are passed in the floating-point
22672 registers in case the function takes variable arguments.  With
22673 @option{-mprototype}, only calls to prototyped variable argument functions
22674 set or clear the bit.
22676 @item -msim
22677 @opindex msim
22678 On embedded PowerPC systems, assume that the startup module is called
22679 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22680 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22681 configurations.
22683 @item -mmvme
22684 @opindex mmvme
22685 On embedded PowerPC systems, assume that the startup module is called
22686 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22687 @file{libc.a}.
22689 @item -mads
22690 @opindex mads
22691 On embedded PowerPC systems, assume that the startup module is called
22692 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22693 @file{libc.a}.
22695 @item -myellowknife
22696 @opindex myellowknife
22697 On embedded PowerPC systems, assume that the startup module is called
22698 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22699 @file{libc.a}.
22701 @item -mvxworks
22702 @opindex mvxworks
22703 On System V.4 and embedded PowerPC systems, specify that you are
22704 compiling for a VxWorks system.
22706 @item -memb
22707 @opindex memb
22708 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22709 header to indicate that @samp{eabi} extended relocations are used.
22711 @item -meabi
22712 @itemx -mno-eabi
22713 @opindex meabi
22714 @opindex mno-eabi
22715 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22716 Embedded Applications Binary Interface (EABI), which is a set of
22717 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22718 means that the stack is aligned to an 8-byte boundary, a function
22719 @code{__eabi} is called from @code{main} to set up the EABI
22720 environment, and the @option{-msdata} option can use both @code{r2} and
22721 @code{r13} to point to two separate small data areas.  Selecting
22722 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22723 no EABI initialization function is called from @code{main}, and the
22724 @option{-msdata} option only uses @code{r13} to point to a single
22725 small data area.  The @option{-meabi} option is on by default if you
22726 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22728 @item -msdata=eabi
22729 @opindex msdata=eabi
22730 On System V.4 and embedded PowerPC systems, put small initialized
22731 @code{const} global and static data in the @code{.sdata2} section, which
22732 is pointed to by register @code{r2}.  Put small initialized
22733 non-@code{const} global and static data in the @code{.sdata} section,
22734 which is pointed to by register @code{r13}.  Put small uninitialized
22735 global and static data in the @code{.sbss} section, which is adjacent to
22736 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22737 incompatible with the @option{-mrelocatable} option.  The
22738 @option{-msdata=eabi} option also sets the @option{-memb} option.
22740 @item -msdata=sysv
22741 @opindex msdata=sysv
22742 On System V.4 and embedded PowerPC systems, put small global and static
22743 data in the @code{.sdata} section, which is pointed to by register
22744 @code{r13}.  Put small uninitialized global and static data in the
22745 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22746 The @option{-msdata=sysv} option is incompatible with the
22747 @option{-mrelocatable} option.
22749 @item -msdata=default
22750 @itemx -msdata
22751 @opindex msdata=default
22752 @opindex msdata
22753 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22754 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22755 same as @option{-msdata=sysv}.
22757 @item -msdata=data
22758 @opindex msdata=data
22759 On System V.4 and embedded PowerPC systems, put small global
22760 data in the @code{.sdata} section.  Put small uninitialized global
22761 data in the @code{.sbss} section.  Do not use register @code{r13}
22762 to address small data however.  This is the default behavior unless
22763 other @option{-msdata} options are used.
22765 @item -msdata=none
22766 @itemx -mno-sdata
22767 @opindex msdata=none
22768 @opindex mno-sdata
22769 On embedded PowerPC systems, put all initialized global and static data
22770 in the @code{.data} section, and all uninitialized data in the
22771 @code{.bss} section.
22773 @item -mblock-move-inline-limit=@var{num}
22774 @opindex mblock-move-inline-limit
22775 Inline all block moves (such as calls to @code{memcpy} or structure
22776 copies) less than or equal to @var{num} bytes.  The minimum value for
22777 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22778 targets.  The default value is target-specific.
22780 @item -G @var{num}
22781 @opindex G
22782 @cindex smaller data references (PowerPC)
22783 @cindex .sdata/.sdata2 references (PowerPC)
22784 On embedded PowerPC systems, put global and static items less than or
22785 equal to @var{num} bytes into the small data or BSS sections instead of
22786 the normal data or BSS section.  By default, @var{num} is 8.  The
22787 @option{-G @var{num}} switch is also passed to the linker.
22788 All modules should be compiled with the same @option{-G @var{num}} value.
22790 @item -mregnames
22791 @itemx -mno-regnames
22792 @opindex mregnames
22793 @opindex mno-regnames
22794 On System V.4 and embedded PowerPC systems do (do not) emit register
22795 names in the assembly language output using symbolic forms.
22797 @item -mlongcall
22798 @itemx -mno-longcall
22799 @opindex mlongcall
22800 @opindex mno-longcall
22801 By default assume that all calls are far away so that a longer and more
22802 expensive calling sequence is required.  This is required for calls
22803 farther than 32 megabytes (33,554,432 bytes) from the current location.
22804 A short call is generated if the compiler knows
22805 the call cannot be that far away.  This setting can be overridden by
22806 the @code{shortcall} function attribute, or by @code{#pragma
22807 longcall(0)}.
22809 Some linkers are capable of detecting out-of-range calls and generating
22810 glue code on the fly.  On these systems, long calls are unnecessary and
22811 generate slower code.  As of this writing, the AIX linker can do this,
22812 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22813 to the GNU linker for 32-bit PowerPC systems as well.
22815 In the future, GCC may ignore all longcall specifications
22816 when the linker is known to generate glue.
22818 @item -mtls-markers
22819 @itemx -mno-tls-markers
22820 @opindex mtls-markers
22821 @opindex mno-tls-markers
22822 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22823 specifying the function argument.  The relocation allows the linker to
22824 reliably associate function call with argument setup instructions for
22825 TLS optimization, which in turn allows GCC to better schedule the
22826 sequence.
22828 @item -mrecip
22829 @itemx -mno-recip
22830 @opindex mrecip
22831 This option enables use of the reciprocal estimate and
22832 reciprocal square root estimate instructions with additional
22833 Newton-Raphson steps to increase precision instead of doing a divide or
22834 square root and divide for floating-point arguments.  You should use
22835 the @option{-ffast-math} option when using @option{-mrecip} (or at
22836 least @option{-funsafe-math-optimizations},
22837 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22838 @option{-fno-trapping-math}).  Note that while the throughput of the
22839 sequence is generally higher than the throughput of the non-reciprocal
22840 instruction, the precision of the sequence can be decreased by up to 2
22841 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22842 roots.
22844 @item -mrecip=@var{opt}
22845 @opindex mrecip=opt
22846 This option controls which reciprocal estimate instructions
22847 may be used.  @var{opt} is a comma-separated list of options, which may
22848 be preceded by a @code{!} to invert the option:
22850 @table @samp
22852 @item all
22853 Enable all estimate instructions.
22855 @item default
22856 Enable the default instructions, equivalent to @option{-mrecip}.
22858 @item none
22859 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22861 @item div
22862 Enable the reciprocal approximation instructions for both
22863 single and double precision.
22865 @item divf
22866 Enable the single-precision reciprocal approximation instructions.
22868 @item divd
22869 Enable the double-precision reciprocal approximation instructions.
22871 @item rsqrt
22872 Enable the reciprocal square root approximation instructions for both
22873 single and double precision.
22875 @item rsqrtf
22876 Enable the single-precision reciprocal square root approximation instructions.
22878 @item rsqrtd
22879 Enable the double-precision reciprocal square root approximation instructions.
22881 @end table
22883 So, for example, @option{-mrecip=all,!rsqrtd} enables
22884 all of the reciprocal estimate instructions, except for the
22885 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22886 which handle the double-precision reciprocal square root calculations.
22888 @item -mrecip-precision
22889 @itemx -mno-recip-precision
22890 @opindex mrecip-precision
22891 Assume (do not assume) that the reciprocal estimate instructions
22892 provide higher-precision estimates than is mandated by the PowerPC
22893 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22894 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22895 The double-precision square root estimate instructions are not generated by
22896 default on low-precision machines, since they do not provide an
22897 estimate that converges after three steps.
22899 @item -mpointers-to-nested-functions
22900 @itemx -mno-pointers-to-nested-functions
22901 @opindex mpointers-to-nested-functions
22902 Generate (do not generate) code to load up the static chain register
22903 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22904 systems where a function pointer points to a 3-word descriptor giving
22905 the function address, TOC value to be loaded in register @code{r2}, and
22906 static chain value to be loaded in register @code{r11}.  The
22907 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22908 call through pointers to nested functions or pointers
22909 to functions compiled in other languages that use the static chain if
22910 you use @option{-mno-pointers-to-nested-functions}.
22912 @item -msave-toc-indirect
22913 @itemx -mno-save-toc-indirect
22914 @opindex msave-toc-indirect
22915 Generate (do not generate) code to save the TOC value in the reserved
22916 stack location in the function prologue if the function calls through
22917 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22918 saved in the prologue, it is saved just before the call through the
22919 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22921 @item -mcompat-align-parm
22922 @itemx -mno-compat-align-parm
22923 @opindex mcompat-align-parm
22924 Generate (do not generate) code to pass structure parameters with a
22925 maximum alignment of 64 bits, for compatibility with older versions
22926 of GCC.
22928 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22929 structure parameter on a 128-bit boundary when that structure contained
22930 a member requiring 128-bit alignment.  This is corrected in more
22931 recent versions of GCC.  This option may be used to generate code
22932 that is compatible with functions compiled with older versions of
22933 GCC.
22935 The @option{-mno-compat-align-parm} option is the default.
22937 @item -mstack-protector-guard=@var{guard}
22938 @itemx -mstack-protector-guard-reg=@var{reg}
22939 @itemx -mstack-protector-guard-offset=@var{offset}
22940 @itemx -mstack-protector-guard-symbol=@var{symbol}
22941 @opindex mstack-protector-guard
22942 @opindex mstack-protector-guard-reg
22943 @opindex mstack-protector-guard-offset
22944 @opindex mstack-protector-guard-symbol
22945 Generate stack protection code using canary at @var{guard}.  Supported
22946 locations are @samp{global} for global canary or @samp{tls} for per-thread
22947 canary in the TLS block (the default with GNU libc version 2.4 or later).
22949 With the latter choice the options
22950 @option{-mstack-protector-guard-reg=@var{reg}} and
22951 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22952 which register to use as base register for reading the canary, and from what
22953 offset from that base register. The default for those is as specified in the
22954 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22955 the offset with a symbol reference to a canary in the TLS block.
22956 @end table
22959 @node RISC-V Options
22960 @subsection RISC-V Options
22961 @cindex RISC-V Options
22963 These command-line options are defined for RISC-V targets:
22965 @table @gcctabopt
22966 @item -mbranch-cost=@var{n}
22967 @opindex mbranch-cost
22968 Set the cost of branches to roughly @var{n} instructions.
22970 @item -mplt
22971 @itemx -mno-plt
22972 @opindex plt
22973 When generating PIC code, do or don't allow the use of PLTs. Ignored for
22974 non-PIC.  The default is @option{-mplt}.
22976 @item -mabi=@var{ABI-string}
22977 @opindex mabi
22978 Specify integer and floating-point calling convention.  @var{ABI-string}
22979 contains two parts: the size of integer types and the registers used for
22980 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
22981 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
22982 32-bit), and that floating-point values up to 64 bits wide are passed in F
22983 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
22984 allows the compiler to generate code that uses the F and D extensions but only
22985 allows floating-point values up to 32 bits long to be passed in registers; or
22986 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
22987 passed in registers.
22989 The default for this argument is system dependent, users who want a specific
22990 calling convention should specify one explicitly.  The valid calling
22991 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
22992 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
22993 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
22994 invalid because the ABI requires 64-bit values be passed in F registers, but F
22995 registers are only 32 bits wide.  There is also the @samp{ilp32e} ABI that can
22996 only be used with the @samp{rv32e} architecture.  This ABI is not well
22997 specified at present, and is subject to change.
22999 @item -mfdiv
23000 @itemx -mno-fdiv
23001 @opindex mfdiv
23002 Do or don't use hardware floating-point divide and square root instructions.
23003 This requires the F or D extensions for floating-point registers.  The default
23004 is to use them if the specified architecture has these instructions.
23006 @item -mdiv
23007 @itemx -mno-div
23008 @opindex mdiv
23009 Do or don't use hardware instructions for integer division.  This requires the
23010 M extension.  The default is to use them if the specified architecture has
23011 these instructions.
23013 @item -march=@var{ISA-string}
23014 @opindex march
23015 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23016 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
23017 @samp{rv32imaf}.
23019 @item -mtune=@var{processor-string}
23020 @opindex mtune
23021 Optimize the output for the given processor, specified by microarchitecture
23022 name.
23024 @item -mpreferred-stack-boundary=@var{num}
23025 @opindex mpreferred-stack-boundary
23026 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23027 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23028 the default is 4 (16 bytes or 128-bits).
23030 @strong{Warning:} If you use this switch, then you must build all modules with
23031 the same value, including any libraries.  This includes the system libraries
23032 and startup modules.
23034 @item -msmall-data-limit=@var{n}
23035 @opindex msmall-data-limit
23036 Put global and static data smaller than @var{n} bytes into a special section
23037 (on some targets).
23039 @item -msave-restore
23040 @itemx -mno-save-restore
23041 @opindex msave-restore
23042 Do or don't use smaller but slower prologue and epilogue code that uses
23043 library function calls.  The default is to use fast inline prologues and
23044 epilogues.
23046 @item -mstrict-align
23047 @itemx -mno-strict-align
23048 @opindex mstrict-align
23049 Do not or do generate unaligned memory accesses.  The default is set depending
23050 on whether the processor we are optimizing for supports fast unaligned access
23051 or not.
23053 @item -mcmodel=medlow
23054 @opindex mcmodel=medlow
23055 Generate code for the medium-low code model. The program and its statically
23056 defined symbols must lie within a single 2 GiB address range and must lie
23057 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23058 statically or dynamically linked. This is the default code model.
23060 @item -mcmodel=medany
23061 @opindex mcmodel=medany
23062 Generate code for the medium-any code model. The program and its statically
23063 defined symbols must be within any single 2 GiB address range. Programs can be
23064 statically or dynamically linked.
23066 @item -mexplicit-relocs
23067 @itemx -mno-exlicit-relocs
23068 Use or do not use assembler relocation operators when dealing with symbolic
23069 addresses.  The alternative is to use assembler macros instead, which may
23070 limit optimization.
23072 @item -mrelax
23073 @itemx -mno-relax
23074 Take advantage of linker relaxations to reduce the number of instructions
23075 required to materialize symbol addresses. The default is to take advantage of
23076 linker relaxations.
23078 @end table
23080 @node RL78 Options
23081 @subsection RL78 Options
23082 @cindex RL78 Options
23084 @table @gcctabopt
23086 @item -msim
23087 @opindex msim
23088 Links in additional target libraries to support operation within a
23089 simulator.
23091 @item -mmul=none
23092 @itemx -mmul=g10
23093 @itemx -mmul=g13
23094 @itemx -mmul=g14
23095 @itemx -mmul=rl78
23096 @opindex mmul
23097 Specifies the type of hardware multiplication and division support to
23098 be used.  The simplest is @code{none}, which uses software for both
23099 multiplication and division.  This is the default.  The @code{g13}
23100 value is for the hardware multiply/divide peripheral found on the
23101 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23102 the multiplication and division instructions supported by the RL78/G14
23103 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23104 the value @code{mg10} is an alias for @code{none}.
23106 In addition a C preprocessor macro is defined, based upon the setting
23107 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23108 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23110 @item -mcpu=g10
23111 @itemx -mcpu=g13
23112 @itemx -mcpu=g14
23113 @itemx -mcpu=rl78
23114 @opindex mcpu
23115 Specifies the RL78 core to target.  The default is the G14 core, also
23116 known as an S3 core or just RL78.  The G13 or S2 core does not have
23117 multiply or divide instructions, instead it uses a hardware peripheral
23118 for these operations.  The G10 or S1 core does not have register
23119 banks, so it uses a different calling convention.
23121 If this option is set it also selects the type of hardware multiply
23122 support to use, unless this is overridden by an explicit
23123 @option{-mmul=none} option on the command line.  Thus specifying
23124 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23125 peripheral and specifying @option{-mcpu=g10} disables the use of
23126 hardware multiplications altogether.
23128 Note, although the RL78/G14 core is the default target, specifying
23129 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23130 change the behavior of the toolchain since it also enables G14
23131 hardware multiply support.  If these options are not specified on the
23132 command line then software multiplication routines will be used even
23133 though the code targets the RL78 core.  This is for backwards
23134 compatibility with older toolchains which did not have hardware
23135 multiply and divide support.
23137 In addition a C preprocessor macro is defined, based upon the setting
23138 of this option.  Possible values are: @code{__RL78_G10__},
23139 @code{__RL78_G13__} or @code{__RL78_G14__}.
23141 @item -mg10
23142 @itemx -mg13
23143 @itemx -mg14
23144 @itemx -mrl78
23145 @opindex mg10
23146 @opindex mg13
23147 @opindex mg14
23148 @opindex mrl78
23149 These are aliases for the corresponding @option{-mcpu=} option.  They
23150 are provided for backwards compatibility.
23152 @item -mallregs
23153 @opindex mallregs
23154 Allow the compiler to use all of the available registers.  By default
23155 registers @code{r24..r31} are reserved for use in interrupt handlers.
23156 With this option enabled these registers can be used in ordinary
23157 functions as well.
23159 @item -m64bit-doubles
23160 @itemx -m32bit-doubles
23161 @opindex m64bit-doubles
23162 @opindex m32bit-doubles
23163 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23164 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23165 @option{-m32bit-doubles}.
23167 @item -msave-mduc-in-interrupts
23168 @itemx -mno-save-mduc-in-interrupts
23169 @opindex msave-mduc-in-interrupts
23170 @opindex mno-save-mduc-in-interrupts
23171 Specifies that interrupt handler functions should preserve the
23172 MDUC registers.  This is only necessary if normal code might use
23173 the MDUC registers, for example because it performs multiplication
23174 and division operations.  The default is to ignore the MDUC registers
23175 as this makes the interrupt handlers faster.  The target option -mg13
23176 needs to be passed for this to work as this feature is only available
23177 on the G13 target (S2 core).  The MDUC registers will only be saved
23178 if the interrupt handler performs a multiplication or division
23179 operation or it calls another function.
23181 @end table
23183 @node RS/6000 and PowerPC Options
23184 @subsection IBM RS/6000 and PowerPC Options
23185 @cindex RS/6000 and PowerPC Options
23186 @cindex IBM RS/6000 and PowerPC Options
23188 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23189 @table @gcctabopt
23190 @item -mpowerpc-gpopt
23191 @itemx -mno-powerpc-gpopt
23192 @itemx -mpowerpc-gfxopt
23193 @itemx -mno-powerpc-gfxopt
23194 @need 800
23195 @itemx -mpowerpc64
23196 @itemx -mno-powerpc64
23197 @itemx -mmfcrf
23198 @itemx -mno-mfcrf
23199 @itemx -mpopcntb
23200 @itemx -mno-popcntb
23201 @itemx -mpopcntd
23202 @itemx -mno-popcntd
23203 @itemx -mfprnd
23204 @itemx -mno-fprnd
23205 @need 800
23206 @itemx -mcmpb
23207 @itemx -mno-cmpb
23208 @itemx -mmfpgpr
23209 @itemx -mno-mfpgpr
23210 @itemx -mhard-dfp
23211 @itemx -mno-hard-dfp
23212 @opindex mpowerpc-gpopt
23213 @opindex mno-powerpc-gpopt
23214 @opindex mpowerpc-gfxopt
23215 @opindex mno-powerpc-gfxopt
23216 @opindex mpowerpc64
23217 @opindex mno-powerpc64
23218 @opindex mmfcrf
23219 @opindex mno-mfcrf
23220 @opindex mpopcntb
23221 @opindex mno-popcntb
23222 @opindex mpopcntd
23223 @opindex mno-popcntd
23224 @opindex mfprnd
23225 @opindex mno-fprnd
23226 @opindex mcmpb
23227 @opindex mno-cmpb
23228 @opindex mmfpgpr
23229 @opindex mno-mfpgpr
23230 @opindex mhard-dfp
23231 @opindex mno-hard-dfp
23232 You use these options to specify which instructions are available on the
23233 processor you are using.  The default value of these options is
23234 determined when configuring GCC@.  Specifying the
23235 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23236 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23237 rather than the options listed above.
23239 Specifying @option{-mpowerpc-gpopt} allows
23240 GCC to use the optional PowerPC architecture instructions in the
23241 General Purpose group, including floating-point square root.  Specifying
23242 @option{-mpowerpc-gfxopt} allows GCC to
23243 use the optional PowerPC architecture instructions in the Graphics
23244 group, including floating-point select.
23246 The @option{-mmfcrf} option allows GCC to generate the move from
23247 condition register field instruction implemented on the POWER4
23248 processor and other processors that support the PowerPC V2.01
23249 architecture.
23250 The @option{-mpopcntb} option allows GCC to generate the popcount and
23251 double-precision FP reciprocal estimate instruction implemented on the
23252 POWER5 processor and other processors that support the PowerPC V2.02
23253 architecture.
23254 The @option{-mpopcntd} option allows GCC to generate the popcount
23255 instruction implemented on the POWER7 processor and other processors
23256 that support the PowerPC V2.06 architecture.
23257 The @option{-mfprnd} option allows GCC to generate the FP round to
23258 integer instructions implemented on the POWER5+ processor and other
23259 processors that support the PowerPC V2.03 architecture.
23260 The @option{-mcmpb} option allows GCC to generate the compare bytes
23261 instruction implemented on the POWER6 processor and other processors
23262 that support the PowerPC V2.05 architecture.
23263 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23264 general-purpose register instructions implemented on the POWER6X
23265 processor and other processors that support the extended PowerPC V2.05
23266 architecture.
23267 The @option{-mhard-dfp} option allows GCC to generate the decimal
23268 floating-point instructions implemented on some POWER processors.
23270 The @option{-mpowerpc64} option allows GCC to generate the additional
23271 64-bit instructions that are found in the full PowerPC64 architecture
23272 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23273 @option{-mno-powerpc64}.
23275 @item -mcpu=@var{cpu_type}
23276 @opindex mcpu
23277 Set architecture type, register usage, and
23278 instruction scheduling parameters for machine type @var{cpu_type}.
23279 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23280 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23281 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23282 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23283 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23284 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23285 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23286 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23287 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23288 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23289 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23290 @samp{rs64}, and @samp{native}.
23292 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23293 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23294 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23295 architecture machine types, with an appropriate, generic processor
23296 model assumed for scheduling purposes.
23298 Specifying @samp{native} as cpu type detects and selects the
23299 architecture option that corresponds to the host processor of the
23300 system performing the compilation.
23301 @option{-mcpu=native} has no effect if GCC does not recognize the
23302 processor.
23304 The other options specify a specific processor.  Code generated under
23305 those options runs best on that processor, and may not run at all on
23306 others.
23308 The @option{-mcpu} options automatically enable or disable the
23309 following options:
23311 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23312 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23313 -mpowerpc-gpopt  -mpowerpc-gfxopt @gol
23314 -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23315 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
23316 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23318 The particular options set for any particular CPU varies between
23319 compiler versions, depending on what setting seems to produce optimal
23320 code for that CPU; it doesn't necessarily reflect the actual hardware's
23321 capabilities.  If you wish to set an individual option to a particular
23322 value, you may specify it after the @option{-mcpu} option, like
23323 @option{-mcpu=970 -mno-altivec}.
23325 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23326 not enabled or disabled by the @option{-mcpu} option at present because
23327 AIX does not have full support for these options.  You may still
23328 enable or disable them individually if you're sure it'll work in your
23329 environment.
23331 @item -mtune=@var{cpu_type}
23332 @opindex mtune
23333 Set the instruction scheduling parameters for machine type
23334 @var{cpu_type}, but do not set the architecture type or register usage,
23335 as @option{-mcpu=@var{cpu_type}} does.  The same
23336 values for @var{cpu_type} are used for @option{-mtune} as for
23337 @option{-mcpu}.  If both are specified, the code generated uses the
23338 architecture and registers set by @option{-mcpu}, but the
23339 scheduling parameters set by @option{-mtune}.
23341 @item -mcmodel=small
23342 @opindex mcmodel=small
23343 Generate PowerPC64 code for the small model: The TOC is limited to
23344 64k.
23346 @item -mcmodel=medium
23347 @opindex mcmodel=medium
23348 Generate PowerPC64 code for the medium model: The TOC and other static
23349 data may be up to a total of 4G in size.  This is the default for 64-bit
23350 Linux.
23352 @item -mcmodel=large
23353 @opindex mcmodel=large
23354 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23355 in size.  Other data and code is only limited by the 64-bit address
23356 space.
23358 @item -maltivec
23359 @itemx -mno-altivec
23360 @opindex maltivec
23361 @opindex mno-altivec
23362 Generate code that uses (does not use) AltiVec instructions, and also
23363 enable the use of built-in functions that allow more direct access to
23364 the AltiVec instruction set.  You may also need to set
23365 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23366 enhancements.
23368 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23369 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23370 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23371 match array element order corresponding to the endianness of the
23372 target.  That is, element zero identifies the leftmost element in a
23373 vector register when targeting a big-endian platform, and identifies
23374 the rightmost element in a vector register when targeting a
23375 little-endian platform.
23377 @item -maltivec=be
23378 @opindex maltivec=be
23379 Generate AltiVec instructions using big-endian element order,
23380 regardless of whether the target is big- or little-endian.  This is
23381 the default when targeting a big-endian platform.  Using this option
23382 is currently deprecated.  Support for this feature will be removed in
23383 GCC 9.
23385 The element order is used to interpret element numbers in AltiVec
23386 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23387 @code{vec_insert}.  By default, these match array element order
23388 corresponding to the endianness for the target.
23390 @item -maltivec=le
23391 @opindex maltivec=le
23392 Generate AltiVec instructions using little-endian element order,
23393 regardless of whether the target is big- or little-endian.  This is
23394 the default when targeting a little-endian platform.  This option is
23395 currently ignored when targeting a big-endian platform.
23397 The element order is used to interpret element numbers in AltiVec
23398 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23399 @code{vec_insert}.  By default, these match array element order
23400 corresponding to the endianness for the target.
23402 @item -mvrsave
23403 @itemx -mno-vrsave
23404 @opindex mvrsave
23405 @opindex mno-vrsave
23406 Generate VRSAVE instructions when generating AltiVec code.
23408 @item -msecure-plt
23409 @opindex msecure-plt
23410 Generate code that allows @command{ld} and @command{ld.so}
23411 to build executables and shared
23412 libraries with non-executable @code{.plt} and @code{.got} sections.
23413 This is a PowerPC
23414 32-bit SYSV ABI option.
23416 @item -mbss-plt
23417 @opindex mbss-plt
23418 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23419 fills in, and
23420 requires @code{.plt} and @code{.got}
23421 sections that are both writable and executable.
23422 This is a PowerPC 32-bit SYSV ABI option.
23424 @item -misel
23425 @itemx -mno-isel
23426 @opindex misel
23427 @opindex mno-isel
23428 This switch enables or disables the generation of ISEL instructions.
23430 @item -misel=@var{yes/no}
23431 This switch has been deprecated.  Use @option{-misel} and
23432 @option{-mno-isel} instead.
23434 @item -mvsx
23435 @itemx -mno-vsx
23436 @opindex mvsx
23437 @opindex mno-vsx
23438 Generate code that uses (does not use) vector/scalar (VSX)
23439 instructions, and also enable the use of built-in functions that allow
23440 more direct access to the VSX instruction set.
23442 @item -mcrypto
23443 @itemx -mno-crypto
23444 @opindex mcrypto
23445 @opindex mno-crypto
23446 Enable the use (disable) of the built-in functions that allow direct
23447 access to the cryptographic instructions that were added in version
23448 2.07 of the PowerPC ISA.
23450 @item -mhtm
23451 @itemx -mno-htm
23452 @opindex mhtm
23453 @opindex mno-htm
23454 Enable (disable) the use of the built-in functions that allow direct
23455 access to the Hardware Transactional Memory (HTM) instructions that
23456 were added in version 2.07 of the PowerPC ISA.
23458 @item -mpower8-fusion
23459 @itemx -mno-power8-fusion
23460 @opindex mpower8-fusion
23461 @opindex mno-power8-fusion
23462 Generate code that keeps (does not keeps) some integer operations
23463 adjacent so that the instructions can be fused together on power8 and
23464 later processors.
23466 @item -mpower8-vector
23467 @itemx -mno-power8-vector
23468 @opindex mpower8-vector
23469 @opindex mno-power8-vector
23470 Generate code that uses (does not use) the vector and scalar
23471 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23472 enable the use of built-in functions that allow more direct access to
23473 the vector instructions.
23475 @item -mquad-memory
23476 @itemx -mno-quad-memory
23477 @opindex mquad-memory
23478 @opindex mno-quad-memory
23479 Generate code that uses (does not use) the non-atomic quad word memory
23480 instructions.  The @option{-mquad-memory} option requires use of
23481 64-bit mode.
23483 @item -mquad-memory-atomic
23484 @itemx -mno-quad-memory-atomic
23485 @opindex mquad-memory-atomic
23486 @opindex mno-quad-memory-atomic
23487 Generate code that uses (does not use) the atomic quad word memory
23488 instructions.  The @option{-mquad-memory-atomic} option requires use of
23489 64-bit mode.
23491 @item -mfloat128
23492 @itemx -mno-float128
23493 @opindex mfloat128
23494 @opindex mno-float128
23495 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23496 and use either software emulation for IEEE 128-bit floating point or
23497 hardware instructions.
23499 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23500 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23501 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23502 floating point support only works on PowerPC Linux systems.
23504 The default for @option{-mfloat128} is enabled on PowerPC Linux
23505 systems using the VSX instruction set, and disabled on other systems.
23507 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23508 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23509 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23510 floating point instructions.  Otherwise, if you do not specify to
23511 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23512 system, IEEE 128-bit floating point will be done with software
23513 emulation.
23515 @item -mfloat128-hardware
23516 @itemx -mno-float128-hardware
23517 @opindex mfloat128-hardware
23518 @opindex mno-float128-hardware
23519 Enable/disable using ISA 3.0 hardware instructions to support the
23520 @var{__float128} data type.
23522 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23523 Linux systems using the ISA 3.0 instruction set, and disabled on other
23524 systems.
23526 @item -m32
23527 @itemx -m64
23528 @opindex m32
23529 @opindex m64
23530 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23531 targets (including GNU/Linux).  The 32-bit environment sets int, long
23532 and pointer to 32 bits and generates code that runs on any PowerPC
23533 variant.  The 64-bit environment sets int to 32 bits and long and
23534 pointer to 64 bits, and generates code for PowerPC64, as for
23535 @option{-mpowerpc64}.
23537 @item -mfull-toc
23538 @itemx -mno-fp-in-toc
23539 @itemx -mno-sum-in-toc
23540 @itemx -mminimal-toc
23541 @opindex mfull-toc
23542 @opindex mno-fp-in-toc
23543 @opindex mno-sum-in-toc
23544 @opindex mminimal-toc
23545 Modify generation of the TOC (Table Of Contents), which is created for
23546 every executable file.  The @option{-mfull-toc} option is selected by
23547 default.  In that case, GCC allocates at least one TOC entry for
23548 each unique non-automatic variable reference in your program.  GCC
23549 also places floating-point constants in the TOC@.  However, only
23550 16,384 entries are available in the TOC@.
23552 If you receive a linker error message that saying you have overflowed
23553 the available TOC space, you can reduce the amount of TOC space used
23554 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23555 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23556 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23557 generate code to calculate the sum of an address and a constant at
23558 run time instead of putting that sum into the TOC@.  You may specify one
23559 or both of these options.  Each causes GCC to produce very slightly
23560 slower and larger code at the expense of conserving TOC space.
23562 If you still run out of space in the TOC even when you specify both of
23563 these options, specify @option{-mminimal-toc} instead.  This option causes
23564 GCC to make only one TOC entry for every file.  When you specify this
23565 option, GCC produces code that is slower and larger but which
23566 uses extremely little TOC space.  You may wish to use this option
23567 only on files that contain less frequently-executed code.
23569 @item -maix64
23570 @itemx -maix32
23571 @opindex maix64
23572 @opindex maix32
23573 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23574 @code{long} type, and the infrastructure needed to support them.
23575 Specifying @option{-maix64} implies @option{-mpowerpc64},
23576 while @option{-maix32} disables the 64-bit ABI and
23577 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23579 @item -mxl-compat
23580 @itemx -mno-xl-compat
23581 @opindex mxl-compat
23582 @opindex mno-xl-compat
23583 Produce code that conforms more closely to IBM XL compiler semantics
23584 when using AIX-compatible ABI@.  Pass floating-point arguments to
23585 prototyped functions beyond the register save area (RSA) on the stack
23586 in addition to argument FPRs.  Do not assume that most significant
23587 double in 128-bit long double value is properly rounded when comparing
23588 values and converting to double.  Use XL symbol names for long double
23589 support routines.
23591 The AIX calling convention was extended but not initially documented to
23592 handle an obscure K&R C case of calling a function that takes the
23593 address of its arguments with fewer arguments than declared.  IBM XL
23594 compilers access floating-point arguments that do not fit in the
23595 RSA from the stack when a subroutine is compiled without
23596 optimization.  Because always storing floating-point arguments on the
23597 stack is inefficient and rarely needed, this option is not enabled by
23598 default and only is necessary when calling subroutines compiled by IBM
23599 XL compilers without optimization.
23601 @item -mpe
23602 @opindex mpe
23603 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23604 application written to use message passing with special startup code to
23605 enable the application to run.  The system must have PE installed in the
23606 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23607 must be overridden with the @option{-specs=} option to specify the
23608 appropriate directory location.  The Parallel Environment does not
23609 support threads, so the @option{-mpe} option and the @option{-pthread}
23610 option are incompatible.
23612 @item -malign-natural
23613 @itemx -malign-power
23614 @opindex malign-natural
23615 @opindex malign-power
23616 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23617 @option{-malign-natural} overrides the ABI-defined alignment of larger
23618 types, such as floating-point doubles, on their natural size-based boundary.
23619 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23620 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23622 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23623 is not supported.
23625 @item -msoft-float
23626 @itemx -mhard-float
23627 @opindex msoft-float
23628 @opindex mhard-float
23629 Generate code that does not use (uses) the floating-point register set.
23630 Software floating-point emulation is provided if you use the
23631 @option{-msoft-float} option, and pass the option to GCC when linking.
23633 @item -mmultiple
23634 @itemx -mno-multiple
23635 @opindex mmultiple
23636 @opindex mno-multiple
23637 Generate code that uses (does not use) the load multiple word
23638 instructions and the store multiple word instructions.  These
23639 instructions are generated by default on POWER systems, and not
23640 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23641 PowerPC systems, since those instructions do not work when the
23642 processor is in little-endian mode.  The exceptions are PPC740 and
23643 PPC750 which permit these instructions in little-endian mode.
23645 @item -mupdate
23646 @itemx -mno-update
23647 @opindex mupdate
23648 @opindex mno-update
23649 Generate code that uses (does not use) the load or store instructions
23650 that update the base register to the address of the calculated memory
23651 location.  These instructions are generated by default.  If you use
23652 @option{-mno-update}, there is a small window between the time that the
23653 stack pointer is updated and the address of the previous frame is
23654 stored, which means code that walks the stack frame across interrupts or
23655 signals may get corrupted data.
23657 @item -mavoid-indexed-addresses
23658 @itemx -mno-avoid-indexed-addresses
23659 @opindex mavoid-indexed-addresses
23660 @opindex mno-avoid-indexed-addresses
23661 Generate code that tries to avoid (not avoid) the use of indexed load
23662 or store instructions. These instructions can incur a performance
23663 penalty on Power6 processors in certain situations, such as when
23664 stepping through large arrays that cross a 16M boundary.  This option
23665 is enabled by default when targeting Power6 and disabled otherwise.
23667 @item -mfused-madd
23668 @itemx -mno-fused-madd
23669 @opindex mfused-madd
23670 @opindex mno-fused-madd
23671 Generate code that uses (does not use) the floating-point multiply and
23672 accumulate instructions.  These instructions are generated by default
23673 if hardware floating point is used.  The machine-dependent
23674 @option{-mfused-madd} option is now mapped to the machine-independent
23675 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23676 mapped to @option{-ffp-contract=off}.
23678 @item -mmulhw
23679 @itemx -mno-mulhw
23680 @opindex mmulhw
23681 @opindex mno-mulhw
23682 Generate code that uses (does not use) the half-word multiply and
23683 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23684 These instructions are generated by default when targeting those
23685 processors.
23687 @item -mdlmzb
23688 @itemx -mno-dlmzb
23689 @opindex mdlmzb
23690 @opindex mno-dlmzb
23691 Generate code that uses (does not use) the string-search @samp{dlmzb}
23692 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23693 generated by default when targeting those processors.
23695 @item -mno-bit-align
23696 @itemx -mbit-align
23697 @opindex mno-bit-align
23698 @opindex mbit-align
23699 On System V.4 and embedded PowerPC systems do not (do) force structures
23700 and unions that contain bit-fields to be aligned to the base type of the
23701 bit-field.
23703 For example, by default a structure containing nothing but 8
23704 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23705 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23706 the structure is aligned to a 1-byte boundary and is 1 byte in
23707 size.
23709 @item -mno-strict-align
23710 @itemx -mstrict-align
23711 @opindex mno-strict-align
23712 @opindex mstrict-align
23713 On System V.4 and embedded PowerPC systems do not (do) assume that
23714 unaligned memory references are handled by the system.
23716 @item -mrelocatable
23717 @itemx -mno-relocatable
23718 @opindex mrelocatable
23719 @opindex mno-relocatable
23720 Generate code that allows (does not allow) a static executable to be
23721 relocated to a different address at run time.  A simple embedded
23722 PowerPC system loader should relocate the entire contents of
23723 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23724 a table of 32-bit addresses generated by this option.  For this to
23725 work, all objects linked together must be compiled with
23726 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23727 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23729 @item -mrelocatable-lib
23730 @itemx -mno-relocatable-lib
23731 @opindex mrelocatable-lib
23732 @opindex mno-relocatable-lib
23733 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23734 @code{.fixup} section to allow static executables to be relocated at
23735 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23736 alignment of @option{-mrelocatable}.  Objects compiled with
23737 @option{-mrelocatable-lib} may be linked with objects compiled with
23738 any combination of the @option{-mrelocatable} options.
23740 @item -mno-toc
23741 @itemx -mtoc
23742 @opindex mno-toc
23743 @opindex mtoc
23744 On System V.4 and embedded PowerPC systems do not (do) assume that
23745 register 2 contains a pointer to a global area pointing to the addresses
23746 used in the program.
23748 @item -mlittle
23749 @itemx -mlittle-endian
23750 @opindex mlittle
23751 @opindex mlittle-endian
23752 On System V.4 and embedded PowerPC systems compile code for the
23753 processor in little-endian mode.  The @option{-mlittle-endian} option is
23754 the same as @option{-mlittle}.
23756 @item -mbig
23757 @itemx -mbig-endian
23758 @opindex mbig
23759 @opindex mbig-endian
23760 On System V.4 and embedded PowerPC systems compile code for the
23761 processor in big-endian mode.  The @option{-mbig-endian} option is
23762 the same as @option{-mbig}.
23764 @item -mdynamic-no-pic
23765 @opindex mdynamic-no-pic
23766 On Darwin and Mac OS X systems, compile code so that it is not
23767 relocatable, but that its external references are relocatable.  The
23768 resulting code is suitable for applications, but not shared
23769 libraries.
23771 @item -msingle-pic-base
23772 @opindex msingle-pic-base
23773 Treat the register used for PIC addressing as read-only, rather than
23774 loading it in the prologue for each function.  The runtime system is
23775 responsible for initializing this register with an appropriate value
23776 before execution begins.
23778 @item -mprioritize-restricted-insns=@var{priority}
23779 @opindex mprioritize-restricted-insns
23780 This option controls the priority that is assigned to
23781 dispatch-slot restricted instructions during the second scheduling
23782 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23783 or @samp{2} to assign no, highest, or second-highest (respectively) 
23784 priority to dispatch-slot restricted
23785 instructions.
23787 @item -msched-costly-dep=@var{dependence_type}
23788 @opindex msched-costly-dep
23789 This option controls which dependences are considered costly
23790 by the target during instruction scheduling.  The argument
23791 @var{dependence_type} takes one of the following values:
23793 @table @asis
23794 @item @samp{no}
23795 No dependence is costly.
23797 @item @samp{all}
23798 All dependences are costly.
23800 @item @samp{true_store_to_load}
23801 A true dependence from store to load is costly.
23803 @item @samp{store_to_load}
23804 Any dependence from store to load is costly.
23806 @item @var{number}
23807 Any dependence for which the latency is greater than or equal to 
23808 @var{number} is costly.
23809 @end table
23811 @item -minsert-sched-nops=@var{scheme}
23812 @opindex minsert-sched-nops
23813 This option controls which NOP insertion scheme is used during
23814 the second scheduling pass.  The argument @var{scheme} takes one of the
23815 following values:
23817 @table @asis
23818 @item @samp{no}
23819 Don't insert NOPs.
23821 @item @samp{pad}
23822 Pad with NOPs any dispatch group that has vacant issue slots,
23823 according to the scheduler's grouping.
23825 @item @samp{regroup_exact}
23826 Insert NOPs to force costly dependent insns into
23827 separate groups.  Insert exactly as many NOPs as needed to force an insn
23828 to a new group, according to the estimated processor grouping.
23830 @item @var{number}
23831 Insert NOPs to force costly dependent insns into
23832 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23833 @end table
23835 @item -mcall-sysv
23836 @opindex mcall-sysv
23837 On System V.4 and embedded PowerPC systems compile code using calling
23838 conventions that adhere to the March 1995 draft of the System V
23839 Application Binary Interface, PowerPC processor supplement.  This is the
23840 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23842 @item -mcall-sysv-eabi
23843 @itemx -mcall-eabi
23844 @opindex mcall-sysv-eabi
23845 @opindex mcall-eabi
23846 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23848 @item -mcall-sysv-noeabi
23849 @opindex mcall-sysv-noeabi
23850 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23852 @item -mcall-aixdesc
23853 @opindex m
23854 On System V.4 and embedded PowerPC systems compile code for the AIX
23855 operating system.
23857 @item -mcall-linux
23858 @opindex mcall-linux
23859 On System V.4 and embedded PowerPC systems compile code for the
23860 Linux-based GNU system.
23862 @item -mcall-freebsd
23863 @opindex mcall-freebsd
23864 On System V.4 and embedded PowerPC systems compile code for the
23865 FreeBSD operating system.
23867 @item -mcall-netbsd
23868 @opindex mcall-netbsd
23869 On System V.4 and embedded PowerPC systems compile code for the
23870 NetBSD operating system.
23872 @item -mcall-openbsd
23873 @opindex mcall-netbsd
23874 On System V.4 and embedded PowerPC systems compile code for the
23875 OpenBSD operating system.
23877 @item -mtraceback=@var{traceback_type}
23878 @opindex mtraceback
23879 Select the type of traceback table. Valid values for @var{traceback_type}
23880 are @samp{full}, @samp{part}, and @samp{no}.
23882 @item -maix-struct-return
23883 @opindex maix-struct-return
23884 Return all structures in memory (as specified by the AIX ABI)@.
23886 @item -msvr4-struct-return
23887 @opindex msvr4-struct-return
23888 Return structures smaller than 8 bytes in registers (as specified by the
23889 SVR4 ABI)@.
23891 @item -mabi=@var{abi-type}
23892 @opindex mabi
23893 Extend the current ABI with a particular extension, or remove such extension.
23894 Valid values are @samp{altivec}, @samp{no-altivec},
23895 @samp{ibmlongdouble}, @samp{ieeelongdouble},
23896 @samp{elfv1}, @samp{elfv2}@.
23898 @item -mabi=ibmlongdouble
23899 @opindex mabi=ibmlongdouble
23900 Change the current ABI to use IBM extended-precision long double.
23901 This is not likely to work if your system defaults to using IEEE
23902 extended-precision long double.  If you change the long double type
23903 from IEEE extended-precision, the compiler will issue a warning unless
23904 you use the @option{-Wno-psabi} option.
23906 @item -mabi=ieeelongdouble
23907 @opindex mabi=ieeelongdouble
23908 Change the current ABI to use IEEE extended-precision long double.
23909 This is not likely to work if your system defaults to using IBM
23910 extended-precision long double.  If you change the long double type
23911 from IBM extended-precision, the compiler will issue a warning unless
23912 you use the @option{-Wno-psabi} option.
23914 @item -mabi=elfv1
23915 @opindex mabi=elfv1
23916 Change the current ABI to use the ELFv1 ABI.
23917 This is the default ABI for big-endian PowerPC 64-bit Linux.
23918 Overriding the default ABI requires special system support and is
23919 likely to fail in spectacular ways.
23921 @item -mabi=elfv2
23922 @opindex mabi=elfv2
23923 Change the current ABI to use the ELFv2 ABI.
23924 This is the default ABI for little-endian PowerPC 64-bit Linux.
23925 Overriding the default ABI requires special system support and is
23926 likely to fail in spectacular ways.
23928 @item -mgnu-attribute
23929 @itemx -mno-gnu-attribute
23930 @opindex mgnu-attribute
23931 @opindex mno-gnu-attribute
23932 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23933 .gnu.attributes section that specify ABI variations in function
23934 parameters or return values.
23936 @item -mprototype
23937 @itemx -mno-prototype
23938 @opindex mprototype
23939 @opindex mno-prototype
23940 On System V.4 and embedded PowerPC systems assume that all calls to
23941 variable argument functions are properly prototyped.  Otherwise, the
23942 compiler must insert an instruction before every non-prototyped call to
23943 set or clear bit 6 of the condition code register (@code{CR}) to
23944 indicate whether floating-point values are passed in the floating-point
23945 registers in case the function takes variable arguments.  With
23946 @option{-mprototype}, only calls to prototyped variable argument functions
23947 set or clear the bit.
23949 @item -msim
23950 @opindex msim
23951 On embedded PowerPC systems, assume that the startup module is called
23952 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23953 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23954 configurations.
23956 @item -mmvme
23957 @opindex mmvme
23958 On embedded PowerPC systems, assume that the startup module is called
23959 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23960 @file{libc.a}.
23962 @item -mads
23963 @opindex mads
23964 On embedded PowerPC systems, assume that the startup module is called
23965 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23966 @file{libc.a}.
23968 @item -myellowknife
23969 @opindex myellowknife
23970 On embedded PowerPC systems, assume that the startup module is called
23971 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
23972 @file{libc.a}.
23974 @item -mvxworks
23975 @opindex mvxworks
23976 On System V.4 and embedded PowerPC systems, specify that you are
23977 compiling for a VxWorks system.
23979 @item -memb
23980 @opindex memb
23981 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23982 header to indicate that @samp{eabi} extended relocations are used.
23984 @item -meabi
23985 @itemx -mno-eabi
23986 @opindex meabi
23987 @opindex mno-eabi
23988 On System V.4 and embedded PowerPC systems do (do not) adhere to the
23989 Embedded Applications Binary Interface (EABI), which is a set of
23990 modifications to the System V.4 specifications.  Selecting @option{-meabi}
23991 means that the stack is aligned to an 8-byte boundary, a function
23992 @code{__eabi} is called from @code{main} to set up the EABI
23993 environment, and the @option{-msdata} option can use both @code{r2} and
23994 @code{r13} to point to two separate small data areas.  Selecting
23995 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
23996 no EABI initialization function is called from @code{main}, and the
23997 @option{-msdata} option only uses @code{r13} to point to a single
23998 small data area.  The @option{-meabi} option is on by default if you
23999 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24001 @item -msdata=eabi
24002 @opindex msdata=eabi
24003 On System V.4 and embedded PowerPC systems, put small initialized
24004 @code{const} global and static data in the @code{.sdata2} section, which
24005 is pointed to by register @code{r2}.  Put small initialized
24006 non-@code{const} global and static data in the @code{.sdata} section,
24007 which is pointed to by register @code{r13}.  Put small uninitialized
24008 global and static data in the @code{.sbss} section, which is adjacent to
24009 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24010 incompatible with the @option{-mrelocatable} option.  The
24011 @option{-msdata=eabi} option also sets the @option{-memb} option.
24013 @item -msdata=sysv
24014 @opindex msdata=sysv
24015 On System V.4 and embedded PowerPC systems, put small global and static
24016 data in the @code{.sdata} section, which is pointed to by register
24017 @code{r13}.  Put small uninitialized global and static data in the
24018 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24019 The @option{-msdata=sysv} option is incompatible with the
24020 @option{-mrelocatable} option.
24022 @item -msdata=default
24023 @itemx -msdata
24024 @opindex msdata=default
24025 @opindex msdata
24026 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24027 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24028 same as @option{-msdata=sysv}.
24030 @item -msdata=data
24031 @opindex msdata=data
24032 On System V.4 and embedded PowerPC systems, put small global
24033 data in the @code{.sdata} section.  Put small uninitialized global
24034 data in the @code{.sbss} section.  Do not use register @code{r13}
24035 to address small data however.  This is the default behavior unless
24036 other @option{-msdata} options are used.
24038 @item -msdata=none
24039 @itemx -mno-sdata
24040 @opindex msdata=none
24041 @opindex mno-sdata
24042 On embedded PowerPC systems, put all initialized global and static data
24043 in the @code{.data} section, and all uninitialized data in the
24044 @code{.bss} section.
24046 @item -mreadonly-in-sdata
24047 @opindex mreadonly-in-sdata
24048 @opindex mno-readonly-in-sdata
24049 Put read-only objects in the @code{.sdata} section as well.  This is the
24050 default.
24052 @item -mblock-move-inline-limit=@var{num}
24053 @opindex mblock-move-inline-limit
24054 Inline all block moves (such as calls to @code{memcpy} or structure
24055 copies) less than or equal to @var{num} bytes.  The minimum value for
24056 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24057 targets.  The default value is target-specific.
24059 @item -mblock-compare-inline-limit=@var{num}
24060 @opindex mblock-compare-inline-limit
24061 Generate non-looping inline code for all block compares (such as calls
24062 to @code{memcmp} or structure compares) less than or equal to @var{num}
24063 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24064 block compare is disabled. The default value is target-specific.
24066 @item -mblock-compare-inline-loop-limit=@var{num}
24067 @opindex mblock-compare-inline-loop-limit
24068 Generate an inline expansion using loop code for all block compares that
24069 are less than or equal to @var{num} bytes, but greater than the limit
24070 for non-loop inline block compare expansion. If the block length is not
24071 constant, at most @var{num} bytes will be compared before @code{memcmp}
24072 is called to compare the remainder of the block. The default value is
24073 target-specific.
24075 @item -mstring-compare-inline-limit=@var{num}
24076 @opindex mstring-compare-inline-limit
24077 Generate at most @var{num} pairs of load instructions to compare the
24078 string inline. If the difference or end of string is not found at the
24079 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24080 take care of the rest of the comparison. The default is 8 pairs of
24081 loads, which will compare 64 bytes on a 64-bit target and 32 bytes on a
24082 32-bit target.
24084 @item -G @var{num}
24085 @opindex G
24086 @cindex smaller data references (PowerPC)
24087 @cindex .sdata/.sdata2 references (PowerPC)
24088 On embedded PowerPC systems, put global and static items less than or
24089 equal to @var{num} bytes into the small data or BSS sections instead of
24090 the normal data or BSS section.  By default, @var{num} is 8.  The
24091 @option{-G @var{num}} switch is also passed to the linker.
24092 All modules should be compiled with the same @option{-G @var{num}} value.
24094 @item -mregnames
24095 @itemx -mno-regnames
24096 @opindex mregnames
24097 @opindex mno-regnames
24098 On System V.4 and embedded PowerPC systems do (do not) emit register
24099 names in the assembly language output using symbolic forms.
24101 @item -mlongcall
24102 @itemx -mno-longcall
24103 @opindex mlongcall
24104 @opindex mno-longcall
24105 By default assume that all calls are far away so that a longer and more
24106 expensive calling sequence is required.  This is required for calls
24107 farther than 32 megabytes (33,554,432 bytes) from the current location.
24108 A short call is generated if the compiler knows
24109 the call cannot be that far away.  This setting can be overridden by
24110 the @code{shortcall} function attribute, or by @code{#pragma
24111 longcall(0)}.
24113 Some linkers are capable of detecting out-of-range calls and generating
24114 glue code on the fly.  On these systems, long calls are unnecessary and
24115 generate slower code.  As of this writing, the AIX linker can do this,
24116 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24117 to the GNU linker for 32-bit PowerPC systems as well.
24119 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24120 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24121 addresses represent the callee and the branch island.  The
24122 Darwin/PPC linker prefers the first address and generates a @code{bl
24123 callee} if the PPC @code{bl} instruction reaches the callee directly;
24124 otherwise, the linker generates @code{bl L42} to call the branch
24125 island.  The branch island is appended to the body of the
24126 calling function; it computes the full 32-bit address of the callee
24127 and jumps to it.
24129 On Mach-O (Darwin) systems, this option directs the compiler emit to
24130 the glue for every direct call, and the Darwin linker decides whether
24131 to use or discard it.
24133 In the future, GCC may ignore all longcall specifications
24134 when the linker is known to generate glue.
24136 @item -mtls-markers
24137 @itemx -mno-tls-markers
24138 @opindex mtls-markers
24139 @opindex mno-tls-markers
24140 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24141 specifying the function argument.  The relocation allows the linker to
24142 reliably associate function call with argument setup instructions for
24143 TLS optimization, which in turn allows GCC to better schedule the
24144 sequence.
24146 @item -mrecip
24147 @itemx -mno-recip
24148 @opindex mrecip
24149 This option enables use of the reciprocal estimate and
24150 reciprocal square root estimate instructions with additional
24151 Newton-Raphson steps to increase precision instead of doing a divide or
24152 square root and divide for floating-point arguments.  You should use
24153 the @option{-ffast-math} option when using @option{-mrecip} (or at
24154 least @option{-funsafe-math-optimizations},
24155 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24156 @option{-fno-trapping-math}).  Note that while the throughput of the
24157 sequence is generally higher than the throughput of the non-reciprocal
24158 instruction, the precision of the sequence can be decreased by up to 2
24159 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24160 roots.
24162 @item -mrecip=@var{opt}
24163 @opindex mrecip=opt
24164 This option controls which reciprocal estimate instructions
24165 may be used.  @var{opt} is a comma-separated list of options, which may
24166 be preceded by a @code{!} to invert the option:
24168 @table @samp
24170 @item all
24171 Enable all estimate instructions.
24173 @item default 
24174 Enable the default instructions, equivalent to @option{-mrecip}.
24176 @item none 
24177 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24179 @item div 
24180 Enable the reciprocal approximation instructions for both 
24181 single and double precision.
24183 @item divf 
24184 Enable the single-precision reciprocal approximation instructions.
24186 @item divd 
24187 Enable the double-precision reciprocal approximation instructions.
24189 @item rsqrt 
24190 Enable the reciprocal square root approximation instructions for both
24191 single and double precision.
24193 @item rsqrtf 
24194 Enable the single-precision reciprocal square root approximation instructions.
24196 @item rsqrtd 
24197 Enable the double-precision reciprocal square root approximation instructions.
24199 @end table
24201 So, for example, @option{-mrecip=all,!rsqrtd} enables
24202 all of the reciprocal estimate instructions, except for the
24203 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24204 which handle the double-precision reciprocal square root calculations.
24206 @item -mrecip-precision
24207 @itemx -mno-recip-precision
24208 @opindex mrecip-precision
24209 Assume (do not assume) that the reciprocal estimate instructions
24210 provide higher-precision estimates than is mandated by the PowerPC
24211 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24212 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24213 The double-precision square root estimate instructions are not generated by
24214 default on low-precision machines, since they do not provide an
24215 estimate that converges after three steps.
24217 @item -mveclibabi=@var{type}
24218 @opindex mveclibabi
24219 Specifies the ABI type to use for vectorizing intrinsics using an
24220 external library.  The only type supported at present is @samp{mass},
24221 which specifies to use IBM's Mathematical Acceleration Subsystem
24222 (MASS) libraries for vectorizing intrinsics using external libraries.
24223 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24224 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24225 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24226 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24227 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24228 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24229 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24230 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24231 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24232 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24233 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24234 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24235 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24236 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24237 for power7.  Both @option{-ftree-vectorize} and
24238 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24239 libraries must be specified at link time.
24241 @item -mfriz
24242 @itemx -mno-friz
24243 @opindex mfriz
24244 Generate (do not generate) the @code{friz} instruction when the
24245 @option{-funsafe-math-optimizations} option is used to optimize
24246 rounding of floating-point values to 64-bit integer and back to floating
24247 point.  The @code{friz} instruction does not return the same value if
24248 the floating-point number is too large to fit in an integer.
24250 @item -mpointers-to-nested-functions
24251 @itemx -mno-pointers-to-nested-functions
24252 @opindex mpointers-to-nested-functions
24253 Generate (do not generate) code to load up the static chain register
24254 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24255 systems where a function pointer points to a 3-word descriptor giving
24256 the function address, TOC value to be loaded in register @code{r2}, and
24257 static chain value to be loaded in register @code{r11}.  The
24258 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24259 call through pointers to nested functions or pointers
24260 to functions compiled in other languages that use the static chain if
24261 you use @option{-mno-pointers-to-nested-functions}.
24263 @item -msave-toc-indirect
24264 @itemx -mno-save-toc-indirect
24265 @opindex msave-toc-indirect
24266 Generate (do not generate) code to save the TOC value in the reserved
24267 stack location in the function prologue if the function calls through
24268 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24269 saved in the prologue, it is saved just before the call through the
24270 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24272 @item -mcompat-align-parm
24273 @itemx -mno-compat-align-parm
24274 @opindex mcompat-align-parm
24275 Generate (do not generate) code to pass structure parameters with a
24276 maximum alignment of 64 bits, for compatibility with older versions
24277 of GCC.
24279 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24280 structure parameter on a 128-bit boundary when that structure contained
24281 a member requiring 128-bit alignment.  This is corrected in more
24282 recent versions of GCC.  This option may be used to generate code
24283 that is compatible with functions compiled with older versions of
24284 GCC.
24286 The @option{-mno-compat-align-parm} option is the default.
24288 @item -mstack-protector-guard=@var{guard}
24289 @itemx -mstack-protector-guard-reg=@var{reg}
24290 @itemx -mstack-protector-guard-offset=@var{offset}
24291 @itemx -mstack-protector-guard-symbol=@var{symbol}
24292 @opindex mstack-protector-guard
24293 @opindex mstack-protector-guard-reg
24294 @opindex mstack-protector-guard-offset
24295 @opindex mstack-protector-guard-symbol
24296 Generate stack protection code using canary at @var{guard}.  Supported
24297 locations are @samp{global} for global canary or @samp{tls} for per-thread
24298 canary in the TLS block (the default with GNU libc version 2.4 or later).
24300 With the latter choice the options
24301 @option{-mstack-protector-guard-reg=@var{reg}} and
24302 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24303 which register to use as base register for reading the canary, and from what
24304 offset from that base register. The default for those is as specified in the
24305 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24306 the offset with a symbol reference to a canary in the TLS block.
24307 @end table
24309 @node RX Options
24310 @subsection RX Options
24311 @cindex RX Options
24313 These command-line options are defined for RX targets:
24315 @table @gcctabopt
24316 @item -m64bit-doubles
24317 @itemx -m32bit-doubles
24318 @opindex m64bit-doubles
24319 @opindex m32bit-doubles
24320 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24321 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24322 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24323 works on 32-bit values, which is why the default is
24324 @option{-m32bit-doubles}.
24326 @item -fpu
24327 @itemx -nofpu
24328 @opindex fpu
24329 @opindex nofpu
24330 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24331 floating-point hardware.  The default is enabled for the RX600
24332 series and disabled for the RX200 series.
24334 Floating-point instructions are only generated for 32-bit floating-point 
24335 values, however, so the FPU hardware is not used for doubles if the
24336 @option{-m64bit-doubles} option is used.
24338 @emph{Note} If the @option{-fpu} option is enabled then
24339 @option{-funsafe-math-optimizations} is also enabled automatically.
24340 This is because the RX FPU instructions are themselves unsafe.
24342 @item -mcpu=@var{name}
24343 @opindex mcpu
24344 Selects the type of RX CPU to be targeted.  Currently three types are
24345 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24346 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24348 The only difference between @samp{RX600} and @samp{RX610} is that the
24349 @samp{RX610} does not support the @code{MVTIPL} instruction.
24351 The @samp{RX200} series does not have a hardware floating-point unit
24352 and so @option{-nofpu} is enabled by default when this type is
24353 selected.
24355 @item -mbig-endian-data
24356 @itemx -mlittle-endian-data
24357 @opindex mbig-endian-data
24358 @opindex mlittle-endian-data
24359 Store data (but not code) in the big-endian format.  The default is
24360 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24361 format.
24363 @item -msmall-data-limit=@var{N}
24364 @opindex msmall-data-limit
24365 Specifies the maximum size in bytes of global and static variables
24366 which can be placed into the small data area.  Using the small data
24367 area can lead to smaller and faster code, but the size of area is
24368 limited and it is up to the programmer to ensure that the area does
24369 not overflow.  Also when the small data area is used one of the RX's
24370 registers (usually @code{r13}) is reserved for use pointing to this
24371 area, so it is no longer available for use by the compiler.  This
24372 could result in slower and/or larger code if variables are pushed onto
24373 the stack instead of being held in this register.
24375 Note, common variables (variables that have not been initialized) and
24376 constants are not placed into the small data area as they are assigned
24377 to other sections in the output executable.
24379 The default value is zero, which disables this feature.  Note, this
24380 feature is not enabled by default with higher optimization levels
24381 (@option{-O2} etc) because of the potentially detrimental effects of
24382 reserving a register.  It is up to the programmer to experiment and
24383 discover whether this feature is of benefit to their program.  See the
24384 description of the @option{-mpid} option for a description of how the
24385 actual register to hold the small data area pointer is chosen.
24387 @item -msim
24388 @itemx -mno-sim
24389 @opindex msim
24390 @opindex mno-sim
24391 Use the simulator runtime.  The default is to use the libgloss
24392 board-specific runtime.
24394 @item -mas100-syntax
24395 @itemx -mno-as100-syntax
24396 @opindex mas100-syntax
24397 @opindex mno-as100-syntax
24398 When generating assembler output use a syntax that is compatible with
24399 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24400 assembler, but it has some restrictions so it is not generated by default.
24402 @item -mmax-constant-size=@var{N}
24403 @opindex mmax-constant-size
24404 Specifies the maximum size, in bytes, of a constant that can be used as
24405 an operand in a RX instruction.  Although the RX instruction set does
24406 allow constants of up to 4 bytes in length to be used in instructions,
24407 a longer value equates to a longer instruction.  Thus in some
24408 circumstances it can be beneficial to restrict the size of constants
24409 that are used in instructions.  Constants that are too big are instead
24410 placed into a constant pool and referenced via register indirection.
24412 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24413 or 4 means that constants of any size are allowed.
24415 @item -mrelax
24416 @opindex mrelax
24417 Enable linker relaxation.  Linker relaxation is a process whereby the
24418 linker attempts to reduce the size of a program by finding shorter
24419 versions of various instructions.  Disabled by default.
24421 @item -mint-register=@var{N}
24422 @opindex mint-register
24423 Specify the number of registers to reserve for fast interrupt handler
24424 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24425 means that register @code{r13} is reserved for the exclusive use
24426 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24427 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24428 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24429 A value of 0, the default, does not reserve any registers.
24431 @item -msave-acc-in-interrupts
24432 @opindex msave-acc-in-interrupts
24433 Specifies that interrupt handler functions should preserve the
24434 accumulator register.  This is only necessary if normal code might use
24435 the accumulator register, for example because it performs 64-bit
24436 multiplications.  The default is to ignore the accumulator as this
24437 makes the interrupt handlers faster.
24439 @item -mpid
24440 @itemx -mno-pid
24441 @opindex mpid
24442 @opindex mno-pid
24443 Enables the generation of position independent data.  When enabled any
24444 access to constant data is done via an offset from a base address
24445 held in a register.  This allows the location of constant data to be
24446 determined at run time without requiring the executable to be
24447 relocated, which is a benefit to embedded applications with tight
24448 memory constraints.  Data that can be modified is not affected by this
24449 option.
24451 Note, using this feature reserves a register, usually @code{r13}, for
24452 the constant data base address.  This can result in slower and/or
24453 larger code, especially in complicated functions.
24455 The actual register chosen to hold the constant data base address
24456 depends upon whether the @option{-msmall-data-limit} and/or the
24457 @option{-mint-register} command-line options are enabled.  Starting
24458 with register @code{r13} and proceeding downwards, registers are
24459 allocated first to satisfy the requirements of @option{-mint-register},
24460 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24461 is possible for the small data area register to be @code{r8} if both
24462 @option{-mint-register=4} and @option{-mpid} are specified on the
24463 command line.
24465 By default this feature is not enabled.  The default can be restored
24466 via the @option{-mno-pid} command-line option.
24468 @item -mno-warn-multiple-fast-interrupts
24469 @itemx -mwarn-multiple-fast-interrupts
24470 @opindex mno-warn-multiple-fast-interrupts
24471 @opindex mwarn-multiple-fast-interrupts
24472 Prevents GCC from issuing a warning message if it finds more than one
24473 fast interrupt handler when it is compiling a file.  The default is to
24474 issue a warning for each extra fast interrupt handler found, as the RX
24475 only supports one such interrupt.
24477 @item -mallow-string-insns
24478 @itemx -mno-allow-string-insns
24479 @opindex mallow-string-insns
24480 @opindex mno-allow-string-insns
24481 Enables or disables the use of the string manipulation instructions
24482 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24483 @code{SWHILE} and also the @code{RMPA} instruction.  These
24484 instructions may prefetch data, which is not safe to do if accessing
24485 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24486 for more information).
24488 The default is to allow these instructions, but it is not possible for
24489 GCC to reliably detect all circumstances where a string instruction
24490 might be used to access an I/O register, so their use cannot be
24491 disabled automatically.  Instead it is reliant upon the programmer to
24492 use the @option{-mno-allow-string-insns} option if their program
24493 accesses I/O space.
24495 When the instructions are enabled GCC defines the C preprocessor
24496 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24497 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24499 @item -mjsr
24500 @itemx -mno-jsr
24501 @opindex mjsr
24502 @opindex mno-jsr
24503 Use only (or not only) @code{JSR} instructions to access functions.
24504 This option can be used when code size exceeds the range of @code{BSR}
24505 instructions.  Note that @option{-mno-jsr} does not mean to not use
24506 @code{JSR} but instead means that any type of branch may be used.
24507 @end table
24509 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24510 has special significance to the RX port when used with the
24511 @code{interrupt} function attribute.  This attribute indicates a
24512 function intended to process fast interrupts.  GCC ensures
24513 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24514 and/or @code{r13} and only provided that the normal use of the
24515 corresponding registers have been restricted via the
24516 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24517 options.
24519 @node S/390 and zSeries Options
24520 @subsection S/390 and zSeries Options
24521 @cindex S/390 and zSeries Options
24523 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24525 @table @gcctabopt
24526 @item -mhard-float
24527 @itemx -msoft-float
24528 @opindex mhard-float
24529 @opindex msoft-float
24530 Use (do not use) the hardware floating-point instructions and registers
24531 for floating-point operations.  When @option{-msoft-float} is specified,
24532 functions in @file{libgcc.a} are used to perform floating-point
24533 operations.  When @option{-mhard-float} is specified, the compiler
24534 generates IEEE floating-point instructions.  This is the default.
24536 @item -mhard-dfp
24537 @itemx -mno-hard-dfp
24538 @opindex mhard-dfp
24539 @opindex mno-hard-dfp
24540 Use (do not use) the hardware decimal-floating-point instructions for
24541 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24542 specified, functions in @file{libgcc.a} are used to perform
24543 decimal-floating-point operations.  When @option{-mhard-dfp} is
24544 specified, the compiler generates decimal-floating-point hardware
24545 instructions.  This is the default for @option{-march=z9-ec} or higher.
24547 @item -mlong-double-64
24548 @itemx -mlong-double-128
24549 @opindex mlong-double-64
24550 @opindex mlong-double-128
24551 These switches control the size of @code{long double} type. A size
24552 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24553 type. This is the default.
24555 @item -mbackchain
24556 @itemx -mno-backchain
24557 @opindex mbackchain
24558 @opindex mno-backchain
24559 Store (do not store) the address of the caller's frame as backchain pointer
24560 into the callee's stack frame.
24561 A backchain may be needed to allow debugging using tools that do not understand
24562 DWARF call frame information.
24563 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24564 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24565 the backchain is placed into the topmost word of the 96/160 byte register
24566 save area.
24568 In general, code compiled with @option{-mbackchain} is call-compatible with
24569 code compiled with @option{-mmo-backchain}; however, use of the backchain
24570 for debugging purposes usually requires that the whole binary is built with
24571 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24572 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24573 to build a linux kernel use @option{-msoft-float}.
24575 The default is to not maintain the backchain.
24577 @item -mpacked-stack
24578 @itemx -mno-packed-stack
24579 @opindex mpacked-stack
24580 @opindex mno-packed-stack
24581 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24582 specified, the compiler uses the all fields of the 96/160 byte register save
24583 area only for their default purpose; unused fields still take up stack space.
24584 When @option{-mpacked-stack} is specified, register save slots are densely
24585 packed at the top of the register save area; unused space is reused for other
24586 purposes, allowing for more efficient use of the available stack space.
24587 However, when @option{-mbackchain} is also in effect, the topmost word of
24588 the save area is always used to store the backchain, and the return address
24589 register is always saved two words below the backchain.
24591 As long as the stack frame backchain is not used, code generated with
24592 @option{-mpacked-stack} is call-compatible with code generated with
24593 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24594 S/390 or zSeries generated code that uses the stack frame backchain at run
24595 time, not just for debugging purposes.  Such code is not call-compatible
24596 with code compiled with @option{-mpacked-stack}.  Also, note that the
24597 combination of @option{-mbackchain},
24598 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24599 to build a linux kernel use @option{-msoft-float}.
24601 The default is to not use the packed stack layout.
24603 @item -msmall-exec
24604 @itemx -mno-small-exec
24605 @opindex msmall-exec
24606 @opindex mno-small-exec
24607 Generate (or do not generate) code using the @code{bras} instruction
24608 to do subroutine calls.
24609 This only works reliably if the total executable size does not
24610 exceed 64k.  The default is to use the @code{basr} instruction instead,
24611 which does not have this limitation.
24613 @item -m64
24614 @itemx -m31
24615 @opindex m64
24616 @opindex m31
24617 When @option{-m31} is specified, generate code compliant to the
24618 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24619 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24620 particular to generate 64-bit instructions.  For the @samp{s390}
24621 targets, the default is @option{-m31}, while the @samp{s390x}
24622 targets default to @option{-m64}.
24624 @item -mzarch
24625 @itemx -mesa
24626 @opindex mzarch
24627 @opindex mesa
24628 When @option{-mzarch} is specified, generate code using the
24629 instructions available on z/Architecture.
24630 When @option{-mesa} is specified, generate code using the
24631 instructions available on ESA/390.  Note that @option{-mesa} is
24632 not possible with @option{-m64}.
24633 When generating code compliant to the GNU/Linux for S/390 ABI,
24634 the default is @option{-mesa}.  When generating code compliant
24635 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24637 @item -mhtm
24638 @itemx -mno-htm
24639 @opindex mhtm
24640 @opindex mno-htm
24641 The @option{-mhtm} option enables a set of builtins making use of
24642 instructions available with the transactional execution facility
24643 introduced with the IBM zEnterprise EC12 machine generation
24644 @ref{S/390 System z Built-in Functions}.
24645 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24647 @item -mvx
24648 @itemx -mno-vx
24649 @opindex mvx
24650 @opindex mno-vx
24651 When @option{-mvx} is specified, generate code using the instructions
24652 available with the vector extension facility introduced with the IBM
24653 z13 machine generation.
24654 This option changes the ABI for some vector type values with regard to
24655 alignment and calling conventions.  In case vector type values are
24656 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24657 command will be added to mark the resulting binary with the ABI used.
24658 @option{-mvx} is enabled by default when using @option{-march=z13}.
24660 @item -mzvector
24661 @itemx -mno-zvector
24662 @opindex mzvector
24663 @opindex mno-zvector
24664 The @option{-mzvector} option enables vector language extensions and
24665 builtins using instructions available with the vector extension
24666 facility introduced with the IBM z13 machine generation.
24667 This option adds support for @samp{vector} to be used as a keyword to
24668 define vector type variables and arguments.  @samp{vector} is only
24669 available when GNU extensions are enabled.  It will not be expanded
24670 when requesting strict standard compliance e.g. with @option{-std=c99}.
24671 In addition to the GCC low-level builtins @option{-mzvector} enables
24672 a set of builtins added for compatibility with AltiVec-style
24673 implementations like Power and Cell.  In order to make use of these
24674 builtins the header file @file{vecintrin.h} needs to be included.
24675 @option{-mzvector} is disabled by default.
24677 @item -mmvcle
24678 @itemx -mno-mvcle
24679 @opindex mmvcle
24680 @opindex mno-mvcle
24681 Generate (or do not generate) code using the @code{mvcle} instruction
24682 to perform block moves.  When @option{-mno-mvcle} is specified,
24683 use a @code{mvc} loop instead.  This is the default unless optimizing for
24684 size.
24686 @item -mdebug
24687 @itemx -mno-debug
24688 @opindex mdebug
24689 @opindex mno-debug
24690 Print (or do not print) additional debug information when compiling.
24691 The default is to not print debug information.
24693 @item -march=@var{cpu-type}
24694 @opindex march
24695 Generate code that runs on @var{cpu-type}, which is the name of a
24696 system representing a certain processor type.  Possible values for
24697 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24698 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24699 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24700 @samp{native}.
24702 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24703 @samp{g6} are deprecated and will be removed with future releases.
24705 Specifying @samp{native} as cpu type can be used to select the best
24706 architecture option for the host processor.
24707 @option{-march=native} has no effect if GCC does not recognize the
24708 processor.
24710 @item -mtune=@var{cpu-type}
24711 @opindex mtune
24712 Tune to @var{cpu-type} everything applicable about the generated code,
24713 except for the ABI and the set of available instructions.
24714 The list of @var{cpu-type} values is the same as for @option{-march}.
24715 The default is the value used for @option{-march}.
24717 @item -mtpf-trace
24718 @itemx -mno-tpf-trace
24719 @opindex mtpf-trace
24720 @opindex mno-tpf-trace
24721 Generate code that adds (does not add) in TPF OS specific branches to trace
24722 routines in the operating system.  This option is off by default, even
24723 when compiling for the TPF OS@.
24725 @item -mfused-madd
24726 @itemx -mno-fused-madd
24727 @opindex mfused-madd
24728 @opindex mno-fused-madd
24729 Generate code that uses (does not use) the floating-point multiply and
24730 accumulate instructions.  These instructions are generated by default if
24731 hardware floating point is used.
24733 @item -mwarn-framesize=@var{framesize}
24734 @opindex mwarn-framesize
24735 Emit a warning if the current function exceeds the given frame size.  Because
24736 this is a compile-time check it doesn't need to be a real problem when the program
24737 runs.  It is intended to identify functions that most probably cause
24738 a stack overflow.  It is useful to be used in an environment with limited stack
24739 size e.g.@: the linux kernel.
24741 @item -mwarn-dynamicstack
24742 @opindex mwarn-dynamicstack
24743 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24744 arrays.  This is generally a bad idea with a limited stack size.
24746 @item -mstack-guard=@var{stack-guard}
24747 @itemx -mstack-size=@var{stack-size}
24748 @opindex mstack-guard
24749 @opindex mstack-size
24750 If these options are provided the S/390 back end emits additional instructions in
24751 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24752 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24753 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24754 the frame size of the compiled function is chosen.
24755 These options are intended to be used to help debugging stack overflow problems.
24756 The additionally emitted code causes only little overhead and hence can also be
24757 used in production-like systems without greater performance degradation.  The given
24758 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24759 @var{stack-guard} without exceeding 64k.
24760 In order to be efficient the extra code makes the assumption that the stack starts
24761 at an address aligned to the value given by @var{stack-size}.
24762 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24764 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24765 @opindex mhotpatch
24766 If the hotpatch option is enabled, a ``hot-patching'' function
24767 prologue is generated for all functions in the compilation unit.
24768 The funtion label is prepended with the given number of two-byte
24769 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24770 the label, 2 * @var{post-halfwords} bytes are appended, using the
24771 largest NOP like instructions the architecture allows (maximum
24772 1000000).
24774 If both arguments are zero, hotpatching is disabled.
24776 This option can be overridden for individual functions with the
24777 @code{hotpatch} attribute.
24778 @end table
24780 @node Score Options
24781 @subsection Score Options
24782 @cindex Score Options
24784 These options are defined for Score implementations:
24786 @table @gcctabopt
24787 @item -meb
24788 @opindex meb
24789 Compile code for big-endian mode.  This is the default.
24791 @item -mel
24792 @opindex mel
24793 Compile code for little-endian mode.
24795 @item -mnhwloop
24796 @opindex mnhwloop
24797 Disable generation of @code{bcnz} instructions.
24799 @item -muls
24800 @opindex muls
24801 Enable generation of unaligned load and store instructions.
24803 @item -mmac
24804 @opindex mmac
24805 Enable the use of multiply-accumulate instructions. Disabled by default.
24807 @item -mscore5
24808 @opindex mscore5
24809 Specify the SCORE5 as the target architecture.
24811 @item -mscore5u
24812 @opindex mscore5u
24813 Specify the SCORE5U of the target architecture.
24815 @item -mscore7
24816 @opindex mscore7
24817 Specify the SCORE7 as the target architecture. This is the default.
24819 @item -mscore7d
24820 @opindex mscore7d
24821 Specify the SCORE7D as the target architecture.
24822 @end table
24824 @node SH Options
24825 @subsection SH Options
24827 These @samp{-m} options are defined for the SH implementations:
24829 @table @gcctabopt
24830 @item -m1
24831 @opindex m1
24832 Generate code for the SH1.
24834 @item -m2
24835 @opindex m2
24836 Generate code for the SH2.
24838 @item -m2e
24839 Generate code for the SH2e.
24841 @item -m2a-nofpu
24842 @opindex m2a-nofpu
24843 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24844 that the floating-point unit is not used.
24846 @item -m2a-single-only
24847 @opindex m2a-single-only
24848 Generate code for the SH2a-FPU, in such a way that no double-precision
24849 floating-point operations are used.
24851 @item -m2a-single
24852 @opindex m2a-single
24853 Generate code for the SH2a-FPU assuming the floating-point unit is in
24854 single-precision mode by default.
24856 @item -m2a
24857 @opindex m2a
24858 Generate code for the SH2a-FPU assuming the floating-point unit is in
24859 double-precision mode by default.
24861 @item -m3
24862 @opindex m3
24863 Generate code for the SH3.
24865 @item -m3e
24866 @opindex m3e
24867 Generate code for the SH3e.
24869 @item -m4-nofpu
24870 @opindex m4-nofpu
24871 Generate code for the SH4 without a floating-point unit.
24873 @item -m4-single-only
24874 @opindex m4-single-only
24875 Generate code for the SH4 with a floating-point unit that only
24876 supports single-precision arithmetic.
24878 @item -m4-single
24879 @opindex m4-single
24880 Generate code for the SH4 assuming the floating-point unit is in
24881 single-precision mode by default.
24883 @item -m4
24884 @opindex m4
24885 Generate code for the SH4.
24887 @item -m4-100
24888 @opindex m4-100
24889 Generate code for SH4-100.
24891 @item -m4-100-nofpu
24892 @opindex m4-100-nofpu
24893 Generate code for SH4-100 in such a way that the
24894 floating-point unit is not used.
24896 @item -m4-100-single
24897 @opindex m4-100-single
24898 Generate code for SH4-100 assuming the floating-point unit is in
24899 single-precision mode by default.
24901 @item -m4-100-single-only
24902 @opindex m4-100-single-only
24903 Generate code for SH4-100 in such a way that no double-precision
24904 floating-point operations are used.
24906 @item -m4-200
24907 @opindex m4-200
24908 Generate code for SH4-200.
24910 @item -m4-200-nofpu
24911 @opindex m4-200-nofpu
24912 Generate code for SH4-200 without in such a way that the
24913 floating-point unit is not used.
24915 @item -m4-200-single
24916 @opindex m4-200-single
24917 Generate code for SH4-200 assuming the floating-point unit is in
24918 single-precision mode by default.
24920 @item -m4-200-single-only
24921 @opindex m4-200-single-only
24922 Generate code for SH4-200 in such a way that no double-precision
24923 floating-point operations are used.
24925 @item -m4-300
24926 @opindex m4-300
24927 Generate code for SH4-300.
24929 @item -m4-300-nofpu
24930 @opindex m4-300-nofpu
24931 Generate code for SH4-300 without in such a way that the
24932 floating-point unit is not used.
24934 @item -m4-300-single
24935 @opindex m4-300-single
24936 Generate code for SH4-300 in such a way that no double-precision
24937 floating-point operations are used.
24939 @item -m4-300-single-only
24940 @opindex m4-300-single-only
24941 Generate code for SH4-300 in such a way that no double-precision
24942 floating-point operations are used.
24944 @item -m4-340
24945 @opindex m4-340
24946 Generate code for SH4-340 (no MMU, no FPU).
24948 @item -m4-500
24949 @opindex m4-500
24950 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24951 assembler.
24953 @item -m4a-nofpu
24954 @opindex m4a-nofpu
24955 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
24956 floating-point unit is not used.
24958 @item -m4a-single-only
24959 @opindex m4a-single-only
24960 Generate code for the SH4a, in such a way that no double-precision
24961 floating-point operations are used.
24963 @item -m4a-single
24964 @opindex m4a-single
24965 Generate code for the SH4a assuming the floating-point unit is in
24966 single-precision mode by default.
24968 @item -m4a
24969 @opindex m4a
24970 Generate code for the SH4a.
24972 @item -m4al
24973 @opindex m4al
24974 Same as @option{-m4a-nofpu}, except that it implicitly passes
24975 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
24976 instructions at the moment.
24978 @item -mb
24979 @opindex mb
24980 Compile code for the processor in big-endian mode.
24982 @item -ml
24983 @opindex ml
24984 Compile code for the processor in little-endian mode.
24986 @item -mdalign
24987 @opindex mdalign
24988 Align doubles at 64-bit boundaries.  Note that this changes the calling
24989 conventions, and thus some functions from the standard C library do
24990 not work unless you recompile it first with @option{-mdalign}.
24992 @item -mrelax
24993 @opindex mrelax
24994 Shorten some address references at link time, when possible; uses the
24995 linker option @option{-relax}.
24997 @item -mbigtable
24998 @opindex mbigtable
24999 Use 32-bit offsets in @code{switch} tables.  The default is to use
25000 16-bit offsets.
25002 @item -mbitops
25003 @opindex mbitops
25004 Enable the use of bit manipulation instructions on SH2A.
25006 @item -mfmovd
25007 @opindex mfmovd
25008 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25009 alignment constraints.
25011 @item -mrenesas
25012 @opindex mrenesas
25013 Comply with the calling conventions defined by Renesas.
25015 @item -mno-renesas
25016 @opindex mno-renesas
25017 Comply with the calling conventions defined for GCC before the Renesas
25018 conventions were available.  This option is the default for all
25019 targets of the SH toolchain.
25021 @item -mnomacsave
25022 @opindex mnomacsave
25023 Mark the @code{MAC} register as call-clobbered, even if
25024 @option{-mrenesas} is given.
25026 @item -mieee
25027 @itemx -mno-ieee
25028 @opindex mieee
25029 @opindex mno-ieee
25030 Control the IEEE compliance of floating-point comparisons, which affects the
25031 handling of cases where the result of a comparison is unordered.  By default
25032 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25033 enabled @option{-mno-ieee} is implicitly set, which results in faster
25034 floating-point greater-equal and less-equal comparisons.  The implicit settings
25035 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25037 @item -minline-ic_invalidate
25038 @opindex minline-ic_invalidate
25039 Inline code to invalidate instruction cache entries after setting up
25040 nested function trampolines.
25041 This option has no effect if @option{-musermode} is in effect and the selected
25042 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25043 instruction.
25044 If the selected code generation option does not allow the use of the @code{icbi}
25045 instruction, and @option{-musermode} is not in effect, the inlined code
25046 manipulates the instruction cache address array directly with an associative
25047 write.  This not only requires privileged mode at run time, but it also
25048 fails if the cache line had been mapped via the TLB and has become unmapped.
25050 @item -misize
25051 @opindex misize
25052 Dump instruction size and location in the assembly code.
25054 @item -mpadstruct
25055 @opindex mpadstruct
25056 This option is deprecated.  It pads structures to multiple of 4 bytes,
25057 which is incompatible with the SH ABI@.
25059 @item -matomic-model=@var{model}
25060 @opindex matomic-model=@var{model}
25061 Sets the model of atomic operations and additional parameters as a comma
25062 separated list.  For details on the atomic built-in functions see
25063 @ref{__atomic Builtins}.  The following models and parameters are supported:
25065 @table @samp
25067 @item none
25068 Disable compiler generated atomic sequences and emit library calls for atomic
25069 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25071 @item soft-gusa
25072 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25073 built-in functions.  The generated atomic sequences require additional support
25074 from the interrupt/exception handling code of the system and are only suitable
25075 for SH3* and SH4* single-core systems.  This option is enabled by default when
25076 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25077 this option also partially utilizes the hardware atomic instructions
25078 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25079 @samp{strict} is specified.  
25081 @item soft-tcb
25082 Generate software atomic sequences that use a variable in the thread control
25083 block.  This is a variation of the gUSA sequences which can also be used on
25084 SH1* and SH2* targets.  The generated atomic sequences require additional
25085 support from the interrupt/exception handling code of the system and are only
25086 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25087 parameter has to be specified as well.
25089 @item soft-imask
25090 Generate software atomic sequences that temporarily disable interrupts by
25091 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25092 in privileged mode and is only suitable for single-core systems.  Additional
25093 support from the interrupt/exception handling code of the system is not
25094 required.  This model is enabled by default when the target is
25095 @code{sh*-*-linux*} and SH1* or SH2*.
25097 @item hard-llcs
25098 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25099 instructions only.  This is only available on SH4A and is suitable for
25100 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25101 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25102 Code compiled with this option is also compatible with other software
25103 atomic model interrupt/exception handling systems if executed on an SH4A
25104 system.  Additional support from the interrupt/exception handling code of the
25105 system is not required for this model.
25107 @item gbr-offset=
25108 This parameter specifies the offset in bytes of the variable in the thread
25109 control block structure that should be used by the generated atomic sequences
25110 when the @samp{soft-tcb} model has been selected.  For other models this
25111 parameter is ignored.  The specified value must be an integer multiple of four
25112 and in the range 0-1020.
25114 @item strict
25115 This parameter prevents mixed usage of multiple atomic models, even if they
25116 are compatible, and makes the compiler generate atomic sequences of the
25117 specified model only.
25119 @end table
25121 @item -mtas
25122 @opindex mtas
25123 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25124 Notice that depending on the particular hardware and software configuration
25125 this can degrade overall performance due to the operand cache line flushes
25126 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25127 processors the @code{tas.b} instruction must be used with caution since it
25128 can result in data corruption for certain cache configurations.
25130 @item -mprefergot
25131 @opindex mprefergot
25132 When generating position-independent code, emit function calls using
25133 the Global Offset Table instead of the Procedure Linkage Table.
25135 @item -musermode
25136 @itemx -mno-usermode
25137 @opindex musermode
25138 @opindex mno-usermode
25139 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25140 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25141 inlined code would not work in user mode.  @option{-musermode} is the default
25142 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25143 @option{-musermode} has no effect, since there is no user mode.
25145 @item -multcost=@var{number}
25146 @opindex multcost=@var{number}
25147 Set the cost to assume for a multiply insn.
25149 @item -mdiv=@var{strategy}
25150 @opindex mdiv=@var{strategy}
25151 Set the division strategy to be used for integer division operations.
25152 @var{strategy} can be one of: 
25154 @table @samp
25156 @item call-div1
25157 Calls a library function that uses the single-step division instruction
25158 @code{div1} to perform the operation.  Division by zero calculates an
25159 unspecified result and does not trap.  This is the default except for SH4,
25160 SH2A and SHcompact.
25162 @item call-fp
25163 Calls a library function that performs the operation in double precision
25164 floating point.  Division by zero causes a floating-point exception.  This is
25165 the default for SHcompact with FPU.  Specifying this for targets that do not
25166 have a double precision FPU defaults to @code{call-div1}.
25168 @item call-table
25169 Calls a library function that uses a lookup table for small divisors and
25170 the @code{div1} instruction with case distinction for larger divisors.  Division
25171 by zero calculates an unspecified result and does not trap.  This is the default
25172 for SH4.  Specifying this for targets that do not have dynamic shift
25173 instructions defaults to @code{call-div1}.
25175 @end table
25177 When a division strategy has not been specified the default strategy is
25178 selected based on the current target.  For SH2A the default strategy is to
25179 use the @code{divs} and @code{divu} instructions instead of library function
25180 calls.
25182 @item -maccumulate-outgoing-args
25183 @opindex maccumulate-outgoing-args
25184 Reserve space once for outgoing arguments in the function prologue rather
25185 than around each call.  Generally beneficial for performance and size.  Also
25186 needed for unwinding to avoid changing the stack frame around conditional code.
25188 @item -mdivsi3_libfunc=@var{name}
25189 @opindex mdivsi3_libfunc=@var{name}
25190 Set the name of the library function used for 32-bit signed division to
25191 @var{name}.
25192 This only affects the name used in the @samp{call} division strategies, and
25193 the compiler still expects the same sets of input/output/clobbered registers as
25194 if this option were not present.
25196 @item -mfixed-range=@var{register-range}
25197 @opindex mfixed-range
25198 Generate code treating the given register range as fixed registers.
25199 A fixed register is one that the register allocator can not use.  This is
25200 useful when compiling kernel code.  A register range is specified as
25201 two registers separated by a dash.  Multiple register ranges can be
25202 specified separated by a comma.
25204 @item -mbranch-cost=@var{num}
25205 @opindex mbranch-cost=@var{num}
25206 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25207 make the compiler try to generate more branch-free code if possible.  
25208 If not specified the value is selected depending on the processor type that
25209 is being compiled for.
25211 @item -mzdcbranch
25212 @itemx -mno-zdcbranch
25213 @opindex mzdcbranch
25214 @opindex mno-zdcbranch
25215 Assume (do not assume) that zero displacement conditional branch instructions
25216 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25217 compiler prefers zero displacement branch code sequences.  This is
25218 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25219 disabled by specifying @option{-mno-zdcbranch}.
25221 @item -mcbranch-force-delay-slot
25222 @opindex mcbranch-force-delay-slot
25223 Force the usage of delay slots for conditional branches, which stuffs the delay
25224 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25225 this option is disabled.  It can be enabled to work around hardware bugs as
25226 found in the original SH7055.
25228 @item -mfused-madd
25229 @itemx -mno-fused-madd
25230 @opindex mfused-madd
25231 @opindex mno-fused-madd
25232 Generate code that uses (does not use) the floating-point multiply and
25233 accumulate instructions.  These instructions are generated by default
25234 if hardware floating point is used.  The machine-dependent
25235 @option{-mfused-madd} option is now mapped to the machine-independent
25236 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25237 mapped to @option{-ffp-contract=off}.
25239 @item -mfsca
25240 @itemx -mno-fsca
25241 @opindex mfsca
25242 @opindex mno-fsca
25243 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25244 and cosine approximations.  The option @option{-mfsca} must be used in
25245 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25246 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25247 approximations even if @option{-funsafe-math-optimizations} is in effect.
25249 @item -mfsrra
25250 @itemx -mno-fsrra
25251 @opindex mfsrra
25252 @opindex mno-fsrra
25253 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25254 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25255 in combination with @option{-funsafe-math-optimizations} and
25256 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25257 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25258 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25259 in effect.
25261 @item -mpretend-cmove
25262 @opindex mpretend-cmove
25263 Prefer zero-displacement conditional branches for conditional move instruction
25264 patterns.  This can result in faster code on the SH4 processor.
25266 @item -mfdpic
25267 @opindex fdpic
25268 Generate code using the FDPIC ABI.
25270 @end table
25272 @node Solaris 2 Options
25273 @subsection Solaris 2 Options
25274 @cindex Solaris 2 options
25276 These @samp{-m} options are supported on Solaris 2:
25278 @table @gcctabopt
25279 @item -mclear-hwcap
25280 @opindex mclear-hwcap
25281 @option{-mclear-hwcap} tells the compiler to remove the hardware
25282 capabilities generated by the Solaris assembler.  This is only necessary
25283 when object files use ISA extensions not supported by the current
25284 machine, but check at runtime whether or not to use them.
25286 @item -mimpure-text
25287 @opindex mimpure-text
25288 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25289 the compiler to not pass @option{-z text} to the linker when linking a
25290 shared object.  Using this option, you can link position-dependent
25291 code into a shared object.
25293 @option{-mimpure-text} suppresses the ``relocations remain against
25294 allocatable but non-writable sections'' linker error message.
25295 However, the necessary relocations trigger copy-on-write, and the
25296 shared object is not actually shared across processes.  Instead of
25297 using @option{-mimpure-text}, you should compile all source code with
25298 @option{-fpic} or @option{-fPIC}.
25300 @end table
25302 These switches are supported in addition to the above on Solaris 2:
25304 @table @gcctabopt
25305 @item -pthreads
25306 @opindex pthreads
25307 This is a synonym for @option{-pthread}.
25308 @end table
25310 @node SPARC Options
25311 @subsection SPARC Options
25312 @cindex SPARC options
25314 These @samp{-m} options are supported on the SPARC:
25316 @table @gcctabopt
25317 @item -mno-app-regs
25318 @itemx -mapp-regs
25319 @opindex mno-app-regs
25320 @opindex mapp-regs
25321 Specify @option{-mapp-regs} to generate output using the global registers
25322 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25323 global register 1, each global register 2 through 4 is then treated as an
25324 allocable register that is clobbered by function calls.  This is the default.
25326 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25327 specify @option{-mno-app-regs}.  You should compile libraries and system
25328 software with this option.
25330 @item -mflat
25331 @itemx -mno-flat
25332 @opindex mflat
25333 @opindex mno-flat
25334 With @option{-mflat}, the compiler does not generate save/restore instructions
25335 and uses a ``flat'' or single register window model.  This model is compatible
25336 with the regular register window model.  The local registers and the input
25337 registers (0--5) are still treated as ``call-saved'' registers and are
25338 saved on the stack as needed.
25340 With @option{-mno-flat} (the default), the compiler generates save/restore
25341 instructions (except for leaf functions).  This is the normal operating mode.
25343 @item -mfpu
25344 @itemx -mhard-float
25345 @opindex mfpu
25346 @opindex mhard-float
25347 Generate output containing floating-point instructions.  This is the
25348 default.
25350 @item -mno-fpu
25351 @itemx -msoft-float
25352 @opindex mno-fpu
25353 @opindex msoft-float
25354 Generate output containing library calls for floating point.
25355 @strong{Warning:} the requisite libraries are not available for all SPARC
25356 targets.  Normally the facilities of the machine's usual C compiler are
25357 used, but this cannot be done directly in cross-compilation.  You must make
25358 your own arrangements to provide suitable library functions for
25359 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25360 @samp{sparclite-*-*} do provide software floating-point support.
25362 @option{-msoft-float} changes the calling convention in the output file;
25363 therefore, it is only useful if you compile @emph{all} of a program with
25364 this option.  In particular, you need to compile @file{libgcc.a}, the
25365 library that comes with GCC, with @option{-msoft-float} in order for
25366 this to work.
25368 @item -mhard-quad-float
25369 @opindex mhard-quad-float
25370 Generate output containing quad-word (long double) floating-point
25371 instructions.
25373 @item -msoft-quad-float
25374 @opindex msoft-quad-float
25375 Generate output containing library calls for quad-word (long double)
25376 floating-point instructions.  The functions called are those specified
25377 in the SPARC ABI@.  This is the default.
25379 As of this writing, there are no SPARC implementations that have hardware
25380 support for the quad-word floating-point instructions.  They all invoke
25381 a trap handler for one of these instructions, and then the trap handler
25382 emulates the effect of the instruction.  Because of the trap handler overhead,
25383 this is much slower than calling the ABI library routines.  Thus the
25384 @option{-msoft-quad-float} option is the default.
25386 @item -mno-unaligned-doubles
25387 @itemx -munaligned-doubles
25388 @opindex mno-unaligned-doubles
25389 @opindex munaligned-doubles
25390 Assume that doubles have 8-byte alignment.  This is the default.
25392 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25393 alignment only if they are contained in another type, or if they have an
25394 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25395 Specifying this option avoids some rare compatibility problems with code
25396 generated by other compilers.  It is not the default because it results
25397 in a performance loss, especially for floating-point code.
25399 @item -muser-mode
25400 @itemx -mno-user-mode
25401 @opindex muser-mode
25402 @opindex mno-user-mode
25403 Do not generate code that can only run in supervisor mode.  This is relevant
25404 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25405 is the default.
25407 @item -mfaster-structs
25408 @itemx -mno-faster-structs
25409 @opindex mfaster-structs
25410 @opindex mno-faster-structs
25411 With @option{-mfaster-structs}, the compiler assumes that structures
25412 should have 8-byte alignment.  This enables the use of pairs of
25413 @code{ldd} and @code{std} instructions for copies in structure
25414 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25415 However, the use of this changed alignment directly violates the SPARC
25416 ABI@.  Thus, it's intended only for use on targets where the developer
25417 acknowledges that their resulting code is not directly in line with
25418 the rules of the ABI@.
25420 @item -mstd-struct-return
25421 @itemx -mno-std-struct-return
25422 @opindex mstd-struct-return
25423 @opindex mno-std-struct-return
25424 With @option{-mstd-struct-return}, the compiler generates checking code
25425 in functions returning structures or unions to detect size mismatches
25426 between the two sides of function calls, as per the 32-bit ABI@.
25428 The default is @option{-mno-std-struct-return}.  This option has no effect
25429 in 64-bit mode.
25431 @item -mlra
25432 @itemx -mno-lra
25433 @opindex mlra
25434 @opindex mno-lra
25435 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25436 so @option{-mno-lra} needs to be passed to get old Reload.
25438 @item -mcpu=@var{cpu_type}
25439 @opindex mcpu
25440 Set the instruction set, register set, and instruction scheduling parameters
25441 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25442 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25443 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25444 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25445 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25446 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25448 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25449 which selects the best architecture option for the host processor.
25450 @option{-mcpu=native} has no effect if GCC does not recognize
25451 the processor.
25453 Default instruction scheduling parameters are used for values that select
25454 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25455 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25457 Here is a list of each supported architecture and their supported
25458 implementations.
25460 @table @asis
25461 @item v7
25462 cypress, leon3v7
25464 @item v8
25465 supersparc, hypersparc, leon, leon3
25467 @item sparclite
25468 f930, f934, sparclite86x
25470 @item sparclet
25471 tsc701
25473 @item v9
25474 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25475 niagara7, m8
25476 @end table
25478 By default (unless configured otherwise), GCC generates code for the V7
25479 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25480 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25481 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25482 SPARCStation 1, 2, IPX etc.
25484 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25485 architecture.  The only difference from V7 code is that the compiler emits
25486 the integer multiply and integer divide instructions which exist in SPARC-V8
25487 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25488 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25489 2000 series.
25491 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25492 the SPARC architecture.  This adds the integer multiply, integer divide step
25493 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25494 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25495 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25496 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25497 MB86934 chip, which is the more recent SPARClite with FPU@.
25499 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25500 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25501 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25502 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25503 optimizes it for the TEMIC SPARClet chip.
25505 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25506 architecture.  This adds 64-bit integer and floating-point move instructions,
25507 3 additional floating-point condition code registers and conditional move
25508 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25509 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25510 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25511 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25512 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25513 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25514 additionally optimizes it for Sun UltraSPARC T2 chips. With
25515 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25516 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25517 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25518 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25519 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25520 additionally optimizes it for Oracle M8 chips.
25522 @item -mtune=@var{cpu_type}
25523 @opindex mtune
25524 Set the instruction scheduling parameters for machine type
25525 @var{cpu_type}, but do not set the instruction set or register set that the
25526 option @option{-mcpu=@var{cpu_type}} does.
25528 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25529 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25530 that select a particular CPU implementation.  Those are
25531 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25532 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25533 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25534 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25535 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25536 and GNU/Linux toolchains, @samp{native} can also be used.
25538 @item -mv8plus
25539 @itemx -mno-v8plus
25540 @opindex mv8plus
25541 @opindex mno-v8plus
25542 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25543 difference from the V8 ABI is that the global and out registers are
25544 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25545 mode for all SPARC-V9 processors.
25547 @item -mvis
25548 @itemx -mno-vis
25549 @opindex mvis
25550 @opindex mno-vis
25551 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25552 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25554 @item -mvis2
25555 @itemx -mno-vis2
25556 @opindex mvis2
25557 @opindex mno-vis2
25558 With @option{-mvis2}, GCC generates code that takes advantage of
25559 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25560 default is @option{-mvis2} when targeting a cpu that supports such
25561 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25562 also sets @option{-mvis}.
25564 @item -mvis3
25565 @itemx -mno-vis3
25566 @opindex mvis3
25567 @opindex mno-vis3
25568 With @option{-mvis3}, GCC generates code that takes advantage of
25569 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25570 default is @option{-mvis3} when targeting a cpu that supports such
25571 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25572 also sets @option{-mvis2} and @option{-mvis}.
25574 @item -mvis4
25575 @itemx -mno-vis4
25576 @opindex mvis4
25577 @opindex mno-vis4
25578 With @option{-mvis4}, GCC generates code that takes advantage of
25579 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25580 default is @option{-mvis4} when targeting a cpu that supports such
25581 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25582 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25584 @item -mvis4b
25585 @itemx -mno-vis4b
25586 @opindex mvis4b
25587 @opindex mno-vis4b
25588 With @option{-mvis4b}, GCC generates code that takes advantage of
25589 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25590 the additional VIS instructions introduced in the Oracle SPARC
25591 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25592 cpu that supports such instructions, such as m8 and later.  Setting
25593 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25594 @option{-mvis2} and @option{-mvis}.
25596 @item -mcbcond
25597 @itemx -mno-cbcond
25598 @opindex mcbcond
25599 @opindex mno-cbcond
25600 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25601 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25602 when targeting a CPU that supports such instructions, such as Niagara-4 and
25603 later.
25605 @item -mfmaf
25606 @itemx -mno-fmaf
25607 @opindex mfmaf
25608 @opindex mno-fmaf
25609 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25610 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25611 when targeting a CPU that supports such instructions, such as Niagara-3 and
25612 later.
25614 @item -mfsmuld
25615 @itemx -mno-fsmuld
25616 @opindex mfsmuld
25617 @opindex mno-fsmuld
25618 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25619 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25620 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25621 or V9 with FPU except @option{-mcpu=leon}.
25623 @item -mpopc
25624 @itemx -mno-popc
25625 @opindex mpopc
25626 @opindex mno-popc
25627 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25628 Population Count instruction.  The default is @option{-mpopc}
25629 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25630 later.
25632 @item -msubxc
25633 @itemx -mno-subxc
25634 @opindex msubxc
25635 @opindex mno-subxc
25636 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25637 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25638 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25639 later.
25641 @item -mfix-at697f
25642 @opindex mfix-at697f
25643 Enable the documented workaround for the single erratum of the Atmel AT697F
25644 processor (which corresponds to erratum #13 of the AT697E processor).
25646 @item -mfix-ut699
25647 @opindex mfix-ut699
25648 Enable the documented workarounds for the floating-point errata and the data
25649 cache nullify errata of the UT699 processor.
25651 @item -mfix-ut700
25652 @opindex mfix-ut700
25653 Enable the documented workaround for the back-to-back store errata of
25654 the UT699E/UT700 processor.
25656 @item -mfix-gr712rc
25657 @opindex mfix-gr712rc
25658 Enable the documented workaround for the back-to-back store errata of
25659 the GR712RC processor.
25660 @end table
25662 These @samp{-m} options are supported in addition to the above
25663 on SPARC-V9 processors in 64-bit environments:
25665 @table @gcctabopt
25666 @item -m32
25667 @itemx -m64
25668 @opindex m32
25669 @opindex m64
25670 Generate code for a 32-bit or 64-bit environment.
25671 The 32-bit environment sets int, long and pointer to 32 bits.
25672 The 64-bit environment sets int to 32 bits and long and pointer
25673 to 64 bits.
25675 @item -mcmodel=@var{which}
25676 @opindex mcmodel
25677 Set the code model to one of
25679 @table @samp
25680 @item medlow
25681 The Medium/Low code model: 64-bit addresses, programs
25682 must be linked in the low 32 bits of memory.  Programs can be statically
25683 or dynamically linked.
25685 @item medmid
25686 The Medium/Middle code model: 64-bit addresses, programs
25687 must be linked in the low 44 bits of memory, the text and data segments must
25688 be less than 2GB in size and the data segment must be located within 2GB of
25689 the text segment.
25691 @item medany
25692 The Medium/Anywhere code model: 64-bit addresses, programs
25693 may be linked anywhere in memory, the text and data segments must be less
25694 than 2GB in size and the data segment must be located within 2GB of the
25695 text segment.
25697 @item embmedany
25698 The Medium/Anywhere code model for embedded systems:
25699 64-bit addresses, the text and data segments must be less than 2GB in
25700 size, both starting anywhere in memory (determined at link time).  The
25701 global register %g4 points to the base of the data segment.  Programs
25702 are statically linked and PIC is not supported.
25703 @end table
25705 @item -mmemory-model=@var{mem-model}
25706 @opindex mmemory-model
25707 Set the memory model in force on the processor to one of
25709 @table @samp
25710 @item default
25711 The default memory model for the processor and operating system.
25713 @item rmo
25714 Relaxed Memory Order
25716 @item pso
25717 Partial Store Order
25719 @item tso
25720 Total Store Order
25722 @item sc
25723 Sequential Consistency
25724 @end table
25726 These memory models are formally defined in Appendix D of the SPARC-V9
25727 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25729 @item -mstack-bias
25730 @itemx -mno-stack-bias
25731 @opindex mstack-bias
25732 @opindex mno-stack-bias
25733 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25734 frame pointer if present, are offset by @minus{}2047 which must be added back
25735 when making stack frame references.  This is the default in 64-bit mode.
25736 Otherwise, assume no such offset is present.
25737 @end table
25739 @node SPU Options
25740 @subsection SPU Options
25741 @cindex SPU options
25743 These @samp{-m} options are supported on the SPU:
25745 @table @gcctabopt
25746 @item -mwarn-reloc
25747 @itemx -merror-reloc
25748 @opindex mwarn-reloc
25749 @opindex merror-reloc
25751 The loader for SPU does not handle dynamic relocations.  By default, GCC
25752 gives an error when it generates code that requires a dynamic
25753 relocation.  @option{-mno-error-reloc} disables the error,
25754 @option{-mwarn-reloc} generates a warning instead.
25756 @item -msafe-dma
25757 @itemx -munsafe-dma
25758 @opindex msafe-dma
25759 @opindex munsafe-dma
25761 Instructions that initiate or test completion of DMA must not be
25762 reordered with respect to loads and stores of the memory that is being
25763 accessed.
25764 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25765 memory accesses, but that can lead to inefficient code in places where the
25766 memory is known to not change.  Rather than mark the memory as volatile,
25767 you can use @option{-msafe-dma} to tell the compiler to treat
25768 the DMA instructions as potentially affecting all memory.  
25770 @item -mbranch-hints
25771 @opindex mbranch-hints
25773 By default, GCC generates a branch hint instruction to avoid
25774 pipeline stalls for always-taken or probably-taken branches.  A hint
25775 is not generated closer than 8 instructions away from its branch.
25776 There is little reason to disable them, except for debugging purposes,
25777 or to make an object a little bit smaller.
25779 @item -msmall-mem
25780 @itemx -mlarge-mem
25781 @opindex msmall-mem
25782 @opindex mlarge-mem
25784 By default, GCC generates code assuming that addresses are never larger
25785 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25786 a full 32-bit address.
25788 @item -mstdmain
25789 @opindex mstdmain
25791 By default, GCC links against startup code that assumes the SPU-style
25792 main function interface (which has an unconventional parameter list).
25793 With @option{-mstdmain}, GCC links your program against startup
25794 code that assumes a C99-style interface to @code{main}, including a
25795 local copy of @code{argv} strings.
25797 @item -mfixed-range=@var{register-range}
25798 @opindex mfixed-range
25799 Generate code treating the given register range as fixed registers.
25800 A fixed register is one that the register allocator cannot use.  This is
25801 useful when compiling kernel code.  A register range is specified as
25802 two registers separated by a dash.  Multiple register ranges can be
25803 specified separated by a comma.
25805 @item -mea32
25806 @itemx -mea64
25807 @opindex mea32
25808 @opindex mea64
25809 Compile code assuming that pointers to the PPU address space accessed
25810 via the @code{__ea} named address space qualifier are either 32 or 64
25811 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25812 all object code in an executable must be compiled with the same setting.
25814 @item -maddress-space-conversion
25815 @itemx -mno-address-space-conversion
25816 @opindex maddress-space-conversion
25817 @opindex mno-address-space-conversion
25818 Allow/disallow treating the @code{__ea} address space as superset
25819 of the generic address space.  This enables explicit type casts
25820 between @code{__ea} and generic pointer as well as implicit
25821 conversions of generic pointers to @code{__ea} pointers.  The
25822 default is to allow address space pointer conversions.
25824 @item -mcache-size=@var{cache-size}
25825 @opindex mcache-size
25826 This option controls the version of libgcc that the compiler links to an
25827 executable and selects a software-managed cache for accessing variables
25828 in the @code{__ea} address space with a particular cache size.  Possible
25829 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25830 and @samp{128}.  The default cache size is 64KB.
25832 @item -matomic-updates
25833 @itemx -mno-atomic-updates
25834 @opindex matomic-updates
25835 @opindex mno-atomic-updates
25836 This option controls the version of libgcc that the compiler links to an
25837 executable and selects whether atomic updates to the software-managed
25838 cache of PPU-side variables are used.  If you use atomic updates, changes
25839 to a PPU variable from SPU code using the @code{__ea} named address space
25840 qualifier do not interfere with changes to other PPU variables residing
25841 in the same cache line from PPU code.  If you do not use atomic updates,
25842 such interference may occur; however, writing back cache lines is
25843 more efficient.  The default behavior is to use atomic updates.
25845 @item -mdual-nops
25846 @itemx -mdual-nops=@var{n}
25847 @opindex mdual-nops
25848 By default, GCC inserts NOPs to increase dual issue when it expects
25849 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25850 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25851 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25853 @item -mhint-max-nops=@var{n}
25854 @opindex mhint-max-nops
25855 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25856 be at least 8 instructions away from the branch it is affecting.  GCC
25857 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25858 generate the branch hint.
25860 @item -mhint-max-distance=@var{n}
25861 @opindex mhint-max-distance
25862 The encoding of the branch hint instruction limits the hint to be within
25863 256 instructions of the branch it is affecting.  By default, GCC makes
25864 sure it is within 125.
25866 @item -msafe-hints
25867 @opindex msafe-hints
25868 Work around a hardware bug that causes the SPU to stall indefinitely.
25869 By default, GCC inserts the @code{hbrp} instruction to make sure
25870 this stall won't happen.
25872 @end table
25874 @node System V Options
25875 @subsection Options for System V
25877 These additional options are available on System V Release 4 for
25878 compatibility with other compilers on those systems:
25880 @table @gcctabopt
25881 @item -G
25882 @opindex G
25883 Create a shared object.
25884 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25886 @item -Qy
25887 @opindex Qy
25888 Identify the versions of each tool used by the compiler, in a
25889 @code{.ident} assembler directive in the output.
25891 @item -Qn
25892 @opindex Qn
25893 Refrain from adding @code{.ident} directives to the output file (this is
25894 the default).
25896 @item -YP,@var{dirs}
25897 @opindex YP
25898 Search the directories @var{dirs}, and no others, for libraries
25899 specified with @option{-l}.
25901 @item -Ym,@var{dir}
25902 @opindex Ym
25903 Look in the directory @var{dir} to find the M4 preprocessor.
25904 The assembler uses this option.
25905 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25906 @c the generic assembler that comes with Solaris takes just -Ym.
25907 @end table
25909 @node TILE-Gx Options
25910 @subsection TILE-Gx Options
25911 @cindex TILE-Gx options
25913 These @samp{-m} options are supported on the TILE-Gx:
25915 @table @gcctabopt
25916 @item -mcmodel=small
25917 @opindex mcmodel=small
25918 Generate code for the small model.  The distance for direct calls is
25919 limited to 500M in either direction.  PC-relative addresses are 32
25920 bits.  Absolute addresses support the full address range.
25922 @item -mcmodel=large
25923 @opindex mcmodel=large
25924 Generate code for the large model.  There is no limitation on call
25925 distance, pc-relative addresses, or absolute addresses.
25927 @item -mcpu=@var{name}
25928 @opindex mcpu
25929 Selects the type of CPU to be targeted.  Currently the only supported
25930 type is @samp{tilegx}.
25932 @item -m32
25933 @itemx -m64
25934 @opindex m32
25935 @opindex m64
25936 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25937 environment sets int, long, and pointer to 32 bits.  The 64-bit
25938 environment sets int to 32 bits and long and pointer to 64 bits.
25940 @item -mbig-endian
25941 @itemx -mlittle-endian
25942 @opindex mbig-endian
25943 @opindex mlittle-endian
25944 Generate code in big/little endian mode, respectively.
25945 @end table
25947 @node TILEPro Options
25948 @subsection TILEPro Options
25949 @cindex TILEPro options
25951 These @samp{-m} options are supported on the TILEPro:
25953 @table @gcctabopt
25954 @item -mcpu=@var{name}
25955 @opindex mcpu
25956 Selects the type of CPU to be targeted.  Currently the only supported
25957 type is @samp{tilepro}.
25959 @item -m32
25960 @opindex m32
25961 Generate code for a 32-bit environment, which sets int, long, and
25962 pointer to 32 bits.  This is the only supported behavior so the flag
25963 is essentially ignored.
25964 @end table
25966 @node V850 Options
25967 @subsection V850 Options
25968 @cindex V850 Options
25970 These @samp{-m} options are defined for V850 implementations:
25972 @table @gcctabopt
25973 @item -mlong-calls
25974 @itemx -mno-long-calls
25975 @opindex mlong-calls
25976 @opindex mno-long-calls
25977 Treat all calls as being far away (near).  If calls are assumed to be
25978 far away, the compiler always loads the function's address into a
25979 register, and calls indirect through the pointer.
25981 @item -mno-ep
25982 @itemx -mep
25983 @opindex mno-ep
25984 @opindex mep
25985 Do not optimize (do optimize) basic blocks that use the same index
25986 pointer 4 or more times to copy pointer into the @code{ep} register, and
25987 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
25988 option is on by default if you optimize.
25990 @item -mno-prolog-function
25991 @itemx -mprolog-function
25992 @opindex mno-prolog-function
25993 @opindex mprolog-function
25994 Do not use (do use) external functions to save and restore registers
25995 at the prologue and epilogue of a function.  The external functions
25996 are slower, but use less code space if more than one function saves
25997 the same number of registers.  The @option{-mprolog-function} option
25998 is on by default if you optimize.
26000 @item -mspace
26001 @opindex mspace
26002 Try to make the code as small as possible.  At present, this just turns
26003 on the @option{-mep} and @option{-mprolog-function} options.
26005 @item -mtda=@var{n}
26006 @opindex mtda
26007 Put static or global variables whose size is @var{n} bytes or less into
26008 the tiny data area that register @code{ep} points to.  The tiny data
26009 area can hold up to 256 bytes in total (128 bytes for byte references).
26011 @item -msda=@var{n}
26012 @opindex msda
26013 Put static or global variables whose size is @var{n} bytes or less into
26014 the small data area that register @code{gp} points to.  The small data
26015 area can hold up to 64 kilobytes.
26017 @item -mzda=@var{n}
26018 @opindex mzda
26019 Put static or global variables whose size is @var{n} bytes or less into
26020 the first 32 kilobytes of memory.
26022 @item -mv850
26023 @opindex mv850
26024 Specify that the target processor is the V850.
26026 @item -mv850e3v5
26027 @opindex mv850e3v5
26028 Specify that the target processor is the V850E3V5.  The preprocessor
26029 constant @code{__v850e3v5__} is defined if this option is used.
26031 @item -mv850e2v4
26032 @opindex mv850e2v4
26033 Specify that the target processor is the V850E3V5.  This is an alias for
26034 the @option{-mv850e3v5} option.
26036 @item -mv850e2v3
26037 @opindex mv850e2v3
26038 Specify that the target processor is the V850E2V3.  The preprocessor
26039 constant @code{__v850e2v3__} is defined if this option is used.
26041 @item -mv850e2
26042 @opindex mv850e2
26043 Specify that the target processor is the V850E2.  The preprocessor
26044 constant @code{__v850e2__} is defined if this option is used.
26046 @item -mv850e1
26047 @opindex mv850e1
26048 Specify that the target processor is the V850E1.  The preprocessor
26049 constants @code{__v850e1__} and @code{__v850e__} are defined if
26050 this option is used.
26052 @item -mv850es
26053 @opindex mv850es
26054 Specify that the target processor is the V850ES.  This is an alias for
26055 the @option{-mv850e1} option.
26057 @item -mv850e
26058 @opindex mv850e
26059 Specify that the target processor is the V850E@.  The preprocessor
26060 constant @code{__v850e__} is defined if this option is used.
26062 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26063 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26064 are defined then a default target processor is chosen and the
26065 relevant @samp{__v850*__} preprocessor constant is defined.
26067 The preprocessor constants @code{__v850} and @code{__v851__} are always
26068 defined, regardless of which processor variant is the target.
26070 @item -mdisable-callt
26071 @itemx -mno-disable-callt
26072 @opindex mdisable-callt
26073 @opindex mno-disable-callt
26074 This option suppresses generation of the @code{CALLT} instruction for the
26075 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26076 architecture.
26078 This option is enabled by default when the RH850 ABI is
26079 in use (see @option{-mrh850-abi}), and disabled by default when the
26080 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26081 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26083 @item -mrelax
26084 @itemx -mno-relax
26085 @opindex mrelax
26086 @opindex mno-relax
26087 Pass on (or do not pass on) the @option{-mrelax} command-line option
26088 to the assembler.
26090 @item -mlong-jumps
26091 @itemx -mno-long-jumps
26092 @opindex mlong-jumps
26093 @opindex mno-long-jumps
26094 Disable (or re-enable) the generation of PC-relative jump instructions.
26096 @item -msoft-float
26097 @itemx -mhard-float
26098 @opindex msoft-float
26099 @opindex mhard-float
26100 Disable (or re-enable) the generation of hardware floating point
26101 instructions.  This option is only significant when the target
26102 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26103 instructions are being generated then the C preprocessor symbol
26104 @code{__FPU_OK__} is defined, otherwise the symbol
26105 @code{__NO_FPU__} is defined.
26107 @item -mloop
26108 @opindex mloop
26109 Enables the use of the e3v5 LOOP instruction.  The use of this
26110 instruction is not enabled by default when the e3v5 architecture is
26111 selected because its use is still experimental.
26113 @item -mrh850-abi
26114 @itemx -mghs
26115 @opindex mrh850-abi
26116 @opindex mghs
26117 Enables support for the RH850 version of the V850 ABI.  This is the
26118 default.  With this version of the ABI the following rules apply:
26120 @itemize
26121 @item
26122 Integer sized structures and unions are returned via a memory pointer
26123 rather than a register.
26125 @item
26126 Large structures and unions (more than 8 bytes in size) are passed by
26127 value.
26129 @item
26130 Functions are aligned to 16-bit boundaries.
26132 @item
26133 The @option{-m8byte-align} command-line option is supported.
26135 @item
26136 The @option{-mdisable-callt} command-line option is enabled by
26137 default.  The @option{-mno-disable-callt} command-line option is not
26138 supported.
26139 @end itemize
26141 When this version of the ABI is enabled the C preprocessor symbol
26142 @code{__V850_RH850_ABI__} is defined.
26144 @item -mgcc-abi
26145 @opindex mgcc-abi
26146 Enables support for the old GCC version of the V850 ABI.  With this
26147 version of the ABI the following rules apply:
26149 @itemize
26150 @item
26151 Integer sized structures and unions are returned in register @code{r10}.
26153 @item
26154 Large structures and unions (more than 8 bytes in size) are passed by
26155 reference.
26157 @item
26158 Functions are aligned to 32-bit boundaries, unless optimizing for
26159 size.
26161 @item
26162 The @option{-m8byte-align} command-line option is not supported.
26164 @item
26165 The @option{-mdisable-callt} command-line option is supported but not
26166 enabled by default.
26167 @end itemize
26169 When this version of the ABI is enabled the C preprocessor symbol
26170 @code{__V850_GCC_ABI__} is defined.
26172 @item -m8byte-align
26173 @itemx -mno-8byte-align
26174 @opindex m8byte-align
26175 @opindex mno-8byte-align
26176 Enables support for @code{double} and @code{long long} types to be
26177 aligned on 8-byte boundaries.  The default is to restrict the
26178 alignment of all objects to at most 4-bytes.  When
26179 @option{-m8byte-align} is in effect the C preprocessor symbol
26180 @code{__V850_8BYTE_ALIGN__} is defined.
26182 @item -mbig-switch
26183 @opindex mbig-switch
26184 Generate code suitable for big switch tables.  Use this option only if
26185 the assembler/linker complain about out of range branches within a switch
26186 table.
26188 @item -mapp-regs
26189 @opindex mapp-regs
26190 This option causes r2 and r5 to be used in the code generated by
26191 the compiler.  This setting is the default.
26193 @item -mno-app-regs
26194 @opindex mno-app-regs
26195 This option causes r2 and r5 to be treated as fixed registers.
26197 @end table
26199 @node VAX Options
26200 @subsection VAX Options
26201 @cindex VAX options
26203 These @samp{-m} options are defined for the VAX:
26205 @table @gcctabopt
26206 @item -munix
26207 @opindex munix
26208 Do not output certain jump instructions (@code{aobleq} and so on)
26209 that the Unix assembler for the VAX cannot handle across long
26210 ranges.
26212 @item -mgnu
26213 @opindex mgnu
26214 Do output those jump instructions, on the assumption that the
26215 GNU assembler is being used.
26217 @item -mg
26218 @opindex mg
26219 Output code for G-format floating-point numbers instead of D-format.
26220 @end table
26222 @node Visium Options
26223 @subsection Visium Options
26224 @cindex Visium options
26226 @table @gcctabopt
26228 @item -mdebug
26229 @opindex mdebug
26230 A program which performs file I/O and is destined to run on an MCM target
26231 should be linked with this option.  It causes the libraries libc.a and
26232 libdebug.a to be linked.  The program should be run on the target under
26233 the control of the GDB remote debugging stub.
26235 @item -msim
26236 @opindex msim
26237 A program which performs file I/O and is destined to run on the simulator
26238 should be linked with option.  This causes libraries libc.a and libsim.a to
26239 be linked.
26241 @item -mfpu
26242 @itemx -mhard-float
26243 @opindex mfpu
26244 @opindex mhard-float
26245 Generate code containing floating-point instructions.  This is the
26246 default.
26248 @item -mno-fpu
26249 @itemx -msoft-float
26250 @opindex mno-fpu
26251 @opindex msoft-float
26252 Generate code containing library calls for floating-point.
26254 @option{-msoft-float} changes the calling convention in the output file;
26255 therefore, it is only useful if you compile @emph{all} of a program with
26256 this option.  In particular, you need to compile @file{libgcc.a}, the
26257 library that comes with GCC, with @option{-msoft-float} in order for
26258 this to work.
26260 @item -mcpu=@var{cpu_type}
26261 @opindex mcpu
26262 Set the instruction set, register set, and instruction scheduling parameters
26263 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26264 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26266 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26268 By default (unless configured otherwise), GCC generates code for the GR5
26269 variant of the Visium architecture.  
26271 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26272 architecture.  The only difference from GR5 code is that the compiler will
26273 generate block move instructions.
26275 @item -mtune=@var{cpu_type}
26276 @opindex mtune
26277 Set the instruction scheduling parameters for machine type @var{cpu_type},
26278 but do not set the instruction set or register set that the option
26279 @option{-mcpu=@var{cpu_type}} would.
26281 @item -msv-mode
26282 @opindex msv-mode
26283 Generate code for the supervisor mode, where there are no restrictions on
26284 the access to general registers.  This is the default.
26286 @item -muser-mode
26287 @opindex muser-mode
26288 Generate code for the user mode, where the access to some general registers
26289 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26290 mode; on the GR6, only registers r29 to r31 are affected.
26291 @end table
26293 @node VMS Options
26294 @subsection VMS Options
26296 These @samp{-m} options are defined for the VMS implementations:
26298 @table @gcctabopt
26299 @item -mvms-return-codes
26300 @opindex mvms-return-codes
26301 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26302 condition (e.g.@ error) codes.
26304 @item -mdebug-main=@var{prefix}
26305 @opindex mdebug-main=@var{prefix}
26306 Flag the first routine whose name starts with @var{prefix} as the main
26307 routine for the debugger.
26309 @item -mmalloc64
26310 @opindex mmalloc64
26311 Default to 64-bit memory allocation routines.
26313 @item -mpointer-size=@var{size}
26314 @opindex mpointer-size=@var{size}
26315 Set the default size of pointers. Possible options for @var{size} are
26316 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26317 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26318 The later option disables @code{pragma pointer_size}.
26319 @end table
26321 @node VxWorks Options
26322 @subsection VxWorks Options
26323 @cindex VxWorks Options
26325 The options in this section are defined for all VxWorks targets.
26326 Options specific to the target hardware are listed with the other
26327 options for that target.
26329 @table @gcctabopt
26330 @item -mrtp
26331 @opindex mrtp
26332 GCC can generate code for both VxWorks kernels and real time processes
26333 (RTPs).  This option switches from the former to the latter.  It also
26334 defines the preprocessor macro @code{__RTP__}.
26336 @item -non-static
26337 @opindex non-static
26338 Link an RTP executable against shared libraries rather than static
26339 libraries.  The options @option{-static} and @option{-shared} can
26340 also be used for RTPs (@pxref{Link Options}); @option{-static}
26341 is the default.
26343 @item -Bstatic
26344 @itemx -Bdynamic
26345 @opindex Bstatic
26346 @opindex Bdynamic
26347 These options are passed down to the linker.  They are defined for
26348 compatibility with Diab.
26350 @item -Xbind-lazy
26351 @opindex Xbind-lazy
26352 Enable lazy binding of function calls.  This option is equivalent to
26353 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26355 @item -Xbind-now
26356 @opindex Xbind-now
26357 Disable lazy binding of function calls.  This option is the default and
26358 is defined for compatibility with Diab.
26359 @end table
26361 @node x86 Options
26362 @subsection x86 Options
26363 @cindex x86 Options
26365 These @samp{-m} options are defined for the x86 family of computers.
26367 @table @gcctabopt
26369 @item -march=@var{cpu-type}
26370 @opindex march
26371 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26372 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26373 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26374 to generate code that may not run at all on processors other than the one
26375 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26376 @option{-mtune=@var{cpu-type}}.
26378 The choices for @var{cpu-type} are:
26380 @table @samp
26381 @item native
26382 This selects the CPU to generate code for at compilation time by determining
26383 the processor type of the compiling machine.  Using @option{-march=native}
26384 enables all instruction subsets supported by the local machine (hence
26385 the result might not run on different machines).  Using @option{-mtune=native}
26386 produces code optimized for the local machine under the constraints
26387 of the selected instruction set.  
26389 @item x86-64
26390 A generic CPU with 64-bit extensions.
26392 @item i386
26393 Original Intel i386 CPU@.
26395 @item i486
26396 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26398 @item i586
26399 @itemx pentium
26400 Intel Pentium CPU with no MMX support.
26402 @item lakemont
26403 Intel Lakemont MCU, based on Intel Pentium CPU.
26405 @item pentium-mmx
26406 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26408 @item pentiumpro
26409 Intel Pentium Pro CPU@.
26411 @item i686
26412 When used with @option{-march}, the Pentium Pro
26413 instruction set is used, so the code runs on all i686 family chips.
26414 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26416 @item pentium2
26417 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26418 support.
26420 @item pentium3
26421 @itemx pentium3m
26422 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26423 set support.
26425 @item pentium-m
26426 Intel Pentium M; low-power version of Intel Pentium III CPU
26427 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26429 @item pentium4
26430 @itemx pentium4m
26431 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26433 @item prescott
26434 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26435 set support.
26437 @item nocona
26438 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26439 SSE2 and SSE3 instruction set support.
26441 @item core2
26442 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26443 instruction set support.
26445 @item nehalem
26446 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26447 SSE4.1, SSE4.2 and POPCNT instruction set support.
26449 @item westmere
26450 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26451 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26453 @item sandybridge
26454 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26455 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26457 @item ivybridge
26458 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26459 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26460 instruction set support.
26462 @item haswell
26463 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26464 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26465 BMI, BMI2 and F16C instruction set support.
26467 @item broadwell
26468 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26469 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26470 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26472 @item skylake
26473 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26474 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26475 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26476 XSAVES instruction set support.
26478 @item bonnell
26479 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26480 instruction set support.
26482 @item silvermont
26483 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26484 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26486 @item goldmont
26487 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26488 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
26489 instruction set support.
26491 @item goldmont-plus
26492 Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26493 SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE,
26494 PTWRITE, RDPID, SGX and UMIP instruction set support.
26496 @item tremont
26497 Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26498 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, PTWRITE,
26499 RDPID, SGX, UMIP, GFNI-SSE, CLWB and ENCLV instruction set support.
26501 @item knl
26502 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26503 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26504 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26505 AVX512CD instruction set support.
26507 @item knm
26508 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26509 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26510 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26511 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26513 @item skylake-avx512
26514 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26515 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26516 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26517 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26519 @item cannonlake
26520 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26521 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26522 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26523 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26524 AVX512IFMA, SHA and UMIP instruction set support.
26526 @item icelake-client
26527 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26528 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26529 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26530 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26531 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26532 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26534 @item icelake-server
26535 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26536 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26537 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26538 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26539 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26540 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26541 set support.
26543 @item k6
26544 AMD K6 CPU with MMX instruction set support.
26546 @item k6-2
26547 @itemx k6-3
26548 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26550 @item athlon
26551 @itemx athlon-tbird
26552 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26553 support.
26555 @item athlon-4
26556 @itemx athlon-xp
26557 @itemx athlon-mp
26558 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26559 instruction set support.
26561 @item k8
26562 @itemx opteron
26563 @itemx athlon64
26564 @itemx athlon-fx
26565 Processors based on the AMD K8 core with x86-64 instruction set support,
26566 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26567 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26568 instruction set extensions.)
26570 @item k8-sse3
26571 @itemx opteron-sse3
26572 @itemx athlon64-sse3
26573 Improved versions of AMD K8 cores with SSE3 instruction set support.
26575 @item amdfam10
26576 @itemx barcelona
26577 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26578 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26579 instruction set extensions.)
26581 @item bdver1
26582 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26583 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26584 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26585 @item bdver2
26586 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26587 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26588 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26589 extensions.)
26590 @item bdver3
26591 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26592 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26593 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26594 64-bit instruction set extensions.
26595 @item bdver4
26596 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26597 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26598 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26599 SSE4.2, ABM and 64-bit instruction set extensions.
26601 @item znver1
26602 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26603 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26604 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26605 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26606 instruction set extensions.
26608 @item btver1
26609 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26610 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26611 instruction set extensions.)
26613 @item btver2
26614 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26615 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26616 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26618 @item winchip-c6
26619 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26620 set support.
26622 @item winchip2
26623 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26624 instruction set support.
26626 @item c3
26627 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26628 (No scheduling is implemented for this chip.)
26630 @item c3-2
26631 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26632 (No scheduling is implemented for this chip.)
26634 @item c7
26635 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26636 (No scheduling is implemented for this chip.)
26638 @item samuel-2
26639 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26640 (No scheduling is implemented for this chip.)
26642 @item nehemiah
26643 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26644 (No scheduling is implemented for this chip.)
26646 @item esther
26647 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26648 (No scheduling is implemented for this chip.)
26650 @item eden-x2
26651 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26652 (No scheduling is implemented for this chip.)
26654 @item eden-x4
26655 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26656 AVX and AVX2 instruction set support.
26657 (No scheduling is implemented for this chip.)
26659 @item nano
26660 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26661 instruction set support.
26662 (No scheduling is implemented for this chip.)
26664 @item nano-1000
26665 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26666 instruction set support.
26667 (No scheduling is implemented for this chip.)
26669 @item nano-2000
26670 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26671 instruction set support.
26672 (No scheduling is implemented for this chip.)
26674 @item nano-3000
26675 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26676 instruction set support.
26677 (No scheduling is implemented for this chip.)
26679 @item nano-x2
26680 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26681 instruction set support.
26682 (No scheduling is implemented for this chip.)
26684 @item nano-x4
26685 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26686 instruction set support.
26687 (No scheduling is implemented for this chip.)
26689 @item geode
26690 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26691 @end table
26693 @item -mtune=@var{cpu-type}
26694 @opindex mtune
26695 Tune to @var{cpu-type} everything applicable about the generated code, except
26696 for the ABI and the set of available instructions.  
26697 While picking a specific @var{cpu-type} schedules things appropriately
26698 for that particular chip, the compiler does not generate any code that
26699 cannot run on the default machine type unless you use a
26700 @option{-march=@var{cpu-type}} option.
26701 For example, if GCC is configured for i686-pc-linux-gnu
26702 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26703 but still runs on i686 machines.
26705 The choices for @var{cpu-type} are the same as for @option{-march}.
26706 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26708 @table @samp
26709 @item generic
26710 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26711 If you know the CPU on which your code will run, then you should use
26712 the corresponding @option{-mtune} or @option{-march} option instead of
26713 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26714 of your application will have, then you should use this option.
26716 As new processors are deployed in the marketplace, the behavior of this
26717 option will change.  Therefore, if you upgrade to a newer version of
26718 GCC, code generation controlled by this option will change to reflect
26719 the processors
26720 that are most common at the time that version of GCC is released.
26722 There is no @option{-march=generic} option because @option{-march}
26723 indicates the instruction set the compiler can use, and there is no
26724 generic instruction set applicable to all processors.  In contrast,
26725 @option{-mtune} indicates the processor (or, in this case, collection of
26726 processors) for which the code is optimized.
26728 @item intel
26729 Produce code optimized for the most current Intel processors, which are
26730 Haswell and Silvermont for this version of GCC.  If you know the CPU
26731 on which your code will run, then you should use the corresponding
26732 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26733 But, if you want your application performs better on both Haswell and
26734 Silvermont, then you should use this option.
26736 As new Intel processors are deployed in the marketplace, the behavior of
26737 this 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 most current Intel processors at the time that version of GCC is
26740 released.
26742 There is no @option{-march=intel} option because @option{-march} indicates
26743 the instruction set the compiler can use, and there is no common
26744 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.
26747 @end table
26749 @item -mcpu=@var{cpu-type}
26750 @opindex mcpu
26751 A deprecated synonym for @option{-mtune}.
26753 @item -mfpmath=@var{unit}
26754 @opindex mfpmath
26755 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26756 for @var{unit} are:
26758 @table @samp
26759 @item 387
26760 Use the standard 387 floating-point coprocessor present on the majority of chips and
26761 emulated otherwise.  Code compiled with this option runs almost everywhere.
26762 The temporary results are computed in 80-bit precision instead of the precision
26763 specified by the type, resulting in slightly different results compared to most
26764 of other chips.  See @option{-ffloat-store} for more detailed description.
26766 This is the default choice for non-Darwin x86-32 targets.
26768 @item sse
26769 Use scalar floating-point instructions present in the SSE instruction set.
26770 This instruction set is supported by Pentium III and newer chips,
26771 and in the AMD line
26772 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26773 instruction set supports only single-precision arithmetic, thus the double and
26774 extended-precision arithmetic are still done using 387.  A later version, present
26775 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26776 arithmetic too.
26778 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26779 or @option{-msse2} switches to enable SSE extensions and make this option
26780 effective.  For the x86-64 compiler, these extensions are enabled by default.
26782 The resulting code should be considerably faster in the majority of cases and avoid
26783 the numerical instability problems of 387 code, but may break some existing
26784 code that expects temporaries to be 80 bits.
26786 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26787 and the default choice for x86-32 targets with the SSE2 instruction set
26788 when @option{-ffast-math} is enabled.
26790 @item sse,387
26791 @itemx sse+387
26792 @itemx both
26793 Attempt to utilize both instruction sets at once.  This effectively doubles the
26794 amount of available registers, and on chips with separate execution units for
26795 387 and SSE the execution resources too.  Use this option with care, as it is
26796 still experimental, because the GCC register allocator does not model separate
26797 functional units well, resulting in unstable performance.
26798 @end table
26800 @item -masm=@var{dialect}
26801 @opindex masm=@var{dialect}
26802 Output assembly instructions using selected @var{dialect}.  Also affects
26803 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26804 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26805 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26806 not support @samp{intel}.
26808 @item -mieee-fp
26809 @itemx -mno-ieee-fp
26810 @opindex mieee-fp
26811 @opindex mno-ieee-fp
26812 Control whether or not the compiler uses IEEE floating-point
26813 comparisons.  These correctly handle the case where the result of a
26814 comparison is unordered.
26816 @item -m80387
26817 @itemx -mhard-float
26818 @opindex 80387
26819 @opindex mhard-float
26820 Generate output containing 80387 instructions for floating point.
26822 @item -mno-80387
26823 @itemx -msoft-float
26824 @opindex no-80387
26825 @opindex msoft-float
26826 Generate output containing library calls for floating point.
26828 @strong{Warning:} the requisite libraries are not part of GCC@.
26829 Normally the facilities of the machine's usual C compiler are used, but
26830 this cannot be done directly in cross-compilation.  You must make your
26831 own arrangements to provide suitable library functions for
26832 cross-compilation.
26834 On machines where a function returns floating-point results in the 80387
26835 register stack, some floating-point opcodes may be emitted even if
26836 @option{-msoft-float} is used.
26838 @item -mno-fp-ret-in-387
26839 @opindex mno-fp-ret-in-387
26840 Do not use the FPU registers for return values of functions.
26842 The usual calling convention has functions return values of types
26843 @code{float} and @code{double} in an FPU register, even if there
26844 is no FPU@.  The idea is that the operating system should emulate
26845 an FPU@.
26847 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26848 in ordinary CPU registers instead.
26850 @item -mno-fancy-math-387
26851 @opindex mno-fancy-math-387
26852 Some 387 emulators do not support the @code{sin}, @code{cos} and
26853 @code{sqrt} instructions for the 387.  Specify this option to avoid
26854 generating those instructions.  This option is the default on
26855 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26856 indicates that the target CPU always has an FPU and so the
26857 instruction does not need emulation.  These
26858 instructions are not generated unless you also use the
26859 @option{-funsafe-math-optimizations} switch.
26861 @item -malign-double
26862 @itemx -mno-align-double
26863 @opindex malign-double
26864 @opindex mno-align-double
26865 Control whether GCC aligns @code{double}, @code{long double}, and
26866 @code{long long} variables on a two-word boundary or a one-word
26867 boundary.  Aligning @code{double} variables on a two-word boundary
26868 produces code that runs somewhat faster on a Pentium at the
26869 expense of more memory.
26871 On x86-64, @option{-malign-double} is enabled by default.
26873 @strong{Warning:} if you use the @option{-malign-double} switch,
26874 structures containing the above types are aligned differently than
26875 the published application binary interface specifications for the x86-32
26876 and are not binary compatible with structures in code compiled
26877 without that switch.
26879 @item -m96bit-long-double
26880 @itemx -m128bit-long-double
26881 @opindex m96bit-long-double
26882 @opindex m128bit-long-double
26883 These switches control the size of @code{long double} type.  The x86-32
26884 application binary interface specifies the size to be 96 bits,
26885 so @option{-m96bit-long-double} is the default in 32-bit mode.
26887 Modern architectures (Pentium and newer) prefer @code{long double}
26888 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26889 conforming to the ABI, this is not possible.  So specifying
26890 @option{-m128bit-long-double} aligns @code{long double}
26891 to a 16-byte boundary by padding the @code{long double} with an additional
26892 32-bit zero.
26894 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26895 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26897 Notice that neither of these options enable any extra precision over the x87
26898 standard of 80 bits for a @code{long double}.
26900 @strong{Warning:} if you override the default value for your target ABI, this
26901 changes the size of 
26902 structures and arrays containing @code{long double} variables,
26903 as well as modifying the function calling convention for functions taking
26904 @code{long double}.  Hence they are not binary-compatible
26905 with code compiled without that switch.
26907 @item -mlong-double-64
26908 @itemx -mlong-double-80
26909 @itemx -mlong-double-128
26910 @opindex mlong-double-64
26911 @opindex mlong-double-80
26912 @opindex mlong-double-128
26913 These switches control the size of @code{long double} type. A size
26914 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26915 type. This is the default for 32-bit Bionic C library.  A size
26916 of 128 bits makes the @code{long double} type equivalent to the
26917 @code{__float128} type. This is the default for 64-bit Bionic C library.
26919 @strong{Warning:} if you override the default value for your target ABI, this
26920 changes the size of
26921 structures and arrays containing @code{long double} variables,
26922 as well as modifying the function calling convention for functions taking
26923 @code{long double}.  Hence they are not binary-compatible
26924 with code compiled without that switch.
26926 @item -malign-data=@var{type}
26927 @opindex malign-data
26928 Control how GCC aligns variables.  Supported values for @var{type} are
26929 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26930 and earlier, @samp{abi} uses alignment value as specified by the
26931 psABI, and @samp{cacheline} uses increased alignment value to match
26932 the cache line size.  @samp{compat} is the default.
26934 @item -mlarge-data-threshold=@var{threshold}
26935 @opindex mlarge-data-threshold
26936 When @option{-mcmodel=medium} is specified, data objects larger than
26937 @var{threshold} are placed in the large data section.  This value must be the
26938 same across all objects linked into the binary, and defaults to 65535.
26940 @item -mrtd
26941 @opindex mrtd
26942 Use a different function-calling convention, in which functions that
26943 take a fixed number of arguments return with the @code{ret @var{num}}
26944 instruction, which pops their arguments while returning.  This saves one
26945 instruction in the caller since there is no need to pop the arguments
26946 there.
26948 You can specify that an individual function is called with this calling
26949 sequence with the function attribute @code{stdcall}.  You can also
26950 override the @option{-mrtd} option by using the function attribute
26951 @code{cdecl}.  @xref{Function Attributes}.
26953 @strong{Warning:} this calling convention is incompatible with the one
26954 normally used on Unix, so you cannot use it if you need to call
26955 libraries compiled with the Unix compiler.
26957 Also, you must provide function prototypes for all functions that
26958 take variable numbers of arguments (including @code{printf});
26959 otherwise incorrect code is generated for calls to those
26960 functions.
26962 In addition, seriously incorrect code results if you call a
26963 function with too many arguments.  (Normally, extra arguments are
26964 harmlessly ignored.)
26966 @item -mregparm=@var{num}
26967 @opindex mregparm
26968 Control how many registers are used to pass integer arguments.  By
26969 default, no registers are used to pass arguments, and at most 3
26970 registers can be used.  You can control this behavior for a specific
26971 function by using the function attribute @code{regparm}.
26972 @xref{Function Attributes}.
26974 @strong{Warning:} if you use this switch, and
26975 @var{num} is nonzero, then you must build all modules with the same
26976 value, including any libraries.  This includes the system libraries and
26977 startup modules.
26979 @item -msseregparm
26980 @opindex msseregparm
26981 Use SSE register passing conventions for float and double arguments
26982 and return values.  You can control this behavior for a specific
26983 function by using the function attribute @code{sseregparm}.
26984 @xref{Function Attributes}.
26986 @strong{Warning:} if you use this switch then you must build all
26987 modules with the same value, including any libraries.  This includes
26988 the system libraries and startup modules.
26990 @item -mvect8-ret-in-mem
26991 @opindex mvect8-ret-in-mem
26992 Return 8-byte vectors in memory instead of MMX registers.  This is the
26993 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
26994 Studio compilers until version 12.  Later compiler versions (starting
26995 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
26996 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
26997 you need to remain compatible with existing code produced by those
26998 previous compiler versions or older versions of GCC@.
27000 @item -mpc32
27001 @itemx -mpc64
27002 @itemx -mpc80
27003 @opindex mpc32
27004 @opindex mpc64
27005 @opindex mpc80
27007 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27008 is specified, the significands of results of floating-point operations are
27009 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27010 significands of results of floating-point operations to 53 bits (double
27011 precision) and @option{-mpc80} rounds the significands of results of
27012 floating-point operations to 64 bits (extended double precision), which is
27013 the default.  When this option is used, floating-point operations in higher
27014 precisions are not available to the programmer without setting the FPU
27015 control word explicitly.
27017 Setting the rounding of floating-point operations to less than the default
27018 80 bits can speed some programs by 2% or more.  Note that some mathematical
27019 libraries assume that extended-precision (80-bit) floating-point operations
27020 are enabled by default; routines in such libraries could suffer significant
27021 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27022 when this option is used to set the precision to less than extended precision.
27024 @item -mstackrealign
27025 @opindex mstackrealign
27026 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27027 option generates an alternate prologue and epilogue that realigns the
27028 run-time stack if necessary.  This supports mixing legacy codes that keep
27029 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27030 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27031 applicable to individual functions.
27033 @item -mpreferred-stack-boundary=@var{num}
27034 @opindex mpreferred-stack-boundary
27035 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27036 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27037 the default is 4 (16 bytes or 128 bits).
27039 @strong{Warning:} When generating code for the x86-64 architecture with
27040 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27041 used to keep the stack boundary aligned to 8 byte boundary.  Since
27042 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27043 intended to be used in controlled environment where stack space is
27044 important limitation.  This option leads to wrong code when functions
27045 compiled with 16 byte stack alignment (such as functions from a standard
27046 library) are called with misaligned stack.  In this case, SSE
27047 instructions may lead to misaligned memory access traps.  In addition,
27048 variable arguments are handled incorrectly for 16 byte aligned
27049 objects (including x87 long double and __int128), leading to wrong
27050 results.  You must build all modules with
27051 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27052 includes the system libraries and startup modules.
27054 @item -mincoming-stack-boundary=@var{num}
27055 @opindex mincoming-stack-boundary
27056 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27057 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27058 the one specified by @option{-mpreferred-stack-boundary} is used.
27060 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27061 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27062 suffer significant run time performance penalties.  On Pentium III, the
27063 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27064 properly if it is not 16-byte aligned.
27066 To ensure proper alignment of this values on the stack, the stack boundary
27067 must be as aligned as that required by any value stored on the stack.
27068 Further, every function must be generated such that it keeps the stack
27069 aligned.  Thus calling a function compiled with a higher preferred
27070 stack boundary from a function compiled with a lower preferred stack
27071 boundary most likely misaligns the stack.  It is recommended that
27072 libraries that use callbacks always use the default setting.
27074 This extra alignment does consume extra stack space, and generally
27075 increases code size.  Code that is sensitive to stack space usage, such
27076 as embedded systems and operating system kernels, may want to reduce the
27077 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27079 @need 200
27080 @item -mmmx
27081 @opindex mmmx
27082 @need 200
27083 @itemx -msse
27084 @opindex msse
27085 @need 200
27086 @itemx -msse2
27087 @opindex msse2
27088 @need 200
27089 @itemx -msse3
27090 @opindex msse3
27091 @need 200
27092 @itemx -mssse3
27093 @opindex mssse3
27094 @need 200
27095 @itemx -msse4
27096 @opindex msse4
27097 @need 200
27098 @itemx -msse4a
27099 @opindex msse4a
27100 @need 200
27101 @itemx -msse4.1
27102 @opindex msse4.1
27103 @need 200
27104 @itemx -msse4.2
27105 @opindex msse4.2
27106 @need 200
27107 @itemx -mavx
27108 @opindex mavx
27109 @need 200
27110 @itemx -mavx2
27111 @opindex mavx2
27112 @need 200
27113 @itemx -mavx512f
27114 @opindex mavx512f
27115 @need 200
27116 @itemx -mavx512pf
27117 @opindex mavx512pf
27118 @need 200
27119 @itemx -mavx512er
27120 @opindex mavx512er
27121 @need 200
27122 @itemx -mavx512cd
27123 @opindex mavx512cd
27124 @need 200
27125 @itemx -mavx512vl
27126 @opindex mavx512vl
27127 @need 200
27128 @itemx -mavx512bw
27129 @opindex mavx512bw
27130 @need 200
27131 @itemx -mavx512dq
27132 @opindex mavx512dq
27133 @need 200
27134 @itemx -mavx512ifma
27135 @opindex mavx512ifma
27136 @need 200
27137 @itemx -mavx512vbmi
27138 @opindex mavx512vbmi
27139 @need 200
27140 @itemx -msha
27141 @opindex msha
27142 @need 200
27143 @itemx -maes
27144 @opindex maes
27145 @need 200
27146 @itemx -mpclmul
27147 @opindex mpclmul
27148 @need 200
27149 @itemx -mclflushopt
27150 @opindex mclflushopt
27151 @need 200
27152 @itemx -mfsgsbase
27153 @opindex mfsgsbase
27154 @need 200
27155 @itemx -mrdrnd
27156 @opindex mrdrnd
27157 @need 200
27158 @itemx -mf16c
27159 @opindex mf16c
27160 @need 200
27161 @itemx -mfma
27162 @opindex mfma
27163 @need 200
27164 @itemx -mpconfig
27165 @opindex mpconfig
27166 @need 200
27167 @itemx -mwbnoinvd
27168 @opindex mwbnoinvd
27169 @need 200
27170 @itemx -mfma4
27171 @opindex mfma4
27172 @need 200
27173 @itemx -mprefetchwt1
27174 @opindex mprefetchwt1
27175 @need 200
27176 @itemx -mxop
27177 @opindex mxop
27178 @need 200
27179 @itemx -mlwp
27180 @opindex mlwp
27181 @need 200
27182 @itemx -m3dnow
27183 @opindex m3dnow
27184 @need 200
27185 @itemx -m3dnowa
27186 @opindex m3dnowa
27187 @need 200
27188 @itemx -mpopcnt
27189 @opindex mpopcnt
27190 @need 200
27191 @itemx -mabm
27192 @opindex mabm
27193 @need 200
27194 @itemx -mbmi
27195 @opindex mbmi
27196 @need 200
27197 @itemx -mbmi2
27198 @need 200
27199 @itemx -mlzcnt
27200 @opindex mlzcnt
27201 @need 200
27202 @itemx -mfxsr
27203 @opindex mfxsr
27204 @need 200
27205 @itemx -mxsave
27206 @opindex mxsave
27207 @need 200
27208 @itemx -mxsaveopt
27209 @opindex mxsaveopt
27210 @need 200
27211 @itemx -mxsavec
27212 @opindex mxsavec
27213 @need 200
27214 @itemx -mxsaves
27215 @opindex mxsaves
27216 @need 200
27217 @itemx -mrtm
27218 @opindex mrtm
27219 @need 200
27220 @itemx -mtbm
27221 @opindex mtbm
27222 @need 200
27223 @itemx -mmwaitx
27224 @opindex mmwaitx
27225 @need 200
27226 @itemx -mclzero
27227 @opindex mclzero
27228 @need 200
27229 @itemx -mpku
27230 @opindex mpku
27231 @need 200
27232 @itemx -mavx512vbmi2
27233 @opindex mavx512vbmi2
27234 @need 200
27235 @itemx -mgfni
27236 @opindex mgfni
27237 @need 200
27238 @itemx -mvaes
27239 @opindex mvaes
27240 @need 200
27241 @itemx -mwaitpkg
27242 @opindex -mwaitpkg
27243 @need 200
27244 @itemx -mvpclmulqdq
27245 @opindex mvpclmulqdq
27246 @need 200
27247 @itemx -mavx512bitalg
27248 @opindex mavx512bitalg
27249 @need 200
27250 @itemx -mmovdiri
27251 @opindex mmovdiri
27252 @need 200
27253 @itemx -mmovdir64b
27254 @opindex mmovdir64b
27255 @need 200
27256 @itemx -mavx512vpopcntdq
27257 @opindex mavx512vpopcntdq
27258 @need 200
27259 @itemx -mcldemote
27260 @opindex mcldemote
27261 These switches enable the use of instructions in the MMX, SSE,
27262 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27263 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27264 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES, WAITPKG,
27265 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27266 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
27267 AVX512VPOPCNTDQ, CLDEMOTE, 3DNow!@: or enhanced 3DNow!@: extended instruction
27268 sets. Each has a corresponding @option{-mno-} option to disable use of these
27269 instructions.
27271 These extensions are also available as built-in functions: see
27272 @ref{x86 Built-in Functions}, for details of the functions enabled and
27273 disabled by these switches.
27275 To generate SSE/SSE2 instructions automatically from floating-point
27276 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27278 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27279 generates new AVX instructions or AVX equivalence for all SSEx instructions
27280 when needed.
27282 These options enable GCC to use these extended instructions in
27283 generated code, even without @option{-mfpmath=sse}.  Applications that
27284 perform run-time CPU detection must compile separate files for each
27285 supported architecture, using the appropriate flags.  In particular,
27286 the file containing the CPU detection code should be compiled without
27287 these options.
27289 @item -mdump-tune-features
27290 @opindex mdump-tune-features
27291 This option instructs GCC to dump the names of the x86 performance 
27292 tuning features and default settings. The names can be used in 
27293 @option{-mtune-ctrl=@var{feature-list}}.
27295 @item -mtune-ctrl=@var{feature-list}
27296 @opindex mtune-ctrl=@var{feature-list}
27297 This option is used to do fine grain control of x86 code generation features.
27298 @var{feature-list} is a comma separated list of @var{feature} names. See also
27299 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27300 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27301 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27302 developers. Using it may lead to code paths not covered by testing and can
27303 potentially result in compiler ICEs or runtime errors.
27305 @item -mno-default
27306 @opindex mno-default
27307 This option instructs GCC to turn off all tunable features. See also 
27308 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27310 @item -mcld
27311 @opindex mcld
27312 This option instructs GCC to emit a @code{cld} instruction in the prologue
27313 of functions that use string instructions.  String instructions depend on
27314 the DF flag to select between autoincrement or autodecrement mode.  While the
27315 ABI specifies the DF flag to be cleared on function entry, some operating
27316 systems violate this specification by not clearing the DF flag in their
27317 exception dispatchers.  The exception handler can be invoked with the DF flag
27318 set, which leads to wrong direction mode when string instructions are used.
27319 This option can be enabled by default on 32-bit x86 targets by configuring
27320 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27321 instructions can be suppressed with the @option{-mno-cld} compiler option
27322 in this case.
27324 @item -mvzeroupper
27325 @opindex mvzeroupper
27326 This option instructs GCC to emit a @code{vzeroupper} instruction
27327 before a transfer of control flow out of the function to minimize
27328 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27329 intrinsics.
27331 @item -mprefer-avx128
27332 @opindex mprefer-avx128
27333 This option instructs GCC to use 128-bit AVX instructions instead of
27334 256-bit AVX instructions in the auto-vectorizer.
27336 @item -mprefer-vector-width=@var{opt}
27337 @opindex mprefer-vector-width
27338 This option instructs GCC to use @var{opt}-bit vector width in instructions
27339 instead of default on the selected platform.
27341 @table @samp
27342 @item none
27343 No extra limitations applied to GCC other than defined by the selected platform.
27345 @item 128
27346 Prefer 128-bit vector width for instructions.
27348 @item 256
27349 Prefer 256-bit vector width for instructions.
27351 @item 512
27352 Prefer 512-bit vector width for instructions.
27353 @end table
27355 @item -mcx16
27356 @opindex mcx16
27357 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27358 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27359 objects.  This is useful for atomic updates of data structures exceeding one
27360 machine word in size.  The compiler uses this instruction to implement
27361 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27362 128-bit integers, a library call is always used.
27364 @item -msahf
27365 @opindex msahf
27366 This option enables generation of @code{SAHF} instructions in 64-bit code.
27367 Early Intel Pentium 4 CPUs with Intel 64 support,
27368 prior to the introduction of Pentium 4 G1 step in December 2005,
27369 lacked the @code{LAHF} and @code{SAHF} instructions
27370 which are supported by AMD64.
27371 These are load and store instructions, respectively, for certain status flags.
27372 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27373 @code{drem}, and @code{remainder} built-in functions;
27374 see @ref{Other Builtins} for details.
27376 @item -mmovbe
27377 @opindex mmovbe
27378 This option enables use of the @code{movbe} instruction to implement
27379 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27381 @item -mshstk
27382 @opindex mshstk
27383 The @option{-mshstk} option enables shadow stack built-in functions
27384 from x86 Control-flow Enforcement Technology (CET).
27386 @item -mcrc32
27387 @opindex mcrc32
27388 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27389 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27390 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27392 @item -mrecip
27393 @opindex mrecip
27394 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27395 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27396 with an additional Newton-Raphson step
27397 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27398 (and their vectorized
27399 variants) for single-precision floating-point arguments.  These instructions
27400 are generated only when @option{-funsafe-math-optimizations} is enabled
27401 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27402 Note that while the throughput of the sequence is higher than the throughput
27403 of the non-reciprocal instruction, the precision of the sequence can be
27404 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27406 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27407 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27408 combination), and doesn't need @option{-mrecip}.
27410 Also note that GCC emits the above sequence with additional Newton-Raphson step
27411 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27412 already with @option{-ffast-math} (or the above option combination), and
27413 doesn't need @option{-mrecip}.
27415 @item -mrecip=@var{opt}
27416 @opindex mrecip=opt
27417 This option controls which reciprocal estimate instructions
27418 may be used.  @var{opt} is a comma-separated list of options, which may
27419 be preceded by a @samp{!} to invert the option:
27421 @table @samp
27422 @item all
27423 Enable all estimate instructions.
27425 @item default
27426 Enable the default instructions, equivalent to @option{-mrecip}.
27428 @item none
27429 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27431 @item div
27432 Enable the approximation for scalar division.
27434 @item vec-div
27435 Enable the approximation for vectorized division.
27437 @item sqrt
27438 Enable the approximation for scalar square root.
27440 @item vec-sqrt
27441 Enable the approximation for vectorized square root.
27442 @end table
27444 So, for example, @option{-mrecip=all,!sqrt} enables
27445 all of the reciprocal approximations, except for square root.
27447 @item -mveclibabi=@var{type}
27448 @opindex mveclibabi
27449 Specifies the ABI type to use for vectorizing intrinsics using an
27450 external library.  Supported values for @var{type} are @samp{svml} 
27451 for the Intel short
27452 vector math library and @samp{acml} for the AMD math core library.
27453 To use this option, both @option{-ftree-vectorize} and
27454 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27455 ABI-compatible library must be specified at link time.
27457 GCC currently emits calls to @code{vmldExp2},
27458 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27459 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27460 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27461 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27462 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27463 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27464 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27465 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27466 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27467 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27468 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27469 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27470 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27471 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27472 when @option{-mveclibabi=acml} is used.  
27474 @item -mabi=@var{name}
27475 @opindex mabi
27476 Generate code for the specified calling convention.  Permissible values
27477 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27478 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27479 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27480 You can control this behavior for specific functions by
27481 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27482 @xref{Function Attributes}.
27484 @item -mforce-indirect-call
27485 @opindex mforce-indirect-call
27486 Force all calls to functions to be indirect. This is useful
27487 when using Intel Processor Trace where it generates more precise timing
27488 information for function calls.
27490 @item -mcall-ms2sysv-xlogues
27491 @opindex mcall-ms2sysv-xlogues
27492 @opindex mno-call-ms2sysv-xlogues
27493 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27494 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27495 default, the code for saving and restoring these registers is emitted inline,
27496 resulting in fairly lengthy prologues and epilogues.  Using
27497 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27498 use stubs in the static portion of libgcc to perform these saves and restores,
27499 thus reducing function size at the cost of a few extra instructions.
27501 @item -mtls-dialect=@var{type}
27502 @opindex mtls-dialect
27503 Generate code to access thread-local storage using the @samp{gnu} or
27504 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27505 @samp{gnu2} is more efficient, but it may add compile- and run-time
27506 requirements that cannot be satisfied on all systems.
27508 @item -mpush-args
27509 @itemx -mno-push-args
27510 @opindex mpush-args
27511 @opindex mno-push-args
27512 Use PUSH operations to store outgoing parameters.  This method is shorter
27513 and usually equally fast as method using SUB/MOV operations and is enabled
27514 by default.  In some cases disabling it may improve performance because of
27515 improved scheduling and reduced dependencies.
27517 @item -maccumulate-outgoing-args
27518 @opindex maccumulate-outgoing-args
27519 If enabled, the maximum amount of space required for outgoing arguments is
27520 computed in the function prologue.  This is faster on most modern CPUs
27521 because of reduced dependencies, improved scheduling and reduced stack usage
27522 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27523 increase in code size.  This switch implies @option{-mno-push-args}.
27525 @item -mthreads
27526 @opindex mthreads
27527 Support thread-safe exception handling on MinGW.  Programs that rely
27528 on thread-safe exception handling must compile and link all code with the
27529 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27530 @option{-D_MT}; when linking, it links in a special thread helper library
27531 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27533 @item -mms-bitfields
27534 @itemx -mno-ms-bitfields
27535 @opindex mms-bitfields
27536 @opindex mno-ms-bitfields
27538 Enable/disable bit-field layout compatible with the native Microsoft
27539 Windows compiler.  
27541 If @code{packed} is used on a structure, or if bit-fields are used,
27542 it may be that the Microsoft ABI lays out the structure differently
27543 than the way GCC normally does.  Particularly when moving packed
27544 data between functions compiled with GCC and the native Microsoft compiler
27545 (either via function call or as data in a file), it may be necessary to access
27546 either format.
27548 This option is enabled by default for Microsoft Windows
27549 targets.  This behavior can also be controlled locally by use of variable
27550 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27551 and @ref{x86 Type Attributes}.
27553 The Microsoft structure layout algorithm is fairly simple with the exception
27554 of the bit-field packing.  
27555 The padding and alignment of members of structures and whether a bit-field 
27556 can straddle a storage-unit boundary are determine by these rules:
27558 @enumerate
27559 @item Structure members are stored sequentially in the order in which they are
27560 declared: the first member has the lowest memory address and the last member
27561 the highest.
27563 @item Every data object has an alignment requirement.  The alignment requirement
27564 for all data except structures, unions, and arrays is either the size of the
27565 object or the current packing size (specified with either the
27566 @code{aligned} attribute or the @code{pack} pragma),
27567 whichever is less.  For structures, unions, and arrays,
27568 the alignment requirement is the largest alignment requirement of its members.
27569 Every object is allocated an offset so that:
27571 @smallexample
27572 offset % alignment_requirement == 0
27573 @end smallexample
27575 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27576 unit if the integral types are the same size and if the next bit-field fits
27577 into the current allocation unit without crossing the boundary imposed by the
27578 common alignment requirements of the bit-fields.
27579 @end enumerate
27581 MSVC interprets zero-length bit-fields in the following ways:
27583 @enumerate
27584 @item If a zero-length bit-field is inserted between two bit-fields that
27585 are normally coalesced, the bit-fields are not coalesced.
27587 For example:
27589 @smallexample
27590 struct
27591  @{
27592    unsigned long bf_1 : 12;
27593    unsigned long : 0;
27594    unsigned long bf_2 : 12;
27595  @} t1;
27596 @end smallexample
27598 @noindent
27599 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27600 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27602 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27603 alignment of the zero-length bit-field is greater than the member that follows it,
27604 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27606 For example:
27608 @smallexample
27609 struct
27610  @{
27611    char foo : 4;
27612    short : 0;
27613    char bar;
27614  @} t2;
27616 struct
27617  @{
27618    char foo : 4;
27619    short : 0;
27620    double bar;
27621  @} t3;
27622 @end smallexample
27624 @noindent
27625 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27626 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27627 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27628 of the structure.
27630 Taking this into account, it is important to note the following:
27632 @enumerate
27633 @item If a zero-length bit-field follows a normal bit-field, the type of the
27634 zero-length bit-field may affect the alignment of the structure as whole. For
27635 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27636 normal bit-field, and is of type short.
27638 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27639 still affect the alignment of the structure:
27641 @smallexample
27642 struct
27643  @{
27644    char foo : 6;
27645    long : 0;
27646  @} t4;
27647 @end smallexample
27649 @noindent
27650 Here, @code{t4} takes up 4 bytes.
27651 @end enumerate
27653 @item Zero-length bit-fields following non-bit-field members are ignored:
27655 @smallexample
27656 struct
27657  @{
27658    char foo;
27659    long : 0;
27660    char bar;
27661  @} t5;
27662 @end smallexample
27664 @noindent
27665 Here, @code{t5} takes up 2 bytes.
27666 @end enumerate
27669 @item -mno-align-stringops
27670 @opindex mno-align-stringops
27671 Do not align the destination of inlined string operations.  This switch reduces
27672 code size and improves performance in case the destination is already aligned,
27673 but GCC doesn't know about it.
27675 @item -minline-all-stringops
27676 @opindex minline-all-stringops
27677 By default GCC inlines string operations only when the destination is 
27678 known to be aligned to least a 4-byte boundary.  
27679 This enables more inlining and increases code
27680 size, but may improve performance of code that depends on fast
27681 @code{memcpy}, @code{strlen},
27682 and @code{memset} for short lengths.
27684 @item -minline-stringops-dynamically
27685 @opindex minline-stringops-dynamically
27686 For string operations of unknown size, use run-time checks with
27687 inline code for small blocks and a library call for large blocks.
27689 @item -mstringop-strategy=@var{alg}
27690 @opindex mstringop-strategy=@var{alg}
27691 Override the internal decision heuristic for the particular algorithm to use
27692 for inlining string operations.  The allowed values for @var{alg} are:
27694 @table @samp
27695 @item rep_byte
27696 @itemx rep_4byte
27697 @itemx rep_8byte
27698 Expand using i386 @code{rep} prefix of the specified size.
27700 @item byte_loop
27701 @itemx loop
27702 @itemx unrolled_loop
27703 Expand into an inline loop.
27705 @item libcall
27706 Always use a library call.
27707 @end table
27709 @item -mmemcpy-strategy=@var{strategy}
27710 @opindex mmemcpy-strategy=@var{strategy}
27711 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27712 should be inlined and what inline algorithm to use when the expected size
27713 of the copy operation is known. @var{strategy} 
27714 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27715 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27716 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27717 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27718 in the list must be specified in increasing order.  The minimal byte size for 
27719 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27720 preceding range.
27722 @item -mmemset-strategy=@var{strategy}
27723 @opindex mmemset-strategy=@var{strategy}
27724 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27725 @code{__builtin_memset} expansion.
27727 @item -momit-leaf-frame-pointer
27728 @opindex momit-leaf-frame-pointer
27729 Don't keep the frame pointer in a register for leaf functions.  This
27730 avoids the instructions to save, set up, and restore frame pointers and
27731 makes an extra register available in leaf functions.  The option
27732 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27733 which might make debugging harder.
27735 @item -mtls-direct-seg-refs
27736 @itemx -mno-tls-direct-seg-refs
27737 @opindex mtls-direct-seg-refs
27738 Controls whether TLS variables may be accessed with offsets from the
27739 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27740 or whether the thread base pointer must be added.  Whether or not this
27741 is valid depends on the operating system, and whether it maps the
27742 segment to cover the entire TLS area.
27744 For systems that use the GNU C Library, the default is on.
27746 @item -msse2avx
27747 @itemx -mno-sse2avx
27748 @opindex msse2avx
27749 Specify that the assembler should encode SSE instructions with VEX
27750 prefix.  The option @option{-mavx} turns this on by default.
27752 @item -mfentry
27753 @itemx -mno-fentry
27754 @opindex mfentry
27755 If profiling is active (@option{-pg}), put the profiling
27756 counter call before the prologue.
27757 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27758 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27760 @item -mrecord-mcount
27761 @itemx -mno-record-mcount
27762 @opindex mrecord-mcount
27763 If profiling is active (@option{-pg}), generate a __mcount_loc section
27764 that contains pointers to each profiling call. This is useful for
27765 automatically patching and out calls.
27767 @item -mnop-mcount
27768 @itemx -mno-nop-mcount
27769 @opindex mnop-mcount
27770 If profiling is active (@option{-pg}), generate the calls to
27771 the profiling functions as NOPs. This is useful when they
27772 should be patched in later dynamically. This is likely only
27773 useful together with @option{-mrecord-mcount}.
27775 @item -mskip-rax-setup
27776 @itemx -mno-skip-rax-setup
27777 @opindex mskip-rax-setup
27778 When generating code for the x86-64 architecture with SSE extensions
27779 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27780 register when there are no variable arguments passed in vector registers.
27782 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27783 saving vector registers on stack when passing variable arguments, the
27784 impacts of this option are callees may waste some stack space,
27785 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27786 those issues, regardless the RAX register value.
27788 @item -m8bit-idiv
27789 @itemx -mno-8bit-idiv
27790 @opindex m8bit-idiv
27791 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27792 much faster than 32-bit/64-bit integer divide.  This option generates a
27793 run-time check.  If both dividend and divisor are within range of 0
27794 to 255, 8-bit unsigned integer divide is used instead of
27795 32-bit/64-bit integer divide.
27797 @item -mavx256-split-unaligned-load
27798 @itemx -mavx256-split-unaligned-store
27799 @opindex mavx256-split-unaligned-load
27800 @opindex mavx256-split-unaligned-store
27801 Split 32-byte AVX unaligned load and store.
27803 @item -mstack-protector-guard=@var{guard}
27804 @itemx -mstack-protector-guard-reg=@var{reg}
27805 @itemx -mstack-protector-guard-offset=@var{offset}
27806 @opindex mstack-protector-guard
27807 @opindex mstack-protector-guard-reg
27808 @opindex mstack-protector-guard-offset
27809 Generate stack protection code using canary at @var{guard}.  Supported
27810 locations are @samp{global} for global canary or @samp{tls} for per-thread
27811 canary in the TLS block (the default).  This option has effect only when
27812 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27814 With the latter choice the options
27815 @option{-mstack-protector-guard-reg=@var{reg}} and
27816 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27817 which segment register (@code{%fs} or @code{%gs}) to use as base register
27818 for reading the canary, and from what offset from that base register.
27819 The default for those is as specified in the relevant ABI.
27821 @item -mmitigate-rop
27822 @opindex mmitigate-rop
27823 Try to avoid generating code sequences that contain unintended return
27824 opcodes, to mitigate against certain forms of attack. At the moment,
27825 this option is limited in what it can do and should not be relied
27826 on to provide serious protection.
27828 @item -mgeneral-regs-only
27829 @opindex mgeneral-regs-only
27830 Generate code that uses only the general-purpose registers.  This
27831 prevents the compiler from using floating-point, vector, mask and bound
27832 registers.
27834 @item -mindirect-branch=@var{choice}
27835 @opindex -mindirect-branch
27836 Convert indirect call and jump with @var{choice}.  The default is
27837 @samp{keep}, which keeps indirect call and jump unmodified.
27838 @samp{thunk} converts indirect call and jump to call and return thunk.
27839 @samp{thunk-inline} converts indirect call and jump to inlined call
27840 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27841 to external call and return thunk provided in a separate object file.
27842 You can control this behavior for a specific function by using the
27843 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27845 Note that @option{-mcmodel=large} is incompatible with
27846 @option{-mindirect-branch=thunk} and
27847 @option{-mindirect-branch=thunk-extern} since the thunk function may
27848 not be reachable in the large code model.
27850 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27851 @option{-fcf-protection=branch} since the external thunk can not be modified
27852 to disable control-flow check.
27854 @item -mfunction-return=@var{choice}
27855 @opindex -mfunction-return
27856 Convert function return with @var{choice}.  The default is @samp{keep},
27857 which keeps function return unmodified.  @samp{thunk} converts function
27858 return to call and return thunk.  @samp{thunk-inline} converts function
27859 return to inlined call and return thunk.  @samp{thunk-extern} converts
27860 function return to external call and return thunk provided in a separate
27861 object file.  You can control this behavior for a specific function by
27862 using the function attribute @code{function_return}.
27863 @xref{Function Attributes}.
27865 Note that @option{-mcmodel=large} is incompatible with
27866 @option{-mfunction-return=thunk} and
27867 @option{-mfunction-return=thunk-extern} since the thunk function may
27868 not be reachable in the large code model.
27871 @item -mindirect-branch-register
27872 @opindex -mindirect-branch-register
27873 Force indirect call and jump via register.
27875 @end table
27877 These @samp{-m} switches are supported in addition to the above
27878 on x86-64 processors in 64-bit environments.
27880 @table @gcctabopt
27881 @item -m32
27882 @itemx -m64
27883 @itemx -mx32
27884 @itemx -m16
27885 @itemx -miamcu
27886 @opindex m32
27887 @opindex m64
27888 @opindex mx32
27889 @opindex m16
27890 @opindex miamcu
27891 Generate code for a 16-bit, 32-bit or 64-bit environment.
27892 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27893 to 32 bits, and
27894 generates code that runs on any i386 system.
27896 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27897 types to 64 bits, and generates code for the x86-64 architecture.
27898 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27899 and @option{-mdynamic-no-pic} options.
27901 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27902 to 32 bits, and
27903 generates code for the x86-64 architecture.
27905 The @option{-m16} option is the same as @option{-m32}, except for that
27906 it outputs the @code{.code16gcc} assembly directive at the beginning of
27907 the assembly output so that the binary can run in 16-bit mode.
27909 The @option{-miamcu} option generates code which conforms to Intel MCU
27910 psABI.  It requires the @option{-m32} option to be turned on.
27912 @item -mno-red-zone
27913 @opindex mno-red-zone
27914 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27915 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27916 stack pointer that is not modified by signal or interrupt handlers
27917 and therefore can be used for temporary data without adjusting the stack
27918 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27920 @item -mcmodel=small
27921 @opindex mcmodel=small
27922 Generate code for the small code model: the program and its symbols must
27923 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27924 Programs can be statically or dynamically linked.  This is the default
27925 code model.
27927 @item -mcmodel=kernel
27928 @opindex mcmodel=kernel
27929 Generate code for the kernel code model.  The kernel runs in the
27930 negative 2 GB of the address space.
27931 This model has to be used for Linux kernel code.
27933 @item -mcmodel=medium
27934 @opindex mcmodel=medium
27935 Generate code for the medium model: the program is linked in the lower 2
27936 GB of the address space.  Small symbols are also placed there.  Symbols
27937 with sizes larger than @option{-mlarge-data-threshold} are put into
27938 large data or BSS sections and can be located above 2GB.  Programs can
27939 be statically or dynamically linked.
27941 @item -mcmodel=large
27942 @opindex mcmodel=large
27943 Generate code for the large model.  This model makes no assumptions
27944 about addresses and sizes of sections.
27946 @item -maddress-mode=long
27947 @opindex maddress-mode=long
27948 Generate code for long address mode.  This is only supported for 64-bit
27949 and x32 environments.  It is the default address mode for 64-bit
27950 environments.
27952 @item -maddress-mode=short
27953 @opindex maddress-mode=short
27954 Generate code for short address mode.  This is only supported for 32-bit
27955 and x32 environments.  It is the default address mode for 32-bit and
27956 x32 environments.
27957 @end table
27959 @node x86 Windows Options
27960 @subsection x86 Windows Options
27961 @cindex x86 Windows Options
27962 @cindex Windows Options for x86
27964 These additional options are available for Microsoft Windows targets:
27966 @table @gcctabopt
27967 @item -mconsole
27968 @opindex mconsole
27969 This option
27970 specifies that a console application is to be generated, by
27971 instructing the linker to set the PE header subsystem type
27972 required for console applications.
27973 This option is available for Cygwin and MinGW targets and is
27974 enabled by default on those targets.
27976 @item -mdll
27977 @opindex mdll
27978 This option is available for Cygwin and MinGW targets.  It
27979 specifies that a DLL---a dynamic link library---is to be
27980 generated, enabling the selection of the required runtime
27981 startup object and entry point.
27983 @item -mnop-fun-dllimport
27984 @opindex mnop-fun-dllimport
27985 This option is available for Cygwin and MinGW targets.  It
27986 specifies that the @code{dllimport} attribute should be ignored.
27988 @item -mthread
27989 @opindex mthread
27990 This option is available for MinGW targets. It specifies
27991 that MinGW-specific thread support is to be used.
27993 @item -municode
27994 @opindex municode
27995 This option is available for MinGW-w64 targets.  It causes
27996 the @code{UNICODE} preprocessor macro to be predefined, and
27997 chooses Unicode-capable runtime startup code.
27999 @item -mwin32
28000 @opindex mwin32
28001 This option is available for Cygwin and MinGW targets.  It
28002 specifies that the typical Microsoft Windows predefined macros are to
28003 be set in the pre-processor, but does not influence the choice
28004 of runtime library/startup code.
28006 @item -mwindows
28007 @opindex mwindows
28008 This option is available for Cygwin and MinGW targets.  It
28009 specifies that a GUI application is to be generated by
28010 instructing the linker to set the PE header subsystem type
28011 appropriately.
28013 @item -fno-set-stack-executable
28014 @opindex fno-set-stack-executable
28015 This option is available for MinGW targets. It specifies that
28016 the executable flag for the stack used by nested functions isn't
28017 set. This is necessary for binaries running in kernel mode of
28018 Microsoft Windows, as there the User32 API, which is used to set executable
28019 privileges, isn't available.
28021 @item -fwritable-relocated-rdata
28022 @opindex fno-writable-relocated-rdata
28023 This option is available for MinGW and Cygwin targets.  It specifies
28024 that relocated-data in read-only section is put into the @code{.data}
28025 section.  This is a necessary for older runtimes not supporting
28026 modification of @code{.rdata} sections for pseudo-relocation.
28028 @item -mpe-aligned-commons
28029 @opindex mpe-aligned-commons
28030 This option is available for Cygwin and MinGW targets.  It
28031 specifies that the GNU extension to the PE file format that
28032 permits the correct alignment of COMMON variables should be
28033 used when generating code.  It is enabled by default if
28034 GCC detects that the target assembler found during configuration
28035 supports the feature.
28036 @end table
28038 See also under @ref{x86 Options} for standard options.
28040 @node Xstormy16 Options
28041 @subsection Xstormy16 Options
28042 @cindex Xstormy16 Options
28044 These options are defined for Xstormy16:
28046 @table @gcctabopt
28047 @item -msim
28048 @opindex msim
28049 Choose startup files and linker script suitable for the simulator.
28050 @end table
28052 @node Xtensa Options
28053 @subsection Xtensa Options
28054 @cindex Xtensa Options
28056 These options are supported for Xtensa targets:
28058 @table @gcctabopt
28059 @item -mconst16
28060 @itemx -mno-const16
28061 @opindex mconst16
28062 @opindex mno-const16
28063 Enable or disable use of @code{CONST16} instructions for loading
28064 constant values.  The @code{CONST16} instruction is currently not a
28065 standard option from Tensilica.  When enabled, @code{CONST16}
28066 instructions are always used in place of the standard @code{L32R}
28067 instructions.  The use of @code{CONST16} is enabled by default only if
28068 the @code{L32R} instruction is not available.
28070 @item -mfused-madd
28071 @itemx -mno-fused-madd
28072 @opindex mfused-madd
28073 @opindex mno-fused-madd
28074 Enable or disable use of fused multiply/add and multiply/subtract
28075 instructions in the floating-point option.  This has no effect if the
28076 floating-point option is not also enabled.  Disabling fused multiply/add
28077 and multiply/subtract instructions forces the compiler to use separate
28078 instructions for the multiply and add/subtract operations.  This may be
28079 desirable in some cases where strict IEEE 754-compliant results are
28080 required: the fused multiply add/subtract instructions do not round the
28081 intermediate result, thereby producing results with @emph{more} bits of
28082 precision than specified by the IEEE standard.  Disabling fused multiply
28083 add/subtract instructions also ensures that the program output is not
28084 sensitive to the compiler's ability to combine multiply and add/subtract
28085 operations.
28087 @item -mserialize-volatile
28088 @itemx -mno-serialize-volatile
28089 @opindex mserialize-volatile
28090 @opindex mno-serialize-volatile
28091 When this option is enabled, GCC inserts @code{MEMW} instructions before
28092 @code{volatile} memory references to guarantee sequential consistency.
28093 The default is @option{-mserialize-volatile}.  Use
28094 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28096 @item -mforce-no-pic
28097 @opindex mforce-no-pic
28098 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28099 position-independent code (PIC), this option disables PIC for compiling
28100 kernel code.
28102 @item -mtext-section-literals
28103 @itemx -mno-text-section-literals
28104 @opindex mtext-section-literals
28105 @opindex mno-text-section-literals
28106 These options control the treatment of literal pools.  The default is
28107 @option{-mno-text-section-literals}, which places literals in a separate
28108 section in the output file.  This allows the literal pool to be placed
28109 in a data RAM/ROM, and it also allows the linker to combine literal
28110 pools from separate object files to remove redundant literals and
28111 improve code size.  With @option{-mtext-section-literals}, the literals
28112 are interspersed in the text section in order to keep them as close as
28113 possible to their references.  This may be necessary for large assembly
28114 files.  Literals for each function are placed right before that function.
28116 @item -mauto-litpools
28117 @itemx -mno-auto-litpools
28118 @opindex mauto-litpools
28119 @opindex mno-auto-litpools
28120 These options control the treatment of literal pools.  The default is
28121 @option{-mno-auto-litpools}, which places literals in a separate
28122 section in the output file unless @option{-mtext-section-literals} is
28123 used.  With @option{-mauto-litpools} the literals are interspersed in
28124 the text section by the assembler.  Compiler does not produce explicit
28125 @code{.literal} directives and loads literals into registers with
28126 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28127 do relaxation and place literals as necessary.  This option allows
28128 assembler to create several literal pools per function and assemble
28129 very big functions, which may not be possible with
28130 @option{-mtext-section-literals}.
28132 @item -mtarget-align
28133 @itemx -mno-target-align
28134 @opindex mtarget-align
28135 @opindex mno-target-align
28136 When this option is enabled, GCC instructs the assembler to
28137 automatically align instructions to reduce branch penalties at the
28138 expense of some code density.  The assembler attempts to widen density
28139 instructions to align branch targets and the instructions following call
28140 instructions.  If there are not enough preceding safe density
28141 instructions to align a target, no widening is performed.  The
28142 default is @option{-mtarget-align}.  These options do not affect the
28143 treatment of auto-aligned instructions like @code{LOOP}, which the
28144 assembler always aligns, either by widening density instructions or
28145 by inserting NOP instructions.
28147 @item -mlongcalls
28148 @itemx -mno-longcalls
28149 @opindex mlongcalls
28150 @opindex mno-longcalls
28151 When this option is enabled, GCC instructs the assembler to translate
28152 direct calls to indirect calls unless it can determine that the target
28153 of a direct call is in the range allowed by the call instruction.  This
28154 translation typically occurs for calls to functions in other source
28155 files.  Specifically, the assembler translates a direct @code{CALL}
28156 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28157 The default is @option{-mno-longcalls}.  This option should be used in
28158 programs where the call target can potentially be out of range.  This
28159 option is implemented in the assembler, not the compiler, so the
28160 assembly code generated by GCC still shows direct call
28161 instructions---look at the disassembled object code to see the actual
28162 instructions.  Note that the assembler uses an indirect call for
28163 every cross-file call, not just those that really are out of range.
28164 @end table
28166 @node zSeries Options
28167 @subsection zSeries Options
28168 @cindex zSeries options
28170 These are listed under @xref{S/390 and zSeries Options}.
28173 @c man end
28175 @node Spec Files
28176 @section Specifying Subprocesses and the Switches to Pass to Them
28177 @cindex Spec Files
28179 @command{gcc} is a driver program.  It performs its job by invoking a
28180 sequence of other programs to do the work of compiling, assembling and
28181 linking.  GCC interprets its command-line parameters and uses these to
28182 deduce which programs it should invoke, and which command-line options
28183 it ought to place on their command lines.  This behavior is controlled
28184 by @dfn{spec strings}.  In most cases there is one spec string for each
28185 program that GCC can invoke, but a few programs have multiple spec
28186 strings to control their behavior.  The spec strings built into GCC can
28187 be overridden by using the @option{-specs=} command-line switch to specify
28188 a spec file.
28190 @dfn{Spec files} are plain-text files that are used to construct spec
28191 strings.  They consist of a sequence of directives separated by blank
28192 lines.  The type of directive is determined by the first non-whitespace
28193 character on the line, which can be one of the following:
28195 @table @code
28196 @item %@var{command}
28197 Issues a @var{command} to the spec file processor.  The commands that can
28198 appear here are:
28200 @table @code
28201 @item %include <@var{file}>
28202 @cindex @code{%include}
28203 Search for @var{file} and insert its text at the current point in the
28204 specs file.
28206 @item %include_noerr <@var{file}>
28207 @cindex @code{%include_noerr}
28208 Just like @samp{%include}, but do not generate an error message if the include
28209 file cannot be found.
28211 @item %rename @var{old_name} @var{new_name}
28212 @cindex @code{%rename}
28213 Rename the spec string @var{old_name} to @var{new_name}.
28215 @end table
28217 @item *[@var{spec_name}]:
28218 This tells the compiler to create, override or delete the named spec
28219 string.  All lines after this directive up to the next directive or
28220 blank line are considered to be the text for the spec string.  If this
28221 results in an empty string then the spec is deleted.  (Or, if the
28222 spec did not exist, then nothing happens.)  Otherwise, if the spec
28223 does not currently exist a new spec is created.  If the spec does
28224 exist then its contents are overridden by the text of this
28225 directive, unless the first character of that text is the @samp{+}
28226 character, in which case the text is appended to the spec.
28228 @item [@var{suffix}]:
28229 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28230 and up to the next directive or blank line are considered to make up the
28231 spec string for the indicated suffix.  When the compiler encounters an
28232 input file with the named suffix, it processes the spec string in
28233 order to work out how to compile that file.  For example:
28235 @smallexample
28236 .ZZ:
28237 z-compile -input %i
28238 @end smallexample
28240 This says that any input file whose name ends in @samp{.ZZ} should be
28241 passed to the program @samp{z-compile}, which should be invoked with the
28242 command-line switch @option{-input} and with the result of performing the
28243 @samp{%i} substitution.  (See below.)
28245 As an alternative to providing a spec string, the text following a
28246 suffix directive can be one of the following:
28248 @table @code
28249 @item @@@var{language}
28250 This says that the suffix is an alias for a known @var{language}.  This is
28251 similar to using the @option{-x} command-line switch to GCC to specify a
28252 language explicitly.  For example:
28254 @smallexample
28255 .ZZ:
28256 @@c++
28257 @end smallexample
28259 Says that .ZZ files are, in fact, C++ source files.
28261 @item #@var{name}
28262 This causes an error messages saying:
28264 @smallexample
28265 @var{name} compiler not installed on this system.
28266 @end smallexample
28267 @end table
28269 GCC already has an extensive list of suffixes built into it.
28270 This directive adds an entry to the end of the list of suffixes, but
28271 since the list is searched from the end backwards, it is effectively
28272 possible to override earlier entries using this technique.
28274 @end table
28276 GCC has the following spec strings built into it.  Spec files can
28277 override these strings or create their own.  Note that individual
28278 targets can also add their own spec strings to this list.
28280 @smallexample
28281 asm          Options to pass to the assembler
28282 asm_final    Options to pass to the assembler post-processor
28283 cpp          Options to pass to the C preprocessor
28284 cc1          Options to pass to the C compiler
28285 cc1plus      Options to pass to the C++ compiler
28286 endfile      Object files to include at the end of the link
28287 link         Options to pass to the linker
28288 lib          Libraries to include on the command line to the linker
28289 libgcc       Decides which GCC support library to pass to the linker
28290 linker       Sets the name of the linker
28291 predefines   Defines to be passed to the C preprocessor
28292 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28293              by default
28294 startfile    Object files to include at the start of the link
28295 @end smallexample
28297 Here is a small example of a spec file:
28299 @smallexample
28300 %rename lib                 old_lib
28302 *lib:
28303 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28304 @end smallexample
28306 This example renames the spec called @samp{lib} to @samp{old_lib} and
28307 then overrides the previous definition of @samp{lib} with a new one.
28308 The new definition adds in some extra command-line options before
28309 including the text of the old definition.
28311 @dfn{Spec strings} are a list of command-line options to be passed to their
28312 corresponding program.  In addition, the spec strings can contain
28313 @samp{%}-prefixed sequences to substitute variable text or to
28314 conditionally insert text into the command line.  Using these constructs
28315 it is possible to generate quite complex command lines.
28317 Here is a table of all defined @samp{%}-sequences for spec
28318 strings.  Note that spaces are not generated automatically around the
28319 results of expanding these sequences.  Therefore you can concatenate them
28320 together or combine them with constant text in a single argument.
28322 @table @code
28323 @item %%
28324 Substitute one @samp{%} into the program name or argument.
28326 @item %i
28327 Substitute the name of the input file being processed.
28329 @item %b
28330 Substitute the basename of the input file being processed.
28331 This is the substring up to (and not including) the last period
28332 and not including the directory.
28334 @item %B
28335 This is the same as @samp{%b}, but include the file suffix (text after
28336 the last period).
28338 @item %d
28339 Marks the argument containing or following the @samp{%d} as a
28340 temporary file name, so that that file is deleted if GCC exits
28341 successfully.  Unlike @samp{%g}, this contributes no text to the
28342 argument.
28344 @item %g@var{suffix}
28345 Substitute a file name that has suffix @var{suffix} and is chosen
28346 once per compilation, and mark the argument in the same way as
28347 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28348 name is now chosen in a way that is hard to predict even when previously
28349 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28350 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28351 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28352 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28353 was simply substituted with a file name chosen once per compilation,
28354 without regard to any appended suffix (which was therefore treated
28355 just like ordinary text), making such attacks more likely to succeed.
28357 @item %u@var{suffix}
28358 Like @samp{%g}, but generates a new temporary file name
28359 each time it appears instead of once per compilation.
28361 @item %U@var{suffix}
28362 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28363 new one if there is no such last file name.  In the absence of any
28364 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28365 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28366 involves the generation of two distinct file names, one
28367 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28368 simply substituted with a file name chosen for the previous @samp{%u},
28369 without regard to any appended suffix.
28371 @item %j@var{suffix}
28372 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28373 writable, and if @option{-save-temps} is not used; 
28374 otherwise, substitute the name
28375 of a temporary file, just like @samp{%u}.  This temporary file is not
28376 meant for communication between processes, but rather as a junk
28377 disposal mechanism.
28379 @item %|@var{suffix}
28380 @itemx %m@var{suffix}
28381 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28382 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28383 all.  These are the two most common ways to instruct a program that it
28384 should read from standard input or write to standard output.  If you
28385 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28386 construct: see for example @file{f/lang-specs.h}.
28388 @item %.@var{SUFFIX}
28389 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28390 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28391 terminated by the next space or %.
28393 @item %w
28394 Marks the argument containing or following the @samp{%w} as the
28395 designated output file of this compilation.  This puts the argument
28396 into the sequence of arguments that @samp{%o} substitutes.
28398 @item %o
28399 Substitutes the names of all the output files, with spaces
28400 automatically placed around them.  You should write spaces
28401 around the @samp{%o} as well or the results are undefined.
28402 @samp{%o} is for use in the specs for running the linker.
28403 Input files whose names have no recognized suffix are not compiled
28404 at all, but they are included among the output files, so they are
28405 linked.
28407 @item %O
28408 Substitutes the suffix for object files.  Note that this is
28409 handled specially when it immediately follows @samp{%g, %u, or %U},
28410 because of the need for those to form complete file names.  The
28411 handling is such that @samp{%O} is treated exactly as if it had already
28412 been substituted, except that @samp{%g, %u, and %U} do not currently
28413 support additional @var{suffix} characters following @samp{%O} as they do
28414 following, for example, @samp{.o}.
28416 @item %p
28417 Substitutes the standard macro predefinitions for the
28418 current target machine.  Use this when running @command{cpp}.
28420 @item %P
28421 Like @samp{%p}, but puts @samp{__} before and after the name of each
28422 predefined macro, except for macros that start with @samp{__} or with
28423 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28426 @item %I
28427 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28428 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28429 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28430 and @option{-imultilib} as necessary.
28432 @item %s
28433 Current argument is the name of a library or startup file of some sort.
28434 Search for that file in a standard list of directories and substitute
28435 the full name found.  The current working directory is included in the
28436 list of directories scanned.
28438 @item %T
28439 Current argument is the name of a linker script.  Search for that file
28440 in the current list of directories to scan for libraries. If the file
28441 is located insert a @option{--script} option into the command line
28442 followed by the full path name found.  If the file is not found then
28443 generate an error message.  Note: the current working directory is not
28444 searched.
28446 @item %e@var{str}
28447 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28448 Use this when inconsistent options are detected.
28450 @item %(@var{name})
28451 Substitute the contents of spec string @var{name} at this point.
28453 @item %x@{@var{option}@}
28454 Accumulate an option for @samp{%X}.
28456 @item %X
28457 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28458 spec string.
28460 @item %Y
28461 Output the accumulated assembler options specified by @option{-Wa}.
28463 @item %Z
28464 Output the accumulated preprocessor options specified by @option{-Wp}.
28466 @item %a
28467 Process the @code{asm} spec.  This is used to compute the
28468 switches to be passed to the assembler.
28470 @item %A
28471 Process the @code{asm_final} spec.  This is a spec string for
28472 passing switches to an assembler post-processor, if such a program is
28473 needed.
28475 @item %l
28476 Process the @code{link} spec.  This is the spec for computing the
28477 command line passed to the linker.  Typically it makes use of the
28478 @samp{%L %G %S %D and %E} sequences.
28480 @item %D
28481 Dump out a @option{-L} option for each directory that GCC believes might
28482 contain startup files.  If the target supports multilibs then the
28483 current multilib directory is prepended to each of these paths.
28485 @item %L
28486 Process the @code{lib} spec.  This is a spec string for deciding which
28487 libraries are included on the command line to the linker.
28489 @item %G
28490 Process the @code{libgcc} spec.  This is a spec string for deciding
28491 which GCC support library is included on the command line to the linker.
28493 @item %S
28494 Process the @code{startfile} spec.  This is a spec for deciding which
28495 object files are the first ones passed to the linker.  Typically
28496 this might be a file named @file{crt0.o}.
28498 @item %E
28499 Process the @code{endfile} spec.  This is a spec string that specifies
28500 the last object files that are passed to the linker.
28502 @item %C
28503 Process the @code{cpp} spec.  This is used to construct the arguments
28504 to be passed to the C preprocessor.
28506 @item %1
28507 Process the @code{cc1} spec.  This is used to construct the options to be
28508 passed to the actual C compiler (@command{cc1}).
28510 @item %2
28511 Process the @code{cc1plus} spec.  This is used to construct the options to be
28512 passed to the actual C++ compiler (@command{cc1plus}).
28514 @item %*
28515 Substitute the variable part of a matched option.  See below.
28516 Note that each comma in the substituted string is replaced by
28517 a single space.
28519 @item %<S
28520 Remove all occurrences of @code{-S} from the command line.  Note---this
28521 command is position dependent.  @samp{%} commands in the spec string
28522 before this one see @code{-S}, @samp{%} commands in the spec string
28523 after this one do not.
28525 @item %:@var{function}(@var{args})
28526 Call the named function @var{function}, passing it @var{args}.
28527 @var{args} is first processed as a nested spec string, then split
28528 into an argument vector in the usual fashion.  The function returns
28529 a string which is processed as if it had appeared literally as part
28530 of the current spec.
28532 The following built-in spec functions are provided:
28534 @table @code
28535 @item @code{getenv}
28536 The @code{getenv} spec function takes two arguments: an environment
28537 variable name and a string.  If the environment variable is not
28538 defined, a fatal error is issued.  Otherwise, the return value is the
28539 value of the environment variable concatenated with the string.  For
28540 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28542 @smallexample
28543 %:getenv(TOPDIR /include)
28544 @end smallexample
28546 expands to @file{/path/to/top/include}.
28548 @item @code{if-exists}
28549 The @code{if-exists} spec function takes one argument, an absolute
28550 pathname to a file.  If the file exists, @code{if-exists} returns the
28551 pathname.  Here is a small example of its usage:
28553 @smallexample
28554 *startfile:
28555 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28556 @end smallexample
28558 @item @code{if-exists-else}
28559 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28560 spec function, except that it takes two arguments.  The first argument is
28561 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28562 returns the pathname.  If it does not exist, it returns the second argument.
28563 This way, @code{if-exists-else} can be used to select one file or another,
28564 based on the existence of the first.  Here is a small example of its usage:
28566 @smallexample
28567 *startfile:
28568 crt0%O%s %:if-exists(crti%O%s) \
28569 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28570 @end smallexample
28572 @item @code{replace-outfile}
28573 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28574 first argument in the outfiles array and replaces it with the second argument.  Here
28575 is a small example of its usage:
28577 @smallexample
28578 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28579 @end smallexample
28581 @item @code{remove-outfile}
28582 The @code{remove-outfile} spec function takes one argument.  It looks for the
28583 first argument in the outfiles array and removes it.  Here is a small example
28584 its usage:
28586 @smallexample
28587 %:remove-outfile(-lm)
28588 @end smallexample
28590 @item @code{pass-through-libs}
28591 The @code{pass-through-libs} spec function takes any number of arguments.  It
28592 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28593 assumes are the names of linker input library archive files) and returns a
28594 result containing all the found arguments each prepended by
28595 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28596 intended to be passed to the LTO linker plugin.
28598 @smallexample
28599 %:pass-through-libs(%G %L %G)
28600 @end smallexample
28602 @item @code{print-asm-header}
28603 The @code{print-asm-header} function takes no arguments and simply
28604 prints a banner like:
28606 @smallexample
28607 Assembler options
28608 =================
28610 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28611 @end smallexample
28613 It is used to separate compiler options from assembler options
28614 in the @option{--target-help} output.
28615 @end table
28617 @item %@{S@}
28618 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28619 If that switch is not specified, this substitutes nothing.  Note that
28620 the leading dash is omitted when specifying this option, and it is
28621 automatically inserted if the substitution is performed.  Thus the spec
28622 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28623 and outputs the command-line option @option{-foo}.
28625 @item %W@{S@}
28626 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28627 deleted on failure.
28629 @item %@{S*@}
28630 Substitutes all the switches specified to GCC whose names start
28631 with @code{-S}, but which also take an argument.  This is used for
28632 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28633 GCC considers @option{-o foo} as being
28634 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28635 text, including the space.  Thus two arguments are generated.
28637 @item %@{S*&T*@}
28638 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28639 (the order of @code{S} and @code{T} in the spec is not significant).
28640 There can be any number of ampersand-separated variables; for each the
28641 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28643 @item %@{S:X@}
28644 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28646 @item %@{!S:X@}
28647 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28649 @item %@{S*:X@}
28650 Substitutes @code{X} if one or more switches whose names start with
28651 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28652 once, no matter how many such switches appeared.  However, if @code{%*}
28653 appears somewhere in @code{X}, then @code{X} is substituted once
28654 for each matching switch, with the @code{%*} replaced by the part of
28655 that switch matching the @code{*}.
28657 If @code{%*} appears as the last part of a spec sequence then a space
28658 is added after the end of the last substitution.  If there is more
28659 text in the sequence, however, then a space is not generated.  This
28660 allows the @code{%*} substitution to be used as part of a larger
28661 string.  For example, a spec string like this:
28663 @smallexample
28664 %@{mcu=*:--script=%*/memory.ld@}
28665 @end smallexample
28667 @noindent
28668 when matching an option like @option{-mcu=newchip} produces:
28670 @smallexample
28671 --script=newchip/memory.ld
28672 @end smallexample
28674 @item %@{.S:X@}
28675 Substitutes @code{X}, if processing a file with suffix @code{S}.
28677 @item %@{!.S:X@}
28678 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28680 @item %@{,S:X@}
28681 Substitutes @code{X}, if processing a file for language @code{S}.
28683 @item %@{!,S:X@}
28684 Substitutes @code{X}, if not processing a file for language @code{S}.
28686 @item %@{S|P:X@}
28687 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28688 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28689 @code{*} sequences as well, although they have a stronger binding than
28690 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28691 alternatives must be starred, and only the first matching alternative
28692 is substituted.
28694 For example, a spec string like this:
28696 @smallexample
28697 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28698 @end smallexample
28700 @noindent
28701 outputs the following command-line options from the following input
28702 command-line options:
28704 @smallexample
28705 fred.c        -foo -baz
28706 jim.d         -bar -boggle
28707 -d fred.c     -foo -baz -boggle
28708 -d jim.d      -bar -baz -boggle
28709 @end smallexample
28711 @item %@{S:X; T:Y; :D@}
28713 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28714 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28715 be as many clauses as you need.  This may be combined with @code{.},
28716 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28719 @end table
28721 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28722 or similar construct can use a backslash to ignore the special meaning
28723 of the character following it, thus allowing literal matching of a
28724 character that is otherwise specially treated.  For example,
28725 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28726 @option{-std=iso9899:1999} option is given.
28728 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28729 construct may contain other nested @samp{%} constructs or spaces, or
28730 even newlines.  They are processed as usual, as described above.
28731 Trailing white space in @code{X} is ignored.  White space may also
28732 appear anywhere on the left side of the colon in these constructs,
28733 except between @code{.} or @code{*} and the corresponding word.
28735 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28736 handled specifically in these constructs.  If another value of
28737 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28738 @option{-W} switch is found later in the command line, the earlier
28739 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28740 just one letter, which passes all matching options.
28742 The character @samp{|} at the beginning of the predicate text is used to
28743 indicate that a command should be piped to the following command, but
28744 only if @option{-pipe} is specified.
28746 It is built into GCC which switches take arguments and which do not.
28747 (You might think it would be useful to generalize this to allow each
28748 compiler's spec to say which switches take arguments.  But this cannot
28749 be done in a consistent fashion.  GCC cannot even decide which input
28750 files have been specified without knowing which switches take arguments,
28751 and it must know which input files to compile in order to tell which
28752 compilers to run).
28754 GCC also knows implicitly that arguments starting in @option{-l} are to be
28755 treated as compiler output files, and passed to the linker in their
28756 proper position among the other output files.
28758 @node Environment Variables
28759 @section Environment Variables Affecting GCC
28760 @cindex environment variables
28762 @c man begin ENVIRONMENT
28763 This section describes several environment variables that affect how GCC
28764 operates.  Some of them work by specifying directories or prefixes to use
28765 when searching for various kinds of files.  Some are used to specify other
28766 aspects of the compilation environment.
28768 Note that you can also specify places to search using options such as
28769 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28770 take precedence over places specified using environment variables, which
28771 in turn take precedence over those specified by the configuration of GCC@.
28772 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28773 GNU Compiler Collection (GCC) Internals}.
28775 @table @env
28776 @item LANG
28777 @itemx LC_CTYPE
28778 @c @itemx LC_COLLATE
28779 @itemx LC_MESSAGES
28780 @c @itemx LC_MONETARY
28781 @c @itemx LC_NUMERIC
28782 @c @itemx LC_TIME
28783 @itemx LC_ALL
28784 @findex LANG
28785 @findex LC_CTYPE
28786 @c @findex LC_COLLATE
28787 @findex LC_MESSAGES
28788 @c @findex LC_MONETARY
28789 @c @findex LC_NUMERIC
28790 @c @findex LC_TIME
28791 @findex LC_ALL
28792 @cindex locale
28793 These environment variables control the way that GCC uses
28794 localization information which allows GCC to work with different
28795 national conventions.  GCC inspects the locale categories
28796 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28797 so.  These locale categories can be set to any value supported by your
28798 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28799 Kingdom encoded in UTF-8.
28801 The @env{LC_CTYPE} environment variable specifies character
28802 classification.  GCC uses it to determine the character boundaries in
28803 a string; this is needed for some multibyte encodings that contain quote
28804 and escape characters that are otherwise interpreted as a string
28805 end or escape.
28807 The @env{LC_MESSAGES} environment variable specifies the language to
28808 use in diagnostic messages.
28810 If the @env{LC_ALL} environment variable is set, it overrides the value
28811 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28812 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28813 environment variable.  If none of these variables are set, GCC
28814 defaults to traditional C English behavior.
28816 @item TMPDIR
28817 @findex TMPDIR
28818 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28819 files.  GCC uses temporary files to hold the output of one stage of
28820 compilation which is to be used as input to the next stage: for example,
28821 the output of the preprocessor, which is the input to the compiler
28822 proper.
28824 @item GCC_COMPARE_DEBUG
28825 @findex GCC_COMPARE_DEBUG
28826 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28827 @option{-fcompare-debug} to the compiler driver.  See the documentation
28828 of this option for more details.
28830 @item GCC_EXEC_PREFIX
28831 @findex GCC_EXEC_PREFIX
28832 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28833 names of the subprograms executed by the compiler.  No slash is added
28834 when this prefix is combined with the name of a subprogram, but you can
28835 specify a prefix that ends with a slash if you wish.
28837 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28838 an appropriate prefix to use based on the pathname it is invoked with.
28840 If GCC cannot find the subprogram using the specified prefix, it
28841 tries looking in the usual places for the subprogram.
28843 The default value of @env{GCC_EXEC_PREFIX} is
28844 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28845 the installed compiler. In many cases @var{prefix} is the value
28846 of @code{prefix} when you ran the @file{configure} script.
28848 Other prefixes specified with @option{-B} take precedence over this prefix.
28850 This prefix is also used for finding files such as @file{crt0.o} that are
28851 used for linking.
28853 In addition, the prefix is used in an unusual way in finding the
28854 directories to search for header files.  For each of the standard
28855 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28856 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28857 replacing that beginning with the specified prefix to produce an
28858 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28859 @file{foo/bar} just before it searches the standard directory 
28860 @file{/usr/local/lib/bar}.
28861 If a standard directory begins with the configured
28862 @var{prefix} then the value of @var{prefix} is replaced by
28863 @env{GCC_EXEC_PREFIX} when looking for header files.
28865 @item COMPILER_PATH
28866 @findex COMPILER_PATH
28867 The value of @env{COMPILER_PATH} is a colon-separated list of
28868 directories, much like @env{PATH}.  GCC tries the directories thus
28869 specified when searching for subprograms, if it cannot find the
28870 subprograms using @env{GCC_EXEC_PREFIX}.
28872 @item LIBRARY_PATH
28873 @findex LIBRARY_PATH
28874 The value of @env{LIBRARY_PATH} is a colon-separated list of
28875 directories, much like @env{PATH}.  When configured as a native compiler,
28876 GCC tries the directories thus specified when searching for special
28877 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28878 using GCC also uses these directories when searching for ordinary
28879 libraries for the @option{-l} option (but directories specified with
28880 @option{-L} come first).
28882 @item LANG
28883 @findex LANG
28884 @cindex locale definition
28885 This variable is used to pass locale information to the compiler.  One way in
28886 which this information is used is to determine the character set to be used
28887 when character literals, string literals and comments are parsed in C and C++.
28888 When the compiler is configured to allow multibyte characters,
28889 the following values for @env{LANG} are recognized:
28891 @table @samp
28892 @item C-JIS
28893 Recognize JIS characters.
28894 @item C-SJIS
28895 Recognize SJIS characters.
28896 @item C-EUCJP
28897 Recognize EUCJP characters.
28898 @end table
28900 If @env{LANG} is not defined, or if it has some other value, then the
28901 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28902 recognize and translate multibyte characters.
28903 @end table
28905 @noindent
28906 Some additional environment variables affect the behavior of the
28907 preprocessor.
28909 @include cppenv.texi
28911 @c man end
28913 @node Precompiled Headers
28914 @section Using Precompiled Headers
28915 @cindex precompiled headers
28916 @cindex speed of compilation
28918 Often large projects have many header files that are included in every
28919 source file.  The time the compiler takes to process these header files
28920 over and over again can account for nearly all of the time required to
28921 build the project.  To make builds faster, GCC allows you to
28922 @dfn{precompile} a header file.
28924 To create a precompiled header file, simply compile it as you would any
28925 other file, if necessary using the @option{-x} option to make the driver
28926 treat it as a C or C++ header file.  You may want to use a
28927 tool like @command{make} to keep the precompiled header up-to-date when
28928 the headers it contains change.
28930 A precompiled header file is searched for when @code{#include} is
28931 seen in the compilation.  As it searches for the included file
28932 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28933 compiler looks for a precompiled header in each directory just before it
28934 looks for the include file in that directory.  The name searched for is
28935 the name specified in the @code{#include} with @samp{.gch} appended.  If
28936 the precompiled header file cannot be used, it is ignored.
28938 For instance, if you have @code{#include "all.h"}, and you have
28939 @file{all.h.gch} in the same directory as @file{all.h}, then the
28940 precompiled header file is used if possible, and the original
28941 header is used otherwise.
28943 Alternatively, you might decide to put the precompiled header file in a
28944 directory and use @option{-I} to ensure that directory is searched
28945 before (or instead of) the directory containing the original header.
28946 Then, if you want to check that the precompiled header file is always
28947 used, you can put a file of the same name as the original header in this
28948 directory containing an @code{#error} command.
28950 This also works with @option{-include}.  So yet another way to use
28951 precompiled headers, good for projects not designed with precompiled
28952 header files in mind, is to simply take most of the header files used by
28953 a project, include them from another header file, precompile that header
28954 file, and @option{-include} the precompiled header.  If the header files
28955 have guards against multiple inclusion, they are skipped because
28956 they've already been included (in the precompiled header).
28958 If you need to precompile the same header file for different
28959 languages, targets, or compiler options, you can instead make a
28960 @emph{directory} named like @file{all.h.gch}, and put each precompiled
28961 header in the directory, perhaps using @option{-o}.  It doesn't matter
28962 what you call the files in the directory; every precompiled header in
28963 the directory is considered.  The first precompiled header
28964 encountered in the directory that is valid for this compilation is
28965 used; they're searched in no particular order.
28967 There are many other possibilities, limited only by your imagination,
28968 good sense, and the constraints of your build system.
28970 A precompiled header file can be used only when these conditions apply:
28972 @itemize
28973 @item
28974 Only one precompiled header can be used in a particular compilation.
28976 @item
28977 A precompiled header cannot be used once the first C token is seen.  You
28978 can have preprocessor directives before a precompiled header; you cannot
28979 include a precompiled header from inside another header.
28981 @item
28982 The precompiled header file must be produced for the same language as
28983 the current compilation.  You cannot use a C precompiled header for a C++
28984 compilation.
28986 @item
28987 The precompiled header file must have been produced by the same compiler
28988 binary as the current compilation is using.
28990 @item
28991 Any macros defined before the precompiled header is included must
28992 either be defined in the same way as when the precompiled header was
28993 generated, or must not affect the precompiled header, which usually
28994 means that they don't appear in the precompiled header at all.
28996 The @option{-D} option is one way to define a macro before a
28997 precompiled header is included; using a @code{#define} can also do it.
28998 There are also some options that define macros implicitly, like
28999 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29000 defined this way.
29002 @item If debugging information is output when using the precompiled
29003 header, using @option{-g} or similar, the same kind of debugging information
29004 must have been output when building the precompiled header.  However,
29005 a precompiled header built using @option{-g} can be used in a compilation
29006 when no debugging information is being output.
29008 @item The same @option{-m} options must generally be used when building
29009 and using the precompiled header.  @xref{Submodel Options},
29010 for any cases where this rule is relaxed.
29012 @item Each of the following options must be the same when building and using
29013 the precompiled header:
29015 @gccoptlist{-fexceptions}
29017 @item
29018 Some other command-line options starting with @option{-f},
29019 @option{-p}, or @option{-O} must be defined in the same way as when
29020 the precompiled header was generated.  At present, it's not clear
29021 which options are safe to change and which are not; the safest choice
29022 is to use exactly the same options when generating and using the
29023 precompiled header.  The following are known to be safe:
29025 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29026 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29027 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29028 -pedantic-errors}
29030 @end itemize
29032 For all of these except the last, the compiler automatically
29033 ignores the precompiled header if the conditions aren't met.  If you
29034 find an option combination that doesn't work and doesn't cause the
29035 precompiled header to be ignored, please consider filing a bug report,
29036 see @ref{Bugs}.
29038 If you do use differing options when generating and using the
29039 precompiled header, the actual behavior is a mixture of the
29040 behavior for the options.  For instance, if you use @option{-g} to
29041 generate the precompiled header but not when using it, you may or may
29042 not get debugging information for routines in the precompiled header.