* cp-tree.h (cp_expr): Remove copy constructor.
[official-gcc.git] / gcc / doc / invoke.texi
blobca3772bbebfc92b55518846adbc1fc9906d91226
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  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-attributes -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gas-loc-support  -gno-as-loc-support @gol
349 -gas-locview-support  -gno-as-locview-support @gol
350 -gcolumn-info  -gno-column-info @gol
351 -gstatement-frontiers  -gno-statement-frontiers @gol
352 -gvariable-location-views  -gno-variable-location-views @gol
353 -ginternal-reset-location-views  -gno-internal-reset-location-views @gol
354 -ginline-points  -gno-inline-points @gol
355 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
356 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
357 -fno-eliminate-unused-debug-types @gol
358 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
359 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
360 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
361 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
362 -fvar-tracking  -fvar-tracking-assignments}
364 @item Optimization Options
365 @xref{Optimize Options,,Options that Control Optimization}.
366 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
367 -falign-jumps[=@var{n}] @gol
368 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
369 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
370 -fauto-inc-dec  -fbranch-probabilities @gol
371 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
372 -fbtr-bb-exclusive  -fcaller-saves @gol
373 -fcombine-stack-adjustments  -fconserve-stack @gol
374 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
375 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
376 -fcx-limited-range @gol
377 -fdata-sections  -fdce  -fdelayed-branch @gol
378 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
379 -fdevirtualize-at-ltrans  -fdse @gol
380 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
381 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
382 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
383 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
384 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
385 -fif-conversion2  -findirect-inlining @gol
386 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
387 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
388 -fipa-bit-cp -fipa-vrp @gol
389 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
390 -fira-algorithm=@var{algorithm} @gol
391 -fira-region=@var{region}  -fira-hoist-pressure @gol
392 -fira-loop-pressure  -fno-ira-share-save-slots @gol
393 -fno-ira-share-spill-slots @gol
394 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
395 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
396 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
397 -floop-block  -floop-interchange  -floop-strip-mine @gol
398 -floop-unroll-and-jam  -floop-nest-optimize @gol
399 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
400 -flto-partition=@var{alg}  -fmerge-all-constants @gol
401 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
402 -fmove-loop-invariants  -fno-branch-count-reg @gol
403 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
404 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
405 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
406 -fno-sched-spec  -fno-signed-zeros @gol
407 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
408 -fomit-frame-pointer  -foptimize-sibling-calls @gol
409 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
410 -fprefetch-loop-arrays @gol
411 -fprofile-correction @gol
412 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
413 -fprofile-reorder-functions @gol
414 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
415 -freorder-blocks-algorithm=@var{algorithm} @gol
416 -freorder-blocks-and-partition  -freorder-functions @gol
417 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
418 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
419 -fsched-spec-load  -fsched-spec-load-dangerous @gol
420 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
421 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
422 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
423 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
424 -fschedule-fusion @gol
425 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
426 -fselective-scheduling  -fselective-scheduling2 @gol
427 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
428 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
429 -fsignaling-nans @gol
430 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
431 -fsplit-paths @gol
432 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
433 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
434 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
435 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
436 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
437 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
438 -ftree-loop-if-convert  -ftree-loop-im @gol
439 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
440 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
441 -ftree-loop-vectorize @gol
442 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
443 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
444 -ftree-switch-conversion  -ftree-tail-merge @gol
445 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
446 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
447 -funsafe-math-optimizations  -funswitch-loops @gol
448 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
449 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
450 --param @var{name}=@var{value}
451 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
453 @item Program Instrumentation Options
454 @xref{Instrumentation Options,,Program Instrumentation Options}.
455 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
456 -fprofile-abs-path @gol
457 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
458 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
459 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
460 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
461 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
462 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
463 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
464 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
465 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
466 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
467 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
468 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
469 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
470 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
471 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
472 -fstack-protector-explicit  -fstack-check @gol
473 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
474 -fno-stack-limit  -fsplit-stack @gol
475 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
476 -fvtv-counts  -fvtv-debug @gol
477 -finstrument-functions @gol
478 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
479 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
481 @item Preprocessor Options
482 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
483 @gccoptlist{-A@var{question}=@var{answer} @gol
484 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
485 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
486 -dD  -dI  -dM  -dN  -dU @gol
487 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
488 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
489 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
490 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
491 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
492 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
493 -H  -imacros @var{file}  -include @var{file} @gol
494 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
495 -no-integrated-cpp  -P  -pthread  -remap @gol
496 -traditional  -traditional-cpp  -trigraphs @gol
497 -U@var{macro}  -undef  @gol
498 -Wp,@var{option}  -Xpreprocessor @var{option}}
500 @item Assembler Options
501 @xref{Assembler Options,,Passing Options to the Assembler}.
502 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
504 @item Linker Options
505 @xref{Link Options,,Options for Linking}.
506 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
507 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
508 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
509 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
510 -static-libmpx  -static-libmpxwrappers @gol
511 -shared  -shared-libgcc  -symbolic @gol
512 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
513 -u @var{symbol}  -z @var{keyword}}
515 @item Directory Options
516 @xref{Directory Options,,Options for Directory Search}.
517 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
518 -idirafter @var{dir} @gol
519 -imacros @var{file}  -imultilib @var{dir} @gol
520 -iplugindir=@var{dir}  -iprefix @var{file} @gol
521 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
522 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
523 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
524 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
526 @item Code Generation Options
527 @xref{Code Gen Options,,Options for Code Generation Conventions}.
528 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
529 -ffixed-@var{reg}  -fexceptions @gol
530 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
531 -fasynchronous-unwind-tables @gol
532 -fno-gnu-unique @gol
533 -finhibit-size-directive  -fno-common  -fno-ident @gol
534 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
535 -fno-jump-tables @gol
536 -frecord-gcc-switches @gol
537 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
538 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
539 -fleading-underscore  -ftls-model=@var{model} @gol
540 -fstack-reuse=@var{reuse_level} @gol
541 -ftrampolines  -ftrapv  -fwrapv @gol
542 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
543 -fstrict-volatile-bitfields  -fsync-libcalls}
545 @item Developer Options
546 @xref{Developer Options,,GCC Developer Options}.
547 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
548 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
549 -fdbg-cnt=@var{counter-value-list} @gol
550 -fdisable-ipa-@var{pass_name} @gol
551 -fdisable-rtl-@var{pass_name} @gol
552 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
553 -fdisable-tree-@var{pass_name} @gol
554 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
555 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
556 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
557 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
558 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
559 -fdump-lang-all @gol
560 -fdump-lang-@var{switch} @gol
561 -fdump-lang-@var{switch}-@var{options} @gol
562 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
563 -fdump-passes @gol
564 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
565 -fdump-statistics @gol
566 -fdump-tree-all @gol
567 -fdump-tree-@var{switch} @gol
568 -fdump-tree-@var{switch}-@var{options} @gol
569 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
570 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
571 -fenable-@var{kind}-@var{pass} @gol
572 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
573 -fira-verbose=@var{n} @gol
574 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
575 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
576 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
577 -fprofile-report @gol
578 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
579 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
580 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
581 -fvar-tracking-assignments-toggle  -gtoggle @gol
582 -print-file-name=@var{library}  -print-libgcc-file-name @gol
583 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
584 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
585 -print-sysroot  -print-sysroot-headers-suffix @gol
586 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
588 @item Machine-Dependent Options
589 @xref{Submodel Options,,Machine-Dependent Options}.
590 @c This list is ordered alphanumerically by subsection name.
591 @c Try and put the significant identifier (CPU or system) first,
592 @c so users have a clue at guessing where the ones they want will be.
594 @emph{AArch64 Options}
595 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
596 -mgeneral-regs-only @gol
597 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
598 -mstrict-align @gol
599 -momit-leaf-frame-pointer @gol
600 -mtls-dialect=desc  -mtls-dialect=traditional @gol
601 -mtls-size=@var{size} @gol
602 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
603 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
604 -mpc-relative-literal-loads @gol
605 -msign-return-address=@var{scope} @gol
606 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
607 -moverride=@var{string}  -mverbose-cost-dump}
609 @emph{Adapteva Epiphany Options}
610 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
611 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
612 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
613 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
614 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
615 -msplit-vecmove-early  -m1reg-@var{reg}}
617 @emph{ARC Options}
618 @gccoptlist{-mbarrel-shifter -mjli-always @gol
619 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
620 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
621 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
622 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
623 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
624 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
625 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
626 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
627 -mvolatile-cache  -mtp-regno=@var{regno} @gol
628 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
629 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
630 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
631 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
632 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
633 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
634 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
635 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16}
637 @emph{ARM Options}
638 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
639 -mabi=@var{name} @gol
640 -mapcs-stack-check  -mno-apcs-stack-check @gol
641 -mapcs-reentrant  -mno-apcs-reentrant @gol
642 -msched-prolog  -mno-sched-prolog @gol
643 -mlittle-endian  -mbig-endian @gol
644 -mbe8 -mbe32 @gol
645 -mfloat-abi=@var{name} @gol
646 -mfp16-format=@var{name}
647 -mthumb-interwork  -mno-thumb-interwork @gol
648 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
649 -mtune=@var{name}  -mprint-tune-info @gol
650 -mstructure-size-boundary=@var{n} @gol
651 -mabort-on-noreturn @gol
652 -mlong-calls  -mno-long-calls @gol
653 -msingle-pic-base  -mno-single-pic-base @gol
654 -mpic-register=@var{reg} @gol
655 -mnop-fun-dllimport @gol
656 -mpoke-function-name @gol
657 -mthumb  -marm  -mflip-thumb @gol
658 -mtpcs-frame  -mtpcs-leaf-frame @gol
659 -mcaller-super-interworking  -mcallee-super-interworking @gol
660 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
661 -mword-relocations @gol
662 -mfix-cortex-m3-ldrd @gol
663 -munaligned-access @gol
664 -mneon-for-64bits @gol
665 -mslow-flash-data @gol
666 -masm-syntax-unified @gol
667 -mrestrict-it @gol
668 -mverbose-cost-dump @gol
669 -mpure-code @gol
670 -mcmse}
672 @emph{AVR Options}
673 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
674 -mbranch-cost=@var{cost} @gol
675 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
676 -mn_flash=@var{size}  -mno-interrupts @gol
677 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
678 -mfract-convert-truncate @gol
679 -mshort-calls  -nodevicelib @gol
680 -Waddr-space-convert  -Wmisspelled-isr}
682 @emph{Blackfin Options}
683 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
684 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
685 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
686 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
687 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
688 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
689 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
690 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
691 -micplb}
693 @emph{C6X Options}
694 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
695 -msim  -msdata=@var{sdata-type}}
697 @emph{CRIS Options}
698 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
699 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
700 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
701 -mstack-align  -mdata-align  -mconst-align @gol
702 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
703 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
704 -mmul-bug-workaround  -mno-mul-bug-workaround}
706 @emph{CR16 Options}
707 @gccoptlist{-mmac @gol
708 -mcr16cplus  -mcr16c @gol
709 -msim  -mint32  -mbit-ops
710 -mdata-model=@var{model}}
712 @emph{Darwin Options}
713 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
714 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
715 -client_name  -compatibility_version  -current_version @gol
716 -dead_strip @gol
717 -dependency-file  -dylib_file  -dylinker_install_name @gol
718 -dynamic  -dynamiclib  -exported_symbols_list @gol
719 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
720 -force_flat_namespace  -headerpad_max_install_names @gol
721 -iframework @gol
722 -image_base  -init  -install_name  -keep_private_externs @gol
723 -multi_module  -multiply_defined  -multiply_defined_unused @gol
724 -noall_load   -no_dead_strip_inits_and_terms @gol
725 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
726 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
727 -private_bundle  -read_only_relocs  -sectalign @gol
728 -sectobjectsymbols  -whyload  -seg1addr @gol
729 -sectcreate  -sectobjectsymbols  -sectorder @gol
730 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
731 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
732 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
733 -single_module  -static  -sub_library  -sub_umbrella @gol
734 -twolevel_namespace  -umbrella  -undefined @gol
735 -unexported_symbols_list  -weak_reference_mismatches @gol
736 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
737 -mkernel  -mone-byte-bool}
739 @emph{DEC Alpha Options}
740 @gccoptlist{-mno-fp-regs  -msoft-float @gol
741 -mieee  -mieee-with-inexact  -mieee-conformant @gol
742 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
743 -mtrap-precision=@var{mode}  -mbuild-constants @gol
744 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
745 -mbwx  -mmax  -mfix  -mcix @gol
746 -mfloat-vax  -mfloat-ieee @gol
747 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
748 -msmall-text  -mlarge-text @gol
749 -mmemory-latency=@var{time}}
751 @emph{FR30 Options}
752 @gccoptlist{-msmall-model  -mno-lsim}
754 @emph{FT32 Options}
755 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
757 @emph{FRV Options}
758 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
759 -mhard-float  -msoft-float @gol
760 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
761 -mdouble  -mno-double @gol
762 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
763 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
764 -mlinked-fp  -mlong-calls  -malign-labels @gol
765 -mlibrary-pic  -macc-4  -macc-8 @gol
766 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
767 -moptimize-membar  -mno-optimize-membar @gol
768 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
769 -mvliw-branch  -mno-vliw-branch @gol
770 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
771 -mno-nested-cond-exec  -mtomcat-stats @gol
772 -mTLS  -mtls @gol
773 -mcpu=@var{cpu}}
775 @emph{GNU/Linux Options}
776 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
777 -tno-android-cc  -tno-android-ld}
779 @emph{H8/300 Options}
780 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
782 @emph{HPPA Options}
783 @gccoptlist{-march=@var{architecture-type} @gol
784 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
785 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
786 -mfixed-range=@var{register-range} @gol
787 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
788 -mlong-load-store  -mno-disable-fpregs @gol
789 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
790 -mno-jump-in-delay  -mno-long-load-store @gol
791 -mno-portable-runtime  -mno-soft-float @gol
792 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
793 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
794 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
795 -munix=@var{unix-std}  -nolibdld  -static  -threads}
797 @emph{IA-64 Options}
798 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
799 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
800 -mconstant-gp  -mauto-pic  -mfused-madd @gol
801 -minline-float-divide-min-latency @gol
802 -minline-float-divide-max-throughput @gol
803 -mno-inline-float-divide @gol
804 -minline-int-divide-min-latency @gol
805 -minline-int-divide-max-throughput  @gol
806 -mno-inline-int-divide @gol
807 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
808 -mno-inline-sqrt @gol
809 -mdwarf2-asm  -mearly-stop-bits @gol
810 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
811 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
812 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
813 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
814 -msched-spec-ldc  -msched-spec-control-ldc @gol
815 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
816 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
817 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
818 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
820 @emph{LM32 Options}
821 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
822 -msign-extend-enabled  -muser-enabled}
824 @emph{M32R/D Options}
825 @gccoptlist{-m32r2  -m32rx  -m32r @gol
826 -mdebug @gol
827 -malign-loops  -mno-align-loops @gol
828 -missue-rate=@var{number} @gol
829 -mbranch-cost=@var{number} @gol
830 -mmodel=@var{code-size-model-type} @gol
831 -msdata=@var{sdata-type} @gol
832 -mno-flush-func  -mflush-func=@var{name} @gol
833 -mno-flush-trap  -mflush-trap=@var{number} @gol
834 -G @var{num}}
836 @emph{M32C Options}
837 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
839 @emph{M680x0 Options}
840 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
841 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
842 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
843 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
844 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
845 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
846 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
847 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
848 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
850 @emph{MCore Options}
851 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
852 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
853 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
854 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
855 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
857 @emph{MeP Options}
858 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
859 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
860 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
861 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
862 -mtiny=@var{n}}
864 @emph{MicroBlaze Options}
865 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
866 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
867 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
868 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
869 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}
870 -mpic-data-is-text-relative}
872 @emph{MIPS Options}
873 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
874 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
875 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
876 -mips16  -mno-mips16  -mflip-mips16 @gol
877 -minterlink-compressed  -mno-interlink-compressed @gol
878 -minterlink-mips16  -mno-interlink-mips16 @gol
879 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
880 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
881 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
882 -mno-float  -msingle-float  -mdouble-float @gol
883 -modd-spreg  -mno-odd-spreg @gol
884 -mabs=@var{mode}  -mnan=@var{encoding} @gol
885 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
886 -mmcu  -mmno-mcu @gol
887 -meva  -mno-eva @gol
888 -mvirt  -mno-virt @gol
889 -mxpa  -mno-xpa @gol
890 -mmicromips  -mno-micromips @gol
891 -mmsa  -mno-msa @gol
892 -mfpu=@var{fpu-type} @gol
893 -msmartmips  -mno-smartmips @gol
894 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
895 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
896 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
897 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
898 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
899 -membedded-data  -mno-embedded-data @gol
900 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
901 -mcode-readable=@var{setting} @gol
902 -msplit-addresses  -mno-split-addresses @gol
903 -mexplicit-relocs  -mno-explicit-relocs @gol
904 -mcheck-zero-division  -mno-check-zero-division @gol
905 -mdivide-traps  -mdivide-breaks @gol
906 -mload-store-pairs  -mno-load-store-pairs @gol
907 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
908 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
909 -mfix-24k  -mno-fix-24k @gol
910 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
911 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
912 -mfix-vr4120  -mno-fix-vr4120 @gol
913 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
914 -mflush-func=@var{func}  -mno-flush-func @gol
915 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
916 -mcompact-branches=@var{policy} @gol
917 -mfp-exceptions  -mno-fp-exceptions @gol
918 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
919 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
920 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
921 -mframe-header-opt  -mno-frame-header-opt}
923 @emph{MMIX Options}
924 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
925 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
926 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
927 -mno-base-addresses  -msingle-exit  -mno-single-exit}
929 @emph{MN10300 Options}
930 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
931 -mno-am33  -mam33  -mam33-2  -mam34 @gol
932 -mtune=@var{cpu-type} @gol
933 -mreturn-pointer-on-d0 @gol
934 -mno-crt0  -mrelax  -mliw  -msetlb}
936 @emph{Moxie Options}
937 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
939 @emph{MSP430 Options}
940 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
941 -mwarn-mcu @gol
942 -mcode-region=  -mdata-region= @gol
943 -msilicon-errata=  -msilicon-errata-warn= @gol
944 -mhwmult=  -minrt}
946 @emph{NDS32 Options}
947 @gccoptlist{-mbig-endian  -mlittle-endian @gol
948 -mreduced-regs  -mfull-regs @gol
949 -mcmov  -mno-cmov @gol
950 -mext-perf  -mno-ext-perf @gol
951 -mext-perf2  -mno-ext-perf2 @gol
952 -mext-string  -mno-ext-string @gol
953 -mv3push  -mno-v3push @gol
954 -m16bit  -mno-16bit @gol
955 -misr-vector-size=@var{num} @gol
956 -mcache-block-size=@var{num} @gol
957 -march=@var{arch} @gol
958 -mcmodel=@var{code-model} @gol
959 -mctor-dtor  -mrelax}
961 @emph{Nios II Options}
962 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
963 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
964 -mel  -meb @gol
965 -mno-bypass-cache  -mbypass-cache @gol
966 -mno-cache-volatile  -mcache-volatile @gol
967 -mno-fast-sw-div  -mfast-sw-div @gol
968 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
969 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
970 -mcustom-fpu-cfg=@var{name} @gol
971 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
972 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
974 @emph{Nvidia PTX Options}
975 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
977 @emph{PDP-11 Options}
978 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
979 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
980 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
981 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
982 -mbranch-expensive  -mbranch-cheap @gol
983 -munix-asm  -mdec-asm}
985 @emph{picoChip Options}
986 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
987 -msymbol-as-address  -mno-inefficient-warnings}
989 @emph{PowerPC Options}
990 See RS/6000 and PowerPC Options.
992 @emph{PowerPC SPE Options}
993 @gccoptlist{-mcpu=@var{cpu-type} @gol
994 -mtune=@var{cpu-type} @gol
995 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
996 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
997 -m32  -mxl-compat  -mno-xl-compat @gol
998 -malign-power  -malign-natural @gol
999 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1000 -msingle-float  -mdouble-float @gol
1001 -mupdate  -mno-update @gol
1002 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1003 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1004 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1005 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1006 -msingle-pic-base @gol
1007 -mprioritize-restricted-insns=@var{priority} @gol
1008 -msched-costly-dep=@var{dependence_type} @gol
1009 -minsert-sched-nops=@var{scheme} @gol
1010 -mcall-sysv  -mcall-netbsd @gol
1011 -maix-struct-return  -msvr4-struct-return @gol
1012 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1013 -mblock-move-inline-limit=@var{num} @gol
1014 -misel  -mno-isel @gol
1015 -misel=yes  -misel=no @gol
1016 -mspe  -mno-spe @gol
1017 -mspe=yes  -mspe=no @gol
1018 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1019 -mprototype  -mno-prototype @gol
1020 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1021 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1022 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1023 -mno-recip-precision @gol
1024 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1025 -msave-toc-indirect  -mno-save-toc-indirect @gol
1026 -mcompat-align-parm  -mno-compat-align-parm @gol
1027 -mfloat128  -mno-float128 @gol
1028 -mgnu-attribute  -mno-gnu-attribute @gol
1029 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1030 -mstack-protector-guard-offset=@var{offset}}
1032 @emph{RISC-V Options}
1033 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1034 -mplt  -mno-plt @gol
1035 -mabi=@var{ABI-string} @gol
1036 -mfdiv  -mno-fdiv @gol
1037 -mdiv  -mno-div @gol
1038 -march=@var{ISA-string} @gol
1039 -mtune=@var{processor-string} @gol
1040 -mpreferred-stack-boundary=@var{num} @gol
1041 -msmall-data-limit=@var{N-bytes} @gol
1042 -msave-restore  -mno-save-restore @gol
1043 -mstrict-align -mno-strict-align @gol
1044 -mcmodel=medlow -mcmodel=medany @gol
1045 -mexplicit-relocs  -mno-explicit-relocs @gol
1046 -mrelax -mno-relax @gol}
1048 @emph{RL78 Options}
1049 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1050 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1051 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1053 @emph{RS/6000 and PowerPC Options}
1054 @gccoptlist{-mcpu=@var{cpu-type} @gol
1055 -mtune=@var{cpu-type} @gol
1056 -mcmodel=@var{code-model} @gol
1057 -mpowerpc64 @gol
1058 -maltivec  -mno-altivec @gol
1059 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1060 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1061 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1062 -mfprnd  -mno-fprnd @gol
1063 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1064 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1065 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1066 -malign-power  -malign-natural @gol
1067 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1068 -mupdate  -mno-update @gol
1069 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1070 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1071 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1072 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1073 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1074 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1075 -mprioritize-restricted-insns=@var{priority} @gol
1076 -msched-costly-dep=@var{dependence_type} @gol
1077 -minsert-sched-nops=@var{scheme} @gol
1078 -mcall-aixdesc  -mcall-eabi  -mcall-freebsd  @gol
1079 -mcall-linux  -mcall-netbsd  -mcall-openbsd  @gol
1080 -mcall-sysv  -mcall-sysv-eabi  -mcall-sysv-noeabi @gol
1081 -mtraceback=@var{traceback_type} @gol
1082 -maix-struct-return  -msvr4-struct-return @gol
1083 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1084 -mblock-move-inline-limit=@var{num} @gol
1085 -mblock-compare-inline-limit=@var{num} @gol
1086 -mblock-compare-inline-loop-limit=@var{num} @gol
1087 -mstring-compare-inline-limit=@var{num} @gol
1088 -misel  -mno-isel @gol
1089 -misel=yes  -misel=no @gol
1090 -mvrsave  -mno-vrsave @gol
1091 -mmulhw  -mno-mulhw @gol
1092 -mdlmzb  -mno-dlmzb @gol
1093 -mprototype  -mno-prototype @gol
1094 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1095 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1096 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1097 -mno-recip-precision @gol
1098 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1099 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1100 -msave-toc-indirect  -mno-save-toc-indirect @gol
1101 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1102 -mcrypto  -mno-crypto  -mhtm  -mno-htm @gol
1103 -mquad-memory  -mno-quad-memory @gol
1104 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1105 -mcompat-align-parm  -mno-compat-align-parm @gol
1106 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1107 -mgnu-attribute  -mno-gnu-attribute @gol
1108 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1109 -mstack-protector-guard-offset=@var{offset}}
1111 @emph{RX Options}
1112 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1113 -mcpu=@gol
1114 -mbig-endian-data  -mlittle-endian-data @gol
1115 -msmall-data @gol
1116 -msim  -mno-sim@gol
1117 -mas100-syntax  -mno-as100-syntax@gol
1118 -mrelax@gol
1119 -mmax-constant-size=@gol
1120 -mint-register=@gol
1121 -mpid@gol
1122 -mallow-string-insns  -mno-allow-string-insns@gol
1123 -mjsr@gol
1124 -mno-warn-multiple-fast-interrupts@gol
1125 -msave-acc-in-interrupts}
1127 @emph{S/390 and zSeries Options}
1128 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1129 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1130 -mlong-double-64  -mlong-double-128 @gol
1131 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1132 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1133 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1134 -mhtm  -mvx  -mzvector @gol
1135 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1136 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1137 -mhotpatch=@var{halfwords},@var{halfwords}}
1139 @emph{Score Options}
1140 @gccoptlist{-meb  -mel @gol
1141 -mnhwloop @gol
1142 -muls @gol
1143 -mmac @gol
1144 -mscore5  -mscore5u  -mscore7  -mscore7d}
1146 @emph{SH Options}
1147 @gccoptlist{-m1  -m2  -m2e @gol
1148 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1149 -m3  -m3e @gol
1150 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1151 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1152 -mb  -ml  -mdalign  -mrelax @gol
1153 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1154 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1155 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1156 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1157 -maccumulate-outgoing-args @gol
1158 -matomic-model=@var{atomic-model} @gol
1159 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1160 -mcbranch-force-delay-slot @gol
1161 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1162 -mpretend-cmove  -mtas}
1164 @emph{Solaris 2 Options}
1165 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1166 -pthreads}
1168 @emph{SPARC Options}
1169 @gccoptlist{-mcpu=@var{cpu-type} @gol
1170 -mtune=@var{cpu-type} @gol
1171 -mcmodel=@var{code-model} @gol
1172 -mmemory-model=@var{mem-model} @gol
1173 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1174 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1175 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mhard-quad-float  -msoft-quad-float @gol
1177 -mstack-bias  -mno-stack-bias @gol
1178 -mstd-struct-return  -mno-std-struct-return @gol
1179 -munaligned-doubles  -mno-unaligned-doubles @gol
1180 -muser-mode  -mno-user-mode @gol
1181 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1182 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1183 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1184 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1185 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1186 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1187 -mlra  -mno-lra}
1189 @emph{SPU Options}
1190 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1191 -msafe-dma  -munsafe-dma @gol
1192 -mbranch-hints @gol
1193 -msmall-mem  -mlarge-mem  -mstdmain @gol
1194 -mfixed-range=@var{register-range} @gol
1195 -mea32  -mea64 @gol
1196 -maddress-space-conversion  -mno-address-space-conversion @gol
1197 -mcache-size=@var{cache-size} @gol
1198 -matomic-updates  -mno-atomic-updates}
1200 @emph{System V Options}
1201 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1203 @emph{TILE-Gx Options}
1204 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1205 -mcmodel=@var{code-model}}
1207 @emph{TILEPro Options}
1208 @gccoptlist{-mcpu=@var{cpu}  -m32}
1210 @emph{V850 Options}
1211 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1212 -mprolog-function  -mno-prolog-function  -mspace @gol
1213 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1214 -mapp-regs  -mno-app-regs @gol
1215 -mdisable-callt  -mno-disable-callt @gol
1216 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1217 -mv850e  -mv850  -mv850e3v5 @gol
1218 -mloop @gol
1219 -mrelax @gol
1220 -mlong-jumps @gol
1221 -msoft-float @gol
1222 -mhard-float @gol
1223 -mgcc-abi @gol
1224 -mrh850-abi @gol
1225 -mbig-switch}
1227 @emph{VAX Options}
1228 @gccoptlist{-mg  -mgnu  -munix}
1230 @emph{Visium Options}
1231 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1232 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1234 @emph{VMS Options}
1235 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1236 -mpointer-size=@var{size}}
1238 @emph{VxWorks Options}
1239 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1240 -Xbind-lazy  -Xbind-now}
1242 @emph{x86 Options}
1243 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1244 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1245 -mfpmath=@var{unit} @gol
1246 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1247 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1248 -mno-wide-multiply  -mrtd  -malign-double @gol
1249 -mpreferred-stack-boundary=@var{num} @gol
1250 -mincoming-stack-boundary=@var{num} @gol
1251 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1252 -mrecip  -mrecip=@var{opt} @gol
1253 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1254 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1255 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1256 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1257 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1258 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1259 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1260 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1261 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  -mwaitpkg @gol
1262 -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1263 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq
1264 -mcldemote @gol
1265 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1266 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1267 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1268 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1269 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1270 -mregparm=@var{num}  -msseregparm @gol
1271 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1272 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1273 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1274 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1275 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1276 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1277 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1278 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1279 -mstack-protector-guard-reg=@var{reg} @gol
1280 -mstack-protector-guard-offset=@var{offset} @gol
1281 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1282 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1283 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1284 -mindirect-branch-register}
1286 @emph{x86 Windows Options}
1287 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1288 -mnop-fun-dllimport  -mthread @gol
1289 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1291 @emph{Xstormy16 Options}
1292 @gccoptlist{-msim}
1294 @emph{Xtensa Options}
1295 @gccoptlist{-mconst16  -mno-const16 @gol
1296 -mfused-madd  -mno-fused-madd @gol
1297 -mforce-no-pic @gol
1298 -mserialize-volatile  -mno-serialize-volatile @gol
1299 -mtext-section-literals  -mno-text-section-literals @gol
1300 -mauto-litpools  -mno-auto-litpools @gol
1301 -mtarget-align  -mno-target-align @gol
1302 -mlongcalls  -mno-longcalls}
1304 @emph{zSeries Options}
1305 See S/390 and zSeries Options.
1306 @end table
1309 @node Overall Options
1310 @section Options Controlling the Kind of Output
1312 Compilation can involve up to four stages: preprocessing, compilation
1313 proper, assembly and linking, always in that order.  GCC is capable of
1314 preprocessing and compiling several files either into several
1315 assembler input files, or into one assembler input file; then each
1316 assembler input file produces an object file, and linking combines all
1317 the object files (those newly compiled, and those specified as input)
1318 into an executable file.
1320 @cindex file name suffix
1321 For any given input file, the file name suffix determines what kind of
1322 compilation is done:
1324 @table @gcctabopt
1325 @item @var{file}.c
1326 C source code that must be preprocessed.
1328 @item @var{file}.i
1329 C source code that should not be preprocessed.
1331 @item @var{file}.ii
1332 C++ source code that should not be preprocessed.
1334 @item @var{file}.m
1335 Objective-C source code.  Note that you must link with the @file{libobjc}
1336 library to make an Objective-C program work.
1338 @item @var{file}.mi
1339 Objective-C source code that should not be preprocessed.
1341 @item @var{file}.mm
1342 @itemx @var{file}.M
1343 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1344 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1345 to a literal capital M@.
1347 @item @var{file}.mii
1348 Objective-C++ source code that should not be preprocessed.
1350 @item @var{file}.h
1351 C, C++, Objective-C or Objective-C++ header file to be turned into a
1352 precompiled header (default), or C, C++ header file to be turned into an
1353 Ada spec (via the @option{-fdump-ada-spec} switch).
1355 @item @var{file}.cc
1356 @itemx @var{file}.cp
1357 @itemx @var{file}.cxx
1358 @itemx @var{file}.cpp
1359 @itemx @var{file}.CPP
1360 @itemx @var{file}.c++
1361 @itemx @var{file}.C
1362 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1363 the last two letters must both be literally @samp{x}.  Likewise,
1364 @samp{.C} refers to a literal capital C@.
1366 @item @var{file}.mm
1367 @itemx @var{file}.M
1368 Objective-C++ source code that must be preprocessed.
1370 @item @var{file}.mii
1371 Objective-C++ source code that should not be preprocessed.
1373 @item @var{file}.hh
1374 @itemx @var{file}.H
1375 @itemx @var{file}.hp
1376 @itemx @var{file}.hxx
1377 @itemx @var{file}.hpp
1378 @itemx @var{file}.HPP
1379 @itemx @var{file}.h++
1380 @itemx @var{file}.tcc
1381 C++ header file to be turned into a precompiled header or Ada spec.
1383 @item @var{file}.f
1384 @itemx @var{file}.for
1385 @itemx @var{file}.ftn
1386 Fixed form Fortran source code that should not be preprocessed.
1388 @item @var{file}.F
1389 @itemx @var{file}.FOR
1390 @itemx @var{file}.fpp
1391 @itemx @var{file}.FPP
1392 @itemx @var{file}.FTN
1393 Fixed form Fortran source code that must be preprocessed (with the traditional
1394 preprocessor).
1396 @item @var{file}.f90
1397 @itemx @var{file}.f95
1398 @itemx @var{file}.f03
1399 @itemx @var{file}.f08
1400 Free form Fortran source code that should not be preprocessed.
1402 @item @var{file}.F90
1403 @itemx @var{file}.F95
1404 @itemx @var{file}.F03
1405 @itemx @var{file}.F08
1406 Free form Fortran source code that must be preprocessed (with the
1407 traditional preprocessor).
1409 @item @var{file}.go
1410 Go source code.
1412 @item @var{file}.brig
1413 BRIG files (binary representation of HSAIL).
1415 @item @var{file}.ads
1416 Ada source code file that contains a library unit declaration (a
1417 declaration of a package, subprogram, or generic, or a generic
1418 instantiation), or a library unit renaming declaration (a package,
1419 generic, or subprogram renaming declaration).  Such files are also
1420 called @dfn{specs}.
1422 @item @var{file}.adb
1423 Ada source code file containing a library unit body (a subprogram or
1424 package body).  Such files are also called @dfn{bodies}.
1426 @c GCC also knows about some suffixes for languages not yet included:
1427 @c Pascal:
1428 @c @var{file}.p
1429 @c @var{file}.pas
1430 @c Ratfor:
1431 @c @var{file}.r
1433 @item @var{file}.s
1434 Assembler code.
1436 @item @var{file}.S
1437 @itemx @var{file}.sx
1438 Assembler code that must be preprocessed.
1440 @item @var{other}
1441 An object file to be fed straight into linking.
1442 Any file name with no recognized suffix is treated this way.
1443 @end table
1445 @opindex x
1446 You can specify the input language explicitly with the @option{-x} option:
1448 @table @gcctabopt
1449 @item -x @var{language}
1450 Specify explicitly the @var{language} for the following input files
1451 (rather than letting the compiler choose a default based on the file
1452 name suffix).  This option applies to all following input files until
1453 the next @option{-x} option.  Possible values for @var{language} are:
1454 @smallexample
1455 c  c-header  cpp-output
1456 c++  c++-header  c++-cpp-output
1457 objective-c  objective-c-header  objective-c-cpp-output
1458 objective-c++ objective-c++-header objective-c++-cpp-output
1459 assembler  assembler-with-cpp
1461 f77  f77-cpp-input f95  f95-cpp-input
1463 brig
1464 @end smallexample
1466 @item -x none
1467 Turn off any specification of a language, so that subsequent files are
1468 handled according to their file name suffixes (as they are if @option{-x}
1469 has not been used at all).
1470 @end table
1472 If you only want some of the stages of compilation, you can use
1473 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1474 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1475 @command{gcc} is to stop.  Note that some combinations (for example,
1476 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1478 @table @gcctabopt
1479 @item -c
1480 @opindex c
1481 Compile or assemble the source files, but do not link.  The linking
1482 stage simply is not done.  The ultimate output is in the form of an
1483 object file for each source file.
1485 By default, the object file name for a source file is made by replacing
1486 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1488 Unrecognized input files, not requiring compilation or assembly, are
1489 ignored.
1491 @item -S
1492 @opindex S
1493 Stop after the stage of compilation proper; do not assemble.  The output
1494 is in the form of an assembler code file for each non-assembler input
1495 file specified.
1497 By default, the assembler file name for a source file is made by
1498 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1500 Input files that don't require compilation are ignored.
1502 @item -E
1503 @opindex E
1504 Stop after the preprocessing stage; do not run the compiler proper.  The
1505 output is in the form of preprocessed source code, which is sent to the
1506 standard output.
1508 Input files that don't require preprocessing are ignored.
1510 @cindex output file option
1511 @item -o @var{file}
1512 @opindex o
1513 Place output in file @var{file}.  This applies to whatever
1514 sort of output is being produced, whether it be an executable file,
1515 an object file, an assembler file or preprocessed C code.
1517 If @option{-o} is not specified, the default is to put an executable
1518 file in @file{a.out}, the object file for
1519 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1520 assembler file in @file{@var{source}.s}, a precompiled header file in
1521 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1522 standard output.
1524 @item -v
1525 @opindex v
1526 Print (on standard error output) the commands executed to run the stages
1527 of compilation.  Also print the version number of the compiler driver
1528 program and of the preprocessor and the compiler proper.
1530 @item -###
1531 @opindex ###
1532 Like @option{-v} except the commands are not executed and arguments
1533 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1534 This is useful for shell scripts to capture the driver-generated command lines.
1536 @item --help
1537 @opindex help
1538 Print (on the standard output) a description of the command-line options
1539 understood by @command{gcc}.  If the @option{-v} option is also specified
1540 then @option{--help} is also passed on to the various processes
1541 invoked by @command{gcc}, so that they can display the command-line options
1542 they accept.  If the @option{-Wextra} option has also been specified
1543 (prior to the @option{--help} option), then command-line options that
1544 have no documentation associated with them are also displayed.
1546 @item --target-help
1547 @opindex target-help
1548 Print (on the standard output) a description of target-specific command-line
1549 options for each tool.  For some targets extra target-specific
1550 information may also be printed.
1552 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1553 Print (on the standard output) a description of the command-line
1554 options understood by the compiler that fit into all specified classes
1555 and qualifiers.  These are the supported classes:
1557 @table @asis
1558 @item @samp{optimizers}
1559 Display all of the optimization options supported by the
1560 compiler.
1562 @item @samp{warnings}
1563 Display all of the options controlling warning messages
1564 produced by the compiler.
1566 @item @samp{target}
1567 Display target-specific options.  Unlike the
1568 @option{--target-help} option however, target-specific options of the
1569 linker and assembler are not displayed.  This is because those
1570 tools do not currently support the extended @option{--help=} syntax.
1572 @item @samp{params}
1573 Display the values recognized by the @option{--param}
1574 option.
1576 @item @var{language}
1577 Display the options supported for @var{language}, where
1578 @var{language} is the name of one of the languages supported in this
1579 version of GCC@.
1581 @item @samp{common}
1582 Display the options that are common to all languages.
1583 @end table
1585 These are the supported qualifiers:
1587 @table @asis
1588 @item @samp{undocumented}
1589 Display only those options that are undocumented.
1591 @item @samp{joined}
1592 Display options taking an argument that appears after an equal
1593 sign in the same continuous piece of text, such as:
1594 @samp{--help=target}.
1596 @item @samp{separate}
1597 Display options taking an argument that appears as a separate word
1598 following the original option, such as: @samp{-o output-file}.
1599 @end table
1601 Thus for example to display all the undocumented target-specific
1602 switches supported by the compiler, use:
1604 @smallexample
1605 --help=target,undocumented
1606 @end smallexample
1608 The sense of a qualifier can be inverted by prefixing it with the
1609 @samp{^} character, so for example to display all binary warning
1610 options (i.e., ones that are either on or off and that do not take an
1611 argument) that have a description, use:
1613 @smallexample
1614 --help=warnings,^joined,^undocumented
1615 @end smallexample
1617 The argument to @option{--help=} should not consist solely of inverted
1618 qualifiers.
1620 Combining several classes is possible, although this usually
1621 restricts the output so much that there is nothing to display.  One
1622 case where it does work, however, is when one of the classes is
1623 @var{target}.  For example, to display all the target-specific
1624 optimization options, use:
1626 @smallexample
1627 --help=target,optimizers
1628 @end smallexample
1630 The @option{--help=} option can be repeated on the command line.  Each
1631 successive use displays its requested class of options, skipping
1632 those that have already been displayed.
1634 If the @option{-Q} option appears on the command line before the
1635 @option{--help=} option, then the descriptive text displayed by
1636 @option{--help=} is changed.  Instead of describing the displayed
1637 options, an indication is given as to whether the option is enabled,
1638 disabled or set to a specific value (assuming that the compiler
1639 knows this at the point where the @option{--help=} option is used).
1641 Here is a truncated example from the ARM port of @command{gcc}:
1643 @smallexample
1644   % gcc -Q -mabi=2 --help=target -c
1645   The following options are target specific:
1646   -mabi=                                2
1647   -mabort-on-noreturn                   [disabled]
1648   -mapcs                                [disabled]
1649 @end smallexample
1651 The output is sensitive to the effects of previous command-line
1652 options, so for example it is possible to find out which optimizations
1653 are enabled at @option{-O2} by using:
1655 @smallexample
1656 -Q -O2 --help=optimizers
1657 @end smallexample
1659 Alternatively you can discover which binary optimizations are enabled
1660 by @option{-O3} by using:
1662 @smallexample
1663 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1664 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1665 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1666 @end smallexample
1668 @item --version
1669 @opindex version
1670 Display the version number and copyrights of the invoked GCC@.
1672 @item -pass-exit-codes
1673 @opindex pass-exit-codes
1674 Normally the @command{gcc} program exits with the code of 1 if any
1675 phase of the compiler returns a non-success return code.  If you specify
1676 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1677 the numerically highest error produced by any phase returning an error
1678 indication.  The C, C++, and Fortran front ends return 4 if an internal
1679 compiler error is encountered.
1681 @item -pipe
1682 @opindex pipe
1683 Use pipes rather than temporary files for communication between the
1684 various stages of compilation.  This fails to work on some systems where
1685 the assembler is unable to read from a pipe; but the GNU assembler has
1686 no trouble.
1688 @item -specs=@var{file}
1689 @opindex specs
1690 Process @var{file} after the compiler reads in the standard @file{specs}
1691 file, in order to override the defaults which the @command{gcc} driver
1692 program uses when determining what switches to pass to @command{cc1},
1693 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1694 @option{-specs=@var{file}} can be specified on the command line, and they
1695 are processed in order, from left to right.  @xref{Spec Files}, for
1696 information about the format of the @var{file}.
1698 @item -wrapper
1699 @opindex wrapper
1700 Invoke all subcommands under a wrapper program.  The name of the
1701 wrapper program and its parameters are passed as a comma separated
1702 list.
1704 @smallexample
1705 gcc -c t.c -wrapper gdb,--args
1706 @end smallexample
1708 @noindent
1709 This invokes all subprograms of @command{gcc} under
1710 @samp{gdb --args}, thus the invocation of @command{cc1} is
1711 @samp{gdb --args cc1 @dots{}}.
1713 @item -ffile-prefix-map=@var{old}=@var{new}
1714 @opindex ffile-prefix-map
1715 When compiling files residing in directory @file{@var{old}}, record
1716 any references to them in the result of the compilation as if the
1717 files resided in directory @file{@var{new}} instead.  Specifying this
1718 option is equivalent to specifying all the individual
1719 @option{-f*-prefix-map} options.  This can be used to make reproducible
1720 builds that are location independent.  See also
1721 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1723 @item -fplugin=@var{name}.so
1724 @opindex fplugin
1725 Load the plugin code in file @var{name}.so, assumed to be a
1726 shared object to be dlopen'd by the compiler.  The base name of
1727 the shared object file is used to identify the plugin for the
1728 purposes of argument parsing (See
1729 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1730 Each plugin should define the callback functions specified in the
1731 Plugins API.
1733 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1734 @opindex fplugin-arg
1735 Define an argument called @var{key} with a value of @var{value}
1736 for the plugin called @var{name}.
1738 @item -fdump-ada-spec@r{[}-slim@r{]}
1739 @opindex fdump-ada-spec
1740 For C and C++ source and include files, generate corresponding Ada specs.
1741 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1742 GNAT User's Guide}, which provides detailed documentation on this feature.
1744 @item -fada-spec-parent=@var{unit}
1745 @opindex fada-spec-parent
1746 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1747 Ada specs as child units of parent @var{unit}.
1749 @item -fdump-go-spec=@var{file}
1750 @opindex fdump-go-spec
1751 For input files in any language, generate corresponding Go
1752 declarations in @var{file}.  This generates Go @code{const},
1753 @code{type}, @code{var}, and @code{func} declarations which may be a
1754 useful way to start writing a Go interface to code written in some
1755 other language.
1757 @include @value{srcdir}/../libiberty/at-file.texi
1758 @end table
1760 @node Invoking G++
1761 @section Compiling C++ Programs
1763 @cindex suffixes for C++ source
1764 @cindex C++ source file suffixes
1765 C++ source files conventionally use one of the suffixes @samp{.C},
1766 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1767 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1768 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1769 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1770 files with these names and compiles them as C++ programs even if you
1771 call the compiler the same way as for compiling C programs (usually
1772 with the name @command{gcc}).
1774 @findex g++
1775 @findex c++
1776 However, the use of @command{gcc} does not add the C++ library.
1777 @command{g++} is a program that calls GCC and automatically specifies linking
1778 against the C++ library.  It treats @samp{.c},
1779 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1780 files unless @option{-x} is used.  This program is also useful when
1781 precompiling a C header file with a @samp{.h} extension for use in C++
1782 compilations.  On many systems, @command{g++} is also installed with
1783 the name @command{c++}.
1785 @cindex invoking @command{g++}
1786 When you compile C++ programs, you may specify many of the same
1787 command-line options that you use for compiling programs in any
1788 language; or command-line options meaningful for C and related
1789 languages; or options that are meaningful only for C++ programs.
1790 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1791 explanations of options for languages related to C@.
1792 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1793 explanations of options that are meaningful only for C++ programs.
1795 @node C Dialect Options
1796 @section Options Controlling C Dialect
1797 @cindex dialect options
1798 @cindex language dialect options
1799 @cindex options, dialect
1801 The following options control the dialect of C (or languages derived
1802 from C, such as C++, Objective-C and Objective-C++) that the compiler
1803 accepts:
1805 @table @gcctabopt
1806 @cindex ANSI support
1807 @cindex ISO support
1808 @item -ansi
1809 @opindex ansi
1810 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1811 equivalent to @option{-std=c++98}.
1813 This turns off certain features of GCC that are incompatible with ISO
1814 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1815 such as the @code{asm} and @code{typeof} keywords, and
1816 predefined macros such as @code{unix} and @code{vax} that identify the
1817 type of system you are using.  It also enables the undesirable and
1818 rarely used ISO trigraph feature.  For the C compiler,
1819 it disables recognition of C++ style @samp{//} comments as well as
1820 the @code{inline} keyword.
1822 The alternate keywords @code{__asm__}, @code{__extension__},
1823 @code{__inline__} and @code{__typeof__} continue to work despite
1824 @option{-ansi}.  You would not want to use them in an ISO C program, of
1825 course, but it is useful to put them in header files that might be included
1826 in compilations done with @option{-ansi}.  Alternate predefined macros
1827 such as @code{__unix__} and @code{__vax__} are also available, with or
1828 without @option{-ansi}.
1830 The @option{-ansi} option does not cause non-ISO programs to be
1831 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1832 addition to @option{-ansi}.  @xref{Warning Options}.
1834 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1835 option is used.  Some header files may notice this macro and refrain
1836 from declaring certain functions or defining certain macros that the
1837 ISO standard doesn't call for; this is to avoid interfering with any
1838 programs that might use these names for other things.
1840 Functions that are normally built in but do not have semantics
1841 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1842 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1843 built-in functions provided by GCC}, for details of the functions
1844 affected.
1846 @item -std=
1847 @opindex std
1848 Determine the language standard. @xref{Standards,,Language Standards
1849 Supported by GCC}, for details of these standard versions.  This option
1850 is currently only supported when compiling C or C++.
1852 The compiler can accept several base standards, such as @samp{c90} or
1853 @samp{c++98}, and GNU dialects of those standards, such as
1854 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1855 compiler accepts all programs following that standard plus those
1856 using GNU extensions that do not contradict it.  For example,
1857 @option{-std=c90} turns off certain features of GCC that are
1858 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1859 keywords, but not other GNU extensions that do not have a meaning in
1860 ISO C90, such as omitting the middle term of a @code{?:}
1861 expression. On the other hand, when a GNU dialect of a standard is
1862 specified, all features supported by the compiler are enabled, even when
1863 those features change the meaning of the base standard.  As a result, some
1864 strict-conforming programs may be rejected.  The particular standard
1865 is used by @option{-Wpedantic} to identify which features are GNU
1866 extensions given that version of the standard. For example
1867 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1868 comments, while @option{-std=gnu99 -Wpedantic} does not.
1870 A value for this option must be provided; possible values are
1872 @table @samp
1873 @item c90
1874 @itemx c89
1875 @itemx iso9899:1990
1876 Support all ISO C90 programs (certain GNU extensions that conflict
1877 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1879 @item iso9899:199409
1880 ISO C90 as modified in amendment 1.
1882 @item c99
1883 @itemx c9x
1884 @itemx iso9899:1999
1885 @itemx iso9899:199x
1886 ISO C99.  This standard is substantially completely supported, modulo
1887 bugs and floating-point issues
1888 (mainly but not entirely relating to optional C99 features from
1889 Annexes F and G).  See
1890 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1891 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1893 @item c11
1894 @itemx c1x
1895 @itemx iso9899:2011
1896 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1897 substantially completely supported, modulo bugs, floating-point issues
1898 (mainly but not entirely relating to optional C11 features from
1899 Annexes F and G) and the optional Annexes K (Bounds-checking
1900 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1902 @item c17
1903 @itemx c18
1904 @itemx iso9899:2017
1905 @itemx iso9899:2018
1906 ISO C17, the 2017 revision of the ISO C standard (expected to be
1907 published in 2018).  This standard is
1908 same as C11 except for corrections of defects (all of which are also
1909 applied with @option{-std=c11}) and a new value of
1910 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1912 @item gnu90
1913 @itemx gnu89
1914 GNU dialect of ISO C90 (including some C99 features).
1916 @item gnu99
1917 @itemx gnu9x
1918 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1920 @item gnu11
1921 @itemx gnu1x
1922 GNU dialect of ISO C11.
1923 The name @samp{gnu1x} is deprecated.
1925 @item gnu17
1926 @itemx gnu18
1927 GNU dialect of ISO C17.  This is the default for C code.
1929 @item c++98
1930 @itemx c++03
1931 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1932 additional defect reports. Same as @option{-ansi} for C++ code.
1934 @item gnu++98
1935 @itemx gnu++03
1936 GNU dialect of @option{-std=c++98}.
1938 @item c++11
1939 @itemx c++0x
1940 The 2011 ISO C++ standard plus amendments.
1941 The name @samp{c++0x} is deprecated.
1943 @item gnu++11
1944 @itemx gnu++0x
1945 GNU dialect of @option{-std=c++11}.
1946 The name @samp{gnu++0x} is deprecated.
1948 @item c++14
1949 @itemx c++1y
1950 The 2014 ISO C++ standard plus amendments.
1951 The name @samp{c++1y} is deprecated.
1953 @item gnu++14
1954 @itemx gnu++1y
1955 GNU dialect of @option{-std=c++14}.
1956 This is the default for C++ code.
1957 The name @samp{gnu++1y} is deprecated.
1959 @item c++17
1960 @itemx c++1z
1961 The 2017 ISO C++ standard plus amendments.
1962 The name @samp{c++1z} is deprecated.
1964 @item gnu++17
1965 @itemx gnu++1z
1966 GNU dialect of @option{-std=c++17}.
1967 The name @samp{gnu++1z} is deprecated.
1969 @item c++2a
1970 The next revision of the ISO C++ standard, tentatively planned for
1971 2020.  Support is highly experimental, and will almost certainly
1972 change in incompatible ways in future releases.
1974 @item gnu++2a
1975 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1976 and will almost certainly change in incompatible ways in future
1977 releases.
1978 @end table
1980 @item -fgnu89-inline
1981 @opindex fgnu89-inline
1982 The option @option{-fgnu89-inline} tells GCC to use the traditional
1983 GNU semantics for @code{inline} functions when in C99 mode.
1984 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1985 Using this option is roughly equivalent to adding the
1986 @code{gnu_inline} function attribute to all inline functions
1987 (@pxref{Function Attributes}).
1989 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1990 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1991 specifies the default behavior).
1992 This option is not supported in @option{-std=c90} or
1993 @option{-std=gnu90} mode.
1995 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1996 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1997 in effect for @code{inline} functions.  @xref{Common Predefined
1998 Macros,,,cpp,The C Preprocessor}.
2000 @item -fpermitted-flt-eval-methods=@var{style}
2001 @opindex fpermitted-flt-eval-methods
2002 @opindex fpermitted-flt-eval-methods=c11
2003 @opindex fpermitted-flt-eval-methods=ts-18661-3
2004 ISO/IEC TS 18661-3 defines new permissible values for
2005 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2006 a semantic type that is an interchange or extended format should be
2007 evaluated to the precision and range of that type.  These new values are
2008 a superset of those permitted under C99/C11, which does not specify the
2009 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2010 conforming to C11 may not have been written expecting the possibility of
2011 the new values.
2013 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2014 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2015 or the extended set of values specified in ISO/IEC TS 18661-3.
2017 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2019 The default when in a standards compliant mode (@option{-std=c11} or similar)
2020 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2021 dialect (@option{-std=gnu11} or similar) is
2022 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2024 @item -aux-info @var{filename}
2025 @opindex aux-info
2026 Output to the given filename prototyped declarations for all functions
2027 declared and/or defined in a translation unit, including those in header
2028 files.  This option is silently ignored in any language other than C@.
2030 Besides declarations, the file indicates, in comments, the origin of
2031 each declaration (source file and line), whether the declaration was
2032 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2033 @samp{O} for old, respectively, in the first character after the line
2034 number and the colon), and whether it came from a declaration or a
2035 definition (@samp{C} or @samp{F}, respectively, in the following
2036 character).  In the case of function definitions, a K&R-style list of
2037 arguments followed by their declarations is also provided, inside
2038 comments, after the declaration.
2040 @item -fallow-parameterless-variadic-functions
2041 @opindex fallow-parameterless-variadic-functions
2042 Accept variadic functions without named parameters.
2044 Although it is possible to define such a function, this is not very
2045 useful as it is not possible to read the arguments.  This is only
2046 supported for C as this construct is allowed by C++.
2048 @item -fno-asm
2049 @opindex fno-asm
2050 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2051 keyword, so that code can use these words as identifiers.  You can use
2052 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2053 instead.  @option{-ansi} implies @option{-fno-asm}.
2055 In C++, this switch only affects the @code{typeof} keyword, since
2056 @code{asm} and @code{inline} are standard keywords.  You may want to
2057 use the @option{-fno-gnu-keywords} flag instead, which has the same
2058 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2059 switch only affects the @code{asm} and @code{typeof} keywords, since
2060 @code{inline} is a standard keyword in ISO C99.
2062 @item -fno-builtin
2063 @itemx -fno-builtin-@var{function}
2064 @opindex fno-builtin
2065 @cindex built-in functions
2066 Don't recognize built-in functions that do not begin with
2067 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2068 functions provided by GCC}, for details of the functions affected,
2069 including those which are not built-in functions when @option{-ansi} or
2070 @option{-std} options for strict ISO C conformance are used because they
2071 do not have an ISO standard meaning.
2073 GCC normally generates special code to handle certain built-in functions
2074 more efficiently; for instance, calls to @code{alloca} may become single
2075 instructions which adjust the stack directly, and calls to @code{memcpy}
2076 may become inline copy loops.  The resulting code is often both smaller
2077 and faster, but since the function calls no longer appear as such, you
2078 cannot set a breakpoint on those calls, nor can you change the behavior
2079 of the functions by linking with a different library.  In addition,
2080 when a function is recognized as a built-in function, GCC may use
2081 information about that function to warn about problems with calls to
2082 that function, or to generate more efficient code, even if the
2083 resulting code still contains calls to that function.  For example,
2084 warnings are given with @option{-Wformat} for bad calls to
2085 @code{printf} when @code{printf} is built in and @code{strlen} is
2086 known not to modify global memory.
2088 With the @option{-fno-builtin-@var{function}} option
2089 only the built-in function @var{function} is
2090 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2091 function is named that is not built-in in this version of GCC, this
2092 option is ignored.  There is no corresponding
2093 @option{-fbuiltin-@var{function}} option; if you wish to enable
2094 built-in functions selectively when using @option{-fno-builtin} or
2095 @option{-ffreestanding}, you may define macros such as:
2097 @smallexample
2098 #define abs(n)          __builtin_abs ((n))
2099 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2100 @end smallexample
2102 @item -fgimple
2103 @opindex fgimple
2105 Enable parsing of function definitions marked with @code{__GIMPLE}.
2106 This is an experimental feature that allows unit testing of GIMPLE
2107 passes.
2109 @item -fhosted
2110 @opindex fhosted
2111 @cindex hosted environment
2113 Assert that compilation targets a hosted environment.  This implies
2114 @option{-fbuiltin}.  A hosted environment is one in which the
2115 entire standard library is available, and in which @code{main} has a return
2116 type of @code{int}.  Examples are nearly everything except a kernel.
2117 This is equivalent to @option{-fno-freestanding}.
2119 @item -ffreestanding
2120 @opindex ffreestanding
2121 @cindex hosted environment
2123 Assert that compilation targets a freestanding environment.  This
2124 implies @option{-fno-builtin}.  A freestanding environment
2125 is one in which the standard library may not exist, and program startup may
2126 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2127 This is equivalent to @option{-fno-hosted}.
2129 @xref{Standards,,Language Standards Supported by GCC}, for details of
2130 freestanding and hosted environments.
2132 @item -fopenacc
2133 @opindex fopenacc
2134 @cindex OpenACC accelerator programming
2135 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2136 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2137 compiler generates accelerated code according to the OpenACC Application
2138 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2139 implies @option{-pthread}, and thus is only supported on targets that
2140 have support for @option{-pthread}.
2142 @item -fopenacc-dim=@var{geom}
2143 @opindex fopenacc-dim
2144 @cindex OpenACC accelerator programming
2145 Specify default compute dimensions for parallel offload regions that do
2146 not explicitly specify.  The @var{geom} value is a triple of
2147 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2148 can be omitted, to use a target-specific default value.
2150 @item -fopenmp
2151 @opindex fopenmp
2152 @cindex OpenMP parallel
2153 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2154 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2155 compiler generates parallel code according to the OpenMP Application
2156 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2157 implies @option{-pthread}, and thus is only supported on targets that
2158 have support for @option{-pthread}. @option{-fopenmp} implies
2159 @option{-fopenmp-simd}.
2161 @item -fopenmp-simd
2162 @opindex fopenmp-simd
2163 @cindex OpenMP SIMD
2164 @cindex SIMD
2165 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2166 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2167 are ignored.
2169 @item -fgnu-tm
2170 @opindex fgnu-tm
2171 When the option @option{-fgnu-tm} is specified, the compiler
2172 generates code for the Linux variant of Intel's current Transactional
2173 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2174 an experimental feature whose interface may change in future versions
2175 of GCC, as the official specification changes.  Please note that not
2176 all architectures are supported for this feature.
2178 For more information on GCC's support for transactional memory,
2179 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2180 Transactional Memory Library}.
2182 Note that the transactional memory feature is not supported with
2183 non-call exceptions (@option{-fnon-call-exceptions}).
2185 @item -fms-extensions
2186 @opindex fms-extensions
2187 Accept some non-standard constructs used in Microsoft header files.
2189 In C++ code, this allows member names in structures to be similar
2190 to previous types declarations.
2192 @smallexample
2193 typedef int UOW;
2194 struct ABC @{
2195   UOW UOW;
2197 @end smallexample
2199 Some cases of unnamed fields in structures and unions are only
2200 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2201 fields within structs/unions}, for details.
2203 Note that this option is off for all targets but x86 
2204 targets using ms-abi.
2206 @item -fplan9-extensions
2207 @opindex fplan9-extensions
2208 Accept some non-standard constructs used in Plan 9 code.
2210 This enables @option{-fms-extensions}, permits passing pointers to
2211 structures with anonymous fields to functions that expect pointers to
2212 elements of the type of the field, and permits referring to anonymous
2213 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2214 struct/union fields within structs/unions}, for details.  This is only
2215 supported for C, not C++.
2217 @item -fcond-mismatch
2218 @opindex fcond-mismatch
2219 Allow conditional expressions with mismatched types in the second and
2220 third arguments.  The value of such an expression is void.  This option
2221 is not supported for C++.
2223 @item -flax-vector-conversions
2224 @opindex flax-vector-conversions
2225 Allow implicit conversions between vectors with differing numbers of
2226 elements and/or incompatible element types.  This option should not be
2227 used for new code.
2229 @item -funsigned-char
2230 @opindex funsigned-char
2231 Let the type @code{char} be unsigned, like @code{unsigned char}.
2233 Each kind of machine has a default for what @code{char} should
2234 be.  It is either like @code{unsigned char} by default or like
2235 @code{signed char} by default.
2237 Ideally, a portable program should always use @code{signed char} or
2238 @code{unsigned char} when it depends on the signedness of an object.
2239 But many programs have been written to use plain @code{char} and
2240 expect it to be signed, or expect it to be unsigned, depending on the
2241 machines they were written for.  This option, and its inverse, let you
2242 make such a program work with the opposite default.
2244 The type @code{char} is always a distinct type from each of
2245 @code{signed char} or @code{unsigned char}, even though its behavior
2246 is always just like one of those two.
2248 @item -fsigned-char
2249 @opindex fsigned-char
2250 Let the type @code{char} be signed, like @code{signed char}.
2252 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2253 the negative form of @option{-funsigned-char}.  Likewise, the option
2254 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2256 @item -fsigned-bitfields
2257 @itemx -funsigned-bitfields
2258 @itemx -fno-signed-bitfields
2259 @itemx -fno-unsigned-bitfields
2260 @opindex fsigned-bitfields
2261 @opindex funsigned-bitfields
2262 @opindex fno-signed-bitfields
2263 @opindex fno-unsigned-bitfields
2264 These options control whether a bit-field is signed or unsigned, when the
2265 declaration does not use either @code{signed} or @code{unsigned}.  By
2266 default, such a bit-field is signed, because this is consistent: the
2267 basic integer types such as @code{int} are signed types.
2269 @item -fsso-struct=@var{endianness}
2270 @opindex fsso-struct
2271 Set the default scalar storage order of structures and unions to the
2272 specified endianness.  The accepted values are @samp{big-endian},
2273 @samp{little-endian} and @samp{native} for the native endianness of
2274 the target (the default).  This option is not supported for C++.
2276 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2277 code that is not binary compatible with code generated without it if the
2278 specified endianness is not the native endianness of the target.
2279 @end table
2281 @node C++ Dialect Options
2282 @section Options Controlling C++ Dialect
2284 @cindex compiler options, C++
2285 @cindex C++ options, command-line
2286 @cindex options, C++
2287 This section describes the command-line options that are only meaningful
2288 for C++ programs.  You can also use most of the GNU compiler options
2289 regardless of what language your program is in.  For example, you
2290 might compile a file @file{firstClass.C} like this:
2292 @smallexample
2293 g++ -g -fstrict-enums -O -c firstClass.C
2294 @end smallexample
2296 @noindent
2297 In this example, only @option{-fstrict-enums} is an option meant
2298 only for C++ programs; you can use the other options with any
2299 language supported by GCC@.
2301 Some options for compiling C programs, such as @option{-std}, are also
2302 relevant for C++ programs.
2303 @xref{C Dialect Options,,Options Controlling C Dialect}.
2305 Here is a list of options that are @emph{only} for compiling C++ programs:
2307 @table @gcctabopt
2309 @item -fabi-version=@var{n}
2310 @opindex fabi-version
2311 Use version @var{n} of the C++ ABI@.  The default is version 0.
2313 Version 0 refers to the version conforming most closely to
2314 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2315 will change in different versions of G++ as ABI bugs are fixed.
2317 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2319 Version 2 is the version of the C++ ABI that first appeared in G++
2320 3.4, and was the default through G++ 4.9.
2322 Version 3 corrects an error in mangling a constant address as a
2323 template argument.
2325 Version 4, which first appeared in G++ 4.5, implements a standard
2326 mangling for vector types.
2328 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2329 attribute const/volatile on function pointer types, decltype of a
2330 plain decl, and use of a function parameter in the declaration of
2331 another parameter.
2333 Version 6, which first appeared in G++ 4.7, corrects the promotion
2334 behavior of C++11 scoped enums and the mangling of template argument
2335 packs, const/static_cast, prefix ++ and --, and a class scope function
2336 used as a template argument.
2338 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2339 builtin type and corrects the mangling of lambdas in default argument
2340 scope.
2342 Version 8, which first appeared in G++ 4.9, corrects the substitution
2343 behavior of function types with function-cv-qualifiers.
2345 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2346 @code{nullptr_t}.
2348 Version 10, which first appeared in G++ 6.1, adds mangling of
2349 attributes that affect type identity, such as ia32 calling convention
2350 attributes (e.g. @samp{stdcall}).
2352 Version 11, which first appeared in G++ 7, corrects the mangling of
2353 sizeof... expressions and operator names.  For multiple entities with
2354 the same name within a function, that are declared in different scopes,
2355 the mangling now changes starting with the twelfth occurrence.  It also
2356 implies @option{-fnew-inheriting-ctors}.
2358 See also @option{-Wabi}.
2360 @item -fabi-compat-version=@var{n}
2361 @opindex fabi-compat-version
2362 On targets that support strong aliases, G++
2363 works around mangling changes by creating an alias with the correct
2364 mangled name when defining a symbol with an incorrect mangled name.
2365 This switch specifies which ABI version to use for the alias.
2367 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2368 compatibility).  If another ABI version is explicitly selected, this
2369 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2370 use @option{-fabi-compat-version=2}.
2372 If this option is not provided but @option{-Wabi=@var{n}} is, that
2373 version is used for compatibility aliases.  If this option is provided
2374 along with @option{-Wabi} (without the version), the version from this
2375 option is used for the warning.
2377 @item -fno-access-control
2378 @opindex fno-access-control
2379 Turn off all access checking.  This switch is mainly useful for working
2380 around bugs in the access control code.
2382 @item -faligned-new
2383 @opindex faligned-new
2384 Enable support for C++17 @code{new} of types that require more
2385 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2386 numeric argument such as @code{-faligned-new=32} can be used to
2387 specify how much alignment (in bytes) is provided by that function,
2388 but few users will need to override the default of
2389 @code{alignof(std::max_align_t)}.
2391 This flag is enabled by default for @option{-std=c++17}.
2393 @item -fcheck-new
2394 @opindex fcheck-new
2395 Check that the pointer returned by @code{operator new} is non-null
2396 before attempting to modify the storage allocated.  This check is
2397 normally unnecessary because the C++ standard specifies that
2398 @code{operator new} only returns @code{0} if it is declared
2399 @code{throw()}, in which case the compiler always checks the
2400 return value even without this option.  In all other cases, when
2401 @code{operator new} has a non-empty exception specification, memory
2402 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2403 @samp{new (nothrow)}.
2405 @item -fconcepts
2406 @opindex fconcepts
2407 Enable support for the C++ Extensions for Concepts Technical
2408 Specification, ISO 19217 (2015), which allows code like
2410 @smallexample
2411 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2412 template <Addable T> T add (T a, T b) @{ return a + b; @}
2413 @end smallexample
2415 @item -fconstexpr-depth=@var{n}
2416 @opindex fconstexpr-depth
2417 Set the maximum nested evaluation depth for C++11 constexpr functions
2418 to @var{n}.  A limit is needed to detect endless recursion during
2419 constant expression evaluation.  The minimum specified by the standard
2420 is 512.
2422 @item -fconstexpr-loop-limit=@var{n}
2423 @opindex fconstexpr-loop-limit
2424 Set the maximum number of iterations for a loop in C++14 constexpr functions
2425 to @var{n}.  A limit is needed to detect infinite loops during
2426 constant expression evaluation.  The default is 262144 (1<<18).
2428 @item -fdeduce-init-list
2429 @opindex fdeduce-init-list
2430 Enable deduction of a template type parameter as
2431 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2433 @smallexample
2434 template <class T> auto forward(T t) -> decltype (realfn (t))
2436   return realfn (t);
2439 void f()
2441   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2443 @end smallexample
2445 This deduction was implemented as a possible extension to the
2446 originally proposed semantics for the C++11 standard, but was not part
2447 of the final standard, so it is disabled by default.  This option is
2448 deprecated, and may be removed in a future version of G++.
2450 @item -fno-elide-constructors
2451 @opindex fno-elide-constructors
2452 The C++ standard allows an implementation to omit creating a temporary
2453 that is only used to initialize another object of the same type.
2454 Specifying this option disables that optimization, and forces G++ to
2455 call the copy constructor in all cases.  This option also causes G++
2456 to call trivial member functions which otherwise would be expanded inline.
2458 In C++17, the compiler is required to omit these temporaries, but this
2459 option still affects trivial member functions.
2461 @item -fno-enforce-eh-specs
2462 @opindex fno-enforce-eh-specs
2463 Don't generate code to check for violation of exception specifications
2464 at run time.  This option violates the C++ standard, but may be useful
2465 for reducing code size in production builds, much like defining
2466 @code{NDEBUG}.  This does not give user code permission to throw
2467 exceptions in violation of the exception specifications; the compiler
2468 still optimizes based on the specifications, so throwing an
2469 unexpected exception results in undefined behavior at run time.
2471 @item -fextern-tls-init
2472 @itemx -fno-extern-tls-init
2473 @opindex fextern-tls-init
2474 @opindex fno-extern-tls-init
2475 The C++11 and OpenMP standards allow @code{thread_local} and
2476 @code{threadprivate} variables to have dynamic (runtime)
2477 initialization.  To support this, any use of such a variable goes
2478 through a wrapper function that performs any necessary initialization.
2479 When the use and definition of the variable are in the same
2480 translation unit, this overhead can be optimized away, but when the
2481 use is in a different translation unit there is significant overhead
2482 even if the variable doesn't actually need dynamic initialization.  If
2483 the programmer can be sure that no use of the variable in a
2484 non-defining TU needs to trigger dynamic initialization (either
2485 because the variable is statically initialized, or a use of the
2486 variable in the defining TU will be executed before any uses in
2487 another TU), they can avoid this overhead with the
2488 @option{-fno-extern-tls-init} option.
2490 On targets that support symbol aliases, the default is
2491 @option{-fextern-tls-init}.  On targets that do not support symbol
2492 aliases, the default is @option{-fno-extern-tls-init}.
2494 @item -fno-gnu-keywords
2495 @opindex fno-gnu-keywords
2496 Do not recognize @code{typeof} as a keyword, so that code can use this
2497 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2498 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2499 @option{-std=c++98}, @option{-std=c++11}, etc.
2501 @item -fno-implicit-templates
2502 @opindex fno-implicit-templates
2503 Never emit code for non-inline templates that are instantiated
2504 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2505 @xref{Template Instantiation}, for more information.
2507 @item -fno-implicit-inline-templates
2508 @opindex fno-implicit-inline-templates
2509 Don't emit code for implicit instantiations of inline templates, either.
2510 The default is to handle inlines differently so that compiles with and
2511 without optimization need the same set of explicit instantiations.
2513 @item -fno-implement-inlines
2514 @opindex fno-implement-inlines
2515 To save space, do not emit out-of-line copies of inline functions
2516 controlled by @code{#pragma implementation}.  This causes linker
2517 errors if these functions are not inlined everywhere they are called.
2519 @item -fms-extensions
2520 @opindex fms-extensions
2521 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2522 int and getting a pointer to member function via non-standard syntax.
2524 @item -fnew-inheriting-ctors
2525 @opindex fnew-inheriting-ctors
2526 Enable the P0136 adjustment to the semantics of C++11 constructor
2527 inheritance.  This is part of C++17 but also considered to be a Defect
2528 Report against C++11 and C++14.  This flag is enabled by default
2529 unless @option{-fabi-version=10} or lower is specified.
2531 @item -fnew-ttp-matching
2532 @opindex fnew-ttp-matching
2533 Enable the P0522 resolution to Core issue 150, template template
2534 parameters and default arguments: this allows a template with default
2535 template arguments as an argument for a template template parameter
2536 with fewer template parameters.  This flag is enabled by default for
2537 @option{-std=c++17}.
2539 @item -fno-nonansi-builtins
2540 @opindex fno-nonansi-builtins
2541 Disable built-in declarations of functions that are not mandated by
2542 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2543 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2545 @item -fnothrow-opt
2546 @opindex fnothrow-opt
2547 Treat a @code{throw()} exception specification as if it were a
2548 @code{noexcept} specification to reduce or eliminate the text size
2549 overhead relative to a function with no exception specification.  If
2550 the function has local variables of types with non-trivial
2551 destructors, the exception specification actually makes the
2552 function smaller because the EH cleanups for those variables can be
2553 optimized away.  The semantic effect is that an exception thrown out of
2554 a function with such an exception specification results in a call
2555 to @code{terminate} rather than @code{unexpected}.
2557 @item -fno-operator-names
2558 @opindex fno-operator-names
2559 Do not treat the operator name keywords @code{and}, @code{bitand},
2560 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2561 synonyms as keywords.
2563 @item -fno-optional-diags
2564 @opindex fno-optional-diags
2565 Disable diagnostics that the standard says a compiler does not need to
2566 issue.  Currently, the only such diagnostic issued by G++ is the one for
2567 a name having multiple meanings within a class.
2569 @item -fpermissive
2570 @opindex fpermissive
2571 Downgrade some diagnostics about nonconformant code from errors to
2572 warnings.  Thus, using @option{-fpermissive} allows some
2573 nonconforming code to compile.
2575 @item -fno-pretty-templates
2576 @opindex fno-pretty-templates
2577 When an error message refers to a specialization of a function
2578 template, the compiler normally prints the signature of the
2579 template followed by the template arguments and any typedefs or
2580 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2581 rather than @code{void f(int)}) so that it's clear which template is
2582 involved.  When an error message refers to a specialization of a class
2583 template, the compiler omits any template arguments that match
2584 the default template arguments for that template.  If either of these
2585 behaviors make it harder to understand the error message rather than
2586 easier, you can use @option{-fno-pretty-templates} to disable them.
2588 @item -frepo
2589 @opindex frepo
2590 Enable automatic template instantiation at link time.  This option also
2591 implies @option{-fno-implicit-templates}.  @xref{Template
2592 Instantiation}, for more information.
2594 @item -fno-rtti
2595 @opindex fno-rtti
2596 Disable generation of information about every class with virtual
2597 functions for use by the C++ run-time type identification features
2598 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2599 of the language, you can save some space by using this flag.  Note that
2600 exception handling uses the same information, but G++ generates it as
2601 needed. The @code{dynamic_cast} operator can still be used for casts that
2602 do not require run-time type information, i.e.@: casts to @code{void *} or to
2603 unambiguous base classes.
2605 @item -fsized-deallocation
2606 @opindex fsized-deallocation
2607 Enable the built-in global declarations
2608 @smallexample
2609 void operator delete (void *, std::size_t) noexcept;
2610 void operator delete[] (void *, std::size_t) noexcept;
2611 @end smallexample
2612 as introduced in C++14.  This is useful for user-defined replacement
2613 deallocation functions that, for example, use the size of the object
2614 to make deallocation faster.  Enabled by default under
2615 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2616 warns about places that might want to add a definition.
2618 @item -fstrict-enums
2619 @opindex fstrict-enums
2620 Allow the compiler to optimize using the assumption that a value of
2621 enumerated type can only be one of the values of the enumeration (as
2622 defined in the C++ standard; basically, a value that can be
2623 represented in the minimum number of bits needed to represent all the
2624 enumerators).  This assumption may not be valid if the program uses a
2625 cast to convert an arbitrary integer value to the enumerated type.
2627 @item -fstrong-eval-order
2628 @opindex fstrong-eval-order
2629 Evaluate member access, array subscripting, and shift expressions in
2630 left-to-right order, and evaluate assignment in right-to-left order,
2631 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2632 @option{-fstrong-eval-order=some} enables just the ordering of member
2633 access and shift expressions, and is the default without
2634 @option{-std=c++17}.
2636 @item -ftemplate-backtrace-limit=@var{n}
2637 @opindex ftemplate-backtrace-limit
2638 Set the maximum number of template instantiation notes for a single
2639 warning or error to @var{n}.  The default value is 10.
2641 @item -ftemplate-depth=@var{n}
2642 @opindex ftemplate-depth
2643 Set the maximum instantiation depth for template classes to @var{n}.
2644 A limit on the template instantiation depth is needed to detect
2645 endless recursions during template class instantiation.  ANSI/ISO C++
2646 conforming programs must not rely on a maximum depth greater than 17
2647 (changed to 1024 in C++11).  The default value is 900, as the compiler
2648 can run out of stack space before hitting 1024 in some situations.
2650 @item -fno-threadsafe-statics
2651 @opindex fno-threadsafe-statics
2652 Do not emit the extra code to use the routines specified in the C++
2653 ABI for thread-safe initialization of local statics.  You can use this
2654 option to reduce code size slightly in code that doesn't need to be
2655 thread-safe.
2657 @item -fuse-cxa-atexit
2658 @opindex fuse-cxa-atexit
2659 Register destructors for objects with static storage duration with the
2660 @code{__cxa_atexit} function rather than the @code{atexit} function.
2661 This option is required for fully standards-compliant handling of static
2662 destructors, but only works if your C library supports
2663 @code{__cxa_atexit}.
2665 @item -fno-use-cxa-get-exception-ptr
2666 @opindex fno-use-cxa-get-exception-ptr
2667 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2668 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2669 if the runtime routine is not available.
2671 @item -fvisibility-inlines-hidden
2672 @opindex fvisibility-inlines-hidden
2673 This switch declares that the user does not attempt to compare
2674 pointers to inline functions or methods where the addresses of the two functions
2675 are taken in different shared objects.
2677 The effect of this is that GCC may, effectively, mark inline methods with
2678 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2679 appear in the export table of a DSO and do not require a PLT indirection
2680 when used within the DSO@.  Enabling this option can have a dramatic effect
2681 on load and link times of a DSO as it massively reduces the size of the
2682 dynamic export table when the library makes heavy use of templates.
2684 The behavior of this switch is not quite the same as marking the
2685 methods as hidden directly, because it does not affect static variables
2686 local to the function or cause the compiler to deduce that
2687 the function is defined in only one shared object.
2689 You may mark a method as having a visibility explicitly to negate the
2690 effect of the switch for that method.  For example, if you do want to
2691 compare pointers to a particular inline method, you might mark it as
2692 having default visibility.  Marking the enclosing class with explicit
2693 visibility has no effect.
2695 Explicitly instantiated inline methods are unaffected by this option
2696 as their linkage might otherwise cross a shared library boundary.
2697 @xref{Template Instantiation}.
2699 @item -fvisibility-ms-compat
2700 @opindex fvisibility-ms-compat
2701 This flag attempts to use visibility settings to make GCC's C++
2702 linkage model compatible with that of Microsoft Visual Studio.
2704 The flag makes these changes to GCC's linkage model:
2706 @enumerate
2707 @item
2708 It sets the default visibility to @code{hidden}, like
2709 @option{-fvisibility=hidden}.
2711 @item
2712 Types, but not their members, are not hidden by default.
2714 @item
2715 The One Definition Rule is relaxed for types without explicit
2716 visibility specifications that are defined in more than one
2717 shared object: those declarations are permitted if they are
2718 permitted when this option is not used.
2719 @end enumerate
2721 In new code it is better to use @option{-fvisibility=hidden} and
2722 export those classes that are intended to be externally visible.
2723 Unfortunately it is possible for code to rely, perhaps accidentally,
2724 on the Visual Studio behavior.
2726 Among the consequences of these changes are that static data members
2727 of the same type with the same name but defined in different shared
2728 objects are different, so changing one does not change the other;
2729 and that pointers to function members defined in different shared
2730 objects may not compare equal.  When this flag is given, it is a
2731 violation of the ODR to define types with the same name differently.
2733 @item -fno-weak
2734 @opindex fno-weak
2735 Do not use weak symbol support, even if it is provided by the linker.
2736 By default, G++ uses weak symbols if they are available.  This
2737 option exists only for testing, and should not be used by end-users;
2738 it results in inferior code and has no benefits.  This option may
2739 be removed in a future release of G++.
2741 @item -nostdinc++
2742 @opindex nostdinc++
2743 Do not search for header files in the standard directories specific to
2744 C++, but do still search the other standard directories.  (This option
2745 is used when building the C++ library.)
2746 @end table
2748 In addition, these optimization, warning, and code generation options
2749 have meanings only for C++ programs:
2751 @table @gcctabopt
2752 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2753 @opindex Wabi
2754 @opindex Wno-abi
2755 Warn when G++ it generates code that is probably not compatible with
2756 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2757 ABI with each major release, normally @option{-Wabi} will warn only if
2758 there is a check added later in a release series for an ABI issue
2759 discovered since the initial release.  @option{-Wabi} will warn about
2760 more things if an older ABI version is selected (with
2761 @option{-fabi-version=@var{n}}).
2763 @option{-Wabi} can also be used with an explicit version number to
2764 warn about compatibility with a particular @option{-fabi-version}
2765 level, e.g. @option{-Wabi=2} to warn about changes relative to
2766 @option{-fabi-version=2}.
2768 If an explicit version number is provided and
2769 @option{-fabi-compat-version} is not specified, the version number
2770 from this option is used for compatibility aliases.  If no explicit
2771 version number is provided with this option, but
2772 @option{-fabi-compat-version} is specified, that version number is
2773 used for ABI warnings.
2775 Although an effort has been made to warn about
2776 all such cases, there are probably some cases that are not warned about,
2777 even though G++ is generating incompatible code.  There may also be
2778 cases where warnings are emitted even though the code that is generated
2779 is compatible.
2781 You should rewrite your code to avoid these warnings if you are
2782 concerned about the fact that code generated by G++ may not be binary
2783 compatible with code generated by other compilers.
2785 Known incompatibilities in @option{-fabi-version=2} (which was the
2786 default from GCC 3.4 to 4.9) include:
2788 @itemize @bullet
2790 @item
2791 A template with a non-type template parameter of reference type was
2792 mangled incorrectly:
2793 @smallexample
2794 extern int N;
2795 template <int &> struct S @{@};
2796 void n (S<N>) @{2@}
2797 @end smallexample
2799 This was fixed in @option{-fabi-version=3}.
2801 @item
2802 SIMD vector types declared using @code{__attribute ((vector_size))} were
2803 mangled in a non-standard way that does not allow for overloading of
2804 functions taking vectors of different sizes.
2806 The mangling was changed in @option{-fabi-version=4}.
2808 @item
2809 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2810 qualifiers, and @code{decltype} of a plain declaration was folded away.
2812 These mangling issues were fixed in @option{-fabi-version=5}.
2814 @item
2815 Scoped enumerators passed as arguments to a variadic function are
2816 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2817 On most targets this does not actually affect the parameter passing
2818 ABI, as there is no way to pass an argument smaller than @code{int}.
2820 Also, the ABI changed the mangling of template argument packs,
2821 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2822 a class scope function used as a template argument.
2824 These issues were corrected in @option{-fabi-version=6}.
2826 @item
2827 Lambdas in default argument scope were mangled incorrectly, and the
2828 ABI changed the mangling of @code{nullptr_t}.
2830 These issues were corrected in @option{-fabi-version=7}.
2832 @item
2833 When mangling a function type with function-cv-qualifiers, the
2834 un-qualified function type was incorrectly treated as a substitution
2835 candidate.
2837 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2839 @item
2840 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2841 unaligned accesses.  Note that this did not affect the ABI of a
2842 function with a @code{nullptr_t} parameter, as parameters have a
2843 minimum alignment.
2845 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2847 @item
2848 Target-specific attributes that affect the identity of a type, such as
2849 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2850 did not affect the mangled name, leading to name collisions when
2851 function pointers were used as template arguments.
2853 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2855 @end itemize
2857 It also warns about psABI-related changes.  The known psABI changes at this
2858 point include:
2860 @itemize @bullet
2862 @item
2863 For SysV/x86-64, unions with @code{long double} members are 
2864 passed in memory as specified in psABI.  For example:
2866 @smallexample
2867 union U @{
2868   long double ld;
2869   int i;
2871 @end smallexample
2873 @noindent
2874 @code{union U} is always passed in memory.
2876 @end itemize
2878 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2879 @opindex Wabi-tag
2880 @opindex -Wabi-tag
2881 Warn when a type with an ABI tag is used in a context that does not
2882 have that ABI tag.  See @ref{C++ Attributes} for more information
2883 about ABI tags.
2885 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2886 @opindex Wctor-dtor-privacy
2887 @opindex Wno-ctor-dtor-privacy
2888 Warn when a class seems unusable because all the constructors or
2889 destructors in that class are private, and it has neither friends nor
2890 public static member functions.  Also warn if there are no non-private
2891 methods, and there's at least one private member function that isn't
2892 a constructor or destructor.
2894 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2895 @opindex Wdelete-non-virtual-dtor
2896 @opindex Wno-delete-non-virtual-dtor
2897 Warn when @code{delete} is used to destroy an instance of a class that
2898 has virtual functions and non-virtual destructor. It is unsafe to delete
2899 an instance of a derived class through a pointer to a base class if the
2900 base class does not have a virtual destructor.  This warning is enabled
2901 by @option{-Wall}.
2903 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2904 @opindex Wliteral-suffix
2905 @opindex Wno-literal-suffix
2906 Warn when a string or character literal is followed by a ud-suffix which does
2907 not begin with an underscore.  As a conforming extension, GCC treats such
2908 suffixes as separate preprocessing tokens in order to maintain backwards
2909 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2910 For example:
2912 @smallexample
2913 #define __STDC_FORMAT_MACROS
2914 #include <inttypes.h>
2915 #include <stdio.h>
2917 int main() @{
2918   int64_t i64 = 123;
2919   printf("My int64: %" PRId64"\n", i64);
2921 @end smallexample
2923 In this case, @code{PRId64} is treated as a separate preprocessing token.
2925 Additionally, warn when a user-defined literal operator is declared with
2926 a literal suffix identifier that doesn't begin with an underscore. Literal
2927 suffix identifiers that don't begin with an underscore are reserved for
2928 future standardization.
2930 This warning is enabled by default.
2932 @item -Wlto-type-mismatch
2933 @opindex Wlto-type-mismatch
2934 @opindex Wno-lto-type-mismatch
2936 During the link-time optimization warn about type mismatches in
2937 global declarations from different compilation units.
2938 Requires @option{-flto} to be enabled.  Enabled by default.
2940 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2941 @opindex Wnarrowing
2942 @opindex Wno-narrowing
2943 For C++11 and later standards, narrowing conversions are diagnosed by default,
2944 as required by the standard.  A narrowing conversion from a constant produces
2945 an error, and a narrowing conversion from a non-constant produces a warning,
2946 but @option{-Wno-narrowing} suppresses the diagnostic.
2947 Note that this does not affect the meaning of well-formed code;
2948 narrowing conversions are still considered ill-formed in SFINAE contexts.
2950 With @option{-Wnarrowing} in C++98, warn when a narrowing
2951 conversion prohibited by C++11 occurs within
2952 @samp{@{ @}}, e.g.
2954 @smallexample
2955 int i = @{ 2.2 @}; // error: narrowing from double to int
2956 @end smallexample
2958 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2960 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2961 @opindex Wnoexcept
2962 @opindex Wno-noexcept
2963 Warn when a noexcept-expression evaluates to false because of a call
2964 to a function that does not have a non-throwing exception
2965 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2966 the compiler to never throw an exception.
2968 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2969 @opindex Wnoexcept-type
2970 @opindex Wno-noexcept-type
2971 Warn if the C++17 feature making @code{noexcept} part of a function
2972 type changes the mangled name of a symbol relative to C++14.  Enabled
2973 by @option{-Wabi} and @option{-Wc++17-compat}.
2975 As an example:
2977 @smallexample
2978 template <class T> void f(T t) @{ t(); @};
2979 void g() noexcept;
2980 void h() @{ f(g); @} 
2981 @end smallexample
2983 @noindent
2984 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2985 C++17 it calls @code{f<void(*)()noexcept>}.
2987 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2988 @opindex Wclass-memaccess
2989 Warn when the destination of a call to a raw memory function such as
2990 @code{memset} or @code{memcpy} is an object of class type, and when writing
2991 into such an object might bypass the class non-trivial or deleted constructor
2992 or copy assignment, violate const-correctness or encapsulation, or corrupt
2993 virtual table pointers.  Modifying the representation of such objects may
2994 violate invariants maintained by member functions of the class.  For example,
2995 the call to @code{memset} below is undefined because it modifies a non-trivial
2996 class object and is, therefore, diagnosed.  The safe way to either initialize
2997 or clear the storage of objects of such types is by using the appropriate
2998 constructor or assignment operator, if one is available.
2999 @smallexample
3000 std::string str = "abc";
3001 memset (&str, 0, sizeof str);
3002 @end smallexample
3003 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3004 Explicitly casting the pointer to the class object to @code{void *} or
3005 to a type that can be safely accessed by the raw memory function suppresses
3006 the warning.
3008 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3009 @opindex Wnon-virtual-dtor
3010 @opindex Wno-non-virtual-dtor
3011 Warn when a class has virtual functions and an accessible non-virtual
3012 destructor itself or in an accessible polymorphic base class, in which
3013 case it is possible but unsafe to delete an instance of a derived
3014 class through a pointer to the class itself or base class.  This
3015 warning is automatically enabled if @option{-Weffc++} is specified.
3017 @item -Wregister @r{(C++ and Objective-C++ only)}
3018 @opindex Wregister
3019 @opindex Wno-register
3020 Warn on uses of the @code{register} storage class specifier, except
3021 when it is part of the GNU @ref{Explicit Register Variables} extension.
3022 The use of the @code{register} keyword as storage class specifier has
3023 been deprecated in C++11 and removed in C++17.
3024 Enabled by default with @option{-std=c++17}.
3026 @item -Wreorder @r{(C++ and Objective-C++ only)}
3027 @opindex Wreorder
3028 @opindex Wno-reorder
3029 @cindex reordering, warning
3030 @cindex warning for reordering of member initializers
3031 Warn when the order of member initializers given in the code does not
3032 match the order in which they must be executed.  For instance:
3034 @smallexample
3035 struct A @{
3036   int i;
3037   int j;
3038   A(): j (0), i (1) @{ @}
3040 @end smallexample
3042 @noindent
3043 The compiler rearranges the member initializers for @code{i}
3044 and @code{j} to match the declaration order of the members, emitting
3045 a warning to that effect.  This warning is enabled by @option{-Wall}.
3047 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3048 @opindex fext-numeric-literals
3049 @opindex fno-ext-numeric-literals
3050 Accept imaginary, fixed-point, or machine-defined
3051 literal number suffixes as GNU extensions.
3052 When this option is turned off these suffixes are treated
3053 as C++11 user-defined literal numeric suffixes.
3054 This is on by default for all pre-C++11 dialects and all GNU dialects:
3055 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3056 @option{-std=gnu++14}.
3057 This option is off by default
3058 for ISO C++11 onwards (@option{-std=c++11}, ...).
3059 @end table
3061 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3063 @table @gcctabopt
3064 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3065 @opindex Weffc++
3066 @opindex Wno-effc++
3067 Warn about violations of the following style guidelines from Scott Meyers'
3068 @cite{Effective C++} series of books:
3070 @itemize @bullet
3071 @item
3072 Define a copy constructor and an assignment operator for classes
3073 with dynamically-allocated memory.
3075 @item
3076 Prefer initialization to assignment in constructors.
3078 @item
3079 Have @code{operator=} return a reference to @code{*this}.
3081 @item
3082 Don't try to return a reference when you must return an object.
3084 @item
3085 Distinguish between prefix and postfix forms of increment and
3086 decrement operators.
3088 @item
3089 Never overload @code{&&}, @code{||}, or @code{,}.
3091 @end itemize
3093 This option also enables @option{-Wnon-virtual-dtor}, which is also
3094 one of the effective C++ recommendations.  However, the check is
3095 extended to warn about the lack of virtual destructor in accessible
3096 non-polymorphic bases classes too.
3098 When selecting this option, be aware that the standard library
3099 headers do not obey all of these guidelines; use @samp{grep -v}
3100 to filter out those warnings.
3102 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3103 @opindex Wstrict-null-sentinel
3104 @opindex Wno-strict-null-sentinel
3105 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3106 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3107 to @code{__null}.  Although it is a null pointer constant rather than a
3108 null pointer, it is guaranteed to be of the same size as a pointer.
3109 But this use is not portable across different compilers.
3111 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3112 @opindex Wno-non-template-friend
3113 @opindex Wnon-template-friend
3114 Disable warnings when non-template friend functions are declared
3115 within a template.  In very old versions of GCC that predate implementation
3116 of the ISO standard, declarations such as 
3117 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3118 could be interpreted as a particular specialization of a template
3119 function; the warning exists to diagnose compatibility problems, 
3120 and is enabled by default.
3122 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3123 @opindex Wold-style-cast
3124 @opindex Wno-old-style-cast
3125 Warn if an old-style (C-style) cast to a non-void type is used within
3126 a C++ program.  The new-style casts (@code{dynamic_cast},
3127 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3128 less vulnerable to unintended effects and much easier to search for.
3130 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3131 @opindex Woverloaded-virtual
3132 @opindex Wno-overloaded-virtual
3133 @cindex overloaded virtual function, warning
3134 @cindex warning for overloaded virtual function
3135 Warn when a function declaration hides virtual functions from a
3136 base class.  For example, in:
3138 @smallexample
3139 struct A @{
3140   virtual void f();
3143 struct B: public A @{
3144   void f(int);
3146 @end smallexample
3148 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3149 like:
3151 @smallexample
3152 B* b;
3153 b->f();
3154 @end smallexample
3156 @noindent
3157 fails to compile.
3159 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3160 @opindex Wno-pmf-conversions
3161 @opindex Wpmf-conversions
3162 Disable the diagnostic for converting a bound pointer to member function
3163 to a plain pointer.
3165 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3166 @opindex Wsign-promo
3167 @opindex Wno-sign-promo
3168 Warn when overload resolution chooses a promotion from unsigned or
3169 enumerated type to a signed type, over a conversion to an unsigned type of
3170 the same size.  Previous versions of G++ tried to preserve
3171 unsignedness, but the standard mandates the current behavior.
3173 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3174 @opindex Wtemplates
3175 Warn when a primary template declaration is encountered.  Some coding
3176 rules disallow templates, and this may be used to enforce that rule.
3177 The warning is inactive inside a system header file, such as the STL, so
3178 one can still use the STL.  One may also instantiate or specialize
3179 templates.
3181 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3182 @opindex Wmultiple-inheritance
3183 Warn when a class is defined with multiple direct base classes.  Some
3184 coding rules disallow multiple inheritance, and this may be used to
3185 enforce that rule.  The warning is inactive inside a system header file,
3186 such as the STL, so one can still use the STL.  One may also define
3187 classes that indirectly use multiple inheritance.
3189 @item -Wvirtual-inheritance
3190 @opindex Wvirtual-inheritance
3191 Warn when a class is defined with a virtual direct base class.  Some
3192 coding rules disallow multiple inheritance, and this may be used to
3193 enforce that rule.  The warning is inactive inside a system header file,
3194 such as the STL, so one can still use the STL.  One may also define
3195 classes that indirectly use virtual inheritance.
3197 @item -Wnamespaces
3198 @opindex Wnamespaces
3199 Warn when a namespace definition is opened.  Some coding rules disallow
3200 namespaces, and this may be used to enforce that rule.  The warning is
3201 inactive inside a system header file, such as the STL, so one can still
3202 use the STL.  One may also use using directives and qualified names.
3204 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3205 @opindex Wterminate
3206 @opindex Wno-terminate
3207 Disable the warning about a throw-expression that will immediately
3208 result in a call to @code{terminate}.
3209 @end table
3211 @node Objective-C and Objective-C++ Dialect Options
3212 @section Options Controlling Objective-C and Objective-C++ Dialects
3214 @cindex compiler options, Objective-C and Objective-C++
3215 @cindex Objective-C and Objective-C++ options, command-line
3216 @cindex options, Objective-C and Objective-C++
3217 (NOTE: This manual does not describe the Objective-C and Objective-C++
3218 languages themselves.  @xref{Standards,,Language Standards
3219 Supported by GCC}, for references.)
3221 This section describes the command-line options that are only meaningful
3222 for Objective-C and Objective-C++ programs.  You can also use most of
3223 the language-independent GNU compiler options.
3224 For example, you might compile a file @file{some_class.m} like this:
3226 @smallexample
3227 gcc -g -fgnu-runtime -O -c some_class.m
3228 @end smallexample
3230 @noindent
3231 In this example, @option{-fgnu-runtime} is an option meant only for
3232 Objective-C and Objective-C++ programs; you can use the other options with
3233 any language supported by GCC@.
3235 Note that since Objective-C is an extension of the C language, Objective-C
3236 compilations may also use options specific to the C front-end (e.g.,
3237 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3238 C++-specific options (e.g., @option{-Wabi}).
3240 Here is a list of options that are @emph{only} for compiling Objective-C
3241 and Objective-C++ programs:
3243 @table @gcctabopt
3244 @item -fconstant-string-class=@var{class-name}
3245 @opindex fconstant-string-class
3246 Use @var{class-name} as the name of the class to instantiate for each
3247 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3248 class name is @code{NXConstantString} if the GNU runtime is being used, and
3249 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3250 @option{-fconstant-cfstrings} option, if also present, overrides the
3251 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3252 to be laid out as constant CoreFoundation strings.
3254 @item -fgnu-runtime
3255 @opindex fgnu-runtime
3256 Generate object code compatible with the standard GNU Objective-C
3257 runtime.  This is the default for most types of systems.
3259 @item -fnext-runtime
3260 @opindex fnext-runtime
3261 Generate output compatible with the NeXT runtime.  This is the default
3262 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3263 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3264 used.
3266 @item -fno-nil-receivers
3267 @opindex fno-nil-receivers
3268 Assume that all Objective-C message dispatches (@code{[receiver
3269 message:arg]}) in this translation unit ensure that the receiver is
3270 not @code{nil}.  This allows for more efficient entry points in the
3271 runtime to be used.  This option is only available in conjunction with
3272 the NeXT runtime and ABI version 0 or 1.
3274 @item -fobjc-abi-version=@var{n}
3275 @opindex fobjc-abi-version
3276 Use version @var{n} of the Objective-C ABI for the selected runtime.
3277 This option is currently supported only for the NeXT runtime.  In that
3278 case, Version 0 is the traditional (32-bit) ABI without support for
3279 properties and other Objective-C 2.0 additions.  Version 1 is the
3280 traditional (32-bit) ABI with support for properties and other
3281 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3282 nothing is specified, the default is Version 0 on 32-bit target
3283 machines, and Version 2 on 64-bit target machines.
3285 @item -fobjc-call-cxx-cdtors
3286 @opindex fobjc-call-cxx-cdtors
3287 For each Objective-C class, check if any of its instance variables is a
3288 C++ object with a non-trivial default constructor.  If so, synthesize a
3289 special @code{- (id) .cxx_construct} instance method which runs
3290 non-trivial default constructors on any such instance variables, in order,
3291 and then return @code{self}.  Similarly, check if any instance variable
3292 is a C++ object with a non-trivial destructor, and if so, synthesize a
3293 special @code{- (void) .cxx_destruct} method which runs
3294 all such default destructors, in reverse order.
3296 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3297 methods thusly generated only operate on instance variables
3298 declared in the current Objective-C class, and not those inherited
3299 from superclasses.  It is the responsibility of the Objective-C
3300 runtime to invoke all such methods in an object's inheritance
3301 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3302 by the runtime immediately after a new object instance is allocated;
3303 the @code{- (void) .cxx_destruct} methods are invoked immediately
3304 before the runtime deallocates an object instance.
3306 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3307 support for invoking the @code{- (id) .cxx_construct} and
3308 @code{- (void) .cxx_destruct} methods.
3310 @item -fobjc-direct-dispatch
3311 @opindex fobjc-direct-dispatch
3312 Allow fast jumps to the message dispatcher.  On Darwin this is
3313 accomplished via the comm page.
3315 @item -fobjc-exceptions
3316 @opindex fobjc-exceptions
3317 Enable syntactic support for structured exception handling in
3318 Objective-C, similar to what is offered by C++.  This option
3319 is required to use the Objective-C keywords @code{@@try},
3320 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3321 @code{@@synchronized}.  This option is available with both the GNU
3322 runtime and the NeXT runtime (but not available in conjunction with
3323 the NeXT runtime on Mac OS X 10.2 and earlier).
3325 @item -fobjc-gc
3326 @opindex fobjc-gc
3327 Enable garbage collection (GC) in Objective-C and Objective-C++
3328 programs.  This option is only available with the NeXT runtime; the
3329 GNU runtime has a different garbage collection implementation that
3330 does not require special compiler flags.
3332 @item -fobjc-nilcheck
3333 @opindex fobjc-nilcheck
3334 For the NeXT runtime with version 2 of the ABI, check for a nil
3335 receiver in method invocations before doing the actual method call.
3336 This is the default and can be disabled using
3337 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3338 checked for nil in this way no matter what this flag is set to.
3339 Currently this flag does nothing when the GNU runtime, or an older
3340 version of the NeXT runtime ABI, is used.
3342 @item -fobjc-std=objc1
3343 @opindex fobjc-std
3344 Conform to the language syntax of Objective-C 1.0, the language
3345 recognized by GCC 4.0.  This only affects the Objective-C additions to
3346 the C/C++ language; it does not affect conformance to C/C++ standards,
3347 which is controlled by the separate C/C++ dialect option flags.  When
3348 this option is used with the Objective-C or Objective-C++ compiler,
3349 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3350 This is useful if you need to make sure that your Objective-C code can
3351 be compiled with older versions of GCC@.
3353 @item -freplace-objc-classes
3354 @opindex freplace-objc-classes
3355 Emit a special marker instructing @command{ld(1)} not to statically link in
3356 the resulting object file, and allow @command{dyld(1)} to load it in at
3357 run time instead.  This is used in conjunction with the Fix-and-Continue
3358 debugging mode, where the object file in question may be recompiled and
3359 dynamically reloaded in the course of program execution, without the need
3360 to restart the program itself.  Currently, Fix-and-Continue functionality
3361 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3362 and later.
3364 @item -fzero-link
3365 @opindex fzero-link
3366 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3367 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3368 compile time) with static class references that get initialized at load time,
3369 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3370 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3371 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3372 for individual class implementations to be modified during program execution.
3373 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3374 regardless of command-line options.
3376 @item -fno-local-ivars
3377 @opindex fno-local-ivars
3378 @opindex flocal-ivars
3379 By default instance variables in Objective-C can be accessed as if
3380 they were local variables from within the methods of the class they're
3381 declared in.  This can lead to shadowing between instance variables
3382 and other variables declared either locally inside a class method or
3383 globally with the same name.  Specifying the @option{-fno-local-ivars}
3384 flag disables this behavior thus avoiding variable shadowing issues.
3386 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3387 @opindex fivar-visibility
3388 Set the default instance variable visibility to the specified option
3389 so that instance variables declared outside the scope of any access
3390 modifier directives default to the specified visibility.
3392 @item -gen-decls
3393 @opindex gen-decls
3394 Dump interface declarations for all classes seen in the source file to a
3395 file named @file{@var{sourcename}.decl}.
3397 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3398 @opindex Wassign-intercept
3399 @opindex Wno-assign-intercept
3400 Warn whenever an Objective-C assignment is being intercepted by the
3401 garbage collector.
3403 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3404 @opindex Wno-protocol
3405 @opindex Wprotocol
3406 If a class is declared to implement a protocol, a warning is issued for
3407 every method in the protocol that is not implemented by the class.  The
3408 default behavior is to issue a warning for every method not explicitly
3409 implemented in the class, even if a method implementation is inherited
3410 from the superclass.  If you use the @option{-Wno-protocol} option, then
3411 methods inherited from the superclass are considered to be implemented,
3412 and no warning is issued for them.
3414 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3415 @opindex Wselector
3416 @opindex Wno-selector
3417 Warn if multiple methods of different types for the same selector are
3418 found during compilation.  The check is performed on the list of methods
3419 in the final stage of compilation.  Additionally, a check is performed
3420 for each selector appearing in a @code{@@selector(@dots{})}
3421 expression, and a corresponding method for that selector has been found
3422 during compilation.  Because these checks scan the method table only at
3423 the end of compilation, these warnings are not produced if the final
3424 stage of compilation is not reached, for example because an error is
3425 found during compilation, or because the @option{-fsyntax-only} option is
3426 being used.
3428 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3429 @opindex Wstrict-selector-match
3430 @opindex Wno-strict-selector-match
3431 Warn if multiple methods with differing argument and/or return types are
3432 found for a given selector when attempting to send a message using this
3433 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3434 is off (which is the default behavior), the compiler omits such warnings
3435 if any differences found are confined to types that share the same size
3436 and alignment.
3438 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3439 @opindex Wundeclared-selector
3440 @opindex Wno-undeclared-selector
3441 Warn if a @code{@@selector(@dots{})} expression referring to an
3442 undeclared selector is found.  A selector is considered undeclared if no
3443 method with that name has been declared before the
3444 @code{@@selector(@dots{})} expression, either explicitly in an
3445 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3446 an @code{@@implementation} section.  This option always performs its
3447 checks as soon as a @code{@@selector(@dots{})} expression is found,
3448 while @option{-Wselector} only performs its checks in the final stage of
3449 compilation.  This also enforces the coding style convention
3450 that methods and selectors must be declared before being used.
3452 @item -print-objc-runtime-info
3453 @opindex print-objc-runtime-info
3454 Generate C header describing the largest structure that is passed by
3455 value, if any.
3457 @end table
3459 @node Diagnostic Message Formatting Options
3460 @section Options to Control Diagnostic Messages Formatting
3461 @cindex options to control diagnostics formatting
3462 @cindex diagnostic messages
3463 @cindex message formatting
3465 Traditionally, diagnostic messages have been formatted irrespective of
3466 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3467 options described below
3468 to control the formatting algorithm for diagnostic messages, 
3469 e.g.@: how many characters per line, how often source location
3470 information should be reported.  Note that some language front ends may not
3471 honor these options.
3473 @table @gcctabopt
3474 @item -fmessage-length=@var{n}
3475 @opindex fmessage-length
3476 Try to format error messages so that they fit on lines of about
3477 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3478 done; each error message appears on a single line.  This is the
3479 default for all front ends.
3481 @item -fdiagnostics-show-location=once
3482 @opindex fdiagnostics-show-location
3483 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3484 reporter to emit source location information @emph{once}; that is, in
3485 case the message is too long to fit on a single physical line and has to
3486 be wrapped, the source location won't be emitted (as prefix) again,
3487 over and over, in subsequent continuation lines.  This is the default
3488 behavior.
3490 @item -fdiagnostics-show-location=every-line
3491 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3492 messages reporter to emit the same source location information (as
3493 prefix) for physical lines that result from the process of breaking
3494 a message which is too long to fit on a single line.
3496 @item -fdiagnostics-color[=@var{WHEN}]
3497 @itemx -fno-diagnostics-color
3498 @opindex fdiagnostics-color
3499 @cindex highlight, color
3500 @vindex GCC_COLORS @r{environment variable}
3501 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3502 or @samp{auto}.  The default depends on how the compiler has been configured,
3503 it can be any of the above @var{WHEN} options or also @samp{never}
3504 if @env{GCC_COLORS} environment variable isn't present in the environment,
3505 and @samp{auto} otherwise.
3506 @samp{auto} means to use color only when the standard error is a terminal.
3507 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3508 aliases for @option{-fdiagnostics-color=always} and
3509 @option{-fdiagnostics-color=never}, respectively.
3511 The colors are defined by the environment variable @env{GCC_COLORS}.
3512 Its value is a colon-separated list of capabilities and Select Graphic
3513 Rendition (SGR) substrings. SGR commands are interpreted by the
3514 terminal or terminal emulator.  (See the section in the documentation
3515 of your text terminal for permitted values and their meanings as
3516 character attributes.)  These substring values are integers in decimal
3517 representation and can be concatenated with semicolons.
3518 Common values to concatenate include
3519 @samp{1} for bold,
3520 @samp{4} for underline,
3521 @samp{5} for blink,
3522 @samp{7} for inverse,
3523 @samp{39} for default foreground color,
3524 @samp{30} to @samp{37} for foreground colors,
3525 @samp{90} to @samp{97} for 16-color mode foreground colors,
3526 @samp{38;5;0} to @samp{38;5;255}
3527 for 88-color and 256-color modes foreground colors,
3528 @samp{49} for default background color,
3529 @samp{40} to @samp{47} for background colors,
3530 @samp{100} to @samp{107} for 16-color mode background colors,
3531 and @samp{48;5;0} to @samp{48;5;255}
3532 for 88-color and 256-color modes background colors.
3534 The default @env{GCC_COLORS} is
3535 @smallexample
3536 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3537 quote=01:fixit-insert=32:fixit-delete=31:\
3538 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3539 type-diff=01;32
3540 @end smallexample
3541 @noindent
3542 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3543 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3544 @samp{01} is bold, and @samp{31} is red.
3545 Setting @env{GCC_COLORS} to the empty string disables colors.
3546 Supported capabilities are as follows.
3548 @table @code
3549 @item error=
3550 @vindex error GCC_COLORS @r{capability}
3551 SGR substring for error: markers.
3553 @item warning=
3554 @vindex warning GCC_COLORS @r{capability}
3555 SGR substring for warning: markers.
3557 @item note=
3558 @vindex note GCC_COLORS @r{capability}
3559 SGR substring for note: markers.
3561 @item range1=
3562 @vindex range1 GCC_COLORS @r{capability}
3563 SGR substring for first additional range.
3565 @item range2=
3566 @vindex range2 GCC_COLORS @r{capability}
3567 SGR substring for second additional range.
3569 @item locus=
3570 @vindex locus GCC_COLORS @r{capability}
3571 SGR substring for location information, @samp{file:line} or
3572 @samp{file:line:column} etc.
3574 @item quote=
3575 @vindex quote GCC_COLORS @r{capability}
3576 SGR substring for information printed within quotes.
3578 @item fixit-insert=
3579 @vindex fixit-insert GCC_COLORS @r{capability}
3580 SGR substring for fix-it hints suggesting text to
3581 be inserted or replaced.
3583 @item fixit-delete=
3584 @vindex fixit-delete GCC_COLORS @r{capability}
3585 SGR substring for fix-it hints suggesting text to
3586 be deleted.
3588 @item diff-filename=
3589 @vindex diff-filename GCC_COLORS @r{capability}
3590 SGR substring for filename headers within generated patches.
3592 @item diff-hunk=
3593 @vindex diff-hunk GCC_COLORS @r{capability}
3594 SGR substring for the starts of hunks within generated patches.
3596 @item diff-delete=
3597 @vindex diff-delete GCC_COLORS @r{capability}
3598 SGR substring for deleted lines within generated patches.
3600 @item diff-insert=
3601 @vindex diff-insert GCC_COLORS @r{capability}
3602 SGR substring for inserted lines within generated patches.
3604 @item type-diff=
3605 @vindex type-diff GCC_COLORS @r{capability}
3606 SGR substring for highlighting mismatching types within template
3607 arguments in the C++ frontend.
3608 @end table
3610 @item -fno-diagnostics-show-option
3611 @opindex fno-diagnostics-show-option
3612 @opindex fdiagnostics-show-option
3613 By default, each diagnostic emitted includes text indicating the
3614 command-line option that directly controls the diagnostic (if such an
3615 option is known to the diagnostic machinery).  Specifying the
3616 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3618 @item -fno-diagnostics-show-caret
3619 @opindex fno-diagnostics-show-caret
3620 @opindex fdiagnostics-show-caret
3621 By default, each diagnostic emitted includes the original source line
3622 and a caret @samp{^} indicating the column.  This option suppresses this
3623 information.  The source line is truncated to @var{n} characters, if
3624 the @option{-fmessage-length=n} option is given.  When the output is done
3625 to the terminal, the width is limited to the width given by the
3626 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3628 @item -fdiagnostics-parseable-fixits
3629 @opindex fdiagnostics-parseable-fixits
3630 Emit fix-it hints in a machine-parseable format, suitable for consumption
3631 by IDEs.  For each fix-it, a line will be printed after the relevant
3632 diagnostic, starting with the string ``fix-it:''.  For example:
3634 @smallexample
3635 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3636 @end smallexample
3638 The location is expressed as a half-open range, expressed as a count of
3639 bytes, starting at byte 1 for the initial column.  In the above example,
3640 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3641 given string:
3643 @smallexample
3644 00000000011111111112222222222
3645 12345678901234567890123456789
3646   gtk_widget_showall (dlg);
3647   ^^^^^^^^^^^^^^^^^^
3648   gtk_widget_show_all
3649 @end smallexample
3651 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3652 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3653 (e.g. vertical tab as ``\013'').
3655 An empty replacement string indicates that the given range is to be removed.
3656 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3657 be inserted at the given position.
3659 @item -fdiagnostics-generate-patch
3660 @opindex fdiagnostics-generate-patch
3661 Print fix-it hints to stderr in unified diff format, after any diagnostics
3662 are printed.  For example:
3664 @smallexample
3665 --- test.c
3666 +++ test.c
3667 @@ -42,5 +42,5 @@
3669  void show_cb(GtkDialog *dlg)
3670  @{
3671 -  gtk_widget_showall(dlg);
3672 +  gtk_widget_show_all(dlg);
3673  @}
3675 @end smallexample
3677 The diff may or may not be colorized, following the same rules
3678 as for diagnostics (see @option{-fdiagnostics-color}).
3680 @item -fdiagnostics-show-template-tree
3681 @opindex fdiagnostics-show-template-tree
3683 In the C++ frontend, when printing diagnostics showing mismatching
3684 template types, such as:
3686 @smallexample
3687   could not convert 'std::map<int, std::vector<double> >()'
3688     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3689 @end smallexample
3691 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3692 tree-like structure showing the common and differing parts of the types,
3693 such as:
3695 @smallexample
3696   map<
3697     [...],
3698     vector<
3699       [double != float]>>
3700 @end smallexample
3702 The parts that differ are highlighted with color (``double'' and
3703 ``float'' in this case).
3705 @item -fno-elide-type
3706 @opindex fno-elide-type
3707 @opindex felide-type
3708 By default when the C++ frontend prints diagnostics showing mismatching
3709 template types, common parts of the types are printed as ``[...]'' to
3710 simplify the error message.  For example:
3712 @smallexample
3713   could not convert 'std::map<int, std::vector<double> >()'
3714     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3715 @end smallexample
3717 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3718 This flag also affects the output of the
3719 @option{-fdiagnostics-show-template-tree} flag.
3721 @item -fno-show-column
3722 @opindex fno-show-column
3723 Do not print column numbers in diagnostics.  This may be necessary if
3724 diagnostics are being scanned by a program that does not understand the
3725 column numbers, such as @command{dejagnu}.
3727 @end table
3729 @node Warning Options
3730 @section Options to Request or Suppress Warnings
3731 @cindex options to control warnings
3732 @cindex warning messages
3733 @cindex messages, warning
3734 @cindex suppressing warnings
3736 Warnings are diagnostic messages that report constructions that
3737 are not inherently erroneous but that are risky or suggest there
3738 may have been an error.
3740 The following language-independent options do not enable specific
3741 warnings but control the kinds of diagnostics produced by GCC@.
3743 @table @gcctabopt
3744 @cindex syntax checking
3745 @item -fsyntax-only
3746 @opindex fsyntax-only
3747 Check the code for syntax errors, but don't do anything beyond that.
3749 @item -fmax-errors=@var{n}
3750 @opindex fmax-errors
3751 Limits the maximum number of error messages to @var{n}, at which point
3752 GCC bails out rather than attempting to continue processing the source
3753 code.  If @var{n} is 0 (the default), there is no limit on the number
3754 of error messages produced.  If @option{-Wfatal-errors} is also
3755 specified, then @option{-Wfatal-errors} takes precedence over this
3756 option.
3758 @item -w
3759 @opindex w
3760 Inhibit all warning messages.
3762 @item -Werror
3763 @opindex Werror
3764 @opindex Wno-error
3765 Make all warnings into errors.
3767 @item -Werror=
3768 @opindex Werror=
3769 @opindex Wno-error=
3770 Make the specified warning into an error.  The specifier for a warning
3771 is appended; for example @option{-Werror=switch} turns the warnings
3772 controlled by @option{-Wswitch} into errors.  This switch takes a
3773 negative form, to be used to negate @option{-Werror} for specific
3774 warnings; for example @option{-Wno-error=switch} makes
3775 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3776 is in effect.
3778 The warning message for each controllable warning includes the
3779 option that controls the warning.  That option can then be used with
3780 @option{-Werror=} and @option{-Wno-error=} as described above.
3781 (Printing of the option in the warning message can be disabled using the
3782 @option{-fno-diagnostics-show-option} flag.)
3784 Note that specifying @option{-Werror=}@var{foo} automatically implies
3785 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3786 imply anything.
3788 @item -Wfatal-errors
3789 @opindex Wfatal-errors
3790 @opindex Wno-fatal-errors
3791 This option causes the compiler to abort compilation on the first error
3792 occurred rather than trying to keep going and printing further error
3793 messages.
3795 @end table
3797 You can request many specific warnings with options beginning with
3798 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3799 implicit declarations.  Each of these specific warning options also
3800 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3801 example, @option{-Wno-implicit}.  This manual lists only one of the
3802 two forms, whichever is not the default.  For further
3803 language-specific options also refer to @ref{C++ Dialect Options} and
3804 @ref{Objective-C and Objective-C++ Dialect Options}.
3806 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3807 options, such as @option{-Wunused}, which may turn on further options,
3808 such as @option{-Wunused-value}. The combined effect of positive and
3809 negative forms is that more specific options have priority over less
3810 specific ones, independently of their position in the command-line. For
3811 options of the same specificity, the last one takes effect. Options
3812 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3813 as if they appeared at the end of the command-line.
3815 When an unrecognized warning option is requested (e.g.,
3816 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3817 that the option is not recognized.  However, if the @option{-Wno-} form
3818 is used, the behavior is slightly different: no diagnostic is
3819 produced for @option{-Wno-unknown-warning} unless other diagnostics
3820 are being produced.  This allows the use of new @option{-Wno-} options
3821 with old compilers, but if something goes wrong, the compiler
3822 warns that an unrecognized option is present.
3824 @table @gcctabopt
3825 @item -Wpedantic
3826 @itemx -pedantic
3827 @opindex pedantic
3828 @opindex Wpedantic
3829 Issue all the warnings demanded by strict ISO C and ISO C++;
3830 reject all programs that use forbidden extensions, and some other
3831 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3832 version of the ISO C standard specified by any @option{-std} option used.
3834 Valid ISO C and ISO C++ programs should compile properly with or without
3835 this option (though a rare few require @option{-ansi} or a
3836 @option{-std} option specifying the required version of ISO C)@.  However,
3837 without this option, certain GNU extensions and traditional C and C++
3838 features are supported as well.  With this option, they are rejected.
3840 @option{-Wpedantic} does not cause warning messages for use of the
3841 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3842 warnings are also disabled in the expression that follows
3843 @code{__extension__}.  However, only system header files should use
3844 these escape routes; application programs should avoid them.
3845 @xref{Alternate Keywords}.
3847 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3848 C conformance.  They soon find that it does not do quite what they want:
3849 it finds some non-ISO practices, but not all---only those for which
3850 ISO C @emph{requires} a diagnostic, and some others for which
3851 diagnostics have been added.
3853 A feature to report any failure to conform to ISO C might be useful in
3854 some instances, but would require considerable additional work and would
3855 be quite different from @option{-Wpedantic}.  We don't have plans to
3856 support such a feature in the near future.
3858 Where the standard specified with @option{-std} represents a GNU
3859 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3860 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3861 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3862 where they are required by the base standard.  (It does not make sense
3863 for such warnings to be given only for features not in the specified GNU
3864 C dialect, since by definition the GNU dialects of C include all
3865 features the compiler supports with the given option, and there would be
3866 nothing to warn about.)
3868 @item -pedantic-errors
3869 @opindex pedantic-errors
3870 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3871 requires a diagnostic, in some cases where there is undefined behavior
3872 at compile-time and in some other cases that do not prevent compilation
3873 of programs that are valid according to the standard. This is not
3874 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3875 by this option and not enabled by the latter and vice versa.
3877 @item -Wall
3878 @opindex Wall
3879 @opindex Wno-all
3880 This enables all the warnings about constructions that some users
3881 consider questionable, and that are easy to avoid (or modify to
3882 prevent the warning), even in conjunction with macros.  This also
3883 enables some language-specific warnings described in @ref{C++ Dialect
3884 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3886 @option{-Wall} turns on the following warning flags:
3888 @gccoptlist{-Waddress   @gol
3889 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3890 -Wbool-compare  @gol
3891 -Wbool-operation  @gol
3892 -Wc++11-compat  -Wc++14-compat  @gol
3893 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3894 -Wchar-subscripts  @gol
3895 -Wcomment  @gol
3896 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3897 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3898 -Wformat   @gol
3899 -Wint-in-bool-context  @gol
3900 -Wimplicit @r{(C and Objective-C only)} @gol
3901 -Wimplicit-int @r{(C and Objective-C only)} @gol
3902 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3903 -Winit-self @r{(only for C++)} @gol
3904 -Wlogical-not-parentheses @gol
3905 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3906 -Wmaybe-uninitialized @gol
3907 -Wmemset-elt-size @gol
3908 -Wmemset-transposed-args @gol
3909 -Wmisleading-indentation @r{(only for C/C++)} @gol
3910 -Wmissing-attributes @gol
3911 -Wmissing-braces @r{(only for C/ObjC)} @gol
3912 -Wmultistatement-macros  @gol
3913 -Wnarrowing @r{(only for C++)}  @gol
3914 -Wnonnull  @gol
3915 -Wnonnull-compare  @gol
3916 -Wopenmp-simd @gol
3917 -Wparentheses  @gol
3918 -Wpointer-sign  @gol
3919 -Wreorder   @gol
3920 -Wrestrict   @gol
3921 -Wreturn-type  @gol
3922 -Wsequence-point  @gol
3923 -Wsign-compare @r{(only in C++)}  @gol
3924 -Wsizeof-pointer-div @gol
3925 -Wsizeof-pointer-memaccess @gol
3926 -Wstrict-aliasing  @gol
3927 -Wstrict-overflow=1  @gol
3928 -Wswitch  @gol
3929 -Wtautological-compare  @gol
3930 -Wtrigraphs  @gol
3931 -Wuninitialized  @gol
3932 -Wunknown-pragmas  @gol
3933 -Wunused-function  @gol
3934 -Wunused-label     @gol
3935 -Wunused-value     @gol
3936 -Wunused-variable  @gol
3937 -Wvolatile-register-var @gol
3940 Note that some warning flags are not implied by @option{-Wall}.  Some of
3941 them warn about constructions that users generally do not consider
3942 questionable, but which occasionally you might wish to check for;
3943 others warn about constructions that are necessary or hard to avoid in
3944 some cases, and there is no simple way to modify the code to suppress
3945 the warning. Some of them are enabled by @option{-Wextra} but many of
3946 them must be enabled individually.
3948 @item -Wextra
3949 @opindex W
3950 @opindex Wextra
3951 @opindex Wno-extra
3952 This enables some extra warning flags that are not enabled by
3953 @option{-Wall}. (This option used to be called @option{-W}.  The older
3954 name is still supported, but the newer name is more descriptive.)
3956 @gccoptlist{-Wclobbered  @gol
3957 -Wcast-function-type  @gol
3958 -Wempty-body  @gol
3959 -Wignored-qualifiers @gol
3960 -Wimplicit-fallthrough=3 @gol
3961 -Wmissing-field-initializers  @gol
3962 -Wmissing-parameter-type @r{(C only)}  @gol
3963 -Wold-style-declaration @r{(C only)}  @gol
3964 -Woverride-init  @gol
3965 -Wsign-compare @r{(C only)} @gol
3966 -Wtype-limits  @gol
3967 -Wuninitialized  @gol
3968 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3969 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3970 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3973 The option @option{-Wextra} also prints warning messages for the
3974 following cases:
3976 @itemize @bullet
3978 @item
3979 A pointer is compared against integer zero with @code{<}, @code{<=},
3980 @code{>}, or @code{>=}.
3982 @item
3983 (C++ only) An enumerator and a non-enumerator both appear in a
3984 conditional expression.
3986 @item
3987 (C++ only) Ambiguous virtual bases.
3989 @item
3990 (C++ only) Subscripting an array that has been declared @code{register}.
3992 @item
3993 (C++ only) Taking the address of a variable that has been declared
3994 @code{register}.
3996 @item
3997 (C++ only) A base class is not initialized in the copy constructor
3998 of a derived class.
4000 @end itemize
4002 @item -Wchar-subscripts
4003 @opindex Wchar-subscripts
4004 @opindex Wno-char-subscripts
4005 Warn if an array subscript has type @code{char}.  This is a common cause
4006 of error, as programmers often forget that this type is signed on some
4007 machines.
4008 This warning is enabled by @option{-Wall}.
4010 @item -Wchkp
4011 @opindex Wchkp
4012 Warn about an invalid memory access that is found by Pointer Bounds Checker
4013 (@option{-fcheck-pointer-bounds}).
4015 @item -Wno-coverage-mismatch
4016 @opindex Wno-coverage-mismatch
4017 Warn if feedback profiles do not match when using the
4018 @option{-fprofile-use} option.
4019 If a source file is changed between compiling with @option{-fprofile-gen} and
4020 with @option{-fprofile-use}, the files with the profile feedback can fail
4021 to match the source file and GCC cannot use the profile feedback
4022 information.  By default, this warning is enabled and is treated as an
4023 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4024 warning or @option{-Wno-error=coverage-mismatch} can be used to
4025 disable the error.  Disabling the error for this warning can result in
4026 poorly optimized code and is useful only in the
4027 case of very minor changes such as bug fixes to an existing code-base.
4028 Completely disabling the warning is not recommended.
4030 @item -Wno-cpp
4031 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4033 Suppress warning messages emitted by @code{#warning} directives.
4035 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4036 @opindex Wdouble-promotion
4037 @opindex Wno-double-promotion
4038 Give a warning when a value of type @code{float} is implicitly
4039 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4040 floating-point unit implement @code{float} in hardware, but emulate
4041 @code{double} in software.  On such a machine, doing computations
4042 using @code{double} values is much more expensive because of the
4043 overhead required for software emulation.
4045 It is easy to accidentally do computations with @code{double} because
4046 floating-point literals are implicitly of type @code{double}.  For
4047 example, in:
4048 @smallexample
4049 @group
4050 float area(float radius)
4052    return 3.14159 * radius * radius;
4054 @end group
4055 @end smallexample
4056 the compiler performs the entire computation with @code{double}
4057 because the floating-point literal is a @code{double}.
4059 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4060 @opindex Wduplicate-decl-specifier
4061 @opindex Wno-duplicate-decl-specifier
4062 Warn if a declaration has duplicate @code{const}, @code{volatile},
4063 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4064 @option{-Wall}.
4066 @item -Wformat
4067 @itemx -Wformat=@var{n}
4068 @opindex Wformat
4069 @opindex Wno-format
4070 @opindex ffreestanding
4071 @opindex fno-builtin
4072 @opindex Wformat=
4073 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4074 the arguments supplied have types appropriate to the format string
4075 specified, and that the conversions specified in the format string make
4076 sense.  This includes standard functions, and others specified by format
4077 attributes (@pxref{Function Attributes}), in the @code{printf},
4078 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4079 not in the C standard) families (or other target-specific families).
4080 Which functions are checked without format attributes having been
4081 specified depends on the standard version selected, and such checks of
4082 functions without the attribute specified are disabled by
4083 @option{-ffreestanding} or @option{-fno-builtin}.
4085 The formats are checked against the format features supported by GNU
4086 libc version 2.2.  These include all ISO C90 and C99 features, as well
4087 as features from the Single Unix Specification and some BSD and GNU
4088 extensions.  Other library implementations may not support all these
4089 features; GCC does not support warning about features that go beyond a
4090 particular library's limitations.  However, if @option{-Wpedantic} is used
4091 with @option{-Wformat}, warnings are given about format features not
4092 in the selected standard version (but not for @code{strfmon} formats,
4093 since those are not in any version of the C standard).  @xref{C Dialect
4094 Options,,Options Controlling C Dialect}.
4096 @table @gcctabopt
4097 @item -Wformat=1
4098 @itemx -Wformat
4099 @opindex Wformat
4100 @opindex Wformat=1
4101 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4102 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4103 @option{-Wformat} also checks for null format arguments for several
4104 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4105 aspects of this level of format checking can be disabled by the
4106 options: @option{-Wno-format-contains-nul},
4107 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4108 @option{-Wformat} is enabled by @option{-Wall}.
4110 @item -Wno-format-contains-nul
4111 @opindex Wno-format-contains-nul
4112 @opindex Wformat-contains-nul
4113 If @option{-Wformat} is specified, do not warn about format strings that
4114 contain NUL bytes.
4116 @item -Wno-format-extra-args
4117 @opindex Wno-format-extra-args
4118 @opindex Wformat-extra-args
4119 If @option{-Wformat} is specified, do not warn about excess arguments to a
4120 @code{printf} or @code{scanf} format function.  The C standard specifies
4121 that such arguments are ignored.
4123 Where the unused arguments lie between used arguments that are
4124 specified with @samp{$} operand number specifications, normally
4125 warnings are still given, since the implementation could not know what
4126 type to pass to @code{va_arg} to skip the unused arguments.  However,
4127 in the case of @code{scanf} formats, this option suppresses the
4128 warning if the unused arguments are all pointers, since the Single
4129 Unix Specification says that such unused arguments are allowed.
4131 @item -Wformat-overflow
4132 @itemx -Wformat-overflow=@var{level}
4133 @opindex Wformat-overflow
4134 @opindex Wno-format-overflow
4135 Warn about calls to formatted input/output functions such as @code{sprintf}
4136 and @code{vsprintf} that might overflow the destination buffer.  When the
4137 exact number of bytes written by a format directive cannot be determined
4138 at compile-time it is estimated based on heuristics that depend on the
4139 @var{level} argument and on optimization.  While enabling optimization
4140 will in most cases improve the accuracy of the warning, it may also
4141 result in false positives.
4143 @table @gcctabopt
4144 @item -Wformat-overflow
4145 @itemx -Wformat-overflow=1
4146 @opindex Wformat-overflow
4147 @opindex Wno-format-overflow
4148 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4149 employs a conservative approach that warns only about calls that most
4150 likely overflow the buffer.  At this level, numeric arguments to format
4151 directives with unknown values are assumed to have the value of one, and
4152 strings of unknown length to be empty.  Numeric arguments that are known
4153 to be bounded to a subrange of their type, or string arguments whose output
4154 is bounded either by their directive's precision or by a finite set of
4155 string literals, are assumed to take on the value within the range that
4156 results in the most bytes on output.  For example, the call to @code{sprintf}
4157 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4158 the terminating NUL character (@code{'\0'}) appended by the function
4159 to the destination buffer will be written past its end.  Increasing
4160 the size of the buffer by a single byte is sufficient to avoid the
4161 warning, though it may not be sufficient to avoid the overflow.
4163 @smallexample
4164 void f (int a, int b)
4166   char buf [13];
4167   sprintf (buf, "a = %i, b = %i\n", a, b);
4169 @end smallexample
4171 @item -Wformat-overflow=2
4172 Level @var{2} warns also about calls that might overflow the destination
4173 buffer given an argument of sufficient length or magnitude.  At level
4174 @var{2}, unknown numeric arguments are assumed to have the minimum
4175 representable value for signed types with a precision greater than 1, and
4176 the maximum representable value otherwise.  Unknown string arguments whose
4177 length cannot be assumed to be bounded either by the directive's precision,
4178 or by a finite set of string literals they may evaluate to, or the character
4179 array they may point to, are assumed to be 1 character long.
4181 At level @var{2}, the call in the example above is again diagnosed, but
4182 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4183 @code{%i} directive will write some of its digits beyond the end of
4184 the destination buffer.  To make the call safe regardless of the values
4185 of the two variables, the size of the destination buffer must be increased
4186 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4187 an informational note following the warning.
4189 An alternative to increasing the size of the destination buffer is to
4190 constrain the range of formatted values.  The maximum length of string
4191 arguments can be bounded by specifying the precision in the format
4192 directive.  When numeric arguments of format directives can be assumed
4193 to be bounded by less than the precision of their type, choosing
4194 an appropriate length modifier to the format specifier will reduce
4195 the required buffer size.  For example, if @var{a} and @var{b} in the
4196 example above can be assumed to be within the precision of
4197 the @code{short int} type then using either the @code{%hi} format
4198 directive or casting the argument to @code{short} reduces the maximum
4199 required size of the buffer to 24 bytes.
4201 @smallexample
4202 void f (int a, int b)
4204   char buf [23];
4205   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4207 @end smallexample
4208 @end table
4210 @item -Wno-format-zero-length
4211 @opindex Wno-format-zero-length
4212 @opindex Wformat-zero-length
4213 If @option{-Wformat} is specified, do not warn about zero-length formats.
4214 The C standard specifies that zero-length formats are allowed.
4217 @item -Wformat=2
4218 @opindex Wformat=2
4219 Enable @option{-Wformat} plus additional format checks.  Currently
4220 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4221 -Wformat-y2k}.
4223 @item -Wformat-nonliteral
4224 @opindex Wformat-nonliteral
4225 @opindex Wno-format-nonliteral
4226 If @option{-Wformat} is specified, also warn if the format string is not a
4227 string literal and so cannot be checked, unless the format function
4228 takes its format arguments as a @code{va_list}.
4230 @item -Wformat-security
4231 @opindex Wformat-security
4232 @opindex Wno-format-security
4233 If @option{-Wformat} is specified, also warn about uses of format
4234 functions that represent possible security problems.  At present, this
4235 warns about calls to @code{printf} and @code{scanf} functions where the
4236 format string is not a string literal and there are no format arguments,
4237 as in @code{printf (foo);}.  This may be a security hole if the format
4238 string came from untrusted input and contains @samp{%n}.  (This is
4239 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4240 in future warnings may be added to @option{-Wformat-security} that are not
4241 included in @option{-Wformat-nonliteral}.)
4243 @item -Wformat-signedness
4244 @opindex Wformat-signedness
4245 @opindex Wno-format-signedness
4246 If @option{-Wformat} is specified, also warn if the format string
4247 requires an unsigned argument and the argument is signed and vice versa.
4249 @item -Wformat-truncation
4250 @itemx -Wformat-truncation=@var{level}
4251 @opindex Wformat-truncation
4252 @opindex Wno-format-truncation
4253 Warn about calls to formatted input/output functions such as @code{snprintf}
4254 and @code{vsnprintf} that might result in output truncation.  When the exact
4255 number of bytes written by a format directive cannot be determined at
4256 compile-time it is estimated based on heuristics that depend on
4257 the @var{level} argument and on optimization.  While enabling optimization
4258 will in most cases improve the accuracy of the warning, it may also result
4259 in false positives.  Except as noted otherwise, the option uses the same
4260 logic @option{-Wformat-overflow}.
4262 @table @gcctabopt
4263 @item -Wformat-truncation
4264 @itemx -Wformat-truncation=1
4265 @opindex Wformat-truncation
4266 @opindex Wno-format-overflow
4267 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4268 employs a conservative approach that warns only about calls to bounded
4269 functions whose return value is unused and that will most likely result
4270 in output truncation.
4272 @item -Wformat-truncation=2
4273 Level @var{2} warns also about calls to bounded functions whose return
4274 value is used and that might result in truncation given an argument of
4275 sufficient length or magnitude.
4276 @end table
4278 @item -Wformat-y2k
4279 @opindex Wformat-y2k
4280 @opindex Wno-format-y2k
4281 If @option{-Wformat} is specified, also warn about @code{strftime}
4282 formats that may yield only a two-digit year.
4283 @end table
4285 @item -Wnonnull
4286 @opindex Wnonnull
4287 @opindex Wno-nonnull
4288 Warn about passing a null pointer for arguments marked as
4289 requiring a non-null value by the @code{nonnull} function attribute.
4291 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4292 can be disabled with the @option{-Wno-nonnull} option.
4294 @item -Wnonnull-compare
4295 @opindex Wnonnull-compare
4296 @opindex Wno-nonnull-compare
4297 Warn when comparing an argument marked with the @code{nonnull}
4298 function attribute against null inside the function.
4300 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4301 can be disabled with the @option{-Wno-nonnull-compare} option.
4303 @item -Wnull-dereference
4304 @opindex Wnull-dereference
4305 @opindex Wno-null-dereference
4306 Warn if the compiler detects paths that trigger erroneous or
4307 undefined behavior due to dereferencing a null pointer.  This option
4308 is only active when @option{-fdelete-null-pointer-checks} is active,
4309 which is enabled by optimizations in most targets.  The precision of
4310 the warnings depends on the optimization options used.
4312 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4313 @opindex Winit-self
4314 @opindex Wno-init-self
4315 Warn about uninitialized variables that are initialized with themselves.
4316 Note this option can only be used with the @option{-Wuninitialized} option.
4318 For example, GCC warns about @code{i} being uninitialized in the
4319 following snippet only when @option{-Winit-self} has been specified:
4320 @smallexample
4321 @group
4322 int f()
4324   int i = i;
4325   return i;
4327 @end group
4328 @end smallexample
4330 This warning is enabled by @option{-Wall} in C++.
4332 @item -Wimplicit-int @r{(C and Objective-C only)}
4333 @opindex Wimplicit-int
4334 @opindex Wno-implicit-int
4335 Warn when a declaration does not specify a type.
4336 This warning is enabled by @option{-Wall}.
4338 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4339 @opindex Wimplicit-function-declaration
4340 @opindex Wno-implicit-function-declaration
4341 Give a warning whenever a function is used before being declared. In
4342 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4343 enabled by default and it is made into an error by
4344 @option{-pedantic-errors}. This warning is also enabled by
4345 @option{-Wall}.
4347 @item -Wimplicit @r{(C and Objective-C only)}
4348 @opindex Wimplicit
4349 @opindex Wno-implicit
4350 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4351 This warning is enabled by @option{-Wall}.
4353 @item -Wimplicit-fallthrough
4354 @opindex Wimplicit-fallthrough
4355 @opindex Wno-implicit-fallthrough
4356 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4357 and @option{-Wno-implicit-fallthrough} is the same as
4358 @option{-Wimplicit-fallthrough=0}.
4360 @item -Wimplicit-fallthrough=@var{n}
4361 @opindex Wimplicit-fallthrough=
4362 Warn when a switch case falls through.  For example:
4364 @smallexample
4365 @group
4366 switch (cond)
4367   @{
4368   case 1:
4369     a = 1;
4370     break;
4371   case 2:
4372     a = 2;
4373   case 3:
4374     a = 3;
4375     break;
4376   @}
4377 @end group
4378 @end smallexample
4380 This warning does not warn when the last statement of a case cannot
4381 fall through, e.g. when there is a return statement or a call to function
4382 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4383 also takes into account control flow statements, such as ifs, and only
4384 warns when appropriate.  E.g.@:
4386 @smallexample
4387 @group
4388 switch (cond)
4389   @{
4390   case 1:
4391     if (i > 3) @{
4392       bar (5);
4393       break;
4394     @} else if (i < 1) @{
4395       bar (0);
4396     @} else
4397       return;
4398   default:
4399     @dots{}
4400   @}
4401 @end group
4402 @end smallexample
4404 Since there are occasions where a switch case fall through is desirable,
4405 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4406 to be used along with a null statement to suppress this warning that
4407 would normally occur:
4409 @smallexample
4410 @group
4411 switch (cond)
4412   @{
4413   case 1:
4414     bar (0);
4415     __attribute__ ((fallthrough));
4416   default:
4417     @dots{}
4418   @}
4419 @end group
4420 @end smallexample
4422 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4423 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4424 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4425 Instead of these attributes, it is also possible to add a fallthrough comment
4426 to silence the warning.  The whole body of the C or C++ style comment should
4427 match the given regular expressions listed below.  The option argument @var{n}
4428 specifies what kind of comments are accepted:
4430 @itemize @bullet
4432 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4434 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4435 expression, any comment is used as fallthrough comment.
4437 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4438 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4440 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4441 following regular expressions:
4443 @itemize @bullet
4445 @item @code{-fallthrough}
4447 @item @code{@@fallthrough@@}
4449 @item @code{lint -fallthrough[ \t]*}
4451 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4453 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4455 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4457 @end itemize
4459 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4460 following regular expressions:
4462 @itemize @bullet
4464 @item @code{-fallthrough}
4466 @item @code{@@fallthrough@@}
4468 @item @code{lint -fallthrough[ \t]*}
4470 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4472 @end itemize
4474 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4475 fallthrough comments, only attributes disable the warning.
4477 @end itemize
4479 The comment needs to be followed after optional whitespace and other comments
4480 by @code{case} or @code{default} keywords or by a user label that precedes some
4481 @code{case} or @code{default} label.
4483 @smallexample
4484 @group
4485 switch (cond)
4486   @{
4487   case 1:
4488     bar (0);
4489     /* FALLTHRU */
4490   default:
4491     @dots{}
4492   @}
4493 @end group
4494 @end smallexample
4496 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4498 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4499 @opindex Wif-not-aligned
4500 @opindex Wno-if-not-aligned
4501 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4502 should be issued.  This is is enabled by default.
4503 Use @option{-Wno-if-not-aligned} to disable it.
4505 @item -Wignored-qualifiers @r{(C and C++ only)}
4506 @opindex Wignored-qualifiers
4507 @opindex Wno-ignored-qualifiers
4508 Warn if the return type of a function has a type qualifier
4509 such as @code{const}.  For ISO C such a type qualifier has no effect,
4510 since the value returned by a function is not an lvalue.
4511 For C++, the warning is only emitted for scalar types or @code{void}.
4512 ISO C prohibits qualified @code{void} return types on function
4513 definitions, so such return types always receive a warning
4514 even without this option.
4516 This warning is also enabled by @option{-Wextra}.
4518 @item -Wignored-attributes @r{(C and C++ only)}
4519 @opindex Wignored-attributes
4520 @opindex Wno-ignored-attributes
4521 Warn when an attribute is ignored.  This is different from the
4522 @option{-Wattributes} option in that it warns whenever the compiler decides
4523 to drop an attribute, not that the attribute is either unknown, used in a
4524 wrong place, etc.  This warning is enabled by default.
4526 @item -Wmain
4527 @opindex Wmain
4528 @opindex Wno-main
4529 Warn if the type of @code{main} is suspicious.  @code{main} should be
4530 a function with external linkage, returning int, taking either zero
4531 arguments, two, or three arguments of appropriate types.  This warning
4532 is enabled by default in C++ and is enabled by either @option{-Wall}
4533 or @option{-Wpedantic}.
4535 @item -Wmisleading-indentation @r{(C and C++ only)}
4536 @opindex Wmisleading-indentation
4537 @opindex Wno-misleading-indentation
4538 Warn when the indentation of the code does not reflect the block structure.
4539 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4540 @code{for} clauses with a guarded statement that does not use braces,
4541 followed by an unguarded statement with the same indentation.
4543 In the following example, the call to ``bar'' is misleadingly indented as
4544 if it were guarded by the ``if'' conditional.
4546 @smallexample
4547   if (some_condition ())
4548     foo ();
4549     bar ();  /* Gotcha: this is not guarded by the "if".  */
4550 @end smallexample
4552 In the case of mixed tabs and spaces, the warning uses the
4553 @option{-ftabstop=} option to determine if the statements line up
4554 (defaulting to 8).
4556 The warning is not issued for code involving multiline preprocessor logic
4557 such as the following example.
4559 @smallexample
4560   if (flagA)
4561     foo (0);
4562 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4563   if (flagB)
4564 #endif
4565     foo (1);
4566 @end smallexample
4568 The warning is not issued after a @code{#line} directive, since this
4569 typically indicates autogenerated code, and no assumptions can be made
4570 about the layout of the file that the directive references.
4572 This warning is enabled by @option{-Wall} in C and C++.
4574 @item -Wmissing-attributes
4575 @opindex Wmissing-attributes
4576 @opindex Wno-missing-attributes
4577 Warn when a declaration of a function is missing one or more attributes
4578 that a related function is declared with and whose absence may adversely
4579 affect the correctness or efficiency of generated code.  For example, in
4580 C++, the warning is issued when an explicit specialization of a primary
4581 template declared with attribute @code{alloc_align}, @code{alloc_size},
4582 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4583 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4584 @code{error}, and @code{warning} suppress the warning.
4585 (@pxref{Function Attributes}).
4587 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4589 For example, since the declaration of the primary function template
4590 below makes use of both attribute @code{malloc} and @code{alloc_size}
4591 the declaration of the explicit specialization of the template is
4592 diagnosed because it is missing one of the attributes.
4594 @smallexample
4595 template <class T>
4596 T* __attribute__ ((malloc, alloc_size (1)))
4597 allocate (size_t);
4599 template <>
4600 void* __attribute__ ((malloc))   // missing alloc_size
4601 allocate<void> (size_t);
4602 @end smallexample
4604 @item -Wmissing-braces
4605 @opindex Wmissing-braces
4606 @opindex Wno-missing-braces
4607 Warn if an aggregate or union initializer is not fully bracketed.  In
4608 the following example, the initializer for @code{a} is not fully
4609 bracketed, but that for @code{b} is fully bracketed.  This warning is
4610 enabled by @option{-Wall} in C.
4612 @smallexample
4613 int a[2][2] = @{ 0, 1, 2, 3 @};
4614 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4615 @end smallexample
4617 This warning is enabled by @option{-Wall}.
4619 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4620 @opindex Wmissing-include-dirs
4621 @opindex Wno-missing-include-dirs
4622 Warn if a user-supplied include directory does not exist.
4624 @item -Wmultistatement-macros
4625 @opindex Wmultistatement-macros
4626 @opindex Wno-multistatement-macros
4627 Warn about unsafe multiple statement macros that appear to be guarded
4628 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4629 @code{while}, in which only the first statement is actually guarded after
4630 the macro is expanded.
4632 For example:
4634 @smallexample
4635 #define DOIT x++; y++
4636 if (c)
4637   DOIT;
4638 @end smallexample
4640 will increment @code{y} unconditionally, not just when @code{c} holds.
4641 The can usually be fixed by wrapping the macro in a do-while loop:
4642 @smallexample
4643 #define DOIT do @{ x++; y++; @} while (0)
4644 if (c)
4645   DOIT;
4646 @end smallexample
4648 This warning is enabled by @option{-Wall} in C and C++.
4650 @item -Wparentheses
4651 @opindex Wparentheses
4652 @opindex Wno-parentheses
4653 Warn if parentheses are omitted in certain contexts, such
4654 as when there is an assignment in a context where a truth value
4655 is expected, or when operators are nested whose precedence people
4656 often get confused about.
4658 Also warn if a comparison like @code{x<=y<=z} appears; this is
4659 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4660 interpretation from that of ordinary mathematical notation.
4662 Also warn for dangerous uses of the GNU extension to
4663 @code{?:} with omitted middle operand. When the condition
4664 in the @code{?}: operator is a boolean expression, the omitted value is
4665 always 1.  Often programmers expect it to be a value computed
4666 inside the conditional expression instead.
4668 For C++ this also warns for some cases of unnecessary parentheses in
4669 declarations, which can indicate an attempt at a function call instead
4670 of a declaration:
4671 @smallexample
4673   // Declares a local variable called mymutex.
4674   std::unique_lock<std::mutex> (mymutex);
4675   // User meant std::unique_lock<std::mutex> lock (mymutex);
4677 @end smallexample
4679 This warning is enabled by @option{-Wall}.
4681 @item -Wsequence-point
4682 @opindex Wsequence-point
4683 @opindex Wno-sequence-point
4684 Warn about code that may have undefined semantics because of violations
4685 of sequence point rules in the C and C++ standards.
4687 The C and C++ standards define the order in which expressions in a C/C++
4688 program are evaluated in terms of @dfn{sequence points}, which represent
4689 a partial ordering between the execution of parts of the program: those
4690 executed before the sequence point, and those executed after it.  These
4691 occur after the evaluation of a full expression (one which is not part
4692 of a larger expression), after the evaluation of the first operand of a
4693 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4694 function is called (but after the evaluation of its arguments and the
4695 expression denoting the called function), and in certain other places.
4696 Other than as expressed by the sequence point rules, the order of
4697 evaluation of subexpressions of an expression is not specified.  All
4698 these rules describe only a partial order rather than a total order,
4699 since, for example, if two functions are called within one expression
4700 with no sequence point between them, the order in which the functions
4701 are called is not specified.  However, the standards committee have
4702 ruled that function calls do not overlap.
4704 It is not specified when between sequence points modifications to the
4705 values of objects take effect.  Programs whose behavior depends on this
4706 have undefined behavior; the C and C++ standards specify that ``Between
4707 the previous and next sequence point an object shall have its stored
4708 value modified at most once by the evaluation of an expression.
4709 Furthermore, the prior value shall be read only to determine the value
4710 to be stored.''.  If a program breaks these rules, the results on any
4711 particular implementation are entirely unpredictable.
4713 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4714 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4715 diagnosed by this option, and it may give an occasional false positive
4716 result, but in general it has been found fairly effective at detecting
4717 this sort of problem in programs.
4719 The C++17 standard will define the order of evaluation of operands in
4720 more cases: in particular it requires that the right-hand side of an
4721 assignment be evaluated before the left-hand side, so the above
4722 examples are no longer undefined.  But this warning will still warn
4723 about them, to help people avoid writing code that is undefined in C
4724 and earlier revisions of C++.
4726 The standard is worded confusingly, therefore there is some debate
4727 over the precise meaning of the sequence point rules in subtle cases.
4728 Links to discussions of the problem, including proposed formal
4729 definitions, may be found on the GCC readings page, at
4730 @uref{http://gcc.gnu.org/@/readings.html}.
4732 This warning is enabled by @option{-Wall} for C and C++.
4734 @item -Wno-return-local-addr
4735 @opindex Wno-return-local-addr
4736 @opindex Wreturn-local-addr
4737 Do not warn about returning a pointer (or in C++, a reference) to a
4738 variable that goes out of scope after the function returns.
4740 @item -Wreturn-type
4741 @opindex Wreturn-type
4742 @opindex Wno-return-type
4743 Warn whenever a function is defined with a return type that defaults
4744 to @code{int}.  Also warn about any @code{return} statement with no
4745 return value in a function whose return type is not @code{void}
4746 (falling off the end of the function body is considered returning
4747 without a value).
4749 For C only, warn about a @code{return} statement with an expression in a
4750 function whose return type is @code{void}, unless the expression type is
4751 also @code{void}.  As a GNU extension, the latter case is accepted
4752 without a warning unless @option{-Wpedantic} is used.
4754 For C++, a function without return type always produces a diagnostic
4755 message, even when @option{-Wno-return-type} is specified.  The only
4756 exceptions are @code{main} and functions defined in system headers.
4758 This warning is enabled by default for C++ and is enabled by @option{-Wall}.
4760 @item -Wshift-count-negative
4761 @opindex Wshift-count-negative
4762 @opindex Wno-shift-count-negative
4763 Warn if shift count is negative. This warning is enabled by default.
4765 @item -Wshift-count-overflow
4766 @opindex Wshift-count-overflow
4767 @opindex Wno-shift-count-overflow
4768 Warn if shift count >= width of type. This warning is enabled by default.
4770 @item -Wshift-negative-value
4771 @opindex Wshift-negative-value
4772 @opindex Wno-shift-negative-value
4773 Warn if left shifting a negative value.  This warning is enabled by
4774 @option{-Wextra} in C99 and C++11 modes (and newer).
4776 @item -Wshift-overflow
4777 @itemx -Wshift-overflow=@var{n}
4778 @opindex Wshift-overflow
4779 @opindex Wno-shift-overflow
4780 Warn about left shift overflows.  This warning is enabled by
4781 default in C99 and C++11 modes (and newer).
4783 @table @gcctabopt
4784 @item -Wshift-overflow=1
4785 This is the warning level of @option{-Wshift-overflow} and is enabled
4786 by default in C99 and C++11 modes (and newer).  This warning level does
4787 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4788 an overflow is still rejected in contexts where an integer constant expression
4789 is required.)
4791 @item -Wshift-overflow=2
4792 This warning level also warns about left-shifting 1 into the sign bit,
4793 unless C++14 mode is active.
4794 @end table
4796 @item -Wswitch
4797 @opindex Wswitch
4798 @opindex Wno-switch
4799 Warn whenever a @code{switch} statement has an index of enumerated type
4800 and lacks a @code{case} for one or more of the named codes of that
4801 enumeration.  (The presence of a @code{default} label prevents this
4802 warning.)  @code{case} labels outside the enumeration range also
4803 provoke warnings when this option is used (even if there is a
4804 @code{default} label).
4805 This warning is enabled by @option{-Wall}.
4807 @item -Wswitch-default
4808 @opindex Wswitch-default
4809 @opindex Wno-switch-default
4810 Warn whenever a @code{switch} statement does not have a @code{default}
4811 case.
4813 @item -Wswitch-enum
4814 @opindex Wswitch-enum
4815 @opindex Wno-switch-enum
4816 Warn whenever a @code{switch} statement has an index of enumerated type
4817 and lacks a @code{case} for one or more of the named codes of that
4818 enumeration.  @code{case} labels outside the enumeration range also
4819 provoke warnings when this option is used.  The only difference
4820 between @option{-Wswitch} and this option is that this option gives a
4821 warning about an omitted enumeration code even if there is a
4822 @code{default} label.
4824 @item -Wswitch-bool
4825 @opindex Wswitch-bool
4826 @opindex Wno-switch-bool
4827 Warn whenever a @code{switch} statement has an index of boolean type
4828 and the case values are outside the range of a boolean type.
4829 It is possible to suppress this warning by casting the controlling
4830 expression to a type other than @code{bool}.  For example:
4831 @smallexample
4832 @group
4833 switch ((int) (a == 4))
4834   @{
4835   @dots{}
4836   @}
4837 @end group
4838 @end smallexample
4839 This warning is enabled by default for C and C++ programs.
4841 @item -Wswitch-unreachable
4842 @opindex Wswitch-unreachable
4843 @opindex Wno-switch-unreachable
4844 Warn whenever a @code{switch} statement contains statements between the
4845 controlling expression and the first case label, which will never be
4846 executed.  For example:
4847 @smallexample
4848 @group
4849 switch (cond)
4850   @{
4851    i = 15;
4852   @dots{}
4853    case 5:
4854   @dots{}
4855   @}
4856 @end group
4857 @end smallexample
4858 @option{-Wswitch-unreachable} does not warn if the statement between the
4859 controlling expression and the first case label is just a declaration:
4860 @smallexample
4861 @group
4862 switch (cond)
4863   @{
4864    int i;
4865   @dots{}
4866    case 5:
4867    i = 5;
4868   @dots{}
4869   @}
4870 @end group
4871 @end smallexample
4872 This warning is enabled by default for C and C++ programs.
4874 @item -Wsync-nand @r{(C and C++ only)}
4875 @opindex Wsync-nand
4876 @opindex Wno-sync-nand
4877 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4878 built-in functions are used.  These functions changed semantics in GCC 4.4.
4880 @item -Wunused-but-set-parameter
4881 @opindex Wunused-but-set-parameter
4882 @opindex Wno-unused-but-set-parameter
4883 Warn whenever a function parameter is assigned to, but otherwise unused
4884 (aside from its declaration).
4886 To suppress this warning use the @code{unused} attribute
4887 (@pxref{Variable Attributes}).
4889 This warning is also enabled by @option{-Wunused} together with
4890 @option{-Wextra}.
4892 @item -Wunused-but-set-variable
4893 @opindex Wunused-but-set-variable
4894 @opindex Wno-unused-but-set-variable
4895 Warn whenever a local variable is assigned to, but otherwise unused
4896 (aside from its declaration).
4897 This warning is enabled by @option{-Wall}.
4899 To suppress this warning use the @code{unused} attribute
4900 (@pxref{Variable Attributes}).
4902 This warning is also enabled by @option{-Wunused}, which is enabled
4903 by @option{-Wall}.
4905 @item -Wunused-function
4906 @opindex Wunused-function
4907 @opindex Wno-unused-function
4908 Warn whenever a static function is declared but not defined or a
4909 non-inline static function is unused.
4910 This warning is enabled by @option{-Wall}.
4912 @item -Wunused-label
4913 @opindex Wunused-label
4914 @opindex Wno-unused-label
4915 Warn whenever a label is declared but not used.
4916 This warning is enabled by @option{-Wall}.
4918 To suppress this warning use the @code{unused} attribute
4919 (@pxref{Variable Attributes}).
4921 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4922 @opindex Wunused-local-typedefs
4923 Warn when a typedef locally defined in a function is not used.
4924 This warning is enabled by @option{-Wall}.
4926 @item -Wunused-parameter
4927 @opindex Wunused-parameter
4928 @opindex Wno-unused-parameter
4929 Warn whenever a function parameter is unused aside from its declaration.
4931 To suppress this warning use the @code{unused} attribute
4932 (@pxref{Variable Attributes}).
4934 @item -Wno-unused-result
4935 @opindex Wunused-result
4936 @opindex Wno-unused-result
4937 Do not warn if a caller of a function marked with attribute
4938 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4939 its return value. The default is @option{-Wunused-result}.
4941 @item -Wunused-variable
4942 @opindex Wunused-variable
4943 @opindex Wno-unused-variable
4944 Warn whenever a local or static variable is unused aside from its
4945 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4946 but not for C++. This warning is enabled by @option{-Wall}.
4948 To suppress this warning use the @code{unused} attribute
4949 (@pxref{Variable Attributes}).
4951 @item -Wunused-const-variable
4952 @itemx -Wunused-const-variable=@var{n}
4953 @opindex Wunused-const-variable
4954 @opindex Wno-unused-const-variable
4955 Warn whenever a constant static variable is unused aside from its declaration.
4956 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4957 for C, but not for C++. In C this declares variable storage, but in C++ this
4958 is not an error since const variables take the place of @code{#define}s.
4960 To suppress this warning use the @code{unused} attribute
4961 (@pxref{Variable Attributes}).
4963 @table @gcctabopt
4964 @item -Wunused-const-variable=1
4965 This is the warning level that is enabled by @option{-Wunused-variable} for
4966 C.  It warns only about unused static const variables defined in the main
4967 compilation unit, but not about static const variables declared in any
4968 header included.
4970 @item -Wunused-const-variable=2
4971 This warning level also warns for unused constant static variables in
4972 headers (excluding system headers).  This is the warning level of
4973 @option{-Wunused-const-variable} and must be explicitly requested since
4974 in C++ this isn't an error and in C it might be harder to clean up all
4975 headers included.
4976 @end table
4978 @item -Wunused-value
4979 @opindex Wunused-value
4980 @opindex Wno-unused-value
4981 Warn whenever a statement computes a result that is explicitly not
4982 used. To suppress this warning cast the unused expression to
4983 @code{void}. This includes an expression-statement or the left-hand
4984 side of a comma expression that contains no side effects. For example,
4985 an expression such as @code{x[i,j]} causes a warning, while
4986 @code{x[(void)i,j]} does not.
4988 This warning is enabled by @option{-Wall}.
4990 @item -Wunused
4991 @opindex Wunused
4992 @opindex Wno-unused
4993 All the above @option{-Wunused} options combined.
4995 In order to get a warning about an unused function parameter, you must
4996 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4997 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4999 @item -Wuninitialized
5000 @opindex Wuninitialized
5001 @opindex Wno-uninitialized
5002 Warn if an automatic variable is used without first being initialized
5003 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5004 warn if a non-static reference or non-static @code{const} member
5005 appears in a class without constructors.
5007 If you want to warn about code that uses the uninitialized value of the
5008 variable in its own initializer, use the @option{-Winit-self} option.
5010 These warnings occur for individual uninitialized or clobbered
5011 elements of structure, union or array variables as well as for
5012 variables that are uninitialized or clobbered as a whole.  They do
5013 not occur for variables or elements declared @code{volatile}.  Because
5014 these warnings depend on optimization, the exact variables or elements
5015 for which there are warnings depends on the precise optimization
5016 options and version of GCC used.
5018 Note that there may be no warning about a variable that is used only
5019 to compute a value that itself is never used, because such
5020 computations may be deleted by data flow analysis before the warnings
5021 are printed.
5023 @item -Winvalid-memory-model
5024 @opindex Winvalid-memory-model
5025 @opindex Wno-invalid-memory-model
5026 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5027 and the C11 atomic generic functions with a memory consistency argument
5028 that is either invalid for the operation or outside the range of values
5029 of the @code{memory_order} enumeration.  For example, since the
5030 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5031 defined for the relaxed, release, and sequentially consistent memory
5032 orders the following code is diagnosed:
5034 @smallexample
5035 void store (int *i)
5037   __atomic_store_n (i, 0, memory_order_consume);
5039 @end smallexample
5041 @option{-Winvalid-memory-model} is enabled by default.
5043 @item -Wmaybe-uninitialized
5044 @opindex Wmaybe-uninitialized
5045 @opindex Wno-maybe-uninitialized
5046 For an automatic (i.e.@ local) variable, if there exists a path from the
5047 function entry to a use of the variable that is initialized, but there exist
5048 some other paths for which the variable is not initialized, the compiler
5049 emits a warning if it cannot prove the uninitialized paths are not
5050 executed at run time.
5052 These warnings are only possible in optimizing compilation, because otherwise
5053 GCC does not keep track of the state of variables.
5055 These warnings are made optional because GCC may not be able to determine when
5056 the code is correct in spite of appearing to have an error.  Here is one
5057 example of how this can happen:
5059 @smallexample
5060 @group
5062   int x;
5063   switch (y)
5064     @{
5065     case 1: x = 1;
5066       break;
5067     case 2: x = 4;
5068       break;
5069     case 3: x = 5;
5070     @}
5071   foo (x);
5073 @end group
5074 @end smallexample
5076 @noindent
5077 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5078 always initialized, but GCC doesn't know this. To suppress the
5079 warning, you need to provide a default case with assert(0) or
5080 similar code.
5082 @cindex @code{longjmp} warnings
5083 This option also warns when a non-volatile automatic variable might be
5084 changed by a call to @code{longjmp}.
5085 The compiler sees only the calls to @code{setjmp}.  It cannot know
5086 where @code{longjmp} will be called; in fact, a signal handler could
5087 call it at any point in the code.  As a result, you may get a warning
5088 even when there is in fact no problem because @code{longjmp} cannot
5089 in fact be called at the place that would cause a problem.
5091 Some spurious warnings can be avoided if you declare all the functions
5092 you use that never return as @code{noreturn}.  @xref{Function
5093 Attributes}.
5095 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5097 @item -Wunknown-pragmas
5098 @opindex Wunknown-pragmas
5099 @opindex Wno-unknown-pragmas
5100 @cindex warning for unknown pragmas
5101 @cindex unknown pragmas, warning
5102 @cindex pragmas, warning of unknown
5103 Warn when a @code{#pragma} directive is encountered that is not understood by 
5104 GCC@.  If this command-line option is used, warnings are even issued
5105 for unknown pragmas in system header files.  This is not the case if
5106 the warnings are only enabled by the @option{-Wall} command-line option.
5108 @item -Wno-pragmas
5109 @opindex Wno-pragmas
5110 @opindex Wpragmas
5111 Do not warn about misuses of pragmas, such as incorrect parameters,
5112 invalid syntax, or conflicts between pragmas.  See also
5113 @option{-Wunknown-pragmas}.
5115 @item -Wstrict-aliasing
5116 @opindex Wstrict-aliasing
5117 @opindex Wno-strict-aliasing
5118 This option is only active when @option{-fstrict-aliasing} is active.
5119 It warns about code that might break the strict aliasing rules that the
5120 compiler is using for optimization.  The warning does not catch all
5121 cases, but does attempt to catch the more common pitfalls.  It is
5122 included in @option{-Wall}.
5123 It is equivalent to @option{-Wstrict-aliasing=3}
5125 @item -Wstrict-aliasing=n
5126 @opindex Wstrict-aliasing=n
5127 This option is only active when @option{-fstrict-aliasing} is active.
5128 It warns about code that might break the strict aliasing rules that the
5129 compiler is using for optimization.
5130 Higher levels correspond to higher accuracy (fewer false positives).
5131 Higher levels also correspond to more effort, similar to the way @option{-O} 
5132 works.
5133 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5135 Level 1: Most aggressive, quick, least accurate.
5136 Possibly useful when higher levels
5137 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5138 false negatives.  However, it has many false positives.
5139 Warns for all pointer conversions between possibly incompatible types,
5140 even if never dereferenced.  Runs in the front end only.
5142 Level 2: Aggressive, quick, not too precise.
5143 May still have many false positives (not as many as level 1 though),
5144 and few false negatives (but possibly more than level 1).
5145 Unlike level 1, it only warns when an address is taken.  Warns about
5146 incomplete types.  Runs in the front end only.
5148 Level 3 (default for @option{-Wstrict-aliasing}):
5149 Should have very few false positives and few false
5150 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5151 Takes care of the common pun+dereference pattern in the front end:
5152 @code{*(int*)&some_float}.
5153 If optimization is enabled, it also runs in the back end, where it deals
5154 with multiple statement cases using flow-sensitive points-to information.
5155 Only warns when the converted pointer is dereferenced.
5156 Does not warn about incomplete types.
5158 @item -Wstrict-overflow
5159 @itemx -Wstrict-overflow=@var{n}
5160 @opindex Wstrict-overflow
5161 @opindex Wno-strict-overflow
5162 This option is only active when signed overflow is undefined.
5163 It warns about cases where the compiler optimizes based on the
5164 assumption that signed overflow does not occur.  Note that it does not
5165 warn about all cases where the code might overflow: it only warns
5166 about cases where the compiler implements some optimization.  Thus
5167 this warning depends on the optimization level.
5169 An optimization that assumes that signed overflow does not occur is
5170 perfectly safe if the values of the variables involved are such that
5171 overflow never does, in fact, occur.  Therefore this warning can
5172 easily give a false positive: a warning about code that is not
5173 actually a problem.  To help focus on important issues, several
5174 warning levels are defined.  No warnings are issued for the use of
5175 undefined signed overflow when estimating how many iterations a loop
5176 requires, in particular when determining whether a loop will be
5177 executed at all.
5179 @table @gcctabopt
5180 @item -Wstrict-overflow=1
5181 Warn about cases that are both questionable and easy to avoid.  For
5182 example the compiler simplifies
5183 @code{x + 1 > x} to @code{1}.  This level of
5184 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5185 are not, and must be explicitly requested.
5187 @item -Wstrict-overflow=2
5188 Also warn about other cases where a comparison is simplified to a
5189 constant.  For example: @code{abs (x) >= 0}.  This can only be
5190 simplified when signed integer overflow is undefined, because
5191 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5192 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5193 @option{-Wstrict-overflow=2}.
5195 @item -Wstrict-overflow=3
5196 Also warn about other cases where a comparison is simplified.  For
5197 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5199 @item -Wstrict-overflow=4
5200 Also warn about other simplifications not covered by the above cases.
5201 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5203 @item -Wstrict-overflow=5
5204 Also warn about cases where the compiler reduces the magnitude of a
5205 constant involved in a comparison.  For example: @code{x + 2 > y} is
5206 simplified to @code{x + 1 >= y}.  This is reported only at the
5207 highest warning level because this simplification applies to many
5208 comparisons, so this warning level gives a very large number of
5209 false positives.
5210 @end table
5212 @item -Wstringop-overflow
5213 @itemx -Wstringop-overflow=@var{type}
5214 @opindex Wstringop-overflow
5215 @opindex Wno-stringop-overflow
5216 Warn for calls to string manipulation functions such as @code{memcpy} and
5217 @code{strcpy} that are determined to overflow the destination buffer.  The
5218 optional argument is one greater than the type of Object Size Checking to
5219 perform to determine the size of the destination.  @xref{Object Size Checking}.
5220 The argument is meaningful only for functions that operate on character arrays
5221 but not for raw memory functions like @code{memcpy} which always make use
5222 of Object Size type-0.  The option also warns for calls that specify a size
5223 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5224 The option produces the best results with optimization enabled but can detect
5225 a small subset of simple buffer overflows even without optimization in
5226 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5227 correspond to the standard functions.  In any case, the option warns about
5228 just a subset of buffer overflows detected by the corresponding overflow
5229 checking built-ins.  For example, the option will issue a warning for
5230 the @code{strcpy} call below because it copies at least 5 characters
5231 (the string @code{"blue"} including the terminating NUL) into the buffer
5232 of size 4.
5234 @smallexample
5235 enum Color @{ blue, purple, yellow @};
5236 const char* f (enum Color clr)
5238   static char buf [4];
5239   const char *str;
5240   switch (clr)
5241     @{
5242       case blue: str = "blue"; break;
5243       case purple: str = "purple"; break;
5244       case yellow: str = "yellow"; break;
5245     @}
5247   return strcpy (buf, str);   // warning here
5249 @end smallexample
5251 Option @option{-Wstringop-overflow=2} is enabled by default.
5253 @table @gcctabopt
5254 @item -Wstringop-overflow
5255 @itemx -Wstringop-overflow=1
5256 @opindex Wstringop-overflow
5257 @opindex Wno-stringop-overflow
5258 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5259 to determine the sizes of destination objects.  This is the default setting
5260 of the option.  At this setting the option will not warn for writes past
5261 the end of subobjects of larger objects accessed by pointers unless the
5262 size of the largest surrounding object is known.  When the destination may
5263 be one of several objects it is assumed to be the largest one of them.  On
5264 Linux systems, when optimization is enabled at this setting the option warns
5265 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5266 a non-zero value.
5268 @item -Wstringop-overflow=2
5269 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5270 to determine the sizes of destination objects.  At this setting the option
5271 will warn about overflows when writing to members of the largest complete
5272 objects whose exact size is known.  It will, however, not warn for excessive
5273 writes to the same members of unknown objects referenced by pointers since
5274 they may point to arrays containing unknown numbers of elements.
5276 @item -Wstringop-overflow=3
5277 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5278 to determine the sizes of destination objects.  At this setting the option
5279 warns about overflowing the smallest object or data member.  This is the
5280 most restrictive setting of the option that may result in warnings for safe
5281 code.
5283 @item -Wstringop-overflow=4
5284 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5285 to determine the sizes of destination objects.  At this setting the option
5286 will warn about overflowing any data members, and when the destination is
5287 one of several objects it uses the size of the largest of them to decide
5288 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5289 setting of the option may result in warnings for benign code.
5290 @end table
5292 @item -Wstringop-truncation
5293 @opindex Wstringop-truncation
5294 @opindex Wno-stringop-truncation
5295 Warn for calls to bounded string manipulation functions such as @code{strncat},
5296 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5297 or leave the destination unchanged.
5299 In the following example, the call to @code{strncat} specifies a bound that
5300 is less than the length of the source string.  As a result, the copy of
5301 the source will be truncated and so the call is diagnosed.  To avoid the
5302 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5304 @smallexample
5305 void append (char *buf, size_t bufsize)
5307   strncat (buf, ".txt", 3);
5309 @end smallexample
5311 As another example, the following call to @code{strncpy} results in copying
5312 to @code{d} just the characters preceding the terminating NUL, without
5313 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5314 necessarily a NUL-terminated string is a common mistake, and so the call
5315 is diagnosed.  To avoid the warning when the result is not expected to be
5316 NUL-terminated, call @code{memcpy} instead.
5318 @smallexample
5319 void copy (char *d, const char *s)
5321   strncpy (d, s, strlen (s));
5323 @end smallexample
5325 In the following example, the call to @code{strncpy} specifies the size
5326 of the destination buffer as the bound.  If the length of the source
5327 string is equal to or greater than this size the result of the copy will
5328 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5329 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5330 element of the buffer to @code{NUL}.
5332 @smallexample
5333 void copy (const char *s)
5335   char buf[80];
5336   strncpy (buf, s, sizeof buf);
5337   @dots{}
5339 @end smallexample
5341 In situations where a character array is intended to store a sequence
5342 of bytes with no terminating @code{NUL} such an array may be annotated
5343 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5344 however, are not suitable arguments to functions that expect
5345 @code{NUL}-terminated strings.  To help detect accidental misuses of
5346 such arrays GCC issues warnings unless it can prove that the use is
5347 safe.  @xref{Common Variable Attributes}.
5349 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5350 @opindex Wsuggest-attribute=
5351 @opindex Wno-suggest-attribute=
5352 Warn for cases where adding an attribute may be beneficial. The
5353 attributes currently supported are listed below.
5355 @table @gcctabopt
5356 @item -Wsuggest-attribute=pure
5357 @itemx -Wsuggest-attribute=const
5358 @itemx -Wsuggest-attribute=noreturn
5359 @itemx -Wsuggest-attribute=malloc
5360 @opindex Wsuggest-attribute=pure
5361 @opindex Wno-suggest-attribute=pure
5362 @opindex Wsuggest-attribute=const
5363 @opindex Wno-suggest-attribute=const
5364 @opindex Wsuggest-attribute=noreturn
5365 @opindex Wno-suggest-attribute=noreturn
5366 @opindex Wsuggest-attribute=malloc
5367 @opindex Wno-suggest-attribute=malloc
5369 Warn about functions that might be candidates for attributes
5370 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5371 only warns for functions visible in other compilation units or (in the case of
5372 @code{pure} and @code{const}) if it cannot prove that the function returns
5373 normally. A function returns normally if it doesn't contain an infinite loop or
5374 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5375 requires option @option{-fipa-pure-const}, which is enabled by default at
5376 @option{-O} and higher.  Higher optimization levels improve the accuracy
5377 of the analysis.
5379 @item -Wsuggest-attribute=format
5380 @itemx -Wmissing-format-attribute
5381 @opindex Wsuggest-attribute=format
5382 @opindex Wmissing-format-attribute
5383 @opindex Wno-suggest-attribute=format
5384 @opindex Wno-missing-format-attribute
5385 @opindex Wformat
5386 @opindex Wno-format
5388 Warn about function pointers that might be candidates for @code{format}
5389 attributes.  Note these are only possible candidates, not absolute ones.
5390 GCC guesses that function pointers with @code{format} attributes that
5391 are used in assignment, initialization, parameter passing or return
5392 statements should have a corresponding @code{format} attribute in the
5393 resulting type.  I.e.@: the left-hand side of the assignment or
5394 initialization, the type of the parameter variable, or the return type
5395 of the containing function respectively should also have a @code{format}
5396 attribute to avoid the warning.
5398 GCC also warns about function definitions that might be
5399 candidates for @code{format} attributes.  Again, these are only
5400 possible candidates.  GCC guesses that @code{format} attributes
5401 might be appropriate for any function that calls a function like
5402 @code{vprintf} or @code{vscanf}, but this might not always be the
5403 case, and some functions for which @code{format} attributes are
5404 appropriate may not be detected.
5406 @item -Wsuggest-attribute=cold
5407 @opindex Wsuggest-attribute=cold
5408 @opindex Wno-suggest-attribute=cold
5410 Warn about functions that might be candidates for @code{cold} attribute.  This
5411 is based on static detection and generally will only warn about functions which
5412 always leads to a call to another @code{cold} function such as wrappers of
5413 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5414 @end table
5416 @item -Wsuggest-final-types
5417 @opindex Wno-suggest-final-types
5418 @opindex Wsuggest-final-types
5419 Warn about types with virtual methods where code quality would be improved
5420 if the type were declared with the C++11 @code{final} specifier, 
5421 or, if possible,
5422 declared in an anonymous namespace. This allows GCC to more aggressively
5423 devirtualize the polymorphic calls. This warning is more effective with link
5424 time optimization, where the information about the class hierarchy graph is
5425 more complete.
5427 @item -Wsuggest-final-methods
5428 @opindex Wno-suggest-final-methods
5429 @opindex Wsuggest-final-methods
5430 Warn about virtual methods where code quality would be improved if the method
5431 were declared with the C++11 @code{final} specifier, 
5432 or, if possible, its type were
5433 declared in an anonymous namespace or with the @code{final} specifier.
5434 This warning is
5435 more effective with link-time optimization, where the information about the
5436 class hierarchy graph is more complete. It is recommended to first consider
5437 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5438 annotations.
5440 @item -Wsuggest-override
5441 Warn about overriding virtual functions that are not marked with the override
5442 keyword.
5444 @item -Walloc-zero
5445 @opindex Wno-alloc-zero
5446 @opindex Walloc-zero
5447 Warn about calls to allocation functions decorated with attribute
5448 @code{alloc_size} that specify zero bytes, including those to the built-in
5449 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5450 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5451 when called with a zero size differs among implementations (and in the case
5452 of @code{realloc} has been deprecated) relying on it may result in subtle
5453 portability bugs and should be avoided.
5455 @item -Walloc-size-larger-than=@var{n}
5456 Warn about calls to functions decorated with attribute @code{alloc_size}
5457 that attempt to allocate objects larger than the specified number of bytes,
5458 or where the result of the size computation in an integer type with infinite
5459 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5460 may end in one of the standard suffixes designating a multiple of bytes
5461 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5462 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5463 @xref{Function Attributes}.
5465 @item -Walloca
5466 @opindex Wno-alloca
5467 @opindex Walloca
5468 This option warns on all uses of @code{alloca} in the source.
5470 @item -Walloca-larger-than=@var{n}
5471 This option warns on calls to @code{alloca} that are not bounded by a
5472 controlling predicate limiting its argument of integer type to at most
5473 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5474 Arguments of non-integer types are considered unbounded even if they
5475 appear to be constrained to the expected range.
5477 For example, a bounded case of @code{alloca} could be:
5479 @smallexample
5480 void func (size_t n)
5482   void *p;
5483   if (n <= 1000)
5484     p = alloca (n);
5485   else
5486     p = malloc (n);
5487   f (p);
5489 @end smallexample
5491 In the above example, passing @code{-Walloca-larger-than=1000} would not
5492 issue a warning because the call to @code{alloca} is known to be at most
5493 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5494 the compiler would emit a warning.
5496 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5497 controlling predicate constraining its integer argument.  For example:
5499 @smallexample
5500 void func ()
5502   void *p = alloca (n);
5503   f (p);
5505 @end smallexample
5507 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5508 a warning, but this time because of the lack of bounds checking.
5510 Note, that even seemingly correct code involving signed integers could
5511 cause a warning:
5513 @smallexample
5514 void func (signed int n)
5516   if (n < 500)
5517     @{
5518       p = alloca (n);
5519       f (p);
5520     @}
5522 @end smallexample
5524 In the above example, @var{n} could be negative, causing a larger than
5525 expected argument to be implicitly cast into the @code{alloca} call.
5527 This option also warns when @code{alloca} is used in a loop.
5529 This warning is not enabled by @option{-Wall}, and is only active when
5530 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5532 See also @option{-Wvla-larger-than=@var{n}}.
5534 @item -Warray-bounds
5535 @itemx -Warray-bounds=@var{n}
5536 @opindex Wno-array-bounds
5537 @opindex Warray-bounds
5538 This option is only active when @option{-ftree-vrp} is active
5539 (default for @option{-O2} and above). It warns about subscripts to arrays
5540 that are always out of bounds. This warning is enabled by @option{-Wall}.
5542 @table @gcctabopt
5543 @item -Warray-bounds=1
5544 This is the warning level of @option{-Warray-bounds} and is enabled
5545 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5547 @item -Warray-bounds=2
5548 This warning level also warns about out of bounds access for
5549 arrays at the end of a struct and for arrays accessed through
5550 pointers. This warning level may give a larger number of
5551 false positives and is deactivated by default.
5552 @end table
5554 @item -Wattribute-alias
5555 Warn about declarations using the @code{alias} and similar attributes whose
5556 target is incompatible with the type of the alias.  @xref{Function Attributes,
5557 ,Declaring Attributes of Functions}.
5559 @item -Wbool-compare
5560 @opindex Wno-bool-compare
5561 @opindex Wbool-compare
5562 Warn about boolean expression compared with an integer value different from
5563 @code{true}/@code{false}.  For instance, the following comparison is
5564 always false:
5565 @smallexample
5566 int n = 5;
5567 @dots{}
5568 if ((n > 1) == 2) @{ @dots{} @}
5569 @end smallexample
5570 This warning is enabled by @option{-Wall}.
5572 @item -Wbool-operation
5573 @opindex Wno-bool-operation
5574 @opindex Wbool-operation
5575 Warn about suspicious operations on expressions of a boolean type.  For
5576 instance, bitwise negation of a boolean is very likely a bug in the program.
5577 For C, this warning also warns about incrementing or decrementing a boolean,
5578 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5579 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5581 This warning is enabled by @option{-Wall}.
5583 @item -Wduplicated-branches
5584 @opindex Wno-duplicated-branches
5585 @opindex Wduplicated-branches
5586 Warn when an if-else has identical branches.  This warning detects cases like
5587 @smallexample
5588 if (p != NULL)
5589   return 0;
5590 else
5591   return 0;
5592 @end smallexample
5593 It doesn't warn when both branches contain just a null statement.  This warning
5594 also warn for conditional operators:
5595 @smallexample
5596   int i = x ? *p : *p;
5597 @end smallexample
5599 @item -Wduplicated-cond
5600 @opindex Wno-duplicated-cond
5601 @opindex Wduplicated-cond
5602 Warn about duplicated conditions in an if-else-if chain.  For instance,
5603 warn for the following code:
5604 @smallexample
5605 if (p->q != NULL) @{ @dots{} @}
5606 else if (p->q != NULL) @{ @dots{} @}
5607 @end smallexample
5609 @item -Wframe-address
5610 @opindex Wno-frame-address
5611 @opindex Wframe-address
5612 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5613 is called with an argument greater than 0.  Such calls may return indeterminate
5614 values or crash the program.  The warning is included in @option{-Wall}.
5616 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5617 @opindex Wno-discarded-qualifiers
5618 @opindex Wdiscarded-qualifiers
5619 Do not warn if type qualifiers on pointers are being discarded.
5620 Typically, the compiler warns if a @code{const char *} variable is
5621 passed to a function that takes a @code{char *} parameter.  This option
5622 can be used to suppress such a warning.
5624 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5625 @opindex Wno-discarded-array-qualifiers
5626 @opindex Wdiscarded-array-qualifiers
5627 Do not warn if type qualifiers on arrays which are pointer targets
5628 are being discarded. Typically, the compiler warns if a
5629 @code{const int (*)[]} variable is passed to a function that
5630 takes a @code{int (*)[]} parameter.  This option can be used to
5631 suppress such a warning.
5633 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5634 @opindex Wno-incompatible-pointer-types
5635 @opindex Wincompatible-pointer-types
5636 Do not warn when there is a conversion between pointers that have incompatible
5637 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5638 which warns for pointer argument passing or assignment with different
5639 signedness.
5641 @item -Wno-int-conversion @r{(C and Objective-C only)}
5642 @opindex Wno-int-conversion
5643 @opindex Wint-conversion
5644 Do not warn about incompatible integer to pointer and pointer to integer
5645 conversions.  This warning is about implicit conversions; for explicit
5646 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5647 @option{-Wno-pointer-to-int-cast} may be used.
5649 @item -Wno-div-by-zero
5650 @opindex Wno-div-by-zero
5651 @opindex Wdiv-by-zero
5652 Do not warn about compile-time integer division by zero.  Floating-point
5653 division by zero is not warned about, as it can be a legitimate way of
5654 obtaining infinities and NaNs.
5656 @item -Wsystem-headers
5657 @opindex Wsystem-headers
5658 @opindex Wno-system-headers
5659 @cindex warnings from system headers
5660 @cindex system headers, warnings from
5661 Print warning messages for constructs found in system header files.
5662 Warnings from system headers are normally suppressed, on the assumption
5663 that they usually do not indicate real problems and would only make the
5664 compiler output harder to read.  Using this command-line option tells
5665 GCC to emit warnings from system headers as if they occurred in user
5666 code.  However, note that using @option{-Wall} in conjunction with this
5667 option does @emph{not} warn about unknown pragmas in system
5668 headers---for that, @option{-Wunknown-pragmas} must also be used.
5670 @item -Wtautological-compare
5671 @opindex Wtautological-compare
5672 @opindex Wno-tautological-compare
5673 Warn if a self-comparison always evaluates to true or false.  This
5674 warning detects various mistakes such as:
5675 @smallexample
5676 int i = 1;
5677 @dots{}
5678 if (i > i) @{ @dots{} @}
5679 @end smallexample
5681 This warning also warns about bitwise comparisons that always evaluate
5682 to true or false, for instance:
5683 @smallexample
5684 if ((a & 16) == 10) @{ @dots{} @}
5685 @end smallexample
5686 will always be false.
5688 This warning is enabled by @option{-Wall}.
5690 @item -Wtrampolines
5691 @opindex Wtrampolines
5692 @opindex Wno-trampolines
5693 Warn about trampolines generated for pointers to nested functions.
5694 A trampoline is a small piece of data or code that is created at run
5695 time on the stack when the address of a nested function is taken, and is
5696 used to call the nested function indirectly.  For some targets, it is
5697 made up of data only and thus requires no special treatment.  But, for
5698 most targets, it is made up of code and thus requires the stack to be
5699 made executable in order for the program to work properly.
5701 @item -Wfloat-equal
5702 @opindex Wfloat-equal
5703 @opindex Wno-float-equal
5704 Warn if floating-point values are used in equality comparisons.
5706 The idea behind this is that sometimes it is convenient (for the
5707 programmer) to consider floating-point values as approximations to
5708 infinitely precise real numbers.  If you are doing this, then you need
5709 to compute (by analyzing the code, or in some other way) the maximum or
5710 likely maximum error that the computation introduces, and allow for it
5711 when performing comparisons (and when producing output, but that's a
5712 different problem).  In particular, instead of testing for equality, you
5713 should check to see whether the two values have ranges that overlap; and
5714 this is done with the relational operators, so equality comparisons are
5715 probably mistaken.
5717 @item -Wtraditional @r{(C and Objective-C only)}
5718 @opindex Wtraditional
5719 @opindex Wno-traditional
5720 Warn about certain constructs that behave differently in traditional and
5721 ISO C@.  Also warn about ISO C constructs that have no traditional C
5722 equivalent, and/or problematic constructs that should be avoided.
5724 @itemize @bullet
5725 @item
5726 Macro parameters that appear within string literals in the macro body.
5727 In traditional C macro replacement takes place within string literals,
5728 but in ISO C it does not.
5730 @item
5731 In traditional C, some preprocessor directives did not exist.
5732 Traditional preprocessors only considered a line to be a directive
5733 if the @samp{#} appeared in column 1 on the line.  Therefore
5734 @option{-Wtraditional} warns about directives that traditional C
5735 understands but ignores because the @samp{#} does not appear as the
5736 first character on the line.  It also suggests you hide directives like
5737 @code{#pragma} not understood by traditional C by indenting them.  Some
5738 traditional implementations do not recognize @code{#elif}, so this option
5739 suggests avoiding it altogether.
5741 @item
5742 A function-like macro that appears without arguments.
5744 @item
5745 The unary plus operator.
5747 @item
5748 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5749 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5750 constants.)  Note, these suffixes appear in macros defined in the system
5751 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5752 Use of these macros in user code might normally lead to spurious
5753 warnings, however GCC's integrated preprocessor has enough context to
5754 avoid warning in these cases.
5756 @item
5757 A function declared external in one block and then used after the end of
5758 the block.
5760 @item
5761 A @code{switch} statement has an operand of type @code{long}.
5763 @item
5764 A non-@code{static} function declaration follows a @code{static} one.
5765 This construct is not accepted by some traditional C compilers.
5767 @item
5768 The ISO type of an integer constant has a different width or
5769 signedness from its traditional type.  This warning is only issued if
5770 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5771 typically represent bit patterns, are not warned about.
5773 @item
5774 Usage of ISO string concatenation is detected.
5776 @item
5777 Initialization of automatic aggregates.
5779 @item
5780 Identifier conflicts with labels.  Traditional C lacks a separate
5781 namespace for labels.
5783 @item
5784 Initialization of unions.  If the initializer is zero, the warning is
5785 omitted.  This is done under the assumption that the zero initializer in
5786 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5787 initializer warnings and relies on default initialization to zero in the
5788 traditional C case.
5790 @item
5791 Conversions by prototypes between fixed/floating-point values and vice
5792 versa.  The absence of these prototypes when compiling with traditional
5793 C causes serious problems.  This is a subset of the possible
5794 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5796 @item
5797 Use of ISO C style function definitions.  This warning intentionally is
5798 @emph{not} issued for prototype declarations or variadic functions
5799 because these ISO C features appear in your code when using
5800 libiberty's traditional C compatibility macros, @code{PARAMS} and
5801 @code{VPARAMS}.  This warning is also bypassed for nested functions
5802 because that feature is already a GCC extension and thus not relevant to
5803 traditional C compatibility.
5804 @end itemize
5806 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5807 @opindex Wtraditional-conversion
5808 @opindex Wno-traditional-conversion
5809 Warn if a prototype causes a type conversion that is different from what
5810 would happen to the same argument in the absence of a prototype.  This
5811 includes conversions of fixed point to floating and vice versa, and
5812 conversions changing the width or signedness of a fixed-point argument
5813 except when the same as the default promotion.
5815 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5816 @opindex Wdeclaration-after-statement
5817 @opindex Wno-declaration-after-statement
5818 Warn when a declaration is found after a statement in a block.  This
5819 construct, known from C++, was introduced with ISO C99 and is by default
5820 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5822 @item -Wshadow
5823 @opindex Wshadow
5824 @opindex Wno-shadow
5825 Warn whenever a local variable or type declaration shadows another
5826 variable, parameter, type, class member (in C++), or instance variable
5827 (in Objective-C) or whenever a built-in function is shadowed. Note
5828 that in C++, the compiler warns if a local variable shadows an
5829 explicit typedef, but not if it shadows a struct/class/enum.
5830 Same as @option{-Wshadow=global}.
5832 @item -Wno-shadow-ivar @r{(Objective-C only)}
5833 @opindex Wno-shadow-ivar
5834 @opindex Wshadow-ivar
5835 Do not warn whenever a local variable shadows an instance variable in an
5836 Objective-C method.
5838 @item -Wshadow=global
5839 @opindex Wshadow=local
5840 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5842 @item -Wshadow=local
5843 @opindex Wshadow=local
5844 Warn when a local variable shadows another local variable or parameter.
5845 This warning is enabled by @option{-Wshadow=global}.
5847 @item -Wshadow=compatible-local
5848 @opindex Wshadow=compatible-local
5849 Warn when a local variable shadows another local variable or parameter
5850 whose type is compatible with that of the shadowing variable. In C++,
5851 type compatibility here means the type of the shadowing variable can be
5852 converted to that of the shadowed variable. The creation of this flag
5853 (in addition to @option{-Wshadow=local}) is based on the idea that when
5854 a local variable shadows another one of incompatible type, it is most
5855 likely intentional, not a bug or typo, as shown in the following example:
5857 @smallexample
5858 @group
5859 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5861   for (int i = 0; i < N; ++i)
5862   @{
5863     ...
5864   @}
5865   ...
5867 @end group
5868 @end smallexample
5870 Since the two variable @code{i} in the example above have incompatible types,
5871 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5872 Because their types are incompatible, if a programmer accidentally uses one
5873 in place of the other, type checking will catch that and emit an error or
5874 warning. So not warning (about shadowing) in this case will not lead to
5875 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5876 possibly reduce the number of warnings triggered by intentional shadowing.
5878 This warning is enabled by @option{-Wshadow=local}.
5880 @item -Wlarger-than=@var{len}
5881 @opindex Wlarger-than=@var{len}
5882 @opindex Wlarger-than-@var{len}
5883 Warn whenever an object of larger than @var{len} bytes is defined.
5885 @item -Wframe-larger-than=@var{len}
5886 @opindex Wframe-larger-than
5887 Warn if the size of a function frame is larger than @var{len} bytes.
5888 The computation done to determine the stack frame size is approximate
5889 and not conservative.
5890 The actual requirements may be somewhat greater than @var{len}
5891 even if you do not get a warning.  In addition, any space allocated
5892 via @code{alloca}, variable-length arrays, or related constructs
5893 is not included by the compiler when determining
5894 whether or not to issue a warning.
5896 @item -Wno-free-nonheap-object
5897 @opindex Wno-free-nonheap-object
5898 @opindex Wfree-nonheap-object
5899 Do not warn when attempting to free an object that was not allocated
5900 on the heap.
5902 @item -Wstack-usage=@var{len}
5903 @opindex Wstack-usage
5904 Warn if the stack usage of a function might be larger than @var{len} bytes.
5905 The computation done to determine the stack usage is conservative.
5906 Any space allocated via @code{alloca}, variable-length arrays, or related
5907 constructs is included by the compiler when determining whether or not to
5908 issue a warning.
5910 The message is in keeping with the output of @option{-fstack-usage}.
5912 @itemize
5913 @item
5914 If the stack usage is fully static but exceeds the specified amount, it's:
5916 @smallexample
5917   warning: stack usage is 1120 bytes
5918 @end smallexample
5919 @item
5920 If the stack usage is (partly) dynamic but bounded, it's:
5922 @smallexample
5923   warning: stack usage might be 1648 bytes
5924 @end smallexample
5925 @item
5926 If the stack usage is (partly) dynamic and not bounded, it's:
5928 @smallexample
5929   warning: stack usage might be unbounded
5930 @end smallexample
5931 @end itemize
5933 @item -Wunsafe-loop-optimizations
5934 @opindex Wunsafe-loop-optimizations
5935 @opindex Wno-unsafe-loop-optimizations
5936 Warn if the loop cannot be optimized because the compiler cannot
5937 assume anything on the bounds of the loop indices.  With
5938 @option{-funsafe-loop-optimizations} warn if the compiler makes
5939 such assumptions.
5941 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5942 @opindex Wno-pedantic-ms-format
5943 @opindex Wpedantic-ms-format
5944 When used in combination with @option{-Wformat}
5945 and @option{-pedantic} without GNU extensions, this option
5946 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5947 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5948 which depend on the MS runtime.
5950 @item -Waligned-new
5951 @opindex Waligned-new
5952 @opindex Wno-aligned-new
5953 Warn about a new-expression of a type that requires greater alignment
5954 than the @code{alignof(std::max_align_t)} but uses an allocation
5955 function without an explicit alignment parameter. This option is
5956 enabled by @option{-Wall}.
5958 Normally this only warns about global allocation functions, but
5959 @option{-Waligned-new=all} also warns about class member allocation
5960 functions.
5962 @item -Wplacement-new
5963 @itemx -Wplacement-new=@var{n}
5964 @opindex Wplacement-new
5965 @opindex Wno-placement-new
5966 Warn about placement new expressions with undefined behavior, such as
5967 constructing an object in a buffer that is smaller than the type of
5968 the object.  For example, the placement new expression below is diagnosed
5969 because it attempts to construct an array of 64 integers in a buffer only
5970 64 bytes large.
5971 @smallexample
5972 char buf [64];
5973 new (buf) int[64];
5974 @end smallexample
5975 This warning is enabled by default.
5977 @table @gcctabopt
5978 @item -Wplacement-new=1
5979 This is the default warning level of @option{-Wplacement-new}.  At this
5980 level the warning is not issued for some strictly undefined constructs that
5981 GCC allows as extensions for compatibility with legacy code.  For example,
5982 the following @code{new} expression is not diagnosed at this level even
5983 though it has undefined behavior according to the C++ standard because
5984 it writes past the end of the one-element array.
5985 @smallexample
5986 struct S @{ int n, a[1]; @};
5987 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5988 new (s->a)int [32]();
5989 @end smallexample
5991 @item -Wplacement-new=2
5992 At this level, in addition to diagnosing all the same constructs as at level
5993 1, a diagnostic is also issued for placement new expressions that construct
5994 an object in the last member of structure whose type is an array of a single
5995 element and whose size is less than the size of the object being constructed.
5996 While the previous example would be diagnosed, the following construct makes
5997 use of the flexible member array extension to avoid the warning at level 2.
5998 @smallexample
5999 struct S @{ int n, a[]; @};
6000 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6001 new (s->a)int [32]();
6002 @end smallexample
6004 @end table
6006 @item -Wpointer-arith
6007 @opindex Wpointer-arith
6008 @opindex Wno-pointer-arith
6009 Warn about anything that depends on the ``size of'' a function type or
6010 of @code{void}.  GNU C assigns these types a size of 1, for
6011 convenience in calculations with @code{void *} pointers and pointers
6012 to functions.  In C++, warn also when an arithmetic operation involves
6013 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6015 @item -Wpointer-compare
6016 @opindex Wpointer-compare
6017 @opindex Wno-pointer-compare
6018 Warn if a pointer is compared with a zero character constant.  This usually
6019 means that the pointer was meant to be dereferenced.  For example:
6021 @smallexample
6022 const char *p = foo ();
6023 if (p == '\0')
6024   return 42;
6025 @end smallexample
6027 Note that the code above is invalid in C++11.
6029 This warning is enabled by default.
6031 @item -Wtype-limits
6032 @opindex Wtype-limits
6033 @opindex Wno-type-limits
6034 Warn if a comparison is always true or always false due to the limited
6035 range of the data type, but do not warn for constant expressions.  For
6036 example, warn if an unsigned variable is compared against zero with
6037 @code{<} or @code{>=}.  This warning is also enabled by
6038 @option{-Wextra}.
6040 @include cppwarnopts.texi
6042 @item -Wbad-function-cast @r{(C and Objective-C only)}
6043 @opindex Wbad-function-cast
6044 @opindex Wno-bad-function-cast
6045 Warn when a function call is cast to a non-matching type.
6046 For example, warn if a call to a function returning an integer type 
6047 is cast to a pointer type.
6049 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6050 @opindex Wc90-c99-compat
6051 @opindex Wno-c90-c99-compat
6052 Warn about features not present in ISO C90, but present in ISO C99.
6053 For instance, warn about use of variable length arrays, @code{long long}
6054 type, @code{bool} type, compound literals, designated initializers, and so
6055 on.  This option is independent of the standards mode.  Warnings are disabled
6056 in the expression that follows @code{__extension__}.
6058 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6059 @opindex Wc99-c11-compat
6060 @opindex Wno-c99-c11-compat
6061 Warn about features not present in ISO C99, but present in ISO C11.
6062 For instance, warn about use of anonymous structures and unions,
6063 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6064 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6065 and so on.  This option is independent of the standards mode.  Warnings are
6066 disabled in the expression that follows @code{__extension__}.
6068 @item -Wc++-compat @r{(C and Objective-C only)}
6069 @opindex Wc++-compat
6070 Warn about ISO C constructs that are outside of the common subset of
6071 ISO C and ISO C++, e.g.@: request for implicit conversion from
6072 @code{void *} to a pointer to non-@code{void} type.
6074 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6075 @opindex Wc++11-compat
6076 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6077 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6078 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6079 enabled by @option{-Wall}.
6081 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6082 @opindex Wc++14-compat
6083 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6084 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6086 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6087 @opindex Wc++17-compat
6088 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6089 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6091 @item -Wcast-qual
6092 @opindex Wcast-qual
6093 @opindex Wno-cast-qual
6094 Warn whenever a pointer is cast so as to remove a type qualifier from
6095 the target type.  For example, warn if a @code{const char *} is cast
6096 to an ordinary @code{char *}.
6098 Also warn when making a cast that introduces a type qualifier in an
6099 unsafe way.  For example, casting @code{char **} to @code{const char **}
6100 is unsafe, as in this example:
6102 @smallexample
6103   /* p is char ** value.  */
6104   const char **q = (const char **) p;
6105   /* Assignment of readonly string to const char * is OK.  */
6106   *q = "string";
6107   /* Now char** pointer points to read-only memory.  */
6108   **p = 'b';
6109 @end smallexample
6111 @item -Wcast-align
6112 @opindex Wcast-align
6113 @opindex Wno-cast-align
6114 Warn whenever a pointer is cast such that the required alignment of the
6115 target is increased.  For example, warn if a @code{char *} is cast to
6116 an @code{int *} on machines where integers can only be accessed at
6117 two- or four-byte boundaries.
6119 @item -Wcast-align=strict
6120 @opindex Wcast-align=strict
6121 Warn whenever a pointer is cast such that the required alignment of the
6122 target is increased.  For example, warn if a @code{char *} is cast to
6123 an @code{int *} regardless of the target machine.
6125 @item -Wcast-function-type
6126 @opindex Wcast-function-type
6127 @opindex Wno-cast-function-type
6128 Warn when a function pointer is cast to an incompatible function pointer.
6129 In a cast involving function types with a variable argument list only
6130 the types of initial arguments that are provided are considered.
6131 Any parameter of pointer-type matches any other pointer-type.  Any benign
6132 differences in integral types are ignored, like @code{int} vs. @code{long}
6133 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6134 type @code{void (*) (void)} is special and matches everything, which can
6135 be used to suppress this warning.
6136 In a cast involving pointer to member types this warning warns whenever
6137 the type cast is changing the pointer to member type.
6138 This warning is enabled by @option{-Wextra}.
6140 @item -Wwrite-strings
6141 @opindex Wwrite-strings
6142 @opindex Wno-write-strings
6143 When compiling C, give string constants the type @code{const
6144 char[@var{length}]} so that copying the address of one into a
6145 non-@code{const} @code{char *} pointer produces a warning.  These
6146 warnings help you find at compile time code that can try to write
6147 into a string constant, but only if you have been very careful about
6148 using @code{const} in declarations and prototypes.  Otherwise, it is
6149 just a nuisance. This is why we did not make @option{-Wall} request
6150 these warnings.
6152 When compiling C++, warn about the deprecated conversion from string
6153 literals to @code{char *}.  This warning is enabled by default for C++
6154 programs.
6156 @item -Wcatch-value
6157 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6158 @opindex Wcatch-value
6159 @opindex Wno-catch-value
6160 Warn about catch handlers that do not catch via reference.
6161 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6162 warn about polymorphic class types that are caught by value.
6163 With @option{-Wcatch-value=2} warn about all class types that are caught
6164 by value. With @option{-Wcatch-value=3} warn about all types that are
6165 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6167 @item -Wclobbered
6168 @opindex Wclobbered
6169 @opindex Wno-clobbered
6170 Warn for variables that might be changed by @code{longjmp} or
6171 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6173 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6174 @opindex Wconditionally-supported
6175 @opindex Wno-conditionally-supported
6176 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6178 @item -Wconversion
6179 @opindex Wconversion
6180 @opindex Wno-conversion
6181 Warn for implicit conversions that may alter a value. This includes
6182 conversions between real and integer, like @code{abs (x)} when
6183 @code{x} is @code{double}; conversions between signed and unsigned,
6184 like @code{unsigned ui = -1}; and conversions to smaller types, like
6185 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6186 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6187 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6188 conversions between signed and unsigned integers can be disabled by
6189 using @option{-Wno-sign-conversion}.
6191 For C++, also warn for confusing overload resolution for user-defined
6192 conversions; and conversions that never use a type conversion
6193 operator: conversions to @code{void}, the same type, a base class or a
6194 reference to them. Warnings about conversions between signed and
6195 unsigned integers are disabled by default in C++ unless
6196 @option{-Wsign-conversion} is explicitly enabled.
6198 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6199 @opindex Wconversion-null
6200 @opindex Wno-conversion-null
6201 Do not warn for conversions between @code{NULL} and non-pointer
6202 types. @option{-Wconversion-null} is enabled by default.
6204 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6205 @opindex Wzero-as-null-pointer-constant
6206 @opindex Wno-zero-as-null-pointer-constant
6207 Warn when a literal @samp{0} is used as null pointer constant.  This can
6208 be useful to facilitate the conversion to @code{nullptr} in C++11.
6210 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6211 @opindex Wsubobject-linkage
6212 @opindex Wno-subobject-linkage
6213 Warn if a class type has a base or a field whose type uses the anonymous
6214 namespace or depends on a type with no linkage.  If a type A depends on
6215 a type B with no or internal linkage, defining it in multiple
6216 translation units would be an ODR violation because the meaning of B
6217 is different in each translation unit.  If A only appears in a single
6218 translation unit, the best way to silence the warning is to give it
6219 internal linkage by putting it in an anonymous namespace as well.  The
6220 compiler doesn't give this warning for types defined in the main .C
6221 file, as those are unlikely to have multiple definitions.
6222 @option{-Wsubobject-linkage} is enabled by default.
6224 @item -Wdangling-else
6225 @opindex Wdangling-else
6226 @opindex Wno-dangling-else
6227 Warn about constructions where there may be confusion to which
6228 @code{if} statement an @code{else} branch belongs.  Here is an example of
6229 such a case:
6231 @smallexample
6232 @group
6234   if (a)
6235     if (b)
6236       foo ();
6237   else
6238     bar ();
6240 @end group
6241 @end smallexample
6243 In C/C++, every @code{else} branch belongs to the innermost possible
6244 @code{if} statement, which in this example is @code{if (b)}.  This is
6245 often not what the programmer expected, as illustrated in the above
6246 example by indentation the programmer chose.  When there is the
6247 potential for this confusion, GCC issues a warning when this flag
6248 is specified.  To eliminate the warning, add explicit braces around
6249 the innermost @code{if} statement so there is no way the @code{else}
6250 can belong to the enclosing @code{if}.  The resulting code
6251 looks like this:
6253 @smallexample
6254 @group
6256   if (a)
6257     @{
6258       if (b)
6259         foo ();
6260       else
6261         bar ();
6262     @}
6264 @end group
6265 @end smallexample
6267 This warning is enabled by @option{-Wparentheses}.
6269 @item -Wdate-time
6270 @opindex Wdate-time
6271 @opindex Wno-date-time
6272 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6273 are encountered as they might prevent bit-wise-identical reproducible
6274 compilations.
6276 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6277 @opindex Wdelete-incomplete
6278 @opindex Wno-delete-incomplete
6279 Warn when deleting a pointer to incomplete type, which may cause
6280 undefined behavior at runtime.  This warning is enabled by default.
6282 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6283 @opindex Wuseless-cast
6284 @opindex Wno-useless-cast
6285 Warn when an expression is casted to its own type.
6287 @item -Wempty-body
6288 @opindex Wempty-body
6289 @opindex Wno-empty-body
6290 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6291 while} statement.  This warning is also enabled by @option{-Wextra}.
6293 @item -Wenum-compare
6294 @opindex Wenum-compare
6295 @opindex Wno-enum-compare
6296 Warn about a comparison between values of different enumerated types.
6297 In C++ enumerated type mismatches in conditional expressions are also
6298 diagnosed and the warning is enabled by default.  In C this warning is 
6299 enabled by @option{-Wall}.
6301 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6302 @opindex Wextra-semi
6303 @opindex Wno-extra-semi
6304 Warn about redundant semicolon after in-class function definition.
6306 @item -Wjump-misses-init @r{(C, Objective-C only)}
6307 @opindex Wjump-misses-init
6308 @opindex Wno-jump-misses-init
6309 Warn if a @code{goto} statement or a @code{switch} statement jumps
6310 forward across the initialization of a variable, or jumps backward to a
6311 label after the variable has been initialized.  This only warns about
6312 variables that are initialized when they are declared.  This warning is
6313 only supported for C and Objective-C; in C++ this sort of branch is an
6314 error in any case.
6316 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6317 can be disabled with the @option{-Wno-jump-misses-init} option.
6319 @item -Wsign-compare
6320 @opindex Wsign-compare
6321 @opindex Wno-sign-compare
6322 @cindex warning for comparison of signed and unsigned values
6323 @cindex comparison of signed and unsigned values, warning
6324 @cindex signed and unsigned values, comparison warning
6325 Warn when a comparison between signed and unsigned values could produce
6326 an incorrect result when the signed value is converted to unsigned.
6327 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6328 also enabled by @option{-Wextra}.
6330 @item -Wsign-conversion
6331 @opindex Wsign-conversion
6332 @opindex Wno-sign-conversion
6333 Warn for implicit conversions that may change the sign of an integer
6334 value, like assigning a signed integer expression to an unsigned
6335 integer variable. An explicit cast silences the warning. In C, this
6336 option is enabled also by @option{-Wconversion}.
6338 @item -Wfloat-conversion
6339 @opindex Wfloat-conversion
6340 @opindex Wno-float-conversion
6341 Warn for implicit conversions that reduce the precision of a real value.
6342 This includes conversions from real to integer, and from higher precision
6343 real to lower precision real values.  This option is also enabled by
6344 @option{-Wconversion}.
6346 @item -Wno-scalar-storage-order
6347 @opindex -Wno-scalar-storage-order
6348 @opindex -Wscalar-storage-order
6349 Do not warn on suspicious constructs involving reverse scalar storage order.
6351 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6352 @opindex Wsized-deallocation
6353 @opindex Wno-sized-deallocation
6354 Warn about a definition of an unsized deallocation function
6355 @smallexample
6356 void operator delete (void *) noexcept;
6357 void operator delete[] (void *) noexcept;
6358 @end smallexample
6359 without a definition of the corresponding sized deallocation function
6360 @smallexample
6361 void operator delete (void *, std::size_t) noexcept;
6362 void operator delete[] (void *, std::size_t) noexcept;
6363 @end smallexample
6364 or vice versa.  Enabled by @option{-Wextra} along with
6365 @option{-fsized-deallocation}.
6367 @item -Wsizeof-pointer-div
6368 @opindex Wsizeof-pointer-div
6369 @opindex Wno-sizeof-pointer-div
6370 Warn for suspicious divisions of two sizeof expressions that divide
6371 the pointer size by the element size, which is the usual way to compute
6372 the array size but won't work out correctly with pointers.  This warning
6373 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6374 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6376 @item -Wsizeof-pointer-memaccess
6377 @opindex Wsizeof-pointer-memaccess
6378 @opindex Wno-sizeof-pointer-memaccess
6379 Warn for suspicious length parameters to certain string and memory built-in
6380 functions if the argument uses @code{sizeof}.  This warning triggers for
6381 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6382 an array, but a pointer, and suggests a possible fix, or about
6383 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6384 also warns about calls to bounded string copy functions like @code{strncat}
6385 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6386 the source array.  For example, in the following function the call to
6387 @code{strncat} specifies the size of the source string as the bound.  That
6388 is almost certainly a mistake and so the call is diagnosed.
6389 @smallexample
6390 void make_file (const char *name)
6392   char path[PATH_MAX];
6393   strncpy (path, name, sizeof path - 1);
6394   strncat (path, ".text", sizeof ".text");
6395   @dots{}
6397 @end smallexample
6399 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6401 @item -Wsizeof-array-argument
6402 @opindex Wsizeof-array-argument
6403 @opindex Wno-sizeof-array-argument
6404 Warn when the @code{sizeof} operator is applied to a parameter that is
6405 declared as an array in a function definition.  This warning is enabled by
6406 default for C and C++ programs.
6408 @item -Wmemset-elt-size
6409 @opindex Wmemset-elt-size
6410 @opindex Wno-memset-elt-size
6411 Warn for suspicious calls to the @code{memset} built-in function, if the
6412 first argument references an array, and the third argument is a number
6413 equal to the number of elements, but not equal to the size of the array
6414 in memory.  This indicates that the user has omitted a multiplication by
6415 the element size.  This warning is enabled by @option{-Wall}.
6417 @item -Wmemset-transposed-args
6418 @opindex Wmemset-transposed-args
6419 @opindex Wno-memset-transposed-args
6420 Warn for suspicious calls to the @code{memset} built-in function, if the
6421 second argument is not zero and the third argument is zero.  This warns e.g.@
6422 about @code{memset (buf, sizeof buf, 0)} where most probably
6423 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6424 is only emitted if the third argument is literal zero.  If it is some
6425 expression that is folded to zero, a cast of zero to some type, etc., 
6426 it is far less likely that the user has mistakenly exchanged the arguments 
6427 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6429 @item -Waddress
6430 @opindex Waddress
6431 @opindex Wno-address
6432 Warn about suspicious uses of memory addresses. These include using
6433 the address of a function in a conditional expression, such as
6434 @code{void func(void); if (func)}, and comparisons against the memory
6435 address of a string literal, such as @code{if (x == "abc")}.  Such
6436 uses typically indicate a programmer error: the address of a function
6437 always evaluates to true, so their use in a conditional usually
6438 indicate that the programmer forgot the parentheses in a function
6439 call; and comparisons against string literals result in unspecified
6440 behavior and are not portable in C, so they usually indicate that the
6441 programmer intended to use @code{strcmp}.  This warning is enabled by
6442 @option{-Wall}.
6444 @item -Wlogical-op
6445 @opindex Wlogical-op
6446 @opindex Wno-logical-op
6447 Warn about suspicious uses of logical operators in expressions.
6448 This includes using logical operators in contexts where a
6449 bit-wise operator is likely to be expected.  Also warns when
6450 the operands of a logical operator are the same:
6451 @smallexample
6452 extern int a;
6453 if (a < 0 && a < 0) @{ @dots{} @}
6454 @end smallexample
6456 @item -Wlogical-not-parentheses
6457 @opindex Wlogical-not-parentheses
6458 @opindex Wno-logical-not-parentheses
6459 Warn about logical not used on the left hand side operand of a comparison.
6460 This option does not warn if the right operand is considered to be a boolean
6461 expression.  Its purpose is to detect suspicious code like the following:
6462 @smallexample
6463 int a;
6464 @dots{}
6465 if (!a > 1) @{ @dots{} @}
6466 @end smallexample
6468 It is possible to suppress the warning by wrapping the LHS into
6469 parentheses:
6470 @smallexample
6471 if ((!a) > 1) @{ @dots{} @}
6472 @end smallexample
6474 This warning is enabled by @option{-Wall}.
6476 @item -Waggregate-return
6477 @opindex Waggregate-return
6478 @opindex Wno-aggregate-return
6479 Warn if any functions that return structures or unions are defined or
6480 called.  (In languages where you can return an array, this also elicits
6481 a warning.)
6483 @item -Wno-aggressive-loop-optimizations
6484 @opindex Wno-aggressive-loop-optimizations
6485 @opindex Waggressive-loop-optimizations
6486 Warn if in a loop with constant number of iterations the compiler detects
6487 undefined behavior in some statement during one or more of the iterations.
6489 @item -Wno-attributes
6490 @opindex Wno-attributes
6491 @opindex Wattributes
6492 Do not warn if an unexpected @code{__attribute__} is used, such as
6493 unrecognized attributes, function attributes applied to variables,
6494 etc.  This does not stop errors for incorrect use of supported
6495 attributes.
6497 @item -Wno-builtin-declaration-mismatch
6498 @opindex Wno-builtin-declaration-mismatch
6499 @opindex Wbuiltin-declaration-mismatch
6500 Warn if a built-in function is declared with the wrong signature or 
6501 as non-function.
6502 This warning is enabled by default.
6504 @item -Wno-builtin-macro-redefined
6505 @opindex Wno-builtin-macro-redefined
6506 @opindex Wbuiltin-macro-redefined
6507 Do not warn if certain built-in macros are redefined.  This suppresses
6508 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6509 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6511 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6512 @opindex Wstrict-prototypes
6513 @opindex Wno-strict-prototypes
6514 Warn if a function is declared or defined without specifying the
6515 argument types.  (An old-style function definition is permitted without
6516 a warning if preceded by a declaration that specifies the argument
6517 types.)
6519 @item -Wold-style-declaration @r{(C and Objective-C only)}
6520 @opindex Wold-style-declaration
6521 @opindex Wno-old-style-declaration
6522 Warn for obsolescent usages, according to the C Standard, in a
6523 declaration. For example, warn if storage-class specifiers like
6524 @code{static} are not the first things in a declaration.  This warning
6525 is also enabled by @option{-Wextra}.
6527 @item -Wold-style-definition @r{(C and Objective-C only)}
6528 @opindex Wold-style-definition
6529 @opindex Wno-old-style-definition
6530 Warn if an old-style function definition is used.  A warning is given
6531 even if there is a previous prototype.
6533 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6534 @opindex Wmissing-parameter-type
6535 @opindex Wno-missing-parameter-type
6536 A function parameter is declared without a type specifier in K&R-style
6537 functions:
6539 @smallexample
6540 void foo(bar) @{ @}
6541 @end smallexample
6543 This warning is also enabled by @option{-Wextra}.
6545 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6546 @opindex Wmissing-prototypes
6547 @opindex Wno-missing-prototypes
6548 Warn if a global function is defined without a previous prototype
6549 declaration.  This warning is issued even if the definition itself
6550 provides a prototype.  Use this option to detect global functions
6551 that do not have a matching prototype declaration in a header file.
6552 This option is not valid for C++ because all function declarations
6553 provide prototypes and a non-matching declaration declares an
6554 overload rather than conflict with an earlier declaration.
6555 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6557 @item -Wmissing-declarations
6558 @opindex Wmissing-declarations
6559 @opindex Wno-missing-declarations
6560 Warn if a global function is defined without a previous declaration.
6561 Do so even if the definition itself provides a prototype.
6562 Use this option to detect global functions that are not declared in
6563 header files.  In C, no warnings are issued for functions with previous
6564 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6565 missing prototypes.  In C++, no warnings are issued for function templates,
6566 or for inline functions, or for functions in anonymous namespaces.
6568 @item -Wmissing-field-initializers
6569 @opindex Wmissing-field-initializers
6570 @opindex Wno-missing-field-initializers
6571 @opindex W
6572 @opindex Wextra
6573 @opindex Wno-extra
6574 Warn if a structure's initializer has some fields missing.  For
6575 example, the following code causes such a warning, because
6576 @code{x.h} is implicitly zero:
6578 @smallexample
6579 struct s @{ int f, g, h; @};
6580 struct s x = @{ 3, 4 @};
6581 @end smallexample
6583 This option does not warn about designated initializers, so the following
6584 modification does not trigger a warning:
6586 @smallexample
6587 struct s @{ int f, g, h; @};
6588 struct s x = @{ .f = 3, .g = 4 @};
6589 @end smallexample
6591 In C this option does not warn about the universal zero initializer
6592 @samp{@{ 0 @}}:
6594 @smallexample
6595 struct s @{ int f, g, h; @};
6596 struct s x = @{ 0 @};
6597 @end smallexample
6599 Likewise, in C++ this option does not warn about the empty @{ @}
6600 initializer, for example:
6602 @smallexample
6603 struct s @{ int f, g, h; @};
6604 s x = @{ @};
6605 @end smallexample
6607 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6608 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6610 @item -Wno-multichar
6611 @opindex Wno-multichar
6612 @opindex Wmultichar
6613 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6614 Usually they indicate a typo in the user's code, as they have
6615 implementation-defined values, and should not be used in portable code.
6617 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6618 @opindex Wnormalized=
6619 @opindex Wnormalized
6620 @opindex Wno-normalized
6621 @cindex NFC
6622 @cindex NFKC
6623 @cindex character set, input normalization
6624 In ISO C and ISO C++, two identifiers are different if they are
6625 different sequences of characters.  However, sometimes when characters
6626 outside the basic ASCII character set are used, you can have two
6627 different character sequences that look the same.  To avoid confusion,
6628 the ISO 10646 standard sets out some @dfn{normalization rules} which
6629 when applied ensure that two sequences that look the same are turned into
6630 the same sequence.  GCC can warn you if you are using identifiers that
6631 have not been normalized; this option controls that warning.
6633 There are four levels of warning supported by GCC@.  The default is
6634 @option{-Wnormalized=nfc}, which warns about any identifier that is
6635 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6636 recommended form for most uses.  It is equivalent to
6637 @option{-Wnormalized}.
6639 Unfortunately, there are some characters allowed in identifiers by
6640 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6641 identifiers.  That is, there's no way to use these symbols in portable
6642 ISO C or C++ and have all your identifiers in NFC@.
6643 @option{-Wnormalized=id} suppresses the warning for these characters.
6644 It is hoped that future versions of the standards involved will correct
6645 this, which is why this option is not the default.
6647 You can switch the warning off for all characters by writing
6648 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6649 only do this if you are using some other normalization scheme (like
6650 ``D''), because otherwise you can easily create bugs that are
6651 literally impossible to see.
6653 Some characters in ISO 10646 have distinct meanings but look identical
6654 in some fonts or display methodologies, especially once formatting has
6655 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6656 LETTER N'', displays just like a regular @code{n} that has been
6657 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6658 normalization scheme to convert all these into a standard form as
6659 well, and GCC warns if your code is not in NFKC if you use
6660 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6661 about every identifier that contains the letter O because it might be
6662 confused with the digit 0, and so is not the default, but may be
6663 useful as a local coding convention if the programming environment 
6664 cannot be fixed to display these characters distinctly.
6666 @item -Wno-deprecated
6667 @opindex Wno-deprecated
6668 @opindex Wdeprecated
6669 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6671 @item -Wno-deprecated-declarations
6672 @opindex Wno-deprecated-declarations
6673 @opindex Wdeprecated-declarations
6674 Do not warn about uses of functions (@pxref{Function Attributes}),
6675 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6676 Attributes}) marked as deprecated by using the @code{deprecated}
6677 attribute.
6679 @item -Wno-overflow
6680 @opindex Wno-overflow
6681 @opindex Woverflow
6682 Do not warn about compile-time overflow in constant expressions.
6684 @item -Wno-odr
6685 @opindex Wno-odr
6686 @opindex Wodr
6687 Warn about One Definition Rule violations during link-time optimization.
6688 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6690 @item -Wopenmp-simd
6691 @opindex Wopenm-simd
6692 Warn if the vectorizer cost model overrides the OpenMP
6693 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6694 option can be used to relax the cost model.
6696 @item -Woverride-init @r{(C and Objective-C only)}
6697 @opindex Woverride-init
6698 @opindex Wno-override-init
6699 @opindex W
6700 @opindex Wextra
6701 @opindex Wno-extra
6702 Warn if an initialized field without side effects is overridden when
6703 using designated initializers (@pxref{Designated Inits, , Designated
6704 Initializers}).
6706 This warning is included in @option{-Wextra}.  To get other
6707 @option{-Wextra} warnings without this one, use @option{-Wextra
6708 -Wno-override-init}.
6710 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6711 @opindex Woverride-init-side-effects
6712 @opindex Wno-override-init-side-effects
6713 Warn if an initialized field with side effects is overridden when
6714 using designated initializers (@pxref{Designated Inits, , Designated
6715 Initializers}).  This warning is enabled by default.
6717 @item -Wpacked
6718 @opindex Wpacked
6719 @opindex Wno-packed
6720 Warn if a structure is given the packed attribute, but the packed
6721 attribute has no effect on the layout or size of the structure.
6722 Such structures may be mis-aligned for little benefit.  For
6723 instance, in this code, the variable @code{f.x} in @code{struct bar}
6724 is misaligned even though @code{struct bar} does not itself
6725 have the packed attribute:
6727 @smallexample
6728 @group
6729 struct foo @{
6730   int x;
6731   char a, b, c, d;
6732 @} __attribute__((packed));
6733 struct bar @{
6734   char z;
6735   struct foo f;
6737 @end group
6738 @end smallexample
6740 @item -Wpacked-bitfield-compat
6741 @opindex Wpacked-bitfield-compat
6742 @opindex Wno-packed-bitfield-compat
6743 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6744 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6745 the change can lead to differences in the structure layout.  GCC
6746 informs you when the offset of such a field has changed in GCC 4.4.
6747 For example there is no longer a 4-bit padding between field @code{a}
6748 and @code{b} in this structure:
6750 @smallexample
6751 struct foo
6753   char a:4;
6754   char b:8;
6755 @} __attribute__ ((packed));
6756 @end smallexample
6758 This warning is enabled by default.  Use
6759 @option{-Wno-packed-bitfield-compat} to disable this warning.
6761 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6762 @opindex Wpacked-not-aligned
6763 @opindex Wno-packed-not-aligned
6764 Warn if a structure field with explicitly specified alignment in a
6765 packed struct or union is misaligned.  For example, a warning will
6766 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6767 'struct S' is less than 8}, in this code:
6769 @smallexample
6770 @group
6771 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6772 struct __attribute__ ((packed)) S @{
6773   struct S8 s8;
6775 @end group
6776 @end smallexample
6778 This warning is enabled by @option{-Wall}.
6780 @item -Wpadded
6781 @opindex Wpadded
6782 @opindex Wno-padded
6783 Warn if padding is included in a structure, either to align an element
6784 of the structure or to align the whole structure.  Sometimes when this
6785 happens it is possible to rearrange the fields of the structure to
6786 reduce the padding and so make the structure smaller.
6788 @item -Wredundant-decls
6789 @opindex Wredundant-decls
6790 @opindex Wno-redundant-decls
6791 Warn if anything is declared more than once in the same scope, even in
6792 cases where multiple declaration is valid and changes nothing.
6794 @item -Wno-restrict
6795 @opindex Wrestrict
6796 @opindex Wno-restrict
6797 Warn when an object referenced by a @code{restrict}-qualified parameter
6798 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6799 argument, or when copies between such objects overlap.  For example,
6800 the call to the @code{strcpy} function below attempts to truncate the string
6801 by replacing its initial characters with the last four.  However, because
6802 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6803 the call is diagnosed.
6805 @smallexample
6806 void foo (void)
6808   char a[] = "abcd1234";
6809   strcpy (a, a + 4);
6810   @dots{}
6812 @end smallexample
6813 The @option{-Wrestrict} option detects some instances of simple overlap
6814 even without optimization but works best at @option{-O2} and above.  It
6815 is included in @option{-Wall}.
6817 @item -Wnested-externs @r{(C and Objective-C only)}
6818 @opindex Wnested-externs
6819 @opindex Wno-nested-externs
6820 Warn if an @code{extern} declaration is encountered within a function.
6822 @item -Wno-inherited-variadic-ctor
6823 @opindex Winherited-variadic-ctor
6824 @opindex Wno-inherited-variadic-ctor
6825 Suppress warnings about use of C++11 inheriting constructors when the
6826 base class inherited from has a C variadic constructor; the warning is
6827 on by default because the ellipsis is not inherited.
6829 @item -Winline
6830 @opindex Winline
6831 @opindex Wno-inline
6832 Warn if a function that is declared as inline cannot be inlined.
6833 Even with this option, the compiler does not warn about failures to
6834 inline functions declared in system headers.
6836 The compiler uses a variety of heuristics to determine whether or not
6837 to inline a function.  For example, the compiler takes into account
6838 the size of the function being inlined and the amount of inlining
6839 that has already been done in the current function.  Therefore,
6840 seemingly insignificant changes in the source program can cause the
6841 warnings produced by @option{-Winline} to appear or disappear.
6843 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6844 @opindex Wno-invalid-offsetof
6845 @opindex Winvalid-offsetof
6846 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6847 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6848 to a non-standard-layout type is undefined.  In existing C++ implementations,
6849 however, @code{offsetof} typically gives meaningful results.
6850 This flag is for users who are aware that they are
6851 writing nonportable code and who have deliberately chosen to ignore the
6852 warning about it.
6854 The restrictions on @code{offsetof} may be relaxed in a future version
6855 of the C++ standard.
6857 @item -Wint-in-bool-context
6858 @opindex Wint-in-bool-context
6859 @opindex Wno-int-in-bool-context
6860 Warn for suspicious use of integer values where boolean values are expected,
6861 such as conditional expressions (?:) using non-boolean integer constants in
6862 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6863 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6864 for all kinds of multiplications regardless of the data type.
6865 This warning is enabled by @option{-Wall}.
6867 @item -Wno-int-to-pointer-cast
6868 @opindex Wno-int-to-pointer-cast
6869 @opindex Wint-to-pointer-cast
6870 Suppress warnings from casts to pointer type of an integer of a
6871 different size. In C++, casting to a pointer type of smaller size is
6872 an error. @option{Wint-to-pointer-cast} is enabled by default.
6875 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6876 @opindex Wno-pointer-to-int-cast
6877 @opindex Wpointer-to-int-cast
6878 Suppress warnings from casts from a pointer to an integer type of a
6879 different size.
6881 @item -Winvalid-pch
6882 @opindex Winvalid-pch
6883 @opindex Wno-invalid-pch
6884 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6885 the search path but cannot be used.
6887 @item -Wlong-long
6888 @opindex Wlong-long
6889 @opindex Wno-long-long
6890 Warn if @code{long long} type is used.  This is enabled by either
6891 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6892 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6894 @item -Wvariadic-macros
6895 @opindex Wvariadic-macros
6896 @opindex Wno-variadic-macros
6897 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6898 alternate syntax is used in ISO C99 mode.  This is enabled by either
6899 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6900 messages, use @option{-Wno-variadic-macros}.
6902 @item -Wvarargs
6903 @opindex Wvarargs
6904 @opindex Wno-varargs
6905 Warn upon questionable usage of the macros used to handle variable
6906 arguments like @code{va_start}.  This is default.  To inhibit the
6907 warning messages, use @option{-Wno-varargs}.
6909 @item -Wvector-operation-performance
6910 @opindex Wvector-operation-performance
6911 @opindex Wno-vector-operation-performance
6912 Warn if vector operation is not implemented via SIMD capabilities of the
6913 architecture.  Mainly useful for the performance tuning.
6914 Vector operation can be implemented @code{piecewise}, which means that the
6915 scalar operation is performed on every vector element; 
6916 @code{in parallel}, which means that the vector operation is implemented
6917 using scalars of wider type, which normally is more performance efficient;
6918 and @code{as a single scalar}, which means that vector fits into a
6919 scalar type.
6921 @item -Wno-virtual-move-assign
6922 @opindex Wvirtual-move-assign
6923 @opindex Wno-virtual-move-assign
6924 Suppress warnings about inheriting from a virtual base with a
6925 non-trivial C++11 move assignment operator.  This is dangerous because
6926 if the virtual base is reachable along more than one path, it is
6927 moved multiple times, which can mean both objects end up in the
6928 moved-from state.  If the move assignment operator is written to avoid
6929 moving from a moved-from object, this warning can be disabled.
6931 @item -Wvla
6932 @opindex Wvla
6933 @opindex Wno-vla
6934 Warn if a variable-length array is used in the code.
6935 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6936 the variable-length array.
6938 @item -Wvla-larger-than=@var{n}
6939 If this option is used, the compiler will warn on uses of
6940 variable-length arrays where the size is either unbounded, or bounded
6941 by an argument that can be larger than @var{n} bytes.  This is similar
6942 to how @option{-Walloca-larger-than=@var{n}} works, but with
6943 variable-length arrays.
6945 Note that GCC may optimize small variable-length arrays of a known
6946 value into plain arrays, so this warning may not get triggered for
6947 such arrays.
6949 This warning is not enabled by @option{-Wall}, and is only active when
6950 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6952 See also @option{-Walloca-larger-than=@var{n}}.
6954 @item -Wvolatile-register-var
6955 @opindex Wvolatile-register-var
6956 @opindex Wno-volatile-register-var
6957 Warn if a register variable is declared volatile.  The volatile
6958 modifier does not inhibit all optimizations that may eliminate reads
6959 and/or writes to register variables.  This warning is enabled by
6960 @option{-Wall}.
6962 @item -Wdisabled-optimization
6963 @opindex Wdisabled-optimization
6964 @opindex Wno-disabled-optimization
6965 Warn if a requested optimization pass is disabled.  This warning does
6966 not generally indicate that there is anything wrong with your code; it
6967 merely indicates that GCC's optimizers are unable to handle the code
6968 effectively.  Often, the problem is that your code is too big or too
6969 complex; GCC refuses to optimize programs when the optimization
6970 itself is likely to take inordinate amounts of time.
6972 @item -Wpointer-sign @r{(C and Objective-C only)}
6973 @opindex Wpointer-sign
6974 @opindex Wno-pointer-sign
6975 Warn for pointer argument passing or assignment with different signedness.
6976 This option is only supported for C and Objective-C@.  It is implied by
6977 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6978 @option{-Wno-pointer-sign}.
6980 @item -Wstack-protector
6981 @opindex Wstack-protector
6982 @opindex Wno-stack-protector
6983 This option is only active when @option{-fstack-protector} is active.  It
6984 warns about functions that are not protected against stack smashing.
6986 @item -Woverlength-strings
6987 @opindex Woverlength-strings
6988 @opindex Wno-overlength-strings
6989 Warn about string constants that are longer than the ``minimum
6990 maximum'' length specified in the C standard.  Modern compilers
6991 generally allow string constants that are much longer than the
6992 standard's minimum limit, but very portable programs should avoid
6993 using longer strings.
6995 The limit applies @emph{after} string constant concatenation, and does
6996 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6997 C99, it was raised to 4095.  C++98 does not specify a normative
6998 minimum maximum, so we do not diagnose overlength strings in C++@.
7000 This option is implied by @option{-Wpedantic}, and can be disabled with
7001 @option{-Wno-overlength-strings}.
7003 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7004 @opindex Wunsuffixed-float-constants
7006 Issue a warning for any floating constant that does not have
7007 a suffix.  When used together with @option{-Wsystem-headers} it
7008 warns about such constants in system header files.  This can be useful
7009 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7010 from the decimal floating-point extension to C99.
7012 @item -Wno-designated-init @r{(C and Objective-C only)}
7013 Suppress warnings when a positional initializer is used to initialize
7014 a structure that has been marked with the @code{designated_init}
7015 attribute.
7017 @item -Whsa
7018 Issue a warning when HSAIL cannot be emitted for the compiled function or
7019 OpenMP construct.
7021 @end table
7023 @node Debugging Options
7024 @section Options for Debugging Your Program
7025 @cindex options, debugging
7026 @cindex debugging information options
7028 To tell GCC to emit extra information for use by a debugger, in almost 
7029 all cases you need only to add @option{-g} to your other options.
7031 GCC allows you to use @option{-g} with
7032 @option{-O}.  The shortcuts taken by optimized code may occasionally
7033 be surprising: some variables you declared may not exist
7034 at all; flow of control may briefly move where you did not expect it;
7035 some statements may not be executed because they compute constant
7036 results or their values are already at hand; some statements may
7037 execute in different places because they have been moved out of loops.
7038 Nevertheless it is possible to debug optimized output.  This makes
7039 it reasonable to use the optimizer for programs that might have bugs.
7041 If you are not using some other optimization option, consider
7042 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7043 With no @option{-O} option at all, some compiler passes that collect
7044 information useful for debugging do not run at all, so that
7045 @option{-Og} may result in a better debugging experience.
7047 @table @gcctabopt
7048 @item -g
7049 @opindex g
7050 Produce debugging information in the operating system's native format
7051 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7052 information.
7054 On most systems that use stabs format, @option{-g} enables use of extra
7055 debugging information that only GDB can use; this extra information
7056 makes debugging work better in GDB but probably makes other debuggers
7057 crash or
7058 refuse to read the program.  If you want to control for certain whether
7059 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7060 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7062 @item -ggdb
7063 @opindex ggdb
7064 Produce debugging information for use by GDB@.  This means to use the
7065 most expressive format available (DWARF, stabs, or the native format
7066 if neither of those are supported), including GDB extensions if at all
7067 possible.
7069 @item -gdwarf
7070 @itemx -gdwarf-@var{version}
7071 @opindex gdwarf
7072 Produce debugging information in DWARF format (if that is supported).
7073 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7074 for most targets is 4.  DWARF Version 5 is only experimental.
7076 Note that with DWARF Version 2, some ports require and always
7077 use some non-conflicting DWARF 3 extensions in the unwind tables.
7079 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7080 for maximum benefit.
7082 GCC no longer supports DWARF Version 1, which is substantially
7083 different than Version 2 and later.  For historical reasons, some
7084 other DWARF-related options such as
7085 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7086 in their names, but apply to all currently-supported versions of DWARF.
7088 @item -gstabs
7089 @opindex gstabs
7090 Produce debugging information in stabs format (if that is supported),
7091 without GDB extensions.  This is the format used by DBX on most BSD
7092 systems.  On MIPS, Alpha and System V Release 4 systems this option
7093 produces stabs debugging output that is not understood by DBX@.
7094 On System V Release 4 systems this option requires the GNU assembler.
7096 @item -gstabs+
7097 @opindex gstabs+
7098 Produce debugging information in stabs format (if that is supported),
7099 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7100 use of these extensions is likely to make other debuggers crash or
7101 refuse to read the program.
7103 @item -gxcoff
7104 @opindex gxcoff
7105 Produce debugging information in XCOFF format (if that is supported).
7106 This is the format used by the DBX debugger on IBM RS/6000 systems.
7108 @item -gxcoff+
7109 @opindex gxcoff+
7110 Produce debugging information in XCOFF format (if that is supported),
7111 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7112 use of these extensions is likely to make other debuggers crash or
7113 refuse to read the program, and may cause assemblers other than the GNU
7114 assembler (GAS) to fail with an error.
7116 @item -gvms
7117 @opindex gvms
7118 Produce debugging information in Alpha/VMS debug format (if that is
7119 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7121 @item -g@var{level}
7122 @itemx -ggdb@var{level}
7123 @itemx -gstabs@var{level}
7124 @itemx -gxcoff@var{level}
7125 @itemx -gvms@var{level}
7126 Request debugging information and also use @var{level} to specify how
7127 much information.  The default level is 2.
7129 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7130 @option{-g}.
7132 Level 1 produces minimal information, enough for making backtraces in
7133 parts of the program that you don't plan to debug.  This includes
7134 descriptions of functions and external variables, and line number
7135 tables, but no information about local variables.
7137 Level 3 includes extra information, such as all the macro definitions
7138 present in the program.  Some debuggers support macro expansion when
7139 you use @option{-g3}.
7141 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7142 confusion with @option{-gdwarf-@var{level}}.
7143 Instead use an additional @option{-g@var{level}} option to change the
7144 debug level for DWARF.
7146 @item -feliminate-unused-debug-symbols
7147 @opindex feliminate-unused-debug-symbols
7148 Produce debugging information in stabs format (if that is supported),
7149 for only symbols that are actually used.
7151 @item -femit-class-debug-always
7152 @opindex femit-class-debug-always
7153 Instead of emitting debugging information for a C++ class in only one
7154 object file, emit it in all object files using the class.  This option
7155 should be used only with debuggers that are unable to handle the way GCC
7156 normally emits debugging information for classes because using this
7157 option increases the size of debugging information by as much as a
7158 factor of two.
7160 @item -fno-merge-debug-strings
7161 @opindex fmerge-debug-strings
7162 @opindex fno-merge-debug-strings
7163 Direct the linker to not merge together strings in the debugging
7164 information that are identical in different object files.  Merging is
7165 not supported by all assemblers or linkers.  Merging decreases the size
7166 of the debug information in the output file at the cost of increasing
7167 link processing time.  Merging is enabled by default.
7169 @item -fdebug-prefix-map=@var{old}=@var{new}
7170 @opindex fdebug-prefix-map
7171 When compiling files residing in directory @file{@var{old}}, record
7172 debugging information describing them as if the files resided in
7173 directory @file{@var{new}} instead.  This can be used to replace a
7174 build-time path with an install-time path in the debug info.  It can
7175 also be used to change an absolute path to a relative path by using
7176 @file{.} for @var{new}.  This can give more reproducible builds, which
7177 are location independent, but may require an extra command to tell GDB
7178 where to find the source files. See also @option{-ffile-prefix-map}.
7180 @item -fvar-tracking
7181 @opindex fvar-tracking
7182 Run variable tracking pass.  It computes where variables are stored at each
7183 position in code.  Better debugging information is then generated
7184 (if the debugging information format supports this information).
7186 It is enabled by default when compiling with optimization (@option{-Os},
7187 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7188 the debug info format supports it.
7190 @item -fvar-tracking-assignments
7191 @opindex fvar-tracking-assignments
7192 @opindex fno-var-tracking-assignments
7193 Annotate assignments to user variables early in the compilation and
7194 attempt to carry the annotations over throughout the compilation all the
7195 way to the end, in an attempt to improve debug information while
7196 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7198 It can be enabled even if var-tracking is disabled, in which case
7199 annotations are created and maintained, but discarded at the end.
7200 By default, this flag is enabled together with @option{-fvar-tracking},
7201 except when selective scheduling is enabled.
7203 @item -gsplit-dwarf
7204 @opindex gsplit-dwarf
7205 Separate as much DWARF debugging information as possible into a
7206 separate output file with the extension @file{.dwo}.  This option allows
7207 the build system to avoid linking files with debug information.  To
7208 be useful, this option requires a debugger capable of reading @file{.dwo}
7209 files.
7211 @item -gpubnames
7212 @opindex gpubnames
7213 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7215 @item -ggnu-pubnames
7216 @opindex ggnu-pubnames
7217 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7218 suitable for conversion into a GDB@ index.  This option is only useful
7219 with a linker that can produce GDB@ index version 7.
7221 @item -fdebug-types-section
7222 @opindex fdebug-types-section
7223 @opindex fno-debug-types-section
7224 When using DWARF Version 4 or higher, type DIEs can be put into
7225 their own @code{.debug_types} section instead of making them part of the
7226 @code{.debug_info} section.  It is more efficient to put them in a separate
7227 comdat section since the linker can then remove duplicates.
7228 But not all DWARF consumers support @code{.debug_types} sections yet
7229 and on some objects @code{.debug_types} produces larger instead of smaller
7230 debugging information.
7232 @item -grecord-gcc-switches
7233 @itemx -gno-record-gcc-switches
7234 @opindex grecord-gcc-switches
7235 @opindex gno-record-gcc-switches
7236 This switch causes the command-line options used to invoke the
7237 compiler that may affect code generation to be appended to the
7238 DW_AT_producer attribute in DWARF debugging information.  The options
7239 are concatenated with spaces separating them from each other and from
7240 the compiler version.  
7241 It is enabled by default.
7242 See also @option{-frecord-gcc-switches} for another
7243 way of storing compiler options into the object file.  
7245 @item -gstrict-dwarf
7246 @opindex gstrict-dwarf
7247 Disallow using extensions of later DWARF standard version than selected
7248 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7249 DWARF extensions from later standard versions is allowed.
7251 @item -gno-strict-dwarf
7252 @opindex gno-strict-dwarf
7253 Allow using extensions of later DWARF standard version than selected with
7254 @option{-gdwarf-@var{version}}.
7256 @item -gas-loc-support
7257 @opindex gas-loc-support
7258 Inform the compiler that the assembler supports @code{.loc} directives.
7259 It may then use them for the assembler to generate DWARF2+ line number
7260 tables.
7262 This is generally desirable, because assembler-generated line-number
7263 tables are a lot more compact than those the compiler can generate
7264 itself.
7266 This option will be enabled by default if, at GCC configure time, the
7267 assembler was found to support such directives.
7269 @item -gno-as-loc-support
7270 @opindex gno-as-loc-support
7271 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7272 line number tables are to be generated.
7274 @item gas-locview-support
7275 @opindex gas-locview-support
7276 Inform the compiler that the assembler supports @code{view} assignment
7277 and reset assertion checking in @code{.loc} directives.
7279 This option will be enabled by default if, at GCC configure time, the
7280 assembler was found to support them.
7282 @item gno-as-locview-support
7283 Force GCC to assign view numbers internally, if
7284 @option{-gvariable-location-views} are explicitly requested.
7286 @item -gcolumn-info
7287 @itemx -gno-column-info
7288 @opindex gcolumn-info
7289 @opindex gno-column-info
7290 Emit location column information into DWARF debugging information, rather
7291 than just file and line.
7292 This option is enabled by default.
7294 @item -gstatement-frontiers
7295 @itemx -gno-statement-frontiers
7296 @opindex gstatement-frontiers
7297 @opindex gno-statement-frontiers
7298 This option causes GCC to create markers in the internal representation
7299 at the beginning of statements, and to keep them roughly in place
7300 throughout compilation, using them to guide the output of @code{is_stmt}
7301 markers in the line number table.  This is enabled by default when
7302 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7303 @dots{}), and outputting DWARF 2 debug information at the normal level.
7305 @item -gvariable-location-views
7306 @itemx -gvariable-location-views=incompat5
7307 @itemx -gno-variable-location-views
7308 @opindex gvariable-location-views
7309 @opindex gvariable-location-views=incompat5
7310 @opindex gno-variable-location-views
7311 Augment variable location lists with progressive view numbers implied
7312 from the line number table.  This enables debug information consumers to
7313 inspect state at certain points of the program, even if no instructions
7314 associated with the corresponding source locations are present at that
7315 point.  If the assembler lacks support for view numbers in line number
7316 tables, this will cause the compiler to emit the line number table,
7317 which generally makes them somewhat less compact.  The augmented line
7318 number tables and location lists are fully backward-compatible, so they
7319 can be consumed by debug information consumers that are not aware of
7320 these augmentations, but they won't derive any benefit from them either.
7322 This is enabled by default when outputting DWARF 2 debug information at
7323 the normal level, as long as there is assembler support,
7324 @option{-fvar-tracking-assignments} is enabled and
7325 @option{-gstrict-dwarf} is not.  When assembler support is not
7326 available, this may still be enabled, but it will force GCC to output
7327 internal line number tables, and if
7328 @option{-ginternal-reset-location-views} is not enabled, that will most
7329 certainly lead to silently mismatching location views.
7331 There is a proposed representation for view numbers that is not backward
7332 compatible with the location list format introduced in DWARF 5, that can
7333 be enabled with @option{-gvariable-location-views=incompat5}.  This
7334 option may be removed in the future, is only provided as a reference
7335 implementation of the proposed representation.  Debug information
7336 consumers are not expected to support this extended format, and they
7337 would be rendered unable to decode location lists using it.
7339 @item -ginternal-reset-location-views
7340 @itemx -gnointernal-reset-location-views
7341 @opindex ginternal-reset-location-views
7342 @opindex gno-internal-reset-location-views
7343 Attempt to determine location views that can be omitted from location
7344 view lists.  This requires the compiler to have very accurate insn
7345 length estimates, which isn't always the case, and it may cause
7346 incorrect view lists to be generated silently when using an assembler
7347 that does not support location view lists.  The GNU assembler will flag
7348 any such error as a @code{view number mismatch}.  This is only enabled
7349 on ports that define a reliable estimation function.
7351 @item -ginline-points
7352 @itemx -gno-inline-points
7353 @opindex ginline-points
7354 @opindex gno-inline-points
7355 Generate extended debug information for inlined functions.  Location
7356 view tracking markers are inserted at inlined entry points, so that
7357 address and view numbers can be computed and output in debug
7358 information.  This can be enabled independently of location views, in
7359 which case the view numbers won't be output, but it can only be enabled
7360 along with statement frontiers, and it is only enabled by default if
7361 location views are enabled.
7363 @item -gz@r{[}=@var{type}@r{]}
7364 @opindex gz
7365 Produce compressed debug sections in DWARF format, if that is supported.
7366 If @var{type} is not given, the default type depends on the capabilities
7367 of the assembler and linker used.  @var{type} may be one of
7368 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7369 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7370 compression in traditional GNU format).  If the linker doesn't support
7371 writing compressed debug sections, the option is rejected.  Otherwise,
7372 if the assembler does not support them, @option{-gz} is silently ignored
7373 when producing object files.
7375 @item -femit-struct-debug-baseonly
7376 @opindex femit-struct-debug-baseonly
7377 Emit debug information for struct-like types
7378 only when the base name of the compilation source file
7379 matches the base name of file in which the struct is defined.
7381 This option substantially reduces the size of debugging information,
7382 but at significant potential loss in type information to the debugger.
7383 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7384 See @option{-femit-struct-debug-detailed} for more detailed control.
7386 This option works only with DWARF debug output.
7388 @item -femit-struct-debug-reduced
7389 @opindex femit-struct-debug-reduced
7390 Emit debug information for struct-like types
7391 only when the base name of the compilation source file
7392 matches the base name of file in which the type is defined,
7393 unless the struct is a template or defined in a system header.
7395 This option significantly reduces the size of debugging information,
7396 with some potential loss in type information to the debugger.
7397 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7398 See @option{-femit-struct-debug-detailed} for more detailed control.
7400 This option works only with DWARF debug output.
7402 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7403 @opindex femit-struct-debug-detailed
7404 Specify the struct-like types
7405 for which the compiler generates debug information.
7406 The intent is to reduce duplicate struct debug information
7407 between different object files within the same program.
7409 This option is a detailed version of
7410 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7411 which serves for most needs.
7413 A specification has the syntax@*
7414 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7416 The optional first word limits the specification to
7417 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7418 A struct type is used directly when it is the type of a variable, member.
7419 Indirect uses arise through pointers to structs.
7420 That is, when use of an incomplete struct is valid, the use is indirect.
7421 An example is
7422 @samp{struct one direct; struct two * indirect;}.
7424 The optional second word limits the specification to
7425 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7426 Generic structs are a bit complicated to explain.
7427 For C++, these are non-explicit specializations of template classes,
7428 or non-template classes within the above.
7429 Other programming languages have generics,
7430 but @option{-femit-struct-debug-detailed} does not yet implement them.
7432 The third word specifies the source files for those
7433 structs for which the compiler should emit debug information.
7434 The values @samp{none} and @samp{any} have the normal meaning.
7435 The value @samp{base} means that
7436 the base of name of the file in which the type declaration appears
7437 must match the base of the name of the main compilation file.
7438 In practice, this means that when compiling @file{foo.c}, debug information
7439 is generated for types declared in that file and @file{foo.h},
7440 but not other header files.
7441 The value @samp{sys} means those types satisfying @samp{base}
7442 or declared in system or compiler headers.
7444 You may need to experiment to determine the best settings for your application.
7446 The default is @option{-femit-struct-debug-detailed=all}.
7448 This option works only with DWARF debug output.
7450 @item -fno-dwarf2-cfi-asm
7451 @opindex fdwarf2-cfi-asm
7452 @opindex fno-dwarf2-cfi-asm
7453 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7454 instead of using GAS @code{.cfi_*} directives.
7456 @item -fno-eliminate-unused-debug-types
7457 @opindex feliminate-unused-debug-types
7458 @opindex fno-eliminate-unused-debug-types
7459 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7460 output for types that are nowhere used in the source file being compiled.
7461 Sometimes it is useful to have GCC emit debugging
7462 information for all types declared in a compilation
7463 unit, regardless of whether or not they are actually used
7464 in that compilation unit, for example 
7465 if, in the debugger, you want to cast a value to a type that is
7466 not actually used in your program (but is declared).  More often,
7467 however, this results in a significant amount of wasted space.
7468 @end table
7470 @node Optimize Options
7471 @section Options That Control Optimization
7472 @cindex optimize options
7473 @cindex options, optimization
7475 These options control various sorts of optimizations.
7477 Without any optimization option, the compiler's goal is to reduce the
7478 cost of compilation and to make debugging produce the expected
7479 results.  Statements are independent: if you stop the program with a
7480 breakpoint between statements, you can then assign a new value to any
7481 variable or change the program counter to any other statement in the
7482 function and get exactly the results you expect from the source
7483 code.
7485 Turning on optimization flags makes the compiler attempt to improve
7486 the performance and/or code size at the expense of compilation time
7487 and possibly the ability to debug the program.
7489 The compiler performs optimization based on the knowledge it has of the
7490 program.  Compiling multiple files at once to a single output file mode allows
7491 the compiler to use information gained from all of the files when compiling
7492 each of them.
7494 Not all optimizations are controlled directly by a flag.  Only
7495 optimizations that have a flag are listed in this section.
7497 Most optimizations are only enabled if an @option{-O} level is set on
7498 the command line.  Otherwise they are disabled, even if individual
7499 optimization flags are specified.
7501 Depending on the target and how GCC was configured, a slightly different
7502 set of optimizations may be enabled at each @option{-O} level than
7503 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7504 to find out the exact set of optimizations that are enabled at each level.
7505 @xref{Overall Options}, for examples.
7507 @table @gcctabopt
7508 @item -O
7509 @itemx -O1
7510 @opindex O
7511 @opindex O1
7512 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7513 more memory for a large function.
7515 With @option{-O}, the compiler tries to reduce code size and execution
7516 time, without performing any optimizations that take a great deal of
7517 compilation time.
7519 @option{-O} turns on the following optimization flags:
7520 @gccoptlist{
7521 -fauto-inc-dec @gol
7522 -fbranch-count-reg @gol
7523 -fcombine-stack-adjustments @gol
7524 -fcompare-elim @gol
7525 -fcprop-registers @gol
7526 -fdce @gol
7527 -fdefer-pop @gol
7528 -fdelayed-branch @gol
7529 -fdse @gol
7530 -fforward-propagate @gol
7531 -fguess-branch-probability @gol
7532 -fif-conversion2 @gol
7533 -fif-conversion @gol
7534 -finline-functions-called-once @gol
7535 -fipa-pure-const @gol
7536 -fipa-profile @gol
7537 -fipa-reference @gol
7538 -fmerge-constants @gol
7539 -fmove-loop-invariants @gol
7540 -fomit-frame-pointer @gol
7541 -freorder-blocks @gol
7542 -fshrink-wrap @gol
7543 -fshrink-wrap-separate @gol
7544 -fsplit-wide-types @gol
7545 -fssa-backprop @gol
7546 -fssa-phiopt @gol
7547 -ftree-bit-ccp @gol
7548 -ftree-ccp @gol
7549 -ftree-ch @gol
7550 -ftree-coalesce-vars @gol
7551 -ftree-copy-prop @gol
7552 -ftree-dce @gol
7553 -ftree-dominator-opts @gol
7554 -ftree-dse @gol
7555 -ftree-forwprop @gol
7556 -ftree-fre @gol
7557 -ftree-phiprop @gol
7558 -ftree-sink @gol
7559 -ftree-slsr @gol
7560 -ftree-sra @gol
7561 -ftree-pta @gol
7562 -ftree-ter @gol
7563 -funit-at-a-time}
7565 @item -O2
7566 @opindex O2
7567 Optimize even more.  GCC performs nearly all supported optimizations
7568 that do not involve a space-speed tradeoff.
7569 As compared to @option{-O}, this option increases both compilation time
7570 and the performance of the generated code.
7572 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7573 also turns on the following optimization flags:
7574 @gccoptlist{-fthread-jumps @gol
7575 -falign-functions  -falign-jumps @gol
7576 -falign-loops  -falign-labels @gol
7577 -fcaller-saves @gol
7578 -fcrossjumping @gol
7579 -fcse-follow-jumps  -fcse-skip-blocks @gol
7580 -fdelete-null-pointer-checks @gol
7581 -fdevirtualize -fdevirtualize-speculatively @gol
7582 -fexpensive-optimizations @gol
7583 -fgcse  -fgcse-lm  @gol
7584 -fhoist-adjacent-loads @gol
7585 -finline-small-functions @gol
7586 -findirect-inlining @gol
7587 -fipa-cp @gol
7588 -fipa-bit-cp @gol
7589 -fipa-vrp @gol
7590 -fipa-sra @gol
7591 -fipa-icf @gol
7592 -fisolate-erroneous-paths-dereference @gol
7593 -flra-remat @gol
7594 -foptimize-sibling-calls @gol
7595 -foptimize-strlen @gol
7596 -fpartial-inlining @gol
7597 -fpeephole2 @gol
7598 -freorder-blocks-algorithm=stc @gol
7599 -freorder-blocks-and-partition -freorder-functions @gol
7600 -frerun-cse-after-loop  @gol
7601 -fsched-interblock  -fsched-spec @gol
7602 -fschedule-insns  -fschedule-insns2 @gol
7603 -fstore-merging @gol
7604 -fstrict-aliasing @gol
7605 -ftree-builtin-call-dce @gol
7606 -ftree-switch-conversion -ftree-tail-merge @gol
7607 -fcode-hoisting @gol
7608 -ftree-pre @gol
7609 -ftree-vrp @gol
7610 -fipa-ra}
7612 Please note the warning under @option{-fgcse} about
7613 invoking @option{-O2} on programs that use computed gotos.
7615 @item -O3
7616 @opindex O3
7617 Optimize yet more.  @option{-O3} turns on all optimizations specified
7618 by @option{-O2} and also turns on the following optimization flags:
7619 @gccoptlist{-finline-functions @gol
7620 -funswitch-loops @gol
7621 -fpredictive-commoning @gol
7622 -fgcse-after-reload @gol
7623 -ftree-loop-vectorize @gol
7624 -ftree-loop-distribution @gol
7625 -ftree-loop-distribute-patterns @gol
7626 -floop-interchange @gol
7627 -floop-unroll-and-jam @gol
7628 -fsplit-paths @gol
7629 -ftree-slp-vectorize @gol
7630 -fvect-cost-model @gol
7631 -ftree-partial-pre @gol
7632 -fpeel-loops @gol
7633 -fipa-cp-clone}
7635 @item -O0
7636 @opindex O0
7637 Reduce compilation time and make debugging produce the expected
7638 results.  This is the default.
7640 @item -Os
7641 @opindex Os
7642 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7643 do not typically increase code size.  It also performs further
7644 optimizations designed to reduce code size.
7646 @option{-Os} disables the following optimization flags:
7647 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7648 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7649 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7651 @item -Ofast
7652 @opindex Ofast
7653 Disregard strict standards compliance.  @option{-Ofast} enables all
7654 @option{-O3} optimizations.  It also enables optimizations that are not
7655 valid for all standard-compliant programs.
7656 It turns on @option{-ffast-math} and the Fortran-specific
7657 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7658 specified, and @option{-fno-protect-parens}.
7660 @item -Og
7661 @opindex Og
7662 Optimize debugging experience.  @option{-Og} enables optimizations
7663 that do not interfere with debugging. It should be the optimization
7664 level of choice for the standard edit-compile-debug cycle, offering
7665 a reasonable level of optimization while maintaining fast compilation
7666 and a good debugging experience.
7667 @end table
7669 If you use multiple @option{-O} options, with or without level numbers,
7670 the last such option is the one that is effective.
7672 Options of the form @option{-f@var{flag}} specify machine-independent
7673 flags.  Most flags have both positive and negative forms; the negative
7674 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7675 below, only one of the forms is listed---the one you typically 
7676 use.  You can figure out the other form by either removing @samp{no-}
7677 or adding it.
7679 The following options control specific optimizations.  They are either
7680 activated by @option{-O} options or are related to ones that are.  You
7681 can use the following flags in the rare cases when ``fine-tuning'' of
7682 optimizations to be performed is desired.
7684 @table @gcctabopt
7685 @item -fno-defer-pop
7686 @opindex fno-defer-pop
7687 Always pop the arguments to each function call as soon as that function
7688 returns.  For machines that must pop arguments after a function call,
7689 the compiler normally lets arguments accumulate on the stack for several
7690 function calls and pops them all at once.
7692 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7694 @item -fforward-propagate
7695 @opindex fforward-propagate
7696 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7697 instructions and checks if the result can be simplified.  If loop unrolling
7698 is active, two passes are performed and the second is scheduled after
7699 loop unrolling.
7701 This option is enabled by default at optimization levels @option{-O},
7702 @option{-O2}, @option{-O3}, @option{-Os}.
7704 @item -ffp-contract=@var{style}
7705 @opindex ffp-contract
7706 @option{-ffp-contract=off} disables floating-point expression contraction.
7707 @option{-ffp-contract=fast} enables floating-point expression contraction
7708 such as forming of fused multiply-add operations if the target has
7709 native support for them.
7710 @option{-ffp-contract=on} enables floating-point expression contraction
7711 if allowed by the language standard.  This is currently not implemented
7712 and treated equal to @option{-ffp-contract=off}.
7714 The default is @option{-ffp-contract=fast}.
7716 @item -fomit-frame-pointer
7717 @opindex fomit-frame-pointer
7718 Omit the frame pointer in functions that don't need one.  This avoids the
7719 instructions to save, set up and restore the frame pointer; on many targets
7720 it also makes an extra register available.
7722 On some targets this flag has no effect because the standard calling sequence
7723 always uses a frame pointer, so it cannot be omitted.
7725 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7726 is used in all functions.  Several targets always omit the frame pointer in
7727 leaf functions.
7729 Enabled by default at @option{-O} and higher.
7731 @item -foptimize-sibling-calls
7732 @opindex foptimize-sibling-calls
7733 Optimize sibling and tail recursive calls.
7735 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7737 @item -foptimize-strlen
7738 @opindex foptimize-strlen
7739 Optimize various standard C string functions (e.g. @code{strlen},
7740 @code{strchr} or @code{strcpy}) and
7741 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7743 Enabled at levels @option{-O2}, @option{-O3}.
7745 @item -fno-inline
7746 @opindex fno-inline
7747 Do not expand any functions inline apart from those marked with
7748 the @code{always_inline} attribute.  This is the default when not
7749 optimizing.
7751 Single functions can be exempted from inlining by marking them
7752 with the @code{noinline} attribute.
7754 @item -finline-small-functions
7755 @opindex finline-small-functions
7756 Integrate functions into their callers when their body is smaller than expected
7757 function call code (so overall size of program gets smaller).  The compiler
7758 heuristically decides which functions are simple enough to be worth integrating
7759 in this way.  This inlining applies to all functions, even those not declared
7760 inline.
7762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7764 @item -findirect-inlining
7765 @opindex findirect-inlining
7766 Inline also indirect calls that are discovered to be known at compile
7767 time thanks to previous inlining.  This option has any effect only
7768 when inlining itself is turned on by the @option{-finline-functions}
7769 or @option{-finline-small-functions} options.
7771 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7773 @item -finline-functions
7774 @opindex finline-functions
7775 Consider all functions for inlining, even if they are not declared inline.
7776 The compiler heuristically decides which functions are worth integrating
7777 in this way.
7779 If all calls to a given function are integrated, and the function is
7780 declared @code{static}, then the function is normally not output as
7781 assembler code in its own right.
7783 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7785 @item -finline-functions-called-once
7786 @opindex finline-functions-called-once
7787 Consider all @code{static} functions called once for inlining into their
7788 caller even if they are not marked @code{inline}.  If a call to a given
7789 function is integrated, then the function is not output as assembler code
7790 in its own right.
7792 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7794 @item -fearly-inlining
7795 @opindex fearly-inlining
7796 Inline functions marked by @code{always_inline} and functions whose body seems
7797 smaller than the function call overhead early before doing
7798 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7799 makes profiling significantly cheaper and usually inlining faster on programs
7800 having large chains of nested wrapper functions.
7802 Enabled by default.
7804 @item -fipa-sra
7805 @opindex fipa-sra
7806 Perform interprocedural scalar replacement of aggregates, removal of
7807 unused parameters and replacement of parameters passed by reference
7808 by parameters passed by value.
7810 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7812 @item -finline-limit=@var{n}
7813 @opindex finline-limit
7814 By default, GCC limits the size of functions that can be inlined.  This flag
7815 allows coarse control of this limit.  @var{n} is the size of functions that
7816 can be inlined in number of pseudo instructions.
7818 Inlining is actually controlled by a number of parameters, which may be
7819 specified individually by using @option{--param @var{name}=@var{value}}.
7820 The @option{-finline-limit=@var{n}} option sets some of these parameters
7821 as follows:
7823 @table @gcctabopt
7824 @item max-inline-insns-single
7825 is set to @var{n}/2.
7826 @item max-inline-insns-auto
7827 is set to @var{n}/2.
7828 @end table
7830 See below for a documentation of the individual
7831 parameters controlling inlining and for the defaults of these parameters.
7833 @emph{Note:} there may be no value to @option{-finline-limit} that results
7834 in default behavior.
7836 @emph{Note:} pseudo instruction represents, in this particular context, an
7837 abstract measurement of function's size.  In no way does it represent a count
7838 of assembly instructions and as such its exact meaning might change from one
7839 release to an another.
7841 @item -fno-keep-inline-dllexport
7842 @opindex fno-keep-inline-dllexport
7843 This is a more fine-grained version of @option{-fkeep-inline-functions},
7844 which applies only to functions that are declared using the @code{dllexport}
7845 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7846 Functions}.
7848 @item -fkeep-inline-functions
7849 @opindex fkeep-inline-functions
7850 In C, emit @code{static} functions that are declared @code{inline}
7851 into the object file, even if the function has been inlined into all
7852 of its callers.  This switch does not affect functions using the
7853 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7854 inline functions into the object file.
7856 @item -fkeep-static-functions
7857 @opindex fkeep-static-functions
7858 Emit @code{static} functions into the object file, even if the function
7859 is never used.
7861 @item -fkeep-static-consts
7862 @opindex fkeep-static-consts
7863 Emit variables declared @code{static const} when optimization isn't turned
7864 on, even if the variables aren't referenced.
7866 GCC enables this option by default.  If you want to force the compiler to
7867 check if a variable is referenced, regardless of whether or not
7868 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7870 @item -fmerge-constants
7871 @opindex fmerge-constants
7872 Attempt to merge identical constants (string constants and floating-point
7873 constants) across compilation units.
7875 This option is the default for optimized compilation if the assembler and
7876 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7877 behavior.
7879 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7881 @item -fmerge-all-constants
7882 @opindex fmerge-all-constants
7883 Attempt to merge identical constants and identical variables.
7885 This option implies @option{-fmerge-constants}.  In addition to
7886 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7887 arrays or initialized constant variables with integral or floating-point
7888 types.  Languages like C or C++ require each variable, including multiple
7889 instances of the same variable in recursive calls, to have distinct locations,
7890 so using this option results in non-conforming
7891 behavior.
7893 @item -fmodulo-sched
7894 @opindex fmodulo-sched
7895 Perform swing modulo scheduling immediately before the first scheduling
7896 pass.  This pass looks at innermost loops and reorders their
7897 instructions by overlapping different iterations.
7899 @item -fmodulo-sched-allow-regmoves
7900 @opindex fmodulo-sched-allow-regmoves
7901 Perform more aggressive SMS-based modulo scheduling with register moves
7902 allowed.  By setting this flag certain anti-dependences edges are
7903 deleted, which triggers the generation of reg-moves based on the
7904 life-range analysis.  This option is effective only with
7905 @option{-fmodulo-sched} enabled.
7907 @item -fno-branch-count-reg
7908 @opindex fno-branch-count-reg
7909 Avoid running a pass scanning for opportunities to use ``decrement and
7910 branch'' instructions on a count register instead of generating sequences
7911 of instructions that decrement a register, compare it against zero, and
7912 then branch based upon the result.  This option is only meaningful on
7913 architectures that support such instructions, which include x86, PowerPC,
7914 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7915 doesn't remove the decrement and branch instructions from the generated
7916 instruction stream introduced by other optimization passes.
7918 Enabled by default at @option{-O1} and higher.
7920 The default is @option{-fbranch-count-reg}.
7922 @item -fno-function-cse
7923 @opindex fno-function-cse
7924 Do not put function addresses in registers; make each instruction that
7925 calls a constant function contain the function's address explicitly.
7927 This option results in less efficient code, but some strange hacks
7928 that alter the assembler output may be confused by the optimizations
7929 performed when this option is not used.
7931 The default is @option{-ffunction-cse}
7933 @item -fno-zero-initialized-in-bss
7934 @opindex fno-zero-initialized-in-bss
7935 If the target supports a BSS section, GCC by default puts variables that
7936 are initialized to zero into BSS@.  This can save space in the resulting
7937 code.
7939 This option turns off this behavior because some programs explicitly
7940 rely on variables going to the data section---e.g., so that the
7941 resulting executable can find the beginning of that section and/or make
7942 assumptions based on that.
7944 The default is @option{-fzero-initialized-in-bss}.
7946 @item -fthread-jumps
7947 @opindex fthread-jumps
7948 Perform optimizations that check to see if a jump branches to a
7949 location where another comparison subsumed by the first is found.  If
7950 so, the first branch is redirected to either the destination of the
7951 second branch or a point immediately following it, depending on whether
7952 the condition is known to be true or false.
7954 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7956 @item -fsplit-wide-types
7957 @opindex fsplit-wide-types
7958 When using a type that occupies multiple registers, such as @code{long
7959 long} on a 32-bit system, split the registers apart and allocate them
7960 independently.  This normally generates better code for those types,
7961 but may make debugging more difficult.
7963 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7964 @option{-Os}.
7966 @item -fcse-follow-jumps
7967 @opindex fcse-follow-jumps
7968 In common subexpression elimination (CSE), scan through jump instructions
7969 when the target of the jump is not reached by any other path.  For
7970 example, when CSE encounters an @code{if} statement with an
7971 @code{else} clause, CSE follows the jump when the condition
7972 tested is false.
7974 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7976 @item -fcse-skip-blocks
7977 @opindex fcse-skip-blocks
7978 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7979 follow jumps that conditionally skip over blocks.  When CSE
7980 encounters a simple @code{if} statement with no else clause,
7981 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7982 body of the @code{if}.
7984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7986 @item -frerun-cse-after-loop
7987 @opindex frerun-cse-after-loop
7988 Re-run common subexpression elimination after loop optimizations are
7989 performed.
7991 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7993 @item -fgcse
7994 @opindex fgcse
7995 Perform a global common subexpression elimination pass.
7996 This pass also performs global constant and copy propagation.
7998 @emph{Note:} When compiling a program using computed gotos, a GCC
7999 extension, you may get better run-time performance if you disable
8000 the global common subexpression elimination pass by adding
8001 @option{-fno-gcse} to the command line.
8003 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8005 @item -fgcse-lm
8006 @opindex fgcse-lm
8007 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8008 attempts to move loads that are only killed by stores into themselves.  This
8009 allows a loop containing a load/store sequence to be changed to a load outside
8010 the loop, and a copy/store within the loop.
8012 Enabled by default when @option{-fgcse} is enabled.
8014 @item -fgcse-sm
8015 @opindex fgcse-sm
8016 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8017 global common subexpression elimination.  This pass attempts to move
8018 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8019 loops containing a load/store sequence can be changed to a load before
8020 the loop and a store after the loop.
8022 Not enabled at any optimization level.
8024 @item -fgcse-las
8025 @opindex fgcse-las
8026 When @option{-fgcse-las} is enabled, the global common subexpression
8027 elimination pass eliminates redundant loads that come after stores to the
8028 same memory location (both partial and full redundancies).
8030 Not enabled at any optimization level.
8032 @item -fgcse-after-reload
8033 @opindex fgcse-after-reload
8034 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8035 pass is performed after reload.  The purpose of this pass is to clean up
8036 redundant spilling.
8038 @item -faggressive-loop-optimizations
8039 @opindex faggressive-loop-optimizations
8040 This option tells the loop optimizer to use language constraints to
8041 derive bounds for the number of iterations of a loop.  This assumes that
8042 loop code does not invoke undefined behavior by for example causing signed
8043 integer overflows or out-of-bound array accesses.  The bounds for the
8044 number of iterations of a loop are used to guide loop unrolling and peeling
8045 and loop exit test optimizations.
8046 This option is enabled by default.
8048 @item -funconstrained-commons
8049 @opindex funconstrained-commons
8050 This option tells the compiler that variables declared in common blocks
8051 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8052 prevents certain optimizations that depend on knowing the array bounds.
8054 @item -fcrossjumping
8055 @opindex fcrossjumping
8056 Perform cross-jumping transformation.
8057 This transformation unifies equivalent code and saves code size.  The
8058 resulting code may or may not perform better than without cross-jumping.
8060 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8062 @item -fauto-inc-dec
8063 @opindex fauto-inc-dec
8064 Combine increments or decrements of addresses with memory accesses.
8065 This pass is always skipped on architectures that do not have
8066 instructions to support this.  Enabled by default at @option{-O} and
8067 higher on architectures that support this.
8069 @item -fdce
8070 @opindex fdce
8071 Perform dead code elimination (DCE) on RTL@.
8072 Enabled by default at @option{-O} and higher.
8074 @item -fdse
8075 @opindex fdse
8076 Perform dead store elimination (DSE) on RTL@.
8077 Enabled by default at @option{-O} and higher.
8079 @item -fif-conversion
8080 @opindex fif-conversion
8081 Attempt to transform conditional jumps into branch-less equivalents.  This
8082 includes use of conditional moves, min, max, set flags and abs instructions, and
8083 some tricks doable by standard arithmetics.  The use of conditional execution
8084 on chips where it is available is controlled by @option{-fif-conversion2}.
8086 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8088 @item -fif-conversion2
8089 @opindex fif-conversion2
8090 Use conditional execution (where available) to transform conditional jumps into
8091 branch-less equivalents.
8093 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8095 @item -fdeclone-ctor-dtor
8096 @opindex fdeclone-ctor-dtor
8097 The C++ ABI requires multiple entry points for constructors and
8098 destructors: one for a base subobject, one for a complete object, and
8099 one for a virtual destructor that calls operator delete afterwards.
8100 For a hierarchy with virtual bases, the base and complete variants are
8101 clones, which means two copies of the function.  With this option, the
8102 base and complete variants are changed to be thunks that call a common
8103 implementation.
8105 Enabled by @option{-Os}.
8107 @item -fdelete-null-pointer-checks
8108 @opindex fdelete-null-pointer-checks
8109 Assume that programs cannot safely dereference null pointers, and that
8110 no code or data element resides at address zero.
8111 This option enables simple constant
8112 folding optimizations at all optimization levels.  In addition, other
8113 optimization passes in GCC use this flag to control global dataflow
8114 analyses that eliminate useless checks for null pointers; these assume
8115 that a memory access to address zero always results in a trap, so
8116 that if a pointer is checked after it has already been dereferenced,
8117 it cannot be null.
8119 Note however that in some environments this assumption is not true.
8120 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8121 for programs that depend on that behavior.
8123 This option is enabled by default on most targets.  On Nios II ELF, it
8124 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8126 Passes that use the dataflow information
8127 are enabled independently at different optimization levels.
8129 @item -fdevirtualize
8130 @opindex fdevirtualize
8131 Attempt to convert calls to virtual functions to direct calls.  This
8132 is done both within a procedure and interprocedurally as part of
8133 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8134 propagation (@option{-fipa-cp}).
8135 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8137 @item -fdevirtualize-speculatively
8138 @opindex fdevirtualize-speculatively
8139 Attempt to convert calls to virtual functions to speculative direct calls.
8140 Based on the analysis of the type inheritance graph, determine for a given call
8141 the set of likely targets. If the set is small, preferably of size 1, change
8142 the call into a conditional deciding between direct and indirect calls.  The
8143 speculative calls enable more optimizations, such as inlining.  When they seem
8144 useless after further optimization, they are converted back into original form.
8146 @item -fdevirtualize-at-ltrans
8147 @opindex fdevirtualize-at-ltrans
8148 Stream extra information needed for aggressive devirtualization when running
8149 the link-time optimizer in local transformation mode.  
8150 This option enables more devirtualization but
8151 significantly increases the size of streamed data. For this reason it is
8152 disabled by default.
8154 @item -fexpensive-optimizations
8155 @opindex fexpensive-optimizations
8156 Perform a number of minor optimizations that are relatively expensive.
8158 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8160 @item -free
8161 @opindex free
8162 Attempt to remove redundant extension instructions.  This is especially
8163 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8164 registers after writing to their lower 32-bit half.
8166 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8167 @option{-O3}, @option{-Os}.
8169 @item -fno-lifetime-dse
8170 @opindex fno-lifetime-dse
8171 In C++ the value of an object is only affected by changes within its
8172 lifetime: when the constructor begins, the object has an indeterminate
8173 value, and any changes during the lifetime of the object are dead when
8174 the object is destroyed.  Normally dead store elimination will take
8175 advantage of this; if your code relies on the value of the object
8176 storage persisting beyond the lifetime of the object, you can use this
8177 flag to disable this optimization.  To preserve stores before the
8178 constructor starts (e.g. because your operator new clears the object
8179 storage) but still treat the object as dead after the destructor you,
8180 can use @option{-flifetime-dse=1}.  The default behavior can be
8181 explicitly selected with @option{-flifetime-dse=2}.
8182 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8184 @item -flive-range-shrinkage
8185 @opindex flive-range-shrinkage
8186 Attempt to decrease register pressure through register live range
8187 shrinkage.  This is helpful for fast processors with small or moderate
8188 size register sets.
8190 @item -fira-algorithm=@var{algorithm}
8191 @opindex fira-algorithm
8192 Use the specified coloring algorithm for the integrated register
8193 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8194 specifies Chow's priority coloring, or @samp{CB}, which specifies
8195 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8196 for all architectures, but for those targets that do support it, it is
8197 the default because it generates better code.
8199 @item -fira-region=@var{region}
8200 @opindex fira-region
8201 Use specified regions for the integrated register allocator.  The
8202 @var{region} argument should be one of the following:
8204 @table @samp
8206 @item all
8207 Use all loops as register allocation regions.
8208 This can give the best results for machines with a small and/or
8209 irregular register set.
8211 @item mixed
8212 Use all loops except for loops with small register pressure 
8213 as the regions.  This value usually gives
8214 the best results in most cases and for most architectures,
8215 and is enabled by default when compiling with optimization for speed
8216 (@option{-O}, @option{-O2}, @dots{}).
8218 @item one
8219 Use all functions as a single region.  
8220 This typically results in the smallest code size, and is enabled by default for
8221 @option{-Os} or @option{-O0}.
8223 @end table
8225 @item -fira-hoist-pressure
8226 @opindex fira-hoist-pressure
8227 Use IRA to evaluate register pressure in the code hoisting pass for
8228 decisions to hoist expressions.  This option usually results in smaller
8229 code, but it can slow the compiler down.
8231 This option is enabled at level @option{-Os} for all targets.
8233 @item -fira-loop-pressure
8234 @opindex fira-loop-pressure
8235 Use IRA to evaluate register pressure in loops for decisions to move
8236 loop invariants.  This option usually results in generation
8237 of faster and smaller code on machines with large register files (>= 32
8238 registers), but it can slow the compiler down.
8240 This option is enabled at level @option{-O3} for some targets.
8242 @item -fno-ira-share-save-slots
8243 @opindex fno-ira-share-save-slots
8244 Disable sharing of stack slots used for saving call-used hard
8245 registers living through a call.  Each hard register gets a
8246 separate stack slot, and as a result function stack frames are
8247 larger.
8249 @item -fno-ira-share-spill-slots
8250 @opindex fno-ira-share-spill-slots
8251 Disable sharing of stack slots allocated for pseudo-registers.  Each
8252 pseudo-register that does not get a hard register gets a separate
8253 stack slot, and as a result function stack frames are larger.
8255 @item -flra-remat
8256 @opindex flra-remat
8257 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8258 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8259 values if it is profitable.
8261 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8263 @item -fdelayed-branch
8264 @opindex fdelayed-branch
8265 If supported for the target machine, attempt to reorder instructions
8266 to exploit instruction slots available after delayed branch
8267 instructions.
8269 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8271 @item -fschedule-insns
8272 @opindex fschedule-insns
8273 If supported for the target machine, attempt to reorder instructions to
8274 eliminate execution stalls due to required data being unavailable.  This
8275 helps machines that have slow floating point or memory load instructions
8276 by allowing other instructions to be issued until the result of the load
8277 or floating-point instruction is required.
8279 Enabled at levels @option{-O2}, @option{-O3}.
8281 @item -fschedule-insns2
8282 @opindex fschedule-insns2
8283 Similar to @option{-fschedule-insns}, but requests an additional pass of
8284 instruction scheduling after register allocation has been done.  This is
8285 especially useful on machines with a relatively small number of
8286 registers and where memory load instructions take more than one cycle.
8288 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8290 @item -fno-sched-interblock
8291 @opindex fno-sched-interblock
8292 Don't schedule instructions across basic blocks.  This is normally
8293 enabled by default when scheduling before register allocation, i.e.@:
8294 with @option{-fschedule-insns} or at @option{-O2} or higher.
8296 @item -fno-sched-spec
8297 @opindex fno-sched-spec
8298 Don't allow speculative motion of non-load instructions.  This is normally
8299 enabled by default when scheduling before register allocation, i.e.@:
8300 with @option{-fschedule-insns} or at @option{-O2} or higher.
8302 @item -fsched-pressure
8303 @opindex fsched-pressure
8304 Enable register pressure sensitive insn scheduling before register
8305 allocation.  This only makes sense when scheduling before register
8306 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8307 @option{-O2} or higher.  Usage of this option can improve the
8308 generated code and decrease its size by preventing register pressure
8309 increase above the number of available hard registers and subsequent
8310 spills in register allocation.
8312 @item -fsched-spec-load
8313 @opindex fsched-spec-load
8314 Allow speculative motion of some load instructions.  This only makes
8315 sense when scheduling before register allocation, i.e.@: with
8316 @option{-fschedule-insns} or at @option{-O2} or higher.
8318 @item -fsched-spec-load-dangerous
8319 @opindex fsched-spec-load-dangerous
8320 Allow speculative motion of more load instructions.  This only makes
8321 sense when scheduling before register allocation, i.e.@: with
8322 @option{-fschedule-insns} or at @option{-O2} or higher.
8324 @item -fsched-stalled-insns
8325 @itemx -fsched-stalled-insns=@var{n}
8326 @opindex fsched-stalled-insns
8327 Define how many insns (if any) can be moved prematurely from the queue
8328 of stalled insns into the ready list during the second scheduling pass.
8329 @option{-fno-sched-stalled-insns} means that no insns are moved
8330 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8331 on how many queued insns can be moved prematurely.
8332 @option{-fsched-stalled-insns} without a value is equivalent to
8333 @option{-fsched-stalled-insns=1}.
8335 @item -fsched-stalled-insns-dep
8336 @itemx -fsched-stalled-insns-dep=@var{n}
8337 @opindex fsched-stalled-insns-dep
8338 Define how many insn groups (cycles) are examined for a dependency
8339 on a stalled insn that is a candidate for premature removal from the queue
8340 of stalled insns.  This has an effect only during the second scheduling pass,
8341 and only if @option{-fsched-stalled-insns} is used.
8342 @option{-fno-sched-stalled-insns-dep} is equivalent to
8343 @option{-fsched-stalled-insns-dep=0}.
8344 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8345 @option{-fsched-stalled-insns-dep=1}.
8347 @item -fsched2-use-superblocks
8348 @opindex fsched2-use-superblocks
8349 When scheduling after register allocation, use superblock scheduling.
8350 This allows motion across basic block boundaries,
8351 resulting in faster schedules.  This option is experimental, as not all machine
8352 descriptions used by GCC model the CPU closely enough to avoid unreliable
8353 results from the algorithm.
8355 This only makes sense when scheduling after register allocation, i.e.@: with
8356 @option{-fschedule-insns2} or at @option{-O2} or higher.
8358 @item -fsched-group-heuristic
8359 @opindex fsched-group-heuristic
8360 Enable the group heuristic in the scheduler.  This heuristic favors
8361 the instruction that belongs to a schedule group.  This is enabled
8362 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8363 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8365 @item -fsched-critical-path-heuristic
8366 @opindex fsched-critical-path-heuristic
8367 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8368 instructions on the critical path.  This is enabled by default when
8369 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8370 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8372 @item -fsched-spec-insn-heuristic
8373 @opindex fsched-spec-insn-heuristic
8374 Enable the speculative instruction heuristic in the scheduler.  This
8375 heuristic favors speculative instructions with greater dependency weakness.
8376 This is enabled by default when scheduling is enabled, i.e.@:
8377 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8378 or at @option{-O2} or higher.
8380 @item -fsched-rank-heuristic
8381 @opindex fsched-rank-heuristic
8382 Enable the rank heuristic in the scheduler.  This heuristic favors
8383 the instruction belonging to a basic block with greater size or frequency.
8384 This is enabled by default when scheduling is enabled, i.e.@:
8385 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8386 at @option{-O2} or higher.
8388 @item -fsched-last-insn-heuristic
8389 @opindex fsched-last-insn-heuristic
8390 Enable the last-instruction heuristic in the scheduler.  This heuristic
8391 favors the instruction that is less dependent on the last instruction
8392 scheduled.  This is enabled by default when scheduling is enabled,
8393 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8394 at @option{-O2} or higher.
8396 @item -fsched-dep-count-heuristic
8397 @opindex fsched-dep-count-heuristic
8398 Enable the dependent-count heuristic in the scheduler.  This heuristic
8399 favors the instruction that has more instructions depending on it.
8400 This is enabled by default when scheduling is enabled, i.e.@:
8401 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8402 at @option{-O2} or higher.
8404 @item -freschedule-modulo-scheduled-loops
8405 @opindex freschedule-modulo-scheduled-loops
8406 Modulo scheduling is performed before traditional scheduling.  If a loop
8407 is modulo scheduled, later scheduling passes may change its schedule.  
8408 Use this option to control that behavior.
8410 @item -fselective-scheduling
8411 @opindex fselective-scheduling
8412 Schedule instructions using selective scheduling algorithm.  Selective
8413 scheduling runs instead of the first scheduler pass.
8415 @item -fselective-scheduling2
8416 @opindex fselective-scheduling2
8417 Schedule instructions using selective scheduling algorithm.  Selective
8418 scheduling runs instead of the second scheduler pass.
8420 @item -fsel-sched-pipelining
8421 @opindex fsel-sched-pipelining
8422 Enable software pipelining of innermost loops during selective scheduling.
8423 This option has no effect unless one of @option{-fselective-scheduling} or
8424 @option{-fselective-scheduling2} is turned on.
8426 @item -fsel-sched-pipelining-outer-loops
8427 @opindex fsel-sched-pipelining-outer-loops
8428 When pipelining loops during selective scheduling, also pipeline outer loops.
8429 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8431 @item -fsemantic-interposition
8432 @opindex fsemantic-interposition
8433 Some object formats, like ELF, allow interposing of symbols by the 
8434 dynamic linker.
8435 This means that for symbols exported from the DSO, the compiler cannot perform
8436 interprocedural propagation, inlining and other optimizations in anticipation
8437 that the function or variable in question may change. While this feature is
8438 useful, for example, to rewrite memory allocation functions by a debugging
8439 implementation, it is expensive in the terms of code quality.
8440 With @option{-fno-semantic-interposition} the compiler assumes that 
8441 if interposition happens for functions the overwriting function will have 
8442 precisely the same semantics (and side effects). 
8443 Similarly if interposition happens
8444 for variables, the constructor of the variable will be the same. The flag
8445 has no effect for functions explicitly declared inline 
8446 (where it is never allowed for interposition to change semantics) 
8447 and for symbols explicitly declared weak.
8449 @item -fshrink-wrap
8450 @opindex fshrink-wrap
8451 Emit function prologues only before parts of the function that need it,
8452 rather than at the top of the function.  This flag is enabled by default at
8453 @option{-O} and higher.
8455 @item -fshrink-wrap-separate
8456 @opindex fshrink-wrap-separate
8457 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8458 those parts are only executed when needed.
8459 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8460 is also turned on and the target supports this.
8462 @item -fcaller-saves
8463 @opindex fcaller-saves
8464 Enable allocation of values to registers that are clobbered by
8465 function calls, by emitting extra instructions to save and restore the
8466 registers around such calls.  Such allocation is done only when it
8467 seems to result in better code.
8469 This option is always enabled by default on certain machines, usually
8470 those which have no call-preserved registers to use instead.
8472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8474 @item -fcombine-stack-adjustments
8475 @opindex fcombine-stack-adjustments
8476 Tracks stack adjustments (pushes and pops) and stack memory references
8477 and then tries to find ways to combine them.
8479 Enabled by default at @option{-O1} and higher.
8481 @item -fipa-ra
8482 @opindex fipa-ra
8483 Use caller save registers for allocation if those registers are not used by
8484 any called function.  In that case it is not necessary to save and restore
8485 them around calls.  This is only possible if called functions are part of
8486 same compilation unit as current function and they are compiled before it.
8488 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8489 is disabled if generated code will be instrumented for profiling
8490 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8491 exactly (this happens on targets that do not expose prologues
8492 and epilogues in RTL).
8494 @item -fconserve-stack
8495 @opindex fconserve-stack
8496 Attempt to minimize stack usage.  The compiler attempts to use less
8497 stack space, even if that makes the program slower.  This option
8498 implies setting the @option{large-stack-frame} parameter to 100
8499 and the @option{large-stack-frame-growth} parameter to 400.
8501 @item -ftree-reassoc
8502 @opindex ftree-reassoc
8503 Perform reassociation on trees.  This flag is enabled by default
8504 at @option{-O} and higher.
8506 @item -fcode-hoisting
8507 @opindex fcode-hoisting
8508 Perform code hoisting.  Code hoisting tries to move the
8509 evaluation of expressions executed on all paths to the function exit
8510 as early as possible.  This is especially useful as a code size
8511 optimization, but it often helps for code speed as well.
8512 This flag is enabled by default at @option{-O2} and higher.
8514 @item -ftree-pre
8515 @opindex ftree-pre
8516 Perform partial redundancy elimination (PRE) on trees.  This flag is
8517 enabled by default at @option{-O2} and @option{-O3}.
8519 @item -ftree-partial-pre
8520 @opindex ftree-partial-pre
8521 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8522 enabled by default at @option{-O3}.
8524 @item -ftree-forwprop
8525 @opindex ftree-forwprop
8526 Perform forward propagation on trees.  This flag is enabled by default
8527 at @option{-O} and higher.
8529 @item -ftree-fre
8530 @opindex ftree-fre
8531 Perform full redundancy elimination (FRE) on trees.  The difference
8532 between FRE and PRE is that FRE only considers expressions
8533 that are computed on all paths leading to the redundant computation.
8534 This analysis is faster than PRE, though it exposes fewer redundancies.
8535 This flag is enabled by default at @option{-O} and higher.
8537 @item -ftree-phiprop
8538 @opindex ftree-phiprop
8539 Perform hoisting of loads from conditional pointers on trees.  This
8540 pass is enabled by default at @option{-O} and higher.
8542 @item -fhoist-adjacent-loads
8543 @opindex fhoist-adjacent-loads
8544 Speculatively hoist loads from both branches of an if-then-else if the
8545 loads are from adjacent locations in the same structure and the target
8546 architecture has a conditional move instruction.  This flag is enabled
8547 by default at @option{-O2} and higher.
8549 @item -ftree-copy-prop
8550 @opindex ftree-copy-prop
8551 Perform copy propagation on trees.  This pass eliminates unnecessary
8552 copy operations.  This flag is enabled by default at @option{-O} and
8553 higher.
8555 @item -fipa-pure-const
8556 @opindex fipa-pure-const
8557 Discover which functions are pure or constant.
8558 Enabled by default at @option{-O} and higher.
8560 @item -fipa-reference
8561 @opindex fipa-reference
8562 Discover which static variables do not escape the
8563 compilation unit.
8564 Enabled by default at @option{-O} and higher.
8566 @item -fipa-pta
8567 @opindex fipa-pta
8568 Perform interprocedural pointer analysis and interprocedural modification
8569 and reference analysis.  This option can cause excessive memory and
8570 compile-time usage on large compilation units.  It is not enabled by
8571 default at any optimization level.
8573 @item -fipa-profile
8574 @opindex fipa-profile
8575 Perform interprocedural profile propagation.  The functions called only from
8576 cold functions are marked as cold. Also functions executed once (such as
8577 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8578 functions and loop less parts of functions executed once are then optimized for
8579 size.
8580 Enabled by default at @option{-O} and higher.
8582 @item -fipa-cp
8583 @opindex fipa-cp
8584 Perform interprocedural constant propagation.
8585 This optimization analyzes the program to determine when values passed
8586 to functions are constants and then optimizes accordingly.
8587 This optimization can substantially increase performance
8588 if the application has constants passed to functions.
8589 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8591 @item -fipa-cp-clone
8592 @opindex fipa-cp-clone
8593 Perform function cloning to make interprocedural constant propagation stronger.
8594 When enabled, interprocedural constant propagation performs function cloning
8595 when externally visible function can be called with constant arguments.
8596 Because this optimization can create multiple copies of functions,
8597 it may significantly increase code size
8598 (see @option{--param ipcp-unit-growth=@var{value}}).
8599 This flag is enabled by default at @option{-O3}.
8601 @item -fipa-bit-cp
8602 @opindex -fipa-bit-cp
8603 When enabled, perform interprocedural bitwise constant
8604 propagation. This flag is enabled by default at @option{-O2}. It
8605 requires that @option{-fipa-cp} is enabled.
8607 @item -fipa-vrp
8608 @opindex -fipa-vrp
8609 When enabled, perform interprocedural propagation of value
8610 ranges. This flag is enabled by default at @option{-O2}. It requires
8611 that @option{-fipa-cp} is enabled.
8613 @item -fipa-icf
8614 @opindex fipa-icf
8615 Perform Identical Code Folding for functions and read-only variables.
8616 The optimization reduces code size and may disturb unwind stacks by replacing
8617 a function by equivalent one with a different name. The optimization works
8618 more effectively with link-time optimization enabled.
8620 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8621 works on different levels and thus the optimizations are not same - there are
8622 equivalences that are found only by GCC and equivalences found only by Gold.
8624 This flag is enabled by default at @option{-O2} and @option{-Os}.
8626 @item -fisolate-erroneous-paths-dereference
8627 @opindex fisolate-erroneous-paths-dereference
8628 Detect paths that trigger erroneous or undefined behavior due to
8629 dereferencing a null pointer.  Isolate those paths from the main control
8630 flow and turn the statement with erroneous or undefined behavior into a trap.
8631 This flag is enabled by default at @option{-O2} and higher and depends on
8632 @option{-fdelete-null-pointer-checks} also being enabled.
8634 @item -fisolate-erroneous-paths-attribute
8635 @opindex fisolate-erroneous-paths-attribute
8636 Detect paths that trigger erroneous or undefined behavior due to a null value
8637 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8638 attribute.  Isolate those paths from the main control flow and turn the
8639 statement with erroneous or undefined behavior into a trap.  This is not
8640 currently enabled, but may be enabled by @option{-O2} in the future.
8642 @item -ftree-sink
8643 @opindex ftree-sink
8644 Perform forward store motion on trees.  This flag is
8645 enabled by default at @option{-O} and higher.
8647 @item -ftree-bit-ccp
8648 @opindex ftree-bit-ccp
8649 Perform sparse conditional bit constant propagation on trees and propagate
8650 pointer alignment information.
8651 This pass only operates on local scalar variables and is enabled by default
8652 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8654 @item -ftree-ccp
8655 @opindex ftree-ccp
8656 Perform sparse conditional constant propagation (CCP) on trees.  This
8657 pass only operates on local scalar variables and is enabled by default
8658 at @option{-O} and higher.
8660 @item -fssa-backprop
8661 @opindex fssa-backprop
8662 Propagate information about uses of a value up the definition chain
8663 in order to simplify the definitions.  For example, this pass strips
8664 sign operations if the sign of a value never matters.  The flag is
8665 enabled by default at @option{-O} and higher.
8667 @item -fssa-phiopt
8668 @opindex fssa-phiopt
8669 Perform pattern matching on SSA PHI nodes to optimize conditional
8670 code.  This pass is enabled by default at @option{-O} and higher.
8672 @item -ftree-switch-conversion
8673 @opindex ftree-switch-conversion
8674 Perform conversion of simple initializations in a switch to
8675 initializations from a scalar array.  This flag is enabled by default
8676 at @option{-O2} and higher.
8678 @item -ftree-tail-merge
8679 @opindex ftree-tail-merge
8680 Look for identical code sequences.  When found, replace one with a jump to the
8681 other.  This optimization is known as tail merging or cross jumping.  This flag
8682 is enabled by default at @option{-O2} and higher.  The compilation time
8683 in this pass can
8684 be limited using @option{max-tail-merge-comparisons} parameter and
8685 @option{max-tail-merge-iterations} parameter.
8687 @item -ftree-dce
8688 @opindex ftree-dce
8689 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8690 default at @option{-O} and higher.
8692 @item -ftree-builtin-call-dce
8693 @opindex ftree-builtin-call-dce
8694 Perform conditional dead code elimination (DCE) for calls to built-in functions
8695 that may set @code{errno} but are otherwise free of side effects.  This flag is
8696 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8697 specified.
8699 @item -ftree-dominator-opts
8700 @opindex ftree-dominator-opts
8701 Perform a variety of simple scalar cleanups (constant/copy
8702 propagation, redundancy elimination, range propagation and expression
8703 simplification) based on a dominator tree traversal.  This also
8704 performs jump threading (to reduce jumps to jumps). This flag is
8705 enabled by default at @option{-O} and higher.
8707 @item -ftree-dse
8708 @opindex ftree-dse
8709 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8710 a memory location that is later overwritten by another store without
8711 any intervening loads.  In this case the earlier store can be deleted.  This
8712 flag is enabled by default at @option{-O} and higher.
8714 @item -ftree-ch
8715 @opindex ftree-ch
8716 Perform loop header copying on trees.  This is beneficial since it increases
8717 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8718 is enabled by default at @option{-O} and higher.  It is not enabled
8719 for @option{-Os}, since it usually increases code size.
8721 @item -ftree-loop-optimize
8722 @opindex ftree-loop-optimize
8723 Perform loop optimizations on trees.  This flag is enabled by default
8724 at @option{-O} and higher.
8726 @item -ftree-loop-linear
8727 @itemx -floop-strip-mine
8728 @itemx -floop-block
8729 @opindex ftree-loop-linear
8730 @opindex floop-strip-mine
8731 @opindex floop-block
8732 Perform loop nest optimizations.  Same as
8733 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8734 to be configured with @option{--with-isl} to enable the Graphite loop
8735 transformation infrastructure.
8737 @item -fgraphite-identity
8738 @opindex fgraphite-identity
8739 Enable the identity transformation for graphite.  For every SCoP we generate
8740 the polyhedral representation and transform it back to gimple.  Using
8741 @option{-fgraphite-identity} we can check the costs or benefits of the
8742 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8743 are also performed by the code generator isl, like index splitting and
8744 dead code elimination in loops.
8746 @item -floop-nest-optimize
8747 @opindex floop-nest-optimize
8748 Enable the isl based loop nest optimizer.  This is a generic loop nest
8749 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8750 structure optimized for data-locality and parallelism.  This option
8751 is experimental.
8753 @item -floop-parallelize-all
8754 @opindex floop-parallelize-all
8755 Use the Graphite data dependence analysis to identify loops that can
8756 be parallelized.  Parallelize all the loops that can be analyzed to
8757 not contain loop carried dependences without checking that it is
8758 profitable to parallelize the loops.
8760 @item -ftree-coalesce-vars
8761 @opindex ftree-coalesce-vars
8762 While transforming the program out of the SSA representation, attempt to
8763 reduce copying by coalescing versions of different user-defined
8764 variables, instead of just compiler temporaries.  This may severely
8765 limit the ability to debug an optimized program compiled with
8766 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8767 prevents SSA coalescing of user variables.  This option is enabled by
8768 default if optimization is enabled, and it does very little otherwise.
8770 @item -ftree-loop-if-convert
8771 @opindex ftree-loop-if-convert
8772 Attempt to transform conditional jumps in the innermost loops to
8773 branch-less equivalents.  The intent is to remove control-flow from
8774 the innermost loops in order to improve the ability of the
8775 vectorization pass to handle these loops.  This is enabled by default
8776 if vectorization is enabled.
8778 @item -ftree-loop-distribution
8779 @opindex ftree-loop-distribution
8780 Perform loop distribution.  This flag can improve cache performance on
8781 big loop bodies and allow further loop optimizations, like
8782 parallelization or vectorization, to take place.  For example, the loop
8783 @smallexample
8784 DO I = 1, N
8785   A(I) = B(I) + C
8786   D(I) = E(I) * F
8787 ENDDO
8788 @end smallexample
8789 is transformed to
8790 @smallexample
8791 DO I = 1, N
8792    A(I) = B(I) + C
8793 ENDDO
8794 DO I = 1, N
8795    D(I) = E(I) * F
8796 ENDDO
8797 @end smallexample
8799 @item -ftree-loop-distribute-patterns
8800 @opindex ftree-loop-distribute-patterns
8801 Perform loop distribution of patterns that can be code generated with
8802 calls to a library.  This flag is enabled by default at @option{-O3}.
8804 This pass distributes the initialization loops and generates a call to
8805 memset zero.  For example, the loop
8806 @smallexample
8807 DO I = 1, N
8808   A(I) = 0
8809   B(I) = A(I) + I
8810 ENDDO
8811 @end smallexample
8812 is transformed to
8813 @smallexample
8814 DO I = 1, N
8815    A(I) = 0
8816 ENDDO
8817 DO I = 1, N
8818    B(I) = A(I) + I
8819 ENDDO
8820 @end smallexample
8821 and the initialization loop is transformed into a call to memset zero.
8823 @item -floop-interchange
8824 @opindex floop-interchange
8825 Perform loop interchange outside of graphite.  This flag can improve cache
8826 performance on loop nest and allow further loop optimizations, like
8827 vectorization, to take place.  For example, the loop
8828 @smallexample
8829 for (int i = 0; i < N; i++)
8830   for (int j = 0; j < N; j++)
8831     for (int k = 0; k < N; k++)
8832       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8833 @end smallexample
8834 is transformed to
8835 @smallexample
8836 for (int i = 0; i < N; i++)
8837   for (int k = 0; k < N; k++)
8838     for (int j = 0; j < N; j++)
8839       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8840 @end smallexample
8842 @item -ftree-loop-im
8843 @opindex ftree-loop-im
8844 Perform loop invariant motion on trees.  This pass moves only invariants that
8845 are hard to handle at RTL level (function calls, operations that expand to
8846 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8847 operands of conditions that are invariant out of the loop, so that we can use
8848 just trivial invariantness analysis in loop unswitching.  The pass also includes
8849 store motion.
8851 @item -ftree-loop-ivcanon
8852 @opindex ftree-loop-ivcanon
8853 Create a canonical counter for number of iterations in loops for which
8854 determining number of iterations requires complicated analysis.  Later
8855 optimizations then may determine the number easily.  Useful especially
8856 in connection with unrolling.
8858 @item -fivopts
8859 @opindex fivopts
8860 Perform induction variable optimizations (strength reduction, induction
8861 variable merging and induction variable elimination) on trees.
8863 @item -ftree-parallelize-loops=n
8864 @opindex ftree-parallelize-loops
8865 Parallelize loops, i.e., split their iteration space to run in n threads.
8866 This is only possible for loops whose iterations are independent
8867 and can be arbitrarily reordered.  The optimization is only
8868 profitable on multiprocessor machines, for loops that are CPU-intensive,
8869 rather than constrained e.g.@: by memory bandwidth.  This option
8870 implies @option{-pthread}, and thus is only supported on targets
8871 that have support for @option{-pthread}.
8873 @item -ftree-pta
8874 @opindex ftree-pta
8875 Perform function-local points-to analysis on trees.  This flag is
8876 enabled by default at @option{-O} and higher.
8878 @item -ftree-sra
8879 @opindex ftree-sra
8880 Perform scalar replacement of aggregates.  This pass replaces structure
8881 references with scalars to prevent committing structures to memory too
8882 early.  This flag is enabled by default at @option{-O} and higher.
8884 @item -fstore-merging
8885 @opindex fstore-merging
8886 Perform merging of narrow stores to consecutive memory addresses.  This pass
8887 merges contiguous stores of immediate values narrower than a word into fewer
8888 wider stores to reduce the number of instructions.  This is enabled by default
8889 at @option{-O2} and higher as well as @option{-Os}.
8891 @item -ftree-ter
8892 @opindex ftree-ter
8893 Perform temporary expression replacement during the SSA->normal phase.  Single
8894 use/single def temporaries are replaced at their use location with their
8895 defining expression.  This results in non-GIMPLE code, but gives the expanders
8896 much more complex trees to work on resulting in better RTL generation.  This is
8897 enabled by default at @option{-O} and higher.
8899 @item -ftree-slsr
8900 @opindex ftree-slsr
8901 Perform straight-line strength reduction on trees.  This recognizes related
8902 expressions involving multiplications and replaces them by less expensive
8903 calculations when possible.  This is enabled by default at @option{-O} and
8904 higher.
8906 @item -ftree-vectorize
8907 @opindex ftree-vectorize
8908 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8909 and @option{-ftree-slp-vectorize} if not explicitly specified.
8911 @item -ftree-loop-vectorize
8912 @opindex ftree-loop-vectorize
8913 Perform loop vectorization on trees. This flag is enabled by default at
8914 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8916 @item -ftree-slp-vectorize
8917 @opindex ftree-slp-vectorize
8918 Perform basic block vectorization on trees. This flag is enabled by default at
8919 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8921 @item -fvect-cost-model=@var{model}
8922 @opindex fvect-cost-model
8923 Alter the cost model used for vectorization.  The @var{model} argument
8924 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8925 With the @samp{unlimited} model the vectorized code-path is assumed
8926 to be profitable while with the @samp{dynamic} model a runtime check
8927 guards the vectorized code-path to enable it only for iteration
8928 counts that will likely execute faster than when executing the original
8929 scalar loop.  The @samp{cheap} model disables vectorization of
8930 loops where doing so would be cost prohibitive for example due to
8931 required runtime checks for data dependence or alignment but otherwise
8932 is equal to the @samp{dynamic} model.
8933 The default cost model depends on other optimization flags and is
8934 either @samp{dynamic} or @samp{cheap}.
8936 @item -fsimd-cost-model=@var{model}
8937 @opindex fsimd-cost-model
8938 Alter the cost model used for vectorization of loops marked with the OpenMP
8939 simd directive.  The @var{model} argument should be one of
8940 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8941 have the same meaning as described in @option{-fvect-cost-model} and by
8942 default a cost model defined with @option{-fvect-cost-model} is used.
8944 @item -ftree-vrp
8945 @opindex ftree-vrp
8946 Perform Value Range Propagation on trees.  This is similar to the
8947 constant propagation pass, but instead of values, ranges of values are
8948 propagated.  This allows the optimizers to remove unnecessary range
8949 checks like array bound checks and null pointer checks.  This is
8950 enabled by default at @option{-O2} and higher.  Null pointer check
8951 elimination is only done if @option{-fdelete-null-pointer-checks} is
8952 enabled.
8954 @item -fsplit-paths
8955 @opindex fsplit-paths
8956 Split paths leading to loop backedges.  This can improve dead code
8957 elimination and common subexpression elimination.  This is enabled by
8958 default at @option{-O2} and above.
8960 @item -fsplit-ivs-in-unroller
8961 @opindex fsplit-ivs-in-unroller
8962 Enables expression of values of induction variables in later iterations
8963 of the unrolled loop using the value in the first iteration.  This breaks
8964 long dependency chains, thus improving efficiency of the scheduling passes.
8966 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8967 same effect.  However, that is not reliable in cases where the loop body
8968 is more complicated than a single basic block.  It also does not work at all
8969 on some architectures due to restrictions in the CSE pass.
8971 This optimization is enabled by default.
8973 @item -fvariable-expansion-in-unroller
8974 @opindex fvariable-expansion-in-unroller
8975 With this option, the compiler creates multiple copies of some
8976 local variables when unrolling a loop, which can result in superior code.
8978 @item -fpartial-inlining
8979 @opindex fpartial-inlining
8980 Inline parts of functions.  This option has any effect only
8981 when inlining itself is turned on by the @option{-finline-functions}
8982 or @option{-finline-small-functions} options.
8984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8986 @item -fpredictive-commoning
8987 @opindex fpredictive-commoning
8988 Perform predictive commoning optimization, i.e., reusing computations
8989 (especially memory loads and stores) performed in previous
8990 iterations of loops.
8992 This option is enabled at level @option{-O3}.
8994 @item -fprefetch-loop-arrays
8995 @opindex fprefetch-loop-arrays
8996 If supported by the target machine, generate instructions to prefetch
8997 memory to improve the performance of loops that access large arrays.
8999 This option may generate better or worse code; results are highly
9000 dependent on the structure of loops within the source code.
9002 Disabled at level @option{-Os}.
9004 @item -fno-printf-return-value
9005 @opindex fno-printf-return-value
9006 Do not substitute constants for known return value of formatted output
9007 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9008 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9009 transformation allows GCC to optimize or even eliminate branches based
9010 on the known return value of these functions called with arguments that
9011 are either constant, or whose values are known to be in a range that
9012 makes determining the exact return value possible.  For example, when
9013 @option{-fprintf-return-value} is in effect, both the branch and the
9014 body of the @code{if} statement (but not the call to @code{snprint})
9015 can be optimized away when @code{i} is a 32-bit or smaller integer
9016 because the return value is guaranteed to be at most 8.
9018 @smallexample
9019 char buf[9];
9020 if (snprintf (buf, "%08x", i) >= sizeof buf)
9021   @dots{}
9022 @end smallexample
9024 The @option{-fprintf-return-value} option relies on other optimizations
9025 and yields best results with @option{-O2} and above.  It works in tandem
9026 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9027 options.  The @option{-fprintf-return-value} option is enabled by default.
9029 @item -fno-peephole
9030 @itemx -fno-peephole2
9031 @opindex fno-peephole
9032 @opindex fno-peephole2
9033 Disable any machine-specific peephole optimizations.  The difference
9034 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9035 are implemented in the compiler; some targets use one, some use the
9036 other, a few use both.
9038 @option{-fpeephole} is enabled by default.
9039 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9041 @item -fno-guess-branch-probability
9042 @opindex fno-guess-branch-probability
9043 Do not guess branch probabilities using heuristics.
9045 GCC uses heuristics to guess branch probabilities if they are
9046 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9047 heuristics are based on the control flow graph.  If some branch probabilities
9048 are specified by @code{__builtin_expect}, then the heuristics are
9049 used to guess branch probabilities for the rest of the control flow graph,
9050 taking the @code{__builtin_expect} info into account.  The interactions
9051 between the heuristics and @code{__builtin_expect} can be complex, and in
9052 some cases, it may be useful to disable the heuristics so that the effects
9053 of @code{__builtin_expect} are easier to understand.
9055 The default is @option{-fguess-branch-probability} at levels
9056 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9058 @item -freorder-blocks
9059 @opindex freorder-blocks
9060 Reorder basic blocks in the compiled function in order to reduce number of
9061 taken branches and improve code locality.
9063 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9065 @item -freorder-blocks-algorithm=@var{algorithm}
9066 @opindex freorder-blocks-algorithm
9067 Use the specified algorithm for basic block reordering.  The
9068 @var{algorithm} argument can be @samp{simple}, which does not increase
9069 code size (except sometimes due to secondary effects like alignment),
9070 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9071 put all often executed code together, minimizing the number of branches
9072 executed by making extra copies of code.
9074 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9075 @samp{stc} at levels @option{-O2}, @option{-O3}.
9077 @item -freorder-blocks-and-partition
9078 @opindex freorder-blocks-and-partition
9079 In addition to reordering basic blocks in the compiled function, in order
9080 to reduce number of taken branches, partitions hot and cold basic blocks
9081 into separate sections of the assembly and @file{.o} files, to improve
9082 paging and cache locality performance.
9084 This optimization is automatically turned off in the presence of
9085 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9086 section attribute and on any architecture that does not support named
9087 sections.  When @option{-fsplit-stack} is used this option is not
9088 enabled by default (to avoid linker errors), but may be enabled
9089 explicitly (if using a working linker).
9091 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9093 @item -freorder-functions
9094 @opindex freorder-functions
9095 Reorder functions in the object file in order to
9096 improve code locality.  This is implemented by using special
9097 subsections @code{.text.hot} for most frequently executed functions and
9098 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9099 the linker so object file format must support named sections and linker must
9100 place them in a reasonable way.
9102 Also profile feedback must be available to make this option effective.  See
9103 @option{-fprofile-arcs} for details.
9105 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9107 @item -fstrict-aliasing
9108 @opindex fstrict-aliasing
9109 Allow the compiler to assume the strictest aliasing rules applicable to
9110 the language being compiled.  For C (and C++), this activates
9111 optimizations based on the type of expressions.  In particular, an
9112 object of one type is assumed never to reside at the same address as an
9113 object of a different type, unless the types are almost the same.  For
9114 example, an @code{unsigned int} can alias an @code{int}, but not a
9115 @code{void*} or a @code{double}.  A character type may alias any other
9116 type.
9118 @anchor{Type-punning}Pay special attention to code like this:
9119 @smallexample
9120 union a_union @{
9121   int i;
9122   double d;
9125 int f() @{
9126   union a_union t;
9127   t.d = 3.0;
9128   return t.i;
9130 @end smallexample
9131 The practice of reading from a different union member than the one most
9132 recently written to (called ``type-punning'') is common.  Even with
9133 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9134 is accessed through the union type.  So, the code above works as
9135 expected.  @xref{Structures unions enumerations and bit-fields
9136 implementation}.  However, this code might not:
9137 @smallexample
9138 int f() @{
9139   union a_union t;
9140   int* ip;
9141   t.d = 3.0;
9142   ip = &t.i;
9143   return *ip;
9145 @end smallexample
9147 Similarly, access by taking the address, casting the resulting pointer
9148 and dereferencing the result has undefined behavior, even if the cast
9149 uses a union type, e.g.:
9150 @smallexample
9151 int f() @{
9152   double d = 3.0;
9153   return ((union a_union *) &d)->i;
9155 @end smallexample
9157 The @option{-fstrict-aliasing} option is enabled at levels
9158 @option{-O2}, @option{-O3}, @option{-Os}.
9160 @item -falign-functions
9161 @itemx -falign-functions=@var{n}
9162 @opindex falign-functions
9163 Align the start of functions to the next power-of-two greater than
9164 @var{n}, skipping up to @var{n} bytes.  For instance,
9165 @option{-falign-functions=32} aligns functions to the next 32-byte
9166 boundary, but @option{-falign-functions=24} aligns to the next
9167 32-byte boundary only if this can be done by skipping 23 bytes or less.
9169 @option{-fno-align-functions} and @option{-falign-functions=1} are
9170 equivalent and mean that functions are not aligned.
9172 Some assemblers only support this flag when @var{n} is a power of two;
9173 in that case, it is rounded up.
9175 If @var{n} is not specified or is zero, use a machine-dependent default.
9176 The maximum allowed @var{n} option value is 65536.
9178 Enabled at levels @option{-O2}, @option{-O3}.
9180 @item -flimit-function-alignment
9181 If this option is enabled, the compiler tries to avoid unnecessarily
9182 overaligning functions. It attempts to instruct the assembler to align
9183 by the amount specified by @option{-falign-functions}, but not to
9184 skip more bytes than the size of the function.
9186 @item -falign-labels
9187 @itemx -falign-labels=@var{n}
9188 @opindex falign-labels
9189 Align all branch targets to a power-of-two boundary, skipping up to
9190 @var{n} bytes like @option{-falign-functions}.  This option can easily
9191 make code slower, because it must insert dummy operations for when the
9192 branch target is reached in the usual flow of the code.
9194 @option{-fno-align-labels} and @option{-falign-labels=1} are
9195 equivalent and mean that labels are not aligned.
9197 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9198 are greater than this value, then their values are used instead.
9200 If @var{n} is not specified or is zero, use a machine-dependent default
9201 which is very likely to be @samp{1}, meaning no alignment.
9202 The maximum allowed @var{n} option value is 65536.
9204 Enabled at levels @option{-O2}, @option{-O3}.
9206 @item -falign-loops
9207 @itemx -falign-loops=@var{n}
9208 @opindex falign-loops
9209 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9210 like @option{-falign-functions}.  If the loops are
9211 executed many times, this makes up for any execution of the dummy
9212 operations.
9214 @option{-fno-align-loops} and @option{-falign-loops=1} are
9215 equivalent and mean that loops are not aligned.
9216 The maximum allowed @var{n} option value is 65536.
9218 If @var{n} is not specified or is zero, use a machine-dependent default.
9220 Enabled at levels @option{-O2}, @option{-O3}.
9222 @item -falign-jumps
9223 @itemx -falign-jumps=@var{n}
9224 @opindex falign-jumps
9225 Align branch targets to a power-of-two boundary, for branch targets
9226 where the targets can only be reached by jumping, skipping up to @var{n}
9227 bytes like @option{-falign-functions}.  In this case, no dummy operations
9228 need be executed.
9230 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9231 equivalent and mean that loops are not aligned.
9233 If @var{n} is not specified or is zero, use a machine-dependent default.
9234 The maximum allowed @var{n} option value is 65536.
9236 Enabled at levels @option{-O2}, @option{-O3}.
9238 @item -funit-at-a-time
9239 @opindex funit-at-a-time
9240 This option is left for compatibility reasons. @option{-funit-at-a-time}
9241 has no effect, while @option{-fno-unit-at-a-time} implies
9242 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9244 Enabled by default.
9246 @item -fno-toplevel-reorder
9247 @opindex fno-toplevel-reorder
9248 Do not reorder top-level functions, variables, and @code{asm}
9249 statements.  Output them in the same order that they appear in the
9250 input file.  When this option is used, unreferenced static variables
9251 are not removed.  This option is intended to support existing code
9252 that relies on a particular ordering.  For new code, it is better to
9253 use attributes when possible.
9255 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9256 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9257 targets.
9259 @item -fweb
9260 @opindex fweb
9261 Constructs webs as commonly used for register allocation purposes and assign
9262 each web individual pseudo register.  This allows the register allocation pass
9263 to operate on pseudos directly, but also strengthens several other optimization
9264 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9265 however, make debugging impossible, since variables no longer stay in a
9266 ``home register''.
9268 Enabled by default with @option{-funroll-loops}.
9270 @item -fwhole-program
9271 @opindex fwhole-program
9272 Assume that the current compilation unit represents the whole program being
9273 compiled.  All public functions and variables with the exception of @code{main}
9274 and those merged by attribute @code{externally_visible} become static functions
9275 and in effect are optimized more aggressively by interprocedural optimizers.
9277 This option should not be used in combination with @option{-flto}.
9278 Instead relying on a linker plugin should provide safer and more precise
9279 information.
9281 @item -flto[=@var{n}]
9282 @opindex flto
9283 This option runs the standard link-time optimizer.  When invoked
9284 with source code, it generates GIMPLE (one of GCC's internal
9285 representations) and writes it to special ELF sections in the object
9286 file.  When the object files are linked together, all the function
9287 bodies are read from these ELF sections and instantiated as if they
9288 had been part of the same translation unit.
9290 To use the link-time optimizer, @option{-flto} and optimization
9291 options should be specified at compile time and during the final link.
9292 It is recommended that you compile all the files participating in the
9293 same link with the same options and also specify those options at
9294 link time.  
9295 For example:
9297 @smallexample
9298 gcc -c -O2 -flto foo.c
9299 gcc -c -O2 -flto bar.c
9300 gcc -o myprog -flto -O2 foo.o bar.o
9301 @end smallexample
9303 The first two invocations to GCC save a bytecode representation
9304 of GIMPLE into special ELF sections inside @file{foo.o} and
9305 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9306 @file{foo.o} and @file{bar.o}, merges the two files into a single
9307 internal image, and compiles the result as usual.  Since both
9308 @file{foo.o} and @file{bar.o} are merged into a single image, this
9309 causes all the interprocedural analyses and optimizations in GCC to
9310 work across the two files as if they were a single one.  This means,
9311 for example, that the inliner is able to inline functions in
9312 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9314 Another (simpler) way to enable link-time optimization is:
9316 @smallexample
9317 gcc -o myprog -flto -O2 foo.c bar.c
9318 @end smallexample
9320 The above generates bytecode for @file{foo.c} and @file{bar.c},
9321 merges them together into a single GIMPLE representation and optimizes
9322 them as usual to produce @file{myprog}.
9324 The only important thing to keep in mind is that to enable link-time
9325 optimizations you need to use the GCC driver to perform the link step.
9326 GCC then automatically performs link-time optimization if any of the
9327 objects involved were compiled with the @option{-flto} command-line option.  
9328 You generally
9329 should specify the optimization options to be used for link-time
9330 optimization though GCC tries to be clever at guessing an
9331 optimization level to use from the options used at compile time
9332 if you fail to specify one at link time.  You can always override
9333 the automatic decision to do link-time optimization
9334 by passing @option{-fno-lto} to the link command.
9336 To make whole program optimization effective, it is necessary to make
9337 certain whole program assumptions.  The compiler needs to know
9338 what functions and variables can be accessed by libraries and runtime
9339 outside of the link-time optimized unit.  When supported by the linker,
9340 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9341 to the compiler about used and externally visible symbols.  When
9342 the linker plugin is not available, @option{-fwhole-program} should be
9343 used to allow the compiler to make these assumptions, which leads
9344 to more aggressive optimization decisions.
9346 When @option{-fuse-linker-plugin} is not enabled, when a file is
9347 compiled with @option{-flto}, the generated object file is larger than
9348 a regular object file because it contains GIMPLE bytecodes and the usual
9349 final code (see @option{-ffat-lto-objects}.  This means that
9350 object files with LTO information can be linked as normal object
9351 files; if @option{-fno-lto} is passed to the linker, no
9352 interprocedural optimizations are applied.  Note that when
9353 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9354 but you cannot perform a regular, non-LTO link on them.
9356 Additionally, the optimization flags used to compile individual files
9357 are not necessarily related to those used at link time.  For instance,
9359 @smallexample
9360 gcc -c -O0 -ffat-lto-objects -flto foo.c
9361 gcc -c -O0 -ffat-lto-objects -flto bar.c
9362 gcc -o myprog -O3 foo.o bar.o
9363 @end smallexample
9365 This produces individual object files with unoptimized assembler
9366 code, but the resulting binary @file{myprog} is optimized at
9367 @option{-O3}.  If, instead, the final binary is generated with
9368 @option{-fno-lto}, then @file{myprog} is not optimized.
9370 When producing the final binary, GCC only
9371 applies link-time optimizations to those files that contain bytecode.
9372 Therefore, you can mix and match object files and libraries with
9373 GIMPLE bytecodes and final object code.  GCC automatically selects
9374 which files to optimize in LTO mode and which files to link without
9375 further processing.
9377 There are some code generation flags preserved by GCC when
9378 generating bytecodes, as they need to be used during the final link
9379 stage.  Generally options specified at link time override those
9380 specified at compile time.
9382 If you do not specify an optimization level option @option{-O} at
9383 link time, then GCC uses the highest optimization level 
9384 used when compiling the object files.
9386 Currently, the following options and their settings are taken from
9387 the first object file that explicitly specifies them: 
9388 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9389 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9390 and all the @option{-m} target flags.
9392 Certain ABI-changing flags are required to match in all compilation units,
9393 and trying to override this at link time with a conflicting value
9394 is ignored.  This includes options such as @option{-freg-struct-return}
9395 and @option{-fpcc-struct-return}. 
9397 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9398 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9399 are passed through to the link stage and merged conservatively for
9400 conflicting translation units.  Specifically
9401 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9402 precedence; and for example @option{-ffp-contract=off} takes precedence
9403 over @option{-ffp-contract=fast}.  You can override them at link time.
9405 If LTO encounters objects with C linkage declared with incompatible
9406 types in separate translation units to be linked together (undefined
9407 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9408 issued.  The behavior is still undefined at run time.  Similar
9409 diagnostics may be raised for other languages.
9411 Another feature of LTO is that it is possible to apply interprocedural
9412 optimizations on files written in different languages:
9414 @smallexample
9415 gcc -c -flto foo.c
9416 g++ -c -flto bar.cc
9417 gfortran -c -flto baz.f90
9418 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9419 @end smallexample
9421 Notice that the final link is done with @command{g++} to get the C++
9422 runtime libraries and @option{-lgfortran} is added to get the Fortran
9423 runtime libraries.  In general, when mixing languages in LTO mode, you
9424 should use the same link command options as when mixing languages in a
9425 regular (non-LTO) compilation.
9427 If object files containing GIMPLE bytecode are stored in a library archive, say
9428 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9429 are using a linker with plugin support.  To create static libraries suitable
9430 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9431 and @command{ranlib}; 
9432 to show the symbols of object files with GIMPLE bytecode, use
9433 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9434 and @command{nm} have been compiled with plugin support.  At link time, use the the
9435 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9436 the LTO optimization process:
9438 @smallexample
9439 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9440 @end smallexample
9442 With the linker plugin enabled, the linker extracts the needed
9443 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9444 to make them part of the aggregated GIMPLE image to be optimized.
9446 If you are not using a linker with plugin support and/or do not
9447 enable the linker plugin, then the objects inside @file{libfoo.a}
9448 are extracted and linked as usual, but they do not participate
9449 in the LTO optimization process.  In order to make a static library suitable
9450 for both LTO optimization and usual linkage, compile its object files with
9451 @option{-flto} @option{-ffat-lto-objects}.
9453 Link-time optimizations do not require the presence of the whole program to
9454 operate.  If the program does not require any symbols to be exported, it is
9455 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9456 the interprocedural optimizers to use more aggressive assumptions which may
9457 lead to improved optimization opportunities.
9458 Use of @option{-fwhole-program} is not needed when linker plugin is
9459 active (see @option{-fuse-linker-plugin}).
9461 The current implementation of LTO makes no
9462 attempt to generate bytecode that is portable between different
9463 types of hosts.  The bytecode files are versioned and there is a
9464 strict version check, so bytecode files generated in one version of
9465 GCC do not work with an older or newer version of GCC.
9467 Link-time optimization does not work well with generation of debugging
9468 information on systems other than those using a combination of ELF and
9469 DWARF.
9471 If you specify the optional @var{n}, the optimization and code
9472 generation done at link time is executed in parallel using @var{n}
9473 parallel jobs by utilizing an installed @command{make} program.  The
9474 environment variable @env{MAKE} may be used to override the program
9475 used.  The default value for @var{n} is 1.
9477 You can also specify @option{-flto=jobserver} to use GNU make's
9478 job server mode to determine the number of parallel jobs. This
9479 is useful when the Makefile calling GCC is already executing in parallel.
9480 You must prepend a @samp{+} to the command recipe in the parent Makefile
9481 for this to work.  This option likely only works if @env{MAKE} is
9482 GNU make.
9484 @item -flto-partition=@var{alg}
9485 @opindex flto-partition
9486 Specify the partitioning algorithm used by the link-time optimizer.
9487 The value is either @samp{1to1} to specify a partitioning mirroring
9488 the original source files or @samp{balanced} to specify partitioning
9489 into equally sized chunks (whenever possible) or @samp{max} to create
9490 new partition for every symbol where possible.  Specifying @samp{none}
9491 as an algorithm disables partitioning and streaming completely. 
9492 The default value is @samp{balanced}. While @samp{1to1} can be used
9493 as an workaround for various code ordering issues, the @samp{max}
9494 partitioning is intended for internal testing only.
9495 The value @samp{one} specifies that exactly one partition should be
9496 used while the value @samp{none} bypasses partitioning and executes
9497 the link-time optimization step directly from the WPA phase.
9499 @item -flto-odr-type-merging
9500 @opindex flto-odr-type-merging
9501 Enable streaming of mangled types names of C++ types and their unification
9502 at link time.  This increases size of LTO object files, but enables
9503 diagnostics about One Definition Rule violations.
9505 @item -flto-compression-level=@var{n}
9506 @opindex flto-compression-level
9507 This option specifies the level of compression used for intermediate
9508 language written to LTO object files, and is only meaningful in
9509 conjunction with LTO mode (@option{-flto}).  Valid
9510 values are 0 (no compression) to 9 (maximum compression).  Values
9511 outside this range are clamped to either 0 or 9.  If the option is not
9512 given, a default balanced compression setting is used.
9514 @item -fuse-linker-plugin
9515 @opindex fuse-linker-plugin
9516 Enables the use of a linker plugin during link-time optimization.  This
9517 option relies on plugin support in the linker, which is available in gold
9518 or in GNU ld 2.21 or newer.
9520 This option enables the extraction of object files with GIMPLE bytecode out
9521 of library archives. This improves the quality of optimization by exposing
9522 more code to the link-time optimizer.  This information specifies what
9523 symbols can be accessed externally (by non-LTO object or during dynamic
9524 linking).  Resulting code quality improvements on binaries (and shared
9525 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9526 See @option{-flto} for a description of the effect of this flag and how to
9527 use it.
9529 This option is enabled by default when LTO support in GCC is enabled
9530 and GCC was configured for use with
9531 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9533 @item -ffat-lto-objects
9534 @opindex ffat-lto-objects
9535 Fat LTO objects are object files that contain both the intermediate language
9536 and the object code. This makes them usable for both LTO linking and normal
9537 linking. This option is effective only when compiling with @option{-flto}
9538 and is ignored at link time.
9540 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9541 requires the complete toolchain to be aware of LTO. It requires a linker with
9542 linker plugin support for basic functionality.  Additionally,
9543 @command{nm}, @command{ar} and @command{ranlib}
9544 need to support linker plugins to allow a full-featured build environment
9545 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9546 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9547 to these tools. With non fat LTO makefiles need to be modified to use them.
9549 Note that modern binutils provide plugin auto-load mechanism.
9550 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9551 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9552 @command{gcc-ranlib}).
9554 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9555 support.
9557 @item -fcompare-elim
9558 @opindex fcompare-elim
9559 After register allocation and post-register allocation instruction splitting,
9560 identify arithmetic instructions that compute processor flags similar to a
9561 comparison operation based on that arithmetic.  If possible, eliminate the
9562 explicit comparison operation.
9564 This pass only applies to certain targets that cannot explicitly represent
9565 the comparison operation before register allocation is complete.
9567 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9569 @item -fcprop-registers
9570 @opindex fcprop-registers
9571 After register allocation and post-register allocation instruction splitting,
9572 perform a copy-propagation pass to try to reduce scheduling dependencies
9573 and occasionally eliminate the copy.
9575 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9577 @item -fprofile-correction
9578 @opindex fprofile-correction
9579 Profiles collected using an instrumented binary for multi-threaded programs may
9580 be inconsistent due to missed counter updates. When this option is specified,
9581 GCC uses heuristics to correct or smooth out such inconsistencies. By
9582 default, GCC emits an error message when an inconsistent profile is detected.
9584 @item -fprofile-use
9585 @itemx -fprofile-use=@var{path}
9586 @opindex fprofile-use
9587 Enable profile feedback-directed optimizations, 
9588 and the following optimizations
9589 which are generally profitable only with profile feedback available:
9590 @option{-fbranch-probabilities}, @option{-fvpt},
9591 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9592 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9594 Before you can use this option, you must first generate profiling information.
9595 @xref{Instrumentation Options}, for information about the
9596 @option{-fprofile-generate} option.
9598 By default, GCC emits an error message if the feedback profiles do not
9599 match the source code.  This error can be turned into a warning by using
9600 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9601 code.
9603 If @var{path} is specified, GCC looks at the @var{path} to find
9604 the profile feedback data files. See @option{-fprofile-dir}.
9606 @item -fauto-profile
9607 @itemx -fauto-profile=@var{path}
9608 @opindex fauto-profile
9609 Enable sampling-based feedback-directed optimizations, 
9610 and the following optimizations
9611 which are generally profitable only with profile feedback available:
9612 @option{-fbranch-probabilities}, @option{-fvpt},
9613 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9614 @option{-ftree-vectorize},
9615 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9616 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9617 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9619 @var{path} is the name of a file containing AutoFDO profile information.
9620 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9622 Producing an AutoFDO profile data file requires running your program
9623 with the @command{perf} utility on a supported GNU/Linux target system.
9624 For more information, see @uref{https://perf.wiki.kernel.org/}.
9626 E.g.
9627 @smallexample
9628 perf record -e br_inst_retired:near_taken -b -o perf.data \
9629     -- your_program
9630 @end smallexample
9632 Then use the @command{create_gcov} tool to convert the raw profile data
9633 to a format that can be used by GCC.@  You must also supply the 
9634 unstripped binary for your program to this tool.  
9635 See @uref{https://github.com/google/autofdo}.
9637 E.g.
9638 @smallexample
9639 create_gcov --binary=your_program.unstripped --profile=perf.data \
9640     --gcov=profile.afdo
9641 @end smallexample
9642 @end table
9644 The following options control compiler behavior regarding floating-point 
9645 arithmetic.  These options trade off between speed and
9646 correctness.  All must be specifically enabled.
9648 @table @gcctabopt
9649 @item -ffloat-store
9650 @opindex ffloat-store
9651 Do not store floating-point variables in registers, and inhibit other
9652 options that might change whether a floating-point value is taken from a
9653 register or memory.
9655 @cindex floating-point precision
9656 This option prevents undesirable excess precision on machines such as
9657 the 68000 where the floating registers (of the 68881) keep more
9658 precision than a @code{double} is supposed to have.  Similarly for the
9659 x86 architecture.  For most programs, the excess precision does only
9660 good, but a few programs rely on the precise definition of IEEE floating
9661 point.  Use @option{-ffloat-store} for such programs, after modifying
9662 them to store all pertinent intermediate computations into variables.
9664 @item -fexcess-precision=@var{style}
9665 @opindex fexcess-precision
9666 This option allows further control over excess precision on machines
9667 where floating-point operations occur in a format with more precision or
9668 range than the IEEE standard and interchange floating-point types.  By
9669 default, @option{-fexcess-precision=fast} is in effect; this means that
9670 operations may be carried out in a wider precision than the types specified
9671 in the source if that would result in faster code, and it is unpredictable
9672 when rounding to the types specified in the source code takes place.
9673 When compiling C, if @option{-fexcess-precision=standard} is specified then
9674 excess precision follows the rules specified in ISO C99; in particular,
9675 both casts and assignments cause values to be rounded to their
9676 semantic types (whereas @option{-ffloat-store} only affects
9677 assignments).  This option is enabled by default for C if a strict
9678 conformance option such as @option{-std=c99} is used.
9679 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9680 regardless of whether a strict conformance option is used.
9682 @opindex mfpmath
9683 @option{-fexcess-precision=standard} is not implemented for languages
9684 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9685 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9686 semantics apply without excess precision, and in the latter, rounding
9687 is unpredictable.
9689 @item -ffast-math
9690 @opindex ffast-math
9691 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9692 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9693 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9694 @option{-fexcess-precision=fast}.
9696 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9698 This option is not turned on by any @option{-O} option besides
9699 @option{-Ofast} since it can result in incorrect output for programs
9700 that depend on an exact implementation of IEEE or ISO rules/specifications
9701 for math functions. It may, however, yield faster code for programs
9702 that do not require the guarantees of these specifications.
9704 @item -fno-math-errno
9705 @opindex fno-math-errno
9706 Do not set @code{errno} after calling math functions that are executed
9707 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9708 IEEE exceptions for math error handling may want to use this flag
9709 for speed while maintaining IEEE arithmetic compatibility.
9711 This option is not turned on by any @option{-O} option since
9712 it can result in incorrect output for programs that depend on
9713 an exact implementation of IEEE or ISO rules/specifications for
9714 math functions. It may, however, yield faster code for programs
9715 that do not require the guarantees of these specifications.
9717 The default is @option{-fmath-errno}.
9719 On Darwin systems, the math library never sets @code{errno}.  There is
9720 therefore no reason for the compiler to consider the possibility that
9721 it might, and @option{-fno-math-errno} is the default.
9723 @item -funsafe-math-optimizations
9724 @opindex funsafe-math-optimizations
9726 Allow optimizations for floating-point arithmetic that (a) assume
9727 that arguments and results are valid and (b) may violate IEEE or
9728 ANSI standards.  When used at link time, it may include libraries
9729 or startup files that change the default FPU control word or other
9730 similar optimizations.
9732 This option is not turned on by any @option{-O} option since
9733 it can result in incorrect output for programs that depend on
9734 an exact implementation of IEEE or ISO rules/specifications for
9735 math functions. It may, however, yield faster code for programs
9736 that do not require the guarantees of these specifications.
9737 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9738 @option{-fassociative-math} and @option{-freciprocal-math}.
9740 The default is @option{-fno-unsafe-math-optimizations}.
9742 @item -fassociative-math
9743 @opindex fassociative-math
9745 Allow re-association of operands in series of floating-point operations.
9746 This violates the ISO C and C++ language standard by possibly changing
9747 computation result.  NOTE: re-ordering may change the sign of zero as
9748 well as ignore NaNs and inhibit or create underflow or overflow (and
9749 thus cannot be used on code that relies on rounding behavior like
9750 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9751 and thus may not be used when ordered comparisons are required.
9752 This option requires that both @option{-fno-signed-zeros} and
9753 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9754 much sense with @option{-frounding-math}. For Fortran the option
9755 is automatically enabled when both @option{-fno-signed-zeros} and
9756 @option{-fno-trapping-math} are in effect.
9758 The default is @option{-fno-associative-math}.
9760 @item -freciprocal-math
9761 @opindex freciprocal-math
9763 Allow the reciprocal of a value to be used instead of dividing by
9764 the value if this enables optimizations.  For example @code{x / y}
9765 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9766 is subject to common subexpression elimination.  Note that this loses
9767 precision and increases the number of flops operating on the value.
9769 The default is @option{-fno-reciprocal-math}.
9771 @item -ffinite-math-only
9772 @opindex ffinite-math-only
9773 Allow optimizations for floating-point arithmetic that assume
9774 that arguments and results are not NaNs or +-Infs.
9776 This option is not turned on by any @option{-O} option since
9777 it can result in incorrect output for programs that depend on
9778 an exact implementation of IEEE or ISO rules/specifications for
9779 math functions. It may, however, yield faster code for programs
9780 that do not require the guarantees of these specifications.
9782 The default is @option{-fno-finite-math-only}.
9784 @item -fno-signed-zeros
9785 @opindex fno-signed-zeros
9786 Allow optimizations for floating-point arithmetic that ignore the
9787 signedness of zero.  IEEE arithmetic specifies the behavior of
9788 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9789 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9790 This option implies that the sign of a zero result isn't significant.
9792 The default is @option{-fsigned-zeros}.
9794 @item -fno-trapping-math
9795 @opindex fno-trapping-math
9796 Compile code assuming that floating-point operations cannot generate
9797 user-visible traps.  These traps include division by zero, overflow,
9798 underflow, inexact result and invalid operation.  This option requires
9799 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9800 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9802 This option should never be turned on by any @option{-O} option since
9803 it can result in incorrect output for programs that depend on
9804 an exact implementation of IEEE or ISO rules/specifications for
9805 math functions.
9807 The default is @option{-ftrapping-math}.
9809 @item -frounding-math
9810 @opindex frounding-math
9811 Disable transformations and optimizations that assume default floating-point
9812 rounding behavior.  This is round-to-zero for all floating point
9813 to integer conversions, and round-to-nearest for all other arithmetic
9814 truncations.  This option should be specified for programs that change
9815 the FP rounding mode dynamically, or that may be executed with a
9816 non-default rounding mode.  This option disables constant folding of
9817 floating-point expressions at compile time (which may be affected by
9818 rounding mode) and arithmetic transformations that are unsafe in the
9819 presence of sign-dependent rounding modes.
9821 The default is @option{-fno-rounding-math}.
9823 This option is experimental and does not currently guarantee to
9824 disable all GCC optimizations that are affected by rounding mode.
9825 Future versions of GCC may provide finer control of this setting
9826 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9827 will be used to specify the default state for @code{FENV_ACCESS}.
9829 @item -fsignaling-nans
9830 @opindex fsignaling-nans
9831 Compile code assuming that IEEE signaling NaNs may generate user-visible
9832 traps during floating-point operations.  Setting this option disables
9833 optimizations that may change the number of exceptions visible with
9834 signaling NaNs.  This option implies @option{-ftrapping-math}.
9836 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9837 be defined.
9839 The default is @option{-fno-signaling-nans}.
9841 This option is experimental and does not currently guarantee to
9842 disable all GCC optimizations that affect signaling NaN behavior.
9844 @item -fno-fp-int-builtin-inexact
9845 @opindex fno-fp-int-builtin-inexact
9846 Do not allow the built-in functions @code{ceil}, @code{floor},
9847 @code{round} and @code{trunc}, and their @code{float} and @code{long
9848 double} variants, to generate code that raises the ``inexact''
9849 floating-point exception for noninteger arguments.  ISO C99 and C11
9850 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9851 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9852 functions to do so.
9854 The default is @option{-ffp-int-builtin-inexact}, allowing the
9855 exception to be raised.  This option does nothing unless
9856 @option{-ftrapping-math} is in effect.
9858 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9859 generate a call to a library function then the ``inexact'' exception
9860 may be raised if the library implementation does not follow TS 18661.
9862 @item -fsingle-precision-constant
9863 @opindex fsingle-precision-constant
9864 Treat floating-point constants as single precision instead of
9865 implicitly converting them to double-precision constants.
9867 @item -fcx-limited-range
9868 @opindex fcx-limited-range
9869 When enabled, this option states that a range reduction step is not
9870 needed when performing complex division.  Also, there is no checking
9871 whether the result of a complex multiplication or division is @code{NaN
9872 + I*NaN}, with an attempt to rescue the situation in that case.  The
9873 default is @option{-fno-cx-limited-range}, but is enabled by
9874 @option{-ffast-math}.
9876 This option controls the default setting of the ISO C99
9877 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9878 all languages.
9880 @item -fcx-fortran-rules
9881 @opindex fcx-fortran-rules
9882 Complex multiplication and division follow Fortran rules.  Range
9883 reduction is done as part of complex division, but there is no checking
9884 whether the result of a complex multiplication or division is @code{NaN
9885 + I*NaN}, with an attempt to rescue the situation in that case.
9887 The default is @option{-fno-cx-fortran-rules}.
9889 @end table
9891 The following options control optimizations that may improve
9892 performance, but are not enabled by any @option{-O} options.  This
9893 section includes experimental options that may produce broken code.
9895 @table @gcctabopt
9896 @item -fbranch-probabilities
9897 @opindex fbranch-probabilities
9898 After running a program compiled with @option{-fprofile-arcs}
9899 (@pxref{Instrumentation Options}),
9900 you can compile it a second time using
9901 @option{-fbranch-probabilities}, to improve optimizations based on
9902 the number of times each branch was taken.  When a program
9903 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9904 counts to a file called @file{@var{sourcename}.gcda} for each source
9905 file.  The information in this data file is very dependent on the
9906 structure of the generated code, so you must use the same source code
9907 and the same optimization options for both compilations.
9909 With @option{-fbranch-probabilities}, GCC puts a
9910 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9911 These can be used to improve optimization.  Currently, they are only
9912 used in one place: in @file{reorg.c}, instead of guessing which path a
9913 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9914 exactly determine which path is taken more often.
9916 @item -fprofile-values
9917 @opindex fprofile-values
9918 If combined with @option{-fprofile-arcs}, it adds code so that some
9919 data about values of expressions in the program is gathered.
9921 With @option{-fbranch-probabilities}, it reads back the data gathered
9922 from profiling values of expressions for usage in optimizations.
9924 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9926 @item -fprofile-reorder-functions
9927 @opindex fprofile-reorder-functions
9928 Function reordering based on profile instrumentation collects
9929 first time of execution of a function and orders these functions
9930 in ascending order.
9932 Enabled with @option{-fprofile-use}.
9934 @item -fvpt
9935 @opindex fvpt
9936 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9937 to add code to gather information about values of expressions.
9939 With @option{-fbranch-probabilities}, it reads back the data gathered
9940 and actually performs the optimizations based on them.
9941 Currently the optimizations include specialization of division operations
9942 using the knowledge about the value of the denominator.
9944 @item -frename-registers
9945 @opindex frename-registers
9946 Attempt to avoid false dependencies in scheduled code by making use
9947 of registers left over after register allocation.  This optimization
9948 most benefits processors with lots of registers.  Depending on the
9949 debug information format adopted by the target, however, it can
9950 make debugging impossible, since variables no longer stay in
9951 a ``home register''.
9953 Enabled by default with @option{-funroll-loops}.
9955 @item -fschedule-fusion
9956 @opindex fschedule-fusion
9957 Performs a target dependent pass over the instruction stream to schedule
9958 instructions of same type together because target machine can execute them
9959 more efficiently if they are adjacent to each other in the instruction flow.
9961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9963 @item -ftracer
9964 @opindex ftracer
9965 Perform tail duplication to enlarge superblock size.  This transformation
9966 simplifies the control flow of the function allowing other optimizations to do
9967 a better job.
9969 Enabled with @option{-fprofile-use}.
9971 @item -funroll-loops
9972 @opindex funroll-loops
9973 Unroll loops whose number of iterations can be determined at compile time or
9974 upon entry to the loop.  @option{-funroll-loops} implies
9975 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9976 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9977 a small constant number of iterations).  This option makes code larger, and may
9978 or may not make it run faster.
9980 Enabled with @option{-fprofile-use}.
9982 @item -funroll-all-loops
9983 @opindex funroll-all-loops
9984 Unroll all loops, even if their number of iterations is uncertain when
9985 the loop is entered.  This usually makes programs run more slowly.
9986 @option{-funroll-all-loops} implies the same options as
9987 @option{-funroll-loops}.
9989 @item -fpeel-loops
9990 @opindex fpeel-loops
9991 Peels loops for which there is enough information that they do not
9992 roll much (from profile feedback or static analysis).  It also turns on
9993 complete loop peeling (i.e.@: complete removal of loops with small constant
9994 number of iterations).
9996 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9998 @item -fmove-loop-invariants
9999 @opindex fmove-loop-invariants
10000 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10001 at level @option{-O1}
10003 @item -fsplit-loops
10004 @opindex fsplit-loops
10005 Split a loop into two if it contains a condition that's always true
10006 for one side of the iteration space and false for the other.
10008 @item -funswitch-loops
10009 @opindex funswitch-loops
10010 Move branches with loop invariant conditions out of the loop, with duplicates
10011 of the loop on both branches (modified according to result of the condition).
10013 @item -floop-unroll-and-jam
10014 @opindex floop-unroll-and-jam
10015 Apply unroll and jam transformations on feasible loops.  In a loop
10016 nest this unrolls the outer loop by some factor and fuses the resulting
10017 multiple inner loops.
10019 @item -ffunction-sections
10020 @itemx -fdata-sections
10021 @opindex ffunction-sections
10022 @opindex fdata-sections
10023 Place each function or data item into its own section in the output
10024 file if the target supports arbitrary sections.  The name of the
10025 function or the name of the data item determines the section's name
10026 in the output file.
10028 Use these options on systems where the linker can perform optimizations to
10029 improve locality of reference in the instruction space.  Most systems using the
10030 ELF object format have linkers with such optimizations.  On AIX, the linker
10031 rearranges sections (CSECTs) based on the call graph.  The performance impact
10032 varies.
10034 Together with a linker garbage collection (linker @option{--gc-sections}
10035 option) these options may lead to smaller statically-linked executables (after
10036 stripping).
10038 On ELF/DWARF systems these options do not degenerate the quality of the debug
10039 information.  There could be issues with other object files/debug info formats.
10041 Only use these options when there are significant benefits from doing so.  When
10042 you specify these options, the assembler and linker create larger object and
10043 executable files and are also slower.  These options affect code generation.
10044 They prevent optimizations by the compiler and assembler using relative
10045 locations inside a translation unit since the locations are unknown until
10046 link time.  An example of such an optimization is relaxing calls to short call
10047 instructions.
10049 @item -fbranch-target-load-optimize
10050 @opindex fbranch-target-load-optimize
10051 Perform branch target register load optimization before prologue / epilogue
10052 threading.
10053 The use of target registers can typically be exposed only during reload,
10054 thus hoisting loads out of loops and doing inter-block scheduling needs
10055 a separate optimization pass.
10057 @item -fbranch-target-load-optimize2
10058 @opindex fbranch-target-load-optimize2
10059 Perform branch target register load optimization after prologue / epilogue
10060 threading.
10062 @item -fbtr-bb-exclusive
10063 @opindex fbtr-bb-exclusive
10064 When performing branch target register load optimization, don't reuse
10065 branch target registers within any basic block.
10067 @item -fstdarg-opt
10068 @opindex fstdarg-opt
10069 Optimize the prologue of variadic argument functions with respect to usage of
10070 those arguments.
10072 @item -fsection-anchors
10073 @opindex fsection-anchors
10074 Try to reduce the number of symbolic address calculations by using
10075 shared ``anchor'' symbols to address nearby objects.  This transformation
10076 can help to reduce the number of GOT entries and GOT accesses on some
10077 targets.
10079 For example, the implementation of the following function @code{foo}:
10081 @smallexample
10082 static int a, b, c;
10083 int foo (void) @{ return a + b + c; @}
10084 @end smallexample
10086 @noindent
10087 usually calculates the addresses of all three variables, but if you
10088 compile it with @option{-fsection-anchors}, it accesses the variables
10089 from a common anchor point instead.  The effect is similar to the
10090 following pseudocode (which isn't valid C):
10092 @smallexample
10093 int foo (void)
10095   register int *xr = &x;
10096   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10098 @end smallexample
10100 Not all targets support this option.
10102 @item --param @var{name}=@var{value}
10103 @opindex param
10104 In some places, GCC uses various constants to control the amount of
10105 optimization that is done.  For example, GCC does not inline functions
10106 that contain more than a certain number of instructions.  You can
10107 control some of these constants on the command line using the
10108 @option{--param} option.
10110 The names of specific parameters, and the meaning of the values, are
10111 tied to the internals of the compiler, and are subject to change
10112 without notice in future releases.
10114 In each case, the @var{value} is an integer.  The allowable choices for
10115 @var{name} are:
10117 @table @gcctabopt
10118 @item predictable-branch-outcome
10119 When branch is predicted to be taken with probability lower than this threshold
10120 (in percent), then it is considered well predictable. The default is 10.
10122 @item max-rtl-if-conversion-insns
10123 RTL if-conversion tries to remove conditional branches around a block and
10124 replace them with conditionally executed instructions.  This parameter
10125 gives the maximum number of instructions in a block which should be
10126 considered for if-conversion.  The default is 10, though the compiler will
10127 also use other heuristics to decide whether if-conversion is likely to be
10128 profitable.
10130 @item max-rtl-if-conversion-predictable-cost
10131 @itemx max-rtl-if-conversion-unpredictable-cost
10132 RTL if-conversion will try to remove conditional branches around a block
10133 and replace them with conditionally executed instructions.  These parameters
10134 give the maximum permissible cost for the sequence that would be generated
10135 by if-conversion depending on whether the branch is statically determined
10136 to be predictable or not.  The units for this parameter are the same as
10137 those for the GCC internal seq_cost metric.  The compiler will try to
10138 provide a reasonable default for this parameter using the BRANCH_COST
10139 target macro.
10141 @item max-crossjump-edges
10142 The maximum number of incoming edges to consider for cross-jumping.
10143 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10144 the number of edges incoming to each block.  Increasing values mean
10145 more aggressive optimization, making the compilation time increase with
10146 probably small improvement in executable size.
10148 @item min-crossjump-insns
10149 The minimum number of instructions that must be matched at the end
10150 of two blocks before cross-jumping is performed on them.  This
10151 value is ignored in the case where all instructions in the block being
10152 cross-jumped from are matched.  The default value is 5.
10154 @item max-grow-copy-bb-insns
10155 The maximum code size expansion factor when copying basic blocks
10156 instead of jumping.  The expansion is relative to a jump instruction.
10157 The default value is 8.
10159 @item max-goto-duplication-insns
10160 The maximum number of instructions to duplicate to a block that jumps
10161 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10162 passes, GCC factors computed gotos early in the compilation process,
10163 and unfactors them as late as possible.  Only computed jumps at the
10164 end of a basic blocks with no more than max-goto-duplication-insns are
10165 unfactored.  The default value is 8.
10167 @item max-delay-slot-insn-search
10168 The maximum number of instructions to consider when looking for an
10169 instruction to fill a delay slot.  If more than this arbitrary number of
10170 instructions are searched, the time savings from filling the delay slot
10171 are minimal, so stop searching.  Increasing values mean more
10172 aggressive optimization, making the compilation time increase with probably
10173 small improvement in execution time.
10175 @item max-delay-slot-live-search
10176 When trying to fill delay slots, the maximum number of instructions to
10177 consider when searching for a block with valid live register
10178 information.  Increasing this arbitrarily chosen value means more
10179 aggressive optimization, increasing the compilation time.  This parameter
10180 should be removed when the delay slot code is rewritten to maintain the
10181 control-flow graph.
10183 @item max-gcse-memory
10184 The approximate maximum amount of memory that can be allocated in
10185 order to perform the global common subexpression elimination
10186 optimization.  If more memory than specified is required, the
10187 optimization is not done.
10189 @item max-gcse-insertion-ratio
10190 If the ratio of expression insertions to deletions is larger than this value
10191 for any expression, then RTL PRE inserts or removes the expression and thus
10192 leaves partially redundant computations in the instruction stream.  The default value is 20.
10194 @item max-pending-list-length
10195 The maximum number of pending dependencies scheduling allows
10196 before flushing the current state and starting over.  Large functions
10197 with few branches or calls can create excessively large lists which
10198 needlessly consume memory and resources.
10200 @item max-modulo-backtrack-attempts
10201 The maximum number of backtrack attempts the scheduler should make
10202 when modulo scheduling a loop.  Larger values can exponentially increase
10203 compilation time.
10205 @item max-inline-insns-single
10206 Several parameters control the tree inliner used in GCC@.
10207 This number sets the maximum number of instructions (counted in GCC's
10208 internal representation) in a single function that the tree inliner
10209 considers for inlining.  This only affects functions declared
10210 inline and methods implemented in a class declaration (C++).
10211 The default value is 400.
10213 @item max-inline-insns-auto
10214 When you use @option{-finline-functions} (included in @option{-O3}),
10215 a lot of functions that would otherwise not be considered for inlining
10216 by the compiler are investigated.  To those functions, a different
10217 (more restrictive) limit compared to functions declared inline can
10218 be applied.
10219 The default value is 30.
10221 @item inline-min-speedup
10222 When estimated performance improvement of caller + callee runtime exceeds this
10223 threshold (in percent), the function can be inlined regardless of the limit on
10224 @option{--param max-inline-insns-single} and @option{--param
10225 max-inline-insns-auto}.
10226 The default value is 15.
10228 @item large-function-insns
10229 The limit specifying really large functions.  For functions larger than this
10230 limit after inlining, inlining is constrained by
10231 @option{--param large-function-growth}.  This parameter is useful primarily
10232 to avoid extreme compilation time caused by non-linear algorithms used by the
10233 back end.
10234 The default value is 2700.
10236 @item large-function-growth
10237 Specifies maximal growth of large function caused by inlining in percents.
10238 The default value is 100 which limits large function growth to 2.0 times
10239 the original size.
10241 @item large-unit-insns
10242 The limit specifying large translation unit.  Growth caused by inlining of
10243 units larger than this limit is limited by @option{--param inline-unit-growth}.
10244 For small units this might be too tight.
10245 For example, consider a unit consisting of function A
10246 that is inline and B that just calls A three times.  If B is small relative to
10247 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10248 large units consisting of small inlineable functions, however, the overall unit
10249 growth limit is needed to avoid exponential explosion of code size.  Thus for
10250 smaller units, the size is increased to @option{--param large-unit-insns}
10251 before applying @option{--param inline-unit-growth}.  The default is 10000.
10253 @item inline-unit-growth
10254 Specifies maximal overall growth of the compilation unit caused by inlining.
10255 The default value is 20 which limits unit growth to 1.2 times the original
10256 size. Cold functions (either marked cold via an attribute or by profile
10257 feedback) are not accounted into the unit size.
10259 @item ipcp-unit-growth
10260 Specifies maximal overall growth of the compilation unit caused by
10261 interprocedural constant propagation.  The default value is 10 which limits
10262 unit growth to 1.1 times the original size.
10264 @item large-stack-frame
10265 The limit specifying large stack frames.  While inlining the algorithm is trying
10266 to not grow past this limit too much.  The default value is 256 bytes.
10268 @item large-stack-frame-growth
10269 Specifies maximal growth of large stack frames caused by inlining in percents.
10270 The default value is 1000 which limits large stack frame growth to 11 times
10271 the original size.
10273 @item max-inline-insns-recursive
10274 @itemx max-inline-insns-recursive-auto
10275 Specifies the maximum number of instructions an out-of-line copy of a
10276 self-recursive inline
10277 function can grow into by performing recursive inlining.
10279 @option{--param max-inline-insns-recursive} applies to functions
10280 declared inline.
10281 For functions not declared inline, recursive inlining
10282 happens only when @option{-finline-functions} (included in @option{-O3}) is
10283 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10284 default value is 450.
10286 @item max-inline-recursive-depth
10287 @itemx max-inline-recursive-depth-auto
10288 Specifies the maximum recursion depth used for recursive inlining.
10290 @option{--param max-inline-recursive-depth} applies to functions
10291 declared inline.  For functions not declared inline, recursive inlining
10292 happens only when @option{-finline-functions} (included in @option{-O3}) is
10293 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10294 default value is 8.
10296 @item min-inline-recursive-probability
10297 Recursive inlining is profitable only for function having deep recursion
10298 in average and can hurt for function having little recursion depth by
10299 increasing the prologue size or complexity of function body to other
10300 optimizers.
10302 When profile feedback is available (see @option{-fprofile-generate}) the actual
10303 recursion depth can be guessed from the probability that function recurses
10304 via a given call expression.  This parameter limits inlining only to call
10305 expressions whose probability exceeds the given threshold (in percents).
10306 The default value is 10.
10308 @item early-inlining-insns
10309 Specify growth that the early inliner can make.  In effect it increases
10310 the amount of inlining for code having a large abstraction penalty.
10311 The default value is 14.
10313 @item max-early-inliner-iterations
10314 Limit of iterations of the early inliner.  This basically bounds
10315 the number of nested indirect calls the early inliner can resolve.
10316 Deeper chains are still handled by late inlining.
10318 @item comdat-sharing-probability
10319 Probability (in percent) that C++ inline function with comdat visibility
10320 are shared across multiple compilation units.  The default value is 20.
10322 @item profile-func-internal-id
10323 A parameter to control whether to use function internal id in profile
10324 database lookup. If the value is 0, the compiler uses an id that
10325 is based on function assembler name and filename, which makes old profile
10326 data more tolerant to source changes such as function reordering etc.
10327 The default value is 0.
10329 @item min-vect-loop-bound
10330 The minimum number of iterations under which loops are not vectorized
10331 when @option{-ftree-vectorize} is used.  The number of iterations after
10332 vectorization needs to be greater than the value specified by this option
10333 to allow vectorization.  The default value is 0.
10335 @item gcse-cost-distance-ratio
10336 Scaling factor in calculation of maximum distance an expression
10337 can be moved by GCSE optimizations.  This is currently supported only in the
10338 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10339 is with simple expressions, i.e., the expressions that have cost
10340 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10341 hoisting of simple expressions.  The default value is 10.
10343 @item gcse-unrestricted-cost
10344 Cost, roughly measured as the cost of a single typical machine
10345 instruction, at which GCSE optimizations do not constrain
10346 the distance an expression can travel.  This is currently
10347 supported only in the code hoisting pass.  The lesser the cost,
10348 the more aggressive code hoisting is.  Specifying 0 
10349 allows all expressions to travel unrestricted distances.
10350 The default value is 3.
10352 @item max-hoist-depth
10353 The depth of search in the dominator tree for expressions to hoist.
10354 This is used to avoid quadratic behavior in hoisting algorithm.
10355 The value of 0 does not limit on the search, but may slow down compilation
10356 of huge functions.  The default value is 30.
10358 @item max-tail-merge-comparisons
10359 The maximum amount of similar bbs to compare a bb with.  This is used to
10360 avoid quadratic behavior in tree tail merging.  The default value is 10.
10362 @item max-tail-merge-iterations
10363 The maximum amount of iterations of the pass over the function.  This is used to
10364 limit compilation time in tree tail merging.  The default value is 2.
10366 @item store-merging-allow-unaligned
10367 Allow the store merging pass to introduce unaligned stores if it is legal to
10368 do so.  The default value is 1.
10370 @item max-stores-to-merge
10371 The maximum number of stores to attempt to merge into wider stores in the store
10372 merging pass.  The minimum value is 2 and the default is 64.
10374 @item max-unrolled-insns
10375 The maximum number of instructions that a loop may have to be unrolled.
10376 If a loop is unrolled, this parameter also determines how many times
10377 the loop code is unrolled.
10379 @item max-average-unrolled-insns
10380 The maximum number of instructions biased by probabilities of their execution
10381 that a loop may have to be unrolled.  If a loop is unrolled,
10382 this parameter also determines how many times the loop code is unrolled.
10384 @item max-unroll-times
10385 The maximum number of unrollings of a single loop.
10387 @item max-peeled-insns
10388 The maximum number of instructions that a loop may have to be peeled.
10389 If a loop is peeled, this parameter also determines how many times
10390 the loop code is peeled.
10392 @item max-peel-times
10393 The maximum number of peelings of a single loop.
10395 @item max-peel-branches
10396 The maximum number of branches on the hot path through the peeled sequence.
10398 @item max-completely-peeled-insns
10399 The maximum number of insns of a completely peeled loop.
10401 @item max-completely-peel-times
10402 The maximum number of iterations of a loop to be suitable for complete peeling.
10404 @item max-completely-peel-loop-nest-depth
10405 The maximum depth of a loop nest suitable for complete peeling.
10407 @item max-unswitch-insns
10408 The maximum number of insns of an unswitched loop.
10410 @item max-unswitch-level
10411 The maximum number of branches unswitched in a single loop.
10413 @item max-loop-headers-insns
10414 The maximum number of insns in loop header duplicated by the copy loop headers
10415 pass.
10417 @item lim-expensive
10418 The minimum cost of an expensive expression in the loop invariant motion.
10420 @item iv-consider-all-candidates-bound
10421 Bound on number of candidates for induction variables, below which
10422 all candidates are considered for each use in induction variable
10423 optimizations.  If there are more candidates than this,
10424 only the most relevant ones are considered to avoid quadratic time complexity.
10426 @item iv-max-considered-uses
10427 The induction variable optimizations give up on loops that contain more
10428 induction variable uses.
10430 @item iv-always-prune-cand-set-bound
10431 If the number of candidates in the set is smaller than this value,
10432 always try to remove unnecessary ivs from the set
10433 when adding a new one.
10435 @item avg-loop-niter
10436 Average number of iterations of a loop.
10438 @item dse-max-object-size
10439 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10440 Larger values may result in larger compilation times.
10442 @item scev-max-expr-size
10443 Bound on size of expressions used in the scalar evolutions analyzer.
10444 Large expressions slow the analyzer.
10446 @item scev-max-expr-complexity
10447 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10448 Complex expressions slow the analyzer.
10450 @item max-tree-if-conversion-phi-args
10451 Maximum number of arguments in a PHI supported by TREE if conversion
10452 unless the loop is marked with simd pragma.
10454 @item vect-max-version-for-alignment-checks
10455 The maximum number of run-time checks that can be performed when
10456 doing loop versioning for alignment in the vectorizer.
10458 @item vect-max-version-for-alias-checks
10459 The maximum number of run-time checks that can be performed when
10460 doing loop versioning for alias in the vectorizer.
10462 @item vect-max-peeling-for-alignment
10463 The maximum number of loop peels to enhance access alignment
10464 for vectorizer. Value -1 means no limit.
10466 @item max-iterations-to-track
10467 The maximum number of iterations of a loop the brute-force algorithm
10468 for analysis of the number of iterations of the loop tries to evaluate.
10470 @item hot-bb-count-ws-permille
10471 A basic block profile count is considered hot if it contributes to 
10472 the given permillage (i.e. 0...1000) of the entire profiled execution.
10474 @item hot-bb-frequency-fraction
10475 Select fraction of the entry block frequency of executions of basic block in
10476 function given basic block needs to have to be considered hot.
10478 @item max-predicted-iterations
10479 The maximum number of loop iterations we predict statically.  This is useful
10480 in cases where a function contains a single loop with known bound and
10481 another loop with unknown bound.
10482 The known number of iterations is predicted correctly, while
10483 the unknown number of iterations average to roughly 10.  This means that the
10484 loop without bounds appears artificially cold relative to the other one.
10486 @item builtin-expect-probability
10487 Control the probability of the expression having the specified value. This
10488 parameter takes a percentage (i.e. 0 ... 100) as input.
10489 The default probability of 90 is obtained empirically.
10491 @item align-threshold
10493 Select fraction of the maximal frequency of executions of a basic block in
10494 a function to align the basic block.
10496 @item align-loop-iterations
10498 A loop expected to iterate at least the selected number of iterations is
10499 aligned.
10501 @item tracer-dynamic-coverage
10502 @itemx tracer-dynamic-coverage-feedback
10504 This value is used to limit superblock formation once the given percentage of
10505 executed instructions is covered.  This limits unnecessary code size
10506 expansion.
10508 The @option{tracer-dynamic-coverage-feedback} parameter
10509 is used only when profile
10510 feedback is available.  The real profiles (as opposed to statically estimated
10511 ones) are much less balanced allowing the threshold to be larger value.
10513 @item tracer-max-code-growth
10514 Stop tail duplication once code growth has reached given percentage.  This is
10515 a rather artificial limit, as most of the duplicates are eliminated later in
10516 cross jumping, so it may be set to much higher values than is the desired code
10517 growth.
10519 @item tracer-min-branch-ratio
10521 Stop reverse growth when the reverse probability of best edge is less than this
10522 threshold (in percent).
10524 @item tracer-min-branch-probability
10525 @itemx tracer-min-branch-probability-feedback
10527 Stop forward growth if the best edge has probability lower than this
10528 threshold.
10530 Similarly to @option{tracer-dynamic-coverage} two parameters are
10531 provided.  @option{tracer-min-branch-probability-feedback} is used for
10532 compilation with profile feedback and @option{tracer-min-branch-probability}
10533 compilation without.  The value for compilation with profile feedback
10534 needs to be more conservative (higher) in order to make tracer
10535 effective.
10537 @item stack-clash-protection-guard-size
10538 Specify the size of the operating system provided stack guard as
10539 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10540 Acceptable values are between 12 and 30.  Higher values may reduce the
10541 number of explicit probes, but a value larger than the operating system
10542 provided guard will leave code vulnerable to stack clash style attacks.
10544 @item stack-clash-protection-probe-interval
10545 Stack clash protection involves probing stack space as it is allocated.  This
10546 param controls the maximum distance between probes into the stack as 2 raised
10547 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10548 12.  Higher values may reduce the number of explicit probes, but a value
10549 larger than the operating system provided guard will leave code vulnerable to
10550 stack clash style attacks.
10552 @item max-cse-path-length
10554 The maximum number of basic blocks on path that CSE considers.
10555 The default is 10.
10557 @item max-cse-insns
10558 The maximum number of instructions CSE processes before flushing.
10559 The default is 1000.
10561 @item ggc-min-expand
10563 GCC uses a garbage collector to manage its own memory allocation.  This
10564 parameter specifies the minimum percentage by which the garbage
10565 collector's heap should be allowed to expand between collections.
10566 Tuning this may improve compilation speed; it has no effect on code
10567 generation.
10569 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10570 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10571 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10572 GCC is not able to calculate RAM on a particular platform, the lower
10573 bound of 30% is used.  Setting this parameter and
10574 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10575 every opportunity.  This is extremely slow, but can be useful for
10576 debugging.
10578 @item ggc-min-heapsize
10580 Minimum size of the garbage collector's heap before it begins bothering
10581 to collect garbage.  The first collection occurs after the heap expands
10582 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10583 tuning this may improve compilation speed, and has no effect on code
10584 generation.
10586 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10587 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10588 with a lower bound of 4096 (four megabytes) and an upper bound of
10589 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10590 particular platform, the lower bound is used.  Setting this parameter
10591 very large effectively disables garbage collection.  Setting this
10592 parameter and @option{ggc-min-expand} to zero causes a full collection
10593 to occur at every opportunity.
10595 @item max-reload-search-insns
10596 The maximum number of instruction reload should look backward for equivalent
10597 register.  Increasing values mean more aggressive optimization, making the
10598 compilation time increase with probably slightly better performance.
10599 The default value is 100.
10601 @item max-cselib-memory-locations
10602 The maximum number of memory locations cselib should take into account.
10603 Increasing values mean more aggressive optimization, making the compilation time
10604 increase with probably slightly better performance.  The default value is 500.
10606 @item max-sched-ready-insns
10607 The maximum number of instructions ready to be issued the scheduler should
10608 consider at any given time during the first scheduling pass.  Increasing
10609 values mean more thorough searches, making the compilation time increase
10610 with probably little benefit.  The default value is 100.
10612 @item max-sched-region-blocks
10613 The maximum number of blocks in a region to be considered for
10614 interblock scheduling.  The default value is 10.
10616 @item max-pipeline-region-blocks
10617 The maximum number of blocks in a region to be considered for
10618 pipelining in the selective scheduler.  The default value is 15.
10620 @item max-sched-region-insns
10621 The maximum number of insns in a region to be considered for
10622 interblock scheduling.  The default value is 100.
10624 @item max-pipeline-region-insns
10625 The maximum number of insns in a region to be considered for
10626 pipelining in the selective scheduler.  The default value is 200.
10628 @item min-spec-prob
10629 The minimum probability (in percents) of reaching a source block
10630 for interblock speculative scheduling.  The default value is 40.
10632 @item max-sched-extend-regions-iters
10633 The maximum number of iterations through CFG to extend regions.
10634 A value of 0 (the default) disables region extensions.
10636 @item max-sched-insn-conflict-delay
10637 The maximum conflict delay for an insn to be considered for speculative motion.
10638 The default value is 3.
10640 @item sched-spec-prob-cutoff
10641 The minimal probability of speculation success (in percents), so that
10642 speculative insns are scheduled.
10643 The default value is 40.
10645 @item sched-state-edge-prob-cutoff
10646 The minimum probability an edge must have for the scheduler to save its
10647 state across it.
10648 The default value is 10.
10650 @item sched-mem-true-dep-cost
10651 Minimal distance (in CPU cycles) between store and load targeting same
10652 memory locations.  The default value is 1.
10654 @item selsched-max-lookahead
10655 The maximum size of the lookahead window of selective scheduling.  It is a
10656 depth of search for available instructions.
10657 The default value is 50.
10659 @item selsched-max-sched-times
10660 The maximum number of times that an instruction is scheduled during
10661 selective scheduling.  This is the limit on the number of iterations
10662 through which the instruction may be pipelined.  The default value is 2.
10664 @item selsched-insns-to-rename
10665 The maximum number of best instructions in the ready list that are considered
10666 for renaming in the selective scheduler.  The default value is 2.
10668 @item sms-min-sc
10669 The minimum value of stage count that swing modulo scheduler
10670 generates.  The default value is 2.
10672 @item max-last-value-rtl
10673 The maximum size measured as number of RTLs that can be recorded in an expression
10674 in combiner for a pseudo register as last known value of that register.  The default
10675 is 10000.
10677 @item max-combine-insns
10678 The maximum number of instructions the RTL combiner tries to combine.
10679 The default value is 2 at @option{-Og} and 4 otherwise.
10681 @item integer-share-limit
10682 Small integer constants can use a shared data structure, reducing the
10683 compiler's memory usage and increasing its speed.  This sets the maximum
10684 value of a shared integer constant.  The default value is 256.
10686 @item ssp-buffer-size
10687 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10688 protection when @option{-fstack-protection} is used.
10690 @item min-size-for-stack-sharing
10691 The minimum size of variables taking part in stack slot sharing when not
10692 optimizing. The default value is 32.
10694 @item max-jump-thread-duplication-stmts
10695 Maximum number of statements allowed in a block that needs to be
10696 duplicated when threading jumps.
10698 @item max-fields-for-field-sensitive
10699 Maximum number of fields in a structure treated in
10700 a field sensitive manner during pointer analysis.  The default is zero
10701 for @option{-O0} and @option{-O1},
10702 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10704 @item prefetch-latency
10705 Estimate on average number of instructions that are executed before
10706 prefetch finishes.  The distance prefetched ahead is proportional
10707 to this constant.  Increasing this number may also lead to less
10708 streams being prefetched (see @option{simultaneous-prefetches}).
10710 @item simultaneous-prefetches
10711 Maximum number of prefetches that can run at the same time.
10713 @item l1-cache-line-size
10714 The size of cache line in L1 cache, in bytes.
10716 @item l1-cache-size
10717 The size of L1 cache, in kilobytes.
10719 @item l2-cache-size
10720 The size of L2 cache, in kilobytes.
10722 @item loop-interchange-max-num-stmts
10723 The maximum number of stmts in a loop to be interchanged.
10725 @item loop-interchange-stride-ratio
10726 The minimum ratio between stride of two loops for interchange to be profitable.
10728 @item min-insn-to-prefetch-ratio
10729 The minimum ratio between the number of instructions and the
10730 number of prefetches to enable prefetching in a loop.
10732 @item prefetch-min-insn-to-mem-ratio
10733 The minimum ratio between the number of instructions and the
10734 number of memory references to enable prefetching in a loop.
10736 @item use-canonical-types
10737 Whether the compiler should use the ``canonical'' type system.  By
10738 default, this should always be 1, which uses a more efficient internal
10739 mechanism for comparing types in C++ and Objective-C++.  However, if
10740 bugs in the canonical type system are causing compilation failures,
10741 set this value to 0 to disable canonical types.
10743 @item switch-conversion-max-branch-ratio
10744 Switch initialization conversion refuses to create arrays that are
10745 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10746 branches in the switch.
10748 @item max-partial-antic-length
10749 Maximum length of the partial antic set computed during the tree
10750 partial redundancy elimination optimization (@option{-ftree-pre}) when
10751 optimizing at @option{-O3} and above.  For some sorts of source code
10752 the enhanced partial redundancy elimination optimization can run away,
10753 consuming all of the memory available on the host machine.  This
10754 parameter sets a limit on the length of the sets that are computed,
10755 which prevents the runaway behavior.  Setting a value of 0 for
10756 this parameter allows an unlimited set length.
10758 @item sccvn-max-scc-size
10759 Maximum size of a strongly connected component (SCC) during SCCVN
10760 processing.  If this limit is hit, SCCVN processing for the whole
10761 function is not done and optimizations depending on it are
10762 disabled.  The default maximum SCC size is 10000.
10764 @item sccvn-max-alias-queries-per-access
10765 Maximum number of alias-oracle queries we perform when looking for
10766 redundancies for loads and stores.  If this limit is hit the search
10767 is aborted and the load or store is not considered redundant.  The
10768 number of queries is algorithmically limited to the number of
10769 stores on all paths from the load to the function entry.
10770 The default maximum number of queries is 1000.
10772 @item ira-max-loops-num
10773 IRA uses regional register allocation by default.  If a function
10774 contains more loops than the number given by this parameter, only at most
10775 the given number of the most frequently-executed loops form regions
10776 for regional register allocation.  The default value of the
10777 parameter is 100.
10779 @item ira-max-conflict-table-size 
10780 Although IRA uses a sophisticated algorithm to compress the conflict
10781 table, the table can still require excessive amounts of memory for
10782 huge functions.  If the conflict table for a function could be more
10783 than the size in MB given by this parameter, the register allocator
10784 instead uses a faster, simpler, and lower-quality
10785 algorithm that does not require building a pseudo-register conflict table.  
10786 The default value of the parameter is 2000.
10788 @item ira-loop-reserved-regs
10789 IRA can be used to evaluate more accurate register pressure in loops
10790 for decisions to move loop invariants (see @option{-O3}).  The number
10791 of available registers reserved for some other purposes is given
10792 by this parameter.  The default value of the parameter is 2, which is
10793 the minimal number of registers needed by typical instructions.
10794 This value is the best found from numerous experiments.
10796 @item lra-inheritance-ebb-probability-cutoff
10797 LRA tries to reuse values reloaded in registers in subsequent insns.
10798 This optimization is called inheritance.  EBB is used as a region to
10799 do this optimization.  The parameter defines a minimal fall-through
10800 edge probability in percentage used to add BB to inheritance EBB in
10801 LRA.  The default value of the parameter is 40.  The value was chosen
10802 from numerous runs of SPEC2000 on x86-64.
10804 @item loop-invariant-max-bbs-in-loop
10805 Loop invariant motion can be very expensive, both in compilation time and
10806 in amount of needed compile-time memory, with very large loops.  Loops
10807 with more basic blocks than this parameter won't have loop invariant
10808 motion optimization performed on them.  The default value of the
10809 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10811 @item loop-max-datarefs-for-datadeps
10812 Building data dependencies is expensive for very large loops.  This
10813 parameter limits the number of data references in loops that are
10814 considered for data dependence analysis.  These large loops are no
10815 handled by the optimizations using loop data dependencies.
10816 The default value is 1000.
10818 @item max-vartrack-size
10819 Sets a maximum number of hash table slots to use during variable
10820 tracking dataflow analysis of any function.  If this limit is exceeded
10821 with variable tracking at assignments enabled, analysis for that
10822 function is retried without it, after removing all debug insns from
10823 the function.  If the limit is exceeded even without debug insns, var
10824 tracking analysis is completely disabled for the function.  Setting
10825 the parameter to zero makes it unlimited.
10827 @item max-vartrack-expr-depth
10828 Sets a maximum number of recursion levels when attempting to map
10829 variable names or debug temporaries to value expressions.  This trades
10830 compilation time for more complete debug information.  If this is set too
10831 low, value expressions that are available and could be represented in
10832 debug information may end up not being used; setting this higher may
10833 enable the compiler to find more complex debug expressions, but compile
10834 time and memory use may grow.  The default is 12.
10836 @item max-debug-marker-count
10837 Sets a threshold on the number of debug markers (e.g. begin stmt
10838 markers) to avoid complexity explosion at inlining or expanding to RTL.
10839 If a function has more such gimple stmts than the set limit, such stmts
10840 will be dropped from the inlined copy of a function, and from its RTL
10841 expansion.  The default is 100000.
10843 @item min-nondebug-insn-uid
10844 Use uids starting at this parameter for nondebug insns.  The range below
10845 the parameter is reserved exclusively for debug insns created by
10846 @option{-fvar-tracking-assignments}, but debug insns may get
10847 (non-overlapping) uids above it if the reserved range is exhausted.
10849 @item ipa-sra-ptr-growth-factor
10850 IPA-SRA replaces a pointer to an aggregate with one or more new
10851 parameters only when their cumulative size is less or equal to
10852 @option{ipa-sra-ptr-growth-factor} times the size of the original
10853 pointer parameter.
10855 @item sra-max-scalarization-size-Ospeed
10856 @itemx sra-max-scalarization-size-Osize
10857 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10858 replace scalar parts of aggregates with uses of independent scalar
10859 variables.  These parameters control the maximum size, in storage units,
10860 of aggregate which is considered for replacement when compiling for
10861 speed
10862 (@option{sra-max-scalarization-size-Ospeed}) or size
10863 (@option{sra-max-scalarization-size-Osize}) respectively.
10865 @item tm-max-aggregate-size
10866 When making copies of thread-local variables in a transaction, this
10867 parameter specifies the size in bytes after which variables are
10868 saved with the logging functions as opposed to save/restore code
10869 sequence pairs.  This option only applies when using
10870 @option{-fgnu-tm}.
10872 @item graphite-max-nb-scop-params
10873 To avoid exponential effects in the Graphite loop transforms, the
10874 number of parameters in a Static Control Part (SCoP) is bounded.  The
10875 default value is 10 parameters, a value of zero can be used to lift
10876 the bound.  A variable whose value is unknown at compilation time and
10877 defined outside a SCoP is a parameter of the SCoP.
10879 @item loop-block-tile-size
10880 Loop blocking or strip mining transforms, enabled with
10881 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10882 loop in the loop nest by a given number of iterations.  The strip
10883 length can be changed using the @option{loop-block-tile-size}
10884 parameter.  The default value is 51 iterations.
10886 @item loop-unroll-jam-size
10887 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10888 default value is 4.
10890 @item loop-unroll-jam-depth
10891 Specify the dimension to be unrolled (counting from the most inner loop)
10892 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10894 @item ipa-cp-value-list-size
10895 IPA-CP attempts to track all possible values and types passed to a function's
10896 parameter in order to propagate them and perform devirtualization.
10897 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10898 stores per one formal parameter of a function.
10900 @item ipa-cp-eval-threshold
10901 IPA-CP calculates its own score of cloning profitability heuristics
10902 and performs those cloning opportunities with scores that exceed
10903 @option{ipa-cp-eval-threshold}.
10905 @item ipa-cp-recursion-penalty
10906 Percentage penalty the recursive functions will receive when they
10907 are evaluated for cloning.
10909 @item ipa-cp-single-call-penalty
10910 Percentage penalty functions containing a single call to another
10911 function will receive when they are evaluated for cloning.
10914 @item ipa-max-agg-items
10915 IPA-CP is also capable to propagate a number of scalar values passed
10916 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10917 number of such values per one parameter.
10919 @item ipa-cp-loop-hint-bonus
10920 When IPA-CP determines that a cloning candidate would make the number
10921 of iterations of a loop known, it adds a bonus of
10922 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10923 the candidate.
10925 @item ipa-cp-array-index-hint-bonus
10926 When IPA-CP determines that a cloning candidate would make the index of
10927 an array access known, it adds a bonus of
10928 @option{ipa-cp-array-index-hint-bonus} to the profitability
10929 score of the candidate.
10931 @item ipa-max-aa-steps
10932 During its analysis of function bodies, IPA-CP employs alias analysis
10933 in order to track values pointed to by function parameters.  In order
10934 not spend too much time analyzing huge functions, it gives up and
10935 consider all memory clobbered after examining
10936 @option{ipa-max-aa-steps} statements modifying memory.
10938 @item lto-partitions
10939 Specify desired number of partitions produced during WHOPR compilation.
10940 The number of partitions should exceed the number of CPUs used for compilation.
10941 The default value is 32.
10943 @item lto-min-partition
10944 Size of minimal partition for WHOPR (in estimated instructions).
10945 This prevents expenses of splitting very small programs into too many
10946 partitions.
10948 @item lto-max-partition
10949 Size of max partition for WHOPR (in estimated instructions).
10950 to provide an upper bound for individual size of partition.
10951 Meant to be used only with balanced partitioning.
10953 @item cxx-max-namespaces-for-diagnostic-help
10954 The maximum number of namespaces to consult for suggestions when C++
10955 name lookup fails for an identifier.  The default is 1000.
10957 @item sink-frequency-threshold
10958 The maximum relative execution frequency (in percents) of the target block
10959 relative to a statement's original block to allow statement sinking of a
10960 statement.  Larger numbers result in more aggressive statement sinking.
10961 The default value is 75.  A small positive adjustment is applied for
10962 statements with memory operands as those are even more profitable so sink.
10964 @item max-stores-to-sink
10965 The maximum number of conditional store pairs that can be sunk.  Set to 0
10966 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10967 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10969 @item allow-store-data-races
10970 Allow optimizers to introduce new data races on stores.
10971 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10972 at optimization level @option{-Ofast}.
10974 @item case-values-threshold
10975 The smallest number of different values for which it is best to use a
10976 jump-table instead of a tree of conditional branches.  If the value is
10977 0, use the default for the machine.  The default is 0.
10979 @item tree-reassoc-width
10980 Set the maximum number of instructions executed in parallel in
10981 reassociated tree. This parameter overrides target dependent
10982 heuristics used by default if has non zero value.
10984 @item sched-pressure-algorithm
10985 Choose between the two available implementations of
10986 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10987 and is the more likely to prevent instructions from being reordered.
10988 Algorithm 2 was designed to be a compromise between the relatively
10989 conservative approach taken by algorithm 1 and the rather aggressive
10990 approach taken by the default scheduler.  It relies more heavily on
10991 having a regular register file and accurate register pressure classes.
10992 See @file{haifa-sched.c} in the GCC sources for more details.
10994 The default choice depends on the target.
10996 @item max-slsr-cand-scan
10997 Set the maximum number of existing candidates that are considered when
10998 seeking a basis for a new straight-line strength reduction candidate.
11000 @item asan-globals
11001 Enable buffer overflow detection for global objects.  This kind
11002 of protection is enabled by default if you are using
11003 @option{-fsanitize=address} option.
11004 To disable global objects protection use @option{--param asan-globals=0}.
11006 @item asan-stack
11007 Enable buffer overflow detection for stack objects.  This kind of
11008 protection is enabled by default when using @option{-fsanitize=address}.
11009 To disable stack protection use @option{--param asan-stack=0} option.
11011 @item asan-instrument-reads
11012 Enable buffer overflow detection for memory reads.  This kind of
11013 protection is enabled by default when using @option{-fsanitize=address}.
11014 To disable memory reads protection use
11015 @option{--param asan-instrument-reads=0}.
11017 @item asan-instrument-writes
11018 Enable buffer overflow detection for memory writes.  This kind of
11019 protection is enabled by default when using @option{-fsanitize=address}.
11020 To disable memory writes protection use
11021 @option{--param asan-instrument-writes=0} option.
11023 @item asan-memintrin
11024 Enable detection for built-in functions.  This kind of protection
11025 is enabled by default when using @option{-fsanitize=address}.
11026 To disable built-in functions protection use
11027 @option{--param asan-memintrin=0}.
11029 @item asan-use-after-return
11030 Enable detection of use-after-return.  This kind of protection
11031 is enabled by default when using the @option{-fsanitize=address} option.
11032 To disable it use @option{--param asan-use-after-return=0}.
11034 Note: By default the check is disabled at run time.  To enable it,
11035 add @code{detect_stack_use_after_return=1} to the environment variable
11036 @env{ASAN_OPTIONS}.
11038 @item asan-instrumentation-with-call-threshold
11039 If number of memory accesses in function being instrumented
11040 is greater or equal to this number, use callbacks instead of inline checks.
11041 E.g. to disable inline code use
11042 @option{--param asan-instrumentation-with-call-threshold=0}.
11044 @item use-after-scope-direct-emission-threshold
11045 If the size of a local variable in bytes is smaller or equal to this
11046 number, directly poison (or unpoison) shadow memory instead of using
11047 run-time callbacks.  The default value is 256.
11049 @item chkp-max-ctor-size
11050 Static constructors generated by Pointer Bounds Checker may become very
11051 large and significantly increase compile time at optimization level
11052 @option{-O1} and higher.  This parameter is a maximum number of statements
11053 in a single generated constructor.  Default value is 5000.
11055 @item max-fsm-thread-path-insns
11056 Maximum number of instructions to copy when duplicating blocks on a
11057 finite state automaton jump thread path.  The default is 100.
11059 @item max-fsm-thread-length
11060 Maximum number of basic blocks on a finite state automaton jump thread
11061 path.  The default is 10.
11063 @item max-fsm-thread-paths
11064 Maximum number of new jump thread paths to create for a finite state
11065 automaton.  The default is 50.
11067 @item parloops-chunk-size
11068 Chunk size of omp schedule for loops parallelized by parloops.  The default
11069 is 0.
11071 @item parloops-schedule
11072 Schedule type of omp schedule for loops parallelized by parloops (static,
11073 dynamic, guided, auto, runtime).  The default is static.
11075 @item parloops-min-per-thread
11076 The minimum number of iterations per thread of an innermost parallelized
11077 loop for which the parallelized variant is prefered over the single threaded
11078 one.  The default is 100.  Note that for a parallelized loop nest the
11079 minimum number of iterations of the outermost loop per thread is two.
11081 @item max-ssa-name-query-depth
11082 Maximum depth of recursion when querying properties of SSA names in things
11083 like fold routines.  One level of recursion corresponds to following a
11084 use-def chain.
11086 @item hsa-gen-debug-stores
11087 Enable emission of special debug stores within HSA kernels which are
11088 then read and reported by libgomp plugin.  Generation of these stores
11089 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11090 enable it.
11092 @item max-speculative-devirt-maydefs
11093 The maximum number of may-defs we analyze when looking for a must-def
11094 specifying the dynamic type of an object that invokes a virtual call
11095 we may be able to devirtualize speculatively.
11097 @item max-vrp-switch-assertions
11098 The maximum number of assertions to add along the default edge of a switch
11099 statement during VRP.  The default is 10.
11101 @item unroll-jam-min-percent
11102 The minimum percentage of memory references that must be optimized
11103 away for the unroll-and-jam transformation to be considered profitable.
11105 @item unroll-jam-max-unroll
11106 The maximum number of times the outer loop should be unrolled by
11107 the unroll-and-jam transformation.
11108 @end table
11109 @end table
11111 @node Instrumentation Options
11112 @section Program Instrumentation Options
11113 @cindex instrumentation options
11114 @cindex program instrumentation options
11115 @cindex run-time error checking options
11116 @cindex profiling options
11117 @cindex options, program instrumentation
11118 @cindex options, run-time error checking
11119 @cindex options, profiling
11121 GCC supports a number of command-line options that control adding
11122 run-time instrumentation to the code it normally generates.  
11123 For example, one purpose of instrumentation is collect profiling
11124 statistics for use in finding program hot spots, code coverage
11125 analysis, or profile-guided optimizations.
11126 Another class of program instrumentation is adding run-time checking 
11127 to detect programming errors like invalid pointer
11128 dereferences or out-of-bounds array accesses, as well as deliberately
11129 hostile attacks such as stack smashing or C++ vtable hijacking.
11130 There is also a general hook which can be used to implement other
11131 forms of tracing or function-level instrumentation for debug or
11132 program analysis purposes.
11134 @table @gcctabopt
11135 @cindex @command{prof}
11136 @item -p
11137 @opindex p
11138 Generate extra code to write profile information suitable for the
11139 analysis program @command{prof}.  You must use this option when compiling
11140 the source files you want data about, and you must also use it when
11141 linking.
11143 @cindex @command{gprof}
11144 @item -pg
11145 @opindex pg
11146 Generate extra code to write profile information suitable for the
11147 analysis program @command{gprof}.  You must use this option when compiling
11148 the source files you want data about, and you must also use it when
11149 linking.
11151 @item -fprofile-arcs
11152 @opindex fprofile-arcs
11153 Add code so that program flow @dfn{arcs} are instrumented.  During
11154 execution the program records how many times each branch and call is
11155 executed and how many times it is taken or returns.  On targets that support
11156 constructors with priority support, profiling properly handles constructors,
11157 destructors and C++ constructors (and destructors) of classes which are used
11158 as a type of a global variable.
11160 When the compiled
11161 program exits it saves this data to a file called
11162 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11163 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11164 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11165 @var{auxname} is generated from the name of the output file, if
11166 explicitly specified and it is not the final executable, otherwise it is
11167 the basename of the source file.  In both cases any suffix is removed
11168 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11169 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11170 @xref{Cross-profiling}.
11172 @cindex @command{gcov}
11173 @item --coverage
11174 @opindex coverage
11176 This option is used to compile and link code instrumented for coverage
11177 analysis.  The option is a synonym for @option{-fprofile-arcs}
11178 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11179 linking).  See the documentation for those options for more details.
11181 @itemize
11183 @item
11184 Compile the source files with @option{-fprofile-arcs} plus optimization
11185 and code generation options.  For test coverage analysis, use the
11186 additional @option{-ftest-coverage} option.  You do not need to profile
11187 every source file in a program.
11189 @item
11190 Compile the source files additionally with @option{-fprofile-abs-path}
11191 to create absolute path names in the @file{.gcno} files.  This allows
11192 @command{gcov} to find the correct sources in projects where compilations
11193 occur with different working directories.
11195 @item
11196 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11197 (the latter implies the former).
11199 @item
11200 Run the program on a representative workload to generate the arc profile
11201 information.  This may be repeated any number of times.  You can run
11202 concurrent instances of your program, and provided that the file system
11203 supports locking, the data files will be correctly updated.  Unless
11204 a strict ISO C dialect option is in effect, @code{fork} calls are
11205 detected and correctly handled without double counting.
11207 @item
11208 For profile-directed optimizations, compile the source files again with
11209 the same optimization and code generation options plus
11210 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11211 Control Optimization}).
11213 @item
11214 For test coverage analysis, use @command{gcov} to produce human readable
11215 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11216 @command{gcov} documentation for further information.
11218 @end itemize
11220 With @option{-fprofile-arcs}, for each function of your program GCC
11221 creates a program flow graph, then finds a spanning tree for the graph.
11222 Only arcs that are not on the spanning tree have to be instrumented: the
11223 compiler adds code to count the number of times that these arcs are
11224 executed.  When an arc is the only exit or only entrance to a block, the
11225 instrumentation code can be added to the block; otherwise, a new basic
11226 block must be created to hold the instrumentation code.
11228 @need 2000
11229 @item -ftest-coverage
11230 @opindex ftest-coverage
11231 Produce a notes file that the @command{gcov} code-coverage utility
11232 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11233 show program coverage.  Each source file's note file is called
11234 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11235 above for a description of @var{auxname} and instructions on how to
11236 generate test coverage data.  Coverage data matches the source files
11237 more closely if you do not optimize.
11239 @item -fprofile-abs-path
11240 @opindex fprofile-abs-path
11241 Automatically convert relative source file names to absolute path names
11242 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11243 sources in projects where compilations occur with different working
11244 directories.
11246 @item -fprofile-dir=@var{path}
11247 @opindex fprofile-dir
11249 Set the directory to search for the profile data files in to @var{path}.
11250 This option affects only the profile data generated by
11251 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11252 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11253 and its related options.  Both absolute and relative paths can be used.
11254 By default, GCC uses the current directory as @var{path}, thus the
11255 profile data file appears in the same directory as the object file.
11257 @item -fprofile-generate
11258 @itemx -fprofile-generate=@var{path}
11259 @opindex fprofile-generate
11261 Enable options usually used for instrumenting application to produce
11262 profile useful for later recompilation with profile feedback based
11263 optimization.  You must use @option{-fprofile-generate} both when
11264 compiling and when linking your program.
11266 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11268 If @var{path} is specified, GCC looks at the @var{path} to find
11269 the profile feedback data files. See @option{-fprofile-dir}.
11271 To optimize the program based on the collected profile information, use
11272 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11274 @item -fprofile-update=@var{method}
11275 @opindex fprofile-update
11277 Alter the update method for an application instrumented for profile
11278 feedback based optimization.  The @var{method} argument should be one of
11279 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11280 The first one is useful for single-threaded applications,
11281 while the second one prevents profile corruption by emitting thread-safe code.
11283 @strong{Warning:} When an application does not properly join all threads
11284 (or creates an detached thread), a profile file can be still corrupted.
11286 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11287 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11288 automatically selects @samp{prefer-atomic} when @option{-pthread}
11289 is present in the command line.
11291 @item -fsanitize=address
11292 @opindex fsanitize=address
11293 Enable AddressSanitizer, a fast memory error detector.
11294 Memory access instructions are instrumented to detect
11295 out-of-bounds and use-after-free bugs.
11296 The option enables @option{-fsanitize-address-use-after-scope}.
11297 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11298 more details.  The run-time behavior can be influenced using the
11299 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11300 the available options are shown at startup of the instrumented program.  See
11301 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11302 for a list of supported options.
11303 The option cannot be combined with @option{-fsanitize=thread}
11304 and/or @option{-fcheck-pointer-bounds}.
11306 @item -fsanitize=kernel-address
11307 @opindex fsanitize=kernel-address
11308 Enable AddressSanitizer for Linux kernel.
11309 See @uref{https://github.com/google/kasan/wiki} for more details.
11310 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11312 @item -fsanitize=pointer-compare
11313 @opindex fsanitize=pointer-compare
11314 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11315 The option must be combined with either @option{-fsanitize=kernel-address} or
11316 @option{-fsanitize=address}
11317 The option cannot be combined with @option{-fsanitize=thread}
11318 and/or @option{-fcheck-pointer-bounds}.
11319 Note: By default the check is disabled at run time.  To enable it,
11320 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11321 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11322 invalid operation only when both pointers are non-null.
11324 @item -fsanitize=pointer-subtract
11325 @opindex fsanitize=pointer-subtract
11326 Instrument subtraction with pointer operands.
11327 The option must be combined with either @option{-fsanitize=kernel-address} or
11328 @option{-fsanitize=address}
11329 The option cannot be combined with @option{-fsanitize=thread}
11330 and/or @option{-fcheck-pointer-bounds}.
11331 Note: By default the check is disabled at run time.  To enable it,
11332 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11333 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11334 invalid operation only when both pointers are non-null.
11336 @item -fsanitize=thread
11337 @opindex fsanitize=thread
11338 Enable ThreadSanitizer, a fast data race detector.
11339 Memory access instructions are instrumented to detect
11340 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11341 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11342 environment variable; see
11343 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11344 supported options.
11345 The option cannot be combined with @option{-fsanitize=address},
11346 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11348 Note that sanitized atomic builtins cannot throw exceptions when
11349 operating on invalid memory addresses with non-call exceptions
11350 (@option{-fnon-call-exceptions}).
11352 @item -fsanitize=leak
11353 @opindex fsanitize=leak
11354 Enable LeakSanitizer, a memory leak detector.
11355 This option only matters for linking of executables and
11356 the executable is linked against a library that overrides @code{malloc}
11357 and other allocator functions.  See
11358 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11359 details.  The run-time behavior can be influenced using the
11360 @env{LSAN_OPTIONS} environment variable.
11361 The option cannot be combined with @option{-fsanitize=thread}.
11363 @item -fsanitize=undefined
11364 @opindex fsanitize=undefined
11365 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11366 Various computations are instrumented to detect undefined behavior
11367 at runtime.  Current suboptions are:
11369 @table @gcctabopt
11371 @item -fsanitize=shift
11372 @opindex fsanitize=shift
11373 This option enables checking that the result of a shift operation is
11374 not undefined.  Note that what exactly is considered undefined differs
11375 slightly between C and C++, as well as between ISO C90 and C99, etc.
11376 This option has two suboptions, @option{-fsanitize=shift-base} and
11377 @option{-fsanitize=shift-exponent}.
11379 @item -fsanitize=shift-exponent
11380 @opindex fsanitize=shift-exponent
11381 This option enables checking that the second argument of a shift operation
11382 is not negative and is smaller than the precision of the promoted first
11383 argument.
11385 @item -fsanitize=shift-base
11386 @opindex fsanitize=shift-base
11387 If the second argument of a shift operation is within range, check that the
11388 result of a shift operation is not undefined.  Note that what exactly is
11389 considered undefined differs slightly between C and C++, as well as between
11390 ISO C90 and C99, etc.
11392 @item -fsanitize=integer-divide-by-zero
11393 @opindex fsanitize=integer-divide-by-zero
11394 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11396 @item -fsanitize=unreachable
11397 @opindex fsanitize=unreachable
11398 With this option, the compiler turns the @code{__builtin_unreachable}
11399 call into a diagnostics message call instead.  When reaching the
11400 @code{__builtin_unreachable} call, the behavior is undefined.
11402 @item -fsanitize=vla-bound
11403 @opindex fsanitize=vla-bound
11404 This option instructs the compiler to check that the size of a variable
11405 length array is positive.
11407 @item -fsanitize=null
11408 @opindex fsanitize=null
11409 This option enables pointer checking.  Particularly, the application
11410 built with this option turned on will issue an error message when it
11411 tries to dereference a NULL pointer, or if a reference (possibly an
11412 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11413 on an object pointed by a NULL pointer.
11415 @item -fsanitize=return
11416 @opindex fsanitize=return
11417 This option enables return statement checking.  Programs
11418 built with this option turned on will issue an error message
11419 when the end of a non-void function is reached without actually
11420 returning a value.  This option works in C++ only.
11422 @item -fsanitize=signed-integer-overflow
11423 @opindex fsanitize=signed-integer-overflow
11424 This option enables signed integer overflow checking.  We check that
11425 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11426 does not overflow in the signed arithmetics.  Note, integer promotion
11427 rules must be taken into account.  That is, the following is not an
11428 overflow:
11429 @smallexample
11430 signed char a = SCHAR_MAX;
11431 a++;
11432 @end smallexample
11434 @item -fsanitize=bounds
11435 @opindex fsanitize=bounds
11436 This option enables instrumentation of array bounds.  Various out of bounds
11437 accesses are detected.  Flexible array members, flexible array member-like
11438 arrays, and initializers of variables with static storage are not instrumented.
11439 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11441 @item -fsanitize=bounds-strict
11442 @opindex fsanitize=bounds-strict
11443 This option enables strict instrumentation of array bounds.  Most out of bounds
11444 accesses are detected, including flexible array members and flexible array
11445 member-like arrays.  Initializers of variables with static storage are not
11446 instrumented.  The option cannot be combined
11447 with @option{-fcheck-pointer-bounds}.
11449 @item -fsanitize=alignment
11450 @opindex fsanitize=alignment
11452 This option enables checking of alignment of pointers when they are
11453 dereferenced, or when a reference is bound to insufficiently aligned target,
11454 or when a method or constructor is invoked on insufficiently aligned object.
11456 @item -fsanitize=object-size
11457 @opindex fsanitize=object-size
11458 This option enables instrumentation of memory references using the
11459 @code{__builtin_object_size} function.  Various out of bounds pointer
11460 accesses are detected.
11462 @item -fsanitize=float-divide-by-zero
11463 @opindex fsanitize=float-divide-by-zero
11464 Detect floating-point division by zero.  Unlike other similar options,
11465 @option{-fsanitize=float-divide-by-zero} is not enabled by
11466 @option{-fsanitize=undefined}, since floating-point division by zero can
11467 be a legitimate way of obtaining infinities and NaNs.
11469 @item -fsanitize=float-cast-overflow
11470 @opindex fsanitize=float-cast-overflow
11471 This option enables floating-point type to integer conversion checking.
11472 We check that the result of the conversion does not overflow.
11473 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11474 not enabled by @option{-fsanitize=undefined}.
11475 This option does not work well with @code{FE_INVALID} exceptions enabled.
11477 @item -fsanitize=nonnull-attribute
11478 @opindex fsanitize=nonnull-attribute
11480 This option enables instrumentation of calls, checking whether null values
11481 are not passed to arguments marked as requiring a non-null value by the
11482 @code{nonnull} function attribute.
11484 @item -fsanitize=returns-nonnull-attribute
11485 @opindex fsanitize=returns-nonnull-attribute
11487 This option enables instrumentation of return statements in functions
11488 marked with @code{returns_nonnull} function attribute, to detect returning
11489 of null values from such functions.
11491 @item -fsanitize=bool
11492 @opindex fsanitize=bool
11494 This option enables instrumentation of loads from bool.  If a value other
11495 than 0/1 is loaded, a run-time error is issued.
11497 @item -fsanitize=enum
11498 @opindex fsanitize=enum
11500 This option enables instrumentation of loads from an enum type.  If
11501 a value outside the range of values for the enum type is loaded,
11502 a run-time error is issued.
11504 @item -fsanitize=vptr
11505 @opindex fsanitize=vptr
11507 This option enables instrumentation of C++ member function calls, member
11508 accesses and some conversions between pointers to base and derived classes,
11509 to verify the referenced object has the correct dynamic type.
11511 @item -fsanitize=pointer-overflow
11512 @opindex fsanitize=pointer-overflow
11514 This option enables instrumentation of pointer arithmetics.  If the pointer
11515 arithmetics overflows, a run-time error is issued.
11517 @item -fsanitize=builtin
11518 @opindex fsanitize=builtin
11520 This option enables instrumentation of arguments to selected builtin
11521 functions.  If an invalid value is passed to such arguments, a run-time
11522 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11523 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11524 by this option.
11526 @end table
11528 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11529 @option{-fsanitize=undefined} gives a diagnostic message.
11530 This currently works only for the C family of languages.
11532 @item -fno-sanitize=all
11533 @opindex fno-sanitize=all
11535 This option disables all previously enabled sanitizers.
11536 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11537 together.
11539 @item -fasan-shadow-offset=@var{number}
11540 @opindex fasan-shadow-offset
11541 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11542 It is useful for experimenting with different shadow memory layouts in
11543 Kernel AddressSanitizer.
11545 @item -fsanitize-sections=@var{s1},@var{s2},...
11546 @opindex fsanitize-sections
11547 Sanitize global variables in selected user-defined sections.  @var{si} may
11548 contain wildcards.
11550 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11551 @opindex fsanitize-recover
11552 @opindex fno-sanitize-recover
11553 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11554 mentioned in comma-separated list of @var{opts}.  Enabling this option
11555 for a sanitizer component causes it to attempt to continue
11556 running the program as if no error happened.  This means multiple
11557 runtime errors can be reported in a single program run, and the exit
11558 code of the program may indicate success even when errors
11559 have been reported.  The @option{-fno-sanitize-recover=} option
11560 can be used to alter
11561 this behavior: only the first detected error is reported
11562 and program then exits with a non-zero exit code.
11564 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11565 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11566 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11567 @option{-fsanitize=bounds-strict},
11568 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11569 For these sanitizers error recovery is turned on by default,
11570 except @option{-fsanitize=address}, for which this feature is experimental.
11571 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11572 accepted, the former enables recovery for all sanitizers that support it,
11573 the latter disables recovery for all sanitizers that support it.
11575 Even if a recovery mode is turned on the compiler side, it needs to be also
11576 enabled on the runtime library side, otherwise the failures are still fatal.
11577 The runtime library defaults to @code{halt_on_error=0} for
11578 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11579 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11580 setting the @code{halt_on_error} flag in the corresponding environment variable.
11582 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11583 equivalent to specifying an @var{opts} list of:
11585 @smallexample
11586 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11587 @end smallexample
11589 @item -fsanitize-address-use-after-scope
11590 @opindex fsanitize-address-use-after-scope
11591 Enable sanitization of local variables to detect use-after-scope bugs.
11592 The option sets @option{-fstack-reuse} to @samp{none}.
11594 @item -fsanitize-undefined-trap-on-error
11595 @opindex fsanitize-undefined-trap-on-error
11596 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11597 report undefined behavior using @code{__builtin_trap} rather than
11598 a @code{libubsan} library routine.  The advantage of this is that the
11599 @code{libubsan} library is not needed and is not linked in, so this
11600 is usable even in freestanding environments.
11602 @item -fsanitize-coverage=trace-pc
11603 @opindex fsanitize-coverage=trace-pc
11604 Enable coverage-guided fuzzing code instrumentation.
11605 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11607 @item -fsanitize-coverage=trace-cmp
11608 @opindex fsanitize-coverage=trace-cmp
11609 Enable dataflow guided fuzzing code instrumentation.
11610 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11611 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11612 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11613 variable or @code{__sanitizer_cov_trace_const_cmp1},
11614 @code{__sanitizer_cov_trace_const_cmp2},
11615 @code{__sanitizer_cov_trace_const_cmp4} or
11616 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11617 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11618 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11619 @code{__sanitizer_cov_trace_switch} for switch statements.
11621 @item -fbounds-check
11622 @opindex fbounds-check
11623 For front ends that support it, generate additional code to check that
11624 indices used to access arrays are within the declared range.  This is
11625 currently only supported by the Fortran front end, where this option
11626 defaults to false.
11628 @item -fcheck-pointer-bounds
11629 @opindex fcheck-pointer-bounds
11630 @opindex fno-check-pointer-bounds
11631 @cindex Pointer Bounds Checker options
11632 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11633 is instrumented with checks of the pointer used for memory access against
11634 bounds associated with that pointer.  
11636 Currently there
11637 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11638 and @option{-mmpx} are required to enable this feature.  
11639 MPX-based instrumentation requires
11640 a runtime library to enable MPX in hardware and handle bounds
11641 violation signals.  By default when @option{-fcheck-pointer-bounds}
11642 and @option{-mmpx} options are used to link a program, the GCC driver
11643 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11644 Bounds checking on calls to dynamic libraries requires a linker
11645 with @option{-z bndplt} support; if GCC was configured with a linker
11646 without support for this option (including the Gold linker and older
11647 versions of ld), a warning is given if you link with @option{-mmpx}
11648 without also specifying @option{-static}, since the overall effectiveness
11649 of the bounds checking protection is reduced.
11650 See also @option{-static-libmpxwrappers}.
11652 MPX-based instrumentation
11653 may be used for debugging and also may be included in production code
11654 to increase program security.  Depending on usage, you may
11655 have different requirements for the runtime library.  The current version
11656 of the MPX runtime library is more oriented for use as a debugging
11657 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11658 also @option{-static-libmpx}.  The runtime library  behavior can be
11659 influenced using various @env{CHKP_RT_*} environment variables.  See
11660 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11661 for more details.
11663 Generated instrumentation may be controlled by various
11664 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11665 structure field attribute (@pxref{Type Attributes}) and
11666 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11667 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11668 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11669 Bounds Checker builtins}, for more information.
11671 @item -fchkp-check-incomplete-type
11672 @opindex fchkp-check-incomplete-type
11673 @opindex fno-chkp-check-incomplete-type
11674 Generate pointer bounds checks for variables with incomplete type.
11675 Enabled by default.
11677 @item -fchkp-narrow-bounds
11678 @opindex fchkp-narrow-bounds
11679 @opindex fno-chkp-narrow-bounds
11680 Controls bounds used by Pointer Bounds Checker for pointers to object
11681 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11682 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11683 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11685 @item -fchkp-first-field-has-own-bounds
11686 @opindex fchkp-first-field-has-own-bounds
11687 @opindex fno-chkp-first-field-has-own-bounds
11688 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11689 first field in the structure.  By default a pointer to the first field has
11690 the same bounds as a pointer to the whole structure.
11692 @item -fchkp-flexible-struct-trailing-arrays
11693 @opindex fchkp-flexible-struct-trailing-arrays
11694 @opindex fno-chkp-flexible-struct-trailing-arrays
11695 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11696 possibly flexible.  By default only array fields with zero length or that are
11697 marked with attribute bnd_variable_size are treated as flexible.
11699 @item -fchkp-narrow-to-innermost-array
11700 @opindex fchkp-narrow-to-innermost-array
11701 @opindex fno-chkp-narrow-to-innermost-array
11702 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11703 case of nested static array access.  By default this option is disabled and
11704 bounds of the outermost array are used.
11706 @item -fchkp-optimize
11707 @opindex fchkp-optimize
11708 @opindex fno-chkp-optimize
11709 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11710 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11712 @item -fchkp-use-fast-string-functions
11713 @opindex fchkp-use-fast-string-functions
11714 @opindex fno-chkp-use-fast-string-functions
11715 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11716 by Pointer Bounds Checker.  Disabled by default.
11718 @item -fchkp-use-nochk-string-functions
11719 @opindex fchkp-use-nochk-string-functions
11720 @opindex fno-chkp-use-nochk-string-functions
11721 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11722 by Pointer Bounds Checker.  Disabled by default.
11724 @item -fchkp-use-static-bounds
11725 @opindex fchkp-use-static-bounds
11726 @opindex fno-chkp-use-static-bounds
11727 Allow Pointer Bounds Checker to generate static bounds holding
11728 bounds of static variables.  Enabled by default.
11730 @item -fchkp-use-static-const-bounds
11731 @opindex fchkp-use-static-const-bounds
11732 @opindex fno-chkp-use-static-const-bounds
11733 Use statically-initialized bounds for constant bounds instead of
11734 generating them each time they are required.  By default enabled when
11735 @option{-fchkp-use-static-bounds} is enabled.
11737 @item -fchkp-treat-zero-dynamic-size-as-infinite
11738 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11739 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11740 With this option, objects with incomplete type whose
11741 dynamically-obtained size is zero are treated as having infinite size
11742 instead by Pointer Bounds
11743 Checker.  This option may be helpful if a program is linked with a library
11744 missing size information for some symbols.  Disabled by default.
11746 @item -fchkp-check-read
11747 @opindex fchkp-check-read
11748 @opindex fno-chkp-check-read
11749 Instructs Pointer Bounds Checker to generate checks for all read
11750 accesses to memory.  Enabled by default.
11752 @item -fchkp-check-write
11753 @opindex fchkp-check-write
11754 @opindex fno-chkp-check-write
11755 Instructs Pointer Bounds Checker to generate checks for all write
11756 accesses to memory.  Enabled by default.
11758 @item -fchkp-store-bounds
11759 @opindex fchkp-store-bounds
11760 @opindex fno-chkp-store-bounds
11761 Instructs Pointer Bounds Checker to generate bounds stores for
11762 pointer writes.  Enabled by default.
11764 @item -fchkp-instrument-calls
11765 @opindex fchkp-instrument-calls
11766 @opindex fno-chkp-instrument-calls
11767 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11768 Enabled by default.
11770 @item -fchkp-instrument-marked-only
11771 @opindex fchkp-instrument-marked-only
11772 @opindex fno-chkp-instrument-marked-only
11773 Instructs Pointer Bounds Checker to instrument only functions
11774 marked with the @code{bnd_instrument} attribute
11775 (@pxref{Function Attributes}).  Disabled by default.
11777 @item -fchkp-use-wrappers
11778 @opindex fchkp-use-wrappers
11779 @opindex fno-chkp-use-wrappers
11780 Allows Pointer Bounds Checker to replace calls to built-in functions
11781 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11782 is used to link a program, the GCC driver automatically links
11783 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11784 Enabled by default.
11786 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11787 @opindex fcf-protection
11788 Enable code instrumentation of control-flow transfers to increase
11789 program security by checking that target addresses of control-flow
11790 transfer instructions (such as indirect function call, function return,
11791 indirect jump) are valid.  This prevents diverting the flow of control
11792 to an unexpected target.  This is intended to protect against such
11793 threats as Return-oriented Programming (ROP), and similarly
11794 call/jmp-oriented programming (COP/JOP).
11796 The value @code{branch} tells the compiler to implement checking of
11797 validity of control-flow transfer at the point of indirect branch
11798 instructions, i.e. call/jmp instructions.  The value @code{return}
11799 implements checking of validity at the point of returning from a
11800 function.  The value @code{full} is an alias for specifying both
11801 @code{branch} and @code{return}. The value @code{none} turns off
11802 instrumentation.
11804 The macro @code{__CET__} is defined when @option{-fcf-protection} is
11805 used.  The first bit of @code{__CET__} is set to 1 for the value
11806 @code{branch} and the second bit of @code{__CET__} is set to 1 for
11807 the @code{return}.
11809 You can also use the @code{nocf_check} attribute to identify
11810 which functions and calls should be skipped from instrumentation
11811 (@pxref{Function Attributes}).
11813 Currently the x86 GNU/Linux target provides an implementation based
11814 on Intel Control-flow Enforcement Technology (CET).
11816 @item -fstack-protector
11817 @opindex fstack-protector
11818 Emit extra code to check for buffer overflows, such as stack smashing
11819 attacks.  This is done by adding a guard variable to functions with
11820 vulnerable objects.  This includes functions that call @code{alloca}, and
11821 functions with buffers larger than 8 bytes.  The guards are initialized
11822 when a function is entered and then checked when the function exits.
11823 If a guard check fails, an error message is printed and the program exits.
11825 @item -fstack-protector-all
11826 @opindex fstack-protector-all
11827 Like @option{-fstack-protector} except that all functions are protected.
11829 @item -fstack-protector-strong
11830 @opindex fstack-protector-strong
11831 Like @option{-fstack-protector} but includes additional functions to
11832 be protected --- those that have local array definitions, or have
11833 references to local frame addresses.
11835 @item -fstack-protector-explicit
11836 @opindex fstack-protector-explicit
11837 Like @option{-fstack-protector} but only protects those functions which
11838 have the @code{stack_protect} attribute.
11840 @item -fstack-check
11841 @opindex fstack-check
11842 Generate code to verify that you do not go beyond the boundary of the
11843 stack.  You should specify this flag if you are running in an
11844 environment with multiple threads, but you only rarely need to specify it in
11845 a single-threaded environment since stack overflow is automatically
11846 detected on nearly all systems if there is only one stack.
11848 Note that this switch does not actually cause checking to be done; the
11849 operating system or the language runtime must do that.  The switch causes
11850 generation of code to ensure that they see the stack being extended.
11852 You can additionally specify a string parameter: @samp{no} means no
11853 checking, @samp{generic} means force the use of old-style checking,
11854 @samp{specific} means use the best checking method and is equivalent
11855 to bare @option{-fstack-check}.
11857 Old-style checking is a generic mechanism that requires no specific
11858 target support in the compiler but comes with the following drawbacks:
11860 @enumerate
11861 @item
11862 Modified allocation strategy for large objects: they are always
11863 allocated dynamically if their size exceeds a fixed threshold.  Note this
11864 may change the semantics of some code.
11866 @item
11867 Fixed limit on the size of the static frame of functions: when it is
11868 topped by a particular function, stack checking is not reliable and
11869 a warning is issued by the compiler.
11871 @item
11872 Inefficiency: because of both the modified allocation strategy and the
11873 generic implementation, code performance is hampered.
11874 @end enumerate
11876 Note that old-style stack checking is also the fallback method for
11877 @samp{specific} if no target support has been added in the compiler.
11879 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11880 and stack overflows.  @samp{specific} is an excellent choice when compiling
11881 Ada code.  It is not generally sufficient to protect against stack-clash
11882 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11884 @item -fstack-clash-protection
11885 @opindex fstack-clash-protection
11886 Generate code to prevent stack clash style attacks.  When this option is
11887 enabled, the compiler will only allocate one page of stack space at a time
11888 and each page is accessed immediately after allocation.  Thus, it prevents
11889 allocations from jumping over any stack guard page provided by the
11890 operating system.
11892 Most targets do not fully support stack clash protection.  However, on
11893 those targets @option{-fstack-clash-protection} will protect dynamic stack
11894 allocations.  @option{-fstack-clash-protection} may also provide limited
11895 protection for static stack allocations if the target supports
11896 @option{-fstack-check=specific}.
11898 @item -fstack-limit-register=@var{reg}
11899 @itemx -fstack-limit-symbol=@var{sym}
11900 @itemx -fno-stack-limit
11901 @opindex fstack-limit-register
11902 @opindex fstack-limit-symbol
11903 @opindex fno-stack-limit
11904 Generate code to ensure that the stack does not grow beyond a certain value,
11905 either the value of a register or the address of a symbol.  If a larger
11906 stack is required, a signal is raised at run time.  For most targets,
11907 the signal is raised before the stack overruns the boundary, so
11908 it is possible to catch the signal without taking special precautions.
11910 For instance, if the stack starts at absolute address @samp{0x80000000}
11911 and grows downwards, you can use the flags
11912 @option{-fstack-limit-symbol=__stack_limit} and
11913 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11914 of 128KB@.  Note that this may only work with the GNU linker.
11916 You can locally override stack limit checking by using the
11917 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11919 @item -fsplit-stack
11920 @opindex fsplit-stack
11921 Generate code to automatically split the stack before it overflows.
11922 The resulting program has a discontiguous stack which can only
11923 overflow if the program is unable to allocate any more memory.  This
11924 is most useful when running threaded programs, as it is no longer
11925 necessary to calculate a good stack size to use for each thread.  This
11926 is currently only implemented for the x86 targets running
11927 GNU/Linux.
11929 When code compiled with @option{-fsplit-stack} calls code compiled
11930 without @option{-fsplit-stack}, there may not be much stack space
11931 available for the latter code to run.  If compiling all code,
11932 including library code, with @option{-fsplit-stack} is not an option,
11933 then the linker can fix up these calls so that the code compiled
11934 without @option{-fsplit-stack} always has a large stack.  Support for
11935 this is implemented in the gold linker in GNU binutils release 2.21
11936 and later.
11938 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11939 @opindex fvtable-verify
11940 This option is only available when compiling C++ code.
11941 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11942 feature that verifies at run time, for every virtual call, that
11943 the vtable pointer through which the call is made is valid for the type of
11944 the object, and has not been corrupted or overwritten.  If an invalid vtable
11945 pointer is detected at run time, an error is reported and execution of the
11946 program is immediately halted.
11948 This option causes run-time data structures to be built at program startup,
11949 which are used for verifying the vtable pointers.  
11950 The options @samp{std} and @samp{preinit}
11951 control the timing of when these data structures are built.  In both cases the
11952 data structures are built before execution reaches @code{main}.  Using
11953 @option{-fvtable-verify=std} causes the data structures to be built after
11954 shared libraries have been loaded and initialized.
11955 @option{-fvtable-verify=preinit} causes them to be built before shared
11956 libraries have been loaded and initialized.
11958 If this option appears multiple times in the command line with different
11959 values specified, @samp{none} takes highest priority over both @samp{std} and
11960 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11962 @item -fvtv-debug
11963 @opindex fvtv-debug
11964 When used in conjunction with @option{-fvtable-verify=std} or 
11965 @option{-fvtable-verify=preinit}, causes debug versions of the 
11966 runtime functions for the vtable verification feature to be called.  
11967 This flag also causes the compiler to log information about which 
11968 vtable pointers it finds for each class.
11969 This information is written to a file named @file{vtv_set_ptr_data.log} 
11970 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11971 if that is defined or the current working directory otherwise.
11973 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11974 file, be sure to delete any existing one.
11976 @item -fvtv-counts
11977 @opindex fvtv-counts
11978 This is a debugging flag.  When used in conjunction with
11979 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11980 causes the compiler to keep track of the total number of virtual calls
11981 it encounters and the number of verifications it inserts.  It also
11982 counts the number of calls to certain run-time library functions
11983 that it inserts and logs this information for each compilation unit.
11984 The compiler writes this information to a file named
11985 @file{vtv_count_data.log} in the directory named by the environment
11986 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11987 directory otherwise.  It also counts the size of the vtable pointer sets
11988 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11989 in the same directory.
11991 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11992 files, be sure to delete any existing ones.
11994 @item -finstrument-functions
11995 @opindex finstrument-functions
11996 Generate instrumentation calls for entry and exit to functions.  Just
11997 after function entry and just before function exit, the following
11998 profiling functions are called with the address of the current
11999 function and its call site.  (On some platforms,
12000 @code{__builtin_return_address} does not work beyond the current
12001 function, so the call site information may not be available to the
12002 profiling functions otherwise.)
12004 @smallexample
12005 void __cyg_profile_func_enter (void *this_fn,
12006                                void *call_site);
12007 void __cyg_profile_func_exit  (void *this_fn,
12008                                void *call_site);
12009 @end smallexample
12011 The first argument is the address of the start of the current function,
12012 which may be looked up exactly in the symbol table.
12014 This instrumentation is also done for functions expanded inline in other
12015 functions.  The profiling calls indicate where, conceptually, the
12016 inline function is entered and exited.  This means that addressable
12017 versions of such functions must be available.  If all your uses of a
12018 function are expanded inline, this may mean an additional expansion of
12019 code size.  If you use @code{extern inline} in your C code, an
12020 addressable version of such functions must be provided.  (This is
12021 normally the case anyway, but if you get lucky and the optimizer always
12022 expands the functions inline, you might have gotten away without
12023 providing static copies.)
12025 A function may be given the attribute @code{no_instrument_function}, in
12026 which case this instrumentation is not done.  This can be used, for
12027 example, for the profiling functions listed above, high-priority
12028 interrupt routines, and any functions from which the profiling functions
12029 cannot safely be called (perhaps signal handlers, if the profiling
12030 routines generate output or allocate memory).
12032 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12033 @opindex finstrument-functions-exclude-file-list
12035 Set the list of functions that are excluded from instrumentation (see
12036 the description of @option{-finstrument-functions}).  If the file that
12037 contains a function definition matches with one of @var{file}, then
12038 that function is not instrumented.  The match is done on substrings:
12039 if the @var{file} parameter is a substring of the file name, it is
12040 considered to be a match.
12042 For example:
12044 @smallexample
12045 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12046 @end smallexample
12048 @noindent
12049 excludes any inline function defined in files whose pathnames
12050 contain @file{/bits/stl} or @file{include/sys}.
12052 If, for some reason, you want to include letter @samp{,} in one of
12053 @var{sym}, write @samp{\,}. For example,
12054 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12055 (note the single quote surrounding the option).
12057 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12058 @opindex finstrument-functions-exclude-function-list
12060 This is similar to @option{-finstrument-functions-exclude-file-list},
12061 but this option sets the list of function names to be excluded from
12062 instrumentation.  The function name to be matched is its user-visible
12063 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12064 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12065 match is done on substrings: if the @var{sym} parameter is a substring
12066 of the function name, it is considered to be a match.  For C99 and C++
12067 extended identifiers, the function name must be given in UTF-8, not
12068 using universal character names.
12070 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12071 @opindex fpatchable-function-entry
12072 Generate @var{N} NOPs right at the beginning
12073 of each function, with the function entry point before the @var{M}th NOP.
12074 If @var{M} is omitted, it defaults to @code{0} so the
12075 function entry points to the address just at the first NOP.
12076 The NOP instructions reserve extra space which can be used to patch in
12077 any desired instrumentation at run time, provided that the code segment
12078 is writable.  The amount of space is controllable indirectly via
12079 the number of NOPs; the NOP instruction used corresponds to the instruction
12080 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12081 is target-specific and may also depend on the architecture variant and/or
12082 other compilation options.
12084 For run-time identification, the starting addresses of these areas,
12085 which correspond to their respective function entries minus @var{M},
12086 are additionally collected in the @code{__patchable_function_entries}
12087 section of the resulting binary.
12089 Note that the value of @code{__attribute__ ((patchable_function_entry
12090 (N,M)))} takes precedence over command-line option
12091 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12092 the area size or to remove it completely on a single function.
12093 If @code{N=0}, no pad location is recorded.
12095 The NOP instructions are inserted at---and maybe before, depending on
12096 @var{M}---the function entry address, even before the prologue.
12098 @end table
12101 @node Preprocessor Options
12102 @section Options Controlling the Preprocessor
12103 @cindex preprocessor options
12104 @cindex options, preprocessor
12106 These options control the C preprocessor, which is run on each C source
12107 file before actual compilation.
12109 If you use the @option{-E} option, nothing is done except preprocessing.
12110 Some of these options make sense only together with @option{-E} because
12111 they cause the preprocessor output to be unsuitable for actual
12112 compilation.
12114 In addition to the options listed here, there are a number of options 
12115 to control search paths for include files documented in 
12116 @ref{Directory Options}.  
12117 Options to control preprocessor diagnostics are listed in 
12118 @ref{Warning Options}.
12120 @table @gcctabopt
12121 @include cppopts.texi
12123 @item -Wp,@var{option}
12124 @opindex Wp
12125 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12126 and pass @var{option} directly through to the preprocessor.  If
12127 @var{option} contains commas, it is split into multiple options at the
12128 commas.  However, many options are modified, translated or interpreted
12129 by the compiler driver before being passed to the preprocessor, and
12130 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12131 interface is undocumented and subject to change, so whenever possible
12132 you should avoid using @option{-Wp} and let the driver handle the
12133 options instead.
12135 @item -Xpreprocessor @var{option}
12136 @opindex Xpreprocessor
12137 Pass @var{option} as an option to the preprocessor.  You can use this to
12138 supply system-specific preprocessor options that GCC does not 
12139 recognize.
12141 If you want to pass an option that takes an argument, you must use
12142 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12144 @item -no-integrated-cpp
12145 @opindex no-integrated-cpp
12146 Perform preprocessing as a separate pass before compilation.
12147 By default, GCC performs preprocessing as an integrated part of
12148 input tokenization and parsing.
12149 If this option is provided, the appropriate language front end
12150 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12151 and Objective-C, respectively) is instead invoked twice,
12152 once for preprocessing only and once for actual compilation
12153 of the preprocessed input.
12154 This option may be useful in conjunction with the @option{-B} or
12155 @option{-wrapper} options to specify an alternate preprocessor or
12156 perform additional processing of the program source between
12157 normal preprocessing and compilation.
12159 @end table
12161 @node Assembler Options
12162 @section Passing Options to the Assembler
12164 @c prevent bad page break with this line
12165 You can pass options to the assembler.
12167 @table @gcctabopt
12168 @item -Wa,@var{option}
12169 @opindex Wa
12170 Pass @var{option} as an option to the assembler.  If @var{option}
12171 contains commas, it is split into multiple options at the commas.
12173 @item -Xassembler @var{option}
12174 @opindex Xassembler
12175 Pass @var{option} as an option to the assembler.  You can use this to
12176 supply system-specific assembler options that GCC does not
12177 recognize.
12179 If you want to pass an option that takes an argument, you must use
12180 @option{-Xassembler} twice, once for the option and once for the argument.
12182 @end table
12184 @node Link Options
12185 @section Options for Linking
12186 @cindex link options
12187 @cindex options, linking
12189 These options come into play when the compiler links object files into
12190 an executable output file.  They are meaningless if the compiler is
12191 not doing a link step.
12193 @table @gcctabopt
12194 @cindex file names
12195 @item @var{object-file-name}
12196 A file name that does not end in a special recognized suffix is
12197 considered to name an object file or library.  (Object files are
12198 distinguished from libraries by the linker according to the file
12199 contents.)  If linking is done, these object files are used as input
12200 to the linker.
12202 @item -c
12203 @itemx -S
12204 @itemx -E
12205 @opindex c
12206 @opindex S
12207 @opindex E
12208 If any of these options is used, then the linker is not run, and
12209 object file names should not be used as arguments.  @xref{Overall
12210 Options}.
12212 @item -fuse-ld=bfd
12213 @opindex fuse-ld=bfd
12214 Use the @command{bfd} linker instead of the default linker.
12216 @item -fuse-ld=gold
12217 @opindex fuse-ld=gold
12218 Use the @command{gold} linker instead of the default linker.
12220 @cindex Libraries
12221 @item -l@var{library}
12222 @itemx -l @var{library}
12223 @opindex l
12224 Search the library named @var{library} when linking.  (The second
12225 alternative with the library as a separate argument is only for
12226 POSIX compliance and is not recommended.)
12228 It makes a difference where in the command you write this option; the
12229 linker searches and processes libraries and object files in the order they
12230 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12231 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12232 to functions in @samp{z}, those functions may not be loaded.
12234 The linker searches a standard list of directories for the library,
12235 which is actually a file named @file{lib@var{library}.a}.  The linker
12236 then uses this file as if it had been specified precisely by name.
12238 The directories searched include several standard system directories
12239 plus any that you specify with @option{-L}.
12241 Normally the files found this way are library files---archive files
12242 whose members are object files.  The linker handles an archive file by
12243 scanning through it for members which define symbols that have so far
12244 been referenced but not defined.  But if the file that is found is an
12245 ordinary object file, it is linked in the usual fashion.  The only
12246 difference between using an @option{-l} option and specifying a file name
12247 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12248 and searches several directories.
12250 @item -lobjc
12251 @opindex lobjc
12252 You need this special case of the @option{-l} option in order to
12253 link an Objective-C or Objective-C++ program.
12255 @item -nostartfiles
12256 @opindex nostartfiles
12257 Do not use the standard system startup files when linking.
12258 The standard system libraries are used normally, unless @option{-nostdlib}
12259 or @option{-nodefaultlibs} is used.
12261 @item -nodefaultlibs
12262 @opindex nodefaultlibs
12263 Do not use the standard system libraries when linking.
12264 Only the libraries you specify are passed to the linker, and options
12265 specifying linkage of the system libraries, such as @option{-static-libgcc}
12266 or @option{-shared-libgcc}, are ignored.  
12267 The standard startup files are used normally, unless @option{-nostartfiles}
12268 is used.  
12270 The compiler may generate calls to @code{memcmp},
12271 @code{memset}, @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 @item -nostdlib
12277 @opindex nostdlib
12278 Do not use the standard system startup files or libraries when linking.
12279 No startup files and only the libraries you specify are passed to
12280 the linker, and options specifying linkage of the system libraries, such as
12281 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12283 The compiler may generate calls to @code{memcmp}, @code{memset},
12284 @code{memcpy} and @code{memmove}.
12285 These entries are usually resolved by entries in
12286 libc.  These entry points should be supplied through some other
12287 mechanism when this option is specified.
12289 @cindex @option{-lgcc}, use with @option{-nostdlib}
12290 @cindex @option{-nostdlib} and unresolved references
12291 @cindex unresolved references and @option{-nostdlib}
12292 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12293 @cindex @option{-nodefaultlibs} and unresolved references
12294 @cindex unresolved references and @option{-nodefaultlibs}
12295 One of the standard libraries bypassed by @option{-nostdlib} and
12296 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12297 which GCC uses to overcome shortcomings of particular machines, or special
12298 needs for some languages.
12299 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12300 Collection (GCC) Internals},
12301 for more discussion of @file{libgcc.a}.)
12302 In most cases, you need @file{libgcc.a} even when you want to avoid
12303 other standard libraries.  In other words, when you specify @option{-nostdlib}
12304 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12305 This ensures that you have no unresolved references to internal GCC
12306 library subroutines.
12307 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12308 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12309 GNU Compiler Collection (GCC) Internals}.)
12311 @item -pie
12312 @opindex pie
12313 Produce a dynamically linked position independent executable on targets
12314 that support it.  For predictable results, you must also specify the same
12315 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12316 or model suboptions) when you specify this linker option.
12318 @item -no-pie
12319 @opindex no-pie
12320 Don't produce a dynamically linked position independent executable.
12322 @item -static-pie
12323 @opindex static-pie
12324 Produce a static position independent executable on targets that support
12325 it.  A static position independent executable is similar to a static
12326 executable, but can be loaded at any address without a dynamic linker.
12327 For predictable results, you must also specify the same set of options
12328 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12329 suboptions) when you specify this linker option.
12331 @item -pthread
12332 @opindex pthread
12333 Link with the POSIX threads library.  This option is supported on 
12334 GNU/Linux targets, most other Unix derivatives, and also on 
12335 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12336 flags for the preprocessor, so it should be used consistently for both
12337 compilation and linking.
12339 @item -rdynamic
12340 @opindex rdynamic
12341 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12342 that support it. This instructs the linker to add all symbols, not
12343 only used ones, to the dynamic symbol table. This option is needed
12344 for some uses of @code{dlopen} or to allow obtaining backtraces
12345 from within a program.
12347 @item -s
12348 @opindex s
12349 Remove all symbol table and relocation information from the executable.
12351 @item -static
12352 @opindex static
12353 On systems that support dynamic linking, this overrides @option{-pie}
12354 and prevents linking with the shared libraries.  On other systems, this
12355 option has no effect.
12357 @item -shared
12358 @opindex shared
12359 Produce a shared object which can then be linked with other objects to
12360 form an executable.  Not all systems support this option.  For predictable
12361 results, you must also specify the same set of options used for compilation
12362 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12363 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12364 needs to build supplementary stub code for constructors to work.  On
12365 multi-libbed systems, @samp{gcc -shared} must select the correct support
12366 libraries to link against.  Failing to supply the correct flags may lead
12367 to subtle defects.  Supplying them in cases where they are not necessary
12368 is innocuous.}
12370 @item -shared-libgcc
12371 @itemx -static-libgcc
12372 @opindex shared-libgcc
12373 @opindex static-libgcc
12374 On systems that provide @file{libgcc} as a shared library, these options
12375 force the use of either the shared or static version, respectively.
12376 If no shared version of @file{libgcc} was built when the compiler was
12377 configured, these options have no effect.
12379 There are several situations in which an application should use the
12380 shared @file{libgcc} instead of the static version.  The most common
12381 of these is when the application wishes to throw and catch exceptions
12382 across different shared libraries.  In that case, each of the libraries
12383 as well as the application itself should use the shared @file{libgcc}.
12385 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12386  whenever you build a shared library or a main executable, because C++
12387  programs typically use exceptions, so this is the right thing to do.
12389 If, instead, you use the GCC driver to create shared libraries, you may
12390 find that they are not always linked with the shared @file{libgcc}.
12391 If GCC finds, at its configuration time, that you have a non-GNU linker
12392 or a GNU linker that does not support option @option{--eh-frame-hdr},
12393 it links the shared version of @file{libgcc} into shared libraries
12394 by default.  Otherwise, it takes advantage of the linker and optimizes
12395 away the linking with the shared version of @file{libgcc}, linking with
12396 the static version of libgcc by default.  This allows exceptions to
12397 propagate through such shared libraries, without incurring relocation
12398 costs at library load time.
12400 However, if a library or main executable is supposed to throw or catch
12401 exceptions, you must link it using the G++ driver, as appropriate
12402 for the languages used in the program, or using the option
12403 @option{-shared-libgcc}, such that it is linked with the shared
12404 @file{libgcc}.
12406 @item -static-libasan
12407 @opindex static-libasan
12408 When the @option{-fsanitize=address} option is used to link a program,
12409 the GCC driver automatically links against @option{libasan}.  If
12410 @file{libasan} is available as a shared library, and the @option{-static}
12411 option is not used, then this links against the shared version of
12412 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12413 driver to link @file{libasan} statically, without necessarily linking
12414 other libraries statically.
12416 @item -static-libtsan
12417 @opindex static-libtsan
12418 When the @option{-fsanitize=thread} option is used to link a program,
12419 the GCC driver automatically links against @option{libtsan}.  If
12420 @file{libtsan} is available as a shared library, and the @option{-static}
12421 option is not used, then this links against the shared version of
12422 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12423 driver to link @file{libtsan} statically, without necessarily linking
12424 other libraries statically.
12426 @item -static-liblsan
12427 @opindex static-liblsan
12428 When the @option{-fsanitize=leak} option is used to link a program,
12429 the GCC driver automatically links against @option{liblsan}.  If
12430 @file{liblsan} is available as a shared library, and the @option{-static}
12431 option is not used, then this links against the shared version of
12432 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12433 driver to link @file{liblsan} statically, without necessarily linking
12434 other libraries statically.
12436 @item -static-libubsan
12437 @opindex static-libubsan
12438 When the @option{-fsanitize=undefined} option is used to link a program,
12439 the GCC driver automatically links against @option{libubsan}.  If
12440 @file{libubsan} is available as a shared library, and the @option{-static}
12441 option is not used, then this links against the shared version of
12442 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12443 driver to link @file{libubsan} statically, without necessarily linking
12444 other libraries statically.
12446 @item -static-libmpx
12447 @opindex static-libmpx
12448 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12449 used to link a program, the GCC driver automatically links against
12450 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12451 and the @option{-static} option is not used, then this links against
12452 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12453 option directs the GCC driver to link @file{libmpx} statically,
12454 without necessarily linking other libraries statically.
12456 @item -static-libmpxwrappers
12457 @opindex static-libmpxwrappers
12458 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12459 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12460 GCC driver automatically links against @file{libmpxwrappers}.  If
12461 @file{libmpxwrappers} is available as a shared library, and the
12462 @option{-static} option is not used, then this links against the shared
12463 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12464 option directs the GCC driver to link @file{libmpxwrappers} statically,
12465 without necessarily linking other libraries statically.
12467 @item -static-libstdc++
12468 @opindex static-libstdc++
12469 When the @command{g++} program is used to link a C++ program, it
12470 normally automatically links against @option{libstdc++}.  If
12471 @file{libstdc++} is available as a shared library, and the
12472 @option{-static} option is not used, then this links against the
12473 shared version of @file{libstdc++}.  That is normally fine.  However, it
12474 is sometimes useful to freeze the version of @file{libstdc++} used by
12475 the program without going all the way to a fully static link.  The
12476 @option{-static-libstdc++} option directs the @command{g++} driver to
12477 link @file{libstdc++} statically, without necessarily linking other
12478 libraries statically.
12480 @item -symbolic
12481 @opindex symbolic
12482 Bind references to global symbols when building a shared object.  Warn
12483 about any unresolved references (unless overridden by the link editor
12484 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12485 this option.
12487 @item -T @var{script}
12488 @opindex T
12489 @cindex linker script
12490 Use @var{script} as the linker script.  This option is supported by most
12491 systems using the GNU linker.  On some targets, such as bare-board
12492 targets without an operating system, the @option{-T} option may be required
12493 when linking to avoid references to undefined symbols.
12495 @item -Xlinker @var{option}
12496 @opindex Xlinker
12497 Pass @var{option} as an option to the linker.  You can use this to
12498 supply system-specific linker options that GCC does not recognize.
12500 If you want to pass an option that takes a separate argument, you must use
12501 @option{-Xlinker} twice, once for the option and once for the argument.
12502 For example, to pass @option{-assert definitions}, you must write
12503 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12504 @option{-Xlinker "-assert definitions"}, because this passes the entire
12505 string as a single argument, which is not what the linker expects.
12507 When using the GNU linker, it is usually more convenient to pass
12508 arguments to linker options using the @option{@var{option}=@var{value}}
12509 syntax than as separate arguments.  For example, you can specify
12510 @option{-Xlinker -Map=output.map} rather than
12511 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12512 this syntax for command-line options.
12514 @item -Wl,@var{option}
12515 @opindex Wl
12516 Pass @var{option} as an option to the linker.  If @var{option} contains
12517 commas, it is split into multiple options at the commas.  You can use this
12518 syntax to pass an argument to the option.
12519 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12520 linker.  When using the GNU linker, you can also get the same effect with
12521 @option{-Wl,-Map=output.map}.
12523 @item -u @var{symbol}
12524 @opindex u
12525 Pretend the symbol @var{symbol} is undefined, to force linking of
12526 library modules to define it.  You can use @option{-u} multiple times with
12527 different symbols to force loading of additional library modules.
12529 @item -z @var{keyword}
12530 @opindex z
12531 @option{-z} is passed directly on to the linker along with the keyword
12532 @var{keyword}. See the section in the documentation of your linker for
12533 permitted values and their meanings.
12534 @end table
12536 @node Directory Options
12537 @section Options for Directory Search
12538 @cindex directory options
12539 @cindex options, directory search
12540 @cindex search path
12542 These options specify directories to search for header files, for
12543 libraries and for parts of the compiler:
12545 @table @gcctabopt
12546 @include cppdiropts.texi
12548 @item -iplugindir=@var{dir}
12549 @opindex iplugindir=
12550 Set the directory to search for plugins that are passed
12551 by @option{-fplugin=@var{name}} instead of
12552 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12553 to be used by the user, but only passed by the driver.
12555 @item -L@var{dir}
12556 @opindex L
12557 Add directory @var{dir} to the list of directories to be searched
12558 for @option{-l}.
12560 @item -B@var{prefix}
12561 @opindex B
12562 This option specifies where to find the executables, libraries,
12563 include files, and data files of the compiler itself.
12565 The compiler driver program runs one or more of the subprograms
12566 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12567 @var{prefix} as a prefix for each program it tries to run, both with and
12568 without @samp{@var{machine}/@var{version}/} for the corresponding target
12569 machine and compiler version.
12571 For each subprogram to be run, the compiler driver first tries the
12572 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12573 is not specified, the driver tries two standard prefixes, 
12574 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12575 those results in a file name that is found, the unmodified program
12576 name is searched for using the directories specified in your
12577 @env{PATH} environment variable.
12579 The compiler checks to see if the path provided by @option{-B}
12580 refers to a directory, and if necessary it adds a directory
12581 separator character at the end of the path.
12583 @option{-B} prefixes that effectively specify directory names also apply
12584 to libraries in the linker, because the compiler translates these
12585 options into @option{-L} options for the linker.  They also apply to
12586 include files in the preprocessor, because the compiler translates these
12587 options into @option{-isystem} options for the preprocessor.  In this case,
12588 the compiler appends @samp{include} to the prefix.
12590 The runtime support file @file{libgcc.a} can also be searched for using
12591 the @option{-B} prefix, if needed.  If it is not found there, the two
12592 standard prefixes above are tried, and that is all.  The file is left
12593 out of the link if it is not found by those means.
12595 Another way to specify a prefix much like the @option{-B} prefix is to use
12596 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12597 Variables}.
12599 As a special kludge, if the path provided by @option{-B} is
12600 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12601 9, then it is replaced by @file{[dir/]include}.  This is to help
12602 with boot-strapping the compiler.
12604 @item -no-canonical-prefixes
12605 @opindex no-canonical-prefixes
12606 Do not expand any symbolic links, resolve references to @samp{/../}
12607 or @samp{/./}, or make the path absolute when generating a relative
12608 prefix.
12610 @item --sysroot=@var{dir}
12611 @opindex sysroot
12612 Use @var{dir} as the logical root directory for headers and libraries.
12613 For example, if the compiler normally searches for headers in
12614 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12615 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12617 If you use both this option and the @option{-isysroot} option, then
12618 the @option{--sysroot} option applies to libraries, but the
12619 @option{-isysroot} option applies to header files.
12621 The GNU linker (beginning with version 2.16) has the necessary support
12622 for this option.  If your linker does not support this option, the
12623 header file aspect of @option{--sysroot} still works, but the
12624 library aspect does not.
12626 @item --no-sysroot-suffix
12627 @opindex no-sysroot-suffix
12628 For some targets, a suffix is added to the root directory specified
12629 with @option{--sysroot}, depending on the other options used, so that
12630 headers may for example be found in
12631 @file{@var{dir}/@var{suffix}/usr/include} instead of
12632 @file{@var{dir}/usr/include}.  This option disables the addition of
12633 such a suffix.
12635 @end table
12637 @node Code Gen Options
12638 @section Options for Code Generation Conventions
12639 @cindex code generation conventions
12640 @cindex options, code generation
12641 @cindex run-time options
12643 These machine-independent options control the interface conventions
12644 used in code generation.
12646 Most of them have both positive and negative forms; the negative form
12647 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12648 one of the forms is listed---the one that is not the default.  You
12649 can figure out the other form by either removing @samp{no-} or adding
12652 @table @gcctabopt
12653 @item -fstack-reuse=@var{reuse-level}
12654 @opindex fstack_reuse
12655 This option controls stack space reuse for user declared local/auto variables
12656 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12657 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12658 local variables and temporaries, @samp{named_vars} enables the reuse only for
12659 user defined local variables with names, and @samp{none} disables stack reuse
12660 completely. The default value is @samp{all}. The option is needed when the
12661 program extends the lifetime of a scoped local variable or a compiler generated
12662 temporary beyond the end point defined by the language.  When a lifetime of
12663 a variable ends, and if the variable lives in memory, the optimizing compiler
12664 has the freedom to reuse its stack space with other temporaries or scoped
12665 local variables whose live range does not overlap with it. Legacy code extending
12666 local lifetime is likely to break with the stack reuse optimization.
12668 For example,
12670 @smallexample
12671    int *p;
12672    @{
12673      int local1;
12675      p = &local1;
12676      local1 = 10;
12677      ....
12678    @}
12679    @{
12680       int local2;
12681       local2 = 20;
12682       ...
12683    @}
12685    if (*p == 10)  // out of scope use of local1
12686      @{
12688      @}
12689 @end smallexample
12691 Another example:
12692 @smallexample
12694    struct A
12695    @{
12696        A(int k) : i(k), j(k) @{ @}
12697        int i;
12698        int j;
12699    @};
12701    A *ap;
12703    void foo(const A& ar)
12704    @{
12705       ap = &ar;
12706    @}
12708    void bar()
12709    @{
12710       foo(A(10)); // temp object's lifetime ends when foo returns
12712       @{
12713         A a(20);
12714         ....
12715       @}
12716       ap->i+= 10;  // ap references out of scope temp whose space
12717                    // is reused with a. What is the value of ap->i?
12718    @}
12720 @end smallexample
12722 The lifetime of a compiler generated temporary is well defined by the C++
12723 standard. When a lifetime of a temporary ends, and if the temporary lives
12724 in memory, the optimizing compiler has the freedom to reuse its stack
12725 space with other temporaries or scoped local variables whose live range
12726 does not overlap with it. However some of the legacy code relies on
12727 the behavior of older compilers in which temporaries' stack space is
12728 not reused, the aggressive stack reuse can lead to runtime errors. This
12729 option is used to control the temporary stack reuse optimization.
12731 @item -ftrapv
12732 @opindex ftrapv
12733 This option generates traps for signed overflow on addition, subtraction,
12734 multiplication operations.
12735 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12736 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12737 @option{-fwrapv} being effective.  Note that only active options override, so
12738 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12739 results in @option{-ftrapv} being effective.
12741 @item -fwrapv
12742 @opindex fwrapv
12743 This option instructs the compiler to assume that signed arithmetic
12744 overflow of addition, subtraction and multiplication wraps around
12745 using twos-complement representation.  This flag enables some optimizations
12746 and disables others.
12747 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12748 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12749 @option{-fwrapv} being effective.  Note that only active options override, so
12750 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12751 results in @option{-ftrapv} being effective.
12753 @item -fwrapv-pointer
12754 @opindex fwrapv-pointer
12755 This option instructs the compiler to assume that pointer arithmetic
12756 overflow on addition and subtraction wraps around using twos-complement
12757 representation.  This flag disables some optimizations which assume
12758 pointer overflow is invalid.
12760 @item -fstrict-overflow
12761 @opindex fstrict-overflow
12762 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12763 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12765 @item -fexceptions
12766 @opindex fexceptions
12767 Enable exception handling.  Generates extra code needed to propagate
12768 exceptions.  For some targets, this implies GCC generates frame
12769 unwind information for all functions, which can produce significant data
12770 size overhead, although it does not affect execution.  If you do not
12771 specify this option, GCC enables it by default for languages like
12772 C++ that normally require exception handling, and disables it for
12773 languages like C that do not normally require it.  However, you may need
12774 to enable this option when compiling C code that needs to interoperate
12775 properly with exception handlers written in C++.  You may also wish to
12776 disable this option if you are compiling older C++ programs that don't
12777 use exception handling.
12779 @item -fnon-call-exceptions
12780 @opindex fnon-call-exceptions
12781 Generate code that allows trapping instructions to throw exceptions.
12782 Note that this requires platform-specific runtime support that does
12783 not exist everywhere.  Moreover, it only allows @emph{trapping}
12784 instructions to throw exceptions, i.e.@: memory references or floating-point
12785 instructions.  It does not allow exceptions to be thrown from
12786 arbitrary signal handlers such as @code{SIGALRM}.
12788 @item -fdelete-dead-exceptions
12789 @opindex fdelete-dead-exceptions
12790 Consider that instructions that may throw exceptions but don't otherwise
12791 contribute to the execution of the program can be optimized away.
12792 This option is enabled by default for the Ada front end, as permitted by
12793 the Ada language specification.
12794 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12796 @item -funwind-tables
12797 @opindex funwind-tables
12798 Similar to @option{-fexceptions}, except that it just generates any needed
12799 static data, but does not affect the generated code in any other way.
12800 You normally do not need to enable this option; instead, a language processor
12801 that needs this handling enables it on your behalf.
12803 @item -fasynchronous-unwind-tables
12804 @opindex fasynchronous-unwind-tables
12805 Generate unwind table in DWARF format, if supported by target machine.  The
12806 table is exact at each instruction boundary, so it can be used for stack
12807 unwinding from asynchronous events (such as debugger or garbage collector).
12809 @item -fno-gnu-unique
12810 @opindex fno-gnu-unique
12811 On systems with recent GNU assembler and C library, the C++ compiler
12812 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12813 of template static data members and static local variables in inline
12814 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12815 is necessary to avoid problems with a library used by two different
12816 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12817 therefore disagreeing with the other one about the binding of the
12818 symbol.  But this causes @code{dlclose} to be ignored for affected
12819 DSOs; if your program relies on reinitialization of a DSO via
12820 @code{dlclose} and @code{dlopen}, you can use
12821 @option{-fno-gnu-unique}.
12823 @item -fpcc-struct-return
12824 @opindex fpcc-struct-return
12825 Return ``short'' @code{struct} and @code{union} values in memory like
12826 longer ones, rather than in registers.  This convention is less
12827 efficient, but it has the advantage of allowing intercallability between
12828 GCC-compiled files and files compiled with other compilers, particularly
12829 the Portable C Compiler (pcc).
12831 The precise convention for returning structures in memory depends
12832 on the target configuration macros.
12834 Short structures and unions are those whose size and alignment match
12835 that of some integer type.
12837 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12838 switch is not binary compatible with code compiled with the
12839 @option{-freg-struct-return} switch.
12840 Use it to conform to a non-default application binary interface.
12842 @item -freg-struct-return
12843 @opindex freg-struct-return
12844 Return @code{struct} and @code{union} values in registers when possible.
12845 This is more efficient for small structures than
12846 @option{-fpcc-struct-return}.
12848 If you specify neither @option{-fpcc-struct-return} nor
12849 @option{-freg-struct-return}, GCC defaults to whichever convention is
12850 standard for the target.  If there is no standard convention, GCC
12851 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12852 the principal compiler.  In those cases, we can choose the standard, and
12853 we chose the more efficient register return alternative.
12855 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12856 switch is not binary compatible with code compiled with the
12857 @option{-fpcc-struct-return} switch.
12858 Use it to conform to a non-default application binary interface.
12860 @item -fshort-enums
12861 @opindex fshort-enums
12862 Allocate to an @code{enum} type only as many bytes as it needs for the
12863 declared range of possible values.  Specifically, the @code{enum} type
12864 is equivalent to the smallest integer type that has enough room.
12866 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12867 code that is not binary compatible with code generated without that switch.
12868 Use it to conform to a non-default application binary interface.
12870 @item -fshort-wchar
12871 @opindex fshort-wchar
12872 Override the underlying type for @code{wchar_t} to be @code{short
12873 unsigned int} instead of the default for the target.  This option is
12874 useful for building programs to run under WINE@.
12876 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12877 code that is not binary compatible with code generated without that switch.
12878 Use it to conform to a non-default application binary interface.
12880 @item -fno-common
12881 @opindex fno-common
12882 @cindex tentative definitions
12883 In C code, this option controls the placement of global variables 
12884 defined without an initializer, known as @dfn{tentative definitions} 
12885 in the C standard.  Tentative definitions are distinct from declarations 
12886 of a variable with the @code{extern} keyword, which do not allocate storage.
12888 Unix C compilers have traditionally allocated storage for
12889 uninitialized global variables in a common block.  This allows the
12890 linker to resolve all tentative definitions of the same variable
12891 in different compilation units to the same object, or to a non-tentative
12892 definition.  
12893 This is the behavior specified by @option{-fcommon}, and is the default for 
12894 GCC on most targets.  
12895 On the other hand, this behavior is not required by ISO
12896 C, and on some targets may carry a speed or code size penalty on
12897 variable references.
12899 The @option{-fno-common} option specifies that the compiler should instead
12900 place uninitialized global variables in the data section of the object file.
12901 This inhibits the merging of tentative definitions by the linker so
12902 you get a multiple-definition error if the same 
12903 variable is defined in more than one compilation unit.
12904 Compiling with @option{-fno-common} is useful on targets for which
12905 it provides better performance, or if you wish to verify that the
12906 program will work on other systems that always treat uninitialized
12907 variable definitions this way.
12909 @item -fno-ident
12910 @opindex fno-ident
12911 Ignore the @code{#ident} directive.
12913 @item -finhibit-size-directive
12914 @opindex finhibit-size-directive
12915 Don't output a @code{.size} assembler directive, or anything else that
12916 would cause trouble if the function is split in the middle, and the
12917 two halves are placed at locations far apart in memory.  This option is
12918 used when compiling @file{crtstuff.c}; you should not need to use it
12919 for anything else.
12921 @item -fverbose-asm
12922 @opindex fverbose-asm
12923 Put extra commentary information in the generated assembly code to
12924 make it more readable.  This option is generally only of use to those
12925 who actually need to read the generated assembly code (perhaps while
12926 debugging the compiler itself).
12928 @option{-fno-verbose-asm}, the default, causes the
12929 extra information to be omitted and is useful when comparing two assembler
12930 files.
12932 The added comments include:
12934 @itemize @bullet
12936 @item
12937 information on the compiler version and command-line options,
12939 @item
12940 the source code lines associated with the assembly instructions,
12941 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12943 @item
12944 hints on which high-level expressions correspond to
12945 the various assembly instruction operands.
12947 @end itemize
12949 For example, given this C source file:
12951 @smallexample
12952 int test (int n)
12954   int i;
12955   int total = 0;
12957   for (i = 0; i < n; i++)
12958     total += i * i;
12960   return total;
12962 @end smallexample
12964 compiling to (x86_64) assembly via @option{-S} and emitting the result
12965 direct to stdout via @option{-o} @option{-}
12967 @smallexample
12968 gcc -S test.c -fverbose-asm -Os -o -
12969 @end smallexample
12971 gives output similar to this:
12973 @smallexample
12974         .file   "test.c"
12975 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12976   [...snip...]
12977 # options passed:
12978   [...snip...]
12980         .text
12981         .globl  test
12982         .type   test, @@function
12983 test:
12984 .LFB0:
12985         .cfi_startproc
12986 # test.c:4:   int total = 0;
12987         xorl    %eax, %eax      # <retval>
12988 # test.c:6:   for (i = 0; i < n; i++)
12989         xorl    %edx, %edx      # i
12990 .L2:
12991 # test.c:6:   for (i = 0; i < n; i++)
12992         cmpl    %edi, %edx      # n, i
12993         jge     .L5     #,
12994 # test.c:7:     total += i * i;
12995         movl    %edx, %ecx      # i, tmp92
12996         imull   %edx, %ecx      # i, tmp92
12997 # test.c:6:   for (i = 0; i < n; i++)
12998         incl    %edx    # i
12999 # test.c:7:     total += i * i;
13000         addl    %ecx, %eax      # tmp92, <retval>
13001         jmp     .L2     #
13002 .L5:
13003 # test.c:10: @}
13004         ret
13005         .cfi_endproc
13006 .LFE0:
13007         .size   test, .-test
13008         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13009         .section        .note.GNU-stack,"",@@progbits
13010 @end smallexample
13012 The comments are intended for humans rather than machines and hence the
13013 precise format of the comments is subject to change.
13015 @item -frecord-gcc-switches
13016 @opindex frecord-gcc-switches
13017 This switch causes the command line used to invoke the
13018 compiler to be recorded into the object file that is being created.
13019 This switch is only implemented on some targets and the exact format
13020 of the recording is target and binary file format dependent, but it
13021 usually takes the form of a section containing ASCII text.  This
13022 switch is related to the @option{-fverbose-asm} switch, but that
13023 switch only records information in the assembler output file as
13024 comments, so it never reaches the object file.
13025 See also @option{-grecord-gcc-switches} for another
13026 way of storing compiler options into the object file.
13028 @item -fpic
13029 @opindex fpic
13030 @cindex global offset table
13031 @cindex PIC
13032 Generate position-independent code (PIC) suitable for use in a shared
13033 library, if supported for the target machine.  Such code accesses all
13034 constant addresses through a global offset table (GOT)@.  The dynamic
13035 loader resolves the GOT entries when the program starts (the dynamic
13036 loader is not part of GCC; it is part of the operating system).  If
13037 the GOT size for the linked executable exceeds a machine-specific
13038 maximum size, you get an error message from the linker indicating that
13039 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13040 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13041 on the m68k and RS/6000.  The x86 has no such limit.)
13043 Position-independent code requires special support, and therefore works
13044 only on certain machines.  For the x86, GCC supports PIC for System V
13045 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13046 position-independent.
13048 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13049 are defined to 1.
13051 @item -fPIC
13052 @opindex fPIC
13053 If supported for the target machine, emit position-independent code,
13054 suitable for dynamic linking and avoiding any limit on the size of the
13055 global offset table.  This option makes a difference on AArch64, m68k,
13056 PowerPC and SPARC@.
13058 Position-independent code requires special support, and therefore works
13059 only on certain machines.
13061 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13062 are defined to 2.
13064 @item -fpie
13065 @itemx -fPIE
13066 @opindex fpie
13067 @opindex fPIE
13068 These options are similar to @option{-fpic} and @option{-fPIC}, but the
13069 generated position-independent code can be only linked into executables.
13070 Usually these options are used to compile code that will be linked using
13071 the @option{-pie} GCC option.
13073 @option{-fpie} and @option{-fPIE} both define the macros
13074 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13075 for @option{-fpie} and 2 for @option{-fPIE}.
13077 @item -fno-plt
13078 @opindex fno-plt
13079 Do not use the PLT for external function calls in position-independent code.
13080 Instead, load the callee address at call sites from the GOT and branch to it.
13081 This leads to more efficient code by eliminating PLT stubs and exposing
13082 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13083 PLT stubs expect the GOT pointer in a specific register, this gives more
13084 register allocation freedom to the compiler.
13085 Lazy binding requires use of the PLT; 
13086 with @option{-fno-plt} all external symbols are resolved at load time.
13088 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13089 through the PLT for specific external functions.
13091 In position-dependent code, a few targets also convert calls to
13092 functions that are marked to not use the PLT to use the GOT instead.
13094 @item -fno-jump-tables
13095 @opindex fno-jump-tables
13096 Do not use jump tables for switch statements even where it would be
13097 more efficient than other code generation strategies.  This option is
13098 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13099 building code that forms part of a dynamic linker and cannot
13100 reference the address of a jump table.  On some targets, jump tables
13101 do not require a GOT and this option is not needed.
13103 @item -ffixed-@var{reg}
13104 @opindex ffixed
13105 Treat the register named @var{reg} as a fixed register; generated code
13106 should never refer to it (except perhaps as a stack pointer, frame
13107 pointer or in some other fixed role).
13109 @var{reg} must be the name of a register.  The register names accepted
13110 are machine-specific and are defined in the @code{REGISTER_NAMES}
13111 macro in the machine description macro file.
13113 This flag does not have a negative form, because it specifies a
13114 three-way choice.
13116 @item -fcall-used-@var{reg}
13117 @opindex fcall-used
13118 Treat the register named @var{reg} as an allocable register that is
13119 clobbered by function calls.  It may be allocated for temporaries or
13120 variables that do not live across a call.  Functions compiled this way
13121 do not save and restore the register @var{reg}.
13123 It is an error to use this flag with the frame pointer or stack pointer.
13124 Use of this flag for other registers that have fixed pervasive roles in
13125 the machine's execution model produces disastrous results.
13127 This flag does not have a negative form, because it specifies a
13128 three-way choice.
13130 @item -fcall-saved-@var{reg}
13131 @opindex fcall-saved
13132 Treat the register named @var{reg} as an allocable register saved by
13133 functions.  It may be allocated even for temporaries or variables that
13134 live across a call.  Functions compiled this way save and restore
13135 the register @var{reg} if they use it.
13137 It is an error to use this flag with the frame pointer or stack pointer.
13138 Use of this flag for other registers that have fixed pervasive roles in
13139 the machine's execution model produces disastrous results.
13141 A different sort of disaster results from the use of this flag for
13142 a register in which function values may be returned.
13144 This flag does not have a negative form, because it specifies a
13145 three-way choice.
13147 @item -fpack-struct[=@var{n}]
13148 @opindex fpack-struct
13149 Without a value specified, pack all structure members together without
13150 holes.  When a value is specified (which must be a small power of two), pack
13151 structure members according to this value, representing the maximum
13152 alignment (that is, objects with default alignment requirements larger than
13153 this are output potentially unaligned at the next fitting location.
13155 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13156 code that is not binary compatible with code generated without that switch.
13157 Additionally, it makes the code suboptimal.
13158 Use it to conform to a non-default application binary interface.
13160 @item -fleading-underscore
13161 @opindex fleading-underscore
13162 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13163 change the way C symbols are represented in the object file.  One use
13164 is to help link with legacy assembly code.
13166 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13167 generate code that is not binary compatible with code generated without that
13168 switch.  Use it to conform to a non-default application binary interface.
13169 Not all targets provide complete support for this switch.
13171 @item -ftls-model=@var{model}
13172 @opindex ftls-model
13173 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13174 The @var{model} argument should be one of @samp{global-dynamic},
13175 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13176 Note that the choice is subject to optimization: the compiler may use
13177 a more efficient model for symbols not visible outside of the translation
13178 unit, or if @option{-fpic} is not given on the command line.
13180 The default without @option{-fpic} is @samp{initial-exec}; with
13181 @option{-fpic} the default is @samp{global-dynamic}.
13183 @item -ftrampolines
13184 @opindex ftrampolines
13185 For targets that normally need trampolines for nested functions, always
13186 generate them instead of using descriptors.  Otherwise, for targets that
13187 do not need them, like for example HP-PA or IA-64, do nothing.
13189 A trampoline is a small piece of code that is created at run time on the
13190 stack when the address of a nested function is taken, and is used to call
13191 the nested function indirectly.  Therefore, it requires the stack to be
13192 made executable in order for the program to work properly.
13194 @option{-fno-trampolines} is enabled by default on a language by language
13195 basis to let the compiler avoid generating them, if it computes that this
13196 is safe, and replace them with descriptors.  Descriptors are made up of data
13197 only, but the generated code must be prepared to deal with them.  As of this
13198 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13200 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13201 @option{-fno-trampolines} are not binary compatible if nested functions are
13202 present.  This option must therefore be used on a program-wide basis and be
13203 manipulated with extreme care.
13205 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13206 @opindex fvisibility
13207 Set the default ELF image symbol visibility to the specified option---all
13208 symbols are marked with this unless overridden within the code.
13209 Using this feature can very substantially improve linking and
13210 load times of shared object libraries, produce more optimized
13211 code, provide near-perfect API export and prevent symbol clashes.
13212 It is @strong{strongly} recommended that you use this in any shared objects
13213 you distribute.
13215 Despite the nomenclature, @samp{default} always means public; i.e.,
13216 available to be linked against from outside the shared object.
13217 @samp{protected} and @samp{internal} are pretty useless in real-world
13218 usage so the only other commonly used option is @samp{hidden}.
13219 The default if @option{-fvisibility} isn't specified is
13220 @samp{default}, i.e., make every symbol public.
13222 A good explanation of the benefits offered by ensuring ELF
13223 symbols have the correct visibility is given by ``How To Write
13224 Shared Libraries'' by Ulrich Drepper (which can be found at
13225 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13226 solution made possible by this option to marking things hidden when
13227 the default is public is to make the default hidden and mark things
13228 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13229 and @code{__attribute__ ((visibility("default")))} instead of
13230 @code{__declspec(dllexport)} you get almost identical semantics with
13231 identical syntax.  This is a great boon to those working with
13232 cross-platform projects.
13234 For those adding visibility support to existing code, you may find
13235 @code{#pragma GCC visibility} of use.  This works by you enclosing
13236 the declarations you wish to set visibility for with (for example)
13237 @code{#pragma GCC visibility push(hidden)} and
13238 @code{#pragma GCC visibility pop}.
13239 Bear in mind that symbol visibility should be viewed @strong{as
13240 part of the API interface contract} and thus all new code should
13241 always specify visibility when it is not the default; i.e., declarations
13242 only for use within the local DSO should @strong{always} be marked explicitly
13243 as hidden as so to avoid PLT indirection overheads---making this
13244 abundantly clear also aids readability and self-documentation of the code.
13245 Note that due to ISO C++ specification requirements, @code{operator new} and
13246 @code{operator delete} must always be of default visibility.
13248 Be aware that headers from outside your project, in particular system
13249 headers and headers from any other library you use, may not be
13250 expecting to be compiled with visibility other than the default.  You
13251 may need to explicitly say @code{#pragma GCC visibility push(default)}
13252 before including any such headers.
13254 @code{extern} declarations are not affected by @option{-fvisibility}, so
13255 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13256 no modifications.  However, this means that calls to @code{extern}
13257 functions with no explicit visibility use the PLT, so it is more
13258 effective to use @code{__attribute ((visibility))} and/or
13259 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13260 declarations should be treated as hidden.
13262 Note that @option{-fvisibility} does affect C++ vague linkage
13263 entities. This means that, for instance, an exception class that is
13264 be thrown between DSOs must be explicitly marked with default
13265 visibility so that the @samp{type_info} nodes are unified between
13266 the DSOs.
13268 An overview of these techniques, their benefits and how to use them
13269 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13271 @item -fstrict-volatile-bitfields
13272 @opindex fstrict-volatile-bitfields
13273 This option should be used if accesses to volatile bit-fields (or other
13274 structure fields, although the compiler usually honors those types
13275 anyway) should use a single access of the width of the
13276 field's type, aligned to a natural alignment if possible.  For
13277 example, targets with memory-mapped peripheral registers might require
13278 all such accesses to be 16 bits wide; with this flag you can
13279 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13280 is 16 bits on these targets) to force GCC to use 16-bit accesses
13281 instead of, perhaps, a more efficient 32-bit access.
13283 If this option is disabled, the compiler uses the most efficient
13284 instruction.  In the previous example, that might be a 32-bit load
13285 instruction, even though that accesses bytes that do not contain
13286 any portion of the bit-field, or memory-mapped registers unrelated to
13287 the one being updated.
13289 In some cases, such as when the @code{packed} attribute is applied to a 
13290 structure field, it may not be possible to access the field with a single
13291 read or write that is correctly aligned for the target machine.  In this
13292 case GCC falls back to generating multiple accesses rather than code that 
13293 will fault or truncate the result at run time.
13295 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13296 not allowed to touch non bit-field members.  It is therefore recommended
13297 to define all bits of the field's type as bit-field members.
13299 The default value of this option is determined by the application binary
13300 interface for the target processor.
13302 @item -fsync-libcalls
13303 @opindex fsync-libcalls
13304 This option controls whether any out-of-line instance of the @code{__sync}
13305 family of functions may be used to implement the C++11 @code{__atomic}
13306 family of functions.
13308 The default value of this option is enabled, thus the only useful form
13309 of the option is @option{-fno-sync-libcalls}.  This option is used in
13310 the implementation of the @file{libatomic} runtime library.
13312 @end table
13314 @node Developer Options
13315 @section GCC Developer Options
13316 @cindex developer options
13317 @cindex debugging GCC
13318 @cindex debug dump options
13319 @cindex dump options
13320 @cindex compilation statistics
13322 This section describes command-line options that are primarily of
13323 interest to GCC developers, including options to support compiler
13324 testing and investigation of compiler bugs and compile-time
13325 performance problems.  This includes options that produce debug dumps
13326 at various points in the compilation; that print statistics such as
13327 memory use and execution time; and that print information about GCC's
13328 configuration, such as where it searches for libraries.  You should
13329 rarely need to use any of these options for ordinary compilation and
13330 linking tasks.
13332 Many developer options that cause GCC to dump output to a file take an
13333 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
13334 or @samp{-} to dump to standard output, and @samp{stderr} for standard
13335 error.
13337 If @samp{=@var{filename}} is omitted, a default dump file name is
13338 constructed by concatenating the base dump file name, a pass number,
13339 phase letter, and pass name.  The base dump file name is the name of
13340 output file produced by the compiler if explicitly specified and not
13341 an executable; otherwise it is the source file name.
13342 The pass number is determined by the order passes are registered with
13343 the compiler's pass manager. 
13344 This is generally the same as the order of execution, but passes
13345 registered by plugins, target-specific passes, or passes that are
13346 otherwise registered late are numbered higher than the pass named
13347 @samp{final}, even if they are executed earlier.  The phase letter is
13348 one of @samp{i} (inter-procedural analysis), @samp{l}
13349 (language-specific), @samp{r} (RTL), or @samp{t} (tree). 
13350 The files are created in the directory of the output file. 
13352 @table @gcctabopt
13354 @item -d@var{letters}
13355 @itemx -fdump-rtl-@var{pass}
13356 @itemx -fdump-rtl-@var{pass}=@var{filename}
13357 @opindex d
13358 @opindex fdump-rtl-@var{pass}
13359 Says to make debugging dumps during compilation at times specified by
13360 @var{letters}.  This is used for debugging the RTL-based passes of the
13361 compiler.
13363 Some @option{-d@var{letters}} switches have different meaning when
13364 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13365 for information about preprocessor-specific dump options.
13367 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13368 @option{-d} option @var{letters}.  Here are the possible
13369 letters for use in @var{pass} and @var{letters}, and their meanings:
13371 @table @gcctabopt
13373 @item -fdump-rtl-alignments
13374 @opindex fdump-rtl-alignments
13375 Dump after branch alignments have been computed.
13377 @item -fdump-rtl-asmcons
13378 @opindex fdump-rtl-asmcons
13379 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13381 @item -fdump-rtl-auto_inc_dec
13382 @opindex fdump-rtl-auto_inc_dec
13383 Dump after auto-inc-dec discovery.  This pass is only run on
13384 architectures that have auto inc or auto dec instructions.
13386 @item -fdump-rtl-barriers
13387 @opindex fdump-rtl-barriers
13388 Dump after cleaning up the barrier instructions.
13390 @item -fdump-rtl-bbpart
13391 @opindex fdump-rtl-bbpart
13392 Dump after partitioning hot and cold basic blocks.
13394 @item -fdump-rtl-bbro
13395 @opindex fdump-rtl-bbro
13396 Dump after block reordering.
13398 @item -fdump-rtl-btl1
13399 @itemx -fdump-rtl-btl2
13400 @opindex fdump-rtl-btl2
13401 @opindex fdump-rtl-btl2
13402 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13403 after the two branch
13404 target load optimization passes.
13406 @item -fdump-rtl-bypass
13407 @opindex fdump-rtl-bypass
13408 Dump after jump bypassing and control flow optimizations.
13410 @item -fdump-rtl-combine
13411 @opindex fdump-rtl-combine
13412 Dump after the RTL instruction combination pass.
13414 @item -fdump-rtl-compgotos
13415 @opindex fdump-rtl-compgotos
13416 Dump after duplicating the computed gotos.
13418 @item -fdump-rtl-ce1
13419 @itemx -fdump-rtl-ce2
13420 @itemx -fdump-rtl-ce3
13421 @opindex fdump-rtl-ce1
13422 @opindex fdump-rtl-ce2
13423 @opindex fdump-rtl-ce3
13424 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13425 @option{-fdump-rtl-ce3} enable dumping after the three
13426 if conversion passes.
13428 @item -fdump-rtl-cprop_hardreg
13429 @opindex fdump-rtl-cprop_hardreg
13430 Dump after hard register copy propagation.
13432 @item -fdump-rtl-csa
13433 @opindex fdump-rtl-csa
13434 Dump after combining stack adjustments.
13436 @item -fdump-rtl-cse1
13437 @itemx -fdump-rtl-cse2
13438 @opindex fdump-rtl-cse1
13439 @opindex fdump-rtl-cse2
13440 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13441 the two common subexpression elimination passes.
13443 @item -fdump-rtl-dce
13444 @opindex fdump-rtl-dce
13445 Dump after the standalone dead code elimination passes.
13447 @item -fdump-rtl-dbr
13448 @opindex fdump-rtl-dbr
13449 Dump after delayed branch scheduling.
13451 @item -fdump-rtl-dce1
13452 @itemx -fdump-rtl-dce2
13453 @opindex fdump-rtl-dce1
13454 @opindex fdump-rtl-dce2
13455 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13456 the two dead store elimination passes.
13458 @item -fdump-rtl-eh
13459 @opindex fdump-rtl-eh
13460 Dump after finalization of EH handling code.
13462 @item -fdump-rtl-eh_ranges
13463 @opindex fdump-rtl-eh_ranges
13464 Dump after conversion of EH handling range regions.
13466 @item -fdump-rtl-expand
13467 @opindex fdump-rtl-expand
13468 Dump after RTL generation.
13470 @item -fdump-rtl-fwprop1
13471 @itemx -fdump-rtl-fwprop2
13472 @opindex fdump-rtl-fwprop1
13473 @opindex fdump-rtl-fwprop2
13474 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13475 dumping after the two forward propagation passes.
13477 @item -fdump-rtl-gcse1
13478 @itemx -fdump-rtl-gcse2
13479 @opindex fdump-rtl-gcse1
13480 @opindex fdump-rtl-gcse2
13481 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13482 after global common subexpression elimination.
13484 @item -fdump-rtl-init-regs
13485 @opindex fdump-rtl-init-regs
13486 Dump after the initialization of the registers.
13488 @item -fdump-rtl-initvals
13489 @opindex fdump-rtl-initvals
13490 Dump after the computation of the initial value sets.
13492 @item -fdump-rtl-into_cfglayout
13493 @opindex fdump-rtl-into_cfglayout
13494 Dump after converting to cfglayout mode.
13496 @item -fdump-rtl-ira
13497 @opindex fdump-rtl-ira
13498 Dump after iterated register allocation.
13500 @item -fdump-rtl-jump
13501 @opindex fdump-rtl-jump
13502 Dump after the second jump optimization.
13504 @item -fdump-rtl-loop2
13505 @opindex fdump-rtl-loop2
13506 @option{-fdump-rtl-loop2} enables dumping after the rtl
13507 loop optimization passes.
13509 @item -fdump-rtl-mach
13510 @opindex fdump-rtl-mach
13511 Dump after performing the machine dependent reorganization pass, if that
13512 pass exists.
13514 @item -fdump-rtl-mode_sw
13515 @opindex fdump-rtl-mode_sw
13516 Dump after removing redundant mode switches.
13518 @item -fdump-rtl-rnreg
13519 @opindex fdump-rtl-rnreg
13520 Dump after register renumbering.
13522 @item -fdump-rtl-outof_cfglayout
13523 @opindex fdump-rtl-outof_cfglayout
13524 Dump after converting from cfglayout mode.
13526 @item -fdump-rtl-peephole2
13527 @opindex fdump-rtl-peephole2
13528 Dump after the peephole pass.
13530 @item -fdump-rtl-postreload
13531 @opindex fdump-rtl-postreload
13532 Dump after post-reload optimizations.
13534 @item -fdump-rtl-pro_and_epilogue
13535 @opindex fdump-rtl-pro_and_epilogue
13536 Dump after generating the function prologues and epilogues.
13538 @item -fdump-rtl-sched1
13539 @itemx -fdump-rtl-sched2
13540 @opindex fdump-rtl-sched1
13541 @opindex fdump-rtl-sched2
13542 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13543 after the basic block scheduling passes.
13545 @item -fdump-rtl-ree
13546 @opindex fdump-rtl-ree
13547 Dump after sign/zero extension elimination.
13549 @item -fdump-rtl-seqabstr
13550 @opindex fdump-rtl-seqabstr
13551 Dump after common sequence discovery.
13553 @item -fdump-rtl-shorten
13554 @opindex fdump-rtl-shorten
13555 Dump after shortening branches.
13557 @item -fdump-rtl-sibling
13558 @opindex fdump-rtl-sibling
13559 Dump after sibling call optimizations.
13561 @item -fdump-rtl-split1
13562 @itemx -fdump-rtl-split2
13563 @itemx -fdump-rtl-split3
13564 @itemx -fdump-rtl-split4
13565 @itemx -fdump-rtl-split5
13566 @opindex fdump-rtl-split1
13567 @opindex fdump-rtl-split2
13568 @opindex fdump-rtl-split3
13569 @opindex fdump-rtl-split4
13570 @opindex fdump-rtl-split5
13571 These options enable dumping after five rounds of
13572 instruction splitting.
13574 @item -fdump-rtl-sms
13575 @opindex fdump-rtl-sms
13576 Dump after modulo scheduling.  This pass is only run on some
13577 architectures.
13579 @item -fdump-rtl-stack
13580 @opindex fdump-rtl-stack
13581 Dump after conversion from GCC's ``flat register file'' registers to the
13582 x87's stack-like registers.  This pass is only run on x86 variants.
13584 @item -fdump-rtl-subreg1
13585 @itemx -fdump-rtl-subreg2
13586 @opindex fdump-rtl-subreg1
13587 @opindex fdump-rtl-subreg2
13588 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13589 the two subreg expansion passes.
13591 @item -fdump-rtl-unshare
13592 @opindex fdump-rtl-unshare
13593 Dump after all rtl has been unshared.
13595 @item -fdump-rtl-vartrack
13596 @opindex fdump-rtl-vartrack
13597 Dump after variable tracking.
13599 @item -fdump-rtl-vregs
13600 @opindex fdump-rtl-vregs
13601 Dump after converting virtual registers to hard registers.
13603 @item -fdump-rtl-web
13604 @opindex fdump-rtl-web
13605 Dump after live range splitting.
13607 @item -fdump-rtl-regclass
13608 @itemx -fdump-rtl-subregs_of_mode_init
13609 @itemx -fdump-rtl-subregs_of_mode_finish
13610 @itemx -fdump-rtl-dfinit
13611 @itemx -fdump-rtl-dfinish
13612 @opindex fdump-rtl-regclass
13613 @opindex fdump-rtl-subregs_of_mode_init
13614 @opindex fdump-rtl-subregs_of_mode_finish
13615 @opindex fdump-rtl-dfinit
13616 @opindex fdump-rtl-dfinish
13617 These dumps are defined but always produce empty files.
13619 @item -da
13620 @itemx -fdump-rtl-all
13621 @opindex da
13622 @opindex fdump-rtl-all
13623 Produce all the dumps listed above.
13625 @item -dA
13626 @opindex dA
13627 Annotate the assembler output with miscellaneous debugging information.
13629 @item -dD
13630 @opindex dD
13631 Dump all macro definitions, at the end of preprocessing, in addition to
13632 normal output.
13634 @item -dH
13635 @opindex dH
13636 Produce a core dump whenever an error occurs.
13638 @item -dp
13639 @opindex dp
13640 Annotate the assembler output with a comment indicating which
13641 pattern and alternative is used.  The length and cost of each instruction are
13642 also printed.
13644 @item -dP
13645 @opindex dP
13646 Dump the RTL in the assembler output as a comment before each instruction.
13647 Also turns on @option{-dp} annotation.
13649 @item -dx
13650 @opindex dx
13651 Just generate RTL for a function instead of compiling it.  Usually used
13652 with @option{-fdump-rtl-expand}.
13653 @end table
13655 @item -fdump-noaddr
13656 @opindex fdump-noaddr
13657 When doing debugging dumps, suppress address output.  This makes it more
13658 feasible to use diff on debugging dumps for compiler invocations with
13659 different compiler binaries and/or different
13660 text / bss / data / heap / stack / dso start locations.
13662 @item -freport-bug
13663 @opindex freport-bug
13664 Collect and dump debug information into a temporary file if an
13665 internal compiler error (ICE) occurs.
13667 @item -fdump-unnumbered
13668 @opindex fdump-unnumbered
13669 When doing debugging dumps, suppress instruction numbers and address output.
13670 This makes it more feasible to use diff on debugging dumps for compiler
13671 invocations with different options, in particular with and without
13672 @option{-g}.
13674 @item -fdump-unnumbered-links
13675 @opindex fdump-unnumbered-links
13676 When doing debugging dumps (see @option{-d} option above), suppress
13677 instruction numbers for the links to the previous and next instructions
13678 in a sequence.
13680 @item -fdump-ipa-@var{switch}
13681 @opindex fdump-ipa
13682 Control the dumping at various stages of inter-procedural analysis
13683 language tree to a file.  The file name is generated by appending a
13684 switch specific suffix to the source file name, and the file is created
13685 in the same directory as the output file.  The following dumps are
13686 possible:
13688 @table @samp
13689 @item all
13690 Enables all inter-procedural analysis dumps.
13692 @item cgraph
13693 Dumps information about call-graph optimization, unused function removal,
13694 and inlining decisions.
13696 @item inline
13697 Dump after function inlining.
13699 @end table
13701 @item -fdump-lang-all
13702 @itemx -fdump-lang-@var{switch}
13703 @itemx -fdump-lang-@var{switch}-@var{options}
13704 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13705 @opindex fdump-lang-all
13706 @opindex fdump-lang
13707 Control the dumping of language-specific information.  The @var{options}
13708 and @var{filename} portions behave as described in the
13709 @option{-fdump-tree} option.  The following @var{switch} values are
13710 accepted:
13712 @table @samp
13713 @item all
13715 Enable all language-specific dumps.
13717 @item class
13718 Dump class hierarchy information.  Virtual table information is emitted
13719 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13721 @item raw
13722 Dump the raw internal tree data.  This option is applicable to C++ only.
13724 @end table
13726 @item -fdump-passes
13727 @opindex fdump-passes
13728 Print on @file{stderr} the list of optimization passes that are turned
13729 on and off by the current command-line options.
13731 @item -fdump-statistics-@var{option}
13732 @opindex fdump-statistics
13733 Enable and control dumping of pass statistics in a separate file.  The
13734 file name is generated by appending a suffix ending in
13735 @samp{.statistics} to the source file name, and the file is created in
13736 the same directory as the output file.  If the @samp{-@var{option}}
13737 form is used, @samp{-stats} causes counters to be summed over the
13738 whole compilation unit while @samp{-details} dumps every event as
13739 the passes generate them.  The default with no option is to sum
13740 counters for each function compiled.
13742 @item -fdump-tree-all
13743 @itemx -fdump-tree-@var{switch}
13744 @itemx -fdump-tree-@var{switch}-@var{options}
13745 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13746 @opindex fdump-tree-all
13747 @opindex fdump-tree
13748 Control the dumping at various stages of processing the intermediate
13749 language tree to a file.  If the @samp{-@var{options}}
13750 form is used, @var{options} is a list of @samp{-} separated options
13751 which control the details of the dump.  Not all options are applicable
13752 to all dumps; those that are not meaningful are ignored.  The
13753 following options are available
13755 @table @samp
13756 @item address
13757 Print the address of each node.  Usually this is not meaningful as it
13758 changes according to the environment and source file.  Its primary use
13759 is for tying up a dump file with a debug environment.
13760 @item asmname
13761 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13762 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13763 use working backward from mangled names in the assembly file.
13764 @item slim
13765 When dumping front-end intermediate representations, inhibit dumping
13766 of members of a scope or body of a function merely because that scope
13767 has been reached.  Only dump such items when they are directly reachable
13768 by some other path.
13770 When dumping pretty-printed trees, this option inhibits dumping the
13771 bodies of control structures.
13773 When dumping RTL, print the RTL in slim (condensed) form instead of
13774 the default LISP-like representation.
13775 @item raw
13776 Print a raw representation of the tree.  By default, trees are
13777 pretty-printed into a C-like representation.
13778 @item details
13779 Enable more detailed dumps (not honored by every dump option). Also
13780 include information from the optimization passes.
13781 @item stats
13782 Enable dumping various statistics about the pass (not honored by every dump
13783 option).
13784 @item blocks
13785 Enable showing basic block boundaries (disabled in raw dumps).
13786 @item graph
13787 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13788 dump a representation of the control flow graph suitable for viewing with
13789 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13790 the file is pretty-printed as a subgraph, so that GraphViz can render them
13791 all in a single plot.
13793 This option currently only works for RTL dumps, and the RTL is always
13794 dumped in slim form.
13795 @item vops
13796 Enable showing virtual operands for every statement.
13797 @item lineno
13798 Enable showing line numbers for statements.
13799 @item uid
13800 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13801 @item verbose
13802 Enable showing the tree dump for each statement.
13803 @item eh
13804 Enable showing the EH region number holding each statement.
13805 @item scev
13806 Enable showing scalar evolution analysis details.
13807 @item optimized
13808 Enable showing optimization information (only available in certain
13809 passes).
13810 @item missed
13811 Enable showing missed optimization information (only available in certain
13812 passes).
13813 @item note
13814 Enable other detailed optimization information (only available in
13815 certain passes).
13816 @item all
13817 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13818 and @option{lineno}.
13819 @item optall
13820 Turn on all optimization options, i.e., @option{optimized},
13821 @option{missed}, and @option{note}.
13822 @end table
13824 To determine what tree dumps are available or find the dump for a pass
13825 of interest follow the steps below.
13827 @enumerate
13828 @item
13829 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13830 look for a code that corresponds to the pass you are interested in.
13831 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13832 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13833 The number at the end distinguishes distinct invocations of the same pass.
13834 @item
13835 To enable the creation of the dump file, append the pass code to
13836 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13837 to enable the dump from the Early Value Range Propagation pass, invoke
13838 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13839 specify the name of the dump file.  If you don't specify one, GCC
13840 creates as described below.
13841 @item
13842 Find the pass dump in a file whose name is composed of three components
13843 separated by a period: the name of the source file GCC was invoked to
13844 compile, a numeric suffix indicating the pass number followed by the
13845 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13846 and finally the pass code.  For example, the Early VRP pass dump might
13847 be in a file named @file{myfile.c.038t.evrp} in the current working
13848 directory.  Note that the numeric codes are not stable and may change
13849 from one version of GCC to another.
13850 @end enumerate
13852 @item -fopt-info
13853 @itemx -fopt-info-@var{options}
13854 @itemx -fopt-info-@var{options}=@var{filename}
13855 @opindex fopt-info
13856 Controls optimization dumps from various optimization passes. If the
13857 @samp{-@var{options}} form is used, @var{options} is a list of
13858 @samp{-} separated option keywords to select the dump details and
13859 optimizations.  
13861 The @var{options} can be divided into two groups: options describing the
13862 verbosity of the dump, and options describing which optimizations
13863 should be included. The options from both the groups can be freely
13864 mixed as they are non-overlapping. However, in case of any conflicts,
13865 the later options override the earlier options on the command
13866 line. 
13868 The following options control the dump verbosity:
13870 @table @samp
13871 @item optimized
13872 Print information when an optimization is successfully applied. It is
13873 up to a pass to decide which information is relevant. For example, the
13874 vectorizer passes print the source location of loops which are
13875 successfully vectorized.
13876 @item missed
13877 Print information about missed optimizations. Individual passes
13878 control which information to include in the output. 
13879 @item note
13880 Print verbose information about optimizations, such as certain
13881 transformations, more detailed messages about decisions etc.
13882 @item all
13883 Print detailed optimization information. This includes
13884 @samp{optimized}, @samp{missed}, and @samp{note}.
13885 @end table
13887 One or more of the following option keywords can be used to describe a
13888 group of optimizations:
13890 @table @samp
13891 @item ipa
13892 Enable dumps from all interprocedural optimizations.
13893 @item loop
13894 Enable dumps from all loop optimizations.
13895 @item inline
13896 Enable dumps from all inlining optimizations.
13897 @item omp
13898 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13899 @item vec
13900 Enable dumps from all vectorization optimizations.
13901 @item optall
13902 Enable dumps from all optimizations. This is a superset of
13903 the optimization groups listed above.
13904 @end table
13906 If @var{options} is
13907 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13908 info about successful optimizations from all the passes.  
13910 If the @var{filename} is provided, then the dumps from all the
13911 applicable optimizations are concatenated into the @var{filename}.
13912 Otherwise the dump is output onto @file{stderr}. Though multiple
13913 @option{-fopt-info} options are accepted, only one of them can include
13914 a @var{filename}. If other filenames are provided then all but the
13915 first such option are ignored.
13917 Note that the output @var{filename} is overwritten
13918 in case of multiple translation units. If a combined output from
13919 multiple translation units is desired, @file{stderr} should be used
13920 instead.
13922 In the following example, the optimization info is output to
13923 @file{stderr}:
13925 @smallexample
13926 gcc -O3 -fopt-info
13927 @end smallexample
13929 This example:
13930 @smallexample
13931 gcc -O3 -fopt-info-missed=missed.all
13932 @end smallexample
13934 @noindent
13935 outputs missed optimization report from all the passes into
13936 @file{missed.all}, and this one:
13938 @smallexample
13939 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13940 @end smallexample
13942 @noindent
13943 prints information about missed optimization opportunities from
13944 vectorization passes on @file{stderr}.  
13945 Note that @option{-fopt-info-vec-missed} is equivalent to 
13946 @option{-fopt-info-missed-vec}.  The order of the optimization group
13947 names and message types listed after @option{-fopt-info} does not matter.
13949 As another example,
13950 @smallexample
13951 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13952 @end smallexample
13954 @noindent
13955 outputs information about missed optimizations as well as
13956 optimized locations from all the inlining passes into
13957 @file{inline.txt}.
13959 Finally, consider:
13961 @smallexample
13962 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13963 @end smallexample
13965 @noindent
13966 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13967 in conflict since only one output file is allowed. In this case, only
13968 the first option takes effect and the subsequent options are
13969 ignored. Thus only @file{vec.miss} is produced which contains
13970 dumps from the vectorizer about missed opportunities.
13972 @item -fsched-verbose=@var{n}
13973 @opindex fsched-verbose
13974 On targets that use instruction scheduling, this option controls the
13975 amount of debugging output the scheduler prints to the dump files.
13977 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13978 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13979 For @var{n} greater than one, it also output basic block probabilities,
13980 detailed ready list information and unit/insn info.  For @var{n} greater
13981 than two, it includes RTL at abort point, control-flow and regions info.
13982 And for @var{n} over four, @option{-fsched-verbose} also includes
13983 dependence info.
13987 @item -fenable-@var{kind}-@var{pass}
13988 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13989 @opindex fdisable-
13990 @opindex fenable-
13992 This is a set of options that are used to explicitly disable/enable
13993 optimization passes.  These options are intended for use for debugging GCC.
13994 Compiler users should use regular options for enabling/disabling
13995 passes instead.
13997 @table @gcctabopt
13999 @item -fdisable-ipa-@var{pass}
14000 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14001 statically invoked in the compiler multiple times, the pass name should be
14002 appended with a sequential number starting from 1.
14004 @item -fdisable-rtl-@var{pass}
14005 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14006 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14007 statically invoked in the compiler multiple times, the pass name should be
14008 appended with a sequential number starting from 1.  @var{range-list} is a 
14009 comma-separated list of function ranges or assembler names.  Each range is a number
14010 pair separated by a colon.  The range is inclusive in both ends.  If the range
14011 is trivial, the number pair can be simplified as a single number.  If the
14012 function's call graph node's @var{uid} falls within one of the specified ranges,
14013 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14014 function header of a dump file, and the pass names can be dumped by using
14015 option @option{-fdump-passes}.
14017 @item -fdisable-tree-@var{pass}
14018 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14019 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14020 option arguments.
14022 @item -fenable-ipa-@var{pass}
14023 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14024 statically invoked in the compiler multiple times, the pass name should be
14025 appended with a sequential number starting from 1.
14027 @item -fenable-rtl-@var{pass}
14028 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14029 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14030 description and examples.
14032 @item -fenable-tree-@var{pass}
14033 @itemx -fenable-tree-@var{pass}=@var{range-list}
14034 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14035 of option arguments.
14037 @end table
14039 Here are some examples showing uses of these options.
14041 @smallexample
14043 # disable ccp1 for all functions
14044    -fdisable-tree-ccp1
14045 # disable complete unroll for function whose cgraph node uid is 1
14046    -fenable-tree-cunroll=1
14047 # disable gcse2 for functions at the following ranges [1,1],
14048 # [300,400], and [400,1000]
14049 # disable gcse2 for functions foo and foo2
14050    -fdisable-rtl-gcse2=foo,foo2
14051 # disable early inlining
14052    -fdisable-tree-einline
14053 # disable ipa inlining
14054    -fdisable-ipa-inline
14055 # enable tree full unroll
14056    -fenable-tree-unroll
14058 @end smallexample
14060 @item -fchecking
14061 @itemx -fchecking=@var{n}
14062 @opindex fchecking
14063 @opindex fno-checking
14064 Enable internal consistency checking.  The default depends on
14065 the compiler configuration.  @option{-fchecking=2} enables further
14066 internal consistency checking that might affect code generation.
14068 @item -frandom-seed=@var{string}
14069 @opindex frandom-seed
14070 This option provides a seed that GCC uses in place of
14071 random numbers in generating certain symbol names
14072 that have to be different in every compiled file.  It is also used to
14073 place unique stamps in coverage data files and the object files that
14074 produce them.  You can use the @option{-frandom-seed} option to produce
14075 reproducibly identical object files.
14077 The @var{string} can either be a number (decimal, octal or hex) or an
14078 arbitrary string (in which case it's converted to a number by
14079 computing CRC32).
14081 The @var{string} should be different for every file you compile.
14083 @item -save-temps
14084 @itemx -save-temps=cwd
14085 @opindex save-temps
14086 Store the usual ``temporary'' intermediate files permanently; place them
14087 in the current directory and name them based on the source file.  Thus,
14088 compiling @file{foo.c} with @option{-c -save-temps} produces files
14089 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14090 preprocessed @file{foo.i} output file even though the compiler now
14091 normally uses an integrated preprocessor.
14093 When used in combination with the @option{-x} command-line option,
14094 @option{-save-temps} is sensible enough to avoid over writing an
14095 input source file with the same extension as an intermediate file.
14096 The corresponding intermediate file may be obtained by renaming the
14097 source file before using @option{-save-temps}.
14099 If you invoke GCC in parallel, compiling several different source
14100 files that share a common base name in different subdirectories or the
14101 same source file compiled for multiple output destinations, it is
14102 likely that the different parallel compilers will interfere with each
14103 other, and overwrite the temporary files.  For instance:
14105 @smallexample
14106 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14107 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14108 @end smallexample
14110 may result in @file{foo.i} and @file{foo.o} being written to
14111 simultaneously by both compilers.
14113 @item -save-temps=obj
14114 @opindex save-temps=obj
14115 Store the usual ``temporary'' intermediate files permanently.  If the
14116 @option{-o} option is used, the temporary files are based on the
14117 object file.  If the @option{-o} option is not used, the
14118 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14120 For example:
14122 @smallexample
14123 gcc -save-temps=obj -c foo.c
14124 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14125 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14126 @end smallexample
14128 @noindent
14129 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14130 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14131 @file{dir2/yfoobar.o}.
14133 @item -time@r{[}=@var{file}@r{]}
14134 @opindex time
14135 Report the CPU time taken by each subprocess in the compilation
14136 sequence.  For C source files, this is the compiler proper and assembler
14137 (plus the linker if linking is done).
14139 Without the specification of an output file, the output looks like this:
14141 @smallexample
14142 # cc1 0.12 0.01
14143 # as 0.00 0.01
14144 @end smallexample
14146 The first number on each line is the ``user time'', that is time spent
14147 executing the program itself.  The second number is ``system time'',
14148 time spent executing operating system routines on behalf of the program.
14149 Both numbers are in seconds.
14151 With the specification of an output file, the output is appended to the
14152 named file, and it looks like this:
14154 @smallexample
14155 0.12 0.01 cc1 @var{options}
14156 0.00 0.01 as @var{options}
14157 @end smallexample
14159 The ``user time'' and the ``system time'' are moved before the program
14160 name, and the options passed to the program are displayed, so that one
14161 can later tell what file was being compiled, and with which options.
14163 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14164 @opindex fdump-final-insns
14165 Dump the final internal representation (RTL) to @var{file}.  If the
14166 optional argument is omitted (or if @var{file} is @code{.}), the name
14167 of the dump file is determined by appending @code{.gkd} to the
14168 compilation output file name.
14170 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14171 @opindex fcompare-debug
14172 @opindex fno-compare-debug
14173 If no error occurs during compilation, run the compiler a second time,
14174 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14175 passed to the second compilation.  Dump the final internal
14176 representation in both compilations, and print an error if they differ.
14178 If the equal sign is omitted, the default @option{-gtoggle} is used.
14180 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14181 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14182 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14183 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14184 is used.
14186 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14187 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14188 of the final representation and the second compilation, preventing even
14189 @env{GCC_COMPARE_DEBUG} from taking effect.
14191 To verify full coverage during @option{-fcompare-debug} testing, set
14192 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14193 which GCC rejects as an invalid option in any actual compilation
14194 (rather than preprocessing, assembly or linking).  To get just a
14195 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14196 not overridden} will do.
14198 @item -fcompare-debug-second
14199 @opindex fcompare-debug-second
14200 This option is implicitly passed to the compiler for the second
14201 compilation requested by @option{-fcompare-debug}, along with options to
14202 silence warnings, and omitting other options that would cause the compiler
14203 to produce output to files or to standard output as a side effect.  Dump
14204 files and preserved temporary files are renamed so as to contain the
14205 @code{.gk} additional extension during the second compilation, to avoid
14206 overwriting those generated by the first.
14208 When this option is passed to the compiler driver, it causes the
14209 @emph{first} compilation to be skipped, which makes it useful for little
14210 other than debugging the compiler proper.
14212 @item -gtoggle
14213 @opindex gtoggle
14214 Turn off generation of debug info, if leaving out this option
14215 generates it, or turn it on at level 2 otherwise.  The position of this
14216 argument in the command line does not matter; it takes effect after all
14217 other options are processed, and it does so only once, no matter how
14218 many times it is given.  This is mainly intended to be used with
14219 @option{-fcompare-debug}.
14221 @item -fvar-tracking-assignments-toggle
14222 @opindex fvar-tracking-assignments-toggle
14223 @opindex fno-var-tracking-assignments-toggle
14224 Toggle @option{-fvar-tracking-assignments}, in the same way that
14225 @option{-gtoggle} toggles @option{-g}.
14227 @item -Q
14228 @opindex Q
14229 Makes the compiler print out each function name as it is compiled, and
14230 print some statistics about each pass when it finishes.
14232 @item -ftime-report
14233 @opindex ftime-report
14234 Makes the compiler print some statistics about the time consumed by each
14235 pass when it finishes.
14237 @item -ftime-report-details
14238 @opindex ftime-report-details
14239 Record the time consumed by infrastructure parts separately for each pass.
14241 @item -fira-verbose=@var{n}
14242 @opindex fira-verbose
14243 Control the verbosity of the dump file for the integrated register allocator.
14244 The default value is 5.  If the value @var{n} is greater or equal to 10,
14245 the dump output is sent to stderr using the same format as @var{n} minus 10.
14247 @item -flto-report
14248 @opindex flto-report
14249 Prints a report with internal details on the workings of the link-time
14250 optimizer.  The contents of this report vary from version to version.
14251 It is meant to be useful to GCC developers when processing object
14252 files in LTO mode (via @option{-flto}).
14254 Disabled by default.
14256 @item -flto-report-wpa
14257 @opindex flto-report-wpa
14258 Like @option{-flto-report}, but only print for the WPA phase of Link
14259 Time Optimization.
14261 @item -fmem-report
14262 @opindex fmem-report
14263 Makes the compiler print some statistics about permanent memory
14264 allocation when it finishes.
14266 @item -fmem-report-wpa
14267 @opindex fmem-report-wpa
14268 Makes the compiler print some statistics about permanent memory
14269 allocation for the WPA phase only.
14271 @item -fpre-ipa-mem-report
14272 @opindex fpre-ipa-mem-report
14273 @item -fpost-ipa-mem-report
14274 @opindex fpost-ipa-mem-report
14275 Makes the compiler print some statistics about permanent memory
14276 allocation before or after interprocedural optimization.
14278 @item -fprofile-report
14279 @opindex fprofile-report
14280 Makes the compiler print some statistics about consistency of the
14281 (estimated) profile and effect of individual passes.
14283 @item -fstack-usage
14284 @opindex fstack-usage
14285 Makes the compiler output stack usage information for the program, on a
14286 per-function basis.  The filename for the dump is made by appending
14287 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14288 the output file, if explicitly specified and it is not an executable,
14289 otherwise it is the basename of the source file.  An entry is made up
14290 of three fields:
14292 @itemize
14293 @item
14294 The name of the function.
14295 @item
14296 A number of bytes.
14297 @item
14298 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14299 @end itemize
14301 The qualifier @code{static} means that the function manipulates the stack
14302 statically: a fixed number of bytes are allocated for the frame on function
14303 entry and released on function exit; no stack adjustments are otherwise made
14304 in the function.  The second field is this fixed number of bytes.
14306 The qualifier @code{dynamic} means that the function manipulates the stack
14307 dynamically: in addition to the static allocation described above, stack
14308 adjustments are made in the body of the function, for example to push/pop
14309 arguments around function calls.  If the qualifier @code{bounded} is also
14310 present, the amount of these adjustments is bounded at compile time and
14311 the second field is an upper bound of the total amount of stack used by
14312 the function.  If it is not present, the amount of these adjustments is
14313 not bounded at compile time and the second field only represents the
14314 bounded part.
14316 @item -fstats
14317 @opindex fstats
14318 Emit statistics about front-end processing at the end of the compilation.
14319 This option is supported only by the C++ front end, and
14320 the information is generally only useful to the G++ development team.
14322 @item -fdbg-cnt-list
14323 @opindex fdbg-cnt-list
14324 Print the name and the counter upper bound for all debug counters.
14327 @item -fdbg-cnt=@var{counter-value-list}
14328 @opindex fdbg-cnt
14329 Set the internal debug counter upper bound.  @var{counter-value-list}
14330 is a comma-separated list of @var{name}:@var{value} pairs
14331 which sets the upper bound of each debug counter @var{name} to @var{value}.
14332 All debug counters have the initial upper bound of @code{UINT_MAX};
14333 thus @code{dbg_cnt} returns true always unless the upper bound
14334 is set by this option.
14335 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14336 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14338 @item -print-file-name=@var{library}
14339 @opindex print-file-name
14340 Print the full absolute name of the library file @var{library} that
14341 would be used when linking---and don't do anything else.  With this
14342 option, GCC does not compile or link anything; it just prints the
14343 file name.
14345 @item -print-multi-directory
14346 @opindex print-multi-directory
14347 Print the directory name corresponding to the multilib selected by any
14348 other switches present in the command line.  This directory is supposed
14349 to exist in @env{GCC_EXEC_PREFIX}.
14351 @item -print-multi-lib
14352 @opindex print-multi-lib
14353 Print the mapping from multilib directory names to compiler switches
14354 that enable them.  The directory name is separated from the switches by
14355 @samp{;}, and each switch starts with an @samp{@@} instead of the
14356 @samp{-}, without spaces between multiple switches.  This is supposed to
14357 ease shell processing.
14359 @item -print-multi-os-directory
14360 @opindex print-multi-os-directory
14361 Print the path to OS libraries for the selected
14362 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14363 present in the @file{lib} subdirectory and no multilibs are used, this is
14364 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14365 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14366 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14367 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14369 @item -print-multiarch
14370 @opindex print-multiarch
14371 Print the path to OS libraries for the selected multiarch,
14372 relative to some @file{lib} subdirectory.
14374 @item -print-prog-name=@var{program}
14375 @opindex print-prog-name
14376 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14378 @item -print-libgcc-file-name
14379 @opindex print-libgcc-file-name
14380 Same as @option{-print-file-name=libgcc.a}.
14382 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14383 but you do want to link with @file{libgcc.a}.  You can do:
14385 @smallexample
14386 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14387 @end smallexample
14389 @item -print-search-dirs
14390 @opindex print-search-dirs
14391 Print the name of the configured installation directory and a list of
14392 program and library directories @command{gcc} searches---and don't do anything else.
14394 This is useful when @command{gcc} prints the error message
14395 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14396 To resolve this you either need to put @file{cpp0} and the other compiler
14397 components where @command{gcc} expects to find them, or you can set the environment
14398 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14399 Don't forget the trailing @samp{/}.
14400 @xref{Environment Variables}.
14402 @item -print-sysroot
14403 @opindex print-sysroot
14404 Print the target sysroot directory that is used during
14405 compilation.  This is the target sysroot specified either at configure
14406 time or using the @option{--sysroot} option, possibly with an extra
14407 suffix that depends on compilation options.  If no target sysroot is
14408 specified, the option prints nothing.
14410 @item -print-sysroot-headers-suffix
14411 @opindex print-sysroot-headers-suffix
14412 Print the suffix added to the target sysroot when searching for
14413 headers, or give an error if the compiler is not configured with such
14414 a suffix---and don't do anything else.
14416 @item -dumpmachine
14417 @opindex dumpmachine
14418 Print the compiler's target machine (for example,
14419 @samp{i686-pc-linux-gnu})---and don't do anything else.
14421 @item -dumpversion
14422 @opindex dumpversion
14423 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14424 anything else.  This is the compiler version used in filesystem paths,
14425 specs, can be depending on how the compiler has been configured just
14426 a single number (major version), two numbers separated by dot (major and
14427 minor version) or three numbers separated by dots (major, minor and patchlevel
14428 version).
14430 @item -dumpfullversion
14431 @opindex dumpfullversion
14432 Print the full compiler version, always 3 numbers separated by dots,
14433 major, minor and patchlevel version.
14435 @item -dumpspecs
14436 @opindex dumpspecs
14437 Print the compiler's built-in specs---and don't do anything else.  (This
14438 is used when GCC itself is being built.)  @xref{Spec Files}.
14439 @end table
14441 @node Submodel Options
14442 @section Machine-Dependent Options
14443 @cindex submodel options
14444 @cindex specifying hardware config
14445 @cindex hardware models and configurations, specifying
14446 @cindex target-dependent options
14447 @cindex machine-dependent options
14449 Each target machine supported by GCC can have its own options---for
14450 example, to allow you to compile for a particular processor variant or
14451 ABI, or to control optimizations specific to that machine.  By
14452 convention, the names of machine-specific options start with
14453 @samp{-m}.
14455 Some configurations of the compiler also support additional target-specific
14456 options, usually for compatibility with other compilers on the same
14457 platform.
14459 @c This list is ordered alphanumerically by subsection name.
14460 @c It should be the same order and spelling as these options are listed
14461 @c in Machine Dependent Options
14463 @menu
14464 * AArch64 Options::
14465 * Adapteva Epiphany Options::
14466 * ARC Options::
14467 * ARM Options::
14468 * AVR Options::
14469 * Blackfin Options::
14470 * C6X Options::
14471 * CRIS Options::
14472 * CR16 Options::
14473 * Darwin Options::
14474 * DEC Alpha Options::
14475 * FR30 Options::
14476 * FT32 Options::
14477 * FRV Options::
14478 * GNU/Linux Options::
14479 * H8/300 Options::
14480 * HPPA Options::
14481 * IA-64 Options::
14482 * LM32 Options::
14483 * M32C Options::
14484 * M32R/D Options::
14485 * M680x0 Options::
14486 * MCore Options::
14487 * MeP Options::
14488 * MicroBlaze Options::
14489 * MIPS Options::
14490 * MMIX Options::
14491 * MN10300 Options::
14492 * Moxie Options::
14493 * MSP430 Options::
14494 * NDS32 Options::
14495 * Nios II Options::
14496 * Nvidia PTX Options::
14497 * PDP-11 Options::
14498 * picoChip Options::
14499 * PowerPC Options::
14500 * PowerPC SPE Options::
14501 * RISC-V Options::
14502 * RL78 Options::
14503 * RS/6000 and PowerPC Options::
14504 * RX Options::
14505 * S/390 and zSeries Options::
14506 * Score Options::
14507 * SH Options::
14508 * Solaris 2 Options::
14509 * SPARC Options::
14510 * SPU Options::
14511 * System V Options::
14512 * TILE-Gx Options::
14513 * TILEPro Options::
14514 * V850 Options::
14515 * VAX Options::
14516 * Visium Options::
14517 * VMS Options::
14518 * VxWorks Options::
14519 * x86 Options::
14520 * x86 Windows Options::
14521 * Xstormy16 Options::
14522 * Xtensa Options::
14523 * zSeries Options::
14524 @end menu
14526 @node AArch64 Options
14527 @subsection AArch64 Options
14528 @cindex AArch64 Options
14530 These options are defined for AArch64 implementations:
14532 @table @gcctabopt
14534 @item -mabi=@var{name}
14535 @opindex mabi
14536 Generate code for the specified data model.  Permissible values
14537 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14538 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14539 but long int and pointers are 64 bits.
14541 The default depends on the specific target configuration.  Note that
14542 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14543 entire program with the same ABI, and link with a compatible set of libraries.
14545 @item -mbig-endian
14546 @opindex mbig-endian
14547 Generate big-endian code.  This is the default when GCC is configured for an
14548 @samp{aarch64_be-*-*} target.
14550 @item -mgeneral-regs-only
14551 @opindex mgeneral-regs-only
14552 Generate code which uses only the general-purpose registers.  This will prevent
14553 the compiler from using floating-point and Advanced SIMD registers but will not
14554 impose any restrictions on the assembler.
14556 @item -mlittle-endian
14557 @opindex mlittle-endian
14558 Generate little-endian code.  This is the default when GCC is configured for an
14559 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14561 @item -mcmodel=tiny
14562 @opindex mcmodel=tiny
14563 Generate code for the tiny code model.  The program and its statically defined
14564 symbols must be within 1MB of each other.  Programs can be statically or
14565 dynamically linked.
14567 @item -mcmodel=small
14568 @opindex mcmodel=small
14569 Generate code for the small code model.  The program and its statically defined
14570 symbols must be within 4GB of each other.  Programs can be statically or
14571 dynamically linked.  This is the default code model.
14573 @item -mcmodel=large
14574 @opindex mcmodel=large
14575 Generate code for the large code model.  This makes no assumptions about
14576 addresses and sizes of sections.  Programs can be statically linked only.
14578 @item -mstrict-align
14579 @opindex mstrict-align
14580 Avoid generating memory accesses that may not be aligned on a natural object
14581 boundary as described in the architecture specification.
14583 @item -momit-leaf-frame-pointer
14584 @itemx -mno-omit-leaf-frame-pointer
14585 @opindex momit-leaf-frame-pointer
14586 @opindex mno-omit-leaf-frame-pointer
14587 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14588 default.
14590 @item -mtls-dialect=desc
14591 @opindex mtls-dialect=desc
14592 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14593 of TLS variables.  This is the default.
14595 @item -mtls-dialect=traditional
14596 @opindex mtls-dialect=traditional
14597 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14598 of TLS variables.
14600 @item -mtls-size=@var{size}
14601 @opindex mtls-size
14602 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14603 This option requires binutils 2.26 or newer.
14605 @item -mfix-cortex-a53-835769
14606 @itemx -mno-fix-cortex-a53-835769
14607 @opindex mfix-cortex-a53-835769
14608 @opindex mno-fix-cortex-a53-835769
14609 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14610 This involves inserting a NOP instruction between memory instructions and
14611 64-bit integer multiply-accumulate instructions.
14613 @item -mfix-cortex-a53-843419
14614 @itemx -mno-fix-cortex-a53-843419
14615 @opindex mfix-cortex-a53-843419
14616 @opindex mno-fix-cortex-a53-843419
14617 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14618 This erratum workaround is made at link time and this will only pass the
14619 corresponding flag to the linker.
14621 @item -mlow-precision-recip-sqrt
14622 @itemx -mno-low-precision-recip-sqrt
14623 @opindex mlow-precision-recip-sqrt
14624 @opindex mno-low-precision-recip-sqrt
14625 Enable or disable the reciprocal square root approximation.
14626 This option only has an effect if @option{-ffast-math} or
14627 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14628 precision of reciprocal square root results to about 16 bits for
14629 single precision and to 32 bits for double precision.
14631 @item -mlow-precision-sqrt
14632 @itemx -mno-low-precision-sqrt
14633 @opindex -mlow-precision-sqrt
14634 @opindex -mno-low-precision-sqrt
14635 Enable or disable the square root approximation.
14636 This option only has an effect if @option{-ffast-math} or
14637 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14638 precision of square root results to about 16 bits for
14639 single precision and to 32 bits for double precision.
14640 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14642 @item -mlow-precision-div
14643 @itemx -mno-low-precision-div
14644 @opindex -mlow-precision-div
14645 @opindex -mno-low-precision-div
14646 Enable or disable the division approximation.
14647 This option only has an effect if @option{-ffast-math} or
14648 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14649 precision of division results to about 16 bits for
14650 single precision and to 32 bits for double precision.
14652 @item -march=@var{name}
14653 @opindex march
14654 Specify the name of the target architecture and, optionally, one or
14655 more feature modifiers.  This option has the form
14656 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14658 The permissible values for @var{arch} are @samp{armv8-a},
14659 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14660 or @var{native}.
14662 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14663 support for the ARMv8.4-A architecture extensions.
14665 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14666 support for the ARMv8.3-A architecture extensions.
14668 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14669 support for the ARMv8.2-A architecture extensions.
14671 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14672 support for the ARMv8.1-A architecture extension.  In particular, it
14673 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14675 The value @samp{native} is available on native AArch64 GNU/Linux and
14676 causes the compiler to pick the architecture of the host system.  This
14677 option has no effect if the compiler is unable to recognize the
14678 architecture of the host system,
14680 The permissible values for @var{feature} are listed in the sub-section
14681 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14682 Feature Modifiers}.  Where conflicting feature modifiers are
14683 specified, the right-most feature is used.
14685 GCC uses @var{name} to determine what kind of instructions it can emit
14686 when generating assembly code.  If @option{-march} is specified
14687 without either of @option{-mtune} or @option{-mcpu} also being
14688 specified, the code is tuned to perform well across a range of target
14689 processors implementing the target architecture.
14691 @item -mtune=@var{name}
14692 @opindex mtune
14693 Specify the name of the target processor for which GCC should tune the
14694 performance of the code.  Permissible values for this option are:
14695 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14696 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14697 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14698 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14699 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14700 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14701 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14702 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14703 @samp{native}.
14705 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14706 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14707 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14708 big.LITTLE system.
14710 Additionally on native AArch64 GNU/Linux systems the value
14711 @samp{native} tunes performance to the host system.  This option has no effect
14712 if the compiler is unable to recognize the processor of the host system.
14714 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14715 are specified, the code is tuned to perform well across a range
14716 of target processors.
14718 This option cannot be suffixed by feature modifiers.
14720 @item -mcpu=@var{name}
14721 @opindex mcpu
14722 Specify the name of the target processor, optionally suffixed by one
14723 or more feature modifiers.  This option has the form
14724 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14725 the permissible values for @var{cpu} are the same as those available
14726 for @option{-mtune}.  The permissible values for @var{feature} are
14727 documented in the sub-section on
14728 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14729 Feature Modifiers}.  Where conflicting feature modifiers are
14730 specified, the right-most feature is used.
14732 GCC uses @var{name} to determine what kind of instructions it can emit when
14733 generating assembly code (as if by @option{-march}) and to determine
14734 the target processor for which to tune for performance (as if
14735 by @option{-mtune}).  Where this option is used in conjunction
14736 with @option{-march} or @option{-mtune}, those options take precedence
14737 over the appropriate part of this option.
14739 @item -moverride=@var{string}
14740 @opindex moverride
14741 Override tuning decisions made by the back-end in response to a
14742 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14743 for @var{string} in this option are not guaranteed to be consistent
14744 across releases.
14746 This option is only intended to be useful when developing GCC.
14748 @item -mverbose-cost-dump
14749 @opindex mverbose-cost-dump
14750 Enable verbose cost model dumping in the debug dump files.  This option is
14751 provided for use in debugging the compiler.
14753 @item -mpc-relative-literal-loads
14754 @itemx -mno-pc-relative-literal-loads
14755 @opindex mpc-relative-literal-loads
14756 @opindex mno-pc-relative-literal-loads
14757 Enable or disable PC-relative literal loads.  With this option literal pools are
14758 accessed using a single instruction and emitted after each function.  This
14759 limits the maximum size of functions to 1MB.  This is enabled by default for
14760 @option{-mcmodel=tiny}.
14762 @item -msign-return-address=@var{scope}
14763 @opindex msign-return-address
14764 Select the function scope on which return address signing will be applied.
14765 Permissible values are @samp{none}, which disables return address signing,
14766 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14767 functions, and @samp{all}, which enables pointer signing for all functions.  The
14768 default value is @samp{none}.
14770 @item -msve-vector-bits=@var{bits}
14771 @opindex msve-vector-bits
14772 Specify the number of bits in an SVE vector register.  This option only has
14773 an effect when SVE is enabled.
14775 GCC supports two forms of SVE code generation: ``vector-length
14776 agnostic'' output that works with any size of vector register and
14777 ``vector-length specific'' output that only works when the vector
14778 registers are a particular size.  Replacing @var{bits} with
14779 @samp{scalable} selects vector-length agnostic output while
14780 replacing it with a number selects vector-length specific output.
14781 The possible lengths in the latter case are: 128, 256, 512, 1024
14782 and 2048.  @samp{scalable} is the default.
14784 At present, @samp{-msve-vector-bits=128} produces the same output
14785 as @samp{-msve-vector-bits=scalable}.
14787 @end table
14789 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14790 @anchor{aarch64-feature-modifiers}
14791 @cindex @option{-march} feature modifiers
14792 @cindex @option{-mcpu} feature modifiers
14793 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14794 the following and their inverses @option{no@var{feature}}:
14796 @table @samp
14797 @item crc
14798 Enable CRC extension.  This is on by default for
14799 @option{-march=armv8.1-a}.
14800 @item crypto
14801 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14802 instructions.
14803 @item fp
14804 Enable floating-point instructions.  This is on by default for all possible
14805 values for options @option{-march} and @option{-mcpu}.
14806 @item simd
14807 Enable Advanced SIMD instructions.  This also enables floating-point
14808 instructions.  This is on by default for all possible values for options
14809 @option{-march} and @option{-mcpu}.
14810 @item sve
14811 Enable Scalable Vector Extension instructions.  This also enables Advanced
14812 SIMD and floating-point instructions.
14813 @item lse
14814 Enable Large System Extension instructions.  This is on by default for
14815 @option{-march=armv8.1-a}.
14816 @item rdma
14817 Enable Round Double Multiply Accumulate instructions.  This is on by default
14818 for @option{-march=armv8.1-a}.
14819 @item fp16
14820 Enable FP16 extension.  This also enables floating-point instructions.
14821 @item fp16fml
14822 Enable FP16 fmla extension.  This also enables FP16 extensions and
14823 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.
14825 @item rcpc
14826 Enable the RcPc extension.  This does not change code generation from GCC,
14827 but is passed on to the assembler, enabling inline asm statements to use
14828 instructions from the RcPc extension.
14829 @item dotprod
14830 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14831 @item aes
14832 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14833 SIMD instructions.
14834 @item sha2
14835 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14836 @item sha3
14837 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14838 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14839 @item sm4
14840 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14841 Use of this option with architectures prior to Armv8.2-A is not supported.
14843 @end table
14845 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14846 which implies @option{fp}.
14847 Conversely, @option{nofp} implies @option{nosimd}, which implies
14848 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14850 @node Adapteva Epiphany Options
14851 @subsection Adapteva Epiphany Options
14853 These @samp{-m} options are defined for Adapteva Epiphany:
14855 @table @gcctabopt
14856 @item -mhalf-reg-file
14857 @opindex mhalf-reg-file
14858 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14859 That allows code to run on hardware variants that lack these registers.
14861 @item -mprefer-short-insn-regs
14862 @opindex mprefer-short-insn-regs
14863 Preferentially allocate registers that allow short instruction generation.
14864 This can result in increased instruction count, so this may either reduce or
14865 increase overall code size.
14867 @item -mbranch-cost=@var{num}
14868 @opindex mbranch-cost
14869 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14870 This cost is only a heuristic and is not guaranteed to produce
14871 consistent results across releases.
14873 @item -mcmove
14874 @opindex mcmove
14875 Enable the generation of conditional moves.
14877 @item -mnops=@var{num}
14878 @opindex mnops
14879 Emit @var{num} NOPs before every other generated instruction.
14881 @item -mno-soft-cmpsf
14882 @opindex mno-soft-cmpsf
14883 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14884 and test the flags.  This is faster than a software comparison, but can
14885 get incorrect results in the presence of NaNs, or when two different small
14886 numbers are compared such that their difference is calculated as zero.
14887 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14888 software comparisons.
14890 @item -mstack-offset=@var{num}
14891 @opindex mstack-offset
14892 Set the offset between the top of the stack and the stack pointer.
14893 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14894 can be used by leaf functions without stack allocation.
14895 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14896 Note also that this option changes the ABI; compiling a program with a
14897 different stack offset than the libraries have been compiled with
14898 generally does not work.
14899 This option can be useful if you want to evaluate if a different stack
14900 offset would give you better code, but to actually use a different stack
14901 offset to build working programs, it is recommended to configure the
14902 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14904 @item -mno-round-nearest
14905 @opindex mno-round-nearest
14906 Make the scheduler assume that the rounding mode has been set to
14907 truncating.  The default is @option{-mround-nearest}.
14909 @item -mlong-calls
14910 @opindex mlong-calls
14911 If not otherwise specified by an attribute, assume all calls might be beyond
14912 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14913 function address into a register before performing a (otherwise direct) call.
14914 This is the default.
14916 @item -mshort-calls
14917 @opindex short-calls
14918 If not otherwise specified by an attribute, assume all direct calls are
14919 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14920 for direct calls.  The default is @option{-mlong-calls}.
14922 @item -msmall16
14923 @opindex msmall16
14924 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14925 apply to function addresses for which @option{-mlong-calls} semantics
14926 are in effect.
14928 @item -mfp-mode=@var{mode}
14929 @opindex mfp-mode
14930 Set the prevailing mode of the floating-point unit.
14931 This determines the floating-point mode that is provided and expected
14932 at function call and return time.  Making this mode match the mode you
14933 predominantly need at function start can make your programs smaller and
14934 faster by avoiding unnecessary mode switches.
14936 @var{mode} can be set to one the following values:
14938 @table @samp
14939 @item caller
14940 Any mode at function entry is valid, and retained or restored when
14941 the function returns, and when it calls other functions.
14942 This mode is useful for compiling libraries or other compilation units
14943 you might want to incorporate into different programs with different
14944 prevailing FPU modes, and the convenience of being able to use a single
14945 object file outweighs the size and speed overhead for any extra
14946 mode switching that might be needed, compared with what would be needed
14947 with a more specific choice of prevailing FPU mode.
14949 @item truncate
14950 This is the mode used for floating-point calculations with
14951 truncating (i.e.@: round towards zero) rounding mode.  That includes
14952 conversion from floating point to integer.
14954 @item round-nearest
14955 This is the mode used for floating-point calculations with
14956 round-to-nearest-or-even rounding mode.
14958 @item int
14959 This is the mode used to perform integer calculations in the FPU, e.g.@:
14960 integer multiply, or integer multiply-and-accumulate.
14961 @end table
14963 The default is @option{-mfp-mode=caller}
14965 @item -mnosplit-lohi
14966 @itemx -mno-postinc
14967 @itemx -mno-postmodify
14968 @opindex mnosplit-lohi
14969 @opindex mno-postinc
14970 @opindex mno-postmodify
14971 Code generation tweaks that disable, respectively, splitting of 32-bit
14972 loads, generation of post-increment addresses, and generation of
14973 post-modify addresses.  The defaults are @option{msplit-lohi},
14974 @option{-mpost-inc}, and @option{-mpost-modify}.
14976 @item -mnovect-double
14977 @opindex mno-vect-double
14978 Change the preferred SIMD mode to SImode.  The default is
14979 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14981 @item -max-vect-align=@var{num}
14982 @opindex max-vect-align
14983 The maximum alignment for SIMD vector mode types.
14984 @var{num} may be 4 or 8.  The default is 8.
14985 Note that this is an ABI change, even though many library function
14986 interfaces are unaffected if they don't use SIMD vector modes
14987 in places that affect size and/or alignment of relevant types.
14989 @item -msplit-vecmove-early
14990 @opindex msplit-vecmove-early
14991 Split vector moves into single word moves before reload.  In theory this
14992 can give better register allocation, but so far the reverse seems to be
14993 generally the case.
14995 @item -m1reg-@var{reg}
14996 @opindex m1reg-
14997 Specify a register to hold the constant @minus{}1, which makes loading small negative
14998 constants and certain bitmasks faster.
14999 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15000 which specify use of that register as a fixed register,
15001 and @samp{none}, which means that no register is used for this
15002 purpose.  The default is @option{-m1reg-none}.
15004 @end table
15006 @node ARC Options
15007 @subsection ARC Options
15008 @cindex ARC options
15010 The following options control the architecture variant for which code
15011 is being compiled:
15013 @c architecture variants
15014 @table @gcctabopt
15016 @item -mbarrel-shifter
15017 @opindex mbarrel-shifter
15018 Generate instructions supported by barrel shifter.  This is the default
15019 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15021 @item -mjli-always
15022 @opindex mjli-alawys
15023 Force to call a function using jli_s instruction.  This option is
15024 valid only for ARCv2 architecture.
15026 @item -mcpu=@var{cpu}
15027 @opindex mcpu
15028 Set architecture type, register usage, and instruction scheduling
15029 parameters for @var{cpu}.  There are also shortcut alias options
15030 available for backward compatibility and convenience.  Supported
15031 values for @var{cpu} are
15033 @table @samp
15034 @opindex mA6
15035 @opindex mARC600
15036 @item arc600
15037 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15039 @item arc601
15040 @opindex mARC601
15041 Compile for ARC601.  Alias: @option{-mARC601}.
15043 @item arc700
15044 @opindex mA7
15045 @opindex mARC700
15046 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15047 This is the default when configured with @option{--with-cpu=arc700}@.
15049 @item arcem
15050 Compile for ARC EM.
15052 @item archs
15053 Compile for ARC HS.
15055 @item em
15056 Compile for ARC EM CPU with no hardware extensions.
15058 @item em4
15059 Compile for ARC EM4 CPU.
15061 @item em4_dmips
15062 Compile for ARC EM4 DMIPS CPU.
15064 @item em4_fpus
15065 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15066 extension.
15068 @item em4_fpuda
15069 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15070 double assist instructions.
15072 @item hs
15073 Compile for ARC HS CPU with no hardware extensions except the atomic
15074 instructions.
15076 @item hs34
15077 Compile for ARC HS34 CPU.
15079 @item hs38
15080 Compile for ARC HS38 CPU.
15082 @item hs38_linux
15083 Compile for ARC HS38 CPU with all hardware extensions on.
15085 @item arc600_norm
15086 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15088 @item arc600_mul32x16
15089 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15090 instructions enabled.
15092 @item arc600_mul64
15093 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15094 instructions enabled.
15096 @item arc601_norm
15097 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15099 @item arc601_mul32x16
15100 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15101 instructions enabled.
15103 @item arc601_mul64
15104 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15105 instructions enabled.
15107 @item nps400
15108 Compile for ARC 700 on NPS400 chip.
15110 @item em_mini
15111 Compile for ARC EM minimalist configuration featuring reduced register
15112 set.
15114 @end table
15116 @item -mdpfp
15117 @opindex mdpfp
15118 @itemx -mdpfp-compact
15119 @opindex mdpfp-compact
15120 Generate double-precision FPX instructions, tuned for the compact
15121 implementation.
15123 @item -mdpfp-fast
15124 @opindex mdpfp-fast
15125 Generate double-precision FPX instructions, tuned for the fast
15126 implementation.
15128 @item -mno-dpfp-lrsr
15129 @opindex mno-dpfp-lrsr
15130 Disable @code{lr} and @code{sr} instructions from using FPX extension
15131 aux registers.
15133 @item -mea
15134 @opindex mea
15135 Generate extended arithmetic instructions.  Currently only
15136 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15137 supported.  This is always enabled for @option{-mcpu=ARC700}.
15139 @item -mno-mpy
15140 @opindex mno-mpy
15141 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15142 deprecated.
15144 @item -mmul32x16
15145 @opindex mmul32x16
15146 Generate 32x16-bit multiply and multiply-accumulate instructions.
15148 @item -mmul64
15149 @opindex mmul64
15150 Generate @code{mul64} and @code{mulu64} instructions.  
15151 Only valid for @option{-mcpu=ARC600}.
15153 @item -mnorm
15154 @opindex mnorm
15155 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15156 is in effect.
15158 @item -mspfp
15159 @opindex mspfp
15160 @itemx -mspfp-compact
15161 @opindex mspfp-compact
15162 Generate single-precision FPX instructions, tuned for the compact
15163 implementation.
15165 @item -mspfp-fast
15166 @opindex mspfp-fast
15167 Generate single-precision FPX instructions, tuned for the fast
15168 implementation.
15170 @item -msimd
15171 @opindex msimd
15172 Enable generation of ARC SIMD instructions via target-specific
15173 builtins.  Only valid for @option{-mcpu=ARC700}.
15175 @item -msoft-float
15176 @opindex msoft-float
15177 This option ignored; it is provided for compatibility purposes only.
15178 Software floating-point code is emitted by default, and this default
15179 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15180 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15181 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15183 @item -mswap
15184 @opindex mswap
15185 Generate @code{swap} instructions.
15187 @item -matomic
15188 @opindex matomic
15189 This enables use of the locked load/store conditional extension to implement
15190 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15191 EM cores.
15193 @item -mdiv-rem
15194 @opindex mdiv-rem
15195 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15197 @item -mcode-density
15198 @opindex mcode-density
15199 Enable code density instructions for ARC EM.  
15200 This option is on by default for ARC HS.
15202 @item -mll64
15203 @opindex mll64
15204 Enable double load/store operations for ARC HS cores.
15206 @item -mtp-regno=@var{regno}
15207 @opindex mtp-regno
15208 Specify thread pointer register number.
15210 @item -mmpy-option=@var{multo}
15211 @opindex mmpy-option
15212 Compile ARCv2 code with a multiplier design option.  You can specify 
15213 the option using either a string or numeric value for @var{multo}.  
15214 @samp{wlh1} is the default value.  The recognized values are:
15216 @table @samp
15217 @item 0
15218 @itemx none
15219 No multiplier available.
15221 @item 1
15222 @itemx w
15223 16x16 multiplier, fully pipelined.
15224 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15226 @item 2
15227 @itemx wlh1
15228 32x32 multiplier, fully
15229 pipelined (1 stage).  The following instructions are additionally
15230 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15232 @item 3
15233 @itemx wlh2
15234 32x32 multiplier, fully pipelined
15235 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15236 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15238 @item 4
15239 @itemx wlh3
15240 Two 16x16 multipliers, blocking,
15241 sequential.  The following instructions are additionally enabled: @code{mpy},
15242 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15244 @item 5
15245 @itemx wlh4
15246 One 16x16 multiplier, blocking,
15247 sequential.  The following instructions are additionally enabled: @code{mpy},
15248 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15250 @item 6
15251 @itemx wlh5
15252 One 32x4 multiplier, blocking,
15253 sequential.  The following instructions are additionally enabled: @code{mpy},
15254 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15256 @item 7
15257 @itemx plus_dmpy
15258 ARC HS SIMD support.
15260 @item 8
15261 @itemx plus_macd
15262 ARC HS SIMD support.
15264 @item 9
15265 @itemx plus_qmacw
15266 ARC HS SIMD support.
15268 @end table
15270 This option is only available for ARCv2 cores@.
15272 @item -mfpu=@var{fpu}
15273 @opindex mfpu
15274 Enables support for specific floating-point hardware extensions for ARCv2
15275 cores.  Supported values for @var{fpu} are:
15277 @table @samp
15279 @item fpus
15280 Enables support for single-precision floating-point hardware
15281 extensions@.
15283 @item fpud
15284 Enables support for double-precision floating-point hardware
15285 extensions.  The single-precision floating-point extension is also
15286 enabled.  Not available for ARC EM@.
15288 @item fpuda
15289 Enables support for double-precision floating-point hardware
15290 extensions using double-precision assist instructions.  The single-precision
15291 floating-point extension is also enabled.  This option is
15292 only available for ARC EM@.
15294 @item fpuda_div
15295 Enables support for double-precision floating-point hardware
15296 extensions using double-precision assist instructions.
15297 The single-precision floating-point, square-root, and divide 
15298 extensions are also enabled.  This option is
15299 only available for ARC EM@.
15301 @item fpuda_fma
15302 Enables support for double-precision floating-point hardware
15303 extensions using double-precision assist instructions.
15304 The single-precision floating-point and fused multiply and add 
15305 hardware extensions are also enabled.  This option is
15306 only available for ARC EM@.
15308 @item fpuda_all
15309 Enables support for double-precision floating-point hardware
15310 extensions using double-precision assist instructions.
15311 All single-precision floating-point hardware extensions are also
15312 enabled.  This option is only available for ARC EM@.
15314 @item fpus_div
15315 Enables support for single-precision floating-point, square-root and divide 
15316 hardware extensions@.
15318 @item fpud_div
15319 Enables support for double-precision floating-point, square-root and divide 
15320 hardware extensions.  This option
15321 includes option @samp{fpus_div}. Not available for ARC EM@.
15323 @item fpus_fma
15324 Enables support for single-precision floating-point and 
15325 fused multiply and add hardware extensions@.
15327 @item fpud_fma
15328 Enables support for double-precision floating-point and 
15329 fused multiply and add hardware extensions.  This option
15330 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15332 @item fpus_all
15333 Enables support for all single-precision floating-point hardware
15334 extensions@.
15336 @item fpud_all
15337 Enables support for all single- and double-precision floating-point
15338 hardware extensions.  Not available for ARC EM@.
15340 @end table
15342 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15343 @opindex mirq-ctrl-saved
15344 Specifies general-purposes registers that the processor automatically
15345 saves/restores on interrupt entry and exit.  @var{register-range} is
15346 specified as two registers separated by a dash.  The register range
15347 always starts with @code{r0}, the upper limit is @code{fp} register.
15348 @var{blink} and @var{lp_count} are optional.  This option is only
15349 valid for ARC EM and ARC HS cores.
15351 @item -mrgf-banked-regs=@var{number}
15352 @opindex mrgf-banked-regs
15353 Specifies the number of registers replicated in second register bank
15354 on entry to fast interrupt.  Fast interrupts are interrupts with the
15355 highest priority level P0.  These interrupts save only PC and STATUS32
15356 registers to avoid memory transactions during interrupt entry and exit
15357 sequences.  Use this option when you are using fast interrupts in an
15358 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15360 @item -mlpc-width=@var{width}
15361 @opindex mlpc-width
15362 Specify the width of the @code{lp_count} register.  Valid values for
15363 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15364 fixed to 32 bits.  If the width is less than 32, the compiler does not
15365 attempt to transform loops in your program to use the zero-delay loop
15366 mechanism unless it is known that the @code{lp_count} register can
15367 hold the required loop-counter value.  Depending on the width
15368 specified, the compiler and run-time library might continue to use the
15369 loop mechanism for various needs.  This option defines macro
15370 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15372 @item -mrf16
15373 @opindex mrf16
15374 This option instructs the compiler to generate code for a 16-entry
15375 register file.  This option defines the @code{__ARC_RF16__}
15376 preprocessor macro.
15378 @end table
15380 The following options are passed through to the assembler, and also
15381 define preprocessor macro symbols.
15383 @c Flags used by the assembler, but for which we define preprocessor
15384 @c macro symbols as well.
15385 @table @gcctabopt
15386 @item -mdsp-packa
15387 @opindex mdsp-packa
15388 Passed down to the assembler to enable the DSP Pack A extensions.
15389 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15390 deprecated.
15392 @item -mdvbf
15393 @opindex mdvbf
15394 Passed down to the assembler to enable the dual Viterbi butterfly
15395 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15396 option is deprecated.
15398 @c ARC700 4.10 extension instruction
15399 @item -mlock
15400 @opindex mlock
15401 Passed down to the assembler to enable the locked load/store
15402 conditional extension.  Also sets the preprocessor symbol
15403 @code{__Xlock}.
15405 @item -mmac-d16
15406 @opindex mmac-d16
15407 Passed down to the assembler.  Also sets the preprocessor symbol
15408 @code{__Xxmac_d16}.  This option is deprecated.
15410 @item -mmac-24
15411 @opindex mmac-24
15412 Passed down to the assembler.  Also sets the preprocessor symbol
15413 @code{__Xxmac_24}.  This option is deprecated.
15415 @c ARC700 4.10 extension instruction
15416 @item -mrtsc
15417 @opindex mrtsc
15418 Passed down to the assembler to enable the 64-bit time-stamp counter
15419 extension instruction.  Also sets the preprocessor symbol
15420 @code{__Xrtsc}.  This option is deprecated.
15422 @c ARC700 4.10 extension instruction
15423 @item -mswape
15424 @opindex mswape
15425 Passed down to the assembler to enable the swap byte ordering
15426 extension instruction.  Also sets the preprocessor symbol
15427 @code{__Xswape}.
15429 @item -mtelephony
15430 @opindex mtelephony
15431 Passed down to the assembler to enable dual- and single-operand
15432 instructions for telephony.  Also sets the preprocessor symbol
15433 @code{__Xtelephony}.  This option is deprecated.
15435 @item -mxy
15436 @opindex mxy
15437 Passed down to the assembler to enable the XY memory extension.  Also
15438 sets the preprocessor symbol @code{__Xxy}.
15440 @end table
15442 The following options control how the assembly code is annotated:
15444 @c Assembly annotation options
15445 @table @gcctabopt
15446 @item -misize
15447 @opindex misize
15448 Annotate assembler instructions with estimated addresses.
15450 @item -mannotate-align
15451 @opindex mannotate-align
15452 Explain what alignment considerations lead to the decision to make an
15453 instruction short or long.
15455 @end table
15457 The following options are passed through to the linker:
15459 @c options passed through to the linker
15460 @table @gcctabopt
15461 @item -marclinux
15462 @opindex marclinux
15463 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15464 This option is enabled by default in tool chains built for
15465 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15466 when profiling is not requested.
15468 @item -marclinux_prof
15469 @opindex marclinux_prof
15470 Passed through to the linker, to specify use of the
15471 @code{arclinux_prof} emulation.  This option is enabled by default in
15472 tool chains built for @w{@code{arc-linux-uclibc}} and
15473 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15475 @end table
15477 The following options control the semantics of generated code:
15479 @c semantically relevant code generation options
15480 @table @gcctabopt
15481 @item -mlong-calls
15482 @opindex mlong-calls
15483 Generate calls as register indirect calls, thus providing access
15484 to the full 32-bit address range.
15486 @item -mmedium-calls
15487 @opindex mmedium-calls
15488 Don't use less than 25-bit addressing range for calls, which is the
15489 offset available for an unconditional branch-and-link
15490 instruction.  Conditional execution of function calls is suppressed, to
15491 allow use of the 25-bit range, rather than the 21-bit range with
15492 conditional branch-and-link.  This is the default for tool chains built
15493 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15495 @item -G @var{num}
15496 @opindex G
15497 Put definitions of externally-visible data in a small data section if
15498 that data is no bigger than @var{num} bytes.  The default value of
15499 @var{num} is 4 for any ARC configuration, or 8 when we have double
15500 load/store operations.
15502 @item -mno-sdata
15503 @opindex mno-sdata
15504 Do not generate sdata references.  This is the default for tool chains
15505 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15506 targets.
15508 @item -mvolatile-cache
15509 @opindex mvolatile-cache
15510 Use ordinarily cached memory accesses for volatile references.  This is the
15511 default.
15513 @item -mno-volatile-cache
15514 @opindex mno-volatile-cache
15515 Enable cache bypass for volatile references.
15517 @end table
15519 The following options fine tune code generation:
15520 @c code generation tuning options
15521 @table @gcctabopt
15522 @item -malign-call
15523 @opindex malign-call
15524 Do alignment optimizations for call instructions.
15526 @item -mauto-modify-reg
15527 @opindex mauto-modify-reg
15528 Enable the use of pre/post modify with register displacement.
15530 @item -mbbit-peephole
15531 @opindex mbbit-peephole
15532 Enable bbit peephole2.
15534 @item -mno-brcc
15535 @opindex mno-brcc
15536 This option disables a target-specific pass in @file{arc_reorg} to
15537 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15538 It has no effect on
15539 generation of these instructions driven by the combiner pass.
15541 @item -mcase-vector-pcrel
15542 @opindex mcase-vector-pcrel
15543 Use PC-relative switch case tables to enable case table shortening.
15544 This is the default for @option{-Os}.
15546 @item -mcompact-casesi
15547 @opindex mcompact-casesi
15548 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15549 and only available for ARCv1 cores.
15551 @item -mno-cond-exec
15552 @opindex mno-cond-exec
15553 Disable the ARCompact-specific pass to generate conditional 
15554 execution instructions.
15556 Due to delay slot scheduling and interactions between operand numbers,
15557 literal sizes, instruction lengths, and the support for conditional execution,
15558 the target-independent pass to generate conditional execution is often lacking,
15559 so the ARC port has kept a special pass around that tries to find more
15560 conditional execution generation opportunities after register allocation,
15561 branch shortening, and delay slot scheduling have been done.  This pass
15562 generally, but not always, improves performance and code size, at the cost of
15563 extra compilation time, which is why there is an option to switch it off.
15564 If you have a problem with call instructions exceeding their allowable
15565 offset range because they are conditionalized, you should consider using
15566 @option{-mmedium-calls} instead.
15568 @item -mearly-cbranchsi
15569 @opindex mearly-cbranchsi
15570 Enable pre-reload use of the @code{cbranchsi} pattern.
15572 @item -mexpand-adddi
15573 @opindex mexpand-adddi
15574 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15575 @code{add.f}, @code{adc} etc.  This option is deprecated.
15577 @item -mindexed-loads
15578 @opindex mindexed-loads
15579 Enable the use of indexed loads.  This can be problematic because some
15580 optimizers then assume that indexed stores exist, which is not
15581 the case.
15583 @item -mlra
15584 @opindex mlra
15585 Enable Local Register Allocation.  This is still experimental for ARC,
15586 so by default the compiler uses standard reload
15587 (i.e. @option{-mno-lra}).
15589 @item -mlra-priority-none
15590 @opindex mlra-priority-none
15591 Don't indicate any priority for target registers.
15593 @item -mlra-priority-compact
15594 @opindex mlra-priority-compact
15595 Indicate target register priority for r0..r3 / r12..r15.
15597 @item -mlra-priority-noncompact
15598 @opindex mlra-priority-noncompact
15599 Reduce target register priority for r0..r3 / r12..r15.
15601 @item -mno-millicode
15602 @opindex mno-millicode
15603 When optimizing for size (using @option{-Os}), prologues and epilogues
15604 that have to save or restore a large number of registers are often
15605 shortened by using call to a special function in libgcc; this is
15606 referred to as a @emph{millicode} call.  As these calls can pose
15607 performance issues, and/or cause linking issues when linking in a
15608 nonstandard way, this option is provided to turn off millicode call
15609 generation.
15611 @item -mmixed-code
15612 @opindex mmixed-code
15613 Tweak register allocation to help 16-bit instruction generation.
15614 This generally has the effect of decreasing the average instruction size
15615 while increasing the instruction count.
15617 @item -mq-class
15618 @opindex mq-class
15619 Enable @samp{q} instruction alternatives.
15620 This is the default for @option{-Os}.
15622 @item -mRcq
15623 @opindex mRcq
15624 Enable @samp{Rcq} constraint handling.  
15625 Most short code generation depends on this.
15626 This is the default.
15628 @item -mRcw
15629 @opindex mRcw
15630 Enable @samp{Rcw} constraint handling.  
15631 Most ccfsm condexec mostly depends on this.
15632 This is the default.
15634 @item -msize-level=@var{level}
15635 @opindex msize-level
15636 Fine-tune size optimization with regards to instruction lengths and alignment.
15637 The recognized values for @var{level} are:
15638 @table @samp
15639 @item 0
15640 No size optimization.  This level is deprecated and treated like @samp{1}.
15642 @item 1
15643 Short instructions are used opportunistically.
15645 @item 2
15646 In addition, alignment of loops and of code after barriers are dropped.
15648 @item 3
15649 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15651 @end table
15653 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15654 the behavior when this is not set is equivalent to level @samp{1}.
15656 @item -mtune=@var{cpu}
15657 @opindex mtune
15658 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15659 by @option{-mcpu=}.
15661 Supported values for @var{cpu} are
15663 @table @samp
15664 @item ARC600
15665 Tune for ARC600 CPU.
15667 @item ARC601
15668 Tune for ARC601 CPU.
15670 @item ARC700
15671 Tune for ARC700 CPU with standard multiplier block.
15673 @item ARC700-xmac
15674 Tune for ARC700 CPU with XMAC block.
15676 @item ARC725D
15677 Tune for ARC725D CPU.
15679 @item ARC750D
15680 Tune for ARC750D CPU.
15682 @end table
15684 @item -mmultcost=@var{num}
15685 @opindex mmultcost
15686 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15687 normal instruction.
15689 @item -munalign-prob-threshold=@var{probability}
15690 @opindex munalign-prob-threshold
15691 Set probability threshold for unaligning branches.
15692 When tuning for @samp{ARC700} and optimizing for speed, branches without
15693 filled delay slot are preferably emitted unaligned and long, unless
15694 profiling indicates that the probability for the branch to be taken
15695 is below @var{probability}.  @xref{Cross-profiling}.
15696 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15698 @end table
15700 The following options are maintained for backward compatibility, but
15701 are now deprecated and will be removed in a future release:
15703 @c Deprecated options
15704 @table @gcctabopt
15706 @item -margonaut
15707 @opindex margonaut
15708 Obsolete FPX.
15710 @item -mbig-endian
15711 @opindex mbig-endian
15712 @itemx -EB
15713 @opindex EB
15714 Compile code for big-endian targets.  Use of these options is now
15715 deprecated.  Big-endian code is supported by configuring GCC to build
15716 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15717 for which big endian is the default.
15719 @item -mlittle-endian
15720 @opindex mlittle-endian
15721 @itemx -EL
15722 @opindex EL
15723 Compile code for little-endian targets.  Use of these options is now
15724 deprecated.  Little-endian code is supported by configuring GCC to build 
15725 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15726 for which little endian is the default.
15728 @item -mbarrel_shifter
15729 @opindex mbarrel_shifter
15730 Replaced by @option{-mbarrel-shifter}.
15732 @item -mdpfp_compact
15733 @opindex mdpfp_compact
15734 Replaced by @option{-mdpfp-compact}.
15736 @item -mdpfp_fast
15737 @opindex mdpfp_fast
15738 Replaced by @option{-mdpfp-fast}.
15740 @item -mdsp_packa
15741 @opindex mdsp_packa
15742 Replaced by @option{-mdsp-packa}.
15744 @item -mEA
15745 @opindex mEA
15746 Replaced by @option{-mea}.
15748 @item -mmac_24
15749 @opindex mmac_24
15750 Replaced by @option{-mmac-24}.
15752 @item -mmac_d16
15753 @opindex mmac_d16
15754 Replaced by @option{-mmac-d16}.
15756 @item -mspfp_compact
15757 @opindex mspfp_compact
15758 Replaced by @option{-mspfp-compact}.
15760 @item -mspfp_fast
15761 @opindex mspfp_fast
15762 Replaced by @option{-mspfp-fast}.
15764 @item -mtune=@var{cpu}
15765 @opindex mtune
15766 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15767 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15768 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15770 @item -multcost=@var{num}
15771 @opindex multcost
15772 Replaced by @option{-mmultcost}.
15774 @end table
15776 @node ARM Options
15777 @subsection ARM Options
15778 @cindex ARM options
15780 These @samp{-m} options are defined for the ARM port:
15782 @table @gcctabopt
15783 @item -mabi=@var{name}
15784 @opindex mabi
15785 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15786 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15788 @item -mapcs-frame
15789 @opindex mapcs-frame
15790 Generate a stack frame that is compliant with the ARM Procedure Call
15791 Standard for all functions, even if this is not strictly necessary for
15792 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15793 with this option causes the stack frames not to be generated for
15794 leaf functions.  The default is @option{-mno-apcs-frame}.
15795 This option is deprecated.
15797 @item -mapcs
15798 @opindex mapcs
15799 This is a synonym for @option{-mapcs-frame} and is deprecated.
15801 @ignore
15802 @c not currently implemented
15803 @item -mapcs-stack-check
15804 @opindex mapcs-stack-check
15805 Generate code to check the amount of stack space available upon entry to
15806 every function (that actually uses some stack space).  If there is
15807 insufficient space available then either the function
15808 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15809 called, depending upon the amount of stack space required.  The runtime
15810 system is required to provide these functions.  The default is
15811 @option{-mno-apcs-stack-check}, since this produces smaller code.
15813 @c not currently implemented
15814 @item -mapcs-reentrant
15815 @opindex mapcs-reentrant
15816 Generate reentrant, position-independent code.  The default is
15817 @option{-mno-apcs-reentrant}.
15818 @end ignore
15820 @item -mthumb-interwork
15821 @opindex mthumb-interwork
15822 Generate code that supports calling between the ARM and Thumb
15823 instruction sets.  Without this option, on pre-v5 architectures, the
15824 two instruction sets cannot be reliably used inside one program.  The
15825 default is @option{-mno-thumb-interwork}, since slightly larger code
15826 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15827 configurations this option is meaningless.
15829 @item -mno-sched-prolog
15830 @opindex mno-sched-prolog
15831 Prevent the reordering of instructions in the function prologue, or the
15832 merging of those instruction with the instructions in the function's
15833 body.  This means that all functions start with a recognizable set
15834 of instructions (or in fact one of a choice from a small set of
15835 different function prologues), and this information can be used to
15836 locate the start of functions inside an executable piece of code.  The
15837 default is @option{-msched-prolog}.
15839 @item -mfloat-abi=@var{name}
15840 @opindex mfloat-abi
15841 Specifies which floating-point ABI to use.  Permissible values
15842 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15844 Specifying @samp{soft} causes GCC to generate output containing
15845 library calls for floating-point operations.
15846 @samp{softfp} allows the generation of code using hardware floating-point
15847 instructions, but still uses the soft-float calling conventions.
15848 @samp{hard} allows generation of floating-point instructions
15849 and uses FPU-specific calling conventions.
15851 The default depends on the specific target configuration.  Note that
15852 the hard-float and soft-float ABIs are not link-compatible; you must
15853 compile your entire program with the same ABI, and link with a
15854 compatible set of libraries.
15856 @item -mlittle-endian
15857 @opindex mlittle-endian
15858 Generate code for a processor running in little-endian mode.  This is
15859 the default for all standard configurations.
15861 @item -mbig-endian
15862 @opindex mbig-endian
15863 Generate code for a processor running in big-endian mode; the default is
15864 to compile code for a little-endian processor.
15866 @item -mbe8
15867 @itemx -mbe32
15868 @opindex mbe8
15869 When linking a big-endian image select between BE8 and BE32 formats.
15870 The option has no effect for little-endian images and is ignored.  The
15871 default is dependent on the selected target architecture.  For ARMv6
15872 and later architectures the default is BE8, for older architectures
15873 the default is BE32.  BE32 format has been deprecated by ARM.
15875 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15876 @opindex march
15877 This specifies the name of the target ARM architecture.  GCC uses this
15878 name to determine what kind of instructions it can emit when generating
15879 assembly code.  This option can be used in conjunction with or instead
15880 of the @option{-mcpu=} option.
15882 Permissible names are:
15883 @samp{armv4t},
15884 @samp{armv5t}, @samp{armv5te},
15885 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15886 @samp{armv6z}, @samp{armv6zk},
15887 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15888 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15889 @samp{armv8.4-a},
15890 @samp{armv7-r},
15891 @samp{armv8-r},
15892 @samp{armv6-m}, @samp{armv6s-m},
15893 @samp{armv7-m}, @samp{armv7e-m},
15894 @samp{armv8-m.base}, @samp{armv8-m.main},
15895 @samp{iwmmxt} and @samp{iwmmxt2}.
15897 Additionally, the following architectures, which lack support for the
15898 Thumb execution state, are recognized but support is deprecated:
15899 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15900 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15902 Many of the architectures support extensions.  These can be added by
15903 appending @samp{+@var{extension}} to the architecture name.  Extension
15904 options are processed in order and capabilities accumulate.  An extension
15905 will also enable any necessary base extensions
15906 upon which it depends.  For example, the @samp{+crypto} extension
15907 will always enable the @samp{+simd} extension.  The exception to the
15908 additive construction is for extensions that are prefixed with
15909 @samp{+no@dots{}}: these extensions disable the specified option and
15910 any other extensions that may depend on the presence of that
15911 extension.
15913 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15914 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15915 entirely disabled by the @samp{+nofp} option that follows it.
15917 Most extension names are generically named, but have an effect that is
15918 dependent upon the architecture to which it is applied.  For example,
15919 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15920 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15921 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15922 variant for @samp{armv8-a}.
15924 The table below lists the supported extensions for each architecture.
15925 Architectures not mentioned do not support any extensions.
15927 @table @samp
15928 @item  armv5e
15929 @itemx armv5te
15930 @itemx armv6
15931 @itemx armv6j
15932 @itemx armv6k
15933 @itemx armv6kz
15934 @itemx armv6t2
15935 @itemx armv6z
15936 @itemx armv6zk
15937 @table @samp
15938 @item +fp
15939 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15940 used as an alias for this extension.
15942 @item +nofp
15943 Disable the floating-point instructions.
15944 @end table
15946 @item armv7
15947 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15948 @table @samp
15949 @item +fp
15950 The VFPv3 floating-point instructions, with 16 double-precision
15951 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15952 for this extension.  Note that floating-point is not supported by the
15953 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15954 ARMv7-R architectures.
15956 @item +nofp
15957 Disable the floating-point instructions.
15958 @end table
15960 @item armv7-a
15961 @table @samp
15962 @item +fp
15963 The VFPv3 floating-point instructions, with 16 double-precision
15964 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15965 for this extension.
15967 @item +simd
15968 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15969 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15970 for this extension.
15972 @item +vfpv3
15973 The VFPv3 floating-point instructions, with 32 double-precision
15974 registers.
15976 @item +vfpv3-d16-fp16
15977 The VFPv3 floating-point instructions, with 16 double-precision
15978 registers and the half-precision floating-point conversion operations.
15980 @item +vfpv3-fp16
15981 The VFPv3 floating-point instructions, with 32 double-precision
15982 registers and the half-precision floating-point conversion operations.
15984 @item +vfpv4-d16
15985 The VFPv4 floating-point instructions, with 16 double-precision
15986 registers.
15988 @item +vfpv4
15989 The VFPv4 floating-point instructions, with 32 double-precision
15990 registers.
15992 @item +neon-fp16
15993 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15994 the half-precision floating-point conversion operations.
15996 @item +neon-vfpv4
15997 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15999 @item +nosimd
16000 Disable the Advanced SIMD instructions (does not disable floating point).
16002 @item +nofp
16003 Disable the floating-point and Advanced SIMD instructions.
16004 @end table
16006 @item armv7ve
16007 The extended version of the ARMv7-A architecture with support for
16008 virtualization.
16009 @table @samp
16010 @item +fp
16011 The VFPv4 floating-point instructions, with 16 double-precision registers.
16012 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16014 @item +simd
16015 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16016 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16018 @item +vfpv3-d16
16019 The VFPv3 floating-point instructions, with 16 double-precision
16020 registers.
16022 @item +vfpv3
16023 The VFPv3 floating-point instructions, with 32 double-precision
16024 registers.
16026 @item +vfpv3-d16-fp16
16027 The VFPv3 floating-point instructions, with 16 double-precision
16028 registers and the half-precision floating-point conversion operations.
16030 @item +vfpv3-fp16
16031 The VFPv3 floating-point instructions, with 32 double-precision
16032 registers and the half-precision floating-point conversion operations.
16034 @item +vfpv4-d16
16035 The VFPv4 floating-point instructions, with 16 double-precision
16036 registers.
16038 @item +vfpv4
16039 The VFPv4 floating-point instructions, with 32 double-precision
16040 registers.
16042 @item +neon
16043 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16044 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16046 @item +neon-fp16
16047 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16048 the half-precision floating-point conversion operations.
16050 @item +nosimd
16051 Disable the Advanced SIMD instructions (does not disable floating point).
16053 @item +nofp
16054 Disable the floating-point and Advanced SIMD instructions.
16055 @end table
16057 @item armv8-a
16058 @table @samp
16059 @item +crc
16060 The Cyclic Redundancy Check (CRC) instructions.
16061 @item +simd
16062 The ARMv8-A Advanced SIMD and floating-point instructions.
16063 @item +crypto
16064 The cryptographic instructions.
16065 @item +nocrypto
16066 Disable the cryptographic instructions.
16067 @item +nofp
16068 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16069 @end table
16071 @item armv8.1-a
16072 @table @samp
16073 @item +simd
16074 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16076 @item +crypto
16077 The cryptographic instructions.  This also enables the Advanced SIMD and
16078 floating-point instructions.
16080 @item +nocrypto
16081 Disable the cryptographic instructions.
16083 @item +nofp
16084 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16085 @end table
16087 @item armv8.2-a
16088 @itemx armv8.3-a
16089 @table @samp
16090 @item +fp16
16091 The half-precision floating-point data processing instructions.
16092 This also enables the Advanced SIMD and floating-point instructions.
16094 @item +fp16fml
16095 The half-precision floating-point fmla extension.  This also enables
16096 the half-precision floating-point extension and Advanced SIMD and
16097 floating-point instructions.
16099 @item +simd
16100 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16102 @item +crypto
16103 The cryptographic instructions.  This also enables the Advanced SIMD and
16104 floating-point instructions.
16106 @item +dotprod
16107 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16109 @item +nocrypto
16110 Disable the cryptographic extension.
16112 @item +nofp
16113 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16114 @end table
16116 @item armv8.4-a
16117 @table @samp
16118 @item +fp16
16119 The half-precision floating-point data processing instructions.
16120 This also enables the Advanced SIMD and floating-point instructions as well
16121 as the Dot Product extension and the half-precision floating-point fmla
16122 extension.
16124 @item +simd
16125 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16126 Dot Product extension.
16128 @item +crypto
16129 The cryptographic instructions.  This also enables the Advanced SIMD and
16130 floating-point instructions as well as the Dot Product extension.
16132 @item +nocrypto
16133 Disable the cryptographic extension.
16135 @item +nofp
16136 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16137 @end table
16139 @item armv7-r
16140 @table @samp
16141 @item +fp.sp
16142 The single-precision VFPv3 floating-point instructions.  The extension
16143 @samp{+vfpv3xd} can be used as an alias for this extension.
16145 @item +fp
16146 The VFPv3 floating-point instructions with 16 double-precision registers.
16147 The extension +vfpv3-d16 can be used as an alias for this extension.
16149 @item +nofp
16150 Disable the floating-point extension.
16152 @item +idiv
16153 The ARM-state integer division instructions.
16155 @item +noidiv
16156 Disable the ARM-state integer division extension.
16157 @end table
16159 @item armv7e-m
16160 @table @samp
16161 @item +fp
16162 The single-precision VFPv4 floating-point instructions.
16164 @item +fpv5
16165 The single-precision FPv5 floating-point instructions.
16167 @item +fp.dp
16168 The single- and double-precision FPv5 floating-point instructions.
16170 @item +nofp
16171 Disable the floating-point extensions.
16172 @end table
16174 @item  armv8-m.main
16175 @table @samp
16176 @item +dsp
16177 The DSP instructions.
16179 @item +nodsp
16180 Disable the DSP extension.
16182 @item +fp
16183 The single-precision floating-point instructions.
16185 @item +fp.dp
16186 The single- and double-precision floating-point instructions.
16188 @item +nofp
16189 Disable the floating-point extension.
16190 @end table
16192 @item armv8-r
16193 @table @samp
16194 @item +crc
16195 The Cyclic Redundancy Check (CRC) instructions.
16196 @item +fp.sp
16197 The single-precision FPv5 floating-point instructions.
16198 @item +simd
16199 The ARMv8-A Advanced SIMD and floating-point instructions.
16200 @item +crypto
16201 The cryptographic instructions.
16202 @item +nocrypto
16203 Disable the cryptographic instructions.
16204 @item +nofp
16205 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16206 @end table
16208 @end table
16210 @option{-march=native} causes the compiler to auto-detect the architecture
16211 of the build computer.  At present, this feature is only supported on
16212 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16213 is unsuccessful the option has no effect.
16215 @item -mtune=@var{name}
16216 @opindex mtune
16217 This option specifies the name of the target ARM processor for
16218 which GCC should tune the performance of the code.
16219 For some ARM implementations better performance can be obtained by using
16220 this option.
16221 Permissible names are: @samp{arm2}, @samp{arm250},
16222 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16223 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16224 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16225 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16226 @samp{arm720},
16227 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16228 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16229 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16230 @samp{strongarm1110},
16231 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16232 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16233 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16234 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16235 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16236 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16237 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16238 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16239 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16240 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16241 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16242 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16243 @samp{cortex-r8}, @samp{cortex-r52},
16244 @samp{cortex-m33},
16245 @samp{cortex-m23},
16246 @samp{cortex-m7},
16247 @samp{cortex-m4},
16248 @samp{cortex-m3},
16249 @samp{cortex-m1},
16250 @samp{cortex-m0},
16251 @samp{cortex-m0plus},
16252 @samp{cortex-m1.small-multiply},
16253 @samp{cortex-m0.small-multiply},
16254 @samp{cortex-m0plus.small-multiply},
16255 @samp{exynos-m1},
16256 @samp{marvell-pj4},
16257 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16258 @samp{fa526}, @samp{fa626},
16259 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16260 @samp{xgene1}.
16262 Additionally, this option can specify that GCC should tune the performance
16263 of the code for a big.LITTLE system.  Permissible names are:
16264 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16265 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16266 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16267 @samp{cortex-a75.cortex-a55}.
16269 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16270 performance for a blend of processors within architecture @var{arch}.
16271 The aim is to generate code that run well on the current most popular
16272 processors, balancing between optimizations that benefit some CPUs in the
16273 range, and avoiding performance pitfalls of other CPUs.  The effects of
16274 this option may change in future GCC versions as CPU models come and go.
16276 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16277 the extension options do not affect the tuning of the generated code.
16279 @option{-mtune=native} causes the compiler to auto-detect the CPU
16280 of the build computer.  At present, this feature is only supported on
16281 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16282 unsuccessful the option has no effect.
16284 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16285 @opindex mcpu
16286 This specifies the name of the target ARM processor.  GCC uses this name
16287 to derive the name of the target ARM architecture (as if specified
16288 by @option{-march}) and the ARM processor type for which to tune for
16289 performance (as if specified by @option{-mtune}).  Where this option
16290 is used in conjunction with @option{-march} or @option{-mtune},
16291 those options take precedence over the appropriate part of this option.
16293 Many of the supported CPUs implement optional architectural
16294 extensions.  Where this is so the architectural extensions are
16295 normally enabled by default.  If implementations that lack the
16296 extension exist, then the extension syntax can be used to disable
16297 those extensions that have been omitted.  For floating-point and
16298 Advanced SIMD (Neon) instructions, the settings of the options
16299 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16300 floating-point and Advanced SIMD instructions will only be used if
16301 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16302 @option{-mfpu} other than @samp{auto} will override the available
16303 floating-point and SIMD extension instructions.
16305 For example, @samp{cortex-a9} can be found in three major
16306 configurations: integer only, with just a floating-point unit or with
16307 floating-point and Advanced SIMD.  The default is to enable all the
16308 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16309 be used to disable just the SIMD or both the SIMD and floating-point
16310 instructions respectively.
16312 Permissible names for this option are the same as those for
16313 @option{-mtune}.
16315 The following extension options are common to the listed CPUs:
16317 @table @samp
16318 @item +nodsp
16319 Disable the DSP instructions on @samp{cortex-m33}.
16321 @item  +nofp
16322 Disables the floating-point instructions on @samp{arm9e},
16323 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16324 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16325 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16326 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16327 Disables the floating-point and SIMD instructions on
16328 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16329 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16330 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16331 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16332 @samp{cortex-a53} and @samp{cortex-a55}.
16334 @item +nofp.dp
16335 Disables the double-precision component of the floating-point instructions
16336 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16338 @item +nosimd
16339 Disables the SIMD (but not floating-point) instructions on
16340 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16341 and @samp{cortex-a9}.
16343 @item +crypto
16344 Enables the cryptographic instructions on @samp{cortex-a32},
16345 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16346 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16347 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16348 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16349 @samp{cortex-a75.cortex-a55}.
16350 @end table
16352 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16353 VFPv3 with 16 double-precision registers.  It supports the following
16354 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16355 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16356 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16357 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16358 @option{-march=armv7-a}.
16360 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16361 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16362 See @option{-mtune} for more information.
16364 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16365 of the build computer.  At present, this feature is only supported on
16366 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16367 is unsuccessful the option has no effect.
16369 @item -mfpu=@var{name}
16370 @opindex mfpu
16371 This specifies what floating-point hardware (or hardware emulation) is
16372 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16373 @samp{vfpv3},
16374 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16375 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16376 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16377 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16378 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16379 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16380 is an alias for @samp{vfpv2}.
16382 The setting @samp{auto} is the default and is special.  It causes the
16383 compiler to select the floating-point and Advanced SIMD instructions
16384 based on the settings of @option{-mcpu} and @option{-march}.
16386 If the selected floating-point hardware includes the NEON extension
16387 (e.g. @option{-mfpu=neon}), note that floating-point
16388 operations are not generated by GCC's auto-vectorization pass unless
16389 @option{-funsafe-math-optimizations} is also specified.  This is
16390 because NEON hardware does not fully implement the IEEE 754 standard for
16391 floating-point arithmetic (in particular denormal values are treated as
16392 zero), so the use of NEON instructions may lead to a loss of precision.
16394 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}).
16396 @item -mfp16-format=@var{name}
16397 @opindex mfp16-format
16398 Specify the format of the @code{__fp16} half-precision floating-point type.
16399 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16400 the default is @samp{none}, in which case the @code{__fp16} type is not
16401 defined.  @xref{Half-Precision}, for more information.
16403 @item -mstructure-size-boundary=@var{n}
16404 @opindex mstructure-size-boundary
16405 The sizes of all structures and unions are rounded up to a multiple
16406 of the number of bits set by this option.  Permissible values are 8, 32
16407 and 64.  The default value varies for different toolchains.  For the COFF
16408 targeted toolchain the default value is 8.  A value of 64 is only allowed
16409 if the underlying ABI supports it.
16411 Specifying a larger number can produce faster, more efficient code, but
16412 can also increase the size of the program.  Different values are potentially
16413 incompatible.  Code compiled with one value cannot necessarily expect to
16414 work with code or libraries compiled with another value, if they exchange
16415 information using structures or unions.
16417 This option is deprecated.
16419 @item -mabort-on-noreturn
16420 @opindex mabort-on-noreturn
16421 Generate a call to the function @code{abort} at the end of a
16422 @code{noreturn} function.  It is executed if the function tries to
16423 return.
16425 @item -mlong-calls
16426 @itemx -mno-long-calls
16427 @opindex mlong-calls
16428 @opindex mno-long-calls
16429 Tells the compiler to perform function calls by first loading the
16430 address of the function into a register and then performing a subroutine
16431 call on this register.  This switch is needed if the target function
16432 lies outside of the 64-megabyte addressing range of the offset-based
16433 version of subroutine call instruction.
16435 Even if this switch is enabled, not all function calls are turned
16436 into long calls.  The heuristic is that static functions, functions
16437 that have the @code{short_call} attribute, functions that are inside
16438 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16439 definitions have already been compiled within the current compilation
16440 unit are not turned into long calls.  The exceptions to this rule are
16441 that weak function definitions, functions with the @code{long_call}
16442 attribute or the @code{section} attribute, and functions that are within
16443 the scope of a @code{#pragma long_calls} directive are always
16444 turned into long calls.
16446 This feature is not enabled by default.  Specifying
16447 @option{-mno-long-calls} restores the default behavior, as does
16448 placing the function calls within the scope of a @code{#pragma
16449 long_calls_off} directive.  Note these switches have no effect on how
16450 the compiler generates code to handle function calls via function
16451 pointers.
16453 @item -msingle-pic-base
16454 @opindex msingle-pic-base
16455 Treat the register used for PIC addressing as read-only, rather than
16456 loading it in the prologue for each function.  The runtime system is
16457 responsible for initializing this register with an appropriate value
16458 before execution begins.
16460 @item -mpic-register=@var{reg}
16461 @opindex mpic-register
16462 Specify the register to be used for PIC addressing.
16463 For standard PIC base case, the default is any suitable register
16464 determined by compiler.  For single PIC base case, the default is
16465 @samp{R9} if target is EABI based or stack-checking is enabled,
16466 otherwise the default is @samp{R10}.
16468 @item -mpic-data-is-text-relative
16469 @opindex mpic-data-is-text-relative
16470 Assume that the displacement between the text and data segments is fixed
16471 at static link time.  This permits using PC-relative addressing
16472 operations to access data known to be in the data segment.  For
16473 non-VxWorks RTP targets, this option is enabled by default.  When
16474 disabled on such targets, it will enable @option{-msingle-pic-base} by
16475 default.
16477 @item -mpoke-function-name
16478 @opindex mpoke-function-name
16479 Write the name of each function into the text section, directly
16480 preceding the function prologue.  The generated code is similar to this:
16482 @smallexample
16483      t0
16484          .ascii "arm_poke_function_name", 0
16485          .align
16486      t1
16487          .word 0xff000000 + (t1 - t0)
16488      arm_poke_function_name
16489          mov     ip, sp
16490          stmfd   sp!, @{fp, ip, lr, pc@}
16491          sub     fp, ip, #4
16492 @end smallexample
16494 When performing a stack backtrace, code can inspect the value of
16495 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16496 location @code{pc - 12} and the top 8 bits are set, then we know that
16497 there is a function name embedded immediately preceding this location
16498 and has length @code{((pc[-3]) & 0xff000000)}.
16500 @item -mthumb
16501 @itemx -marm
16502 @opindex marm
16503 @opindex mthumb
16505 Select between generating code that executes in ARM and Thumb
16506 states.  The default for most configurations is to generate code
16507 that executes in ARM state, but the default can be changed by
16508 configuring GCC with the @option{--with-mode=}@var{state}
16509 configure option.
16511 You can also override the ARM and Thumb mode for each function
16512 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16513 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16515 @item -mflip-thumb 
16516 @opindex mflip-thumb
16517 Switch ARM/Thumb modes on alternating functions.
16518 This option is provided for regression testing of mixed Thumb/ARM code
16519 generation, and is not intended for ordinary use in compiling code.
16521 @item -mtpcs-frame
16522 @opindex mtpcs-frame
16523 Generate a stack frame that is compliant with the Thumb Procedure Call
16524 Standard for all non-leaf functions.  (A leaf function is one that does
16525 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16527 @item -mtpcs-leaf-frame
16528 @opindex mtpcs-leaf-frame
16529 Generate a stack frame that is compliant with the Thumb Procedure Call
16530 Standard for all leaf functions.  (A leaf function is one that does
16531 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16533 @item -mcallee-super-interworking
16534 @opindex mcallee-super-interworking
16535 Gives all externally visible functions in the file being compiled an ARM
16536 instruction set header which switches to Thumb mode before executing the
16537 rest of the function.  This allows these functions to be called from
16538 non-interworking code.  This option is not valid in AAPCS configurations
16539 because interworking is enabled by default.
16541 @item -mcaller-super-interworking
16542 @opindex mcaller-super-interworking
16543 Allows calls via function pointers (including virtual functions) to
16544 execute correctly regardless of whether the target code has been
16545 compiled for interworking or not.  There is a small overhead in the cost
16546 of executing a function pointer if this option is enabled.  This option
16547 is not valid in AAPCS configurations because interworking is enabled
16548 by default.
16550 @item -mtp=@var{name}
16551 @opindex mtp
16552 Specify the access model for the thread local storage pointer.  The valid
16553 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16554 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16555 (supported in the arm6k architecture), and @samp{auto}, which uses the
16556 best available method for the selected processor.  The default setting is
16557 @samp{auto}.
16559 @item -mtls-dialect=@var{dialect}
16560 @opindex mtls-dialect
16561 Specify the dialect to use for accessing thread local storage.  Two
16562 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16563 @samp{gnu} dialect selects the original GNU scheme for supporting
16564 local and global dynamic TLS models.  The @samp{gnu2} dialect
16565 selects the GNU descriptor scheme, which provides better performance
16566 for shared libraries.  The GNU descriptor scheme is compatible with
16567 the original scheme, but does require new assembler, linker and
16568 library support.  Initial and local exec TLS models are unaffected by
16569 this option and always use the original scheme.
16571 @item -mword-relocations
16572 @opindex mword-relocations
16573 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16574 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16575 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16576 is specified.
16578 @item -mfix-cortex-m3-ldrd
16579 @opindex mfix-cortex-m3-ldrd
16580 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16581 with overlapping destination and base registers are used.  This option avoids
16582 generating these instructions.  This option is enabled by default when
16583 @option{-mcpu=cortex-m3} is specified.
16585 @item -munaligned-access
16586 @itemx -mno-unaligned-access
16587 @opindex munaligned-access
16588 @opindex mno-unaligned-access
16589 Enables (or disables) reading and writing of 16- and 32- bit values
16590 from addresses that are not 16- or 32- bit aligned.  By default
16591 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16592 ARMv8-M Baseline architectures, and enabled for all other
16593 architectures.  If unaligned access is not enabled then words in packed
16594 data structures are accessed a byte at a time.
16596 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16597 generated object file to either true or false, depending upon the
16598 setting of this option.  If unaligned access is enabled then the
16599 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16600 defined.
16602 @item -mneon-for-64bits
16603 @opindex mneon-for-64bits
16604 Enables using Neon to handle scalar 64-bits operations. This is
16605 disabled by default since the cost of moving data from core registers
16606 to Neon is high.
16608 @item -mslow-flash-data
16609 @opindex mslow-flash-data
16610 Assume loading data from flash is slower than fetching instruction.
16611 Therefore literal load is minimized for better performance.
16612 This option is only supported when compiling for ARMv7 M-profile and
16613 off by default.
16615 @item -masm-syntax-unified
16616 @opindex masm-syntax-unified
16617 Assume inline assembler is using unified asm syntax.  The default is
16618 currently off which implies divided syntax.  This option has no impact
16619 on Thumb2. However, this may change in future releases of GCC.
16620 Divided syntax should be considered deprecated.
16622 @item -mrestrict-it
16623 @opindex mrestrict-it
16624 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16625 IT blocks can only contain a single 16-bit instruction from a select
16626 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16628 @item -mprint-tune-info
16629 @opindex mprint-tune-info
16630 Print CPU tuning information as comment in assembler file.  This is
16631 an option used only for regression testing of the compiler and not
16632 intended for ordinary use in compiling code.  This option is disabled
16633 by default.
16635 @item -mverbose-cost-dump
16636 @opindex mverbose-cost-dump
16637 Enable verbose cost model dumping in the debug dump files.  This option is
16638 provided for use in debugging the compiler.
16640 @item -mpure-code
16641 @opindex mpure-code
16642 Do not allow constant data to be placed in code sections.
16643 Additionally, when compiling for ELF object format give all text sections the
16644 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16645 is only available when generating non-pic code for M-profile targets with the
16646 MOVT instruction.
16648 @item -mcmse
16649 @opindex mcmse
16650 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16651 Development Tools Engineering Specification", which can be found on
16652 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16653 @end table
16655 @node AVR Options
16656 @subsection AVR Options
16657 @cindex AVR Options
16659 These options are defined for AVR implementations:
16661 @table @gcctabopt
16662 @item -mmcu=@var{mcu}
16663 @opindex mmcu
16664 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16666 The default for this option is@tie{}@samp{avr2}.
16668 GCC supports the following AVR devices and ISAs:
16670 @include avr-mmcu.texi
16672 @item -mabsdata
16673 @opindex mabsdata
16675 Assume that all data in static storage can be accessed by LDS / STS
16676 instructions.  This option has only an effect on reduced Tiny devices like
16677 ATtiny40.  See also the @code{absdata}
16678 @ref{AVR Variable Attributes,variable attribute}.
16680 @item -maccumulate-args
16681 @opindex maccumulate-args
16682 Accumulate outgoing function arguments and acquire/release the needed
16683 stack space for outgoing function arguments once in function
16684 prologue/epilogue.  Without this option, outgoing arguments are pushed
16685 before calling a function and popped afterwards.
16687 Popping the arguments after the function call can be expensive on
16688 AVR so that accumulating the stack space might lead to smaller
16689 executables because arguments need not be removed from the
16690 stack after such a function call.
16692 This option can lead to reduced code size for functions that perform
16693 several calls to functions that get their arguments on the stack like
16694 calls to printf-like functions.
16696 @item -mbranch-cost=@var{cost}
16697 @opindex mbranch-cost
16698 Set the branch costs for conditional branch instructions to
16699 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16700 integers. The default branch cost is 0.
16702 @item -mcall-prologues
16703 @opindex mcall-prologues
16704 Functions prologues/epilogues are expanded as calls to appropriate
16705 subroutines.  Code size is smaller.
16707 @item -mgas-isr-prologues
16708 @opindex mgas-isr-prologues
16709 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16710 instruction supported by GNU Binutils.
16711 If this option is on, the feature can still be disabled for individual
16712 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16713 function attribute.  This feature is activated per default
16714 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16715 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16717 @item -mint8
16718 @opindex mint8
16719 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16720 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16721 and @code{long long} is 4 bytes.  Please note that this option does not
16722 conform to the C standards, but it results in smaller code
16723 size.
16725 @item -mmain-is-OS_task
16726 @opindex mmain-is-OS_task
16727 Do not save registers in @code{main}.  The effect is the same like
16728 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16729 to @code{main}. It is activated per default if optimization is on.
16731 @item -mn-flash=@var{num}
16732 @opindex mn-flash
16733 Assume that the flash memory has a size of 
16734 @var{num} times 64@tie{}KiB.
16736 @item -mno-interrupts
16737 @opindex mno-interrupts
16738 Generated code is not compatible with hardware interrupts.
16739 Code size is smaller.
16741 @item -mrelax
16742 @opindex mrelax
16743 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16744 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16745 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16746 the assembler's command line and the @option{--relax} option to the
16747 linker's command line.
16749 Jump relaxing is performed by the linker because jump offsets are not
16750 known before code is located. Therefore, the assembler code generated by the
16751 compiler is the same, but the instructions in the executable may
16752 differ from instructions in the assembler code.
16754 Relaxing must be turned on if linker stubs are needed, see the
16755 section on @code{EIND} and linker stubs below.
16757 @item -mrmw
16758 @opindex mrmw
16759 Assume that the device supports the Read-Modify-Write
16760 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16762 @item -mshort-calls
16763 @opindex mshort-calls
16765 Assume that @code{RJMP} and @code{RCALL} can target the whole
16766 program memory.
16768 This option is used internally for multilib selection.  It is
16769 not an optimization option, and you don't need to set it by hand.
16771 @item -msp8
16772 @opindex msp8
16773 Treat the stack pointer register as an 8-bit register,
16774 i.e.@: assume the high byte of the stack pointer is zero.
16775 In general, you don't need to set this option by hand.
16777 This option is used internally by the compiler to select and
16778 build multilibs for architectures @code{avr2} and @code{avr25}.
16779 These architectures mix devices with and without @code{SPH}.
16780 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16781 the compiler driver adds or removes this option from the compiler
16782 proper's command line, because the compiler then knows if the device
16783 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16784 register or not.
16786 @item -mstrict-X
16787 @opindex mstrict-X
16788 Use address register @code{X} in a way proposed by the hardware.  This means
16789 that @code{X} is only used in indirect, post-increment or
16790 pre-decrement addressing.
16792 Without this option, the @code{X} register may be used in the same way
16793 as @code{Y} or @code{Z} which then is emulated by additional
16794 instructions.  
16795 For example, loading a value with @code{X+const} addressing with a
16796 small non-negative @code{const < 64} to a register @var{Rn} is
16797 performed as
16799 @example
16800 adiw r26, const   ; X += const
16801 ld   @var{Rn}, X        ; @var{Rn} = *X
16802 sbiw r26, const   ; X -= const
16803 @end example
16805 @item -mtiny-stack
16806 @opindex mtiny-stack
16807 Only change the lower 8@tie{}bits of the stack pointer.
16809 @item -mfract-convert-truncate
16810 @opindex mfract-convert-truncate
16811 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16813 @item -nodevicelib
16814 @opindex nodevicelib
16815 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16817 @item -Waddr-space-convert
16818 @opindex Waddr-space-convert
16819 Warn about conversions between address spaces in the case where the
16820 resulting address space is not contained in the incoming address space.
16822 @item -Wmisspelled-isr
16823 @opindex Wmisspelled-isr
16824 Warn if the ISR is misspelled, i.e. without __vector prefix.
16825 Enabled by default.
16826 @end table
16828 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16829 @cindex @code{EIND}
16830 Pointers in the implementation are 16@tie{}bits wide.
16831 The address of a function or label is represented as word address so
16832 that indirect jumps and calls can target any code address in the
16833 range of 64@tie{}Ki words.
16835 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16836 bytes of program memory space, there is a special function register called
16837 @code{EIND} that serves as most significant part of the target address
16838 when @code{EICALL} or @code{EIJMP} instructions are used.
16840 Indirect jumps and calls on these devices are handled as follows by
16841 the compiler and are subject to some limitations:
16843 @itemize @bullet
16845 @item
16846 The compiler never sets @code{EIND}.
16848 @item
16849 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16850 instructions or might read @code{EIND} directly in order to emulate an
16851 indirect call/jump by means of a @code{RET} instruction.
16853 @item
16854 The compiler assumes that @code{EIND} never changes during the startup
16855 code or during the application. In particular, @code{EIND} is not
16856 saved/restored in function or interrupt service routine
16857 prologue/epilogue.
16859 @item
16860 For indirect calls to functions and computed goto, the linker
16861 generates @emph{stubs}. Stubs are jump pads sometimes also called
16862 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16863 The stub contains a direct jump to the desired address.
16865 @item
16866 Linker relaxation must be turned on so that the linker generates
16867 the stubs correctly in all situations. See the compiler option
16868 @option{-mrelax} and the linker option @option{--relax}.
16869 There are corner cases where the linker is supposed to generate stubs
16870 but aborts without relaxation and without a helpful error message.
16872 @item
16873 The default linker script is arranged for code with @code{EIND = 0}.
16874 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16875 linker script has to be used in order to place the sections whose
16876 name start with @code{.trampolines} into the segment where @code{EIND}
16877 points to.
16879 @item
16880 The startup code from libgcc never sets @code{EIND}.
16881 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16882 For the impact of AVR-LibC on @code{EIND}, see the
16883 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16885 @item
16886 It is legitimate for user-specific startup code to set up @code{EIND}
16887 early, for example by means of initialization code located in
16888 section @code{.init3}. Such code runs prior to general startup code
16889 that initializes RAM and calls constructors, but after the bit
16890 of startup code from AVR-LibC that sets @code{EIND} to the segment
16891 where the vector table is located.
16892 @example
16893 #include <avr/io.h>
16895 static void
16896 __attribute__((section(".init3"),naked,used,no_instrument_function))
16897 init3_set_eind (void)
16899   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16900                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16902 @end example
16904 @noindent
16905 The @code{__trampolines_start} symbol is defined in the linker script.
16907 @item
16908 Stubs are generated automatically by the linker if
16909 the following two conditions are met:
16910 @itemize @minus
16912 @item The address of a label is taken by means of the @code{gs} modifier
16913 (short for @emph{generate stubs}) like so:
16914 @example
16915 LDI r24, lo8(gs(@var{func}))
16916 LDI r25, hi8(gs(@var{func}))
16917 @end example
16918 @item The final location of that label is in a code segment
16919 @emph{outside} the segment where the stubs are located.
16920 @end itemize
16922 @item
16923 The compiler emits such @code{gs} modifiers for code labels in the
16924 following situations:
16925 @itemize @minus
16926 @item Taking address of a function or code label.
16927 @item Computed goto.
16928 @item If prologue-save function is used, see @option{-mcall-prologues}
16929 command-line option.
16930 @item Switch/case dispatch tables. If you do not want such dispatch
16931 tables you can specify the @option{-fno-jump-tables} command-line option.
16932 @item C and C++ constructors/destructors called during startup/shutdown.
16933 @item If the tools hit a @code{gs()} modifier explained above.
16934 @end itemize
16936 @item
16937 Jumping to non-symbolic addresses like so is @emph{not} supported:
16939 @example
16940 int main (void)
16942     /* Call function at word address 0x2 */
16943     return ((int(*)(void)) 0x2)();
16945 @end example
16947 Instead, a stub has to be set up, i.e.@: the function has to be called
16948 through a symbol (@code{func_4} in the example):
16950 @example
16951 int main (void)
16953     extern int func_4 (void);
16955     /* Call function at byte address 0x4 */
16956     return func_4();
16958 @end example
16960 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16961 Alternatively, @code{func_4} can be defined in the linker script.
16962 @end itemize
16964 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16965 @cindex @code{RAMPD}
16966 @cindex @code{RAMPX}
16967 @cindex @code{RAMPY}
16968 @cindex @code{RAMPZ}
16969 Some AVR devices support memories larger than the 64@tie{}KiB range
16970 that can be accessed with 16-bit pointers.  To access memory locations
16971 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16972 register is used as high part of the address:
16973 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16974 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16975 register, respectively, to get a wide address. Similarly,
16976 @code{RAMPD} is used together with direct addressing.
16978 @itemize
16979 @item
16980 The startup code initializes the @code{RAMP} special function
16981 registers with zero.
16983 @item
16984 If a @ref{AVR Named Address Spaces,named address space} other than
16985 generic or @code{__flash} is used, then @code{RAMPZ} is set
16986 as needed before the operation.
16988 @item
16989 If the device supports RAM larger than 64@tie{}KiB and the compiler
16990 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16991 is reset to zero after the operation.
16993 @item
16994 If the device comes with a specific @code{RAMP} register, the ISR
16995 prologue/epilogue saves/restores that SFR and initializes it with
16996 zero in case the ISR code might (implicitly) use it.
16998 @item
16999 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17000 If you use inline assembler to read from locations outside the
17001 16-bit address range and change one of the @code{RAMP} registers,
17002 you must reset it to zero after the access.
17004 @end itemize
17006 @subsubsection AVR Built-in Macros
17008 GCC defines several built-in macros so that the user code can test
17009 for the presence or absence of features.  Almost any of the following
17010 built-in macros are deduced from device capabilities and thus
17011 triggered by the @option{-mmcu=} command-line option.
17013 For even more AVR-specific built-in macros see
17014 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17016 @table @code
17018 @item __AVR_ARCH__
17019 Build-in macro that resolves to a decimal number that identifies the
17020 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17021 Possible values are:
17023 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17024 @code{4}, @code{5}, @code{51}, @code{6}
17026 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17027 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17029 respectively and
17031 @code{100},
17032 @code{102}, @code{103}, @code{104},
17033 @code{105}, @code{106}, @code{107}
17035 for @var{mcu}=@code{avrtiny},
17036 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17037 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17038 If @var{mcu} specifies a device, this built-in macro is set
17039 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17040 defined to @code{4}.
17042 @item __AVR_@var{Device}__
17043 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17044 the device's name. For example, @option{-mmcu=atmega8} defines the
17045 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17046 @code{__AVR_ATtiny261A__}, etc.
17048 The built-in macros' names follow
17049 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17050 the device name as from the AVR user manual. The difference between
17051 @var{Device} in the built-in macro and @var{device} in
17052 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17054 If @var{device} is not a device but only a core architecture like
17055 @samp{avr51}, this macro is not defined.
17057 @item __AVR_DEVICE_NAME__
17058 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17059 the device's name. For example, with @option{-mmcu=atmega8} the macro
17060 is defined to @code{atmega8}.
17062 If @var{device} is not a device but only a core architecture like
17063 @samp{avr51}, this macro is not defined.
17065 @item __AVR_XMEGA__
17066 The device / architecture belongs to the XMEGA family of devices.
17068 @item __AVR_HAVE_ELPM__
17069 The device has the @code{ELPM} instruction.
17071 @item __AVR_HAVE_ELPMX__
17072 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17073 R@var{n},Z+} instructions.
17075 @item __AVR_HAVE_MOVW__
17076 The device has the @code{MOVW} instruction to perform 16-bit
17077 register-register moves.
17079 @item __AVR_HAVE_LPMX__
17080 The device has the @code{LPM R@var{n},Z} and
17081 @code{LPM R@var{n},Z+} instructions.
17083 @item __AVR_HAVE_MUL__
17084 The device has a hardware multiplier. 
17086 @item __AVR_HAVE_JMP_CALL__
17087 The device has the @code{JMP} and @code{CALL} instructions.
17088 This is the case for devices with more than 8@tie{}KiB of program
17089 memory.
17091 @item __AVR_HAVE_EIJMP_EICALL__
17092 @itemx __AVR_3_BYTE_PC__
17093 The device has the @code{EIJMP} and @code{EICALL} instructions.
17094 This is the case for devices with more than 128@tie{}KiB of program memory.
17095 This also means that the program counter
17096 (PC) is 3@tie{}bytes wide.
17098 @item __AVR_2_BYTE_PC__
17099 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17100 with up to 128@tie{}KiB of program memory.
17102 @item __AVR_HAVE_8BIT_SP__
17103 @itemx __AVR_HAVE_16BIT_SP__
17104 The stack pointer (SP) register is treated as 8-bit respectively
17105 16-bit register by the compiler.
17106 The definition of these macros is affected by @option{-mtiny-stack}.
17108 @item __AVR_HAVE_SPH__
17109 @itemx __AVR_SP8__
17110 The device has the SPH (high part of stack pointer) special function
17111 register or has an 8-bit stack pointer, respectively.
17112 The definition of these macros is affected by @option{-mmcu=} and
17113 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17114 by @option{-msp8}.
17116 @item __AVR_HAVE_RAMPD__
17117 @itemx __AVR_HAVE_RAMPX__
17118 @itemx __AVR_HAVE_RAMPY__
17119 @itemx __AVR_HAVE_RAMPZ__
17120 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17121 @code{RAMPZ} special function register, respectively.
17123 @item __NO_INTERRUPTS__
17124 This macro reflects the @option{-mno-interrupts} command-line option.
17126 @item __AVR_ERRATA_SKIP__
17127 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17128 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17129 instructions because of a hardware erratum.  Skip instructions are
17130 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17131 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17132 set.
17134 @item __AVR_ISA_RMW__
17135 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17137 @item __AVR_SFR_OFFSET__=@var{offset}
17138 Instructions that can address I/O special function registers directly
17139 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17140 address as if addressed by an instruction to access RAM like @code{LD}
17141 or @code{STS}. This offset depends on the device architecture and has
17142 to be subtracted from the RAM address in order to get the
17143 respective I/O@tie{}address.
17145 @item __AVR_SHORT_CALLS__
17146 The @option{-mshort-calls} command line option is set.
17148 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17149 Some devices support reading from flash memory by means of @code{LD*}
17150 instructions.  The flash memory is seen in the data address space
17151 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17152 is not defined, this feature is not available.  If defined,
17153 the address space is linear and there is no need to put
17154 @code{.rodata} into RAM.  This is handled by the default linker
17155 description file, and is currently available for
17156 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17157 there is no need to use address spaces like @code{__flash} or
17158 features like attribute @code{progmem} and @code{pgm_read_*}.
17160 @item __WITH_AVRLIBC__
17161 The compiler is configured to be used together with AVR-Libc.
17162 See the @option{--with-avrlibc} configure option.
17164 @end table
17166 @node Blackfin Options
17167 @subsection Blackfin Options
17168 @cindex Blackfin Options
17170 @table @gcctabopt
17171 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17172 @opindex mcpu=
17173 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17174 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17175 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17176 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17177 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17178 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17179 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17180 @samp{bf561}, @samp{bf592}.
17182 The optional @var{sirevision} specifies the silicon revision of the target
17183 Blackfin processor.  Any workarounds available for the targeted silicon revision
17184 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17185 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17186 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17187 hexadecimal digits representing the major and minor numbers in the silicon
17188 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17189 is not defined.  If @var{sirevision} is @samp{any}, the
17190 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17191 If this optional @var{sirevision} is not used, GCC assumes the latest known
17192 silicon revision of the targeted Blackfin processor.
17194 GCC defines a preprocessor macro for the specified @var{cpu}.
17195 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17196 provided by libgloss to be linked in if @option{-msim} is not given.
17198 Without this option, @samp{bf532} is used as the processor by default.
17200 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17201 only the preprocessor macro is defined.
17203 @item -msim
17204 @opindex msim
17205 Specifies that the program will be run on the simulator.  This causes
17206 the simulator BSP provided by libgloss to be linked in.  This option
17207 has effect only for @samp{bfin-elf} toolchain.
17208 Certain other options, such as @option{-mid-shared-library} and
17209 @option{-mfdpic}, imply @option{-msim}.
17211 @item -momit-leaf-frame-pointer
17212 @opindex momit-leaf-frame-pointer
17213 Don't keep the frame pointer in a register for leaf functions.  This
17214 avoids the instructions to save, set up and restore frame pointers and
17215 makes an extra register available in leaf functions.
17217 @item -mspecld-anomaly
17218 @opindex mspecld-anomaly
17219 When enabled, the compiler ensures that the generated code does not
17220 contain speculative loads after jump instructions. If this option is used,
17221 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17223 @item -mno-specld-anomaly
17224 @opindex mno-specld-anomaly
17225 Don't generate extra code to prevent speculative loads from occurring.
17227 @item -mcsync-anomaly
17228 @opindex mcsync-anomaly
17229 When enabled, the compiler ensures that the generated code does not
17230 contain CSYNC or SSYNC instructions too soon after conditional branches.
17231 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17233 @item -mno-csync-anomaly
17234 @opindex mno-csync-anomaly
17235 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17236 occurring too soon after a conditional branch.
17238 @item -mlow-64k
17239 @opindex mlow-64k
17240 When enabled, the compiler is free to take advantage of the knowledge that
17241 the entire program fits into the low 64k of memory.
17243 @item -mno-low-64k
17244 @opindex mno-low-64k
17245 Assume that the program is arbitrarily large.  This is the default.
17247 @item -mstack-check-l1
17248 @opindex mstack-check-l1
17249 Do stack checking using information placed into L1 scratchpad memory by the
17250 uClinux kernel.
17252 @item -mid-shared-library
17253 @opindex mid-shared-library
17254 Generate code that supports shared libraries via the library ID method.
17255 This allows for execute in place and shared libraries in an environment
17256 without virtual memory management.  This option implies @option{-fPIC}.
17257 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17259 @item -mno-id-shared-library
17260 @opindex mno-id-shared-library
17261 Generate code that doesn't assume ID-based shared libraries are being used.
17262 This is the default.
17264 @item -mleaf-id-shared-library
17265 @opindex mleaf-id-shared-library
17266 Generate code that supports shared libraries via the library ID method,
17267 but assumes that this library or executable won't link against any other
17268 ID shared libraries.  That allows the compiler to use faster code for jumps
17269 and calls.
17271 @item -mno-leaf-id-shared-library
17272 @opindex mno-leaf-id-shared-library
17273 Do not assume that the code being compiled won't link against any ID shared
17274 libraries.  Slower code is generated for jump and call insns.
17276 @item -mshared-library-id=n
17277 @opindex mshared-library-id
17278 Specifies the identification number of the ID-based shared library being
17279 compiled.  Specifying a value of 0 generates more compact code; specifying
17280 other values forces the allocation of that number to the current
17281 library but is no more space- or time-efficient than omitting this option.
17283 @item -msep-data
17284 @opindex msep-data
17285 Generate code that allows the data segment to be located in a different
17286 area of memory from the text segment.  This allows for execute in place in
17287 an environment without virtual memory management by eliminating relocations
17288 against the text section.
17290 @item -mno-sep-data
17291 @opindex mno-sep-data
17292 Generate code that assumes that the data segment follows the text segment.
17293 This is the default.
17295 @item -mlong-calls
17296 @itemx -mno-long-calls
17297 @opindex mlong-calls
17298 @opindex mno-long-calls
17299 Tells the compiler to perform function calls by first loading the
17300 address of the function into a register and then performing a subroutine
17301 call on this register.  This switch is needed if the target function
17302 lies outside of the 24-bit addressing range of the offset-based
17303 version of subroutine call instruction.
17305 This feature is not enabled by default.  Specifying
17306 @option{-mno-long-calls} restores the default behavior.  Note these
17307 switches have no effect on how the compiler generates code to handle
17308 function calls via function pointers.
17310 @item -mfast-fp
17311 @opindex mfast-fp
17312 Link with the fast floating-point library. This library relaxes some of
17313 the IEEE floating-point standard's rules for checking inputs against
17314 Not-a-Number (NAN), in the interest of performance.
17316 @item -minline-plt
17317 @opindex minline-plt
17318 Enable inlining of PLT entries in function calls to functions that are
17319 not known to bind locally.  It has no effect without @option{-mfdpic}.
17321 @item -mmulticore
17322 @opindex mmulticore
17323 Build a standalone application for multicore Blackfin processors. 
17324 This option causes proper start files and link scripts supporting 
17325 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17326 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17328 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17329 selects the one-application-per-core programming model.  Without
17330 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17331 programming model is used. In this model, the main function of Core B
17332 should be named as @code{coreb_main}.
17334 If this option is not used, the single-core application programming
17335 model is used.
17337 @item -mcorea
17338 @opindex mcorea
17339 Build a standalone application for Core A of BF561 when using
17340 the one-application-per-core programming model. Proper start files
17341 and link scripts are used to support Core A, and the macro
17342 @code{__BFIN_COREA} is defined.
17343 This option can only be used in conjunction with @option{-mmulticore}.
17345 @item -mcoreb
17346 @opindex mcoreb
17347 Build a standalone application for Core B of BF561 when using
17348 the one-application-per-core programming model. Proper start files
17349 and link scripts are used to support Core B, and the macro
17350 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17351 should be used instead of @code{main}. 
17352 This option can only be used in conjunction with @option{-mmulticore}.
17354 @item -msdram
17355 @opindex msdram
17356 Build a standalone application for SDRAM. Proper start files and
17357 link scripts are used to put the application into SDRAM, and the macro
17358 @code{__BFIN_SDRAM} is defined.
17359 The loader should initialize SDRAM before loading the application.
17361 @item -micplb
17362 @opindex micplb
17363 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17364 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17365 are enabled; for standalone applications the default is off.
17366 @end table
17368 @node C6X Options
17369 @subsection C6X Options
17370 @cindex C6X Options
17372 @table @gcctabopt
17373 @item -march=@var{name}
17374 @opindex march
17375 This specifies the name of the target architecture.  GCC uses this
17376 name to determine what kind of instructions it can emit when generating
17377 assembly code.  Permissible names are: @samp{c62x},
17378 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17380 @item -mbig-endian
17381 @opindex mbig-endian
17382 Generate code for a big-endian target.
17384 @item -mlittle-endian
17385 @opindex mlittle-endian
17386 Generate code for a little-endian target.  This is the default.
17388 @item -msim
17389 @opindex msim
17390 Choose startup files and linker script suitable for the simulator.
17392 @item -msdata=default
17393 @opindex msdata=default
17394 Put small global and static data in the @code{.neardata} section,
17395 which is pointed to by register @code{B14}.  Put small uninitialized
17396 global and static data in the @code{.bss} section, which is adjacent
17397 to the @code{.neardata} section.  Put small read-only data into the
17398 @code{.rodata} section.  The corresponding sections used for large
17399 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17401 @item -msdata=all
17402 @opindex msdata=all
17403 Put all data, not just small objects, into the sections reserved for
17404 small data, and use addressing relative to the @code{B14} register to
17405 access them.
17407 @item -msdata=none
17408 @opindex msdata=none
17409 Make no use of the sections reserved for small data, and use absolute
17410 addresses to access all data.  Put all initialized global and static
17411 data in the @code{.fardata} section, and all uninitialized data in the
17412 @code{.far} section.  Put all constant data into the @code{.const}
17413 section.
17414 @end table
17416 @node CRIS Options
17417 @subsection CRIS Options
17418 @cindex CRIS Options
17420 These options are defined specifically for the CRIS ports.
17422 @table @gcctabopt
17423 @item -march=@var{architecture-type}
17424 @itemx -mcpu=@var{architecture-type}
17425 @opindex march
17426 @opindex mcpu
17427 Generate code for the specified architecture.  The choices for
17428 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17429 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17430 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17431 @samp{v10}.
17433 @item -mtune=@var{architecture-type}
17434 @opindex mtune
17435 Tune to @var{architecture-type} everything applicable about the generated
17436 code, except for the ABI and the set of available instructions.  The
17437 choices for @var{architecture-type} are the same as for
17438 @option{-march=@var{architecture-type}}.
17440 @item -mmax-stack-frame=@var{n}
17441 @opindex mmax-stack-frame
17442 Warn when the stack frame of a function exceeds @var{n} bytes.
17444 @item -metrax4
17445 @itemx -metrax100
17446 @opindex metrax4
17447 @opindex metrax100
17448 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17449 @option{-march=v3} and @option{-march=v8} respectively.
17451 @item -mmul-bug-workaround
17452 @itemx -mno-mul-bug-workaround
17453 @opindex mmul-bug-workaround
17454 @opindex mno-mul-bug-workaround
17455 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17456 models where it applies.  This option is active by default.
17458 @item -mpdebug
17459 @opindex mpdebug
17460 Enable CRIS-specific verbose debug-related information in the assembly
17461 code.  This option also has the effect of turning off the @samp{#NO_APP}
17462 formatted-code indicator to the assembler at the beginning of the
17463 assembly file.
17465 @item -mcc-init
17466 @opindex mcc-init
17467 Do not use condition-code results from previous instruction; always emit
17468 compare and test instructions before use of condition codes.
17470 @item -mno-side-effects
17471 @opindex mno-side-effects
17472 Do not emit instructions with side effects in addressing modes other than
17473 post-increment.
17475 @item -mstack-align
17476 @itemx -mno-stack-align
17477 @itemx -mdata-align
17478 @itemx -mno-data-align
17479 @itemx -mconst-align
17480 @itemx -mno-const-align
17481 @opindex mstack-align
17482 @opindex mno-stack-align
17483 @opindex mdata-align
17484 @opindex mno-data-align
17485 @opindex mconst-align
17486 @opindex mno-const-align
17487 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17488 stack frame, individual data and constants to be aligned for the maximum
17489 single data access size for the chosen CPU model.  The default is to
17490 arrange for 32-bit alignment.  ABI details such as structure layout are
17491 not affected by these options.
17493 @item -m32-bit
17494 @itemx -m16-bit
17495 @itemx -m8-bit
17496 @opindex m32-bit
17497 @opindex m16-bit
17498 @opindex m8-bit
17499 Similar to the stack- data- and const-align options above, these options
17500 arrange for stack frame, writable data and constants to all be 32-bit,
17501 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17503 @item -mno-prologue-epilogue
17504 @itemx -mprologue-epilogue
17505 @opindex mno-prologue-epilogue
17506 @opindex mprologue-epilogue
17507 With @option{-mno-prologue-epilogue}, the normal function prologue and
17508 epilogue which set up the stack frame are omitted and no return
17509 instructions or return sequences are generated in the code.  Use this
17510 option only together with visual inspection of the compiled code: no
17511 warnings or errors are generated when call-saved registers must be saved,
17512 or storage for local variables needs to be allocated.
17514 @item -mno-gotplt
17515 @itemx -mgotplt
17516 @opindex mno-gotplt
17517 @opindex mgotplt
17518 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17519 instruction sequences that load addresses for functions from the PLT part
17520 of the GOT rather than (traditional on other architectures) calls to the
17521 PLT@.  The default is @option{-mgotplt}.
17523 @item -melf
17524 @opindex melf
17525 Legacy no-op option only recognized with the cris-axis-elf and
17526 cris-axis-linux-gnu targets.
17528 @item -mlinux
17529 @opindex mlinux
17530 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17532 @item -sim
17533 @opindex sim
17534 This option, recognized for the cris-axis-elf, arranges
17535 to link with input-output functions from a simulator library.  Code,
17536 initialized data and zero-initialized data are allocated consecutively.
17538 @item -sim2
17539 @opindex sim2
17540 Like @option{-sim}, but pass linker options to locate initialized data at
17541 0x40000000 and zero-initialized data at 0x80000000.
17542 @end table
17544 @node CR16 Options
17545 @subsection CR16 Options
17546 @cindex CR16 Options
17548 These options are defined specifically for the CR16 ports.
17550 @table @gcctabopt
17552 @item -mmac
17553 @opindex mmac
17554 Enable the use of multiply-accumulate instructions. Disabled by default.
17556 @item -mcr16cplus
17557 @itemx -mcr16c
17558 @opindex mcr16cplus
17559 @opindex mcr16c
17560 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17561 is default.
17563 @item -msim
17564 @opindex msim
17565 Links the library libsim.a which is in compatible with simulator. Applicable
17566 to ELF compiler only.
17568 @item -mint32
17569 @opindex mint32
17570 Choose integer type as 32-bit wide.
17572 @item -mbit-ops
17573 @opindex mbit-ops
17574 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17576 @item -mdata-model=@var{model}
17577 @opindex mdata-model
17578 Choose a data model. The choices for @var{model} are @samp{near},
17579 @samp{far} or @samp{medium}. @samp{medium} is default.
17580 However, @samp{far} is not valid with @option{-mcr16c}, as the
17581 CR16C architecture does not support the far data model.
17582 @end table
17584 @node Darwin Options
17585 @subsection Darwin Options
17586 @cindex Darwin options
17588 These options are defined for all architectures running the Darwin operating
17589 system.
17591 FSF GCC on Darwin does not create ``fat'' object files; it creates
17592 an object file for the single architecture that GCC was built to
17593 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17594 @option{-arch} options are used; it does so by running the compiler or
17595 linker multiple times and joining the results together with
17596 @file{lipo}.
17598 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17599 @samp{i686}) is determined by the flags that specify the ISA
17600 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17601 @option{-force_cpusubtype_ALL} option can be used to override this.
17603 The Darwin tools vary in their behavior when presented with an ISA
17604 mismatch.  The assembler, @file{as}, only permits instructions to
17605 be used that are valid for the subtype of the file it is generating,
17606 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17607 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17608 and prints an error if asked to create a shared library with a less
17609 restrictive subtype than its input files (for instance, trying to put
17610 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17611 for executables, @command{ld}, quietly gives the executable the most
17612 restrictive subtype of any of its input files.
17614 @table @gcctabopt
17615 @item -F@var{dir}
17616 @opindex F
17617 Add the framework directory @var{dir} to the head of the list of
17618 directories to be searched for header files.  These directories are
17619 interleaved with those specified by @option{-I} options and are
17620 scanned in a left-to-right order.
17622 A framework directory is a directory with frameworks in it.  A
17623 framework is a directory with a @file{Headers} and/or
17624 @file{PrivateHeaders} directory contained directly in it that ends
17625 in @file{.framework}.  The name of a framework is the name of this
17626 directory excluding the @file{.framework}.  Headers associated with
17627 the framework are found in one of those two directories, with
17628 @file{Headers} being searched first.  A subframework is a framework
17629 directory that is in a framework's @file{Frameworks} directory.
17630 Includes of subframework headers can only appear in a header of a
17631 framework that contains the subframework, or in a sibling subframework
17632 header.  Two subframeworks are siblings if they occur in the same
17633 framework.  A subframework should not have the same name as a
17634 framework; a warning is issued if this is violated.  Currently a
17635 subframework cannot have subframeworks; in the future, the mechanism
17636 may be extended to support this.  The standard frameworks can be found
17637 in @file{/System/Library/Frameworks} and
17638 @file{/Library/Frameworks}.  An example include looks like
17639 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17640 the name of the framework and @file{header.h} is found in the
17641 @file{PrivateHeaders} or @file{Headers} directory.
17643 @item -iframework@var{dir}
17644 @opindex iframework
17645 Like @option{-F} except the directory is a treated as a system
17646 directory.  The main difference between this @option{-iframework} and
17647 @option{-F} is that with @option{-iframework} the compiler does not
17648 warn about constructs contained within header files found via
17649 @var{dir}.  This option is valid only for the C family of languages.
17651 @item -gused
17652 @opindex gused
17653 Emit debugging information for symbols that are used.  For stabs
17654 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17655 This is by default ON@.
17657 @item -gfull
17658 @opindex gfull
17659 Emit debugging information for all symbols and types.
17661 @item -mmacosx-version-min=@var{version}
17662 The earliest version of MacOS X that this executable will run on
17663 is @var{version}.  Typical values of @var{version} include @code{10.1},
17664 @code{10.2}, and @code{10.3.9}.
17666 If the compiler was built to use the system's headers by default,
17667 then the default for this option is the system version on which the
17668 compiler is running, otherwise the default is to make choices that
17669 are compatible with as many systems and code bases as possible.
17671 @item -mkernel
17672 @opindex mkernel
17673 Enable kernel development mode.  The @option{-mkernel} option sets
17674 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17675 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17676 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17677 applicable.  This mode also sets @option{-mno-altivec},
17678 @option{-msoft-float}, @option{-fno-builtin} and
17679 @option{-mlong-branch} for PowerPC targets.
17681 @item -mone-byte-bool
17682 @opindex mone-byte-bool
17683 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17684 By default @code{sizeof(bool)} is @code{4} when compiling for
17685 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17686 option has no effect on x86.
17688 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17689 to generate code that is not binary compatible with code generated
17690 without that switch.  Using this switch may require recompiling all
17691 other modules in a program, including system libraries.  Use this
17692 switch to conform to a non-default data model.
17694 @item -mfix-and-continue
17695 @itemx -ffix-and-continue
17696 @itemx -findirect-data
17697 @opindex mfix-and-continue
17698 @opindex ffix-and-continue
17699 @opindex findirect-data
17700 Generate code suitable for fast turnaround development, such as to
17701 allow GDB to dynamically load @file{.o} files into already-running
17702 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17703 are provided for backwards compatibility.
17705 @item -all_load
17706 @opindex all_load
17707 Loads all members of static archive libraries.
17708 See man ld(1) for more information.
17710 @item -arch_errors_fatal
17711 @opindex arch_errors_fatal
17712 Cause the errors having to do with files that have the wrong architecture
17713 to be fatal.
17715 @item -bind_at_load
17716 @opindex bind_at_load
17717 Causes the output file to be marked such that the dynamic linker will
17718 bind all undefined references when the file is loaded or launched.
17720 @item -bundle
17721 @opindex bundle
17722 Produce a Mach-o bundle format file.
17723 See man ld(1) for more information.
17725 @item -bundle_loader @var{executable}
17726 @opindex bundle_loader
17727 This option specifies the @var{executable} that will load the build
17728 output file being linked.  See man ld(1) for more information.
17730 @item -dynamiclib
17731 @opindex dynamiclib
17732 When passed this option, GCC produces a dynamic library instead of
17733 an executable when linking, using the Darwin @file{libtool} command.
17735 @item -force_cpusubtype_ALL
17736 @opindex force_cpusubtype_ALL
17737 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17738 one controlled by the @option{-mcpu} or @option{-march} option.
17740 @item -allowable_client  @var{client_name}
17741 @itemx -client_name
17742 @itemx -compatibility_version
17743 @itemx -current_version
17744 @itemx -dead_strip
17745 @itemx -dependency-file
17746 @itemx -dylib_file
17747 @itemx -dylinker_install_name
17748 @itemx -dynamic
17749 @itemx -exported_symbols_list
17750 @itemx -filelist
17751 @need 800
17752 @itemx -flat_namespace
17753 @itemx -force_flat_namespace
17754 @itemx -headerpad_max_install_names
17755 @itemx -image_base
17756 @itemx -init
17757 @itemx -install_name
17758 @itemx -keep_private_externs
17759 @itemx -multi_module
17760 @itemx -multiply_defined
17761 @itemx -multiply_defined_unused
17762 @need 800
17763 @itemx -noall_load
17764 @itemx -no_dead_strip_inits_and_terms
17765 @itemx -nofixprebinding
17766 @itemx -nomultidefs
17767 @itemx -noprebind
17768 @itemx -noseglinkedit
17769 @itemx -pagezero_size
17770 @itemx -prebind
17771 @itemx -prebind_all_twolevel_modules
17772 @itemx -private_bundle
17773 @need 800
17774 @itemx -read_only_relocs
17775 @itemx -sectalign
17776 @itemx -sectobjectsymbols
17777 @itemx -whyload
17778 @itemx -seg1addr
17779 @itemx -sectcreate
17780 @itemx -sectobjectsymbols
17781 @itemx -sectorder
17782 @itemx -segaddr
17783 @itemx -segs_read_only_addr
17784 @need 800
17785 @itemx -segs_read_write_addr
17786 @itemx -seg_addr_table
17787 @itemx -seg_addr_table_filename
17788 @itemx -seglinkedit
17789 @itemx -segprot
17790 @itemx -segs_read_only_addr
17791 @itemx -segs_read_write_addr
17792 @itemx -single_module
17793 @itemx -static
17794 @itemx -sub_library
17795 @need 800
17796 @itemx -sub_umbrella
17797 @itemx -twolevel_namespace
17798 @itemx -umbrella
17799 @itemx -undefined
17800 @itemx -unexported_symbols_list
17801 @itemx -weak_reference_mismatches
17802 @itemx -whatsloaded
17803 @opindex allowable_client
17804 @opindex client_name
17805 @opindex compatibility_version
17806 @opindex current_version
17807 @opindex dead_strip
17808 @opindex dependency-file
17809 @opindex dylib_file
17810 @opindex dylinker_install_name
17811 @opindex dynamic
17812 @opindex exported_symbols_list
17813 @opindex filelist
17814 @opindex flat_namespace
17815 @opindex force_flat_namespace
17816 @opindex headerpad_max_install_names
17817 @opindex image_base
17818 @opindex init
17819 @opindex install_name
17820 @opindex keep_private_externs
17821 @opindex multi_module
17822 @opindex multiply_defined
17823 @opindex multiply_defined_unused
17824 @opindex noall_load
17825 @opindex no_dead_strip_inits_and_terms
17826 @opindex nofixprebinding
17827 @opindex nomultidefs
17828 @opindex noprebind
17829 @opindex noseglinkedit
17830 @opindex pagezero_size
17831 @opindex prebind
17832 @opindex prebind_all_twolevel_modules
17833 @opindex private_bundle
17834 @opindex read_only_relocs
17835 @opindex sectalign
17836 @opindex sectobjectsymbols
17837 @opindex whyload
17838 @opindex seg1addr
17839 @opindex sectcreate
17840 @opindex sectobjectsymbols
17841 @opindex sectorder
17842 @opindex segaddr
17843 @opindex segs_read_only_addr
17844 @opindex segs_read_write_addr
17845 @opindex seg_addr_table
17846 @opindex seg_addr_table_filename
17847 @opindex seglinkedit
17848 @opindex segprot
17849 @opindex segs_read_only_addr
17850 @opindex segs_read_write_addr
17851 @opindex single_module
17852 @opindex static
17853 @opindex sub_library
17854 @opindex sub_umbrella
17855 @opindex twolevel_namespace
17856 @opindex umbrella
17857 @opindex undefined
17858 @opindex unexported_symbols_list
17859 @opindex weak_reference_mismatches
17860 @opindex whatsloaded
17861 These options are passed to the Darwin linker.  The Darwin linker man page
17862 describes them in detail.
17863 @end table
17865 @node DEC Alpha Options
17866 @subsection DEC Alpha Options
17868 These @samp{-m} options are defined for the DEC Alpha implementations:
17870 @table @gcctabopt
17871 @item -mno-soft-float
17872 @itemx -msoft-float
17873 @opindex mno-soft-float
17874 @opindex msoft-float
17875 Use (do not use) the hardware floating-point instructions for
17876 floating-point operations.  When @option{-msoft-float} is specified,
17877 functions in @file{libgcc.a} are used to perform floating-point
17878 operations.  Unless they are replaced by routines that emulate the
17879 floating-point operations, or compiled in such a way as to call such
17880 emulations routines, these routines issue floating-point
17881 operations.   If you are compiling for an Alpha without floating-point
17882 operations, you must ensure that the library is built so as not to call
17883 them.
17885 Note that Alpha implementations without floating-point operations are
17886 required to have floating-point registers.
17888 @item -mfp-reg
17889 @itemx -mno-fp-regs
17890 @opindex mfp-reg
17891 @opindex mno-fp-regs
17892 Generate code that uses (does not use) the floating-point register set.
17893 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17894 register set is not used, floating-point operands are passed in integer
17895 registers as if they were integers and floating-point results are passed
17896 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17897 so any function with a floating-point argument or return value called by code
17898 compiled with @option{-mno-fp-regs} must also be compiled with that
17899 option.
17901 A typical use of this option is building a kernel that does not use,
17902 and hence need not save and restore, any floating-point registers.
17904 @item -mieee
17905 @opindex mieee
17906 The Alpha architecture implements floating-point hardware optimized for
17907 maximum performance.  It is mostly compliant with the IEEE floating-point
17908 standard.  However, for full compliance, software assistance is
17909 required.  This option generates code fully IEEE-compliant code
17910 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17911 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17912 defined during compilation.  The resulting code is less efficient but is
17913 able to correctly support denormalized numbers and exceptional IEEE
17914 values such as not-a-number and plus/minus infinity.  Other Alpha
17915 compilers call this option @option{-ieee_with_no_inexact}.
17917 @item -mieee-with-inexact
17918 @opindex mieee-with-inexact
17919 This is like @option{-mieee} except the generated code also maintains
17920 the IEEE @var{inexact-flag}.  Turning on this option causes the
17921 generated code to implement fully-compliant IEEE math.  In addition to
17922 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17923 macro.  On some Alpha implementations the resulting code may execute
17924 significantly slower than the code generated by default.  Since there is
17925 very little code that depends on the @var{inexact-flag}, you should
17926 normally not specify this option.  Other Alpha compilers call this
17927 option @option{-ieee_with_inexact}.
17929 @item -mfp-trap-mode=@var{trap-mode}
17930 @opindex mfp-trap-mode
17931 This option controls what floating-point related traps are enabled.
17932 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17933 The trap mode can be set to one of four values:
17935 @table @samp
17936 @item n
17937 This is the default (normal) setting.  The only traps that are enabled
17938 are the ones that cannot be disabled in software (e.g., division by zero
17939 trap).
17941 @item u
17942 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17943 as well.
17945 @item su
17946 Like @samp{u}, but the instructions are marked to be safe for software
17947 completion (see Alpha architecture manual for details).
17949 @item sui
17950 Like @samp{su}, but inexact traps are enabled as well.
17951 @end table
17953 @item -mfp-rounding-mode=@var{rounding-mode}
17954 @opindex mfp-rounding-mode
17955 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17956 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17959 @table @samp
17960 @item n
17961 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17962 the nearest machine number or towards the even machine number in case
17963 of a tie.
17965 @item m
17966 Round towards minus infinity.
17968 @item c
17969 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17971 @item d
17972 Dynamic rounding mode.  A field in the floating-point control register
17973 (@var{fpcr}, see Alpha architecture reference manual) controls the
17974 rounding mode in effect.  The C library initializes this register for
17975 rounding towards plus infinity.  Thus, unless your program modifies the
17976 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17977 @end table
17979 @item -mtrap-precision=@var{trap-precision}
17980 @opindex mtrap-precision
17981 In the Alpha architecture, floating-point traps are imprecise.  This
17982 means without software assistance it is impossible to recover from a
17983 floating trap and program execution normally needs to be terminated.
17984 GCC can generate code that can assist operating system trap handlers
17985 in determining the exact location that caused a floating-point trap.
17986 Depending on the requirements of an application, different levels of
17987 precisions can be selected:
17989 @table @samp
17990 @item p
17991 Program precision.  This option is the default and means a trap handler
17992 can only identify which program caused a floating-point exception.
17994 @item f
17995 Function precision.  The trap handler can determine the function that
17996 caused a floating-point exception.
17998 @item i
17999 Instruction precision.  The trap handler can determine the exact
18000 instruction that caused a floating-point exception.
18001 @end table
18003 Other Alpha compilers provide the equivalent options called
18004 @option{-scope_safe} and @option{-resumption_safe}.
18006 @item -mieee-conformant
18007 @opindex mieee-conformant
18008 This option marks the generated code as IEEE conformant.  You must not
18009 use this option unless you also specify @option{-mtrap-precision=i} and either
18010 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18011 is to emit the line @samp{.eflag 48} in the function prologue of the
18012 generated assembly file.
18014 @item -mbuild-constants
18015 @opindex mbuild-constants
18016 Normally GCC examines a 32- or 64-bit integer constant to
18017 see if it can construct it from smaller constants in two or three
18018 instructions.  If it cannot, it outputs the constant as a literal and
18019 generates code to load it from the data segment at run time.
18021 Use this option to require GCC to construct @emph{all} integer constants
18022 using code, even if it takes more instructions (the maximum is six).
18024 You typically use this option to build a shared library dynamic
18025 loader.  Itself a shared library, it must relocate itself in memory
18026 before it can find the variables and constants in its own data segment.
18028 @item -mbwx
18029 @itemx -mno-bwx
18030 @itemx -mcix
18031 @itemx -mno-cix
18032 @itemx -mfix
18033 @itemx -mno-fix
18034 @itemx -mmax
18035 @itemx -mno-max
18036 @opindex mbwx
18037 @opindex mno-bwx
18038 @opindex mcix
18039 @opindex mno-cix
18040 @opindex mfix
18041 @opindex mno-fix
18042 @opindex mmax
18043 @opindex mno-max
18044 Indicate whether GCC should generate code to use the optional BWX,
18045 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18046 sets supported by the CPU type specified via @option{-mcpu=} option or that
18047 of the CPU on which GCC was built if none is specified.
18049 @item -mfloat-vax
18050 @itemx -mfloat-ieee
18051 @opindex mfloat-vax
18052 @opindex mfloat-ieee
18053 Generate code that uses (does not use) VAX F and G floating-point
18054 arithmetic instead of IEEE single and double precision.
18056 @item -mexplicit-relocs
18057 @itemx -mno-explicit-relocs
18058 @opindex mexplicit-relocs
18059 @opindex mno-explicit-relocs
18060 Older Alpha assemblers provided no way to generate symbol relocations
18061 except via assembler macros.  Use of these macros does not allow
18062 optimal instruction scheduling.  GNU binutils as of version 2.12
18063 supports a new syntax that allows the compiler to explicitly mark
18064 which relocations should apply to which instructions.  This option
18065 is mostly useful for debugging, as GCC detects the capabilities of
18066 the assembler when it is built and sets the default accordingly.
18068 @item -msmall-data
18069 @itemx -mlarge-data
18070 @opindex msmall-data
18071 @opindex mlarge-data
18072 When @option{-mexplicit-relocs} is in effect, static data is
18073 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18074 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18075 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18076 16-bit relocations off of the @code{$gp} register.  This limits the
18077 size of the small data area to 64KB, but allows the variables to be
18078 directly accessed via a single instruction.
18080 The default is @option{-mlarge-data}.  With this option the data area
18081 is limited to just below 2GB@.  Programs that require more than 2GB of
18082 data must use @code{malloc} or @code{mmap} to allocate the data in the
18083 heap instead of in the program's data segment.
18085 When generating code for shared libraries, @option{-fpic} implies
18086 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18088 @item -msmall-text
18089 @itemx -mlarge-text
18090 @opindex msmall-text
18091 @opindex mlarge-text
18092 When @option{-msmall-text} is used, the compiler assumes that the
18093 code of the entire program (or shared library) fits in 4MB, and is
18094 thus reachable with a branch instruction.  When @option{-msmall-data}
18095 is used, the compiler can assume that all local symbols share the
18096 same @code{$gp} value, and thus reduce the number of instructions
18097 required for a function call from 4 to 1.
18099 The default is @option{-mlarge-text}.
18101 @item -mcpu=@var{cpu_type}
18102 @opindex mcpu
18103 Set the instruction set and instruction scheduling parameters for
18104 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18105 style name or the corresponding chip number.  GCC supports scheduling
18106 parameters for the EV4, EV5 and EV6 family of processors and
18107 chooses the default values for the instruction set from the processor
18108 you specify.  If you do not specify a processor type, GCC defaults
18109 to the processor on which the compiler was built.
18111 Supported values for @var{cpu_type} are
18113 @table @samp
18114 @item ev4
18115 @itemx ev45
18116 @itemx 21064
18117 Schedules as an EV4 and has no instruction set extensions.
18119 @item ev5
18120 @itemx 21164
18121 Schedules as an EV5 and has no instruction set extensions.
18123 @item ev56
18124 @itemx 21164a
18125 Schedules as an EV5 and supports the BWX extension.
18127 @item pca56
18128 @itemx 21164pc
18129 @itemx 21164PC
18130 Schedules as an EV5 and supports the BWX and MAX extensions.
18132 @item ev6
18133 @itemx 21264
18134 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18136 @item ev67
18137 @itemx 21264a
18138 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18139 @end table
18141 Native toolchains also support the value @samp{native},
18142 which selects the best architecture option for the host processor.
18143 @option{-mcpu=native} has no effect if GCC does not recognize
18144 the processor.
18146 @item -mtune=@var{cpu_type}
18147 @opindex mtune
18148 Set only the instruction scheduling parameters for machine type
18149 @var{cpu_type}.  The instruction set is not changed.
18151 Native toolchains also support the value @samp{native},
18152 which selects the best architecture option for the host processor.
18153 @option{-mtune=native} has no effect if GCC does not recognize
18154 the processor.
18156 @item -mmemory-latency=@var{time}
18157 @opindex mmemory-latency
18158 Sets the latency the scheduler should assume for typical memory
18159 references as seen by the application.  This number is highly
18160 dependent on the memory access patterns used by the application
18161 and the size of the external cache on the machine.
18163 Valid options for @var{time} are
18165 @table @samp
18166 @item @var{number}
18167 A decimal number representing clock cycles.
18169 @item L1
18170 @itemx L2
18171 @itemx L3
18172 @itemx main
18173 The compiler contains estimates of the number of clock cycles for
18174 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18175 (also called Dcache, Scache, and Bcache), as well as to main memory.
18176 Note that L3 is only valid for EV5.
18178 @end table
18179 @end table
18181 @node FR30 Options
18182 @subsection FR30 Options
18183 @cindex FR30 Options
18185 These options are defined specifically for the FR30 port.
18187 @table @gcctabopt
18189 @item -msmall-model
18190 @opindex msmall-model
18191 Use the small address space model.  This can produce smaller code, but
18192 it does assume that all symbolic values and addresses fit into a
18193 20-bit range.
18195 @item -mno-lsim
18196 @opindex mno-lsim
18197 Assume that runtime support has been provided and so there is no need
18198 to include the simulator library (@file{libsim.a}) on the linker
18199 command line.
18201 @end table
18203 @node FT32 Options
18204 @subsection FT32 Options
18205 @cindex FT32 Options
18207 These options are defined specifically for the FT32 port.
18209 @table @gcctabopt
18211 @item -msim
18212 @opindex msim
18213 Specifies that the program will be run on the simulator.  This causes
18214 an alternate runtime startup and library to be linked.
18215 You must not use this option when generating programs that will run on
18216 real hardware; you must provide your own runtime library for whatever
18217 I/O functions are needed.
18219 @item -mlra
18220 @opindex mlra
18221 Enable Local Register Allocation.  This is still experimental for FT32,
18222 so by default the compiler uses standard reload.
18224 @item -mnodiv
18225 @opindex mnodiv
18226 Do not use div and mod instructions.
18228 @item -mft32b
18229 @opindex mft32b
18230 Enable use of the extended instructions of the FT32B processor.
18232 @item -mcompress
18233 @opindex mcompress
18234 Compress all code using the Ft32B code compression scheme.
18236 @item -mnopm
18237 @opindex  mnopm
18238 Do not generate code that reads program memory.
18240 @end table
18242 @node FRV Options
18243 @subsection FRV Options
18244 @cindex FRV Options
18246 @table @gcctabopt
18247 @item -mgpr-32
18248 @opindex mgpr-32
18250 Only use the first 32 general-purpose registers.
18252 @item -mgpr-64
18253 @opindex mgpr-64
18255 Use all 64 general-purpose registers.
18257 @item -mfpr-32
18258 @opindex mfpr-32
18260 Use only the first 32 floating-point registers.
18262 @item -mfpr-64
18263 @opindex mfpr-64
18265 Use all 64 floating-point registers.
18267 @item -mhard-float
18268 @opindex mhard-float
18270 Use hardware instructions for floating-point operations.
18272 @item -msoft-float
18273 @opindex msoft-float
18275 Use library routines for floating-point operations.
18277 @item -malloc-cc
18278 @opindex malloc-cc
18280 Dynamically allocate condition code registers.
18282 @item -mfixed-cc
18283 @opindex mfixed-cc
18285 Do not try to dynamically allocate condition code registers, only
18286 use @code{icc0} and @code{fcc0}.
18288 @item -mdword
18289 @opindex mdword
18291 Change ABI to use double word insns.
18293 @item -mno-dword
18294 @opindex mno-dword
18296 Do not use double word instructions.
18298 @item -mdouble
18299 @opindex mdouble
18301 Use floating-point double instructions.
18303 @item -mno-double
18304 @opindex mno-double
18306 Do not use floating-point double instructions.
18308 @item -mmedia
18309 @opindex mmedia
18311 Use media instructions.
18313 @item -mno-media
18314 @opindex mno-media
18316 Do not use media instructions.
18318 @item -mmuladd
18319 @opindex mmuladd
18321 Use multiply and add/subtract instructions.
18323 @item -mno-muladd
18324 @opindex mno-muladd
18326 Do not use multiply and add/subtract instructions.
18328 @item -mfdpic
18329 @opindex mfdpic
18331 Select the FDPIC ABI, which uses function descriptors to represent
18332 pointers to functions.  Without any PIC/PIE-related options, it
18333 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18334 assumes GOT entries and small data are within a 12-bit range from the
18335 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18336 are computed with 32 bits.
18337 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18339 @item -minline-plt
18340 @opindex minline-plt
18342 Enable inlining of PLT entries in function calls to functions that are
18343 not known to bind locally.  It has no effect without @option{-mfdpic}.
18344 It's enabled by default if optimizing for speed and compiling for
18345 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18346 optimization option such as @option{-O3} or above is present in the
18347 command line.
18349 @item -mTLS
18350 @opindex mTLS
18352 Assume a large TLS segment when generating thread-local code.
18354 @item -mtls
18355 @opindex mtls
18357 Do not assume a large TLS segment when generating thread-local code.
18359 @item -mgprel-ro
18360 @opindex mgprel-ro
18362 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18363 that is known to be in read-only sections.  It's enabled by default,
18364 except for @option{-fpic} or @option{-fpie}: even though it may help
18365 make the global offset table smaller, it trades 1 instruction for 4.
18366 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18367 one of which may be shared by multiple symbols, and it avoids the need
18368 for a GOT entry for the referenced symbol, so it's more likely to be a
18369 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18371 @item -multilib-library-pic
18372 @opindex multilib-library-pic
18374 Link with the (library, not FD) pic libraries.  It's implied by
18375 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18376 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18377 it explicitly.
18379 @item -mlinked-fp
18380 @opindex mlinked-fp
18382 Follow the EABI requirement of always creating a frame pointer whenever
18383 a stack frame is allocated.  This option is enabled by default and can
18384 be disabled with @option{-mno-linked-fp}.
18386 @item -mlong-calls
18387 @opindex mlong-calls
18389 Use indirect addressing to call functions outside the current
18390 compilation unit.  This allows the functions to be placed anywhere
18391 within the 32-bit address space.
18393 @item -malign-labels
18394 @opindex malign-labels
18396 Try to align labels to an 8-byte boundary by inserting NOPs into the
18397 previous packet.  This option only has an effect when VLIW packing
18398 is enabled.  It doesn't create new packets; it merely adds NOPs to
18399 existing ones.
18401 @item -mlibrary-pic
18402 @opindex mlibrary-pic
18404 Generate position-independent EABI code.
18406 @item -macc-4
18407 @opindex macc-4
18409 Use only the first four media accumulator registers.
18411 @item -macc-8
18412 @opindex macc-8
18414 Use all eight media accumulator registers.
18416 @item -mpack
18417 @opindex mpack
18419 Pack VLIW instructions.
18421 @item -mno-pack
18422 @opindex mno-pack
18424 Do not pack VLIW instructions.
18426 @item -mno-eflags
18427 @opindex mno-eflags
18429 Do not mark ABI switches in e_flags.
18431 @item -mcond-move
18432 @opindex mcond-move
18434 Enable the use of conditional-move instructions (default).
18436 This switch is mainly for debugging the compiler and will likely be removed
18437 in a future version.
18439 @item -mno-cond-move
18440 @opindex mno-cond-move
18442 Disable the use of conditional-move instructions.
18444 This switch is mainly for debugging the compiler and will likely be removed
18445 in a future version.
18447 @item -mscc
18448 @opindex mscc
18450 Enable the use of conditional set instructions (default).
18452 This switch is mainly for debugging the compiler and will likely be removed
18453 in a future version.
18455 @item -mno-scc
18456 @opindex mno-scc
18458 Disable the use of conditional set instructions.
18460 This switch is mainly for debugging the compiler and will likely be removed
18461 in a future version.
18463 @item -mcond-exec
18464 @opindex mcond-exec
18466 Enable the use of conditional execution (default).
18468 This switch is mainly for debugging the compiler and will likely be removed
18469 in a future version.
18471 @item -mno-cond-exec
18472 @opindex mno-cond-exec
18474 Disable the use of conditional execution.
18476 This switch is mainly for debugging the compiler and will likely be removed
18477 in a future version.
18479 @item -mvliw-branch
18480 @opindex mvliw-branch
18482 Run a pass to pack branches into VLIW instructions (default).
18484 This switch is mainly for debugging the compiler and will likely be removed
18485 in a future version.
18487 @item -mno-vliw-branch
18488 @opindex mno-vliw-branch
18490 Do not run a pass to pack branches into VLIW instructions.
18492 This switch is mainly for debugging the compiler and will likely be removed
18493 in a future version.
18495 @item -mmulti-cond-exec
18496 @opindex mmulti-cond-exec
18498 Enable optimization of @code{&&} and @code{||} in conditional execution
18499 (default).
18501 This switch is mainly for debugging the compiler and will likely be removed
18502 in a future version.
18504 @item -mno-multi-cond-exec
18505 @opindex mno-multi-cond-exec
18507 Disable optimization of @code{&&} and @code{||} in conditional execution.
18509 This switch is mainly for debugging the compiler and will likely be removed
18510 in a future version.
18512 @item -mnested-cond-exec
18513 @opindex mnested-cond-exec
18515 Enable nested conditional execution optimizations (default).
18517 This switch is mainly for debugging the compiler and will likely be removed
18518 in a future version.
18520 @item -mno-nested-cond-exec
18521 @opindex mno-nested-cond-exec
18523 Disable nested conditional execution optimizations.
18525 This switch is mainly for debugging the compiler and will likely be removed
18526 in a future version.
18528 @item -moptimize-membar
18529 @opindex moptimize-membar
18531 This switch removes redundant @code{membar} instructions from the
18532 compiler-generated code.  It is enabled by default.
18534 @item -mno-optimize-membar
18535 @opindex mno-optimize-membar
18537 This switch disables the automatic removal of redundant @code{membar}
18538 instructions from the generated code.
18540 @item -mtomcat-stats
18541 @opindex mtomcat-stats
18543 Cause gas to print out tomcat statistics.
18545 @item -mcpu=@var{cpu}
18546 @opindex mcpu
18548 Select the processor type for which to generate code.  Possible values are
18549 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18550 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18552 @end table
18554 @node GNU/Linux Options
18555 @subsection GNU/Linux Options
18557 These @samp{-m} options are defined for GNU/Linux targets:
18559 @table @gcctabopt
18560 @item -mglibc
18561 @opindex mglibc
18562 Use the GNU C library.  This is the default except
18563 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18564 @samp{*-*-linux-*android*} targets.
18566 @item -muclibc
18567 @opindex muclibc
18568 Use uClibc C library.  This is the default on
18569 @samp{*-*-linux-*uclibc*} targets.
18571 @item -mmusl
18572 @opindex mmusl
18573 Use the musl C library.  This is the default on
18574 @samp{*-*-linux-*musl*} targets.
18576 @item -mbionic
18577 @opindex mbionic
18578 Use Bionic C library.  This is the default on
18579 @samp{*-*-linux-*android*} targets.
18581 @item -mandroid
18582 @opindex mandroid
18583 Compile code compatible with Android platform.  This is the default on
18584 @samp{*-*-linux-*android*} targets.
18586 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18587 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18588 this option makes the GCC driver pass Android-specific options to the linker.
18589 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18590 to be defined.
18592 @item -tno-android-cc
18593 @opindex tno-android-cc
18594 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18595 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18596 @option{-fno-rtti} by default.
18598 @item -tno-android-ld
18599 @opindex tno-android-ld
18600 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18601 linking options to the linker.
18603 @end table
18605 @node H8/300 Options
18606 @subsection H8/300 Options
18608 These @samp{-m} options are defined for the H8/300 implementations:
18610 @table @gcctabopt
18611 @item -mrelax
18612 @opindex mrelax
18613 Shorten some address references at link time, when possible; uses the
18614 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18615 ld, Using ld}, for a fuller description.
18617 @item -mh
18618 @opindex mh
18619 Generate code for the H8/300H@.
18621 @item -ms
18622 @opindex ms
18623 Generate code for the H8S@.
18625 @item -mn
18626 @opindex mn
18627 Generate code for the H8S and H8/300H in the normal mode.  This switch
18628 must be used either with @option{-mh} or @option{-ms}.
18630 @item -ms2600
18631 @opindex ms2600
18632 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18634 @item -mexr
18635 @opindex mexr
18636 Extended registers are stored on stack before execution of function
18637 with monitor attribute. Default option is @option{-mexr}.
18638 This option is valid only for H8S targets.
18640 @item -mno-exr
18641 @opindex mno-exr
18642 Extended registers are not stored on stack before execution of function 
18643 with monitor attribute. Default option is @option{-mno-exr}. 
18644 This option is valid only for H8S targets.
18646 @item -mint32
18647 @opindex mint32
18648 Make @code{int} data 32 bits by default.
18650 @item -malign-300
18651 @opindex malign-300
18652 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18653 The default for the H8/300H and H8S is to align longs and floats on
18654 4-byte boundaries.
18655 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18656 This option has no effect on the H8/300.
18657 @end table
18659 @node HPPA Options
18660 @subsection HPPA Options
18661 @cindex HPPA Options
18663 These @samp{-m} options are defined for the HPPA family of computers:
18665 @table @gcctabopt
18666 @item -march=@var{architecture-type}
18667 @opindex march
18668 Generate code for the specified architecture.  The choices for
18669 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18670 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18671 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18672 architecture option for your machine.  Code compiled for lower numbered
18673 architectures runs on higher numbered architectures, but not the
18674 other way around.
18676 @item -mpa-risc-1-0
18677 @itemx -mpa-risc-1-1
18678 @itemx -mpa-risc-2-0
18679 @opindex mpa-risc-1-0
18680 @opindex mpa-risc-1-1
18681 @opindex mpa-risc-2-0
18682 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18684 @item -mcaller-copies
18685 @opindex mcaller-copies
18686 The caller copies function arguments passed by hidden reference.  This
18687 option should be used with care as it is not compatible with the default
18688 32-bit runtime.  However, only aggregates larger than eight bytes are
18689 passed by hidden reference and the option provides better compatibility
18690 with OpenMP.
18692 @item -mjump-in-delay
18693 @opindex mjump-in-delay
18694 This option is ignored and provided for compatibility purposes only.
18696 @item -mdisable-fpregs
18697 @opindex mdisable-fpregs
18698 Prevent floating-point registers from being used in any manner.  This is
18699 necessary for compiling kernels that perform lazy context switching of
18700 floating-point registers.  If you use this option and attempt to perform
18701 floating-point operations, the compiler aborts.
18703 @item -mdisable-indexing
18704 @opindex mdisable-indexing
18705 Prevent the compiler from using indexing address modes.  This avoids some
18706 rather obscure problems when compiling MIG generated code under MACH@.
18708 @item -mno-space-regs
18709 @opindex mno-space-regs
18710 Generate code that assumes the target has no space registers.  This allows
18711 GCC to generate faster indirect calls and use unscaled index address modes.
18713 Such code is suitable for level 0 PA systems and kernels.
18715 @item -mfast-indirect-calls
18716 @opindex mfast-indirect-calls
18717 Generate code that assumes calls never cross space boundaries.  This
18718 allows GCC to emit code that performs faster indirect calls.
18720 This option does not work in the presence of shared libraries or nested
18721 functions.
18723 @item -mfixed-range=@var{register-range}
18724 @opindex mfixed-range
18725 Generate code treating the given register range as fixed registers.
18726 A fixed register is one that the register allocator cannot use.  This is
18727 useful when compiling kernel code.  A register range is specified as
18728 two registers separated by a dash.  Multiple register ranges can be
18729 specified separated by a comma.
18731 @item -mlong-load-store
18732 @opindex mlong-load-store
18733 Generate 3-instruction load and store sequences as sometimes required by
18734 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18735 the HP compilers.
18737 @item -mportable-runtime
18738 @opindex mportable-runtime
18739 Use the portable calling conventions proposed by HP for ELF systems.
18741 @item -mgas
18742 @opindex mgas
18743 Enable the use of assembler directives only GAS understands.
18745 @item -mschedule=@var{cpu-type}
18746 @opindex mschedule
18747 Schedule code according to the constraints for the machine type
18748 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18749 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18750 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18751 proper scheduling option for your machine.  The default scheduling is
18752 @samp{8000}.
18754 @item -mlinker-opt
18755 @opindex mlinker-opt
18756 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18757 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18758 linkers in which they give bogus error messages when linking some programs.
18760 @item -msoft-float
18761 @opindex msoft-float
18762 Generate output containing library calls for floating point.
18763 @strong{Warning:} the requisite libraries are not available for all HPPA
18764 targets.  Normally the facilities of the machine's usual C compiler are
18765 used, but this cannot be done directly in cross-compilation.  You must make
18766 your own arrangements to provide suitable library functions for
18767 cross-compilation.
18769 @option{-msoft-float} changes the calling convention in the output file;
18770 therefore, it is only useful if you compile @emph{all} of a program with
18771 this option.  In particular, you need to compile @file{libgcc.a}, the
18772 library that comes with GCC, with @option{-msoft-float} in order for
18773 this to work.
18775 @item -msio
18776 @opindex msio
18777 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18778 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18779 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18780 options are available under HP-UX and HI-UX@.
18782 @item -mgnu-ld
18783 @opindex mgnu-ld
18784 Use options specific to GNU @command{ld}.
18785 This passes @option{-shared} to @command{ld} when
18786 building a shared library.  It is the default when GCC is configured,
18787 explicitly or implicitly, with the GNU linker.  This option does not
18788 affect which @command{ld} is called; it only changes what parameters
18789 are passed to that @command{ld}.
18790 The @command{ld} that is called is determined by the
18791 @option{--with-ld} configure option, GCC's program search path, and
18792 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18793 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18794 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18796 @item -mhp-ld
18797 @opindex mhp-ld
18798 Use options specific to HP @command{ld}.
18799 This passes @option{-b} to @command{ld} when building
18800 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18801 links.  It is the default when GCC is configured, explicitly or
18802 implicitly, with the HP linker.  This option does not affect
18803 which @command{ld} is called; it only changes what parameters are passed to that
18804 @command{ld}.
18805 The @command{ld} that is called is determined by the @option{--with-ld}
18806 configure option, GCC's program search path, and finally by the user's
18807 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18808 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18809 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18811 @item -mlong-calls
18812 @opindex mno-long-calls
18813 Generate code that uses long call sequences.  This ensures that a call
18814 is always able to reach linker generated stubs.  The default is to generate
18815 long calls only when the distance from the call site to the beginning
18816 of the function or translation unit, as the case may be, exceeds a
18817 predefined limit set by the branch type being used.  The limits for
18818 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18819 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18820 240,000 bytes.
18822 Distances are measured from the beginning of functions when using the
18823 @option{-ffunction-sections} option, or when using the @option{-mgas}
18824 and @option{-mno-portable-runtime} options together under HP-UX with
18825 the SOM linker.
18827 It is normally not desirable to use this option as it degrades
18828 performance.  However, it may be useful in large applications,
18829 particularly when partial linking is used to build the application.
18831 The types of long calls used depends on the capabilities of the
18832 assembler and linker, and the type of code being generated.  The
18833 impact on systems that support long absolute calls, and long pic
18834 symbol-difference or pc-relative calls should be relatively small.
18835 However, an indirect call is used on 32-bit ELF systems in pic code
18836 and it is quite long.
18838 @item -munix=@var{unix-std}
18839 @opindex march
18840 Generate compiler predefines and select a startfile for the specified
18841 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18842 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18843 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18844 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18845 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18846 and later.
18848 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18849 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18850 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18851 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18852 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18853 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18855 It is @emph{important} to note that this option changes the interfaces
18856 for various library routines.  It also affects the operational behavior
18857 of the C library.  Thus, @emph{extreme} care is needed in using this
18858 option.
18860 Library code that is intended to operate with more than one UNIX
18861 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18862 as appropriate.  Most GNU software doesn't provide this capability.
18864 @item -nolibdld
18865 @opindex nolibdld
18866 Suppress the generation of link options to search libdld.sl when the
18867 @option{-static} option is specified on HP-UX 10 and later.
18869 @item -static
18870 @opindex static
18871 The HP-UX implementation of setlocale in libc has a dependency on
18872 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18873 when the @option{-static} option is specified, special link options
18874 are needed to resolve this dependency.
18876 On HP-UX 10 and later, the GCC driver adds the necessary options to
18877 link with libdld.sl when the @option{-static} option is specified.
18878 This causes the resulting binary to be dynamic.  On the 64-bit port,
18879 the linkers generate dynamic binaries by default in any case.  The
18880 @option{-nolibdld} option can be used to prevent the GCC driver from
18881 adding these link options.
18883 @item -threads
18884 @opindex threads
18885 Add support for multithreading with the @dfn{dce thread} library
18886 under HP-UX@.  This option sets flags for both the preprocessor and
18887 linker.
18888 @end table
18890 @node IA-64 Options
18891 @subsection IA-64 Options
18892 @cindex IA-64 Options
18894 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18896 @table @gcctabopt
18897 @item -mbig-endian
18898 @opindex mbig-endian
18899 Generate code for a big-endian target.  This is the default for HP-UX@.
18901 @item -mlittle-endian
18902 @opindex mlittle-endian
18903 Generate code for a little-endian target.  This is the default for AIX5
18904 and GNU/Linux.
18906 @item -mgnu-as
18907 @itemx -mno-gnu-as
18908 @opindex mgnu-as
18909 @opindex mno-gnu-as
18910 Generate (or don't) code for the GNU assembler.  This is the default.
18911 @c Also, this is the default if the configure option @option{--with-gnu-as}
18912 @c is used.
18914 @item -mgnu-ld
18915 @itemx -mno-gnu-ld
18916 @opindex mgnu-ld
18917 @opindex mno-gnu-ld
18918 Generate (or don't) code for the GNU linker.  This is the default.
18919 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18920 @c is used.
18922 @item -mno-pic
18923 @opindex mno-pic
18924 Generate code that does not use a global pointer register.  The result
18925 is not position independent code, and violates the IA-64 ABI@.
18927 @item -mvolatile-asm-stop
18928 @itemx -mno-volatile-asm-stop
18929 @opindex mvolatile-asm-stop
18930 @opindex mno-volatile-asm-stop
18931 Generate (or don't) a stop bit immediately before and after volatile asm
18932 statements.
18934 @item -mregister-names
18935 @itemx -mno-register-names
18936 @opindex mregister-names
18937 @opindex mno-register-names
18938 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18939 the stacked registers.  This may make assembler output more readable.
18941 @item -mno-sdata
18942 @itemx -msdata
18943 @opindex mno-sdata
18944 @opindex msdata
18945 Disable (or enable) optimizations that use the small data section.  This may
18946 be useful for working around optimizer bugs.
18948 @item -mconstant-gp
18949 @opindex mconstant-gp
18950 Generate code that uses a single constant global pointer value.  This is
18951 useful when compiling kernel code.
18953 @item -mauto-pic
18954 @opindex mauto-pic
18955 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18956 This is useful when compiling firmware code.
18958 @item -minline-float-divide-min-latency
18959 @opindex minline-float-divide-min-latency
18960 Generate code for inline divides of floating-point values
18961 using the minimum latency algorithm.
18963 @item -minline-float-divide-max-throughput
18964 @opindex minline-float-divide-max-throughput
18965 Generate code for inline divides of floating-point values
18966 using the maximum throughput algorithm.
18968 @item -mno-inline-float-divide
18969 @opindex mno-inline-float-divide
18970 Do not generate inline code for divides of floating-point values.
18972 @item -minline-int-divide-min-latency
18973 @opindex minline-int-divide-min-latency
18974 Generate code for inline divides of integer values
18975 using the minimum latency algorithm.
18977 @item -minline-int-divide-max-throughput
18978 @opindex minline-int-divide-max-throughput
18979 Generate code for inline divides of integer values
18980 using the maximum throughput algorithm.
18982 @item -mno-inline-int-divide
18983 @opindex mno-inline-int-divide
18984 Do not generate inline code for divides of integer values.
18986 @item -minline-sqrt-min-latency
18987 @opindex minline-sqrt-min-latency
18988 Generate code for inline square roots
18989 using the minimum latency algorithm.
18991 @item -minline-sqrt-max-throughput
18992 @opindex minline-sqrt-max-throughput
18993 Generate code for inline square roots
18994 using the maximum throughput algorithm.
18996 @item -mno-inline-sqrt
18997 @opindex mno-inline-sqrt
18998 Do not generate inline code for @code{sqrt}.
19000 @item -mfused-madd
19001 @itemx -mno-fused-madd
19002 @opindex mfused-madd
19003 @opindex mno-fused-madd
19004 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19005 instructions.  The default is to use these instructions.
19007 @item -mno-dwarf2-asm
19008 @itemx -mdwarf2-asm
19009 @opindex mno-dwarf2-asm
19010 @opindex mdwarf2-asm
19011 Don't (or do) generate assembler code for the DWARF line number debugging
19012 info.  This may be useful when not using the GNU assembler.
19014 @item -mearly-stop-bits
19015 @itemx -mno-early-stop-bits
19016 @opindex mearly-stop-bits
19017 @opindex mno-early-stop-bits
19018 Allow stop bits to be placed earlier than immediately preceding the
19019 instruction that triggered the stop bit.  This can improve instruction
19020 scheduling, but does not always do so.
19022 @item -mfixed-range=@var{register-range}
19023 @opindex mfixed-range
19024 Generate code treating the given register range as fixed registers.
19025 A fixed register is one that the register allocator cannot use.  This is
19026 useful when compiling kernel code.  A register range is specified as
19027 two registers separated by a dash.  Multiple register ranges can be
19028 specified separated by a comma.
19030 @item -mtls-size=@var{tls-size}
19031 @opindex mtls-size
19032 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19035 @item -mtune=@var{cpu-type}
19036 @opindex mtune
19037 Tune the instruction scheduling for a particular CPU, Valid values are
19038 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19039 and @samp{mckinley}.
19041 @item -milp32
19042 @itemx -mlp64
19043 @opindex milp32
19044 @opindex mlp64
19045 Generate code for a 32-bit or 64-bit environment.
19046 The 32-bit environment sets int, long and pointer to 32 bits.
19047 The 64-bit environment sets int to 32 bits and long and pointer
19048 to 64 bits.  These are HP-UX specific flags.
19050 @item -mno-sched-br-data-spec
19051 @itemx -msched-br-data-spec
19052 @opindex mno-sched-br-data-spec
19053 @opindex msched-br-data-spec
19054 (Dis/En)able data speculative scheduling before reload.
19055 This results in generation of @code{ld.a} instructions and
19056 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19057 The default setting is disabled.
19059 @item -msched-ar-data-spec
19060 @itemx -mno-sched-ar-data-spec
19061 @opindex msched-ar-data-spec
19062 @opindex mno-sched-ar-data-spec
19063 (En/Dis)able data speculative scheduling after reload.
19064 This results in generation of @code{ld.a} instructions and
19065 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19066 The default setting is enabled.
19068 @item -mno-sched-control-spec
19069 @itemx -msched-control-spec
19070 @opindex mno-sched-control-spec
19071 @opindex msched-control-spec
19072 (Dis/En)able control speculative scheduling.  This feature is
19073 available only during region scheduling (i.e.@: before reload).
19074 This results in generation of the @code{ld.s} instructions and
19075 the corresponding check instructions @code{chk.s}.
19076 The default setting is disabled.
19078 @item -msched-br-in-data-spec
19079 @itemx -mno-sched-br-in-data-spec
19080 @opindex msched-br-in-data-spec
19081 @opindex mno-sched-br-in-data-spec
19082 (En/Dis)able speculative scheduling of the instructions that
19083 are dependent on the data speculative loads before reload.
19084 This is effective only with @option{-msched-br-data-spec} enabled.
19085 The default setting is enabled.
19087 @item -msched-ar-in-data-spec
19088 @itemx -mno-sched-ar-in-data-spec
19089 @opindex msched-ar-in-data-spec
19090 @opindex mno-sched-ar-in-data-spec
19091 (En/Dis)able speculative scheduling of the instructions that
19092 are dependent on the data speculative loads after reload.
19093 This is effective only with @option{-msched-ar-data-spec} enabled.
19094 The default setting is enabled.
19096 @item -msched-in-control-spec
19097 @itemx -mno-sched-in-control-spec
19098 @opindex msched-in-control-spec
19099 @opindex mno-sched-in-control-spec
19100 (En/Dis)able speculative scheduling of the instructions that
19101 are dependent on the control speculative loads.
19102 This is effective only with @option{-msched-control-spec} enabled.
19103 The default setting is enabled.
19105 @item -mno-sched-prefer-non-data-spec-insns
19106 @itemx -msched-prefer-non-data-spec-insns
19107 @opindex mno-sched-prefer-non-data-spec-insns
19108 @opindex msched-prefer-non-data-spec-insns
19109 If enabled, data-speculative instructions are chosen for schedule
19110 only if there are no other choices at the moment.  This makes
19111 the use of the data speculation much more conservative.
19112 The default setting is disabled.
19114 @item -mno-sched-prefer-non-control-spec-insns
19115 @itemx -msched-prefer-non-control-spec-insns
19116 @opindex mno-sched-prefer-non-control-spec-insns
19117 @opindex msched-prefer-non-control-spec-insns
19118 If enabled, control-speculative instructions are chosen for schedule
19119 only if there are no other choices at the moment.  This makes
19120 the use of the control speculation much more conservative.
19121 The default setting is disabled.
19123 @item -mno-sched-count-spec-in-critical-path
19124 @itemx -msched-count-spec-in-critical-path
19125 @opindex mno-sched-count-spec-in-critical-path
19126 @opindex msched-count-spec-in-critical-path
19127 If enabled, speculative dependencies are considered during
19128 computation of the instructions priorities.  This makes the use of the
19129 speculation a bit more conservative.
19130 The default setting is disabled.
19132 @item -msched-spec-ldc
19133 @opindex msched-spec-ldc
19134 Use a simple data speculation check.  This option is on by default.
19136 @item -msched-control-spec-ldc
19137 @opindex msched-spec-ldc
19138 Use a simple check for control speculation.  This option is on by default.
19140 @item -msched-stop-bits-after-every-cycle
19141 @opindex msched-stop-bits-after-every-cycle
19142 Place a stop bit after every cycle when scheduling.  This option is on
19143 by default.
19145 @item -msched-fp-mem-deps-zero-cost
19146 @opindex msched-fp-mem-deps-zero-cost
19147 Assume that floating-point stores and loads are not likely to cause a conflict
19148 when placed into the same instruction group.  This option is disabled by
19149 default.
19151 @item -msel-sched-dont-check-control-spec
19152 @opindex msel-sched-dont-check-control-spec
19153 Generate checks for control speculation in selective scheduling.
19154 This flag is disabled by default.
19156 @item -msched-max-memory-insns=@var{max-insns}
19157 @opindex msched-max-memory-insns
19158 Limit on the number of memory insns per instruction group, giving lower
19159 priority to subsequent memory insns attempting to schedule in the same
19160 instruction group. Frequently useful to prevent cache bank conflicts.
19161 The default value is 1.
19163 @item -msched-max-memory-insns-hard-limit
19164 @opindex msched-max-memory-insns-hard-limit
19165 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19166 disallowing more than that number in an instruction group.
19167 Otherwise, the limit is ``soft'', meaning that non-memory operations
19168 are preferred when the limit is reached, but memory operations may still
19169 be scheduled.
19171 @end table
19173 @node LM32 Options
19174 @subsection LM32 Options
19175 @cindex LM32 options
19177 These @option{-m} options are defined for the LatticeMico32 architecture:
19179 @table @gcctabopt
19180 @item -mbarrel-shift-enabled
19181 @opindex mbarrel-shift-enabled
19182 Enable barrel-shift instructions.
19184 @item -mdivide-enabled
19185 @opindex mdivide-enabled
19186 Enable divide and modulus instructions.
19188 @item -mmultiply-enabled
19189 @opindex multiply-enabled
19190 Enable multiply instructions.
19192 @item -msign-extend-enabled
19193 @opindex msign-extend-enabled
19194 Enable sign extend instructions.
19196 @item -muser-enabled
19197 @opindex muser-enabled
19198 Enable user-defined instructions.
19200 @end table
19202 @node M32C Options
19203 @subsection M32C Options
19204 @cindex M32C options
19206 @table @gcctabopt
19207 @item -mcpu=@var{name}
19208 @opindex mcpu=
19209 Select the CPU for which code is generated.  @var{name} may be one of
19210 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19211 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19212 the M32C/80 series.
19214 @item -msim
19215 @opindex msim
19216 Specifies that the program will be run on the simulator.  This causes
19217 an alternate runtime library to be linked in which supports, for
19218 example, file I/O@.  You must not use this option when generating
19219 programs that will run on real hardware; you must provide your own
19220 runtime library for whatever I/O functions are needed.
19222 @item -memregs=@var{number}
19223 @opindex memregs=
19224 Specifies the number of memory-based pseudo-registers GCC uses
19225 during code generation.  These pseudo-registers are used like real
19226 registers, so there is a tradeoff between GCC's ability to fit the
19227 code into available registers, and the performance penalty of using
19228 memory instead of registers.  Note that all modules in a program must
19229 be compiled with the same value for this option.  Because of that, you
19230 must not use this option with GCC's default runtime libraries.
19232 @end table
19234 @node M32R/D Options
19235 @subsection M32R/D Options
19236 @cindex M32R/D options
19238 These @option{-m} options are defined for Renesas M32R/D architectures:
19240 @table @gcctabopt
19241 @item -m32r2
19242 @opindex m32r2
19243 Generate code for the M32R/2@.
19245 @item -m32rx
19246 @opindex m32rx
19247 Generate code for the M32R/X@.
19249 @item -m32r
19250 @opindex m32r
19251 Generate code for the M32R@.  This is the default.
19253 @item -mmodel=small
19254 @opindex mmodel=small
19255 Assume all objects live in the lower 16MB of memory (so that their addresses
19256 can be loaded with the @code{ld24} instruction), and assume all subroutines
19257 are reachable with the @code{bl} instruction.
19258 This is the default.
19260 The addressability of a particular object can be set with the
19261 @code{model} attribute.
19263 @item -mmodel=medium
19264 @opindex mmodel=medium
19265 Assume objects may be anywhere in the 32-bit address space (the compiler
19266 generates @code{seth/add3} instructions to load their addresses), and
19267 assume all subroutines are reachable with the @code{bl} instruction.
19269 @item -mmodel=large
19270 @opindex mmodel=large
19271 Assume objects may be anywhere in the 32-bit address space (the compiler
19272 generates @code{seth/add3} instructions to load their addresses), and
19273 assume subroutines may not be reachable with the @code{bl} instruction
19274 (the compiler generates the much slower @code{seth/add3/jl}
19275 instruction sequence).
19277 @item -msdata=none
19278 @opindex msdata=none
19279 Disable use of the small data area.  Variables are put into
19280 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19281 @code{section} attribute has been specified).
19282 This is the default.
19284 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19285 Objects may be explicitly put in the small data area with the
19286 @code{section} attribute using one of these sections.
19288 @item -msdata=sdata
19289 @opindex msdata=sdata
19290 Put small global and static data in the small data area, but do not
19291 generate special code to reference them.
19293 @item -msdata=use
19294 @opindex msdata=use
19295 Put small global and static data in the small data area, and generate
19296 special instructions to reference them.
19298 @item -G @var{num}
19299 @opindex G
19300 @cindex smaller data references
19301 Put global and static objects less than or equal to @var{num} bytes
19302 into the small data or BSS sections instead of the normal data or BSS
19303 sections.  The default value of @var{num} is 8.
19304 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19305 for this option to have any effect.
19307 All modules should be compiled with the same @option{-G @var{num}} value.
19308 Compiling with different values of @var{num} may or may not work; if it
19309 doesn't the linker gives an error message---incorrect code is not
19310 generated.
19312 @item -mdebug
19313 @opindex mdebug
19314 Makes the M32R-specific code in the compiler display some statistics
19315 that might help in debugging programs.
19317 @item -malign-loops
19318 @opindex malign-loops
19319 Align all loops to a 32-byte boundary.
19321 @item -mno-align-loops
19322 @opindex mno-align-loops
19323 Do not enforce a 32-byte alignment for loops.  This is the default.
19325 @item -missue-rate=@var{number}
19326 @opindex missue-rate=@var{number}
19327 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19328 or 2.
19330 @item -mbranch-cost=@var{number}
19331 @opindex mbranch-cost=@var{number}
19332 @var{number} can only be 1 or 2.  If it is 1 then branches are
19333 preferred over conditional code, if it is 2, then the opposite applies.
19335 @item -mflush-trap=@var{number}
19336 @opindex mflush-trap=@var{number}
19337 Specifies the trap number to use to flush the cache.  The default is
19338 12.  Valid numbers are between 0 and 15 inclusive.
19340 @item -mno-flush-trap
19341 @opindex mno-flush-trap
19342 Specifies that the cache cannot be flushed by using a trap.
19344 @item -mflush-func=@var{name}
19345 @opindex mflush-func=@var{name}
19346 Specifies the name of the operating system function to call to flush
19347 the cache.  The default is @samp{_flush_cache}, but a function call
19348 is only used if a trap is not available.
19350 @item -mno-flush-func
19351 @opindex mno-flush-func
19352 Indicates that there is no OS function for flushing the cache.
19354 @end table
19356 @node M680x0 Options
19357 @subsection M680x0 Options
19358 @cindex M680x0 options
19360 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19361 The default settings depend on which architecture was selected when
19362 the compiler was configured; the defaults for the most common choices
19363 are given below.
19365 @table @gcctabopt
19366 @item -march=@var{arch}
19367 @opindex march
19368 Generate code for a specific M680x0 or ColdFire instruction set
19369 architecture.  Permissible values of @var{arch} for M680x0
19370 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19371 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19372 architectures are selected according to Freescale's ISA classification
19373 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19374 @samp{isab} and @samp{isac}.
19376 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19377 code for a ColdFire target.  The @var{arch} in this macro is one of the
19378 @option{-march} arguments given above.
19380 When used together, @option{-march} and @option{-mtune} select code
19381 that runs on a family of similar processors but that is optimized
19382 for a particular microarchitecture.
19384 @item -mcpu=@var{cpu}
19385 @opindex mcpu
19386 Generate code for a specific M680x0 or ColdFire processor.
19387 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19388 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19389 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19390 below, which also classifies the CPUs into families:
19392 @multitable @columnfractions 0.20 0.80
19393 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19394 @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}
19395 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19396 @item @samp{5206e} @tab @samp{5206e}
19397 @item @samp{5208} @tab @samp{5207} @samp{5208}
19398 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19399 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19400 @item @samp{5216} @tab @samp{5214} @samp{5216}
19401 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19402 @item @samp{5225} @tab @samp{5224} @samp{5225}
19403 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19404 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19405 @item @samp{5249} @tab @samp{5249}
19406 @item @samp{5250} @tab @samp{5250}
19407 @item @samp{5271} @tab @samp{5270} @samp{5271}
19408 @item @samp{5272} @tab @samp{5272}
19409 @item @samp{5275} @tab @samp{5274} @samp{5275}
19410 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19411 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19412 @item @samp{5307} @tab @samp{5307}
19413 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19414 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19415 @item @samp{5407} @tab @samp{5407}
19416 @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}
19417 @end multitable
19419 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19420 @var{arch} is compatible with @var{cpu}.  Other combinations of
19421 @option{-mcpu} and @option{-march} are rejected.
19423 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19424 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19425 where the value of @var{family} is given by the table above.
19427 @item -mtune=@var{tune}
19428 @opindex mtune
19429 Tune the code for a particular microarchitecture within the
19430 constraints set by @option{-march} and @option{-mcpu}.
19431 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19432 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19433 and @samp{cpu32}.  The ColdFire microarchitectures
19434 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19436 You can also use @option{-mtune=68020-40} for code that needs
19437 to run relatively well on 68020, 68030 and 68040 targets.
19438 @option{-mtune=68020-60} is similar but includes 68060 targets
19439 as well.  These two options select the same tuning decisions as
19440 @option{-m68020-40} and @option{-m68020-60} respectively.
19442 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19443 when tuning for 680x0 architecture @var{arch}.  It also defines
19444 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19445 option is used.  If GCC is tuning for a range of architectures,
19446 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19447 it defines the macros for every architecture in the range.
19449 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19450 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19451 of the arguments given above.
19453 @item -m68000
19454 @itemx -mc68000
19455 @opindex m68000
19456 @opindex mc68000
19457 Generate output for a 68000.  This is the default
19458 when the compiler is configured for 68000-based systems.
19459 It is equivalent to @option{-march=68000}.
19461 Use this option for microcontrollers with a 68000 or EC000 core,
19462 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19464 @item -m68010
19465 @opindex m68010
19466 Generate output for a 68010.  This is the default
19467 when the compiler is configured for 68010-based systems.
19468 It is equivalent to @option{-march=68010}.
19470 @item -m68020
19471 @itemx -mc68020
19472 @opindex m68020
19473 @opindex mc68020
19474 Generate output for a 68020.  This is the default
19475 when the compiler is configured for 68020-based systems.
19476 It is equivalent to @option{-march=68020}.
19478 @item -m68030
19479 @opindex m68030
19480 Generate output for a 68030.  This is the default when the compiler is
19481 configured for 68030-based systems.  It is equivalent to
19482 @option{-march=68030}.
19484 @item -m68040
19485 @opindex m68040
19486 Generate output for a 68040.  This is the default when the compiler is
19487 configured for 68040-based systems.  It is equivalent to
19488 @option{-march=68040}.
19490 This option inhibits the use of 68881/68882 instructions that have to be
19491 emulated by software on the 68040.  Use this option if your 68040 does not
19492 have code to emulate those instructions.
19494 @item -m68060
19495 @opindex m68060
19496 Generate output for a 68060.  This is the default when the compiler is
19497 configured for 68060-based systems.  It is equivalent to
19498 @option{-march=68060}.
19500 This option inhibits the use of 68020 and 68881/68882 instructions that
19501 have to be emulated by software on the 68060.  Use this option if your 68060
19502 does not have code to emulate those instructions.
19504 @item -mcpu32
19505 @opindex mcpu32
19506 Generate output for a CPU32.  This is the default
19507 when the compiler is configured for CPU32-based systems.
19508 It is equivalent to @option{-march=cpu32}.
19510 Use this option for microcontrollers with a
19511 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19512 68336, 68340, 68341, 68349 and 68360.
19514 @item -m5200
19515 @opindex m5200
19516 Generate output for a 520X ColdFire CPU@.  This is the default
19517 when the compiler is configured for 520X-based systems.
19518 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19519 in favor of that option.
19521 Use this option for microcontroller with a 5200 core, including
19522 the MCF5202, MCF5203, MCF5204 and MCF5206.
19524 @item -m5206e
19525 @opindex m5206e
19526 Generate output for a 5206e ColdFire CPU@.  The option is now
19527 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19529 @item -m528x
19530 @opindex m528x
19531 Generate output for a member of the ColdFire 528X family.
19532 The option is now deprecated in favor of the equivalent
19533 @option{-mcpu=528x}.
19535 @item -m5307
19536 @opindex m5307
19537 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19538 in favor of the equivalent @option{-mcpu=5307}.
19540 @item -m5407
19541 @opindex m5407
19542 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19543 in favor of the equivalent @option{-mcpu=5407}.
19545 @item -mcfv4e
19546 @opindex mcfv4e
19547 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19548 This includes use of hardware floating-point instructions.
19549 The option is equivalent to @option{-mcpu=547x}, and is now
19550 deprecated in favor of that option.
19552 @item -m68020-40
19553 @opindex m68020-40
19554 Generate output for a 68040, without using any of the new instructions.
19555 This results in code that can run relatively efficiently on either a
19556 68020/68881 or a 68030 or a 68040.  The generated code does use the
19557 68881 instructions that are emulated on the 68040.
19559 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19561 @item -m68020-60
19562 @opindex m68020-60
19563 Generate output for a 68060, without using any of the new instructions.
19564 This results in code that can run relatively efficiently on either a
19565 68020/68881 or a 68030 or a 68040.  The generated code does use the
19566 68881 instructions that are emulated on the 68060.
19568 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19570 @item -mhard-float
19571 @itemx -m68881
19572 @opindex mhard-float
19573 @opindex m68881
19574 Generate floating-point instructions.  This is the default for 68020
19575 and above, and for ColdFire devices that have an FPU@.  It defines the
19576 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19577 on ColdFire targets.
19579 @item -msoft-float
19580 @opindex msoft-float
19581 Do not generate floating-point instructions; use library calls instead.
19582 This is the default for 68000, 68010, and 68832 targets.  It is also
19583 the default for ColdFire devices that have no FPU.
19585 @item -mdiv
19586 @itemx -mno-div
19587 @opindex mdiv
19588 @opindex mno-div
19589 Generate (do not generate) ColdFire hardware divide and remainder
19590 instructions.  If @option{-march} is used without @option{-mcpu},
19591 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19592 architectures.  Otherwise, the default is taken from the target CPU
19593 (either the default CPU, or the one specified by @option{-mcpu}).  For
19594 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19595 @option{-mcpu=5206e}.
19597 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19599 @item -mshort
19600 @opindex mshort
19601 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19602 Additionally, parameters passed on the stack are also aligned to a
19603 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19605 @item -mno-short
19606 @opindex mno-short
19607 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19609 @item -mnobitfield
19610 @itemx -mno-bitfield
19611 @opindex mnobitfield
19612 @opindex mno-bitfield
19613 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19614 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19616 @item -mbitfield
19617 @opindex mbitfield
19618 Do use the bit-field instructions.  The @option{-m68020} option implies
19619 @option{-mbitfield}.  This is the default if you use a configuration
19620 designed for a 68020.
19622 @item -mrtd
19623 @opindex mrtd
19624 Use a different function-calling convention, in which functions
19625 that take a fixed number of arguments return with the @code{rtd}
19626 instruction, which pops their arguments while returning.  This
19627 saves one instruction in the caller since there is no need to pop
19628 the arguments there.
19630 This calling convention is incompatible with the one normally
19631 used on Unix, so you cannot use it if you need to call libraries
19632 compiled with the Unix compiler.
19634 Also, you must provide function prototypes for all functions that
19635 take variable numbers of arguments (including @code{printf});
19636 otherwise incorrect code is generated for calls to those
19637 functions.
19639 In addition, seriously incorrect code results if you call a
19640 function with too many arguments.  (Normally, extra arguments are
19641 harmlessly ignored.)
19643 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19644 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19646 @item -mno-rtd
19647 @opindex mno-rtd
19648 Do not use the calling conventions selected by @option{-mrtd}.
19649 This is the default.
19651 @item -malign-int
19652 @itemx -mno-align-int
19653 @opindex malign-int
19654 @opindex mno-align-int
19655 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19656 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19657 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19658 Aligning variables on 32-bit boundaries produces code that runs somewhat
19659 faster on processors with 32-bit busses at the expense of more memory.
19661 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19662 aligns structures containing the above types differently than
19663 most published application binary interface specifications for the m68k.
19665 @item -mpcrel
19666 @opindex mpcrel
19667 Use the pc-relative addressing mode of the 68000 directly, instead of
19668 using a global offset table.  At present, this option implies @option{-fpic},
19669 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19670 not presently supported with @option{-mpcrel}, though this could be supported for
19671 68020 and higher processors.
19673 @item -mno-strict-align
19674 @itemx -mstrict-align
19675 @opindex mno-strict-align
19676 @opindex mstrict-align
19677 Do not (do) assume that unaligned memory references are handled by
19678 the system.
19680 @item -msep-data
19681 Generate code that allows the data segment to be located in a different
19682 area of memory from the text segment.  This allows for execute-in-place in
19683 an environment without virtual memory management.  This option implies
19684 @option{-fPIC}.
19686 @item -mno-sep-data
19687 Generate code that assumes that the data segment follows the text segment.
19688 This is the default.
19690 @item -mid-shared-library
19691 Generate code that supports shared libraries via the library ID method.
19692 This allows for execute-in-place and shared libraries in an environment
19693 without virtual memory management.  This option implies @option{-fPIC}.
19695 @item -mno-id-shared-library
19696 Generate code that doesn't assume ID-based shared libraries are being used.
19697 This is the default.
19699 @item -mshared-library-id=n
19700 Specifies the identification number of the ID-based shared library being
19701 compiled.  Specifying a value of 0 generates more compact code; specifying
19702 other values forces the allocation of that number to the current
19703 library, but is no more space- or time-efficient than omitting this option.
19705 @item -mxgot
19706 @itemx -mno-xgot
19707 @opindex mxgot
19708 @opindex mno-xgot
19709 When generating position-independent code for ColdFire, generate code
19710 that works if the GOT has more than 8192 entries.  This code is
19711 larger and slower than code generated without this option.  On M680x0
19712 processors, this option is not needed; @option{-fPIC} suffices.
19714 GCC normally uses a single instruction to load values from the GOT@.
19715 While this is relatively efficient, it only works if the GOT
19716 is smaller than about 64k.  Anything larger causes the linker
19717 to report an error such as:
19719 @cindex relocation truncated to fit (ColdFire)
19720 @smallexample
19721 relocation truncated to fit: R_68K_GOT16O foobar
19722 @end smallexample
19724 If this happens, you should recompile your code with @option{-mxgot}.
19725 It should then work with very large GOTs.  However, code generated with
19726 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19727 the value of a global symbol.
19729 Note that some linkers, including newer versions of the GNU linker,
19730 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19731 you should only need to use @option{-mxgot} when compiling a single
19732 object file that accesses more than 8192 GOT entries.  Very few do.
19734 These options have no effect unless GCC is generating
19735 position-independent code.
19737 @item -mlong-jump-table-offsets
19738 @opindex mlong-jump-table-offsets
19739 Use 32-bit offsets in @code{switch} tables.  The default is to use
19740 16-bit offsets.
19742 @end table
19744 @node MCore Options
19745 @subsection MCore Options
19746 @cindex MCore options
19748 These are the @samp{-m} options defined for the Motorola M*Core
19749 processors.
19751 @table @gcctabopt
19753 @item -mhardlit
19754 @itemx -mno-hardlit
19755 @opindex mhardlit
19756 @opindex mno-hardlit
19757 Inline constants into the code stream if it can be done in two
19758 instructions or less.
19760 @item -mdiv
19761 @itemx -mno-div
19762 @opindex mdiv
19763 @opindex mno-div
19764 Use the divide instruction.  (Enabled by default).
19766 @item -mrelax-immediate
19767 @itemx -mno-relax-immediate
19768 @opindex mrelax-immediate
19769 @opindex mno-relax-immediate
19770 Allow arbitrary-sized immediates in bit operations.
19772 @item -mwide-bitfields
19773 @itemx -mno-wide-bitfields
19774 @opindex mwide-bitfields
19775 @opindex mno-wide-bitfields
19776 Always treat bit-fields as @code{int}-sized.
19778 @item -m4byte-functions
19779 @itemx -mno-4byte-functions
19780 @opindex m4byte-functions
19781 @opindex mno-4byte-functions
19782 Force all functions to be aligned to a 4-byte boundary.
19784 @item -mcallgraph-data
19785 @itemx -mno-callgraph-data
19786 @opindex mcallgraph-data
19787 @opindex mno-callgraph-data
19788 Emit callgraph information.
19790 @item -mslow-bytes
19791 @itemx -mno-slow-bytes
19792 @opindex mslow-bytes
19793 @opindex mno-slow-bytes
19794 Prefer word access when reading byte quantities.
19796 @item -mlittle-endian
19797 @itemx -mbig-endian
19798 @opindex mlittle-endian
19799 @opindex mbig-endian
19800 Generate code for a little-endian target.
19802 @item -m210
19803 @itemx -m340
19804 @opindex m210
19805 @opindex m340
19806 Generate code for the 210 processor.
19808 @item -mno-lsim
19809 @opindex mno-lsim
19810 Assume that runtime support has been provided and so omit the
19811 simulator library (@file{libsim.a)} from the linker command line.
19813 @item -mstack-increment=@var{size}
19814 @opindex mstack-increment
19815 Set the maximum amount for a single stack increment operation.  Large
19816 values can increase the speed of programs that contain functions
19817 that need a large amount of stack space, but they can also trigger a
19818 segmentation fault if the stack is extended too much.  The default
19819 value is 0x1000.
19821 @end table
19823 @node MeP Options
19824 @subsection MeP Options
19825 @cindex MeP options
19827 @table @gcctabopt
19829 @item -mabsdiff
19830 @opindex mabsdiff
19831 Enables the @code{abs} instruction, which is the absolute difference
19832 between two registers.
19834 @item -mall-opts
19835 @opindex mall-opts
19836 Enables all the optional instructions---average, multiply, divide, bit
19837 operations, leading zero, absolute difference, min/max, clip, and
19838 saturation.
19841 @item -maverage
19842 @opindex maverage
19843 Enables the @code{ave} instruction, which computes the average of two
19844 registers.
19846 @item -mbased=@var{n}
19847 @opindex mbased=
19848 Variables of size @var{n} bytes or smaller are placed in the
19849 @code{.based} section by default.  Based variables use the @code{$tp}
19850 register as a base register, and there is a 128-byte limit to the
19851 @code{.based} section.
19853 @item -mbitops
19854 @opindex mbitops
19855 Enables the bit operation instructions---bit test (@code{btstm}), set
19856 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19857 test-and-set (@code{tas}).
19859 @item -mc=@var{name}
19860 @opindex mc=
19861 Selects which section constant data is placed in.  @var{name} may
19862 be @samp{tiny}, @samp{near}, or @samp{far}.
19864 @item -mclip
19865 @opindex mclip
19866 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19867 useful unless you also provide @option{-mminmax}.
19869 @item -mconfig=@var{name}
19870 @opindex mconfig=
19871 Selects one of the built-in core configurations.  Each MeP chip has
19872 one or more modules in it; each module has a core CPU and a variety of
19873 coprocessors, optional instructions, and peripherals.  The
19874 @code{MeP-Integrator} tool, not part of GCC, provides these
19875 configurations through this option; using this option is the same as
19876 using all the corresponding command-line options.  The default
19877 configuration is @samp{default}.
19879 @item -mcop
19880 @opindex mcop
19881 Enables the coprocessor instructions.  By default, this is a 32-bit
19882 coprocessor.  Note that the coprocessor is normally enabled via the
19883 @option{-mconfig=} option.
19885 @item -mcop32
19886 @opindex mcop32
19887 Enables the 32-bit coprocessor's instructions.
19889 @item -mcop64
19890 @opindex mcop64
19891 Enables the 64-bit coprocessor's instructions.
19893 @item -mivc2
19894 @opindex mivc2
19895 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19897 @item -mdc
19898 @opindex mdc
19899 Causes constant variables to be placed in the @code{.near} section.
19901 @item -mdiv
19902 @opindex mdiv
19903 Enables the @code{div} and @code{divu} instructions.
19905 @item -meb
19906 @opindex meb
19907 Generate big-endian code.
19909 @item -mel
19910 @opindex mel
19911 Generate little-endian code.
19913 @item -mio-volatile
19914 @opindex mio-volatile
19915 Tells the compiler that any variable marked with the @code{io}
19916 attribute is to be considered volatile.
19918 @item -ml
19919 @opindex ml
19920 Causes variables to be assigned to the @code{.far} section by default.
19922 @item -mleadz
19923 @opindex mleadz
19924 Enables the @code{leadz} (leading zero) instruction.
19926 @item -mm
19927 @opindex mm
19928 Causes variables to be assigned to the @code{.near} section by default.
19930 @item -mminmax
19931 @opindex mminmax
19932 Enables the @code{min} and @code{max} instructions.
19934 @item -mmult
19935 @opindex mmult
19936 Enables the multiplication and multiply-accumulate instructions.
19938 @item -mno-opts
19939 @opindex mno-opts
19940 Disables all the optional instructions enabled by @option{-mall-opts}.
19942 @item -mrepeat
19943 @opindex mrepeat
19944 Enables the @code{repeat} and @code{erepeat} instructions, used for
19945 low-overhead looping.
19947 @item -ms
19948 @opindex ms
19949 Causes all variables to default to the @code{.tiny} section.  Note
19950 that there is a 65536-byte limit to this section.  Accesses to these
19951 variables use the @code{%gp} base register.
19953 @item -msatur
19954 @opindex msatur
19955 Enables the saturation instructions.  Note that the compiler does not
19956 currently generate these itself, but this option is included for
19957 compatibility with other tools, like @code{as}.
19959 @item -msdram
19960 @opindex msdram
19961 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19963 @item -msim
19964 @opindex msim
19965 Link the simulator run-time libraries.
19967 @item -msimnovec
19968 @opindex msimnovec
19969 Link the simulator runtime libraries, excluding built-in support
19970 for reset and exception vectors and tables.
19972 @item -mtf
19973 @opindex mtf
19974 Causes all functions to default to the @code{.far} section.  Without
19975 this option, functions default to the @code{.near} section.
19977 @item -mtiny=@var{n}
19978 @opindex mtiny=
19979 Variables that are @var{n} bytes or smaller are allocated to the
19980 @code{.tiny} section.  These variables use the @code{$gp} base
19981 register.  The default for this option is 4, but note that there's a
19982 65536-byte limit to the @code{.tiny} section.
19984 @end table
19986 @node MicroBlaze Options
19987 @subsection MicroBlaze Options
19988 @cindex MicroBlaze Options
19990 @table @gcctabopt
19992 @item -msoft-float
19993 @opindex msoft-float
19994 Use software emulation for floating point (default).
19996 @item -mhard-float
19997 @opindex mhard-float
19998 Use hardware floating-point instructions.
20000 @item -mmemcpy
20001 @opindex mmemcpy
20002 Do not optimize block moves, use @code{memcpy}.
20004 @item -mno-clearbss
20005 @opindex mno-clearbss
20006 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20008 @item -mcpu=@var{cpu-type}
20009 @opindex mcpu=
20010 Use features of, and schedule code for, the given CPU.
20011 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20012 where @var{X} is a major version, @var{YY} is the minor version, and
20013 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20014 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20016 @item -mxl-soft-mul
20017 @opindex mxl-soft-mul
20018 Use software multiply emulation (default).
20020 @item -mxl-soft-div
20021 @opindex mxl-soft-div
20022 Use software emulation for divides (default).
20024 @item -mxl-barrel-shift
20025 @opindex mxl-barrel-shift
20026 Use the hardware barrel shifter.
20028 @item -mxl-pattern-compare
20029 @opindex mxl-pattern-compare
20030 Use pattern compare instructions.
20032 @item -msmall-divides
20033 @opindex msmall-divides
20034 Use table lookup optimization for small signed integer divisions.
20036 @item -mxl-stack-check
20037 @opindex mxl-stack-check
20038 This option is deprecated.  Use @option{-fstack-check} instead.
20040 @item -mxl-gp-opt
20041 @opindex mxl-gp-opt
20042 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20044 @item -mxl-multiply-high
20045 @opindex mxl-multiply-high
20046 Use multiply high instructions for high part of 32x32 multiply.
20048 @item -mxl-float-convert
20049 @opindex mxl-float-convert
20050 Use hardware floating-point conversion instructions.
20052 @item -mxl-float-sqrt
20053 @opindex mxl-float-sqrt
20054 Use hardware floating-point square root instruction.
20056 @item -mbig-endian
20057 @opindex mbig-endian
20058 Generate code for a big-endian target.
20060 @item -mlittle-endian
20061 @opindex mlittle-endian
20062 Generate code for a little-endian target.
20064 @item -mxl-reorder
20065 @opindex mxl-reorder
20066 Use reorder instructions (swap and byte reversed load/store).
20068 @item -mxl-mode-@var{app-model}
20069 Select application model @var{app-model}.  Valid models are
20070 @table @samp
20071 @item executable
20072 normal executable (default), uses startup code @file{crt0.o}.
20074 @item -mpic-data-is-text-relative
20075 @opindex mpic-data-is-text-relative
20076 Assume that the displacement between the text and data segments is fixed
20077 at static link time.  This allows data to be referenced by offset from start of
20078 text address instead of GOT since PC-relative addressing is not supported.
20080 @item xmdstub
20081 for use with Xilinx Microprocessor Debugger (XMD) based
20082 software intrusive debug agent called xmdstub. This uses startup file
20083 @file{crt1.o} and sets the start address of the program to 0x800.
20085 @item bootstrap
20086 for applications that are loaded using a bootloader.
20087 This model uses startup file @file{crt2.o} which does not contain a processor
20088 reset vector handler. This is suitable for transferring control on a
20089 processor reset to the bootloader rather than the application.
20091 @item novectors
20092 for applications that do not require any of the
20093 MicroBlaze vectors. This option may be useful for applications running
20094 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20095 @end table
20097 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20098 @option{-mxl-mode-@var{app-model}}.
20100 @end table
20102 @node MIPS Options
20103 @subsection MIPS Options
20104 @cindex MIPS options
20106 @table @gcctabopt
20108 @item -EB
20109 @opindex EB
20110 Generate big-endian code.
20112 @item -EL
20113 @opindex EL
20114 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20115 configurations.
20117 @item -march=@var{arch}
20118 @opindex march
20119 Generate code that runs on @var{arch}, which can be the name of a
20120 generic MIPS ISA, or the name of a particular processor.
20121 The ISA names are:
20122 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20123 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20124 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20125 @samp{mips64r5} and @samp{mips64r6}.
20126 The processor names are:
20127 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20128 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20129 @samp{5kc}, @samp{5kf},
20130 @samp{20kc},
20131 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20132 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20133 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20134 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20135 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20136 @samp{i6400},
20137 @samp{interaptiv},
20138 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20139 @samp{m4k},
20140 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20141 @samp{m5100}, @samp{m5101},
20142 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20143 @samp{orion},
20144 @samp{p5600},
20145 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20146 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20147 @samp{rm7000}, @samp{rm9000},
20148 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20149 @samp{sb1},
20150 @samp{sr71000},
20151 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20152 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20153 @samp{xlr} and @samp{xlp}.
20154 The special value @samp{from-abi} selects the
20155 most compatible architecture for the selected ABI (that is,
20156 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20158 The native Linux/GNU toolchain also supports the value @samp{native},
20159 which selects the best architecture option for the host processor.
20160 @option{-march=native} has no effect if GCC does not recognize
20161 the processor.
20163 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20164 (for example, @option{-march=r2k}).  Prefixes are optional, and
20165 @samp{vr} may be written @samp{r}.
20167 Names of the form @samp{@var{n}f2_1} refer to processors with
20168 FPUs clocked at half the rate of the core, names of the form
20169 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20170 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20171 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20172 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20173 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20174 accepted as synonyms for @samp{@var{n}f1_1}.
20176 GCC defines two macros based on the value of this option.  The first
20177 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20178 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20179 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20180 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20181 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20183 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20184 above.  In other words, it has the full prefix and does not
20185 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20186 the macro names the resolved architecture (either @code{"mips1"} or
20187 @code{"mips3"}).  It names the default architecture when no
20188 @option{-march} option is given.
20190 @item -mtune=@var{arch}
20191 @opindex mtune
20192 Optimize for @var{arch}.  Among other things, this option controls
20193 the way instructions are scheduled, and the perceived cost of arithmetic
20194 operations.  The list of @var{arch} values is the same as for
20195 @option{-march}.
20197 When this option is not used, GCC optimizes for the processor
20198 specified by @option{-march}.  By using @option{-march} and
20199 @option{-mtune} together, it is possible to generate code that
20200 runs on a family of processors, but optimize the code for one
20201 particular member of that family.
20203 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20204 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20205 @option{-march} ones described above.
20207 @item -mips1
20208 @opindex mips1
20209 Equivalent to @option{-march=mips1}.
20211 @item -mips2
20212 @opindex mips2
20213 Equivalent to @option{-march=mips2}.
20215 @item -mips3
20216 @opindex mips3
20217 Equivalent to @option{-march=mips3}.
20219 @item -mips4
20220 @opindex mips4
20221 Equivalent to @option{-march=mips4}.
20223 @item -mips32
20224 @opindex mips32
20225 Equivalent to @option{-march=mips32}.
20227 @item -mips32r3
20228 @opindex mips32r3
20229 Equivalent to @option{-march=mips32r3}.
20231 @item -mips32r5
20232 @opindex mips32r5
20233 Equivalent to @option{-march=mips32r5}.
20235 @item -mips32r6
20236 @opindex mips32r6
20237 Equivalent to @option{-march=mips32r6}.
20239 @item -mips64
20240 @opindex mips64
20241 Equivalent to @option{-march=mips64}.
20243 @item -mips64r2
20244 @opindex mips64r2
20245 Equivalent to @option{-march=mips64r2}.
20247 @item -mips64r3
20248 @opindex mips64r3
20249 Equivalent to @option{-march=mips64r3}.
20251 @item -mips64r5
20252 @opindex mips64r5
20253 Equivalent to @option{-march=mips64r5}.
20255 @item -mips64r6
20256 @opindex mips64r6
20257 Equivalent to @option{-march=mips64r6}.
20259 @item -mips16
20260 @itemx -mno-mips16
20261 @opindex mips16
20262 @opindex mno-mips16
20263 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20264 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20266 MIPS16 code generation can also be controlled on a per-function basis
20267 by means of @code{mips16} and @code{nomips16} attributes.
20268 @xref{Function Attributes}, for more information.
20270 @item -mflip-mips16
20271 @opindex mflip-mips16
20272 Generate MIPS16 code on alternating functions.  This option is provided
20273 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20274 not intended for ordinary use in compiling user code.
20276 @item -minterlink-compressed
20277 @itemx -mno-interlink-compressed
20278 @opindex minterlink-compressed
20279 @opindex mno-interlink-compressed
20280 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20281 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20283 For example, code using the standard ISA encoding cannot jump directly
20284 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20285 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20286 knows that the target of the jump is not compressed.
20288 @item -minterlink-mips16
20289 @itemx -mno-interlink-mips16
20290 @opindex minterlink-mips16
20291 @opindex mno-interlink-mips16
20292 Aliases of @option{-minterlink-compressed} and
20293 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20294 and are retained for backwards compatibility.
20296 @item -mabi=32
20297 @itemx -mabi=o64
20298 @itemx -mabi=n32
20299 @itemx -mabi=64
20300 @itemx -mabi=eabi
20301 @opindex mabi=32
20302 @opindex mabi=o64
20303 @opindex mabi=n32
20304 @opindex mabi=64
20305 @opindex mabi=eabi
20306 Generate code for the given ABI@.
20308 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20309 generates 64-bit code when you select a 64-bit architecture, but you
20310 can use @option{-mgp32} to get 32-bit code instead.
20312 For information about the O64 ABI, see
20313 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20315 GCC supports a variant of the o32 ABI in which floating-point registers
20316 are 64 rather than 32 bits wide.  You can select this combination with
20317 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20318 and @code{mfhc1} instructions and is therefore only supported for
20319 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20321 The register assignments for arguments and return values remain the
20322 same, but each scalar value is passed in a single 64-bit register
20323 rather than a pair of 32-bit registers.  For example, scalar
20324 floating-point values are returned in @samp{$f0} only, not a
20325 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20326 remains the same in that the even-numbered double-precision registers
20327 are saved.
20329 Two additional variants of the o32 ABI are supported to enable
20330 a transition from 32-bit to 64-bit registers.  These are FPXX
20331 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20332 The FPXX extension mandates that all code must execute correctly
20333 when run using 32-bit or 64-bit registers.  The code can be interlinked
20334 with either FP32 or FP64, but not both.
20335 The FP64A extension is similar to the FP64 extension but forbids the
20336 use of odd-numbered single-precision registers.  This can be used
20337 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20338 processors and allows both FP32 and FP64A code to interlink and
20339 run in the same process without changing FPU modes.
20341 @item -mabicalls
20342 @itemx -mno-abicalls
20343 @opindex mabicalls
20344 @opindex mno-abicalls
20345 Generate (do not generate) code that is suitable for SVR4-style
20346 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20347 systems.
20349 @item -mshared
20350 @itemx -mno-shared
20351 Generate (do not generate) code that is fully position-independent,
20352 and that can therefore be linked into shared libraries.  This option
20353 only affects @option{-mabicalls}.
20355 All @option{-mabicalls} code has traditionally been position-independent,
20356 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20357 as an extension, the GNU toolchain allows executables to use absolute
20358 accesses for locally-binding symbols.  It can also use shorter GP
20359 initialization sequences and generate direct calls to locally-defined
20360 functions.  This mode is selected by @option{-mno-shared}.
20362 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20363 objects that can only be linked by the GNU linker.  However, the option
20364 does not affect the ABI of the final executable; it only affects the ABI
20365 of relocatable objects.  Using @option{-mno-shared} generally makes
20366 executables both smaller and quicker.
20368 @option{-mshared} is the default.
20370 @item -mplt
20371 @itemx -mno-plt
20372 @opindex mplt
20373 @opindex mno-plt
20374 Assume (do not assume) that the static and dynamic linkers
20375 support PLTs and copy relocations.  This option only affects
20376 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20377 has no effect without @option{-msym32}.
20379 You can make @option{-mplt} the default by configuring
20380 GCC with @option{--with-mips-plt}.  The default is
20381 @option{-mno-plt} otherwise.
20383 @item -mxgot
20384 @itemx -mno-xgot
20385 @opindex mxgot
20386 @opindex mno-xgot
20387 Lift (do not lift) the usual restrictions on the size of the global
20388 offset table.
20390 GCC normally uses a single instruction to load values from the GOT@.
20391 While this is relatively efficient, it only works if the GOT
20392 is smaller than about 64k.  Anything larger causes the linker
20393 to report an error such as:
20395 @cindex relocation truncated to fit (MIPS)
20396 @smallexample
20397 relocation truncated to fit: R_MIPS_GOT16 foobar
20398 @end smallexample
20400 If this happens, you should recompile your code with @option{-mxgot}.
20401 This works with very large GOTs, although the code is also
20402 less efficient, since it takes three instructions to fetch the
20403 value of a global symbol.
20405 Note that some linkers can create multiple GOTs.  If you have such a
20406 linker, you should only need to use @option{-mxgot} when a single object
20407 file accesses more than 64k's worth of GOT entries.  Very few do.
20409 These options have no effect unless GCC is generating position
20410 independent code.
20412 @item -mgp32
20413 @opindex mgp32
20414 Assume that general-purpose registers are 32 bits wide.
20416 @item -mgp64
20417 @opindex mgp64
20418 Assume that general-purpose registers are 64 bits wide.
20420 @item -mfp32
20421 @opindex mfp32
20422 Assume that floating-point registers are 32 bits wide.
20424 @item -mfp64
20425 @opindex mfp64
20426 Assume that floating-point registers are 64 bits wide.
20428 @item -mfpxx
20429 @opindex mfpxx
20430 Do not assume the width of floating-point registers.
20432 @item -mhard-float
20433 @opindex mhard-float
20434 Use floating-point coprocessor instructions.
20436 @item -msoft-float
20437 @opindex msoft-float
20438 Do not use floating-point coprocessor instructions.  Implement
20439 floating-point calculations using library calls instead.
20441 @item -mno-float
20442 @opindex mno-float
20443 Equivalent to @option{-msoft-float}, but additionally asserts that the
20444 program being compiled does not perform any floating-point operations.
20445 This option is presently supported only by some bare-metal MIPS
20446 configurations, where it may select a special set of libraries
20447 that lack all floating-point support (including, for example, the
20448 floating-point @code{printf} formats).  
20449 If code compiled with @option{-mno-float} accidentally contains
20450 floating-point operations, it is likely to suffer a link-time
20451 or run-time failure.
20453 @item -msingle-float
20454 @opindex msingle-float
20455 Assume that the floating-point coprocessor only supports single-precision
20456 operations.
20458 @item -mdouble-float
20459 @opindex mdouble-float
20460 Assume that the floating-point coprocessor supports double-precision
20461 operations.  This is the default.
20463 @item -modd-spreg
20464 @itemx -mno-odd-spreg
20465 @opindex modd-spreg
20466 @opindex mno-odd-spreg
20467 Enable the use of odd-numbered single-precision floating-point registers
20468 for the o32 ABI.  This is the default for processors that are known to
20469 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20470 is set by default.
20472 @item -mabs=2008
20473 @itemx -mabs=legacy
20474 @opindex mabs=2008
20475 @opindex mabs=legacy
20476 These options control the treatment of the special not-a-number (NaN)
20477 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20478 @code{neg.@i{fmt}} machine instructions.
20480 By default or when @option{-mabs=legacy} is used the legacy
20481 treatment is selected.  In this case these instructions are considered
20482 arithmetic and avoided where correct operation is required and the
20483 input operand might be a NaN.  A longer sequence of instructions that
20484 manipulate the sign bit of floating-point datum manually is used
20485 instead unless the @option{-ffinite-math-only} option has also been
20486 specified.
20488 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20489 this case these instructions are considered non-arithmetic and therefore
20490 operating correctly in all cases, including in particular where the
20491 input operand is a NaN.  These instructions are therefore always used
20492 for the respective operations.
20494 @item -mnan=2008
20495 @itemx -mnan=legacy
20496 @opindex mnan=2008
20497 @opindex mnan=legacy
20498 These options control the encoding of the special not-a-number (NaN)
20499 IEEE 754 floating-point data.
20501 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20502 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20503 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20504 by the first bit of their trailing significand field being 1.
20506 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20507 this case qNaNs are denoted by the first bit of their trailing
20508 significand field being 1, whereas sNaNs are denoted by the first bit of
20509 their trailing significand field being 0.
20511 The default is @option{-mnan=legacy} unless GCC has been configured with
20512 @option{--with-nan=2008}.
20514 @item -mllsc
20515 @itemx -mno-llsc
20516 @opindex mllsc
20517 @opindex mno-llsc
20518 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20519 implement atomic memory built-in functions.  When neither option is
20520 specified, GCC uses the instructions if the target architecture
20521 supports them.
20523 @option{-mllsc} is useful if the runtime environment can emulate the
20524 instructions and @option{-mno-llsc} can be useful when compiling for
20525 nonstandard ISAs.  You can make either option the default by
20526 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20527 respectively.  @option{--with-llsc} is the default for some
20528 configurations; see the installation documentation for details.
20530 @item -mdsp
20531 @itemx -mno-dsp
20532 @opindex mdsp
20533 @opindex mno-dsp
20534 Use (do not use) revision 1 of the MIPS DSP ASE@.
20535 @xref{MIPS DSP Built-in Functions}.  This option defines the
20536 preprocessor macro @code{__mips_dsp}.  It also defines
20537 @code{__mips_dsp_rev} to 1.
20539 @item -mdspr2
20540 @itemx -mno-dspr2
20541 @opindex mdspr2
20542 @opindex mno-dspr2
20543 Use (do not use) revision 2 of the MIPS DSP ASE@.
20544 @xref{MIPS DSP Built-in Functions}.  This option defines the
20545 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20546 It also defines @code{__mips_dsp_rev} to 2.
20548 @item -msmartmips
20549 @itemx -mno-smartmips
20550 @opindex msmartmips
20551 @opindex mno-smartmips
20552 Use (do not use) the MIPS SmartMIPS ASE.
20554 @item -mpaired-single
20555 @itemx -mno-paired-single
20556 @opindex mpaired-single
20557 @opindex mno-paired-single
20558 Use (do not use) paired-single floating-point instructions.
20559 @xref{MIPS Paired-Single Support}.  This option requires
20560 hardware floating-point support to be enabled.
20562 @item -mdmx
20563 @itemx -mno-mdmx
20564 @opindex mdmx
20565 @opindex mno-mdmx
20566 Use (do not use) MIPS Digital Media Extension instructions.
20567 This option can only be used when generating 64-bit code and requires
20568 hardware floating-point support to be enabled.
20570 @item -mips3d
20571 @itemx -mno-mips3d
20572 @opindex mips3d
20573 @opindex mno-mips3d
20574 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20575 The option @option{-mips3d} implies @option{-mpaired-single}.
20577 @item -mmicromips
20578 @itemx -mno-micromips
20579 @opindex mmicromips
20580 @opindex mno-mmicromips
20581 Generate (do not generate) microMIPS code.
20583 MicroMIPS code generation can also be controlled on a per-function basis
20584 by means of @code{micromips} and @code{nomicromips} attributes.
20585 @xref{Function Attributes}, for more information.
20587 @item -mmt
20588 @itemx -mno-mt
20589 @opindex mmt
20590 @opindex mno-mt
20591 Use (do not use) MT Multithreading instructions.
20593 @item -mmcu
20594 @itemx -mno-mcu
20595 @opindex mmcu
20596 @opindex mno-mcu
20597 Use (do not use) the MIPS MCU ASE instructions.
20599 @item -meva
20600 @itemx -mno-eva
20601 @opindex meva
20602 @opindex mno-eva
20603 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20605 @item -mvirt
20606 @itemx -mno-virt
20607 @opindex mvirt
20608 @opindex mno-virt
20609 Use (do not use) the MIPS Virtualization (VZ) instructions.
20611 @item -mxpa
20612 @itemx -mno-xpa
20613 @opindex mxpa
20614 @opindex mno-xpa
20615 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20617 @item -mlong64
20618 @opindex mlong64
20619 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20620 an explanation of the default and the way that the pointer size is
20621 determined.
20623 @item -mlong32
20624 @opindex mlong32
20625 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20627 The default size of @code{int}s, @code{long}s and pointers depends on
20628 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20629 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20630 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20631 or the same size as integer registers, whichever is smaller.
20633 @item -msym32
20634 @itemx -mno-sym32
20635 @opindex msym32
20636 @opindex mno-sym32
20637 Assume (do not assume) that all symbols have 32-bit values, regardless
20638 of the selected ABI@.  This option is useful in combination with
20639 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20640 to generate shorter and faster references to symbolic addresses.
20642 @item -G @var{num}
20643 @opindex G
20644 Put definitions of externally-visible data in a small data section
20645 if that data is no bigger than @var{num} bytes.  GCC can then generate
20646 more efficient accesses to the data; see @option{-mgpopt} for details.
20648 The default @option{-G} option depends on the configuration.
20650 @item -mlocal-sdata
20651 @itemx -mno-local-sdata
20652 @opindex mlocal-sdata
20653 @opindex mno-local-sdata
20654 Extend (do not extend) the @option{-G} behavior to local data too,
20655 such as to static variables in C@.  @option{-mlocal-sdata} is the
20656 default for all configurations.
20658 If the linker complains that an application is using too much small data,
20659 you might want to try rebuilding the less performance-critical parts with
20660 @option{-mno-local-sdata}.  You might also want to build large
20661 libraries with @option{-mno-local-sdata}, so that the libraries leave
20662 more room for the main program.
20664 @item -mextern-sdata
20665 @itemx -mno-extern-sdata
20666 @opindex mextern-sdata
20667 @opindex mno-extern-sdata
20668 Assume (do not assume) that externally-defined data is in
20669 a small data section if the size of that data is within the @option{-G} limit.
20670 @option{-mextern-sdata} is the default for all configurations.
20672 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20673 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20674 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20675 is placed in a small data section.  If @var{Var} is defined by another
20676 module, you must either compile that module with a high-enough
20677 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20678 definition.  If @var{Var} is common, you must link the application
20679 with a high-enough @option{-G} setting.
20681 The easiest way of satisfying these restrictions is to compile
20682 and link every module with the same @option{-G} option.  However,
20683 you may wish to build a library that supports several different
20684 small data limits.  You can do this by compiling the library with
20685 the highest supported @option{-G} setting and additionally using
20686 @option{-mno-extern-sdata} to stop the library from making assumptions
20687 about externally-defined data.
20689 @item -mgpopt
20690 @itemx -mno-gpopt
20691 @opindex mgpopt
20692 @opindex mno-gpopt
20693 Use (do not use) GP-relative accesses for symbols that are known to be
20694 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20695 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20696 configurations.
20698 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20699 might not hold the value of @code{_gp}.  For example, if the code is
20700 part of a library that might be used in a boot monitor, programs that
20701 call boot monitor routines pass an unknown value in @code{$gp}.
20702 (In such situations, the boot monitor itself is usually compiled
20703 with @option{-G0}.)
20705 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20706 @option{-mno-extern-sdata}.
20708 @item -membedded-data
20709 @itemx -mno-embedded-data
20710 @opindex membedded-data
20711 @opindex mno-embedded-data
20712 Allocate variables to the read-only data section first if possible, then
20713 next in the small data section if possible, otherwise in data.  This gives
20714 slightly slower code than the default, but reduces the amount of RAM required
20715 when executing, and thus may be preferred for some embedded systems.
20717 @item -muninit-const-in-rodata
20718 @itemx -mno-uninit-const-in-rodata
20719 @opindex muninit-const-in-rodata
20720 @opindex mno-uninit-const-in-rodata
20721 Put uninitialized @code{const} variables in the read-only data section.
20722 This option is only meaningful in conjunction with @option{-membedded-data}.
20724 @item -mcode-readable=@var{setting}
20725 @opindex mcode-readable
20726 Specify whether GCC may generate code that reads from executable sections.
20727 There are three possible settings:
20729 @table @gcctabopt
20730 @item -mcode-readable=yes
20731 Instructions may freely access executable sections.  This is the
20732 default setting.
20734 @item -mcode-readable=pcrel
20735 MIPS16 PC-relative load instructions can access executable sections,
20736 but other instructions must not do so.  This option is useful on 4KSc
20737 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20738 It is also useful on processors that can be configured to have a dual
20739 instruction/data SRAM interface and that, like the M4K, automatically
20740 redirect PC-relative loads to the instruction RAM.
20742 @item -mcode-readable=no
20743 Instructions must not access executable sections.  This option can be
20744 useful on targets that are configured to have a dual instruction/data
20745 SRAM interface but that (unlike the M4K) do not automatically redirect
20746 PC-relative loads to the instruction RAM.
20747 @end table
20749 @item -msplit-addresses
20750 @itemx -mno-split-addresses
20751 @opindex msplit-addresses
20752 @opindex mno-split-addresses
20753 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20754 relocation operators.  This option has been superseded by
20755 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20757 @item -mexplicit-relocs
20758 @itemx -mno-explicit-relocs
20759 @opindex mexplicit-relocs
20760 @opindex mno-explicit-relocs
20761 Use (do not use) assembler relocation operators when dealing with symbolic
20762 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20763 is to use assembler macros instead.
20765 @option{-mexplicit-relocs} is the default if GCC was configured
20766 to use an assembler that supports relocation operators.
20768 @item -mcheck-zero-division
20769 @itemx -mno-check-zero-division
20770 @opindex mcheck-zero-division
20771 @opindex mno-check-zero-division
20772 Trap (do not trap) on integer division by zero.
20774 The default is @option{-mcheck-zero-division}.
20776 @item -mdivide-traps
20777 @itemx -mdivide-breaks
20778 @opindex mdivide-traps
20779 @opindex mdivide-breaks
20780 MIPS systems check for division by zero by generating either a
20781 conditional trap or a break instruction.  Using traps results in
20782 smaller code, but is only supported on MIPS II and later.  Also, some
20783 versions of the Linux kernel have a bug that prevents trap from
20784 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20785 allow conditional traps on architectures that support them and
20786 @option{-mdivide-breaks} to force the use of breaks.
20788 The default is usually @option{-mdivide-traps}, but this can be
20789 overridden at configure time using @option{--with-divide=breaks}.
20790 Divide-by-zero checks can be completely disabled using
20791 @option{-mno-check-zero-division}.
20793 @item -mload-store-pairs
20794 @itemx -mno-load-store-pairs
20795 @opindex mload-store-pairs
20796 @opindex mno-load-store-pairs
20797 Enable (disable) an optimization that pairs consecutive load or store
20798 instructions to enable load/store bonding.  This option is enabled by
20799 default but only takes effect when the selected architecture is known
20800 to support bonding.
20802 @item -mmemcpy
20803 @itemx -mno-memcpy
20804 @opindex mmemcpy
20805 @opindex mno-memcpy
20806 Force (do not force) the use of @code{memcpy} for non-trivial block
20807 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20808 most constant-sized copies.
20810 @item -mlong-calls
20811 @itemx -mno-long-calls
20812 @opindex mlong-calls
20813 @opindex mno-long-calls
20814 Disable (do not disable) use of the @code{jal} instruction.  Calling
20815 functions using @code{jal} is more efficient but requires the caller
20816 and callee to be in the same 256 megabyte segment.
20818 This option has no effect on abicalls code.  The default is
20819 @option{-mno-long-calls}.
20821 @item -mmad
20822 @itemx -mno-mad
20823 @opindex mmad
20824 @opindex mno-mad
20825 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20826 instructions, as provided by the R4650 ISA@.
20828 @item -mimadd
20829 @itemx -mno-imadd
20830 @opindex mimadd
20831 @opindex mno-imadd
20832 Enable (disable) use of the @code{madd} and @code{msub} integer
20833 instructions.  The default is @option{-mimadd} on architectures
20834 that support @code{madd} and @code{msub} except for the 74k 
20835 architecture where it was found to generate slower code.
20837 @item -mfused-madd
20838 @itemx -mno-fused-madd
20839 @opindex mfused-madd
20840 @opindex mno-fused-madd
20841 Enable (disable) use of the floating-point multiply-accumulate
20842 instructions, when they are available.  The default is
20843 @option{-mfused-madd}.
20845 On the R8000 CPU when multiply-accumulate instructions are used,
20846 the intermediate product is calculated to infinite precision
20847 and is not subject to the FCSR Flush to Zero bit.  This may be
20848 undesirable in some circumstances.  On other processors the result
20849 is numerically identical to the equivalent computation using
20850 separate multiply, add, subtract and negate instructions.
20852 @item -nocpp
20853 @opindex nocpp
20854 Tell the MIPS assembler to not run its preprocessor over user
20855 assembler files (with a @samp{.s} suffix) when assembling them.
20857 @item -mfix-24k
20858 @itemx -mno-fix-24k
20859 @opindex mfix-24k
20860 @opindex mno-fix-24k
20861 Work around the 24K E48 (lost data on stores during refill) errata.
20862 The workarounds are implemented by the assembler rather than by GCC@.
20864 @item -mfix-r4000
20865 @itemx -mno-fix-r4000
20866 @opindex mfix-r4000
20867 @opindex mno-fix-r4000
20868 Work around certain R4000 CPU errata:
20869 @itemize @minus
20870 @item
20871 A double-word or a variable shift may give an incorrect result if executed
20872 immediately after starting an integer division.
20873 @item
20874 A double-word or a variable shift may give an incorrect result if executed
20875 while an integer multiplication is in progress.
20876 @item
20877 An integer division may give an incorrect result if started in a delay slot
20878 of a taken branch or a jump.
20879 @end itemize
20881 @item -mfix-r4400
20882 @itemx -mno-fix-r4400
20883 @opindex mfix-r4400
20884 @opindex mno-fix-r4400
20885 Work around certain R4400 CPU errata:
20886 @itemize @minus
20887 @item
20888 A double-word or a variable shift may give an incorrect result if executed
20889 immediately after starting an integer division.
20890 @end itemize
20892 @item -mfix-r10000
20893 @itemx -mno-fix-r10000
20894 @opindex mfix-r10000
20895 @opindex mno-fix-r10000
20896 Work around certain R10000 errata:
20897 @itemize @minus
20898 @item
20899 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20900 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20901 @end itemize
20903 This option can only be used if the target architecture supports
20904 branch-likely instructions.  @option{-mfix-r10000} is the default when
20905 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20906 otherwise.
20908 @item -mfix-rm7000
20909 @itemx -mno-fix-rm7000
20910 @opindex mfix-rm7000
20911 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20912 workarounds are implemented by the assembler rather than by GCC@.
20914 @item -mfix-vr4120
20915 @itemx -mno-fix-vr4120
20916 @opindex mfix-vr4120
20917 Work around certain VR4120 errata:
20918 @itemize @minus
20919 @item
20920 @code{dmultu} does not always produce the correct result.
20921 @item
20922 @code{div} and @code{ddiv} do not always produce the correct result if one
20923 of the operands is negative.
20924 @end itemize
20925 The workarounds for the division errata rely on special functions in
20926 @file{libgcc.a}.  At present, these functions are only provided by
20927 the @code{mips64vr*-elf} configurations.
20929 Other VR4120 errata require a NOP to be inserted between certain pairs of
20930 instructions.  These errata are handled by the assembler, not by GCC itself.
20932 @item -mfix-vr4130
20933 @opindex mfix-vr4130
20934 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20935 workarounds are implemented by the assembler rather than by GCC,
20936 although GCC avoids using @code{mflo} and @code{mfhi} if the
20937 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20938 instructions are available instead.
20940 @item -mfix-sb1
20941 @itemx -mno-fix-sb1
20942 @opindex mfix-sb1
20943 Work around certain SB-1 CPU core errata.
20944 (This flag currently works around the SB-1 revision 2
20945 ``F1'' and ``F2'' floating-point errata.)
20947 @item -mr10k-cache-barrier=@var{setting}
20948 @opindex mr10k-cache-barrier
20949 Specify whether GCC should insert cache barriers to avoid the
20950 side effects of speculation on R10K processors.
20952 In common with many processors, the R10K tries to predict the outcome
20953 of a conditional branch and speculatively executes instructions from
20954 the ``taken'' branch.  It later aborts these instructions if the
20955 predicted outcome is wrong.  However, on the R10K, even aborted
20956 instructions can have side effects.
20958 This problem only affects kernel stores and, depending on the system,
20959 kernel loads.  As an example, a speculatively-executed store may load
20960 the target memory into cache and mark the cache line as dirty, even if
20961 the store itself is later aborted.  If a DMA operation writes to the
20962 same area of memory before the ``dirty'' line is flushed, the cached
20963 data overwrites the DMA-ed data.  See the R10K processor manual
20964 for a full description, including other potential problems.
20966 One workaround is to insert cache barrier instructions before every memory
20967 access that might be speculatively executed and that might have side
20968 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20969 controls GCC's implementation of this workaround.  It assumes that
20970 aborted accesses to any byte in the following regions does not have
20971 side effects:
20973 @enumerate
20974 @item
20975 the memory occupied by the current function's stack frame;
20977 @item
20978 the memory occupied by an incoming stack argument;
20980 @item
20981 the memory occupied by an object with a link-time-constant address.
20982 @end enumerate
20984 It is the kernel's responsibility to ensure that speculative
20985 accesses to these regions are indeed safe.
20987 If the input program contains a function declaration such as:
20989 @smallexample
20990 void foo (void);
20991 @end smallexample
20993 then the implementation of @code{foo} must allow @code{j foo} and
20994 @code{jal foo} to be executed speculatively.  GCC honors this
20995 restriction for functions it compiles itself.  It expects non-GCC
20996 functions (such as hand-written assembly code) to do the same.
20998 The option has three forms:
21000 @table @gcctabopt
21001 @item -mr10k-cache-barrier=load-store
21002 Insert a cache barrier before a load or store that might be
21003 speculatively executed and that might have side effects even
21004 if aborted.
21006 @item -mr10k-cache-barrier=store
21007 Insert a cache barrier before a store that might be speculatively
21008 executed and that might have side effects even if aborted.
21010 @item -mr10k-cache-barrier=none
21011 Disable the insertion of cache barriers.  This is the default setting.
21012 @end table
21014 @item -mflush-func=@var{func}
21015 @itemx -mno-flush-func
21016 @opindex mflush-func
21017 Specifies the function to call to flush the I and D caches, or to not
21018 call any such function.  If called, the function must take the same
21019 arguments as the common @code{_flush_func}, that is, the address of the
21020 memory range for which the cache is being flushed, the size of the
21021 memory range, and the number 3 (to flush both caches).  The default
21022 depends on the target GCC was configured for, but commonly is either
21023 @code{_flush_func} or @code{__cpu_flush}.
21025 @item mbranch-cost=@var{num}
21026 @opindex mbranch-cost
21027 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21028 This cost is only a heuristic and is not guaranteed to produce
21029 consistent results across releases.  A zero cost redundantly selects
21030 the default, which is based on the @option{-mtune} setting.
21032 @item -mbranch-likely
21033 @itemx -mno-branch-likely
21034 @opindex mbranch-likely
21035 @opindex mno-branch-likely
21036 Enable or disable use of Branch Likely instructions, regardless of the
21037 default for the selected architecture.  By default, Branch Likely
21038 instructions may be generated if they are supported by the selected
21039 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21040 and processors that implement those architectures; for those, Branch
21041 Likely instructions are not be generated by default because the MIPS32
21042 and MIPS64 architectures specifically deprecate their use.
21044 @item -mcompact-branches=never
21045 @itemx -mcompact-branches=optimal
21046 @itemx -mcompact-branches=always
21047 @opindex mcompact-branches=never
21048 @opindex mcompact-branches=optimal
21049 @opindex mcompact-branches=always
21050 These options control which form of branches will be generated.  The
21051 default is @option{-mcompact-branches=optimal}.
21053 The @option{-mcompact-branches=never} option ensures that compact branch
21054 instructions will never be generated.
21056 The @option{-mcompact-branches=always} option ensures that a compact
21057 branch instruction will be generated if available.  If a compact branch
21058 instruction is not available, a delay slot form of the branch will be
21059 used instead.
21061 This option is supported from MIPS Release 6 onwards.
21063 The @option{-mcompact-branches=optimal} option will cause a delay slot
21064 branch to be used if one is available in the current ISA and the delay
21065 slot is successfully filled.  If the delay slot is not filled, a compact
21066 branch will be chosen if one is available.
21068 @item -mfp-exceptions
21069 @itemx -mno-fp-exceptions
21070 @opindex mfp-exceptions
21071 Specifies whether FP exceptions are enabled.  This affects how
21072 FP instructions are scheduled for some processors.
21073 The default is that FP exceptions are
21074 enabled.
21076 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21077 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21078 FP pipe.
21080 @item -mvr4130-align
21081 @itemx -mno-vr4130-align
21082 @opindex mvr4130-align
21083 The VR4130 pipeline is two-way superscalar, but can only issue two
21084 instructions together if the first one is 8-byte aligned.  When this
21085 option is enabled, GCC aligns pairs of instructions that it
21086 thinks should execute in parallel.
21088 This option only has an effect when optimizing for the VR4130.
21089 It normally makes code faster, but at the expense of making it bigger.
21090 It is enabled by default at optimization level @option{-O3}.
21092 @item -msynci
21093 @itemx -mno-synci
21094 @opindex msynci
21095 Enable (disable) generation of @code{synci} instructions on
21096 architectures that support it.  The @code{synci} instructions (if
21097 enabled) are generated when @code{__builtin___clear_cache} is
21098 compiled.
21100 This option defaults to @option{-mno-synci}, but the default can be
21101 overridden by configuring GCC with @option{--with-synci}.
21103 When compiling code for single processor systems, it is generally safe
21104 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21105 does not invalidate the instruction caches on all cores and may lead
21106 to undefined behavior.
21108 @item -mrelax-pic-calls
21109 @itemx -mno-relax-pic-calls
21110 @opindex mrelax-pic-calls
21111 Try to turn PIC calls that are normally dispatched via register
21112 @code{$25} into direct calls.  This is only possible if the linker can
21113 resolve the destination at link time and if the destination is within
21114 range for a direct call.
21116 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21117 an assembler and a linker that support the @code{.reloc} assembly
21118 directive and @option{-mexplicit-relocs} is in effect.  With
21119 @option{-mno-explicit-relocs}, this optimization can be performed by the
21120 assembler and the linker alone without help from the compiler.
21122 @item -mmcount-ra-address
21123 @itemx -mno-mcount-ra-address
21124 @opindex mmcount-ra-address
21125 @opindex mno-mcount-ra-address
21126 Emit (do not emit) code that allows @code{_mcount} to modify the
21127 calling function's return address.  When enabled, this option extends
21128 the usual @code{_mcount} interface with a new @var{ra-address}
21129 parameter, which has type @code{intptr_t *} and is passed in register
21130 @code{$12}.  @code{_mcount} can then modify the return address by
21131 doing both of the following:
21132 @itemize
21133 @item
21134 Returning the new address in register @code{$31}.
21135 @item
21136 Storing the new address in @code{*@var{ra-address}},
21137 if @var{ra-address} is nonnull.
21138 @end itemize
21140 The default is @option{-mno-mcount-ra-address}.
21142 @item -mframe-header-opt
21143 @itemx -mno-frame-header-opt
21144 @opindex mframe-header-opt
21145 Enable (disable) frame header optimization in the o32 ABI.  When using the
21146 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21147 function to write out register arguments.  When enabled, this optimization
21148 will suppress the allocation of the frame header if it can be determined that
21149 it is unused.
21151 This optimization is off by default at all optimization levels.
21153 @item -mlxc1-sxc1
21154 @itemx -mno-lxc1-sxc1
21155 @opindex mlxc1-sxc1
21156 When applicable, enable (disable) the generation of @code{lwxc1},
21157 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21159 @item -mmadd4
21160 @itemx -mno-madd4
21161 @opindex mmadd4
21162 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21163 @code{madd.d} and related instructions.  Enabled by default.
21165 @end table
21167 @node MMIX Options
21168 @subsection MMIX Options
21169 @cindex MMIX Options
21171 These options are defined for the MMIX:
21173 @table @gcctabopt
21174 @item -mlibfuncs
21175 @itemx -mno-libfuncs
21176 @opindex mlibfuncs
21177 @opindex mno-libfuncs
21178 Specify that intrinsic library functions are being compiled, passing all
21179 values in registers, no matter the size.
21181 @item -mepsilon
21182 @itemx -mno-epsilon
21183 @opindex mepsilon
21184 @opindex mno-epsilon
21185 Generate floating-point comparison instructions that compare with respect
21186 to the @code{rE} epsilon register.
21188 @item -mabi=mmixware
21189 @itemx -mabi=gnu
21190 @opindex mabi=mmixware
21191 @opindex mabi=gnu
21192 Generate code that passes function parameters and return values that (in
21193 the called function) are seen as registers @code{$0} and up, as opposed to
21194 the GNU ABI which uses global registers @code{$231} and up.
21196 @item -mzero-extend
21197 @itemx -mno-zero-extend
21198 @opindex mzero-extend
21199 @opindex mno-zero-extend
21200 When reading data from memory in sizes shorter than 64 bits, use (do not
21201 use) zero-extending load instructions by default, rather than
21202 sign-extending ones.
21204 @item -mknuthdiv
21205 @itemx -mno-knuthdiv
21206 @opindex mknuthdiv
21207 @opindex mno-knuthdiv
21208 Make the result of a division yielding a remainder have the same sign as
21209 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21210 remainder follows the sign of the dividend.  Both methods are
21211 arithmetically valid, the latter being almost exclusively used.
21213 @item -mtoplevel-symbols
21214 @itemx -mno-toplevel-symbols
21215 @opindex mtoplevel-symbols
21216 @opindex mno-toplevel-symbols
21217 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21218 code can be used with the @code{PREFIX} assembly directive.
21220 @item -melf
21221 @opindex melf
21222 Generate an executable in the ELF format, rather than the default
21223 @samp{mmo} format used by the @command{mmix} simulator.
21225 @item -mbranch-predict
21226 @itemx -mno-branch-predict
21227 @opindex mbranch-predict
21228 @opindex mno-branch-predict
21229 Use (do not use) the probable-branch instructions, when static branch
21230 prediction indicates a probable branch.
21232 @item -mbase-addresses
21233 @itemx -mno-base-addresses
21234 @opindex mbase-addresses
21235 @opindex mno-base-addresses
21236 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21237 base address automatically generates a request (handled by the assembler
21238 and the linker) for a constant to be set up in a global register.  The
21239 register is used for one or more base address requests within the range 0
21240 to 255 from the value held in the register.  The generally leads to short
21241 and fast code, but the number of different data items that can be
21242 addressed is limited.  This means that a program that uses lots of static
21243 data may require @option{-mno-base-addresses}.
21245 @item -msingle-exit
21246 @itemx -mno-single-exit
21247 @opindex msingle-exit
21248 @opindex mno-single-exit
21249 Force (do not force) generated code to have a single exit point in each
21250 function.
21251 @end table
21253 @node MN10300 Options
21254 @subsection MN10300 Options
21255 @cindex MN10300 options
21257 These @option{-m} options are defined for Matsushita MN10300 architectures:
21259 @table @gcctabopt
21260 @item -mmult-bug
21261 @opindex mmult-bug
21262 Generate code to avoid bugs in the multiply instructions for the MN10300
21263 processors.  This is the default.
21265 @item -mno-mult-bug
21266 @opindex mno-mult-bug
21267 Do not generate code to avoid bugs in the multiply instructions for the
21268 MN10300 processors.
21270 @item -mam33
21271 @opindex mam33
21272 Generate code using features specific to the AM33 processor.
21274 @item -mno-am33
21275 @opindex mno-am33
21276 Do not generate code using features specific to the AM33 processor.  This
21277 is the default.
21279 @item -mam33-2
21280 @opindex mam33-2
21281 Generate code using features specific to the AM33/2.0 processor.
21283 @item -mam34
21284 @opindex mam34
21285 Generate code using features specific to the AM34 processor.
21287 @item -mtune=@var{cpu-type}
21288 @opindex mtune
21289 Use the timing characteristics of the indicated CPU type when
21290 scheduling instructions.  This does not change the targeted processor
21291 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21292 @samp{am33-2} or @samp{am34}.
21294 @item -mreturn-pointer-on-d0
21295 @opindex mreturn-pointer-on-d0
21296 When generating a function that returns a pointer, return the pointer
21297 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21298 only in @code{a0}, and attempts to call such functions without a prototype
21299 result in errors.  Note that this option is on by default; use
21300 @option{-mno-return-pointer-on-d0} to disable it.
21302 @item -mno-crt0
21303 @opindex mno-crt0
21304 Do not link in the C run-time initialization object file.
21306 @item -mrelax
21307 @opindex mrelax
21308 Indicate to the linker that it should perform a relaxation optimization pass
21309 to shorten branches, calls and absolute memory addresses.  This option only
21310 has an effect when used on the command line for the final link step.
21312 This option makes symbolic debugging impossible.
21314 @item -mliw
21315 @opindex mliw
21316 Allow the compiler to generate @emph{Long Instruction Word}
21317 instructions if the target is the @samp{AM33} or later.  This is the
21318 default.  This option defines the preprocessor macro @code{__LIW__}.
21320 @item -mnoliw
21321 @opindex mnoliw
21322 Do not allow the compiler to generate @emph{Long Instruction Word}
21323 instructions.  This option defines the preprocessor macro
21324 @code{__NO_LIW__}.
21326 @item -msetlb
21327 @opindex msetlb
21328 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21329 instructions if the target is the @samp{AM33} or later.  This is the
21330 default.  This option defines the preprocessor macro @code{__SETLB__}.
21332 @item -mnosetlb
21333 @opindex mnosetlb
21334 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21335 instructions.  This option defines the preprocessor macro
21336 @code{__NO_SETLB__}.
21338 @end table
21340 @node Moxie Options
21341 @subsection Moxie Options
21342 @cindex Moxie Options
21344 @table @gcctabopt
21346 @item -meb
21347 @opindex meb
21348 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21349 configurations.
21351 @item -mel
21352 @opindex mel
21353 Generate little-endian code.
21355 @item -mmul.x
21356 @opindex mmul.x
21357 Generate mul.x and umul.x instructions.  This is the default for
21358 @samp{moxiebox-*-*} configurations.
21360 @item -mno-crt0
21361 @opindex mno-crt0
21362 Do not link in the C run-time initialization object file.
21364 @end table
21366 @node MSP430 Options
21367 @subsection MSP430 Options
21368 @cindex MSP430 Options
21370 These options are defined for the MSP430:
21372 @table @gcctabopt
21374 @item -masm-hex
21375 @opindex masm-hex
21376 Force assembly output to always use hex constants.  Normally such
21377 constants are signed decimals, but this option is available for
21378 testsuite and/or aesthetic purposes.
21380 @item -mmcu=
21381 @opindex mmcu=
21382 Select the MCU to target.  This is used to create a C preprocessor
21383 symbol based upon the MCU name, converted to upper case and pre- and
21384 post-fixed with @samp{__}.  This in turn is used by the
21385 @file{msp430.h} header file to select an MCU-specific supplementary
21386 header file.
21388 The option also sets the ISA to use.  If the MCU name is one that is
21389 known to only support the 430 ISA then that is selected, otherwise the
21390 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21391 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21392 name selects the 430X ISA.
21394 In addition an MCU-specific linker script is added to the linker
21395 command line.  The script's name is the name of the MCU with
21396 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21397 command line defines the C preprocessor symbol @code{__XXX__} and
21398 cause the linker to search for a script called @file{xxx.ld}.
21400 This option is also passed on to the assembler.
21402 @item -mwarn-mcu
21403 @itemx -mno-warn-mcu
21404 @opindex mwarn-mcu
21405 @opindex mno-warn-mcu
21406 This option enables or disables warnings about conflicts between the
21407 MCU name specified by the @option{-mmcu} option and the ISA set by the
21408 @option{-mcpu} option and/or the hardware multiply support set by the
21409 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21410 MCU names.  This option is on by default.
21412 @item -mcpu=
21413 @opindex mcpu=
21414 Specifies the ISA to use.  Accepted values are @samp{msp430},
21415 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21416 @option{-mmcu=} option should be used to select the ISA.
21418 @item -msim
21419 @opindex msim
21420 Link to the simulator runtime libraries and linker script.  Overrides
21421 any scripts that would be selected by the @option{-mmcu=} option.
21423 @item -mlarge
21424 @opindex mlarge
21425 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21427 @item -msmall
21428 @opindex msmall
21429 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21431 @item -mrelax
21432 @opindex mrelax
21433 This option is passed to the assembler and linker, and allows the
21434 linker to perform certain optimizations that cannot be done until
21435 the final link.
21437 @item mhwmult=
21438 @opindex mhwmult=
21439 Describes the type of hardware multiply supported by the target.
21440 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21441 for the original 16-bit-only multiply supported by early MCUs.
21442 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21443 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21444 A value of @samp{auto} can also be given.  This tells GCC to deduce
21445 the hardware multiply support based upon the MCU name provided by the
21446 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21447 the MCU name is not recognized then no hardware multiply support is
21448 assumed.  @code{auto} is the default setting.
21450 Hardware multiplies are normally performed by calling a library
21451 routine.  This saves space in the generated code.  When compiling at
21452 @option{-O3} or higher however the hardware multiplier is invoked
21453 inline.  This makes for bigger, but faster code.
21455 The hardware multiply routines disable interrupts whilst running and
21456 restore the previous interrupt state when they finish.  This makes
21457 them safe to use inside interrupt handlers as well as in normal code.
21459 @item -minrt
21460 @opindex minrt
21461 Enable the use of a minimum runtime environment - no static
21462 initializers or constructors.  This is intended for memory-constrained
21463 devices.  The compiler includes special symbols in some objects
21464 that tell the linker and runtime which code fragments are required.
21466 @item -mcode-region=
21467 @itemx -mdata-region=
21468 @opindex mcode-region
21469 @opindex mdata-region
21470 These options tell the compiler where to place functions and data that
21471 do not have one of the @code{lower}, @code{upper}, @code{either} or
21472 @code{section} attributes.  Possible values are @code{lower},
21473 @code{upper}, @code{either} or @code{any}.  The first three behave
21474 like the corresponding attribute.  The fourth possible value -
21475 @code{any} - is the default.  It leaves placement entirely up to the
21476 linker script and how it assigns the standard sections
21477 (@code{.text}, @code{.data}, etc) to the memory regions.
21479 @item -msilicon-errata=
21480 @opindex msilicon-errata
21481 This option passes on a request to assembler to enable the fixes for
21482 the named silicon errata.
21484 @item -msilicon-errata-warn=
21485 @opindex msilicon-errata-warn
21486 This option passes on a request to the assembler to enable warning
21487 messages when a silicon errata might need to be applied.
21489 @end table
21491 @node NDS32 Options
21492 @subsection NDS32 Options
21493 @cindex NDS32 Options
21495 These options are defined for NDS32 implementations:
21497 @table @gcctabopt
21499 @item -mbig-endian
21500 @opindex mbig-endian
21501 Generate code in big-endian mode.
21503 @item -mlittle-endian
21504 @opindex mlittle-endian
21505 Generate code in little-endian mode.
21507 @item -mreduced-regs
21508 @opindex mreduced-regs
21509 Use reduced-set registers for register allocation.
21511 @item -mfull-regs
21512 @opindex mfull-regs
21513 Use full-set registers for register allocation.
21515 @item -mcmov
21516 @opindex mcmov
21517 Generate conditional move instructions.
21519 @item -mno-cmov
21520 @opindex mno-cmov
21521 Do not generate conditional move instructions.
21523 @item -mext-perf
21524 @opindex mperf-ext
21525 Generate performance extension instructions.
21527 @item -mno-ext-perf
21528 @opindex mno-perf-ext
21529 Do not generate performance extension instructions.
21531 @item -mext-perf2
21532 @opindex mperf-ext
21533 Generate performance extension 2 instructions.
21535 @item -mno-ext-perf2
21536 @opindex mno-perf-ext
21537 Do not generate performance extension 2 instructions.
21539 @item -mext-string
21540 @opindex mperf-ext
21541 Generate string extension instructions.
21543 @item -mno-ext-string
21544 @opindex mno-perf-ext
21545 Do not generate string extension instructions.
21547 @item -mv3push
21548 @opindex mv3push
21549 Generate v3 push25/pop25 instructions.
21551 @item -mno-v3push
21552 @opindex mno-v3push
21553 Do not generate v3 push25/pop25 instructions.
21555 @item -m16-bit
21556 @opindex m16-bit
21557 Generate 16-bit instructions.
21559 @item -mno-16-bit
21560 @opindex mno-16-bit
21561 Do not generate 16-bit instructions.
21563 @item -misr-vector-size=@var{num}
21564 @opindex misr-vector-size
21565 Specify the size of each interrupt vector, which must be 4 or 16.
21567 @item -mcache-block-size=@var{num}
21568 @opindex mcache-block-size
21569 Specify the size of each cache block,
21570 which must be a power of 2 between 4 and 512.
21572 @item -march=@var{arch}
21573 @opindex march
21574 Specify the name of the target architecture.
21576 @item -mcmodel=@var{code-model}
21577 @opindex mcmodel
21578 Set the code model to one of
21579 @table @asis
21580 @item @samp{small}
21581 All the data and read-only data segments must be within 512KB addressing space.
21582 The text segment must be within 16MB addressing space.
21583 @item @samp{medium}
21584 The data segment must be within 512KB while the read-only data segment can be
21585 within 4GB addressing space.  The text segment should be still within 16MB
21586 addressing space.
21587 @item @samp{large}
21588 All the text and data segments can be within 4GB addressing space.
21589 @end table
21591 @item -mctor-dtor
21592 @opindex mctor-dtor
21593 Enable constructor/destructor feature.
21595 @item -mrelax
21596 @opindex mrelax
21597 Guide linker to relax instructions.
21599 @end table
21601 @node Nios II Options
21602 @subsection Nios II Options
21603 @cindex Nios II options
21604 @cindex Altera Nios II options
21606 These are the options defined for the Altera Nios II processor.
21608 @table @gcctabopt
21610 @item -G @var{num}
21611 @opindex G
21612 @cindex smaller data references
21613 Put global and static objects less than or equal to @var{num} bytes
21614 into the small data or BSS sections instead of the normal data or BSS
21615 sections.  The default value of @var{num} is 8.
21617 @item -mgpopt=@var{option}
21618 @itemx -mgpopt
21619 @itemx -mno-gpopt
21620 @opindex mgpopt
21621 @opindex mno-gpopt
21622 Generate (do not generate) GP-relative accesses.  The following 
21623 @var{option} names are recognized:
21625 @table @samp
21627 @item none
21628 Do not generate GP-relative accesses.
21630 @item local
21631 Generate GP-relative accesses for small data objects that are not 
21632 external, weak, or uninitialized common symbols.  
21633 Also use GP-relative addressing for objects that
21634 have been explicitly placed in a small data section via a @code{section}
21635 attribute.
21637 @item global
21638 As for @samp{local}, but also generate GP-relative accesses for
21639 small data objects that are external, weak, or common.  If you use this option,
21640 you must ensure that all parts of your program (including libraries) are
21641 compiled with the same @option{-G} setting.
21643 @item data
21644 Generate GP-relative accesses for all data objects in the program.  If you
21645 use this option, the entire data and BSS segments
21646 of your program must fit in 64K of memory and you must use an appropriate
21647 linker script to allocate them within the addressable range of the
21648 global pointer.
21650 @item all
21651 Generate GP-relative addresses for function pointers as well as data
21652 pointers.  If you use this option, the entire text, data, and BSS segments
21653 of your program must fit in 64K of memory and you must use an appropriate
21654 linker script to allocate them within the addressable range of the
21655 global pointer.
21657 @end table
21659 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21660 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21662 The default is @option{-mgpopt} except when @option{-fpic} or
21663 @option{-fPIC} is specified to generate position-independent code.
21664 Note that the Nios II ABI does not permit GP-relative accesses from
21665 shared libraries.
21667 You may need to specify @option{-mno-gpopt} explicitly when building
21668 programs that include large amounts of small data, including large
21669 GOT data sections.  In this case, the 16-bit offset for GP-relative
21670 addressing may not be large enough to allow access to the entire 
21671 small data section.
21673 @item -mgprel-sec=@var{regexp}
21674 @opindex mgprel-sec
21675 This option specifies additional section names that can be accessed via
21676 GP-relative addressing.  It is most useful in conjunction with 
21677 @code{section} attributes on variable declarations 
21678 (@pxref{Common Variable Attributes}) and a custom linker script.  
21679 The @var{regexp} is a POSIX Extended Regular Expression.
21681 This option does not affect the behavior of the @option{-G} option, and 
21682 and the specified sections are in addition to the standard @code{.sdata} 
21683 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21685 @item -mr0rel-sec=@var{regexp}
21686 @opindex mr0rel-sec
21687 This option specifies names of sections that can be accessed via a 
21688 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21689 of the 32-bit address space.  It is most useful in conjunction with 
21690 @code{section} attributes on variable declarations 
21691 (@pxref{Common Variable Attributes}) and a custom linker script.  
21692 The @var{regexp} is a POSIX Extended Regular Expression.
21694 In contrast to the use of GP-relative addressing for small data, 
21695 zero-based addressing is never generated by default and there are no 
21696 conventional section names used in standard linker scripts for sections
21697 in the low or high areas of memory.
21699 @item -mel
21700 @itemx -meb
21701 @opindex mel
21702 @opindex meb
21703 Generate little-endian (default) or big-endian (experimental) code,
21704 respectively.
21706 @item -march=@var{arch}
21707 @opindex march
21708 This specifies the name of the target Nios II architecture.  GCC uses this
21709 name to determine what kind of instructions it can emit when generating
21710 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21712 The preprocessor macro @code{__nios2_arch__} is available to programs,
21713 with value 1 or 2, indicating the targeted ISA level.
21715 @item -mbypass-cache
21716 @itemx -mno-bypass-cache
21717 @opindex mno-bypass-cache
21718 @opindex mbypass-cache
21719 Force all load and store instructions to always bypass cache by 
21720 using I/O variants of the instructions. The default is not to
21721 bypass the cache.
21723 @item -mno-cache-volatile 
21724 @itemx -mcache-volatile       
21725 @opindex mcache-volatile 
21726 @opindex mno-cache-volatile
21727 Volatile memory access bypass the cache using the I/O variants of 
21728 the load and store instructions. The default is not to bypass the cache.
21730 @item -mno-fast-sw-div
21731 @itemx -mfast-sw-div
21732 @opindex mno-fast-sw-div
21733 @opindex mfast-sw-div
21734 Do not use table-based fast divide for small numbers. The default 
21735 is to use the fast divide at @option{-O3} and above.
21737 @item -mno-hw-mul
21738 @itemx -mhw-mul
21739 @itemx -mno-hw-mulx
21740 @itemx -mhw-mulx
21741 @itemx -mno-hw-div
21742 @itemx -mhw-div
21743 @opindex mno-hw-mul
21744 @opindex mhw-mul
21745 @opindex mno-hw-mulx
21746 @opindex mhw-mulx
21747 @opindex mno-hw-div
21748 @opindex mhw-div
21749 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21750 instructions by the compiler. The default is to emit @code{mul}
21751 and not emit @code{div} and @code{mulx}.
21753 @item -mbmx
21754 @itemx -mno-bmx
21755 @itemx -mcdx
21756 @itemx -mno-cdx
21757 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21758 CDX (code density) instructions.  Enabling these instructions also
21759 requires @option{-march=r2}.  Since these instructions are optional
21760 extensions to the R2 architecture, the default is not to emit them.
21762 @item -mcustom-@var{insn}=@var{N}
21763 @itemx -mno-custom-@var{insn}
21764 @opindex mcustom-@var{insn}
21765 @opindex mno-custom-@var{insn}
21766 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21767 custom instruction with encoding @var{N} when generating code that uses 
21768 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21769 instruction 253 for single-precision floating-point add operations instead
21770 of the default behavior of using a library call.
21772 The following values of @var{insn} are supported.  Except as otherwise
21773 noted, floating-point operations are expected to be implemented with
21774 normal IEEE 754 semantics and correspond directly to the C operators or the
21775 equivalent GCC built-in functions (@pxref{Other Builtins}).
21777 Single-precision floating point:
21778 @table @asis
21780 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21781 Binary arithmetic operations.
21783 @item @samp{fnegs}
21784 Unary negation.
21786 @item @samp{fabss}
21787 Unary absolute value.
21789 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21790 Comparison operations.
21792 @item @samp{fmins}, @samp{fmaxs}
21793 Floating-point minimum and maximum.  These instructions are only
21794 generated if @option{-ffinite-math-only} is specified.
21796 @item @samp{fsqrts}
21797 Unary square root operation.
21799 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21800 Floating-point trigonometric and exponential functions.  These instructions
21801 are only generated if @option{-funsafe-math-optimizations} is also specified.
21803 @end table
21805 Double-precision floating point:
21806 @table @asis
21808 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21809 Binary arithmetic operations.
21811 @item @samp{fnegd}
21812 Unary negation.
21814 @item @samp{fabsd}
21815 Unary absolute value.
21817 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21818 Comparison operations.
21820 @item @samp{fmind}, @samp{fmaxd}
21821 Double-precision minimum and maximum.  These instructions are only
21822 generated if @option{-ffinite-math-only} is specified.
21824 @item @samp{fsqrtd}
21825 Unary square root operation.
21827 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21828 Double-precision trigonometric and exponential functions.  These instructions
21829 are only generated if @option{-funsafe-math-optimizations} is also specified.
21831 @end table
21833 Conversions:
21834 @table @asis
21835 @item @samp{fextsd}
21836 Conversion from single precision to double precision.
21838 @item @samp{ftruncds}
21839 Conversion from double precision to single precision.
21841 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21842 Conversion from floating point to signed or unsigned integer types, with
21843 truncation towards zero.
21845 @item @samp{round}
21846 Conversion from single-precision floating point to signed integer,
21847 rounding to the nearest integer and ties away from zero.
21848 This corresponds to the @code{__builtin_lroundf} function when
21849 @option{-fno-math-errno} is used.
21851 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21852 Conversion from signed or unsigned integer types to floating-point types.
21854 @end table
21856 In addition, all of the following transfer instructions for internal
21857 registers X and Y must be provided to use any of the double-precision
21858 floating-point instructions.  Custom instructions taking two
21859 double-precision source operands expect the first operand in the
21860 64-bit register X.  The other operand (or only operand of a unary
21861 operation) is given to the custom arithmetic instruction with the
21862 least significant half in source register @var{src1} and the most
21863 significant half in @var{src2}.  A custom instruction that returns a
21864 double-precision result returns the most significant 32 bits in the
21865 destination register and the other half in 32-bit register Y.  
21866 GCC automatically generates the necessary code sequences to write
21867 register X and/or read register Y when double-precision floating-point
21868 instructions are used.
21870 @table @asis
21872 @item @samp{fwrx}
21873 Write @var{src1} into the least significant half of X and @var{src2} into
21874 the most significant half of X.
21876 @item @samp{fwry}
21877 Write @var{src1} into Y.
21879 @item @samp{frdxhi}, @samp{frdxlo}
21880 Read the most or least (respectively) significant half of X and store it in
21881 @var{dest}.
21883 @item @samp{frdy}
21884 Read the value of Y and store it into @var{dest}.
21885 @end table
21887 Note that you can gain more local control over generation of Nios II custom
21888 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21889 and @code{target("no-custom-@var{insn}")} function attributes
21890 (@pxref{Function Attributes})
21891 or pragmas (@pxref{Function Specific Option Pragmas}).
21893 @item -mcustom-fpu-cfg=@var{name}
21894 @opindex mcustom-fpu-cfg
21896 This option enables a predefined, named set of custom instruction encodings
21897 (see @option{-mcustom-@var{insn}} above).  
21898 Currently, the following sets are defined:
21900 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21901 @gccoptlist{-mcustom-fmuls=252 @gol
21902 -mcustom-fadds=253 @gol
21903 -mcustom-fsubs=254 @gol
21904 -fsingle-precision-constant}
21906 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21907 @gccoptlist{-mcustom-fmuls=252 @gol
21908 -mcustom-fadds=253 @gol
21909 -mcustom-fsubs=254 @gol
21910 -mcustom-fdivs=255 @gol
21911 -fsingle-precision-constant}
21913 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21914 @gccoptlist{-mcustom-floatus=243 @gol
21915 -mcustom-fixsi=244 @gol
21916 -mcustom-floatis=245 @gol
21917 -mcustom-fcmpgts=246 @gol
21918 -mcustom-fcmples=249 @gol
21919 -mcustom-fcmpeqs=250 @gol
21920 -mcustom-fcmpnes=251 @gol
21921 -mcustom-fmuls=252 @gol
21922 -mcustom-fadds=253 @gol
21923 -mcustom-fsubs=254 @gol
21924 -mcustom-fdivs=255 @gol
21925 -fsingle-precision-constant}
21927 Custom instruction assignments given by individual
21928 @option{-mcustom-@var{insn}=} options override those given by
21929 @option{-mcustom-fpu-cfg=}, regardless of the
21930 order of the options on the command line.
21932 Note that you can gain more local control over selection of a FPU
21933 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21934 function attribute (@pxref{Function Attributes})
21935 or pragma (@pxref{Function Specific Option Pragmas}).
21937 @end table
21939 These additional @samp{-m} options are available for the Altera Nios II
21940 ELF (bare-metal) target:
21942 @table @gcctabopt
21944 @item -mhal
21945 @opindex mhal
21946 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21947 startup and termination code, and is typically used in conjunction with
21948 @option{-msys-crt0=} to specify the location of the alternate startup code
21949 provided by the HAL BSP.
21951 @item -msmallc
21952 @opindex msmallc
21953 Link with a limited version of the C library, @option{-lsmallc}, rather than
21954 Newlib.
21956 @item -msys-crt0=@var{startfile}
21957 @opindex msys-crt0
21958 @var{startfile} is the file name of the startfile (crt0) to use 
21959 when linking.  This option is only useful in conjunction with @option{-mhal}.
21961 @item -msys-lib=@var{systemlib}
21962 @opindex msys-lib
21963 @var{systemlib} is the library name of the library that provides
21964 low-level system calls required by the C library,
21965 e.g. @code{read} and @code{write}.
21966 This option is typically used to link with a library provided by a HAL BSP.
21968 @end table
21970 @node Nvidia PTX Options
21971 @subsection Nvidia PTX Options
21972 @cindex Nvidia PTX options
21973 @cindex nvptx options
21975 These options are defined for Nvidia PTX:
21977 @table @gcctabopt
21979 @item -m32
21980 @itemx -m64
21981 @opindex m32
21982 @opindex m64
21983 Generate code for 32-bit or 64-bit ABI.
21985 @item -mmainkernel
21986 @opindex mmainkernel
21987 Link in code for a __main kernel.  This is for stand-alone instead of
21988 offloading execution.
21990 @item -moptimize
21991 @opindex moptimize
21992 Apply partitioned execution optimizations.  This is the default when any
21993 level of optimization is selected.
21995 @item -msoft-stack
21996 @opindex msoft-stack
21997 Generate code that does not use @code{.local} memory
21998 directly for stack storage. Instead, a per-warp stack pointer is
21999 maintained explicitly. This enables variable-length stack allocation (with
22000 variable-length arrays or @code{alloca}), and when global memory is used for
22001 underlying storage, makes it possible to access automatic variables from other
22002 threads, or with atomic instructions. This code generation variant is used
22003 for OpenMP offloading, but the option is exposed on its own for the purpose
22004 of testing the compiler; to generate code suitable for linking into programs
22005 using OpenMP offloading, use option @option{-mgomp}.
22007 @item -muniform-simt
22008 @opindex muniform-simt
22009 Switch to code generation variant that allows to execute all threads in each
22010 warp, while maintaining memory state and side effects as if only one thread
22011 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22012 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22013 current lane index equals the master lane index), and the register being
22014 assigned is copied via a shuffle instruction from the master lane.  Outside of
22015 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22016 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22017 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22018 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22019 with current lane index to compute the master lane index.
22021 @item -mgomp
22022 @opindex mgomp
22023 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22024 @option{-muniform-simt} options, and selects corresponding multilib variant.
22026 @end table
22028 @node PDP-11 Options
22029 @subsection PDP-11 Options
22030 @cindex PDP-11 Options
22032 These options are defined for the PDP-11:
22034 @table @gcctabopt
22035 @item -mfpu
22036 @opindex mfpu
22037 Use hardware FPP floating point.  This is the default.  (FIS floating
22038 point on the PDP-11/40 is not supported.)
22040 @item -msoft-float
22041 @opindex msoft-float
22042 Do not use hardware floating point.
22044 @item -mac0
22045 @opindex mac0
22046 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22048 @item -mno-ac0
22049 @opindex mno-ac0
22050 Return floating-point results in memory.  This is the default.
22052 @item -m40
22053 @opindex m40
22054 Generate code for a PDP-11/40.
22056 @item -m45
22057 @opindex m45
22058 Generate code for a PDP-11/45.  This is the default.
22060 @item -m10
22061 @opindex m10
22062 Generate code for a PDP-11/10.
22064 @item -mbcopy-builtin
22065 @opindex mbcopy-builtin
22066 Use inline @code{movmemhi} patterns for copying memory.  This is the
22067 default.
22069 @item -mbcopy
22070 @opindex mbcopy
22071 Do not use inline @code{movmemhi} patterns for copying memory.
22073 @item -mint16
22074 @itemx -mno-int32
22075 @opindex mint16
22076 @opindex mno-int32
22077 Use 16-bit @code{int}.  This is the default.
22079 @item -mint32
22080 @itemx -mno-int16
22081 @opindex mint32
22082 @opindex mno-int16
22083 Use 32-bit @code{int}.
22085 @item -mfloat64
22086 @itemx -mno-float32
22087 @opindex mfloat64
22088 @opindex mno-float32
22089 Use 64-bit @code{float}.  This is the default.
22091 @item -mfloat32
22092 @itemx -mno-float64
22093 @opindex mfloat32
22094 @opindex mno-float64
22095 Use 32-bit @code{float}.
22097 @item -mabshi
22098 @opindex mabshi
22099 Use @code{abshi2} pattern.  This is the default.
22101 @item -mno-abshi
22102 @opindex mno-abshi
22103 Do not use @code{abshi2} pattern.
22105 @item -mbranch-expensive
22106 @opindex mbranch-expensive
22107 Pretend that branches are expensive.  This is for experimenting with
22108 code generation only.
22110 @item -mbranch-cheap
22111 @opindex mbranch-cheap
22112 Do not pretend that branches are expensive.  This is the default.
22114 @item -munix-asm
22115 @opindex munix-asm
22116 Use Unix assembler syntax.  This is the default when configured for
22117 @samp{pdp11-*-bsd}.
22119 @item -mdec-asm
22120 @opindex mdec-asm
22121 Use DEC assembler syntax.  This is the default when configured for any
22122 PDP-11 target other than @samp{pdp11-*-bsd}.
22123 @end table
22125 @node picoChip Options
22126 @subsection picoChip Options
22127 @cindex picoChip options
22129 These @samp{-m} options are defined for picoChip implementations:
22131 @table @gcctabopt
22133 @item -mae=@var{ae_type}
22134 @opindex mcpu
22135 Set the instruction set, register set, and instruction scheduling
22136 parameters for array element type @var{ae_type}.  Supported values
22137 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22139 @option{-mae=ANY} selects a completely generic AE type.  Code
22140 generated with this option runs on any of the other AE types.  The
22141 code is not as efficient as it would be if compiled for a specific
22142 AE type, and some types of operation (e.g., multiplication) do not
22143 work properly on all types of AE.
22145 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22146 for compiled code, and is the default.
22148 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22149 option may suffer from poor performance of byte (char) manipulation,
22150 since the DSP AE does not provide hardware support for byte load/stores.
22152 @item -msymbol-as-address
22153 Enable the compiler to directly use a symbol name as an address in a
22154 load/store instruction, without first loading it into a
22155 register.  Typically, the use of this option generates larger
22156 programs, which run faster than when the option isn't used.  However, the
22157 results vary from program to program, so it is left as a user option,
22158 rather than being permanently enabled.
22160 @item -mno-inefficient-warnings
22161 Disables warnings about the generation of inefficient code.  These
22162 warnings can be generated, for example, when compiling code that
22163 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22164 no hardware support for byte-level memory operations, so all byte
22165 load/stores must be synthesized from word load/store operations.  This is
22166 inefficient and a warning is generated to indicate
22167 that you should rewrite the code to avoid byte operations, or to target
22168 an AE type that has the necessary hardware support.  This option disables
22169 these warnings.
22171 @end table
22173 @node PowerPC Options
22174 @subsection PowerPC Options
22175 @cindex PowerPC options
22177 These are listed under @xref{RS/6000 and PowerPC Options}.
22179 @node PowerPC SPE Options
22180 @subsection PowerPC SPE Options
22181 @cindex PowerPC SPE options
22183 These @samp{-m} options are defined for PowerPC SPE:
22184 @table @gcctabopt
22185 @item -mmfcrf
22186 @itemx -mno-mfcrf
22187 @itemx -mpopcntb
22188 @itemx -mno-popcntb
22189 @opindex mmfcrf
22190 @opindex mno-mfcrf
22191 @opindex mpopcntb
22192 @opindex mno-popcntb
22193 You use these options to specify which instructions are available on the
22194 processor you are using.  The default value of these options is
22195 determined when configuring GCC@.  Specifying the
22196 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22197 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22198 rather than the options listed above.
22200 The @option{-mmfcrf} option allows GCC to generate the move from
22201 condition register field instruction implemented on the POWER4
22202 processor and other processors that support the PowerPC V2.01
22203 architecture.
22204 The @option{-mpopcntb} option allows GCC to generate the popcount and
22205 double-precision FP reciprocal estimate instruction implemented on the
22206 POWER5 processor and other processors that support the PowerPC V2.02
22207 architecture.
22209 @item -mcpu=@var{cpu_type}
22210 @opindex mcpu
22211 Set architecture type, register usage, and
22212 instruction scheduling parameters for machine type @var{cpu_type}.
22213 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22214 and @samp{native}.
22216 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22217 endian), with an appropriate, generic processor model assumed for
22218 scheduling purposes.
22220 Specifying @samp{native} as cpu type detects and selects the
22221 architecture option that corresponds to the host processor of the
22222 system performing the compilation.
22223 @option{-mcpu=native} has no effect if GCC does not recognize the
22224 processor.
22226 The other options specify a specific processor.  Code generated under
22227 those options runs best on that processor, and may not run at all on
22228 others.
22230 The @option{-mcpu} options automatically enable or disable the
22231 following options:
22233 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22234 -mpopcntb -mpopcntd @gol
22235 -msingle-float -mdouble-float @gol
22236 -mfloat128}
22238 The particular options set for any particular CPU varies between
22239 compiler versions, depending on what setting seems to produce optimal
22240 code for that CPU; it doesn't necessarily reflect the actual hardware's
22241 capabilities.  If you wish to set an individual option to a particular
22242 value, you may specify it after the @option{-mcpu} option, like
22243 @option{-mcpu=8548}.
22245 @item -mtune=@var{cpu_type}
22246 @opindex mtune
22247 Set the instruction scheduling parameters for machine type
22248 @var{cpu_type}, but do not set the architecture type or register usage,
22249 as @option{-mcpu=@var{cpu_type}} does.  The same
22250 values for @var{cpu_type} are used for @option{-mtune} as for
22251 @option{-mcpu}.  If both are specified, the code generated uses the
22252 architecture and registers set by @option{-mcpu}, but the
22253 scheduling parameters set by @option{-mtune}.
22255 @item -msecure-plt
22256 @opindex msecure-plt
22257 Generate code that allows @command{ld} and @command{ld.so}
22258 to build executables and shared
22259 libraries with non-executable @code{.plt} and @code{.got} sections.
22260 This is a PowerPC
22261 32-bit SYSV ABI option.
22263 @item -mbss-plt
22264 @opindex mbss-plt
22265 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22266 fills in, and
22267 requires @code{.plt} and @code{.got}
22268 sections that are both writable and executable.
22269 This is a PowerPC 32-bit SYSV ABI option.
22271 @item -misel
22272 @itemx -mno-isel
22273 @opindex misel
22274 @opindex mno-isel
22275 This switch enables or disables the generation of ISEL instructions.
22277 @item -misel=@var{yes/no}
22278 This switch has been deprecated.  Use @option{-misel} and
22279 @option{-mno-isel} instead.
22281 @item -mspe
22282 @itemx -mno-spe
22283 @opindex mspe
22284 @opindex mno-spe
22285 This switch enables or disables the generation of SPE simd
22286 instructions.
22288 @item -mspe=@var{yes/no}
22289 This option has been deprecated.  Use @option{-mspe} and
22290 @option{-mno-spe} instead.
22292 @item -mfloat128
22293 @itemx -mno-float128
22294 @opindex mfloat128
22295 @opindex mno-float128
22296 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22297 and use either software emulation for IEEE 128-bit floating point or
22298 hardware instructions.
22300 @item -mfloat-gprs=@var{yes/single/double/no}
22301 @itemx -mfloat-gprs
22302 @opindex mfloat-gprs
22303 This switch enables or disables the generation of floating-point
22304 operations on the general-purpose registers for architectures that
22305 support it.
22307 The argument @samp{yes} or @samp{single} enables the use of
22308 single-precision floating-point operations.
22310 The argument @samp{double} enables the use of single and
22311 double-precision floating-point operations.
22313 The argument @samp{no} disables floating-point operations on the
22314 general-purpose registers.
22316 This option is currently only available on the MPC854x.
22318 @item -mfull-toc
22319 @itemx -mno-fp-in-toc
22320 @itemx -mno-sum-in-toc
22321 @itemx -mminimal-toc
22322 @opindex mfull-toc
22323 @opindex mno-fp-in-toc
22324 @opindex mno-sum-in-toc
22325 @opindex mminimal-toc
22326 Modify generation of the TOC (Table Of Contents), which is created for
22327 every executable file.  The @option{-mfull-toc} option is selected by
22328 default.  In that case, GCC allocates at least one TOC entry for
22329 each unique non-automatic variable reference in your program.  GCC
22330 also places floating-point constants in the TOC@.  However, only
22331 16,384 entries are available in the TOC@.
22333 If you receive a linker error message that saying you have overflowed
22334 the available TOC space, you can reduce the amount of TOC space used
22335 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22336 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22337 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22338 generate code to calculate the sum of an address and a constant at
22339 run time instead of putting that sum into the TOC@.  You may specify one
22340 or both of these options.  Each causes GCC to produce very slightly
22341 slower and larger code at the expense of conserving TOC space.
22343 If you still run out of space in the TOC even when you specify both of
22344 these options, specify @option{-mminimal-toc} instead.  This option causes
22345 GCC to make only one TOC entry for every file.  When you specify this
22346 option, GCC produces code that is slower and larger but which
22347 uses extremely little TOC space.  You may wish to use this option
22348 only on files that contain less frequently-executed code.
22350 @item -maix32
22351 @opindex maix32
22352 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22354 @item -mxl-compat
22355 @itemx -mno-xl-compat
22356 @opindex mxl-compat
22357 @opindex mno-xl-compat
22358 Produce code that conforms more closely to IBM XL compiler semantics
22359 when using AIX-compatible ABI@.  Pass floating-point arguments to
22360 prototyped functions beyond the register save area (RSA) on the stack
22361 in addition to argument FPRs.  Do not assume that most significant
22362 double in 128-bit long double value is properly rounded when comparing
22363 values and converting to double.  Use XL symbol names for long double
22364 support routines.
22366 The AIX calling convention was extended but not initially documented to
22367 handle an obscure K&R C case of calling a function that takes the
22368 address of its arguments with fewer arguments than declared.  IBM XL
22369 compilers access floating-point arguments that do not fit in the
22370 RSA from the stack when a subroutine is compiled without
22371 optimization.  Because always storing floating-point arguments on the
22372 stack is inefficient and rarely needed, this option is not enabled by
22373 default and only is necessary when calling subroutines compiled by IBM
22374 XL compilers without optimization.
22376 @item -malign-natural
22377 @itemx -malign-power
22378 @opindex malign-natural
22379 @opindex malign-power
22380 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22381 @option{-malign-natural} overrides the ABI-defined alignment of larger
22382 types, such as floating-point doubles, on their natural size-based boundary.
22383 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22384 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22386 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22387 is not supported.
22389 @item -msoft-float
22390 @itemx -mhard-float
22391 @opindex msoft-float
22392 @opindex mhard-float
22393 Generate code that does not use (uses) the floating-point register set.
22394 Software floating-point emulation is provided if you use the
22395 @option{-msoft-float} option, and pass the option to GCC when linking.
22397 @item -msingle-float
22398 @itemx -mdouble-float
22399 @opindex msingle-float
22400 @opindex mdouble-float
22401 Generate code for single- or double-precision floating-point operations.
22402 @option{-mdouble-float} implies @option{-msingle-float}.
22404 @item -mmultiple
22405 @itemx -mno-multiple
22406 @opindex mmultiple
22407 @opindex mno-multiple
22408 Generate code that uses (does not use) the load multiple word
22409 instructions and the store multiple word instructions.  These
22410 instructions are generated by default on POWER systems, and not
22411 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22412 PowerPC systems, since those instructions do not work when the
22413 processor is in little-endian mode.  The exceptions are PPC740 and
22414 PPC750 which permit these instructions in little-endian mode.
22416 @item -mupdate
22417 @itemx -mno-update
22418 @opindex mupdate
22419 @opindex mno-update
22420 Generate code that uses (does not use) the load or store instructions
22421 that update the base register to the address of the calculated memory
22422 location.  These instructions are generated by default.  If you use
22423 @option{-mno-update}, there is a small window between the time that the
22424 stack pointer is updated and the address of the previous frame is
22425 stored, which means code that walks the stack frame across interrupts or
22426 signals may get corrupted data.
22428 @item -mavoid-indexed-addresses
22429 @itemx -mno-avoid-indexed-addresses
22430 @opindex mavoid-indexed-addresses
22431 @opindex mno-avoid-indexed-addresses
22432 Generate code that tries to avoid (not avoid) the use of indexed load
22433 or store instructions. These instructions can incur a performance
22434 penalty on Power6 processors in certain situations, such as when
22435 stepping through large arrays that cross a 16M boundary.  This option
22436 is enabled by default when targeting Power6 and disabled otherwise.
22438 @item -mfused-madd
22439 @itemx -mno-fused-madd
22440 @opindex mfused-madd
22441 @opindex mno-fused-madd
22442 Generate code that uses (does not use) the floating-point multiply and
22443 accumulate instructions.  These instructions are generated by default
22444 if hardware floating point is used.  The machine-dependent
22445 @option{-mfused-madd} option is now mapped to the machine-independent
22446 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22447 mapped to @option{-ffp-contract=off}.
22449 @item -mno-strict-align
22450 @itemx -mstrict-align
22451 @opindex mno-strict-align
22452 @opindex mstrict-align
22453 On System V.4 and embedded PowerPC systems do not (do) assume that
22454 unaligned memory references are handled by the system.
22456 @item -mrelocatable
22457 @itemx -mno-relocatable
22458 @opindex mrelocatable
22459 @opindex mno-relocatable
22460 Generate code that allows (does not allow) a static executable to be
22461 relocated to a different address at run time.  A simple embedded
22462 PowerPC system loader should relocate the entire contents of
22463 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22464 a table of 32-bit addresses generated by this option.  For this to
22465 work, all objects linked together must be compiled with
22466 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22467 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22469 @item -mrelocatable-lib
22470 @itemx -mno-relocatable-lib
22471 @opindex mrelocatable-lib
22472 @opindex mno-relocatable-lib
22473 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22474 @code{.fixup} section to allow static executables to be relocated at
22475 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22476 alignment of @option{-mrelocatable}.  Objects compiled with
22477 @option{-mrelocatable-lib} may be linked with objects compiled with
22478 any combination of the @option{-mrelocatable} options.
22480 @item -mno-toc
22481 @itemx -mtoc
22482 @opindex mno-toc
22483 @opindex mtoc
22484 On System V.4 and embedded PowerPC systems do not (do) assume that
22485 register 2 contains a pointer to a global area pointing to the addresses
22486 used in the program.
22488 @item -mlittle
22489 @itemx -mlittle-endian
22490 @opindex mlittle
22491 @opindex mlittle-endian
22492 On System V.4 and embedded PowerPC systems compile code for the
22493 processor in little-endian mode.  The @option{-mlittle-endian} option is
22494 the same as @option{-mlittle}.
22496 @item -mbig
22497 @itemx -mbig-endian
22498 @opindex mbig
22499 @opindex mbig-endian
22500 On System V.4 and embedded PowerPC systems compile code for the
22501 processor in big-endian mode.  The @option{-mbig-endian} option is
22502 the same as @option{-mbig}.
22504 @item -mdynamic-no-pic
22505 @opindex mdynamic-no-pic
22506 On Darwin and Mac OS X systems, compile code so that it is not
22507 relocatable, but that its external references are relocatable.  The
22508 resulting code is suitable for applications, but not shared
22509 libraries.
22511 @item -msingle-pic-base
22512 @opindex msingle-pic-base
22513 Treat the register used for PIC addressing as read-only, rather than
22514 loading it in the prologue for each function.  The runtime system is
22515 responsible for initializing this register with an appropriate value
22516 before execution begins.
22518 @item -mprioritize-restricted-insns=@var{priority}
22519 @opindex mprioritize-restricted-insns
22520 This option controls the priority that is assigned to
22521 dispatch-slot restricted instructions during the second scheduling
22522 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22523 or @samp{2} to assign no, highest, or second-highest (respectively)
22524 priority to dispatch-slot restricted
22525 instructions.
22527 @item -msched-costly-dep=@var{dependence_type}
22528 @opindex msched-costly-dep
22529 This option controls which dependences are considered costly
22530 by the target during instruction scheduling.  The argument
22531 @var{dependence_type} takes one of the following values:
22533 @table @asis
22534 @item @samp{no}
22535 No dependence is costly.
22537 @item @samp{all}
22538 All dependences are costly.
22540 @item @samp{true_store_to_load}
22541 A true dependence from store to load is costly.
22543 @item @samp{store_to_load}
22544 Any dependence from store to load is costly.
22546 @item @var{number}
22547 Any dependence for which the latency is greater than or equal to
22548 @var{number} is costly.
22549 @end table
22551 @item -minsert-sched-nops=@var{scheme}
22552 @opindex minsert-sched-nops
22553 This option controls which NOP insertion scheme is used during
22554 the second scheduling pass.  The argument @var{scheme} takes one of the
22555 following values:
22557 @table @asis
22558 @item @samp{no}
22559 Don't insert NOPs.
22561 @item @samp{pad}
22562 Pad with NOPs any dispatch group that has vacant issue slots,
22563 according to the scheduler's grouping.
22565 @item @samp{regroup_exact}
22566 Insert NOPs to force costly dependent insns into
22567 separate groups.  Insert exactly as many NOPs as needed to force an insn
22568 to a new group, according to the estimated processor grouping.
22570 @item @var{number}
22571 Insert NOPs to force costly dependent insns into
22572 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22573 @end table
22575 @item -mcall-sysv
22576 @opindex mcall-sysv
22577 On System V.4 and embedded PowerPC systems compile code using calling
22578 conventions that adhere to the March 1995 draft of the System V
22579 Application Binary Interface, PowerPC processor supplement.  This is the
22580 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22582 @item -mcall-sysv-eabi
22583 @itemx -mcall-eabi
22584 @opindex mcall-sysv-eabi
22585 @opindex mcall-eabi
22586 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22588 @item -mcall-sysv-noeabi
22589 @opindex mcall-sysv-noeabi
22590 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22592 @item -mcall-aixdesc
22593 @opindex m
22594 On System V.4 and embedded PowerPC systems compile code for the AIX
22595 operating system.
22597 @item -mcall-linux
22598 @opindex mcall-linux
22599 On System V.4 and embedded PowerPC systems compile code for the
22600 Linux-based GNU system.
22602 @item -mcall-freebsd
22603 @opindex mcall-freebsd
22604 On System V.4 and embedded PowerPC systems compile code for the
22605 FreeBSD operating system.
22607 @item -mcall-netbsd
22608 @opindex mcall-netbsd
22609 On System V.4 and embedded PowerPC systems compile code for the
22610 NetBSD operating system.
22612 @item -mcall-openbsd
22613 @opindex mcall-netbsd
22614 On System V.4 and embedded PowerPC systems compile code for the
22615 OpenBSD operating system.
22617 @item -maix-struct-return
22618 @opindex maix-struct-return
22619 Return all structures in memory (as specified by the AIX ABI)@.
22621 @item -msvr4-struct-return
22622 @opindex msvr4-struct-return
22623 Return structures smaller than 8 bytes in registers (as specified by the
22624 SVR4 ABI)@.
22626 @item -mabi=@var{abi-type}
22627 @opindex mabi
22628 Extend the current ABI with a particular extension, or remove such extension.
22629 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22630 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22631 @samp{elfv1}, @samp{elfv2}@.
22633 @item -mabi=spe
22634 @opindex mabi=spe
22635 Extend the current ABI with SPE ABI extensions.  This does not change
22636 the default ABI, instead it adds the SPE ABI extensions to the current
22637 ABI@.
22639 @item -mabi=no-spe
22640 @opindex mabi=no-spe
22641 Disable Book-E SPE ABI extensions for the current ABI@.
22643 @item -mabi=ibmlongdouble
22644 @opindex mabi=ibmlongdouble
22645 Change the current ABI to use IBM extended-precision long double.
22646 This is not likely to work if your system defaults to using IEEE
22647 extended-precision long double.  If you change the long double type
22648 from IEEE extended-precision, the compiler will issue a warning unless
22649 you use the @option{-Wno-psabi} option.
22651 @item -mabi=ieeelongdouble
22652 @opindex mabi=ieeelongdouble
22653 Change the current ABI to use IEEE extended-precision long double.
22654 This is not likely to work if your system defaults to using IBM
22655 extended-precision long double.  If you change the long double type
22656 from IBM extended-precision, the compiler will issue a warning unless
22657 you use the @option{-Wno-psabi} option.
22659 @item -mabi=elfv1
22660 @opindex mabi=elfv1
22661 Change the current ABI to use the ELFv1 ABI.
22662 This is the default ABI for big-endian PowerPC 64-bit Linux.
22663 Overriding the default ABI requires special system support and is
22664 likely to fail in spectacular ways.
22666 @item -mabi=elfv2
22667 @opindex mabi=elfv2
22668 Change the current ABI to use the ELFv2 ABI.
22669 This is the default ABI for little-endian PowerPC 64-bit Linux.
22670 Overriding the default ABI requires special system support and is
22671 likely to fail in spectacular ways.
22673 @item -mgnu-attribute
22674 @itemx -mno-gnu-attribute
22675 @opindex mgnu-attribute
22676 @opindex mno-gnu-attribute
22677 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22678 .gnu.attributes section that specify ABI variations in function
22679 parameters or return values.
22681 @item -mprototype
22682 @itemx -mno-prototype
22683 @opindex mprototype
22684 @opindex mno-prototype
22685 On System V.4 and embedded PowerPC systems assume that all calls to
22686 variable argument functions are properly prototyped.  Otherwise, the
22687 compiler must insert an instruction before every non-prototyped call to
22688 set or clear bit 6 of the condition code register (@code{CR}) to
22689 indicate whether floating-point values are passed in the floating-point
22690 registers in case the function takes variable arguments.  With
22691 @option{-mprototype}, only calls to prototyped variable argument functions
22692 set or clear the bit.
22694 @item -msim
22695 @opindex msim
22696 On embedded PowerPC systems, assume that the startup module is called
22697 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22698 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22699 configurations.
22701 @item -mmvme
22702 @opindex mmvme
22703 On embedded PowerPC systems, assume that the startup module is called
22704 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22705 @file{libc.a}.
22707 @item -mads
22708 @opindex mads
22709 On embedded PowerPC systems, assume that the startup module is called
22710 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22711 @file{libc.a}.
22713 @item -myellowknife
22714 @opindex myellowknife
22715 On embedded PowerPC systems, assume that the startup module is called
22716 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22717 @file{libc.a}.
22719 @item -mvxworks
22720 @opindex mvxworks
22721 On System V.4 and embedded PowerPC systems, specify that you are
22722 compiling for a VxWorks system.
22724 @item -memb
22725 @opindex memb
22726 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22727 header to indicate that @samp{eabi} extended relocations are used.
22729 @item -meabi
22730 @itemx -mno-eabi
22731 @opindex meabi
22732 @opindex mno-eabi
22733 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22734 Embedded Applications Binary Interface (EABI), which is a set of
22735 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22736 means that the stack is aligned to an 8-byte boundary, a function
22737 @code{__eabi} is called from @code{main} to set up the EABI
22738 environment, and the @option{-msdata} option can use both @code{r2} and
22739 @code{r13} to point to two separate small data areas.  Selecting
22740 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22741 no EABI initialization function is called from @code{main}, and the
22742 @option{-msdata} option only uses @code{r13} to point to a single
22743 small data area.  The @option{-meabi} option is on by default if you
22744 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22746 @item -msdata=eabi
22747 @opindex msdata=eabi
22748 On System V.4 and embedded PowerPC systems, put small initialized
22749 @code{const} global and static data in the @code{.sdata2} section, which
22750 is pointed to by register @code{r2}.  Put small initialized
22751 non-@code{const} global and static data in the @code{.sdata} section,
22752 which is pointed to by register @code{r13}.  Put small uninitialized
22753 global and static data in the @code{.sbss} section, which is adjacent to
22754 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22755 incompatible with the @option{-mrelocatable} option.  The
22756 @option{-msdata=eabi} option also sets the @option{-memb} option.
22758 @item -msdata=sysv
22759 @opindex msdata=sysv
22760 On System V.4 and embedded PowerPC systems, put small global and static
22761 data in the @code{.sdata} section, which is pointed to by register
22762 @code{r13}.  Put small uninitialized global and static data in the
22763 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22764 The @option{-msdata=sysv} option is incompatible with the
22765 @option{-mrelocatable} option.
22767 @item -msdata=default
22768 @itemx -msdata
22769 @opindex msdata=default
22770 @opindex msdata
22771 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22772 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22773 same as @option{-msdata=sysv}.
22775 @item -msdata=data
22776 @opindex msdata=data
22777 On System V.4 and embedded PowerPC systems, put small global
22778 data in the @code{.sdata} section.  Put small uninitialized global
22779 data in the @code{.sbss} section.  Do not use register @code{r13}
22780 to address small data however.  This is the default behavior unless
22781 other @option{-msdata} options are used.
22783 @item -msdata=none
22784 @itemx -mno-sdata
22785 @opindex msdata=none
22786 @opindex mno-sdata
22787 On embedded PowerPC systems, put all initialized global and static data
22788 in the @code{.data} section, and all uninitialized data in the
22789 @code{.bss} section.
22791 @item -mblock-move-inline-limit=@var{num}
22792 @opindex mblock-move-inline-limit
22793 Inline all block moves (such as calls to @code{memcpy} or structure
22794 copies) less than or equal to @var{num} bytes.  The minimum value for
22795 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22796 targets.  The default value is target-specific.
22798 @item -G @var{num}
22799 @opindex G
22800 @cindex smaller data references (PowerPC)
22801 @cindex .sdata/.sdata2 references (PowerPC)
22802 On embedded PowerPC systems, put global and static items less than or
22803 equal to @var{num} bytes into the small data or BSS sections instead of
22804 the normal data or BSS section.  By default, @var{num} is 8.  The
22805 @option{-G @var{num}} switch is also passed to the linker.
22806 All modules should be compiled with the same @option{-G @var{num}} value.
22808 @item -mregnames
22809 @itemx -mno-regnames
22810 @opindex mregnames
22811 @opindex mno-regnames
22812 On System V.4 and embedded PowerPC systems do (do not) emit register
22813 names in the assembly language output using symbolic forms.
22815 @item -mlongcall
22816 @itemx -mno-longcall
22817 @opindex mlongcall
22818 @opindex mno-longcall
22819 By default assume that all calls are far away so that a longer and more
22820 expensive calling sequence is required.  This is required for calls
22821 farther than 32 megabytes (33,554,432 bytes) from the current location.
22822 A short call is generated if the compiler knows
22823 the call cannot be that far away.  This setting can be overridden by
22824 the @code{shortcall} function attribute, or by @code{#pragma
22825 longcall(0)}.
22827 Some linkers are capable of detecting out-of-range calls and generating
22828 glue code on the fly.  On these systems, long calls are unnecessary and
22829 generate slower code.  As of this writing, the AIX linker can do this,
22830 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22831 to the GNU linker for 32-bit PowerPC systems as well.
22833 In the future, GCC may ignore all longcall specifications
22834 when the linker is known to generate glue.
22836 @item -mtls-markers
22837 @itemx -mno-tls-markers
22838 @opindex mtls-markers
22839 @opindex mno-tls-markers
22840 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22841 specifying the function argument.  The relocation allows the linker to
22842 reliably associate function call with argument setup instructions for
22843 TLS optimization, which in turn allows GCC to better schedule the
22844 sequence.
22846 @item -mrecip
22847 @itemx -mno-recip
22848 @opindex mrecip
22849 This option enables use of the reciprocal estimate and
22850 reciprocal square root estimate instructions with additional
22851 Newton-Raphson steps to increase precision instead of doing a divide or
22852 square root and divide for floating-point arguments.  You should use
22853 the @option{-ffast-math} option when using @option{-mrecip} (or at
22854 least @option{-funsafe-math-optimizations},
22855 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22856 @option{-fno-trapping-math}).  Note that while the throughput of the
22857 sequence is generally higher than the throughput of the non-reciprocal
22858 instruction, the precision of the sequence can be decreased by up to 2
22859 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22860 roots.
22862 @item -mrecip=@var{opt}
22863 @opindex mrecip=opt
22864 This option controls which reciprocal estimate instructions
22865 may be used.  @var{opt} is a comma-separated list of options, which may
22866 be preceded by a @code{!} to invert the option:
22868 @table @samp
22870 @item all
22871 Enable all estimate instructions.
22873 @item default
22874 Enable the default instructions, equivalent to @option{-mrecip}.
22876 @item none
22877 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22879 @item div
22880 Enable the reciprocal approximation instructions for both
22881 single and double precision.
22883 @item divf
22884 Enable the single-precision reciprocal approximation instructions.
22886 @item divd
22887 Enable the double-precision reciprocal approximation instructions.
22889 @item rsqrt
22890 Enable the reciprocal square root approximation instructions for both
22891 single and double precision.
22893 @item rsqrtf
22894 Enable the single-precision reciprocal square root approximation instructions.
22896 @item rsqrtd
22897 Enable the double-precision reciprocal square root approximation instructions.
22899 @end table
22901 So, for example, @option{-mrecip=all,!rsqrtd} enables
22902 all of the reciprocal estimate instructions, except for the
22903 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22904 which handle the double-precision reciprocal square root calculations.
22906 @item -mrecip-precision
22907 @itemx -mno-recip-precision
22908 @opindex mrecip-precision
22909 Assume (do not assume) that the reciprocal estimate instructions
22910 provide higher-precision estimates than is mandated by the PowerPC
22911 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22912 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22913 The double-precision square root estimate instructions are not generated by
22914 default on low-precision machines, since they do not provide an
22915 estimate that converges after three steps.
22917 @item -mpointers-to-nested-functions
22918 @itemx -mno-pointers-to-nested-functions
22919 @opindex mpointers-to-nested-functions
22920 Generate (do not generate) code to load up the static chain register
22921 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22922 systems where a function pointer points to a 3-word descriptor giving
22923 the function address, TOC value to be loaded in register @code{r2}, and
22924 static chain value to be loaded in register @code{r11}.  The
22925 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22926 call through pointers to nested functions or pointers
22927 to functions compiled in other languages that use the static chain if
22928 you use @option{-mno-pointers-to-nested-functions}.
22930 @item -msave-toc-indirect
22931 @itemx -mno-save-toc-indirect
22932 @opindex msave-toc-indirect
22933 Generate (do not generate) code to save the TOC value in the reserved
22934 stack location in the function prologue if the function calls through
22935 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22936 saved in the prologue, it is saved just before the call through the
22937 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22939 @item -mcompat-align-parm
22940 @itemx -mno-compat-align-parm
22941 @opindex mcompat-align-parm
22942 Generate (do not generate) code to pass structure parameters with a
22943 maximum alignment of 64 bits, for compatibility with older versions
22944 of GCC.
22946 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22947 structure parameter on a 128-bit boundary when that structure contained
22948 a member requiring 128-bit alignment.  This is corrected in more
22949 recent versions of GCC.  This option may be used to generate code
22950 that is compatible with functions compiled with older versions of
22951 GCC.
22953 The @option{-mno-compat-align-parm} option is the default.
22955 @item -mstack-protector-guard=@var{guard}
22956 @itemx -mstack-protector-guard-reg=@var{reg}
22957 @itemx -mstack-protector-guard-offset=@var{offset}
22958 @itemx -mstack-protector-guard-symbol=@var{symbol}
22959 @opindex mstack-protector-guard
22960 @opindex mstack-protector-guard-reg
22961 @opindex mstack-protector-guard-offset
22962 @opindex mstack-protector-guard-symbol
22963 Generate stack protection code using canary at @var{guard}.  Supported
22964 locations are @samp{global} for global canary or @samp{tls} for per-thread
22965 canary in the TLS block (the default with GNU libc version 2.4 or later).
22967 With the latter choice the options
22968 @option{-mstack-protector-guard-reg=@var{reg}} and
22969 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22970 which register to use as base register for reading the canary, and from what
22971 offset from that base register. The default for those is as specified in the
22972 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22973 the offset with a symbol reference to a canary in the TLS block.
22974 @end table
22977 @node RISC-V Options
22978 @subsection RISC-V Options
22979 @cindex RISC-V Options
22981 These command-line options are defined for RISC-V targets:
22983 @table @gcctabopt
22984 @item -mbranch-cost=@var{n}
22985 @opindex mbranch-cost
22986 Set the cost of branches to roughly @var{n} instructions.
22988 @item -mplt
22989 @itemx -mno-plt
22990 @opindex plt
22991 When generating PIC code, do or don't allow the use of PLTs. Ignored for
22992 non-PIC.  The default is @option{-mplt}.
22994 @item -mabi=@var{ABI-string}
22995 @opindex mabi
22996 Specify integer and floating-point calling convention.  @var{ABI-string}
22997 contains two parts: the size of integer types and the registers used for
22998 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
22999 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23000 32-bit), and that floating-point values up to 64 bits wide are passed in F
23001 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23002 allows the compiler to generate code that uses the F and D extensions but only
23003 allows floating-point values up to 32 bits long to be passed in registers; or
23004 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23005 passed in registers.
23007 The default for this argument is system dependent, users who want a specific
23008 calling convention should specify one explicitly.  The valid calling
23009 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23010 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23011 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23012 invalid because the ABI requires 64-bit values be passed in F registers, but F
23013 registers are only 32 bits wide.
23015 @item -mfdiv
23016 @itemx -mno-fdiv
23017 @opindex mfdiv
23018 Do or don't use hardware floating-point divide and square root instructions.
23019 This requires the F or D extensions for floating-point registers.  The default
23020 is to use them if the specified architecture has these instructions.
23022 @item -mdiv
23023 @itemx -mno-div
23024 @opindex mdiv
23025 Do or don't use hardware instructions for integer division.  This requires the
23026 M extension.  The default is to use them if the specified architecture has
23027 these instructions.
23029 @item -march=@var{ISA-string}
23030 @opindex march
23031 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23032 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23034 @item -mtune=@var{processor-string}
23035 @opindex mtune
23036 Optimize the output for the given processor, specified by microarchitecture
23037 name.
23039 @item -mpreferred-stack-boundary=@var{num}
23040 @opindex mpreferred-stack-boundary
23041 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23042 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23043 the default is 4 (16 bytes or 128-bits).
23045 @strong{Warning:} If you use this switch, then you must build all modules with
23046 the same value, including any libraries.  This includes the system libraries
23047 and startup modules.
23049 @item -msmall-data-limit=@var{n}
23050 @opindex msmall-data-limit
23051 Put global and static data smaller than @var{n} bytes into a special section
23052 (on some targets).
23054 @item -msave-restore
23055 @itemx -mno-save-restore
23056 @opindex msave-restore
23057 Do or don't use smaller but slower prologue and epilogue code that uses
23058 library function calls.  The default is to use fast inline prologues and
23059 epilogues.
23061 @item -mstrict-align
23062 @itemx -mno-strict-align
23063 @opindex mstrict-align
23064 Do not or do generate unaligned memory accesses.  The default is set depending
23065 on whether the processor we are optimizing for supports fast unaligned access
23066 or not.
23068 @item -mcmodel=medlow
23069 @opindex mcmodel=medlow
23070 Generate code for the medium-low code model. The program and its statically
23071 defined symbols must lie within a single 2 GiB address range and must lie
23072 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23073 statically or dynamically linked. This is the default code model.
23075 @item -mcmodel=medany
23076 @opindex mcmodel=medany
23077 Generate code for the medium-any code model. The program and its statically
23078 defined symbols must be within any single 2 GiB address range. Programs can be
23079 statically or dynamically linked.
23081 @item -mexplicit-relocs
23082 @itemx -mno-exlicit-relocs
23083 Use or do not use assembler relocation operators when dealing with symbolic
23084 addresses.  The alternative is to use assembler macros instead, which may
23085 limit optimization.
23087 @item -mrelax
23088 @itemx -mno-relax
23089 Take advantage of linker relaxations to reduce the number of instructions
23090 required to materialize symbol addresses. The default is to take advantage of
23091 linker relaxations.
23093 @end table
23095 @node RL78 Options
23096 @subsection RL78 Options
23097 @cindex RL78 Options
23099 @table @gcctabopt
23101 @item -msim
23102 @opindex msim
23103 Links in additional target libraries to support operation within a
23104 simulator.
23106 @item -mmul=none
23107 @itemx -mmul=g10
23108 @itemx -mmul=g13
23109 @itemx -mmul=g14
23110 @itemx -mmul=rl78
23111 @opindex mmul
23112 Specifies the type of hardware multiplication and division support to
23113 be used.  The simplest is @code{none}, which uses software for both
23114 multiplication and division.  This is the default.  The @code{g13}
23115 value is for the hardware multiply/divide peripheral found on the
23116 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23117 the multiplication and division instructions supported by the RL78/G14
23118 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23119 the value @code{mg10} is an alias for @code{none}.
23121 In addition a C preprocessor macro is defined, based upon the setting
23122 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23123 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23125 @item -mcpu=g10
23126 @itemx -mcpu=g13
23127 @itemx -mcpu=g14
23128 @itemx -mcpu=rl78
23129 @opindex mcpu
23130 Specifies the RL78 core to target.  The default is the G14 core, also
23131 known as an S3 core or just RL78.  The G13 or S2 core does not have
23132 multiply or divide instructions, instead it uses a hardware peripheral
23133 for these operations.  The G10 or S1 core does not have register
23134 banks, so it uses a different calling convention.
23136 If this option is set it also selects the type of hardware multiply
23137 support to use, unless this is overridden by an explicit
23138 @option{-mmul=none} option on the command line.  Thus specifying
23139 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23140 peripheral and specifying @option{-mcpu=g10} disables the use of
23141 hardware multiplications altogether.
23143 Note, although the RL78/G14 core is the default target, specifying
23144 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23145 change the behavior of the toolchain since it also enables G14
23146 hardware multiply support.  If these options are not specified on the
23147 command line then software multiplication routines will be used even
23148 though the code targets the RL78 core.  This is for backwards
23149 compatibility with older toolchains which did not have hardware
23150 multiply and divide support.
23152 In addition a C preprocessor macro is defined, based upon the setting
23153 of this option.  Possible values are: @code{__RL78_G10__},
23154 @code{__RL78_G13__} or @code{__RL78_G14__}.
23156 @item -mg10
23157 @itemx -mg13
23158 @itemx -mg14
23159 @itemx -mrl78
23160 @opindex mg10
23161 @opindex mg13
23162 @opindex mg14
23163 @opindex mrl78
23164 These are aliases for the corresponding @option{-mcpu=} option.  They
23165 are provided for backwards compatibility.
23167 @item -mallregs
23168 @opindex mallregs
23169 Allow the compiler to use all of the available registers.  By default
23170 registers @code{r24..r31} are reserved for use in interrupt handlers.
23171 With this option enabled these registers can be used in ordinary
23172 functions as well.
23174 @item -m64bit-doubles
23175 @itemx -m32bit-doubles
23176 @opindex m64bit-doubles
23177 @opindex m32bit-doubles
23178 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23179 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23180 @option{-m32bit-doubles}.
23182 @item -msave-mduc-in-interrupts
23183 @itemx -mno-save-mduc-in-interrupts
23184 @opindex msave-mduc-in-interrupts
23185 @opindex mno-save-mduc-in-interrupts
23186 Specifies that interrupt handler functions should preserve the
23187 MDUC registers.  This is only necessary if normal code might use
23188 the MDUC registers, for example because it performs multiplication
23189 and division operations.  The default is to ignore the MDUC registers
23190 as this makes the interrupt handlers faster.  The target option -mg13
23191 needs to be passed for this to work as this feature is only available
23192 on the G13 target (S2 core).  The MDUC registers will only be saved
23193 if the interrupt handler performs a multiplication or division
23194 operation or it calls another function.
23196 @end table
23198 @node RS/6000 and PowerPC Options
23199 @subsection IBM RS/6000 and PowerPC Options
23200 @cindex RS/6000 and PowerPC Options
23201 @cindex IBM RS/6000 and PowerPC Options
23203 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23204 @table @gcctabopt
23205 @item -mpowerpc-gpopt
23206 @itemx -mno-powerpc-gpopt
23207 @itemx -mpowerpc-gfxopt
23208 @itemx -mno-powerpc-gfxopt
23209 @need 800
23210 @itemx -mpowerpc64
23211 @itemx -mno-powerpc64
23212 @itemx -mmfcrf
23213 @itemx -mno-mfcrf
23214 @itemx -mpopcntb
23215 @itemx -mno-popcntb
23216 @itemx -mpopcntd
23217 @itemx -mno-popcntd
23218 @itemx -mfprnd
23219 @itemx -mno-fprnd
23220 @need 800
23221 @itemx -mcmpb
23222 @itemx -mno-cmpb
23223 @itemx -mmfpgpr
23224 @itemx -mno-mfpgpr
23225 @itemx -mhard-dfp
23226 @itemx -mno-hard-dfp
23227 @opindex mpowerpc-gpopt
23228 @opindex mno-powerpc-gpopt
23229 @opindex mpowerpc-gfxopt
23230 @opindex mno-powerpc-gfxopt
23231 @opindex mpowerpc64
23232 @opindex mno-powerpc64
23233 @opindex mmfcrf
23234 @opindex mno-mfcrf
23235 @opindex mpopcntb
23236 @opindex mno-popcntb
23237 @opindex mpopcntd
23238 @opindex mno-popcntd
23239 @opindex mfprnd
23240 @opindex mno-fprnd
23241 @opindex mcmpb
23242 @opindex mno-cmpb
23243 @opindex mmfpgpr
23244 @opindex mno-mfpgpr
23245 @opindex mhard-dfp
23246 @opindex mno-hard-dfp
23247 You use these options to specify which instructions are available on the
23248 processor you are using.  The default value of these options is
23249 determined when configuring GCC@.  Specifying the
23250 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23251 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23252 rather than the options listed above.
23254 Specifying @option{-mpowerpc-gpopt} allows
23255 GCC to use the optional PowerPC architecture instructions in the
23256 General Purpose group, including floating-point square root.  Specifying
23257 @option{-mpowerpc-gfxopt} allows GCC to
23258 use the optional PowerPC architecture instructions in the Graphics
23259 group, including floating-point select.
23261 The @option{-mmfcrf} option allows GCC to generate the move from
23262 condition register field instruction implemented on the POWER4
23263 processor and other processors that support the PowerPC V2.01
23264 architecture.
23265 The @option{-mpopcntb} option allows GCC to generate the popcount and
23266 double-precision FP reciprocal estimate instruction implemented on the
23267 POWER5 processor and other processors that support the PowerPC V2.02
23268 architecture.
23269 The @option{-mpopcntd} option allows GCC to generate the popcount
23270 instruction implemented on the POWER7 processor and other processors
23271 that support the PowerPC V2.06 architecture.
23272 The @option{-mfprnd} option allows GCC to generate the FP round to
23273 integer instructions implemented on the POWER5+ processor and other
23274 processors that support the PowerPC V2.03 architecture.
23275 The @option{-mcmpb} option allows GCC to generate the compare bytes
23276 instruction implemented on the POWER6 processor and other processors
23277 that support the PowerPC V2.05 architecture.
23278 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23279 general-purpose register instructions implemented on the POWER6X
23280 processor and other processors that support the extended PowerPC V2.05
23281 architecture.
23282 The @option{-mhard-dfp} option allows GCC to generate the decimal
23283 floating-point instructions implemented on some POWER processors.
23285 The @option{-mpowerpc64} option allows GCC to generate the additional
23286 64-bit instructions that are found in the full PowerPC64 architecture
23287 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23288 @option{-mno-powerpc64}.
23290 @item -mcpu=@var{cpu_type}
23291 @opindex mcpu
23292 Set architecture type, register usage, and
23293 instruction scheduling parameters for machine type @var{cpu_type}.
23294 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23295 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23296 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23297 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23298 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23299 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23300 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23301 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23302 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23303 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23304 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23305 @samp{rs64}, and @samp{native}.
23307 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23308 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23309 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23310 architecture machine types, with an appropriate, generic processor
23311 model assumed for scheduling purposes.
23313 Specifying @samp{native} as cpu type detects and selects the
23314 architecture option that corresponds to the host processor of the
23315 system performing the compilation.
23316 @option{-mcpu=native} has no effect if GCC does not recognize the
23317 processor.
23319 The other options specify a specific processor.  Code generated under
23320 those options runs best on that processor, and may not run at all on
23321 others.
23323 The @option{-mcpu} options automatically enable or disable the
23324 following options:
23326 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23327 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23328 -mpowerpc-gpopt  -mpowerpc-gfxopt @gol
23329 -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23330 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
23331 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23333 The particular options set for any particular CPU varies between
23334 compiler versions, depending on what setting seems to produce optimal
23335 code for that CPU; it doesn't necessarily reflect the actual hardware's
23336 capabilities.  If you wish to set an individual option to a particular
23337 value, you may specify it after the @option{-mcpu} option, like
23338 @option{-mcpu=970 -mno-altivec}.
23340 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23341 not enabled or disabled by the @option{-mcpu} option at present because
23342 AIX does not have full support for these options.  You may still
23343 enable or disable them individually if you're sure it'll work in your
23344 environment.
23346 @item -mtune=@var{cpu_type}
23347 @opindex mtune
23348 Set the instruction scheduling parameters for machine type
23349 @var{cpu_type}, but do not set the architecture type or register usage,
23350 as @option{-mcpu=@var{cpu_type}} does.  The same
23351 values for @var{cpu_type} are used for @option{-mtune} as for
23352 @option{-mcpu}.  If both are specified, the code generated uses the
23353 architecture and registers set by @option{-mcpu}, but the
23354 scheduling parameters set by @option{-mtune}.
23356 @item -mcmodel=small
23357 @opindex mcmodel=small
23358 Generate PowerPC64 code for the small model: The TOC is limited to
23359 64k.
23361 @item -mcmodel=medium
23362 @opindex mcmodel=medium
23363 Generate PowerPC64 code for the medium model: The TOC and other static
23364 data may be up to a total of 4G in size.  This is the default for 64-bit
23365 Linux.
23367 @item -mcmodel=large
23368 @opindex mcmodel=large
23369 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23370 in size.  Other data and code is only limited by the 64-bit address
23371 space.
23373 @item -maltivec
23374 @itemx -mno-altivec
23375 @opindex maltivec
23376 @opindex mno-altivec
23377 Generate code that uses (does not use) AltiVec instructions, and also
23378 enable the use of built-in functions that allow more direct access to
23379 the AltiVec instruction set.  You may also need to set
23380 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23381 enhancements.
23383 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23384 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23385 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23386 match array element order corresponding to the endianness of the
23387 target.  That is, element zero identifies the leftmost element in a
23388 vector register when targeting a big-endian platform, and identifies
23389 the rightmost element in a vector register when targeting a
23390 little-endian platform.
23392 @item -maltivec=be
23393 @opindex maltivec=be
23394 Generate AltiVec instructions using big-endian element order,
23395 regardless of whether the target is big- or little-endian.  This is
23396 the default when targeting a big-endian platform.  Using this option
23397 is currently deprecated.  Support for this feature will be removed in
23398 GCC 9.
23400 The element order is used to interpret element numbers in AltiVec
23401 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23402 @code{vec_insert}.  By default, these match array element order
23403 corresponding to the endianness for the target.
23405 @item -maltivec=le
23406 @opindex maltivec=le
23407 Generate AltiVec instructions using little-endian element order,
23408 regardless of whether the target is big- or little-endian.  This is
23409 the default when targeting a little-endian platform.  This option is
23410 currently ignored when targeting a big-endian platform.
23412 The element order is used to interpret element numbers in AltiVec
23413 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23414 @code{vec_insert}.  By default, these match array element order
23415 corresponding to the endianness for the target.
23417 @item -mvrsave
23418 @itemx -mno-vrsave
23419 @opindex mvrsave
23420 @opindex mno-vrsave
23421 Generate VRSAVE instructions when generating AltiVec code.
23423 @item -msecure-plt
23424 @opindex msecure-plt
23425 Generate code that allows @command{ld} and @command{ld.so}
23426 to build executables and shared
23427 libraries with non-executable @code{.plt} and @code{.got} sections.
23428 This is a PowerPC
23429 32-bit SYSV ABI option.
23431 @item -mbss-plt
23432 @opindex mbss-plt
23433 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23434 fills in, and
23435 requires @code{.plt} and @code{.got}
23436 sections that are both writable and executable.
23437 This is a PowerPC 32-bit SYSV ABI option.
23439 @item -misel
23440 @itemx -mno-isel
23441 @opindex misel
23442 @opindex mno-isel
23443 This switch enables or disables the generation of ISEL instructions.
23445 @item -misel=@var{yes/no}
23446 This switch has been deprecated.  Use @option{-misel} and
23447 @option{-mno-isel} instead.
23449 @item -mvsx
23450 @itemx -mno-vsx
23451 @opindex mvsx
23452 @opindex mno-vsx
23453 Generate code that uses (does not use) vector/scalar (VSX)
23454 instructions, and also enable the use of built-in functions that allow
23455 more direct access to the VSX instruction set.
23457 @item -mcrypto
23458 @itemx -mno-crypto
23459 @opindex mcrypto
23460 @opindex mno-crypto
23461 Enable the use (disable) of the built-in functions that allow direct
23462 access to the cryptographic instructions that were added in version
23463 2.07 of the PowerPC ISA.
23465 @item -mhtm
23466 @itemx -mno-htm
23467 @opindex mhtm
23468 @opindex mno-htm
23469 Enable (disable) the use of the built-in functions that allow direct
23470 access to the Hardware Transactional Memory (HTM) instructions that
23471 were added in version 2.07 of the PowerPC ISA.
23473 @item -mpower8-fusion
23474 @itemx -mno-power8-fusion
23475 @opindex mpower8-fusion
23476 @opindex mno-power8-fusion
23477 Generate code that keeps (does not keeps) some integer operations
23478 adjacent so that the instructions can be fused together on power8 and
23479 later processors.
23481 @item -mpower8-vector
23482 @itemx -mno-power8-vector
23483 @opindex mpower8-vector
23484 @opindex mno-power8-vector
23485 Generate code that uses (does not use) the vector and scalar
23486 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23487 enable the use of built-in functions that allow more direct access to
23488 the vector instructions.
23490 @item -mquad-memory
23491 @itemx -mno-quad-memory
23492 @opindex mquad-memory
23493 @opindex mno-quad-memory
23494 Generate code that uses (does not use) the non-atomic quad word memory
23495 instructions.  The @option{-mquad-memory} option requires use of
23496 64-bit mode.
23498 @item -mquad-memory-atomic
23499 @itemx -mno-quad-memory-atomic
23500 @opindex mquad-memory-atomic
23501 @opindex mno-quad-memory-atomic
23502 Generate code that uses (does not use) the atomic quad word memory
23503 instructions.  The @option{-mquad-memory-atomic} option requires use of
23504 64-bit mode.
23506 @item -mfloat128
23507 @itemx -mno-float128
23508 @opindex mfloat128
23509 @opindex mno-float128
23510 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23511 and use either software emulation for IEEE 128-bit floating point or
23512 hardware instructions.
23514 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23515 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23516 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23517 floating point support only works on PowerPC Linux systems.
23519 The default for @option{-mfloat128} is enabled on PowerPC Linux
23520 systems using the VSX instruction set, and disabled on other systems.
23522 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23523 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23524 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23525 floating point instructions.  Otherwise, if you do not specify to
23526 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23527 system, IEEE 128-bit floating point will be done with software
23528 emulation.
23530 @item -mfloat128-hardware
23531 @itemx -mno-float128-hardware
23532 @opindex mfloat128-hardware
23533 @opindex mno-float128-hardware
23534 Enable/disable using ISA 3.0 hardware instructions to support the
23535 @var{__float128} data type.
23537 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23538 Linux systems using the ISA 3.0 instruction set, and disabled on other
23539 systems.
23541 @item -m32
23542 @itemx -m64
23543 @opindex m32
23544 @opindex m64
23545 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23546 targets (including GNU/Linux).  The 32-bit environment sets int, long
23547 and pointer to 32 bits and generates code that runs on any PowerPC
23548 variant.  The 64-bit environment sets int to 32 bits and long and
23549 pointer to 64 bits, and generates code for PowerPC64, as for
23550 @option{-mpowerpc64}.
23552 @item -mfull-toc
23553 @itemx -mno-fp-in-toc
23554 @itemx -mno-sum-in-toc
23555 @itemx -mminimal-toc
23556 @opindex mfull-toc
23557 @opindex mno-fp-in-toc
23558 @opindex mno-sum-in-toc
23559 @opindex mminimal-toc
23560 Modify generation of the TOC (Table Of Contents), which is created for
23561 every executable file.  The @option{-mfull-toc} option is selected by
23562 default.  In that case, GCC allocates at least one TOC entry for
23563 each unique non-automatic variable reference in your program.  GCC
23564 also places floating-point constants in the TOC@.  However, only
23565 16,384 entries are available in the TOC@.
23567 If you receive a linker error message that saying you have overflowed
23568 the available TOC space, you can reduce the amount of TOC space used
23569 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23570 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23571 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23572 generate code to calculate the sum of an address and a constant at
23573 run time instead of putting that sum into the TOC@.  You may specify one
23574 or both of these options.  Each causes GCC to produce very slightly
23575 slower and larger code at the expense of conserving TOC space.
23577 If you still run out of space in the TOC even when you specify both of
23578 these options, specify @option{-mminimal-toc} instead.  This option causes
23579 GCC to make only one TOC entry for every file.  When you specify this
23580 option, GCC produces code that is slower and larger but which
23581 uses extremely little TOC space.  You may wish to use this option
23582 only on files that contain less frequently-executed code.
23584 @item -maix64
23585 @itemx -maix32
23586 @opindex maix64
23587 @opindex maix32
23588 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23589 @code{long} type, and the infrastructure needed to support them.
23590 Specifying @option{-maix64} implies @option{-mpowerpc64},
23591 while @option{-maix32} disables the 64-bit ABI and
23592 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23594 @item -mxl-compat
23595 @itemx -mno-xl-compat
23596 @opindex mxl-compat
23597 @opindex mno-xl-compat
23598 Produce code that conforms more closely to IBM XL compiler semantics
23599 when using AIX-compatible ABI@.  Pass floating-point arguments to
23600 prototyped functions beyond the register save area (RSA) on the stack
23601 in addition to argument FPRs.  Do not assume that most significant
23602 double in 128-bit long double value is properly rounded when comparing
23603 values and converting to double.  Use XL symbol names for long double
23604 support routines.
23606 The AIX calling convention was extended but not initially documented to
23607 handle an obscure K&R C case of calling a function that takes the
23608 address of its arguments with fewer arguments than declared.  IBM XL
23609 compilers access floating-point arguments that do not fit in the
23610 RSA from the stack when a subroutine is compiled without
23611 optimization.  Because always storing floating-point arguments on the
23612 stack is inefficient and rarely needed, this option is not enabled by
23613 default and only is necessary when calling subroutines compiled by IBM
23614 XL compilers without optimization.
23616 @item -mpe
23617 @opindex mpe
23618 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23619 application written to use message passing with special startup code to
23620 enable the application to run.  The system must have PE installed in the
23621 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23622 must be overridden with the @option{-specs=} option to specify the
23623 appropriate directory location.  The Parallel Environment does not
23624 support threads, so the @option{-mpe} option and the @option{-pthread}
23625 option are incompatible.
23627 @item -malign-natural
23628 @itemx -malign-power
23629 @opindex malign-natural
23630 @opindex malign-power
23631 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23632 @option{-malign-natural} overrides the ABI-defined alignment of larger
23633 types, such as floating-point doubles, on their natural size-based boundary.
23634 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23635 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23637 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23638 is not supported.
23640 @item -msoft-float
23641 @itemx -mhard-float
23642 @opindex msoft-float
23643 @opindex mhard-float
23644 Generate code that does not use (uses) the floating-point register set.
23645 Software floating-point emulation is provided if you use the
23646 @option{-msoft-float} option, and pass the option to GCC when linking.
23648 @item -mmultiple
23649 @itemx -mno-multiple
23650 @opindex mmultiple
23651 @opindex mno-multiple
23652 Generate code that uses (does not use) the load multiple word
23653 instructions and the store multiple word instructions.  These
23654 instructions are generated by default on POWER systems, and not
23655 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23656 PowerPC systems, since those instructions do not work when the
23657 processor is in little-endian mode.  The exceptions are PPC740 and
23658 PPC750 which permit these instructions in little-endian mode.
23660 @item -mupdate
23661 @itemx -mno-update
23662 @opindex mupdate
23663 @opindex mno-update
23664 Generate code that uses (does not use) the load or store instructions
23665 that update the base register to the address of the calculated memory
23666 location.  These instructions are generated by default.  If you use
23667 @option{-mno-update}, there is a small window between the time that the
23668 stack pointer is updated and the address of the previous frame is
23669 stored, which means code that walks the stack frame across interrupts or
23670 signals may get corrupted data.
23672 @item -mavoid-indexed-addresses
23673 @itemx -mno-avoid-indexed-addresses
23674 @opindex mavoid-indexed-addresses
23675 @opindex mno-avoid-indexed-addresses
23676 Generate code that tries to avoid (not avoid) the use of indexed load
23677 or store instructions. These instructions can incur a performance
23678 penalty on Power6 processors in certain situations, such as when
23679 stepping through large arrays that cross a 16M boundary.  This option
23680 is enabled by default when targeting Power6 and disabled otherwise.
23682 @item -mfused-madd
23683 @itemx -mno-fused-madd
23684 @opindex mfused-madd
23685 @opindex mno-fused-madd
23686 Generate code that uses (does not use) the floating-point multiply and
23687 accumulate instructions.  These instructions are generated by default
23688 if hardware floating point is used.  The machine-dependent
23689 @option{-mfused-madd} option is now mapped to the machine-independent
23690 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23691 mapped to @option{-ffp-contract=off}.
23693 @item -mmulhw
23694 @itemx -mno-mulhw
23695 @opindex mmulhw
23696 @opindex mno-mulhw
23697 Generate code that uses (does not use) the half-word multiply and
23698 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23699 These instructions are generated by default when targeting those
23700 processors.
23702 @item -mdlmzb
23703 @itemx -mno-dlmzb
23704 @opindex mdlmzb
23705 @opindex mno-dlmzb
23706 Generate code that uses (does not use) the string-search @samp{dlmzb}
23707 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23708 generated by default when targeting those processors.
23710 @item -mno-bit-align
23711 @itemx -mbit-align
23712 @opindex mno-bit-align
23713 @opindex mbit-align
23714 On System V.4 and embedded PowerPC systems do not (do) force structures
23715 and unions that contain bit-fields to be aligned to the base type of the
23716 bit-field.
23718 For example, by default a structure containing nothing but 8
23719 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23720 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23721 the structure is aligned to a 1-byte boundary and is 1 byte in
23722 size.
23724 @item -mno-strict-align
23725 @itemx -mstrict-align
23726 @opindex mno-strict-align
23727 @opindex mstrict-align
23728 On System V.4 and embedded PowerPC systems do not (do) assume that
23729 unaligned memory references are handled by the system.
23731 @item -mrelocatable
23732 @itemx -mno-relocatable
23733 @opindex mrelocatable
23734 @opindex mno-relocatable
23735 Generate code that allows (does not allow) a static executable to be
23736 relocated to a different address at run time.  A simple embedded
23737 PowerPC system loader should relocate the entire contents of
23738 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23739 a table of 32-bit addresses generated by this option.  For this to
23740 work, all objects linked together must be compiled with
23741 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23742 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23744 @item -mrelocatable-lib
23745 @itemx -mno-relocatable-lib
23746 @opindex mrelocatable-lib
23747 @opindex mno-relocatable-lib
23748 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23749 @code{.fixup} section to allow static executables to be relocated at
23750 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23751 alignment of @option{-mrelocatable}.  Objects compiled with
23752 @option{-mrelocatable-lib} may be linked with objects compiled with
23753 any combination of the @option{-mrelocatable} options.
23755 @item -mno-toc
23756 @itemx -mtoc
23757 @opindex mno-toc
23758 @opindex mtoc
23759 On System V.4 and embedded PowerPC systems do not (do) assume that
23760 register 2 contains a pointer to a global area pointing to the addresses
23761 used in the program.
23763 @item -mlittle
23764 @itemx -mlittle-endian
23765 @opindex mlittle
23766 @opindex mlittle-endian
23767 On System V.4 and embedded PowerPC systems compile code for the
23768 processor in little-endian mode.  The @option{-mlittle-endian} option is
23769 the same as @option{-mlittle}.
23771 @item -mbig
23772 @itemx -mbig-endian
23773 @opindex mbig
23774 @opindex mbig-endian
23775 On System V.4 and embedded PowerPC systems compile code for the
23776 processor in big-endian mode.  The @option{-mbig-endian} option is
23777 the same as @option{-mbig}.
23779 @item -mdynamic-no-pic
23780 @opindex mdynamic-no-pic
23781 On Darwin and Mac OS X systems, compile code so that it is not
23782 relocatable, but that its external references are relocatable.  The
23783 resulting code is suitable for applications, but not shared
23784 libraries.
23786 @item -msingle-pic-base
23787 @opindex msingle-pic-base
23788 Treat the register used for PIC addressing as read-only, rather than
23789 loading it in the prologue for each function.  The runtime system is
23790 responsible for initializing this register with an appropriate value
23791 before execution begins.
23793 @item -mprioritize-restricted-insns=@var{priority}
23794 @opindex mprioritize-restricted-insns
23795 This option controls the priority that is assigned to
23796 dispatch-slot restricted instructions during the second scheduling
23797 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23798 or @samp{2} to assign no, highest, or second-highest (respectively) 
23799 priority to dispatch-slot restricted
23800 instructions.
23802 @item -msched-costly-dep=@var{dependence_type}
23803 @opindex msched-costly-dep
23804 This option controls which dependences are considered costly
23805 by the target during instruction scheduling.  The argument
23806 @var{dependence_type} takes one of the following values:
23808 @table @asis
23809 @item @samp{no}
23810 No dependence is costly.
23812 @item @samp{all}
23813 All dependences are costly.
23815 @item @samp{true_store_to_load}
23816 A true dependence from store to load is costly.
23818 @item @samp{store_to_load}
23819 Any dependence from store to load is costly.
23821 @item @var{number}
23822 Any dependence for which the latency is greater than or equal to 
23823 @var{number} is costly.
23824 @end table
23826 @item -minsert-sched-nops=@var{scheme}
23827 @opindex minsert-sched-nops
23828 This option controls which NOP insertion scheme is used during
23829 the second scheduling pass.  The argument @var{scheme} takes one of the
23830 following values:
23832 @table @asis
23833 @item @samp{no}
23834 Don't insert NOPs.
23836 @item @samp{pad}
23837 Pad with NOPs any dispatch group that has vacant issue slots,
23838 according to the scheduler's grouping.
23840 @item @samp{regroup_exact}
23841 Insert NOPs to force costly dependent insns into
23842 separate groups.  Insert exactly as many NOPs as needed to force an insn
23843 to a new group, according to the estimated processor grouping.
23845 @item @var{number}
23846 Insert NOPs to force costly dependent insns into
23847 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23848 @end table
23850 @item -mcall-sysv
23851 @opindex mcall-sysv
23852 On System V.4 and embedded PowerPC systems compile code using calling
23853 conventions that adhere to the March 1995 draft of the System V
23854 Application Binary Interface, PowerPC processor supplement.  This is the
23855 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23857 @item -mcall-sysv-eabi
23858 @itemx -mcall-eabi
23859 @opindex mcall-sysv-eabi
23860 @opindex mcall-eabi
23861 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23863 @item -mcall-sysv-noeabi
23864 @opindex mcall-sysv-noeabi
23865 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23867 @item -mcall-aixdesc
23868 @opindex m
23869 On System V.4 and embedded PowerPC systems compile code for the AIX
23870 operating system.
23872 @item -mcall-linux
23873 @opindex mcall-linux
23874 On System V.4 and embedded PowerPC systems compile code for the
23875 Linux-based GNU system.
23877 @item -mcall-freebsd
23878 @opindex mcall-freebsd
23879 On System V.4 and embedded PowerPC systems compile code for the
23880 FreeBSD operating system.
23882 @item -mcall-netbsd
23883 @opindex mcall-netbsd
23884 On System V.4 and embedded PowerPC systems compile code for the
23885 NetBSD operating system.
23887 @item -mcall-openbsd
23888 @opindex mcall-netbsd
23889 On System V.4 and embedded PowerPC systems compile code for the
23890 OpenBSD operating system.
23892 @item -mtraceback=@var{traceback_type}
23893 @opindex mtraceback
23894 Select the type of traceback table. Valid values for @var{traceback_type}
23895 are @samp{full}, @samp{part}, and @samp{no}.
23897 @item -maix-struct-return
23898 @opindex maix-struct-return
23899 Return all structures in memory (as specified by the AIX ABI)@.
23901 @item -msvr4-struct-return
23902 @opindex msvr4-struct-return
23903 Return structures smaller than 8 bytes in registers (as specified by the
23904 SVR4 ABI)@.
23906 @item -mabi=@var{abi-type}
23907 @opindex mabi
23908 Extend the current ABI with a particular extension, or remove such extension.
23909 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23910 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23911 @samp{elfv1}, @samp{elfv2}@.
23913 @item -mabi=ibmlongdouble
23914 @opindex mabi=ibmlongdouble
23915 Change the current ABI to use IBM extended-precision long double.
23916 This is not likely to work if your system defaults to using IEEE
23917 extended-precision long double.  If you change the long double type
23918 from IEEE extended-precision, the compiler will issue a warning unless
23919 you use the @option{-Wno-psabi} option.
23921 @item -mabi=ieeelongdouble
23922 @opindex mabi=ieeelongdouble
23923 Change the current ABI to use IEEE extended-precision long double.
23924 This is not likely to work if your system defaults to using IBM
23925 extended-precision long double.  If you change the long double type
23926 from IBM extended-precision, the compiler will issue a warning unless
23927 you use the @option{-Wno-psabi} option.
23929 @item -mabi=elfv1
23930 @opindex mabi=elfv1
23931 Change the current ABI to use the ELFv1 ABI.
23932 This is the default ABI for big-endian PowerPC 64-bit Linux.
23933 Overriding the default ABI requires special system support and is
23934 likely to fail in spectacular ways.
23936 @item -mabi=elfv2
23937 @opindex mabi=elfv2
23938 Change the current ABI to use the ELFv2 ABI.
23939 This is the default ABI for little-endian PowerPC 64-bit Linux.
23940 Overriding the default ABI requires special system support and is
23941 likely to fail in spectacular ways.
23943 @item -mgnu-attribute
23944 @itemx -mno-gnu-attribute
23945 @opindex mgnu-attribute
23946 @opindex mno-gnu-attribute
23947 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23948 .gnu.attributes section that specify ABI variations in function
23949 parameters or return values.
23951 @item -mprototype
23952 @itemx -mno-prototype
23953 @opindex mprototype
23954 @opindex mno-prototype
23955 On System V.4 and embedded PowerPC systems assume that all calls to
23956 variable argument functions are properly prototyped.  Otherwise, the
23957 compiler must insert an instruction before every non-prototyped call to
23958 set or clear bit 6 of the condition code register (@code{CR}) to
23959 indicate whether floating-point values are passed in the floating-point
23960 registers in case the function takes variable arguments.  With
23961 @option{-mprototype}, only calls to prototyped variable argument functions
23962 set or clear the bit.
23964 @item -msim
23965 @opindex msim
23966 On embedded PowerPC systems, assume that the startup module is called
23967 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23968 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23969 configurations.
23971 @item -mmvme
23972 @opindex mmvme
23973 On embedded PowerPC systems, assume that the startup module is called
23974 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23975 @file{libc.a}.
23977 @item -mads
23978 @opindex mads
23979 On embedded PowerPC systems, assume that the startup module is called
23980 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23981 @file{libc.a}.
23983 @item -myellowknife
23984 @opindex myellowknife
23985 On embedded PowerPC systems, assume that the startup module is called
23986 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
23987 @file{libc.a}.
23989 @item -mvxworks
23990 @opindex mvxworks
23991 On System V.4 and embedded PowerPC systems, specify that you are
23992 compiling for a VxWorks system.
23994 @item -memb
23995 @opindex memb
23996 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23997 header to indicate that @samp{eabi} extended relocations are used.
23999 @item -meabi
24000 @itemx -mno-eabi
24001 @opindex meabi
24002 @opindex mno-eabi
24003 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24004 Embedded Applications Binary Interface (EABI), which is a set of
24005 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24006 means that the stack is aligned to an 8-byte boundary, a function
24007 @code{__eabi} is called from @code{main} to set up the EABI
24008 environment, and the @option{-msdata} option can use both @code{r2} and
24009 @code{r13} to point to two separate small data areas.  Selecting
24010 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24011 no EABI initialization function is called from @code{main}, and the
24012 @option{-msdata} option only uses @code{r13} to point to a single
24013 small data area.  The @option{-meabi} option is on by default if you
24014 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24016 @item -msdata=eabi
24017 @opindex msdata=eabi
24018 On System V.4 and embedded PowerPC systems, put small initialized
24019 @code{const} global and static data in the @code{.sdata2} section, which
24020 is pointed to by register @code{r2}.  Put small initialized
24021 non-@code{const} global and static data in the @code{.sdata} section,
24022 which is pointed to by register @code{r13}.  Put small uninitialized
24023 global and static data in the @code{.sbss} section, which is adjacent to
24024 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24025 incompatible with the @option{-mrelocatable} option.  The
24026 @option{-msdata=eabi} option also sets the @option{-memb} option.
24028 @item -msdata=sysv
24029 @opindex msdata=sysv
24030 On System V.4 and embedded PowerPC systems, put small global and static
24031 data in the @code{.sdata} section, which is pointed to by register
24032 @code{r13}.  Put small uninitialized global and static data in the
24033 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24034 The @option{-msdata=sysv} option is incompatible with the
24035 @option{-mrelocatable} option.
24037 @item -msdata=default
24038 @itemx -msdata
24039 @opindex msdata=default
24040 @opindex msdata
24041 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24042 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24043 same as @option{-msdata=sysv}.
24045 @item -msdata=data
24046 @opindex msdata=data
24047 On System V.4 and embedded PowerPC systems, put small global
24048 data in the @code{.sdata} section.  Put small uninitialized global
24049 data in the @code{.sbss} section.  Do not use register @code{r13}
24050 to address small data however.  This is the default behavior unless
24051 other @option{-msdata} options are used.
24053 @item -msdata=none
24054 @itemx -mno-sdata
24055 @opindex msdata=none
24056 @opindex mno-sdata
24057 On embedded PowerPC systems, put all initialized global and static data
24058 in the @code{.data} section, and all uninitialized data in the
24059 @code{.bss} section.
24061 @item -mreadonly-in-sdata
24062 @opindex mreadonly-in-sdata
24063 @opindex mno-readonly-in-sdata
24064 Put read-only objects in the @code{.sdata} section as well.  This is the
24065 default.
24067 @item -mblock-move-inline-limit=@var{num}
24068 @opindex mblock-move-inline-limit
24069 Inline all block moves (such as calls to @code{memcpy} or structure
24070 copies) less than or equal to @var{num} bytes.  The minimum value for
24071 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24072 targets.  The default value is target-specific.
24074 @item -mblock-compare-inline-limit=@var{num}
24075 @opindex mblock-compare-inline-limit
24076 Generate non-looping inline code for all block compares (such as calls
24077 to @code{memcmp} or structure compares) less than or equal to @var{num}
24078 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24079 block compare is disabled. The default value is target-specific.
24081 @item -mblock-compare-inline-loop-limit=@var{num}
24082 @opindex mblock-compare-inline-loop-limit
24083 Generate an inline expansion using loop code for all block compares that
24084 are less than or equal to @var{num} bytes, but greater than the limit
24085 for non-loop inline block compare expansion. If the block length is not
24086 constant, at most @var{num} bytes will be compared before @code{memcmp}
24087 is called to compare the remainder of the block. The default value is
24088 target-specific.
24090 @item -mstring-compare-inline-limit=@var{num}
24091 @opindex mstring-compare-inline-limit
24092 Generate at most @var{num} pairs of load instructions to compare the
24093 string inline. If the difference or end of string is not found at the
24094 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24095 take care of the rest of the comparison. The default is 8 pairs of
24096 loads, which will compare 64 bytes on a 64-bit target and 32 bytes on a
24097 32-bit target.
24099 @item -G @var{num}
24100 @opindex G
24101 @cindex smaller data references (PowerPC)
24102 @cindex .sdata/.sdata2 references (PowerPC)
24103 On embedded PowerPC systems, put global and static items less than or
24104 equal to @var{num} bytes into the small data or BSS sections instead of
24105 the normal data or BSS section.  By default, @var{num} is 8.  The
24106 @option{-G @var{num}} switch is also passed to the linker.
24107 All modules should be compiled with the same @option{-G @var{num}} value.
24109 @item -mregnames
24110 @itemx -mno-regnames
24111 @opindex mregnames
24112 @opindex mno-regnames
24113 On System V.4 and embedded PowerPC systems do (do not) emit register
24114 names in the assembly language output using symbolic forms.
24116 @item -mlongcall
24117 @itemx -mno-longcall
24118 @opindex mlongcall
24119 @opindex mno-longcall
24120 By default assume that all calls are far away so that a longer and more
24121 expensive calling sequence is required.  This is required for calls
24122 farther than 32 megabytes (33,554,432 bytes) from the current location.
24123 A short call is generated if the compiler knows
24124 the call cannot be that far away.  This setting can be overridden by
24125 the @code{shortcall} function attribute, or by @code{#pragma
24126 longcall(0)}.
24128 Some linkers are capable of detecting out-of-range calls and generating
24129 glue code on the fly.  On these systems, long calls are unnecessary and
24130 generate slower code.  As of this writing, the AIX linker can do this,
24131 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24132 to the GNU linker for 32-bit PowerPC systems as well.
24134 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24135 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24136 addresses represent the callee and the branch island.  The
24137 Darwin/PPC linker prefers the first address and generates a @code{bl
24138 callee} if the PPC @code{bl} instruction reaches the callee directly;
24139 otherwise, the linker generates @code{bl L42} to call the branch
24140 island.  The branch island is appended to the body of the
24141 calling function; it computes the full 32-bit address of the callee
24142 and jumps to it.
24144 On Mach-O (Darwin) systems, this option directs the compiler emit to
24145 the glue for every direct call, and the Darwin linker decides whether
24146 to use or discard it.
24148 In the future, GCC may ignore all longcall specifications
24149 when the linker is known to generate glue.
24151 @item -mtls-markers
24152 @itemx -mno-tls-markers
24153 @opindex mtls-markers
24154 @opindex mno-tls-markers
24155 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24156 specifying the function argument.  The relocation allows the linker to
24157 reliably associate function call with argument setup instructions for
24158 TLS optimization, which in turn allows GCC to better schedule the
24159 sequence.
24161 @item -mrecip
24162 @itemx -mno-recip
24163 @opindex mrecip
24164 This option enables use of the reciprocal estimate and
24165 reciprocal square root estimate instructions with additional
24166 Newton-Raphson steps to increase precision instead of doing a divide or
24167 square root and divide for floating-point arguments.  You should use
24168 the @option{-ffast-math} option when using @option{-mrecip} (or at
24169 least @option{-funsafe-math-optimizations},
24170 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24171 @option{-fno-trapping-math}).  Note that while the throughput of the
24172 sequence is generally higher than the throughput of the non-reciprocal
24173 instruction, the precision of the sequence can be decreased by up to 2
24174 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24175 roots.
24177 @item -mrecip=@var{opt}
24178 @opindex mrecip=opt
24179 This option controls which reciprocal estimate instructions
24180 may be used.  @var{opt} is a comma-separated list of options, which may
24181 be preceded by a @code{!} to invert the option:
24183 @table @samp
24185 @item all
24186 Enable all estimate instructions.
24188 @item default 
24189 Enable the default instructions, equivalent to @option{-mrecip}.
24191 @item none 
24192 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24194 @item div 
24195 Enable the reciprocal approximation instructions for both 
24196 single and double precision.
24198 @item divf 
24199 Enable the single-precision reciprocal approximation instructions.
24201 @item divd 
24202 Enable the double-precision reciprocal approximation instructions.
24204 @item rsqrt 
24205 Enable the reciprocal square root approximation instructions for both
24206 single and double precision.
24208 @item rsqrtf 
24209 Enable the single-precision reciprocal square root approximation instructions.
24211 @item rsqrtd 
24212 Enable the double-precision reciprocal square root approximation instructions.
24214 @end table
24216 So, for example, @option{-mrecip=all,!rsqrtd} enables
24217 all of the reciprocal estimate instructions, except for the
24218 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24219 which handle the double-precision reciprocal square root calculations.
24221 @item -mrecip-precision
24222 @itemx -mno-recip-precision
24223 @opindex mrecip-precision
24224 Assume (do not assume) that the reciprocal estimate instructions
24225 provide higher-precision estimates than is mandated by the PowerPC
24226 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24227 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24228 The double-precision square root estimate instructions are not generated by
24229 default on low-precision machines, since they do not provide an
24230 estimate that converges after three steps.
24232 @item -mveclibabi=@var{type}
24233 @opindex mveclibabi
24234 Specifies the ABI type to use for vectorizing intrinsics using an
24235 external library.  The only type supported at present is @samp{mass},
24236 which specifies to use IBM's Mathematical Acceleration Subsystem
24237 (MASS) libraries for vectorizing intrinsics using external libraries.
24238 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24239 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24240 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24241 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24242 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24243 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24244 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24245 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24246 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24247 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24248 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24249 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24250 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24251 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24252 for power7.  Both @option{-ftree-vectorize} and
24253 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24254 libraries must be specified at link time.
24256 @item -mfriz
24257 @itemx -mno-friz
24258 @opindex mfriz
24259 Generate (do not generate) the @code{friz} instruction when the
24260 @option{-funsafe-math-optimizations} option is used to optimize
24261 rounding of floating-point values to 64-bit integer and back to floating
24262 point.  The @code{friz} instruction does not return the same value if
24263 the floating-point number is too large to fit in an integer.
24265 @item -mpointers-to-nested-functions
24266 @itemx -mno-pointers-to-nested-functions
24267 @opindex mpointers-to-nested-functions
24268 Generate (do not generate) code to load up the static chain register
24269 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24270 systems where a function pointer points to a 3-word descriptor giving
24271 the function address, TOC value to be loaded in register @code{r2}, and
24272 static chain value to be loaded in register @code{r11}.  The
24273 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24274 call through pointers to nested functions or pointers
24275 to functions compiled in other languages that use the static chain if
24276 you use @option{-mno-pointers-to-nested-functions}.
24278 @item -msave-toc-indirect
24279 @itemx -mno-save-toc-indirect
24280 @opindex msave-toc-indirect
24281 Generate (do not generate) code to save the TOC value in the reserved
24282 stack location in the function prologue if the function calls through
24283 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24284 saved in the prologue, it is saved just before the call through the
24285 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24287 @item -mcompat-align-parm
24288 @itemx -mno-compat-align-parm
24289 @opindex mcompat-align-parm
24290 Generate (do not generate) code to pass structure parameters with a
24291 maximum alignment of 64 bits, for compatibility with older versions
24292 of GCC.
24294 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24295 structure parameter on a 128-bit boundary when that structure contained
24296 a member requiring 128-bit alignment.  This is corrected in more
24297 recent versions of GCC.  This option may be used to generate code
24298 that is compatible with functions compiled with older versions of
24299 GCC.
24301 The @option{-mno-compat-align-parm} option is the default.
24303 @item -mstack-protector-guard=@var{guard}
24304 @itemx -mstack-protector-guard-reg=@var{reg}
24305 @itemx -mstack-protector-guard-offset=@var{offset}
24306 @itemx -mstack-protector-guard-symbol=@var{symbol}
24307 @opindex mstack-protector-guard
24308 @opindex mstack-protector-guard-reg
24309 @opindex mstack-protector-guard-offset
24310 @opindex mstack-protector-guard-symbol
24311 Generate stack protection code using canary at @var{guard}.  Supported
24312 locations are @samp{global} for global canary or @samp{tls} for per-thread
24313 canary in the TLS block (the default with GNU libc version 2.4 or later).
24315 With the latter choice the options
24316 @option{-mstack-protector-guard-reg=@var{reg}} and
24317 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24318 which register to use as base register for reading the canary, and from what
24319 offset from that base register. The default for those is as specified in the
24320 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24321 the offset with a symbol reference to a canary in the TLS block.
24322 @end table
24324 @node RX Options
24325 @subsection RX Options
24326 @cindex RX Options
24328 These command-line options are defined for RX targets:
24330 @table @gcctabopt
24331 @item -m64bit-doubles
24332 @itemx -m32bit-doubles
24333 @opindex m64bit-doubles
24334 @opindex m32bit-doubles
24335 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24336 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24337 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24338 works on 32-bit values, which is why the default is
24339 @option{-m32bit-doubles}.
24341 @item -fpu
24342 @itemx -nofpu
24343 @opindex fpu
24344 @opindex nofpu
24345 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24346 floating-point hardware.  The default is enabled for the RX600
24347 series and disabled for the RX200 series.
24349 Floating-point instructions are only generated for 32-bit floating-point 
24350 values, however, so the FPU hardware is not used for doubles if the
24351 @option{-m64bit-doubles} option is used.
24353 @emph{Note} If the @option{-fpu} option is enabled then
24354 @option{-funsafe-math-optimizations} is also enabled automatically.
24355 This is because the RX FPU instructions are themselves unsafe.
24357 @item -mcpu=@var{name}
24358 @opindex mcpu
24359 Selects the type of RX CPU to be targeted.  Currently three types are
24360 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24361 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24363 The only difference between @samp{RX600} and @samp{RX610} is that the
24364 @samp{RX610} does not support the @code{MVTIPL} instruction.
24366 The @samp{RX200} series does not have a hardware floating-point unit
24367 and so @option{-nofpu} is enabled by default when this type is
24368 selected.
24370 @item -mbig-endian-data
24371 @itemx -mlittle-endian-data
24372 @opindex mbig-endian-data
24373 @opindex mlittle-endian-data
24374 Store data (but not code) in the big-endian format.  The default is
24375 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24376 format.
24378 @item -msmall-data-limit=@var{N}
24379 @opindex msmall-data-limit
24380 Specifies the maximum size in bytes of global and static variables
24381 which can be placed into the small data area.  Using the small data
24382 area can lead to smaller and faster code, but the size of area is
24383 limited and it is up to the programmer to ensure that the area does
24384 not overflow.  Also when the small data area is used one of the RX's
24385 registers (usually @code{r13}) is reserved for use pointing to this
24386 area, so it is no longer available for use by the compiler.  This
24387 could result in slower and/or larger code if variables are pushed onto
24388 the stack instead of being held in this register.
24390 Note, common variables (variables that have not been initialized) and
24391 constants are not placed into the small data area as they are assigned
24392 to other sections in the output executable.
24394 The default value is zero, which disables this feature.  Note, this
24395 feature is not enabled by default with higher optimization levels
24396 (@option{-O2} etc) because of the potentially detrimental effects of
24397 reserving a register.  It is up to the programmer to experiment and
24398 discover whether this feature is of benefit to their program.  See the
24399 description of the @option{-mpid} option for a description of how the
24400 actual register to hold the small data area pointer is chosen.
24402 @item -msim
24403 @itemx -mno-sim
24404 @opindex msim
24405 @opindex mno-sim
24406 Use the simulator runtime.  The default is to use the libgloss
24407 board-specific runtime.
24409 @item -mas100-syntax
24410 @itemx -mno-as100-syntax
24411 @opindex mas100-syntax
24412 @opindex mno-as100-syntax
24413 When generating assembler output use a syntax that is compatible with
24414 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24415 assembler, but it has some restrictions so it is not generated by default.
24417 @item -mmax-constant-size=@var{N}
24418 @opindex mmax-constant-size
24419 Specifies the maximum size, in bytes, of a constant that can be used as
24420 an operand in a RX instruction.  Although the RX instruction set does
24421 allow constants of up to 4 bytes in length to be used in instructions,
24422 a longer value equates to a longer instruction.  Thus in some
24423 circumstances it can be beneficial to restrict the size of constants
24424 that are used in instructions.  Constants that are too big are instead
24425 placed into a constant pool and referenced via register indirection.
24427 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24428 or 4 means that constants of any size are allowed.
24430 @item -mrelax
24431 @opindex mrelax
24432 Enable linker relaxation.  Linker relaxation is a process whereby the
24433 linker attempts to reduce the size of a program by finding shorter
24434 versions of various instructions.  Disabled by default.
24436 @item -mint-register=@var{N}
24437 @opindex mint-register
24438 Specify the number of registers to reserve for fast interrupt handler
24439 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24440 means that register @code{r13} is reserved for the exclusive use
24441 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24442 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24443 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24444 A value of 0, the default, does not reserve any registers.
24446 @item -msave-acc-in-interrupts
24447 @opindex msave-acc-in-interrupts
24448 Specifies that interrupt handler functions should preserve the
24449 accumulator register.  This is only necessary if normal code might use
24450 the accumulator register, for example because it performs 64-bit
24451 multiplications.  The default is to ignore the accumulator as this
24452 makes the interrupt handlers faster.
24454 @item -mpid
24455 @itemx -mno-pid
24456 @opindex mpid
24457 @opindex mno-pid
24458 Enables the generation of position independent data.  When enabled any
24459 access to constant data is done via an offset from a base address
24460 held in a register.  This allows the location of constant data to be
24461 determined at run time without requiring the executable to be
24462 relocated, which is a benefit to embedded applications with tight
24463 memory constraints.  Data that can be modified is not affected by this
24464 option.
24466 Note, using this feature reserves a register, usually @code{r13}, for
24467 the constant data base address.  This can result in slower and/or
24468 larger code, especially in complicated functions.
24470 The actual register chosen to hold the constant data base address
24471 depends upon whether the @option{-msmall-data-limit} and/or the
24472 @option{-mint-register} command-line options are enabled.  Starting
24473 with register @code{r13} and proceeding downwards, registers are
24474 allocated first to satisfy the requirements of @option{-mint-register},
24475 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24476 is possible for the small data area register to be @code{r8} if both
24477 @option{-mint-register=4} and @option{-mpid} are specified on the
24478 command line.
24480 By default this feature is not enabled.  The default can be restored
24481 via the @option{-mno-pid} command-line option.
24483 @item -mno-warn-multiple-fast-interrupts
24484 @itemx -mwarn-multiple-fast-interrupts
24485 @opindex mno-warn-multiple-fast-interrupts
24486 @opindex mwarn-multiple-fast-interrupts
24487 Prevents GCC from issuing a warning message if it finds more than one
24488 fast interrupt handler when it is compiling a file.  The default is to
24489 issue a warning for each extra fast interrupt handler found, as the RX
24490 only supports one such interrupt.
24492 @item -mallow-string-insns
24493 @itemx -mno-allow-string-insns
24494 @opindex mallow-string-insns
24495 @opindex mno-allow-string-insns
24496 Enables or disables the use of the string manipulation instructions
24497 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24498 @code{SWHILE} and also the @code{RMPA} instruction.  These
24499 instructions may prefetch data, which is not safe to do if accessing
24500 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24501 for more information).
24503 The default is to allow these instructions, but it is not possible for
24504 GCC to reliably detect all circumstances where a string instruction
24505 might be used to access an I/O register, so their use cannot be
24506 disabled automatically.  Instead it is reliant upon the programmer to
24507 use the @option{-mno-allow-string-insns} option if their program
24508 accesses I/O space.
24510 When the instructions are enabled GCC defines the C preprocessor
24511 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24512 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24514 @item -mjsr
24515 @itemx -mno-jsr
24516 @opindex mjsr
24517 @opindex mno-jsr
24518 Use only (or not only) @code{JSR} instructions to access functions.
24519 This option can be used when code size exceeds the range of @code{BSR}
24520 instructions.  Note that @option{-mno-jsr} does not mean to not use
24521 @code{JSR} but instead means that any type of branch may be used.
24522 @end table
24524 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24525 has special significance to the RX port when used with the
24526 @code{interrupt} function attribute.  This attribute indicates a
24527 function intended to process fast interrupts.  GCC ensures
24528 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24529 and/or @code{r13} and only provided that the normal use of the
24530 corresponding registers have been restricted via the
24531 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24532 options.
24534 @node S/390 and zSeries Options
24535 @subsection S/390 and zSeries Options
24536 @cindex S/390 and zSeries Options
24538 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24540 @table @gcctabopt
24541 @item -mhard-float
24542 @itemx -msoft-float
24543 @opindex mhard-float
24544 @opindex msoft-float
24545 Use (do not use) the hardware floating-point instructions and registers
24546 for floating-point operations.  When @option{-msoft-float} is specified,
24547 functions in @file{libgcc.a} are used to perform floating-point
24548 operations.  When @option{-mhard-float} is specified, the compiler
24549 generates IEEE floating-point instructions.  This is the default.
24551 @item -mhard-dfp
24552 @itemx -mno-hard-dfp
24553 @opindex mhard-dfp
24554 @opindex mno-hard-dfp
24555 Use (do not use) the hardware decimal-floating-point instructions for
24556 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24557 specified, functions in @file{libgcc.a} are used to perform
24558 decimal-floating-point operations.  When @option{-mhard-dfp} is
24559 specified, the compiler generates decimal-floating-point hardware
24560 instructions.  This is the default for @option{-march=z9-ec} or higher.
24562 @item -mlong-double-64
24563 @itemx -mlong-double-128
24564 @opindex mlong-double-64
24565 @opindex mlong-double-128
24566 These switches control the size of @code{long double} type. A size
24567 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24568 type. This is the default.
24570 @item -mbackchain
24571 @itemx -mno-backchain
24572 @opindex mbackchain
24573 @opindex mno-backchain
24574 Store (do not store) the address of the caller's frame as backchain pointer
24575 into the callee's stack frame.
24576 A backchain may be needed to allow debugging using tools that do not understand
24577 DWARF call frame information.
24578 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24579 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24580 the backchain is placed into the topmost word of the 96/160 byte register
24581 save area.
24583 In general, code compiled with @option{-mbackchain} is call-compatible with
24584 code compiled with @option{-mmo-backchain}; however, use of the backchain
24585 for debugging purposes usually requires that the whole binary is built with
24586 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24587 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24588 to build a linux kernel use @option{-msoft-float}.
24590 The default is to not maintain the backchain.
24592 @item -mpacked-stack
24593 @itemx -mno-packed-stack
24594 @opindex mpacked-stack
24595 @opindex mno-packed-stack
24596 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24597 specified, the compiler uses the all fields of the 96/160 byte register save
24598 area only for their default purpose; unused fields still take up stack space.
24599 When @option{-mpacked-stack} is specified, register save slots are densely
24600 packed at the top of the register save area; unused space is reused for other
24601 purposes, allowing for more efficient use of the available stack space.
24602 However, when @option{-mbackchain} is also in effect, the topmost word of
24603 the save area is always used to store the backchain, and the return address
24604 register is always saved two words below the backchain.
24606 As long as the stack frame backchain is not used, code generated with
24607 @option{-mpacked-stack} is call-compatible with code generated with
24608 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24609 S/390 or zSeries generated code that uses the stack frame backchain at run
24610 time, not just for debugging purposes.  Such code is not call-compatible
24611 with code compiled with @option{-mpacked-stack}.  Also, note that the
24612 combination of @option{-mbackchain},
24613 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24614 to build a linux kernel use @option{-msoft-float}.
24616 The default is to not use the packed stack layout.
24618 @item -msmall-exec
24619 @itemx -mno-small-exec
24620 @opindex msmall-exec
24621 @opindex mno-small-exec
24622 Generate (or do not generate) code using the @code{bras} instruction
24623 to do subroutine calls.
24624 This only works reliably if the total executable size does not
24625 exceed 64k.  The default is to use the @code{basr} instruction instead,
24626 which does not have this limitation.
24628 @item -m64
24629 @itemx -m31
24630 @opindex m64
24631 @opindex m31
24632 When @option{-m31} is specified, generate code compliant to the
24633 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24634 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24635 particular to generate 64-bit instructions.  For the @samp{s390}
24636 targets, the default is @option{-m31}, while the @samp{s390x}
24637 targets default to @option{-m64}.
24639 @item -mzarch
24640 @itemx -mesa
24641 @opindex mzarch
24642 @opindex mesa
24643 When @option{-mzarch} is specified, generate code using the
24644 instructions available on z/Architecture.
24645 When @option{-mesa} is specified, generate code using the
24646 instructions available on ESA/390.  Note that @option{-mesa} is
24647 not possible with @option{-m64}.
24648 When generating code compliant to the GNU/Linux for S/390 ABI,
24649 the default is @option{-mesa}.  When generating code compliant
24650 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24652 @item -mhtm
24653 @itemx -mno-htm
24654 @opindex mhtm
24655 @opindex mno-htm
24656 The @option{-mhtm} option enables a set of builtins making use of
24657 instructions available with the transactional execution facility
24658 introduced with the IBM zEnterprise EC12 machine generation
24659 @ref{S/390 System z Built-in Functions}.
24660 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24662 @item -mvx
24663 @itemx -mno-vx
24664 @opindex mvx
24665 @opindex mno-vx
24666 When @option{-mvx} is specified, generate code using the instructions
24667 available with the vector extension facility introduced with the IBM
24668 z13 machine generation.
24669 This option changes the ABI for some vector type values with regard to
24670 alignment and calling conventions.  In case vector type values are
24671 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24672 command will be added to mark the resulting binary with the ABI used.
24673 @option{-mvx} is enabled by default when using @option{-march=z13}.
24675 @item -mzvector
24676 @itemx -mno-zvector
24677 @opindex mzvector
24678 @opindex mno-zvector
24679 The @option{-mzvector} option enables vector language extensions and
24680 builtins using instructions available with the vector extension
24681 facility introduced with the IBM z13 machine generation.
24682 This option adds support for @samp{vector} to be used as a keyword to
24683 define vector type variables and arguments.  @samp{vector} is only
24684 available when GNU extensions are enabled.  It will not be expanded
24685 when requesting strict standard compliance e.g. with @option{-std=c99}.
24686 In addition to the GCC low-level builtins @option{-mzvector} enables
24687 a set of builtins added for compatibility with AltiVec-style
24688 implementations like Power and Cell.  In order to make use of these
24689 builtins the header file @file{vecintrin.h} needs to be included.
24690 @option{-mzvector} is disabled by default.
24692 @item -mmvcle
24693 @itemx -mno-mvcle
24694 @opindex mmvcle
24695 @opindex mno-mvcle
24696 Generate (or do not generate) code using the @code{mvcle} instruction
24697 to perform block moves.  When @option{-mno-mvcle} is specified,
24698 use a @code{mvc} loop instead.  This is the default unless optimizing for
24699 size.
24701 @item -mdebug
24702 @itemx -mno-debug
24703 @opindex mdebug
24704 @opindex mno-debug
24705 Print (or do not print) additional debug information when compiling.
24706 The default is to not print debug information.
24708 @item -march=@var{cpu-type}
24709 @opindex march
24710 Generate code that runs on @var{cpu-type}, which is the name of a
24711 system representing a certain processor type.  Possible values for
24712 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24713 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24714 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24715 @samp{native}.
24717 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24718 @samp{g6} are deprecated and will be removed with future releases.
24720 Specifying @samp{native} as cpu type can be used to select the best
24721 architecture option for the host processor.
24722 @option{-march=native} has no effect if GCC does not recognize the
24723 processor.
24725 @item -mtune=@var{cpu-type}
24726 @opindex mtune
24727 Tune to @var{cpu-type} everything applicable about the generated code,
24728 except for the ABI and the set of available instructions.
24729 The list of @var{cpu-type} values is the same as for @option{-march}.
24730 The default is the value used for @option{-march}.
24732 @item -mtpf-trace
24733 @itemx -mno-tpf-trace
24734 @opindex mtpf-trace
24735 @opindex mno-tpf-trace
24736 Generate code that adds (does not add) in TPF OS specific branches to trace
24737 routines in the operating system.  This option is off by default, even
24738 when compiling for the TPF OS@.
24740 @item -mfused-madd
24741 @itemx -mno-fused-madd
24742 @opindex mfused-madd
24743 @opindex mno-fused-madd
24744 Generate code that uses (does not use) the floating-point multiply and
24745 accumulate instructions.  These instructions are generated by default if
24746 hardware floating point is used.
24748 @item -mwarn-framesize=@var{framesize}
24749 @opindex mwarn-framesize
24750 Emit a warning if the current function exceeds the given frame size.  Because
24751 this is a compile-time check it doesn't need to be a real problem when the program
24752 runs.  It is intended to identify functions that most probably cause
24753 a stack overflow.  It is useful to be used in an environment with limited stack
24754 size e.g.@: the linux kernel.
24756 @item -mwarn-dynamicstack
24757 @opindex mwarn-dynamicstack
24758 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24759 arrays.  This is generally a bad idea with a limited stack size.
24761 @item -mstack-guard=@var{stack-guard}
24762 @itemx -mstack-size=@var{stack-size}
24763 @opindex mstack-guard
24764 @opindex mstack-size
24765 If these options are provided the S/390 back end emits additional instructions in
24766 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24767 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24768 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24769 the frame size of the compiled function is chosen.
24770 These options are intended to be used to help debugging stack overflow problems.
24771 The additionally emitted code causes only little overhead and hence can also be
24772 used in production-like systems without greater performance degradation.  The given
24773 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24774 @var{stack-guard} without exceeding 64k.
24775 In order to be efficient the extra code makes the assumption that the stack starts
24776 at an address aligned to the value given by @var{stack-size}.
24777 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24779 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24780 @opindex mhotpatch
24781 If the hotpatch option is enabled, a ``hot-patching'' function
24782 prologue is generated for all functions in the compilation unit.
24783 The funtion label is prepended with the given number of two-byte
24784 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24785 the label, 2 * @var{post-halfwords} bytes are appended, using the
24786 largest NOP like instructions the architecture allows (maximum
24787 1000000).
24789 If both arguments are zero, hotpatching is disabled.
24791 This option can be overridden for individual functions with the
24792 @code{hotpatch} attribute.
24793 @end table
24795 @node Score Options
24796 @subsection Score Options
24797 @cindex Score Options
24799 These options are defined for Score implementations:
24801 @table @gcctabopt
24802 @item -meb
24803 @opindex meb
24804 Compile code for big-endian mode.  This is the default.
24806 @item -mel
24807 @opindex mel
24808 Compile code for little-endian mode.
24810 @item -mnhwloop
24811 @opindex mnhwloop
24812 Disable generation of @code{bcnz} instructions.
24814 @item -muls
24815 @opindex muls
24816 Enable generation of unaligned load and store instructions.
24818 @item -mmac
24819 @opindex mmac
24820 Enable the use of multiply-accumulate instructions. Disabled by default.
24822 @item -mscore5
24823 @opindex mscore5
24824 Specify the SCORE5 as the target architecture.
24826 @item -mscore5u
24827 @opindex mscore5u
24828 Specify the SCORE5U of the target architecture.
24830 @item -mscore7
24831 @opindex mscore7
24832 Specify the SCORE7 as the target architecture. This is the default.
24834 @item -mscore7d
24835 @opindex mscore7d
24836 Specify the SCORE7D as the target architecture.
24837 @end table
24839 @node SH Options
24840 @subsection SH Options
24842 These @samp{-m} options are defined for the SH implementations:
24844 @table @gcctabopt
24845 @item -m1
24846 @opindex m1
24847 Generate code for the SH1.
24849 @item -m2
24850 @opindex m2
24851 Generate code for the SH2.
24853 @item -m2e
24854 Generate code for the SH2e.
24856 @item -m2a-nofpu
24857 @opindex m2a-nofpu
24858 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24859 that the floating-point unit is not used.
24861 @item -m2a-single-only
24862 @opindex m2a-single-only
24863 Generate code for the SH2a-FPU, in such a way that no double-precision
24864 floating-point operations are used.
24866 @item -m2a-single
24867 @opindex m2a-single
24868 Generate code for the SH2a-FPU assuming the floating-point unit is in
24869 single-precision mode by default.
24871 @item -m2a
24872 @opindex m2a
24873 Generate code for the SH2a-FPU assuming the floating-point unit is in
24874 double-precision mode by default.
24876 @item -m3
24877 @opindex m3
24878 Generate code for the SH3.
24880 @item -m3e
24881 @opindex m3e
24882 Generate code for the SH3e.
24884 @item -m4-nofpu
24885 @opindex m4-nofpu
24886 Generate code for the SH4 without a floating-point unit.
24888 @item -m4-single-only
24889 @opindex m4-single-only
24890 Generate code for the SH4 with a floating-point unit that only
24891 supports single-precision arithmetic.
24893 @item -m4-single
24894 @opindex m4-single
24895 Generate code for the SH4 assuming the floating-point unit is in
24896 single-precision mode by default.
24898 @item -m4
24899 @opindex m4
24900 Generate code for the SH4.
24902 @item -m4-100
24903 @opindex m4-100
24904 Generate code for SH4-100.
24906 @item -m4-100-nofpu
24907 @opindex m4-100-nofpu
24908 Generate code for SH4-100 in such a way that the
24909 floating-point unit is not used.
24911 @item -m4-100-single
24912 @opindex m4-100-single
24913 Generate code for SH4-100 assuming the floating-point unit is in
24914 single-precision mode by default.
24916 @item -m4-100-single-only
24917 @opindex m4-100-single-only
24918 Generate code for SH4-100 in such a way that no double-precision
24919 floating-point operations are used.
24921 @item -m4-200
24922 @opindex m4-200
24923 Generate code for SH4-200.
24925 @item -m4-200-nofpu
24926 @opindex m4-200-nofpu
24927 Generate code for SH4-200 without in such a way that the
24928 floating-point unit is not used.
24930 @item -m4-200-single
24931 @opindex m4-200-single
24932 Generate code for SH4-200 assuming the floating-point unit is in
24933 single-precision mode by default.
24935 @item -m4-200-single-only
24936 @opindex m4-200-single-only
24937 Generate code for SH4-200 in such a way that no double-precision
24938 floating-point operations are used.
24940 @item -m4-300
24941 @opindex m4-300
24942 Generate code for SH4-300.
24944 @item -m4-300-nofpu
24945 @opindex m4-300-nofpu
24946 Generate code for SH4-300 without in such a way that the
24947 floating-point unit is not used.
24949 @item -m4-300-single
24950 @opindex m4-300-single
24951 Generate code for SH4-300 in such a way that no double-precision
24952 floating-point operations are used.
24954 @item -m4-300-single-only
24955 @opindex m4-300-single-only
24956 Generate code for SH4-300 in such a way that no double-precision
24957 floating-point operations are used.
24959 @item -m4-340
24960 @opindex m4-340
24961 Generate code for SH4-340 (no MMU, no FPU).
24963 @item -m4-500
24964 @opindex m4-500
24965 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24966 assembler.
24968 @item -m4a-nofpu
24969 @opindex m4a-nofpu
24970 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
24971 floating-point unit is not used.
24973 @item -m4a-single-only
24974 @opindex m4a-single-only
24975 Generate code for the SH4a, in such a way that no double-precision
24976 floating-point operations are used.
24978 @item -m4a-single
24979 @opindex m4a-single
24980 Generate code for the SH4a assuming the floating-point unit is in
24981 single-precision mode by default.
24983 @item -m4a
24984 @opindex m4a
24985 Generate code for the SH4a.
24987 @item -m4al
24988 @opindex m4al
24989 Same as @option{-m4a-nofpu}, except that it implicitly passes
24990 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
24991 instructions at the moment.
24993 @item -mb
24994 @opindex mb
24995 Compile code for the processor in big-endian mode.
24997 @item -ml
24998 @opindex ml
24999 Compile code for the processor in little-endian mode.
25001 @item -mdalign
25002 @opindex mdalign
25003 Align doubles at 64-bit boundaries.  Note that this changes the calling
25004 conventions, and thus some functions from the standard C library do
25005 not work unless you recompile it first with @option{-mdalign}.
25007 @item -mrelax
25008 @opindex mrelax
25009 Shorten some address references at link time, when possible; uses the
25010 linker option @option{-relax}.
25012 @item -mbigtable
25013 @opindex mbigtable
25014 Use 32-bit offsets in @code{switch} tables.  The default is to use
25015 16-bit offsets.
25017 @item -mbitops
25018 @opindex mbitops
25019 Enable the use of bit manipulation instructions on SH2A.
25021 @item -mfmovd
25022 @opindex mfmovd
25023 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25024 alignment constraints.
25026 @item -mrenesas
25027 @opindex mrenesas
25028 Comply with the calling conventions defined by Renesas.
25030 @item -mno-renesas
25031 @opindex mno-renesas
25032 Comply with the calling conventions defined for GCC before the Renesas
25033 conventions were available.  This option is the default for all
25034 targets of the SH toolchain.
25036 @item -mnomacsave
25037 @opindex mnomacsave
25038 Mark the @code{MAC} register as call-clobbered, even if
25039 @option{-mrenesas} is given.
25041 @item -mieee
25042 @itemx -mno-ieee
25043 @opindex mieee
25044 @opindex mno-ieee
25045 Control the IEEE compliance of floating-point comparisons, which affects the
25046 handling of cases where the result of a comparison is unordered.  By default
25047 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25048 enabled @option{-mno-ieee} is implicitly set, which results in faster
25049 floating-point greater-equal and less-equal comparisons.  The implicit settings
25050 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25052 @item -minline-ic_invalidate
25053 @opindex minline-ic_invalidate
25054 Inline code to invalidate instruction cache entries after setting up
25055 nested function trampolines.
25056 This option has no effect if @option{-musermode} is in effect and the selected
25057 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25058 instruction.
25059 If the selected code generation option does not allow the use of the @code{icbi}
25060 instruction, and @option{-musermode} is not in effect, the inlined code
25061 manipulates the instruction cache address array directly with an associative
25062 write.  This not only requires privileged mode at run time, but it also
25063 fails if the cache line had been mapped via the TLB and has become unmapped.
25065 @item -misize
25066 @opindex misize
25067 Dump instruction size and location in the assembly code.
25069 @item -mpadstruct
25070 @opindex mpadstruct
25071 This option is deprecated.  It pads structures to multiple of 4 bytes,
25072 which is incompatible with the SH ABI@.
25074 @item -matomic-model=@var{model}
25075 @opindex matomic-model=@var{model}
25076 Sets the model of atomic operations and additional parameters as a comma
25077 separated list.  For details on the atomic built-in functions see
25078 @ref{__atomic Builtins}.  The following models and parameters are supported:
25080 @table @samp
25082 @item none
25083 Disable compiler generated atomic sequences and emit library calls for atomic
25084 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25086 @item soft-gusa
25087 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25088 built-in functions.  The generated atomic sequences require additional support
25089 from the interrupt/exception handling code of the system and are only suitable
25090 for SH3* and SH4* single-core systems.  This option is enabled by default when
25091 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25092 this option also partially utilizes the hardware atomic instructions
25093 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25094 @samp{strict} is specified.  
25096 @item soft-tcb
25097 Generate software atomic sequences that use a variable in the thread control
25098 block.  This is a variation of the gUSA sequences which can also be used on
25099 SH1* and SH2* targets.  The generated atomic sequences require additional
25100 support from the interrupt/exception handling code of the system and are only
25101 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25102 parameter has to be specified as well.
25104 @item soft-imask
25105 Generate software atomic sequences that temporarily disable interrupts by
25106 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25107 in privileged mode and is only suitable for single-core systems.  Additional
25108 support from the interrupt/exception handling code of the system is not
25109 required.  This model is enabled by default when the target is
25110 @code{sh*-*-linux*} and SH1* or SH2*.
25112 @item hard-llcs
25113 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25114 instructions only.  This is only available on SH4A and is suitable for
25115 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25116 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25117 Code compiled with this option is also compatible with other software
25118 atomic model interrupt/exception handling systems if executed on an SH4A
25119 system.  Additional support from the interrupt/exception handling code of the
25120 system is not required for this model.
25122 @item gbr-offset=
25123 This parameter specifies the offset in bytes of the variable in the thread
25124 control block structure that should be used by the generated atomic sequences
25125 when the @samp{soft-tcb} model has been selected.  For other models this
25126 parameter is ignored.  The specified value must be an integer multiple of four
25127 and in the range 0-1020.
25129 @item strict
25130 This parameter prevents mixed usage of multiple atomic models, even if they
25131 are compatible, and makes the compiler generate atomic sequences of the
25132 specified model only.
25134 @end table
25136 @item -mtas
25137 @opindex mtas
25138 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25139 Notice that depending on the particular hardware and software configuration
25140 this can degrade overall performance due to the operand cache line flushes
25141 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25142 processors the @code{tas.b} instruction must be used with caution since it
25143 can result in data corruption for certain cache configurations.
25145 @item -mprefergot
25146 @opindex mprefergot
25147 When generating position-independent code, emit function calls using
25148 the Global Offset Table instead of the Procedure Linkage Table.
25150 @item -musermode
25151 @itemx -mno-usermode
25152 @opindex musermode
25153 @opindex mno-usermode
25154 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25155 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25156 inlined code would not work in user mode.  @option{-musermode} is the default
25157 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25158 @option{-musermode} has no effect, since there is no user mode.
25160 @item -multcost=@var{number}
25161 @opindex multcost=@var{number}
25162 Set the cost to assume for a multiply insn.
25164 @item -mdiv=@var{strategy}
25165 @opindex mdiv=@var{strategy}
25166 Set the division strategy to be used for integer division operations.
25167 @var{strategy} can be one of: 
25169 @table @samp
25171 @item call-div1
25172 Calls a library function that uses the single-step division instruction
25173 @code{div1} to perform the operation.  Division by zero calculates an
25174 unspecified result and does not trap.  This is the default except for SH4,
25175 SH2A and SHcompact.
25177 @item call-fp
25178 Calls a library function that performs the operation in double precision
25179 floating point.  Division by zero causes a floating-point exception.  This is
25180 the default for SHcompact with FPU.  Specifying this for targets that do not
25181 have a double precision FPU defaults to @code{call-div1}.
25183 @item call-table
25184 Calls a library function that uses a lookup table for small divisors and
25185 the @code{div1} instruction with case distinction for larger divisors.  Division
25186 by zero calculates an unspecified result and does not trap.  This is the default
25187 for SH4.  Specifying this for targets that do not have dynamic shift
25188 instructions defaults to @code{call-div1}.
25190 @end table
25192 When a division strategy has not been specified the default strategy is
25193 selected based on the current target.  For SH2A the default strategy is to
25194 use the @code{divs} and @code{divu} instructions instead of library function
25195 calls.
25197 @item -maccumulate-outgoing-args
25198 @opindex maccumulate-outgoing-args
25199 Reserve space once for outgoing arguments in the function prologue rather
25200 than around each call.  Generally beneficial for performance and size.  Also
25201 needed for unwinding to avoid changing the stack frame around conditional code.
25203 @item -mdivsi3_libfunc=@var{name}
25204 @opindex mdivsi3_libfunc=@var{name}
25205 Set the name of the library function used for 32-bit signed division to
25206 @var{name}.
25207 This only affects the name used in the @samp{call} division strategies, and
25208 the compiler still expects the same sets of input/output/clobbered registers as
25209 if this option were not present.
25211 @item -mfixed-range=@var{register-range}
25212 @opindex mfixed-range
25213 Generate code treating the given register range as fixed registers.
25214 A fixed register is one that the register allocator can not use.  This is
25215 useful when compiling kernel code.  A register range is specified as
25216 two registers separated by a dash.  Multiple register ranges can be
25217 specified separated by a comma.
25219 @item -mbranch-cost=@var{num}
25220 @opindex mbranch-cost=@var{num}
25221 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25222 make the compiler try to generate more branch-free code if possible.  
25223 If not specified the value is selected depending on the processor type that
25224 is being compiled for.
25226 @item -mzdcbranch
25227 @itemx -mno-zdcbranch
25228 @opindex mzdcbranch
25229 @opindex mno-zdcbranch
25230 Assume (do not assume) that zero displacement conditional branch instructions
25231 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25232 compiler prefers zero displacement branch code sequences.  This is
25233 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25234 disabled by specifying @option{-mno-zdcbranch}.
25236 @item -mcbranch-force-delay-slot
25237 @opindex mcbranch-force-delay-slot
25238 Force the usage of delay slots for conditional branches, which stuffs the delay
25239 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25240 this option is disabled.  It can be enabled to work around hardware bugs as
25241 found in the original SH7055.
25243 @item -mfused-madd
25244 @itemx -mno-fused-madd
25245 @opindex mfused-madd
25246 @opindex mno-fused-madd
25247 Generate code that uses (does not use) the floating-point multiply and
25248 accumulate instructions.  These instructions are generated by default
25249 if hardware floating point is used.  The machine-dependent
25250 @option{-mfused-madd} option is now mapped to the machine-independent
25251 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25252 mapped to @option{-ffp-contract=off}.
25254 @item -mfsca
25255 @itemx -mno-fsca
25256 @opindex mfsca
25257 @opindex mno-fsca
25258 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25259 and cosine approximations.  The option @option{-mfsca} must be used in
25260 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25261 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25262 approximations even if @option{-funsafe-math-optimizations} is in effect.
25264 @item -mfsrra
25265 @itemx -mno-fsrra
25266 @opindex mfsrra
25267 @opindex mno-fsrra
25268 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25269 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25270 in combination with @option{-funsafe-math-optimizations} and
25271 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25272 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25273 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25274 in effect.
25276 @item -mpretend-cmove
25277 @opindex mpretend-cmove
25278 Prefer zero-displacement conditional branches for conditional move instruction
25279 patterns.  This can result in faster code on the SH4 processor.
25281 @item -mfdpic
25282 @opindex fdpic
25283 Generate code using the FDPIC ABI.
25285 @end table
25287 @node Solaris 2 Options
25288 @subsection Solaris 2 Options
25289 @cindex Solaris 2 options
25291 These @samp{-m} options are supported on Solaris 2:
25293 @table @gcctabopt
25294 @item -mclear-hwcap
25295 @opindex mclear-hwcap
25296 @option{-mclear-hwcap} tells the compiler to remove the hardware
25297 capabilities generated by the Solaris assembler.  This is only necessary
25298 when object files use ISA extensions not supported by the current
25299 machine, but check at runtime whether or not to use them.
25301 @item -mimpure-text
25302 @opindex mimpure-text
25303 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25304 the compiler to not pass @option{-z text} to the linker when linking a
25305 shared object.  Using this option, you can link position-dependent
25306 code into a shared object.
25308 @option{-mimpure-text} suppresses the ``relocations remain against
25309 allocatable but non-writable sections'' linker error message.
25310 However, the necessary relocations trigger copy-on-write, and the
25311 shared object is not actually shared across processes.  Instead of
25312 using @option{-mimpure-text}, you should compile all source code with
25313 @option{-fpic} or @option{-fPIC}.
25315 @end table
25317 These switches are supported in addition to the above on Solaris 2:
25319 @table @gcctabopt
25320 @item -pthreads
25321 @opindex pthreads
25322 This is a synonym for @option{-pthread}.
25323 @end table
25325 @node SPARC Options
25326 @subsection SPARC Options
25327 @cindex SPARC options
25329 These @samp{-m} options are supported on the SPARC:
25331 @table @gcctabopt
25332 @item -mno-app-regs
25333 @itemx -mapp-regs
25334 @opindex mno-app-regs
25335 @opindex mapp-regs
25336 Specify @option{-mapp-regs} to generate output using the global registers
25337 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25338 global register 1, each global register 2 through 4 is then treated as an
25339 allocable register that is clobbered by function calls.  This is the default.
25341 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25342 specify @option{-mno-app-regs}.  You should compile libraries and system
25343 software with this option.
25345 @item -mflat
25346 @itemx -mno-flat
25347 @opindex mflat
25348 @opindex mno-flat
25349 With @option{-mflat}, the compiler does not generate save/restore instructions
25350 and uses a ``flat'' or single register window model.  This model is compatible
25351 with the regular register window model.  The local registers and the input
25352 registers (0--5) are still treated as ``call-saved'' registers and are
25353 saved on the stack as needed.
25355 With @option{-mno-flat} (the default), the compiler generates save/restore
25356 instructions (except for leaf functions).  This is the normal operating mode.
25358 @item -mfpu
25359 @itemx -mhard-float
25360 @opindex mfpu
25361 @opindex mhard-float
25362 Generate output containing floating-point instructions.  This is the
25363 default.
25365 @item -mno-fpu
25366 @itemx -msoft-float
25367 @opindex mno-fpu
25368 @opindex msoft-float
25369 Generate output containing library calls for floating point.
25370 @strong{Warning:} the requisite libraries are not available for all SPARC
25371 targets.  Normally the facilities of the machine's usual C compiler are
25372 used, but this cannot be done directly in cross-compilation.  You must make
25373 your own arrangements to provide suitable library functions for
25374 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25375 @samp{sparclite-*-*} do provide software floating-point support.
25377 @option{-msoft-float} changes the calling convention in the output file;
25378 therefore, it is only useful if you compile @emph{all} of a program with
25379 this option.  In particular, you need to compile @file{libgcc.a}, the
25380 library that comes with GCC, with @option{-msoft-float} in order for
25381 this to work.
25383 @item -mhard-quad-float
25384 @opindex mhard-quad-float
25385 Generate output containing quad-word (long double) floating-point
25386 instructions.
25388 @item -msoft-quad-float
25389 @opindex msoft-quad-float
25390 Generate output containing library calls for quad-word (long double)
25391 floating-point instructions.  The functions called are those specified
25392 in the SPARC ABI@.  This is the default.
25394 As of this writing, there are no SPARC implementations that have hardware
25395 support for the quad-word floating-point instructions.  They all invoke
25396 a trap handler for one of these instructions, and then the trap handler
25397 emulates the effect of the instruction.  Because of the trap handler overhead,
25398 this is much slower than calling the ABI library routines.  Thus the
25399 @option{-msoft-quad-float} option is the default.
25401 @item -mno-unaligned-doubles
25402 @itemx -munaligned-doubles
25403 @opindex mno-unaligned-doubles
25404 @opindex munaligned-doubles
25405 Assume that doubles have 8-byte alignment.  This is the default.
25407 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25408 alignment only if they are contained in another type, or if they have an
25409 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25410 Specifying this option avoids some rare compatibility problems with code
25411 generated by other compilers.  It is not the default because it results
25412 in a performance loss, especially for floating-point code.
25414 @item -muser-mode
25415 @itemx -mno-user-mode
25416 @opindex muser-mode
25417 @opindex mno-user-mode
25418 Do not generate code that can only run in supervisor mode.  This is relevant
25419 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25420 is the default.
25422 @item -mfaster-structs
25423 @itemx -mno-faster-structs
25424 @opindex mfaster-structs
25425 @opindex mno-faster-structs
25426 With @option{-mfaster-structs}, the compiler assumes that structures
25427 should have 8-byte alignment.  This enables the use of pairs of
25428 @code{ldd} and @code{std} instructions for copies in structure
25429 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25430 However, the use of this changed alignment directly violates the SPARC
25431 ABI@.  Thus, it's intended only for use on targets where the developer
25432 acknowledges that their resulting code is not directly in line with
25433 the rules of the ABI@.
25435 @item -mstd-struct-return
25436 @itemx -mno-std-struct-return
25437 @opindex mstd-struct-return
25438 @opindex mno-std-struct-return
25439 With @option{-mstd-struct-return}, the compiler generates checking code
25440 in functions returning structures or unions to detect size mismatches
25441 between the two sides of function calls, as per the 32-bit ABI@.
25443 The default is @option{-mno-std-struct-return}.  This option has no effect
25444 in 64-bit mode.
25446 @item -mlra
25447 @itemx -mno-lra
25448 @opindex mlra
25449 @opindex mno-lra
25450 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25451 so @option{-mno-lra} needs to be passed to get old Reload.
25453 @item -mcpu=@var{cpu_type}
25454 @opindex mcpu
25455 Set the instruction set, register set, and instruction scheduling parameters
25456 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25457 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25458 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25459 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25460 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25461 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25463 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25464 which selects the best architecture option for the host processor.
25465 @option{-mcpu=native} has no effect if GCC does not recognize
25466 the processor.
25468 Default instruction scheduling parameters are used for values that select
25469 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25470 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25472 Here is a list of each supported architecture and their supported
25473 implementations.
25475 @table @asis
25476 @item v7
25477 cypress, leon3v7
25479 @item v8
25480 supersparc, hypersparc, leon, leon3
25482 @item sparclite
25483 f930, f934, sparclite86x
25485 @item sparclet
25486 tsc701
25488 @item v9
25489 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25490 niagara7, m8
25491 @end table
25493 By default (unless configured otherwise), GCC generates code for the V7
25494 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25495 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25496 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25497 SPARCStation 1, 2, IPX etc.
25499 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25500 architecture.  The only difference from V7 code is that the compiler emits
25501 the integer multiply and integer divide instructions which exist in SPARC-V8
25502 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25503 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25504 2000 series.
25506 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25507 the SPARC architecture.  This adds the integer multiply, integer divide step
25508 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25509 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25510 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25511 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25512 MB86934 chip, which is the more recent SPARClite with FPU@.
25514 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25515 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25516 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25517 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25518 optimizes it for the TEMIC SPARClet chip.
25520 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25521 architecture.  This adds 64-bit integer and floating-point move instructions,
25522 3 additional floating-point condition code registers and conditional move
25523 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25524 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25525 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25526 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25527 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25528 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25529 additionally optimizes it for Sun UltraSPARC T2 chips. With
25530 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25531 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25532 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25533 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25534 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25535 additionally optimizes it for Oracle M8 chips.
25537 @item -mtune=@var{cpu_type}
25538 @opindex mtune
25539 Set the instruction scheduling parameters for machine type
25540 @var{cpu_type}, but do not set the instruction set or register set that the
25541 option @option{-mcpu=@var{cpu_type}} does.
25543 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25544 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25545 that select a particular CPU implementation.  Those are
25546 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25547 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25548 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25549 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25550 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25551 and GNU/Linux toolchains, @samp{native} can also be used.
25553 @item -mv8plus
25554 @itemx -mno-v8plus
25555 @opindex mv8plus
25556 @opindex mno-v8plus
25557 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25558 difference from the V8 ABI is that the global and out registers are
25559 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25560 mode for all SPARC-V9 processors.
25562 @item -mvis
25563 @itemx -mno-vis
25564 @opindex mvis
25565 @opindex mno-vis
25566 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25567 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25569 @item -mvis2
25570 @itemx -mno-vis2
25571 @opindex mvis2
25572 @opindex mno-vis2
25573 With @option{-mvis2}, GCC generates code that takes advantage of
25574 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25575 default is @option{-mvis2} when targeting a cpu that supports such
25576 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25577 also sets @option{-mvis}.
25579 @item -mvis3
25580 @itemx -mno-vis3
25581 @opindex mvis3
25582 @opindex mno-vis3
25583 With @option{-mvis3}, GCC generates code that takes advantage of
25584 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25585 default is @option{-mvis3} when targeting a cpu that supports such
25586 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25587 also sets @option{-mvis2} and @option{-mvis}.
25589 @item -mvis4
25590 @itemx -mno-vis4
25591 @opindex mvis4
25592 @opindex mno-vis4
25593 With @option{-mvis4}, GCC generates code that takes advantage of
25594 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25595 default is @option{-mvis4} when targeting a cpu that supports such
25596 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25597 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25599 @item -mvis4b
25600 @itemx -mno-vis4b
25601 @opindex mvis4b
25602 @opindex mno-vis4b
25603 With @option{-mvis4b}, GCC generates code that takes advantage of
25604 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25605 the additional VIS instructions introduced in the Oracle SPARC
25606 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25607 cpu that supports such instructions, such as m8 and later.  Setting
25608 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25609 @option{-mvis2} and @option{-mvis}.
25611 @item -mcbcond
25612 @itemx -mno-cbcond
25613 @opindex mcbcond
25614 @opindex mno-cbcond
25615 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25616 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25617 when targeting a CPU that supports such instructions, such as Niagara-4 and
25618 later.
25620 @item -mfmaf
25621 @itemx -mno-fmaf
25622 @opindex mfmaf
25623 @opindex mno-fmaf
25624 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25625 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25626 when targeting a CPU that supports such instructions, such as Niagara-3 and
25627 later.
25629 @item -mfsmuld
25630 @itemx -mno-fsmuld
25631 @opindex mfsmuld
25632 @opindex mno-fsmuld
25633 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25634 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25635 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25636 or V9 with FPU except @option{-mcpu=leon}.
25638 @item -mpopc
25639 @itemx -mno-popc
25640 @opindex mpopc
25641 @opindex mno-popc
25642 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25643 Population Count instruction.  The default is @option{-mpopc}
25644 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25645 later.
25647 @item -msubxc
25648 @itemx -mno-subxc
25649 @opindex msubxc
25650 @opindex mno-subxc
25651 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25652 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25653 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25654 later.
25656 @item -mfix-at697f
25657 @opindex mfix-at697f
25658 Enable the documented workaround for the single erratum of the Atmel AT697F
25659 processor (which corresponds to erratum #13 of the AT697E processor).
25661 @item -mfix-ut699
25662 @opindex mfix-ut699
25663 Enable the documented workarounds for the floating-point errata and the data
25664 cache nullify errata of the UT699 processor.
25666 @item -mfix-ut700
25667 @opindex mfix-ut700
25668 Enable the documented workaround for the back-to-back store errata of
25669 the UT699E/UT700 processor.
25671 @item -mfix-gr712rc
25672 @opindex mfix-gr712rc
25673 Enable the documented workaround for the back-to-back store errata of
25674 the GR712RC processor.
25675 @end table
25677 These @samp{-m} options are supported in addition to the above
25678 on SPARC-V9 processors in 64-bit environments:
25680 @table @gcctabopt
25681 @item -m32
25682 @itemx -m64
25683 @opindex m32
25684 @opindex m64
25685 Generate code for a 32-bit or 64-bit environment.
25686 The 32-bit environment sets int, long and pointer to 32 bits.
25687 The 64-bit environment sets int to 32 bits and long and pointer
25688 to 64 bits.
25690 @item -mcmodel=@var{which}
25691 @opindex mcmodel
25692 Set the code model to one of
25694 @table @samp
25695 @item medlow
25696 The Medium/Low code model: 64-bit addresses, programs
25697 must be linked in the low 32 bits of memory.  Programs can be statically
25698 or dynamically linked.
25700 @item medmid
25701 The Medium/Middle code model: 64-bit addresses, programs
25702 must be linked in the low 44 bits of memory, the text and data segments must
25703 be less than 2GB in size and the data segment must be located within 2GB of
25704 the text segment.
25706 @item medany
25707 The Medium/Anywhere code model: 64-bit addresses, programs
25708 may be linked anywhere in memory, the text and data segments must be less
25709 than 2GB in size and the data segment must be located within 2GB of the
25710 text segment.
25712 @item embmedany
25713 The Medium/Anywhere code model for embedded systems:
25714 64-bit addresses, the text and data segments must be less than 2GB in
25715 size, both starting anywhere in memory (determined at link time).  The
25716 global register %g4 points to the base of the data segment.  Programs
25717 are statically linked and PIC is not supported.
25718 @end table
25720 @item -mmemory-model=@var{mem-model}
25721 @opindex mmemory-model
25722 Set the memory model in force on the processor to one of
25724 @table @samp
25725 @item default
25726 The default memory model for the processor and operating system.
25728 @item rmo
25729 Relaxed Memory Order
25731 @item pso
25732 Partial Store Order
25734 @item tso
25735 Total Store Order
25737 @item sc
25738 Sequential Consistency
25739 @end table
25741 These memory models are formally defined in Appendix D of the SPARC-V9
25742 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25744 @item -mstack-bias
25745 @itemx -mno-stack-bias
25746 @opindex mstack-bias
25747 @opindex mno-stack-bias
25748 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25749 frame pointer if present, are offset by @minus{}2047 which must be added back
25750 when making stack frame references.  This is the default in 64-bit mode.
25751 Otherwise, assume no such offset is present.
25752 @end table
25754 @node SPU Options
25755 @subsection SPU Options
25756 @cindex SPU options
25758 These @samp{-m} options are supported on the SPU:
25760 @table @gcctabopt
25761 @item -mwarn-reloc
25762 @itemx -merror-reloc
25763 @opindex mwarn-reloc
25764 @opindex merror-reloc
25766 The loader for SPU does not handle dynamic relocations.  By default, GCC
25767 gives an error when it generates code that requires a dynamic
25768 relocation.  @option{-mno-error-reloc} disables the error,
25769 @option{-mwarn-reloc} generates a warning instead.
25771 @item -msafe-dma
25772 @itemx -munsafe-dma
25773 @opindex msafe-dma
25774 @opindex munsafe-dma
25776 Instructions that initiate or test completion of DMA must not be
25777 reordered with respect to loads and stores of the memory that is being
25778 accessed.
25779 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25780 memory accesses, but that can lead to inefficient code in places where the
25781 memory is known to not change.  Rather than mark the memory as volatile,
25782 you can use @option{-msafe-dma} to tell the compiler to treat
25783 the DMA instructions as potentially affecting all memory.  
25785 @item -mbranch-hints
25786 @opindex mbranch-hints
25788 By default, GCC generates a branch hint instruction to avoid
25789 pipeline stalls for always-taken or probably-taken branches.  A hint
25790 is not generated closer than 8 instructions away from its branch.
25791 There is little reason to disable them, except for debugging purposes,
25792 or to make an object a little bit smaller.
25794 @item -msmall-mem
25795 @itemx -mlarge-mem
25796 @opindex msmall-mem
25797 @opindex mlarge-mem
25799 By default, GCC generates code assuming that addresses are never larger
25800 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25801 a full 32-bit address.
25803 @item -mstdmain
25804 @opindex mstdmain
25806 By default, GCC links against startup code that assumes the SPU-style
25807 main function interface (which has an unconventional parameter list).
25808 With @option{-mstdmain}, GCC links your program against startup
25809 code that assumes a C99-style interface to @code{main}, including a
25810 local copy of @code{argv} strings.
25812 @item -mfixed-range=@var{register-range}
25813 @opindex mfixed-range
25814 Generate code treating the given register range as fixed registers.
25815 A fixed register is one that the register allocator cannot use.  This is
25816 useful when compiling kernel code.  A register range is specified as
25817 two registers separated by a dash.  Multiple register ranges can be
25818 specified separated by a comma.
25820 @item -mea32
25821 @itemx -mea64
25822 @opindex mea32
25823 @opindex mea64
25824 Compile code assuming that pointers to the PPU address space accessed
25825 via the @code{__ea} named address space qualifier are either 32 or 64
25826 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25827 all object code in an executable must be compiled with the same setting.
25829 @item -maddress-space-conversion
25830 @itemx -mno-address-space-conversion
25831 @opindex maddress-space-conversion
25832 @opindex mno-address-space-conversion
25833 Allow/disallow treating the @code{__ea} address space as superset
25834 of the generic address space.  This enables explicit type casts
25835 between @code{__ea} and generic pointer as well as implicit
25836 conversions of generic pointers to @code{__ea} pointers.  The
25837 default is to allow address space pointer conversions.
25839 @item -mcache-size=@var{cache-size}
25840 @opindex mcache-size
25841 This option controls the version of libgcc that the compiler links to an
25842 executable and selects a software-managed cache for accessing variables
25843 in the @code{__ea} address space with a particular cache size.  Possible
25844 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25845 and @samp{128}.  The default cache size is 64KB.
25847 @item -matomic-updates
25848 @itemx -mno-atomic-updates
25849 @opindex matomic-updates
25850 @opindex mno-atomic-updates
25851 This option controls the version of libgcc that the compiler links to an
25852 executable and selects whether atomic updates to the software-managed
25853 cache of PPU-side variables are used.  If you use atomic updates, changes
25854 to a PPU variable from SPU code using the @code{__ea} named address space
25855 qualifier do not interfere with changes to other PPU variables residing
25856 in the same cache line from PPU code.  If you do not use atomic updates,
25857 such interference may occur; however, writing back cache lines is
25858 more efficient.  The default behavior is to use atomic updates.
25860 @item -mdual-nops
25861 @itemx -mdual-nops=@var{n}
25862 @opindex mdual-nops
25863 By default, GCC inserts NOPs to increase dual issue when it expects
25864 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25865 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25866 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25868 @item -mhint-max-nops=@var{n}
25869 @opindex mhint-max-nops
25870 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25871 be at least 8 instructions away from the branch it is affecting.  GCC
25872 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25873 generate the branch hint.
25875 @item -mhint-max-distance=@var{n}
25876 @opindex mhint-max-distance
25877 The encoding of the branch hint instruction limits the hint to be within
25878 256 instructions of the branch it is affecting.  By default, GCC makes
25879 sure it is within 125.
25881 @item -msafe-hints
25882 @opindex msafe-hints
25883 Work around a hardware bug that causes the SPU to stall indefinitely.
25884 By default, GCC inserts the @code{hbrp} instruction to make sure
25885 this stall won't happen.
25887 @end table
25889 @node System V Options
25890 @subsection Options for System V
25892 These additional options are available on System V Release 4 for
25893 compatibility with other compilers on those systems:
25895 @table @gcctabopt
25896 @item -G
25897 @opindex G
25898 Create a shared object.
25899 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25901 @item -Qy
25902 @opindex Qy
25903 Identify the versions of each tool used by the compiler, in a
25904 @code{.ident} assembler directive in the output.
25906 @item -Qn
25907 @opindex Qn
25908 Refrain from adding @code{.ident} directives to the output file (this is
25909 the default).
25911 @item -YP,@var{dirs}
25912 @opindex YP
25913 Search the directories @var{dirs}, and no others, for libraries
25914 specified with @option{-l}.
25916 @item -Ym,@var{dir}
25917 @opindex Ym
25918 Look in the directory @var{dir} to find the M4 preprocessor.
25919 The assembler uses this option.
25920 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25921 @c the generic assembler that comes with Solaris takes just -Ym.
25922 @end table
25924 @node TILE-Gx Options
25925 @subsection TILE-Gx Options
25926 @cindex TILE-Gx options
25928 These @samp{-m} options are supported on the TILE-Gx:
25930 @table @gcctabopt
25931 @item -mcmodel=small
25932 @opindex mcmodel=small
25933 Generate code for the small model.  The distance for direct calls is
25934 limited to 500M in either direction.  PC-relative addresses are 32
25935 bits.  Absolute addresses support the full address range.
25937 @item -mcmodel=large
25938 @opindex mcmodel=large
25939 Generate code for the large model.  There is no limitation on call
25940 distance, pc-relative addresses, or absolute addresses.
25942 @item -mcpu=@var{name}
25943 @opindex mcpu
25944 Selects the type of CPU to be targeted.  Currently the only supported
25945 type is @samp{tilegx}.
25947 @item -m32
25948 @itemx -m64
25949 @opindex m32
25950 @opindex m64
25951 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25952 environment sets int, long, and pointer to 32 bits.  The 64-bit
25953 environment sets int to 32 bits and long and pointer to 64 bits.
25955 @item -mbig-endian
25956 @itemx -mlittle-endian
25957 @opindex mbig-endian
25958 @opindex mlittle-endian
25959 Generate code in big/little endian mode, respectively.
25960 @end table
25962 @node TILEPro Options
25963 @subsection TILEPro Options
25964 @cindex TILEPro options
25966 These @samp{-m} options are supported on the TILEPro:
25968 @table @gcctabopt
25969 @item -mcpu=@var{name}
25970 @opindex mcpu
25971 Selects the type of CPU to be targeted.  Currently the only supported
25972 type is @samp{tilepro}.
25974 @item -m32
25975 @opindex m32
25976 Generate code for a 32-bit environment, which sets int, long, and
25977 pointer to 32 bits.  This is the only supported behavior so the flag
25978 is essentially ignored.
25979 @end table
25981 @node V850 Options
25982 @subsection V850 Options
25983 @cindex V850 Options
25985 These @samp{-m} options are defined for V850 implementations:
25987 @table @gcctabopt
25988 @item -mlong-calls
25989 @itemx -mno-long-calls
25990 @opindex mlong-calls
25991 @opindex mno-long-calls
25992 Treat all calls as being far away (near).  If calls are assumed to be
25993 far away, the compiler always loads the function's address into a
25994 register, and calls indirect through the pointer.
25996 @item -mno-ep
25997 @itemx -mep
25998 @opindex mno-ep
25999 @opindex mep
26000 Do not optimize (do optimize) basic blocks that use the same index
26001 pointer 4 or more times to copy pointer into the @code{ep} register, and
26002 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26003 option is on by default if you optimize.
26005 @item -mno-prolog-function
26006 @itemx -mprolog-function
26007 @opindex mno-prolog-function
26008 @opindex mprolog-function
26009 Do not use (do use) external functions to save and restore registers
26010 at the prologue and epilogue of a function.  The external functions
26011 are slower, but use less code space if more than one function saves
26012 the same number of registers.  The @option{-mprolog-function} option
26013 is on by default if you optimize.
26015 @item -mspace
26016 @opindex mspace
26017 Try to make the code as small as possible.  At present, this just turns
26018 on the @option{-mep} and @option{-mprolog-function} options.
26020 @item -mtda=@var{n}
26021 @opindex mtda
26022 Put static or global variables whose size is @var{n} bytes or less into
26023 the tiny data area that register @code{ep} points to.  The tiny data
26024 area can hold up to 256 bytes in total (128 bytes for byte references).
26026 @item -msda=@var{n}
26027 @opindex msda
26028 Put static or global variables whose size is @var{n} bytes or less into
26029 the small data area that register @code{gp} points to.  The small data
26030 area can hold up to 64 kilobytes.
26032 @item -mzda=@var{n}
26033 @opindex mzda
26034 Put static or global variables whose size is @var{n} bytes or less into
26035 the first 32 kilobytes of memory.
26037 @item -mv850
26038 @opindex mv850
26039 Specify that the target processor is the V850.
26041 @item -mv850e3v5
26042 @opindex mv850e3v5
26043 Specify that the target processor is the V850E3V5.  The preprocessor
26044 constant @code{__v850e3v5__} is defined if this option is used.
26046 @item -mv850e2v4
26047 @opindex mv850e2v4
26048 Specify that the target processor is the V850E3V5.  This is an alias for
26049 the @option{-mv850e3v5} option.
26051 @item -mv850e2v3
26052 @opindex mv850e2v3
26053 Specify that the target processor is the V850E2V3.  The preprocessor
26054 constant @code{__v850e2v3__} is defined if this option is used.
26056 @item -mv850e2
26057 @opindex mv850e2
26058 Specify that the target processor is the V850E2.  The preprocessor
26059 constant @code{__v850e2__} is defined if this option is used.
26061 @item -mv850e1
26062 @opindex mv850e1
26063 Specify that the target processor is the V850E1.  The preprocessor
26064 constants @code{__v850e1__} and @code{__v850e__} are defined if
26065 this option is used.
26067 @item -mv850es
26068 @opindex mv850es
26069 Specify that the target processor is the V850ES.  This is an alias for
26070 the @option{-mv850e1} option.
26072 @item -mv850e
26073 @opindex mv850e
26074 Specify that the target processor is the V850E@.  The preprocessor
26075 constant @code{__v850e__} is defined if this option is used.
26077 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26078 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26079 are defined then a default target processor is chosen and the
26080 relevant @samp{__v850*__} preprocessor constant is defined.
26082 The preprocessor constants @code{__v850} and @code{__v851__} are always
26083 defined, regardless of which processor variant is the target.
26085 @item -mdisable-callt
26086 @itemx -mno-disable-callt
26087 @opindex mdisable-callt
26088 @opindex mno-disable-callt
26089 This option suppresses generation of the @code{CALLT} instruction for the
26090 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26091 architecture.
26093 This option is enabled by default when the RH850 ABI is
26094 in use (see @option{-mrh850-abi}), and disabled by default when the
26095 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26096 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26098 @item -mrelax
26099 @itemx -mno-relax
26100 @opindex mrelax
26101 @opindex mno-relax
26102 Pass on (or do not pass on) the @option{-mrelax} command-line option
26103 to the assembler.
26105 @item -mlong-jumps
26106 @itemx -mno-long-jumps
26107 @opindex mlong-jumps
26108 @opindex mno-long-jumps
26109 Disable (or re-enable) the generation of PC-relative jump instructions.
26111 @item -msoft-float
26112 @itemx -mhard-float
26113 @opindex msoft-float
26114 @opindex mhard-float
26115 Disable (or re-enable) the generation of hardware floating point
26116 instructions.  This option is only significant when the target
26117 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26118 instructions are being generated then the C preprocessor symbol
26119 @code{__FPU_OK__} is defined, otherwise the symbol
26120 @code{__NO_FPU__} is defined.
26122 @item -mloop
26123 @opindex mloop
26124 Enables the use of the e3v5 LOOP instruction.  The use of this
26125 instruction is not enabled by default when the e3v5 architecture is
26126 selected because its use is still experimental.
26128 @item -mrh850-abi
26129 @itemx -mghs
26130 @opindex mrh850-abi
26131 @opindex mghs
26132 Enables support for the RH850 version of the V850 ABI.  This is the
26133 default.  With this version of the ABI the following rules apply:
26135 @itemize
26136 @item
26137 Integer sized structures and unions are returned via a memory pointer
26138 rather than a register.
26140 @item
26141 Large structures and unions (more than 8 bytes in size) are passed by
26142 value.
26144 @item
26145 Functions are aligned to 16-bit boundaries.
26147 @item
26148 The @option{-m8byte-align} command-line option is supported.
26150 @item
26151 The @option{-mdisable-callt} command-line option is enabled by
26152 default.  The @option{-mno-disable-callt} command-line option is not
26153 supported.
26154 @end itemize
26156 When this version of the ABI is enabled the C preprocessor symbol
26157 @code{__V850_RH850_ABI__} is defined.
26159 @item -mgcc-abi
26160 @opindex mgcc-abi
26161 Enables support for the old GCC version of the V850 ABI.  With this
26162 version of the ABI the following rules apply:
26164 @itemize
26165 @item
26166 Integer sized structures and unions are returned in register @code{r10}.
26168 @item
26169 Large structures and unions (more than 8 bytes in size) are passed by
26170 reference.
26172 @item
26173 Functions are aligned to 32-bit boundaries, unless optimizing for
26174 size.
26176 @item
26177 The @option{-m8byte-align} command-line option is not supported.
26179 @item
26180 The @option{-mdisable-callt} command-line option is supported but not
26181 enabled by default.
26182 @end itemize
26184 When this version of the ABI is enabled the C preprocessor symbol
26185 @code{__V850_GCC_ABI__} is defined.
26187 @item -m8byte-align
26188 @itemx -mno-8byte-align
26189 @opindex m8byte-align
26190 @opindex mno-8byte-align
26191 Enables support for @code{double} and @code{long long} types to be
26192 aligned on 8-byte boundaries.  The default is to restrict the
26193 alignment of all objects to at most 4-bytes.  When
26194 @option{-m8byte-align} is in effect the C preprocessor symbol
26195 @code{__V850_8BYTE_ALIGN__} is defined.
26197 @item -mbig-switch
26198 @opindex mbig-switch
26199 Generate code suitable for big switch tables.  Use this option only if
26200 the assembler/linker complain about out of range branches within a switch
26201 table.
26203 @item -mapp-regs
26204 @opindex mapp-regs
26205 This option causes r2 and r5 to be used in the code generated by
26206 the compiler.  This setting is the default.
26208 @item -mno-app-regs
26209 @opindex mno-app-regs
26210 This option causes r2 and r5 to be treated as fixed registers.
26212 @end table
26214 @node VAX Options
26215 @subsection VAX Options
26216 @cindex VAX options
26218 These @samp{-m} options are defined for the VAX:
26220 @table @gcctabopt
26221 @item -munix
26222 @opindex munix
26223 Do not output certain jump instructions (@code{aobleq} and so on)
26224 that the Unix assembler for the VAX cannot handle across long
26225 ranges.
26227 @item -mgnu
26228 @opindex mgnu
26229 Do output those jump instructions, on the assumption that the
26230 GNU assembler is being used.
26232 @item -mg
26233 @opindex mg
26234 Output code for G-format floating-point numbers instead of D-format.
26235 @end table
26237 @node Visium Options
26238 @subsection Visium Options
26239 @cindex Visium options
26241 @table @gcctabopt
26243 @item -mdebug
26244 @opindex mdebug
26245 A program which performs file I/O and is destined to run on an MCM target
26246 should be linked with this option.  It causes the libraries libc.a and
26247 libdebug.a to be linked.  The program should be run on the target under
26248 the control of the GDB remote debugging stub.
26250 @item -msim
26251 @opindex msim
26252 A program which performs file I/O and is destined to run on the simulator
26253 should be linked with option.  This causes libraries libc.a and libsim.a to
26254 be linked.
26256 @item -mfpu
26257 @itemx -mhard-float
26258 @opindex mfpu
26259 @opindex mhard-float
26260 Generate code containing floating-point instructions.  This is the
26261 default.
26263 @item -mno-fpu
26264 @itemx -msoft-float
26265 @opindex mno-fpu
26266 @opindex msoft-float
26267 Generate code containing library calls for floating-point.
26269 @option{-msoft-float} changes the calling convention in the output file;
26270 therefore, it is only useful if you compile @emph{all} of a program with
26271 this option.  In particular, you need to compile @file{libgcc.a}, the
26272 library that comes with GCC, with @option{-msoft-float} in order for
26273 this to work.
26275 @item -mcpu=@var{cpu_type}
26276 @opindex mcpu
26277 Set the instruction set, register set, and instruction scheduling parameters
26278 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26279 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26281 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26283 By default (unless configured otherwise), GCC generates code for the GR5
26284 variant of the Visium architecture.  
26286 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26287 architecture.  The only difference from GR5 code is that the compiler will
26288 generate block move instructions.
26290 @item -mtune=@var{cpu_type}
26291 @opindex mtune
26292 Set the instruction scheduling parameters for machine type @var{cpu_type},
26293 but do not set the instruction set or register set that the option
26294 @option{-mcpu=@var{cpu_type}} would.
26296 @item -msv-mode
26297 @opindex msv-mode
26298 Generate code for the supervisor mode, where there are no restrictions on
26299 the access to general registers.  This is the default.
26301 @item -muser-mode
26302 @opindex muser-mode
26303 Generate code for the user mode, where the access to some general registers
26304 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26305 mode; on the GR6, only registers r29 to r31 are affected.
26306 @end table
26308 @node VMS Options
26309 @subsection VMS Options
26311 These @samp{-m} options are defined for the VMS implementations:
26313 @table @gcctabopt
26314 @item -mvms-return-codes
26315 @opindex mvms-return-codes
26316 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26317 condition (e.g.@ error) codes.
26319 @item -mdebug-main=@var{prefix}
26320 @opindex mdebug-main=@var{prefix}
26321 Flag the first routine whose name starts with @var{prefix} as the main
26322 routine for the debugger.
26324 @item -mmalloc64
26325 @opindex mmalloc64
26326 Default to 64-bit memory allocation routines.
26328 @item -mpointer-size=@var{size}
26329 @opindex mpointer-size=@var{size}
26330 Set the default size of pointers. Possible options for @var{size} are
26331 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26332 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26333 The later option disables @code{pragma pointer_size}.
26334 @end table
26336 @node VxWorks Options
26337 @subsection VxWorks Options
26338 @cindex VxWorks Options
26340 The options in this section are defined for all VxWorks targets.
26341 Options specific to the target hardware are listed with the other
26342 options for that target.
26344 @table @gcctabopt
26345 @item -mrtp
26346 @opindex mrtp
26347 GCC can generate code for both VxWorks kernels and real time processes
26348 (RTPs).  This option switches from the former to the latter.  It also
26349 defines the preprocessor macro @code{__RTP__}.
26351 @item -non-static
26352 @opindex non-static
26353 Link an RTP executable against shared libraries rather than static
26354 libraries.  The options @option{-static} and @option{-shared} can
26355 also be used for RTPs (@pxref{Link Options}); @option{-static}
26356 is the default.
26358 @item -Bstatic
26359 @itemx -Bdynamic
26360 @opindex Bstatic
26361 @opindex Bdynamic
26362 These options are passed down to the linker.  They are defined for
26363 compatibility with Diab.
26365 @item -Xbind-lazy
26366 @opindex Xbind-lazy
26367 Enable lazy binding of function calls.  This option is equivalent to
26368 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26370 @item -Xbind-now
26371 @opindex Xbind-now
26372 Disable lazy binding of function calls.  This option is the default and
26373 is defined for compatibility with Diab.
26374 @end table
26376 @node x86 Options
26377 @subsection x86 Options
26378 @cindex x86 Options
26380 These @samp{-m} options are defined for the x86 family of computers.
26382 @table @gcctabopt
26384 @item -march=@var{cpu-type}
26385 @opindex march
26386 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26387 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26388 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26389 to generate code that may not run at all on processors other than the one
26390 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26391 @option{-mtune=@var{cpu-type}}.
26393 The choices for @var{cpu-type} are:
26395 @table @samp
26396 @item native
26397 This selects the CPU to generate code for at compilation time by determining
26398 the processor type of the compiling machine.  Using @option{-march=native}
26399 enables all instruction subsets supported by the local machine (hence
26400 the result might not run on different machines).  Using @option{-mtune=native}
26401 produces code optimized for the local machine under the constraints
26402 of the selected instruction set.  
26404 @item x86-64
26405 A generic CPU with 64-bit extensions.
26407 @item i386
26408 Original Intel i386 CPU@.
26410 @item i486
26411 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26413 @item i586
26414 @itemx pentium
26415 Intel Pentium CPU with no MMX support.
26417 @item lakemont
26418 Intel Lakemont MCU, based on Intel Pentium CPU.
26420 @item pentium-mmx
26421 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26423 @item pentiumpro
26424 Intel Pentium Pro CPU@.
26426 @item i686
26427 When used with @option{-march}, the Pentium Pro
26428 instruction set is used, so the code runs on all i686 family chips.
26429 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26431 @item pentium2
26432 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26433 support.
26435 @item pentium3
26436 @itemx pentium3m
26437 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26438 set support.
26440 @item pentium-m
26441 Intel Pentium M; low-power version of Intel Pentium III CPU
26442 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26444 @item pentium4
26445 @itemx pentium4m
26446 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26448 @item prescott
26449 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26450 set support.
26452 @item nocona
26453 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26454 SSE2 and SSE3 instruction set support.
26456 @item core2
26457 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26458 instruction set support.
26460 @item nehalem
26461 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26462 SSE4.1, SSE4.2 and POPCNT instruction set support.
26464 @item westmere
26465 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26466 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26468 @item sandybridge
26469 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26470 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26472 @item ivybridge
26473 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26474 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26475 instruction set support.
26477 @item haswell
26478 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26479 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26480 BMI, BMI2 and F16C instruction set support.
26482 @item broadwell
26483 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26484 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26485 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26487 @item skylake
26488 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26489 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26490 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26491 XSAVES instruction set support.
26493 @item bonnell
26494 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26495 instruction set support.
26497 @item silvermont
26498 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26499 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26501 @item goldmont
26502 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26503 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
26504 instruction set support.
26506 @item knl
26507 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26508 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26509 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26510 AVX512CD instruction set support.
26512 @item knm
26513 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26514 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26515 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26516 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26518 @item skylake-avx512
26519 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26520 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26521 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26522 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26524 @item cannonlake
26525 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26526 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26527 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26528 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26529 AVX512IFMA, SHA and UMIP instruction set support.
26531 @item icelake-client
26532 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26533 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26534 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26535 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26536 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26537 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26539 @item icelake-server
26540 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26541 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26542 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26543 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26544 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26545 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26546 set support.
26548 @item k6
26549 AMD K6 CPU with MMX instruction set support.
26551 @item k6-2
26552 @itemx k6-3
26553 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26555 @item athlon
26556 @itemx athlon-tbird
26557 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26558 support.
26560 @item athlon-4
26561 @itemx athlon-xp
26562 @itemx athlon-mp
26563 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26564 instruction set support.
26566 @item k8
26567 @itemx opteron
26568 @itemx athlon64
26569 @itemx athlon-fx
26570 Processors based on the AMD K8 core with x86-64 instruction set support,
26571 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26572 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26573 instruction set extensions.)
26575 @item k8-sse3
26576 @itemx opteron-sse3
26577 @itemx athlon64-sse3
26578 Improved versions of AMD K8 cores with SSE3 instruction set support.
26580 @item amdfam10
26581 @itemx barcelona
26582 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26583 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26584 instruction set extensions.)
26586 @item bdver1
26587 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26588 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26589 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26590 @item bdver2
26591 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26592 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26593 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26594 extensions.)
26595 @item bdver3
26596 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26597 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26598 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26599 64-bit instruction set extensions.
26600 @item bdver4
26601 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26602 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26603 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26604 SSE4.2, ABM and 64-bit instruction set extensions.
26606 @item znver1
26607 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26608 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26609 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26610 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26611 instruction set extensions.
26613 @item btver1
26614 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26615 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26616 instruction set extensions.)
26618 @item btver2
26619 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26620 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26621 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26623 @item winchip-c6
26624 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26625 set support.
26627 @item winchip2
26628 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26629 instruction set support.
26631 @item c3
26632 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26633 (No scheduling is implemented for this chip.)
26635 @item c3-2
26636 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26637 (No scheduling is implemented for this chip.)
26639 @item c7
26640 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26641 (No scheduling is implemented for this chip.)
26643 @item samuel-2
26644 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26645 (No scheduling is implemented for this chip.)
26647 @item nehemiah
26648 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26649 (No scheduling is implemented for this chip.)
26651 @item esther
26652 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26653 (No scheduling is implemented for this chip.)
26655 @item eden-x2
26656 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26657 (No scheduling is implemented for this chip.)
26659 @item eden-x4
26660 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26661 AVX and AVX2 instruction set support.
26662 (No scheduling is implemented for this chip.)
26664 @item nano
26665 Generic VIA Nano 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-1000
26670 VIA Nano 1xxx 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-2000
26675 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26676 instruction set support.
26677 (No scheduling is implemented for this chip.)
26679 @item nano-3000
26680 VIA Nano 3xxx 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-x2
26685 VIA Nano Dual 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 nano-x4
26690 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26691 instruction set support.
26692 (No scheduling is implemented for this chip.)
26694 @item geode
26695 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26696 @end table
26698 @item -mtune=@var{cpu-type}
26699 @opindex mtune
26700 Tune to @var{cpu-type} everything applicable about the generated code, except
26701 for the ABI and the set of available instructions.  
26702 While picking a specific @var{cpu-type} schedules things appropriately
26703 for that particular chip, the compiler does not generate any code that
26704 cannot run on the default machine type unless you use a
26705 @option{-march=@var{cpu-type}} option.
26706 For example, if GCC is configured for i686-pc-linux-gnu
26707 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26708 but still runs on i686 machines.
26710 The choices for @var{cpu-type} are the same as for @option{-march}.
26711 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26713 @table @samp
26714 @item generic
26715 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26716 If you know the CPU on which your code will run, then you should use
26717 the corresponding @option{-mtune} or @option{-march} option instead of
26718 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26719 of your application will have, then you should use this option.
26721 As new processors are deployed in the marketplace, the behavior of this
26722 option will change.  Therefore, if you upgrade to a newer version of
26723 GCC, code generation controlled by this option will change to reflect
26724 the processors
26725 that are most common at the time that version of GCC is released.
26727 There is no @option{-march=generic} option because @option{-march}
26728 indicates the instruction set the compiler can use, and there is no
26729 generic instruction set applicable to all processors.  In contrast,
26730 @option{-mtune} indicates the processor (or, in this case, collection of
26731 processors) for which the code is optimized.
26733 @item intel
26734 Produce code optimized for the most current Intel processors, which are
26735 Haswell and Silvermont for this version of GCC.  If you know the CPU
26736 on which your code will run, then you should use the corresponding
26737 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26738 But, if you want your application performs better on both Haswell and
26739 Silvermont, then you should use this option.
26741 As new Intel processors are deployed in the marketplace, the behavior of
26742 this option will change.  Therefore, if you upgrade to a newer version of
26743 GCC, code generation controlled by this option will change to reflect
26744 the most current Intel processors at the time that version of GCC is
26745 released.
26747 There is no @option{-march=intel} option because @option{-march} indicates
26748 the instruction set the compiler can use, and there is no common
26749 instruction set applicable to all processors.  In contrast,
26750 @option{-mtune} indicates the processor (or, in this case, collection of
26751 processors) for which the code is optimized.
26752 @end table
26754 @item -mcpu=@var{cpu-type}
26755 @opindex mcpu
26756 A deprecated synonym for @option{-mtune}.
26758 @item -mfpmath=@var{unit}
26759 @opindex mfpmath
26760 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26761 for @var{unit} are:
26763 @table @samp
26764 @item 387
26765 Use the standard 387 floating-point coprocessor present on the majority of chips and
26766 emulated otherwise.  Code compiled with this option runs almost everywhere.
26767 The temporary results are computed in 80-bit precision instead of the precision
26768 specified by the type, resulting in slightly different results compared to most
26769 of other chips.  See @option{-ffloat-store} for more detailed description.
26771 This is the default choice for non-Darwin x86-32 targets.
26773 @item sse
26774 Use scalar floating-point instructions present in the SSE instruction set.
26775 This instruction set is supported by Pentium III and newer chips,
26776 and in the AMD line
26777 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26778 instruction set supports only single-precision arithmetic, thus the double and
26779 extended-precision arithmetic are still done using 387.  A later version, present
26780 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26781 arithmetic too.
26783 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26784 or @option{-msse2} switches to enable SSE extensions and make this option
26785 effective.  For the x86-64 compiler, these extensions are enabled by default.
26787 The resulting code should be considerably faster in the majority of cases and avoid
26788 the numerical instability problems of 387 code, but may break some existing
26789 code that expects temporaries to be 80 bits.
26791 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26792 and the default choice for x86-32 targets with the SSE2 instruction set
26793 when @option{-ffast-math} is enabled.
26795 @item sse,387
26796 @itemx sse+387
26797 @itemx both
26798 Attempt to utilize both instruction sets at once.  This effectively doubles the
26799 amount of available registers, and on chips with separate execution units for
26800 387 and SSE the execution resources too.  Use this option with care, as it is
26801 still experimental, because the GCC register allocator does not model separate
26802 functional units well, resulting in unstable performance.
26803 @end table
26805 @item -masm=@var{dialect}
26806 @opindex masm=@var{dialect}
26807 Output assembly instructions using selected @var{dialect}.  Also affects
26808 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26809 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26810 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26811 not support @samp{intel}.
26813 @item -mieee-fp
26814 @itemx -mno-ieee-fp
26815 @opindex mieee-fp
26816 @opindex mno-ieee-fp
26817 Control whether or not the compiler uses IEEE floating-point
26818 comparisons.  These correctly handle the case where the result of a
26819 comparison is unordered.
26821 @item -m80387
26822 @itemx -mhard-float
26823 @opindex 80387
26824 @opindex mhard-float
26825 Generate output containing 80387 instructions for floating point.
26827 @item -mno-80387
26828 @itemx -msoft-float
26829 @opindex no-80387
26830 @opindex msoft-float
26831 Generate output containing library calls for floating point.
26833 @strong{Warning:} the requisite libraries are not part of GCC@.
26834 Normally the facilities of the machine's usual C compiler are used, but
26835 this cannot be done directly in cross-compilation.  You must make your
26836 own arrangements to provide suitable library functions for
26837 cross-compilation.
26839 On machines where a function returns floating-point results in the 80387
26840 register stack, some floating-point opcodes may be emitted even if
26841 @option{-msoft-float} is used.
26843 @item -mno-fp-ret-in-387
26844 @opindex mno-fp-ret-in-387
26845 Do not use the FPU registers for return values of functions.
26847 The usual calling convention has functions return values of types
26848 @code{float} and @code{double} in an FPU register, even if there
26849 is no FPU@.  The idea is that the operating system should emulate
26850 an FPU@.
26852 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26853 in ordinary CPU registers instead.
26855 @item -mno-fancy-math-387
26856 @opindex mno-fancy-math-387
26857 Some 387 emulators do not support the @code{sin}, @code{cos} and
26858 @code{sqrt} instructions for the 387.  Specify this option to avoid
26859 generating those instructions.  This option is the default on
26860 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26861 indicates that the target CPU always has an FPU and so the
26862 instruction does not need emulation.  These
26863 instructions are not generated unless you also use the
26864 @option{-funsafe-math-optimizations} switch.
26866 @item -malign-double
26867 @itemx -mno-align-double
26868 @opindex malign-double
26869 @opindex mno-align-double
26870 Control whether GCC aligns @code{double}, @code{long double}, and
26871 @code{long long} variables on a two-word boundary or a one-word
26872 boundary.  Aligning @code{double} variables on a two-word boundary
26873 produces code that runs somewhat faster on a Pentium at the
26874 expense of more memory.
26876 On x86-64, @option{-malign-double} is enabled by default.
26878 @strong{Warning:} if you use the @option{-malign-double} switch,
26879 structures containing the above types are aligned differently than
26880 the published application binary interface specifications for the x86-32
26881 and are not binary compatible with structures in code compiled
26882 without that switch.
26884 @item -m96bit-long-double
26885 @itemx -m128bit-long-double
26886 @opindex m96bit-long-double
26887 @opindex m128bit-long-double
26888 These switches control the size of @code{long double} type.  The x86-32
26889 application binary interface specifies the size to be 96 bits,
26890 so @option{-m96bit-long-double} is the default in 32-bit mode.
26892 Modern architectures (Pentium and newer) prefer @code{long double}
26893 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26894 conforming to the ABI, this is not possible.  So specifying
26895 @option{-m128bit-long-double} aligns @code{long double}
26896 to a 16-byte boundary by padding the @code{long double} with an additional
26897 32-bit zero.
26899 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26900 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26902 Notice that neither of these options enable any extra precision over the x87
26903 standard of 80 bits for a @code{long double}.
26905 @strong{Warning:} if you override the default value for your target ABI, this
26906 changes the size of 
26907 structures and arrays containing @code{long double} variables,
26908 as well as modifying the function calling convention for functions taking
26909 @code{long double}.  Hence they are not binary-compatible
26910 with code compiled without that switch.
26912 @item -mlong-double-64
26913 @itemx -mlong-double-80
26914 @itemx -mlong-double-128
26915 @opindex mlong-double-64
26916 @opindex mlong-double-80
26917 @opindex mlong-double-128
26918 These switches control the size of @code{long double} type. A size
26919 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26920 type. This is the default for 32-bit Bionic C library.  A size
26921 of 128 bits makes the @code{long double} type equivalent to the
26922 @code{__float128} type. This is the default for 64-bit Bionic C library.
26924 @strong{Warning:} if you override the default value for your target ABI, this
26925 changes the size of
26926 structures and arrays containing @code{long double} variables,
26927 as well as modifying the function calling convention for functions taking
26928 @code{long double}.  Hence they are not binary-compatible
26929 with code compiled without that switch.
26931 @item -malign-data=@var{type}
26932 @opindex malign-data
26933 Control how GCC aligns variables.  Supported values for @var{type} are
26934 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26935 and earlier, @samp{abi} uses alignment value as specified by the
26936 psABI, and @samp{cacheline} uses increased alignment value to match
26937 the cache line size.  @samp{compat} is the default.
26939 @item -mlarge-data-threshold=@var{threshold}
26940 @opindex mlarge-data-threshold
26941 When @option{-mcmodel=medium} is specified, data objects larger than
26942 @var{threshold} are placed in the large data section.  This value must be the
26943 same across all objects linked into the binary, and defaults to 65535.
26945 @item -mrtd
26946 @opindex mrtd
26947 Use a different function-calling convention, in which functions that
26948 take a fixed number of arguments return with the @code{ret @var{num}}
26949 instruction, which pops their arguments while returning.  This saves one
26950 instruction in the caller since there is no need to pop the arguments
26951 there.
26953 You can specify that an individual function is called with this calling
26954 sequence with the function attribute @code{stdcall}.  You can also
26955 override the @option{-mrtd} option by using the function attribute
26956 @code{cdecl}.  @xref{Function Attributes}.
26958 @strong{Warning:} this calling convention is incompatible with the one
26959 normally used on Unix, so you cannot use it if you need to call
26960 libraries compiled with the Unix compiler.
26962 Also, you must provide function prototypes for all functions that
26963 take variable numbers of arguments (including @code{printf});
26964 otherwise incorrect code is generated for calls to those
26965 functions.
26967 In addition, seriously incorrect code results if you call a
26968 function with too many arguments.  (Normally, extra arguments are
26969 harmlessly ignored.)
26971 @item -mregparm=@var{num}
26972 @opindex mregparm
26973 Control how many registers are used to pass integer arguments.  By
26974 default, no registers are used to pass arguments, and at most 3
26975 registers can be used.  You can control this behavior for a specific
26976 function by using the function attribute @code{regparm}.
26977 @xref{Function Attributes}.
26979 @strong{Warning:} if you use this switch, and
26980 @var{num} is nonzero, then you must build all modules with the same
26981 value, including any libraries.  This includes the system libraries and
26982 startup modules.
26984 @item -msseregparm
26985 @opindex msseregparm
26986 Use SSE register passing conventions for float and double arguments
26987 and return values.  You can control this behavior for a specific
26988 function by using the function attribute @code{sseregparm}.
26989 @xref{Function Attributes}.
26991 @strong{Warning:} if you use this switch then you must build all
26992 modules with the same value, including any libraries.  This includes
26993 the system libraries and startup modules.
26995 @item -mvect8-ret-in-mem
26996 @opindex mvect8-ret-in-mem
26997 Return 8-byte vectors in memory instead of MMX registers.  This is the
26998 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
26999 Studio compilers until version 12.  Later compiler versions (starting
27000 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27001 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27002 you need to remain compatible with existing code produced by those
27003 previous compiler versions or older versions of GCC@.
27005 @item -mpc32
27006 @itemx -mpc64
27007 @itemx -mpc80
27008 @opindex mpc32
27009 @opindex mpc64
27010 @opindex mpc80
27012 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27013 is specified, the significands of results of floating-point operations are
27014 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27015 significands of results of floating-point operations to 53 bits (double
27016 precision) and @option{-mpc80} rounds the significands of results of
27017 floating-point operations to 64 bits (extended double precision), which is
27018 the default.  When this option is used, floating-point operations in higher
27019 precisions are not available to the programmer without setting the FPU
27020 control word explicitly.
27022 Setting the rounding of floating-point operations to less than the default
27023 80 bits can speed some programs by 2% or more.  Note that some mathematical
27024 libraries assume that extended-precision (80-bit) floating-point operations
27025 are enabled by default; routines in such libraries could suffer significant
27026 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27027 when this option is used to set the precision to less than extended precision.
27029 @item -mstackrealign
27030 @opindex mstackrealign
27031 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27032 option generates an alternate prologue and epilogue that realigns the
27033 run-time stack if necessary.  This supports mixing legacy codes that keep
27034 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27035 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27036 applicable to individual functions.
27038 @item -mpreferred-stack-boundary=@var{num}
27039 @opindex mpreferred-stack-boundary
27040 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27041 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27042 the default is 4 (16 bytes or 128 bits).
27044 @strong{Warning:} When generating code for the x86-64 architecture with
27045 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27046 used to keep the stack boundary aligned to 8 byte boundary.  Since
27047 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27048 intended to be used in controlled environment where stack space is
27049 important limitation.  This option leads to wrong code when functions
27050 compiled with 16 byte stack alignment (such as functions from a standard
27051 library) are called with misaligned stack.  In this case, SSE
27052 instructions may lead to misaligned memory access traps.  In addition,
27053 variable arguments are handled incorrectly for 16 byte aligned
27054 objects (including x87 long double and __int128), leading to wrong
27055 results.  You must build all modules with
27056 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27057 includes the system libraries and startup modules.
27059 @item -mincoming-stack-boundary=@var{num}
27060 @opindex mincoming-stack-boundary
27061 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27062 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27063 the one specified by @option{-mpreferred-stack-boundary} is used.
27065 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27066 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27067 suffer significant run time performance penalties.  On Pentium III, the
27068 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27069 properly if it is not 16-byte aligned.
27071 To ensure proper alignment of this values on the stack, the stack boundary
27072 must be as aligned as that required by any value stored on the stack.
27073 Further, every function must be generated such that it keeps the stack
27074 aligned.  Thus calling a function compiled with a higher preferred
27075 stack boundary from a function compiled with a lower preferred stack
27076 boundary most likely misaligns the stack.  It is recommended that
27077 libraries that use callbacks always use the default setting.
27079 This extra alignment does consume extra stack space, and generally
27080 increases code size.  Code that is sensitive to stack space usage, such
27081 as embedded systems and operating system kernels, may want to reduce the
27082 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27084 @need 200
27085 @item -mmmx
27086 @opindex mmmx
27087 @need 200
27088 @itemx -msse
27089 @opindex msse
27090 @need 200
27091 @itemx -msse2
27092 @opindex msse2
27093 @need 200
27094 @itemx -msse3
27095 @opindex msse3
27096 @need 200
27097 @itemx -mssse3
27098 @opindex mssse3
27099 @need 200
27100 @itemx -msse4
27101 @opindex msse4
27102 @need 200
27103 @itemx -msse4a
27104 @opindex msse4a
27105 @need 200
27106 @itemx -msse4.1
27107 @opindex msse4.1
27108 @need 200
27109 @itemx -msse4.2
27110 @opindex msse4.2
27111 @need 200
27112 @itemx -mavx
27113 @opindex mavx
27114 @need 200
27115 @itemx -mavx2
27116 @opindex mavx2
27117 @need 200
27118 @itemx -mavx512f
27119 @opindex mavx512f
27120 @need 200
27121 @itemx -mavx512pf
27122 @opindex mavx512pf
27123 @need 200
27124 @itemx -mavx512er
27125 @opindex mavx512er
27126 @need 200
27127 @itemx -mavx512cd
27128 @opindex mavx512cd
27129 @need 200
27130 @itemx -mavx512vl
27131 @opindex mavx512vl
27132 @need 200
27133 @itemx -mavx512bw
27134 @opindex mavx512bw
27135 @need 200
27136 @itemx -mavx512dq
27137 @opindex mavx512dq
27138 @need 200
27139 @itemx -mavx512ifma
27140 @opindex mavx512ifma
27141 @need 200
27142 @itemx -mavx512vbmi
27143 @opindex mavx512vbmi
27144 @need 200
27145 @itemx -msha
27146 @opindex msha
27147 @need 200
27148 @itemx -maes
27149 @opindex maes
27150 @need 200
27151 @itemx -mpclmul
27152 @opindex mpclmul
27153 @need 200
27154 @itemx -mclflushopt
27155 @opindex mclflushopt
27156 @need 200
27157 @itemx -mfsgsbase
27158 @opindex mfsgsbase
27159 @need 200
27160 @itemx -mrdrnd
27161 @opindex mrdrnd
27162 @need 200
27163 @itemx -mf16c
27164 @opindex mf16c
27165 @need 200
27166 @itemx -mfma
27167 @opindex mfma
27168 @need 200
27169 @itemx -mpconfig
27170 @opindex mpconfig
27171 @need 200
27172 @itemx -mwbnoinvd
27173 @opindex mwbnoinvd
27174 @need 200
27175 @itemx -mfma4
27176 @opindex mfma4
27177 @need 200
27178 @itemx -mprefetchwt1
27179 @opindex mprefetchwt1
27180 @need 200
27181 @itemx -mxop
27182 @opindex mxop
27183 @need 200
27184 @itemx -mlwp
27185 @opindex mlwp
27186 @need 200
27187 @itemx -m3dnow
27188 @opindex m3dnow
27189 @need 200
27190 @itemx -m3dnowa
27191 @opindex m3dnowa
27192 @need 200
27193 @itemx -mpopcnt
27194 @opindex mpopcnt
27195 @need 200
27196 @itemx -mabm
27197 @opindex mabm
27198 @need 200
27199 @itemx -mbmi
27200 @opindex mbmi
27201 @need 200
27202 @itemx -mbmi2
27203 @need 200
27204 @itemx -mlzcnt
27205 @opindex mlzcnt
27206 @need 200
27207 @itemx -mfxsr
27208 @opindex mfxsr
27209 @need 200
27210 @itemx -mxsave
27211 @opindex mxsave
27212 @need 200
27213 @itemx -mxsaveopt
27214 @opindex mxsaveopt
27215 @need 200
27216 @itemx -mxsavec
27217 @opindex mxsavec
27218 @need 200
27219 @itemx -mxsaves
27220 @opindex mxsaves
27221 @need 200
27222 @itemx -mrtm
27223 @opindex mrtm
27224 @need 200
27225 @itemx -mtbm
27226 @opindex mtbm
27227 @need 200
27228 @itemx -mmpx
27229 @opindex mmpx
27230 @need 200
27231 @itemx -mmwaitx
27232 @opindex mmwaitx
27233 @need 200
27234 @itemx -mclzero
27235 @opindex mclzero
27236 @need 200
27237 @itemx -mpku
27238 @opindex mpku
27239 @need 200
27240 @itemx -mavx512vbmi2
27241 @opindex mavx512vbmi2
27242 @need 200
27243 @itemx -mgfni
27244 @opindex mgfni
27245 @need 200
27246 @itemx -mvaes
27247 @opindex mvaes
27248 @need 200
27249 @itemx -mwaitpkg
27250 @opindex -mwaitpkg
27251 @need 200
27252 @itemx -mvpclmulqdq
27253 @opindex mvpclmulqdq
27254 @need 200
27255 @itemx -mavx512bitalg
27256 @opindex mavx512bitalg
27257 @need 200
27258 @itemx -mmovdiri
27259 @opindex mmovdiri
27260 @need 200
27261 @itemx -mmovdir64b
27262 @opindex mmovdir64b
27263 @need 200
27264 @itemx -mavx512vpopcntdq
27265 @opindex mavx512vpopcntdq
27266 @need 200
27267 @itemx -mcldemote
27268 @opindex mcldemote
27269 These switches enable the use of instructions in the MMX, SSE,
27270 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27271 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27272 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES, WAITPKG,
27273 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27274 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
27275 AVX512VPOPCNTDQ, CLDEMOTE, 3DNow!@: or enhanced 3DNow!@: extended instruction
27276 sets. Each has a corresponding @option{-mno-} option to disable use of these
27277 instructions.
27279 These extensions are also available as built-in functions: see
27280 @ref{x86 Built-in Functions}, for details of the functions enabled and
27281 disabled by these switches.
27283 To generate SSE/SSE2 instructions automatically from floating-point
27284 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27286 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27287 generates new AVX instructions or AVX equivalence for all SSEx instructions
27288 when needed.
27290 These options enable GCC to use these extended instructions in
27291 generated code, even without @option{-mfpmath=sse}.  Applications that
27292 perform run-time CPU detection must compile separate files for each
27293 supported architecture, using the appropriate flags.  In particular,
27294 the file containing the CPU detection code should be compiled without
27295 these options.
27297 @item -mdump-tune-features
27298 @opindex mdump-tune-features
27299 This option instructs GCC to dump the names of the x86 performance 
27300 tuning features and default settings. The names can be used in 
27301 @option{-mtune-ctrl=@var{feature-list}}.
27303 @item -mtune-ctrl=@var{feature-list}
27304 @opindex mtune-ctrl=@var{feature-list}
27305 This option is used to do fine grain control of x86 code generation features.
27306 @var{feature-list} is a comma separated list of @var{feature} names. See also
27307 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27308 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27309 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27310 developers. Using it may lead to code paths not covered by testing and can
27311 potentially result in compiler ICEs or runtime errors.
27313 @item -mno-default
27314 @opindex mno-default
27315 This option instructs GCC to turn off all tunable features. See also 
27316 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27318 @item -mcld
27319 @opindex mcld
27320 This option instructs GCC to emit a @code{cld} instruction in the prologue
27321 of functions that use string instructions.  String instructions depend on
27322 the DF flag to select between autoincrement or autodecrement mode.  While the
27323 ABI specifies the DF flag to be cleared on function entry, some operating
27324 systems violate this specification by not clearing the DF flag in their
27325 exception dispatchers.  The exception handler can be invoked with the DF flag
27326 set, which leads to wrong direction mode when string instructions are used.
27327 This option can be enabled by default on 32-bit x86 targets by configuring
27328 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27329 instructions can be suppressed with the @option{-mno-cld} compiler option
27330 in this case.
27332 @item -mvzeroupper
27333 @opindex mvzeroupper
27334 This option instructs GCC to emit a @code{vzeroupper} instruction
27335 before a transfer of control flow out of the function to minimize
27336 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27337 intrinsics.
27339 @item -mprefer-avx128
27340 @opindex mprefer-avx128
27341 This option instructs GCC to use 128-bit AVX instructions instead of
27342 256-bit AVX instructions in the auto-vectorizer.
27344 @item -mprefer-vector-width=@var{opt}
27345 @opindex mprefer-vector-width
27346 This option instructs GCC to use @var{opt}-bit vector width in instructions
27347 instead of default on the selected platform.
27349 @table @samp
27350 @item none
27351 No extra limitations applied to GCC other than defined by the selected platform.
27353 @item 128
27354 Prefer 128-bit vector width for instructions.
27356 @item 256
27357 Prefer 256-bit vector width for instructions.
27359 @item 512
27360 Prefer 512-bit vector width for instructions.
27361 @end table
27363 @item -mcx16
27364 @opindex mcx16
27365 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27366 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27367 objects.  This is useful for atomic updates of data structures exceeding one
27368 machine word in size.  The compiler uses this instruction to implement
27369 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27370 128-bit integers, a library call is always used.
27372 @item -msahf
27373 @opindex msahf
27374 This option enables generation of @code{SAHF} instructions in 64-bit code.
27375 Early Intel Pentium 4 CPUs with Intel 64 support,
27376 prior to the introduction of Pentium 4 G1 step in December 2005,
27377 lacked the @code{LAHF} and @code{SAHF} instructions
27378 which are supported by AMD64.
27379 These are load and store instructions, respectively, for certain status flags.
27380 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27381 @code{drem}, and @code{remainder} built-in functions;
27382 see @ref{Other Builtins} for details.
27384 @item -mmovbe
27385 @opindex mmovbe
27386 This option enables use of the @code{movbe} instruction to implement
27387 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27389 @item -mshstk
27390 @opindex mshstk
27391 The @option{-mshstk} option enables shadow stack built-in functions
27392 from x86 Control-flow Enforcement Technology (CET).
27394 @item -mcrc32
27395 @opindex mcrc32
27396 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27397 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27398 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27400 @item -mrecip
27401 @opindex mrecip
27402 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27403 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27404 with an additional Newton-Raphson step
27405 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27406 (and their vectorized
27407 variants) for single-precision floating-point arguments.  These instructions
27408 are generated only when @option{-funsafe-math-optimizations} is enabled
27409 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27410 Note that while the throughput of the sequence is higher than the throughput
27411 of the non-reciprocal instruction, the precision of the sequence can be
27412 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27414 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27415 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27416 combination), and doesn't need @option{-mrecip}.
27418 Also note that GCC emits the above sequence with additional Newton-Raphson step
27419 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27420 already with @option{-ffast-math} (or the above option combination), and
27421 doesn't need @option{-mrecip}.
27423 @item -mrecip=@var{opt}
27424 @opindex mrecip=opt
27425 This option controls which reciprocal estimate instructions
27426 may be used.  @var{opt} is a comma-separated list of options, which may
27427 be preceded by a @samp{!} to invert the option:
27429 @table @samp
27430 @item all
27431 Enable all estimate instructions.
27433 @item default
27434 Enable the default instructions, equivalent to @option{-mrecip}.
27436 @item none
27437 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27439 @item div
27440 Enable the approximation for scalar division.
27442 @item vec-div
27443 Enable the approximation for vectorized division.
27445 @item sqrt
27446 Enable the approximation for scalar square root.
27448 @item vec-sqrt
27449 Enable the approximation for vectorized square root.
27450 @end table
27452 So, for example, @option{-mrecip=all,!sqrt} enables
27453 all of the reciprocal approximations, except for square root.
27455 @item -mveclibabi=@var{type}
27456 @opindex mveclibabi
27457 Specifies the ABI type to use for vectorizing intrinsics using an
27458 external library.  Supported values for @var{type} are @samp{svml} 
27459 for the Intel short
27460 vector math library and @samp{acml} for the AMD math core library.
27461 To use this option, both @option{-ftree-vectorize} and
27462 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27463 ABI-compatible library must be specified at link time.
27465 GCC currently emits calls to @code{vmldExp2},
27466 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27467 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27468 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27469 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27470 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27471 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27472 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27473 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27474 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27475 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27476 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27477 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27478 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27479 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27480 when @option{-mveclibabi=acml} is used.  
27482 @item -mabi=@var{name}
27483 @opindex mabi
27484 Generate code for the specified calling convention.  Permissible values
27485 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27486 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27487 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27488 You can control this behavior for specific functions by
27489 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27490 @xref{Function Attributes}.
27492 @item -mforce-indirect-call
27493 @opindex mforce-indirect-call
27494 Force all calls to functions to be indirect. This is useful
27495 when using Intel Processor Trace where it generates more precise timing
27496 information for function calls.
27498 @item -mcall-ms2sysv-xlogues
27499 @opindex mcall-ms2sysv-xlogues
27500 @opindex mno-call-ms2sysv-xlogues
27501 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27502 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27503 default, the code for saving and restoring these registers is emitted inline,
27504 resulting in fairly lengthy prologues and epilogues.  Using
27505 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27506 use stubs in the static portion of libgcc to perform these saves and restores,
27507 thus reducing function size at the cost of a few extra instructions.
27509 @item -mtls-dialect=@var{type}
27510 @opindex mtls-dialect
27511 Generate code to access thread-local storage using the @samp{gnu} or
27512 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27513 @samp{gnu2} is more efficient, but it may add compile- and run-time
27514 requirements that cannot be satisfied on all systems.
27516 @item -mpush-args
27517 @itemx -mno-push-args
27518 @opindex mpush-args
27519 @opindex mno-push-args
27520 Use PUSH operations to store outgoing parameters.  This method is shorter
27521 and usually equally fast as method using SUB/MOV operations and is enabled
27522 by default.  In some cases disabling it may improve performance because of
27523 improved scheduling and reduced dependencies.
27525 @item -maccumulate-outgoing-args
27526 @opindex maccumulate-outgoing-args
27527 If enabled, the maximum amount of space required for outgoing arguments is
27528 computed in the function prologue.  This is faster on most modern CPUs
27529 because of reduced dependencies, improved scheduling and reduced stack usage
27530 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27531 increase in code size.  This switch implies @option{-mno-push-args}.
27533 @item -mthreads
27534 @opindex mthreads
27535 Support thread-safe exception handling on MinGW.  Programs that rely
27536 on thread-safe exception handling must compile and link all code with the
27537 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27538 @option{-D_MT}; when linking, it links in a special thread helper library
27539 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27541 @item -mms-bitfields
27542 @itemx -mno-ms-bitfields
27543 @opindex mms-bitfields
27544 @opindex mno-ms-bitfields
27546 Enable/disable bit-field layout compatible with the native Microsoft
27547 Windows compiler.  
27549 If @code{packed} is used on a structure, or if bit-fields are used,
27550 it may be that the Microsoft ABI lays out the structure differently
27551 than the way GCC normally does.  Particularly when moving packed
27552 data between functions compiled with GCC and the native Microsoft compiler
27553 (either via function call or as data in a file), it may be necessary to access
27554 either format.
27556 This option is enabled by default for Microsoft Windows
27557 targets.  This behavior can also be controlled locally by use of variable
27558 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27559 and @ref{x86 Type Attributes}.
27561 The Microsoft structure layout algorithm is fairly simple with the exception
27562 of the bit-field packing.  
27563 The padding and alignment of members of structures and whether a bit-field 
27564 can straddle a storage-unit boundary are determine by these rules:
27566 @enumerate
27567 @item Structure members are stored sequentially in the order in which they are
27568 declared: the first member has the lowest memory address and the last member
27569 the highest.
27571 @item Every data object has an alignment requirement.  The alignment requirement
27572 for all data except structures, unions, and arrays is either the size of the
27573 object or the current packing size (specified with either the
27574 @code{aligned} attribute or the @code{pack} pragma),
27575 whichever is less.  For structures, unions, and arrays,
27576 the alignment requirement is the largest alignment requirement of its members.
27577 Every object is allocated an offset so that:
27579 @smallexample
27580 offset % alignment_requirement == 0
27581 @end smallexample
27583 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27584 unit if the integral types are the same size and if the next bit-field fits
27585 into the current allocation unit without crossing the boundary imposed by the
27586 common alignment requirements of the bit-fields.
27587 @end enumerate
27589 MSVC interprets zero-length bit-fields in the following ways:
27591 @enumerate
27592 @item If a zero-length bit-field is inserted between two bit-fields that
27593 are normally coalesced, the bit-fields are not coalesced.
27595 For example:
27597 @smallexample
27598 struct
27599  @{
27600    unsigned long bf_1 : 12;
27601    unsigned long : 0;
27602    unsigned long bf_2 : 12;
27603  @} t1;
27604 @end smallexample
27606 @noindent
27607 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27608 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27610 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27611 alignment of the zero-length bit-field is greater than the member that follows it,
27612 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27614 For example:
27616 @smallexample
27617 struct
27618  @{
27619    char foo : 4;
27620    short : 0;
27621    char bar;
27622  @} t2;
27624 struct
27625  @{
27626    char foo : 4;
27627    short : 0;
27628    double bar;
27629  @} t3;
27630 @end smallexample
27632 @noindent
27633 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27634 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27635 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27636 of the structure.
27638 Taking this into account, it is important to note the following:
27640 @enumerate
27641 @item If a zero-length bit-field follows a normal bit-field, the type of the
27642 zero-length bit-field may affect the alignment of the structure as whole. For
27643 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27644 normal bit-field, and is of type short.
27646 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27647 still affect the alignment of the structure:
27649 @smallexample
27650 struct
27651  @{
27652    char foo : 6;
27653    long : 0;
27654  @} t4;
27655 @end smallexample
27657 @noindent
27658 Here, @code{t4} takes up 4 bytes.
27659 @end enumerate
27661 @item Zero-length bit-fields following non-bit-field members are ignored:
27663 @smallexample
27664 struct
27665  @{
27666    char foo;
27667    long : 0;
27668    char bar;
27669  @} t5;
27670 @end smallexample
27672 @noindent
27673 Here, @code{t5} takes up 2 bytes.
27674 @end enumerate
27677 @item -mno-align-stringops
27678 @opindex mno-align-stringops
27679 Do not align the destination of inlined string operations.  This switch reduces
27680 code size and improves performance in case the destination is already aligned,
27681 but GCC doesn't know about it.
27683 @item -minline-all-stringops
27684 @opindex minline-all-stringops
27685 By default GCC inlines string operations only when the destination is 
27686 known to be aligned to least a 4-byte boundary.  
27687 This enables more inlining and increases code
27688 size, but may improve performance of code that depends on fast
27689 @code{memcpy}, @code{strlen},
27690 and @code{memset} for short lengths.
27692 @item -minline-stringops-dynamically
27693 @opindex minline-stringops-dynamically
27694 For string operations of unknown size, use run-time checks with
27695 inline code for small blocks and a library call for large blocks.
27697 @item -mstringop-strategy=@var{alg}
27698 @opindex mstringop-strategy=@var{alg}
27699 Override the internal decision heuristic for the particular algorithm to use
27700 for inlining string operations.  The allowed values for @var{alg} are:
27702 @table @samp
27703 @item rep_byte
27704 @itemx rep_4byte
27705 @itemx rep_8byte
27706 Expand using i386 @code{rep} prefix of the specified size.
27708 @item byte_loop
27709 @itemx loop
27710 @itemx unrolled_loop
27711 Expand into an inline loop.
27713 @item libcall
27714 Always use a library call.
27715 @end table
27717 @item -mmemcpy-strategy=@var{strategy}
27718 @opindex mmemcpy-strategy=@var{strategy}
27719 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27720 should be inlined and what inline algorithm to use when the expected size
27721 of the copy operation is known. @var{strategy} 
27722 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27723 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27724 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27725 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27726 in the list must be specified in increasing order.  The minimal byte size for 
27727 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27728 preceding range.
27730 @item -mmemset-strategy=@var{strategy}
27731 @opindex mmemset-strategy=@var{strategy}
27732 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27733 @code{__builtin_memset} expansion.
27735 @item -momit-leaf-frame-pointer
27736 @opindex momit-leaf-frame-pointer
27737 Don't keep the frame pointer in a register for leaf functions.  This
27738 avoids the instructions to save, set up, and restore frame pointers and
27739 makes an extra register available in leaf functions.  The option
27740 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27741 which might make debugging harder.
27743 @item -mtls-direct-seg-refs
27744 @itemx -mno-tls-direct-seg-refs
27745 @opindex mtls-direct-seg-refs
27746 Controls whether TLS variables may be accessed with offsets from the
27747 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27748 or whether the thread base pointer must be added.  Whether or not this
27749 is valid depends on the operating system, and whether it maps the
27750 segment to cover the entire TLS area.
27752 For systems that use the GNU C Library, the default is on.
27754 @item -msse2avx
27755 @itemx -mno-sse2avx
27756 @opindex msse2avx
27757 Specify that the assembler should encode SSE instructions with VEX
27758 prefix.  The option @option{-mavx} turns this on by default.
27760 @item -mfentry
27761 @itemx -mno-fentry
27762 @opindex mfentry
27763 If profiling is active (@option{-pg}), put the profiling
27764 counter call before the prologue.
27765 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27766 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27768 @item -mrecord-mcount
27769 @itemx -mno-record-mcount
27770 @opindex mrecord-mcount
27771 If profiling is active (@option{-pg}), generate a __mcount_loc section
27772 that contains pointers to each profiling call. This is useful for
27773 automatically patching and out calls.
27775 @item -mnop-mcount
27776 @itemx -mno-nop-mcount
27777 @opindex mnop-mcount
27778 If profiling is active (@option{-pg}), generate the calls to
27779 the profiling functions as NOPs. This is useful when they
27780 should be patched in later dynamically. This is likely only
27781 useful together with @option{-mrecord-mcount}.
27783 @item -mskip-rax-setup
27784 @itemx -mno-skip-rax-setup
27785 @opindex mskip-rax-setup
27786 When generating code for the x86-64 architecture with SSE extensions
27787 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27788 register when there are no variable arguments passed in vector registers.
27790 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27791 saving vector registers on stack when passing variable arguments, the
27792 impacts of this option are callees may waste some stack space,
27793 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27794 those issues, regardless the RAX register value.
27796 @item -m8bit-idiv
27797 @itemx -mno-8bit-idiv
27798 @opindex m8bit-idiv
27799 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27800 much faster than 32-bit/64-bit integer divide.  This option generates a
27801 run-time check.  If both dividend and divisor are within range of 0
27802 to 255, 8-bit unsigned integer divide is used instead of
27803 32-bit/64-bit integer divide.
27805 @item -mavx256-split-unaligned-load
27806 @itemx -mavx256-split-unaligned-store
27807 @opindex mavx256-split-unaligned-load
27808 @opindex mavx256-split-unaligned-store
27809 Split 32-byte AVX unaligned load and store.
27811 @item -mstack-protector-guard=@var{guard}
27812 @itemx -mstack-protector-guard-reg=@var{reg}
27813 @itemx -mstack-protector-guard-offset=@var{offset}
27814 @opindex mstack-protector-guard
27815 @opindex mstack-protector-guard-reg
27816 @opindex mstack-protector-guard-offset
27817 Generate stack protection code using canary at @var{guard}.  Supported
27818 locations are @samp{global} for global canary or @samp{tls} for per-thread
27819 canary in the TLS block (the default).  This option has effect only when
27820 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27822 With the latter choice the options
27823 @option{-mstack-protector-guard-reg=@var{reg}} and
27824 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27825 which segment register (@code{%fs} or @code{%gs}) to use as base register
27826 for reading the canary, and from what offset from that base register.
27827 The default for those is as specified in the relevant ABI.
27829 @item -mmitigate-rop
27830 @opindex mmitigate-rop
27831 Try to avoid generating code sequences that contain unintended return
27832 opcodes, to mitigate against certain forms of attack. At the moment,
27833 this option is limited in what it can do and should not be relied
27834 on to provide serious protection.
27836 @item -mgeneral-regs-only
27837 @opindex mgeneral-regs-only
27838 Generate code that uses only the general-purpose registers.  This
27839 prevents the compiler from using floating-point, vector, mask and bound
27840 registers.
27842 @item -mindirect-branch=@var{choice}
27843 @opindex -mindirect-branch
27844 Convert indirect call and jump with @var{choice}.  The default is
27845 @samp{keep}, which keeps indirect call and jump unmodified.
27846 @samp{thunk} converts indirect call and jump to call and return thunk.
27847 @samp{thunk-inline} converts indirect call and jump to inlined call
27848 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27849 to external call and return thunk provided in a separate object file.
27850 You can control this behavior for a specific function by using the
27851 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27853 Note that @option{-mcmodel=large} is incompatible with
27854 @option{-mindirect-branch=thunk} and
27855 @option{-mindirect-branch=thunk-extern} since the thunk function may
27856 not be reachable in the large code model.
27858 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27859 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27860 since the external thunk can not be modified to disable control-flow
27861 check.
27863 @item -mfunction-return=@var{choice}
27864 @opindex -mfunction-return
27865 Convert function return with @var{choice}.  The default is @samp{keep},
27866 which keeps function return unmodified.  @samp{thunk} converts function
27867 return to call and return thunk.  @samp{thunk-inline} converts function
27868 return to inlined call and return thunk.  @samp{thunk-extern} converts
27869 function return to external call and return thunk provided in a separate
27870 object file.  You can control this behavior for a specific function by
27871 using the function attribute @code{function_return}.
27872 @xref{Function Attributes}.
27874 Note that @option{-mcmodel=large} is incompatible with
27875 @option{-mfunction-return=thunk} and
27876 @option{-mfunction-return=thunk-extern} since the thunk function may
27877 not be reachable in the large code model.
27880 @item -mindirect-branch-register
27881 @opindex -mindirect-branch-register
27882 Force indirect call and jump via register.
27884 @end table
27886 These @samp{-m} switches are supported in addition to the above
27887 on x86-64 processors in 64-bit environments.
27889 @table @gcctabopt
27890 @item -m32
27891 @itemx -m64
27892 @itemx -mx32
27893 @itemx -m16
27894 @itemx -miamcu
27895 @opindex m32
27896 @opindex m64
27897 @opindex mx32
27898 @opindex m16
27899 @opindex miamcu
27900 Generate code for a 16-bit, 32-bit or 64-bit environment.
27901 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27902 to 32 bits, and
27903 generates code that runs on any i386 system.
27905 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27906 types to 64 bits, and generates code for the x86-64 architecture.
27907 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27908 and @option{-mdynamic-no-pic} options.
27910 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27911 to 32 bits, and
27912 generates code for the x86-64 architecture.
27914 The @option{-m16} option is the same as @option{-m32}, except for that
27915 it outputs the @code{.code16gcc} assembly directive at the beginning of
27916 the assembly output so that the binary can run in 16-bit mode.
27918 The @option{-miamcu} option generates code which conforms to Intel MCU
27919 psABI.  It requires the @option{-m32} option to be turned on.
27921 @item -mno-red-zone
27922 @opindex mno-red-zone
27923 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27924 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27925 stack pointer that is not modified by signal or interrupt handlers
27926 and therefore can be used for temporary data without adjusting the stack
27927 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27929 @item -mcmodel=small
27930 @opindex mcmodel=small
27931 Generate code for the small code model: the program and its symbols must
27932 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27933 Programs can be statically or dynamically linked.  This is the default
27934 code model.
27936 @item -mcmodel=kernel
27937 @opindex mcmodel=kernel
27938 Generate code for the kernel code model.  The kernel runs in the
27939 negative 2 GB of the address space.
27940 This model has to be used for Linux kernel code.
27942 @item -mcmodel=medium
27943 @opindex mcmodel=medium
27944 Generate code for the medium model: the program is linked in the lower 2
27945 GB of the address space.  Small symbols are also placed there.  Symbols
27946 with sizes larger than @option{-mlarge-data-threshold} are put into
27947 large data or BSS sections and can be located above 2GB.  Programs can
27948 be statically or dynamically linked.
27950 @item -mcmodel=large
27951 @opindex mcmodel=large
27952 Generate code for the large model.  This model makes no assumptions
27953 about addresses and sizes of sections.
27955 @item -maddress-mode=long
27956 @opindex maddress-mode=long
27957 Generate code for long address mode.  This is only supported for 64-bit
27958 and x32 environments.  It is the default address mode for 64-bit
27959 environments.
27961 @item -maddress-mode=short
27962 @opindex maddress-mode=short
27963 Generate code for short address mode.  This is only supported for 32-bit
27964 and x32 environments.  It is the default address mode for 32-bit and
27965 x32 environments.
27966 @end table
27968 @node x86 Windows Options
27969 @subsection x86 Windows Options
27970 @cindex x86 Windows Options
27971 @cindex Windows Options for x86
27973 These additional options are available for Microsoft Windows targets:
27975 @table @gcctabopt
27976 @item -mconsole
27977 @opindex mconsole
27978 This option
27979 specifies that a console application is to be generated, by
27980 instructing the linker to set the PE header subsystem type
27981 required for console applications.
27982 This option is available for Cygwin and MinGW targets and is
27983 enabled by default on those targets.
27985 @item -mdll
27986 @opindex mdll
27987 This option is available for Cygwin and MinGW targets.  It
27988 specifies that a DLL---a dynamic link library---is to be
27989 generated, enabling the selection of the required runtime
27990 startup object and entry point.
27992 @item -mnop-fun-dllimport
27993 @opindex mnop-fun-dllimport
27994 This option is available for Cygwin and MinGW targets.  It
27995 specifies that the @code{dllimport} attribute should be ignored.
27997 @item -mthread
27998 @opindex mthread
27999 This option is available for MinGW targets. It specifies
28000 that MinGW-specific thread support is to be used.
28002 @item -municode
28003 @opindex municode
28004 This option is available for MinGW-w64 targets.  It causes
28005 the @code{UNICODE} preprocessor macro to be predefined, and
28006 chooses Unicode-capable runtime startup code.
28008 @item -mwin32
28009 @opindex mwin32
28010 This option is available for Cygwin and MinGW targets.  It
28011 specifies that the typical Microsoft Windows predefined macros are to
28012 be set in the pre-processor, but does not influence the choice
28013 of runtime library/startup code.
28015 @item -mwindows
28016 @opindex mwindows
28017 This option is available for Cygwin and MinGW targets.  It
28018 specifies that a GUI application is to be generated by
28019 instructing the linker to set the PE header subsystem type
28020 appropriately.
28022 @item -fno-set-stack-executable
28023 @opindex fno-set-stack-executable
28024 This option is available for MinGW targets. It specifies that
28025 the executable flag for the stack used by nested functions isn't
28026 set. This is necessary for binaries running in kernel mode of
28027 Microsoft Windows, as there the User32 API, which is used to set executable
28028 privileges, isn't available.
28030 @item -fwritable-relocated-rdata
28031 @opindex fno-writable-relocated-rdata
28032 This option is available for MinGW and Cygwin targets.  It specifies
28033 that relocated-data in read-only section is put into the @code{.data}
28034 section.  This is a necessary for older runtimes not supporting
28035 modification of @code{.rdata} sections for pseudo-relocation.
28037 @item -mpe-aligned-commons
28038 @opindex mpe-aligned-commons
28039 This option is available for Cygwin and MinGW targets.  It
28040 specifies that the GNU extension to the PE file format that
28041 permits the correct alignment of COMMON variables should be
28042 used when generating code.  It is enabled by default if
28043 GCC detects that the target assembler found during configuration
28044 supports the feature.
28045 @end table
28047 See also under @ref{x86 Options} for standard options.
28049 @node Xstormy16 Options
28050 @subsection Xstormy16 Options
28051 @cindex Xstormy16 Options
28053 These options are defined for Xstormy16:
28055 @table @gcctabopt
28056 @item -msim
28057 @opindex msim
28058 Choose startup files and linker script suitable for the simulator.
28059 @end table
28061 @node Xtensa Options
28062 @subsection Xtensa Options
28063 @cindex Xtensa Options
28065 These options are supported for Xtensa targets:
28067 @table @gcctabopt
28068 @item -mconst16
28069 @itemx -mno-const16
28070 @opindex mconst16
28071 @opindex mno-const16
28072 Enable or disable use of @code{CONST16} instructions for loading
28073 constant values.  The @code{CONST16} instruction is currently not a
28074 standard option from Tensilica.  When enabled, @code{CONST16}
28075 instructions are always used in place of the standard @code{L32R}
28076 instructions.  The use of @code{CONST16} is enabled by default only if
28077 the @code{L32R} instruction is not available.
28079 @item -mfused-madd
28080 @itemx -mno-fused-madd
28081 @opindex mfused-madd
28082 @opindex mno-fused-madd
28083 Enable or disable use of fused multiply/add and multiply/subtract
28084 instructions in the floating-point option.  This has no effect if the
28085 floating-point option is not also enabled.  Disabling fused multiply/add
28086 and multiply/subtract instructions forces the compiler to use separate
28087 instructions for the multiply and add/subtract operations.  This may be
28088 desirable in some cases where strict IEEE 754-compliant results are
28089 required: the fused multiply add/subtract instructions do not round the
28090 intermediate result, thereby producing results with @emph{more} bits of
28091 precision than specified by the IEEE standard.  Disabling fused multiply
28092 add/subtract instructions also ensures that the program output is not
28093 sensitive to the compiler's ability to combine multiply and add/subtract
28094 operations.
28096 @item -mserialize-volatile
28097 @itemx -mno-serialize-volatile
28098 @opindex mserialize-volatile
28099 @opindex mno-serialize-volatile
28100 When this option is enabled, GCC inserts @code{MEMW} instructions before
28101 @code{volatile} memory references to guarantee sequential consistency.
28102 The default is @option{-mserialize-volatile}.  Use
28103 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28105 @item -mforce-no-pic
28106 @opindex mforce-no-pic
28107 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28108 position-independent code (PIC), this option disables PIC for compiling
28109 kernel code.
28111 @item -mtext-section-literals
28112 @itemx -mno-text-section-literals
28113 @opindex mtext-section-literals
28114 @opindex mno-text-section-literals
28115 These options control the treatment of literal pools.  The default is
28116 @option{-mno-text-section-literals}, which places literals in a separate
28117 section in the output file.  This allows the literal pool to be placed
28118 in a data RAM/ROM, and it also allows the linker to combine literal
28119 pools from separate object files to remove redundant literals and
28120 improve code size.  With @option{-mtext-section-literals}, the literals
28121 are interspersed in the text section in order to keep them as close as
28122 possible to their references.  This may be necessary for large assembly
28123 files.  Literals for each function are placed right before that function.
28125 @item -mauto-litpools
28126 @itemx -mno-auto-litpools
28127 @opindex mauto-litpools
28128 @opindex mno-auto-litpools
28129 These options control the treatment of literal pools.  The default is
28130 @option{-mno-auto-litpools}, which places literals in a separate
28131 section in the output file unless @option{-mtext-section-literals} is
28132 used.  With @option{-mauto-litpools} the literals are interspersed in
28133 the text section by the assembler.  Compiler does not produce explicit
28134 @code{.literal} directives and loads literals into registers with
28135 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28136 do relaxation and place literals as necessary.  This option allows
28137 assembler to create several literal pools per function and assemble
28138 very big functions, which may not be possible with
28139 @option{-mtext-section-literals}.
28141 @item -mtarget-align
28142 @itemx -mno-target-align
28143 @opindex mtarget-align
28144 @opindex mno-target-align
28145 When this option is enabled, GCC instructs the assembler to
28146 automatically align instructions to reduce branch penalties at the
28147 expense of some code density.  The assembler attempts to widen density
28148 instructions to align branch targets and the instructions following call
28149 instructions.  If there are not enough preceding safe density
28150 instructions to align a target, no widening is performed.  The
28151 default is @option{-mtarget-align}.  These options do not affect the
28152 treatment of auto-aligned instructions like @code{LOOP}, which the
28153 assembler always aligns, either by widening density instructions or
28154 by inserting NOP instructions.
28156 @item -mlongcalls
28157 @itemx -mno-longcalls
28158 @opindex mlongcalls
28159 @opindex mno-longcalls
28160 When this option is enabled, GCC instructs the assembler to translate
28161 direct calls to indirect calls unless it can determine that the target
28162 of a direct call is in the range allowed by the call instruction.  This
28163 translation typically occurs for calls to functions in other source
28164 files.  Specifically, the assembler translates a direct @code{CALL}
28165 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28166 The default is @option{-mno-longcalls}.  This option should be used in
28167 programs where the call target can potentially be out of range.  This
28168 option is implemented in the assembler, not the compiler, so the
28169 assembly code generated by GCC still shows direct call
28170 instructions---look at the disassembled object code to see the actual
28171 instructions.  Note that the assembler uses an indirect call for
28172 every cross-file call, not just those that really are out of range.
28173 @end table
28175 @node zSeries Options
28176 @subsection zSeries Options
28177 @cindex zSeries options
28179 These are listed under @xref{S/390 and zSeries Options}.
28182 @c man end
28184 @node Spec Files
28185 @section Specifying Subprocesses and the Switches to Pass to Them
28186 @cindex Spec Files
28188 @command{gcc} is a driver program.  It performs its job by invoking a
28189 sequence of other programs to do the work of compiling, assembling and
28190 linking.  GCC interprets its command-line parameters and uses these to
28191 deduce which programs it should invoke, and which command-line options
28192 it ought to place on their command lines.  This behavior is controlled
28193 by @dfn{spec strings}.  In most cases there is one spec string for each
28194 program that GCC can invoke, but a few programs have multiple spec
28195 strings to control their behavior.  The spec strings built into GCC can
28196 be overridden by using the @option{-specs=} command-line switch to specify
28197 a spec file.
28199 @dfn{Spec files} are plain-text files that are used to construct spec
28200 strings.  They consist of a sequence of directives separated by blank
28201 lines.  The type of directive is determined by the first non-whitespace
28202 character on the line, which can be one of the following:
28204 @table @code
28205 @item %@var{command}
28206 Issues a @var{command} to the spec file processor.  The commands that can
28207 appear here are:
28209 @table @code
28210 @item %include <@var{file}>
28211 @cindex @code{%include}
28212 Search for @var{file} and insert its text at the current point in the
28213 specs file.
28215 @item %include_noerr <@var{file}>
28216 @cindex @code{%include_noerr}
28217 Just like @samp{%include}, but do not generate an error message if the include
28218 file cannot be found.
28220 @item %rename @var{old_name} @var{new_name}
28221 @cindex @code{%rename}
28222 Rename the spec string @var{old_name} to @var{new_name}.
28224 @end table
28226 @item *[@var{spec_name}]:
28227 This tells the compiler to create, override or delete the named spec
28228 string.  All lines after this directive up to the next directive or
28229 blank line are considered to be the text for the spec string.  If this
28230 results in an empty string then the spec is deleted.  (Or, if the
28231 spec did not exist, then nothing happens.)  Otherwise, if the spec
28232 does not currently exist a new spec is created.  If the spec does
28233 exist then its contents are overridden by the text of this
28234 directive, unless the first character of that text is the @samp{+}
28235 character, in which case the text is appended to the spec.
28237 @item [@var{suffix}]:
28238 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28239 and up to the next directive or blank line are considered to make up the
28240 spec string for the indicated suffix.  When the compiler encounters an
28241 input file with the named suffix, it processes the spec string in
28242 order to work out how to compile that file.  For example:
28244 @smallexample
28245 .ZZ:
28246 z-compile -input %i
28247 @end smallexample
28249 This says that any input file whose name ends in @samp{.ZZ} should be
28250 passed to the program @samp{z-compile}, which should be invoked with the
28251 command-line switch @option{-input} and with the result of performing the
28252 @samp{%i} substitution.  (See below.)
28254 As an alternative to providing a spec string, the text following a
28255 suffix directive can be one of the following:
28257 @table @code
28258 @item @@@var{language}
28259 This says that the suffix is an alias for a known @var{language}.  This is
28260 similar to using the @option{-x} command-line switch to GCC to specify a
28261 language explicitly.  For example:
28263 @smallexample
28264 .ZZ:
28265 @@c++
28266 @end smallexample
28268 Says that .ZZ files are, in fact, C++ source files.
28270 @item #@var{name}
28271 This causes an error messages saying:
28273 @smallexample
28274 @var{name} compiler not installed on this system.
28275 @end smallexample
28276 @end table
28278 GCC already has an extensive list of suffixes built into it.
28279 This directive adds an entry to the end of the list of suffixes, but
28280 since the list is searched from the end backwards, it is effectively
28281 possible to override earlier entries using this technique.
28283 @end table
28285 GCC has the following spec strings built into it.  Spec files can
28286 override these strings or create their own.  Note that individual
28287 targets can also add their own spec strings to this list.
28289 @smallexample
28290 asm          Options to pass to the assembler
28291 asm_final    Options to pass to the assembler post-processor
28292 cpp          Options to pass to the C preprocessor
28293 cc1          Options to pass to the C compiler
28294 cc1plus      Options to pass to the C++ compiler
28295 endfile      Object files to include at the end of the link
28296 link         Options to pass to the linker
28297 lib          Libraries to include on the command line to the linker
28298 libgcc       Decides which GCC support library to pass to the linker
28299 linker       Sets the name of the linker
28300 predefines   Defines to be passed to the C preprocessor
28301 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28302              by default
28303 startfile    Object files to include at the start of the link
28304 @end smallexample
28306 Here is a small example of a spec file:
28308 @smallexample
28309 %rename lib                 old_lib
28311 *lib:
28312 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28313 @end smallexample
28315 This example renames the spec called @samp{lib} to @samp{old_lib} and
28316 then overrides the previous definition of @samp{lib} with a new one.
28317 The new definition adds in some extra command-line options before
28318 including the text of the old definition.
28320 @dfn{Spec strings} are a list of command-line options to be passed to their
28321 corresponding program.  In addition, the spec strings can contain
28322 @samp{%}-prefixed sequences to substitute variable text or to
28323 conditionally insert text into the command line.  Using these constructs
28324 it is possible to generate quite complex command lines.
28326 Here is a table of all defined @samp{%}-sequences for spec
28327 strings.  Note that spaces are not generated automatically around the
28328 results of expanding these sequences.  Therefore you can concatenate them
28329 together or combine them with constant text in a single argument.
28331 @table @code
28332 @item %%
28333 Substitute one @samp{%} into the program name or argument.
28335 @item %i
28336 Substitute the name of the input file being processed.
28338 @item %b
28339 Substitute the basename of the input file being processed.
28340 This is the substring up to (and not including) the last period
28341 and not including the directory.
28343 @item %B
28344 This is the same as @samp{%b}, but include the file suffix (text after
28345 the last period).
28347 @item %d
28348 Marks the argument containing or following the @samp{%d} as a
28349 temporary file name, so that that file is deleted if GCC exits
28350 successfully.  Unlike @samp{%g}, this contributes no text to the
28351 argument.
28353 @item %g@var{suffix}
28354 Substitute a file name that has suffix @var{suffix} and is chosen
28355 once per compilation, and mark the argument in the same way as
28356 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28357 name is now chosen in a way that is hard to predict even when previously
28358 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28359 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28360 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28361 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28362 was simply substituted with a file name chosen once per compilation,
28363 without regard to any appended suffix (which was therefore treated
28364 just like ordinary text), making such attacks more likely to succeed.
28366 @item %u@var{suffix}
28367 Like @samp{%g}, but generates a new temporary file name
28368 each time it appears instead of once per compilation.
28370 @item %U@var{suffix}
28371 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28372 new one if there is no such last file name.  In the absence of any
28373 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28374 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28375 involves the generation of two distinct file names, one
28376 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28377 simply substituted with a file name chosen for the previous @samp{%u},
28378 without regard to any appended suffix.
28380 @item %j@var{suffix}
28381 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28382 writable, and if @option{-save-temps} is not used; 
28383 otherwise, substitute the name
28384 of a temporary file, just like @samp{%u}.  This temporary file is not
28385 meant for communication between processes, but rather as a junk
28386 disposal mechanism.
28388 @item %|@var{suffix}
28389 @itemx %m@var{suffix}
28390 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28391 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28392 all.  These are the two most common ways to instruct a program that it
28393 should read from standard input or write to standard output.  If you
28394 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28395 construct: see for example @file{f/lang-specs.h}.
28397 @item %.@var{SUFFIX}
28398 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28399 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28400 terminated by the next space or %.
28402 @item %w
28403 Marks the argument containing or following the @samp{%w} as the
28404 designated output file of this compilation.  This puts the argument
28405 into the sequence of arguments that @samp{%o} substitutes.
28407 @item %o
28408 Substitutes the names of all the output files, with spaces
28409 automatically placed around them.  You should write spaces
28410 around the @samp{%o} as well or the results are undefined.
28411 @samp{%o} is for use in the specs for running the linker.
28412 Input files whose names have no recognized suffix are not compiled
28413 at all, but they are included among the output files, so they are
28414 linked.
28416 @item %O
28417 Substitutes the suffix for object files.  Note that this is
28418 handled specially when it immediately follows @samp{%g, %u, or %U},
28419 because of the need for those to form complete file names.  The
28420 handling is such that @samp{%O} is treated exactly as if it had already
28421 been substituted, except that @samp{%g, %u, and %U} do not currently
28422 support additional @var{suffix} characters following @samp{%O} as they do
28423 following, for example, @samp{.o}.
28425 @item %p
28426 Substitutes the standard macro predefinitions for the
28427 current target machine.  Use this when running @command{cpp}.
28429 @item %P
28430 Like @samp{%p}, but puts @samp{__} before and after the name of each
28431 predefined macro, except for macros that start with @samp{__} or with
28432 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28435 @item %I
28436 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28437 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28438 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28439 and @option{-imultilib} as necessary.
28441 @item %s
28442 Current argument is the name of a library or startup file of some sort.
28443 Search for that file in a standard list of directories and substitute
28444 the full name found.  The current working directory is included in the
28445 list of directories scanned.
28447 @item %T
28448 Current argument is the name of a linker script.  Search for that file
28449 in the current list of directories to scan for libraries. If the file
28450 is located insert a @option{--script} option into the command line
28451 followed by the full path name found.  If the file is not found then
28452 generate an error message.  Note: the current working directory is not
28453 searched.
28455 @item %e@var{str}
28456 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28457 Use this when inconsistent options are detected.
28459 @item %(@var{name})
28460 Substitute the contents of spec string @var{name} at this point.
28462 @item %x@{@var{option}@}
28463 Accumulate an option for @samp{%X}.
28465 @item %X
28466 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28467 spec string.
28469 @item %Y
28470 Output the accumulated assembler options specified by @option{-Wa}.
28472 @item %Z
28473 Output the accumulated preprocessor options specified by @option{-Wp}.
28475 @item %a
28476 Process the @code{asm} spec.  This is used to compute the
28477 switches to be passed to the assembler.
28479 @item %A
28480 Process the @code{asm_final} spec.  This is a spec string for
28481 passing switches to an assembler post-processor, if such a program is
28482 needed.
28484 @item %l
28485 Process the @code{link} spec.  This is the spec for computing the
28486 command line passed to the linker.  Typically it makes use of the
28487 @samp{%L %G %S %D and %E} sequences.
28489 @item %D
28490 Dump out a @option{-L} option for each directory that GCC believes might
28491 contain startup files.  If the target supports multilibs then the
28492 current multilib directory is prepended to each of these paths.
28494 @item %L
28495 Process the @code{lib} spec.  This is a spec string for deciding which
28496 libraries are included on the command line to the linker.
28498 @item %G
28499 Process the @code{libgcc} spec.  This is a spec string for deciding
28500 which GCC support library is included on the command line to the linker.
28502 @item %S
28503 Process the @code{startfile} spec.  This is a spec for deciding which
28504 object files are the first ones passed to the linker.  Typically
28505 this might be a file named @file{crt0.o}.
28507 @item %E
28508 Process the @code{endfile} spec.  This is a spec string that specifies
28509 the last object files that are passed to the linker.
28511 @item %C
28512 Process the @code{cpp} spec.  This is used to construct the arguments
28513 to be passed to the C preprocessor.
28515 @item %1
28516 Process the @code{cc1} spec.  This is used to construct the options to be
28517 passed to the actual C compiler (@command{cc1}).
28519 @item %2
28520 Process the @code{cc1plus} spec.  This is used to construct the options to be
28521 passed to the actual C++ compiler (@command{cc1plus}).
28523 @item %*
28524 Substitute the variable part of a matched option.  See below.
28525 Note that each comma in the substituted string is replaced by
28526 a single space.
28528 @item %<S
28529 Remove all occurrences of @code{-S} from the command line.  Note---this
28530 command is position dependent.  @samp{%} commands in the spec string
28531 before this one see @code{-S}, @samp{%} commands in the spec string
28532 after this one do not.
28534 @item %:@var{function}(@var{args})
28535 Call the named function @var{function}, passing it @var{args}.
28536 @var{args} is first processed as a nested spec string, then split
28537 into an argument vector in the usual fashion.  The function returns
28538 a string which is processed as if it had appeared literally as part
28539 of the current spec.
28541 The following built-in spec functions are provided:
28543 @table @code
28544 @item @code{getenv}
28545 The @code{getenv} spec function takes two arguments: an environment
28546 variable name and a string.  If the environment variable is not
28547 defined, a fatal error is issued.  Otherwise, the return value is the
28548 value of the environment variable concatenated with the string.  For
28549 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28551 @smallexample
28552 %:getenv(TOPDIR /include)
28553 @end smallexample
28555 expands to @file{/path/to/top/include}.
28557 @item @code{if-exists}
28558 The @code{if-exists} spec function takes one argument, an absolute
28559 pathname to a file.  If the file exists, @code{if-exists} returns the
28560 pathname.  Here is a small example of its usage:
28562 @smallexample
28563 *startfile:
28564 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28565 @end smallexample
28567 @item @code{if-exists-else}
28568 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28569 spec function, except that it takes two arguments.  The first argument is
28570 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28571 returns the pathname.  If it does not exist, it returns the second argument.
28572 This way, @code{if-exists-else} can be used to select one file or another,
28573 based on the existence of the first.  Here is a small example of its usage:
28575 @smallexample
28576 *startfile:
28577 crt0%O%s %:if-exists(crti%O%s) \
28578 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28579 @end smallexample
28581 @item @code{replace-outfile}
28582 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28583 first argument in the outfiles array and replaces it with the second argument.  Here
28584 is a small example of its usage:
28586 @smallexample
28587 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28588 @end smallexample
28590 @item @code{remove-outfile}
28591 The @code{remove-outfile} spec function takes one argument.  It looks for the
28592 first argument in the outfiles array and removes it.  Here is a small example
28593 its usage:
28595 @smallexample
28596 %:remove-outfile(-lm)
28597 @end smallexample
28599 @item @code{pass-through-libs}
28600 The @code{pass-through-libs} spec function takes any number of arguments.  It
28601 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28602 assumes are the names of linker input library archive files) and returns a
28603 result containing all the found arguments each prepended by
28604 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28605 intended to be passed to the LTO linker plugin.
28607 @smallexample
28608 %:pass-through-libs(%G %L %G)
28609 @end smallexample
28611 @item @code{print-asm-header}
28612 The @code{print-asm-header} function takes no arguments and simply
28613 prints a banner like:
28615 @smallexample
28616 Assembler options
28617 =================
28619 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28620 @end smallexample
28622 It is used to separate compiler options from assembler options
28623 in the @option{--target-help} output.
28624 @end table
28626 @item %@{S@}
28627 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28628 If that switch is not specified, this substitutes nothing.  Note that
28629 the leading dash is omitted when specifying this option, and it is
28630 automatically inserted if the substitution is performed.  Thus the spec
28631 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28632 and outputs the command-line option @option{-foo}.
28634 @item %W@{S@}
28635 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28636 deleted on failure.
28638 @item %@{S*@}
28639 Substitutes all the switches specified to GCC whose names start
28640 with @code{-S}, but which also take an argument.  This is used for
28641 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28642 GCC considers @option{-o foo} as being
28643 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28644 text, including the space.  Thus two arguments are generated.
28646 @item %@{S*&T*@}
28647 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28648 (the order of @code{S} and @code{T} in the spec is not significant).
28649 There can be any number of ampersand-separated variables; for each the
28650 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28652 @item %@{S:X@}
28653 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28655 @item %@{!S:X@}
28656 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28658 @item %@{S*:X@}
28659 Substitutes @code{X} if one or more switches whose names start with
28660 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28661 once, no matter how many such switches appeared.  However, if @code{%*}
28662 appears somewhere in @code{X}, then @code{X} is substituted once
28663 for each matching switch, with the @code{%*} replaced by the part of
28664 that switch matching the @code{*}.
28666 If @code{%*} appears as the last part of a spec sequence then a space
28667 is added after the end of the last substitution.  If there is more
28668 text in the sequence, however, then a space is not generated.  This
28669 allows the @code{%*} substitution to be used as part of a larger
28670 string.  For example, a spec string like this:
28672 @smallexample
28673 %@{mcu=*:--script=%*/memory.ld@}
28674 @end smallexample
28676 @noindent
28677 when matching an option like @option{-mcu=newchip} produces:
28679 @smallexample
28680 --script=newchip/memory.ld
28681 @end smallexample
28683 @item %@{.S:X@}
28684 Substitutes @code{X}, if processing a file with suffix @code{S}.
28686 @item %@{!.S:X@}
28687 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28689 @item %@{,S:X@}
28690 Substitutes @code{X}, if processing a file for language @code{S}.
28692 @item %@{!,S:X@}
28693 Substitutes @code{X}, if not processing a file for language @code{S}.
28695 @item %@{S|P:X@}
28696 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28697 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28698 @code{*} sequences as well, although they have a stronger binding than
28699 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28700 alternatives must be starred, and only the first matching alternative
28701 is substituted.
28703 For example, a spec string like this:
28705 @smallexample
28706 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28707 @end smallexample
28709 @noindent
28710 outputs the following command-line options from the following input
28711 command-line options:
28713 @smallexample
28714 fred.c        -foo -baz
28715 jim.d         -bar -boggle
28716 -d fred.c     -foo -baz -boggle
28717 -d jim.d      -bar -baz -boggle
28718 @end smallexample
28720 @item %@{S:X; T:Y; :D@}
28722 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28723 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28724 be as many clauses as you need.  This may be combined with @code{.},
28725 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28728 @end table
28730 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28731 or similar construct can use a backslash to ignore the special meaning
28732 of the character following it, thus allowing literal matching of a
28733 character that is otherwise specially treated.  For example,
28734 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28735 @option{-std=iso9899:1999} option is given.
28737 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28738 construct may contain other nested @samp{%} constructs or spaces, or
28739 even newlines.  They are processed as usual, as described above.
28740 Trailing white space in @code{X} is ignored.  White space may also
28741 appear anywhere on the left side of the colon in these constructs,
28742 except between @code{.} or @code{*} and the corresponding word.
28744 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28745 handled specifically in these constructs.  If another value of
28746 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28747 @option{-W} switch is found later in the command line, the earlier
28748 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28749 just one letter, which passes all matching options.
28751 The character @samp{|} at the beginning of the predicate text is used to
28752 indicate that a command should be piped to the following command, but
28753 only if @option{-pipe} is specified.
28755 It is built into GCC which switches take arguments and which do not.
28756 (You might think it would be useful to generalize this to allow each
28757 compiler's spec to say which switches take arguments.  But this cannot
28758 be done in a consistent fashion.  GCC cannot even decide which input
28759 files have been specified without knowing which switches take arguments,
28760 and it must know which input files to compile in order to tell which
28761 compilers to run).
28763 GCC also knows implicitly that arguments starting in @option{-l} are to be
28764 treated as compiler output files, and passed to the linker in their
28765 proper position among the other output files.
28767 @node Environment Variables
28768 @section Environment Variables Affecting GCC
28769 @cindex environment variables
28771 @c man begin ENVIRONMENT
28772 This section describes several environment variables that affect how GCC
28773 operates.  Some of them work by specifying directories or prefixes to use
28774 when searching for various kinds of files.  Some are used to specify other
28775 aspects of the compilation environment.
28777 Note that you can also specify places to search using options such as
28778 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28779 take precedence over places specified using environment variables, which
28780 in turn take precedence over those specified by the configuration of GCC@.
28781 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28782 GNU Compiler Collection (GCC) Internals}.
28784 @table @env
28785 @item LANG
28786 @itemx LC_CTYPE
28787 @c @itemx LC_COLLATE
28788 @itemx LC_MESSAGES
28789 @c @itemx LC_MONETARY
28790 @c @itemx LC_NUMERIC
28791 @c @itemx LC_TIME
28792 @itemx LC_ALL
28793 @findex LANG
28794 @findex LC_CTYPE
28795 @c @findex LC_COLLATE
28796 @findex LC_MESSAGES
28797 @c @findex LC_MONETARY
28798 @c @findex LC_NUMERIC
28799 @c @findex LC_TIME
28800 @findex LC_ALL
28801 @cindex locale
28802 These environment variables control the way that GCC uses
28803 localization information which allows GCC to work with different
28804 national conventions.  GCC inspects the locale categories
28805 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28806 so.  These locale categories can be set to any value supported by your
28807 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28808 Kingdom encoded in UTF-8.
28810 The @env{LC_CTYPE} environment variable specifies character
28811 classification.  GCC uses it to determine the character boundaries in
28812 a string; this is needed for some multibyte encodings that contain quote
28813 and escape characters that are otherwise interpreted as a string
28814 end or escape.
28816 The @env{LC_MESSAGES} environment variable specifies the language to
28817 use in diagnostic messages.
28819 If the @env{LC_ALL} environment variable is set, it overrides the value
28820 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28821 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28822 environment variable.  If none of these variables are set, GCC
28823 defaults to traditional C English behavior.
28825 @item TMPDIR
28826 @findex TMPDIR
28827 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28828 files.  GCC uses temporary files to hold the output of one stage of
28829 compilation which is to be used as input to the next stage: for example,
28830 the output of the preprocessor, which is the input to the compiler
28831 proper.
28833 @item GCC_COMPARE_DEBUG
28834 @findex GCC_COMPARE_DEBUG
28835 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28836 @option{-fcompare-debug} to the compiler driver.  See the documentation
28837 of this option for more details.
28839 @item GCC_EXEC_PREFIX
28840 @findex GCC_EXEC_PREFIX
28841 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28842 names of the subprograms executed by the compiler.  No slash is added
28843 when this prefix is combined with the name of a subprogram, but you can
28844 specify a prefix that ends with a slash if you wish.
28846 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28847 an appropriate prefix to use based on the pathname it is invoked with.
28849 If GCC cannot find the subprogram using the specified prefix, it
28850 tries looking in the usual places for the subprogram.
28852 The default value of @env{GCC_EXEC_PREFIX} is
28853 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28854 the installed compiler. In many cases @var{prefix} is the value
28855 of @code{prefix} when you ran the @file{configure} script.
28857 Other prefixes specified with @option{-B} take precedence over this prefix.
28859 This prefix is also used for finding files such as @file{crt0.o} that are
28860 used for linking.
28862 In addition, the prefix is used in an unusual way in finding the
28863 directories to search for header files.  For each of the standard
28864 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28865 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28866 replacing that beginning with the specified prefix to produce an
28867 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28868 @file{foo/bar} just before it searches the standard directory 
28869 @file{/usr/local/lib/bar}.
28870 If a standard directory begins with the configured
28871 @var{prefix} then the value of @var{prefix} is replaced by
28872 @env{GCC_EXEC_PREFIX} when looking for header files.
28874 @item COMPILER_PATH
28875 @findex COMPILER_PATH
28876 The value of @env{COMPILER_PATH} is a colon-separated list of
28877 directories, much like @env{PATH}.  GCC tries the directories thus
28878 specified when searching for subprograms, if it cannot find the
28879 subprograms using @env{GCC_EXEC_PREFIX}.
28881 @item LIBRARY_PATH
28882 @findex LIBRARY_PATH
28883 The value of @env{LIBRARY_PATH} is a colon-separated list of
28884 directories, much like @env{PATH}.  When configured as a native compiler,
28885 GCC tries the directories thus specified when searching for special
28886 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28887 using GCC also uses these directories when searching for ordinary
28888 libraries for the @option{-l} option (but directories specified with
28889 @option{-L} come first).
28891 @item LANG
28892 @findex LANG
28893 @cindex locale definition
28894 This variable is used to pass locale information to the compiler.  One way in
28895 which this information is used is to determine the character set to be used
28896 when character literals, string literals and comments are parsed in C and C++.
28897 When the compiler is configured to allow multibyte characters,
28898 the following values for @env{LANG} are recognized:
28900 @table @samp
28901 @item C-JIS
28902 Recognize JIS characters.
28903 @item C-SJIS
28904 Recognize SJIS characters.
28905 @item C-EUCJP
28906 Recognize EUCJP characters.
28907 @end table
28909 If @env{LANG} is not defined, or if it has some other value, then the
28910 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28911 recognize and translate multibyte characters.
28912 @end table
28914 @noindent
28915 Some additional environment variables affect the behavior of the
28916 preprocessor.
28918 @include cppenv.texi
28920 @c man end
28922 @node Precompiled Headers
28923 @section Using Precompiled Headers
28924 @cindex precompiled headers
28925 @cindex speed of compilation
28927 Often large projects have many header files that are included in every
28928 source file.  The time the compiler takes to process these header files
28929 over and over again can account for nearly all of the time required to
28930 build the project.  To make builds faster, GCC allows you to
28931 @dfn{precompile} a header file.
28933 To create a precompiled header file, simply compile it as you would any
28934 other file, if necessary using the @option{-x} option to make the driver
28935 treat it as a C or C++ header file.  You may want to use a
28936 tool like @command{make} to keep the precompiled header up-to-date when
28937 the headers it contains change.
28939 A precompiled header file is searched for when @code{#include} is
28940 seen in the compilation.  As it searches for the included file
28941 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28942 compiler looks for a precompiled header in each directory just before it
28943 looks for the include file in that directory.  The name searched for is
28944 the name specified in the @code{#include} with @samp{.gch} appended.  If
28945 the precompiled header file cannot be used, it is ignored.
28947 For instance, if you have @code{#include "all.h"}, and you have
28948 @file{all.h.gch} in the same directory as @file{all.h}, then the
28949 precompiled header file is used if possible, and the original
28950 header is used otherwise.
28952 Alternatively, you might decide to put the precompiled header file in a
28953 directory and use @option{-I} to ensure that directory is searched
28954 before (or instead of) the directory containing the original header.
28955 Then, if you want to check that the precompiled header file is always
28956 used, you can put a file of the same name as the original header in this
28957 directory containing an @code{#error} command.
28959 This also works with @option{-include}.  So yet another way to use
28960 precompiled headers, good for projects not designed with precompiled
28961 header files in mind, is to simply take most of the header files used by
28962 a project, include them from another header file, precompile that header
28963 file, and @option{-include} the precompiled header.  If the header files
28964 have guards against multiple inclusion, they are skipped because
28965 they've already been included (in the precompiled header).
28967 If you need to precompile the same header file for different
28968 languages, targets, or compiler options, you can instead make a
28969 @emph{directory} named like @file{all.h.gch}, and put each precompiled
28970 header in the directory, perhaps using @option{-o}.  It doesn't matter
28971 what you call the files in the directory; every precompiled header in
28972 the directory is considered.  The first precompiled header
28973 encountered in the directory that is valid for this compilation is
28974 used; they're searched in no particular order.
28976 There are many other possibilities, limited only by your imagination,
28977 good sense, and the constraints of your build system.
28979 A precompiled header file can be used only when these conditions apply:
28981 @itemize
28982 @item
28983 Only one precompiled header can be used in a particular compilation.
28985 @item
28986 A precompiled header cannot be used once the first C token is seen.  You
28987 can have preprocessor directives before a precompiled header; you cannot
28988 include a precompiled header from inside another header.
28990 @item
28991 The precompiled header file must be produced for the same language as
28992 the current compilation.  You cannot use a C precompiled header for a C++
28993 compilation.
28995 @item
28996 The precompiled header file must have been produced by the same compiler
28997 binary as the current compilation is using.
28999 @item
29000 Any macros defined before the precompiled header is included must
29001 either be defined in the same way as when the precompiled header was
29002 generated, or must not affect the precompiled header, which usually
29003 means that they don't appear in the precompiled header at all.
29005 The @option{-D} option is one way to define a macro before a
29006 precompiled header is included; using a @code{#define} can also do it.
29007 There are also some options that define macros implicitly, like
29008 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29009 defined this way.
29011 @item If debugging information is output when using the precompiled
29012 header, using @option{-g} or similar, the same kind of debugging information
29013 must have been output when building the precompiled header.  However,
29014 a precompiled header built using @option{-g} can be used in a compilation
29015 when no debugging information is being output.
29017 @item The same @option{-m} options must generally be used when building
29018 and using the precompiled header.  @xref{Submodel Options},
29019 for any cases where this rule is relaxed.
29021 @item Each of the following options must be the same when building and using
29022 the precompiled header:
29024 @gccoptlist{-fexceptions}
29026 @item
29027 Some other command-line options starting with @option{-f},
29028 @option{-p}, or @option{-O} must be defined in the same way as when
29029 the precompiled header was generated.  At present, it's not clear
29030 which options are safe to change and which are not; the safest choice
29031 is to use exactly the same options when generating and using the
29032 precompiled header.  The following are known to be safe:
29034 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29035 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29036 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29037 -pedantic-errors}
29039 @end itemize
29041 For all of these except the last, the compiler automatically
29042 ignores the precompiled header if the conditions aren't met.  If you
29043 find an option combination that doesn't work and doesn't cause the
29044 precompiled header to be ignored, please consider filing a bug report,
29045 see @ref{Bugs}.
29047 If you do use differing options when generating and using the
29048 precompiled header, the actual behavior is a mixture of the
29049 behavior for the options.  For instance, if you use @option{-g} to
29050 generate the precompiled header but not when using it, you may or may
29051 not get debugging information for routines in the precompiled header.