gcc/ChangeLog:
[official-gcc.git] / gcc / doc / invoke.texi
blob52ba3d4cdb09ac21e6b4018e49d850b7ee9ac74b
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -ffile-prefix-map=@var{old}=@var{new}  @gol
176 -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
177 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
179 @item C Language Options
180 @xref{C Dialect Options,,Options Controlling C Dialect}.
181 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
182 -fpermitted-flt-eval-methods=@var{standard} @gol
183 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
184 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
185 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
186 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
187 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
188 -fsigned-bitfields  -fsigned-char @gol
189 -funsigned-bitfields  -funsigned-char}
191 @item C++ Language Options
192 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
193 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
194 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
195 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
196 -ffriend-injection @gol
197 -fno-elide-constructors @gol
198 -fno-enforce-eh-specs @gol
199 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
200 -fno-implicit-templates @gol
201 -fno-implicit-inline-templates @gol
202 -fno-implement-inlines  -fms-extensions @gol
203 -fnew-inheriting-ctors @gol
204 -fnew-ttp-matching @gol
205 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
206 -fno-optional-diags  -fpermissive @gol
207 -fno-pretty-templates @gol
208 -frepo  -fno-rtti  -fsized-deallocation @gol
209 -ftemplate-backtrace-limit=@var{n} @gol
210 -ftemplate-depth=@var{n} @gol
211 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
212 -fno-weak  -nostdinc++ @gol
213 -fvisibility-inlines-hidden @gol
214 -fvisibility-ms-compat @gol
215 -fext-numeric-literals @gol
216 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
217 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
218 -Wnamespaces  -Wnarrowing @gol
219 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
220 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
221 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
222 -Wno-non-template-friend  -Wold-style-cast @gol
223 -Woverloaded-virtual  -Wno-pmf-conversions @gol
224 -Wsign-promo  -Wvirtual-inheritance}
226 @item Objective-C and Objective-C++ Language Options
227 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
228 Objective-C and Objective-C++ Dialects}.
229 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
230 -fgnu-runtime  -fnext-runtime @gol
231 -fno-nil-receivers @gol
232 -fobjc-abi-version=@var{n} @gol
233 -fobjc-call-cxx-cdtors @gol
234 -fobjc-direct-dispatch @gol
235 -fobjc-exceptions @gol
236 -fobjc-gc @gol
237 -fobjc-nilcheck @gol
238 -fobjc-std=objc1 @gol
239 -fno-local-ivars @gol
240 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
241 -freplace-objc-classes @gol
242 -fzero-link @gol
243 -gen-decls @gol
244 -Wassign-intercept @gol
245 -Wno-protocol  -Wselector @gol
246 -Wstrict-selector-match @gol
247 -Wundeclared-selector}
249 @item Diagnostic Message Formatting Options
250 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
251 @gccoptlist{-fmessage-length=@var{n}  @gol
252 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
253 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
254 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
255 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
256 -fdiagnostics-show-template-tree -fno-elide-type @gol
257 -fno-show-column}
259 @item Warning Options
260 @xref{Warning Options,,Options to Request or Suppress Warnings}.
261 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
262 -pedantic-errors @gol
263 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
264 -Walloc-zero  -Walloc-size-larger-than=@var{n}
265 -Walloca  -Walloca-larger-than=@var{n} @gol
266 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
267 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
268 -Wno-builtin-declaration-mismatch @gol
269 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
270 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
271 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
272 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
273 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
274 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
275 -Wdelete-incomplete @gol
276 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
277 -Wdisabled-optimization @gol
278 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
279 -Wno-div-by-zero  -Wdouble-promotion @gol
280 -Wduplicated-branches  -Wduplicated-cond @gol
281 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
282 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
283 -Wfloat-equal  -Wformat  -Wformat=2 @gol
284 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
285 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
286 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
287 -Wformat-y2k  -Wframe-address @gol
288 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
289 -Wif-not-aligned @gol
290 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
291 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
292 -Wimplicit-function-declaration  -Wimplicit-int @gol
293 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
294 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
295 -Winvalid-pch  -Wlarger-than=@var{len} @gol
296 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
297 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
298 -Wmisleading-indentation  -Wmissing-attributes -Wmissing-braces @gol
299 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
300 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
301 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
302 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
303 -Woverride-init-side-effects  -Woverlength-strings @gol
304 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
305 -Wparentheses  -Wno-pedantic-ms-format @gol
306 -Wplacement-new  -Wplacement-new=@var{n} @gol
307 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
308 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
309 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
310 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
311 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
312 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
313 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
314 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
315 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
316 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
317 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
318 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
319 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
320 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
321 -Wmissing-format-attribute  -Wsubobject-linkage @gol
322 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
323 -Wswitch-unreachable  -Wsync-nand @gol
324 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
325 -Wtype-limits  -Wundef @gol
326 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
327 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
328 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
329 -Wunused-parameter  -Wno-unused-result @gol
330 -Wunused-value  -Wunused-variable @gol
331 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
332 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
333 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
334 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
335 -Wzero-as-null-pointer-constant  -Whsa}
337 @item C and Objective-C-only Warning Options
338 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
339 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
340 -Wold-style-declaration  -Wold-style-definition @gol
341 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
342 -Wdeclaration-after-statement  -Wpointer-sign}
344 @item Debugging Options
345 @xref{Debugging Options,,Options for Debugging Your Program}.
346 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
347 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
348 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
349 -gas-loc-support  -gno-as-loc-support @gol
350 -gas-locview-support  -gno-as-locview-support @gol
351 -gcolumn-info  -gno-column-info @gol
352 -gstatement-frontiers  -gno-statement-frontiers @gol
353 -gvariable-location-views  -gno-variable-location-views @gol
354 -ginternal-reset-location-views  -gno-internal-reset-location-views @gol
355 -ginline-points  -gno-inline-points @gol
356 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
357 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
358 -fno-eliminate-unused-debug-types @gol
359 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
360 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
361 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
362 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
363 -fvar-tracking  -fvar-tracking-assignments}
365 @item Optimization Options
366 @xref{Optimize Options,,Options that Control Optimization}.
367 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
368 -falign-jumps[=@var{n}] @gol
369 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
370 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
371 -fauto-inc-dec  -fbranch-probabilities @gol
372 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
373 -fbtr-bb-exclusive  -fcaller-saves @gol
374 -fcombine-stack-adjustments  -fconserve-stack @gol
375 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
376 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
377 -fcx-limited-range @gol
378 -fdata-sections  -fdce  -fdelayed-branch @gol
379 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
380 -fdevirtualize-at-ltrans  -fdse @gol
381 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
382 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
383 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
384 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
385 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
386 -fif-conversion2  -findirect-inlining @gol
387 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
388 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
389 -fipa-bit-cp -fipa-vrp @gol
390 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
391 -fira-algorithm=@var{algorithm} @gol
392 -fira-region=@var{region}  -fira-hoist-pressure @gol
393 -fira-loop-pressure  -fno-ira-share-save-slots @gol
394 -fno-ira-share-spill-slots @gol
395 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
396 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
397 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
398 -floop-block  -floop-interchange  -floop-strip-mine @gol
399 -floop-unroll-and-jam  -floop-nest-optimize @gol
400 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
401 -flto-partition=@var{alg}  -fmerge-all-constants @gol
402 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
403 -fmove-loop-invariants  -fno-branch-count-reg @gol
404 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
405 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
406 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
407 -fno-sched-spec  -fno-signed-zeros @gol
408 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
409 -fomit-frame-pointer  -foptimize-sibling-calls @gol
410 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
411 -fprefetch-loop-arrays @gol
412 -fprofile-correction @gol
413 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
414 -fprofile-reorder-functions @gol
415 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
416 -freorder-blocks-algorithm=@var{algorithm} @gol
417 -freorder-blocks-and-partition  -freorder-functions @gol
418 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
419 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
420 -fsched-spec-load  -fsched-spec-load-dangerous @gol
421 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
422 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
423 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
424 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
425 -fschedule-fusion @gol
426 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
427 -fselective-scheduling  -fselective-scheduling2 @gol
428 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
429 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
430 -fsignaling-nans @gol
431 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
432 -fsplit-paths @gol
433 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
434 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
435 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
436 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
437 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
438 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
439 -ftree-loop-if-convert  -ftree-loop-im @gol
440 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
441 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
442 -ftree-loop-vectorize @gol
443 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
444 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
445 -ftree-switch-conversion  -ftree-tail-merge @gol
446 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
447 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
448 -funsafe-math-optimizations  -funswitch-loops @gol
449 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
450 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
451 --param @var{name}=@var{value}
452 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
454 @item Program Instrumentation Options
455 @xref{Instrumentation Options,,Program Instrumentation Options}.
456 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
457 -fprofile-abs-path @gol
458 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
459 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
460 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
461 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
462 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
463 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
464 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
465 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
466 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
467 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
468 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
469 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
470 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
471 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
472 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
473 -fstack-protector-explicit  -fstack-check @gol
474 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
475 -fno-stack-limit  -fsplit-stack @gol
476 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
477 -fvtv-counts  -fvtv-debug @gol
478 -finstrument-functions @gol
479 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
480 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
482 @item Preprocessor Options
483 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
484 @gccoptlist{-A@var{question}=@var{answer} @gol
485 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
486 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
487 -dD  -dI  -dM  -dN  -dU @gol
488 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
489 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
490 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
491 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
492 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
493 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
494 -H  -imacros @var{file}  -include @var{file} @gol
495 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
496 -no-integrated-cpp  -P  -pthread  -remap @gol
497 -traditional  -traditional-cpp  -trigraphs @gol
498 -U@var{macro}  -undef  @gol
499 -Wp,@var{option}  -Xpreprocessor @var{option}}
501 @item Assembler Options
502 @xref{Assembler Options,,Passing Options to the Assembler}.
503 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
505 @item Linker Options
506 @xref{Link Options,,Options for Linking}.
507 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
508 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
509 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
510 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
511 -static-libmpx  -static-libmpxwrappers @gol
512 -shared  -shared-libgcc  -symbolic @gol
513 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
514 -u @var{symbol}  -z @var{keyword}}
516 @item Directory Options
517 @xref{Directory Options,,Options for Directory Search}.
518 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
519 -idirafter @var{dir} @gol
520 -imacros @var{file}  -imultilib @var{dir} @gol
521 -iplugindir=@var{dir}  -iprefix @var{file} @gol
522 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
523 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
524 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
525 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
527 @item Code Generation Options
528 @xref{Code Gen Options,,Options for Code Generation Conventions}.
529 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
530 -ffixed-@var{reg}  -fexceptions @gol
531 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
532 -fasynchronous-unwind-tables @gol
533 -fno-gnu-unique @gol
534 -finhibit-size-directive  -fno-common  -fno-ident @gol
535 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
536 -fno-jump-tables @gol
537 -frecord-gcc-switches @gol
538 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
539 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
540 -fleading-underscore  -ftls-model=@var{model} @gol
541 -fstack-reuse=@var{reuse_level} @gol
542 -ftrampolines  -ftrapv  -fwrapv @gol
543 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
544 -fstrict-volatile-bitfields  -fsync-libcalls}
546 @item Developer Options
547 @xref{Developer Options,,GCC Developer Options}.
548 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
549 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
550 -fdbg-cnt=@var{counter-value-list} @gol
551 -fdisable-ipa-@var{pass_name} @gol
552 -fdisable-rtl-@var{pass_name} @gol
553 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
554 -fdisable-tree-@var{pass_name} @gol
555 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
556 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
557 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
558 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
559 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
560 -fdump-lang-all @gol
561 -fdump-lang-@var{switch} @gol
562 -fdump-lang-@var{switch}-@var{options} @gol
563 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
564 -fdump-passes @gol
565 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
566 -fdump-statistics @gol
567 -fdump-tree-all @gol
568 -fdump-tree-@var{switch} @gol
569 -fdump-tree-@var{switch}-@var{options} @gol
570 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
571 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
572 -fenable-@var{kind}-@var{pass} @gol
573 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
574 -fira-verbose=@var{n} @gol
575 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
576 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
577 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
578 -fprofile-report @gol
579 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
580 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
581 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
582 -fvar-tracking-assignments-toggle  -gtoggle @gol
583 -print-file-name=@var{library}  -print-libgcc-file-name @gol
584 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
585 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
586 -print-sysroot  -print-sysroot-headers-suffix @gol
587 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
589 @item Machine-Dependent Options
590 @xref{Submodel Options,,Machine-Dependent Options}.
591 @c This list is ordered alphanumerically by subsection name.
592 @c Try and put the significant identifier (CPU or system) first,
593 @c so users have a clue at guessing where the ones they want will be.
595 @emph{AArch64 Options}
596 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
597 -mgeneral-regs-only @gol
598 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
599 -mstrict-align @gol
600 -momit-leaf-frame-pointer @gol
601 -mtls-dialect=desc  -mtls-dialect=traditional @gol
602 -mtls-size=@var{size} @gol
603 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
604 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
605 -mpc-relative-literal-loads @gol
606 -msign-return-address=@var{scope} @gol
607 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
608 -moverride=@var{string}  -mverbose-cost-dump}
610 @emph{Adapteva Epiphany Options}
611 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
612 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
613 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
614 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
615 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
616 -msplit-vecmove-early  -m1reg-@var{reg}}
618 @emph{ARC Options}
619 @gccoptlist{-mbarrel-shifter -mjli-always @gol
620 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
621 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
622 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
623 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
624 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
625 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
626 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
627 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
628 -mvolatile-cache  -mtp-regno=@var{regno} @gol
629 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
630 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
631 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
632 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
633 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
634 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
635 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
636 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16}
638 @emph{ARM Options}
639 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
640 -mabi=@var{name} @gol
641 -mapcs-stack-check  -mno-apcs-stack-check @gol
642 -mapcs-reentrant  -mno-apcs-reentrant @gol
643 -msched-prolog  -mno-sched-prolog @gol
644 -mlittle-endian  -mbig-endian @gol
645 -mbe8 -mbe32 @gol
646 -mfloat-abi=@var{name} @gol
647 -mfp16-format=@var{name}
648 -mthumb-interwork  -mno-thumb-interwork @gol
649 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
650 -mtune=@var{name}  -mprint-tune-info @gol
651 -mstructure-size-boundary=@var{n} @gol
652 -mabort-on-noreturn @gol
653 -mlong-calls  -mno-long-calls @gol
654 -msingle-pic-base  -mno-single-pic-base @gol
655 -mpic-register=@var{reg} @gol
656 -mnop-fun-dllimport @gol
657 -mpoke-function-name @gol
658 -mthumb  -marm  -mflip-thumb @gol
659 -mtpcs-frame  -mtpcs-leaf-frame @gol
660 -mcaller-super-interworking  -mcallee-super-interworking @gol
661 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
662 -mword-relocations @gol
663 -mfix-cortex-m3-ldrd @gol
664 -munaligned-access @gol
665 -mneon-for-64bits @gol
666 -mslow-flash-data @gol
667 -masm-syntax-unified @gol
668 -mrestrict-it @gol
669 -mverbose-cost-dump @gol
670 -mpure-code @gol
671 -mcmse}
673 @emph{AVR Options}
674 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
675 -mbranch-cost=@var{cost} @gol
676 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
677 -mn_flash=@var{size}  -mno-interrupts @gol
678 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
679 -mfract-convert-truncate @gol
680 -mshort-calls  -nodevicelib @gol
681 -Waddr-space-convert  -Wmisspelled-isr}
683 @emph{Blackfin Options}
684 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
685 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
686 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
687 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
688 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
689 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
690 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
691 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
692 -micplb}
694 @emph{C6X Options}
695 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
696 -msim  -msdata=@var{sdata-type}}
698 @emph{CRIS Options}
699 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
700 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
701 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
702 -mstack-align  -mdata-align  -mconst-align @gol
703 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
704 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
705 -mmul-bug-workaround  -mno-mul-bug-workaround}
707 @emph{CR16 Options}
708 @gccoptlist{-mmac @gol
709 -mcr16cplus  -mcr16c @gol
710 -msim  -mint32  -mbit-ops
711 -mdata-model=@var{model}}
713 @emph{Darwin Options}
714 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
715 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
716 -client_name  -compatibility_version  -current_version @gol
717 -dead_strip @gol
718 -dependency-file  -dylib_file  -dylinker_install_name @gol
719 -dynamic  -dynamiclib  -exported_symbols_list @gol
720 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
721 -force_flat_namespace  -headerpad_max_install_names @gol
722 -iframework @gol
723 -image_base  -init  -install_name  -keep_private_externs @gol
724 -multi_module  -multiply_defined  -multiply_defined_unused @gol
725 -noall_load   -no_dead_strip_inits_and_terms @gol
726 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
727 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
728 -private_bundle  -read_only_relocs  -sectalign @gol
729 -sectobjectsymbols  -whyload  -seg1addr @gol
730 -sectcreate  -sectobjectsymbols  -sectorder @gol
731 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
732 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
733 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
734 -single_module  -static  -sub_library  -sub_umbrella @gol
735 -twolevel_namespace  -umbrella  -undefined @gol
736 -unexported_symbols_list  -weak_reference_mismatches @gol
737 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
738 -mkernel  -mone-byte-bool}
740 @emph{DEC Alpha Options}
741 @gccoptlist{-mno-fp-regs  -msoft-float @gol
742 -mieee  -mieee-with-inexact  -mieee-conformant @gol
743 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
744 -mtrap-precision=@var{mode}  -mbuild-constants @gol
745 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
746 -mbwx  -mmax  -mfix  -mcix @gol
747 -mfloat-vax  -mfloat-ieee @gol
748 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
749 -msmall-text  -mlarge-text @gol
750 -mmemory-latency=@var{time}}
752 @emph{FR30 Options}
753 @gccoptlist{-msmall-model  -mno-lsim}
755 @emph{FT32 Options}
756 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
758 @emph{FRV Options}
759 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
760 -mhard-float  -msoft-float @gol
761 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
762 -mdouble  -mno-double @gol
763 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
764 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
765 -mlinked-fp  -mlong-calls  -malign-labels @gol
766 -mlibrary-pic  -macc-4  -macc-8 @gol
767 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
768 -moptimize-membar  -mno-optimize-membar @gol
769 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
770 -mvliw-branch  -mno-vliw-branch @gol
771 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
772 -mno-nested-cond-exec  -mtomcat-stats @gol
773 -mTLS  -mtls @gol
774 -mcpu=@var{cpu}}
776 @emph{GNU/Linux Options}
777 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
778 -tno-android-cc  -tno-android-ld}
780 @emph{H8/300 Options}
781 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
783 @emph{HPPA Options}
784 @gccoptlist{-march=@var{architecture-type} @gol
785 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
786 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
787 -mfixed-range=@var{register-range} @gol
788 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
789 -mlong-load-store  -mno-disable-fpregs @gol
790 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
791 -mno-jump-in-delay  -mno-long-load-store @gol
792 -mno-portable-runtime  -mno-soft-float @gol
793 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
794 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
795 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
796 -munix=@var{unix-std}  -nolibdld  -static  -threads}
798 @emph{IA-64 Options}
799 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
800 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
801 -mconstant-gp  -mauto-pic  -mfused-madd @gol
802 -minline-float-divide-min-latency @gol
803 -minline-float-divide-max-throughput @gol
804 -mno-inline-float-divide @gol
805 -minline-int-divide-min-latency @gol
806 -minline-int-divide-max-throughput  @gol
807 -mno-inline-int-divide @gol
808 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
809 -mno-inline-sqrt @gol
810 -mdwarf2-asm  -mearly-stop-bits @gol
811 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
812 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
813 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
814 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
815 -msched-spec-ldc  -msched-spec-control-ldc @gol
816 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
817 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
818 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
819 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
821 @emph{LM32 Options}
822 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
823 -msign-extend-enabled  -muser-enabled}
825 @emph{M32R/D Options}
826 @gccoptlist{-m32r2  -m32rx  -m32r @gol
827 -mdebug @gol
828 -malign-loops  -mno-align-loops @gol
829 -missue-rate=@var{number} @gol
830 -mbranch-cost=@var{number} @gol
831 -mmodel=@var{code-size-model-type} @gol
832 -msdata=@var{sdata-type} @gol
833 -mno-flush-func  -mflush-func=@var{name} @gol
834 -mno-flush-trap  -mflush-trap=@var{number} @gol
835 -G @var{num}}
837 @emph{M32C Options}
838 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
840 @emph{M680x0 Options}
841 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
842 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
843 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
844 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
845 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
846 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
847 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
848 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
849 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
851 @emph{MCore Options}
852 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
853 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
854 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
855 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
856 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
858 @emph{MeP Options}
859 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
860 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
861 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
862 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
863 -mtiny=@var{n}}
865 @emph{MicroBlaze Options}
866 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
867 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
868 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
869 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
870 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
872 @emph{MIPS Options}
873 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
874 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
875 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
876 -mips16  -mno-mips16  -mflip-mips16 @gol
877 -minterlink-compressed  -mno-interlink-compressed @gol
878 -minterlink-mips16  -mno-interlink-mips16 @gol
879 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
880 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
881 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
882 -mno-float  -msingle-float  -mdouble-float @gol
883 -modd-spreg  -mno-odd-spreg @gol
884 -mabs=@var{mode}  -mnan=@var{encoding} @gol
885 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
886 -mmcu  -mmno-mcu @gol
887 -meva  -mno-eva @gol
888 -mvirt  -mno-virt @gol
889 -mxpa  -mno-xpa @gol
890 -mmicromips  -mno-micromips @gol
891 -mmsa  -mno-msa @gol
892 -mfpu=@var{fpu-type} @gol
893 -msmartmips  -mno-smartmips @gol
894 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
895 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
896 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
897 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
898 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
899 -membedded-data  -mno-embedded-data @gol
900 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
901 -mcode-readable=@var{setting} @gol
902 -msplit-addresses  -mno-split-addresses @gol
903 -mexplicit-relocs  -mno-explicit-relocs @gol
904 -mcheck-zero-division  -mno-check-zero-division @gol
905 -mdivide-traps  -mdivide-breaks @gol
906 -mload-store-pairs  -mno-load-store-pairs @gol
907 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
908 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
909 -mfix-24k  -mno-fix-24k @gol
910 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
911 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
912 -mfix-vr4120  -mno-fix-vr4120 @gol
913 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
914 -mflush-func=@var{func}  -mno-flush-func @gol
915 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
916 -mcompact-branches=@var{policy} @gol
917 -mfp-exceptions  -mno-fp-exceptions @gol
918 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
919 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
920 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
921 -mframe-header-opt  -mno-frame-header-opt}
923 @emph{MMIX Options}
924 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
925 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
926 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
927 -mno-base-addresses  -msingle-exit  -mno-single-exit}
929 @emph{MN10300 Options}
930 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
931 -mno-am33  -mam33  -mam33-2  -mam34 @gol
932 -mtune=@var{cpu-type} @gol
933 -mreturn-pointer-on-d0 @gol
934 -mno-crt0  -mrelax  -mliw  -msetlb}
936 @emph{Moxie Options}
937 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
939 @emph{MSP430 Options}
940 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
941 -mwarn-mcu @gol
942 -mcode-region=  -mdata-region= @gol
943 -msilicon-errata=  -msilicon-errata-warn= @gol
944 -mhwmult=  -minrt}
946 @emph{NDS32 Options}
947 @gccoptlist{-mbig-endian  -mlittle-endian @gol
948 -mreduced-regs  -mfull-regs @gol
949 -mcmov  -mno-cmov @gol
950 -mext-perf  -mno-ext-perf @gol
951 -mext-perf2  -mno-ext-perf2 @gol
952 -mext-string  -mno-ext-string @gol
953 -mv3push  -mno-v3push @gol
954 -m16bit  -mno-16bit @gol
955 -misr-vector-size=@var{num} @gol
956 -mcache-block-size=@var{num} @gol
957 -march=@var{arch} @gol
958 -mcmodel=@var{code-model} @gol
959 -mctor-dtor  -mrelax}
961 @emph{Nios II Options}
962 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
963 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
964 -mel  -meb @gol
965 -mno-bypass-cache  -mbypass-cache @gol
966 -mno-cache-volatile  -mcache-volatile @gol
967 -mno-fast-sw-div  -mfast-sw-div @gol
968 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
969 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
970 -mcustom-fpu-cfg=@var{name} @gol
971 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
972 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
974 @emph{Nvidia PTX Options}
975 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
977 @emph{PDP-11 Options}
978 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
979 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
980 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
981 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
982 -mbranch-expensive  -mbranch-cheap @gol
983 -munix-asm  -mdec-asm}
985 @emph{picoChip Options}
986 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
987 -msymbol-as-address  -mno-inefficient-warnings}
989 @emph{PowerPC Options}
990 See RS/6000 and PowerPC Options.
992 @emph{PowerPC SPE Options}
993 @gccoptlist{-mcpu=@var{cpu-type} @gol
994 -mtune=@var{cpu-type} @gol
995 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
996 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
997 -m32  -mxl-compat  -mno-xl-compat @gol
998 -malign-power  -malign-natural @gol
999 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1000 -msingle-float  -mdouble-float @gol
1001 -mupdate  -mno-update @gol
1002 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1003 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1004 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1005 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1006 -msingle-pic-base @gol
1007 -mprioritize-restricted-insns=@var{priority} @gol
1008 -msched-costly-dep=@var{dependence_type} @gol
1009 -minsert-sched-nops=@var{scheme} @gol
1010 -mcall-sysv  -mcall-netbsd @gol
1011 -maix-struct-return  -msvr4-struct-return @gol
1012 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1013 -mblock-move-inline-limit=@var{num} @gol
1014 -misel  -mno-isel @gol
1015 -misel=yes  -misel=no @gol
1016 -mspe  -mno-spe @gol
1017 -mspe=yes  -mspe=no @gol
1018 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1019 -mprototype  -mno-prototype @gol
1020 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1021 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1022 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1023 -mno-recip-precision @gol
1024 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1025 -msave-toc-indirect  -mno-save-toc-indirect @gol
1026 -mcompat-align-parm  -mno-compat-align-parm @gol
1027 -mfloat128  -mno-float128 @gol
1028 -mgnu-attribute  -mno-gnu-attribute @gol
1029 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1030 -mstack-protector-guard-offset=@var{offset}}
1032 @emph{RISC-V Options}
1033 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1034 -mplt  -mno-plt @gol
1035 -mabi=@var{ABI-string} @gol
1036 -mfdiv  -mno-fdiv @gol
1037 -mdiv  -mno-div @gol
1038 -march=@var{ISA-string} @gol
1039 -mtune=@var{processor-string} @gol
1040 -mpreferred-stack-boundary=@var{num} @gol
1041 -msmall-data-limit=@var{N-bytes} @gol
1042 -msave-restore  -mno-save-restore @gol
1043 -mstrict-align -mno-strict-align @gol
1044 -mcmodel=medlow -mcmodel=medany @gol
1045 -mexplicit-relocs  -mno-explicit-relocs @gol
1046 -mrelax -mno-relax @gol}
1048 @emph{RL78 Options}
1049 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1050 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1051 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1053 @emph{RS/6000 and PowerPC Options}
1054 @gccoptlist{-mcpu=@var{cpu-type} @gol
1055 -mtune=@var{cpu-type} @gol
1056 -mcmodel=@var{code-model} @gol
1057 -mpowerpc64 @gol
1058 -maltivec  -mno-altivec @gol
1059 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1060 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1061 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1062 -mfprnd  -mno-fprnd @gol
1063 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1064 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1065 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1066 -malign-power  -malign-natural @gol
1067 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1068 -msingle-float  -mdouble-float  -msimple-fpu @gol
1069 -mupdate  -mno-update @gol
1070 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1071 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1072 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1073 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1074 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1075 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1076 -mprioritize-restricted-insns=@var{priority} @gol
1077 -msched-costly-dep=@var{dependence_type} @gol
1078 -minsert-sched-nops=@var{scheme} @gol
1079 -mcall-sysv  -mcall-netbsd @gol
1080 -maix-struct-return  -msvr4-struct-return @gol
1081 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1082 -mblock-move-inline-limit=@var{num} @gol
1083 -misel  -mno-isel @gol
1084 -misel=yes  -misel=no @gol
1085 -mpaired @gol
1086 -mvrsave  -mno-vrsave @gol
1087 -mmulhw  -mno-mulhw @gol
1088 -mdlmzb  -mno-dlmzb @gol
1089 -mprototype  -mno-prototype @gol
1090 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1091 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1092 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1093 -mno-recip-precision @gol
1094 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1095 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1096 -msave-toc-indirect  -mno-save-toc-indirect @gol
1097 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1098 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1099 -mquad-memory  -mno-quad-memory @gol
1100 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1101 -mcompat-align-parm  -mno-compat-align-parm @gol
1102 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1103 -mgnu-attribute  -mno-gnu-attribute @gol
1104 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1105 -mstack-protector-guard-offset=@var{offset}}
1107 @emph{RX Options}
1108 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1109 -mcpu=@gol
1110 -mbig-endian-data  -mlittle-endian-data @gol
1111 -msmall-data @gol
1112 -msim  -mno-sim@gol
1113 -mas100-syntax  -mno-as100-syntax@gol
1114 -mrelax@gol
1115 -mmax-constant-size=@gol
1116 -mint-register=@gol
1117 -mpid@gol
1118 -mallow-string-insns  -mno-allow-string-insns@gol
1119 -mjsr@gol
1120 -mno-warn-multiple-fast-interrupts@gol
1121 -msave-acc-in-interrupts}
1123 @emph{S/390 and zSeries Options}
1124 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1125 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1126 -mlong-double-64  -mlong-double-128 @gol
1127 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1128 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1129 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1130 -mhtm  -mvx  -mzvector @gol
1131 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1132 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1133 -mhotpatch=@var{halfwords},@var{halfwords}}
1135 @emph{Score Options}
1136 @gccoptlist{-meb  -mel @gol
1137 -mnhwloop @gol
1138 -muls @gol
1139 -mmac @gol
1140 -mscore5  -mscore5u  -mscore7  -mscore7d}
1142 @emph{SH Options}
1143 @gccoptlist{-m1  -m2  -m2e @gol
1144 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1145 -m3  -m3e @gol
1146 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1147 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1148 -mb  -ml  -mdalign  -mrelax @gol
1149 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1150 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1151 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1152 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1153 -maccumulate-outgoing-args @gol
1154 -matomic-model=@var{atomic-model} @gol
1155 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1156 -mcbranch-force-delay-slot @gol
1157 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1158 -mpretend-cmove  -mtas}
1160 @emph{Solaris 2 Options}
1161 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1162 -pthreads}
1164 @emph{SPARC Options}
1165 @gccoptlist{-mcpu=@var{cpu-type} @gol
1166 -mtune=@var{cpu-type} @gol
1167 -mcmodel=@var{code-model} @gol
1168 -mmemory-model=@var{mem-model} @gol
1169 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1170 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1171 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1172 -mhard-quad-float  -msoft-quad-float @gol
1173 -mstack-bias  -mno-stack-bias @gol
1174 -mstd-struct-return  -mno-std-struct-return @gol
1175 -munaligned-doubles  -mno-unaligned-doubles @gol
1176 -muser-mode  -mno-user-mode @gol
1177 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1178 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1179 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1180 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1181 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1182 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1183 -mlra  -mno-lra}
1185 @emph{SPU Options}
1186 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1187 -msafe-dma  -munsafe-dma @gol
1188 -mbranch-hints @gol
1189 -msmall-mem  -mlarge-mem  -mstdmain @gol
1190 -mfixed-range=@var{register-range} @gol
1191 -mea32  -mea64 @gol
1192 -maddress-space-conversion  -mno-address-space-conversion @gol
1193 -mcache-size=@var{cache-size} @gol
1194 -matomic-updates  -mno-atomic-updates}
1196 @emph{System V Options}
1197 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1199 @emph{TILE-Gx Options}
1200 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1201 -mcmodel=@var{code-model}}
1203 @emph{TILEPro Options}
1204 @gccoptlist{-mcpu=@var{cpu}  -m32}
1206 @emph{V850 Options}
1207 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1208 -mprolog-function  -mno-prolog-function  -mspace @gol
1209 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1210 -mapp-regs  -mno-app-regs @gol
1211 -mdisable-callt  -mno-disable-callt @gol
1212 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1213 -mv850e  -mv850  -mv850e3v5 @gol
1214 -mloop @gol
1215 -mrelax @gol
1216 -mlong-jumps @gol
1217 -msoft-float @gol
1218 -mhard-float @gol
1219 -mgcc-abi @gol
1220 -mrh850-abi @gol
1221 -mbig-switch}
1223 @emph{VAX Options}
1224 @gccoptlist{-mg  -mgnu  -munix}
1226 @emph{Visium Options}
1227 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1228 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1230 @emph{VMS Options}
1231 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1232 -mpointer-size=@var{size}}
1234 @emph{VxWorks Options}
1235 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1236 -Xbind-lazy  -Xbind-now}
1238 @emph{x86 Options}
1239 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1240 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1241 -mfpmath=@var{unit} @gol
1242 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1243 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1244 -mno-wide-multiply  -mrtd  -malign-double @gol
1245 -mpreferred-stack-boundary=@var{num} @gol
1246 -mincoming-stack-boundary=@var{num} @gol
1247 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1248 -mrecip  -mrecip=@var{opt} @gol
1249 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1250 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1251 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1252 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1253 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1254 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1255 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1256 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1257 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1258 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1259 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1260 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1261 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1262 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1263 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1264 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1265 -mregparm=@var{num}  -msseregparm @gol
1266 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1267 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1268 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1269 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1270 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1271 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1272 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1273 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1274 -mstack-protector-guard-reg=@var{reg} @gol
1275 -mstack-protector-guard-offset=@var{offset} @gol
1276 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1277 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1278 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1279 -mindirect-branch-register}
1281 @emph{x86 Windows Options}
1282 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1283 -mnop-fun-dllimport  -mthread @gol
1284 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1286 @emph{Xstormy16 Options}
1287 @gccoptlist{-msim}
1289 @emph{Xtensa Options}
1290 @gccoptlist{-mconst16  -mno-const16 @gol
1291 -mfused-madd  -mno-fused-madd @gol
1292 -mforce-no-pic @gol
1293 -mserialize-volatile  -mno-serialize-volatile @gol
1294 -mtext-section-literals  -mno-text-section-literals @gol
1295 -mauto-litpools  -mno-auto-litpools @gol
1296 -mtarget-align  -mno-target-align @gol
1297 -mlongcalls  -mno-longcalls}
1299 @emph{zSeries Options}
1300 See S/390 and zSeries Options.
1301 @end table
1304 @node Overall Options
1305 @section Options Controlling the Kind of Output
1307 Compilation can involve up to four stages: preprocessing, compilation
1308 proper, assembly and linking, always in that order.  GCC is capable of
1309 preprocessing and compiling several files either into several
1310 assembler input files, or into one assembler input file; then each
1311 assembler input file produces an object file, and linking combines all
1312 the object files (those newly compiled, and those specified as input)
1313 into an executable file.
1315 @cindex file name suffix
1316 For any given input file, the file name suffix determines what kind of
1317 compilation is done:
1319 @table @gcctabopt
1320 @item @var{file}.c
1321 C source code that must be preprocessed.
1323 @item @var{file}.i
1324 C source code that should not be preprocessed.
1326 @item @var{file}.ii
1327 C++ source code that should not be preprocessed.
1329 @item @var{file}.m
1330 Objective-C source code.  Note that you must link with the @file{libobjc}
1331 library to make an Objective-C program work.
1333 @item @var{file}.mi
1334 Objective-C source code that should not be preprocessed.
1336 @item @var{file}.mm
1337 @itemx @var{file}.M
1338 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1339 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1340 to a literal capital M@.
1342 @item @var{file}.mii
1343 Objective-C++ source code that should not be preprocessed.
1345 @item @var{file}.h
1346 C, C++, Objective-C or Objective-C++ header file to be turned into a
1347 precompiled header (default), or C, C++ header file to be turned into an
1348 Ada spec (via the @option{-fdump-ada-spec} switch).
1350 @item @var{file}.cc
1351 @itemx @var{file}.cp
1352 @itemx @var{file}.cxx
1353 @itemx @var{file}.cpp
1354 @itemx @var{file}.CPP
1355 @itemx @var{file}.c++
1356 @itemx @var{file}.C
1357 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1358 the last two letters must both be literally @samp{x}.  Likewise,
1359 @samp{.C} refers to a literal capital C@.
1361 @item @var{file}.mm
1362 @itemx @var{file}.M
1363 Objective-C++ source code that must be preprocessed.
1365 @item @var{file}.mii
1366 Objective-C++ source code that should not be preprocessed.
1368 @item @var{file}.hh
1369 @itemx @var{file}.H
1370 @itemx @var{file}.hp
1371 @itemx @var{file}.hxx
1372 @itemx @var{file}.hpp
1373 @itemx @var{file}.HPP
1374 @itemx @var{file}.h++
1375 @itemx @var{file}.tcc
1376 C++ header file to be turned into a precompiled header or Ada spec.
1378 @item @var{file}.f
1379 @itemx @var{file}.for
1380 @itemx @var{file}.ftn
1381 Fixed form Fortran source code that should not be preprocessed.
1383 @item @var{file}.F
1384 @itemx @var{file}.FOR
1385 @itemx @var{file}.fpp
1386 @itemx @var{file}.FPP
1387 @itemx @var{file}.FTN
1388 Fixed form Fortran source code that must be preprocessed (with the traditional
1389 preprocessor).
1391 @item @var{file}.f90
1392 @itemx @var{file}.f95
1393 @itemx @var{file}.f03
1394 @itemx @var{file}.f08
1395 Free form Fortran source code that should not be preprocessed.
1397 @item @var{file}.F90
1398 @itemx @var{file}.F95
1399 @itemx @var{file}.F03
1400 @itemx @var{file}.F08
1401 Free form Fortran source code that must be preprocessed (with the
1402 traditional preprocessor).
1404 @item @var{file}.go
1405 Go source code.
1407 @item @var{file}.brig
1408 BRIG files (binary representation of HSAIL).
1410 @item @var{file}.ads
1411 Ada source code file that contains a library unit declaration (a
1412 declaration of a package, subprogram, or generic, or a generic
1413 instantiation), or a library unit renaming declaration (a package,
1414 generic, or subprogram renaming declaration).  Such files are also
1415 called @dfn{specs}.
1417 @item @var{file}.adb
1418 Ada source code file containing a library unit body (a subprogram or
1419 package body).  Such files are also called @dfn{bodies}.
1421 @c GCC also knows about some suffixes for languages not yet included:
1422 @c Pascal:
1423 @c @var{file}.p
1424 @c @var{file}.pas
1425 @c Ratfor:
1426 @c @var{file}.r
1428 @item @var{file}.s
1429 Assembler code.
1431 @item @var{file}.S
1432 @itemx @var{file}.sx
1433 Assembler code that must be preprocessed.
1435 @item @var{other}
1436 An object file to be fed straight into linking.
1437 Any file name with no recognized suffix is treated this way.
1438 @end table
1440 @opindex x
1441 You can specify the input language explicitly with the @option{-x} option:
1443 @table @gcctabopt
1444 @item -x @var{language}
1445 Specify explicitly the @var{language} for the following input files
1446 (rather than letting the compiler choose a default based on the file
1447 name suffix).  This option applies to all following input files until
1448 the next @option{-x} option.  Possible values for @var{language} are:
1449 @smallexample
1450 c  c-header  cpp-output
1451 c++  c++-header  c++-cpp-output
1452 objective-c  objective-c-header  objective-c-cpp-output
1453 objective-c++ objective-c++-header objective-c++-cpp-output
1454 assembler  assembler-with-cpp
1456 f77  f77-cpp-input f95  f95-cpp-input
1458 brig
1459 @end smallexample
1461 @item -x none
1462 Turn off any specification of a language, so that subsequent files are
1463 handled according to their file name suffixes (as they are if @option{-x}
1464 has not been used at all).
1465 @end table
1467 If you only want some of the stages of compilation, you can use
1468 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1469 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1470 @command{gcc} is to stop.  Note that some combinations (for example,
1471 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1473 @table @gcctabopt
1474 @item -c
1475 @opindex c
1476 Compile or assemble the source files, but do not link.  The linking
1477 stage simply is not done.  The ultimate output is in the form of an
1478 object file for each source file.
1480 By default, the object file name for a source file is made by replacing
1481 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1483 Unrecognized input files, not requiring compilation or assembly, are
1484 ignored.
1486 @item -S
1487 @opindex S
1488 Stop after the stage of compilation proper; do not assemble.  The output
1489 is in the form of an assembler code file for each non-assembler input
1490 file specified.
1492 By default, the assembler file name for a source file is made by
1493 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1495 Input files that don't require compilation are ignored.
1497 @item -E
1498 @opindex E
1499 Stop after the preprocessing stage; do not run the compiler proper.  The
1500 output is in the form of preprocessed source code, which is sent to the
1501 standard output.
1503 Input files that don't require preprocessing are ignored.
1505 @cindex output file option
1506 @item -o @var{file}
1507 @opindex o
1508 Place output in file @var{file}.  This applies to whatever
1509 sort of output is being produced, whether it be an executable file,
1510 an object file, an assembler file or preprocessed C code.
1512 If @option{-o} is not specified, the default is to put an executable
1513 file in @file{a.out}, the object file for
1514 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1515 assembler file in @file{@var{source}.s}, a precompiled header file in
1516 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1517 standard output.
1519 @item -v
1520 @opindex v
1521 Print (on standard error output) the commands executed to run the stages
1522 of compilation.  Also print the version number of the compiler driver
1523 program and of the preprocessor and the compiler proper.
1525 @item -###
1526 @opindex ###
1527 Like @option{-v} except the commands are not executed and arguments
1528 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1529 This is useful for shell scripts to capture the driver-generated command lines.
1531 @item --help
1532 @opindex help
1533 Print (on the standard output) a description of the command-line options
1534 understood by @command{gcc}.  If the @option{-v} option is also specified
1535 then @option{--help} is also passed on to the various processes
1536 invoked by @command{gcc}, so that they can display the command-line options
1537 they accept.  If the @option{-Wextra} option has also been specified
1538 (prior to the @option{--help} option), then command-line options that
1539 have no documentation associated with them are also displayed.
1541 @item --target-help
1542 @opindex target-help
1543 Print (on the standard output) a description of target-specific command-line
1544 options for each tool.  For some targets extra target-specific
1545 information may also be printed.
1547 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1548 Print (on the standard output) a description of the command-line
1549 options understood by the compiler that fit into all specified classes
1550 and qualifiers.  These are the supported classes:
1552 @table @asis
1553 @item @samp{optimizers}
1554 Display all of the optimization options supported by the
1555 compiler.
1557 @item @samp{warnings}
1558 Display all of the options controlling warning messages
1559 produced by the compiler.
1561 @item @samp{target}
1562 Display target-specific options.  Unlike the
1563 @option{--target-help} option however, target-specific options of the
1564 linker and assembler are not displayed.  This is because those
1565 tools do not currently support the extended @option{--help=} syntax.
1567 @item @samp{params}
1568 Display the values recognized by the @option{--param}
1569 option.
1571 @item @var{language}
1572 Display the options supported for @var{language}, where
1573 @var{language} is the name of one of the languages supported in this
1574 version of GCC@.
1576 @item @samp{common}
1577 Display the options that are common to all languages.
1578 @end table
1580 These are the supported qualifiers:
1582 @table @asis
1583 @item @samp{undocumented}
1584 Display only those options that are undocumented.
1586 @item @samp{joined}
1587 Display options taking an argument that appears after an equal
1588 sign in the same continuous piece of text, such as:
1589 @samp{--help=target}.
1591 @item @samp{separate}
1592 Display options taking an argument that appears as a separate word
1593 following the original option, such as: @samp{-o output-file}.
1594 @end table
1596 Thus for example to display all the undocumented target-specific
1597 switches supported by the compiler, use:
1599 @smallexample
1600 --help=target,undocumented
1601 @end smallexample
1603 The sense of a qualifier can be inverted by prefixing it with the
1604 @samp{^} character, so for example to display all binary warning
1605 options (i.e., ones that are either on or off and that do not take an
1606 argument) that have a description, use:
1608 @smallexample
1609 --help=warnings,^joined,^undocumented
1610 @end smallexample
1612 The argument to @option{--help=} should not consist solely of inverted
1613 qualifiers.
1615 Combining several classes is possible, although this usually
1616 restricts the output so much that there is nothing to display.  One
1617 case where it does work, however, is when one of the classes is
1618 @var{target}.  For example, to display all the target-specific
1619 optimization options, use:
1621 @smallexample
1622 --help=target,optimizers
1623 @end smallexample
1625 The @option{--help=} option can be repeated on the command line.  Each
1626 successive use displays its requested class of options, skipping
1627 those that have already been displayed.
1629 If the @option{-Q} option appears on the command line before the
1630 @option{--help=} option, then the descriptive text displayed by
1631 @option{--help=} is changed.  Instead of describing the displayed
1632 options, an indication is given as to whether the option is enabled,
1633 disabled or set to a specific value (assuming that the compiler
1634 knows this at the point where the @option{--help=} option is used).
1636 Here is a truncated example from the ARM port of @command{gcc}:
1638 @smallexample
1639   % gcc -Q -mabi=2 --help=target -c
1640   The following options are target specific:
1641   -mabi=                                2
1642   -mabort-on-noreturn                   [disabled]
1643   -mapcs                                [disabled]
1644 @end smallexample
1646 The output is sensitive to the effects of previous command-line
1647 options, so for example it is possible to find out which optimizations
1648 are enabled at @option{-O2} by using:
1650 @smallexample
1651 -Q -O2 --help=optimizers
1652 @end smallexample
1654 Alternatively you can discover which binary optimizations are enabled
1655 by @option{-O3} by using:
1657 @smallexample
1658 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1659 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1660 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1661 @end smallexample
1663 @item --version
1664 @opindex version
1665 Display the version number and copyrights of the invoked GCC@.
1667 @item -pass-exit-codes
1668 @opindex pass-exit-codes
1669 Normally the @command{gcc} program exits with the code of 1 if any
1670 phase of the compiler returns a non-success return code.  If you specify
1671 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1672 the numerically highest error produced by any phase returning an error
1673 indication.  The C, C++, and Fortran front ends return 4 if an internal
1674 compiler error is encountered.
1676 @item -pipe
1677 @opindex pipe
1678 Use pipes rather than temporary files for communication between the
1679 various stages of compilation.  This fails to work on some systems where
1680 the assembler is unable to read from a pipe; but the GNU assembler has
1681 no trouble.
1683 @item -specs=@var{file}
1684 @opindex specs
1685 Process @var{file} after the compiler reads in the standard @file{specs}
1686 file, in order to override the defaults which the @command{gcc} driver
1687 program uses when determining what switches to pass to @command{cc1},
1688 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1689 @option{-specs=@var{file}} can be specified on the command line, and they
1690 are processed in order, from left to right.  @xref{Spec Files}, for
1691 information about the format of the @var{file}.
1693 @item -wrapper
1694 @opindex wrapper
1695 Invoke all subcommands under a wrapper program.  The name of the
1696 wrapper program and its parameters are passed as a comma separated
1697 list.
1699 @smallexample
1700 gcc -c t.c -wrapper gdb,--args
1701 @end smallexample
1703 @noindent
1704 This invokes all subprograms of @command{gcc} under
1705 @samp{gdb --args}, thus the invocation of @command{cc1} is
1706 @samp{gdb --args cc1 @dots{}}.
1708 @item -ffile-prefix-map=@var{old}=@var{new}
1709 @opindex ffile-prefix-map
1710 When compiling files residing in directory @file{@var{old}}, record
1711 any references to them in the result of the compilation as if the
1712 files resided in directory @file{@var{new}} instead.  Specifying this
1713 option is equivalent to specifying all the individual
1714 @option{-f*-prefix-map} options.  This can be used to make reproducible
1715 builds that are location independent.  See also
1716 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1718 @item -fplugin=@var{name}.so
1719 @opindex fplugin
1720 Load the plugin code in file @var{name}.so, assumed to be a
1721 shared object to be dlopen'd by the compiler.  The base name of
1722 the shared object file is used to identify the plugin for the
1723 purposes of argument parsing (See
1724 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1725 Each plugin should define the callback functions specified in the
1726 Plugins API.
1728 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1729 @opindex fplugin-arg
1730 Define an argument called @var{key} with a value of @var{value}
1731 for the plugin called @var{name}.
1733 @item -fdump-ada-spec@r{[}-slim@r{]}
1734 @opindex fdump-ada-spec
1735 For C and C++ source and include files, generate corresponding Ada specs.
1736 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1737 GNAT User's Guide}, which provides detailed documentation on this feature.
1739 @item -fada-spec-parent=@var{unit}
1740 @opindex fada-spec-parent
1741 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1742 Ada specs as child units of parent @var{unit}.
1744 @item -fdump-go-spec=@var{file}
1745 @opindex fdump-go-spec
1746 For input files in any language, generate corresponding Go
1747 declarations in @var{file}.  This generates Go @code{const},
1748 @code{type}, @code{var}, and @code{func} declarations which may be a
1749 useful way to start writing a Go interface to code written in some
1750 other language.
1752 @include @value{srcdir}/../libiberty/at-file.texi
1753 @end table
1755 @node Invoking G++
1756 @section Compiling C++ Programs
1758 @cindex suffixes for C++ source
1759 @cindex C++ source file suffixes
1760 C++ source files conventionally use one of the suffixes @samp{.C},
1761 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1762 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1763 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1764 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1765 files with these names and compiles them as C++ programs even if you
1766 call the compiler the same way as for compiling C programs (usually
1767 with the name @command{gcc}).
1769 @findex g++
1770 @findex c++
1771 However, the use of @command{gcc} does not add the C++ library.
1772 @command{g++} is a program that calls GCC and automatically specifies linking
1773 against the C++ library.  It treats @samp{.c},
1774 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1775 files unless @option{-x} is used.  This program is also useful when
1776 precompiling a C header file with a @samp{.h} extension for use in C++
1777 compilations.  On many systems, @command{g++} is also installed with
1778 the name @command{c++}.
1780 @cindex invoking @command{g++}
1781 When you compile C++ programs, you may specify many of the same
1782 command-line options that you use for compiling programs in any
1783 language; or command-line options meaningful for C and related
1784 languages; or options that are meaningful only for C++ programs.
1785 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1786 explanations of options for languages related to C@.
1787 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1788 explanations of options that are meaningful only for C++ programs.
1790 @node C Dialect Options
1791 @section Options Controlling C Dialect
1792 @cindex dialect options
1793 @cindex language dialect options
1794 @cindex options, dialect
1796 The following options control the dialect of C (or languages derived
1797 from C, such as C++, Objective-C and Objective-C++) that the compiler
1798 accepts:
1800 @table @gcctabopt
1801 @cindex ANSI support
1802 @cindex ISO support
1803 @item -ansi
1804 @opindex ansi
1805 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1806 equivalent to @option{-std=c++98}.
1808 This turns off certain features of GCC that are incompatible with ISO
1809 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1810 such as the @code{asm} and @code{typeof} keywords, and
1811 predefined macros such as @code{unix} and @code{vax} that identify the
1812 type of system you are using.  It also enables the undesirable and
1813 rarely used ISO trigraph feature.  For the C compiler,
1814 it disables recognition of C++ style @samp{//} comments as well as
1815 the @code{inline} keyword.
1817 The alternate keywords @code{__asm__}, @code{__extension__},
1818 @code{__inline__} and @code{__typeof__} continue to work despite
1819 @option{-ansi}.  You would not want to use them in an ISO C program, of
1820 course, but it is useful to put them in header files that might be included
1821 in compilations done with @option{-ansi}.  Alternate predefined macros
1822 such as @code{__unix__} and @code{__vax__} are also available, with or
1823 without @option{-ansi}.
1825 The @option{-ansi} option does not cause non-ISO programs to be
1826 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1827 addition to @option{-ansi}.  @xref{Warning Options}.
1829 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1830 option is used.  Some header files may notice this macro and refrain
1831 from declaring certain functions or defining certain macros that the
1832 ISO standard doesn't call for; this is to avoid interfering with any
1833 programs that might use these names for other things.
1835 Functions that are normally built in but do not have semantics
1836 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1837 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1838 built-in functions provided by GCC}, for details of the functions
1839 affected.
1841 @item -std=
1842 @opindex std
1843 Determine the language standard. @xref{Standards,,Language Standards
1844 Supported by GCC}, for details of these standard versions.  This option
1845 is currently only supported when compiling C or C++.
1847 The compiler can accept several base standards, such as @samp{c90} or
1848 @samp{c++98}, and GNU dialects of those standards, such as
1849 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1850 compiler accepts all programs following that standard plus those
1851 using GNU extensions that do not contradict it.  For example,
1852 @option{-std=c90} turns off certain features of GCC that are
1853 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1854 keywords, but not other GNU extensions that do not have a meaning in
1855 ISO C90, such as omitting the middle term of a @code{?:}
1856 expression. On the other hand, when a GNU dialect of a standard is
1857 specified, all features supported by the compiler are enabled, even when
1858 those features change the meaning of the base standard.  As a result, some
1859 strict-conforming programs may be rejected.  The particular standard
1860 is used by @option{-Wpedantic} to identify which features are GNU
1861 extensions given that version of the standard. For example
1862 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1863 comments, while @option{-std=gnu99 -Wpedantic} does not.
1865 A value for this option must be provided; possible values are
1867 @table @samp
1868 @item c90
1869 @itemx c89
1870 @itemx iso9899:1990
1871 Support all ISO C90 programs (certain GNU extensions that conflict
1872 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1874 @item iso9899:199409
1875 ISO C90 as modified in amendment 1.
1877 @item c99
1878 @itemx c9x
1879 @itemx iso9899:1999
1880 @itemx iso9899:199x
1881 ISO C99.  This standard is substantially completely supported, modulo
1882 bugs and floating-point issues
1883 (mainly but not entirely relating to optional C99 features from
1884 Annexes F and G).  See
1885 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1886 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1888 @item c11
1889 @itemx c1x
1890 @itemx iso9899:2011
1891 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1892 substantially completely supported, modulo bugs, floating-point issues
1893 (mainly but not entirely relating to optional C11 features from
1894 Annexes F and G) and the optional Annexes K (Bounds-checking
1895 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1897 @item c17
1898 @itemx c18
1899 @itemx iso9899:2017
1900 @itemx iso9899:2018
1901 ISO C17, the 2017 revision of the ISO C standard (expected to be
1902 published in 2018).  This standard is
1903 same as C11 except for corrections of defects (all of which are also
1904 applied with @option{-std=c11}) and a new value of
1905 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1907 @item gnu90
1908 @itemx gnu89
1909 GNU dialect of ISO C90 (including some C99 features).
1911 @item gnu99
1912 @itemx gnu9x
1913 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1915 @item gnu11
1916 @itemx gnu1x
1917 GNU dialect of ISO C11.
1918 The name @samp{gnu1x} is deprecated.
1920 @item gnu17
1921 @itemx gnu18
1922 GNU dialect of ISO C17.  This is the default for C code.
1924 @item c++98
1925 @itemx c++03
1926 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1927 additional defect reports. Same as @option{-ansi} for C++ code.
1929 @item gnu++98
1930 @itemx gnu++03
1931 GNU dialect of @option{-std=c++98}.
1933 @item c++11
1934 @itemx c++0x
1935 The 2011 ISO C++ standard plus amendments.
1936 The name @samp{c++0x} is deprecated.
1938 @item gnu++11
1939 @itemx gnu++0x
1940 GNU dialect of @option{-std=c++11}.
1941 The name @samp{gnu++0x} is deprecated.
1943 @item c++14
1944 @itemx c++1y
1945 The 2014 ISO C++ standard plus amendments.
1946 The name @samp{c++1y} is deprecated.
1948 @item gnu++14
1949 @itemx gnu++1y
1950 GNU dialect of @option{-std=c++14}.
1951 This is the default for C++ code.
1952 The name @samp{gnu++1y} is deprecated.
1954 @item c++17
1955 @itemx c++1z
1956 The 2017 ISO C++ standard plus amendments.
1957 The name @samp{c++1z} is deprecated.
1959 @item gnu++17
1960 @itemx gnu++1z
1961 GNU dialect of @option{-std=c++17}.
1962 The name @samp{gnu++1z} is deprecated.
1964 @item c++2a
1965 The next revision of the ISO C++ standard, tentatively planned for
1966 2020.  Support is highly experimental, and will almost certainly
1967 change in incompatible ways in future releases.
1969 @item gnu++2a
1970 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1971 and will almost certainly change in incompatible ways in future
1972 releases.
1973 @end table
1975 @item -fgnu89-inline
1976 @opindex fgnu89-inline
1977 The option @option{-fgnu89-inline} tells GCC to use the traditional
1978 GNU semantics for @code{inline} functions when in C99 mode.
1979 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1980 Using this option is roughly equivalent to adding the
1981 @code{gnu_inline} function attribute to all inline functions
1982 (@pxref{Function Attributes}).
1984 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1985 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1986 specifies the default behavior).
1987 This option is not supported in @option{-std=c90} or
1988 @option{-std=gnu90} mode.
1990 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1991 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1992 in effect for @code{inline} functions.  @xref{Common Predefined
1993 Macros,,,cpp,The C Preprocessor}.
1995 @item -fpermitted-flt-eval-methods=@var{style}
1996 @opindex fpermitted-flt-eval-methods
1997 @opindex fpermitted-flt-eval-methods=c11
1998 @opindex fpermitted-flt-eval-methods=ts-18661-3
1999 ISO/IEC TS 18661-3 defines new permissible values for
2000 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2001 a semantic type that is an interchange or extended format should be
2002 evaluated to the precision and range of that type.  These new values are
2003 a superset of those permitted under C99/C11, which does not specify the
2004 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2005 conforming to C11 may not have been written expecting the possibility of
2006 the new values.
2008 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2009 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2010 or the extended set of values specified in ISO/IEC TS 18661-3.
2012 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2014 The default when in a standards compliant mode (@option{-std=c11} or similar)
2015 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2016 dialect (@option{-std=gnu11} or similar) is
2017 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2019 @item -aux-info @var{filename}
2020 @opindex aux-info
2021 Output to the given filename prototyped declarations for all functions
2022 declared and/or defined in a translation unit, including those in header
2023 files.  This option is silently ignored in any language other than C@.
2025 Besides declarations, the file indicates, in comments, the origin of
2026 each declaration (source file and line), whether the declaration was
2027 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2028 @samp{O} for old, respectively, in the first character after the line
2029 number and the colon), and whether it came from a declaration or a
2030 definition (@samp{C} or @samp{F}, respectively, in the following
2031 character).  In the case of function definitions, a K&R-style list of
2032 arguments followed by their declarations is also provided, inside
2033 comments, after the declaration.
2035 @item -fallow-parameterless-variadic-functions
2036 @opindex fallow-parameterless-variadic-functions
2037 Accept variadic functions without named parameters.
2039 Although it is possible to define such a function, this is not very
2040 useful as it is not possible to read the arguments.  This is only
2041 supported for C as this construct is allowed by C++.
2043 @item -fno-asm
2044 @opindex fno-asm
2045 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2046 keyword, so that code can use these words as identifiers.  You can use
2047 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2048 instead.  @option{-ansi} implies @option{-fno-asm}.
2050 In C++, this switch only affects the @code{typeof} keyword, since
2051 @code{asm} and @code{inline} are standard keywords.  You may want to
2052 use the @option{-fno-gnu-keywords} flag instead, which has the same
2053 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2054 switch only affects the @code{asm} and @code{typeof} keywords, since
2055 @code{inline} is a standard keyword in ISO C99.
2057 @item -fno-builtin
2058 @itemx -fno-builtin-@var{function}
2059 @opindex fno-builtin
2060 @cindex built-in functions
2061 Don't recognize built-in functions that do not begin with
2062 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2063 functions provided by GCC}, for details of the functions affected,
2064 including those which are not built-in functions when @option{-ansi} or
2065 @option{-std} options for strict ISO C conformance are used because they
2066 do not have an ISO standard meaning.
2068 GCC normally generates special code to handle certain built-in functions
2069 more efficiently; for instance, calls to @code{alloca} may become single
2070 instructions which adjust the stack directly, and calls to @code{memcpy}
2071 may become inline copy loops.  The resulting code is often both smaller
2072 and faster, but since the function calls no longer appear as such, you
2073 cannot set a breakpoint on those calls, nor can you change the behavior
2074 of the functions by linking with a different library.  In addition,
2075 when a function is recognized as a built-in function, GCC may use
2076 information about that function to warn about problems with calls to
2077 that function, or to generate more efficient code, even if the
2078 resulting code still contains calls to that function.  For example,
2079 warnings are given with @option{-Wformat} for bad calls to
2080 @code{printf} when @code{printf} is built in and @code{strlen} is
2081 known not to modify global memory.
2083 With the @option{-fno-builtin-@var{function}} option
2084 only the built-in function @var{function} is
2085 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2086 function is named that is not built-in in this version of GCC, this
2087 option is ignored.  There is no corresponding
2088 @option{-fbuiltin-@var{function}} option; if you wish to enable
2089 built-in functions selectively when using @option{-fno-builtin} or
2090 @option{-ffreestanding}, you may define macros such as:
2092 @smallexample
2093 #define abs(n)          __builtin_abs ((n))
2094 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2095 @end smallexample
2097 @item -fgimple
2098 @opindex fgimple
2100 Enable parsing of function definitions marked with @code{__GIMPLE}.
2101 This is an experimental feature that allows unit testing of GIMPLE
2102 passes.
2104 @item -fhosted
2105 @opindex fhosted
2106 @cindex hosted environment
2108 Assert that compilation targets a hosted environment.  This implies
2109 @option{-fbuiltin}.  A hosted environment is one in which the
2110 entire standard library is available, and in which @code{main} has a return
2111 type of @code{int}.  Examples are nearly everything except a kernel.
2112 This is equivalent to @option{-fno-freestanding}.
2114 @item -ffreestanding
2115 @opindex ffreestanding
2116 @cindex hosted environment
2118 Assert that compilation targets a freestanding environment.  This
2119 implies @option{-fno-builtin}.  A freestanding environment
2120 is one in which the standard library may not exist, and program startup may
2121 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2122 This is equivalent to @option{-fno-hosted}.
2124 @xref{Standards,,Language Standards Supported by GCC}, for details of
2125 freestanding and hosted environments.
2127 @item -fopenacc
2128 @opindex fopenacc
2129 @cindex OpenACC accelerator programming
2130 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2131 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2132 compiler generates accelerated code according to the OpenACC Application
2133 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2134 implies @option{-pthread}, and thus is only supported on targets that
2135 have support for @option{-pthread}.
2137 @item -fopenacc-dim=@var{geom}
2138 @opindex fopenacc-dim
2139 @cindex OpenACC accelerator programming
2140 Specify default compute dimensions for parallel offload regions that do
2141 not explicitly specify.  The @var{geom} value is a triple of
2142 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2143 can be omitted, to use a target-specific default value.
2145 @item -fopenmp
2146 @opindex fopenmp
2147 @cindex OpenMP parallel
2148 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2149 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2150 compiler generates parallel code according to the OpenMP Application
2151 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2152 implies @option{-pthread}, and thus is only supported on targets that
2153 have support for @option{-pthread}. @option{-fopenmp} implies
2154 @option{-fopenmp-simd}.
2156 @item -fopenmp-simd
2157 @opindex fopenmp-simd
2158 @cindex OpenMP SIMD
2159 @cindex SIMD
2160 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2161 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2162 are ignored.
2164 @item -fgnu-tm
2165 @opindex fgnu-tm
2166 When the option @option{-fgnu-tm} is specified, the compiler
2167 generates code for the Linux variant of Intel's current Transactional
2168 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2169 an experimental feature whose interface may change in future versions
2170 of GCC, as the official specification changes.  Please note that not
2171 all architectures are supported for this feature.
2173 For more information on GCC's support for transactional memory,
2174 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2175 Transactional Memory Library}.
2177 Note that the transactional memory feature is not supported with
2178 non-call exceptions (@option{-fnon-call-exceptions}).
2180 @item -fms-extensions
2181 @opindex fms-extensions
2182 Accept some non-standard constructs used in Microsoft header files.
2184 In C++ code, this allows member names in structures to be similar
2185 to previous types declarations.
2187 @smallexample
2188 typedef int UOW;
2189 struct ABC @{
2190   UOW UOW;
2192 @end smallexample
2194 Some cases of unnamed fields in structures and unions are only
2195 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2196 fields within structs/unions}, for details.
2198 Note that this option is off for all targets but x86 
2199 targets using ms-abi.
2201 @item -fplan9-extensions
2202 @opindex fplan9-extensions
2203 Accept some non-standard constructs used in Plan 9 code.
2205 This enables @option{-fms-extensions}, permits passing pointers to
2206 structures with anonymous fields to functions that expect pointers to
2207 elements of the type of the field, and permits referring to anonymous
2208 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2209 struct/union fields within structs/unions}, for details.  This is only
2210 supported for C, not C++.
2212 @item -fcond-mismatch
2213 @opindex fcond-mismatch
2214 Allow conditional expressions with mismatched types in the second and
2215 third arguments.  The value of such an expression is void.  This option
2216 is not supported for C++.
2218 @item -flax-vector-conversions
2219 @opindex flax-vector-conversions
2220 Allow implicit conversions between vectors with differing numbers of
2221 elements and/or incompatible element types.  This option should not be
2222 used for new code.
2224 @item -funsigned-char
2225 @opindex funsigned-char
2226 Let the type @code{char} be unsigned, like @code{unsigned char}.
2228 Each kind of machine has a default for what @code{char} should
2229 be.  It is either like @code{unsigned char} by default or like
2230 @code{signed char} by default.
2232 Ideally, a portable program should always use @code{signed char} or
2233 @code{unsigned char} when it depends on the signedness of an object.
2234 But many programs have been written to use plain @code{char} and
2235 expect it to be signed, or expect it to be unsigned, depending on the
2236 machines they were written for.  This option, and its inverse, let you
2237 make such a program work with the opposite default.
2239 The type @code{char} is always a distinct type from each of
2240 @code{signed char} or @code{unsigned char}, even though its behavior
2241 is always just like one of those two.
2243 @item -fsigned-char
2244 @opindex fsigned-char
2245 Let the type @code{char} be signed, like @code{signed char}.
2247 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2248 the negative form of @option{-funsigned-char}.  Likewise, the option
2249 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2251 @item -fsigned-bitfields
2252 @itemx -funsigned-bitfields
2253 @itemx -fno-signed-bitfields
2254 @itemx -fno-unsigned-bitfields
2255 @opindex fsigned-bitfields
2256 @opindex funsigned-bitfields
2257 @opindex fno-signed-bitfields
2258 @opindex fno-unsigned-bitfields
2259 These options control whether a bit-field is signed or unsigned, when the
2260 declaration does not use either @code{signed} or @code{unsigned}.  By
2261 default, such a bit-field is signed, because this is consistent: the
2262 basic integer types such as @code{int} are signed types.
2264 @item -fsso-struct=@var{endianness}
2265 @opindex fsso-struct
2266 Set the default scalar storage order of structures and unions to the
2267 specified endianness.  The accepted values are @samp{big-endian},
2268 @samp{little-endian} and @samp{native} for the native endianness of
2269 the target (the default).  This option is not supported for C++.
2271 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2272 code that is not binary compatible with code generated without it if the
2273 specified endianness is not the native endianness of the target.
2274 @end table
2276 @node C++ Dialect Options
2277 @section Options Controlling C++ Dialect
2279 @cindex compiler options, C++
2280 @cindex C++ options, command-line
2281 @cindex options, C++
2282 This section describes the command-line options that are only meaningful
2283 for C++ programs.  You can also use most of the GNU compiler options
2284 regardless of what language your program is in.  For example, you
2285 might compile a file @file{firstClass.C} like this:
2287 @smallexample
2288 g++ -g -fstrict-enums -O -c firstClass.C
2289 @end smallexample
2291 @noindent
2292 In this example, only @option{-fstrict-enums} is an option meant
2293 only for C++ programs; you can use the other options with any
2294 language supported by GCC@.
2296 Some options for compiling C programs, such as @option{-std}, are also
2297 relevant for C++ programs.
2298 @xref{C Dialect Options,,Options Controlling C Dialect}.
2300 Here is a list of options that are @emph{only} for compiling C++ programs:
2302 @table @gcctabopt
2304 @item -fabi-version=@var{n}
2305 @opindex fabi-version
2306 Use version @var{n} of the C++ ABI@.  The default is version 0.
2308 Version 0 refers to the version conforming most closely to
2309 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2310 will change in different versions of G++ as ABI bugs are fixed.
2312 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2314 Version 2 is the version of the C++ ABI that first appeared in G++
2315 3.4, and was the default through G++ 4.9.
2317 Version 3 corrects an error in mangling a constant address as a
2318 template argument.
2320 Version 4, which first appeared in G++ 4.5, implements a standard
2321 mangling for vector types.
2323 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2324 attribute const/volatile on function pointer types, decltype of a
2325 plain decl, and use of a function parameter in the declaration of
2326 another parameter.
2328 Version 6, which first appeared in G++ 4.7, corrects the promotion
2329 behavior of C++11 scoped enums and the mangling of template argument
2330 packs, const/static_cast, prefix ++ and --, and a class scope function
2331 used as a template argument.
2333 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2334 builtin type and corrects the mangling of lambdas in default argument
2335 scope.
2337 Version 8, which first appeared in G++ 4.9, corrects the substitution
2338 behavior of function types with function-cv-qualifiers.
2340 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2341 @code{nullptr_t}.
2343 Version 10, which first appeared in G++ 6.1, adds mangling of
2344 attributes that affect type identity, such as ia32 calling convention
2345 attributes (e.g. @samp{stdcall}).
2347 Version 11, which first appeared in G++ 7, corrects the mangling of
2348 sizeof... expressions and operator names.  For multiple entities with
2349 the same name within a function, that are declared in different scopes,
2350 the mangling now changes starting with the twelfth occurrence.  It also
2351 implies @option{-fnew-inheriting-ctors}.
2353 See also @option{-Wabi}.
2355 @item -fabi-compat-version=@var{n}
2356 @opindex fabi-compat-version
2357 On targets that support strong aliases, G++
2358 works around mangling changes by creating an alias with the correct
2359 mangled name when defining a symbol with an incorrect mangled name.
2360 This switch specifies which ABI version to use for the alias.
2362 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2363 compatibility).  If another ABI version is explicitly selected, this
2364 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2365 use @option{-fabi-compat-version=2}.
2367 If this option is not provided but @option{-Wabi=@var{n}} is, that
2368 version is used for compatibility aliases.  If this option is provided
2369 along with @option{-Wabi} (without the version), the version from this
2370 option is used for the warning.
2372 @item -fno-access-control
2373 @opindex fno-access-control
2374 Turn off all access checking.  This switch is mainly useful for working
2375 around bugs in the access control code.
2377 @item -faligned-new
2378 @opindex faligned-new
2379 Enable support for C++17 @code{new} of types that require more
2380 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2381 numeric argument such as @code{-faligned-new=32} can be used to
2382 specify how much alignment (in bytes) is provided by that function,
2383 but few users will need to override the default of
2384 @code{alignof(std::max_align_t)}.
2386 This flag is enabled by default for @option{-std=c++17}.
2388 @item -fcheck-new
2389 @opindex fcheck-new
2390 Check that the pointer returned by @code{operator new} is non-null
2391 before attempting to modify the storage allocated.  This check is
2392 normally unnecessary because the C++ standard specifies that
2393 @code{operator new} only returns @code{0} if it is declared
2394 @code{throw()}, in which case the compiler always checks the
2395 return value even without this option.  In all other cases, when
2396 @code{operator new} has a non-empty exception specification, memory
2397 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2398 @samp{new (nothrow)}.
2400 @item -fconcepts
2401 @opindex fconcepts
2402 Enable support for the C++ Extensions for Concepts Technical
2403 Specification, ISO 19217 (2015), which allows code like
2405 @smallexample
2406 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2407 template <Addable T> T add (T a, T b) @{ return a + b; @}
2408 @end smallexample
2410 @item -fconstexpr-depth=@var{n}
2411 @opindex fconstexpr-depth
2412 Set the maximum nested evaluation depth for C++11 constexpr functions
2413 to @var{n}.  A limit is needed to detect endless recursion during
2414 constant expression evaluation.  The minimum specified by the standard
2415 is 512.
2417 @item -fconstexpr-loop-limit=@var{n}
2418 @opindex fconstexpr-loop-limit
2419 Set the maximum number of iterations for a loop in C++14 constexpr functions
2420 to @var{n}.  A limit is needed to detect infinite loops during
2421 constant expression evaluation.  The default is 262144 (1<<18).
2423 @item -fdeduce-init-list
2424 @opindex fdeduce-init-list
2425 Enable deduction of a template type parameter as
2426 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2428 @smallexample
2429 template <class T> auto forward(T t) -> decltype (realfn (t))
2431   return realfn (t);
2434 void f()
2436   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2438 @end smallexample
2440 This deduction was implemented as a possible extension to the
2441 originally proposed semantics for the C++11 standard, but was not part
2442 of the final standard, so it is disabled by default.  This option is
2443 deprecated, and may be removed in a future version of G++.
2445 @item -ffriend-injection
2446 @opindex ffriend-injection
2447 Inject friend functions into the enclosing namespace, so that they are
2448 visible outside the scope of the class in which they are declared.
2449 Friend functions were documented to work this way in the old Annotated
2450 C++ Reference Manual.  
2451 However, in ISO C++ a friend function that is not declared
2452 in an enclosing scope can only be found using argument dependent
2453 lookup.  GCC defaults to the standard behavior.
2455 This option is deprecated and will be removed.
2457 @item -fno-elide-constructors
2458 @opindex fno-elide-constructors
2459 The C++ standard allows an implementation to omit creating a temporary
2460 that is only used to initialize another object of the same type.
2461 Specifying this option disables that optimization, and forces G++ to
2462 call the copy constructor in all cases.  This option also causes G++
2463 to call trivial member functions which otherwise would be expanded inline.
2465 In C++17, the compiler is required to omit these temporaries, but this
2466 option still affects trivial member functions.
2468 @item -fno-enforce-eh-specs
2469 @opindex fno-enforce-eh-specs
2470 Don't generate code to check for violation of exception specifications
2471 at run time.  This option violates the C++ standard, but may be useful
2472 for reducing code size in production builds, much like defining
2473 @code{NDEBUG}.  This does not give user code permission to throw
2474 exceptions in violation of the exception specifications; the compiler
2475 still optimizes based on the specifications, so throwing an
2476 unexpected exception results in undefined behavior at run time.
2478 @item -fextern-tls-init
2479 @itemx -fno-extern-tls-init
2480 @opindex fextern-tls-init
2481 @opindex fno-extern-tls-init
2482 The C++11 and OpenMP standards allow @code{thread_local} and
2483 @code{threadprivate} variables to have dynamic (runtime)
2484 initialization.  To support this, any use of such a variable goes
2485 through a wrapper function that performs any necessary initialization.
2486 When the use and definition of the variable are in the same
2487 translation unit, this overhead can be optimized away, but when the
2488 use is in a different translation unit there is significant overhead
2489 even if the variable doesn't actually need dynamic initialization.  If
2490 the programmer can be sure that no use of the variable in a
2491 non-defining TU needs to trigger dynamic initialization (either
2492 because the variable is statically initialized, or a use of the
2493 variable in the defining TU will be executed before any uses in
2494 another TU), they can avoid this overhead with the
2495 @option{-fno-extern-tls-init} option.
2497 On targets that support symbol aliases, the default is
2498 @option{-fextern-tls-init}.  On targets that do not support symbol
2499 aliases, the default is @option{-fno-extern-tls-init}.
2501 @item -ffor-scope
2502 @itemx -fno-for-scope
2503 @opindex ffor-scope
2504 @opindex fno-for-scope
2505 If @option{-ffor-scope} is specified, the scope of variables declared in
2506 a @i{for-init-statement} is limited to the @code{for} loop itself,
2507 as specified by the C++ standard.
2508 If @option{-fno-for-scope} is specified, the scope of variables declared in
2509 a @i{for-init-statement} extends to the end of the enclosing scope,
2510 as was the case in old versions of G++, and other (traditional)
2511 implementations of C++.
2513 This option is deprecated and the associated non-standard
2514 functionality will be removed.
2516 @item -fno-gnu-keywords
2517 @opindex fno-gnu-keywords
2518 Do not recognize @code{typeof} as a keyword, so that code can use this
2519 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2520 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2521 @option{-std=c++98}, @option{-std=c++11}, etc.
2523 @item -fno-implicit-templates
2524 @opindex fno-implicit-templates
2525 Never emit code for non-inline templates that are instantiated
2526 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2527 @xref{Template Instantiation}, for more information.
2529 @item -fno-implicit-inline-templates
2530 @opindex fno-implicit-inline-templates
2531 Don't emit code for implicit instantiations of inline templates, either.
2532 The default is to handle inlines differently so that compiles with and
2533 without optimization need the same set of explicit instantiations.
2535 @item -fno-implement-inlines
2536 @opindex fno-implement-inlines
2537 To save space, do not emit out-of-line copies of inline functions
2538 controlled by @code{#pragma implementation}.  This causes linker
2539 errors if these functions are not inlined everywhere they are called.
2541 @item -fms-extensions
2542 @opindex fms-extensions
2543 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2544 int and getting a pointer to member function via non-standard syntax.
2546 @item -fnew-inheriting-ctors
2547 @opindex fnew-inheriting-ctors
2548 Enable the P0136 adjustment to the semantics of C++11 constructor
2549 inheritance.  This is part of C++17 but also considered to be a Defect
2550 Report against C++11 and C++14.  This flag is enabled by default
2551 unless @option{-fabi-version=10} or lower is specified.
2553 @item -fnew-ttp-matching
2554 @opindex fnew-ttp-matching
2555 Enable the P0522 resolution to Core issue 150, template template
2556 parameters and default arguments: this allows a template with default
2557 template arguments as an argument for a template template parameter
2558 with fewer template parameters.  This flag is enabled by default for
2559 @option{-std=c++17}.
2561 @item -fno-nonansi-builtins
2562 @opindex fno-nonansi-builtins
2563 Disable built-in declarations of functions that are not mandated by
2564 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2565 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2567 @item -fnothrow-opt
2568 @opindex fnothrow-opt
2569 Treat a @code{throw()} exception specification as if it were a
2570 @code{noexcept} specification to reduce or eliminate the text size
2571 overhead relative to a function with no exception specification.  If
2572 the function has local variables of types with non-trivial
2573 destructors, the exception specification actually makes the
2574 function smaller because the EH cleanups for those variables can be
2575 optimized away.  The semantic effect is that an exception thrown out of
2576 a function with such an exception specification results in a call
2577 to @code{terminate} rather than @code{unexpected}.
2579 @item -fno-operator-names
2580 @opindex fno-operator-names
2581 Do not treat the operator name keywords @code{and}, @code{bitand},
2582 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2583 synonyms as keywords.
2585 @item -fno-optional-diags
2586 @opindex fno-optional-diags
2587 Disable diagnostics that the standard says a compiler does not need to
2588 issue.  Currently, the only such diagnostic issued by G++ is the one for
2589 a name having multiple meanings within a class.
2591 @item -fpermissive
2592 @opindex fpermissive
2593 Downgrade some diagnostics about nonconformant code from errors to
2594 warnings.  Thus, using @option{-fpermissive} allows some
2595 nonconforming code to compile.
2597 @item -fno-pretty-templates
2598 @opindex fno-pretty-templates
2599 When an error message refers to a specialization of a function
2600 template, the compiler normally prints the signature of the
2601 template followed by the template arguments and any typedefs or
2602 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2603 rather than @code{void f(int)}) so that it's clear which template is
2604 involved.  When an error message refers to a specialization of a class
2605 template, the compiler omits any template arguments that match
2606 the default template arguments for that template.  If either of these
2607 behaviors make it harder to understand the error message rather than
2608 easier, you can use @option{-fno-pretty-templates} to disable them.
2610 @item -frepo
2611 @opindex frepo
2612 Enable automatic template instantiation at link time.  This option also
2613 implies @option{-fno-implicit-templates}.  @xref{Template
2614 Instantiation}, for more information.
2616 @item -fno-rtti
2617 @opindex fno-rtti
2618 Disable generation of information about every class with virtual
2619 functions for use by the C++ run-time type identification features
2620 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2621 of the language, you can save some space by using this flag.  Note that
2622 exception handling uses the same information, but G++ generates it as
2623 needed. The @code{dynamic_cast} operator can still be used for casts that
2624 do not require run-time type information, i.e.@: casts to @code{void *} or to
2625 unambiguous base classes.
2627 @item -fsized-deallocation
2628 @opindex fsized-deallocation
2629 Enable the built-in global declarations
2630 @smallexample
2631 void operator delete (void *, std::size_t) noexcept;
2632 void operator delete[] (void *, std::size_t) noexcept;
2633 @end smallexample
2634 as introduced in C++14.  This is useful for user-defined replacement
2635 deallocation functions that, for example, use the size of the object
2636 to make deallocation faster.  Enabled by default under
2637 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2638 warns about places that might want to add a definition.
2640 @item -fstrict-enums
2641 @opindex fstrict-enums
2642 Allow the compiler to optimize using the assumption that a value of
2643 enumerated type can only be one of the values of the enumeration (as
2644 defined in the C++ standard; basically, a value that can be
2645 represented in the minimum number of bits needed to represent all the
2646 enumerators).  This assumption may not be valid if the program uses a
2647 cast to convert an arbitrary integer value to the enumerated type.
2649 @item -fstrong-eval-order
2650 @opindex fstrong-eval-order
2651 Evaluate member access, array subscripting, and shift expressions in
2652 left-to-right order, and evaluate assignment in right-to-left order,
2653 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2654 @option{-fstrong-eval-order=some} enables just the ordering of member
2655 access and shift expressions, and is the default without
2656 @option{-std=c++17}.
2658 @item -ftemplate-backtrace-limit=@var{n}
2659 @opindex ftemplate-backtrace-limit
2660 Set the maximum number of template instantiation notes for a single
2661 warning or error to @var{n}.  The default value is 10.
2663 @item -ftemplate-depth=@var{n}
2664 @opindex ftemplate-depth
2665 Set the maximum instantiation depth for template classes to @var{n}.
2666 A limit on the template instantiation depth is needed to detect
2667 endless recursions during template class instantiation.  ANSI/ISO C++
2668 conforming programs must not rely on a maximum depth greater than 17
2669 (changed to 1024 in C++11).  The default value is 900, as the compiler
2670 can run out of stack space before hitting 1024 in some situations.
2672 @item -fno-threadsafe-statics
2673 @opindex fno-threadsafe-statics
2674 Do not emit the extra code to use the routines specified in the C++
2675 ABI for thread-safe initialization of local statics.  You can use this
2676 option to reduce code size slightly in code that doesn't need to be
2677 thread-safe.
2679 @item -fuse-cxa-atexit
2680 @opindex fuse-cxa-atexit
2681 Register destructors for objects with static storage duration with the
2682 @code{__cxa_atexit} function rather than the @code{atexit} function.
2683 This option is required for fully standards-compliant handling of static
2684 destructors, but only works if your C library supports
2685 @code{__cxa_atexit}.
2687 @item -fno-use-cxa-get-exception-ptr
2688 @opindex fno-use-cxa-get-exception-ptr
2689 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2690 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2691 if the runtime routine is not available.
2693 @item -fvisibility-inlines-hidden
2694 @opindex fvisibility-inlines-hidden
2695 This switch declares that the user does not attempt to compare
2696 pointers to inline functions or methods where the addresses of the two functions
2697 are taken in different shared objects.
2699 The effect of this is that GCC may, effectively, mark inline methods with
2700 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2701 appear in the export table of a DSO and do not require a PLT indirection
2702 when used within the DSO@.  Enabling this option can have a dramatic effect
2703 on load and link times of a DSO as it massively reduces the size of the
2704 dynamic export table when the library makes heavy use of templates.
2706 The behavior of this switch is not quite the same as marking the
2707 methods as hidden directly, because it does not affect static variables
2708 local to the function or cause the compiler to deduce that
2709 the function is defined in only one shared object.
2711 You may mark a method as having a visibility explicitly to negate the
2712 effect of the switch for that method.  For example, if you do want to
2713 compare pointers to a particular inline method, you might mark it as
2714 having default visibility.  Marking the enclosing class with explicit
2715 visibility has no effect.
2717 Explicitly instantiated inline methods are unaffected by this option
2718 as their linkage might otherwise cross a shared library boundary.
2719 @xref{Template Instantiation}.
2721 @item -fvisibility-ms-compat
2722 @opindex fvisibility-ms-compat
2723 This flag attempts to use visibility settings to make GCC's C++
2724 linkage model compatible with that of Microsoft Visual Studio.
2726 The flag makes these changes to GCC's linkage model:
2728 @enumerate
2729 @item
2730 It sets the default visibility to @code{hidden}, like
2731 @option{-fvisibility=hidden}.
2733 @item
2734 Types, but not their members, are not hidden by default.
2736 @item
2737 The One Definition Rule is relaxed for types without explicit
2738 visibility specifications that are defined in more than one
2739 shared object: those declarations are permitted if they are
2740 permitted when this option is not used.
2741 @end enumerate
2743 In new code it is better to use @option{-fvisibility=hidden} and
2744 export those classes that are intended to be externally visible.
2745 Unfortunately it is possible for code to rely, perhaps accidentally,
2746 on the Visual Studio behavior.
2748 Among the consequences of these changes are that static data members
2749 of the same type with the same name but defined in different shared
2750 objects are different, so changing one does not change the other;
2751 and that pointers to function members defined in different shared
2752 objects may not compare equal.  When this flag is given, it is a
2753 violation of the ODR to define types with the same name differently.
2755 @item -fno-weak
2756 @opindex fno-weak
2757 Do not use weak symbol support, even if it is provided by the linker.
2758 By default, G++ uses weak symbols if they are available.  This
2759 option exists only for testing, and should not be used by end-users;
2760 it results in inferior code and has no benefits.  This option may
2761 be removed in a future release of G++.
2763 @item -nostdinc++
2764 @opindex nostdinc++
2765 Do not search for header files in the standard directories specific to
2766 C++, but do still search the other standard directories.  (This option
2767 is used when building the C++ library.)
2768 @end table
2770 In addition, these optimization, warning, and code generation options
2771 have meanings only for C++ programs:
2773 @table @gcctabopt
2774 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2775 @opindex Wabi
2776 @opindex Wno-abi
2777 Warn when G++ it generates code that is probably not compatible with
2778 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2779 ABI with each major release, normally @option{-Wabi} will warn only if
2780 there is a check added later in a release series for an ABI issue
2781 discovered since the initial release.  @option{-Wabi} will warn about
2782 more things if an older ABI version is selected (with
2783 @option{-fabi-version=@var{n}}).
2785 @option{-Wabi} can also be used with an explicit version number to
2786 warn about compatibility with a particular @option{-fabi-version}
2787 level, e.g. @option{-Wabi=2} to warn about changes relative to
2788 @option{-fabi-version=2}.
2790 If an explicit version number is provided and
2791 @option{-fabi-compat-version} is not specified, the version number
2792 from this option is used for compatibility aliases.  If no explicit
2793 version number is provided with this option, but
2794 @option{-fabi-compat-version} is specified, that version number is
2795 used for ABI warnings.
2797 Although an effort has been made to warn about
2798 all such cases, there are probably some cases that are not warned about,
2799 even though G++ is generating incompatible code.  There may also be
2800 cases where warnings are emitted even though the code that is generated
2801 is compatible.
2803 You should rewrite your code to avoid these warnings if you are
2804 concerned about the fact that code generated by G++ may not be binary
2805 compatible with code generated by other compilers.
2807 Known incompatibilities in @option{-fabi-version=2} (which was the
2808 default from GCC 3.4 to 4.9) include:
2810 @itemize @bullet
2812 @item
2813 A template with a non-type template parameter of reference type was
2814 mangled incorrectly:
2815 @smallexample
2816 extern int N;
2817 template <int &> struct S @{@};
2818 void n (S<N>) @{2@}
2819 @end smallexample
2821 This was fixed in @option{-fabi-version=3}.
2823 @item
2824 SIMD vector types declared using @code{__attribute ((vector_size))} were
2825 mangled in a non-standard way that does not allow for overloading of
2826 functions taking vectors of different sizes.
2828 The mangling was changed in @option{-fabi-version=4}.
2830 @item
2831 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2832 qualifiers, and @code{decltype} of a plain declaration was folded away.
2834 These mangling issues were fixed in @option{-fabi-version=5}.
2836 @item
2837 Scoped enumerators passed as arguments to a variadic function are
2838 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2839 On most targets this does not actually affect the parameter passing
2840 ABI, as there is no way to pass an argument smaller than @code{int}.
2842 Also, the ABI changed the mangling of template argument packs,
2843 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2844 a class scope function used as a template argument.
2846 These issues were corrected in @option{-fabi-version=6}.
2848 @item
2849 Lambdas in default argument scope were mangled incorrectly, and the
2850 ABI changed the mangling of @code{nullptr_t}.
2852 These issues were corrected in @option{-fabi-version=7}.
2854 @item
2855 When mangling a function type with function-cv-qualifiers, the
2856 un-qualified function type was incorrectly treated as a substitution
2857 candidate.
2859 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2861 @item
2862 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2863 unaligned accesses.  Note that this did not affect the ABI of a
2864 function with a @code{nullptr_t} parameter, as parameters have a
2865 minimum alignment.
2867 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2869 @item
2870 Target-specific attributes that affect the identity of a type, such as
2871 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2872 did not affect the mangled name, leading to name collisions when
2873 function pointers were used as template arguments.
2875 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2877 @end itemize
2879 It also warns about psABI-related changes.  The known psABI changes at this
2880 point include:
2882 @itemize @bullet
2884 @item
2885 For SysV/x86-64, unions with @code{long double} members are 
2886 passed in memory as specified in psABI.  For example:
2888 @smallexample
2889 union U @{
2890   long double ld;
2891   int i;
2893 @end smallexample
2895 @noindent
2896 @code{union U} is always passed in memory.
2898 @end itemize
2900 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2901 @opindex Wabi-tag
2902 @opindex -Wabi-tag
2903 Warn when a type with an ABI tag is used in a context that does not
2904 have that ABI tag.  See @ref{C++ Attributes} for more information
2905 about ABI tags.
2907 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2908 @opindex Wctor-dtor-privacy
2909 @opindex Wno-ctor-dtor-privacy
2910 Warn when a class seems unusable because all the constructors or
2911 destructors in that class are private, and it has neither friends nor
2912 public static member functions.  Also warn if there are no non-private
2913 methods, and there's at least one private member function that isn't
2914 a constructor or destructor.
2916 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2917 @opindex Wdelete-non-virtual-dtor
2918 @opindex Wno-delete-non-virtual-dtor
2919 Warn when @code{delete} is used to destroy an instance of a class that
2920 has virtual functions and non-virtual destructor. It is unsafe to delete
2921 an instance of a derived class through a pointer to a base class if the
2922 base class does not have a virtual destructor.  This warning is enabled
2923 by @option{-Wall}.
2925 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2926 @opindex Wliteral-suffix
2927 @opindex Wno-literal-suffix
2928 Warn when a string or character literal is followed by a ud-suffix which does
2929 not begin with an underscore.  As a conforming extension, GCC treats such
2930 suffixes as separate preprocessing tokens in order to maintain backwards
2931 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2932 For example:
2934 @smallexample
2935 #define __STDC_FORMAT_MACROS
2936 #include <inttypes.h>
2937 #include <stdio.h>
2939 int main() @{
2940   int64_t i64 = 123;
2941   printf("My int64: %" PRId64"\n", i64);
2943 @end smallexample
2945 In this case, @code{PRId64} is treated as a separate preprocessing token.
2947 Additionally, warn when a user-defined literal operator is declared with
2948 a literal suffix identifier that doesn't begin with an underscore. Literal
2949 suffix identifiers that don't begin with an underscore are reserved for
2950 future standardization.
2952 This warning is enabled by default.
2954 @item -Wlto-type-mismatch
2955 @opindex Wlto-type-mismatch
2956 @opindex Wno-lto-type-mismatch
2958 During the link-time optimization warn about type mismatches in
2959 global declarations from different compilation units.
2960 Requires @option{-flto} to be enabled.  Enabled by default.
2962 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2963 @opindex Wnarrowing
2964 @opindex Wno-narrowing
2965 For C++11 and later standards, narrowing conversions are diagnosed by default,
2966 as required by the standard.  A narrowing conversion from a constant produces
2967 an error, and a narrowing conversion from a non-constant produces a warning,
2968 but @option{-Wno-narrowing} suppresses the diagnostic.
2969 Note that this does not affect the meaning of well-formed code;
2970 narrowing conversions are still considered ill-formed in SFINAE contexts.
2972 With @option{-Wnarrowing} in C++98, warn when a narrowing
2973 conversion prohibited by C++11 occurs within
2974 @samp{@{ @}}, e.g.
2976 @smallexample
2977 int i = @{ 2.2 @}; // error: narrowing from double to int
2978 @end smallexample
2980 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2982 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2983 @opindex Wnoexcept
2984 @opindex Wno-noexcept
2985 Warn when a noexcept-expression evaluates to false because of a call
2986 to a function that does not have a non-throwing exception
2987 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2988 the compiler to never throw an exception.
2990 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2991 @opindex Wnoexcept-type
2992 @opindex Wno-noexcept-type
2993 Warn if the C++17 feature making @code{noexcept} part of a function
2994 type changes the mangled name of a symbol relative to C++14.  Enabled
2995 by @option{-Wabi} and @option{-Wc++17-compat}.
2997 As an example:
2999 @smallexample
3000 template <class T> void f(T t) @{ t(); @};
3001 void g() noexcept;
3002 void h() @{ f(g); @} 
3003 @end smallexample
3005 @noindent
3006 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
3007 C++17 it calls @code{f<void(*)()noexcept>}.
3009 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3010 @opindex Wclass-memaccess
3011 Warn when the destination of a call to a raw memory function such as
3012 @code{memset} or @code{memcpy} is an object of class type, and when writing
3013 into such an object might bypass the class non-trivial or deleted constructor
3014 or copy assignment, violate const-correctness or encapsulation, or corrupt
3015 virtual table pointers.  Modifying the representation of such objects may
3016 violate invariants maintained by member functions of the class.  For example,
3017 the call to @code{memset} below is undefined because it modifies a non-trivial
3018 class object and is, therefore, diagnosed.  The safe way to either initialize
3019 or clear the storage of objects of such types is by using the appropriate
3020 constructor or assignment operator, if one is available.
3021 @smallexample
3022 std::string str = "abc";
3023 memset (&str, 0, sizeof str);
3024 @end smallexample
3025 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3026 Explicitly casting the pointer to the class object to @code{void *} or
3027 to a type that can be safely accessed by the raw memory function suppresses
3028 the warning.
3030 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3031 @opindex Wnon-virtual-dtor
3032 @opindex Wno-non-virtual-dtor
3033 Warn when a class has virtual functions and an accessible non-virtual
3034 destructor itself or in an accessible polymorphic base class, in which
3035 case it is possible but unsafe to delete an instance of a derived
3036 class through a pointer to the class itself or base class.  This
3037 warning is automatically enabled if @option{-Weffc++} is specified.
3039 @item -Wregister @r{(C++ and Objective-C++ only)}
3040 @opindex Wregister
3041 @opindex Wno-register
3042 Warn on uses of the @code{register} storage class specifier, except
3043 when it is part of the GNU @ref{Explicit Register Variables} extension.
3044 The use of the @code{register} keyword as storage class specifier has
3045 been deprecated in C++11 and removed in C++17.
3046 Enabled by default with @option{-std=c++17}.
3048 @item -Wreorder @r{(C++ and Objective-C++ only)}
3049 @opindex Wreorder
3050 @opindex Wno-reorder
3051 @cindex reordering, warning
3052 @cindex warning for reordering of member initializers
3053 Warn when the order of member initializers given in the code does not
3054 match the order in which they must be executed.  For instance:
3056 @smallexample
3057 struct A @{
3058   int i;
3059   int j;
3060   A(): j (0), i (1) @{ @}
3062 @end smallexample
3064 @noindent
3065 The compiler rearranges the member initializers for @code{i}
3066 and @code{j} to match the declaration order of the members, emitting
3067 a warning to that effect.  This warning is enabled by @option{-Wall}.
3069 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3070 @opindex fext-numeric-literals
3071 @opindex fno-ext-numeric-literals
3072 Accept imaginary, fixed-point, or machine-defined
3073 literal number suffixes as GNU extensions.
3074 When this option is turned off these suffixes are treated
3075 as C++11 user-defined literal numeric suffixes.
3076 This is on by default for all pre-C++11 dialects and all GNU dialects:
3077 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3078 @option{-std=gnu++14}.
3079 This option is off by default
3080 for ISO C++11 onwards (@option{-std=c++11}, ...).
3081 @end table
3083 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3085 @table @gcctabopt
3086 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3087 @opindex Weffc++
3088 @opindex Wno-effc++
3089 Warn about violations of the following style guidelines from Scott Meyers'
3090 @cite{Effective C++} series of books:
3092 @itemize @bullet
3093 @item
3094 Define a copy constructor and an assignment operator for classes
3095 with dynamically-allocated memory.
3097 @item
3098 Prefer initialization to assignment in constructors.
3100 @item
3101 Have @code{operator=} return a reference to @code{*this}.
3103 @item
3104 Don't try to return a reference when you must return an object.
3106 @item
3107 Distinguish between prefix and postfix forms of increment and
3108 decrement operators.
3110 @item
3111 Never overload @code{&&}, @code{||}, or @code{,}.
3113 @end itemize
3115 This option also enables @option{-Wnon-virtual-dtor}, which is also
3116 one of the effective C++ recommendations.  However, the check is
3117 extended to warn about the lack of virtual destructor in accessible
3118 non-polymorphic bases classes too.
3120 When selecting this option, be aware that the standard library
3121 headers do not obey all of these guidelines; use @samp{grep -v}
3122 to filter out those warnings.
3124 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3125 @opindex Wstrict-null-sentinel
3126 @opindex Wno-strict-null-sentinel
3127 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3128 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3129 to @code{__null}.  Although it is a null pointer constant rather than a
3130 null pointer, it is guaranteed to be of the same size as a pointer.
3131 But this use is not portable across different compilers.
3133 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3134 @opindex Wno-non-template-friend
3135 @opindex Wnon-template-friend
3136 Disable warnings when non-template friend functions are declared
3137 within a template.  In very old versions of GCC that predate implementation
3138 of the ISO standard, declarations such as 
3139 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3140 could be interpreted as a particular specialization of a template
3141 function; the warning exists to diagnose compatibility problems, 
3142 and is enabled by default.
3144 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3145 @opindex Wold-style-cast
3146 @opindex Wno-old-style-cast
3147 Warn if an old-style (C-style) cast to a non-void type is used within
3148 a C++ program.  The new-style casts (@code{dynamic_cast},
3149 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3150 less vulnerable to unintended effects and much easier to search for.
3152 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3153 @opindex Woverloaded-virtual
3154 @opindex Wno-overloaded-virtual
3155 @cindex overloaded virtual function, warning
3156 @cindex warning for overloaded virtual function
3157 Warn when a function declaration hides virtual functions from a
3158 base class.  For example, in:
3160 @smallexample
3161 struct A @{
3162   virtual void f();
3165 struct B: public A @{
3166   void f(int);
3168 @end smallexample
3170 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3171 like:
3173 @smallexample
3174 B* b;
3175 b->f();
3176 @end smallexample
3178 @noindent
3179 fails to compile.
3181 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3182 @opindex Wno-pmf-conversions
3183 @opindex Wpmf-conversions
3184 Disable the diagnostic for converting a bound pointer to member function
3185 to a plain pointer.
3187 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3188 @opindex Wsign-promo
3189 @opindex Wno-sign-promo
3190 Warn when overload resolution chooses a promotion from unsigned or
3191 enumerated type to a signed type, over a conversion to an unsigned type of
3192 the same size.  Previous versions of G++ tried to preserve
3193 unsignedness, but the standard mandates the current behavior.
3195 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3196 @opindex Wtemplates
3197 Warn when a primary template declaration is encountered.  Some coding
3198 rules disallow templates, and this may be used to enforce that rule.
3199 The warning is inactive inside a system header file, such as the STL, so
3200 one can still use the STL.  One may also instantiate or specialize
3201 templates.
3203 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3204 @opindex Wmultiple-inheritance
3205 Warn when a class is defined with multiple direct base classes.  Some
3206 coding rules disallow multiple inheritance, and this may be used to
3207 enforce that rule.  The warning is inactive inside a system header file,
3208 such as the STL, so one can still use the STL.  One may also define
3209 classes that indirectly use multiple inheritance.
3211 @item -Wvirtual-inheritance
3212 @opindex Wvirtual-inheritance
3213 Warn when a class is defined with a virtual direct base class.  Some
3214 coding rules disallow multiple inheritance, and this may be used to
3215 enforce that rule.  The warning is inactive inside a system header file,
3216 such as the STL, so one can still use the STL.  One may also define
3217 classes that indirectly use virtual inheritance.
3219 @item -Wnamespaces
3220 @opindex Wnamespaces
3221 Warn when a namespace definition is opened.  Some coding rules disallow
3222 namespaces, and this may be used to enforce that rule.  The warning is
3223 inactive inside a system header file, such as the STL, so one can still
3224 use the STL.  One may also use using directives and qualified names.
3226 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3227 @opindex Wterminate
3228 @opindex Wno-terminate
3229 Disable the warning about a throw-expression that will immediately
3230 result in a call to @code{terminate}.
3231 @end table
3233 @node Objective-C and Objective-C++ Dialect Options
3234 @section Options Controlling Objective-C and Objective-C++ Dialects
3236 @cindex compiler options, Objective-C and Objective-C++
3237 @cindex Objective-C and Objective-C++ options, command-line
3238 @cindex options, Objective-C and Objective-C++
3239 (NOTE: This manual does not describe the Objective-C and Objective-C++
3240 languages themselves.  @xref{Standards,,Language Standards
3241 Supported by GCC}, for references.)
3243 This section describes the command-line options that are only meaningful
3244 for Objective-C and Objective-C++ programs.  You can also use most of
3245 the language-independent GNU compiler options.
3246 For example, you might compile a file @file{some_class.m} like this:
3248 @smallexample
3249 gcc -g -fgnu-runtime -O -c some_class.m
3250 @end smallexample
3252 @noindent
3253 In this example, @option{-fgnu-runtime} is an option meant only for
3254 Objective-C and Objective-C++ programs; you can use the other options with
3255 any language supported by GCC@.
3257 Note that since Objective-C is an extension of the C language, Objective-C
3258 compilations may also use options specific to the C front-end (e.g.,
3259 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3260 C++-specific options (e.g., @option{-Wabi}).
3262 Here is a list of options that are @emph{only} for compiling Objective-C
3263 and Objective-C++ programs:
3265 @table @gcctabopt
3266 @item -fconstant-string-class=@var{class-name}
3267 @opindex fconstant-string-class
3268 Use @var{class-name} as the name of the class to instantiate for each
3269 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3270 class name is @code{NXConstantString} if the GNU runtime is being used, and
3271 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3272 @option{-fconstant-cfstrings} option, if also present, overrides the
3273 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3274 to be laid out as constant CoreFoundation strings.
3276 @item -fgnu-runtime
3277 @opindex fgnu-runtime
3278 Generate object code compatible with the standard GNU Objective-C
3279 runtime.  This is the default for most types of systems.
3281 @item -fnext-runtime
3282 @opindex fnext-runtime
3283 Generate output compatible with the NeXT runtime.  This is the default
3284 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3285 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3286 used.
3288 @item -fno-nil-receivers
3289 @opindex fno-nil-receivers
3290 Assume that all Objective-C message dispatches (@code{[receiver
3291 message:arg]}) in this translation unit ensure that the receiver is
3292 not @code{nil}.  This allows for more efficient entry points in the
3293 runtime to be used.  This option is only available in conjunction with
3294 the NeXT runtime and ABI version 0 or 1.
3296 @item -fobjc-abi-version=@var{n}
3297 @opindex fobjc-abi-version
3298 Use version @var{n} of the Objective-C ABI for the selected runtime.
3299 This option is currently supported only for the NeXT runtime.  In that
3300 case, Version 0 is the traditional (32-bit) ABI without support for
3301 properties and other Objective-C 2.0 additions.  Version 1 is the
3302 traditional (32-bit) ABI with support for properties and other
3303 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3304 nothing is specified, the default is Version 0 on 32-bit target
3305 machines, and Version 2 on 64-bit target machines.
3307 @item -fobjc-call-cxx-cdtors
3308 @opindex fobjc-call-cxx-cdtors
3309 For each Objective-C class, check if any of its instance variables is a
3310 C++ object with a non-trivial default constructor.  If so, synthesize a
3311 special @code{- (id) .cxx_construct} instance method which runs
3312 non-trivial default constructors on any such instance variables, in order,
3313 and then return @code{self}.  Similarly, check if any instance variable
3314 is a C++ object with a non-trivial destructor, and if so, synthesize a
3315 special @code{- (void) .cxx_destruct} method which runs
3316 all such default destructors, in reverse order.
3318 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3319 methods thusly generated only operate on instance variables
3320 declared in the current Objective-C class, and not those inherited
3321 from superclasses.  It is the responsibility of the Objective-C
3322 runtime to invoke all such methods in an object's inheritance
3323 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3324 by the runtime immediately after a new object instance is allocated;
3325 the @code{- (void) .cxx_destruct} methods are invoked immediately
3326 before the runtime deallocates an object instance.
3328 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3329 support for invoking the @code{- (id) .cxx_construct} and
3330 @code{- (void) .cxx_destruct} methods.
3332 @item -fobjc-direct-dispatch
3333 @opindex fobjc-direct-dispatch
3334 Allow fast jumps to the message dispatcher.  On Darwin this is
3335 accomplished via the comm page.
3337 @item -fobjc-exceptions
3338 @opindex fobjc-exceptions
3339 Enable syntactic support for structured exception handling in
3340 Objective-C, similar to what is offered by C++.  This option
3341 is required to use the Objective-C keywords @code{@@try},
3342 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3343 @code{@@synchronized}.  This option is available with both the GNU
3344 runtime and the NeXT runtime (but not available in conjunction with
3345 the NeXT runtime on Mac OS X 10.2 and earlier).
3347 @item -fobjc-gc
3348 @opindex fobjc-gc
3349 Enable garbage collection (GC) in Objective-C and Objective-C++
3350 programs.  This option is only available with the NeXT runtime; the
3351 GNU runtime has a different garbage collection implementation that
3352 does not require special compiler flags.
3354 @item -fobjc-nilcheck
3355 @opindex fobjc-nilcheck
3356 For the NeXT runtime with version 2 of the ABI, check for a nil
3357 receiver in method invocations before doing the actual method call.
3358 This is the default and can be disabled using
3359 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3360 checked for nil in this way no matter what this flag is set to.
3361 Currently this flag does nothing when the GNU runtime, or an older
3362 version of the NeXT runtime ABI, is used.
3364 @item -fobjc-std=objc1
3365 @opindex fobjc-std
3366 Conform to the language syntax of Objective-C 1.0, the language
3367 recognized by GCC 4.0.  This only affects the Objective-C additions to
3368 the C/C++ language; it does not affect conformance to C/C++ standards,
3369 which is controlled by the separate C/C++ dialect option flags.  When
3370 this option is used with the Objective-C or Objective-C++ compiler,
3371 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3372 This is useful if you need to make sure that your Objective-C code can
3373 be compiled with older versions of GCC@.
3375 @item -freplace-objc-classes
3376 @opindex freplace-objc-classes
3377 Emit a special marker instructing @command{ld(1)} not to statically link in
3378 the resulting object file, and allow @command{dyld(1)} to load it in at
3379 run time instead.  This is used in conjunction with the Fix-and-Continue
3380 debugging mode, where the object file in question may be recompiled and
3381 dynamically reloaded in the course of program execution, without the need
3382 to restart the program itself.  Currently, Fix-and-Continue functionality
3383 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3384 and later.
3386 @item -fzero-link
3387 @opindex fzero-link
3388 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3389 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3390 compile time) with static class references that get initialized at load time,
3391 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3392 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3393 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3394 for individual class implementations to be modified during program execution.
3395 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3396 regardless of command-line options.
3398 @item -fno-local-ivars
3399 @opindex fno-local-ivars
3400 @opindex flocal-ivars
3401 By default instance variables in Objective-C can be accessed as if
3402 they were local variables from within the methods of the class they're
3403 declared in.  This can lead to shadowing between instance variables
3404 and other variables declared either locally inside a class method or
3405 globally with the same name.  Specifying the @option{-fno-local-ivars}
3406 flag disables this behavior thus avoiding variable shadowing issues.
3408 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3409 @opindex fivar-visibility
3410 Set the default instance variable visibility to the specified option
3411 so that instance variables declared outside the scope of any access
3412 modifier directives default to the specified visibility.
3414 @item -gen-decls
3415 @opindex gen-decls
3416 Dump interface declarations for all classes seen in the source file to a
3417 file named @file{@var{sourcename}.decl}.
3419 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3420 @opindex Wassign-intercept
3421 @opindex Wno-assign-intercept
3422 Warn whenever an Objective-C assignment is being intercepted by the
3423 garbage collector.
3425 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3426 @opindex Wno-protocol
3427 @opindex Wprotocol
3428 If a class is declared to implement a protocol, a warning is issued for
3429 every method in the protocol that is not implemented by the class.  The
3430 default behavior is to issue a warning for every method not explicitly
3431 implemented in the class, even if a method implementation is inherited
3432 from the superclass.  If you use the @option{-Wno-protocol} option, then
3433 methods inherited from the superclass are considered to be implemented,
3434 and no warning is issued for them.
3436 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3437 @opindex Wselector
3438 @opindex Wno-selector
3439 Warn if multiple methods of different types for the same selector are
3440 found during compilation.  The check is performed on the list of methods
3441 in the final stage of compilation.  Additionally, a check is performed
3442 for each selector appearing in a @code{@@selector(@dots{})}
3443 expression, and a corresponding method for that selector has been found
3444 during compilation.  Because these checks scan the method table only at
3445 the end of compilation, these warnings are not produced if the final
3446 stage of compilation is not reached, for example because an error is
3447 found during compilation, or because the @option{-fsyntax-only} option is
3448 being used.
3450 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3451 @opindex Wstrict-selector-match
3452 @opindex Wno-strict-selector-match
3453 Warn if multiple methods with differing argument and/or return types are
3454 found for a given selector when attempting to send a message using this
3455 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3456 is off (which is the default behavior), the compiler omits such warnings
3457 if any differences found are confined to types that share the same size
3458 and alignment.
3460 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3461 @opindex Wundeclared-selector
3462 @opindex Wno-undeclared-selector
3463 Warn if a @code{@@selector(@dots{})} expression referring to an
3464 undeclared selector is found.  A selector is considered undeclared if no
3465 method with that name has been declared before the
3466 @code{@@selector(@dots{})} expression, either explicitly in an
3467 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3468 an @code{@@implementation} section.  This option always performs its
3469 checks as soon as a @code{@@selector(@dots{})} expression is found,
3470 while @option{-Wselector} only performs its checks in the final stage of
3471 compilation.  This also enforces the coding style convention
3472 that methods and selectors must be declared before being used.
3474 @item -print-objc-runtime-info
3475 @opindex print-objc-runtime-info
3476 Generate C header describing the largest structure that is passed by
3477 value, if any.
3479 @end table
3481 @node Diagnostic Message Formatting Options
3482 @section Options to Control Diagnostic Messages Formatting
3483 @cindex options to control diagnostics formatting
3484 @cindex diagnostic messages
3485 @cindex message formatting
3487 Traditionally, diagnostic messages have been formatted irrespective of
3488 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3489 options described below
3490 to control the formatting algorithm for diagnostic messages, 
3491 e.g.@: how many characters per line, how often source location
3492 information should be reported.  Note that some language front ends may not
3493 honor these options.
3495 @table @gcctabopt
3496 @item -fmessage-length=@var{n}
3497 @opindex fmessage-length
3498 Try to format error messages so that they fit on lines of about
3499 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3500 done; each error message appears on a single line.  This is the
3501 default for all front ends.
3503 @item -fdiagnostics-show-location=once
3504 @opindex fdiagnostics-show-location
3505 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3506 reporter to emit source location information @emph{once}; that is, in
3507 case the message is too long to fit on a single physical line and has to
3508 be wrapped, the source location won't be emitted (as prefix) again,
3509 over and over, in subsequent continuation lines.  This is the default
3510 behavior.
3512 @item -fdiagnostics-show-location=every-line
3513 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3514 messages reporter to emit the same source location information (as
3515 prefix) for physical lines that result from the process of breaking
3516 a message which is too long to fit on a single line.
3518 @item -fdiagnostics-color[=@var{WHEN}]
3519 @itemx -fno-diagnostics-color
3520 @opindex fdiagnostics-color
3521 @cindex highlight, color
3522 @vindex GCC_COLORS @r{environment variable}
3523 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3524 or @samp{auto}.  The default depends on how the compiler has been configured,
3525 it can be any of the above @var{WHEN} options or also @samp{never}
3526 if @env{GCC_COLORS} environment variable isn't present in the environment,
3527 and @samp{auto} otherwise.
3528 @samp{auto} means to use color only when the standard error is a terminal.
3529 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3530 aliases for @option{-fdiagnostics-color=always} and
3531 @option{-fdiagnostics-color=never}, respectively.
3533 The colors are defined by the environment variable @env{GCC_COLORS}.
3534 Its value is a colon-separated list of capabilities and Select Graphic
3535 Rendition (SGR) substrings. SGR commands are interpreted by the
3536 terminal or terminal emulator.  (See the section in the documentation
3537 of your text terminal for permitted values and their meanings as
3538 character attributes.)  These substring values are integers in decimal
3539 representation and can be concatenated with semicolons.
3540 Common values to concatenate include
3541 @samp{1} for bold,
3542 @samp{4} for underline,
3543 @samp{5} for blink,
3544 @samp{7} for inverse,
3545 @samp{39} for default foreground color,
3546 @samp{30} to @samp{37} for foreground colors,
3547 @samp{90} to @samp{97} for 16-color mode foreground colors,
3548 @samp{38;5;0} to @samp{38;5;255}
3549 for 88-color and 256-color modes foreground colors,
3550 @samp{49} for default background color,
3551 @samp{40} to @samp{47} for background colors,
3552 @samp{100} to @samp{107} for 16-color mode background colors,
3553 and @samp{48;5;0} to @samp{48;5;255}
3554 for 88-color and 256-color modes background colors.
3556 The default @env{GCC_COLORS} is
3557 @smallexample
3558 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3559 quote=01:fixit-insert=32:fixit-delete=31:\
3560 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3561 type-diff=01;32
3562 @end smallexample
3563 @noindent
3564 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3565 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3566 @samp{01} is bold, and @samp{31} is red.
3567 Setting @env{GCC_COLORS} to the empty string disables colors.
3568 Supported capabilities are as follows.
3570 @table @code
3571 @item error=
3572 @vindex error GCC_COLORS @r{capability}
3573 SGR substring for error: markers.
3575 @item warning=
3576 @vindex warning GCC_COLORS @r{capability}
3577 SGR substring for warning: markers.
3579 @item note=
3580 @vindex note GCC_COLORS @r{capability}
3581 SGR substring for note: markers.
3583 @item range1=
3584 @vindex range1 GCC_COLORS @r{capability}
3585 SGR substring for first additional range.
3587 @item range2=
3588 @vindex range2 GCC_COLORS @r{capability}
3589 SGR substring for second additional range.
3591 @item locus=
3592 @vindex locus GCC_COLORS @r{capability}
3593 SGR substring for location information, @samp{file:line} or
3594 @samp{file:line:column} etc.
3596 @item quote=
3597 @vindex quote GCC_COLORS @r{capability}
3598 SGR substring for information printed within quotes.
3600 @item fixit-insert=
3601 @vindex fixit-insert GCC_COLORS @r{capability}
3602 SGR substring for fix-it hints suggesting text to
3603 be inserted or replaced.
3605 @item fixit-delete=
3606 @vindex fixit-delete GCC_COLORS @r{capability}
3607 SGR substring for fix-it hints suggesting text to
3608 be deleted.
3610 @item diff-filename=
3611 @vindex diff-filename GCC_COLORS @r{capability}
3612 SGR substring for filename headers within generated patches.
3614 @item diff-hunk=
3615 @vindex diff-hunk GCC_COLORS @r{capability}
3616 SGR substring for the starts of hunks within generated patches.
3618 @item diff-delete=
3619 @vindex diff-delete GCC_COLORS @r{capability}
3620 SGR substring for deleted lines within generated patches.
3622 @item diff-insert=
3623 @vindex diff-insert GCC_COLORS @r{capability}
3624 SGR substring for inserted lines within generated patches.
3626 @item type-diff=
3627 @vindex type-diff GCC_COLORS @r{capability}
3628 SGR substring for highlighting mismatching types within template
3629 arguments in the C++ frontend.
3630 @end table
3632 @item -fno-diagnostics-show-option
3633 @opindex fno-diagnostics-show-option
3634 @opindex fdiagnostics-show-option
3635 By default, each diagnostic emitted includes text indicating the
3636 command-line option that directly controls the diagnostic (if such an
3637 option is known to the diagnostic machinery).  Specifying the
3638 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3640 @item -fno-diagnostics-show-caret
3641 @opindex fno-diagnostics-show-caret
3642 @opindex fdiagnostics-show-caret
3643 By default, each diagnostic emitted includes the original source line
3644 and a caret @samp{^} indicating the column.  This option suppresses this
3645 information.  The source line is truncated to @var{n} characters, if
3646 the @option{-fmessage-length=n} option is given.  When the output is done
3647 to the terminal, the width is limited to the width given by the
3648 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3650 @item -fdiagnostics-parseable-fixits
3651 @opindex fdiagnostics-parseable-fixits
3652 Emit fix-it hints in a machine-parseable format, suitable for consumption
3653 by IDEs.  For each fix-it, a line will be printed after the relevant
3654 diagnostic, starting with the string ``fix-it:''.  For example:
3656 @smallexample
3657 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3658 @end smallexample
3660 The location is expressed as a half-open range, expressed as a count of
3661 bytes, starting at byte 1 for the initial column.  In the above example,
3662 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3663 given string:
3665 @smallexample
3666 00000000011111111112222222222
3667 12345678901234567890123456789
3668   gtk_widget_showall (dlg);
3669   ^^^^^^^^^^^^^^^^^^
3670   gtk_widget_show_all
3671 @end smallexample
3673 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3674 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3675 (e.g. vertical tab as ``\013'').
3677 An empty replacement string indicates that the given range is to be removed.
3678 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3679 be inserted at the given position.
3681 @item -fdiagnostics-generate-patch
3682 @opindex fdiagnostics-generate-patch
3683 Print fix-it hints to stderr in unified diff format, after any diagnostics
3684 are printed.  For example:
3686 @smallexample
3687 --- test.c
3688 +++ test.c
3689 @@ -42,5 +42,5 @@
3691  void show_cb(GtkDialog *dlg)
3692  @{
3693 -  gtk_widget_showall(dlg);
3694 +  gtk_widget_show_all(dlg);
3695  @}
3697 @end smallexample
3699 The diff may or may not be colorized, following the same rules
3700 as for diagnostics (see @option{-fdiagnostics-color}).
3702 @item -fdiagnostics-show-template-tree
3703 @opindex fdiagnostics-show-template-tree
3705 In the C++ frontend, when printing diagnostics showing mismatching
3706 template types, such as:
3708 @smallexample
3709   could not convert 'std::map<int, std::vector<double> >()'
3710     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3711 @end smallexample
3713 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3714 tree-like structure showing the common and differing parts of the types,
3715 such as:
3717 @smallexample
3718   map<
3719     [...],
3720     vector<
3721       [double != float]>>
3722 @end smallexample
3724 The parts that differ are highlighted with color (``double'' and
3725 ``float'' in this case).
3727 @item -fno-elide-type
3728 @opindex fno-elide-type
3729 @opindex felide-type
3730 By default when the C++ frontend prints diagnostics showing mismatching
3731 template types, common parts of the types are printed as ``[...]'' to
3732 simplify the error message.  For example:
3734 @smallexample
3735   could not convert 'std::map<int, std::vector<double> >()'
3736     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3737 @end smallexample
3739 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3740 This flag also affects the output of the
3741 @option{-fdiagnostics-show-template-tree} flag.
3743 @item -fno-show-column
3744 @opindex fno-show-column
3745 Do not print column numbers in diagnostics.  This may be necessary if
3746 diagnostics are being scanned by a program that does not understand the
3747 column numbers, such as @command{dejagnu}.
3749 @end table
3751 @node Warning Options
3752 @section Options to Request or Suppress Warnings
3753 @cindex options to control warnings
3754 @cindex warning messages
3755 @cindex messages, warning
3756 @cindex suppressing warnings
3758 Warnings are diagnostic messages that report constructions that
3759 are not inherently erroneous but that are risky or suggest there
3760 may have been an error.
3762 The following language-independent options do not enable specific
3763 warnings but control the kinds of diagnostics produced by GCC@.
3765 @table @gcctabopt
3766 @cindex syntax checking
3767 @item -fsyntax-only
3768 @opindex fsyntax-only
3769 Check the code for syntax errors, but don't do anything beyond that.
3771 @item -fmax-errors=@var{n}
3772 @opindex fmax-errors
3773 Limits the maximum number of error messages to @var{n}, at which point
3774 GCC bails out rather than attempting to continue processing the source
3775 code.  If @var{n} is 0 (the default), there is no limit on the number
3776 of error messages produced.  If @option{-Wfatal-errors} is also
3777 specified, then @option{-Wfatal-errors} takes precedence over this
3778 option.
3780 @item -w
3781 @opindex w
3782 Inhibit all warning messages.
3784 @item -Werror
3785 @opindex Werror
3786 @opindex Wno-error
3787 Make all warnings into errors.
3789 @item -Werror=
3790 @opindex Werror=
3791 @opindex Wno-error=
3792 Make the specified warning into an error.  The specifier for a warning
3793 is appended; for example @option{-Werror=switch} turns the warnings
3794 controlled by @option{-Wswitch} into errors.  This switch takes a
3795 negative form, to be used to negate @option{-Werror} for specific
3796 warnings; for example @option{-Wno-error=switch} makes
3797 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3798 is in effect.
3800 The warning message for each controllable warning includes the
3801 option that controls the warning.  That option can then be used with
3802 @option{-Werror=} and @option{-Wno-error=} as described above.
3803 (Printing of the option in the warning message can be disabled using the
3804 @option{-fno-diagnostics-show-option} flag.)
3806 Note that specifying @option{-Werror=}@var{foo} automatically implies
3807 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3808 imply anything.
3810 @item -Wfatal-errors
3811 @opindex Wfatal-errors
3812 @opindex Wno-fatal-errors
3813 This option causes the compiler to abort compilation on the first error
3814 occurred rather than trying to keep going and printing further error
3815 messages.
3817 @end table
3819 You can request many specific warnings with options beginning with
3820 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3821 implicit declarations.  Each of these specific warning options also
3822 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3823 example, @option{-Wno-implicit}.  This manual lists only one of the
3824 two forms, whichever is not the default.  For further
3825 language-specific options also refer to @ref{C++ Dialect Options} and
3826 @ref{Objective-C and Objective-C++ Dialect Options}.
3828 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3829 options, such as @option{-Wunused}, which may turn on further options,
3830 such as @option{-Wunused-value}. The combined effect of positive and
3831 negative forms is that more specific options have priority over less
3832 specific ones, independently of their position in the command-line. For
3833 options of the same specificity, the last one takes effect. Options
3834 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3835 as if they appeared at the end of the command-line.
3837 When an unrecognized warning option is requested (e.g.,
3838 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3839 that the option is not recognized.  However, if the @option{-Wno-} form
3840 is used, the behavior is slightly different: no diagnostic is
3841 produced for @option{-Wno-unknown-warning} unless other diagnostics
3842 are being produced.  This allows the use of new @option{-Wno-} options
3843 with old compilers, but if something goes wrong, the compiler
3844 warns that an unrecognized option is present.
3846 @table @gcctabopt
3847 @item -Wpedantic
3848 @itemx -pedantic
3849 @opindex pedantic
3850 @opindex Wpedantic
3851 Issue all the warnings demanded by strict ISO C and ISO C++;
3852 reject all programs that use forbidden extensions, and some other
3853 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3854 version of the ISO C standard specified by any @option{-std} option used.
3856 Valid ISO C and ISO C++ programs should compile properly with or without
3857 this option (though a rare few require @option{-ansi} or a
3858 @option{-std} option specifying the required version of ISO C)@.  However,
3859 without this option, certain GNU extensions and traditional C and C++
3860 features are supported as well.  With this option, they are rejected.
3862 @option{-Wpedantic} does not cause warning messages for use of the
3863 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3864 warnings are also disabled in the expression that follows
3865 @code{__extension__}.  However, only system header files should use
3866 these escape routes; application programs should avoid them.
3867 @xref{Alternate Keywords}.
3869 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3870 C conformance.  They soon find that it does not do quite what they want:
3871 it finds some non-ISO practices, but not all---only those for which
3872 ISO C @emph{requires} a diagnostic, and some others for which
3873 diagnostics have been added.
3875 A feature to report any failure to conform to ISO C might be useful in
3876 some instances, but would require considerable additional work and would
3877 be quite different from @option{-Wpedantic}.  We don't have plans to
3878 support such a feature in the near future.
3880 Where the standard specified with @option{-std} represents a GNU
3881 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3882 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3883 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3884 where they are required by the base standard.  (It does not make sense
3885 for such warnings to be given only for features not in the specified GNU
3886 C dialect, since by definition the GNU dialects of C include all
3887 features the compiler supports with the given option, and there would be
3888 nothing to warn about.)
3890 @item -pedantic-errors
3891 @opindex pedantic-errors
3892 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3893 requires a diagnostic, in some cases where there is undefined behavior
3894 at compile-time and in some other cases that do not prevent compilation
3895 of programs that are valid according to the standard. This is not
3896 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3897 by this option and not enabled by the latter and vice versa.
3899 @item -Wall
3900 @opindex Wall
3901 @opindex Wno-all
3902 This enables all the warnings about constructions that some users
3903 consider questionable, and that are easy to avoid (or modify to
3904 prevent the warning), even in conjunction with macros.  This also
3905 enables some language-specific warnings described in @ref{C++ Dialect
3906 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3908 @option{-Wall} turns on the following warning flags:
3910 @gccoptlist{-Waddress   @gol
3911 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3912 -Wbool-compare  @gol
3913 -Wbool-operation  @gol
3914 -Wc++11-compat  -Wc++14-compat  @gol
3915 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3916 -Wchar-subscripts  @gol
3917 -Wcomment  @gol
3918 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3919 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3920 -Wformat   @gol
3921 -Wint-in-bool-context  @gol
3922 -Wimplicit @r{(C and Objective-C only)} @gol
3923 -Wimplicit-int @r{(C and Objective-C only)} @gol
3924 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3925 -Winit-self @r{(only for C++)} @gol
3926 -Wlogical-not-parentheses @gol
3927 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3928 -Wmaybe-uninitialized @gol
3929 -Wmemset-elt-size @gol
3930 -Wmemset-transposed-args @gol
3931 -Wmisleading-indentation @r{(only for C/C++)} @gol
3932 -Wmissing-attributes @gol
3933 -Wmissing-braces @r{(only for C/ObjC)} @gol
3934 -Wmultistatement-macros  @gol
3935 -Wnarrowing @r{(only for C++)}  @gol
3936 -Wnonnull  @gol
3937 -Wnonnull-compare  @gol
3938 -Wopenmp-simd @gol
3939 -Wparentheses  @gol
3940 -Wpointer-sign  @gol
3941 -Wreorder   @gol
3942 -Wrestrict   @gol
3943 -Wreturn-type  @gol
3944 -Wsequence-point  @gol
3945 -Wsign-compare @r{(only in C++)}  @gol
3946 -Wsizeof-pointer-div @gol
3947 -Wsizeof-pointer-memaccess @gol
3948 -Wstrict-aliasing  @gol
3949 -Wstrict-overflow=1  @gol
3950 -Wswitch  @gol
3951 -Wtautological-compare  @gol
3952 -Wtrigraphs  @gol
3953 -Wuninitialized  @gol
3954 -Wunknown-pragmas  @gol
3955 -Wunused-function  @gol
3956 -Wunused-label     @gol
3957 -Wunused-value     @gol
3958 -Wunused-variable  @gol
3959 -Wvolatile-register-var @gol
3962 Note that some warning flags are not implied by @option{-Wall}.  Some of
3963 them warn about constructions that users generally do not consider
3964 questionable, but which occasionally you might wish to check for;
3965 others warn about constructions that are necessary or hard to avoid in
3966 some cases, and there is no simple way to modify the code to suppress
3967 the warning. Some of them are enabled by @option{-Wextra} but many of
3968 them must be enabled individually.
3970 @item -Wextra
3971 @opindex W
3972 @opindex Wextra
3973 @opindex Wno-extra
3974 This enables some extra warning flags that are not enabled by
3975 @option{-Wall}. (This option used to be called @option{-W}.  The older
3976 name is still supported, but the newer name is more descriptive.)
3978 @gccoptlist{-Wclobbered  @gol
3979 -Wcast-function-type  @gol
3980 -Wempty-body  @gol
3981 -Wignored-qualifiers @gol
3982 -Wimplicit-fallthrough=3 @gol
3983 -Wmissing-field-initializers  @gol
3984 -Wmissing-parameter-type @r{(C only)}  @gol
3985 -Wold-style-declaration @r{(C only)}  @gol
3986 -Woverride-init  @gol
3987 -Wsign-compare @r{(C only)} @gol
3988 -Wtype-limits  @gol
3989 -Wuninitialized  @gol
3990 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3991 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3992 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3995 The option @option{-Wextra} also prints warning messages for the
3996 following cases:
3998 @itemize @bullet
4000 @item
4001 A pointer is compared against integer zero with @code{<}, @code{<=},
4002 @code{>}, or @code{>=}.
4004 @item
4005 (C++ only) An enumerator and a non-enumerator both appear in a
4006 conditional expression.
4008 @item
4009 (C++ only) Ambiguous virtual bases.
4011 @item
4012 (C++ only) Subscripting an array that has been declared @code{register}.
4014 @item
4015 (C++ only) Taking the address of a variable that has been declared
4016 @code{register}.
4018 @item
4019 (C++ only) A base class is not initialized in the copy constructor
4020 of a derived class.
4022 @end itemize
4024 @item -Wchar-subscripts
4025 @opindex Wchar-subscripts
4026 @opindex Wno-char-subscripts
4027 Warn if an array subscript has type @code{char}.  This is a common cause
4028 of error, as programmers often forget that this type is signed on some
4029 machines.
4030 This warning is enabled by @option{-Wall}.
4032 @item -Wchkp
4033 @opindex Wchkp
4034 Warn about an invalid memory access that is found by Pointer Bounds Checker
4035 (@option{-fcheck-pointer-bounds}).
4037 @item -Wno-coverage-mismatch
4038 @opindex Wno-coverage-mismatch
4039 Warn if feedback profiles do not match when using the
4040 @option{-fprofile-use} option.
4041 If a source file is changed between compiling with @option{-fprofile-gen} and
4042 with @option{-fprofile-use}, the files with the profile feedback can fail
4043 to match the source file and GCC cannot use the profile feedback
4044 information.  By default, this warning is enabled and is treated as an
4045 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4046 warning or @option{-Wno-error=coverage-mismatch} can be used to
4047 disable the error.  Disabling the error for this warning can result in
4048 poorly optimized code and is useful only in the
4049 case of very minor changes such as bug fixes to an existing code-base.
4050 Completely disabling the warning is not recommended.
4052 @item -Wno-cpp
4053 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4055 Suppress warning messages emitted by @code{#warning} directives.
4057 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4058 @opindex Wdouble-promotion
4059 @opindex Wno-double-promotion
4060 Give a warning when a value of type @code{float} is implicitly
4061 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4062 floating-point unit implement @code{float} in hardware, but emulate
4063 @code{double} in software.  On such a machine, doing computations
4064 using @code{double} values is much more expensive because of the
4065 overhead required for software emulation.
4067 It is easy to accidentally do computations with @code{double} because
4068 floating-point literals are implicitly of type @code{double}.  For
4069 example, in:
4070 @smallexample
4071 @group
4072 float area(float radius)
4074    return 3.14159 * radius * radius;
4076 @end group
4077 @end smallexample
4078 the compiler performs the entire computation with @code{double}
4079 because the floating-point literal is a @code{double}.
4081 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4082 @opindex Wduplicate-decl-specifier
4083 @opindex Wno-duplicate-decl-specifier
4084 Warn if a declaration has duplicate @code{const}, @code{volatile},
4085 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4086 @option{-Wall}.
4088 @item -Wformat
4089 @itemx -Wformat=@var{n}
4090 @opindex Wformat
4091 @opindex Wno-format
4092 @opindex ffreestanding
4093 @opindex fno-builtin
4094 @opindex Wformat=
4095 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4096 the arguments supplied have types appropriate to the format string
4097 specified, and that the conversions specified in the format string make
4098 sense.  This includes standard functions, and others specified by format
4099 attributes (@pxref{Function Attributes}), in the @code{printf},
4100 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4101 not in the C standard) families (or other target-specific families).
4102 Which functions are checked without format attributes having been
4103 specified depends on the standard version selected, and such checks of
4104 functions without the attribute specified are disabled by
4105 @option{-ffreestanding} or @option{-fno-builtin}.
4107 The formats are checked against the format features supported by GNU
4108 libc version 2.2.  These include all ISO C90 and C99 features, as well
4109 as features from the Single Unix Specification and some BSD and GNU
4110 extensions.  Other library implementations may not support all these
4111 features; GCC does not support warning about features that go beyond a
4112 particular library's limitations.  However, if @option{-Wpedantic} is used
4113 with @option{-Wformat}, warnings are given about format features not
4114 in the selected standard version (but not for @code{strfmon} formats,
4115 since those are not in any version of the C standard).  @xref{C Dialect
4116 Options,,Options Controlling C Dialect}.
4118 @table @gcctabopt
4119 @item -Wformat=1
4120 @itemx -Wformat
4121 @opindex Wformat
4122 @opindex Wformat=1
4123 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4124 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4125 @option{-Wformat} also checks for null format arguments for several
4126 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4127 aspects of this level of format checking can be disabled by the
4128 options: @option{-Wno-format-contains-nul},
4129 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4130 @option{-Wformat} is enabled by @option{-Wall}.
4132 @item -Wno-format-contains-nul
4133 @opindex Wno-format-contains-nul
4134 @opindex Wformat-contains-nul
4135 If @option{-Wformat} is specified, do not warn about format strings that
4136 contain NUL bytes.
4138 @item -Wno-format-extra-args
4139 @opindex Wno-format-extra-args
4140 @opindex Wformat-extra-args
4141 If @option{-Wformat} is specified, do not warn about excess arguments to a
4142 @code{printf} or @code{scanf} format function.  The C standard specifies
4143 that such arguments are ignored.
4145 Where the unused arguments lie between used arguments that are
4146 specified with @samp{$} operand number specifications, normally
4147 warnings are still given, since the implementation could not know what
4148 type to pass to @code{va_arg} to skip the unused arguments.  However,
4149 in the case of @code{scanf} formats, this option suppresses the
4150 warning if the unused arguments are all pointers, since the Single
4151 Unix Specification says that such unused arguments are allowed.
4153 @item -Wformat-overflow
4154 @itemx -Wformat-overflow=@var{level}
4155 @opindex Wformat-overflow
4156 @opindex Wno-format-overflow
4157 Warn about calls to formatted input/output functions such as @code{sprintf}
4158 and @code{vsprintf} that might overflow the destination buffer.  When the
4159 exact number of bytes written by a format directive cannot be determined
4160 at compile-time it is estimated based on heuristics that depend on the
4161 @var{level} argument and on optimization.  While enabling optimization
4162 will in most cases improve the accuracy of the warning, it may also
4163 result in false positives.
4165 @table @gcctabopt
4166 @item -Wformat-overflow
4167 @itemx -Wformat-overflow=1
4168 @opindex Wformat-overflow
4169 @opindex Wno-format-overflow
4170 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4171 employs a conservative approach that warns only about calls that most
4172 likely overflow the buffer.  At this level, numeric arguments to format
4173 directives with unknown values are assumed to have the value of one, and
4174 strings of unknown length to be empty.  Numeric arguments that are known
4175 to be bounded to a subrange of their type, or string arguments whose output
4176 is bounded either by their directive's precision or by a finite set of
4177 string literals, are assumed to take on the value within the range that
4178 results in the most bytes on output.  For example, the call to @code{sprintf}
4179 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4180 the terminating NUL character (@code{'\0'}) appended by the function
4181 to the destination buffer will be written past its end.  Increasing
4182 the size of the buffer by a single byte is sufficient to avoid the
4183 warning, though it may not be sufficient to avoid the overflow.
4185 @smallexample
4186 void f (int a, int b)
4188   char buf [13];
4189   sprintf (buf, "a = %i, b = %i\n", a, b);
4191 @end smallexample
4193 @item -Wformat-overflow=2
4194 Level @var{2} warns also about calls that might overflow the destination
4195 buffer given an argument of sufficient length or magnitude.  At level
4196 @var{2}, unknown numeric arguments are assumed to have the minimum
4197 representable value for signed types with a precision greater than 1, and
4198 the maximum representable value otherwise.  Unknown string arguments whose
4199 length cannot be assumed to be bounded either by the directive's precision,
4200 or by a finite set of string literals they may evaluate to, or the character
4201 array they may point to, are assumed to be 1 character long.
4203 At level @var{2}, the call in the example above is again diagnosed, but
4204 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4205 @code{%i} directive will write some of its digits beyond the end of
4206 the destination buffer.  To make the call safe regardless of the values
4207 of the two variables, the size of the destination buffer must be increased
4208 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4209 an informational note following the warning.
4211 An alternative to increasing the size of the destination buffer is to
4212 constrain the range of formatted values.  The maximum length of string
4213 arguments can be bounded by specifying the precision in the format
4214 directive.  When numeric arguments of format directives can be assumed
4215 to be bounded by less than the precision of their type, choosing
4216 an appropriate length modifier to the format specifier will reduce
4217 the required buffer size.  For example, if @var{a} and @var{b} in the
4218 example above can be assumed to be within the precision of
4219 the @code{short int} type then using either the @code{%hi} format
4220 directive or casting the argument to @code{short} reduces the maximum
4221 required size of the buffer to 24 bytes.
4223 @smallexample
4224 void f (int a, int b)
4226   char buf [23];
4227   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4229 @end smallexample
4230 @end table
4232 @item -Wno-format-zero-length
4233 @opindex Wno-format-zero-length
4234 @opindex Wformat-zero-length
4235 If @option{-Wformat} is specified, do not warn about zero-length formats.
4236 The C standard specifies that zero-length formats are allowed.
4239 @item -Wformat=2
4240 @opindex Wformat=2
4241 Enable @option{-Wformat} plus additional format checks.  Currently
4242 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4243 -Wformat-y2k}.
4245 @item -Wformat-nonliteral
4246 @opindex Wformat-nonliteral
4247 @opindex Wno-format-nonliteral
4248 If @option{-Wformat} is specified, also warn if the format string is not a
4249 string literal and so cannot be checked, unless the format function
4250 takes its format arguments as a @code{va_list}.
4252 @item -Wformat-security
4253 @opindex Wformat-security
4254 @opindex Wno-format-security
4255 If @option{-Wformat} is specified, also warn about uses of format
4256 functions that represent possible security problems.  At present, this
4257 warns about calls to @code{printf} and @code{scanf} functions where the
4258 format string is not a string literal and there are no format arguments,
4259 as in @code{printf (foo);}.  This may be a security hole if the format
4260 string came from untrusted input and contains @samp{%n}.  (This is
4261 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4262 in future warnings may be added to @option{-Wformat-security} that are not
4263 included in @option{-Wformat-nonliteral}.)
4265 @item -Wformat-signedness
4266 @opindex Wformat-signedness
4267 @opindex Wno-format-signedness
4268 If @option{-Wformat} is specified, also warn if the format string
4269 requires an unsigned argument and the argument is signed and vice versa.
4271 @item -Wformat-truncation
4272 @itemx -Wformat-truncation=@var{level}
4273 @opindex Wformat-truncation
4274 @opindex Wno-format-truncation
4275 Warn about calls to formatted input/output functions such as @code{snprintf}
4276 and @code{vsnprintf} that might result in output truncation.  When the exact
4277 number of bytes written by a format directive cannot be determined at
4278 compile-time it is estimated based on heuristics that depend on
4279 the @var{level} argument and on optimization.  While enabling optimization
4280 will in most cases improve the accuracy of the warning, it may also result
4281 in false positives.  Except as noted otherwise, the option uses the same
4282 logic @option{-Wformat-overflow}.
4284 @table @gcctabopt
4285 @item -Wformat-truncation
4286 @itemx -Wformat-truncation=1
4287 @opindex Wformat-truncation
4288 @opindex Wno-format-overflow
4289 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4290 employs a conservative approach that warns only about calls to bounded
4291 functions whose return value is unused and that will most likely result
4292 in output truncation.
4294 @item -Wformat-truncation=2
4295 Level @var{2} warns also about calls to bounded functions whose return
4296 value is used and that might result in truncation given an argument of
4297 sufficient length or magnitude.
4298 @end table
4300 @item -Wformat-y2k
4301 @opindex Wformat-y2k
4302 @opindex Wno-format-y2k
4303 If @option{-Wformat} is specified, also warn about @code{strftime}
4304 formats that may yield only a two-digit year.
4305 @end table
4307 @item -Wnonnull
4308 @opindex Wnonnull
4309 @opindex Wno-nonnull
4310 Warn about passing a null pointer for arguments marked as
4311 requiring a non-null value by the @code{nonnull} function attribute.
4313 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4314 can be disabled with the @option{-Wno-nonnull} option.
4316 @item -Wnonnull-compare
4317 @opindex Wnonnull-compare
4318 @opindex Wno-nonnull-compare
4319 Warn when comparing an argument marked with the @code{nonnull}
4320 function attribute against null inside the function.
4322 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4323 can be disabled with the @option{-Wno-nonnull-compare} option.
4325 @item -Wnull-dereference
4326 @opindex Wnull-dereference
4327 @opindex Wno-null-dereference
4328 Warn if the compiler detects paths that trigger erroneous or
4329 undefined behavior due to dereferencing a null pointer.  This option
4330 is only active when @option{-fdelete-null-pointer-checks} is active,
4331 which is enabled by optimizations in most targets.  The precision of
4332 the warnings depends on the optimization options used.
4334 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4335 @opindex Winit-self
4336 @opindex Wno-init-self
4337 Warn about uninitialized variables that are initialized with themselves.
4338 Note this option can only be used with the @option{-Wuninitialized} option.
4340 For example, GCC warns about @code{i} being uninitialized in the
4341 following snippet only when @option{-Winit-self} has been specified:
4342 @smallexample
4343 @group
4344 int f()
4346   int i = i;
4347   return i;
4349 @end group
4350 @end smallexample
4352 This warning is enabled by @option{-Wall} in C++.
4354 @item -Wimplicit-int @r{(C and Objective-C only)}
4355 @opindex Wimplicit-int
4356 @opindex Wno-implicit-int
4357 Warn when a declaration does not specify a type.
4358 This warning is enabled by @option{-Wall}.
4360 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4361 @opindex Wimplicit-function-declaration
4362 @opindex Wno-implicit-function-declaration
4363 Give a warning whenever a function is used before being declared. In
4364 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4365 enabled by default and it is made into an error by
4366 @option{-pedantic-errors}. This warning is also enabled by
4367 @option{-Wall}.
4369 @item -Wimplicit @r{(C and Objective-C only)}
4370 @opindex Wimplicit
4371 @opindex Wno-implicit
4372 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4373 This warning is enabled by @option{-Wall}.
4375 @item -Wimplicit-fallthrough
4376 @opindex Wimplicit-fallthrough
4377 @opindex Wno-implicit-fallthrough
4378 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4379 and @option{-Wno-implicit-fallthrough} is the same as
4380 @option{-Wimplicit-fallthrough=0}.
4382 @item -Wimplicit-fallthrough=@var{n}
4383 @opindex Wimplicit-fallthrough=
4384 Warn when a switch case falls through.  For example:
4386 @smallexample
4387 @group
4388 switch (cond)
4389   @{
4390   case 1:
4391     a = 1;
4392     break;
4393   case 2:
4394     a = 2;
4395   case 3:
4396     a = 3;
4397     break;
4398   @}
4399 @end group
4400 @end smallexample
4402 This warning does not warn when the last statement of a case cannot
4403 fall through, e.g. when there is a return statement or a call to function
4404 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4405 also takes into account control flow statements, such as ifs, and only
4406 warns when appropriate.  E.g.@:
4408 @smallexample
4409 @group
4410 switch (cond)
4411   @{
4412   case 1:
4413     if (i > 3) @{
4414       bar (5);
4415       break;
4416     @} else if (i < 1) @{
4417       bar (0);
4418     @} else
4419       return;
4420   default:
4421     @dots{}
4422   @}
4423 @end group
4424 @end smallexample
4426 Since there are occasions where a switch case fall through is desirable,
4427 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4428 to be used along with a null statement to suppress this warning that
4429 would normally occur:
4431 @smallexample
4432 @group
4433 switch (cond)
4434   @{
4435   case 1:
4436     bar (0);
4437     __attribute__ ((fallthrough));
4438   default:
4439     @dots{}
4440   @}
4441 @end group
4442 @end smallexample
4444 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4445 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4446 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4447 Instead of these attributes, it is also possible to add a fallthrough comment
4448 to silence the warning.  The whole body of the C or C++ style comment should
4449 match the given regular expressions listed below.  The option argument @var{n}
4450 specifies what kind of comments are accepted:
4452 @itemize @bullet
4454 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4456 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4457 expression, any comment is used as fallthrough comment.
4459 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4460 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4462 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4463 following regular expressions:
4465 @itemize @bullet
4467 @item @code{-fallthrough}
4469 @item @code{@@fallthrough@@}
4471 @item @code{lint -fallthrough[ \t]*}
4473 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4475 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4477 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4479 @end itemize
4481 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4482 following regular expressions:
4484 @itemize @bullet
4486 @item @code{-fallthrough}
4488 @item @code{@@fallthrough@@}
4490 @item @code{lint -fallthrough[ \t]*}
4492 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4494 @end itemize
4496 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4497 fallthrough comments, only attributes disable the warning.
4499 @end itemize
4501 The comment needs to be followed after optional whitespace and other comments
4502 by @code{case} or @code{default} keywords or by a user label that precedes some
4503 @code{case} or @code{default} label.
4505 @smallexample
4506 @group
4507 switch (cond)
4508   @{
4509   case 1:
4510     bar (0);
4511     /* FALLTHRU */
4512   default:
4513     @dots{}
4514   @}
4515 @end group
4516 @end smallexample
4518 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4520 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4521 @opindex Wif-not-aligned
4522 @opindex Wno-if-not-aligned
4523 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4524 should be issued.  This is is enabled by default.
4525 Use @option{-Wno-if-not-aligned} to disable it.
4527 @item -Wignored-qualifiers @r{(C and C++ only)}
4528 @opindex Wignored-qualifiers
4529 @opindex Wno-ignored-qualifiers
4530 Warn if the return type of a function has a type qualifier
4531 such as @code{const}.  For ISO C such a type qualifier has no effect,
4532 since the value returned by a function is not an lvalue.
4533 For C++, the warning is only emitted for scalar types or @code{void}.
4534 ISO C prohibits qualified @code{void} return types on function
4535 definitions, so such return types always receive a warning
4536 even without this option.
4538 This warning is also enabled by @option{-Wextra}.
4540 @item -Wignored-attributes @r{(C and C++ only)}
4541 @opindex Wignored-attributes
4542 @opindex Wno-ignored-attributes
4543 Warn when an attribute is ignored.  This is different from the
4544 @option{-Wattributes} option in that it warns whenever the compiler decides
4545 to drop an attribute, not that the attribute is either unknown, used in a
4546 wrong place, etc.  This warning is enabled by default.
4548 @item -Wmain
4549 @opindex Wmain
4550 @opindex Wno-main
4551 Warn if the type of @code{main} is suspicious.  @code{main} should be
4552 a function with external linkage, returning int, taking either zero
4553 arguments, two, or three arguments of appropriate types.  This warning
4554 is enabled by default in C++ and is enabled by either @option{-Wall}
4555 or @option{-Wpedantic}.
4557 @item -Wmisleading-indentation @r{(C and C++ only)}
4558 @opindex Wmisleading-indentation
4559 @opindex Wno-misleading-indentation
4560 Warn when the indentation of the code does not reflect the block structure.
4561 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4562 @code{for} clauses with a guarded statement that does not use braces,
4563 followed by an unguarded statement with the same indentation.
4565 In the following example, the call to ``bar'' is misleadingly indented as
4566 if it were guarded by the ``if'' conditional.
4568 @smallexample
4569   if (some_condition ())
4570     foo ();
4571     bar ();  /* Gotcha: this is not guarded by the "if".  */
4572 @end smallexample
4574 In the case of mixed tabs and spaces, the warning uses the
4575 @option{-ftabstop=} option to determine if the statements line up
4576 (defaulting to 8).
4578 The warning is not issued for code involving multiline preprocessor logic
4579 such as the following example.
4581 @smallexample
4582   if (flagA)
4583     foo (0);
4584 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4585   if (flagB)
4586 #endif
4587     foo (1);
4588 @end smallexample
4590 The warning is not issued after a @code{#line} directive, since this
4591 typically indicates autogenerated code, and no assumptions can be made
4592 about the layout of the file that the directive references.
4594 This warning is enabled by @option{-Wall} in C and C++.
4596 @item -Wmissing-attributes
4597 @opindex Wmissing-attributes
4598 @opindex Wno-missing-attributes
4599 Warn when a declaration of a function is missing one or more attributes
4600 that a related function is declared with and whose absence may adversely
4601 affect the correctness or efficiency of generated code.  For example, in
4602 C++, the warning is issued when an explicit specialization of a primary
4603 template declared with attribute @code{alloc_align}, @code{alloc_size},
4604 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4605 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4606 @code{error}, and @code{warning} suppress the warning.
4607 (@pxref{Function Attributes}).
4609 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4611 For example, since the declaration of the primary function template
4612 below makes use of both attribute @code{malloc} and @code{alloc_size}
4613 the declaration of the explicit specialization of the template is
4614 diagnosed because it is missing one of the attributes.
4616 @smallexample
4617 template <class T>
4618 T* __attribute__ ((malloc, alloc_size (1)))
4619 allocate (size_t);
4621 template <>
4622 void* __attribute__ ((malloc))   // missing alloc_size
4623 allocate<void> (size_t);
4624 @end smallexample
4626 @item -Wmissing-braces
4627 @opindex Wmissing-braces
4628 @opindex Wno-missing-braces
4629 Warn if an aggregate or union initializer is not fully bracketed.  In
4630 the following example, the initializer for @code{a} is not fully
4631 bracketed, but that for @code{b} is fully bracketed.  This warning is
4632 enabled by @option{-Wall} in C.
4634 @smallexample
4635 int a[2][2] = @{ 0, 1, 2, 3 @};
4636 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4637 @end smallexample
4639 This warning is enabled by @option{-Wall}.
4641 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4642 @opindex Wmissing-include-dirs
4643 @opindex Wno-missing-include-dirs
4644 Warn if a user-supplied include directory does not exist.
4646 @item -Wmultistatement-macros
4647 @opindex Wmultistatement-macros
4648 @opindex Wno-multistatement-macros
4649 Warn about unsafe multiple statement macros that appear to be guarded
4650 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4651 @code{while}, in which only the first statement is actually guarded after
4652 the macro is expanded.
4654 For example:
4656 @smallexample
4657 #define DOIT x++; y++
4658 if (c)
4659   DOIT;
4660 @end smallexample
4662 will increment @code{y} unconditionally, not just when @code{c} holds.
4663 The can usually be fixed by wrapping the macro in a do-while loop:
4664 @smallexample
4665 #define DOIT do @{ x++; y++; @} while (0)
4666 if (c)
4667   DOIT;
4668 @end smallexample
4670 This warning is enabled by @option{-Wall} in C and C++.
4672 @item -Wparentheses
4673 @opindex Wparentheses
4674 @opindex Wno-parentheses
4675 Warn if parentheses are omitted in certain contexts, such
4676 as when there is an assignment in a context where a truth value
4677 is expected, or when operators are nested whose precedence people
4678 often get confused about.
4680 Also warn if a comparison like @code{x<=y<=z} appears; this is
4681 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4682 interpretation from that of ordinary mathematical notation.
4684 Also warn for dangerous uses of the GNU extension to
4685 @code{?:} with omitted middle operand. When the condition
4686 in the @code{?}: operator is a boolean expression, the omitted value is
4687 always 1.  Often programmers expect it to be a value computed
4688 inside the conditional expression instead.
4690 For C++ this also warns for some cases of unnecessary parentheses in
4691 declarations, which can indicate an attempt at a function call instead
4692 of a declaration:
4693 @smallexample
4695   // Declares a local variable called mymutex.
4696   std::unique_lock<std::mutex> (mymutex);
4697   // User meant std::unique_lock<std::mutex> lock (mymutex);
4699 @end smallexample
4701 This warning is enabled by @option{-Wall}.
4703 @item -Wsequence-point
4704 @opindex Wsequence-point
4705 @opindex Wno-sequence-point
4706 Warn about code that may have undefined semantics because of violations
4707 of sequence point rules in the C and C++ standards.
4709 The C and C++ standards define the order in which expressions in a C/C++
4710 program are evaluated in terms of @dfn{sequence points}, which represent
4711 a partial ordering between the execution of parts of the program: those
4712 executed before the sequence point, and those executed after it.  These
4713 occur after the evaluation of a full expression (one which is not part
4714 of a larger expression), after the evaluation of the first operand of a
4715 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4716 function is called (but after the evaluation of its arguments and the
4717 expression denoting the called function), and in certain other places.
4718 Other than as expressed by the sequence point rules, the order of
4719 evaluation of subexpressions of an expression is not specified.  All
4720 these rules describe only a partial order rather than a total order,
4721 since, for example, if two functions are called within one expression
4722 with no sequence point between them, the order in which the functions
4723 are called is not specified.  However, the standards committee have
4724 ruled that function calls do not overlap.
4726 It is not specified when between sequence points modifications to the
4727 values of objects take effect.  Programs whose behavior depends on this
4728 have undefined behavior; the C and C++ standards specify that ``Between
4729 the previous and next sequence point an object shall have its stored
4730 value modified at most once by the evaluation of an expression.
4731 Furthermore, the prior value shall be read only to determine the value
4732 to be stored.''.  If a program breaks these rules, the results on any
4733 particular implementation are entirely unpredictable.
4735 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4736 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4737 diagnosed by this option, and it may give an occasional false positive
4738 result, but in general it has been found fairly effective at detecting
4739 this sort of problem in programs.
4741 The C++17 standard will define the order of evaluation of operands in
4742 more cases: in particular it requires that the right-hand side of an
4743 assignment be evaluated before the left-hand side, so the above
4744 examples are no longer undefined.  But this warning will still warn
4745 about them, to help people avoid writing code that is undefined in C
4746 and earlier revisions of C++.
4748 The standard is worded confusingly, therefore there is some debate
4749 over the precise meaning of the sequence point rules in subtle cases.
4750 Links to discussions of the problem, including proposed formal
4751 definitions, may be found on the GCC readings page, at
4752 @uref{http://gcc.gnu.org/@/readings.html}.
4754 This warning is enabled by @option{-Wall} for C and C++.
4756 @item -Wno-return-local-addr
4757 @opindex Wno-return-local-addr
4758 @opindex Wreturn-local-addr
4759 Do not warn about returning a pointer (or in C++, a reference) to a
4760 variable that goes out of scope after the function returns.
4762 @item -Wreturn-type
4763 @opindex Wreturn-type
4764 @opindex Wno-return-type
4765 Warn whenever a function is defined with a return type that defaults
4766 to @code{int}.  Also warn about any @code{return} statement with no
4767 return value in a function whose return type is not @code{void}
4768 (falling off the end of the function body is considered returning
4769 without a value).
4771 For C only, warn about a @code{return} statement with an expression in a
4772 function whose return type is @code{void}, unless the expression type is
4773 also @code{void}.  As a GNU extension, the latter case is accepted
4774 without a warning unless @option{-Wpedantic} is used.
4776 For C++, a function without return type always produces a diagnostic
4777 message, even when @option{-Wno-return-type} is specified.  The only
4778 exceptions are @code{main} and functions defined in system headers.
4780 This warning is enabled by @option{-Wall}.
4782 @item -Wshift-count-negative
4783 @opindex Wshift-count-negative
4784 @opindex Wno-shift-count-negative
4785 Warn if shift count is negative. This warning is enabled by default.
4787 @item -Wshift-count-overflow
4788 @opindex Wshift-count-overflow
4789 @opindex Wno-shift-count-overflow
4790 Warn if shift count >= width of type. This warning is enabled by default.
4792 @item -Wshift-negative-value
4793 @opindex Wshift-negative-value
4794 @opindex Wno-shift-negative-value
4795 Warn if left shifting a negative value.  This warning is enabled by
4796 @option{-Wextra} in C99 and C++11 modes (and newer).
4798 @item -Wshift-overflow
4799 @itemx -Wshift-overflow=@var{n}
4800 @opindex Wshift-overflow
4801 @opindex Wno-shift-overflow
4802 Warn about left shift overflows.  This warning is enabled by
4803 default in C99 and C++11 modes (and newer).
4805 @table @gcctabopt
4806 @item -Wshift-overflow=1
4807 This is the warning level of @option{-Wshift-overflow} and is enabled
4808 by default in C99 and C++11 modes (and newer).  This warning level does
4809 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4810 an overflow is still rejected in contexts where an integer constant expression
4811 is required.)
4813 @item -Wshift-overflow=2
4814 This warning level also warns about left-shifting 1 into the sign bit,
4815 unless C++14 mode is active.
4816 @end table
4818 @item -Wswitch
4819 @opindex Wswitch
4820 @opindex Wno-switch
4821 Warn whenever a @code{switch} statement has an index of enumerated type
4822 and lacks a @code{case} for one or more of the named codes of that
4823 enumeration.  (The presence of a @code{default} label prevents this
4824 warning.)  @code{case} labels outside the enumeration range also
4825 provoke warnings when this option is used (even if there is a
4826 @code{default} label).
4827 This warning is enabled by @option{-Wall}.
4829 @item -Wswitch-default
4830 @opindex Wswitch-default
4831 @opindex Wno-switch-default
4832 Warn whenever a @code{switch} statement does not have a @code{default}
4833 case.
4835 @item -Wswitch-enum
4836 @opindex Wswitch-enum
4837 @opindex Wno-switch-enum
4838 Warn whenever a @code{switch} statement has an index of enumerated type
4839 and lacks a @code{case} for one or more of the named codes of that
4840 enumeration.  @code{case} labels outside the enumeration range also
4841 provoke warnings when this option is used.  The only difference
4842 between @option{-Wswitch} and this option is that this option gives a
4843 warning about an omitted enumeration code even if there is a
4844 @code{default} label.
4846 @item -Wswitch-bool
4847 @opindex Wswitch-bool
4848 @opindex Wno-switch-bool
4849 Warn whenever a @code{switch} statement has an index of boolean type
4850 and the case values are outside the range of a boolean type.
4851 It is possible to suppress this warning by casting the controlling
4852 expression to a type other than @code{bool}.  For example:
4853 @smallexample
4854 @group
4855 switch ((int) (a == 4))
4856   @{
4857   @dots{}
4858   @}
4859 @end group
4860 @end smallexample
4861 This warning is enabled by default for C and C++ programs.
4863 @item -Wswitch-unreachable
4864 @opindex Wswitch-unreachable
4865 @opindex Wno-switch-unreachable
4866 Warn whenever a @code{switch} statement contains statements between the
4867 controlling expression and the first case label, which will never be
4868 executed.  For example:
4869 @smallexample
4870 @group
4871 switch (cond)
4872   @{
4873    i = 15;
4874   @dots{}
4875    case 5:
4876   @dots{}
4877   @}
4878 @end group
4879 @end smallexample
4880 @option{-Wswitch-unreachable} does not warn if the statement between the
4881 controlling expression and the first case label is just a declaration:
4882 @smallexample
4883 @group
4884 switch (cond)
4885   @{
4886    int i;
4887   @dots{}
4888    case 5:
4889    i = 5;
4890   @dots{}
4891   @}
4892 @end group
4893 @end smallexample
4894 This warning is enabled by default for C and C++ programs.
4896 @item -Wsync-nand @r{(C and C++ only)}
4897 @opindex Wsync-nand
4898 @opindex Wno-sync-nand
4899 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4900 built-in functions are used.  These functions changed semantics in GCC 4.4.
4902 @item -Wunused-but-set-parameter
4903 @opindex Wunused-but-set-parameter
4904 @opindex Wno-unused-but-set-parameter
4905 Warn whenever a function parameter is assigned to, but otherwise unused
4906 (aside from its declaration).
4908 To suppress this warning use the @code{unused} attribute
4909 (@pxref{Variable Attributes}).
4911 This warning is also enabled by @option{-Wunused} together with
4912 @option{-Wextra}.
4914 @item -Wunused-but-set-variable
4915 @opindex Wunused-but-set-variable
4916 @opindex Wno-unused-but-set-variable
4917 Warn whenever a local variable is assigned to, but otherwise unused
4918 (aside from its declaration).
4919 This warning is enabled by @option{-Wall}.
4921 To suppress this warning use the @code{unused} attribute
4922 (@pxref{Variable Attributes}).
4924 This warning is also enabled by @option{-Wunused}, which is enabled
4925 by @option{-Wall}.
4927 @item -Wunused-function
4928 @opindex Wunused-function
4929 @opindex Wno-unused-function
4930 Warn whenever a static function is declared but not defined or a
4931 non-inline static function is unused.
4932 This warning is enabled by @option{-Wall}.
4934 @item -Wunused-label
4935 @opindex Wunused-label
4936 @opindex Wno-unused-label
4937 Warn whenever a label is declared but not used.
4938 This warning is enabled by @option{-Wall}.
4940 To suppress this warning use the @code{unused} attribute
4941 (@pxref{Variable Attributes}).
4943 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4944 @opindex Wunused-local-typedefs
4945 Warn when a typedef locally defined in a function is not used.
4946 This warning is enabled by @option{-Wall}.
4948 @item -Wunused-parameter
4949 @opindex Wunused-parameter
4950 @opindex Wno-unused-parameter
4951 Warn whenever a function parameter is unused aside from its declaration.
4953 To suppress this warning use the @code{unused} attribute
4954 (@pxref{Variable Attributes}).
4956 @item -Wno-unused-result
4957 @opindex Wunused-result
4958 @opindex Wno-unused-result
4959 Do not warn if a caller of a function marked with attribute
4960 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4961 its return value. The default is @option{-Wunused-result}.
4963 @item -Wunused-variable
4964 @opindex Wunused-variable
4965 @opindex Wno-unused-variable
4966 Warn whenever a local or static variable is unused aside from its
4967 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4968 but not for C++. This warning is enabled by @option{-Wall}.
4970 To suppress this warning use the @code{unused} attribute
4971 (@pxref{Variable Attributes}).
4973 @item -Wunused-const-variable
4974 @itemx -Wunused-const-variable=@var{n}
4975 @opindex Wunused-const-variable
4976 @opindex Wno-unused-const-variable
4977 Warn whenever a constant static variable is unused aside from its declaration.
4978 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4979 for C, but not for C++. In C this declares variable storage, but in C++ this
4980 is not an error since const variables take the place of @code{#define}s.
4982 To suppress this warning use the @code{unused} attribute
4983 (@pxref{Variable Attributes}).
4985 @table @gcctabopt
4986 @item -Wunused-const-variable=1
4987 This is the warning level that is enabled by @option{-Wunused-variable} for
4988 C.  It warns only about unused static const variables defined in the main
4989 compilation unit, but not about static const variables declared in any
4990 header included.
4992 @item -Wunused-const-variable=2
4993 This warning level also warns for unused constant static variables in
4994 headers (excluding system headers).  This is the warning level of
4995 @option{-Wunused-const-variable} and must be explicitly requested since
4996 in C++ this isn't an error and in C it might be harder to clean up all
4997 headers included.
4998 @end table
5000 @item -Wunused-value
5001 @opindex Wunused-value
5002 @opindex Wno-unused-value
5003 Warn whenever a statement computes a result that is explicitly not
5004 used. To suppress this warning cast the unused expression to
5005 @code{void}. This includes an expression-statement or the left-hand
5006 side of a comma expression that contains no side effects. For example,
5007 an expression such as @code{x[i,j]} causes a warning, while
5008 @code{x[(void)i,j]} does not.
5010 This warning is enabled by @option{-Wall}.
5012 @item -Wunused
5013 @opindex Wunused
5014 @opindex Wno-unused
5015 All the above @option{-Wunused} options combined.
5017 In order to get a warning about an unused function parameter, you must
5018 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5019 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5021 @item -Wuninitialized
5022 @opindex Wuninitialized
5023 @opindex Wno-uninitialized
5024 Warn if an automatic variable is used without first being initialized
5025 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5026 warn if a non-static reference or non-static @code{const} member
5027 appears in a class without constructors.
5029 If you want to warn about code that uses the uninitialized value of the
5030 variable in its own initializer, use the @option{-Winit-self} option.
5032 These warnings occur for individual uninitialized or clobbered
5033 elements of structure, union or array variables as well as for
5034 variables that are uninitialized or clobbered as a whole.  They do
5035 not occur for variables or elements declared @code{volatile}.  Because
5036 these warnings depend on optimization, the exact variables or elements
5037 for which there are warnings depends on the precise optimization
5038 options and version of GCC used.
5040 Note that there may be no warning about a variable that is used only
5041 to compute a value that itself is never used, because such
5042 computations may be deleted by data flow analysis before the warnings
5043 are printed.
5045 @item -Winvalid-memory-model
5046 @opindex Winvalid-memory-model
5047 @opindex Wno-invalid-memory-model
5048 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5049 and the C11 atomic generic functions with a memory consistency argument
5050 that is either invalid for the operation or outside the range of values
5051 of the @code{memory_order} enumeration.  For example, since the
5052 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5053 defined for the relaxed, release, and sequentially consistent memory
5054 orders the following code is diagnosed:
5056 @smallexample
5057 void store (int *i)
5059   __atomic_store_n (i, 0, memory_order_consume);
5061 @end smallexample
5063 @option{-Winvalid-memory-model} is enabled by default.
5065 @item -Wmaybe-uninitialized
5066 @opindex Wmaybe-uninitialized
5067 @opindex Wno-maybe-uninitialized
5068 For an automatic (i.e.@ local) variable, if there exists a path from the
5069 function entry to a use of the variable that is initialized, but there exist
5070 some other paths for which the variable is not initialized, the compiler
5071 emits a warning if it cannot prove the uninitialized paths are not
5072 executed at run time.
5074 These warnings are only possible in optimizing compilation, because otherwise
5075 GCC does not keep track of the state of variables.
5077 These warnings are made optional because GCC may not be able to determine when
5078 the code is correct in spite of appearing to have an error.  Here is one
5079 example of how this can happen:
5081 @smallexample
5082 @group
5084   int x;
5085   switch (y)
5086     @{
5087     case 1: x = 1;
5088       break;
5089     case 2: x = 4;
5090       break;
5091     case 3: x = 5;
5092     @}
5093   foo (x);
5095 @end group
5096 @end smallexample
5098 @noindent
5099 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5100 always initialized, but GCC doesn't know this. To suppress the
5101 warning, you need to provide a default case with assert(0) or
5102 similar code.
5104 @cindex @code{longjmp} warnings
5105 This option also warns when a non-volatile automatic variable might be
5106 changed by a call to @code{longjmp}.
5107 The compiler sees only the calls to @code{setjmp}.  It cannot know
5108 where @code{longjmp} will be called; in fact, a signal handler could
5109 call it at any point in the code.  As a result, you may get a warning
5110 even when there is in fact no problem because @code{longjmp} cannot
5111 in fact be called at the place that would cause a problem.
5113 Some spurious warnings can be avoided if you declare all the functions
5114 you use that never return as @code{noreturn}.  @xref{Function
5115 Attributes}.
5117 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5119 @item -Wunknown-pragmas
5120 @opindex Wunknown-pragmas
5121 @opindex Wno-unknown-pragmas
5122 @cindex warning for unknown pragmas
5123 @cindex unknown pragmas, warning
5124 @cindex pragmas, warning of unknown
5125 Warn when a @code{#pragma} directive is encountered that is not understood by 
5126 GCC@.  If this command-line option is used, warnings are even issued
5127 for unknown pragmas in system header files.  This is not the case if
5128 the warnings are only enabled by the @option{-Wall} command-line option.
5130 @item -Wno-pragmas
5131 @opindex Wno-pragmas
5132 @opindex Wpragmas
5133 Do not warn about misuses of pragmas, such as incorrect parameters,
5134 invalid syntax, or conflicts between pragmas.  See also
5135 @option{-Wunknown-pragmas}.
5137 @item -Wstrict-aliasing
5138 @opindex Wstrict-aliasing
5139 @opindex Wno-strict-aliasing
5140 This option is only active when @option{-fstrict-aliasing} is active.
5141 It warns about code that might break the strict aliasing rules that the
5142 compiler is using for optimization.  The warning does not catch all
5143 cases, but does attempt to catch the more common pitfalls.  It is
5144 included in @option{-Wall}.
5145 It is equivalent to @option{-Wstrict-aliasing=3}
5147 @item -Wstrict-aliasing=n
5148 @opindex Wstrict-aliasing=n
5149 This option is only active when @option{-fstrict-aliasing} is active.
5150 It warns about code that might break the strict aliasing rules that the
5151 compiler is using for optimization.
5152 Higher levels correspond to higher accuracy (fewer false positives).
5153 Higher levels also correspond to more effort, similar to the way @option{-O} 
5154 works.
5155 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5157 Level 1: Most aggressive, quick, least accurate.
5158 Possibly useful when higher levels
5159 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5160 false negatives.  However, it has many false positives.
5161 Warns for all pointer conversions between possibly incompatible types,
5162 even if never dereferenced.  Runs in the front end only.
5164 Level 2: Aggressive, quick, not too precise.
5165 May still have many false positives (not as many as level 1 though),
5166 and few false negatives (but possibly more than level 1).
5167 Unlike level 1, it only warns when an address is taken.  Warns about
5168 incomplete types.  Runs in the front end only.
5170 Level 3 (default for @option{-Wstrict-aliasing}):
5171 Should have very few false positives and few false
5172 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5173 Takes care of the common pun+dereference pattern in the front end:
5174 @code{*(int*)&some_float}.
5175 If optimization is enabled, it also runs in the back end, where it deals
5176 with multiple statement cases using flow-sensitive points-to information.
5177 Only warns when the converted pointer is dereferenced.
5178 Does not warn about incomplete types.
5180 @item -Wstrict-overflow
5181 @itemx -Wstrict-overflow=@var{n}
5182 @opindex Wstrict-overflow
5183 @opindex Wno-strict-overflow
5184 This option is only active when signed overflow is undefined.
5185 It warns about cases where the compiler optimizes based on the
5186 assumption that signed overflow does not occur.  Note that it does not
5187 warn about all cases where the code might overflow: it only warns
5188 about cases where the compiler implements some optimization.  Thus
5189 this warning depends on the optimization level.
5191 An optimization that assumes that signed overflow does not occur is
5192 perfectly safe if the values of the variables involved are such that
5193 overflow never does, in fact, occur.  Therefore this warning can
5194 easily give a false positive: a warning about code that is not
5195 actually a problem.  To help focus on important issues, several
5196 warning levels are defined.  No warnings are issued for the use of
5197 undefined signed overflow when estimating how many iterations a loop
5198 requires, in particular when determining whether a loop will be
5199 executed at all.
5201 @table @gcctabopt
5202 @item -Wstrict-overflow=1
5203 Warn about cases that are both questionable and easy to avoid.  For
5204 example the compiler simplifies
5205 @code{x + 1 > x} to @code{1}.  This level of
5206 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5207 are not, and must be explicitly requested.
5209 @item -Wstrict-overflow=2
5210 Also warn about other cases where a comparison is simplified to a
5211 constant.  For example: @code{abs (x) >= 0}.  This can only be
5212 simplified when signed integer overflow is undefined, because
5213 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5214 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5215 @option{-Wstrict-overflow=2}.
5217 @item -Wstrict-overflow=3
5218 Also warn about other cases where a comparison is simplified.  For
5219 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5221 @item -Wstrict-overflow=4
5222 Also warn about other simplifications not covered by the above cases.
5223 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5225 @item -Wstrict-overflow=5
5226 Also warn about cases where the compiler reduces the magnitude of a
5227 constant involved in a comparison.  For example: @code{x + 2 > y} is
5228 simplified to @code{x + 1 >= y}.  This is reported only at the
5229 highest warning level because this simplification applies to many
5230 comparisons, so this warning level gives a very large number of
5231 false positives.
5232 @end table
5234 @item -Wstringop-overflow
5235 @itemx -Wstringop-overflow=@var{type}
5236 @opindex Wstringop-overflow
5237 @opindex Wno-stringop-overflow
5238 Warn for calls to string manipulation functions such as @code{memcpy} and
5239 @code{strcpy} that are determined to overflow the destination buffer.  The
5240 optional argument is one greater than the type of Object Size Checking to
5241 perform to determine the size of the destination.  @xref{Object Size Checking}.
5242 The argument is meaningful only for functions that operate on character arrays
5243 but not for raw memory functions like @code{memcpy} which always make use
5244 of Object Size type-0.  The option also warns for calls that specify a size
5245 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5246 The option produces the best results with optimization enabled but can detect
5247 a small subset of simple buffer overflows even without optimization in
5248 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5249 correspond to the standard functions.  In any case, the option warns about
5250 just a subset of buffer overflows detected by the corresponding overflow
5251 checking built-ins.  For example, the option will issue a warning for
5252 the @code{strcpy} call below because it copies at least 5 characters
5253 (the string @code{"blue"} including the terminating NUL) into the buffer
5254 of size 4.
5256 @smallexample
5257 enum Color @{ blue, purple, yellow @};
5258 const char* f (enum Color clr)
5260   static char buf [4];
5261   const char *str;
5262   switch (clr)
5263     @{
5264       case blue: str = "blue"; break;
5265       case purple: str = "purple"; break;
5266       case yellow: str = "yellow"; break;
5267     @}
5269   return strcpy (buf, str);   // warning here
5271 @end smallexample
5273 Option @option{-Wstringop-overflow=2} is enabled by default.
5275 @table @gcctabopt
5276 @item -Wstringop-overflow
5277 @itemx -Wstringop-overflow=1
5278 @opindex Wstringop-overflow
5279 @opindex Wno-stringop-overflow
5280 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5281 to determine the sizes of destination objects.  This is the default setting
5282 of the option.  At this setting the option will not warn for writes past
5283 the end of subobjects of larger objects accessed by pointers unless the
5284 size of the largest surrounding object is known.  When the destination may
5285 be one of several objects it is assumed to be the largest one of them.  On
5286 Linux systems, when optimization is enabled at this setting the option warns
5287 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5288 a non-zero value.
5290 @item -Wstringop-overflow=2
5291 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5292 to determine the sizes of destination objects.  At this setting the option
5293 will warn about overflows when writing to members of the largest complete
5294 objects whose exact size is known.  It will, however, not warn for excessive
5295 writes to the same members of unknown objects referenced by pointers since
5296 they may point to arrays containing unknown numbers of elements.
5298 @item -Wstringop-overflow=3
5299 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5300 to determine the sizes of destination objects.  At this setting the option
5301 warns about overflowing the smallest object or data member.  This is the
5302 most restrictive setting of the option that may result in warnings for safe
5303 code.
5305 @item -Wstringop-overflow=4
5306 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5307 to determine the sizes of destination objects.  At this setting the option
5308 will warn about overflowing any data members, and when the destination is
5309 one of several objects it uses the size of the largest of them to decide
5310 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5311 setting of the option may result in warnings for benign code.
5312 @end table
5314 @item -Wstringop-truncation
5315 @opindex Wstringop-truncation
5316 @opindex Wno-stringop-truncation
5317 Warn for calls to bounded string manipulation functions such as @code{strncat},
5318 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5319 or leave the destination unchanged.
5321 In the following example, the call to @code{strncat} specifies a bound that
5322 is less than the length of the source string.  As a result, the copy of
5323 the source will be truncated and so the call is diagnosed.  To avoid the
5324 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5326 @smallexample
5327 void append (char *buf, size_t bufsize)
5329   strncat (buf, ".txt", 3);
5331 @end smallexample
5333 As another example, the following call to @code{strncpy} results in copying
5334 to @code{d} just the characters preceding the terminating NUL, without
5335 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5336 necessarily a NUL-terminated string is a common mistake, and so the call
5337 is diagnosed.  To avoid the warning when the result is not expected to be
5338 NUL-terminated, call @code{memcpy} instead.
5340 @smallexample
5341 void copy (char *d, const char *s)
5343   strncpy (d, s, strlen (s));
5345 @end smallexample
5347 In the following example, the call to @code{strncpy} specifies the size
5348 of the destination buffer as the bound.  If the length of the source
5349 string is equal to or greater than this size the result of the copy will
5350 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5351 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5352 element of the buffer to @code{NUL}.
5354 @smallexample
5355 void copy (const char *s)
5357   char buf[80];
5358   strncpy (buf, s, sizeof buf);
5359   @dots{}
5361 @end smallexample
5363 In situations where a character array is intended to store a sequence
5364 of bytes with no terminating @code{NUL} such an array may be annotated
5365 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5366 however, are not suitable arguments to functions that expect
5367 @code{NUL}-terminated strings.  To help detect accidental misuses of
5368 such arrays GCC issues warnings unless it can prove that the use is
5369 safe.  @xref{Common Variable Attributes}.
5371 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5372 @opindex Wsuggest-attribute=
5373 @opindex Wno-suggest-attribute=
5374 Warn for cases where adding an attribute may be beneficial. The
5375 attributes currently supported are listed below.
5377 @table @gcctabopt
5378 @item -Wsuggest-attribute=pure
5379 @itemx -Wsuggest-attribute=const
5380 @itemx -Wsuggest-attribute=noreturn
5381 @itemx -Wsuggest-attribute=malloc
5382 @opindex Wsuggest-attribute=pure
5383 @opindex Wno-suggest-attribute=pure
5384 @opindex Wsuggest-attribute=const
5385 @opindex Wno-suggest-attribute=const
5386 @opindex Wsuggest-attribute=noreturn
5387 @opindex Wno-suggest-attribute=noreturn
5388 @opindex Wsuggest-attribute=malloc
5389 @opindex Wno-suggest-attribute=malloc
5391 Warn about functions that might be candidates for attributes
5392 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5393 only warns for functions visible in other compilation units or (in the case of
5394 @code{pure} and @code{const}) if it cannot prove that the function returns
5395 normally. A function returns normally if it doesn't contain an infinite loop or
5396 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5397 requires option @option{-fipa-pure-const}, which is enabled by default at
5398 @option{-O} and higher.  Higher optimization levels improve the accuracy
5399 of the analysis.
5401 @item -Wsuggest-attribute=format
5402 @itemx -Wmissing-format-attribute
5403 @opindex Wsuggest-attribute=format
5404 @opindex Wmissing-format-attribute
5405 @opindex Wno-suggest-attribute=format
5406 @opindex Wno-missing-format-attribute
5407 @opindex Wformat
5408 @opindex Wno-format
5410 Warn about function pointers that might be candidates for @code{format}
5411 attributes.  Note these are only possible candidates, not absolute ones.
5412 GCC guesses that function pointers with @code{format} attributes that
5413 are used in assignment, initialization, parameter passing or return
5414 statements should have a corresponding @code{format} attribute in the
5415 resulting type.  I.e.@: the left-hand side of the assignment or
5416 initialization, the type of the parameter variable, or the return type
5417 of the containing function respectively should also have a @code{format}
5418 attribute to avoid the warning.
5420 GCC also warns about function definitions that might be
5421 candidates for @code{format} attributes.  Again, these are only
5422 possible candidates.  GCC guesses that @code{format} attributes
5423 might be appropriate for any function that calls a function like
5424 @code{vprintf} or @code{vscanf}, but this might not always be the
5425 case, and some functions for which @code{format} attributes are
5426 appropriate may not be detected.
5428 @item -Wsuggest-attribute=cold
5429 @opindex Wsuggest-attribute=cold
5430 @opindex Wno-suggest-attribute=cold
5432 Warn about functions that might be candidates for @code{cold} attribute.  This
5433 is based on static detection and generally will only warn about functions which
5434 always leads to a call to another @code{cold} function such as wrappers of
5435 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5436 @end table
5438 @item -Wsuggest-final-types
5439 @opindex Wno-suggest-final-types
5440 @opindex Wsuggest-final-types
5441 Warn about types with virtual methods where code quality would be improved
5442 if the type were declared with the C++11 @code{final} specifier, 
5443 or, if possible,
5444 declared in an anonymous namespace. This allows GCC to more aggressively
5445 devirtualize the polymorphic calls. This warning is more effective with link
5446 time optimization, where the information about the class hierarchy graph is
5447 more complete.
5449 @item -Wsuggest-final-methods
5450 @opindex Wno-suggest-final-methods
5451 @opindex Wsuggest-final-methods
5452 Warn about virtual methods where code quality would be improved if the method
5453 were declared with the C++11 @code{final} specifier, 
5454 or, if possible, its type were
5455 declared in an anonymous namespace or with the @code{final} specifier.
5456 This warning is
5457 more effective with link-time optimization, where the information about the
5458 class hierarchy graph is more complete. It is recommended to first consider
5459 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5460 annotations.
5462 @item -Wsuggest-override
5463 Warn about overriding virtual functions that are not marked with the override
5464 keyword.
5466 @item -Walloc-zero
5467 @opindex Wno-alloc-zero
5468 @opindex Walloc-zero
5469 Warn about calls to allocation functions decorated with attribute
5470 @code{alloc_size} that specify zero bytes, including those to the built-in
5471 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5472 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5473 when called with a zero size differs among implementations (and in the case
5474 of @code{realloc} has been deprecated) relying on it may result in subtle
5475 portability bugs and should be avoided.
5477 @item -Walloc-size-larger-than=@var{n}
5478 Warn about calls to functions decorated with attribute @code{alloc_size}
5479 that attempt to allocate objects larger than the specified number of bytes,
5480 or where the result of the size computation in an integer type with infinite
5481 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5482 may end in one of the standard suffixes designating a multiple of bytes
5483 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5484 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5485 @xref{Function Attributes}.
5487 @item -Walloca
5488 @opindex Wno-alloca
5489 @opindex Walloca
5490 This option warns on all uses of @code{alloca} in the source.
5492 @item -Walloca-larger-than=@var{n}
5493 This option warns on calls to @code{alloca} that are not bounded by a
5494 controlling predicate limiting its argument of integer type to at most
5495 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5496 Arguments of non-integer types are considered unbounded even if they
5497 appear to be constrained to the expected range.
5499 For example, a bounded case of @code{alloca} could be:
5501 @smallexample
5502 void func (size_t n)
5504   void *p;
5505   if (n <= 1000)
5506     p = alloca (n);
5507   else
5508     p = malloc (n);
5509   f (p);
5511 @end smallexample
5513 In the above example, passing @code{-Walloca-larger-than=1000} would not
5514 issue a warning because the call to @code{alloca} is known to be at most
5515 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5516 the compiler would emit a warning.
5518 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5519 controlling predicate constraining its integer argument.  For example:
5521 @smallexample
5522 void func ()
5524   void *p = alloca (n);
5525   f (p);
5527 @end smallexample
5529 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5530 a warning, but this time because of the lack of bounds checking.
5532 Note, that even seemingly correct code involving signed integers could
5533 cause a warning:
5535 @smallexample
5536 void func (signed int n)
5538   if (n < 500)
5539     @{
5540       p = alloca (n);
5541       f (p);
5542     @}
5544 @end smallexample
5546 In the above example, @var{n} could be negative, causing a larger than
5547 expected argument to be implicitly cast into the @code{alloca} call.
5549 This option also warns when @code{alloca} is used in a loop.
5551 This warning is not enabled by @option{-Wall}, and is only active when
5552 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5554 See also @option{-Wvla-larger-than=@var{n}}.
5556 @item -Warray-bounds
5557 @itemx -Warray-bounds=@var{n}
5558 @opindex Wno-array-bounds
5559 @opindex Warray-bounds
5560 This option is only active when @option{-ftree-vrp} is active
5561 (default for @option{-O2} and above). It warns about subscripts to arrays
5562 that are always out of bounds. This warning is enabled by @option{-Wall}.
5564 @table @gcctabopt
5565 @item -Warray-bounds=1
5566 This is the warning level of @option{-Warray-bounds} and is enabled
5567 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5569 @item -Warray-bounds=2
5570 This warning level also warns about out of bounds access for
5571 arrays at the end of a struct and for arrays accessed through
5572 pointers. This warning level may give a larger number of
5573 false positives and is deactivated by default.
5574 @end table
5576 @item -Wattribute-alias
5577 Warn about declarations using the @code{alias} and similar attributes whose
5578 target is incompatible with the type of the alias.  @xref{Function Attributes,
5579 ,Declaring Attributes of Functions}.
5581 @item -Wbool-compare
5582 @opindex Wno-bool-compare
5583 @opindex Wbool-compare
5584 Warn about boolean expression compared with an integer value different from
5585 @code{true}/@code{false}.  For instance, the following comparison is
5586 always false:
5587 @smallexample
5588 int n = 5;
5589 @dots{}
5590 if ((n > 1) == 2) @{ @dots{} @}
5591 @end smallexample
5592 This warning is enabled by @option{-Wall}.
5594 @item -Wbool-operation
5595 @opindex Wno-bool-operation
5596 @opindex Wbool-operation
5597 Warn about suspicious operations on expressions of a boolean type.  For
5598 instance, bitwise negation of a boolean is very likely a bug in the program.
5599 For C, this warning also warns about incrementing or decrementing a boolean,
5600 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5601 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5603 This warning is enabled by @option{-Wall}.
5605 @item -Wduplicated-branches
5606 @opindex Wno-duplicated-branches
5607 @opindex Wduplicated-branches
5608 Warn when an if-else has identical branches.  This warning detects cases like
5609 @smallexample
5610 if (p != NULL)
5611   return 0;
5612 else
5613   return 0;
5614 @end smallexample
5615 It doesn't warn when both branches contain just a null statement.  This warning
5616 also warn for conditional operators:
5617 @smallexample
5618   int i = x ? *p : *p;
5619 @end smallexample
5621 @item -Wduplicated-cond
5622 @opindex Wno-duplicated-cond
5623 @opindex Wduplicated-cond
5624 Warn about duplicated conditions in an if-else-if chain.  For instance,
5625 warn for the following code:
5626 @smallexample
5627 if (p->q != NULL) @{ @dots{} @}
5628 else if (p->q != NULL) @{ @dots{} @}
5629 @end smallexample
5631 @item -Wframe-address
5632 @opindex Wno-frame-address
5633 @opindex Wframe-address
5634 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5635 is called with an argument greater than 0.  Such calls may return indeterminate
5636 values or crash the program.  The warning is included in @option{-Wall}.
5638 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5639 @opindex Wno-discarded-qualifiers
5640 @opindex Wdiscarded-qualifiers
5641 Do not warn if type qualifiers on pointers are being discarded.
5642 Typically, the compiler warns if a @code{const char *} variable is
5643 passed to a function that takes a @code{char *} parameter.  This option
5644 can be used to suppress such a warning.
5646 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5647 @opindex Wno-discarded-array-qualifiers
5648 @opindex Wdiscarded-array-qualifiers
5649 Do not warn if type qualifiers on arrays which are pointer targets
5650 are being discarded. Typically, the compiler warns if a
5651 @code{const int (*)[]} variable is passed to a function that
5652 takes a @code{int (*)[]} parameter.  This option can be used to
5653 suppress such a warning.
5655 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5656 @opindex Wno-incompatible-pointer-types
5657 @opindex Wincompatible-pointer-types
5658 Do not warn when there is a conversion between pointers that have incompatible
5659 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5660 which warns for pointer argument passing or assignment with different
5661 signedness.
5663 @item -Wno-int-conversion @r{(C and Objective-C only)}
5664 @opindex Wno-int-conversion
5665 @opindex Wint-conversion
5666 Do not warn about incompatible integer to pointer and pointer to integer
5667 conversions.  This warning is about implicit conversions; for explicit
5668 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5669 @option{-Wno-pointer-to-int-cast} may be used.
5671 @item -Wno-div-by-zero
5672 @opindex Wno-div-by-zero
5673 @opindex Wdiv-by-zero
5674 Do not warn about compile-time integer division by zero.  Floating-point
5675 division by zero is not warned about, as it can be a legitimate way of
5676 obtaining infinities and NaNs.
5678 @item -Wsystem-headers
5679 @opindex Wsystem-headers
5680 @opindex Wno-system-headers
5681 @cindex warnings from system headers
5682 @cindex system headers, warnings from
5683 Print warning messages for constructs found in system header files.
5684 Warnings from system headers are normally suppressed, on the assumption
5685 that they usually do not indicate real problems and would only make the
5686 compiler output harder to read.  Using this command-line option tells
5687 GCC to emit warnings from system headers as if they occurred in user
5688 code.  However, note that using @option{-Wall} in conjunction with this
5689 option does @emph{not} warn about unknown pragmas in system
5690 headers---for that, @option{-Wunknown-pragmas} must also be used.
5692 @item -Wtautological-compare
5693 @opindex Wtautological-compare
5694 @opindex Wno-tautological-compare
5695 Warn if a self-comparison always evaluates to true or false.  This
5696 warning detects various mistakes such as:
5697 @smallexample
5698 int i = 1;
5699 @dots{}
5700 if (i > i) @{ @dots{} @}
5701 @end smallexample
5703 This warning also warns about bitwise comparisons that always evaluate
5704 to true or false, for instance:
5705 @smallexample
5706 if ((a & 16) == 10) @{ @dots{} @}
5707 @end smallexample
5708 will always be false.
5710 This warning is enabled by @option{-Wall}.
5712 @item -Wtrampolines
5713 @opindex Wtrampolines
5714 @opindex Wno-trampolines
5715 Warn about trampolines generated for pointers to nested functions.
5716 A trampoline is a small piece of data or code that is created at run
5717 time on the stack when the address of a nested function is taken, and is
5718 used to call the nested function indirectly.  For some targets, it is
5719 made up of data only and thus requires no special treatment.  But, for
5720 most targets, it is made up of code and thus requires the stack to be
5721 made executable in order for the program to work properly.
5723 @item -Wfloat-equal
5724 @opindex Wfloat-equal
5725 @opindex Wno-float-equal
5726 Warn if floating-point values are used in equality comparisons.
5728 The idea behind this is that sometimes it is convenient (for the
5729 programmer) to consider floating-point values as approximations to
5730 infinitely precise real numbers.  If you are doing this, then you need
5731 to compute (by analyzing the code, or in some other way) the maximum or
5732 likely maximum error that the computation introduces, and allow for it
5733 when performing comparisons (and when producing output, but that's a
5734 different problem).  In particular, instead of testing for equality, you
5735 should check to see whether the two values have ranges that overlap; and
5736 this is done with the relational operators, so equality comparisons are
5737 probably mistaken.
5739 @item -Wtraditional @r{(C and Objective-C only)}
5740 @opindex Wtraditional
5741 @opindex Wno-traditional
5742 Warn about certain constructs that behave differently in traditional and
5743 ISO C@.  Also warn about ISO C constructs that have no traditional C
5744 equivalent, and/or problematic constructs that should be avoided.
5746 @itemize @bullet
5747 @item
5748 Macro parameters that appear within string literals in the macro body.
5749 In traditional C macro replacement takes place within string literals,
5750 but in ISO C it does not.
5752 @item
5753 In traditional C, some preprocessor directives did not exist.
5754 Traditional preprocessors only considered a line to be a directive
5755 if the @samp{#} appeared in column 1 on the line.  Therefore
5756 @option{-Wtraditional} warns about directives that traditional C
5757 understands but ignores because the @samp{#} does not appear as the
5758 first character on the line.  It also suggests you hide directives like
5759 @code{#pragma} not understood by traditional C by indenting them.  Some
5760 traditional implementations do not recognize @code{#elif}, so this option
5761 suggests avoiding it altogether.
5763 @item
5764 A function-like macro that appears without arguments.
5766 @item
5767 The unary plus operator.
5769 @item
5770 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5771 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5772 constants.)  Note, these suffixes appear in macros defined in the system
5773 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5774 Use of these macros in user code might normally lead to spurious
5775 warnings, however GCC's integrated preprocessor has enough context to
5776 avoid warning in these cases.
5778 @item
5779 A function declared external in one block and then used after the end of
5780 the block.
5782 @item
5783 A @code{switch} statement has an operand of type @code{long}.
5785 @item
5786 A non-@code{static} function declaration follows a @code{static} one.
5787 This construct is not accepted by some traditional C compilers.
5789 @item
5790 The ISO type of an integer constant has a different width or
5791 signedness from its traditional type.  This warning is only issued if
5792 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5793 typically represent bit patterns, are not warned about.
5795 @item
5796 Usage of ISO string concatenation is detected.
5798 @item
5799 Initialization of automatic aggregates.
5801 @item
5802 Identifier conflicts with labels.  Traditional C lacks a separate
5803 namespace for labels.
5805 @item
5806 Initialization of unions.  If the initializer is zero, the warning is
5807 omitted.  This is done under the assumption that the zero initializer in
5808 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5809 initializer warnings and relies on default initialization to zero in the
5810 traditional C case.
5812 @item
5813 Conversions by prototypes between fixed/floating-point values and vice
5814 versa.  The absence of these prototypes when compiling with traditional
5815 C causes serious problems.  This is a subset of the possible
5816 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5818 @item
5819 Use of ISO C style function definitions.  This warning intentionally is
5820 @emph{not} issued for prototype declarations or variadic functions
5821 because these ISO C features appear in your code when using
5822 libiberty's traditional C compatibility macros, @code{PARAMS} and
5823 @code{VPARAMS}.  This warning is also bypassed for nested functions
5824 because that feature is already a GCC extension and thus not relevant to
5825 traditional C compatibility.
5826 @end itemize
5828 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5829 @opindex Wtraditional-conversion
5830 @opindex Wno-traditional-conversion
5831 Warn if a prototype causes a type conversion that is different from what
5832 would happen to the same argument in the absence of a prototype.  This
5833 includes conversions of fixed point to floating and vice versa, and
5834 conversions changing the width or signedness of a fixed-point argument
5835 except when the same as the default promotion.
5837 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5838 @opindex Wdeclaration-after-statement
5839 @opindex Wno-declaration-after-statement
5840 Warn when a declaration is found after a statement in a block.  This
5841 construct, known from C++, was introduced with ISO C99 and is by default
5842 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5844 @item -Wshadow
5845 @opindex Wshadow
5846 @opindex Wno-shadow
5847 Warn whenever a local variable or type declaration shadows another
5848 variable, parameter, type, class member (in C++), or instance variable
5849 (in Objective-C) or whenever a built-in function is shadowed. Note
5850 that in C++, the compiler warns if a local variable shadows an
5851 explicit typedef, but not if it shadows a struct/class/enum.
5852 Same as @option{-Wshadow=global}.
5854 @item -Wno-shadow-ivar @r{(Objective-C only)}
5855 @opindex Wno-shadow-ivar
5856 @opindex Wshadow-ivar
5857 Do not warn whenever a local variable shadows an instance variable in an
5858 Objective-C method.
5860 @item -Wshadow=global
5861 @opindex Wshadow=local
5862 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5864 @item -Wshadow=local
5865 @opindex Wshadow=local
5866 Warn when a local variable shadows another local variable or parameter.
5867 This warning is enabled by @option{-Wshadow=global}.
5869 @item -Wshadow=compatible-local
5870 @opindex Wshadow=compatible-local
5871 Warn when a local variable shadows another local variable or parameter
5872 whose type is compatible with that of the shadowing variable. In C++,
5873 type compatibility here means the type of the shadowing variable can be
5874 converted to that of the shadowed variable. The creation of this flag
5875 (in addition to @option{-Wshadow=local}) is based on the idea that when
5876 a local variable shadows another one of incompatible type, it is most
5877 likely intentional, not a bug or typo, as shown in the following example:
5879 @smallexample
5880 @group
5881 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5883   for (int i = 0; i < N; ++i)
5884   @{
5885     ...
5886   @}
5887   ...
5889 @end group
5890 @end smallexample
5892 Since the two variable @code{i} in the example above have incompatible types,
5893 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5894 Because their types are incompatible, if a programmer accidentally uses one
5895 in place of the other, type checking will catch that and emit an error or
5896 warning. So not warning (about shadowing) in this case will not lead to
5897 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5898 possibly reduce the number of warnings triggered by intentional shadowing.
5900 This warning is enabled by @option{-Wshadow=local}.
5902 @item -Wlarger-than=@var{len}
5903 @opindex Wlarger-than=@var{len}
5904 @opindex Wlarger-than-@var{len}
5905 Warn whenever an object of larger than @var{len} bytes is defined.
5907 @item -Wframe-larger-than=@var{len}
5908 @opindex Wframe-larger-than
5909 Warn if the size of a function frame is larger than @var{len} bytes.
5910 The computation done to determine the stack frame size is approximate
5911 and not conservative.
5912 The actual requirements may be somewhat greater than @var{len}
5913 even if you do not get a warning.  In addition, any space allocated
5914 via @code{alloca}, variable-length arrays, or related constructs
5915 is not included by the compiler when determining
5916 whether or not to issue a warning.
5918 @item -Wno-free-nonheap-object
5919 @opindex Wno-free-nonheap-object
5920 @opindex Wfree-nonheap-object
5921 Do not warn when attempting to free an object that was not allocated
5922 on the heap.
5924 @item -Wstack-usage=@var{len}
5925 @opindex Wstack-usage
5926 Warn if the stack usage of a function might be larger than @var{len} bytes.
5927 The computation done to determine the stack usage is conservative.
5928 Any space allocated via @code{alloca}, variable-length arrays, or related
5929 constructs is included by the compiler when determining whether or not to
5930 issue a warning.
5932 The message is in keeping with the output of @option{-fstack-usage}.
5934 @itemize
5935 @item
5936 If the stack usage is fully static but exceeds the specified amount, it's:
5938 @smallexample
5939   warning: stack usage is 1120 bytes
5940 @end smallexample
5941 @item
5942 If the stack usage is (partly) dynamic but bounded, it's:
5944 @smallexample
5945   warning: stack usage might be 1648 bytes
5946 @end smallexample
5947 @item
5948 If the stack usage is (partly) dynamic and not bounded, it's:
5950 @smallexample
5951   warning: stack usage might be unbounded
5952 @end smallexample
5953 @end itemize
5955 @item -Wunsafe-loop-optimizations
5956 @opindex Wunsafe-loop-optimizations
5957 @opindex Wno-unsafe-loop-optimizations
5958 Warn if the loop cannot be optimized because the compiler cannot
5959 assume anything on the bounds of the loop indices.  With
5960 @option{-funsafe-loop-optimizations} warn if the compiler makes
5961 such assumptions.
5963 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5964 @opindex Wno-pedantic-ms-format
5965 @opindex Wpedantic-ms-format
5966 When used in combination with @option{-Wformat}
5967 and @option{-pedantic} without GNU extensions, this option
5968 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5969 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5970 which depend on the MS runtime.
5972 @item -Waligned-new
5973 @opindex Waligned-new
5974 @opindex Wno-aligned-new
5975 Warn about a new-expression of a type that requires greater alignment
5976 than the @code{alignof(std::max_align_t)} but uses an allocation
5977 function without an explicit alignment parameter. This option is
5978 enabled by @option{-Wall}.
5980 Normally this only warns about global allocation functions, but
5981 @option{-Waligned-new=all} also warns about class member allocation
5982 functions.
5984 @item -Wplacement-new
5985 @itemx -Wplacement-new=@var{n}
5986 @opindex Wplacement-new
5987 @opindex Wno-placement-new
5988 Warn about placement new expressions with undefined behavior, such as
5989 constructing an object in a buffer that is smaller than the type of
5990 the object.  For example, the placement new expression below is diagnosed
5991 because it attempts to construct an array of 64 integers in a buffer only
5992 64 bytes large.
5993 @smallexample
5994 char buf [64];
5995 new (buf) int[64];
5996 @end smallexample
5997 This warning is enabled by default.
5999 @table @gcctabopt
6000 @item -Wplacement-new=1
6001 This is the default warning level of @option{-Wplacement-new}.  At this
6002 level the warning is not issued for some strictly undefined constructs that
6003 GCC allows as extensions for compatibility with legacy code.  For example,
6004 the following @code{new} expression is not diagnosed at this level even
6005 though it has undefined behavior according to the C++ standard because
6006 it writes past the end of the one-element array.
6007 @smallexample
6008 struct S @{ int n, a[1]; @};
6009 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6010 new (s->a)int [32]();
6011 @end smallexample
6013 @item -Wplacement-new=2
6014 At this level, in addition to diagnosing all the same constructs as at level
6015 1, a diagnostic is also issued for placement new expressions that construct
6016 an object in the last member of structure whose type is an array of a single
6017 element and whose size is less than the size of the object being constructed.
6018 While the previous example would be diagnosed, the following construct makes
6019 use of the flexible member array extension to avoid the warning at level 2.
6020 @smallexample
6021 struct S @{ int n, a[]; @};
6022 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6023 new (s->a)int [32]();
6024 @end smallexample
6026 @end table
6028 @item -Wpointer-arith
6029 @opindex Wpointer-arith
6030 @opindex Wno-pointer-arith
6031 Warn about anything that depends on the ``size of'' a function type or
6032 of @code{void}.  GNU C assigns these types a size of 1, for
6033 convenience in calculations with @code{void *} pointers and pointers
6034 to functions.  In C++, warn also when an arithmetic operation involves
6035 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6037 @item -Wpointer-compare
6038 @opindex Wpointer-compare
6039 @opindex Wno-pointer-compare
6040 Warn if a pointer is compared with a zero character constant.  This usually
6041 means that the pointer was meant to be dereferenced.  For example:
6043 @smallexample
6044 const char *p = foo ();
6045 if (p == '\0')
6046   return 42;
6047 @end smallexample
6049 Note that the code above is invalid in C++11.
6051 This warning is enabled by default.
6053 @item -Wtype-limits
6054 @opindex Wtype-limits
6055 @opindex Wno-type-limits
6056 Warn if a comparison is always true or always false due to the limited
6057 range of the data type, but do not warn for constant expressions.  For
6058 example, warn if an unsigned variable is compared against zero with
6059 @code{<} or @code{>=}.  This warning is also enabled by
6060 @option{-Wextra}.
6062 @include cppwarnopts.texi
6064 @item -Wbad-function-cast @r{(C and Objective-C only)}
6065 @opindex Wbad-function-cast
6066 @opindex Wno-bad-function-cast
6067 Warn when a function call is cast to a non-matching type.
6068 For example, warn if a call to a function returning an integer type 
6069 is cast to a pointer type.
6071 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6072 @opindex Wc90-c99-compat
6073 @opindex Wno-c90-c99-compat
6074 Warn about features not present in ISO C90, but present in ISO C99.
6075 For instance, warn about use of variable length arrays, @code{long long}
6076 type, @code{bool} type, compound literals, designated initializers, and so
6077 on.  This option is independent of the standards mode.  Warnings are disabled
6078 in the expression that follows @code{__extension__}.
6080 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6081 @opindex Wc99-c11-compat
6082 @opindex Wno-c99-c11-compat
6083 Warn about features not present in ISO C99, but present in ISO C11.
6084 For instance, warn about use of anonymous structures and unions,
6085 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6086 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6087 and so on.  This option is independent of the standards mode.  Warnings are
6088 disabled in the expression that follows @code{__extension__}.
6090 @item -Wc++-compat @r{(C and Objective-C only)}
6091 @opindex Wc++-compat
6092 Warn about ISO C constructs that are outside of the common subset of
6093 ISO C and ISO C++, e.g.@: request for implicit conversion from
6094 @code{void *} to a pointer to non-@code{void} type.
6096 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6097 @opindex Wc++11-compat
6098 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6099 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6100 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6101 enabled by @option{-Wall}.
6103 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6104 @opindex Wc++14-compat
6105 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6106 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6108 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6109 @opindex Wc++17-compat
6110 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6111 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6113 @item -Wcast-qual
6114 @opindex Wcast-qual
6115 @opindex Wno-cast-qual
6116 Warn whenever a pointer is cast so as to remove a type qualifier from
6117 the target type.  For example, warn if a @code{const char *} is cast
6118 to an ordinary @code{char *}.
6120 Also warn when making a cast that introduces a type qualifier in an
6121 unsafe way.  For example, casting @code{char **} to @code{const char **}
6122 is unsafe, as in this example:
6124 @smallexample
6125   /* p is char ** value.  */
6126   const char **q = (const char **) p;
6127   /* Assignment of readonly string to const char * is OK.  */
6128   *q = "string";
6129   /* Now char** pointer points to read-only memory.  */
6130   **p = 'b';
6131 @end smallexample
6133 @item -Wcast-align
6134 @opindex Wcast-align
6135 @opindex Wno-cast-align
6136 Warn whenever a pointer is cast such that the required alignment of the
6137 target is increased.  For example, warn if a @code{char *} is cast to
6138 an @code{int *} on machines where integers can only be accessed at
6139 two- or four-byte boundaries.
6141 @item -Wcast-align=strict
6142 @opindex Wcast-align=strict
6143 Warn whenever a pointer is cast such that the required alignment of the
6144 target is increased.  For example, warn if a @code{char *} is cast to
6145 an @code{int *} regardless of the target machine.
6147 @item -Wcast-function-type
6148 @opindex Wcast-function-type
6149 @opindex Wno-cast-function-type
6150 Warn when a function pointer is cast to an incompatible function pointer.
6151 In a cast involving function types with a variable argument list only
6152 the types of initial arguments that are provided are considered.
6153 Any parameter of pointer-type matches any other pointer-type.  Any benign
6154 differences in integral types are ignored, like @code{int} vs. @code{long}
6155 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6156 type @code{void (*) (void)} is special and matches everything, which can
6157 be used to suppress this warning.
6158 In a cast involving pointer to member types this warning warns whenever
6159 the type cast is changing the pointer to member type.
6160 This warning is enabled by @option{-Wextra}.
6162 @item -Wwrite-strings
6163 @opindex Wwrite-strings
6164 @opindex Wno-write-strings
6165 When compiling C, give string constants the type @code{const
6166 char[@var{length}]} so that copying the address of one into a
6167 non-@code{const} @code{char *} pointer produces a warning.  These
6168 warnings help you find at compile time code that can try to write
6169 into a string constant, but only if you have been very careful about
6170 using @code{const} in declarations and prototypes.  Otherwise, it is
6171 just a nuisance. This is why we did not make @option{-Wall} request
6172 these warnings.
6174 When compiling C++, warn about the deprecated conversion from string
6175 literals to @code{char *}.  This warning is enabled by default for C++
6176 programs.
6178 @item -Wcatch-value
6179 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6180 @opindex Wcatch-value
6181 @opindex Wno-catch-value
6182 Warn about catch handlers that do not catch via reference.
6183 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6184 warn about polymorphic class types that are caught by value.
6185 With @option{-Wcatch-value=2} warn about all class types that are caught
6186 by value. With @option{-Wcatch-value=3} warn about all types that are
6187 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6189 @item -Wclobbered
6190 @opindex Wclobbered
6191 @opindex Wno-clobbered
6192 Warn for variables that might be changed by @code{longjmp} or
6193 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6195 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6196 @opindex Wconditionally-supported
6197 @opindex Wno-conditionally-supported
6198 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6200 @item -Wconversion
6201 @opindex Wconversion
6202 @opindex Wno-conversion
6203 Warn for implicit conversions that may alter a value. This includes
6204 conversions between real and integer, like @code{abs (x)} when
6205 @code{x} is @code{double}; conversions between signed and unsigned,
6206 like @code{unsigned ui = -1}; and conversions to smaller types, like
6207 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6208 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6209 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6210 conversions between signed and unsigned integers can be disabled by
6211 using @option{-Wno-sign-conversion}.
6213 For C++, also warn for confusing overload resolution for user-defined
6214 conversions; and conversions that never use a type conversion
6215 operator: conversions to @code{void}, the same type, a base class or a
6216 reference to them. Warnings about conversions between signed and
6217 unsigned integers are disabled by default in C++ unless
6218 @option{-Wsign-conversion} is explicitly enabled.
6220 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6221 @opindex Wconversion-null
6222 @opindex Wno-conversion-null
6223 Do not warn for conversions between @code{NULL} and non-pointer
6224 types. @option{-Wconversion-null} is enabled by default.
6226 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6227 @opindex Wzero-as-null-pointer-constant
6228 @opindex Wno-zero-as-null-pointer-constant
6229 Warn when a literal @samp{0} is used as null pointer constant.  This can
6230 be useful to facilitate the conversion to @code{nullptr} in C++11.
6232 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6233 @opindex Wsubobject-linkage
6234 @opindex Wno-subobject-linkage
6235 Warn if a class type has a base or a field whose type uses the anonymous
6236 namespace or depends on a type with no linkage.  If a type A depends on
6237 a type B with no or internal linkage, defining it in multiple
6238 translation units would be an ODR violation because the meaning of B
6239 is different in each translation unit.  If A only appears in a single
6240 translation unit, the best way to silence the warning is to give it
6241 internal linkage by putting it in an anonymous namespace as well.  The
6242 compiler doesn't give this warning for types defined in the main .C
6243 file, as those are unlikely to have multiple definitions.
6244 @option{-Wsubobject-linkage} is enabled by default.
6246 @item -Wdangling-else
6247 @opindex Wdangling-else
6248 @opindex Wno-dangling-else
6249 Warn about constructions where there may be confusion to which
6250 @code{if} statement an @code{else} branch belongs.  Here is an example of
6251 such a case:
6253 @smallexample
6254 @group
6256   if (a)
6257     if (b)
6258       foo ();
6259   else
6260     bar ();
6262 @end group
6263 @end smallexample
6265 In C/C++, every @code{else} branch belongs to the innermost possible
6266 @code{if} statement, which in this example is @code{if (b)}.  This is
6267 often not what the programmer expected, as illustrated in the above
6268 example by indentation the programmer chose.  When there is the
6269 potential for this confusion, GCC issues a warning when this flag
6270 is specified.  To eliminate the warning, add explicit braces around
6271 the innermost @code{if} statement so there is no way the @code{else}
6272 can belong to the enclosing @code{if}.  The resulting code
6273 looks like this:
6275 @smallexample
6276 @group
6278   if (a)
6279     @{
6280       if (b)
6281         foo ();
6282       else
6283         bar ();
6284     @}
6286 @end group
6287 @end smallexample
6289 This warning is enabled by @option{-Wparentheses}.
6291 @item -Wdate-time
6292 @opindex Wdate-time
6293 @opindex Wno-date-time
6294 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6295 are encountered as they might prevent bit-wise-identical reproducible
6296 compilations.
6298 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6299 @opindex Wdelete-incomplete
6300 @opindex Wno-delete-incomplete
6301 Warn when deleting a pointer to incomplete type, which may cause
6302 undefined behavior at runtime.  This warning is enabled by default.
6304 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6305 @opindex Wuseless-cast
6306 @opindex Wno-useless-cast
6307 Warn when an expression is casted to its own type.
6309 @item -Wempty-body
6310 @opindex Wempty-body
6311 @opindex Wno-empty-body
6312 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6313 while} statement.  This warning is also enabled by @option{-Wextra}.
6315 @item -Wenum-compare
6316 @opindex Wenum-compare
6317 @opindex Wno-enum-compare
6318 Warn about a comparison between values of different enumerated types.
6319 In C++ enumerated type mismatches in conditional expressions are also
6320 diagnosed and the warning is enabled by default.  In C this warning is 
6321 enabled by @option{-Wall}.
6323 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6324 @opindex Wextra-semi
6325 @opindex Wno-extra-semi
6326 Warn about redundant semicolon after in-class function definition.
6328 @item -Wjump-misses-init @r{(C, Objective-C only)}
6329 @opindex Wjump-misses-init
6330 @opindex Wno-jump-misses-init
6331 Warn if a @code{goto} statement or a @code{switch} statement jumps
6332 forward across the initialization of a variable, or jumps backward to a
6333 label after the variable has been initialized.  This only warns about
6334 variables that are initialized when they are declared.  This warning is
6335 only supported for C and Objective-C; in C++ this sort of branch is an
6336 error in any case.
6338 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6339 can be disabled with the @option{-Wno-jump-misses-init} option.
6341 @item -Wsign-compare
6342 @opindex Wsign-compare
6343 @opindex Wno-sign-compare
6344 @cindex warning for comparison of signed and unsigned values
6345 @cindex comparison of signed and unsigned values, warning
6346 @cindex signed and unsigned values, comparison warning
6347 Warn when a comparison between signed and unsigned values could produce
6348 an incorrect result when the signed value is converted to unsigned.
6349 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6350 also enabled by @option{-Wextra}.
6352 @item -Wsign-conversion
6353 @opindex Wsign-conversion
6354 @opindex Wno-sign-conversion
6355 Warn for implicit conversions that may change the sign of an integer
6356 value, like assigning a signed integer expression to an unsigned
6357 integer variable. An explicit cast silences the warning. In C, this
6358 option is enabled also by @option{-Wconversion}.
6360 @item -Wfloat-conversion
6361 @opindex Wfloat-conversion
6362 @opindex Wno-float-conversion
6363 Warn for implicit conversions that reduce the precision of a real value.
6364 This includes conversions from real to integer, and from higher precision
6365 real to lower precision real values.  This option is also enabled by
6366 @option{-Wconversion}.
6368 @item -Wno-scalar-storage-order
6369 @opindex -Wno-scalar-storage-order
6370 @opindex -Wscalar-storage-order
6371 Do not warn on suspicious constructs involving reverse scalar storage order.
6373 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6374 @opindex Wsized-deallocation
6375 @opindex Wno-sized-deallocation
6376 Warn about a definition of an unsized deallocation function
6377 @smallexample
6378 void operator delete (void *) noexcept;
6379 void operator delete[] (void *) noexcept;
6380 @end smallexample
6381 without a definition of the corresponding sized deallocation function
6382 @smallexample
6383 void operator delete (void *, std::size_t) noexcept;
6384 void operator delete[] (void *, std::size_t) noexcept;
6385 @end smallexample
6386 or vice versa.  Enabled by @option{-Wextra} along with
6387 @option{-fsized-deallocation}.
6389 @item -Wsizeof-pointer-div
6390 @opindex Wsizeof-pointer-div
6391 @opindex Wno-sizeof-pointer-div
6392 Warn for suspicious divisions of two sizeof expressions that divide
6393 the pointer size by the element size, which is the usual way to compute
6394 the array size but won't work out correctly with pointers.  This warning
6395 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6396 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6398 @item -Wsizeof-pointer-memaccess
6399 @opindex Wsizeof-pointer-memaccess
6400 @opindex Wno-sizeof-pointer-memaccess
6401 Warn for suspicious length parameters to certain string and memory built-in
6402 functions if the argument uses @code{sizeof}.  This warning triggers for
6403 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6404 an array, but a pointer, and suggests a possible fix, or about
6405 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6406 also warns about calls to bounded string copy functions like @code{strncat}
6407 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6408 the source array.  For example, in the following function the call to
6409 @code{strncat} specifies the size of the source string as the bound.  That
6410 is almost certainly a mistake and so the call is diagnosed.
6411 @smallexample
6412 void make_file (const char *name)
6414   char path[PATH_MAX];
6415   strncpy (path, name, sizeof path - 1);
6416   strncat (path, ".text", sizeof ".text");
6417   @dots{}
6419 @end smallexample
6421 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6423 @item -Wsizeof-array-argument
6424 @opindex Wsizeof-array-argument
6425 @opindex Wno-sizeof-array-argument
6426 Warn when the @code{sizeof} operator is applied to a parameter that is
6427 declared as an array in a function definition.  This warning is enabled by
6428 default for C and C++ programs.
6430 @item -Wmemset-elt-size
6431 @opindex Wmemset-elt-size
6432 @opindex Wno-memset-elt-size
6433 Warn for suspicious calls to the @code{memset} built-in function, if the
6434 first argument references an array, and the third argument is a number
6435 equal to the number of elements, but not equal to the size of the array
6436 in memory.  This indicates that the user has omitted a multiplication by
6437 the element size.  This warning is enabled by @option{-Wall}.
6439 @item -Wmemset-transposed-args
6440 @opindex Wmemset-transposed-args
6441 @opindex Wno-memset-transposed-args
6442 Warn for suspicious calls to the @code{memset} built-in function, if the
6443 second argument is not zero and the third argument is zero.  This warns e.g.@
6444 about @code{memset (buf, sizeof buf, 0)} where most probably
6445 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6446 is only emitted if the third argument is literal zero.  If it is some
6447 expression that is folded to zero, a cast of zero to some type, etc., 
6448 it is far less likely that the user has mistakenly exchanged the arguments 
6449 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6451 @item -Waddress
6452 @opindex Waddress
6453 @opindex Wno-address
6454 Warn about suspicious uses of memory addresses. These include using
6455 the address of a function in a conditional expression, such as
6456 @code{void func(void); if (func)}, and comparisons against the memory
6457 address of a string literal, such as @code{if (x == "abc")}.  Such
6458 uses typically indicate a programmer error: the address of a function
6459 always evaluates to true, so their use in a conditional usually
6460 indicate that the programmer forgot the parentheses in a function
6461 call; and comparisons against string literals result in unspecified
6462 behavior and are not portable in C, so they usually indicate that the
6463 programmer intended to use @code{strcmp}.  This warning is enabled by
6464 @option{-Wall}.
6466 @item -Wlogical-op
6467 @opindex Wlogical-op
6468 @opindex Wno-logical-op
6469 Warn about suspicious uses of logical operators in expressions.
6470 This includes using logical operators in contexts where a
6471 bit-wise operator is likely to be expected.  Also warns when
6472 the operands of a logical operator are the same:
6473 @smallexample
6474 extern int a;
6475 if (a < 0 && a < 0) @{ @dots{} @}
6476 @end smallexample
6478 @item -Wlogical-not-parentheses
6479 @opindex Wlogical-not-parentheses
6480 @opindex Wno-logical-not-parentheses
6481 Warn about logical not used on the left hand side operand of a comparison.
6482 This option does not warn if the right operand is considered to be a boolean
6483 expression.  Its purpose is to detect suspicious code like the following:
6484 @smallexample
6485 int a;
6486 @dots{}
6487 if (!a > 1) @{ @dots{} @}
6488 @end smallexample
6490 It is possible to suppress the warning by wrapping the LHS into
6491 parentheses:
6492 @smallexample
6493 if ((!a) > 1) @{ @dots{} @}
6494 @end smallexample
6496 This warning is enabled by @option{-Wall}.
6498 @item -Waggregate-return
6499 @opindex Waggregate-return
6500 @opindex Wno-aggregate-return
6501 Warn if any functions that return structures or unions are defined or
6502 called.  (In languages where you can return an array, this also elicits
6503 a warning.)
6505 @item -Wno-aggressive-loop-optimizations
6506 @opindex Wno-aggressive-loop-optimizations
6507 @opindex Waggressive-loop-optimizations
6508 Warn if in a loop with constant number of iterations the compiler detects
6509 undefined behavior in some statement during one or more of the iterations.
6511 @item -Wno-attributes
6512 @opindex Wno-attributes
6513 @opindex Wattributes
6514 Do not warn if an unexpected @code{__attribute__} is used, such as
6515 unrecognized attributes, function attributes applied to variables,
6516 etc.  This does not stop errors for incorrect use of supported
6517 attributes.
6519 @item -Wno-builtin-declaration-mismatch
6520 @opindex Wno-builtin-declaration-mismatch
6521 @opindex Wbuiltin-declaration-mismatch
6522 Warn if a built-in function is declared with the wrong signature or 
6523 as non-function.
6524 This warning is enabled by default.
6526 @item -Wno-builtin-macro-redefined
6527 @opindex Wno-builtin-macro-redefined
6528 @opindex Wbuiltin-macro-redefined
6529 Do not warn if certain built-in macros are redefined.  This suppresses
6530 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6531 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6533 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6534 @opindex Wstrict-prototypes
6535 @opindex Wno-strict-prototypes
6536 Warn if a function is declared or defined without specifying the
6537 argument types.  (An old-style function definition is permitted without
6538 a warning if preceded by a declaration that specifies the argument
6539 types.)
6541 @item -Wold-style-declaration @r{(C and Objective-C only)}
6542 @opindex Wold-style-declaration
6543 @opindex Wno-old-style-declaration
6544 Warn for obsolescent usages, according to the C Standard, in a
6545 declaration. For example, warn if storage-class specifiers like
6546 @code{static} are not the first things in a declaration.  This warning
6547 is also enabled by @option{-Wextra}.
6549 @item -Wold-style-definition @r{(C and Objective-C only)}
6550 @opindex Wold-style-definition
6551 @opindex Wno-old-style-definition
6552 Warn if an old-style function definition is used.  A warning is given
6553 even if there is a previous prototype.
6555 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6556 @opindex Wmissing-parameter-type
6557 @opindex Wno-missing-parameter-type
6558 A function parameter is declared without a type specifier in K&R-style
6559 functions:
6561 @smallexample
6562 void foo(bar) @{ @}
6563 @end smallexample
6565 This warning is also enabled by @option{-Wextra}.
6567 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6568 @opindex Wmissing-prototypes
6569 @opindex Wno-missing-prototypes
6570 Warn if a global function is defined without a previous prototype
6571 declaration.  This warning is issued even if the definition itself
6572 provides a prototype.  Use this option to detect global functions
6573 that do not have a matching prototype declaration in a header file.
6574 This option is not valid for C++ because all function declarations
6575 provide prototypes and a non-matching declaration declares an
6576 overload rather than conflict with an earlier declaration.
6577 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6579 @item -Wmissing-declarations
6580 @opindex Wmissing-declarations
6581 @opindex Wno-missing-declarations
6582 Warn if a global function is defined without a previous declaration.
6583 Do so even if the definition itself provides a prototype.
6584 Use this option to detect global functions that are not declared in
6585 header files.  In C, no warnings are issued for functions with previous
6586 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6587 missing prototypes.  In C++, no warnings are issued for function templates,
6588 or for inline functions, or for functions in anonymous namespaces.
6590 @item -Wmissing-field-initializers
6591 @opindex Wmissing-field-initializers
6592 @opindex Wno-missing-field-initializers
6593 @opindex W
6594 @opindex Wextra
6595 @opindex Wno-extra
6596 Warn if a structure's initializer has some fields missing.  For
6597 example, the following code causes such a warning, because
6598 @code{x.h} is implicitly zero:
6600 @smallexample
6601 struct s @{ int f, g, h; @};
6602 struct s x = @{ 3, 4 @};
6603 @end smallexample
6605 This option does not warn about designated initializers, so the following
6606 modification does not trigger a warning:
6608 @smallexample
6609 struct s @{ int f, g, h; @};
6610 struct s x = @{ .f = 3, .g = 4 @};
6611 @end smallexample
6613 In C this option does not warn about the universal zero initializer
6614 @samp{@{ 0 @}}:
6616 @smallexample
6617 struct s @{ int f, g, h; @};
6618 struct s x = @{ 0 @};
6619 @end smallexample
6621 Likewise, in C++ this option does not warn about the empty @{ @}
6622 initializer, for example:
6624 @smallexample
6625 struct s @{ int f, g, h; @};
6626 s x = @{ @};
6627 @end smallexample
6629 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6630 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6632 @item -Wno-multichar
6633 @opindex Wno-multichar
6634 @opindex Wmultichar
6635 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6636 Usually they indicate a typo in the user's code, as they have
6637 implementation-defined values, and should not be used in portable code.
6639 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6640 @opindex Wnormalized=
6641 @opindex Wnormalized
6642 @opindex Wno-normalized
6643 @cindex NFC
6644 @cindex NFKC
6645 @cindex character set, input normalization
6646 In ISO C and ISO C++, two identifiers are different if they are
6647 different sequences of characters.  However, sometimes when characters
6648 outside the basic ASCII character set are used, you can have two
6649 different character sequences that look the same.  To avoid confusion,
6650 the ISO 10646 standard sets out some @dfn{normalization rules} which
6651 when applied ensure that two sequences that look the same are turned into
6652 the same sequence.  GCC can warn you if you are using identifiers that
6653 have not been normalized; this option controls that warning.
6655 There are four levels of warning supported by GCC@.  The default is
6656 @option{-Wnormalized=nfc}, which warns about any identifier that is
6657 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6658 recommended form for most uses.  It is equivalent to
6659 @option{-Wnormalized}.
6661 Unfortunately, there are some characters allowed in identifiers by
6662 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6663 identifiers.  That is, there's no way to use these symbols in portable
6664 ISO C or C++ and have all your identifiers in NFC@.
6665 @option{-Wnormalized=id} suppresses the warning for these characters.
6666 It is hoped that future versions of the standards involved will correct
6667 this, which is why this option is not the default.
6669 You can switch the warning off for all characters by writing
6670 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6671 only do this if you are using some other normalization scheme (like
6672 ``D''), because otherwise you can easily create bugs that are
6673 literally impossible to see.
6675 Some characters in ISO 10646 have distinct meanings but look identical
6676 in some fonts or display methodologies, especially once formatting has
6677 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6678 LETTER N'', displays just like a regular @code{n} that has been
6679 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6680 normalization scheme to convert all these into a standard form as
6681 well, and GCC warns if your code is not in NFKC if you use
6682 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6683 about every identifier that contains the letter O because it might be
6684 confused with the digit 0, and so is not the default, but may be
6685 useful as a local coding convention if the programming environment 
6686 cannot be fixed to display these characters distinctly.
6688 @item -Wno-deprecated
6689 @opindex Wno-deprecated
6690 @opindex Wdeprecated
6691 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6693 @item -Wno-deprecated-declarations
6694 @opindex Wno-deprecated-declarations
6695 @opindex Wdeprecated-declarations
6696 Do not warn about uses of functions (@pxref{Function Attributes}),
6697 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6698 Attributes}) marked as deprecated by using the @code{deprecated}
6699 attribute.
6701 @item -Wno-overflow
6702 @opindex Wno-overflow
6703 @opindex Woverflow
6704 Do not warn about compile-time overflow in constant expressions.
6706 @item -Wno-odr
6707 @opindex Wno-odr
6708 @opindex Wodr
6709 Warn about One Definition Rule violations during link-time optimization.
6710 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6712 @item -Wopenmp-simd
6713 @opindex Wopenm-simd
6714 Warn if the vectorizer cost model overrides the OpenMP
6715 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6716 option can be used to relax the cost model.
6718 @item -Woverride-init @r{(C and Objective-C only)}
6719 @opindex Woverride-init
6720 @opindex Wno-override-init
6721 @opindex W
6722 @opindex Wextra
6723 @opindex Wno-extra
6724 Warn if an initialized field without side effects is overridden when
6725 using designated initializers (@pxref{Designated Inits, , Designated
6726 Initializers}).
6728 This warning is included in @option{-Wextra}.  To get other
6729 @option{-Wextra} warnings without this one, use @option{-Wextra
6730 -Wno-override-init}.
6732 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6733 @opindex Woverride-init-side-effects
6734 @opindex Wno-override-init-side-effects
6735 Warn if an initialized field with side effects is overridden when
6736 using designated initializers (@pxref{Designated Inits, , Designated
6737 Initializers}).  This warning is enabled by default.
6739 @item -Wpacked
6740 @opindex Wpacked
6741 @opindex Wno-packed
6742 Warn if a structure is given the packed attribute, but the packed
6743 attribute has no effect on the layout or size of the structure.
6744 Such structures may be mis-aligned for little benefit.  For
6745 instance, in this code, the variable @code{f.x} in @code{struct bar}
6746 is misaligned even though @code{struct bar} does not itself
6747 have the packed attribute:
6749 @smallexample
6750 @group
6751 struct foo @{
6752   int x;
6753   char a, b, c, d;
6754 @} __attribute__((packed));
6755 struct bar @{
6756   char z;
6757   struct foo f;
6759 @end group
6760 @end smallexample
6762 @item -Wpacked-bitfield-compat
6763 @opindex Wpacked-bitfield-compat
6764 @opindex Wno-packed-bitfield-compat
6765 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6766 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6767 the change can lead to differences in the structure layout.  GCC
6768 informs you when the offset of such a field has changed in GCC 4.4.
6769 For example there is no longer a 4-bit padding between field @code{a}
6770 and @code{b} in this structure:
6772 @smallexample
6773 struct foo
6775   char a:4;
6776   char b:8;
6777 @} __attribute__ ((packed));
6778 @end smallexample
6780 This warning is enabled by default.  Use
6781 @option{-Wno-packed-bitfield-compat} to disable this warning.
6783 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6784 @opindex Wpacked-not-aligned
6785 @opindex Wno-packed-not-aligned
6786 Warn if a structure field with explicitly specified alignment in a
6787 packed struct or union is misaligned.  For example, a warning will
6788 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6789 'struct S' is less than 8}, in this code:
6791 @smallexample
6792 @group
6793 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6794 struct __attribute__ ((packed)) S @{
6795   struct S8 s8;
6797 @end group
6798 @end smallexample
6800 This warning is enabled by @option{-Wall}.
6802 @item -Wpadded
6803 @opindex Wpadded
6804 @opindex Wno-padded
6805 Warn if padding is included in a structure, either to align an element
6806 of the structure or to align the whole structure.  Sometimes when this
6807 happens it is possible to rearrange the fields of the structure to
6808 reduce the padding and so make the structure smaller.
6810 @item -Wredundant-decls
6811 @opindex Wredundant-decls
6812 @opindex Wno-redundant-decls
6813 Warn if anything is declared more than once in the same scope, even in
6814 cases where multiple declaration is valid and changes nothing.
6816 @item -Wno-restrict
6817 @opindex Wrestrict
6818 @opindex Wno-restrict
6819 Warn when an object referenced by a @code{restrict}-qualified parameter
6820 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6821 argument, or when copies between such objects overlap.  For example,
6822 the call to the @code{strcpy} function below attempts to truncate the string
6823 by replacing its initial characters with the last four.  However, because
6824 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6825 the call is diagnosed.
6827 @smallexample
6828 void foo (void)
6830   char a[] = "abcd1234";
6831   strcpy (a, a + 4);
6832   @dots{}
6834 @end smallexample
6835 The @option{-Wrestrict} option detects some instances of simple overlap
6836 even without optimization but works best at @option{-O2} and above.  It
6837 is included in @option{-Wall}.
6839 @item -Wnested-externs @r{(C and Objective-C only)}
6840 @opindex Wnested-externs
6841 @opindex Wno-nested-externs
6842 Warn if an @code{extern} declaration is encountered within a function.
6844 @item -Wno-inherited-variadic-ctor
6845 @opindex Winherited-variadic-ctor
6846 @opindex Wno-inherited-variadic-ctor
6847 Suppress warnings about use of C++11 inheriting constructors when the
6848 base class inherited from has a C variadic constructor; the warning is
6849 on by default because the ellipsis is not inherited.
6851 @item -Winline
6852 @opindex Winline
6853 @opindex Wno-inline
6854 Warn if a function that is declared as inline cannot be inlined.
6855 Even with this option, the compiler does not warn about failures to
6856 inline functions declared in system headers.
6858 The compiler uses a variety of heuristics to determine whether or not
6859 to inline a function.  For example, the compiler takes into account
6860 the size of the function being inlined and the amount of inlining
6861 that has already been done in the current function.  Therefore,
6862 seemingly insignificant changes in the source program can cause the
6863 warnings produced by @option{-Winline} to appear or disappear.
6865 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6866 @opindex Wno-invalid-offsetof
6867 @opindex Winvalid-offsetof
6868 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6869 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6870 to a non-standard-layout type is undefined.  In existing C++ implementations,
6871 however, @code{offsetof} typically gives meaningful results.
6872 This flag is for users who are aware that they are
6873 writing nonportable code and who have deliberately chosen to ignore the
6874 warning about it.
6876 The restrictions on @code{offsetof} may be relaxed in a future version
6877 of the C++ standard.
6879 @item -Wint-in-bool-context
6880 @opindex Wint-in-bool-context
6881 @opindex Wno-int-in-bool-context
6882 Warn for suspicious use of integer values where boolean values are expected,
6883 such as conditional expressions (?:) using non-boolean integer constants in
6884 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6885 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6886 for all kinds of multiplications regardless of the data type.
6887 This warning is enabled by @option{-Wall}.
6889 @item -Wno-int-to-pointer-cast
6890 @opindex Wno-int-to-pointer-cast
6891 @opindex Wint-to-pointer-cast
6892 Suppress warnings from casts to pointer type of an integer of a
6893 different size. In C++, casting to a pointer type of smaller size is
6894 an error. @option{Wint-to-pointer-cast} is enabled by default.
6897 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6898 @opindex Wno-pointer-to-int-cast
6899 @opindex Wpointer-to-int-cast
6900 Suppress warnings from casts from a pointer to an integer type of a
6901 different size.
6903 @item -Winvalid-pch
6904 @opindex Winvalid-pch
6905 @opindex Wno-invalid-pch
6906 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6907 the search path but cannot be used.
6909 @item -Wlong-long
6910 @opindex Wlong-long
6911 @opindex Wno-long-long
6912 Warn if @code{long long} type is used.  This is enabled by either
6913 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6914 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6916 @item -Wvariadic-macros
6917 @opindex Wvariadic-macros
6918 @opindex Wno-variadic-macros
6919 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6920 alternate syntax is used in ISO C99 mode.  This is enabled by either
6921 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6922 messages, use @option{-Wno-variadic-macros}.
6924 @item -Wvarargs
6925 @opindex Wvarargs
6926 @opindex Wno-varargs
6927 Warn upon questionable usage of the macros used to handle variable
6928 arguments like @code{va_start}.  This is default.  To inhibit the
6929 warning messages, use @option{-Wno-varargs}.
6931 @item -Wvector-operation-performance
6932 @opindex Wvector-operation-performance
6933 @opindex Wno-vector-operation-performance
6934 Warn if vector operation is not implemented via SIMD capabilities of the
6935 architecture.  Mainly useful for the performance tuning.
6936 Vector operation can be implemented @code{piecewise}, which means that the
6937 scalar operation is performed on every vector element; 
6938 @code{in parallel}, which means that the vector operation is implemented
6939 using scalars of wider type, which normally is more performance efficient;
6940 and @code{as a single scalar}, which means that vector fits into a
6941 scalar type.
6943 @item -Wno-virtual-move-assign
6944 @opindex Wvirtual-move-assign
6945 @opindex Wno-virtual-move-assign
6946 Suppress warnings about inheriting from a virtual base with a
6947 non-trivial C++11 move assignment operator.  This is dangerous because
6948 if the virtual base is reachable along more than one path, it is
6949 moved multiple times, which can mean both objects end up in the
6950 moved-from state.  If the move assignment operator is written to avoid
6951 moving from a moved-from object, this warning can be disabled.
6953 @item -Wvla
6954 @opindex Wvla
6955 @opindex Wno-vla
6956 Warn if a variable-length array is used in the code.
6957 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6958 the variable-length array.
6960 @item -Wvla-larger-than=@var{n}
6961 If this option is used, the compiler will warn on uses of
6962 variable-length arrays where the size is either unbounded, or bounded
6963 by an argument that can be larger than @var{n} bytes.  This is similar
6964 to how @option{-Walloca-larger-than=@var{n}} works, but with
6965 variable-length arrays.
6967 Note that GCC may optimize small variable-length arrays of a known
6968 value into plain arrays, so this warning may not get triggered for
6969 such arrays.
6971 This warning is not enabled by @option{-Wall}, and is only active when
6972 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6974 See also @option{-Walloca-larger-than=@var{n}}.
6976 @item -Wvolatile-register-var
6977 @opindex Wvolatile-register-var
6978 @opindex Wno-volatile-register-var
6979 Warn if a register variable is declared volatile.  The volatile
6980 modifier does not inhibit all optimizations that may eliminate reads
6981 and/or writes to register variables.  This warning is enabled by
6982 @option{-Wall}.
6984 @item -Wdisabled-optimization
6985 @opindex Wdisabled-optimization
6986 @opindex Wno-disabled-optimization
6987 Warn if a requested optimization pass is disabled.  This warning does
6988 not generally indicate that there is anything wrong with your code; it
6989 merely indicates that GCC's optimizers are unable to handle the code
6990 effectively.  Often, the problem is that your code is too big or too
6991 complex; GCC refuses to optimize programs when the optimization
6992 itself is likely to take inordinate amounts of time.
6994 @item -Wpointer-sign @r{(C and Objective-C only)}
6995 @opindex Wpointer-sign
6996 @opindex Wno-pointer-sign
6997 Warn for pointer argument passing or assignment with different signedness.
6998 This option is only supported for C and Objective-C@.  It is implied by
6999 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
7000 @option{-Wno-pointer-sign}.
7002 @item -Wstack-protector
7003 @opindex Wstack-protector
7004 @opindex Wno-stack-protector
7005 This option is only active when @option{-fstack-protector} is active.  It
7006 warns about functions that are not protected against stack smashing.
7008 @item -Woverlength-strings
7009 @opindex Woverlength-strings
7010 @opindex Wno-overlength-strings
7011 Warn about string constants that are longer than the ``minimum
7012 maximum'' length specified in the C standard.  Modern compilers
7013 generally allow string constants that are much longer than the
7014 standard's minimum limit, but very portable programs should avoid
7015 using longer strings.
7017 The limit applies @emph{after} string constant concatenation, and does
7018 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7019 C99, it was raised to 4095.  C++98 does not specify a normative
7020 minimum maximum, so we do not diagnose overlength strings in C++@.
7022 This option is implied by @option{-Wpedantic}, and can be disabled with
7023 @option{-Wno-overlength-strings}.
7025 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7026 @opindex Wunsuffixed-float-constants
7028 Issue a warning for any floating constant that does not have
7029 a suffix.  When used together with @option{-Wsystem-headers} it
7030 warns about such constants in system header files.  This can be useful
7031 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7032 from the decimal floating-point extension to C99.
7034 @item -Wno-designated-init @r{(C and Objective-C only)}
7035 Suppress warnings when a positional initializer is used to initialize
7036 a structure that has been marked with the @code{designated_init}
7037 attribute.
7039 @item -Whsa
7040 Issue a warning when HSAIL cannot be emitted for the compiled function or
7041 OpenMP construct.
7043 @end table
7045 @node Debugging Options
7046 @section Options for Debugging Your Program
7047 @cindex options, debugging
7048 @cindex debugging information options
7050 To tell GCC to emit extra information for use by a debugger, in almost 
7051 all cases you need only to add @option{-g} to your other options.
7053 GCC allows you to use @option{-g} with
7054 @option{-O}.  The shortcuts taken by optimized code may occasionally
7055 be surprising: some variables you declared may not exist
7056 at all; flow of control may briefly move where you did not expect it;
7057 some statements may not be executed because they compute constant
7058 results or their values are already at hand; some statements may
7059 execute in different places because they have been moved out of loops.
7060 Nevertheless it is possible to debug optimized output.  This makes
7061 it reasonable to use the optimizer for programs that might have bugs.
7063 If you are not using some other optimization option, consider
7064 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7065 With no @option{-O} option at all, some compiler passes that collect
7066 information useful for debugging do not run at all, so that
7067 @option{-Og} may result in a better debugging experience.
7069 @table @gcctabopt
7070 @item -g
7071 @opindex g
7072 Produce debugging information in the operating system's native format
7073 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7074 information.
7076 On most systems that use stabs format, @option{-g} enables use of extra
7077 debugging information that only GDB can use; this extra information
7078 makes debugging work better in GDB but probably makes other debuggers
7079 crash or
7080 refuse to read the program.  If you want to control for certain whether
7081 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7082 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7084 @item -ggdb
7085 @opindex ggdb
7086 Produce debugging information for use by GDB@.  This means to use the
7087 most expressive format available (DWARF, stabs, or the native format
7088 if neither of those are supported), including GDB extensions if at all
7089 possible.
7091 @item -gdwarf
7092 @itemx -gdwarf-@var{version}
7093 @opindex gdwarf
7094 Produce debugging information in DWARF format (if that is supported).
7095 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7096 for most targets is 4.  DWARF Version 5 is only experimental.
7098 Note that with DWARF Version 2, some ports require and always
7099 use some non-conflicting DWARF 3 extensions in the unwind tables.
7101 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7102 for maximum benefit.
7104 GCC no longer supports DWARF Version 1, which is substantially
7105 different than Version 2 and later.  For historical reasons, some
7106 other DWARF-related options such as
7107 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7108 in their names, but apply to all currently-supported versions of DWARF.
7110 @item -gstabs
7111 @opindex gstabs
7112 Produce debugging information in stabs format (if that is supported),
7113 without GDB extensions.  This is the format used by DBX on most BSD
7114 systems.  On MIPS, Alpha and System V Release 4 systems this option
7115 produces stabs debugging output that is not understood by DBX@.
7116 On System V Release 4 systems this option requires the GNU assembler.
7118 @item -gstabs+
7119 @opindex gstabs+
7120 Produce debugging information in stabs format (if that is supported),
7121 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7122 use of these extensions is likely to make other debuggers crash or
7123 refuse to read the program.
7125 @item -gxcoff
7126 @opindex gxcoff
7127 Produce debugging information in XCOFF format (if that is supported).
7128 This is the format used by the DBX debugger on IBM RS/6000 systems.
7130 @item -gxcoff+
7131 @opindex gxcoff+
7132 Produce debugging information in XCOFF format (if that is supported),
7133 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7134 use of these extensions is likely to make other debuggers crash or
7135 refuse to read the program, and may cause assemblers other than the GNU
7136 assembler (GAS) to fail with an error.
7138 @item -gvms
7139 @opindex gvms
7140 Produce debugging information in Alpha/VMS debug format (if that is
7141 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7143 @item -g@var{level}
7144 @itemx -ggdb@var{level}
7145 @itemx -gstabs@var{level}
7146 @itemx -gxcoff@var{level}
7147 @itemx -gvms@var{level}
7148 Request debugging information and also use @var{level} to specify how
7149 much information.  The default level is 2.
7151 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7152 @option{-g}.
7154 Level 1 produces minimal information, enough for making backtraces in
7155 parts of the program that you don't plan to debug.  This includes
7156 descriptions of functions and external variables, and line number
7157 tables, but no information about local variables.
7159 Level 3 includes extra information, such as all the macro definitions
7160 present in the program.  Some debuggers support macro expansion when
7161 you use @option{-g3}.
7163 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7164 confusion with @option{-gdwarf-@var{level}}.
7165 Instead use an additional @option{-g@var{level}} option to change the
7166 debug level for DWARF.
7168 @item -feliminate-unused-debug-symbols
7169 @opindex feliminate-unused-debug-symbols
7170 Produce debugging information in stabs format (if that is supported),
7171 for only symbols that are actually used.
7173 @item -femit-class-debug-always
7174 @opindex femit-class-debug-always
7175 Instead of emitting debugging information for a C++ class in only one
7176 object file, emit it in all object files using the class.  This option
7177 should be used only with debuggers that are unable to handle the way GCC
7178 normally emits debugging information for classes because using this
7179 option increases the size of debugging information by as much as a
7180 factor of two.
7182 @item -fno-merge-debug-strings
7183 @opindex fmerge-debug-strings
7184 @opindex fno-merge-debug-strings
7185 Direct the linker to not merge together strings in the debugging
7186 information that are identical in different object files.  Merging is
7187 not supported by all assemblers or linkers.  Merging decreases the size
7188 of the debug information in the output file at the cost of increasing
7189 link processing time.  Merging is enabled by default.
7191 @item -fdebug-prefix-map=@var{old}=@var{new}
7192 @opindex fdebug-prefix-map
7193 When compiling files residing in directory @file{@var{old}}, record
7194 debugging information describing them as if the files resided in
7195 directory @file{@var{new}} instead.  This can be used to replace a
7196 build-time path with an install-time path in the debug info.  It can
7197 also be used to change an absolute path to a relative path by using
7198 @file{.} for @var{new}.  This can give more reproducible builds, which
7199 are location independent, but may require an extra command to tell GDB
7200 where to find the source files. See also @option{-ffile-prefix-map}.
7202 @item -fvar-tracking
7203 @opindex fvar-tracking
7204 Run variable tracking pass.  It computes where variables are stored at each
7205 position in code.  Better debugging information is then generated
7206 (if the debugging information format supports this information).
7208 It is enabled by default when compiling with optimization (@option{-Os},
7209 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7210 the debug info format supports it.
7212 @item -fvar-tracking-assignments
7213 @opindex fvar-tracking-assignments
7214 @opindex fno-var-tracking-assignments
7215 Annotate assignments to user variables early in the compilation and
7216 attempt to carry the annotations over throughout the compilation all the
7217 way to the end, in an attempt to improve debug information while
7218 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7220 It can be enabled even if var-tracking is disabled, in which case
7221 annotations are created and maintained, but discarded at the end.
7222 By default, this flag is enabled together with @option{-fvar-tracking},
7223 except when selective scheduling is enabled.
7225 @item -gsplit-dwarf
7226 @opindex gsplit-dwarf
7227 Separate as much DWARF debugging information as possible into a
7228 separate output file with the extension @file{.dwo}.  This option allows
7229 the build system to avoid linking files with debug information.  To
7230 be useful, this option requires a debugger capable of reading @file{.dwo}
7231 files.
7233 @item -gpubnames
7234 @opindex gpubnames
7235 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7237 @item -ggnu-pubnames
7238 @opindex ggnu-pubnames
7239 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7240 suitable for conversion into a GDB@ index.  This option is only useful
7241 with a linker that can produce GDB@ index version 7.
7243 @item -fdebug-types-section
7244 @opindex fdebug-types-section
7245 @opindex fno-debug-types-section
7246 When using DWARF Version 4 or higher, type DIEs can be put into
7247 their own @code{.debug_types} section instead of making them part of the
7248 @code{.debug_info} section.  It is more efficient to put them in a separate
7249 comdat sections since the linker can then remove duplicates.
7250 But not all DWARF consumers support @code{.debug_types} sections yet
7251 and on some objects @code{.debug_types} produces larger instead of smaller
7252 debugging information.
7254 @item -grecord-gcc-switches
7255 @itemx -gno-record-gcc-switches
7256 @opindex grecord-gcc-switches
7257 @opindex gno-record-gcc-switches
7258 This switch causes the command-line options used to invoke the
7259 compiler that may affect code generation to be appended to the
7260 DW_AT_producer attribute in DWARF debugging information.  The options
7261 are concatenated with spaces separating them from each other and from
7262 the compiler version.  
7263 It is enabled by default.
7264 See also @option{-frecord-gcc-switches} for another
7265 way of storing compiler options into the object file.  
7267 @item -gstrict-dwarf
7268 @opindex gstrict-dwarf
7269 Disallow using extensions of later DWARF standard version than selected
7270 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7271 DWARF extensions from later standard versions is allowed.
7273 @item -gno-strict-dwarf
7274 @opindex gno-strict-dwarf
7275 Allow using extensions of later DWARF standard version than selected with
7276 @option{-gdwarf-@var{version}}.
7278 @item -gas-loc-support
7279 @opindex gas-loc-support
7280 Inform the compiler that the assembler supports @code{.loc} directives.
7281 It may then use them for the assembler to generate DWARF2+ line number
7282 tables.
7284 This is generally desirable, because assembler-generated line-number
7285 tables are a lot more compact than those the compiler can generate
7286 itself.
7288 This option will be enabled by default if, at GCC configure time, the
7289 assembler was found to support such directives.
7291 @item -gno-as-loc-support
7292 @opindex gno-as-loc-support
7293 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7294 line number tables are to be generated.
7296 @item gas-locview-support
7297 @opindex gas-locview-support
7298 Inform the compiler that the assembler supports @code{view} assignment
7299 and reset assertion checking in @code{.loc} directives.
7301 This option will be enabled by default if, at GCC configure time, the
7302 assembler was found to support them.
7304 @item gno-as-locview-support
7305 Force GCC to assign view numbers internally, if
7306 @option{-gvariable-location-views} are explicitly requested.
7308 @item -gcolumn-info
7309 @itemx -gno-column-info
7310 @opindex gcolumn-info
7311 @opindex gno-column-info
7312 Emit location column information into DWARF debugging information, rather
7313 than just file and line.
7314 This option is enabled by default.
7316 @item -gstatement-frontiers
7317 @itemx -gno-statement-frontiers
7318 @opindex gstatement-frontiers
7319 @opindex gno-statement-frontiers
7320 This option causes GCC to create markers in the internal representation
7321 at the beginning of statements, and to keep them roughly in place
7322 throughout compilation, using them to guide the output of @code{is_stmt}
7323 markers in the line number table.  This is enabled by default when
7324 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7325 @dots{}), and outputting DWARF 2 debug information at the normal level.
7327 @item -gvariable-location-views
7328 @itemx -gvariable-location-views=incompat5
7329 @itemx -gno-variable-location-views
7330 @opindex gvariable-location-views
7331 @opindex gvariable-location-views=incompat5
7332 @opindex gno-variable-location-views
7333 Augment variable location lists with progressive view numbers implied
7334 from the line number table.  This enables debug information consumers to
7335 inspect state at certain points of the program, even if no instructions
7336 associated with the corresponding source locations are present at that
7337 point.  If the assembler lacks support for view numbers in line number
7338 tables, this will cause the compiler to emit the line number table,
7339 which generally makes them somewhat less compact.  The augmented line
7340 number tables and location lists are fully backward-compatible, so they
7341 can be consumed by debug information consumers that are not aware of
7342 these augmentations, but they won't derive any benefit from them either.
7344 This is enabled by default when outputting DWARF 2 debug information at
7345 the normal level, as long as there is assembler support,
7346 @option{-fvar-tracking-assignments} is enabled and
7347 @option{-gstrict-dwarf} is not.  When assembler support is not
7348 available, this may still be enabled, but it will force GCC to output
7349 internal line number tables, and if
7350 @option{-ginternal-reset-location-views} is not enabled, that will most
7351 certainly lead to silently mismatching location views.
7353 There is a proposed representation for view numbers that is not backward
7354 compatible with the location list format introduced in DWARF 5, that can
7355 be enabled with @option{-gvariable-location-views=incompat5}.  This
7356 option may be removed in the future, is only provided as a reference
7357 implementation of the proposed representation.  Debug information
7358 consumers are not expected to support this extended format, and they
7359 would be rendered unable to decode location lists using it.
7361 @item -ginternal-reset-location-views
7362 @itemx -gnointernal-reset-location-views
7363 @opindex ginternal-reset-location-views
7364 @opindex gno-internal-reset-location-views
7365 Attempt to determine location views that can be omitted from location
7366 view lists.  This requires the compiler to have very accurate insn
7367 length estimates, which isn't always the case, and it may cause
7368 incorrect view lists to be generated silently when using an assembler
7369 that does not support location view lists.  The GNU assembler will flag
7370 any such error as a @code{view number mismatch}.  This is only enabled
7371 on ports that define a reliable estimation function.
7373 @item -ginline-points
7374 @itemx -gno-inline-points
7375 @opindex ginline-points
7376 @opindex gno-inline-points
7377 Generate extended debug information for inlined functions.  Location
7378 view tracking markers are inserted at inlined entry points, so that
7379 address and view numbers can be computed and output in debug
7380 information.  This can be enabled independently of location views, in
7381 which case the view numbers won't be output, but it can only be enabled
7382 along with statement frontiers, and it is only enabled by default if
7383 location views are enabled.
7385 @item -gz@r{[}=@var{type}@r{]}
7386 @opindex gz
7387 Produce compressed debug sections in DWARF format, if that is supported.
7388 If @var{type} is not given, the default type depends on the capabilities
7389 of the assembler and linker used.  @var{type} may be one of
7390 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7391 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7392 compression in traditional GNU format).  If the linker doesn't support
7393 writing compressed debug sections, the option is rejected.  Otherwise,
7394 if the assembler does not support them, @option{-gz} is silently ignored
7395 when producing object files.
7397 @item -femit-struct-debug-baseonly
7398 @opindex femit-struct-debug-baseonly
7399 Emit debug information for struct-like types
7400 only when the base name of the compilation source file
7401 matches the base name of file in which the struct is defined.
7403 This option substantially reduces the size of debugging information,
7404 but at significant potential loss in type information to the debugger.
7405 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7406 See @option{-femit-struct-debug-detailed} for more detailed control.
7408 This option works only with DWARF debug output.
7410 @item -femit-struct-debug-reduced
7411 @opindex femit-struct-debug-reduced
7412 Emit debug information for struct-like types
7413 only when the base name of the compilation source file
7414 matches the base name of file in which the type is defined,
7415 unless the struct is a template or defined in a system header.
7417 This option significantly reduces the size of debugging information,
7418 with some potential loss in type information to the debugger.
7419 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7420 See @option{-femit-struct-debug-detailed} for more detailed control.
7422 This option works only with DWARF debug output.
7424 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7425 @opindex femit-struct-debug-detailed
7426 Specify the struct-like types
7427 for which the compiler generates debug information.
7428 The intent is to reduce duplicate struct debug information
7429 between different object files within the same program.
7431 This option is a detailed version of
7432 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7433 which serves for most needs.
7435 A specification has the syntax@*
7436 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7438 The optional first word limits the specification to
7439 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7440 A struct type is used directly when it is the type of a variable, member.
7441 Indirect uses arise through pointers to structs.
7442 That is, when use of an incomplete struct is valid, the use is indirect.
7443 An example is
7444 @samp{struct one direct; struct two * indirect;}.
7446 The optional second word limits the specification to
7447 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7448 Generic structs are a bit complicated to explain.
7449 For C++, these are non-explicit specializations of template classes,
7450 or non-template classes within the above.
7451 Other programming languages have generics,
7452 but @option{-femit-struct-debug-detailed} does not yet implement them.
7454 The third word specifies the source files for those
7455 structs for which the compiler should emit debug information.
7456 The values @samp{none} and @samp{any} have the normal meaning.
7457 The value @samp{base} means that
7458 the base of name of the file in which the type declaration appears
7459 must match the base of the name of the main compilation file.
7460 In practice, this means that when compiling @file{foo.c}, debug information
7461 is generated for types declared in that file and @file{foo.h},
7462 but not other header files.
7463 The value @samp{sys} means those types satisfying @samp{base}
7464 or declared in system or compiler headers.
7466 You may need to experiment to determine the best settings for your application.
7468 The default is @option{-femit-struct-debug-detailed=all}.
7470 This option works only with DWARF debug output.
7472 @item -fno-dwarf2-cfi-asm
7473 @opindex fdwarf2-cfi-asm
7474 @opindex fno-dwarf2-cfi-asm
7475 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7476 instead of using GAS @code{.cfi_*} directives.
7478 @item -fno-eliminate-unused-debug-types
7479 @opindex feliminate-unused-debug-types
7480 @opindex fno-eliminate-unused-debug-types
7481 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7482 output for types that are nowhere used in the source file being compiled.
7483 Sometimes it is useful to have GCC emit debugging
7484 information for all types declared in a compilation
7485 unit, regardless of whether or not they are actually used
7486 in that compilation unit, for example 
7487 if, in the debugger, you want to cast a value to a type that is
7488 not actually used in your program (but is declared).  More often,
7489 however, this results in a significant amount of wasted space.
7490 @end table
7492 @node Optimize Options
7493 @section Options That Control Optimization
7494 @cindex optimize options
7495 @cindex options, optimization
7497 These options control various sorts of optimizations.
7499 Without any optimization option, the compiler's goal is to reduce the
7500 cost of compilation and to make debugging produce the expected
7501 results.  Statements are independent: if you stop the program with a
7502 breakpoint between statements, you can then assign a new value to any
7503 variable or change the program counter to any other statement in the
7504 function and get exactly the results you expect from the source
7505 code.
7507 Turning on optimization flags makes the compiler attempt to improve
7508 the performance and/or code size at the expense of compilation time
7509 and possibly the ability to debug the program.
7511 The compiler performs optimization based on the knowledge it has of the
7512 program.  Compiling multiple files at once to a single output file mode allows
7513 the compiler to use information gained from all of the files when compiling
7514 each of them.
7516 Not all optimizations are controlled directly by a flag.  Only
7517 optimizations that have a flag are listed in this section.
7519 Most optimizations are only enabled if an @option{-O} level is set on
7520 the command line.  Otherwise they are disabled, even if individual
7521 optimization flags are specified.
7523 Depending on the target and how GCC was configured, a slightly different
7524 set of optimizations may be enabled at each @option{-O} level than
7525 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7526 to find out the exact set of optimizations that are enabled at each level.
7527 @xref{Overall Options}, for examples.
7529 @table @gcctabopt
7530 @item -O
7531 @itemx -O1
7532 @opindex O
7533 @opindex O1
7534 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7535 more memory for a large function.
7537 With @option{-O}, the compiler tries to reduce code size and execution
7538 time, without performing any optimizations that take a great deal of
7539 compilation time.
7541 @option{-O} turns on the following optimization flags:
7542 @gccoptlist{
7543 -fauto-inc-dec @gol
7544 -fbranch-count-reg @gol
7545 -fcombine-stack-adjustments @gol
7546 -fcompare-elim @gol
7547 -fcprop-registers @gol
7548 -fdce @gol
7549 -fdefer-pop @gol
7550 -fdelayed-branch @gol
7551 -fdse @gol
7552 -fforward-propagate @gol
7553 -fguess-branch-probability @gol
7554 -fif-conversion2 @gol
7555 -fif-conversion @gol
7556 -finline-functions-called-once @gol
7557 -fipa-pure-const @gol
7558 -fipa-profile @gol
7559 -fipa-reference @gol
7560 -fmerge-constants @gol
7561 -fmove-loop-invariants @gol
7562 -fomit-frame-pointer @gol
7563 -freorder-blocks @gol
7564 -fshrink-wrap @gol
7565 -fshrink-wrap-separate @gol
7566 -fsplit-wide-types @gol
7567 -fssa-backprop @gol
7568 -fssa-phiopt @gol
7569 -ftree-bit-ccp @gol
7570 -ftree-ccp @gol
7571 -ftree-ch @gol
7572 -ftree-coalesce-vars @gol
7573 -ftree-copy-prop @gol
7574 -ftree-dce @gol
7575 -ftree-dominator-opts @gol
7576 -ftree-dse @gol
7577 -ftree-forwprop @gol
7578 -ftree-fre @gol
7579 -ftree-phiprop @gol
7580 -ftree-sink @gol
7581 -ftree-slsr @gol
7582 -ftree-sra @gol
7583 -ftree-pta @gol
7584 -ftree-ter @gol
7585 -funit-at-a-time}
7587 @item -O2
7588 @opindex O2
7589 Optimize even more.  GCC performs nearly all supported optimizations
7590 that do not involve a space-speed tradeoff.
7591 As compared to @option{-O}, this option increases both compilation time
7592 and the performance of the generated code.
7594 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7595 also turns on the following optimization flags:
7596 @gccoptlist{-fthread-jumps @gol
7597 -falign-functions  -falign-jumps @gol
7598 -falign-loops  -falign-labels @gol
7599 -fcaller-saves @gol
7600 -fcrossjumping @gol
7601 -fcse-follow-jumps  -fcse-skip-blocks @gol
7602 -fdelete-null-pointer-checks @gol
7603 -fdevirtualize -fdevirtualize-speculatively @gol
7604 -fexpensive-optimizations @gol
7605 -fgcse  -fgcse-lm  @gol
7606 -fhoist-adjacent-loads @gol
7607 -finline-small-functions @gol
7608 -findirect-inlining @gol
7609 -fipa-cp @gol
7610 -fipa-bit-cp @gol
7611 -fipa-vrp @gol
7612 -fipa-sra @gol
7613 -fipa-icf @gol
7614 -fisolate-erroneous-paths-dereference @gol
7615 -flra-remat @gol
7616 -foptimize-sibling-calls @gol
7617 -foptimize-strlen @gol
7618 -fpartial-inlining @gol
7619 -fpeephole2 @gol
7620 -freorder-blocks-algorithm=stc @gol
7621 -freorder-blocks-and-partition -freorder-functions @gol
7622 -frerun-cse-after-loop  @gol
7623 -fsched-interblock  -fsched-spec @gol
7624 -fschedule-insns  -fschedule-insns2 @gol
7625 -fstore-merging @gol
7626 -fstrict-aliasing @gol
7627 -ftree-builtin-call-dce @gol
7628 -ftree-switch-conversion -ftree-tail-merge @gol
7629 -fcode-hoisting @gol
7630 -ftree-pre @gol
7631 -ftree-vrp @gol
7632 -fipa-ra}
7634 Please note the warning under @option{-fgcse} about
7635 invoking @option{-O2} on programs that use computed gotos.
7637 @item -O3
7638 @opindex O3
7639 Optimize yet more.  @option{-O3} turns on all optimizations specified
7640 by @option{-O2} and also turns on the following optimization flags:
7641 @gccoptlist{-finline-functions @gol
7642 -funswitch-loops @gol
7643 -fpredictive-commoning @gol
7644 -fgcse-after-reload @gol
7645 -ftree-loop-vectorize @gol
7646 -ftree-loop-distribution @gol
7647 -ftree-loop-distribute-patterns @gol
7648 -floop-interchange @gol
7649 -fsplit-paths @gol
7650 -ftree-slp-vectorize @gol
7651 -fvect-cost-model @gol
7652 -ftree-partial-pre @gol
7653 -fpeel-loops @gol
7654 -fipa-cp-clone}
7656 @item -O0
7657 @opindex O0
7658 Reduce compilation time and make debugging produce the expected
7659 results.  This is the default.
7661 @item -Os
7662 @opindex Os
7663 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7664 do not typically increase code size.  It also performs further
7665 optimizations designed to reduce code size.
7667 @option{-Os} disables the following optimization flags:
7668 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7669 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7670 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7672 @item -Ofast
7673 @opindex Ofast
7674 Disregard strict standards compliance.  @option{-Ofast} enables all
7675 @option{-O3} optimizations.  It also enables optimizations that are not
7676 valid for all standard-compliant programs.
7677 It turns on @option{-ffast-math} and the Fortran-specific
7678 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7679 specified, and @option{-fno-protect-parens}.
7681 @item -Og
7682 @opindex Og
7683 Optimize debugging experience.  @option{-Og} enables optimizations
7684 that do not interfere with debugging. It should be the optimization
7685 level of choice for the standard edit-compile-debug cycle, offering
7686 a reasonable level of optimization while maintaining fast compilation
7687 and a good debugging experience.
7688 @end table
7690 If you use multiple @option{-O} options, with or without level numbers,
7691 the last such option is the one that is effective.
7693 Options of the form @option{-f@var{flag}} specify machine-independent
7694 flags.  Most flags have both positive and negative forms; the negative
7695 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7696 below, only one of the forms is listed---the one you typically 
7697 use.  You can figure out the other form by either removing @samp{no-}
7698 or adding it.
7700 The following options control specific optimizations.  They are either
7701 activated by @option{-O} options or are related to ones that are.  You
7702 can use the following flags in the rare cases when ``fine-tuning'' of
7703 optimizations to be performed is desired.
7705 @table @gcctabopt
7706 @item -fno-defer-pop
7707 @opindex fno-defer-pop
7708 Always pop the arguments to each function call as soon as that function
7709 returns.  For machines that must pop arguments after a function call,
7710 the compiler normally lets arguments accumulate on the stack for several
7711 function calls and pops them all at once.
7713 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7715 @item -fforward-propagate
7716 @opindex fforward-propagate
7717 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7718 instructions and checks if the result can be simplified.  If loop unrolling
7719 is active, two passes are performed and the second is scheduled after
7720 loop unrolling.
7722 This option is enabled by default at optimization levels @option{-O},
7723 @option{-O2}, @option{-O3}, @option{-Os}.
7725 @item -ffp-contract=@var{style}
7726 @opindex ffp-contract
7727 @option{-ffp-contract=off} disables floating-point expression contraction.
7728 @option{-ffp-contract=fast} enables floating-point expression contraction
7729 such as forming of fused multiply-add operations if the target has
7730 native support for them.
7731 @option{-ffp-contract=on} enables floating-point expression contraction
7732 if allowed by the language standard.  This is currently not implemented
7733 and treated equal to @option{-ffp-contract=off}.
7735 The default is @option{-ffp-contract=fast}.
7737 @item -fomit-frame-pointer
7738 @opindex fomit-frame-pointer
7739 Omit the frame pointer in functions that don't need one.  This avoids the
7740 instructions to save, set up and restore the frame pointer; on many targets
7741 it also makes an extra register available.
7743 On some targets this flag has no effect because the standard calling sequence
7744 always uses a frame pointer, so it cannot be omitted.
7746 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7747 is used in all functions.  Several targets always omit the frame pointer in
7748 leaf functions.
7750 Enabled by default at @option{-O} and higher.
7752 @item -foptimize-sibling-calls
7753 @opindex foptimize-sibling-calls
7754 Optimize sibling and tail recursive calls.
7756 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7758 @item -foptimize-strlen
7759 @opindex foptimize-strlen
7760 Optimize various standard C string functions (e.g. @code{strlen},
7761 @code{strchr} or @code{strcpy}) and
7762 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7764 Enabled at levels @option{-O2}, @option{-O3}.
7766 @item -fno-inline
7767 @opindex fno-inline
7768 Do not expand any functions inline apart from those marked with
7769 the @code{always_inline} attribute.  This is the default when not
7770 optimizing.
7772 Single functions can be exempted from inlining by marking them
7773 with the @code{noinline} attribute.
7775 @item -finline-small-functions
7776 @opindex finline-small-functions
7777 Integrate functions into their callers when their body is smaller than expected
7778 function call code (so overall size of program gets smaller).  The compiler
7779 heuristically decides which functions are simple enough to be worth integrating
7780 in this way.  This inlining applies to all functions, even those not declared
7781 inline.
7783 Enabled at level @option{-O2}.
7785 @item -findirect-inlining
7786 @opindex findirect-inlining
7787 Inline also indirect calls that are discovered to be known at compile
7788 time thanks to previous inlining.  This option has any effect only
7789 when inlining itself is turned on by the @option{-finline-functions}
7790 or @option{-finline-small-functions} options.
7792 Enabled at level @option{-O2}.
7794 @item -finline-functions
7795 @opindex finline-functions
7796 Consider all functions for inlining, even if they are not declared inline.
7797 The compiler heuristically decides which functions are worth integrating
7798 in this way.
7800 If all calls to a given function are integrated, and the function is
7801 declared @code{static}, then the function is normally not output as
7802 assembler code in its own right.
7804 Enabled at level @option{-O3}.
7806 @item -finline-functions-called-once
7807 @opindex finline-functions-called-once
7808 Consider all @code{static} functions called once for inlining into their
7809 caller even if they are not marked @code{inline}.  If a call to a given
7810 function is integrated, then the function is not output as assembler code
7811 in its own right.
7813 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7815 @item -fearly-inlining
7816 @opindex fearly-inlining
7817 Inline functions marked by @code{always_inline} and functions whose body seems
7818 smaller than the function call overhead early before doing
7819 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7820 makes profiling significantly cheaper and usually inlining faster on programs
7821 having large chains of nested wrapper functions.
7823 Enabled by default.
7825 @item -fipa-sra
7826 @opindex fipa-sra
7827 Perform interprocedural scalar replacement of aggregates, removal of
7828 unused parameters and replacement of parameters passed by reference
7829 by parameters passed by value.
7831 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7833 @item -finline-limit=@var{n}
7834 @opindex finline-limit
7835 By default, GCC limits the size of functions that can be inlined.  This flag
7836 allows coarse control of this limit.  @var{n} is the size of functions that
7837 can be inlined in number of pseudo instructions.
7839 Inlining is actually controlled by a number of parameters, which may be
7840 specified individually by using @option{--param @var{name}=@var{value}}.
7841 The @option{-finline-limit=@var{n}} option sets some of these parameters
7842 as follows:
7844 @table @gcctabopt
7845 @item max-inline-insns-single
7846 is set to @var{n}/2.
7847 @item max-inline-insns-auto
7848 is set to @var{n}/2.
7849 @end table
7851 See below for a documentation of the individual
7852 parameters controlling inlining and for the defaults of these parameters.
7854 @emph{Note:} there may be no value to @option{-finline-limit} that results
7855 in default behavior.
7857 @emph{Note:} pseudo instruction represents, in this particular context, an
7858 abstract measurement of function's size.  In no way does it represent a count
7859 of assembly instructions and as such its exact meaning might change from one
7860 release to an another.
7862 @item -fno-keep-inline-dllexport
7863 @opindex fno-keep-inline-dllexport
7864 This is a more fine-grained version of @option{-fkeep-inline-functions},
7865 which applies only to functions that are declared using the @code{dllexport}
7866 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7867 Functions}.
7869 @item -fkeep-inline-functions
7870 @opindex fkeep-inline-functions
7871 In C, emit @code{static} functions that are declared @code{inline}
7872 into the object file, even if the function has been inlined into all
7873 of its callers.  This switch does not affect functions using the
7874 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7875 inline functions into the object file.
7877 @item -fkeep-static-functions
7878 @opindex fkeep-static-functions
7879 Emit @code{static} functions into the object file, even if the function
7880 is never used.
7882 @item -fkeep-static-consts
7883 @opindex fkeep-static-consts
7884 Emit variables declared @code{static const} when optimization isn't turned
7885 on, even if the variables aren't referenced.
7887 GCC enables this option by default.  If you want to force the compiler to
7888 check if a variable is referenced, regardless of whether or not
7889 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7891 @item -fmerge-constants
7892 @opindex fmerge-constants
7893 Attempt to merge identical constants (string constants and floating-point
7894 constants) across compilation units.
7896 This option is the default for optimized compilation if the assembler and
7897 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7898 behavior.
7900 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7902 @item -fmerge-all-constants
7903 @opindex fmerge-all-constants
7904 Attempt to merge identical constants and identical variables.
7906 This option implies @option{-fmerge-constants}.  In addition to
7907 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7908 arrays or initialized constant variables with integral or floating-point
7909 types.  Languages like C or C++ require each variable, including multiple
7910 instances of the same variable in recursive calls, to have distinct locations,
7911 so using this option results in non-conforming
7912 behavior.
7914 @item -fmodulo-sched
7915 @opindex fmodulo-sched
7916 Perform swing modulo scheduling immediately before the first scheduling
7917 pass.  This pass looks at innermost loops and reorders their
7918 instructions by overlapping different iterations.
7920 @item -fmodulo-sched-allow-regmoves
7921 @opindex fmodulo-sched-allow-regmoves
7922 Perform more aggressive SMS-based modulo scheduling with register moves
7923 allowed.  By setting this flag certain anti-dependences edges are
7924 deleted, which triggers the generation of reg-moves based on the
7925 life-range analysis.  This option is effective only with
7926 @option{-fmodulo-sched} enabled.
7928 @item -fno-branch-count-reg
7929 @opindex fno-branch-count-reg
7930 Avoid running a pass scanning for opportunities to use ``decrement and
7931 branch'' instructions on a count register instead of generating sequences
7932 of instructions that decrement a register, compare it against zero, and
7933 then branch based upon the result.  This option is only meaningful on
7934 architectures that support such instructions, which include x86, PowerPC,
7935 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7936 doesn't remove the decrement and branch instructions from the generated
7937 instruction stream introduced by other optimization passes.
7939 Enabled by default at @option{-O1} and higher.
7941 The default is @option{-fbranch-count-reg}.
7943 @item -fno-function-cse
7944 @opindex fno-function-cse
7945 Do not put function addresses in registers; make each instruction that
7946 calls a constant function contain the function's address explicitly.
7948 This option results in less efficient code, but some strange hacks
7949 that alter the assembler output may be confused by the optimizations
7950 performed when this option is not used.
7952 The default is @option{-ffunction-cse}
7954 @item -fno-zero-initialized-in-bss
7955 @opindex fno-zero-initialized-in-bss
7956 If the target supports a BSS section, GCC by default puts variables that
7957 are initialized to zero into BSS@.  This can save space in the resulting
7958 code.
7960 This option turns off this behavior because some programs explicitly
7961 rely on variables going to the data section---e.g., so that the
7962 resulting executable can find the beginning of that section and/or make
7963 assumptions based on that.
7965 The default is @option{-fzero-initialized-in-bss}.
7967 @item -fthread-jumps
7968 @opindex fthread-jumps
7969 Perform optimizations that check to see if a jump branches to a
7970 location where another comparison subsumed by the first is found.  If
7971 so, the first branch is redirected to either the destination of the
7972 second branch or a point immediately following it, depending on whether
7973 the condition is known to be true or false.
7975 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7977 @item -fsplit-wide-types
7978 @opindex fsplit-wide-types
7979 When using a type that occupies multiple registers, such as @code{long
7980 long} on a 32-bit system, split the registers apart and allocate them
7981 independently.  This normally generates better code for those types,
7982 but may make debugging more difficult.
7984 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7985 @option{-Os}.
7987 @item -fcse-follow-jumps
7988 @opindex fcse-follow-jumps
7989 In common subexpression elimination (CSE), scan through jump instructions
7990 when the target of the jump is not reached by any other path.  For
7991 example, when CSE encounters an @code{if} statement with an
7992 @code{else} clause, CSE follows the jump when the condition
7993 tested is false.
7995 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7997 @item -fcse-skip-blocks
7998 @opindex fcse-skip-blocks
7999 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8000 follow jumps that conditionally skip over blocks.  When CSE
8001 encounters a simple @code{if} statement with no else clause,
8002 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8003 body of the @code{if}.
8005 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8007 @item -frerun-cse-after-loop
8008 @opindex frerun-cse-after-loop
8009 Re-run common subexpression elimination after loop optimizations are
8010 performed.
8012 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8014 @item -fgcse
8015 @opindex fgcse
8016 Perform a global common subexpression elimination pass.
8017 This pass also performs global constant and copy propagation.
8019 @emph{Note:} When compiling a program using computed gotos, a GCC
8020 extension, you may get better run-time performance if you disable
8021 the global common subexpression elimination pass by adding
8022 @option{-fno-gcse} to the command line.
8024 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8026 @item -fgcse-lm
8027 @opindex fgcse-lm
8028 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8029 attempts to move loads that are only killed by stores into themselves.  This
8030 allows a loop containing a load/store sequence to be changed to a load outside
8031 the loop, and a copy/store within the loop.
8033 Enabled by default when @option{-fgcse} is enabled.
8035 @item -fgcse-sm
8036 @opindex fgcse-sm
8037 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8038 global common subexpression elimination.  This pass attempts to move
8039 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8040 loops containing a load/store sequence can be changed to a load before
8041 the loop and a store after the loop.
8043 Not enabled at any optimization level.
8045 @item -fgcse-las
8046 @opindex fgcse-las
8047 When @option{-fgcse-las} is enabled, the global common subexpression
8048 elimination pass eliminates redundant loads that come after stores to the
8049 same memory location (both partial and full redundancies).
8051 Not enabled at any optimization level.
8053 @item -fgcse-after-reload
8054 @opindex fgcse-after-reload
8055 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8056 pass is performed after reload.  The purpose of this pass is to clean up
8057 redundant spilling.
8059 @item -faggressive-loop-optimizations
8060 @opindex faggressive-loop-optimizations
8061 This option tells the loop optimizer to use language constraints to
8062 derive bounds for the number of iterations of a loop.  This assumes that
8063 loop code does not invoke undefined behavior by for example causing signed
8064 integer overflows or out-of-bound array accesses.  The bounds for the
8065 number of iterations of a loop are used to guide loop unrolling and peeling
8066 and loop exit test optimizations.
8067 This option is enabled by default.
8069 @item -funconstrained-commons
8070 @opindex funconstrained-commons
8071 This option tells the compiler that variables declared in common blocks
8072 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8073 prevents certain optimizations that depend on knowing the array bounds.
8075 @item -fcrossjumping
8076 @opindex fcrossjumping
8077 Perform cross-jumping transformation.
8078 This transformation unifies equivalent code and saves code size.  The
8079 resulting code may or may not perform better than without cross-jumping.
8081 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8083 @item -fauto-inc-dec
8084 @opindex fauto-inc-dec
8085 Combine increments or decrements of addresses with memory accesses.
8086 This pass is always skipped on architectures that do not have
8087 instructions to support this.  Enabled by default at @option{-O} and
8088 higher on architectures that support this.
8090 @item -fdce
8091 @opindex fdce
8092 Perform dead code elimination (DCE) on RTL@.
8093 Enabled by default at @option{-O} and higher.
8095 @item -fdse
8096 @opindex fdse
8097 Perform dead store elimination (DSE) on RTL@.
8098 Enabled by default at @option{-O} and higher.
8100 @item -fif-conversion
8101 @opindex fif-conversion
8102 Attempt to transform conditional jumps into branch-less equivalents.  This
8103 includes use of conditional moves, min, max, set flags and abs instructions, and
8104 some tricks doable by standard arithmetics.  The use of conditional execution
8105 on chips where it is available is controlled by @option{-fif-conversion2}.
8107 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8109 @item -fif-conversion2
8110 @opindex fif-conversion2
8111 Use conditional execution (where available) to transform conditional jumps into
8112 branch-less equivalents.
8114 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8116 @item -fdeclone-ctor-dtor
8117 @opindex fdeclone-ctor-dtor
8118 The C++ ABI requires multiple entry points for constructors and
8119 destructors: one for a base subobject, one for a complete object, and
8120 one for a virtual destructor that calls operator delete afterwards.
8121 For a hierarchy with virtual bases, the base and complete variants are
8122 clones, which means two copies of the function.  With this option, the
8123 base and complete variants are changed to be thunks that call a common
8124 implementation.
8126 Enabled by @option{-Os}.
8128 @item -fdelete-null-pointer-checks
8129 @opindex fdelete-null-pointer-checks
8130 Assume that programs cannot safely dereference null pointers, and that
8131 no code or data element resides at address zero.
8132 This option enables simple constant
8133 folding optimizations at all optimization levels.  In addition, other
8134 optimization passes in GCC use this flag to control global dataflow
8135 analyses that eliminate useless checks for null pointers; these assume
8136 that a memory access to address zero always results in a trap, so
8137 that if a pointer is checked after it has already been dereferenced,
8138 it cannot be null.
8140 Note however that in some environments this assumption is not true.
8141 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8142 for programs that depend on that behavior.
8144 This option is enabled by default on most targets.  On Nios II ELF, it
8145 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8147 Passes that use the dataflow information
8148 are enabled independently at different optimization levels.
8150 @item -fdevirtualize
8151 @opindex fdevirtualize
8152 Attempt to convert calls to virtual functions to direct calls.  This
8153 is done both within a procedure and interprocedurally as part of
8154 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8155 propagation (@option{-fipa-cp}).
8156 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8158 @item -fdevirtualize-speculatively
8159 @opindex fdevirtualize-speculatively
8160 Attempt to convert calls to virtual functions to speculative direct calls.
8161 Based on the analysis of the type inheritance graph, determine for a given call
8162 the set of likely targets. If the set is small, preferably of size 1, change
8163 the call into a conditional deciding between direct and indirect calls.  The
8164 speculative calls enable more optimizations, such as inlining.  When they seem
8165 useless after further optimization, they are converted back into original form.
8167 @item -fdevirtualize-at-ltrans
8168 @opindex fdevirtualize-at-ltrans
8169 Stream extra information needed for aggressive devirtualization when running
8170 the link-time optimizer in local transformation mode.  
8171 This option enables more devirtualization but
8172 significantly increases the size of streamed data. For this reason it is
8173 disabled by default.
8175 @item -fexpensive-optimizations
8176 @opindex fexpensive-optimizations
8177 Perform a number of minor optimizations that are relatively expensive.
8179 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8181 @item -free
8182 @opindex free
8183 Attempt to remove redundant extension instructions.  This is especially
8184 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8185 registers after writing to their lower 32-bit half.
8187 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8188 @option{-O3}, @option{-Os}.
8190 @item -fno-lifetime-dse
8191 @opindex fno-lifetime-dse
8192 In C++ the value of an object is only affected by changes within its
8193 lifetime: when the constructor begins, the object has an indeterminate
8194 value, and any changes during the lifetime of the object are dead when
8195 the object is destroyed.  Normally dead store elimination will take
8196 advantage of this; if your code relies on the value of the object
8197 storage persisting beyond the lifetime of the object, you can use this
8198 flag to disable this optimization.  To preserve stores before the
8199 constructor starts (e.g. because your operator new clears the object
8200 storage) but still treat the object as dead after the destructor you,
8201 can use @option{-flifetime-dse=1}.  The default behavior can be
8202 explicitly selected with @option{-flifetime-dse=2}.
8203 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8205 @item -flive-range-shrinkage
8206 @opindex flive-range-shrinkage
8207 Attempt to decrease register pressure through register live range
8208 shrinkage.  This is helpful for fast processors with small or moderate
8209 size register sets.
8211 @item -fira-algorithm=@var{algorithm}
8212 @opindex fira-algorithm
8213 Use the specified coloring algorithm for the integrated register
8214 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8215 specifies Chow's priority coloring, or @samp{CB}, which specifies
8216 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8217 for all architectures, but for those targets that do support it, it is
8218 the default because it generates better code.
8220 @item -fira-region=@var{region}
8221 @opindex fira-region
8222 Use specified regions for the integrated register allocator.  The
8223 @var{region} argument should be one of the following:
8225 @table @samp
8227 @item all
8228 Use all loops as register allocation regions.
8229 This can give the best results for machines with a small and/or
8230 irregular register set.
8232 @item mixed
8233 Use all loops except for loops with small register pressure 
8234 as the regions.  This value usually gives
8235 the best results in most cases and for most architectures,
8236 and is enabled by default when compiling with optimization for speed
8237 (@option{-O}, @option{-O2}, @dots{}).
8239 @item one
8240 Use all functions as a single region.  
8241 This typically results in the smallest code size, and is enabled by default for
8242 @option{-Os} or @option{-O0}.
8244 @end table
8246 @item -fira-hoist-pressure
8247 @opindex fira-hoist-pressure
8248 Use IRA to evaluate register pressure in the code hoisting pass for
8249 decisions to hoist expressions.  This option usually results in smaller
8250 code, but it can slow the compiler down.
8252 This option is enabled at level @option{-Os} for all targets.
8254 @item -fira-loop-pressure
8255 @opindex fira-loop-pressure
8256 Use IRA to evaluate register pressure in loops for decisions to move
8257 loop invariants.  This option usually results in generation
8258 of faster and smaller code on machines with large register files (>= 32
8259 registers), but it can slow the compiler down.
8261 This option is enabled at level @option{-O3} for some targets.
8263 @item -fno-ira-share-save-slots
8264 @opindex fno-ira-share-save-slots
8265 Disable sharing of stack slots used for saving call-used hard
8266 registers living through a call.  Each hard register gets a
8267 separate stack slot, and as a result function stack frames are
8268 larger.
8270 @item -fno-ira-share-spill-slots
8271 @opindex fno-ira-share-spill-slots
8272 Disable sharing of stack slots allocated for pseudo-registers.  Each
8273 pseudo-register that does not get a hard register gets a separate
8274 stack slot, and as a result function stack frames are larger.
8276 @item -flra-remat
8277 @opindex flra-remat
8278 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8279 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8280 values if it is profitable.
8282 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8284 @item -fdelayed-branch
8285 @opindex fdelayed-branch
8286 If supported for the target machine, attempt to reorder instructions
8287 to exploit instruction slots available after delayed branch
8288 instructions.
8290 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8292 @item -fschedule-insns
8293 @opindex fschedule-insns
8294 If supported for the target machine, attempt to reorder instructions to
8295 eliminate execution stalls due to required data being unavailable.  This
8296 helps machines that have slow floating point or memory load instructions
8297 by allowing other instructions to be issued until the result of the load
8298 or floating-point instruction is required.
8300 Enabled at levels @option{-O2}, @option{-O3}.
8302 @item -fschedule-insns2
8303 @opindex fschedule-insns2
8304 Similar to @option{-fschedule-insns}, but requests an additional pass of
8305 instruction scheduling after register allocation has been done.  This is
8306 especially useful on machines with a relatively small number of
8307 registers and where memory load instructions take more than one cycle.
8309 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8311 @item -fno-sched-interblock
8312 @opindex fno-sched-interblock
8313 Don't schedule instructions across basic blocks.  This is normally
8314 enabled by default when scheduling before register allocation, i.e.@:
8315 with @option{-fschedule-insns} or at @option{-O2} or higher.
8317 @item -fno-sched-spec
8318 @opindex fno-sched-spec
8319 Don't allow speculative motion of non-load instructions.  This is normally
8320 enabled by default when scheduling before register allocation, i.e.@:
8321 with @option{-fschedule-insns} or at @option{-O2} or higher.
8323 @item -fsched-pressure
8324 @opindex fsched-pressure
8325 Enable register pressure sensitive insn scheduling before register
8326 allocation.  This only makes sense when scheduling before register
8327 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8328 @option{-O2} or higher.  Usage of this option can improve the
8329 generated code and decrease its size by preventing register pressure
8330 increase above the number of available hard registers and subsequent
8331 spills in register allocation.
8333 @item -fsched-spec-load
8334 @opindex fsched-spec-load
8335 Allow speculative motion of some load instructions.  This only makes
8336 sense when scheduling before register allocation, i.e.@: with
8337 @option{-fschedule-insns} or at @option{-O2} or higher.
8339 @item -fsched-spec-load-dangerous
8340 @opindex fsched-spec-load-dangerous
8341 Allow speculative motion of more load instructions.  This only makes
8342 sense when scheduling before register allocation, i.e.@: with
8343 @option{-fschedule-insns} or at @option{-O2} or higher.
8345 @item -fsched-stalled-insns
8346 @itemx -fsched-stalled-insns=@var{n}
8347 @opindex fsched-stalled-insns
8348 Define how many insns (if any) can be moved prematurely from the queue
8349 of stalled insns into the ready list during the second scheduling pass.
8350 @option{-fno-sched-stalled-insns} means that no insns are moved
8351 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8352 on how many queued insns can be moved prematurely.
8353 @option{-fsched-stalled-insns} without a value is equivalent to
8354 @option{-fsched-stalled-insns=1}.
8356 @item -fsched-stalled-insns-dep
8357 @itemx -fsched-stalled-insns-dep=@var{n}
8358 @opindex fsched-stalled-insns-dep
8359 Define how many insn groups (cycles) are examined for a dependency
8360 on a stalled insn that is a candidate for premature removal from the queue
8361 of stalled insns.  This has an effect only during the second scheduling pass,
8362 and only if @option{-fsched-stalled-insns} is used.
8363 @option{-fno-sched-stalled-insns-dep} is equivalent to
8364 @option{-fsched-stalled-insns-dep=0}.
8365 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8366 @option{-fsched-stalled-insns-dep=1}.
8368 @item -fsched2-use-superblocks
8369 @opindex fsched2-use-superblocks
8370 When scheduling after register allocation, use superblock scheduling.
8371 This allows motion across basic block boundaries,
8372 resulting in faster schedules.  This option is experimental, as not all machine
8373 descriptions used by GCC model the CPU closely enough to avoid unreliable
8374 results from the algorithm.
8376 This only makes sense when scheduling after register allocation, i.e.@: with
8377 @option{-fschedule-insns2} or at @option{-O2} or higher.
8379 @item -fsched-group-heuristic
8380 @opindex fsched-group-heuristic
8381 Enable the group heuristic in the scheduler.  This heuristic favors
8382 the instruction that belongs to a schedule group.  This is enabled
8383 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8384 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8386 @item -fsched-critical-path-heuristic
8387 @opindex fsched-critical-path-heuristic
8388 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8389 instructions on the critical path.  This is enabled by default when
8390 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8391 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8393 @item -fsched-spec-insn-heuristic
8394 @opindex fsched-spec-insn-heuristic
8395 Enable the speculative instruction heuristic in the scheduler.  This
8396 heuristic favors speculative instructions with greater dependency weakness.
8397 This is enabled by default when scheduling is enabled, i.e.@:
8398 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8399 or at @option{-O2} or higher.
8401 @item -fsched-rank-heuristic
8402 @opindex fsched-rank-heuristic
8403 Enable the rank heuristic in the scheduler.  This heuristic favors
8404 the instruction belonging to a basic block with greater size or frequency.
8405 This is enabled by default when scheduling is enabled, i.e.@:
8406 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8407 at @option{-O2} or higher.
8409 @item -fsched-last-insn-heuristic
8410 @opindex fsched-last-insn-heuristic
8411 Enable the last-instruction heuristic in the scheduler.  This heuristic
8412 favors the instruction that is less dependent on the last instruction
8413 scheduled.  This is enabled by default when scheduling is enabled,
8414 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8415 at @option{-O2} or higher.
8417 @item -fsched-dep-count-heuristic
8418 @opindex fsched-dep-count-heuristic
8419 Enable the dependent-count heuristic in the scheduler.  This heuristic
8420 favors the instruction that has more instructions depending on it.
8421 This is enabled by default when scheduling is enabled, i.e.@:
8422 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8423 at @option{-O2} or higher.
8425 @item -freschedule-modulo-scheduled-loops
8426 @opindex freschedule-modulo-scheduled-loops
8427 Modulo scheduling is performed before traditional scheduling.  If a loop
8428 is modulo scheduled, later scheduling passes may change its schedule.  
8429 Use this option to control that behavior.
8431 @item -fselective-scheduling
8432 @opindex fselective-scheduling
8433 Schedule instructions using selective scheduling algorithm.  Selective
8434 scheduling runs instead of the first scheduler pass.
8436 @item -fselective-scheduling2
8437 @opindex fselective-scheduling2
8438 Schedule instructions using selective scheduling algorithm.  Selective
8439 scheduling runs instead of the second scheduler pass.
8441 @item -fsel-sched-pipelining
8442 @opindex fsel-sched-pipelining
8443 Enable software pipelining of innermost loops during selective scheduling.
8444 This option has no effect unless one of @option{-fselective-scheduling} or
8445 @option{-fselective-scheduling2} is turned on.
8447 @item -fsel-sched-pipelining-outer-loops
8448 @opindex fsel-sched-pipelining-outer-loops
8449 When pipelining loops during selective scheduling, also pipeline outer loops.
8450 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8452 @item -fsemantic-interposition
8453 @opindex fsemantic-interposition
8454 Some object formats, like ELF, allow interposing of symbols by the 
8455 dynamic linker.
8456 This means that for symbols exported from the DSO, the compiler cannot perform
8457 interprocedural propagation, inlining and other optimizations in anticipation
8458 that the function or variable in question may change. While this feature is
8459 useful, for example, to rewrite memory allocation functions by a debugging
8460 implementation, it is expensive in the terms of code quality.
8461 With @option{-fno-semantic-interposition} the compiler assumes that 
8462 if interposition happens for functions the overwriting function will have 
8463 precisely the same semantics (and side effects). 
8464 Similarly if interposition happens
8465 for variables, the constructor of the variable will be the same. The flag
8466 has no effect for functions explicitly declared inline 
8467 (where it is never allowed for interposition to change semantics) 
8468 and for symbols explicitly declared weak.
8470 @item -fshrink-wrap
8471 @opindex fshrink-wrap
8472 Emit function prologues only before parts of the function that need it,
8473 rather than at the top of the function.  This flag is enabled by default at
8474 @option{-O} and higher.
8476 @item -fshrink-wrap-separate
8477 @opindex fshrink-wrap-separate
8478 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8479 those parts are only executed when needed.
8480 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8481 is also turned on and the target supports this.
8483 @item -fcaller-saves
8484 @opindex fcaller-saves
8485 Enable allocation of values to registers that are clobbered by
8486 function calls, by emitting extra instructions to save and restore the
8487 registers around such calls.  Such allocation is done only when it
8488 seems to result in better code.
8490 This option is always enabled by default on certain machines, usually
8491 those which have no call-preserved registers to use instead.
8493 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8495 @item -fcombine-stack-adjustments
8496 @opindex fcombine-stack-adjustments
8497 Tracks stack adjustments (pushes and pops) and stack memory references
8498 and then tries to find ways to combine them.
8500 Enabled by default at @option{-O1} and higher.
8502 @item -fipa-ra
8503 @opindex fipa-ra
8504 Use caller save registers for allocation if those registers are not used by
8505 any called function.  In that case it is not necessary to save and restore
8506 them around calls.  This is only possible if called functions are part of
8507 same compilation unit as current function and they are compiled before it.
8509 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8510 is disabled if generated code will be instrumented for profiling
8511 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8512 exactly (this happens on targets that do not expose prologues
8513 and epilogues in RTL).
8515 @item -fconserve-stack
8516 @opindex fconserve-stack
8517 Attempt to minimize stack usage.  The compiler attempts to use less
8518 stack space, even if that makes the program slower.  This option
8519 implies setting the @option{large-stack-frame} parameter to 100
8520 and the @option{large-stack-frame-growth} parameter to 400.
8522 @item -ftree-reassoc
8523 @opindex ftree-reassoc
8524 Perform reassociation on trees.  This flag is enabled by default
8525 at @option{-O} and higher.
8527 @item -fcode-hoisting
8528 @opindex fcode-hoisting
8529 Perform code hoisting.  Code hoisting tries to move the
8530 evaluation of expressions executed on all paths to the function exit
8531 as early as possible.  This is especially useful as a code size
8532 optimization, but it often helps for code speed as well.
8533 This flag is enabled by default at @option{-O2} and higher.
8535 @item -ftree-pre
8536 @opindex ftree-pre
8537 Perform partial redundancy elimination (PRE) on trees.  This flag is
8538 enabled by default at @option{-O2} and @option{-O3}.
8540 @item -ftree-partial-pre
8541 @opindex ftree-partial-pre
8542 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8543 enabled by default at @option{-O3}.
8545 @item -ftree-forwprop
8546 @opindex ftree-forwprop
8547 Perform forward propagation on trees.  This flag is enabled by default
8548 at @option{-O} and higher.
8550 @item -ftree-fre
8551 @opindex ftree-fre
8552 Perform full redundancy elimination (FRE) on trees.  The difference
8553 between FRE and PRE is that FRE only considers expressions
8554 that are computed on all paths leading to the redundant computation.
8555 This analysis is faster than PRE, though it exposes fewer redundancies.
8556 This flag is enabled by default at @option{-O} and higher.
8558 @item -ftree-phiprop
8559 @opindex ftree-phiprop
8560 Perform hoisting of loads from conditional pointers on trees.  This
8561 pass is enabled by default at @option{-O} and higher.
8563 @item -fhoist-adjacent-loads
8564 @opindex fhoist-adjacent-loads
8565 Speculatively hoist loads from both branches of an if-then-else if the
8566 loads are from adjacent locations in the same structure and the target
8567 architecture has a conditional move instruction.  This flag is enabled
8568 by default at @option{-O2} and higher.
8570 @item -ftree-copy-prop
8571 @opindex ftree-copy-prop
8572 Perform copy propagation on trees.  This pass eliminates unnecessary
8573 copy operations.  This flag is enabled by default at @option{-O} and
8574 higher.
8576 @item -fipa-pure-const
8577 @opindex fipa-pure-const
8578 Discover which functions are pure or constant.
8579 Enabled by default at @option{-O} and higher.
8581 @item -fipa-reference
8582 @opindex fipa-reference
8583 Discover which static variables do not escape the
8584 compilation unit.
8585 Enabled by default at @option{-O} and higher.
8587 @item -fipa-pta
8588 @opindex fipa-pta
8589 Perform interprocedural pointer analysis and interprocedural modification
8590 and reference analysis.  This option can cause excessive memory and
8591 compile-time usage on large compilation units.  It is not enabled by
8592 default at any optimization level.
8594 @item -fipa-profile
8595 @opindex fipa-profile
8596 Perform interprocedural profile propagation.  The functions called only from
8597 cold functions are marked as cold. Also functions executed once (such as
8598 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8599 functions and loop less parts of functions executed once are then optimized for
8600 size.
8601 Enabled by default at @option{-O} and higher.
8603 @item -fipa-cp
8604 @opindex fipa-cp
8605 Perform interprocedural constant propagation.
8606 This optimization analyzes the program to determine when values passed
8607 to functions are constants and then optimizes accordingly.
8608 This optimization can substantially increase performance
8609 if the application has constants passed to functions.
8610 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8612 @item -fipa-cp-clone
8613 @opindex fipa-cp-clone
8614 Perform function cloning to make interprocedural constant propagation stronger.
8615 When enabled, interprocedural constant propagation performs function cloning
8616 when externally visible function can be called with constant arguments.
8617 Because this optimization can create multiple copies of functions,
8618 it may significantly increase code size
8619 (see @option{--param ipcp-unit-growth=@var{value}}).
8620 This flag is enabled by default at @option{-O3}.
8622 @item -fipa-bit-cp
8623 @opindex -fipa-bit-cp
8624 When enabled, perform interprocedural bitwise constant
8625 propagation. This flag is enabled by default at @option{-O2}. It
8626 requires that @option{-fipa-cp} is enabled.
8628 @item -fipa-vrp
8629 @opindex -fipa-vrp
8630 When enabled, perform interprocedural propagation of value
8631 ranges. This flag is enabled by default at @option{-O2}. It requires
8632 that @option{-fipa-cp} is enabled.
8634 @item -fipa-icf
8635 @opindex fipa-icf
8636 Perform Identical Code Folding for functions and read-only variables.
8637 The optimization reduces code size and may disturb unwind stacks by replacing
8638 a function by equivalent one with a different name. The optimization works
8639 more effectively with link-time optimization enabled.
8641 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8642 works on different levels and thus the optimizations are not same - there are
8643 equivalences that are found only by GCC and equivalences found only by Gold.
8645 This flag is enabled by default at @option{-O2} and @option{-Os}.
8647 @item -fisolate-erroneous-paths-dereference
8648 @opindex fisolate-erroneous-paths-dereference
8649 Detect paths that trigger erroneous or undefined behavior due to
8650 dereferencing a null pointer.  Isolate those paths from the main control
8651 flow and turn the statement with erroneous or undefined behavior into a trap.
8652 This flag is enabled by default at @option{-O2} and higher and depends on
8653 @option{-fdelete-null-pointer-checks} also being enabled.
8655 @item -fisolate-erroneous-paths-attribute
8656 @opindex fisolate-erroneous-paths-attribute
8657 Detect paths that trigger erroneous or undefined behavior due to a null value
8658 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8659 attribute.  Isolate those paths from the main control flow and turn the
8660 statement with erroneous or undefined behavior into a trap.  This is not
8661 currently enabled, but may be enabled by @option{-O2} in the future.
8663 @item -ftree-sink
8664 @opindex ftree-sink
8665 Perform forward store motion on trees.  This flag is
8666 enabled by default at @option{-O} and higher.
8668 @item -ftree-bit-ccp
8669 @opindex ftree-bit-ccp
8670 Perform sparse conditional bit constant propagation on trees and propagate
8671 pointer alignment information.
8672 This pass only operates on local scalar variables and is enabled by default
8673 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8675 @item -ftree-ccp
8676 @opindex ftree-ccp
8677 Perform sparse conditional constant propagation (CCP) on trees.  This
8678 pass only operates on local scalar variables and is enabled by default
8679 at @option{-O} and higher.
8681 @item -fssa-backprop
8682 @opindex fssa-backprop
8683 Propagate information about uses of a value up the definition chain
8684 in order to simplify the definitions.  For example, this pass strips
8685 sign operations if the sign of a value never matters.  The flag is
8686 enabled by default at @option{-O} and higher.
8688 @item -fssa-phiopt
8689 @opindex fssa-phiopt
8690 Perform pattern matching on SSA PHI nodes to optimize conditional
8691 code.  This pass is enabled by default at @option{-O} and higher.
8693 @item -ftree-switch-conversion
8694 @opindex ftree-switch-conversion
8695 Perform conversion of simple initializations in a switch to
8696 initializations from a scalar array.  This flag is enabled by default
8697 at @option{-O2} and higher.
8699 @item -ftree-tail-merge
8700 @opindex ftree-tail-merge
8701 Look for identical code sequences.  When found, replace one with a jump to the
8702 other.  This optimization is known as tail merging or cross jumping.  This flag
8703 is enabled by default at @option{-O2} and higher.  The compilation time
8704 in this pass can
8705 be limited using @option{max-tail-merge-comparisons} parameter and
8706 @option{max-tail-merge-iterations} parameter.
8708 @item -ftree-dce
8709 @opindex ftree-dce
8710 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8711 default at @option{-O} and higher.
8713 @item -ftree-builtin-call-dce
8714 @opindex ftree-builtin-call-dce
8715 Perform conditional dead code elimination (DCE) for calls to built-in functions
8716 that may set @code{errno} but are otherwise side-effect free.  This flag is
8717 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8718 specified.
8720 @item -ftree-dominator-opts
8721 @opindex ftree-dominator-opts
8722 Perform a variety of simple scalar cleanups (constant/copy
8723 propagation, redundancy elimination, range propagation and expression
8724 simplification) based on a dominator tree traversal.  This also
8725 performs jump threading (to reduce jumps to jumps). This flag is
8726 enabled by default at @option{-O} and higher.
8728 @item -ftree-dse
8729 @opindex ftree-dse
8730 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8731 a memory location that is later overwritten by another store without
8732 any intervening loads.  In this case the earlier store can be deleted.  This
8733 flag is enabled by default at @option{-O} and higher.
8735 @item -ftree-ch
8736 @opindex ftree-ch
8737 Perform loop header copying on trees.  This is beneficial since it increases
8738 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8739 is enabled by default at @option{-O} and higher.  It is not enabled
8740 for @option{-Os}, since it usually increases code size.
8742 @item -ftree-loop-optimize
8743 @opindex ftree-loop-optimize
8744 Perform loop optimizations on trees.  This flag is enabled by default
8745 at @option{-O} and higher.
8747 @item -ftree-loop-linear
8748 @itemx -floop-strip-mine
8749 @itemx -floop-block
8750 @opindex ftree-loop-linear
8751 @opindex floop-strip-mine
8752 @opindex floop-block
8753 Perform loop nest optimizations.  Same as
8754 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8755 to be configured with @option{--with-isl} to enable the Graphite loop
8756 transformation infrastructure.
8758 @item -fgraphite-identity
8759 @opindex fgraphite-identity
8760 Enable the identity transformation for graphite.  For every SCoP we generate
8761 the polyhedral representation and transform it back to gimple.  Using
8762 @option{-fgraphite-identity} we can check the costs or benefits of the
8763 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8764 are also performed by the code generator isl, like index splitting and
8765 dead code elimination in loops.
8767 @item -floop-nest-optimize
8768 @opindex floop-nest-optimize
8769 Enable the isl based loop nest optimizer.  This is a generic loop nest
8770 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8771 structure optimized for data-locality and parallelism.  This option
8772 is experimental.
8774 @item -floop-parallelize-all
8775 @opindex floop-parallelize-all
8776 Use the Graphite data dependence analysis to identify loops that can
8777 be parallelized.  Parallelize all the loops that can be analyzed to
8778 not contain loop carried dependences without checking that it is
8779 profitable to parallelize the loops.
8781 @item -ftree-coalesce-vars
8782 @opindex ftree-coalesce-vars
8783 While transforming the program out of the SSA representation, attempt to
8784 reduce copying by coalescing versions of different user-defined
8785 variables, instead of just compiler temporaries.  This may severely
8786 limit the ability to debug an optimized program compiled with
8787 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8788 prevents SSA coalescing of user variables.  This option is enabled by
8789 default if optimization is enabled, and it does very little otherwise.
8791 @item -ftree-loop-if-convert
8792 @opindex ftree-loop-if-convert
8793 Attempt to transform conditional jumps in the innermost loops to
8794 branch-less equivalents.  The intent is to remove control-flow from
8795 the innermost loops in order to improve the ability of the
8796 vectorization pass to handle these loops.  This is enabled by default
8797 if vectorization is enabled.
8799 @item -ftree-loop-distribution
8800 @opindex ftree-loop-distribution
8801 Perform loop distribution.  This flag can improve cache performance on
8802 big loop bodies and allow further loop optimizations, like
8803 parallelization or vectorization, to take place.  For example, the loop
8804 @smallexample
8805 DO I = 1, N
8806   A(I) = B(I) + C
8807   D(I) = E(I) * F
8808 ENDDO
8809 @end smallexample
8810 is transformed to
8811 @smallexample
8812 DO I = 1, N
8813    A(I) = B(I) + C
8814 ENDDO
8815 DO I = 1, N
8816    D(I) = E(I) * F
8817 ENDDO
8818 @end smallexample
8820 @item -ftree-loop-distribute-patterns
8821 @opindex ftree-loop-distribute-patterns
8822 Perform loop distribution of patterns that can be code generated with
8823 calls to a library.  This flag is enabled by default at @option{-O3}.
8825 This pass distributes the initialization loops and generates a call to
8826 memset zero.  For example, the loop
8827 @smallexample
8828 DO I = 1, N
8829   A(I) = 0
8830   B(I) = A(I) + I
8831 ENDDO
8832 @end smallexample
8833 is transformed to
8834 @smallexample
8835 DO I = 1, N
8836    A(I) = 0
8837 ENDDO
8838 DO I = 1, N
8839    B(I) = A(I) + I
8840 ENDDO
8841 @end smallexample
8842 and the initialization loop is transformed into a call to memset zero.
8844 @item -floop-interchange
8845 @opindex floop-interchange
8846 Perform loop interchange outside of graphite.  This flag can improve cache
8847 performance on loop nest and allow further loop optimizations, like
8848 vectorization, to take place.  For example, the loop
8849 @smallexample
8850 for (int i = 0; i < N; i++)
8851   for (int j = 0; j < N; j++)
8852     for (int k = 0; k < N; k++)
8853       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8854 @end smallexample
8855 is transformed to
8856 @smallexample
8857 for (int i = 0; i < N; i++)
8858   for (int k = 0; k < N; k++)
8859     for (int j = 0; j < N; j++)
8860       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8861 @end smallexample
8863 @item -ftree-loop-im
8864 @opindex ftree-loop-im
8865 Perform loop invariant motion on trees.  This pass moves only invariants that
8866 are hard to handle at RTL level (function calls, operations that expand to
8867 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8868 operands of conditions that are invariant out of the loop, so that we can use
8869 just trivial invariantness analysis in loop unswitching.  The pass also includes
8870 store motion.
8872 @item -ftree-loop-ivcanon
8873 @opindex ftree-loop-ivcanon
8874 Create a canonical counter for number of iterations in loops for which
8875 determining number of iterations requires complicated analysis.  Later
8876 optimizations then may determine the number easily.  Useful especially
8877 in connection with unrolling.
8879 @item -fivopts
8880 @opindex fivopts
8881 Perform induction variable optimizations (strength reduction, induction
8882 variable merging and induction variable elimination) on trees.
8884 @item -ftree-parallelize-loops=n
8885 @opindex ftree-parallelize-loops
8886 Parallelize loops, i.e., split their iteration space to run in n threads.
8887 This is only possible for loops whose iterations are independent
8888 and can be arbitrarily reordered.  The optimization is only
8889 profitable on multiprocessor machines, for loops that are CPU-intensive,
8890 rather than constrained e.g.@: by memory bandwidth.  This option
8891 implies @option{-pthread}, and thus is only supported on targets
8892 that have support for @option{-pthread}.
8894 @item -ftree-pta
8895 @opindex ftree-pta
8896 Perform function-local points-to analysis on trees.  This flag is
8897 enabled by default at @option{-O} and higher.
8899 @item -ftree-sra
8900 @opindex ftree-sra
8901 Perform scalar replacement of aggregates.  This pass replaces structure
8902 references with scalars to prevent committing structures to memory too
8903 early.  This flag is enabled by default at @option{-O} and higher.
8905 @item -fstore-merging
8906 @opindex fstore-merging
8907 Perform merging of narrow stores to consecutive memory addresses.  This pass
8908 merges contiguous stores of immediate values narrower than a word into fewer
8909 wider stores to reduce the number of instructions.  This is enabled by default
8910 at @option{-O2} and higher as well as @option{-Os}.
8912 @item -ftree-ter
8913 @opindex ftree-ter
8914 Perform temporary expression replacement during the SSA->normal phase.  Single
8915 use/single def temporaries are replaced at their use location with their
8916 defining expression.  This results in non-GIMPLE code, but gives the expanders
8917 much more complex trees to work on resulting in better RTL generation.  This is
8918 enabled by default at @option{-O} and higher.
8920 @item -ftree-slsr
8921 @opindex ftree-slsr
8922 Perform straight-line strength reduction on trees.  This recognizes related
8923 expressions involving multiplications and replaces them by less expensive
8924 calculations when possible.  This is enabled by default at @option{-O} and
8925 higher.
8927 @item -ftree-vectorize
8928 @opindex ftree-vectorize
8929 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8930 and @option{-ftree-slp-vectorize} if not explicitly specified.
8932 @item -ftree-loop-vectorize
8933 @opindex ftree-loop-vectorize
8934 Perform loop vectorization on trees. This flag is enabled by default at
8935 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8937 @item -ftree-slp-vectorize
8938 @opindex ftree-slp-vectorize
8939 Perform basic block vectorization on trees. This flag is enabled by default at
8940 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8942 @item -fvect-cost-model=@var{model}
8943 @opindex fvect-cost-model
8944 Alter the cost model used for vectorization.  The @var{model} argument
8945 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8946 With the @samp{unlimited} model the vectorized code-path is assumed
8947 to be profitable while with the @samp{dynamic} model a runtime check
8948 guards the vectorized code-path to enable it only for iteration
8949 counts that will likely execute faster than when executing the original
8950 scalar loop.  The @samp{cheap} model disables vectorization of
8951 loops where doing so would be cost prohibitive for example due to
8952 required runtime checks for data dependence or alignment but otherwise
8953 is equal to the @samp{dynamic} model.
8954 The default cost model depends on other optimization flags and is
8955 either @samp{dynamic} or @samp{cheap}.
8957 @item -fsimd-cost-model=@var{model}
8958 @opindex fsimd-cost-model
8959 Alter the cost model used for vectorization of loops marked with the OpenMP
8960 simd directive.  The @var{model} argument should be one of
8961 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8962 have the same meaning as described in @option{-fvect-cost-model} and by
8963 default a cost model defined with @option{-fvect-cost-model} is used.
8965 @item -ftree-vrp
8966 @opindex ftree-vrp
8967 Perform Value Range Propagation on trees.  This is similar to the
8968 constant propagation pass, but instead of values, ranges of values are
8969 propagated.  This allows the optimizers to remove unnecessary range
8970 checks like array bound checks and null pointer checks.  This is
8971 enabled by default at @option{-O2} and higher.  Null pointer check
8972 elimination is only done if @option{-fdelete-null-pointer-checks} is
8973 enabled.
8975 @item -fsplit-paths
8976 @opindex fsplit-paths
8977 Split paths leading to loop backedges.  This can improve dead code
8978 elimination and common subexpression elimination.  This is enabled by
8979 default at @option{-O2} and above.
8981 @item -fsplit-ivs-in-unroller
8982 @opindex fsplit-ivs-in-unroller
8983 Enables expression of values of induction variables in later iterations
8984 of the unrolled loop using the value in the first iteration.  This breaks
8985 long dependency chains, thus improving efficiency of the scheduling passes.
8987 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8988 same effect.  However, that is not reliable in cases where the loop body
8989 is more complicated than a single basic block.  It also does not work at all
8990 on some architectures due to restrictions in the CSE pass.
8992 This optimization is enabled by default.
8994 @item -fvariable-expansion-in-unroller
8995 @opindex fvariable-expansion-in-unroller
8996 With this option, the compiler creates multiple copies of some
8997 local variables when unrolling a loop, which can result in superior code.
8999 @item -fpartial-inlining
9000 @opindex fpartial-inlining
9001 Inline parts of functions.  This option has any effect only
9002 when inlining itself is turned on by the @option{-finline-functions}
9003 or @option{-finline-small-functions} options.
9005 Enabled at level @option{-O2}.
9007 @item -fpredictive-commoning
9008 @opindex fpredictive-commoning
9009 Perform predictive commoning optimization, i.e., reusing computations
9010 (especially memory loads and stores) performed in previous
9011 iterations of loops.
9013 This option is enabled at level @option{-O3}.
9015 @item -fprefetch-loop-arrays
9016 @opindex fprefetch-loop-arrays
9017 If supported by the target machine, generate instructions to prefetch
9018 memory to improve the performance of loops that access large arrays.
9020 This option may generate better or worse code; results are highly
9021 dependent on the structure of loops within the source code.
9023 Disabled at level @option{-Os}.
9025 @item -fno-printf-return-value
9026 @opindex fno-printf-return-value
9027 Do not substitute constants for known return value of formatted output
9028 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9029 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9030 transformation allows GCC to optimize or even eliminate branches based
9031 on the known return value of these functions called with arguments that
9032 are either constant, or whose values are known to be in a range that
9033 makes determining the exact return value possible.  For example, when
9034 @option{-fprintf-return-value} is in effect, both the branch and the
9035 body of the @code{if} statement (but not the call to @code{snprint})
9036 can be optimized away when @code{i} is a 32-bit or smaller integer
9037 because the return value is guaranteed to be at most 8.
9039 @smallexample
9040 char buf[9];
9041 if (snprintf (buf, "%08x", i) >= sizeof buf)
9042   @dots{}
9043 @end smallexample
9045 The @option{-fprintf-return-value} option relies on other optimizations
9046 and yields best results with @option{-O2} and above.  It works in tandem
9047 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9048 options.  The @option{-fprintf-return-value} option is enabled by default.
9050 @item -fno-peephole
9051 @itemx -fno-peephole2
9052 @opindex fno-peephole
9053 @opindex fno-peephole2
9054 Disable any machine-specific peephole optimizations.  The difference
9055 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9056 are implemented in the compiler; some targets use one, some use the
9057 other, a few use both.
9059 @option{-fpeephole} is enabled by default.
9060 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9062 @item -fno-guess-branch-probability
9063 @opindex fno-guess-branch-probability
9064 Do not guess branch probabilities using heuristics.
9066 GCC uses heuristics to guess branch probabilities if they are
9067 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9068 heuristics are based on the control flow graph.  If some branch probabilities
9069 are specified by @code{__builtin_expect}, then the heuristics are
9070 used to guess branch probabilities for the rest of the control flow graph,
9071 taking the @code{__builtin_expect} info into account.  The interactions
9072 between the heuristics and @code{__builtin_expect} can be complex, and in
9073 some cases, it may be useful to disable the heuristics so that the effects
9074 of @code{__builtin_expect} are easier to understand.
9076 The default is @option{-fguess-branch-probability} at levels
9077 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9079 @item -freorder-blocks
9080 @opindex freorder-blocks
9081 Reorder basic blocks in the compiled function in order to reduce number of
9082 taken branches and improve code locality.
9084 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9086 @item -freorder-blocks-algorithm=@var{algorithm}
9087 @opindex freorder-blocks-algorithm
9088 Use the specified algorithm for basic block reordering.  The
9089 @var{algorithm} argument can be @samp{simple}, which does not increase
9090 code size (except sometimes due to secondary effects like alignment),
9091 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9092 put all often executed code together, minimizing the number of branches
9093 executed by making extra copies of code.
9095 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9096 @samp{stc} at levels @option{-O2}, @option{-O3}.
9098 @item -freorder-blocks-and-partition
9099 @opindex freorder-blocks-and-partition
9100 In addition to reordering basic blocks in the compiled function, in order
9101 to reduce number of taken branches, partitions hot and cold basic blocks
9102 into separate sections of the assembly and @file{.o} files, to improve
9103 paging and cache locality performance.
9105 This optimization is automatically turned off in the presence of
9106 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9107 section attribute and on any architecture that does not support named
9108 sections.  When @option{-fsplit-stack} is used this option is not
9109 enabled by default (to avoid linker errors), but may be enabled
9110 explicitly (if using a working linker).
9112 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9114 @item -freorder-functions
9115 @opindex freorder-functions
9116 Reorder functions in the object file in order to
9117 improve code locality.  This is implemented by using special
9118 subsections @code{.text.hot} for most frequently executed functions and
9119 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9120 the linker so object file format must support named sections and linker must
9121 place them in a reasonable way.
9123 Also profile feedback must be available to make this option effective.  See
9124 @option{-fprofile-arcs} for details.
9126 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9128 @item -fstrict-aliasing
9129 @opindex fstrict-aliasing
9130 Allow the compiler to assume the strictest aliasing rules applicable to
9131 the language being compiled.  For C (and C++), this activates
9132 optimizations based on the type of expressions.  In particular, an
9133 object of one type is assumed never to reside at the same address as an
9134 object of a different type, unless the types are almost the same.  For
9135 example, an @code{unsigned int} can alias an @code{int}, but not a
9136 @code{void*} or a @code{double}.  A character type may alias any other
9137 type.
9139 @anchor{Type-punning}Pay special attention to code like this:
9140 @smallexample
9141 union a_union @{
9142   int i;
9143   double d;
9146 int f() @{
9147   union a_union t;
9148   t.d = 3.0;
9149   return t.i;
9151 @end smallexample
9152 The practice of reading from a different union member than the one most
9153 recently written to (called ``type-punning'') is common.  Even with
9154 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9155 is accessed through the union type.  So, the code above works as
9156 expected.  @xref{Structures unions enumerations and bit-fields
9157 implementation}.  However, this code might not:
9158 @smallexample
9159 int f() @{
9160   union a_union t;
9161   int* ip;
9162   t.d = 3.0;
9163   ip = &t.i;
9164   return *ip;
9166 @end smallexample
9168 Similarly, access by taking the address, casting the resulting pointer
9169 and dereferencing the result has undefined behavior, even if the cast
9170 uses a union type, e.g.:
9171 @smallexample
9172 int f() @{
9173   double d = 3.0;
9174   return ((union a_union *) &d)->i;
9176 @end smallexample
9178 The @option{-fstrict-aliasing} option is enabled at levels
9179 @option{-O2}, @option{-O3}, @option{-Os}.
9181 @item -falign-functions
9182 @itemx -falign-functions=@var{n}
9183 @opindex falign-functions
9184 Align the start of functions to the next power-of-two greater than
9185 @var{n}, skipping up to @var{n} bytes.  For instance,
9186 @option{-falign-functions=32} aligns functions to the next 32-byte
9187 boundary, but @option{-falign-functions=24} aligns to the next
9188 32-byte boundary only if this can be done by skipping 23 bytes or less.
9190 @option{-fno-align-functions} and @option{-falign-functions=1} are
9191 equivalent and mean that functions are not aligned.
9193 Some assemblers only support this flag when @var{n} is a power of two;
9194 in that case, it is rounded up.
9196 If @var{n} is not specified or is zero, use a machine-dependent default.
9197 The maximum allowed @var{n} option value is 65536.
9199 Enabled at levels @option{-O2}, @option{-O3}.
9201 @item -flimit-function-alignment
9202 If this option is enabled, the compiler tries to avoid unnecessarily
9203 overaligning functions. It attempts to instruct the assembler to align
9204 by the amount specified by @option{-falign-functions}, but not to
9205 skip more bytes than the size of the function.
9207 @item -falign-labels
9208 @itemx -falign-labels=@var{n}
9209 @opindex falign-labels
9210 Align all branch targets to a power-of-two boundary, skipping up to
9211 @var{n} bytes like @option{-falign-functions}.  This option can easily
9212 make code slower, because it must insert dummy operations for when the
9213 branch target is reached in the usual flow of the code.
9215 @option{-fno-align-labels} and @option{-falign-labels=1} are
9216 equivalent and mean that labels are not aligned.
9218 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9219 are greater than this value, then their values are used instead.
9221 If @var{n} is not specified or is zero, use a machine-dependent default
9222 which is very likely to be @samp{1}, meaning no alignment.
9223 The maximum allowed @var{n} option value is 65536.
9225 Enabled at levels @option{-O2}, @option{-O3}.
9227 @item -falign-loops
9228 @itemx -falign-loops=@var{n}
9229 @opindex falign-loops
9230 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9231 like @option{-falign-functions}.  If the loops are
9232 executed many times, this makes up for any execution of the dummy
9233 operations.
9235 @option{-fno-align-loops} and @option{-falign-loops=1} are
9236 equivalent and mean that loops are not aligned.
9237 The maximum allowed @var{n} option value is 65536.
9239 If @var{n} is not specified or is zero, use a machine-dependent default.
9241 Enabled at levels @option{-O2}, @option{-O3}.
9243 @item -falign-jumps
9244 @itemx -falign-jumps=@var{n}
9245 @opindex falign-jumps
9246 Align branch targets to a power-of-two boundary, for branch targets
9247 where the targets can only be reached by jumping, skipping up to @var{n}
9248 bytes like @option{-falign-functions}.  In this case, no dummy operations
9249 need be executed.
9251 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9252 equivalent and mean that loops are not aligned.
9254 If @var{n} is not specified or is zero, use a machine-dependent default.
9255 The maximum allowed @var{n} option value is 65536.
9257 Enabled at levels @option{-O2}, @option{-O3}.
9259 @item -funit-at-a-time
9260 @opindex funit-at-a-time
9261 This option is left for compatibility reasons. @option{-funit-at-a-time}
9262 has no effect, while @option{-fno-unit-at-a-time} implies
9263 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9265 Enabled by default.
9267 @item -fno-toplevel-reorder
9268 @opindex fno-toplevel-reorder
9269 Do not reorder top-level functions, variables, and @code{asm}
9270 statements.  Output them in the same order that they appear in the
9271 input file.  When this option is used, unreferenced static variables
9272 are not removed.  This option is intended to support existing code
9273 that relies on a particular ordering.  For new code, it is better to
9274 use attributes when possible.
9276 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9277 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9278 targets.
9280 @item -fweb
9281 @opindex fweb
9282 Constructs webs as commonly used for register allocation purposes and assign
9283 each web individual pseudo register.  This allows the register allocation pass
9284 to operate on pseudos directly, but also strengthens several other optimization
9285 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9286 however, make debugging impossible, since variables no longer stay in a
9287 ``home register''.
9289 Enabled by default with @option{-funroll-loops}.
9291 @item -fwhole-program
9292 @opindex fwhole-program
9293 Assume that the current compilation unit represents the whole program being
9294 compiled.  All public functions and variables with the exception of @code{main}
9295 and those merged by attribute @code{externally_visible} become static functions
9296 and in effect are optimized more aggressively by interprocedural optimizers.
9298 This option should not be used in combination with @option{-flto}.
9299 Instead relying on a linker plugin should provide safer and more precise
9300 information.
9302 @item -flto[=@var{n}]
9303 @opindex flto
9304 This option runs the standard link-time optimizer.  When invoked
9305 with source code, it generates GIMPLE (one of GCC's internal
9306 representations) and writes it to special ELF sections in the object
9307 file.  When the object files are linked together, all the function
9308 bodies are read from these ELF sections and instantiated as if they
9309 had been part of the same translation unit.
9311 To use the link-time optimizer, @option{-flto} and optimization
9312 options should be specified at compile time and during the final link.
9313 It is recommended that you compile all the files participating in the
9314 same link with the same options and also specify those options at
9315 link time.  
9316 For example:
9318 @smallexample
9319 gcc -c -O2 -flto foo.c
9320 gcc -c -O2 -flto bar.c
9321 gcc -o myprog -flto -O2 foo.o bar.o
9322 @end smallexample
9324 The first two invocations to GCC save a bytecode representation
9325 of GIMPLE into special ELF sections inside @file{foo.o} and
9326 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9327 @file{foo.o} and @file{bar.o}, merges the two files into a single
9328 internal image, and compiles the result as usual.  Since both
9329 @file{foo.o} and @file{bar.o} are merged into a single image, this
9330 causes all the interprocedural analyses and optimizations in GCC to
9331 work across the two files as if they were a single one.  This means,
9332 for example, that the inliner is able to inline functions in
9333 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9335 Another (simpler) way to enable link-time optimization is:
9337 @smallexample
9338 gcc -o myprog -flto -O2 foo.c bar.c
9339 @end smallexample
9341 The above generates bytecode for @file{foo.c} and @file{bar.c},
9342 merges them together into a single GIMPLE representation and optimizes
9343 them as usual to produce @file{myprog}.
9345 The only important thing to keep in mind is that to enable link-time
9346 optimizations you need to use the GCC driver to perform the link step.
9347 GCC then automatically performs link-time optimization if any of the
9348 objects involved were compiled with the @option{-flto} command-line option.  
9349 You generally
9350 should specify the optimization options to be used for link-time
9351 optimization though GCC tries to be clever at guessing an
9352 optimization level to use from the options used at compile time
9353 if you fail to specify one at link time.  You can always override
9354 the automatic decision to do link-time optimization
9355 by passing @option{-fno-lto} to the link command.
9357 To make whole program optimization effective, it is necessary to make
9358 certain whole program assumptions.  The compiler needs to know
9359 what functions and variables can be accessed by libraries and runtime
9360 outside of the link-time optimized unit.  When supported by the linker,
9361 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9362 to the compiler about used and externally visible symbols.  When
9363 the linker plugin is not available, @option{-fwhole-program} should be
9364 used to allow the compiler to make these assumptions, which leads
9365 to more aggressive optimization decisions.
9367 When @option{-fuse-linker-plugin} is not enabled, when a file is
9368 compiled with @option{-flto}, the generated object file is larger than
9369 a regular object file because it contains GIMPLE bytecodes and the usual
9370 final code (see @option{-ffat-lto-objects}.  This means that
9371 object files with LTO information can be linked as normal object
9372 files; if @option{-fno-lto} is passed to the linker, no
9373 interprocedural optimizations are applied.  Note that when
9374 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9375 but you cannot perform a regular, non-LTO link on them.
9377 Additionally, the optimization flags used to compile individual files
9378 are not necessarily related to those used at link time.  For instance,
9380 @smallexample
9381 gcc -c -O0 -ffat-lto-objects -flto foo.c
9382 gcc -c -O0 -ffat-lto-objects -flto bar.c
9383 gcc -o myprog -O3 foo.o bar.o
9384 @end smallexample
9386 This produces individual object files with unoptimized assembler
9387 code, but the resulting binary @file{myprog} is optimized at
9388 @option{-O3}.  If, instead, the final binary is generated with
9389 @option{-fno-lto}, then @file{myprog} is not optimized.
9391 When producing the final binary, GCC only
9392 applies link-time optimizations to those files that contain bytecode.
9393 Therefore, you can mix and match object files and libraries with
9394 GIMPLE bytecodes and final object code.  GCC automatically selects
9395 which files to optimize in LTO mode and which files to link without
9396 further processing.
9398 There are some code generation flags preserved by GCC when
9399 generating bytecodes, as they need to be used during the final link
9400 stage.  Generally options specified at link time override those
9401 specified at compile time.
9403 If you do not specify an optimization level option @option{-O} at
9404 link time, then GCC uses the highest optimization level 
9405 used when compiling the object files.
9407 Currently, the following options and their settings are taken from
9408 the first object file that explicitly specifies them: 
9409 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9410 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9411 and all the @option{-m} target flags.
9413 Certain ABI-changing flags are required to match in all compilation units,
9414 and trying to override this at link time with a conflicting value
9415 is ignored.  This includes options such as @option{-freg-struct-return}
9416 and @option{-fpcc-struct-return}. 
9418 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9419 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9420 are passed through to the link stage and merged conservatively for
9421 conflicting translation units.  Specifically
9422 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9423 precedence; and for example @option{-ffp-contract=off} takes precedence
9424 over @option{-ffp-contract=fast}.  You can override them at link time.
9426 If LTO encounters objects with C linkage declared with incompatible
9427 types in separate translation units to be linked together (undefined
9428 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9429 issued.  The behavior is still undefined at run time.  Similar
9430 diagnostics may be raised for other languages.
9432 Another feature of LTO is that it is possible to apply interprocedural
9433 optimizations on files written in different languages:
9435 @smallexample
9436 gcc -c -flto foo.c
9437 g++ -c -flto bar.cc
9438 gfortran -c -flto baz.f90
9439 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9440 @end smallexample
9442 Notice that the final link is done with @command{g++} to get the C++
9443 runtime libraries and @option{-lgfortran} is added to get the Fortran
9444 runtime libraries.  In general, when mixing languages in LTO mode, you
9445 should use the same link command options as when mixing languages in a
9446 regular (non-LTO) compilation.
9448 If object files containing GIMPLE bytecode are stored in a library archive, say
9449 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9450 are using a linker with plugin support.  To create static libraries suitable
9451 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9452 and @command{ranlib}; 
9453 to show the symbols of object files with GIMPLE bytecode, use
9454 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9455 and @command{nm} have been compiled with plugin support.  At link time, use the the
9456 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9457 the LTO optimization process:
9459 @smallexample
9460 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9461 @end smallexample
9463 With the linker plugin enabled, the linker extracts the needed
9464 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9465 to make them part of the aggregated GIMPLE image to be optimized.
9467 If you are not using a linker with plugin support and/or do not
9468 enable the linker plugin, then the objects inside @file{libfoo.a}
9469 are extracted and linked as usual, but they do not participate
9470 in the LTO optimization process.  In order to make a static library suitable
9471 for both LTO optimization and usual linkage, compile its object files with
9472 @option{-flto} @option{-ffat-lto-objects}.
9474 Link-time optimizations do not require the presence of the whole program to
9475 operate.  If the program does not require any symbols to be exported, it is
9476 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9477 the interprocedural optimizers to use more aggressive assumptions which may
9478 lead to improved optimization opportunities.
9479 Use of @option{-fwhole-program} is not needed when linker plugin is
9480 active (see @option{-fuse-linker-plugin}).
9482 The current implementation of LTO makes no
9483 attempt to generate bytecode that is portable between different
9484 types of hosts.  The bytecode files are versioned and there is a
9485 strict version check, so bytecode files generated in one version of
9486 GCC do not work with an older or newer version of GCC.
9488 Link-time optimization does not work well with generation of debugging
9489 information on systems other than those using a combination of ELF and
9490 DWARF.
9492 If you specify the optional @var{n}, the optimization and code
9493 generation done at link time is executed in parallel using @var{n}
9494 parallel jobs by utilizing an installed @command{make} program.  The
9495 environment variable @env{MAKE} may be used to override the program
9496 used.  The default value for @var{n} is 1.
9498 You can also specify @option{-flto=jobserver} to use GNU make's
9499 job server mode to determine the number of parallel jobs. This
9500 is useful when the Makefile calling GCC is already executing in parallel.
9501 You must prepend a @samp{+} to the command recipe in the parent Makefile
9502 for this to work.  This option likely only works if @env{MAKE} is
9503 GNU make.
9505 @item -flto-partition=@var{alg}
9506 @opindex flto-partition
9507 Specify the partitioning algorithm used by the link-time optimizer.
9508 The value is either @samp{1to1} to specify a partitioning mirroring
9509 the original source files or @samp{balanced} to specify partitioning
9510 into equally sized chunks (whenever possible) or @samp{max} to create
9511 new partition for every symbol where possible.  Specifying @samp{none}
9512 as an algorithm disables partitioning and streaming completely. 
9513 The default value is @samp{balanced}. While @samp{1to1} can be used
9514 as an workaround for various code ordering issues, the @samp{max}
9515 partitioning is intended for internal testing only.
9516 The value @samp{one} specifies that exactly one partition should be
9517 used while the value @samp{none} bypasses partitioning and executes
9518 the link-time optimization step directly from the WPA phase.
9520 @item -flto-odr-type-merging
9521 @opindex flto-odr-type-merging
9522 Enable streaming of mangled types names of C++ types and their unification
9523 at link time.  This increases size of LTO object files, but enables
9524 diagnostics about One Definition Rule violations.
9526 @item -flto-compression-level=@var{n}
9527 @opindex flto-compression-level
9528 This option specifies the level of compression used for intermediate
9529 language written to LTO object files, and is only meaningful in
9530 conjunction with LTO mode (@option{-flto}).  Valid
9531 values are 0 (no compression) to 9 (maximum compression).  Values
9532 outside this range are clamped to either 0 or 9.  If the option is not
9533 given, a default balanced compression setting is used.
9535 @item -fuse-linker-plugin
9536 @opindex fuse-linker-plugin
9537 Enables the use of a linker plugin during link-time optimization.  This
9538 option relies on plugin support in the linker, which is available in gold
9539 or in GNU ld 2.21 or newer.
9541 This option enables the extraction of object files with GIMPLE bytecode out
9542 of library archives. This improves the quality of optimization by exposing
9543 more code to the link-time optimizer.  This information specifies what
9544 symbols can be accessed externally (by non-LTO object or during dynamic
9545 linking).  Resulting code quality improvements on binaries (and shared
9546 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9547 See @option{-flto} for a description of the effect of this flag and how to
9548 use it.
9550 This option is enabled by default when LTO support in GCC is enabled
9551 and GCC was configured for use with
9552 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9554 @item -ffat-lto-objects
9555 @opindex ffat-lto-objects
9556 Fat LTO objects are object files that contain both the intermediate language
9557 and the object code. This makes them usable for both LTO linking and normal
9558 linking. This option is effective only when compiling with @option{-flto}
9559 and is ignored at link time.
9561 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9562 requires the complete toolchain to be aware of LTO. It requires a linker with
9563 linker plugin support for basic functionality.  Additionally,
9564 @command{nm}, @command{ar} and @command{ranlib}
9565 need to support linker plugins to allow a full-featured build environment
9566 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9567 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9568 to these tools. With non fat LTO makefiles need to be modified to use them.
9570 Note that modern binutils provide plugin auto-load mechanism.
9571 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9572 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9573 @command{gcc-ranlib}).
9575 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9576 support.
9578 @item -fcompare-elim
9579 @opindex fcompare-elim
9580 After register allocation and post-register allocation instruction splitting,
9581 identify arithmetic instructions that compute processor flags similar to a
9582 comparison operation based on that arithmetic.  If possible, eliminate the
9583 explicit comparison operation.
9585 This pass only applies to certain targets that cannot explicitly represent
9586 the comparison operation before register allocation is complete.
9588 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9590 @item -fcprop-registers
9591 @opindex fcprop-registers
9592 After register allocation and post-register allocation instruction splitting,
9593 perform a copy-propagation pass to try to reduce scheduling dependencies
9594 and occasionally eliminate the copy.
9596 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9598 @item -fprofile-correction
9599 @opindex fprofile-correction
9600 Profiles collected using an instrumented binary for multi-threaded programs may
9601 be inconsistent due to missed counter updates. When this option is specified,
9602 GCC uses heuristics to correct or smooth out such inconsistencies. By
9603 default, GCC emits an error message when an inconsistent profile is detected.
9605 @item -fprofile-use
9606 @itemx -fprofile-use=@var{path}
9607 @opindex fprofile-use
9608 Enable profile feedback-directed optimizations, 
9609 and the following optimizations
9610 which are generally profitable only with profile feedback available:
9611 @option{-fbranch-probabilities}, @option{-fvpt},
9612 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9613 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9615 Before you can use this option, you must first generate profiling information.
9616 @xref{Instrumentation Options}, for information about the
9617 @option{-fprofile-generate} option.
9619 By default, GCC emits an error message if the feedback profiles do not
9620 match the source code.  This error can be turned into a warning by using
9621 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9622 code.
9624 If @var{path} is specified, GCC looks at the @var{path} to find
9625 the profile feedback data files. See @option{-fprofile-dir}.
9627 @item -fauto-profile
9628 @itemx -fauto-profile=@var{path}
9629 @opindex fauto-profile
9630 Enable sampling-based feedback-directed optimizations, 
9631 and the following optimizations
9632 which are generally profitable only with profile feedback available:
9633 @option{-fbranch-probabilities}, @option{-fvpt},
9634 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9635 @option{-ftree-vectorize},
9636 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9637 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9638 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9640 @var{path} is the name of a file containing AutoFDO profile information.
9641 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9643 Producing an AutoFDO profile data file requires running your program
9644 with the @command{perf} utility on a supported GNU/Linux target system.
9645 For more information, see @uref{https://perf.wiki.kernel.org/}.
9647 E.g.
9648 @smallexample
9649 perf record -e br_inst_retired:near_taken -b -o perf.data \
9650     -- your_program
9651 @end smallexample
9653 Then use the @command{create_gcov} tool to convert the raw profile data
9654 to a format that can be used by GCC.@  You must also supply the 
9655 unstripped binary for your program to this tool.  
9656 See @uref{https://github.com/google/autofdo}.
9658 E.g.
9659 @smallexample
9660 create_gcov --binary=your_program.unstripped --profile=perf.data \
9661     --gcov=profile.afdo
9662 @end smallexample
9663 @end table
9665 The following options control compiler behavior regarding floating-point 
9666 arithmetic.  These options trade off between speed and
9667 correctness.  All must be specifically enabled.
9669 @table @gcctabopt
9670 @item -ffloat-store
9671 @opindex ffloat-store
9672 Do not store floating-point variables in registers, and inhibit other
9673 options that might change whether a floating-point value is taken from a
9674 register or memory.
9676 @cindex floating-point precision
9677 This option prevents undesirable excess precision on machines such as
9678 the 68000 where the floating registers (of the 68881) keep more
9679 precision than a @code{double} is supposed to have.  Similarly for the
9680 x86 architecture.  For most programs, the excess precision does only
9681 good, but a few programs rely on the precise definition of IEEE floating
9682 point.  Use @option{-ffloat-store} for such programs, after modifying
9683 them to store all pertinent intermediate computations into variables.
9685 @item -fexcess-precision=@var{style}
9686 @opindex fexcess-precision
9687 This option allows further control over excess precision on machines
9688 where floating-point operations occur in a format with more precision or
9689 range than the IEEE standard and interchange floating-point types.  By
9690 default, @option{-fexcess-precision=fast} is in effect; this means that
9691 operations may be carried out in a wider precision than the types specified
9692 in the source if that would result in faster code, and it is unpredictable
9693 when rounding to the types specified in the source code takes place.
9694 When compiling C, if @option{-fexcess-precision=standard} is specified then
9695 excess precision follows the rules specified in ISO C99; in particular,
9696 both casts and assignments cause values to be rounded to their
9697 semantic types (whereas @option{-ffloat-store} only affects
9698 assignments).  This option is enabled by default for C if a strict
9699 conformance option such as @option{-std=c99} is used.
9700 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9701 regardless of whether a strict conformance option is used.
9703 @opindex mfpmath
9704 @option{-fexcess-precision=standard} is not implemented for languages
9705 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9706 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9707 semantics apply without excess precision, and in the latter, rounding
9708 is unpredictable.
9710 @item -ffast-math
9711 @opindex ffast-math
9712 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9713 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9714 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9715 @option{-fexcess-precision=fast}.
9717 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9719 This option is not turned on by any @option{-O} option besides
9720 @option{-Ofast} since it can result in incorrect output for programs
9721 that depend on an exact implementation of IEEE or ISO rules/specifications
9722 for math functions. It may, however, yield faster code for programs
9723 that do not require the guarantees of these specifications.
9725 @item -fno-math-errno
9726 @opindex fno-math-errno
9727 Do not set @code{errno} after calling math functions that are executed
9728 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9729 IEEE exceptions for math error handling may want to use this flag
9730 for speed while maintaining IEEE arithmetic compatibility.
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.
9738 The default is @option{-fmath-errno}.
9740 On Darwin systems, the math library never sets @code{errno}.  There is
9741 therefore no reason for the compiler to consider the possibility that
9742 it might, and @option{-fno-math-errno} is the default.
9744 @item -funsafe-math-optimizations
9745 @opindex funsafe-math-optimizations
9747 Allow optimizations for floating-point arithmetic that (a) assume
9748 that arguments and results are valid and (b) may violate IEEE or
9749 ANSI standards.  When used at link time, it may include libraries
9750 or startup files that change the default FPU control word or other
9751 similar optimizations.
9753 This option is not turned on by any @option{-O} option since
9754 it can result in incorrect output for programs that depend on
9755 an exact implementation of IEEE or ISO rules/specifications for
9756 math functions. It may, however, yield faster code for programs
9757 that do not require the guarantees of these specifications.
9758 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9759 @option{-fassociative-math} and @option{-freciprocal-math}.
9761 The default is @option{-fno-unsafe-math-optimizations}.
9763 @item -fassociative-math
9764 @opindex fassociative-math
9766 Allow re-association of operands in series of floating-point operations.
9767 This violates the ISO C and C++ language standard by possibly changing
9768 computation result.  NOTE: re-ordering may change the sign of zero as
9769 well as ignore NaNs and inhibit or create underflow or overflow (and
9770 thus cannot be used on code that relies on rounding behavior like
9771 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9772 and thus may not be used when ordered comparisons are required.
9773 This option requires that both @option{-fno-signed-zeros} and
9774 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9775 much sense with @option{-frounding-math}. For Fortran the option
9776 is automatically enabled when both @option{-fno-signed-zeros} and
9777 @option{-fno-trapping-math} are in effect.
9779 The default is @option{-fno-associative-math}.
9781 @item -freciprocal-math
9782 @opindex freciprocal-math
9784 Allow the reciprocal of a value to be used instead of dividing by
9785 the value if this enables optimizations.  For example @code{x / y}
9786 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9787 is subject to common subexpression elimination.  Note that this loses
9788 precision and increases the number of flops operating on the value.
9790 The default is @option{-fno-reciprocal-math}.
9792 @item -ffinite-math-only
9793 @opindex ffinite-math-only
9794 Allow optimizations for floating-point arithmetic that assume
9795 that arguments and results are not NaNs or +-Infs.
9797 This option is not turned on by any @option{-O} option since
9798 it can result in incorrect output for programs that depend on
9799 an exact implementation of IEEE or ISO rules/specifications for
9800 math functions. It may, however, yield faster code for programs
9801 that do not require the guarantees of these specifications.
9803 The default is @option{-fno-finite-math-only}.
9805 @item -fno-signed-zeros
9806 @opindex fno-signed-zeros
9807 Allow optimizations for floating-point arithmetic that ignore the
9808 signedness of zero.  IEEE arithmetic specifies the behavior of
9809 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9810 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9811 This option implies that the sign of a zero result isn't significant.
9813 The default is @option{-fsigned-zeros}.
9815 @item -fno-trapping-math
9816 @opindex fno-trapping-math
9817 Compile code assuming that floating-point operations cannot generate
9818 user-visible traps.  These traps include division by zero, overflow,
9819 underflow, inexact result and invalid operation.  This option requires
9820 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9821 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9823 This option should never be turned on by any @option{-O} option since
9824 it can result in incorrect output for programs that depend on
9825 an exact implementation of IEEE or ISO rules/specifications for
9826 math functions.
9828 The default is @option{-ftrapping-math}.
9830 @item -frounding-math
9831 @opindex frounding-math
9832 Disable transformations and optimizations that assume default floating-point
9833 rounding behavior.  This is round-to-zero for all floating point
9834 to integer conversions, and round-to-nearest for all other arithmetic
9835 truncations.  This option should be specified for programs that change
9836 the FP rounding mode dynamically, or that may be executed with a
9837 non-default rounding mode.  This option disables constant folding of
9838 floating-point expressions at compile time (which may be affected by
9839 rounding mode) and arithmetic transformations that are unsafe in the
9840 presence of sign-dependent rounding modes.
9842 The default is @option{-fno-rounding-math}.
9844 This option is experimental and does not currently guarantee to
9845 disable all GCC optimizations that are affected by rounding mode.
9846 Future versions of GCC may provide finer control of this setting
9847 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9848 will be used to specify the default state for @code{FENV_ACCESS}.
9850 @item -fsignaling-nans
9851 @opindex fsignaling-nans
9852 Compile code assuming that IEEE signaling NaNs may generate user-visible
9853 traps during floating-point operations.  Setting this option disables
9854 optimizations that may change the number of exceptions visible with
9855 signaling NaNs.  This option implies @option{-ftrapping-math}.
9857 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9858 be defined.
9860 The default is @option{-fno-signaling-nans}.
9862 This option is experimental and does not currently guarantee to
9863 disable all GCC optimizations that affect signaling NaN behavior.
9865 @item -fno-fp-int-builtin-inexact
9866 @opindex fno-fp-int-builtin-inexact
9867 Do not allow the built-in functions @code{ceil}, @code{floor},
9868 @code{round} and @code{trunc}, and their @code{float} and @code{long
9869 double} variants, to generate code that raises the ``inexact''
9870 floating-point exception for noninteger arguments.  ISO C99 and C11
9871 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9872 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9873 functions to do so.
9875 The default is @option{-ffp-int-builtin-inexact}, allowing the
9876 exception to be raised.  This option does nothing unless
9877 @option{-ftrapping-math} is in effect.
9879 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9880 generate a call to a library function then the ``inexact'' exception
9881 may be raised if the library implementation does not follow TS 18661.
9883 @item -fsingle-precision-constant
9884 @opindex fsingle-precision-constant
9885 Treat floating-point constants as single precision instead of
9886 implicitly converting them to double-precision constants.
9888 @item -fcx-limited-range
9889 @opindex fcx-limited-range
9890 When enabled, this option states that a range reduction step is not
9891 needed when performing complex division.  Also, there is no checking
9892 whether the result of a complex multiplication or division is @code{NaN
9893 + I*NaN}, with an attempt to rescue the situation in that case.  The
9894 default is @option{-fno-cx-limited-range}, but is enabled by
9895 @option{-ffast-math}.
9897 This option controls the default setting of the ISO C99
9898 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9899 all languages.
9901 @item -fcx-fortran-rules
9902 @opindex fcx-fortran-rules
9903 Complex multiplication and division follow Fortran rules.  Range
9904 reduction is done as part of complex division, but there is no checking
9905 whether the result of a complex multiplication or division is @code{NaN
9906 + I*NaN}, with an attempt to rescue the situation in that case.
9908 The default is @option{-fno-cx-fortran-rules}.
9910 @end table
9912 The following options control optimizations that may improve
9913 performance, but are not enabled by any @option{-O} options.  This
9914 section includes experimental options that may produce broken code.
9916 @table @gcctabopt
9917 @item -fbranch-probabilities
9918 @opindex fbranch-probabilities
9919 After running a program compiled with @option{-fprofile-arcs}
9920 (@pxref{Instrumentation Options}),
9921 you can compile it a second time using
9922 @option{-fbranch-probabilities}, to improve optimizations based on
9923 the number of times each branch was taken.  When a program
9924 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9925 counts to a file called @file{@var{sourcename}.gcda} for each source
9926 file.  The information in this data file is very dependent on the
9927 structure of the generated code, so you must use the same source code
9928 and the same optimization options for both compilations.
9930 With @option{-fbranch-probabilities}, GCC puts a
9931 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9932 These can be used to improve optimization.  Currently, they are only
9933 used in one place: in @file{reorg.c}, instead of guessing which path a
9934 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9935 exactly determine which path is taken more often.
9937 @item -fprofile-values
9938 @opindex fprofile-values
9939 If combined with @option{-fprofile-arcs}, it adds code so that some
9940 data about values of expressions in the program is gathered.
9942 With @option{-fbranch-probabilities}, it reads back the data gathered
9943 from profiling values of expressions for usage in optimizations.
9945 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9947 @item -fprofile-reorder-functions
9948 @opindex fprofile-reorder-functions
9949 Function reordering based on profile instrumentation collects
9950 first time of execution of a function and orders these functions
9951 in ascending order.
9953 Enabled with @option{-fprofile-use}.
9955 @item -fvpt
9956 @opindex fvpt
9957 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9958 to add code to gather information about values of expressions.
9960 With @option{-fbranch-probabilities}, it reads back the data gathered
9961 and actually performs the optimizations based on them.
9962 Currently the optimizations include specialization of division operations
9963 using the knowledge about the value of the denominator.
9965 @item -frename-registers
9966 @opindex frename-registers
9967 Attempt to avoid false dependencies in scheduled code by making use
9968 of registers left over after register allocation.  This optimization
9969 most benefits processors with lots of registers.  Depending on the
9970 debug information format adopted by the target, however, it can
9971 make debugging impossible, since variables no longer stay in
9972 a ``home register''.
9974 Enabled by default with @option{-funroll-loops}.
9976 @item -fschedule-fusion
9977 @opindex fschedule-fusion
9978 Performs a target dependent pass over the instruction stream to schedule
9979 instructions of same type together because target machine can execute them
9980 more efficiently if they are adjacent to each other in the instruction flow.
9982 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9984 @item -ftracer
9985 @opindex ftracer
9986 Perform tail duplication to enlarge superblock size.  This transformation
9987 simplifies the control flow of the function allowing other optimizations to do
9988 a better job.
9990 Enabled with @option{-fprofile-use}.
9992 @item -funroll-loops
9993 @opindex funroll-loops
9994 Unroll loops whose number of iterations can be determined at compile time or
9995 upon entry to the loop.  @option{-funroll-loops} implies
9996 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9997 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9998 a small constant number of iterations).  This option makes code larger, and may
9999 or may not make it run faster.
10001 Enabled with @option{-fprofile-use}.
10003 @item -funroll-all-loops
10004 @opindex funroll-all-loops
10005 Unroll all loops, even if their number of iterations is uncertain when
10006 the loop is entered.  This usually makes programs run more slowly.
10007 @option{-funroll-all-loops} implies the same options as
10008 @option{-funroll-loops}.
10010 @item -fpeel-loops
10011 @opindex fpeel-loops
10012 Peels loops for which there is enough information that they do not
10013 roll much (from profile feedback or static analysis).  It also turns on
10014 complete loop peeling (i.e.@: complete removal of loops with small constant
10015 number of iterations).
10017 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10019 @item -fmove-loop-invariants
10020 @opindex fmove-loop-invariants
10021 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10022 at level @option{-O1}
10024 @item -fsplit-loops
10025 @opindex fsplit-loops
10026 Split a loop into two if it contains a condition that's always true
10027 for one side of the iteration space and false for the other.
10029 @item -funswitch-loops
10030 @opindex funswitch-loops
10031 Move branches with loop invariant conditions out of the loop, with duplicates
10032 of the loop on both branches (modified according to result of the condition).
10034 @item -floop-unroll-and-jam
10035 @opindex floop-unroll-and-jam
10036 Apply unroll and jam transformations on feasible loops.  In a loop
10037 nest this unrolls the outer loop by some factor and fuses the resulting
10038 multiple inner loops.
10040 @item -ffunction-sections
10041 @itemx -fdata-sections
10042 @opindex ffunction-sections
10043 @opindex fdata-sections
10044 Place each function or data item into its own section in the output
10045 file if the target supports arbitrary sections.  The name of the
10046 function or the name of the data item determines the section's name
10047 in the output file.
10049 Use these options on systems where the linker can perform optimizations to
10050 improve locality of reference in the instruction space.  Most systems using the
10051 ELF object format have linkers with such optimizations.  On AIX, the linker
10052 rearranges sections (CSECTs) based on the call graph.  The performance impact
10053 varies.
10055 Together with a linker garbage collection (linker @option{--gc-sections}
10056 option) these options may lead to smaller statically-linked executables (after
10057 stripping).
10059 On ELF/DWARF systems these options do not degenerate the quality of the debug
10060 information.  There could be issues with other object files/debug info formats.
10062 Only use these options when there are significant benefits from doing so.  When
10063 you specify these options, the assembler and linker create larger object and
10064 executable files and are also slower.  These options affect code generation.
10065 They prevent optimizations by the compiler and assembler using relative
10066 locations inside a translation unit since the locations are unknown until
10067 link time.  An example of such an optimization is relaxing calls to short call
10068 instructions.
10070 @item -fbranch-target-load-optimize
10071 @opindex fbranch-target-load-optimize
10072 Perform branch target register load optimization before prologue / epilogue
10073 threading.
10074 The use of target registers can typically be exposed only during reload,
10075 thus hoisting loads out of loops and doing inter-block scheduling needs
10076 a separate optimization pass.
10078 @item -fbranch-target-load-optimize2
10079 @opindex fbranch-target-load-optimize2
10080 Perform branch target register load optimization after prologue / epilogue
10081 threading.
10083 @item -fbtr-bb-exclusive
10084 @opindex fbtr-bb-exclusive
10085 When performing branch target register load optimization, don't reuse
10086 branch target registers within any basic block.
10088 @item -fstdarg-opt
10089 @opindex fstdarg-opt
10090 Optimize the prologue of variadic argument functions with respect to usage of
10091 those arguments.
10093 @item -fsection-anchors
10094 @opindex fsection-anchors
10095 Try to reduce the number of symbolic address calculations by using
10096 shared ``anchor'' symbols to address nearby objects.  This transformation
10097 can help to reduce the number of GOT entries and GOT accesses on some
10098 targets.
10100 For example, the implementation of the following function @code{foo}:
10102 @smallexample
10103 static int a, b, c;
10104 int foo (void) @{ return a + b + c; @}
10105 @end smallexample
10107 @noindent
10108 usually calculates the addresses of all three variables, but if you
10109 compile it with @option{-fsection-anchors}, it accesses the variables
10110 from a common anchor point instead.  The effect is similar to the
10111 following pseudocode (which isn't valid C):
10113 @smallexample
10114 int foo (void)
10116   register int *xr = &x;
10117   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10119 @end smallexample
10121 Not all targets support this option.
10123 @item --param @var{name}=@var{value}
10124 @opindex param
10125 In some places, GCC uses various constants to control the amount of
10126 optimization that is done.  For example, GCC does not inline functions
10127 that contain more than a certain number of instructions.  You can
10128 control some of these constants on the command line using the
10129 @option{--param} option.
10131 The names of specific parameters, and the meaning of the values, are
10132 tied to the internals of the compiler, and are subject to change
10133 without notice in future releases.
10135 In each case, the @var{value} is an integer.  The allowable choices for
10136 @var{name} are:
10138 @table @gcctabopt
10139 @item predictable-branch-outcome
10140 When branch is predicted to be taken with probability lower than this threshold
10141 (in percent), then it is considered well predictable. The default is 10.
10143 @item max-rtl-if-conversion-insns
10144 RTL if-conversion tries to remove conditional branches around a block and
10145 replace them with conditionally executed instructions.  This parameter
10146 gives the maximum number of instructions in a block which should be
10147 considered for if-conversion.  The default is 10, though the compiler will
10148 also use other heuristics to decide whether if-conversion is likely to be
10149 profitable.
10151 @item max-rtl-if-conversion-predictable-cost
10152 @itemx max-rtl-if-conversion-unpredictable-cost
10153 RTL if-conversion will try to remove conditional branches around a block
10154 and replace them with conditionally executed instructions.  These parameters
10155 give the maximum permissible cost for the sequence that would be generated
10156 by if-conversion depending on whether the branch is statically determined
10157 to be predictable or not.  The units for this parameter are the same as
10158 those for the GCC internal seq_cost metric.  The compiler will try to
10159 provide a reasonable default for this parameter using the BRANCH_COST
10160 target macro.
10162 @item max-crossjump-edges
10163 The maximum number of incoming edges to consider for cross-jumping.
10164 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10165 the number of edges incoming to each block.  Increasing values mean
10166 more aggressive optimization, making the compilation time increase with
10167 probably small improvement in executable size.
10169 @item min-crossjump-insns
10170 The minimum number of instructions that must be matched at the end
10171 of two blocks before cross-jumping is performed on them.  This
10172 value is ignored in the case where all instructions in the block being
10173 cross-jumped from are matched.  The default value is 5.
10175 @item max-grow-copy-bb-insns
10176 The maximum code size expansion factor when copying basic blocks
10177 instead of jumping.  The expansion is relative to a jump instruction.
10178 The default value is 8.
10180 @item max-goto-duplication-insns
10181 The maximum number of instructions to duplicate to a block that jumps
10182 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10183 passes, GCC factors computed gotos early in the compilation process,
10184 and unfactors them as late as possible.  Only computed jumps at the
10185 end of a basic blocks with no more than max-goto-duplication-insns are
10186 unfactored.  The default value is 8.
10188 @item max-delay-slot-insn-search
10189 The maximum number of instructions to consider when looking for an
10190 instruction to fill a delay slot.  If more than this arbitrary number of
10191 instructions are searched, the time savings from filling the delay slot
10192 are minimal, so stop searching.  Increasing values mean more
10193 aggressive optimization, making the compilation time increase with probably
10194 small improvement in execution time.
10196 @item max-delay-slot-live-search
10197 When trying to fill delay slots, the maximum number of instructions to
10198 consider when searching for a block with valid live register
10199 information.  Increasing this arbitrarily chosen value means more
10200 aggressive optimization, increasing the compilation time.  This parameter
10201 should be removed when the delay slot code is rewritten to maintain the
10202 control-flow graph.
10204 @item max-gcse-memory
10205 The approximate maximum amount of memory that can be allocated in
10206 order to perform the global common subexpression elimination
10207 optimization.  If more memory than specified is required, the
10208 optimization is not done.
10210 @item max-gcse-insertion-ratio
10211 If the ratio of expression insertions to deletions is larger than this value
10212 for any expression, then RTL PRE inserts or removes the expression and thus
10213 leaves partially redundant computations in the instruction stream.  The default value is 20.
10215 @item max-pending-list-length
10216 The maximum number of pending dependencies scheduling allows
10217 before flushing the current state and starting over.  Large functions
10218 with few branches or calls can create excessively large lists which
10219 needlessly consume memory and resources.
10221 @item max-modulo-backtrack-attempts
10222 The maximum number of backtrack attempts the scheduler should make
10223 when modulo scheduling a loop.  Larger values can exponentially increase
10224 compilation time.
10226 @item max-inline-insns-single
10227 Several parameters control the tree inliner used in GCC@.
10228 This number sets the maximum number of instructions (counted in GCC's
10229 internal representation) in a single function that the tree inliner
10230 considers for inlining.  This only affects functions declared
10231 inline and methods implemented in a class declaration (C++).
10232 The default value is 400.
10234 @item max-inline-insns-auto
10235 When you use @option{-finline-functions} (included in @option{-O3}),
10236 a lot of functions that would otherwise not be considered for inlining
10237 by the compiler are investigated.  To those functions, a different
10238 (more restrictive) limit compared to functions declared inline can
10239 be applied.
10240 The default value is 30.
10242 @item inline-min-speedup
10243 When estimated performance improvement of caller + callee runtime exceeds this
10244 threshold (in percent), the function can be inlined regardless of the limit on
10245 @option{--param max-inline-insns-single} and @option{--param
10246 max-inline-insns-auto}.
10247 The default value is 15.
10249 @item large-function-insns
10250 The limit specifying really large functions.  For functions larger than this
10251 limit after inlining, inlining is constrained by
10252 @option{--param large-function-growth}.  This parameter is useful primarily
10253 to avoid extreme compilation time caused by non-linear algorithms used by the
10254 back end.
10255 The default value is 2700.
10257 @item large-function-growth
10258 Specifies maximal growth of large function caused by inlining in percents.
10259 The default value is 100 which limits large function growth to 2.0 times
10260 the original size.
10262 @item large-unit-insns
10263 The limit specifying large translation unit.  Growth caused by inlining of
10264 units larger than this limit is limited by @option{--param inline-unit-growth}.
10265 For small units this might be too tight.
10266 For example, consider a unit consisting of function A
10267 that is inline and B that just calls A three times.  If B is small relative to
10268 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10269 large units consisting of small inlineable functions, however, the overall unit
10270 growth limit is needed to avoid exponential explosion of code size.  Thus for
10271 smaller units, the size is increased to @option{--param large-unit-insns}
10272 before applying @option{--param inline-unit-growth}.  The default is 10000.
10274 @item inline-unit-growth
10275 Specifies maximal overall growth of the compilation unit caused by inlining.
10276 The default value is 20 which limits unit growth to 1.2 times the original
10277 size. Cold functions (either marked cold via an attribute or by profile
10278 feedback) are not accounted into the unit size.
10280 @item ipcp-unit-growth
10281 Specifies maximal overall growth of the compilation unit caused by
10282 interprocedural constant propagation.  The default value is 10 which limits
10283 unit growth to 1.1 times the original size.
10285 @item large-stack-frame
10286 The limit specifying large stack frames.  While inlining the algorithm is trying
10287 to not grow past this limit too much.  The default value is 256 bytes.
10289 @item large-stack-frame-growth
10290 Specifies maximal growth of large stack frames caused by inlining in percents.
10291 The default value is 1000 which limits large stack frame growth to 11 times
10292 the original size.
10294 @item max-inline-insns-recursive
10295 @itemx max-inline-insns-recursive-auto
10296 Specifies the maximum number of instructions an out-of-line copy of a
10297 self-recursive inline
10298 function can grow into by performing recursive inlining.
10300 @option{--param max-inline-insns-recursive} applies to functions
10301 declared inline.
10302 For functions not declared inline, recursive inlining
10303 happens only when @option{-finline-functions} (included in @option{-O3}) is
10304 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10305 default value is 450.
10307 @item max-inline-recursive-depth
10308 @itemx max-inline-recursive-depth-auto
10309 Specifies the maximum recursion depth used for recursive inlining.
10311 @option{--param max-inline-recursive-depth} applies to functions
10312 declared inline.  For functions not declared inline, recursive inlining
10313 happens only when @option{-finline-functions} (included in @option{-O3}) is
10314 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10315 default value is 8.
10317 @item min-inline-recursive-probability
10318 Recursive inlining is profitable only for function having deep recursion
10319 in average and can hurt for function having little recursion depth by
10320 increasing the prologue size or complexity of function body to other
10321 optimizers.
10323 When profile feedback is available (see @option{-fprofile-generate}) the actual
10324 recursion depth can be guessed from the probability that function recurses
10325 via a given call expression.  This parameter limits inlining only to call
10326 expressions whose probability exceeds the given threshold (in percents).
10327 The default value is 10.
10329 @item early-inlining-insns
10330 Specify growth that the early inliner can make.  In effect it increases
10331 the amount of inlining for code having a large abstraction penalty.
10332 The default value is 14.
10334 @item max-early-inliner-iterations
10335 Limit of iterations of the early inliner.  This basically bounds
10336 the number of nested indirect calls the early inliner can resolve.
10337 Deeper chains are still handled by late inlining.
10339 @item comdat-sharing-probability
10340 Probability (in percent) that C++ inline function with comdat visibility
10341 are shared across multiple compilation units.  The default value is 20.
10343 @item profile-func-internal-id
10344 A parameter to control whether to use function internal id in profile
10345 database lookup. If the value is 0, the compiler uses an id that
10346 is based on function assembler name and filename, which makes old profile
10347 data more tolerant to source changes such as function reordering etc.
10348 The default value is 0.
10350 @item min-vect-loop-bound
10351 The minimum number of iterations under which loops are not vectorized
10352 when @option{-ftree-vectorize} is used.  The number of iterations after
10353 vectorization needs to be greater than the value specified by this option
10354 to allow vectorization.  The default value is 0.
10356 @item gcse-cost-distance-ratio
10357 Scaling factor in calculation of maximum distance an expression
10358 can be moved by GCSE optimizations.  This is currently supported only in the
10359 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10360 is with simple expressions, i.e., the expressions that have cost
10361 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10362 hoisting of simple expressions.  The default value is 10.
10364 @item gcse-unrestricted-cost
10365 Cost, roughly measured as the cost of a single typical machine
10366 instruction, at which GCSE optimizations do not constrain
10367 the distance an expression can travel.  This is currently
10368 supported only in the code hoisting pass.  The lesser the cost,
10369 the more aggressive code hoisting is.  Specifying 0 
10370 allows all expressions to travel unrestricted distances.
10371 The default value is 3.
10373 @item max-hoist-depth
10374 The depth of search in the dominator tree for expressions to hoist.
10375 This is used to avoid quadratic behavior in hoisting algorithm.
10376 The value of 0 does not limit on the search, but may slow down compilation
10377 of huge functions.  The default value is 30.
10379 @item max-tail-merge-comparisons
10380 The maximum amount of similar bbs to compare a bb with.  This is used to
10381 avoid quadratic behavior in tree tail merging.  The default value is 10.
10383 @item max-tail-merge-iterations
10384 The maximum amount of iterations of the pass over the function.  This is used to
10385 limit compilation time in tree tail merging.  The default value is 2.
10387 @item store-merging-allow-unaligned
10388 Allow the store merging pass to introduce unaligned stores if it is legal to
10389 do so.  The default value is 1.
10391 @item max-stores-to-merge
10392 The maximum number of stores to attempt to merge into wider stores in the store
10393 merging pass.  The minimum value is 2 and the default is 64.
10395 @item max-unrolled-insns
10396 The maximum number of instructions that a loop may have to be unrolled.
10397 If a loop is unrolled, this parameter also determines how many times
10398 the loop code is unrolled.
10400 @item max-average-unrolled-insns
10401 The maximum number of instructions biased by probabilities of their execution
10402 that a loop may have to be unrolled.  If a loop is unrolled,
10403 this parameter also determines how many times the loop code is unrolled.
10405 @item max-unroll-times
10406 The maximum number of unrollings of a single loop.
10408 @item max-peeled-insns
10409 The maximum number of instructions that a loop may have to be peeled.
10410 If a loop is peeled, this parameter also determines how many times
10411 the loop code is peeled.
10413 @item max-peel-times
10414 The maximum number of peelings of a single loop.
10416 @item max-peel-branches
10417 The maximum number of branches on the hot path through the peeled sequence.
10419 @item max-completely-peeled-insns
10420 The maximum number of insns of a completely peeled loop.
10422 @item max-completely-peel-times
10423 The maximum number of iterations of a loop to be suitable for complete peeling.
10425 @item max-completely-peel-loop-nest-depth
10426 The maximum depth of a loop nest suitable for complete peeling.
10428 @item max-unswitch-insns
10429 The maximum number of insns of an unswitched loop.
10431 @item max-unswitch-level
10432 The maximum number of branches unswitched in a single loop.
10434 @item max-loop-headers-insns
10435 The maximum number of insns in loop header duplicated by the copy loop headers
10436 pass.
10438 @item lim-expensive
10439 The minimum cost of an expensive expression in the loop invariant motion.
10441 @item iv-consider-all-candidates-bound
10442 Bound on number of candidates for induction variables, below which
10443 all candidates are considered for each use in induction variable
10444 optimizations.  If there are more candidates than this,
10445 only the most relevant ones are considered to avoid quadratic time complexity.
10447 @item iv-max-considered-uses
10448 The induction variable optimizations give up on loops that contain more
10449 induction variable uses.
10451 @item iv-always-prune-cand-set-bound
10452 If the number of candidates in the set is smaller than this value,
10453 always try to remove unnecessary ivs from the set
10454 when adding a new one.
10456 @item avg-loop-niter
10457 Average number of iterations of a loop.
10459 @item dse-max-object-size
10460 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10461 Larger values may result in larger compilation times.
10463 @item scev-max-expr-size
10464 Bound on size of expressions used in the scalar evolutions analyzer.
10465 Large expressions slow the analyzer.
10467 @item scev-max-expr-complexity
10468 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10469 Complex expressions slow the analyzer.
10471 @item max-tree-if-conversion-phi-args
10472 Maximum number of arguments in a PHI supported by TREE if conversion
10473 unless the loop is marked with simd pragma.
10475 @item vect-max-version-for-alignment-checks
10476 The maximum number of run-time checks that can be performed when
10477 doing loop versioning for alignment in the vectorizer.
10479 @item vect-max-version-for-alias-checks
10480 The maximum number of run-time checks that can be performed when
10481 doing loop versioning for alias in the vectorizer.
10483 @item vect-max-peeling-for-alignment
10484 The maximum number of loop peels to enhance access alignment
10485 for vectorizer. Value -1 means no limit.
10487 @item max-iterations-to-track
10488 The maximum number of iterations of a loop the brute-force algorithm
10489 for analysis of the number of iterations of the loop tries to evaluate.
10491 @item hot-bb-count-ws-permille
10492 A basic block profile count is considered hot if it contributes to 
10493 the given permillage (i.e. 0...1000) of the entire profiled execution.
10495 @item hot-bb-frequency-fraction
10496 Select fraction of the entry block frequency of executions of basic block in
10497 function given basic block needs to have to be considered hot.
10499 @item max-predicted-iterations
10500 The maximum number of loop iterations we predict statically.  This is useful
10501 in cases where a function contains a single loop with known bound and
10502 another loop with unknown bound.
10503 The known number of iterations is predicted correctly, while
10504 the unknown number of iterations average to roughly 10.  This means that the
10505 loop without bounds appears artificially cold relative to the other one.
10507 @item builtin-expect-probability
10508 Control the probability of the expression having the specified value. This
10509 parameter takes a percentage (i.e. 0 ... 100) as input.
10510 The default probability of 90 is obtained empirically.
10512 @item align-threshold
10514 Select fraction of the maximal frequency of executions of a basic block in
10515 a function to align the basic block.
10517 @item align-loop-iterations
10519 A loop expected to iterate at least the selected number of iterations is
10520 aligned.
10522 @item tracer-dynamic-coverage
10523 @itemx tracer-dynamic-coverage-feedback
10525 This value is used to limit superblock formation once the given percentage of
10526 executed instructions is covered.  This limits unnecessary code size
10527 expansion.
10529 The @option{tracer-dynamic-coverage-feedback} parameter
10530 is used only when profile
10531 feedback is available.  The real profiles (as opposed to statically estimated
10532 ones) are much less balanced allowing the threshold to be larger value.
10534 @item tracer-max-code-growth
10535 Stop tail duplication once code growth has reached given percentage.  This is
10536 a rather artificial limit, as most of the duplicates are eliminated later in
10537 cross jumping, so it may be set to much higher values than is the desired code
10538 growth.
10540 @item tracer-min-branch-ratio
10542 Stop reverse growth when the reverse probability of best edge is less than this
10543 threshold (in percent).
10545 @item tracer-min-branch-probability
10546 @itemx tracer-min-branch-probability-feedback
10548 Stop forward growth if the best edge has probability lower than this
10549 threshold.
10551 Similarly to @option{tracer-dynamic-coverage} two parameters are
10552 provided.  @option{tracer-min-branch-probability-feedback} is used for
10553 compilation with profile feedback and @option{tracer-min-branch-probability}
10554 compilation without.  The value for compilation with profile feedback
10555 needs to be more conservative (higher) in order to make tracer
10556 effective.
10558 @item stack-clash-protection-guard-size
10559 Specify the size of the operating system provided stack guard as
10560 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10561 Acceptable values are between 12 and 30.  Higher values may reduce the
10562 number of explicit probes, but a value larger than the operating system
10563 provided guard will leave code vulnerable to stack clash style attacks.
10565 @item stack-clash-protection-probe-interval
10566 Stack clash protection involves probing stack space as it is allocated.  This
10567 param controls the maximum distance between probes into the stack as 2 raised
10568 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10569 12.  Higher values may reduce the number of explicit probes, but a value
10570 larger than the operating system provided guard will leave code vulnerable to
10571 stack clash style attacks.
10573 @item max-cse-path-length
10575 The maximum number of basic blocks on path that CSE considers.
10576 The default is 10.
10578 @item max-cse-insns
10579 The maximum number of instructions CSE processes before flushing.
10580 The default is 1000.
10582 @item ggc-min-expand
10584 GCC uses a garbage collector to manage its own memory allocation.  This
10585 parameter specifies the minimum percentage by which the garbage
10586 collector's heap should be allowed to expand between collections.
10587 Tuning this may improve compilation speed; it has no effect on code
10588 generation.
10590 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10591 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10592 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10593 GCC is not able to calculate RAM on a particular platform, the lower
10594 bound of 30% is used.  Setting this parameter and
10595 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10596 every opportunity.  This is extremely slow, but can be useful for
10597 debugging.
10599 @item ggc-min-heapsize
10601 Minimum size of the garbage collector's heap before it begins bothering
10602 to collect garbage.  The first collection occurs after the heap expands
10603 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10604 tuning this may improve compilation speed, and has no effect on code
10605 generation.
10607 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10608 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10609 with a lower bound of 4096 (four megabytes) and an upper bound of
10610 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10611 particular platform, the lower bound is used.  Setting this parameter
10612 very large effectively disables garbage collection.  Setting this
10613 parameter and @option{ggc-min-expand} to zero causes a full collection
10614 to occur at every opportunity.
10616 @item max-reload-search-insns
10617 The maximum number of instruction reload should look backward for equivalent
10618 register.  Increasing values mean more aggressive optimization, making the
10619 compilation time increase with probably slightly better performance.
10620 The default value is 100.
10622 @item max-cselib-memory-locations
10623 The maximum number of memory locations cselib should take into account.
10624 Increasing values mean more aggressive optimization, making the compilation time
10625 increase with probably slightly better performance.  The default value is 500.
10627 @item max-sched-ready-insns
10628 The maximum number of instructions ready to be issued the scheduler should
10629 consider at any given time during the first scheduling pass.  Increasing
10630 values mean more thorough searches, making the compilation time increase
10631 with probably little benefit.  The default value is 100.
10633 @item max-sched-region-blocks
10634 The maximum number of blocks in a region to be considered for
10635 interblock scheduling.  The default value is 10.
10637 @item max-pipeline-region-blocks
10638 The maximum number of blocks in a region to be considered for
10639 pipelining in the selective scheduler.  The default value is 15.
10641 @item max-sched-region-insns
10642 The maximum number of insns in a region to be considered for
10643 interblock scheduling.  The default value is 100.
10645 @item max-pipeline-region-insns
10646 The maximum number of insns in a region to be considered for
10647 pipelining in the selective scheduler.  The default value is 200.
10649 @item min-spec-prob
10650 The minimum probability (in percents) of reaching a source block
10651 for interblock speculative scheduling.  The default value is 40.
10653 @item max-sched-extend-regions-iters
10654 The maximum number of iterations through CFG to extend regions.
10655 A value of 0 (the default) disables region extensions.
10657 @item max-sched-insn-conflict-delay
10658 The maximum conflict delay for an insn to be considered for speculative motion.
10659 The default value is 3.
10661 @item sched-spec-prob-cutoff
10662 The minimal probability of speculation success (in percents), so that
10663 speculative insns are scheduled.
10664 The default value is 40.
10666 @item sched-state-edge-prob-cutoff
10667 The minimum probability an edge must have for the scheduler to save its
10668 state across it.
10669 The default value is 10.
10671 @item sched-mem-true-dep-cost
10672 Minimal distance (in CPU cycles) between store and load targeting same
10673 memory locations.  The default value is 1.
10675 @item selsched-max-lookahead
10676 The maximum size of the lookahead window of selective scheduling.  It is a
10677 depth of search for available instructions.
10678 The default value is 50.
10680 @item selsched-max-sched-times
10681 The maximum number of times that an instruction is scheduled during
10682 selective scheduling.  This is the limit on the number of iterations
10683 through which the instruction may be pipelined.  The default value is 2.
10685 @item selsched-insns-to-rename
10686 The maximum number of best instructions in the ready list that are considered
10687 for renaming in the selective scheduler.  The default value is 2.
10689 @item sms-min-sc
10690 The minimum value of stage count that swing modulo scheduler
10691 generates.  The default value is 2.
10693 @item max-last-value-rtl
10694 The maximum size measured as number of RTLs that can be recorded in an expression
10695 in combiner for a pseudo register as last known value of that register.  The default
10696 is 10000.
10698 @item max-combine-insns
10699 The maximum number of instructions the RTL combiner tries to combine.
10700 The default value is 2 at @option{-Og} and 4 otherwise.
10702 @item integer-share-limit
10703 Small integer constants can use a shared data structure, reducing the
10704 compiler's memory usage and increasing its speed.  This sets the maximum
10705 value of a shared integer constant.  The default value is 256.
10707 @item ssp-buffer-size
10708 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10709 protection when @option{-fstack-protection} is used.
10711 @item min-size-for-stack-sharing
10712 The minimum size of variables taking part in stack slot sharing when not
10713 optimizing. The default value is 32.
10715 @item max-jump-thread-duplication-stmts
10716 Maximum number of statements allowed in a block that needs to be
10717 duplicated when threading jumps.
10719 @item max-fields-for-field-sensitive
10720 Maximum number of fields in a structure treated in
10721 a field sensitive manner during pointer analysis.  The default is zero
10722 for @option{-O0} and @option{-O1},
10723 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10725 @item prefetch-latency
10726 Estimate on average number of instructions that are executed before
10727 prefetch finishes.  The distance prefetched ahead is proportional
10728 to this constant.  Increasing this number may also lead to less
10729 streams being prefetched (see @option{simultaneous-prefetches}).
10731 @item simultaneous-prefetches
10732 Maximum number of prefetches that can run at the same time.
10734 @item l1-cache-line-size
10735 The size of cache line in L1 cache, in bytes.
10737 @item l1-cache-size
10738 The size of L1 cache, in kilobytes.
10740 @item l2-cache-size
10741 The size of L2 cache, in kilobytes.
10743 @item loop-interchange-max-num-stmts
10744 The maximum number of stmts in a loop to be interchanged.
10746 @item loop-interchange-stride-ratio
10747 The minimum ratio between stride of two loops for interchange to be profitable.
10749 @item min-insn-to-prefetch-ratio
10750 The minimum ratio between the number of instructions and the
10751 number of prefetches to enable prefetching in a loop.
10753 @item prefetch-min-insn-to-mem-ratio
10754 The minimum ratio between the number of instructions and the
10755 number of memory references to enable prefetching in a loop.
10757 @item use-canonical-types
10758 Whether the compiler should use the ``canonical'' type system.  By
10759 default, this should always be 1, which uses a more efficient internal
10760 mechanism for comparing types in C++ and Objective-C++.  However, if
10761 bugs in the canonical type system are causing compilation failures,
10762 set this value to 0 to disable canonical types.
10764 @item switch-conversion-max-branch-ratio
10765 Switch initialization conversion refuses to create arrays that are
10766 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10767 branches in the switch.
10769 @item max-partial-antic-length
10770 Maximum length of the partial antic set computed during the tree
10771 partial redundancy elimination optimization (@option{-ftree-pre}) when
10772 optimizing at @option{-O3} and above.  For some sorts of source code
10773 the enhanced partial redundancy elimination optimization can run away,
10774 consuming all of the memory available on the host machine.  This
10775 parameter sets a limit on the length of the sets that are computed,
10776 which prevents the runaway behavior.  Setting a value of 0 for
10777 this parameter allows an unlimited set length.
10779 @item sccvn-max-scc-size
10780 Maximum size of a strongly connected component (SCC) during SCCVN
10781 processing.  If this limit is hit, SCCVN processing for the whole
10782 function is not done and optimizations depending on it are
10783 disabled.  The default maximum SCC size is 10000.
10785 @item sccvn-max-alias-queries-per-access
10786 Maximum number of alias-oracle queries we perform when looking for
10787 redundancies for loads and stores.  If this limit is hit the search
10788 is aborted and the load or store is not considered redundant.  The
10789 number of queries is algorithmically limited to the number of
10790 stores on all paths from the load to the function entry.
10791 The default maximum number of queries is 1000.
10793 @item ira-max-loops-num
10794 IRA uses regional register allocation by default.  If a function
10795 contains more loops than the number given by this parameter, only at most
10796 the given number of the most frequently-executed loops form regions
10797 for regional register allocation.  The default value of the
10798 parameter is 100.
10800 @item ira-max-conflict-table-size 
10801 Although IRA uses a sophisticated algorithm to compress the conflict
10802 table, the table can still require excessive amounts of memory for
10803 huge functions.  If the conflict table for a function could be more
10804 than the size in MB given by this parameter, the register allocator
10805 instead uses a faster, simpler, and lower-quality
10806 algorithm that does not require building a pseudo-register conflict table.  
10807 The default value of the parameter is 2000.
10809 @item ira-loop-reserved-regs
10810 IRA can be used to evaluate more accurate register pressure in loops
10811 for decisions to move loop invariants (see @option{-O3}).  The number
10812 of available registers reserved for some other purposes is given
10813 by this parameter.  The default value of the parameter is 2, which is
10814 the minimal number of registers needed by typical instructions.
10815 This value is the best found from numerous experiments.
10817 @item lra-inheritance-ebb-probability-cutoff
10818 LRA tries to reuse values reloaded in registers in subsequent insns.
10819 This optimization is called inheritance.  EBB is used as a region to
10820 do this optimization.  The parameter defines a minimal fall-through
10821 edge probability in percentage used to add BB to inheritance EBB in
10822 LRA.  The default value of the parameter is 40.  The value was chosen
10823 from numerous runs of SPEC2000 on x86-64.
10825 @item loop-invariant-max-bbs-in-loop
10826 Loop invariant motion can be very expensive, both in compilation time and
10827 in amount of needed compile-time memory, with very large loops.  Loops
10828 with more basic blocks than this parameter won't have loop invariant
10829 motion optimization performed on them.  The default value of the
10830 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10832 @item loop-max-datarefs-for-datadeps
10833 Building data dependencies is expensive for very large loops.  This
10834 parameter limits the number of data references in loops that are
10835 considered for data dependence analysis.  These large loops are no
10836 handled by the optimizations using loop data dependencies.
10837 The default value is 1000.
10839 @item max-vartrack-size
10840 Sets a maximum number of hash table slots to use during variable
10841 tracking dataflow analysis of any function.  If this limit is exceeded
10842 with variable tracking at assignments enabled, analysis for that
10843 function is retried without it, after removing all debug insns from
10844 the function.  If the limit is exceeded even without debug insns, var
10845 tracking analysis is completely disabled for the function.  Setting
10846 the parameter to zero makes it unlimited.
10848 @item max-vartrack-expr-depth
10849 Sets a maximum number of recursion levels when attempting to map
10850 variable names or debug temporaries to value expressions.  This trades
10851 compilation time for more complete debug information.  If this is set too
10852 low, value expressions that are available and could be represented in
10853 debug information may end up not being used; setting this higher may
10854 enable the compiler to find more complex debug expressions, but compile
10855 time and memory use may grow.  The default is 12.
10857 @item max-debug-marker-count
10858 Sets a threshold on the number of debug markers (e.g. begin stmt
10859 markers) to avoid complexity explosion at inlining or expanding to RTL.
10860 If a function has more such gimple stmts than the set limit, such stmts
10861 will be dropped from the inlined copy of a function, and from its RTL
10862 expansion.  The default is 100000.
10864 @item min-nondebug-insn-uid
10865 Use uids starting at this parameter for nondebug insns.  The range below
10866 the parameter is reserved exclusively for debug insns created by
10867 @option{-fvar-tracking-assignments}, but debug insns may get
10868 (non-overlapping) uids above it if the reserved range is exhausted.
10870 @item ipa-sra-ptr-growth-factor
10871 IPA-SRA replaces a pointer to an aggregate with one or more new
10872 parameters only when their cumulative size is less or equal to
10873 @option{ipa-sra-ptr-growth-factor} times the size of the original
10874 pointer parameter.
10876 @item sra-max-scalarization-size-Ospeed
10877 @itemx sra-max-scalarization-size-Osize
10878 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10879 replace scalar parts of aggregates with uses of independent scalar
10880 variables.  These parameters control the maximum size, in storage units,
10881 of aggregate which is considered for replacement when compiling for
10882 speed
10883 (@option{sra-max-scalarization-size-Ospeed}) or size
10884 (@option{sra-max-scalarization-size-Osize}) respectively.
10886 @item tm-max-aggregate-size
10887 When making copies of thread-local variables in a transaction, this
10888 parameter specifies the size in bytes after which variables are
10889 saved with the logging functions as opposed to save/restore code
10890 sequence pairs.  This option only applies when using
10891 @option{-fgnu-tm}.
10893 @item graphite-max-nb-scop-params
10894 To avoid exponential effects in the Graphite loop transforms, the
10895 number of parameters in a Static Control Part (SCoP) is bounded.  The
10896 default value is 10 parameters, a value of zero can be used to lift
10897 the bound.  A variable whose value is unknown at compilation time and
10898 defined outside a SCoP is a parameter of the SCoP.
10900 @item loop-block-tile-size
10901 Loop blocking or strip mining transforms, enabled with
10902 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10903 loop in the loop nest by a given number of iterations.  The strip
10904 length can be changed using the @option{loop-block-tile-size}
10905 parameter.  The default value is 51 iterations.
10907 @item loop-unroll-jam-size
10908 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10909 default value is 4.
10911 @item loop-unroll-jam-depth
10912 Specify the dimension to be unrolled (counting from the most inner loop)
10913 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10915 @item ipa-cp-value-list-size
10916 IPA-CP attempts to track all possible values and types passed to a function's
10917 parameter in order to propagate them and perform devirtualization.
10918 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10919 stores per one formal parameter of a function.
10921 @item ipa-cp-eval-threshold
10922 IPA-CP calculates its own score of cloning profitability heuristics
10923 and performs those cloning opportunities with scores that exceed
10924 @option{ipa-cp-eval-threshold}.
10926 @item ipa-cp-recursion-penalty
10927 Percentage penalty the recursive functions will receive when they
10928 are evaluated for cloning.
10930 @item ipa-cp-single-call-penalty
10931 Percentage penalty functions containing a single call to another
10932 function will receive when they are evaluated for cloning.
10935 @item ipa-max-agg-items
10936 IPA-CP is also capable to propagate a number of scalar values passed
10937 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10938 number of such values per one parameter.
10940 @item ipa-cp-loop-hint-bonus
10941 When IPA-CP determines that a cloning candidate would make the number
10942 of iterations of a loop known, it adds a bonus of
10943 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10944 the candidate.
10946 @item ipa-cp-array-index-hint-bonus
10947 When IPA-CP determines that a cloning candidate would make the index of
10948 an array access known, it adds a bonus of
10949 @option{ipa-cp-array-index-hint-bonus} to the profitability
10950 score of the candidate.
10952 @item ipa-max-aa-steps
10953 During its analysis of function bodies, IPA-CP employs alias analysis
10954 in order to track values pointed to by function parameters.  In order
10955 not spend too much time analyzing huge functions, it gives up and
10956 consider all memory clobbered after examining
10957 @option{ipa-max-aa-steps} statements modifying memory.
10959 @item lto-partitions
10960 Specify desired number of partitions produced during WHOPR compilation.
10961 The number of partitions should exceed the number of CPUs used for compilation.
10962 The default value is 32.
10964 @item lto-min-partition
10965 Size of minimal partition for WHOPR (in estimated instructions).
10966 This prevents expenses of splitting very small programs into too many
10967 partitions.
10969 @item lto-max-partition
10970 Size of max partition for WHOPR (in estimated instructions).
10971 to provide an upper bound for individual size of partition.
10972 Meant to be used only with balanced partitioning.
10974 @item cxx-max-namespaces-for-diagnostic-help
10975 The maximum number of namespaces to consult for suggestions when C++
10976 name lookup fails for an identifier.  The default is 1000.
10978 @item sink-frequency-threshold
10979 The maximum relative execution frequency (in percents) of the target block
10980 relative to a statement's original block to allow statement sinking of a
10981 statement.  Larger numbers result in more aggressive statement sinking.
10982 The default value is 75.  A small positive adjustment is applied for
10983 statements with memory operands as those are even more profitable so sink.
10985 @item max-stores-to-sink
10986 The maximum number of conditional store pairs that can be sunk.  Set to 0
10987 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10988 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10990 @item allow-store-data-races
10991 Allow optimizers to introduce new data races on stores.
10992 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10993 at optimization level @option{-Ofast}.
10995 @item case-values-threshold
10996 The smallest number of different values for which it is best to use a
10997 jump-table instead of a tree of conditional branches.  If the value is
10998 0, use the default for the machine.  The default is 0.
11000 @item tree-reassoc-width
11001 Set the maximum number of instructions executed in parallel in
11002 reassociated tree. This parameter overrides target dependent
11003 heuristics used by default if has non zero value.
11005 @item sched-pressure-algorithm
11006 Choose between the two available implementations of
11007 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11008 and is the more likely to prevent instructions from being reordered.
11009 Algorithm 2 was designed to be a compromise between the relatively
11010 conservative approach taken by algorithm 1 and the rather aggressive
11011 approach taken by the default scheduler.  It relies more heavily on
11012 having a regular register file and accurate register pressure classes.
11013 See @file{haifa-sched.c} in the GCC sources for more details.
11015 The default choice depends on the target.
11017 @item max-slsr-cand-scan
11018 Set the maximum number of existing candidates that are considered when
11019 seeking a basis for a new straight-line strength reduction candidate.
11021 @item asan-globals
11022 Enable buffer overflow detection for global objects.  This kind
11023 of protection is enabled by default if you are using
11024 @option{-fsanitize=address} option.
11025 To disable global objects protection use @option{--param asan-globals=0}.
11027 @item asan-stack
11028 Enable buffer overflow detection for stack objects.  This kind of
11029 protection is enabled by default when using @option{-fsanitize=address}.
11030 To disable stack protection use @option{--param asan-stack=0} option.
11032 @item asan-instrument-reads
11033 Enable buffer overflow detection for memory reads.  This kind of
11034 protection is enabled by default when using @option{-fsanitize=address}.
11035 To disable memory reads protection use
11036 @option{--param asan-instrument-reads=0}.
11038 @item asan-instrument-writes
11039 Enable buffer overflow detection for memory writes.  This kind of
11040 protection is enabled by default when using @option{-fsanitize=address}.
11041 To disable memory writes protection use
11042 @option{--param asan-instrument-writes=0} option.
11044 @item asan-memintrin
11045 Enable detection for built-in functions.  This kind of protection
11046 is enabled by default when using @option{-fsanitize=address}.
11047 To disable built-in functions protection use
11048 @option{--param asan-memintrin=0}.
11050 @item asan-use-after-return
11051 Enable detection of use-after-return.  This kind of protection
11052 is enabled by default when using the @option{-fsanitize=address} option.
11053 To disable it use @option{--param asan-use-after-return=0}.
11055 Note: By default the check is disabled at run time.  To enable it,
11056 add @code{detect_stack_use_after_return=1} to the environment variable
11057 @env{ASAN_OPTIONS}.
11059 @item asan-instrumentation-with-call-threshold
11060 If number of memory accesses in function being instrumented
11061 is greater or equal to this number, use callbacks instead of inline checks.
11062 E.g. to disable inline code use
11063 @option{--param asan-instrumentation-with-call-threshold=0}.
11065 @item use-after-scope-direct-emission-threshold
11066 If the size of a local variable in bytes is smaller or equal to this
11067 number, directly poison (or unpoison) shadow memory instead of using
11068 run-time callbacks.  The default value is 256.
11070 @item chkp-max-ctor-size
11071 Static constructors generated by Pointer Bounds Checker may become very
11072 large and significantly increase compile time at optimization level
11073 @option{-O1} and higher.  This parameter is a maximum number of statements
11074 in a single generated constructor.  Default value is 5000.
11076 @item max-fsm-thread-path-insns
11077 Maximum number of instructions to copy when duplicating blocks on a
11078 finite state automaton jump thread path.  The default is 100.
11080 @item max-fsm-thread-length
11081 Maximum number of basic blocks on a finite state automaton jump thread
11082 path.  The default is 10.
11084 @item max-fsm-thread-paths
11085 Maximum number of new jump thread paths to create for a finite state
11086 automaton.  The default is 50.
11088 @item parloops-chunk-size
11089 Chunk size of omp schedule for loops parallelized by parloops.  The default
11090 is 0.
11092 @item parloops-schedule
11093 Schedule type of omp schedule for loops parallelized by parloops (static,
11094 dynamic, guided, auto, runtime).  The default is static.
11096 @item parloops-min-per-thread
11097 The minimum number of iterations per thread of an innermost parallelized
11098 loop for which the parallelized variant is prefered over the single threaded
11099 one.  The default is 100.  Note that for a parallelized loop nest the
11100 minimum number of iterations of the outermost loop per thread is two.
11102 @item max-ssa-name-query-depth
11103 Maximum depth of recursion when querying properties of SSA names in things
11104 like fold routines.  One level of recursion corresponds to following a
11105 use-def chain.
11107 @item hsa-gen-debug-stores
11108 Enable emission of special debug stores within HSA kernels which are
11109 then read and reported by libgomp plugin.  Generation of these stores
11110 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11111 enable it.
11113 @item max-speculative-devirt-maydefs
11114 The maximum number of may-defs we analyze when looking for a must-def
11115 specifying the dynamic type of an object that invokes a virtual call
11116 we may be able to devirtualize speculatively.
11118 @item max-vrp-switch-assertions
11119 The maximum number of assertions to add along the default edge of a switch
11120 statement during VRP.  The default is 10.
11122 @item unroll-jam-min-percent
11123 The minimum percentage of memory references that must be optimized
11124 away for the unroll-and-jam transformation to be considered profitable.
11126 @item unroll-jam-max-unroll
11127 The maximum number of times the outer loop should be unrolled by
11128 the unroll-and-jam transformation.
11129 @end table
11130 @end table
11132 @node Instrumentation Options
11133 @section Program Instrumentation Options
11134 @cindex instrumentation options
11135 @cindex program instrumentation options
11136 @cindex run-time error checking options
11137 @cindex profiling options
11138 @cindex options, program instrumentation
11139 @cindex options, run-time error checking
11140 @cindex options, profiling
11142 GCC supports a number of command-line options that control adding
11143 run-time instrumentation to the code it normally generates.  
11144 For example, one purpose of instrumentation is collect profiling
11145 statistics for use in finding program hot spots, code coverage
11146 analysis, or profile-guided optimizations.
11147 Another class of program instrumentation is adding run-time checking 
11148 to detect programming errors like invalid pointer
11149 dereferences or out-of-bounds array accesses, as well as deliberately
11150 hostile attacks such as stack smashing or C++ vtable hijacking.
11151 There is also a general hook which can be used to implement other
11152 forms of tracing or function-level instrumentation for debug or
11153 program analysis purposes.
11155 @table @gcctabopt
11156 @cindex @command{prof}
11157 @item -p
11158 @opindex p
11159 Generate extra code to write profile information suitable for the
11160 analysis program @command{prof}.  You must use this option when compiling
11161 the source files you want data about, and you must also use it when
11162 linking.
11164 @cindex @command{gprof}
11165 @item -pg
11166 @opindex pg
11167 Generate extra code to write profile information suitable for the
11168 analysis program @command{gprof}.  You must use this option when compiling
11169 the source files you want data about, and you must also use it when
11170 linking.
11172 @item -fprofile-arcs
11173 @opindex fprofile-arcs
11174 Add code so that program flow @dfn{arcs} are instrumented.  During
11175 execution the program records how many times each branch and call is
11176 executed and how many times it is taken or returns.  On targets that support
11177 constructors with priority support, profiling properly handles constructors,
11178 destructors and C++ constructors (and destructors) of classes which are used
11179 as a type of a global variable.
11181 When the compiled
11182 program exits it saves this data to a file called
11183 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11184 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11185 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11186 @var{auxname} is generated from the name of the output file, if
11187 explicitly specified and it is not the final executable, otherwise it is
11188 the basename of the source file.  In both cases any suffix is removed
11189 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11190 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11191 @xref{Cross-profiling}.
11193 @cindex @command{gcov}
11194 @item --coverage
11195 @opindex coverage
11197 This option is used to compile and link code instrumented for coverage
11198 analysis.  The option is a synonym for @option{-fprofile-arcs}
11199 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11200 linking).  See the documentation for those options for more details.
11202 @itemize
11204 @item
11205 Compile the source files with @option{-fprofile-arcs} plus optimization
11206 and code generation options.  For test coverage analysis, use the
11207 additional @option{-ftest-coverage} option.  You do not need to profile
11208 every source file in a program.
11210 @item
11211 Compile the source files additionally with @option{-fprofile-abs-path}
11212 to create absolute path names in the @file{.gcno} files.  This allows
11213 @command{gcov} to find the correct sources in projects where compilations
11214 occur with different working directories.
11216 @item
11217 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11218 (the latter implies the former).
11220 @item
11221 Run the program on a representative workload to generate the arc profile
11222 information.  This may be repeated any number of times.  You can run
11223 concurrent instances of your program, and provided that the file system
11224 supports locking, the data files will be correctly updated.  Unless
11225 a strict ISO C dialect option is in effect, @code{fork} calls are
11226 detected and correctly handled without double counting.
11228 @item
11229 For profile-directed optimizations, compile the source files again with
11230 the same optimization and code generation options plus
11231 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11232 Control Optimization}).
11234 @item
11235 For test coverage analysis, use @command{gcov} to produce human readable
11236 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11237 @command{gcov} documentation for further information.
11239 @end itemize
11241 With @option{-fprofile-arcs}, for each function of your program GCC
11242 creates a program flow graph, then finds a spanning tree for the graph.
11243 Only arcs that are not on the spanning tree have to be instrumented: the
11244 compiler adds code to count the number of times that these arcs are
11245 executed.  When an arc is the only exit or only entrance to a block, the
11246 instrumentation code can be added to the block; otherwise, a new basic
11247 block must be created to hold the instrumentation code.
11249 @need 2000
11250 @item -ftest-coverage
11251 @opindex ftest-coverage
11252 Produce a notes file that the @command{gcov} code-coverage utility
11253 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11254 show program coverage.  Each source file's note file is called
11255 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11256 above for a description of @var{auxname} and instructions on how to
11257 generate test coverage data.  Coverage data matches the source files
11258 more closely if you do not optimize.
11260 @item -fprofile-abs-path
11261 @opindex fprofile-abs-path
11262 Automatically convert relative source file names to absolute path names
11263 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11264 sources in projects where compilations occur with different working
11265 directories.
11267 @item -fprofile-dir=@var{path}
11268 @opindex fprofile-dir
11270 Set the directory to search for the profile data files in to @var{path}.
11271 This option affects only the profile data generated by
11272 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11273 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11274 and its related options.  Both absolute and relative paths can be used.
11275 By default, GCC uses the current directory as @var{path}, thus the
11276 profile data file appears in the same directory as the object file.
11278 @item -fprofile-generate
11279 @itemx -fprofile-generate=@var{path}
11280 @opindex fprofile-generate
11282 Enable options usually used for instrumenting application to produce
11283 profile useful for later recompilation with profile feedback based
11284 optimization.  You must use @option{-fprofile-generate} both when
11285 compiling and when linking your program.
11287 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11289 If @var{path} is specified, GCC looks at the @var{path} to find
11290 the profile feedback data files. See @option{-fprofile-dir}.
11292 To optimize the program based on the collected profile information, use
11293 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11295 @item -fprofile-update=@var{method}
11296 @opindex fprofile-update
11298 Alter the update method for an application instrumented for profile
11299 feedback based optimization.  The @var{method} argument should be one of
11300 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11301 The first one is useful for single-threaded applications,
11302 while the second one prevents profile corruption by emitting thread-safe code.
11304 @strong{Warning:} When an application does not properly join all threads
11305 (or creates an detached thread), a profile file can be still corrupted.
11307 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11308 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11309 automatically selects @samp{prefer-atomic} when @option{-pthread}
11310 is present in the command line.
11312 @item -fsanitize=address
11313 @opindex fsanitize=address
11314 Enable AddressSanitizer, a fast memory error detector.
11315 Memory access instructions are instrumented to detect
11316 out-of-bounds and use-after-free bugs.
11317 The option enables @option{-fsanitize-address-use-after-scope}.
11318 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11319 more details.  The run-time behavior can be influenced using the
11320 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11321 the available options are shown at startup of the instrumented program.  See
11322 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11323 for a list of supported options.
11324 The option cannot be combined with @option{-fsanitize=thread}
11325 and/or @option{-fcheck-pointer-bounds}.
11327 @item -fsanitize=kernel-address
11328 @opindex fsanitize=kernel-address
11329 Enable AddressSanitizer for Linux kernel.
11330 See @uref{https://github.com/google/kasan/wiki} for more details.
11331 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11333 @item -fsanitize=pointer-compare
11334 @opindex fsanitize=pointer-compare
11335 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11336 The option must be combined with either @option{-fsanitize=kernel-address} or
11337 @option{-fsanitize=address}
11338 The option cannot be combined with @option{-fsanitize=thread}
11339 and/or @option{-fcheck-pointer-bounds}.
11340 Note: By default the check is disabled at run time.  To enable it,
11341 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11342 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11343 invalid operation only when both pointers are non-null.
11345 @item -fsanitize=pointer-subtract
11346 @opindex fsanitize=pointer-subtract
11347 Instrument subtraction with pointer operands.
11348 The option must be combined with either @option{-fsanitize=kernel-address} or
11349 @option{-fsanitize=address}
11350 The option cannot be combined with @option{-fsanitize=thread}
11351 and/or @option{-fcheck-pointer-bounds}.
11352 Note: By default the check is disabled at run time.  To enable it,
11353 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11354 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11355 invalid operation only when both pointers are non-null.
11357 @item -fsanitize=thread
11358 @opindex fsanitize=thread
11359 Enable ThreadSanitizer, a fast data race detector.
11360 Memory access instructions are instrumented to detect
11361 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11362 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11363 environment variable; see
11364 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11365 supported options.
11366 The option cannot be combined with @option{-fsanitize=address},
11367 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11369 Note that sanitized atomic builtins cannot throw exceptions when
11370 operating on invalid memory addresses with non-call exceptions
11371 (@option{-fnon-call-exceptions}).
11373 @item -fsanitize=leak
11374 @opindex fsanitize=leak
11375 Enable LeakSanitizer, a memory leak detector.
11376 This option only matters for linking of executables and
11377 the executable is linked against a library that overrides @code{malloc}
11378 and other allocator functions.  See
11379 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11380 details.  The run-time behavior can be influenced using the
11381 @env{LSAN_OPTIONS} environment variable.
11382 The option cannot be combined with @option{-fsanitize=thread}.
11384 @item -fsanitize=undefined
11385 @opindex fsanitize=undefined
11386 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11387 Various computations are instrumented to detect undefined behavior
11388 at runtime.  Current suboptions are:
11390 @table @gcctabopt
11392 @item -fsanitize=shift
11393 @opindex fsanitize=shift
11394 This option enables checking that the result of a shift operation is
11395 not undefined.  Note that what exactly is considered undefined differs
11396 slightly between C and C++, as well as between ISO C90 and C99, etc.
11397 This option has two suboptions, @option{-fsanitize=shift-base} and
11398 @option{-fsanitize=shift-exponent}.
11400 @item -fsanitize=shift-exponent
11401 @opindex fsanitize=shift-exponent
11402 This option enables checking that the second argument of a shift operation
11403 is not negative and is smaller than the precision of the promoted first
11404 argument.
11406 @item -fsanitize=shift-base
11407 @opindex fsanitize=shift-base
11408 If the second argument of a shift operation is within range, check that the
11409 result of a shift operation is not undefined.  Note that what exactly is
11410 considered undefined differs slightly between C and C++, as well as between
11411 ISO C90 and C99, etc.
11413 @item -fsanitize=integer-divide-by-zero
11414 @opindex fsanitize=integer-divide-by-zero
11415 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11417 @item -fsanitize=unreachable
11418 @opindex fsanitize=unreachable
11419 With this option, the compiler turns the @code{__builtin_unreachable}
11420 call into a diagnostics message call instead.  When reaching the
11421 @code{__builtin_unreachable} call, the behavior is undefined.
11423 @item -fsanitize=vla-bound
11424 @opindex fsanitize=vla-bound
11425 This option instructs the compiler to check that the size of a variable
11426 length array is positive.
11428 @item -fsanitize=null
11429 @opindex fsanitize=null
11430 This option enables pointer checking.  Particularly, the application
11431 built with this option turned on will issue an error message when it
11432 tries to dereference a NULL pointer, or if a reference (possibly an
11433 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11434 on an object pointed by a NULL pointer.
11436 @item -fsanitize=return
11437 @opindex fsanitize=return
11438 This option enables return statement checking.  Programs
11439 built with this option turned on will issue an error message
11440 when the end of a non-void function is reached without actually
11441 returning a value.  This option works in C++ only.
11443 @item -fsanitize=signed-integer-overflow
11444 @opindex fsanitize=signed-integer-overflow
11445 This option enables signed integer overflow checking.  We check that
11446 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11447 does not overflow in the signed arithmetics.  Note, integer promotion
11448 rules must be taken into account.  That is, the following is not an
11449 overflow:
11450 @smallexample
11451 signed char a = SCHAR_MAX;
11452 a++;
11453 @end smallexample
11455 @item -fsanitize=bounds
11456 @opindex fsanitize=bounds
11457 This option enables instrumentation of array bounds.  Various out of bounds
11458 accesses are detected.  Flexible array members, flexible array member-like
11459 arrays, and initializers of variables with static storage are not instrumented.
11460 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11462 @item -fsanitize=bounds-strict
11463 @opindex fsanitize=bounds-strict
11464 This option enables strict instrumentation of array bounds.  Most out of bounds
11465 accesses are detected, including flexible array members and flexible array
11466 member-like arrays.  Initializers of variables with static storage are not
11467 instrumented.  The option cannot be combined
11468 with @option{-fcheck-pointer-bounds}.
11470 @item -fsanitize=alignment
11471 @opindex fsanitize=alignment
11473 This option enables checking of alignment of pointers when they are
11474 dereferenced, or when a reference is bound to insufficiently aligned target,
11475 or when a method or constructor is invoked on insufficiently aligned object.
11477 @item -fsanitize=object-size
11478 @opindex fsanitize=object-size
11479 This option enables instrumentation of memory references using the
11480 @code{__builtin_object_size} function.  Various out of bounds pointer
11481 accesses are detected.
11483 @item -fsanitize=float-divide-by-zero
11484 @opindex fsanitize=float-divide-by-zero
11485 Detect floating-point division by zero.  Unlike other similar options,
11486 @option{-fsanitize=float-divide-by-zero} is not enabled by
11487 @option{-fsanitize=undefined}, since floating-point division by zero can
11488 be a legitimate way of obtaining infinities and NaNs.
11490 @item -fsanitize=float-cast-overflow
11491 @opindex fsanitize=float-cast-overflow
11492 This option enables floating-point type to integer conversion checking.
11493 We check that the result of the conversion does not overflow.
11494 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11495 not enabled by @option{-fsanitize=undefined}.
11496 This option does not work well with @code{FE_INVALID} exceptions enabled.
11498 @item -fsanitize=nonnull-attribute
11499 @opindex fsanitize=nonnull-attribute
11501 This option enables instrumentation of calls, checking whether null values
11502 are not passed to arguments marked as requiring a non-null value by the
11503 @code{nonnull} function attribute.
11505 @item -fsanitize=returns-nonnull-attribute
11506 @opindex fsanitize=returns-nonnull-attribute
11508 This option enables instrumentation of return statements in functions
11509 marked with @code{returns_nonnull} function attribute, to detect returning
11510 of null values from such functions.
11512 @item -fsanitize=bool
11513 @opindex fsanitize=bool
11515 This option enables instrumentation of loads from bool.  If a value other
11516 than 0/1 is loaded, a run-time error is issued.
11518 @item -fsanitize=enum
11519 @opindex fsanitize=enum
11521 This option enables instrumentation of loads from an enum type.  If
11522 a value outside the range of values for the enum type is loaded,
11523 a run-time error is issued.
11525 @item -fsanitize=vptr
11526 @opindex fsanitize=vptr
11528 This option enables instrumentation of C++ member function calls, member
11529 accesses and some conversions between pointers to base and derived classes,
11530 to verify the referenced object has the correct dynamic type.
11532 @item -fsanitize=pointer-overflow
11533 @opindex fsanitize=pointer-overflow
11535 This option enables instrumentation of pointer arithmetics.  If the pointer
11536 arithmetics overflows, a run-time error is issued.
11538 @item -fsanitize=builtin
11539 @opindex fsanitize=builtin
11541 This option enables instrumentation of arguments to selected builtin
11542 functions.  If an invalid value is passed to such arguments, a run-time
11543 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11544 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11545 by this option.
11547 @end table
11549 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11550 @option{-fsanitize=undefined} gives a diagnostic message.
11551 This currently works only for the C family of languages.
11553 @item -fno-sanitize=all
11554 @opindex fno-sanitize=all
11556 This option disables all previously enabled sanitizers.
11557 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11558 together.
11560 @item -fasan-shadow-offset=@var{number}
11561 @opindex fasan-shadow-offset
11562 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11563 It is useful for experimenting with different shadow memory layouts in
11564 Kernel AddressSanitizer.
11566 @item -fsanitize-sections=@var{s1},@var{s2},...
11567 @opindex fsanitize-sections
11568 Sanitize global variables in selected user-defined sections.  @var{si} may
11569 contain wildcards.
11571 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11572 @opindex fsanitize-recover
11573 @opindex fno-sanitize-recover
11574 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11575 mentioned in comma-separated list of @var{opts}.  Enabling this option
11576 for a sanitizer component causes it to attempt to continue
11577 running the program as if no error happened.  This means multiple
11578 runtime errors can be reported in a single program run, and the exit
11579 code of the program may indicate success even when errors
11580 have been reported.  The @option{-fno-sanitize-recover=} option
11581 can be used to alter
11582 this behavior: only the first detected error is reported
11583 and program then exits with a non-zero exit code.
11585 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11586 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11587 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11588 @option{-fsanitize=bounds-strict},
11589 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11590 For these sanitizers error recovery is turned on by default,
11591 except @option{-fsanitize=address}, for which this feature is experimental.
11592 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11593 accepted, the former enables recovery for all sanitizers that support it,
11594 the latter disables recovery for all sanitizers that support it.
11596 Even if a recovery mode is turned on the compiler side, it needs to be also
11597 enabled on the runtime library side, otherwise the failures are still fatal.
11598 The runtime library defaults to @code{halt_on_error=0} for
11599 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11600 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11601 setting the @code{halt_on_error} flag in the corresponding environment variable.
11603 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11604 equivalent to specifying an @var{opts} list of:
11606 @smallexample
11607 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11608 @end smallexample
11610 @item -fsanitize-address-use-after-scope
11611 @opindex fsanitize-address-use-after-scope
11612 Enable sanitization of local variables to detect use-after-scope bugs.
11613 The option sets @option{-fstack-reuse} to @samp{none}.
11615 @item -fsanitize-undefined-trap-on-error
11616 @opindex fsanitize-undefined-trap-on-error
11617 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11618 report undefined behavior using @code{__builtin_trap} rather than
11619 a @code{libubsan} library routine.  The advantage of this is that the
11620 @code{libubsan} library is not needed and is not linked in, so this
11621 is usable even in freestanding environments.
11623 @item -fsanitize-coverage=trace-pc
11624 @opindex fsanitize-coverage=trace-pc
11625 Enable coverage-guided fuzzing code instrumentation.
11626 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11628 @item -fsanitize-coverage=trace-cmp
11629 @opindex fsanitize-coverage=trace-cmp
11630 Enable dataflow guided fuzzing code instrumentation.
11631 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11632 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11633 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11634 variable or @code{__sanitizer_cov_trace_const_cmp1},
11635 @code{__sanitizer_cov_trace_const_cmp2},
11636 @code{__sanitizer_cov_trace_const_cmp4} or
11637 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11638 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11639 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11640 @code{__sanitizer_cov_trace_switch} for switch statements.
11642 @item -fbounds-check
11643 @opindex fbounds-check
11644 For front ends that support it, generate additional code to check that
11645 indices used to access arrays are within the declared range.  This is
11646 currently only supported by the Fortran front end, where this option
11647 defaults to false.
11649 @item -fcheck-pointer-bounds
11650 @opindex fcheck-pointer-bounds
11651 @opindex fno-check-pointer-bounds
11652 @cindex Pointer Bounds Checker options
11653 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11654 is instrumented with checks of the pointer used for memory access against
11655 bounds associated with that pointer.  
11657 Currently there
11658 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11659 and @option{-mmpx} are required to enable this feature.  
11660 MPX-based instrumentation requires
11661 a runtime library to enable MPX in hardware and handle bounds
11662 violation signals.  By default when @option{-fcheck-pointer-bounds}
11663 and @option{-mmpx} options are used to link a program, the GCC driver
11664 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11665 Bounds checking on calls to dynamic libraries requires a linker
11666 with @option{-z bndplt} support; if GCC was configured with a linker
11667 without support for this option (including the Gold linker and older
11668 versions of ld), a warning is given if you link with @option{-mmpx}
11669 without also specifying @option{-static}, since the overall effectiveness
11670 of the bounds checking protection is reduced.
11671 See also @option{-static-libmpxwrappers}.
11673 MPX-based instrumentation
11674 may be used for debugging and also may be included in production code
11675 to increase program security.  Depending on usage, you may
11676 have different requirements for the runtime library.  The current version
11677 of the MPX runtime library is more oriented for use as a debugging
11678 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11679 also @option{-static-libmpx}.  The runtime library  behavior can be
11680 influenced using various @env{CHKP_RT_*} environment variables.  See
11681 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11682 for more details.
11684 Generated instrumentation may be controlled by various
11685 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11686 structure field attribute (@pxref{Type Attributes}) and
11687 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11688 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11689 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11690 Bounds Checker builtins}, for more information.
11692 @item -fchkp-check-incomplete-type
11693 @opindex fchkp-check-incomplete-type
11694 @opindex fno-chkp-check-incomplete-type
11695 Generate pointer bounds checks for variables with incomplete type.
11696 Enabled by default.
11698 @item -fchkp-narrow-bounds
11699 @opindex fchkp-narrow-bounds
11700 @opindex fno-chkp-narrow-bounds
11701 Controls bounds used by Pointer Bounds Checker for pointers to object
11702 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11703 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11704 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11706 @item -fchkp-first-field-has-own-bounds
11707 @opindex fchkp-first-field-has-own-bounds
11708 @opindex fno-chkp-first-field-has-own-bounds
11709 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11710 first field in the structure.  By default a pointer to the first field has
11711 the same bounds as a pointer to the whole structure.
11713 @item -fchkp-flexible-struct-trailing-arrays
11714 @opindex fchkp-flexible-struct-trailing-arrays
11715 @opindex fno-chkp-flexible-struct-trailing-arrays
11716 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11717 possibly flexible.  By default only array fields with zero length or that are
11718 marked with attribute bnd_variable_size are treated as flexible.
11720 @item -fchkp-narrow-to-innermost-array
11721 @opindex fchkp-narrow-to-innermost-array
11722 @opindex fno-chkp-narrow-to-innermost-array
11723 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11724 case of nested static array access.  By default this option is disabled and
11725 bounds of the outermost array are used.
11727 @item -fchkp-optimize
11728 @opindex fchkp-optimize
11729 @opindex fno-chkp-optimize
11730 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11731 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11733 @item -fchkp-use-fast-string-functions
11734 @opindex fchkp-use-fast-string-functions
11735 @opindex fno-chkp-use-fast-string-functions
11736 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11737 by Pointer Bounds Checker.  Disabled by default.
11739 @item -fchkp-use-nochk-string-functions
11740 @opindex fchkp-use-nochk-string-functions
11741 @opindex fno-chkp-use-nochk-string-functions
11742 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11743 by Pointer Bounds Checker.  Disabled by default.
11745 @item -fchkp-use-static-bounds
11746 @opindex fchkp-use-static-bounds
11747 @opindex fno-chkp-use-static-bounds
11748 Allow Pointer Bounds Checker to generate static bounds holding
11749 bounds of static variables.  Enabled by default.
11751 @item -fchkp-use-static-const-bounds
11752 @opindex fchkp-use-static-const-bounds
11753 @opindex fno-chkp-use-static-const-bounds
11754 Use statically-initialized bounds for constant bounds instead of
11755 generating them each time they are required.  By default enabled when
11756 @option{-fchkp-use-static-bounds} is enabled.
11758 @item -fchkp-treat-zero-dynamic-size-as-infinite
11759 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11760 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11761 With this option, objects with incomplete type whose
11762 dynamically-obtained size is zero are treated as having infinite size
11763 instead by Pointer Bounds
11764 Checker.  This option may be helpful if a program is linked with a library
11765 missing size information for some symbols.  Disabled by default.
11767 @item -fchkp-check-read
11768 @opindex fchkp-check-read
11769 @opindex fno-chkp-check-read
11770 Instructs Pointer Bounds Checker to generate checks for all read
11771 accesses to memory.  Enabled by default.
11773 @item -fchkp-check-write
11774 @opindex fchkp-check-write
11775 @opindex fno-chkp-check-write
11776 Instructs Pointer Bounds Checker to generate checks for all write
11777 accesses to memory.  Enabled by default.
11779 @item -fchkp-store-bounds
11780 @opindex fchkp-store-bounds
11781 @opindex fno-chkp-store-bounds
11782 Instructs Pointer Bounds Checker to generate bounds stores for
11783 pointer writes.  Enabled by default.
11785 @item -fchkp-instrument-calls
11786 @opindex fchkp-instrument-calls
11787 @opindex fno-chkp-instrument-calls
11788 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11789 Enabled by default.
11791 @item -fchkp-instrument-marked-only
11792 @opindex fchkp-instrument-marked-only
11793 @opindex fno-chkp-instrument-marked-only
11794 Instructs Pointer Bounds Checker to instrument only functions
11795 marked with the @code{bnd_instrument} attribute
11796 (@pxref{Function Attributes}).  Disabled by default.
11798 @item -fchkp-use-wrappers
11799 @opindex fchkp-use-wrappers
11800 @opindex fno-chkp-use-wrappers
11801 Allows Pointer Bounds Checker to replace calls to built-in functions
11802 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11803 is used to link a program, the GCC driver automatically links
11804 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11805 Enabled by default.
11807 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11808 @opindex fcf-protection
11809 Enable code instrumentation of control-flow transfers to increase
11810 program security by checking that target addresses of control-flow
11811 transfer instructions (such as indirect function call, function return,
11812 indirect jump) are valid.  This prevents diverting the flow of control
11813 to an unexpected target.  This is intended to protect against such
11814 threats as Return-oriented Programming (ROP), and similarly
11815 call/jmp-oriented programming (COP/JOP).
11817 The value @code{branch} tells the compiler to implement checking of
11818 validity of control-flow transfer at the point of indirect branch
11819 instructions, i.e. call/jmp instructions.  The value @code{return}
11820 implements checking of validity at the point of returning from a
11821 function.  The value @code{full} is an alias for specifying both
11822 @code{branch} and @code{return}. The value @code{none} turns off
11823 instrumentation.
11825 You can also use the @code{nocf_check} attribute to identify
11826 which functions and calls should be skipped from instrumentation
11827 (@pxref{Function Attributes}).
11829 Currently the x86 GNU/Linux target provides an implementation based
11830 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11831 for x86 is controlled by target-specific options @option{-mcet},
11832 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11834 @item -fstack-protector
11835 @opindex fstack-protector
11836 Emit extra code to check for buffer overflows, such as stack smashing
11837 attacks.  This is done by adding a guard variable to functions with
11838 vulnerable objects.  This includes functions that call @code{alloca}, and
11839 functions with buffers larger than 8 bytes.  The guards are initialized
11840 when a function is entered and then checked when the function exits.
11841 If a guard check fails, an error message is printed and the program exits.
11843 @item -fstack-protector-all
11844 @opindex fstack-protector-all
11845 Like @option{-fstack-protector} except that all functions are protected.
11847 @item -fstack-protector-strong
11848 @opindex fstack-protector-strong
11849 Like @option{-fstack-protector} but includes additional functions to
11850 be protected --- those that have local array definitions, or have
11851 references to local frame addresses.
11853 @item -fstack-protector-explicit
11854 @opindex fstack-protector-explicit
11855 Like @option{-fstack-protector} but only protects those functions which
11856 have the @code{stack_protect} attribute.
11858 @item -fstack-check
11859 @opindex fstack-check
11860 Generate code to verify that you do not go beyond the boundary of the
11861 stack.  You should specify this flag if you are running in an
11862 environment with multiple threads, but you only rarely need to specify it in
11863 a single-threaded environment since stack overflow is automatically
11864 detected on nearly all systems if there is only one stack.
11866 Note that this switch does not actually cause checking to be done; the
11867 operating system or the language runtime must do that.  The switch causes
11868 generation of code to ensure that they see the stack being extended.
11870 You can additionally specify a string parameter: @samp{no} means no
11871 checking, @samp{generic} means force the use of old-style checking,
11872 @samp{specific} means use the best checking method and is equivalent
11873 to bare @option{-fstack-check}.
11875 Old-style checking is a generic mechanism that requires no specific
11876 target support in the compiler but comes with the following drawbacks:
11878 @enumerate
11879 @item
11880 Modified allocation strategy for large objects: they are always
11881 allocated dynamically if their size exceeds a fixed threshold.  Note this
11882 may change the semantics of some code.
11884 @item
11885 Fixed limit on the size of the static frame of functions: when it is
11886 topped by a particular function, stack checking is not reliable and
11887 a warning is issued by the compiler.
11889 @item
11890 Inefficiency: because of both the modified allocation strategy and the
11891 generic implementation, code performance is hampered.
11892 @end enumerate
11894 Note that old-style stack checking is also the fallback method for
11895 @samp{specific} if no target support has been added in the compiler.
11897 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11898 and stack overflows.  @samp{specific} is an excellent choice when compiling
11899 Ada code.  It is not generally sufficient to protect against stack-clash
11900 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11902 @item -fstack-clash-protection
11903 @opindex fstack-clash-protection
11904 Generate code to prevent stack clash style attacks.  When this option is
11905 enabled, the compiler will only allocate one page of stack space at a time
11906 and each page is accessed immediately after allocation.  Thus, it prevents
11907 allocations from jumping over any stack guard page provided by the
11908 operating system.
11910 Most targets do not fully support stack clash protection.  However, on
11911 those targets @option{-fstack-clash-protection} will protect dynamic stack
11912 allocations.  @option{-fstack-clash-protection} may also provide limited
11913 protection for static stack allocations if the target supports
11914 @option{-fstack-check=specific}.
11916 @item -fstack-limit-register=@var{reg}
11917 @itemx -fstack-limit-symbol=@var{sym}
11918 @itemx -fno-stack-limit
11919 @opindex fstack-limit-register
11920 @opindex fstack-limit-symbol
11921 @opindex fno-stack-limit
11922 Generate code to ensure that the stack does not grow beyond a certain value,
11923 either the value of a register or the address of a symbol.  If a larger
11924 stack is required, a signal is raised at run time.  For most targets,
11925 the signal is raised before the stack overruns the boundary, so
11926 it is possible to catch the signal without taking special precautions.
11928 For instance, if the stack starts at absolute address @samp{0x80000000}
11929 and grows downwards, you can use the flags
11930 @option{-fstack-limit-symbol=__stack_limit} and
11931 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11932 of 128KB@.  Note that this may only work with the GNU linker.
11934 You can locally override stack limit checking by using the
11935 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11937 @item -fsplit-stack
11938 @opindex fsplit-stack
11939 Generate code to automatically split the stack before it overflows.
11940 The resulting program has a discontiguous stack which can only
11941 overflow if the program is unable to allocate any more memory.  This
11942 is most useful when running threaded programs, as it is no longer
11943 necessary to calculate a good stack size to use for each thread.  This
11944 is currently only implemented for the x86 targets running
11945 GNU/Linux.
11947 When code compiled with @option{-fsplit-stack} calls code compiled
11948 without @option{-fsplit-stack}, there may not be much stack space
11949 available for the latter code to run.  If compiling all code,
11950 including library code, with @option{-fsplit-stack} is not an option,
11951 then the linker can fix up these calls so that the code compiled
11952 without @option{-fsplit-stack} always has a large stack.  Support for
11953 this is implemented in the gold linker in GNU binutils release 2.21
11954 and later.
11956 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11957 @opindex fvtable-verify
11958 This option is only available when compiling C++ code.
11959 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11960 feature that verifies at run time, for every virtual call, that
11961 the vtable pointer through which the call is made is valid for the type of
11962 the object, and has not been corrupted or overwritten.  If an invalid vtable
11963 pointer is detected at run time, an error is reported and execution of the
11964 program is immediately halted.
11966 This option causes run-time data structures to be built at program startup,
11967 which are used for verifying the vtable pointers.  
11968 The options @samp{std} and @samp{preinit}
11969 control the timing of when these data structures are built.  In both cases the
11970 data structures are built before execution reaches @code{main}.  Using
11971 @option{-fvtable-verify=std} causes the data structures to be built after
11972 shared libraries have been loaded and initialized.
11973 @option{-fvtable-verify=preinit} causes them to be built before shared
11974 libraries have been loaded and initialized.
11976 If this option appears multiple times in the command line with different
11977 values specified, @samp{none} takes highest priority over both @samp{std} and
11978 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11980 @item -fvtv-debug
11981 @opindex fvtv-debug
11982 When used in conjunction with @option{-fvtable-verify=std} or 
11983 @option{-fvtable-verify=preinit}, causes debug versions of the 
11984 runtime functions for the vtable verification feature to be called.  
11985 This flag also causes the compiler to log information about which 
11986 vtable pointers it finds for each class.
11987 This information is written to a file named @file{vtv_set_ptr_data.log} 
11988 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11989 if that is defined or the current working directory otherwise.
11991 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11992 file, be sure to delete any existing one.
11994 @item -fvtv-counts
11995 @opindex fvtv-counts
11996 This is a debugging flag.  When used in conjunction with
11997 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11998 causes the compiler to keep track of the total number of virtual calls
11999 it encounters and the number of verifications it inserts.  It also
12000 counts the number of calls to certain run-time library functions
12001 that it inserts and logs this information for each compilation unit.
12002 The compiler writes this information to a file named
12003 @file{vtv_count_data.log} in the directory named by the environment
12004 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12005 directory otherwise.  It also counts the size of the vtable pointer sets
12006 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12007 in the same directory.
12009 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12010 files, be sure to delete any existing ones.
12012 @item -finstrument-functions
12013 @opindex finstrument-functions
12014 Generate instrumentation calls for entry and exit to functions.  Just
12015 after function entry and just before function exit, the following
12016 profiling functions are called with the address of the current
12017 function and its call site.  (On some platforms,
12018 @code{__builtin_return_address} does not work beyond the current
12019 function, so the call site information may not be available to the
12020 profiling functions otherwise.)
12022 @smallexample
12023 void __cyg_profile_func_enter (void *this_fn,
12024                                void *call_site);
12025 void __cyg_profile_func_exit  (void *this_fn,
12026                                void *call_site);
12027 @end smallexample
12029 The first argument is the address of the start of the current function,
12030 which may be looked up exactly in the symbol table.
12032 This instrumentation is also done for functions expanded inline in other
12033 functions.  The profiling calls indicate where, conceptually, the
12034 inline function is entered and exited.  This means that addressable
12035 versions of such functions must be available.  If all your uses of a
12036 function are expanded inline, this may mean an additional expansion of
12037 code size.  If you use @code{extern inline} in your C code, an
12038 addressable version of such functions must be provided.  (This is
12039 normally the case anyway, but if you get lucky and the optimizer always
12040 expands the functions inline, you might have gotten away without
12041 providing static copies.)
12043 A function may be given the attribute @code{no_instrument_function}, in
12044 which case this instrumentation is not done.  This can be used, for
12045 example, for the profiling functions listed above, high-priority
12046 interrupt routines, and any functions from which the profiling functions
12047 cannot safely be called (perhaps signal handlers, if the profiling
12048 routines generate output or allocate memory).
12050 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12051 @opindex finstrument-functions-exclude-file-list
12053 Set the list of functions that are excluded from instrumentation (see
12054 the description of @option{-finstrument-functions}).  If the file that
12055 contains a function definition matches with one of @var{file}, then
12056 that function is not instrumented.  The match is done on substrings:
12057 if the @var{file} parameter is a substring of the file name, it is
12058 considered to be a match.
12060 For example:
12062 @smallexample
12063 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12064 @end smallexample
12066 @noindent
12067 excludes any inline function defined in files whose pathnames
12068 contain @file{/bits/stl} or @file{include/sys}.
12070 If, for some reason, you want to include letter @samp{,} in one of
12071 @var{sym}, write @samp{\,}. For example,
12072 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12073 (note the single quote surrounding the option).
12075 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12076 @opindex finstrument-functions-exclude-function-list
12078 This is similar to @option{-finstrument-functions-exclude-file-list},
12079 but this option sets the list of function names to be excluded from
12080 instrumentation.  The function name to be matched is its user-visible
12081 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12082 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12083 match is done on substrings: if the @var{sym} parameter is a substring
12084 of the function name, it is considered to be a match.  For C99 and C++
12085 extended identifiers, the function name must be given in UTF-8, not
12086 using universal character names.
12088 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12089 @opindex fpatchable-function-entry
12090 Generate @var{N} NOPs right at the beginning
12091 of each function, with the function entry point before the @var{M}th NOP.
12092 If @var{M} is omitted, it defaults to @code{0} so the
12093 function entry points to the address just at the first NOP.
12094 The NOP instructions reserve extra space which can be used to patch in
12095 any desired instrumentation at run time, provided that the code segment
12096 is writable.  The amount of space is controllable indirectly via
12097 the number of NOPs; the NOP instruction used corresponds to the instruction
12098 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12099 is target-specific and may also depend on the architecture variant and/or
12100 other compilation options.
12102 For run-time identification, the starting addresses of these areas,
12103 which correspond to their respective function entries minus @var{M},
12104 are additionally collected in the @code{__patchable_function_entries}
12105 section of the resulting binary.
12107 Note that the value of @code{__attribute__ ((patchable_function_entry
12108 (N,M)))} takes precedence over command-line option
12109 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12110 the area size or to remove it completely on a single function.
12111 If @code{N=0}, no pad location is recorded.
12113 The NOP instructions are inserted at---and maybe before, depending on
12114 @var{M}---the function entry address, even before the prologue.
12116 @end table
12119 @node Preprocessor Options
12120 @section Options Controlling the Preprocessor
12121 @cindex preprocessor options
12122 @cindex options, preprocessor
12124 These options control the C preprocessor, which is run on each C source
12125 file before actual compilation.
12127 If you use the @option{-E} option, nothing is done except preprocessing.
12128 Some of these options make sense only together with @option{-E} because
12129 they cause the preprocessor output to be unsuitable for actual
12130 compilation.
12132 In addition to the options listed here, there are a number of options 
12133 to control search paths for include files documented in 
12134 @ref{Directory Options}.  
12135 Options to control preprocessor diagnostics are listed in 
12136 @ref{Warning Options}.
12138 @table @gcctabopt
12139 @include cppopts.texi
12141 @item -Wp,@var{option}
12142 @opindex Wp
12143 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12144 and pass @var{option} directly through to the preprocessor.  If
12145 @var{option} contains commas, it is split into multiple options at the
12146 commas.  However, many options are modified, translated or interpreted
12147 by the compiler driver before being passed to the preprocessor, and
12148 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12149 interface is undocumented and subject to change, so whenever possible
12150 you should avoid using @option{-Wp} and let the driver handle the
12151 options instead.
12153 @item -Xpreprocessor @var{option}
12154 @opindex Xpreprocessor
12155 Pass @var{option} as an option to the preprocessor.  You can use this to
12156 supply system-specific preprocessor options that GCC does not 
12157 recognize.
12159 If you want to pass an option that takes an argument, you must use
12160 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12162 @item -no-integrated-cpp
12163 @opindex no-integrated-cpp
12164 Perform preprocessing as a separate pass before compilation.
12165 By default, GCC performs preprocessing as an integrated part of
12166 input tokenization and parsing.
12167 If this option is provided, the appropriate language front end
12168 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12169 and Objective-C, respectively) is instead invoked twice,
12170 once for preprocessing only and once for actual compilation
12171 of the preprocessed input.
12172 This option may be useful in conjunction with the @option{-B} or
12173 @option{-wrapper} options to specify an alternate preprocessor or
12174 perform additional processing of the program source between
12175 normal preprocessing and compilation.
12177 @end table
12179 @node Assembler Options
12180 @section Passing Options to the Assembler
12182 @c prevent bad page break with this line
12183 You can pass options to the assembler.
12185 @table @gcctabopt
12186 @item -Wa,@var{option}
12187 @opindex Wa
12188 Pass @var{option} as an option to the assembler.  If @var{option}
12189 contains commas, it is split into multiple options at the commas.
12191 @item -Xassembler @var{option}
12192 @opindex Xassembler
12193 Pass @var{option} as an option to the assembler.  You can use this to
12194 supply system-specific assembler options that GCC does not
12195 recognize.
12197 If you want to pass an option that takes an argument, you must use
12198 @option{-Xassembler} twice, once for the option and once for the argument.
12200 @end table
12202 @node Link Options
12203 @section Options for Linking
12204 @cindex link options
12205 @cindex options, linking
12207 These options come into play when the compiler links object files into
12208 an executable output file.  They are meaningless if the compiler is
12209 not doing a link step.
12211 @table @gcctabopt
12212 @cindex file names
12213 @item @var{object-file-name}
12214 A file name that does not end in a special recognized suffix is
12215 considered to name an object file or library.  (Object files are
12216 distinguished from libraries by the linker according to the file
12217 contents.)  If linking is done, these object files are used as input
12218 to the linker.
12220 @item -c
12221 @itemx -S
12222 @itemx -E
12223 @opindex c
12224 @opindex S
12225 @opindex E
12226 If any of these options is used, then the linker is not run, and
12227 object file names should not be used as arguments.  @xref{Overall
12228 Options}.
12230 @item -fuse-ld=bfd
12231 @opindex fuse-ld=bfd
12232 Use the @command{bfd} linker instead of the default linker.
12234 @item -fuse-ld=gold
12235 @opindex fuse-ld=gold
12236 Use the @command{gold} linker instead of the default linker.
12238 @cindex Libraries
12239 @item -l@var{library}
12240 @itemx -l @var{library}
12241 @opindex l
12242 Search the library named @var{library} when linking.  (The second
12243 alternative with the library as a separate argument is only for
12244 POSIX compliance and is not recommended.)
12246 It makes a difference where in the command you write this option; the
12247 linker searches and processes libraries and object files in the order they
12248 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12249 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12250 to functions in @samp{z}, those functions may not be loaded.
12252 The linker searches a standard list of directories for the library,
12253 which is actually a file named @file{lib@var{library}.a}.  The linker
12254 then uses this file as if it had been specified precisely by name.
12256 The directories searched include several standard system directories
12257 plus any that you specify with @option{-L}.
12259 Normally the files found this way are library files---archive files
12260 whose members are object files.  The linker handles an archive file by
12261 scanning through it for members which define symbols that have so far
12262 been referenced but not defined.  But if the file that is found is an
12263 ordinary object file, it is linked in the usual fashion.  The only
12264 difference between using an @option{-l} option and specifying a file name
12265 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12266 and searches several directories.
12268 @item -lobjc
12269 @opindex lobjc
12270 You need this special case of the @option{-l} option in order to
12271 link an Objective-C or Objective-C++ program.
12273 @item -nostartfiles
12274 @opindex nostartfiles
12275 Do not use the standard system startup files when linking.
12276 The standard system libraries are used normally, unless @option{-nostdlib}
12277 or @option{-nodefaultlibs} is used.
12279 @item -nodefaultlibs
12280 @opindex nodefaultlibs
12281 Do not use the standard system libraries when linking.
12282 Only the libraries you specify are passed to the linker, and options
12283 specifying linkage of the system libraries, such as @option{-static-libgcc}
12284 or @option{-shared-libgcc}, are ignored.  
12285 The standard startup files are used normally, unless @option{-nostartfiles}
12286 is used.  
12288 The compiler may generate calls to @code{memcmp},
12289 @code{memset}, @code{memcpy} and @code{memmove}.
12290 These entries are usually resolved by entries in
12291 libc.  These entry points should be supplied through some other
12292 mechanism when this option is specified.
12294 @item -nostdlib
12295 @opindex nostdlib
12296 Do not use the standard system startup files or libraries when linking.
12297 No startup files and only the libraries you specify are passed to
12298 the linker, and options specifying linkage of the system libraries, such as
12299 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12301 The compiler may generate calls to @code{memcmp}, @code{memset},
12302 @code{memcpy} and @code{memmove}.
12303 These entries are usually resolved by entries in
12304 libc.  These entry points should be supplied through some other
12305 mechanism when this option is specified.
12307 @cindex @option{-lgcc}, use with @option{-nostdlib}
12308 @cindex @option{-nostdlib} and unresolved references
12309 @cindex unresolved references and @option{-nostdlib}
12310 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12311 @cindex @option{-nodefaultlibs} and unresolved references
12312 @cindex unresolved references and @option{-nodefaultlibs}
12313 One of the standard libraries bypassed by @option{-nostdlib} and
12314 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12315 which GCC uses to overcome shortcomings of particular machines, or special
12316 needs for some languages.
12317 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12318 Collection (GCC) Internals},
12319 for more discussion of @file{libgcc.a}.)
12320 In most cases, you need @file{libgcc.a} even when you want to avoid
12321 other standard libraries.  In other words, when you specify @option{-nostdlib}
12322 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12323 This ensures that you have no unresolved references to internal GCC
12324 library subroutines.
12325 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12326 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12327 GNU Compiler Collection (GCC) Internals}.)
12329 @item -pie
12330 @opindex pie
12331 Produce a dynamically linked position independent executable on targets
12332 that support it.  For predictable results, you must also specify the same
12333 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12334 or model suboptions) when you specify this linker option.
12336 @item -no-pie
12337 @opindex no-pie
12338 Don't produce a dynamically linked position independent executable.
12340 @item -static-pie
12341 @opindex static-pie
12342 Produce a static position independent executable on targets that support
12343 it.  A static position independent executable is similar to a static
12344 executable, but can be loaded at any address without a dynamic linker.
12345 For predictable results, you must also specify the same set of options
12346 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12347 suboptions) when you specify this linker option.
12349 @item -pthread
12350 @opindex pthread
12351 Link with the POSIX threads library.  This option is supported on 
12352 GNU/Linux targets, most other Unix derivatives, and also on 
12353 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12354 flags for the preprocessor, so it should be used consistently for both
12355 compilation and linking.
12357 @item -rdynamic
12358 @opindex rdynamic
12359 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12360 that support it. This instructs the linker to add all symbols, not
12361 only used ones, to the dynamic symbol table. This option is needed
12362 for some uses of @code{dlopen} or to allow obtaining backtraces
12363 from within a program.
12365 @item -s
12366 @opindex s
12367 Remove all symbol table and relocation information from the executable.
12369 @item -static
12370 @opindex static
12371 On systems that support dynamic linking, this overrides @option{-pie}
12372 and prevents linking with the shared libraries.  On other systems, this
12373 option has no effect.
12375 @item -shared
12376 @opindex shared
12377 Produce a shared object which can then be linked with other objects to
12378 form an executable.  Not all systems support this option.  For predictable
12379 results, you must also specify the same set of options used for compilation
12380 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12381 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12382 needs to build supplementary stub code for constructors to work.  On
12383 multi-libbed systems, @samp{gcc -shared} must select the correct support
12384 libraries to link against.  Failing to supply the correct flags may lead
12385 to subtle defects.  Supplying them in cases where they are not necessary
12386 is innocuous.}
12388 @item -shared-libgcc
12389 @itemx -static-libgcc
12390 @opindex shared-libgcc
12391 @opindex static-libgcc
12392 On systems that provide @file{libgcc} as a shared library, these options
12393 force the use of either the shared or static version, respectively.
12394 If no shared version of @file{libgcc} was built when the compiler was
12395 configured, these options have no effect.
12397 There are several situations in which an application should use the
12398 shared @file{libgcc} instead of the static version.  The most common
12399 of these is when the application wishes to throw and catch exceptions
12400 across different shared libraries.  In that case, each of the libraries
12401 as well as the application itself should use the shared @file{libgcc}.
12403 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12404  whenever you build a shared library or a main executable, because C++
12405  programs typically use exceptions, so this is the right thing to do.
12407 If, instead, you use the GCC driver to create shared libraries, you may
12408 find that they are not always linked with the shared @file{libgcc}.
12409 If GCC finds, at its configuration time, that you have a non-GNU linker
12410 or a GNU linker that does not support option @option{--eh-frame-hdr},
12411 it links the shared version of @file{libgcc} into shared libraries
12412 by default.  Otherwise, it takes advantage of the linker and optimizes
12413 away the linking with the shared version of @file{libgcc}, linking with
12414 the static version of libgcc by default.  This allows exceptions to
12415 propagate through such shared libraries, without incurring relocation
12416 costs at library load time.
12418 However, if a library or main executable is supposed to throw or catch
12419 exceptions, you must link it using the G++ driver, as appropriate
12420 for the languages used in the program, or using the option
12421 @option{-shared-libgcc}, such that it is linked with the shared
12422 @file{libgcc}.
12424 @item -static-libasan
12425 @opindex static-libasan
12426 When the @option{-fsanitize=address} option is used to link a program,
12427 the GCC driver automatically links against @option{libasan}.  If
12428 @file{libasan} is available as a shared library, and the @option{-static}
12429 option is not used, then this links against the shared version of
12430 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12431 driver to link @file{libasan} statically, without necessarily linking
12432 other libraries statically.
12434 @item -static-libtsan
12435 @opindex static-libtsan
12436 When the @option{-fsanitize=thread} option is used to link a program,
12437 the GCC driver automatically links against @option{libtsan}.  If
12438 @file{libtsan} is available as a shared library, and the @option{-static}
12439 option is not used, then this links against the shared version of
12440 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12441 driver to link @file{libtsan} statically, without necessarily linking
12442 other libraries statically.
12444 @item -static-liblsan
12445 @opindex static-liblsan
12446 When the @option{-fsanitize=leak} option is used to link a program,
12447 the GCC driver automatically links against @option{liblsan}.  If
12448 @file{liblsan} is available as a shared library, and the @option{-static}
12449 option is not used, then this links against the shared version of
12450 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12451 driver to link @file{liblsan} statically, without necessarily linking
12452 other libraries statically.
12454 @item -static-libubsan
12455 @opindex static-libubsan
12456 When the @option{-fsanitize=undefined} option is used to link a program,
12457 the GCC driver automatically links against @option{libubsan}.  If
12458 @file{libubsan} is available as a shared library, and the @option{-static}
12459 option is not used, then this links against the shared version of
12460 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12461 driver to link @file{libubsan} statically, without necessarily linking
12462 other libraries statically.
12464 @item -static-libmpx
12465 @opindex static-libmpx
12466 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12467 used to link a program, the GCC driver automatically links against
12468 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12469 and the @option{-static} option is not used, then this links against
12470 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12471 option directs the GCC driver to link @file{libmpx} statically,
12472 without necessarily linking other libraries statically.
12474 @item -static-libmpxwrappers
12475 @opindex static-libmpxwrappers
12476 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12477 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12478 GCC driver automatically links against @file{libmpxwrappers}.  If
12479 @file{libmpxwrappers} is available as a shared library, and the
12480 @option{-static} option is not used, then this links against the shared
12481 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12482 option directs the GCC driver to link @file{libmpxwrappers} statically,
12483 without necessarily linking other libraries statically.
12485 @item -static-libstdc++
12486 @opindex static-libstdc++
12487 When the @command{g++} program is used to link a C++ program, it
12488 normally automatically links against @option{libstdc++}.  If
12489 @file{libstdc++} is available as a shared library, and the
12490 @option{-static} option is not used, then this links against the
12491 shared version of @file{libstdc++}.  That is normally fine.  However, it
12492 is sometimes useful to freeze the version of @file{libstdc++} used by
12493 the program without going all the way to a fully static link.  The
12494 @option{-static-libstdc++} option directs the @command{g++} driver to
12495 link @file{libstdc++} statically, without necessarily linking other
12496 libraries statically.
12498 @item -symbolic
12499 @opindex symbolic
12500 Bind references to global symbols when building a shared object.  Warn
12501 about any unresolved references (unless overridden by the link editor
12502 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12503 this option.
12505 @item -T @var{script}
12506 @opindex T
12507 @cindex linker script
12508 Use @var{script} as the linker script.  This option is supported by most
12509 systems using the GNU linker.  On some targets, such as bare-board
12510 targets without an operating system, the @option{-T} option may be required
12511 when linking to avoid references to undefined symbols.
12513 @item -Xlinker @var{option}
12514 @opindex Xlinker
12515 Pass @var{option} as an option to the linker.  You can use this to
12516 supply system-specific linker options that GCC does not recognize.
12518 If you want to pass an option that takes a separate argument, you must use
12519 @option{-Xlinker} twice, once for the option and once for the argument.
12520 For example, to pass @option{-assert definitions}, you must write
12521 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12522 @option{-Xlinker "-assert definitions"}, because this passes the entire
12523 string as a single argument, which is not what the linker expects.
12525 When using the GNU linker, it is usually more convenient to pass
12526 arguments to linker options using the @option{@var{option}=@var{value}}
12527 syntax than as separate arguments.  For example, you can specify
12528 @option{-Xlinker -Map=output.map} rather than
12529 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12530 this syntax for command-line options.
12532 @item -Wl,@var{option}
12533 @opindex Wl
12534 Pass @var{option} as an option to the linker.  If @var{option} contains
12535 commas, it is split into multiple options at the commas.  You can use this
12536 syntax to pass an argument to the option.
12537 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12538 linker.  When using the GNU linker, you can also get the same effect with
12539 @option{-Wl,-Map=output.map}.
12541 @item -u @var{symbol}
12542 @opindex u
12543 Pretend the symbol @var{symbol} is undefined, to force linking of
12544 library modules to define it.  You can use @option{-u} multiple times with
12545 different symbols to force loading of additional library modules.
12547 @item -z @var{keyword}
12548 @opindex z
12549 @option{-z} is passed directly on to the linker along with the keyword
12550 @var{keyword}. See the section in the documentation of your linker for
12551 permitted values and their meanings.
12552 @end table
12554 @node Directory Options
12555 @section Options for Directory Search
12556 @cindex directory options
12557 @cindex options, directory search
12558 @cindex search path
12560 These options specify directories to search for header files, for
12561 libraries and for parts of the compiler:
12563 @table @gcctabopt
12564 @include cppdiropts.texi
12566 @item -iplugindir=@var{dir}
12567 @opindex iplugindir=
12568 Set the directory to search for plugins that are passed
12569 by @option{-fplugin=@var{name}} instead of
12570 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12571 to be used by the user, but only passed by the driver.
12573 @item -L@var{dir}
12574 @opindex L
12575 Add directory @var{dir} to the list of directories to be searched
12576 for @option{-l}.
12578 @item -B@var{prefix}
12579 @opindex B
12580 This option specifies where to find the executables, libraries,
12581 include files, and data files of the compiler itself.
12583 The compiler driver program runs one or more of the subprograms
12584 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12585 @var{prefix} as a prefix for each program it tries to run, both with and
12586 without @samp{@var{machine}/@var{version}/} for the corresponding target
12587 machine and compiler version.
12589 For each subprogram to be run, the compiler driver first tries the
12590 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12591 is not specified, the driver tries two standard prefixes, 
12592 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12593 those results in a file name that is found, the unmodified program
12594 name is searched for using the directories specified in your
12595 @env{PATH} environment variable.
12597 The compiler checks to see if the path provided by @option{-B}
12598 refers to a directory, and if necessary it adds a directory
12599 separator character at the end of the path.
12601 @option{-B} prefixes that effectively specify directory names also apply
12602 to libraries in the linker, because the compiler translates these
12603 options into @option{-L} options for the linker.  They also apply to
12604 include files in the preprocessor, because the compiler translates these
12605 options into @option{-isystem} options for the preprocessor.  In this case,
12606 the compiler appends @samp{include} to the prefix.
12608 The runtime support file @file{libgcc.a} can also be searched for using
12609 the @option{-B} prefix, if needed.  If it is not found there, the two
12610 standard prefixes above are tried, and that is all.  The file is left
12611 out of the link if it is not found by those means.
12613 Another way to specify a prefix much like the @option{-B} prefix is to use
12614 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12615 Variables}.
12617 As a special kludge, if the path provided by @option{-B} is
12618 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12619 9, then it is replaced by @file{[dir/]include}.  This is to help
12620 with boot-strapping the compiler.
12622 @item -no-canonical-prefixes
12623 @opindex no-canonical-prefixes
12624 Do not expand any symbolic links, resolve references to @samp{/../}
12625 or @samp{/./}, or make the path absolute when generating a relative
12626 prefix.
12628 @item --sysroot=@var{dir}
12629 @opindex sysroot
12630 Use @var{dir} as the logical root directory for headers and libraries.
12631 For example, if the compiler normally searches for headers in
12632 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12633 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12635 If you use both this option and the @option{-isysroot} option, then
12636 the @option{--sysroot} option applies to libraries, but the
12637 @option{-isysroot} option applies to header files.
12639 The GNU linker (beginning with version 2.16) has the necessary support
12640 for this option.  If your linker does not support this option, the
12641 header file aspect of @option{--sysroot} still works, but the
12642 library aspect does not.
12644 @item --no-sysroot-suffix
12645 @opindex no-sysroot-suffix
12646 For some targets, a suffix is added to the root directory specified
12647 with @option{--sysroot}, depending on the other options used, so that
12648 headers may for example be found in
12649 @file{@var{dir}/@var{suffix}/usr/include} instead of
12650 @file{@var{dir}/usr/include}.  This option disables the addition of
12651 such a suffix.
12653 @end table
12655 @node Code Gen Options
12656 @section Options for Code Generation Conventions
12657 @cindex code generation conventions
12658 @cindex options, code generation
12659 @cindex run-time options
12661 These machine-independent options control the interface conventions
12662 used in code generation.
12664 Most of them have both positive and negative forms; the negative form
12665 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12666 one of the forms is listed---the one that is not the default.  You
12667 can figure out the other form by either removing @samp{no-} or adding
12670 @table @gcctabopt
12671 @item -fstack-reuse=@var{reuse-level}
12672 @opindex fstack_reuse
12673 This option controls stack space reuse for user declared local/auto variables
12674 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12675 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12676 local variables and temporaries, @samp{named_vars} enables the reuse only for
12677 user defined local variables with names, and @samp{none} disables stack reuse
12678 completely. The default value is @samp{all}. The option is needed when the
12679 program extends the lifetime of a scoped local variable or a compiler generated
12680 temporary beyond the end point defined by the language.  When a lifetime of
12681 a variable ends, and if the variable lives in memory, the optimizing compiler
12682 has the freedom to reuse its stack space with other temporaries or scoped
12683 local variables whose live range does not overlap with it. Legacy code extending
12684 local lifetime is likely to break with the stack reuse optimization.
12686 For example,
12688 @smallexample
12689    int *p;
12690    @{
12691      int local1;
12693      p = &local1;
12694      local1 = 10;
12695      ....
12696    @}
12697    @{
12698       int local2;
12699       local2 = 20;
12700       ...
12701    @}
12703    if (*p == 10)  // out of scope use of local1
12704      @{
12706      @}
12707 @end smallexample
12709 Another example:
12710 @smallexample
12712    struct A
12713    @{
12714        A(int k) : i(k), j(k) @{ @}
12715        int i;
12716        int j;
12717    @};
12719    A *ap;
12721    void foo(const A& ar)
12722    @{
12723       ap = &ar;
12724    @}
12726    void bar()
12727    @{
12728       foo(A(10)); // temp object's lifetime ends when foo returns
12730       @{
12731         A a(20);
12732         ....
12733       @}
12734       ap->i+= 10;  // ap references out of scope temp whose space
12735                    // is reused with a. What is the value of ap->i?
12736    @}
12738 @end smallexample
12740 The lifetime of a compiler generated temporary is well defined by the C++
12741 standard. When a lifetime of a temporary ends, and if the temporary lives
12742 in memory, the optimizing compiler has the freedom to reuse its stack
12743 space with other temporaries or scoped local variables whose live range
12744 does not overlap with it. However some of the legacy code relies on
12745 the behavior of older compilers in which temporaries' stack space is
12746 not reused, the aggressive stack reuse can lead to runtime errors. This
12747 option is used to control the temporary stack reuse optimization.
12749 @item -ftrapv
12750 @opindex ftrapv
12751 This option generates traps for signed overflow on addition, subtraction,
12752 multiplication operations.
12753 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12754 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12755 @option{-fwrapv} being effective.  Note that only active options override, so
12756 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12757 results in @option{-ftrapv} being effective.
12759 @item -fwrapv
12760 @opindex fwrapv
12761 This option instructs the compiler to assume that signed arithmetic
12762 overflow of addition, subtraction and multiplication wraps around
12763 using twos-complement representation.  This flag enables some optimizations
12764 and disables others.
12765 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12766 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12767 @option{-fwrapv} being effective.  Note that only active options override, so
12768 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12769 results in @option{-ftrapv} being effective.
12771 @item -fwrapv-pointer
12772 @opindex fwrapv-pointer
12773 This option instructs the compiler to assume that pointer arithmetic
12774 overflow on addition and subtraction wraps around using twos-complement
12775 representation.  This flag disables some optimizations which assume
12776 pointer overflow is invalid.
12778 @item -fstrict-overflow
12779 @opindex fstrict-overflow
12780 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12781 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12783 @item -fexceptions
12784 @opindex fexceptions
12785 Enable exception handling.  Generates extra code needed to propagate
12786 exceptions.  For some targets, this implies GCC generates frame
12787 unwind information for all functions, which can produce significant data
12788 size overhead, although it does not affect execution.  If you do not
12789 specify this option, GCC enables it by default for languages like
12790 C++ that normally require exception handling, and disables it for
12791 languages like C that do not normally require it.  However, you may need
12792 to enable this option when compiling C code that needs to interoperate
12793 properly with exception handlers written in C++.  You may also wish to
12794 disable this option if you are compiling older C++ programs that don't
12795 use exception handling.
12797 @item -fnon-call-exceptions
12798 @opindex fnon-call-exceptions
12799 Generate code that allows trapping instructions to throw exceptions.
12800 Note that this requires platform-specific runtime support that does
12801 not exist everywhere.  Moreover, it only allows @emph{trapping}
12802 instructions to throw exceptions, i.e.@: memory references or floating-point
12803 instructions.  It does not allow exceptions to be thrown from
12804 arbitrary signal handlers such as @code{SIGALRM}.
12806 @item -fdelete-dead-exceptions
12807 @opindex fdelete-dead-exceptions
12808 Consider that instructions that may throw exceptions but don't otherwise
12809 contribute to the execution of the program can be optimized away.
12810 This option is enabled by default for the Ada front end, as permitted by
12811 the Ada language specification.
12812 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12814 @item -funwind-tables
12815 @opindex funwind-tables
12816 Similar to @option{-fexceptions}, except that it just generates any needed
12817 static data, but does not affect the generated code in any other way.
12818 You normally do not need to enable this option; instead, a language processor
12819 that needs this handling enables it on your behalf.
12821 @item -fasynchronous-unwind-tables
12822 @opindex fasynchronous-unwind-tables
12823 Generate unwind table in DWARF format, if supported by target machine.  The
12824 table is exact at each instruction boundary, so it can be used for stack
12825 unwinding from asynchronous events (such as debugger or garbage collector).
12827 @item -fno-gnu-unique
12828 @opindex fno-gnu-unique
12829 On systems with recent GNU assembler and C library, the C++ compiler
12830 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12831 of template static data members and static local variables in inline
12832 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12833 is necessary to avoid problems with a library used by two different
12834 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12835 therefore disagreeing with the other one about the binding of the
12836 symbol.  But this causes @code{dlclose} to be ignored for affected
12837 DSOs; if your program relies on reinitialization of a DSO via
12838 @code{dlclose} and @code{dlopen}, you can use
12839 @option{-fno-gnu-unique}.
12841 @item -fpcc-struct-return
12842 @opindex fpcc-struct-return
12843 Return ``short'' @code{struct} and @code{union} values in memory like
12844 longer ones, rather than in registers.  This convention is less
12845 efficient, but it has the advantage of allowing intercallability between
12846 GCC-compiled files and files compiled with other compilers, particularly
12847 the Portable C Compiler (pcc).
12849 The precise convention for returning structures in memory depends
12850 on the target configuration macros.
12852 Short structures and unions are those whose size and alignment match
12853 that of some integer type.
12855 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12856 switch is not binary compatible with code compiled with the
12857 @option{-freg-struct-return} switch.
12858 Use it to conform to a non-default application binary interface.
12860 @item -freg-struct-return
12861 @opindex freg-struct-return
12862 Return @code{struct} and @code{union} values in registers when possible.
12863 This is more efficient for small structures than
12864 @option{-fpcc-struct-return}.
12866 If you specify neither @option{-fpcc-struct-return} nor
12867 @option{-freg-struct-return}, GCC defaults to whichever convention is
12868 standard for the target.  If there is no standard convention, GCC
12869 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12870 the principal compiler.  In those cases, we can choose the standard, and
12871 we chose the more efficient register return alternative.
12873 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12874 switch is not binary compatible with code compiled with the
12875 @option{-fpcc-struct-return} switch.
12876 Use it to conform to a non-default application binary interface.
12878 @item -fshort-enums
12879 @opindex fshort-enums
12880 Allocate to an @code{enum} type only as many bytes as it needs for the
12881 declared range of possible values.  Specifically, the @code{enum} type
12882 is equivalent to the smallest integer type that has enough room.
12884 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12885 code that is not binary compatible with code generated without that switch.
12886 Use it to conform to a non-default application binary interface.
12888 @item -fshort-wchar
12889 @opindex fshort-wchar
12890 Override the underlying type for @code{wchar_t} to be @code{short
12891 unsigned int} instead of the default for the target.  This option is
12892 useful for building programs to run under WINE@.
12894 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12895 code that is not binary compatible with code generated without that switch.
12896 Use it to conform to a non-default application binary interface.
12898 @item -fno-common
12899 @opindex fno-common
12900 @cindex tentative definitions
12901 In C code, this option controls the placement of global variables 
12902 defined without an initializer, known as @dfn{tentative definitions} 
12903 in the C standard.  Tentative definitions are distinct from declarations 
12904 of a variable with the @code{extern} keyword, which do not allocate storage.
12906 Unix C compilers have traditionally allocated storage for
12907 uninitialized global variables in a common block.  This allows the
12908 linker to resolve all tentative definitions of the same variable
12909 in different compilation units to the same object, or to a non-tentative
12910 definition.  
12911 This is the behavior specified by @option{-fcommon}, and is the default for 
12912 GCC on most targets.  
12913 On the other hand, this behavior is not required by ISO
12914 C, and on some targets may carry a speed or code size penalty on
12915 variable references.
12917 The @option{-fno-common} option specifies that the compiler should instead
12918 place uninitialized global variables in the data section of the object file.
12919 This inhibits the merging of tentative definitions by the linker so
12920 you get a multiple-definition error if the same 
12921 variable is defined in more than one compilation unit.
12922 Compiling with @option{-fno-common} is useful on targets for which
12923 it provides better performance, or if you wish to verify that the
12924 program will work on other systems that always treat uninitialized
12925 variable definitions this way.
12927 @item -fno-ident
12928 @opindex fno-ident
12929 Ignore the @code{#ident} directive.
12931 @item -finhibit-size-directive
12932 @opindex finhibit-size-directive
12933 Don't output a @code{.size} assembler directive, or anything else that
12934 would cause trouble if the function is split in the middle, and the
12935 two halves are placed at locations far apart in memory.  This option is
12936 used when compiling @file{crtstuff.c}; you should not need to use it
12937 for anything else.
12939 @item -fverbose-asm
12940 @opindex fverbose-asm
12941 Put extra commentary information in the generated assembly code to
12942 make it more readable.  This option is generally only of use to those
12943 who actually need to read the generated assembly code (perhaps while
12944 debugging the compiler itself).
12946 @option{-fno-verbose-asm}, the default, causes the
12947 extra information to be omitted and is useful when comparing two assembler
12948 files.
12950 The added comments include:
12952 @itemize @bullet
12954 @item
12955 information on the compiler version and command-line options,
12957 @item
12958 the source code lines associated with the assembly instructions,
12959 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12961 @item
12962 hints on which high-level expressions correspond to
12963 the various assembly instruction operands.
12965 @end itemize
12967 For example, given this C source file:
12969 @smallexample
12970 int test (int n)
12972   int i;
12973   int total = 0;
12975   for (i = 0; i < n; i++)
12976     total += i * i;
12978   return total;
12980 @end smallexample
12982 compiling to (x86_64) assembly via @option{-S} and emitting the result
12983 direct to stdout via @option{-o} @option{-}
12985 @smallexample
12986 gcc -S test.c -fverbose-asm -Os -o -
12987 @end smallexample
12989 gives output similar to this:
12991 @smallexample
12992         .file   "test.c"
12993 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12994   [...snip...]
12995 # options passed:
12996   [...snip...]
12998         .text
12999         .globl  test
13000         .type   test, @@function
13001 test:
13002 .LFB0:
13003         .cfi_startproc
13004 # test.c:4:   int total = 0;
13005         xorl    %eax, %eax      # <retval>
13006 # test.c:6:   for (i = 0; i < n; i++)
13007         xorl    %edx, %edx      # i
13008 .L2:
13009 # test.c:6:   for (i = 0; i < n; i++)
13010         cmpl    %edi, %edx      # n, i
13011         jge     .L5     #,
13012 # test.c:7:     total += i * i;
13013         movl    %edx, %ecx      # i, tmp92
13014         imull   %edx, %ecx      # i, tmp92
13015 # test.c:6:   for (i = 0; i < n; i++)
13016         incl    %edx    # i
13017 # test.c:7:     total += i * i;
13018         addl    %ecx, %eax      # tmp92, <retval>
13019         jmp     .L2     #
13020 .L5:
13021 # test.c:10: @}
13022         ret
13023         .cfi_endproc
13024 .LFE0:
13025         .size   test, .-test
13026         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13027         .section        .note.GNU-stack,"",@@progbits
13028 @end smallexample
13030 The comments are intended for humans rather than machines and hence the
13031 precise format of the comments is subject to change.
13033 @item -frecord-gcc-switches
13034 @opindex frecord-gcc-switches
13035 This switch causes the command line used to invoke the
13036 compiler to be recorded into the object file that is being created.
13037 This switch is only implemented on some targets and the exact format
13038 of the recording is target and binary file format dependent, but it
13039 usually takes the form of a section containing ASCII text.  This
13040 switch is related to the @option{-fverbose-asm} switch, but that
13041 switch only records information in the assembler output file as
13042 comments, so it never reaches the object file.
13043 See also @option{-grecord-gcc-switches} for another
13044 way of storing compiler options into the object file.
13046 @item -fpic
13047 @opindex fpic
13048 @cindex global offset table
13049 @cindex PIC
13050 Generate position-independent code (PIC) suitable for use in a shared
13051 library, if supported for the target machine.  Such code accesses all
13052 constant addresses through a global offset table (GOT)@.  The dynamic
13053 loader resolves the GOT entries when the program starts (the dynamic
13054 loader is not part of GCC; it is part of the operating system).  If
13055 the GOT size for the linked executable exceeds a machine-specific
13056 maximum size, you get an error message from the linker indicating that
13057 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13058 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13059 on the m68k and RS/6000.  The x86 has no such limit.)
13061 Position-independent code requires special support, and therefore works
13062 only on certain machines.  For the x86, GCC supports PIC for System V
13063 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13064 position-independent.
13066 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13067 are defined to 1.
13069 @item -fPIC
13070 @opindex fPIC
13071 If supported for the target machine, emit position-independent code,
13072 suitable for dynamic linking and avoiding any limit on the size of the
13073 global offset table.  This option makes a difference on AArch64, m68k,
13074 PowerPC and SPARC@.
13076 Position-independent code requires special support, and therefore works
13077 only on certain machines.
13079 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13080 are defined to 2.
13082 @item -fpie
13083 @itemx -fPIE
13084 @opindex fpie
13085 @opindex fPIE
13086 These options are similar to @option{-fpic} and @option{-fPIC}, but
13087 generated position independent code can be only linked into executables.
13088 Usually these options are used when @option{-pie} GCC option is
13089 used during linking.
13091 @option{-fpie} and @option{-fPIE} both define the macros
13092 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13093 for @option{-fpie} and 2 for @option{-fPIE}.
13095 @item -fno-plt
13096 @opindex fno-plt
13097 Do not use the PLT for external function calls in position-independent code.
13098 Instead, load the callee address at call sites from the GOT and branch to it.
13099 This leads to more efficient code by eliminating PLT stubs and exposing
13100 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13101 PLT stubs expect the GOT pointer in a specific register, this gives more
13102 register allocation freedom to the compiler.
13103 Lazy binding requires use of the PLT; 
13104 with @option{-fno-plt} all external symbols are resolved at load time.
13106 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13107 through the PLT for specific external functions.
13109 In position-dependent code, a few targets also convert calls to
13110 functions that are marked to not use the PLT to use the GOT instead.
13112 @item -fno-jump-tables
13113 @opindex fno-jump-tables
13114 Do not use jump tables for switch statements even where it would be
13115 more efficient than other code generation strategies.  This option is
13116 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13117 building code that forms part of a dynamic linker and cannot
13118 reference the address of a jump table.  On some targets, jump tables
13119 do not require a GOT and this option is not needed.
13121 @item -ffixed-@var{reg}
13122 @opindex ffixed
13123 Treat the register named @var{reg} as a fixed register; generated code
13124 should never refer to it (except perhaps as a stack pointer, frame
13125 pointer or in some other fixed role).
13127 @var{reg} must be the name of a register.  The register names accepted
13128 are machine-specific and are defined in the @code{REGISTER_NAMES}
13129 macro in the machine description macro file.
13131 This flag does not have a negative form, because it specifies a
13132 three-way choice.
13134 @item -fcall-used-@var{reg}
13135 @opindex fcall-used
13136 Treat the register named @var{reg} as an allocable register that is
13137 clobbered by function calls.  It may be allocated for temporaries or
13138 variables that do not live across a call.  Functions compiled this way
13139 do not save and restore the register @var{reg}.
13141 It is an error to use this flag with the frame pointer or stack pointer.
13142 Use of this flag for other registers that have fixed pervasive roles in
13143 the machine's execution model produces disastrous results.
13145 This flag does not have a negative form, because it specifies a
13146 three-way choice.
13148 @item -fcall-saved-@var{reg}
13149 @opindex fcall-saved
13150 Treat the register named @var{reg} as an allocable register saved by
13151 functions.  It may be allocated even for temporaries or variables that
13152 live across a call.  Functions compiled this way save and restore
13153 the register @var{reg} if they use it.
13155 It is an error to use this flag with the frame pointer or stack pointer.
13156 Use of this flag for other registers that have fixed pervasive roles in
13157 the machine's execution model produces disastrous results.
13159 A different sort of disaster results from the use of this flag for
13160 a register in which function values may be returned.
13162 This flag does not have a negative form, because it specifies a
13163 three-way choice.
13165 @item -fpack-struct[=@var{n}]
13166 @opindex fpack-struct
13167 Without a value specified, pack all structure members together without
13168 holes.  When a value is specified (which must be a small power of two), pack
13169 structure members according to this value, representing the maximum
13170 alignment (that is, objects with default alignment requirements larger than
13171 this are output potentially unaligned at the next fitting location.
13173 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13174 code that is not binary compatible with code generated without that switch.
13175 Additionally, it makes the code suboptimal.
13176 Use it to conform to a non-default application binary interface.
13178 @item -fleading-underscore
13179 @opindex fleading-underscore
13180 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13181 change the way C symbols are represented in the object file.  One use
13182 is to help link with legacy assembly code.
13184 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13185 generate code that is not binary compatible with code generated without that
13186 switch.  Use it to conform to a non-default application binary interface.
13187 Not all targets provide complete support for this switch.
13189 @item -ftls-model=@var{model}
13190 @opindex ftls-model
13191 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13192 The @var{model} argument should be one of @samp{global-dynamic},
13193 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13194 Note that the choice is subject to optimization: the compiler may use
13195 a more efficient model for symbols not visible outside of the translation
13196 unit, or if @option{-fpic} is not given on the command line.
13198 The default without @option{-fpic} is @samp{initial-exec}; with
13199 @option{-fpic} the default is @samp{global-dynamic}.
13201 @item -ftrampolines
13202 @opindex ftrampolines
13203 For targets that normally need trampolines for nested functions, always
13204 generate them instead of using descriptors.  Otherwise, for targets that
13205 do not need them, like for example HP-PA or IA-64, do nothing.
13207 A trampoline is a small piece of code that is created at run time on the
13208 stack when the address of a nested function is taken, and is used to call
13209 the nested function indirectly.  Therefore, it requires the stack to be
13210 made executable in order for the program to work properly.
13212 @option{-fno-trampolines} is enabled by default on a language by language
13213 basis to let the compiler avoid generating them, if it computes that this
13214 is safe, and replace them with descriptors.  Descriptors are made up of data
13215 only, but the generated code must be prepared to deal with them.  As of this
13216 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13218 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13219 @option{-fno-trampolines} are not binary compatible if nested functions are
13220 present.  This option must therefore be used on a program-wide basis and be
13221 manipulated with extreme care.
13223 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13224 @opindex fvisibility
13225 Set the default ELF image symbol visibility to the specified option---all
13226 symbols are marked with this unless overridden within the code.
13227 Using this feature can very substantially improve linking and
13228 load times of shared object libraries, produce more optimized
13229 code, provide near-perfect API export and prevent symbol clashes.
13230 It is @strong{strongly} recommended that you use this in any shared objects
13231 you distribute.
13233 Despite the nomenclature, @samp{default} always means public; i.e.,
13234 available to be linked against from outside the shared object.
13235 @samp{protected} and @samp{internal} are pretty useless in real-world
13236 usage so the only other commonly used option is @samp{hidden}.
13237 The default if @option{-fvisibility} isn't specified is
13238 @samp{default}, i.e., make every symbol public.
13240 A good explanation of the benefits offered by ensuring ELF
13241 symbols have the correct visibility is given by ``How To Write
13242 Shared Libraries'' by Ulrich Drepper (which can be found at
13243 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13244 solution made possible by this option to marking things hidden when
13245 the default is public is to make the default hidden and mark things
13246 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13247 and @code{__attribute__ ((visibility("default")))} instead of
13248 @code{__declspec(dllexport)} you get almost identical semantics with
13249 identical syntax.  This is a great boon to those working with
13250 cross-platform projects.
13252 For those adding visibility support to existing code, you may find
13253 @code{#pragma GCC visibility} of use.  This works by you enclosing
13254 the declarations you wish to set visibility for with (for example)
13255 @code{#pragma GCC visibility push(hidden)} and
13256 @code{#pragma GCC visibility pop}.
13257 Bear in mind that symbol visibility should be viewed @strong{as
13258 part of the API interface contract} and thus all new code should
13259 always specify visibility when it is not the default; i.e., declarations
13260 only for use within the local DSO should @strong{always} be marked explicitly
13261 as hidden as so to avoid PLT indirection overheads---making this
13262 abundantly clear also aids readability and self-documentation of the code.
13263 Note that due to ISO C++ specification requirements, @code{operator new} and
13264 @code{operator delete} must always be of default visibility.
13266 Be aware that headers from outside your project, in particular system
13267 headers and headers from any other library you use, may not be
13268 expecting to be compiled with visibility other than the default.  You
13269 may need to explicitly say @code{#pragma GCC visibility push(default)}
13270 before including any such headers.
13272 @code{extern} declarations are not affected by @option{-fvisibility}, so
13273 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13274 no modifications.  However, this means that calls to @code{extern}
13275 functions with no explicit visibility use the PLT, so it is more
13276 effective to use @code{__attribute ((visibility))} and/or
13277 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13278 declarations should be treated as hidden.
13280 Note that @option{-fvisibility} does affect C++ vague linkage
13281 entities. This means that, for instance, an exception class that is
13282 be thrown between DSOs must be explicitly marked with default
13283 visibility so that the @samp{type_info} nodes are unified between
13284 the DSOs.
13286 An overview of these techniques, their benefits and how to use them
13287 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13289 @item -fstrict-volatile-bitfields
13290 @opindex fstrict-volatile-bitfields
13291 This option should be used if accesses to volatile bit-fields (or other
13292 structure fields, although the compiler usually honors those types
13293 anyway) should use a single access of the width of the
13294 field's type, aligned to a natural alignment if possible.  For
13295 example, targets with memory-mapped peripheral registers might require
13296 all such accesses to be 16 bits wide; with this flag you can
13297 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13298 is 16 bits on these targets) to force GCC to use 16-bit accesses
13299 instead of, perhaps, a more efficient 32-bit access.
13301 If this option is disabled, the compiler uses the most efficient
13302 instruction.  In the previous example, that might be a 32-bit load
13303 instruction, even though that accesses bytes that do not contain
13304 any portion of the bit-field, or memory-mapped registers unrelated to
13305 the one being updated.
13307 In some cases, such as when the @code{packed} attribute is applied to a 
13308 structure field, it may not be possible to access the field with a single
13309 read or write that is correctly aligned for the target machine.  In this
13310 case GCC falls back to generating multiple accesses rather than code that 
13311 will fault or truncate the result at run time.
13313 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13314 not allowed to touch non bit-field members.  It is therefore recommended
13315 to define all bits of the field's type as bit-field members.
13317 The default value of this option is determined by the application binary
13318 interface for the target processor.
13320 @item -fsync-libcalls
13321 @opindex fsync-libcalls
13322 This option controls whether any out-of-line instance of the @code{__sync}
13323 family of functions may be used to implement the C++11 @code{__atomic}
13324 family of functions.
13326 The default value of this option is enabled, thus the only useful form
13327 of the option is @option{-fno-sync-libcalls}.  This option is used in
13328 the implementation of the @file{libatomic} runtime library.
13330 @end table
13332 @node Developer Options
13333 @section GCC Developer Options
13334 @cindex developer options
13335 @cindex debugging GCC
13336 @cindex debug dump options
13337 @cindex dump options
13338 @cindex compilation statistics
13340 This section describes command-line options that are primarily of
13341 interest to GCC developers, including options to support compiler
13342 testing and investigation of compiler bugs and compile-time
13343 performance problems.  This includes options that produce debug dumps
13344 at various points in the compilation; that print statistics such as
13345 memory use and execution time; and that print information about GCC's
13346 configuration, such as where it searches for libraries.  You should
13347 rarely need to use any of these options for ordinary compilation and
13348 linking tasks.
13350 @table @gcctabopt
13352 @item -d@var{letters}
13353 @itemx -fdump-rtl-@var{pass}
13354 @itemx -fdump-rtl-@var{pass}=@var{filename}
13355 @opindex d
13356 @opindex fdump-rtl-@var{pass}
13357 Says to make debugging dumps during compilation at times specified by
13358 @var{letters}.  This is used for debugging the RTL-based passes of the
13359 compiler.  The file names for most of the dumps are made by appending
13360 a pass number and a word to the @var{dumpname}, and the files are
13361 created in the directory of the output file.  In case of
13362 @option{=@var{filename}} option, the dump is output on the given file
13363 instead of the pass numbered dump files.  Note that the pass number is
13364 assigned as passes are registered into the pass manager.  Most passes
13365 are registered in the order that they will execute and for these passes
13366 the number corresponds to the pass execution order.  However, passes
13367 registered by plugins, passes specific to compilation targets, or
13368 passes that are otherwise registered after all the other passes are
13369 numbered higher than a pass named "final", even if they are executed
13370 earlier.  @var{dumpname} is generated from the name of the output
13371 file if explicitly specified and not an executable, otherwise it is
13372 the basename of the source file.  
13374 Some @option{-d@var{letters}} switches have different meaning when
13375 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13376 for information about preprocessor-specific dump options.
13378 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13379 @option{-d} option @var{letters}.  Here are the possible
13380 letters for use in @var{pass} and @var{letters}, and their meanings:
13382 @table @gcctabopt
13384 @item -fdump-rtl-alignments
13385 @opindex fdump-rtl-alignments
13386 Dump after branch alignments have been computed.
13388 @item -fdump-rtl-asmcons
13389 @opindex fdump-rtl-asmcons
13390 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13392 @item -fdump-rtl-auto_inc_dec
13393 @opindex fdump-rtl-auto_inc_dec
13394 Dump after auto-inc-dec discovery.  This pass is only run on
13395 architectures that have auto inc or auto dec instructions.
13397 @item -fdump-rtl-barriers
13398 @opindex fdump-rtl-barriers
13399 Dump after cleaning up the barrier instructions.
13401 @item -fdump-rtl-bbpart
13402 @opindex fdump-rtl-bbpart
13403 Dump after partitioning hot and cold basic blocks.
13405 @item -fdump-rtl-bbro
13406 @opindex fdump-rtl-bbro
13407 Dump after block reordering.
13409 @item -fdump-rtl-btl1
13410 @itemx -fdump-rtl-btl2
13411 @opindex fdump-rtl-btl2
13412 @opindex fdump-rtl-btl2
13413 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13414 after the two branch
13415 target load optimization passes.
13417 @item -fdump-rtl-bypass
13418 @opindex fdump-rtl-bypass
13419 Dump after jump bypassing and control flow optimizations.
13421 @item -fdump-rtl-combine
13422 @opindex fdump-rtl-combine
13423 Dump after the RTL instruction combination pass.
13425 @item -fdump-rtl-compgotos
13426 @opindex fdump-rtl-compgotos
13427 Dump after duplicating the computed gotos.
13429 @item -fdump-rtl-ce1
13430 @itemx -fdump-rtl-ce2
13431 @itemx -fdump-rtl-ce3
13432 @opindex fdump-rtl-ce1
13433 @opindex fdump-rtl-ce2
13434 @opindex fdump-rtl-ce3
13435 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13436 @option{-fdump-rtl-ce3} enable dumping after the three
13437 if conversion passes.
13439 @item -fdump-rtl-cprop_hardreg
13440 @opindex fdump-rtl-cprop_hardreg
13441 Dump after hard register copy propagation.
13443 @item -fdump-rtl-csa
13444 @opindex fdump-rtl-csa
13445 Dump after combining stack adjustments.
13447 @item -fdump-rtl-cse1
13448 @itemx -fdump-rtl-cse2
13449 @opindex fdump-rtl-cse1
13450 @opindex fdump-rtl-cse2
13451 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13452 the two common subexpression elimination passes.
13454 @item -fdump-rtl-dce
13455 @opindex fdump-rtl-dce
13456 Dump after the standalone dead code elimination passes.
13458 @item -fdump-rtl-dbr
13459 @opindex fdump-rtl-dbr
13460 Dump after delayed branch scheduling.
13462 @item -fdump-rtl-dce1
13463 @itemx -fdump-rtl-dce2
13464 @opindex fdump-rtl-dce1
13465 @opindex fdump-rtl-dce2
13466 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13467 the two dead store elimination passes.
13469 @item -fdump-rtl-eh
13470 @opindex fdump-rtl-eh
13471 Dump after finalization of EH handling code.
13473 @item -fdump-rtl-eh_ranges
13474 @opindex fdump-rtl-eh_ranges
13475 Dump after conversion of EH handling range regions.
13477 @item -fdump-rtl-expand
13478 @opindex fdump-rtl-expand
13479 Dump after RTL generation.
13481 @item -fdump-rtl-fwprop1
13482 @itemx -fdump-rtl-fwprop2
13483 @opindex fdump-rtl-fwprop1
13484 @opindex fdump-rtl-fwprop2
13485 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13486 dumping after the two forward propagation passes.
13488 @item -fdump-rtl-gcse1
13489 @itemx -fdump-rtl-gcse2
13490 @opindex fdump-rtl-gcse1
13491 @opindex fdump-rtl-gcse2
13492 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13493 after global common subexpression elimination.
13495 @item -fdump-rtl-init-regs
13496 @opindex fdump-rtl-init-regs
13497 Dump after the initialization of the registers.
13499 @item -fdump-rtl-initvals
13500 @opindex fdump-rtl-initvals
13501 Dump after the computation of the initial value sets.
13503 @item -fdump-rtl-into_cfglayout
13504 @opindex fdump-rtl-into_cfglayout
13505 Dump after converting to cfglayout mode.
13507 @item -fdump-rtl-ira
13508 @opindex fdump-rtl-ira
13509 Dump after iterated register allocation.
13511 @item -fdump-rtl-jump
13512 @opindex fdump-rtl-jump
13513 Dump after the second jump optimization.
13515 @item -fdump-rtl-loop2
13516 @opindex fdump-rtl-loop2
13517 @option{-fdump-rtl-loop2} enables dumping after the rtl
13518 loop optimization passes.
13520 @item -fdump-rtl-mach
13521 @opindex fdump-rtl-mach
13522 Dump after performing the machine dependent reorganization pass, if that
13523 pass exists.
13525 @item -fdump-rtl-mode_sw
13526 @opindex fdump-rtl-mode_sw
13527 Dump after removing redundant mode switches.
13529 @item -fdump-rtl-rnreg
13530 @opindex fdump-rtl-rnreg
13531 Dump after register renumbering.
13533 @item -fdump-rtl-outof_cfglayout
13534 @opindex fdump-rtl-outof_cfglayout
13535 Dump after converting from cfglayout mode.
13537 @item -fdump-rtl-peephole2
13538 @opindex fdump-rtl-peephole2
13539 Dump after the peephole pass.
13541 @item -fdump-rtl-postreload
13542 @opindex fdump-rtl-postreload
13543 Dump after post-reload optimizations.
13545 @item -fdump-rtl-pro_and_epilogue
13546 @opindex fdump-rtl-pro_and_epilogue
13547 Dump after generating the function prologues and epilogues.
13549 @item -fdump-rtl-sched1
13550 @itemx -fdump-rtl-sched2
13551 @opindex fdump-rtl-sched1
13552 @opindex fdump-rtl-sched2
13553 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13554 after the basic block scheduling passes.
13556 @item -fdump-rtl-ree
13557 @opindex fdump-rtl-ree
13558 Dump after sign/zero extension elimination.
13560 @item -fdump-rtl-seqabstr
13561 @opindex fdump-rtl-seqabstr
13562 Dump after common sequence discovery.
13564 @item -fdump-rtl-shorten
13565 @opindex fdump-rtl-shorten
13566 Dump after shortening branches.
13568 @item -fdump-rtl-sibling
13569 @opindex fdump-rtl-sibling
13570 Dump after sibling call optimizations.
13572 @item -fdump-rtl-split1
13573 @itemx -fdump-rtl-split2
13574 @itemx -fdump-rtl-split3
13575 @itemx -fdump-rtl-split4
13576 @itemx -fdump-rtl-split5
13577 @opindex fdump-rtl-split1
13578 @opindex fdump-rtl-split2
13579 @opindex fdump-rtl-split3
13580 @opindex fdump-rtl-split4
13581 @opindex fdump-rtl-split5
13582 These options enable dumping after five rounds of
13583 instruction splitting.
13585 @item -fdump-rtl-sms
13586 @opindex fdump-rtl-sms
13587 Dump after modulo scheduling.  This pass is only run on some
13588 architectures.
13590 @item -fdump-rtl-stack
13591 @opindex fdump-rtl-stack
13592 Dump after conversion from GCC's ``flat register file'' registers to the
13593 x87's stack-like registers.  This pass is only run on x86 variants.
13595 @item -fdump-rtl-subreg1
13596 @itemx -fdump-rtl-subreg2
13597 @opindex fdump-rtl-subreg1
13598 @opindex fdump-rtl-subreg2
13599 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13600 the two subreg expansion passes.
13602 @item -fdump-rtl-unshare
13603 @opindex fdump-rtl-unshare
13604 Dump after all rtl has been unshared.
13606 @item -fdump-rtl-vartrack
13607 @opindex fdump-rtl-vartrack
13608 Dump after variable tracking.
13610 @item -fdump-rtl-vregs
13611 @opindex fdump-rtl-vregs
13612 Dump after converting virtual registers to hard registers.
13614 @item -fdump-rtl-web
13615 @opindex fdump-rtl-web
13616 Dump after live range splitting.
13618 @item -fdump-rtl-regclass
13619 @itemx -fdump-rtl-subregs_of_mode_init
13620 @itemx -fdump-rtl-subregs_of_mode_finish
13621 @itemx -fdump-rtl-dfinit
13622 @itemx -fdump-rtl-dfinish
13623 @opindex fdump-rtl-regclass
13624 @opindex fdump-rtl-subregs_of_mode_init
13625 @opindex fdump-rtl-subregs_of_mode_finish
13626 @opindex fdump-rtl-dfinit
13627 @opindex fdump-rtl-dfinish
13628 These dumps are defined but always produce empty files.
13630 @item -da
13631 @itemx -fdump-rtl-all
13632 @opindex da
13633 @opindex fdump-rtl-all
13634 Produce all the dumps listed above.
13636 @item -dA
13637 @opindex dA
13638 Annotate the assembler output with miscellaneous debugging information.
13640 @item -dD
13641 @opindex dD
13642 Dump all macro definitions, at the end of preprocessing, in addition to
13643 normal output.
13645 @item -dH
13646 @opindex dH
13647 Produce a core dump whenever an error occurs.
13649 @item -dp
13650 @opindex dp
13651 Annotate the assembler output with a comment indicating which
13652 pattern and alternative is used.  The length and cost of each instruction are
13653 also printed.
13655 @item -dP
13656 @opindex dP
13657 Dump the RTL in the assembler output as a comment before each instruction.
13658 Also turns on @option{-dp} annotation.
13660 @item -dx
13661 @opindex dx
13662 Just generate RTL for a function instead of compiling it.  Usually used
13663 with @option{-fdump-rtl-expand}.
13664 @end table
13666 @item -fdump-noaddr
13667 @opindex fdump-noaddr
13668 When doing debugging dumps, suppress address output.  This makes it more
13669 feasible to use diff on debugging dumps for compiler invocations with
13670 different compiler binaries and/or different
13671 text / bss / data / heap / stack / dso start locations.
13673 @item -freport-bug
13674 @opindex freport-bug
13675 Collect and dump debug information into a temporary file if an
13676 internal compiler error (ICE) occurs.
13678 @item -fdump-unnumbered
13679 @opindex fdump-unnumbered
13680 When doing debugging dumps, suppress instruction numbers and address output.
13681 This makes it more feasible to use diff on debugging dumps for compiler
13682 invocations with different options, in particular with and without
13683 @option{-g}.
13685 @item -fdump-unnumbered-links
13686 @opindex fdump-unnumbered-links
13687 When doing debugging dumps (see @option{-d} option above), suppress
13688 instruction numbers for the links to the previous and next instructions
13689 in a sequence.
13691 @item -fdump-ipa-@var{switch}
13692 @opindex fdump-ipa
13693 Control the dumping at various stages of inter-procedural analysis
13694 language tree to a file.  The file name is generated by appending a
13695 switch specific suffix to the source file name, and the file is created
13696 in the same directory as the output file.  The following dumps are
13697 possible:
13699 @table @samp
13700 @item all
13701 Enables all inter-procedural analysis dumps.
13703 @item cgraph
13704 Dumps information about call-graph optimization, unused function removal,
13705 and inlining decisions.
13707 @item inline
13708 Dump after function inlining.
13710 @end table
13712 @item -fdump-lang-all
13713 @itemx -fdump-lang-@var{switch}
13714 @itemx -fdump-lang-@var{switch}-@var{options}
13715 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13716 @opindex fdump-lang-all
13717 @opindex fdump-lang
13718 Control the dumping of language-specific information.  The @var{options}
13719 and @var{filename} portions behave as described in the
13720 @option{-fdump-tree} option.  The following @var{switch} values are
13721 accepted:
13723 @table @samp
13724 @item all
13726 Enable all language-specific dumps.
13728 @item class
13729 Dump class hierarchy information.  Virtual table information is emitted
13730 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13732 @item raw
13733 Dump the raw internal tree data.  This option is applicable to C++ only.
13735 @end table
13737 @item -fdump-passes
13738 @opindex fdump-passes
13739 Print on @file{stderr} the list of optimization passes that are turned
13740 on and off by the current command-line options.
13742 @item -fdump-statistics-@var{option}
13743 @opindex fdump-statistics
13744 Enable and control dumping of pass statistics in a separate file.  The
13745 file name is generated by appending a suffix ending in
13746 @samp{.statistics} to the source file name, and the file is created in
13747 the same directory as the output file.  If the @samp{-@var{option}}
13748 form is used, @samp{-stats} causes counters to be summed over the
13749 whole compilation unit while @samp{-details} dumps every event as
13750 the passes generate them.  The default with no option is to sum
13751 counters for each function compiled.
13753 @item -fdump-tree-all
13754 @itemx -fdump-tree-@var{switch}
13755 @itemx -fdump-tree-@var{switch}-@var{options}
13756 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13757 @opindex fdump-tree-all
13758 @opindex fdump-tree
13759 Control the dumping at various stages of processing the intermediate
13760 language tree to a file.  The file name is generated by appending a
13761 switch-specific suffix to the source file name, and the file is
13762 created in the same directory as the output file. In case of
13763 @option{=@var{filename}} option, the dump is output on the given file
13764 instead of the auto named dump files.  If the @samp{-@var{options}}
13765 form is used, @var{options} is a list of @samp{-} separated options
13766 which control the details of the dump.  Not all options are applicable
13767 to all dumps; those that are not meaningful are ignored.  The
13768 following options are available
13770 @table @samp
13771 @item address
13772 Print the address of each node.  Usually this is not meaningful as it
13773 changes according to the environment and source file.  Its primary use
13774 is for tying up a dump file with a debug environment.
13775 @item asmname
13776 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13777 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13778 use working backward from mangled names in the assembly file.
13779 @item slim
13780 When dumping front-end intermediate representations, inhibit dumping
13781 of members of a scope or body of a function merely because that scope
13782 has been reached.  Only dump such items when they are directly reachable
13783 by some other path.
13785 When dumping pretty-printed trees, this option inhibits dumping the
13786 bodies of control structures.
13788 When dumping RTL, print the RTL in slim (condensed) form instead of
13789 the default LISP-like representation.
13790 @item raw
13791 Print a raw representation of the tree.  By default, trees are
13792 pretty-printed into a C-like representation.
13793 @item details
13794 Enable more detailed dumps (not honored by every dump option). Also
13795 include information from the optimization passes.
13796 @item stats
13797 Enable dumping various statistics about the pass (not honored by every dump
13798 option).
13799 @item blocks
13800 Enable showing basic block boundaries (disabled in raw dumps).
13801 @item graph
13802 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13803 dump a representation of the control flow graph suitable for viewing with
13804 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13805 the file is pretty-printed as a subgraph, so that GraphViz can render them
13806 all in a single plot.
13808 This option currently only works for RTL dumps, and the RTL is always
13809 dumped in slim form.
13810 @item vops
13811 Enable showing virtual operands for every statement.
13812 @item lineno
13813 Enable showing line numbers for statements.
13814 @item uid
13815 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13816 @item verbose
13817 Enable showing the tree dump for each statement.
13818 @item eh
13819 Enable showing the EH region number holding each statement.
13820 @item scev
13821 Enable showing scalar evolution analysis details.
13822 @item optimized
13823 Enable showing optimization information (only available in certain
13824 passes).
13825 @item missed
13826 Enable showing missed optimization information (only available in certain
13827 passes).
13828 @item note
13829 Enable other detailed optimization information (only available in
13830 certain passes).
13831 @item =@var{filename}
13832 Instead of an auto named dump file, output into the given file
13833 name. The file names @file{stdout} and @file{stderr} are treated
13834 specially and are considered already open standard streams. For
13835 example,
13837 @smallexample
13838 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13839      -fdump-tree-pre=/dev/stderr file.c
13840 @end smallexample
13842 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13843 output on to @file{stderr}. If two conflicting dump filenames are
13844 given for the same pass, then the latter option overrides the earlier
13845 one.
13847 @item all
13848 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13849 and @option{lineno}.
13851 @item optall
13852 Turn on all optimization options, i.e., @option{optimized},
13853 @option{missed}, and @option{note}.
13854 @end table
13856 To determine what tree dumps are available or find the dump for a pass
13857 of interest follow the steps below.
13859 @enumerate
13860 @item
13861 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13862 look for a code that corresponds to the pass you are interested in.
13863 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13864 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13865 The number at the end distinguishes distinct invocations of the same pass.
13866 @item
13867 To enable the creation of the dump file, append the pass code to
13868 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13869 to enable the dump from the Early Value Range Propagation pass, invoke
13870 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13871 specify the name of the dump file.  If you don't specify one, GCC
13872 creates as described below.
13873 @item
13874 Find the pass dump in a file whose name is composed of three components
13875 separated by a period: the name of the source file GCC was invoked to
13876 compile, a numeric suffix indicating the pass number followed by the
13877 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13878 and finally the pass code.  For example, the Early VRP pass dump might
13879 be in a file named @file{myfile.c.038t.evrp} in the current working
13880 directory.  Note that the numeric codes are not stable and may change
13881 from one version of GCC to another.
13882 @end enumerate
13884 @item -fopt-info
13885 @itemx -fopt-info-@var{options}
13886 @itemx -fopt-info-@var{options}=@var{filename}
13887 @opindex fopt-info
13888 Controls optimization dumps from various optimization passes. If the
13889 @samp{-@var{options}} form is used, @var{options} is a list of
13890 @samp{-} separated option keywords to select the dump details and
13891 optimizations.  
13893 The @var{options} can be divided into two groups: options describing the
13894 verbosity of the dump, and options describing which optimizations
13895 should be included. The options from both the groups can be freely
13896 mixed as they are non-overlapping. However, in case of any conflicts,
13897 the later options override the earlier options on the command
13898 line. 
13900 The following options control the dump verbosity:
13902 @table @samp
13903 @item optimized
13904 Print information when an optimization is successfully applied. It is
13905 up to a pass to decide which information is relevant. For example, the
13906 vectorizer passes print the source location of loops which are
13907 successfully vectorized.
13908 @item missed
13909 Print information about missed optimizations. Individual passes
13910 control which information to include in the output. 
13911 @item note
13912 Print verbose information about optimizations, such as certain
13913 transformations, more detailed messages about decisions etc.
13914 @item all
13915 Print detailed optimization information. This includes
13916 @samp{optimized}, @samp{missed}, and @samp{note}.
13917 @end table
13919 One or more of the following option keywords can be used to describe a
13920 group of optimizations:
13922 @table @samp
13923 @item ipa
13924 Enable dumps from all interprocedural optimizations.
13925 @item loop
13926 Enable dumps from all loop optimizations.
13927 @item inline
13928 Enable dumps from all inlining optimizations.
13929 @item omp
13930 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13931 @item vec
13932 Enable dumps from all vectorization optimizations.
13933 @item optall
13934 Enable dumps from all optimizations. This is a superset of
13935 the optimization groups listed above.
13936 @end table
13938 If @var{options} is
13939 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13940 info about successful optimizations from all the passes.  
13942 If the @var{filename} is provided, then the dumps from all the
13943 applicable optimizations are concatenated into the @var{filename}.
13944 Otherwise the dump is output onto @file{stderr}. Though multiple
13945 @option{-fopt-info} options are accepted, only one of them can include
13946 a @var{filename}. If other filenames are provided then all but the
13947 first such option are ignored.
13949 Note that the output @var{filename} is overwritten
13950 in case of multiple translation units. If a combined output from
13951 multiple translation units is desired, @file{stderr} should be used
13952 instead.
13954 In the following example, the optimization info is output to
13955 @file{stderr}:
13957 @smallexample
13958 gcc -O3 -fopt-info
13959 @end smallexample
13961 This example:
13962 @smallexample
13963 gcc -O3 -fopt-info-missed=missed.all
13964 @end smallexample
13966 @noindent
13967 outputs missed optimization report from all the passes into
13968 @file{missed.all}, and this one:
13970 @smallexample
13971 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13972 @end smallexample
13974 @noindent
13975 prints information about missed optimization opportunities from
13976 vectorization passes on @file{stderr}.  
13977 Note that @option{-fopt-info-vec-missed} is equivalent to 
13978 @option{-fopt-info-missed-vec}.  The order of the optimization group
13979 names and message types listed after @option{-fopt-info} does not matter.
13981 As another example,
13982 @smallexample
13983 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13984 @end smallexample
13986 @noindent
13987 outputs information about missed optimizations as well as
13988 optimized locations from all the inlining passes into
13989 @file{inline.txt}.
13991 Finally, consider:
13993 @smallexample
13994 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13995 @end smallexample
13997 @noindent
13998 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13999 in conflict since only one output file is allowed. In this case, only
14000 the first option takes effect and the subsequent options are
14001 ignored. Thus only @file{vec.miss} is produced which contains
14002 dumps from the vectorizer about missed opportunities.
14004 @item -fsched-verbose=@var{n}
14005 @opindex fsched-verbose
14006 On targets that use instruction scheduling, this option controls the
14007 amount of debugging output the scheduler prints to the dump files.
14009 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14010 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14011 For @var{n} greater than one, it also output basic block probabilities,
14012 detailed ready list information and unit/insn info.  For @var{n} greater
14013 than two, it includes RTL at abort point, control-flow and regions info.
14014 And for @var{n} over four, @option{-fsched-verbose} also includes
14015 dependence info.
14019 @item -fenable-@var{kind}-@var{pass}
14020 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14021 @opindex fdisable-
14022 @opindex fenable-
14024 This is a set of options that are used to explicitly disable/enable
14025 optimization passes.  These options are intended for use for debugging GCC.
14026 Compiler users should use regular options for enabling/disabling
14027 passes instead.
14029 @table @gcctabopt
14031 @item -fdisable-ipa-@var{pass}
14032 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14033 statically invoked in the compiler multiple times, the pass name should be
14034 appended with a sequential number starting from 1.
14036 @item -fdisable-rtl-@var{pass}
14037 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14038 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14039 statically invoked in the compiler multiple times, the pass name should be
14040 appended with a sequential number starting from 1.  @var{range-list} is a 
14041 comma-separated list of function ranges or assembler names.  Each range is a number
14042 pair separated by a colon.  The range is inclusive in both ends.  If the range
14043 is trivial, the number pair can be simplified as a single number.  If the
14044 function's call graph node's @var{uid} falls within one of the specified ranges,
14045 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14046 function header of a dump file, and the pass names can be dumped by using
14047 option @option{-fdump-passes}.
14049 @item -fdisable-tree-@var{pass}
14050 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14051 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14052 option arguments.
14054 @item -fenable-ipa-@var{pass}
14055 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14056 statically invoked in the compiler multiple times, the pass name should be
14057 appended with a sequential number starting from 1.
14059 @item -fenable-rtl-@var{pass}
14060 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14061 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14062 description and examples.
14064 @item -fenable-tree-@var{pass}
14065 @itemx -fenable-tree-@var{pass}=@var{range-list}
14066 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14067 of option arguments.
14069 @end table
14071 Here are some examples showing uses of these options.
14073 @smallexample
14075 # disable ccp1 for all functions
14076    -fdisable-tree-ccp1
14077 # disable complete unroll for function whose cgraph node uid is 1
14078    -fenable-tree-cunroll=1
14079 # disable gcse2 for functions at the following ranges [1,1],
14080 # [300,400], and [400,1000]
14081 # disable gcse2 for functions foo and foo2
14082    -fdisable-rtl-gcse2=foo,foo2
14083 # disable early inlining
14084    -fdisable-tree-einline
14085 # disable ipa inlining
14086    -fdisable-ipa-inline
14087 # enable tree full unroll
14088    -fenable-tree-unroll
14090 @end smallexample
14092 @item -fchecking
14093 @itemx -fchecking=@var{n}
14094 @opindex fchecking
14095 @opindex fno-checking
14096 Enable internal consistency checking.  The default depends on
14097 the compiler configuration.  @option{-fchecking=2} enables further
14098 internal consistency checking that might affect code generation.
14100 @item -frandom-seed=@var{string}
14101 @opindex frandom-seed
14102 This option provides a seed that GCC uses in place of
14103 random numbers in generating certain symbol names
14104 that have to be different in every compiled file.  It is also used to
14105 place unique stamps in coverage data files and the object files that
14106 produce them.  You can use the @option{-frandom-seed} option to produce
14107 reproducibly identical object files.
14109 The @var{string} can either be a number (decimal, octal or hex) or an
14110 arbitrary string (in which case it's converted to a number by
14111 computing CRC32).
14113 The @var{string} should be different for every file you compile.
14115 @item -save-temps
14116 @itemx -save-temps=cwd
14117 @opindex save-temps
14118 Store the usual ``temporary'' intermediate files permanently; place them
14119 in the current directory and name them based on the source file.  Thus,
14120 compiling @file{foo.c} with @option{-c -save-temps} produces files
14121 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14122 preprocessed @file{foo.i} output file even though the compiler now
14123 normally uses an integrated preprocessor.
14125 When used in combination with the @option{-x} command-line option,
14126 @option{-save-temps} is sensible enough to avoid over writing an
14127 input source file with the same extension as an intermediate file.
14128 The corresponding intermediate file may be obtained by renaming the
14129 source file before using @option{-save-temps}.
14131 If you invoke GCC in parallel, compiling several different source
14132 files that share a common base name in different subdirectories or the
14133 same source file compiled for multiple output destinations, it is
14134 likely that the different parallel compilers will interfere with each
14135 other, and overwrite the temporary files.  For instance:
14137 @smallexample
14138 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14139 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14140 @end smallexample
14142 may result in @file{foo.i} and @file{foo.o} being written to
14143 simultaneously by both compilers.
14145 @item -save-temps=obj
14146 @opindex save-temps=obj
14147 Store the usual ``temporary'' intermediate files permanently.  If the
14148 @option{-o} option is used, the temporary files are based on the
14149 object file.  If the @option{-o} option is not used, the
14150 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14152 For example:
14154 @smallexample
14155 gcc -save-temps=obj -c foo.c
14156 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14157 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14158 @end smallexample
14160 @noindent
14161 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14162 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14163 @file{dir2/yfoobar.o}.
14165 @item -time@r{[}=@var{file}@r{]}
14166 @opindex time
14167 Report the CPU time taken by each subprocess in the compilation
14168 sequence.  For C source files, this is the compiler proper and assembler
14169 (plus the linker if linking is done).
14171 Without the specification of an output file, the output looks like this:
14173 @smallexample
14174 # cc1 0.12 0.01
14175 # as 0.00 0.01
14176 @end smallexample
14178 The first number on each line is the ``user time'', that is time spent
14179 executing the program itself.  The second number is ``system time'',
14180 time spent executing operating system routines on behalf of the program.
14181 Both numbers are in seconds.
14183 With the specification of an output file, the output is appended to the
14184 named file, and it looks like this:
14186 @smallexample
14187 0.12 0.01 cc1 @var{options}
14188 0.00 0.01 as @var{options}
14189 @end smallexample
14191 The ``user time'' and the ``system time'' are moved before the program
14192 name, and the options passed to the program are displayed, so that one
14193 can later tell what file was being compiled, and with which options.
14195 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14196 @opindex fdump-final-insns
14197 Dump the final internal representation (RTL) to @var{file}.  If the
14198 optional argument is omitted (or if @var{file} is @code{.}), the name
14199 of the dump file is determined by appending @code{.gkd} to the
14200 compilation output file name.
14202 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14203 @opindex fcompare-debug
14204 @opindex fno-compare-debug
14205 If no error occurs during compilation, run the compiler a second time,
14206 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14207 passed to the second compilation.  Dump the final internal
14208 representation in both compilations, and print an error if they differ.
14210 If the equal sign is omitted, the default @option{-gtoggle} is used.
14212 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14213 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14214 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14215 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14216 is used.
14218 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14219 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14220 of the final representation and the second compilation, preventing even
14221 @env{GCC_COMPARE_DEBUG} from taking effect.
14223 To verify full coverage during @option{-fcompare-debug} testing, set
14224 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14225 which GCC rejects as an invalid option in any actual compilation
14226 (rather than preprocessing, assembly or linking).  To get just a
14227 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14228 not overridden} will do.
14230 @item -fcompare-debug-second
14231 @opindex fcompare-debug-second
14232 This option is implicitly passed to the compiler for the second
14233 compilation requested by @option{-fcompare-debug}, along with options to
14234 silence warnings, and omitting other options that would cause
14235 side-effect compiler outputs to files or to the standard output.  Dump
14236 files and preserved temporary files are renamed so as to contain the
14237 @code{.gk} additional extension during the second compilation, to avoid
14238 overwriting those generated by the first.
14240 When this option is passed to the compiler driver, it causes the
14241 @emph{first} compilation to be skipped, which makes it useful for little
14242 other than debugging the compiler proper.
14244 @item -gtoggle
14245 @opindex gtoggle
14246 Turn off generation of debug info, if leaving out this option
14247 generates it, or turn it on at level 2 otherwise.  The position of this
14248 argument in the command line does not matter; it takes effect after all
14249 other options are processed, and it does so only once, no matter how
14250 many times it is given.  This is mainly intended to be used with
14251 @option{-fcompare-debug}.
14253 @item -fvar-tracking-assignments-toggle
14254 @opindex fvar-tracking-assignments-toggle
14255 @opindex fno-var-tracking-assignments-toggle
14256 Toggle @option{-fvar-tracking-assignments}, in the same way that
14257 @option{-gtoggle} toggles @option{-g}.
14259 @item -Q
14260 @opindex Q
14261 Makes the compiler print out each function name as it is compiled, and
14262 print some statistics about each pass when it finishes.
14264 @item -ftime-report
14265 @opindex ftime-report
14266 Makes the compiler print some statistics about the time consumed by each
14267 pass when it finishes.
14269 @item -ftime-report-details
14270 @opindex ftime-report-details
14271 Record the time consumed by infrastructure parts separately for each pass.
14273 @item -fira-verbose=@var{n}
14274 @opindex fira-verbose
14275 Control the verbosity of the dump file for the integrated register allocator.
14276 The default value is 5.  If the value @var{n} is greater or equal to 10,
14277 the dump output is sent to stderr using the same format as @var{n} minus 10.
14279 @item -flto-report
14280 @opindex flto-report
14281 Prints a report with internal details on the workings of the link-time
14282 optimizer.  The contents of this report vary from version to version.
14283 It is meant to be useful to GCC developers when processing object
14284 files in LTO mode (via @option{-flto}).
14286 Disabled by default.
14288 @item -flto-report-wpa
14289 @opindex flto-report-wpa
14290 Like @option{-flto-report}, but only print for the WPA phase of Link
14291 Time Optimization.
14293 @item -fmem-report
14294 @opindex fmem-report
14295 Makes the compiler print some statistics about permanent memory
14296 allocation when it finishes.
14298 @item -fmem-report-wpa
14299 @opindex fmem-report-wpa
14300 Makes the compiler print some statistics about permanent memory
14301 allocation for the WPA phase only.
14303 @item -fpre-ipa-mem-report
14304 @opindex fpre-ipa-mem-report
14305 @item -fpost-ipa-mem-report
14306 @opindex fpost-ipa-mem-report
14307 Makes the compiler print some statistics about permanent memory
14308 allocation before or after interprocedural optimization.
14310 @item -fprofile-report
14311 @opindex fprofile-report
14312 Makes the compiler print some statistics about consistency of the
14313 (estimated) profile and effect of individual passes.
14315 @item -fstack-usage
14316 @opindex fstack-usage
14317 Makes the compiler output stack usage information for the program, on a
14318 per-function basis.  The filename for the dump is made by appending
14319 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14320 the output file, if explicitly specified and it is not an executable,
14321 otherwise it is the basename of the source file.  An entry is made up
14322 of three fields:
14324 @itemize
14325 @item
14326 The name of the function.
14327 @item
14328 A number of bytes.
14329 @item
14330 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14331 @end itemize
14333 The qualifier @code{static} means that the function manipulates the stack
14334 statically: a fixed number of bytes are allocated for the frame on function
14335 entry and released on function exit; no stack adjustments are otherwise made
14336 in the function.  The second field is this fixed number of bytes.
14338 The qualifier @code{dynamic} means that the function manipulates the stack
14339 dynamically: in addition to the static allocation described above, stack
14340 adjustments are made in the body of the function, for example to push/pop
14341 arguments around function calls.  If the qualifier @code{bounded} is also
14342 present, the amount of these adjustments is bounded at compile time and
14343 the second field is an upper bound of the total amount of stack used by
14344 the function.  If it is not present, the amount of these adjustments is
14345 not bounded at compile time and the second field only represents the
14346 bounded part.
14348 @item -fstats
14349 @opindex fstats
14350 Emit statistics about front-end processing at the end of the compilation.
14351 This option is supported only by the C++ front end, and
14352 the information is generally only useful to the G++ development team.
14354 @item -fdbg-cnt-list
14355 @opindex fdbg-cnt-list
14356 Print the name and the counter upper bound for all debug counters.
14359 @item -fdbg-cnt=@var{counter-value-list}
14360 @opindex fdbg-cnt
14361 Set the internal debug counter upper bound.  @var{counter-value-list}
14362 is a comma-separated list of @var{name}:@var{value} pairs
14363 which sets the upper bound of each debug counter @var{name} to @var{value}.
14364 All debug counters have the initial upper bound of @code{UINT_MAX};
14365 thus @code{dbg_cnt} returns true always unless the upper bound
14366 is set by this option.
14367 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14368 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14370 @item -print-file-name=@var{library}
14371 @opindex print-file-name
14372 Print the full absolute name of the library file @var{library} that
14373 would be used when linking---and don't do anything else.  With this
14374 option, GCC does not compile or link anything; it just prints the
14375 file name.
14377 @item -print-multi-directory
14378 @opindex print-multi-directory
14379 Print the directory name corresponding to the multilib selected by any
14380 other switches present in the command line.  This directory is supposed
14381 to exist in @env{GCC_EXEC_PREFIX}.
14383 @item -print-multi-lib
14384 @opindex print-multi-lib
14385 Print the mapping from multilib directory names to compiler switches
14386 that enable them.  The directory name is separated from the switches by
14387 @samp{;}, and each switch starts with an @samp{@@} instead of the
14388 @samp{-}, without spaces between multiple switches.  This is supposed to
14389 ease shell processing.
14391 @item -print-multi-os-directory
14392 @opindex print-multi-os-directory
14393 Print the path to OS libraries for the selected
14394 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14395 present in the @file{lib} subdirectory and no multilibs are used, this is
14396 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14397 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14398 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14399 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14401 @item -print-multiarch
14402 @opindex print-multiarch
14403 Print the path to OS libraries for the selected multiarch,
14404 relative to some @file{lib} subdirectory.
14406 @item -print-prog-name=@var{program}
14407 @opindex print-prog-name
14408 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14410 @item -print-libgcc-file-name
14411 @opindex print-libgcc-file-name
14412 Same as @option{-print-file-name=libgcc.a}.
14414 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14415 but you do want to link with @file{libgcc.a}.  You can do:
14417 @smallexample
14418 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14419 @end smallexample
14421 @item -print-search-dirs
14422 @opindex print-search-dirs
14423 Print the name of the configured installation directory and a list of
14424 program and library directories @command{gcc} searches---and don't do anything else.
14426 This is useful when @command{gcc} prints the error message
14427 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14428 To resolve this you either need to put @file{cpp0} and the other compiler
14429 components where @command{gcc} expects to find them, or you can set the environment
14430 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14431 Don't forget the trailing @samp{/}.
14432 @xref{Environment Variables}.
14434 @item -print-sysroot
14435 @opindex print-sysroot
14436 Print the target sysroot directory that is used during
14437 compilation.  This is the target sysroot specified either at configure
14438 time or using the @option{--sysroot} option, possibly with an extra
14439 suffix that depends on compilation options.  If no target sysroot is
14440 specified, the option prints nothing.
14442 @item -print-sysroot-headers-suffix
14443 @opindex print-sysroot-headers-suffix
14444 Print the suffix added to the target sysroot when searching for
14445 headers, or give an error if the compiler is not configured with such
14446 a suffix---and don't do anything else.
14448 @item -dumpmachine
14449 @opindex dumpmachine
14450 Print the compiler's target machine (for example,
14451 @samp{i686-pc-linux-gnu})---and don't do anything else.
14453 @item -dumpversion
14454 @opindex dumpversion
14455 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14456 anything else.  This is the compiler version used in filesystem paths,
14457 specs, can be depending on how the compiler has been configured just
14458 a single number (major version), two numbers separated by dot (major and
14459 minor version) or three numbers separated by dots (major, minor and patchlevel
14460 version).
14462 @item -dumpfullversion
14463 @opindex dumpfullversion
14464 Print the full compiler version, always 3 numbers separated by dots,
14465 major, minor and patchlevel version.
14467 @item -dumpspecs
14468 @opindex dumpspecs
14469 Print the compiler's built-in specs---and don't do anything else.  (This
14470 is used when GCC itself is being built.)  @xref{Spec Files}.
14471 @end table
14473 @node Submodel Options
14474 @section Machine-Dependent Options
14475 @cindex submodel options
14476 @cindex specifying hardware config
14477 @cindex hardware models and configurations, specifying
14478 @cindex target-dependent options
14479 @cindex machine-dependent options
14481 Each target machine supported by GCC can have its own options---for
14482 example, to allow you to compile for a particular processor variant or
14483 ABI, or to control optimizations specific to that machine.  By
14484 convention, the names of machine-specific options start with
14485 @samp{-m}.
14487 Some configurations of the compiler also support additional target-specific
14488 options, usually for compatibility with other compilers on the same
14489 platform.
14491 @c This list is ordered alphanumerically by subsection name.
14492 @c It should be the same order and spelling as these options are listed
14493 @c in Machine Dependent Options
14495 @menu
14496 * AArch64 Options::
14497 * Adapteva Epiphany Options::
14498 * ARC Options::
14499 * ARM Options::
14500 * AVR Options::
14501 * Blackfin Options::
14502 * C6X Options::
14503 * CRIS Options::
14504 * CR16 Options::
14505 * Darwin Options::
14506 * DEC Alpha Options::
14507 * FR30 Options::
14508 * FT32 Options::
14509 * FRV Options::
14510 * GNU/Linux Options::
14511 * H8/300 Options::
14512 * HPPA Options::
14513 * IA-64 Options::
14514 * LM32 Options::
14515 * M32C Options::
14516 * M32R/D Options::
14517 * M680x0 Options::
14518 * MCore Options::
14519 * MeP Options::
14520 * MicroBlaze Options::
14521 * MIPS Options::
14522 * MMIX Options::
14523 * MN10300 Options::
14524 * Moxie Options::
14525 * MSP430 Options::
14526 * NDS32 Options::
14527 * Nios II Options::
14528 * Nvidia PTX Options::
14529 * PDP-11 Options::
14530 * picoChip Options::
14531 * PowerPC Options::
14532 * PowerPC SPE Options::
14533 * RISC-V Options::
14534 * RL78 Options::
14535 * RS/6000 and PowerPC Options::
14536 * RX Options::
14537 * S/390 and zSeries Options::
14538 * Score Options::
14539 * SH Options::
14540 * Solaris 2 Options::
14541 * SPARC Options::
14542 * SPU Options::
14543 * System V Options::
14544 * TILE-Gx Options::
14545 * TILEPro Options::
14546 * V850 Options::
14547 * VAX Options::
14548 * Visium Options::
14549 * VMS Options::
14550 * VxWorks Options::
14551 * x86 Options::
14552 * x86 Windows Options::
14553 * Xstormy16 Options::
14554 * Xtensa Options::
14555 * zSeries Options::
14556 @end menu
14558 @node AArch64 Options
14559 @subsection AArch64 Options
14560 @cindex AArch64 Options
14562 These options are defined for AArch64 implementations:
14564 @table @gcctabopt
14566 @item -mabi=@var{name}
14567 @opindex mabi
14568 Generate code for the specified data model.  Permissible values
14569 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14570 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14571 but long int and pointers are 64 bits.
14573 The default depends on the specific target configuration.  Note that
14574 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14575 entire program with the same ABI, and link with a compatible set of libraries.
14577 @item -mbig-endian
14578 @opindex mbig-endian
14579 Generate big-endian code.  This is the default when GCC is configured for an
14580 @samp{aarch64_be-*-*} target.
14582 @item -mgeneral-regs-only
14583 @opindex mgeneral-regs-only
14584 Generate code which uses only the general-purpose registers.  This will prevent
14585 the compiler from using floating-point and Advanced SIMD registers but will not
14586 impose any restrictions on the assembler.
14588 @item -mlittle-endian
14589 @opindex mlittle-endian
14590 Generate little-endian code.  This is the default when GCC is configured for an
14591 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14593 @item -mcmodel=tiny
14594 @opindex mcmodel=tiny
14595 Generate code for the tiny code model.  The program and its statically defined
14596 symbols must be within 1MB of each other.  Programs can be statically or
14597 dynamically linked.
14599 @item -mcmodel=small
14600 @opindex mcmodel=small
14601 Generate code for the small code model.  The program and its statically defined
14602 symbols must be within 4GB of each other.  Programs can be statically or
14603 dynamically linked.  This is the default code model.
14605 @item -mcmodel=large
14606 @opindex mcmodel=large
14607 Generate code for the large code model.  This makes no assumptions about
14608 addresses and sizes of sections.  Programs can be statically linked only.
14610 @item -mstrict-align
14611 @opindex mstrict-align
14612 Avoid generating memory accesses that may not be aligned on a natural object
14613 boundary as described in the architecture specification.
14615 @item -momit-leaf-frame-pointer
14616 @itemx -mno-omit-leaf-frame-pointer
14617 @opindex momit-leaf-frame-pointer
14618 @opindex mno-omit-leaf-frame-pointer
14619 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14620 default.
14622 @item -mtls-dialect=desc
14623 @opindex mtls-dialect=desc
14624 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14625 of TLS variables.  This is the default.
14627 @item -mtls-dialect=traditional
14628 @opindex mtls-dialect=traditional
14629 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14630 of TLS variables.
14632 @item -mtls-size=@var{size}
14633 @opindex mtls-size
14634 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14635 This option requires binutils 2.26 or newer.
14637 @item -mfix-cortex-a53-835769
14638 @itemx -mno-fix-cortex-a53-835769
14639 @opindex mfix-cortex-a53-835769
14640 @opindex mno-fix-cortex-a53-835769
14641 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14642 This involves inserting a NOP instruction between memory instructions and
14643 64-bit integer multiply-accumulate instructions.
14645 @item -mfix-cortex-a53-843419
14646 @itemx -mno-fix-cortex-a53-843419
14647 @opindex mfix-cortex-a53-843419
14648 @opindex mno-fix-cortex-a53-843419
14649 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14650 This erratum workaround is made at link time and this will only pass the
14651 corresponding flag to the linker.
14653 @item -mlow-precision-recip-sqrt
14654 @itemx -mno-low-precision-recip-sqrt
14655 @opindex mlow-precision-recip-sqrt
14656 @opindex mno-low-precision-recip-sqrt
14657 Enable or disable the reciprocal square root approximation.
14658 This option only has an effect if @option{-ffast-math} or
14659 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14660 precision of reciprocal square root results to about 16 bits for
14661 single precision and to 32 bits for double precision.
14663 @item -mlow-precision-sqrt
14664 @itemx -mno-low-precision-sqrt
14665 @opindex -mlow-precision-sqrt
14666 @opindex -mno-low-precision-sqrt
14667 Enable or disable the square root approximation.
14668 This option only has an effect if @option{-ffast-math} or
14669 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14670 precision of square root results to about 16 bits for
14671 single precision and to 32 bits for double precision.
14672 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14674 @item -mlow-precision-div
14675 @itemx -mno-low-precision-div
14676 @opindex -mlow-precision-div
14677 @opindex -mno-low-precision-div
14678 Enable or disable the division approximation.
14679 This option only has an effect if @option{-ffast-math} or
14680 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14681 precision of division results to about 16 bits for
14682 single precision and to 32 bits for double precision.
14684 @item -march=@var{name}
14685 @opindex march
14686 Specify the name of the target architecture and, optionally, one or
14687 more feature modifiers.  This option has the form
14688 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14690 The permissible values for @var{arch} are @samp{armv8-a},
14691 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14692 or @var{native}.
14694 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14695 support for the ARMv8.4-A architecture extensions.
14697 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14698 support for the ARMv8.3-A architecture extensions.
14700 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14701 support for the ARMv8.2-A architecture extensions.
14703 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14704 support for the ARMv8.1-A architecture extension.  In particular, it
14705 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14707 The value @samp{native} is available on native AArch64 GNU/Linux and
14708 causes the compiler to pick the architecture of the host system.  This
14709 option has no effect if the compiler is unable to recognize the
14710 architecture of the host system,
14712 The permissible values for @var{feature} are listed in the sub-section
14713 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14714 Feature Modifiers}.  Where conflicting feature modifiers are
14715 specified, the right-most feature is used.
14717 GCC uses @var{name} to determine what kind of instructions it can emit
14718 when generating assembly code.  If @option{-march} is specified
14719 without either of @option{-mtune} or @option{-mcpu} also being
14720 specified, the code is tuned to perform well across a range of target
14721 processors implementing the target architecture.
14723 @item -mtune=@var{name}
14724 @opindex mtune
14725 Specify the name of the target processor for which GCC should tune the
14726 performance of the code.  Permissible values for this option are:
14727 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14728 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14729 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14730 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14731 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14732 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14733 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14734 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14735 @samp{native}.
14737 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14738 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14739 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14740 big.LITTLE system.
14742 Additionally on native AArch64 GNU/Linux systems the value
14743 @samp{native} tunes performance to the host system.  This option has no effect
14744 if the compiler is unable to recognize the processor of the host system.
14746 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14747 are specified, the code is tuned to perform well across a range
14748 of target processors.
14750 This option cannot be suffixed by feature modifiers.
14752 @item -mcpu=@var{name}
14753 @opindex mcpu
14754 Specify the name of the target processor, optionally suffixed by one
14755 or more feature modifiers.  This option has the form
14756 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14757 the permissible values for @var{cpu} are the same as those available
14758 for @option{-mtune}.  The permissible values for @var{feature} are
14759 documented in the sub-section on
14760 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14761 Feature Modifiers}.  Where conflicting feature modifiers are
14762 specified, the right-most feature is used.
14764 GCC uses @var{name} to determine what kind of instructions it can emit when
14765 generating assembly code (as if by @option{-march}) and to determine
14766 the target processor for which to tune for performance (as if
14767 by @option{-mtune}).  Where this option is used in conjunction
14768 with @option{-march} or @option{-mtune}, those options take precedence
14769 over the appropriate part of this option.
14771 @item -moverride=@var{string}
14772 @opindex moverride
14773 Override tuning decisions made by the back-end in response to a
14774 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14775 for @var{string} in this option are not guaranteed to be consistent
14776 across releases.
14778 This option is only intended to be useful when developing GCC.
14780 @item -mverbose-cost-dump
14781 @opindex mverbose-cost-dump
14782 Enable verbose cost model dumping in the debug dump files.  This option is
14783 provided for use in debugging the compiler.
14785 @item -mpc-relative-literal-loads
14786 @itemx -mno-pc-relative-literal-loads
14787 @opindex mpc-relative-literal-loads
14788 @opindex mno-pc-relative-literal-loads
14789 Enable or disable PC-relative literal loads.  With this option literal pools are
14790 accessed using a single instruction and emitted after each function.  This
14791 limits the maximum size of functions to 1MB.  This is enabled by default for
14792 @option{-mcmodel=tiny}.
14794 @item -msign-return-address=@var{scope}
14795 @opindex msign-return-address
14796 Select the function scope on which return address signing will be applied.
14797 Permissible values are @samp{none}, which disables return address signing,
14798 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14799 functions, and @samp{all}, which enables pointer signing for all functions.  The
14800 default value is @samp{none}.
14802 @item -msve-vector-bits=@var{bits}
14803 @opindex msve-vector-bits
14804 Specify the number of bits in an SVE vector register.  This option only has
14805 an effect when SVE is enabled.
14807 GCC supports two forms of SVE code generation: ``vector-length
14808 agnostic'' output that works with any size of vector register and
14809 ``vector-length specific'' output that only works when the vector
14810 registers are a particular size.  Replacing @var{bits} with
14811 @samp{scalable} selects vector-length agnostic output while
14812 replacing it with a number selects vector-length specific output.
14813 The possible lengths in the latter case are: 128, 256, 512, 1024
14814 and 2048.  @samp{scalable} is the default.
14816 At present, @samp{-msve-vector-bits=128} produces the same output
14817 as @samp{-msve-vector-bits=scalable}.
14819 @end table
14821 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14822 @anchor{aarch64-feature-modifiers}
14823 @cindex @option{-march} feature modifiers
14824 @cindex @option{-mcpu} feature modifiers
14825 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14826 the following and their inverses @option{no@var{feature}}:
14828 @table @samp
14829 @item crc
14830 Enable CRC extension.  This is on by default for
14831 @option{-march=armv8.1-a}.
14832 @item crypto
14833 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14834 instructions.
14835 @item fp
14836 Enable floating-point instructions.  This is on by default for all possible
14837 values for options @option{-march} and @option{-mcpu}.
14838 @item simd
14839 Enable Advanced SIMD instructions.  This also enables floating-point
14840 instructions.  This is on by default for all possible values for options
14841 @option{-march} and @option{-mcpu}.
14842 @item sve
14843 Enable Scalable Vector Extension instructions.  This also enables Advanced
14844 SIMD and floating-point instructions.
14845 @item lse
14846 Enable Large System Extension instructions.  This is on by default for
14847 @option{-march=armv8.1-a}.
14848 @item rdma
14849 Enable Round Double Multiply Accumulate instructions.  This is on by default
14850 for @option{-march=armv8.1-a}.
14851 @item fp16
14852 Enable FP16 extension.  This also enables floating-point instructions.
14853 @item fp16fml
14854 Enable FP16 fmla extension.  This also enables FP16 extensions and
14855 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.
14857 @item rcpc
14858 Enable the RcPc extension.  This does not change code generation from GCC,
14859 but is passed on to the assembler, enabling inline asm statements to use
14860 instructions from the RcPc extension.
14861 @item dotprod
14862 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14863 @item aes
14864 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14865 SIMD instructions.
14866 @item sha2
14867 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14868 @item sha3
14869 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14870 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14871 @item sm4
14872 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14873 Use of this option with architectures prior to Armv8.2-A is not supported.
14875 @end table
14877 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14878 which implies @option{fp}.
14879 Conversely, @option{nofp} implies @option{nosimd}, which implies
14880 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14882 @node Adapteva Epiphany Options
14883 @subsection Adapteva Epiphany Options
14885 These @samp{-m} options are defined for Adapteva Epiphany:
14887 @table @gcctabopt
14888 @item -mhalf-reg-file
14889 @opindex mhalf-reg-file
14890 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14891 That allows code to run on hardware variants that lack these registers.
14893 @item -mprefer-short-insn-regs
14894 @opindex mprefer-short-insn-regs
14895 Preferentially allocate registers that allow short instruction generation.
14896 This can result in increased instruction count, so this may either reduce or
14897 increase overall code size.
14899 @item -mbranch-cost=@var{num}
14900 @opindex mbranch-cost
14901 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14902 This cost is only a heuristic and is not guaranteed to produce
14903 consistent results across releases.
14905 @item -mcmove
14906 @opindex mcmove
14907 Enable the generation of conditional moves.
14909 @item -mnops=@var{num}
14910 @opindex mnops
14911 Emit @var{num} NOPs before every other generated instruction.
14913 @item -mno-soft-cmpsf
14914 @opindex mno-soft-cmpsf
14915 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14916 and test the flags.  This is faster than a software comparison, but can
14917 get incorrect results in the presence of NaNs, or when two different small
14918 numbers are compared such that their difference is calculated as zero.
14919 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14920 software comparisons.
14922 @item -mstack-offset=@var{num}
14923 @opindex mstack-offset
14924 Set the offset between the top of the stack and the stack pointer.
14925 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14926 can be used by leaf functions without stack allocation.
14927 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14928 Note also that this option changes the ABI; compiling a program with a
14929 different stack offset than the libraries have been compiled with
14930 generally does not work.
14931 This option can be useful if you want to evaluate if a different stack
14932 offset would give you better code, but to actually use a different stack
14933 offset to build working programs, it is recommended to configure the
14934 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14936 @item -mno-round-nearest
14937 @opindex mno-round-nearest
14938 Make the scheduler assume that the rounding mode has been set to
14939 truncating.  The default is @option{-mround-nearest}.
14941 @item -mlong-calls
14942 @opindex mlong-calls
14943 If not otherwise specified by an attribute, assume all calls might be beyond
14944 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14945 function address into a register before performing a (otherwise direct) call.
14946 This is the default.
14948 @item -mshort-calls
14949 @opindex short-calls
14950 If not otherwise specified by an attribute, assume all direct calls are
14951 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14952 for direct calls.  The default is @option{-mlong-calls}.
14954 @item -msmall16
14955 @opindex msmall16
14956 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14957 apply to function addresses for which @option{-mlong-calls} semantics
14958 are in effect.
14960 @item -mfp-mode=@var{mode}
14961 @opindex mfp-mode
14962 Set the prevailing mode of the floating-point unit.
14963 This determines the floating-point mode that is provided and expected
14964 at function call and return time.  Making this mode match the mode you
14965 predominantly need at function start can make your programs smaller and
14966 faster by avoiding unnecessary mode switches.
14968 @var{mode} can be set to one the following values:
14970 @table @samp
14971 @item caller
14972 Any mode at function entry is valid, and retained or restored when
14973 the function returns, and when it calls other functions.
14974 This mode is useful for compiling libraries or other compilation units
14975 you might want to incorporate into different programs with different
14976 prevailing FPU modes, and the convenience of being able to use a single
14977 object file outweighs the size and speed overhead for any extra
14978 mode switching that might be needed, compared with what would be needed
14979 with a more specific choice of prevailing FPU mode.
14981 @item truncate
14982 This is the mode used for floating-point calculations with
14983 truncating (i.e.@: round towards zero) rounding mode.  That includes
14984 conversion from floating point to integer.
14986 @item round-nearest
14987 This is the mode used for floating-point calculations with
14988 round-to-nearest-or-even rounding mode.
14990 @item int
14991 This is the mode used to perform integer calculations in the FPU, e.g.@:
14992 integer multiply, or integer multiply-and-accumulate.
14993 @end table
14995 The default is @option{-mfp-mode=caller}
14997 @item -mnosplit-lohi
14998 @itemx -mno-postinc
14999 @itemx -mno-postmodify
15000 @opindex mnosplit-lohi
15001 @opindex mno-postinc
15002 @opindex mno-postmodify
15003 Code generation tweaks that disable, respectively, splitting of 32-bit
15004 loads, generation of post-increment addresses, and generation of
15005 post-modify addresses.  The defaults are @option{msplit-lohi},
15006 @option{-mpost-inc}, and @option{-mpost-modify}.
15008 @item -mnovect-double
15009 @opindex mno-vect-double
15010 Change the preferred SIMD mode to SImode.  The default is
15011 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15013 @item -max-vect-align=@var{num}
15014 @opindex max-vect-align
15015 The maximum alignment for SIMD vector mode types.
15016 @var{num} may be 4 or 8.  The default is 8.
15017 Note that this is an ABI change, even though many library function
15018 interfaces are unaffected if they don't use SIMD vector modes
15019 in places that affect size and/or alignment of relevant types.
15021 @item -msplit-vecmove-early
15022 @opindex msplit-vecmove-early
15023 Split vector moves into single word moves before reload.  In theory this
15024 can give better register allocation, but so far the reverse seems to be
15025 generally the case.
15027 @item -m1reg-@var{reg}
15028 @opindex m1reg-
15029 Specify a register to hold the constant @minus{}1, which makes loading small negative
15030 constants and certain bitmasks faster.
15031 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15032 which specify use of that register as a fixed register,
15033 and @samp{none}, which means that no register is used for this
15034 purpose.  The default is @option{-m1reg-none}.
15036 @end table
15038 @node ARC Options
15039 @subsection ARC Options
15040 @cindex ARC options
15042 The following options control the architecture variant for which code
15043 is being compiled:
15045 @c architecture variants
15046 @table @gcctabopt
15048 @item -mbarrel-shifter
15049 @opindex mbarrel-shifter
15050 Generate instructions supported by barrel shifter.  This is the default
15051 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15053 @item -mjli-always
15054 @opindex mjli-alawys
15055 Force to call a function using jli_s instruction.  This option is
15056 valid only for ARCv2 architecture.
15058 @item -mcpu=@var{cpu}
15059 @opindex mcpu
15060 Set architecture type, register usage, and instruction scheduling
15061 parameters for @var{cpu}.  There are also shortcut alias options
15062 available for backward compatibility and convenience.  Supported
15063 values for @var{cpu} are
15065 @table @samp
15066 @opindex mA6
15067 @opindex mARC600
15068 @item arc600
15069 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15071 @item arc601
15072 @opindex mARC601
15073 Compile for ARC601.  Alias: @option{-mARC601}.
15075 @item arc700
15076 @opindex mA7
15077 @opindex mARC700
15078 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15079 This is the default when configured with @option{--with-cpu=arc700}@.
15081 @item arcem
15082 Compile for ARC EM.
15084 @item archs
15085 Compile for ARC HS.
15087 @item em
15088 Compile for ARC EM CPU with no hardware extensions.
15090 @item em4
15091 Compile for ARC EM4 CPU.
15093 @item em4_dmips
15094 Compile for ARC EM4 DMIPS CPU.
15096 @item em4_fpus
15097 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15098 extension.
15100 @item em4_fpuda
15101 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15102 double assist instructions.
15104 @item hs
15105 Compile for ARC HS CPU with no hardware extensions except the atomic
15106 instructions.
15108 @item hs34
15109 Compile for ARC HS34 CPU.
15111 @item hs38
15112 Compile for ARC HS38 CPU.
15114 @item hs38_linux
15115 Compile for ARC HS38 CPU with all hardware extensions on.
15117 @item arc600_norm
15118 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15120 @item arc600_mul32x16
15121 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15122 instructions enabled.
15124 @item arc600_mul64
15125 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15126 instructions enabled.
15128 @item arc601_norm
15129 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15131 @item arc601_mul32x16
15132 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15133 instructions enabled.
15135 @item arc601_mul64
15136 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15137 instructions enabled.
15139 @item nps400
15140 Compile for ARC 700 on NPS400 chip.
15142 @item em_mini
15143 Compile for ARC EM minimalist configuration featuring reduced register
15144 set.
15146 @end table
15148 @item -mdpfp
15149 @opindex mdpfp
15150 @itemx -mdpfp-compact
15151 @opindex mdpfp-compact
15152 Generate double-precision FPX instructions, tuned for the compact
15153 implementation.
15155 @item -mdpfp-fast
15156 @opindex mdpfp-fast
15157 Generate double-precision FPX instructions, tuned for the fast
15158 implementation.
15160 @item -mno-dpfp-lrsr
15161 @opindex mno-dpfp-lrsr
15162 Disable @code{lr} and @code{sr} instructions from using FPX extension
15163 aux registers.
15165 @item -mea
15166 @opindex mea
15167 Generate extended arithmetic instructions.  Currently only
15168 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15169 supported.  This is always enabled for @option{-mcpu=ARC700}.
15171 @item -mno-mpy
15172 @opindex mno-mpy
15173 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15174 deprecated.
15176 @item -mmul32x16
15177 @opindex mmul32x16
15178 Generate 32x16-bit multiply and multiply-accumulate instructions.
15180 @item -mmul64
15181 @opindex mmul64
15182 Generate @code{mul64} and @code{mulu64} instructions.  
15183 Only valid for @option{-mcpu=ARC600}.
15185 @item -mnorm
15186 @opindex mnorm
15187 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15188 is in effect.
15190 @item -mspfp
15191 @opindex mspfp
15192 @itemx -mspfp-compact
15193 @opindex mspfp-compact
15194 Generate single-precision FPX instructions, tuned for the compact
15195 implementation.
15197 @item -mspfp-fast
15198 @opindex mspfp-fast
15199 Generate single-precision FPX instructions, tuned for the fast
15200 implementation.
15202 @item -msimd
15203 @opindex msimd
15204 Enable generation of ARC SIMD instructions via target-specific
15205 builtins.  Only valid for @option{-mcpu=ARC700}.
15207 @item -msoft-float
15208 @opindex msoft-float
15209 This option ignored; it is provided for compatibility purposes only.
15210 Software floating-point code is emitted by default, and this default
15211 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15212 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15213 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15215 @item -mswap
15216 @opindex mswap
15217 Generate @code{swap} instructions.
15219 @item -matomic
15220 @opindex matomic
15221 This enables use of the locked load/store conditional extension to implement
15222 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15223 EM cores.
15225 @item -mdiv-rem
15226 @opindex mdiv-rem
15227 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15229 @item -mcode-density
15230 @opindex mcode-density
15231 Enable code density instructions for ARC EM.  
15232 This option is on by default for ARC HS.
15234 @item -mll64
15235 @opindex mll64
15236 Enable double load/store operations for ARC HS cores.
15238 @item -mtp-regno=@var{regno}
15239 @opindex mtp-regno
15240 Specify thread pointer register number.
15242 @item -mmpy-option=@var{multo}
15243 @opindex mmpy-option
15244 Compile ARCv2 code with a multiplier design option.  You can specify 
15245 the option using either a string or numeric value for @var{multo}.  
15246 @samp{wlh1} is the default value.  The recognized values are:
15248 @table @samp
15249 @item 0
15250 @itemx none
15251 No multiplier available.
15253 @item 1
15254 @itemx w
15255 16x16 multiplier, fully pipelined.
15256 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15258 @item 2
15259 @itemx wlh1
15260 32x32 multiplier, fully
15261 pipelined (1 stage).  The following instructions are additionally
15262 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15264 @item 3
15265 @itemx wlh2
15266 32x32 multiplier, fully pipelined
15267 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15268 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15270 @item 4
15271 @itemx wlh3
15272 Two 16x16 multipliers, blocking,
15273 sequential.  The following instructions are additionally enabled: @code{mpy},
15274 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15276 @item 5
15277 @itemx wlh4
15278 One 16x16 multiplier, blocking,
15279 sequential.  The following instructions are additionally enabled: @code{mpy},
15280 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15282 @item 6
15283 @itemx wlh5
15284 One 32x4 multiplier, blocking,
15285 sequential.  The following instructions are additionally enabled: @code{mpy},
15286 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15288 @item 7
15289 @itemx plus_dmpy
15290 ARC HS SIMD support.
15292 @item 8
15293 @itemx plus_macd
15294 ARC HS SIMD support.
15296 @item 9
15297 @itemx plus_qmacw
15298 ARC HS SIMD support.
15300 @end table
15302 This option is only available for ARCv2 cores@.
15304 @item -mfpu=@var{fpu}
15305 @opindex mfpu
15306 Enables support for specific floating-point hardware extensions for ARCv2
15307 cores.  Supported values for @var{fpu} are:
15309 @table @samp
15311 @item fpus
15312 Enables support for single-precision floating-point hardware
15313 extensions@.
15315 @item fpud
15316 Enables support for double-precision floating-point hardware
15317 extensions.  The single-precision floating-point extension is also
15318 enabled.  Not available for ARC EM@.
15320 @item fpuda
15321 Enables support for double-precision floating-point hardware
15322 extensions using double-precision assist instructions.  The single-precision
15323 floating-point extension is also enabled.  This option is
15324 only available for ARC EM@.
15326 @item fpuda_div
15327 Enables support for double-precision floating-point hardware
15328 extensions using double-precision assist instructions.
15329 The single-precision floating-point, square-root, and divide 
15330 extensions are also enabled.  This option is
15331 only available for ARC EM@.
15333 @item fpuda_fma
15334 Enables support for double-precision floating-point hardware
15335 extensions using double-precision assist instructions.
15336 The single-precision floating-point and fused multiply and add 
15337 hardware extensions are also enabled.  This option is
15338 only available for ARC EM@.
15340 @item fpuda_all
15341 Enables support for double-precision floating-point hardware
15342 extensions using double-precision assist instructions.
15343 All single-precision floating-point hardware extensions are also
15344 enabled.  This option is only available for ARC EM@.
15346 @item fpus_div
15347 Enables support for single-precision floating-point, square-root and divide 
15348 hardware extensions@.
15350 @item fpud_div
15351 Enables support for double-precision floating-point, square-root and divide 
15352 hardware extensions.  This option
15353 includes option @samp{fpus_div}. Not available for ARC EM@.
15355 @item fpus_fma
15356 Enables support for single-precision floating-point and 
15357 fused multiply and add hardware extensions@.
15359 @item fpud_fma
15360 Enables support for double-precision floating-point and 
15361 fused multiply and add hardware extensions.  This option
15362 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15364 @item fpus_all
15365 Enables support for all single-precision floating-point hardware
15366 extensions@.
15368 @item fpud_all
15369 Enables support for all single- and double-precision floating-point
15370 hardware extensions.  Not available for ARC EM@.
15372 @end table
15374 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15375 @opindex mirq-ctrl-saved
15376 Specifies general-purposes registers that the processor automatically
15377 saves/restores on interrupt entry and exit.  @var{register-range} is
15378 specified as two registers separated by a dash.  The register range
15379 always starts with @code{r0}, the upper limit is @code{fp} register.
15380 @var{blink} and @var{lp_count} are optional.  This option is only
15381 valid for ARC EM and ARC HS cores.
15383 @item -mrgf-banked-regs=@var{number}
15384 @opindex mrgf-banked-regs
15385 Specifies the number of registers replicated in second register bank
15386 on entry to fast interrupt.  Fast interrupts are interrupts with the
15387 highest priority level P0.  These interrupts save only PC and STATUS32
15388 registers to avoid memory transactions during interrupt entry and exit
15389 sequences.  Use this option when you are using fast interrupts in an
15390 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15392 @item -mlpc-width=@var{width}
15393 @opindex mlpc-width
15394 Specify the width of the @code{lp_count} register.  Valid values for
15395 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15396 fixed to 32 bits.  If the width is less than 32, the compiler does not
15397 attempt to transform loops in your program to use the zero-delay loop
15398 mechanism unless it is known that the @code{lp_count} register can
15399 hold the required loop-counter value.  Depending on the width
15400 specified, the compiler and run-time library might continue to use the
15401 loop mechanism for various needs.  This option defines macro
15402 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15404 @item -mrf16
15405 @opindex mrf16
15406 This option instructs the compiler to generate code for a 16-entry
15407 register file.  This option defines the @code{__ARC_RF16__}
15408 preprocessor macro.
15410 @end table
15412 The following options are passed through to the assembler, and also
15413 define preprocessor macro symbols.
15415 @c Flags used by the assembler, but for which we define preprocessor
15416 @c macro symbols as well.
15417 @table @gcctabopt
15418 @item -mdsp-packa
15419 @opindex mdsp-packa
15420 Passed down to the assembler to enable the DSP Pack A extensions.
15421 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15422 deprecated.
15424 @item -mdvbf
15425 @opindex mdvbf
15426 Passed down to the assembler to enable the dual Viterbi butterfly
15427 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15428 option is deprecated.
15430 @c ARC700 4.10 extension instruction
15431 @item -mlock
15432 @opindex mlock
15433 Passed down to the assembler to enable the locked load/store
15434 conditional extension.  Also sets the preprocessor symbol
15435 @code{__Xlock}.
15437 @item -mmac-d16
15438 @opindex mmac-d16
15439 Passed down to the assembler.  Also sets the preprocessor symbol
15440 @code{__Xxmac_d16}.  This option is deprecated.
15442 @item -mmac-24
15443 @opindex mmac-24
15444 Passed down to the assembler.  Also sets the preprocessor symbol
15445 @code{__Xxmac_24}.  This option is deprecated.
15447 @c ARC700 4.10 extension instruction
15448 @item -mrtsc
15449 @opindex mrtsc
15450 Passed down to the assembler to enable the 64-bit time-stamp counter
15451 extension instruction.  Also sets the preprocessor symbol
15452 @code{__Xrtsc}.  This option is deprecated.
15454 @c ARC700 4.10 extension instruction
15455 @item -mswape
15456 @opindex mswape
15457 Passed down to the assembler to enable the swap byte ordering
15458 extension instruction.  Also sets the preprocessor symbol
15459 @code{__Xswape}.
15461 @item -mtelephony
15462 @opindex mtelephony
15463 Passed down to the assembler to enable dual- and single-operand
15464 instructions for telephony.  Also sets the preprocessor symbol
15465 @code{__Xtelephony}.  This option is deprecated.
15467 @item -mxy
15468 @opindex mxy
15469 Passed down to the assembler to enable the XY memory extension.  Also
15470 sets the preprocessor symbol @code{__Xxy}.
15472 @end table
15474 The following options control how the assembly code is annotated:
15476 @c Assembly annotation options
15477 @table @gcctabopt
15478 @item -misize
15479 @opindex misize
15480 Annotate assembler instructions with estimated addresses.
15482 @item -mannotate-align
15483 @opindex mannotate-align
15484 Explain what alignment considerations lead to the decision to make an
15485 instruction short or long.
15487 @end table
15489 The following options are passed through to the linker:
15491 @c options passed through to the linker
15492 @table @gcctabopt
15493 @item -marclinux
15494 @opindex marclinux
15495 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15496 This option is enabled by default in tool chains built for
15497 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15498 when profiling is not requested.
15500 @item -marclinux_prof
15501 @opindex marclinux_prof
15502 Passed through to the linker, to specify use of the
15503 @code{arclinux_prof} emulation.  This option is enabled by default in
15504 tool chains built for @w{@code{arc-linux-uclibc}} and
15505 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15507 @end table
15509 The following options control the semantics of generated code:
15511 @c semantically relevant code generation options
15512 @table @gcctabopt
15513 @item -mlong-calls
15514 @opindex mlong-calls
15515 Generate calls as register indirect calls, thus providing access
15516 to the full 32-bit address range.
15518 @item -mmedium-calls
15519 @opindex mmedium-calls
15520 Don't use less than 25-bit addressing range for calls, which is the
15521 offset available for an unconditional branch-and-link
15522 instruction.  Conditional execution of function calls is suppressed, to
15523 allow use of the 25-bit range, rather than the 21-bit range with
15524 conditional branch-and-link.  This is the default for tool chains built
15525 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15527 @item -G @var{num}
15528 @opindex G
15529 Put definitions of externally-visible data in a small data section if
15530 that data is no bigger than @var{num} bytes.  The default value of
15531 @var{num} is 4 for any ARC configuration, or 8 when we have double
15532 load/store operations.
15534 @item -mno-sdata
15535 @opindex mno-sdata
15536 Do not generate sdata references.  This is the default for tool chains
15537 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15538 targets.
15540 @item -mvolatile-cache
15541 @opindex mvolatile-cache
15542 Use ordinarily cached memory accesses for volatile references.  This is the
15543 default.
15545 @item -mno-volatile-cache
15546 @opindex mno-volatile-cache
15547 Enable cache bypass for volatile references.
15549 @end table
15551 The following options fine tune code generation:
15552 @c code generation tuning options
15553 @table @gcctabopt
15554 @item -malign-call
15555 @opindex malign-call
15556 Do alignment optimizations for call instructions.
15558 @item -mauto-modify-reg
15559 @opindex mauto-modify-reg
15560 Enable the use of pre/post modify with register displacement.
15562 @item -mbbit-peephole
15563 @opindex mbbit-peephole
15564 Enable bbit peephole2.
15566 @item -mno-brcc
15567 @opindex mno-brcc
15568 This option disables a target-specific pass in @file{arc_reorg} to
15569 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15570 It has no effect on
15571 generation of these instructions driven by the combiner pass.
15573 @item -mcase-vector-pcrel
15574 @opindex mcase-vector-pcrel
15575 Use PC-relative switch case tables to enable case table shortening.
15576 This is the default for @option{-Os}.
15578 @item -mcompact-casesi
15579 @opindex mcompact-casesi
15580 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15581 and only available for ARCv1 cores.
15583 @item -mno-cond-exec
15584 @opindex mno-cond-exec
15585 Disable the ARCompact-specific pass to generate conditional 
15586 execution instructions.
15588 Due to delay slot scheduling and interactions between operand numbers,
15589 literal sizes, instruction lengths, and the support for conditional execution,
15590 the target-independent pass to generate conditional execution is often lacking,
15591 so the ARC port has kept a special pass around that tries to find more
15592 conditional execution generation opportunities after register allocation,
15593 branch shortening, and delay slot scheduling have been done.  This pass
15594 generally, but not always, improves performance and code size, at the cost of
15595 extra compilation time, which is why there is an option to switch it off.
15596 If you have a problem with call instructions exceeding their allowable
15597 offset range because they are conditionalized, you should consider using
15598 @option{-mmedium-calls} instead.
15600 @item -mearly-cbranchsi
15601 @opindex mearly-cbranchsi
15602 Enable pre-reload use of the @code{cbranchsi} pattern.
15604 @item -mexpand-adddi
15605 @opindex mexpand-adddi
15606 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15607 @code{add.f}, @code{adc} etc.  This option is deprecated.
15609 @item -mindexed-loads
15610 @opindex mindexed-loads
15611 Enable the use of indexed loads.  This can be problematic because some
15612 optimizers then assume that indexed stores exist, which is not
15613 the case.
15615 @item -mlra
15616 @opindex mlra
15617 Enable Local Register Allocation.  This is still experimental for ARC,
15618 so by default the compiler uses standard reload
15619 (i.e. @option{-mno-lra}).
15621 @item -mlra-priority-none
15622 @opindex mlra-priority-none
15623 Don't indicate any priority for target registers.
15625 @item -mlra-priority-compact
15626 @opindex mlra-priority-compact
15627 Indicate target register priority for r0..r3 / r12..r15.
15629 @item -mlra-priority-noncompact
15630 @opindex mlra-priority-noncompact
15631 Reduce target register priority for r0..r3 / r12..r15.
15633 @item -mno-millicode
15634 @opindex mno-millicode
15635 When optimizing for size (using @option{-Os}), prologues and epilogues
15636 that have to save or restore a large number of registers are often
15637 shortened by using call to a special function in libgcc; this is
15638 referred to as a @emph{millicode} call.  As these calls can pose
15639 performance issues, and/or cause linking issues when linking in a
15640 nonstandard way, this option is provided to turn off millicode call
15641 generation.
15643 @item -mmixed-code
15644 @opindex mmixed-code
15645 Tweak register allocation to help 16-bit instruction generation.
15646 This generally has the effect of decreasing the average instruction size
15647 while increasing the instruction count.
15649 @item -mq-class
15650 @opindex mq-class
15651 Enable @samp{q} instruction alternatives.
15652 This is the default for @option{-Os}.
15654 @item -mRcq
15655 @opindex mRcq
15656 Enable @samp{Rcq} constraint handling.  
15657 Most short code generation depends on this.
15658 This is the default.
15660 @item -mRcw
15661 @opindex mRcw
15662 Enable @samp{Rcw} constraint handling.  
15663 Most ccfsm condexec mostly depends on this.
15664 This is the default.
15666 @item -msize-level=@var{level}
15667 @opindex msize-level
15668 Fine-tune size optimization with regards to instruction lengths and alignment.
15669 The recognized values for @var{level} are:
15670 @table @samp
15671 @item 0
15672 No size optimization.  This level is deprecated and treated like @samp{1}.
15674 @item 1
15675 Short instructions are used opportunistically.
15677 @item 2
15678 In addition, alignment of loops and of code after barriers are dropped.
15680 @item 3
15681 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15683 @end table
15685 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15686 the behavior when this is not set is equivalent to level @samp{1}.
15688 @item -mtune=@var{cpu}
15689 @opindex mtune
15690 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15691 by @option{-mcpu=}.
15693 Supported values for @var{cpu} are
15695 @table @samp
15696 @item ARC600
15697 Tune for ARC600 CPU.
15699 @item ARC601
15700 Tune for ARC601 CPU.
15702 @item ARC700
15703 Tune for ARC700 CPU with standard multiplier block.
15705 @item ARC700-xmac
15706 Tune for ARC700 CPU with XMAC block.
15708 @item ARC725D
15709 Tune for ARC725D CPU.
15711 @item ARC750D
15712 Tune for ARC750D CPU.
15714 @end table
15716 @item -mmultcost=@var{num}
15717 @opindex mmultcost
15718 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15719 normal instruction.
15721 @item -munalign-prob-threshold=@var{probability}
15722 @opindex munalign-prob-threshold
15723 Set probability threshold for unaligning branches.
15724 When tuning for @samp{ARC700} and optimizing for speed, branches without
15725 filled delay slot are preferably emitted unaligned and long, unless
15726 profiling indicates that the probability for the branch to be taken
15727 is below @var{probability}.  @xref{Cross-profiling}.
15728 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15730 @end table
15732 The following options are maintained for backward compatibility, but
15733 are now deprecated and will be removed in a future release:
15735 @c Deprecated options
15736 @table @gcctabopt
15738 @item -margonaut
15739 @opindex margonaut
15740 Obsolete FPX.
15742 @item -mbig-endian
15743 @opindex mbig-endian
15744 @itemx -EB
15745 @opindex EB
15746 Compile code for big-endian targets.  Use of these options is now
15747 deprecated.  Big-endian code is supported by configuring GCC to build
15748 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15749 for which big endian is the default.
15751 @item -mlittle-endian
15752 @opindex mlittle-endian
15753 @itemx -EL
15754 @opindex EL
15755 Compile code for little-endian targets.  Use of these options is now
15756 deprecated.  Little-endian code is supported by configuring GCC to build 
15757 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15758 for which little endian is the default.
15760 @item -mbarrel_shifter
15761 @opindex mbarrel_shifter
15762 Replaced by @option{-mbarrel-shifter}.
15764 @item -mdpfp_compact
15765 @opindex mdpfp_compact
15766 Replaced by @option{-mdpfp-compact}.
15768 @item -mdpfp_fast
15769 @opindex mdpfp_fast
15770 Replaced by @option{-mdpfp-fast}.
15772 @item -mdsp_packa
15773 @opindex mdsp_packa
15774 Replaced by @option{-mdsp-packa}.
15776 @item -mEA
15777 @opindex mEA
15778 Replaced by @option{-mea}.
15780 @item -mmac_24
15781 @opindex mmac_24
15782 Replaced by @option{-mmac-24}.
15784 @item -mmac_d16
15785 @opindex mmac_d16
15786 Replaced by @option{-mmac-d16}.
15788 @item -mspfp_compact
15789 @opindex mspfp_compact
15790 Replaced by @option{-mspfp-compact}.
15792 @item -mspfp_fast
15793 @opindex mspfp_fast
15794 Replaced by @option{-mspfp-fast}.
15796 @item -mtune=@var{cpu}
15797 @opindex mtune
15798 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15799 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15800 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15802 @item -multcost=@var{num}
15803 @opindex multcost
15804 Replaced by @option{-mmultcost}.
15806 @end table
15808 @node ARM Options
15809 @subsection ARM Options
15810 @cindex ARM options
15812 These @samp{-m} options are defined for the ARM port:
15814 @table @gcctabopt
15815 @item -mabi=@var{name}
15816 @opindex mabi
15817 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15818 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15820 @item -mapcs-frame
15821 @opindex mapcs-frame
15822 Generate a stack frame that is compliant with the ARM Procedure Call
15823 Standard for all functions, even if this is not strictly necessary for
15824 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15825 with this option causes the stack frames not to be generated for
15826 leaf functions.  The default is @option{-mno-apcs-frame}.
15827 This option is deprecated.
15829 @item -mapcs
15830 @opindex mapcs
15831 This is a synonym for @option{-mapcs-frame} and is deprecated.
15833 @ignore
15834 @c not currently implemented
15835 @item -mapcs-stack-check
15836 @opindex mapcs-stack-check
15837 Generate code to check the amount of stack space available upon entry to
15838 every function (that actually uses some stack space).  If there is
15839 insufficient space available then either the function
15840 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15841 called, depending upon the amount of stack space required.  The runtime
15842 system is required to provide these functions.  The default is
15843 @option{-mno-apcs-stack-check}, since this produces smaller code.
15845 @c not currently implemented
15846 @item -mapcs-reentrant
15847 @opindex mapcs-reentrant
15848 Generate reentrant, position-independent code.  The default is
15849 @option{-mno-apcs-reentrant}.
15850 @end ignore
15852 @item -mthumb-interwork
15853 @opindex mthumb-interwork
15854 Generate code that supports calling between the ARM and Thumb
15855 instruction sets.  Without this option, on pre-v5 architectures, the
15856 two instruction sets cannot be reliably used inside one program.  The
15857 default is @option{-mno-thumb-interwork}, since slightly larger code
15858 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15859 configurations this option is meaningless.
15861 @item -mno-sched-prolog
15862 @opindex mno-sched-prolog
15863 Prevent the reordering of instructions in the function prologue, or the
15864 merging of those instruction with the instructions in the function's
15865 body.  This means that all functions start with a recognizable set
15866 of instructions (or in fact one of a choice from a small set of
15867 different function prologues), and this information can be used to
15868 locate the start of functions inside an executable piece of code.  The
15869 default is @option{-msched-prolog}.
15871 @item -mfloat-abi=@var{name}
15872 @opindex mfloat-abi
15873 Specifies which floating-point ABI to use.  Permissible values
15874 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15876 Specifying @samp{soft} causes GCC to generate output containing
15877 library calls for floating-point operations.
15878 @samp{softfp} allows the generation of code using hardware floating-point
15879 instructions, but still uses the soft-float calling conventions.
15880 @samp{hard} allows generation of floating-point instructions
15881 and uses FPU-specific calling conventions.
15883 The default depends on the specific target configuration.  Note that
15884 the hard-float and soft-float ABIs are not link-compatible; you must
15885 compile your entire program with the same ABI, and link with a
15886 compatible set of libraries.
15888 @item -mlittle-endian
15889 @opindex mlittle-endian
15890 Generate code for a processor running in little-endian mode.  This is
15891 the default for all standard configurations.
15893 @item -mbig-endian
15894 @opindex mbig-endian
15895 Generate code for a processor running in big-endian mode; the default is
15896 to compile code for a little-endian processor.
15898 @item -mbe8
15899 @itemx -mbe32
15900 @opindex mbe8
15901 When linking a big-endian image select between BE8 and BE32 formats.
15902 The option has no effect for little-endian images and is ignored.  The
15903 default is dependent on the selected target architecture.  For ARMv6
15904 and later architectures the default is BE8, for older architectures
15905 the default is BE32.  BE32 format has been deprecated by ARM.
15907 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15908 @opindex march
15909 This specifies the name of the target ARM architecture.  GCC uses this
15910 name to determine what kind of instructions it can emit when generating
15911 assembly code.  This option can be used in conjunction with or instead
15912 of the @option{-mcpu=} option.
15914 Permissible names are:
15915 @samp{armv4t},
15916 @samp{armv5t}, @samp{armv5te},
15917 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15918 @samp{armv6z}, @samp{armv6zk},
15919 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15920 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15921 @samp{armv8.4-a},
15922 @samp{armv7-r},
15923 @samp{armv8-r},
15924 @samp{armv6-m}, @samp{armv6s-m},
15925 @samp{armv7-m}, @samp{armv7e-m},
15926 @samp{armv8-m.base}, @samp{armv8-m.main},
15927 @samp{iwmmxt} and @samp{iwmmxt2}.
15929 Additionally, the following architectures, which lack support for the
15930 Thumb execution state, are recognized but support is deprecated:
15931 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15932 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15934 Many of the architectures support extensions.  These can be added by
15935 appending @samp{+@var{extension}} to the architecture name.  Extension
15936 options are processed in order and capabilities accumulate.  An extension
15937 will also enable any necessary base extensions
15938 upon which it depends.  For example, the @samp{+crypto} extension
15939 will always enable the @samp{+simd} extension.  The exception to the
15940 additive construction is for extensions that are prefixed with
15941 @samp{+no@dots{}}: these extensions disable the specified option and
15942 any other extensions that may depend on the presence of that
15943 extension.
15945 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15946 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15947 entirely disabled by the @samp{+nofp} option that follows it.
15949 Most extension names are generically named, but have an effect that is
15950 dependent upon the architecture to which it is applied.  For example,
15951 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15952 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15953 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15954 variant for @samp{armv8-a}.
15956 The table below lists the supported extensions for each architecture.
15957 Architectures not mentioned do not support any extensions.
15959 @table @samp
15960 @item  armv5e
15961 @itemx armv5te
15962 @itemx armv6
15963 @itemx armv6j
15964 @itemx armv6k
15965 @itemx armv6kz
15966 @itemx armv6t2
15967 @itemx armv6z
15968 @itemx armv6zk
15969 @table @samp
15970 @item +fp
15971 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15972 used as an alias for this extension.
15974 @item +nofp
15975 Disable the floating-point instructions.
15976 @end table
15978 @item armv7
15979 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15980 @table @samp
15981 @item +fp
15982 The VFPv3 floating-point instructions, with 16 double-precision
15983 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15984 for this extension.  Note that floating-point is not supported by the
15985 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15986 ARMv7-R architectures.
15988 @item +nofp
15989 Disable the floating-point instructions.
15990 @end table
15992 @item armv7-a
15993 @table @samp
15994 @item +fp
15995 The VFPv3 floating-point instructions, with 16 double-precision
15996 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15997 for this extension.
15999 @item +simd
16000 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16001 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
16002 for this extension.
16004 @item +vfpv3
16005 The VFPv3 floating-point instructions, with 32 double-precision
16006 registers.
16008 @item +vfpv3-d16-fp16
16009 The VFPv3 floating-point instructions, with 16 double-precision
16010 registers and the half-precision floating-point conversion operations.
16012 @item +vfpv3-fp16
16013 The VFPv3 floating-point instructions, with 32 double-precision
16014 registers and the half-precision floating-point conversion operations.
16016 @item +vfpv4-d16
16017 The VFPv4 floating-point instructions, with 16 double-precision
16018 registers.
16020 @item +vfpv4
16021 The VFPv4 floating-point instructions, with 32 double-precision
16022 registers.
16024 @item +neon-fp16
16025 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16026 the half-precision floating-point conversion operations.
16028 @item +neon-vfpv4
16029 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16031 @item +nosimd
16032 Disable the Advanced SIMD instructions (does not disable floating point).
16034 @item +nofp
16035 Disable the floating-point and Advanced SIMD instructions.
16036 @end table
16038 @item armv7ve
16039 The extended version of the ARMv7-A architecture with support for
16040 virtualization.
16041 @table @samp
16042 @item +fp
16043 The VFPv4 floating-point instructions, with 16 double-precision registers.
16044 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16046 @item +simd
16047 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16048 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16050 @item +vfpv3-d16
16051 The VFPv3 floating-point instructions, with 16 double-precision
16052 registers.
16054 @item +vfpv3
16055 The VFPv3 floating-point instructions, with 32 double-precision
16056 registers.
16058 @item +vfpv3-d16-fp16
16059 The VFPv3 floating-point instructions, with 16 double-precision
16060 registers and the half-precision floating-point conversion operations.
16062 @item +vfpv3-fp16
16063 The VFPv3 floating-point instructions, with 32 double-precision
16064 registers and the half-precision floating-point conversion operations.
16066 @item +vfpv4-d16
16067 The VFPv4 floating-point instructions, with 16 double-precision
16068 registers.
16070 @item +vfpv4
16071 The VFPv4 floating-point instructions, with 32 double-precision
16072 registers.
16074 @item +neon
16075 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16076 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16078 @item +neon-fp16
16079 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16080 the half-precision floating-point conversion operations.
16082 @item +nosimd
16083 Disable the Advanced SIMD instructions (does not disable floating point).
16085 @item +nofp
16086 Disable the floating-point and Advanced SIMD instructions.
16087 @end table
16089 @item armv8-a
16090 @table @samp
16091 @item +crc
16092 The Cyclic Redundancy Check (CRC) instructions.
16093 @item +simd
16094 The ARMv8-A Advanced SIMD and floating-point instructions.
16095 @item +crypto
16096 The cryptographic instructions.
16097 @item +nocrypto
16098 Disable the cryptographic instructions.
16099 @item +nofp
16100 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16101 @end table
16103 @item armv8.1-a
16104 @table @samp
16105 @item +simd
16106 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16108 @item +crypto
16109 The cryptographic instructions.  This also enables the Advanced SIMD and
16110 floating-point instructions.
16112 @item +nocrypto
16113 Disable the cryptographic instructions.
16115 @item +nofp
16116 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16117 @end table
16119 @item armv8.2-a
16120 @itemx armv8.3-a
16121 @table @samp
16122 @item +fp16
16123 The half-precision floating-point data processing instructions.
16124 This also enables the Advanced SIMD and floating-point instructions.
16126 @item +fp16fml
16127 The half-precision floating-point fmla extension.  This also enables
16128 the half-precision floating-point extension and Advanced SIMD and
16129 floating-point instructions.
16131 @item +simd
16132 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16134 @item +crypto
16135 The cryptographic instructions.  This also enables the Advanced SIMD and
16136 floating-point instructions.
16138 @item +dotprod
16139 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16141 @item +nocrypto
16142 Disable the cryptographic extension.
16144 @item +nofp
16145 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16146 @end table
16148 @item armv8.4-a
16149 @table @samp
16150 @item +fp16
16151 The half-precision floating-point data processing instructions.
16152 This also enables the Advanced SIMD and floating-point instructions as well
16153 as the Dot Product extension and the half-precision floating-point fmla
16154 extension.
16156 @item +simd
16157 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16158 Dot Product extension.
16160 @item +crypto
16161 The cryptographic instructions.  This also enables the Advanced SIMD and
16162 floating-point instructions as well as the Dot Product extension.
16164 @item +nocrypto
16165 Disable the cryptographic extension.
16167 @item +nofp
16168 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16169 @end table
16171 @item armv7-r
16172 @table @samp
16173 @item +fp.sp
16174 The single-precision VFPv3 floating-point instructions.  The extension
16175 @samp{+vfpv3xd} can be used as an alias for this extension.
16177 @item +fp
16178 The VFPv3 floating-point instructions with 16 double-precision registers.
16179 The extension +vfpv3-d16 can be used as an alias for this extension.
16181 @item +nofp
16182 Disable the floating-point extension.
16184 @item +idiv
16185 The ARM-state integer division instructions.
16187 @item +noidiv
16188 Disable the ARM-state integer division extension.
16189 @end table
16191 @item armv7e-m
16192 @table @samp
16193 @item +fp
16194 The single-precision VFPv4 floating-point instructions.
16196 @item +fpv5
16197 The single-precision FPv5 floating-point instructions.
16199 @item +fp.dp
16200 The single- and double-precision FPv5 floating-point instructions.
16202 @item +nofp
16203 Disable the floating-point extensions.
16204 @end table
16206 @item  armv8-m.main
16207 @table @samp
16208 @item +dsp
16209 The DSP instructions.
16211 @item +nodsp
16212 Disable the DSP extension.
16214 @item +fp
16215 The single-precision floating-point instructions.
16217 @item +fp.dp
16218 The single- and double-precision floating-point instructions.
16220 @item +nofp
16221 Disable the floating-point extension.
16222 @end table
16224 @item armv8-r
16225 @table @samp
16226 @item +crc
16227 The Cyclic Redundancy Check (CRC) instructions.
16228 @item +fp.sp
16229 The single-precision FPv5 floating-point instructions.
16230 @item +simd
16231 The ARMv8-A Advanced SIMD and floating-point instructions.
16232 @item +crypto
16233 The cryptographic instructions.
16234 @item +nocrypto
16235 Disable the cryptographic instructions.
16236 @item +nofp
16237 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16238 @end table
16240 @end table
16242 @option{-march=native} causes the compiler to auto-detect the architecture
16243 of the build computer.  At present, this feature is only supported on
16244 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16245 is unsuccessful the option has no effect.
16247 @item -mtune=@var{name}
16248 @opindex mtune
16249 This option specifies the name of the target ARM processor for
16250 which GCC should tune the performance of the code.
16251 For some ARM implementations better performance can be obtained by using
16252 this option.
16253 Permissible names are: @samp{arm2}, @samp{arm250},
16254 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16255 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16256 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16257 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16258 @samp{arm720},
16259 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16260 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16261 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16262 @samp{strongarm1110},
16263 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16264 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16265 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16266 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16267 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16268 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16269 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16270 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16271 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16272 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16273 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16274 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16275 @samp{cortex-r8}, @samp{cortex-r52},
16276 @samp{cortex-m33},
16277 @samp{cortex-m23},
16278 @samp{cortex-m7},
16279 @samp{cortex-m4},
16280 @samp{cortex-m3},
16281 @samp{cortex-m1},
16282 @samp{cortex-m0},
16283 @samp{cortex-m0plus},
16284 @samp{cortex-m1.small-multiply},
16285 @samp{cortex-m0.small-multiply},
16286 @samp{cortex-m0plus.small-multiply},
16287 @samp{exynos-m1},
16288 @samp{marvell-pj4},
16289 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16290 @samp{fa526}, @samp{fa626},
16291 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16292 @samp{xgene1}.
16294 Additionally, this option can specify that GCC should tune the performance
16295 of the code for a big.LITTLE system.  Permissible names are:
16296 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16297 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16298 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16299 @samp{cortex-a75.cortex-a55}.
16301 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16302 performance for a blend of processors within architecture @var{arch}.
16303 The aim is to generate code that run well on the current most popular
16304 processors, balancing between optimizations that benefit some CPUs in the
16305 range, and avoiding performance pitfalls of other CPUs.  The effects of
16306 this option may change in future GCC versions as CPU models come and go.
16308 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16309 the extension options do not affect the tuning of the generated code.
16311 @option{-mtune=native} causes the compiler to auto-detect the CPU
16312 of the build computer.  At present, this feature is only supported on
16313 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16314 unsuccessful the option has no effect.
16316 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16317 @opindex mcpu
16318 This specifies the name of the target ARM processor.  GCC uses this name
16319 to derive the name of the target ARM architecture (as if specified
16320 by @option{-march}) and the ARM processor type for which to tune for
16321 performance (as if specified by @option{-mtune}).  Where this option
16322 is used in conjunction with @option{-march} or @option{-mtune},
16323 those options take precedence over the appropriate part of this option.
16325 Many of the supported CPUs implement optional architectural
16326 extensions.  Where this is so the architectural extensions are
16327 normally enabled by default.  If implementations that lack the
16328 extension exist, then the extension syntax can be used to disable
16329 those extensions that have been omitted.  For floating-point and
16330 Advanced SIMD (Neon) instructions, the settings of the options
16331 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16332 floating-point and Advanced SIMD instructions will only be used if
16333 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16334 @option{-mfpu} other than @samp{auto} will override the available
16335 floating-point and SIMD extension instructions.
16337 For example, @samp{cortex-a9} can be found in three major
16338 configurations: integer only, with just a floating-point unit or with
16339 floating-point and Advanced SIMD.  The default is to enable all the
16340 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16341 be used to disable just the SIMD or both the SIMD and floating-point
16342 instructions respectively.
16344 Permissible names for this option are the same as those for
16345 @option{-mtune}.
16347 The following extension options are common to the listed CPUs:
16349 @table @samp
16350 @item +nodsp
16351 Disable the DSP instructions on @samp{cortex-m33}.
16353 @item  +nofp
16354 Disables the floating-point instructions on @samp{arm9e},
16355 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16356 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16357 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16358 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16359 Disables the floating-point and SIMD instructions on
16360 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16361 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16362 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16363 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16364 @samp{cortex-a53} and @samp{cortex-a55}.
16366 @item +nofp.dp
16367 Disables the double-precision component of the floating-point instructions
16368 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16370 @item +nosimd
16371 Disables the SIMD (but not floating-point) instructions on
16372 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16373 and @samp{cortex-a9}.
16375 @item +crypto
16376 Enables the cryptographic instructions on @samp{cortex-a32},
16377 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16378 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16379 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16380 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16381 @samp{cortex-a75.cortex-a55}.
16382 @end table
16384 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16385 VFPv3 with 16 double-precision registers.  It supports the following
16386 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16387 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16388 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16389 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16390 @option{-march=armv7-a}.
16392 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16393 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16394 See @option{-mtune} for more information.
16396 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16397 of the build computer.  At present, this feature is only supported on
16398 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16399 is unsuccessful the option has no effect.
16401 @item -mfpu=@var{name}
16402 @opindex mfpu
16403 This specifies what floating-point hardware (or hardware emulation) is
16404 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16405 @samp{vfpv3},
16406 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16407 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16408 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16409 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16410 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16411 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16412 is an alias for @samp{vfpv2}.
16414 The setting @samp{auto} is the default and is special.  It causes the
16415 compiler to select the floating-point and Advanced SIMD instructions
16416 based on the settings of @option{-mcpu} and @option{-march}.
16418 If the selected floating-point hardware includes the NEON extension
16419 (e.g. @option{-mfpu=neon}), note that floating-point
16420 operations are not generated by GCC's auto-vectorization pass unless
16421 @option{-funsafe-math-optimizations} is also specified.  This is
16422 because NEON hardware does not fully implement the IEEE 754 standard for
16423 floating-point arithmetic (in particular denormal values are treated as
16424 zero), so the use of NEON instructions may lead to a loss of precision.
16426 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}).
16428 @item -mfp16-format=@var{name}
16429 @opindex mfp16-format
16430 Specify the format of the @code{__fp16} half-precision floating-point type.
16431 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16432 the default is @samp{none}, in which case the @code{__fp16} type is not
16433 defined.  @xref{Half-Precision}, for more information.
16435 @item -mstructure-size-boundary=@var{n}
16436 @opindex mstructure-size-boundary
16437 The sizes of all structures and unions are rounded up to a multiple
16438 of the number of bits set by this option.  Permissible values are 8, 32
16439 and 64.  The default value varies for different toolchains.  For the COFF
16440 targeted toolchain the default value is 8.  A value of 64 is only allowed
16441 if the underlying ABI supports it.
16443 Specifying a larger number can produce faster, more efficient code, but
16444 can also increase the size of the program.  Different values are potentially
16445 incompatible.  Code compiled with one value cannot necessarily expect to
16446 work with code or libraries compiled with another value, if they exchange
16447 information using structures or unions.
16449 This option is deprecated.
16451 @item -mabort-on-noreturn
16452 @opindex mabort-on-noreturn
16453 Generate a call to the function @code{abort} at the end of a
16454 @code{noreturn} function.  It is executed if the function tries to
16455 return.
16457 @item -mlong-calls
16458 @itemx -mno-long-calls
16459 @opindex mlong-calls
16460 @opindex mno-long-calls
16461 Tells the compiler to perform function calls by first loading the
16462 address of the function into a register and then performing a subroutine
16463 call on this register.  This switch is needed if the target function
16464 lies outside of the 64-megabyte addressing range of the offset-based
16465 version of subroutine call instruction.
16467 Even if this switch is enabled, not all function calls are turned
16468 into long calls.  The heuristic is that static functions, functions
16469 that have the @code{short_call} attribute, functions that are inside
16470 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16471 definitions have already been compiled within the current compilation
16472 unit are not turned into long calls.  The exceptions to this rule are
16473 that weak function definitions, functions with the @code{long_call}
16474 attribute or the @code{section} attribute, and functions that are within
16475 the scope of a @code{#pragma long_calls} directive are always
16476 turned into long calls.
16478 This feature is not enabled by default.  Specifying
16479 @option{-mno-long-calls} restores the default behavior, as does
16480 placing the function calls within the scope of a @code{#pragma
16481 long_calls_off} directive.  Note these switches have no effect on how
16482 the compiler generates code to handle function calls via function
16483 pointers.
16485 @item -msingle-pic-base
16486 @opindex msingle-pic-base
16487 Treat the register used for PIC addressing as read-only, rather than
16488 loading it in the prologue for each function.  The runtime system is
16489 responsible for initializing this register with an appropriate value
16490 before execution begins.
16492 @item -mpic-register=@var{reg}
16493 @opindex mpic-register
16494 Specify the register to be used for PIC addressing.
16495 For standard PIC base case, the default is any suitable register
16496 determined by compiler.  For single PIC base case, the default is
16497 @samp{R9} if target is EABI based or stack-checking is enabled,
16498 otherwise the default is @samp{R10}.
16500 @item -mpic-data-is-text-relative
16501 @opindex mpic-data-is-text-relative
16502 Assume that the displacement between the text and data segments is fixed
16503 at static link time.  This permits using PC-relative addressing
16504 operations to access data known to be in the data segment.  For
16505 non-VxWorks RTP targets, this option is enabled by default.  When
16506 disabled on such targets, it will enable @option{-msingle-pic-base} by
16507 default.
16509 @item -mpoke-function-name
16510 @opindex mpoke-function-name
16511 Write the name of each function into the text section, directly
16512 preceding the function prologue.  The generated code is similar to this:
16514 @smallexample
16515      t0
16516          .ascii "arm_poke_function_name", 0
16517          .align
16518      t1
16519          .word 0xff000000 + (t1 - t0)
16520      arm_poke_function_name
16521          mov     ip, sp
16522          stmfd   sp!, @{fp, ip, lr, pc@}
16523          sub     fp, ip, #4
16524 @end smallexample
16526 When performing a stack backtrace, code can inspect the value of
16527 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16528 location @code{pc - 12} and the top 8 bits are set, then we know that
16529 there is a function name embedded immediately preceding this location
16530 and has length @code{((pc[-3]) & 0xff000000)}.
16532 @item -mthumb
16533 @itemx -marm
16534 @opindex marm
16535 @opindex mthumb
16537 Select between generating code that executes in ARM and Thumb
16538 states.  The default for most configurations is to generate code
16539 that executes in ARM state, but the default can be changed by
16540 configuring GCC with the @option{--with-mode=}@var{state}
16541 configure option.
16543 You can also override the ARM and Thumb mode for each function
16544 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16545 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16547 @item -mflip-thumb 
16548 @opindex mflip-thumb
16549 Switch ARM/Thumb modes on alternating functions.
16550 This option is provided for regression testing of mixed Thumb/ARM code
16551 generation, and is not intended for ordinary use in compiling code.
16553 @item -mtpcs-frame
16554 @opindex mtpcs-frame
16555 Generate a stack frame that is compliant with the Thumb Procedure Call
16556 Standard for all non-leaf functions.  (A leaf function is one that does
16557 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16559 @item -mtpcs-leaf-frame
16560 @opindex mtpcs-leaf-frame
16561 Generate a stack frame that is compliant with the Thumb Procedure Call
16562 Standard for all leaf functions.  (A leaf function is one that does
16563 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16565 @item -mcallee-super-interworking
16566 @opindex mcallee-super-interworking
16567 Gives all externally visible functions in the file being compiled an ARM
16568 instruction set header which switches to Thumb mode before executing the
16569 rest of the function.  This allows these functions to be called from
16570 non-interworking code.  This option is not valid in AAPCS configurations
16571 because interworking is enabled by default.
16573 @item -mcaller-super-interworking
16574 @opindex mcaller-super-interworking
16575 Allows calls via function pointers (including virtual functions) to
16576 execute correctly regardless of whether the target code has been
16577 compiled for interworking or not.  There is a small overhead in the cost
16578 of executing a function pointer if this option is enabled.  This option
16579 is not valid in AAPCS configurations because interworking is enabled
16580 by default.
16582 @item -mtp=@var{name}
16583 @opindex mtp
16584 Specify the access model for the thread local storage pointer.  The valid
16585 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16586 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16587 (supported in the arm6k architecture), and @samp{auto}, which uses the
16588 best available method for the selected processor.  The default setting is
16589 @samp{auto}.
16591 @item -mtls-dialect=@var{dialect}
16592 @opindex mtls-dialect
16593 Specify the dialect to use for accessing thread local storage.  Two
16594 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16595 @samp{gnu} dialect selects the original GNU scheme for supporting
16596 local and global dynamic TLS models.  The @samp{gnu2} dialect
16597 selects the GNU descriptor scheme, which provides better performance
16598 for shared libraries.  The GNU descriptor scheme is compatible with
16599 the original scheme, but does require new assembler, linker and
16600 library support.  Initial and local exec TLS models are unaffected by
16601 this option and always use the original scheme.
16603 @item -mword-relocations
16604 @opindex mword-relocations
16605 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16606 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16607 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16608 is specified.
16610 @item -mfix-cortex-m3-ldrd
16611 @opindex mfix-cortex-m3-ldrd
16612 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16613 with overlapping destination and base registers are used.  This option avoids
16614 generating these instructions.  This option is enabled by default when
16615 @option{-mcpu=cortex-m3} is specified.
16617 @item -munaligned-access
16618 @itemx -mno-unaligned-access
16619 @opindex munaligned-access
16620 @opindex mno-unaligned-access
16621 Enables (or disables) reading and writing of 16- and 32- bit values
16622 from addresses that are not 16- or 32- bit aligned.  By default
16623 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16624 ARMv8-M Baseline architectures, and enabled for all other
16625 architectures.  If unaligned access is not enabled then words in packed
16626 data structures are accessed a byte at a time.
16628 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16629 generated object file to either true or false, depending upon the
16630 setting of this option.  If unaligned access is enabled then the
16631 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16632 defined.
16634 @item -mneon-for-64bits
16635 @opindex mneon-for-64bits
16636 Enables using Neon to handle scalar 64-bits operations. This is
16637 disabled by default since the cost of moving data from core registers
16638 to Neon is high.
16640 @item -mslow-flash-data
16641 @opindex mslow-flash-data
16642 Assume loading data from flash is slower than fetching instruction.
16643 Therefore literal load is minimized for better performance.
16644 This option is only supported when compiling for ARMv7 M-profile and
16645 off by default.
16647 @item -masm-syntax-unified
16648 @opindex masm-syntax-unified
16649 Assume inline assembler is using unified asm syntax.  The default is
16650 currently off which implies divided syntax.  This option has no impact
16651 on Thumb2. However, this may change in future releases of GCC.
16652 Divided syntax should be considered deprecated.
16654 @item -mrestrict-it
16655 @opindex mrestrict-it
16656 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16657 IT blocks can only contain a single 16-bit instruction from a select
16658 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16660 @item -mprint-tune-info
16661 @opindex mprint-tune-info
16662 Print CPU tuning information as comment in assembler file.  This is
16663 an option used only for regression testing of the compiler and not
16664 intended for ordinary use in compiling code.  This option is disabled
16665 by default.
16667 @item -mverbose-cost-dump
16668 @opindex mverbose-cost-dump
16669 Enable verbose cost model dumping in the debug dump files.  This option is
16670 provided for use in debugging the compiler.
16672 @item -mpure-code
16673 @opindex mpure-code
16674 Do not allow constant data to be placed in code sections.
16675 Additionally, when compiling for ELF object format give all text sections the
16676 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16677 is only available when generating non-pic code for M-profile targets with the
16678 MOVT instruction.
16680 @item -mcmse
16681 @opindex mcmse
16682 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16683 Development Tools Engineering Specification", which can be found on
16684 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16685 @end table
16687 @node AVR Options
16688 @subsection AVR Options
16689 @cindex AVR Options
16691 These options are defined for AVR implementations:
16693 @table @gcctabopt
16694 @item -mmcu=@var{mcu}
16695 @opindex mmcu
16696 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16698 The default for this option is@tie{}@samp{avr2}.
16700 GCC supports the following AVR devices and ISAs:
16702 @include avr-mmcu.texi
16704 @item -mabsdata
16705 @opindex mabsdata
16707 Assume that all data in static storage can be accessed by LDS / STS
16708 instructions.  This option has only an effect on reduced Tiny devices like
16709 ATtiny40.  See also the @code{absdata}
16710 @ref{AVR Variable Attributes,variable attribute}.
16712 @item -maccumulate-args
16713 @opindex maccumulate-args
16714 Accumulate outgoing function arguments and acquire/release the needed
16715 stack space for outgoing function arguments once in function
16716 prologue/epilogue.  Without this option, outgoing arguments are pushed
16717 before calling a function and popped afterwards.
16719 Popping the arguments after the function call can be expensive on
16720 AVR so that accumulating the stack space might lead to smaller
16721 executables because arguments need not be removed from the
16722 stack after such a function call.
16724 This option can lead to reduced code size for functions that perform
16725 several calls to functions that get their arguments on the stack like
16726 calls to printf-like functions.
16728 @item -mbranch-cost=@var{cost}
16729 @opindex mbranch-cost
16730 Set the branch costs for conditional branch instructions to
16731 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16732 integers. The default branch cost is 0.
16734 @item -mcall-prologues
16735 @opindex mcall-prologues
16736 Functions prologues/epilogues are expanded as calls to appropriate
16737 subroutines.  Code size is smaller.
16739 @item -mgas-isr-prologues
16740 @opindex mgas-isr-prologues
16741 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16742 instruction supported by GNU Binutils.
16743 If this option is on, the feature can still be disabled for individual
16744 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16745 function attribute.  This feature is activated per default
16746 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16747 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16749 @item -mint8
16750 @opindex mint8
16751 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16752 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16753 and @code{long long} is 4 bytes.  Please note that this option does not
16754 conform to the C standards, but it results in smaller code
16755 size.
16757 @item -mmain-is-OS_task
16758 @opindex mmain-is-OS_task
16759 Do not save registers in @code{main}.  The effect is the same like
16760 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16761 to @code{main}. It is activated per default if optimization is on.
16763 @item -mn-flash=@var{num}
16764 @opindex mn-flash
16765 Assume that the flash memory has a size of 
16766 @var{num} times 64@tie{}KiB.
16768 @item -mno-interrupts
16769 @opindex mno-interrupts
16770 Generated code is not compatible with hardware interrupts.
16771 Code size is smaller.
16773 @item -mrelax
16774 @opindex mrelax
16775 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16776 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16777 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16778 the assembler's command line and the @option{--relax} option to the
16779 linker's command line.
16781 Jump relaxing is performed by the linker because jump offsets are not
16782 known before code is located. Therefore, the assembler code generated by the
16783 compiler is the same, but the instructions in the executable may
16784 differ from instructions in the assembler code.
16786 Relaxing must be turned on if linker stubs are needed, see the
16787 section on @code{EIND} and linker stubs below.
16789 @item -mrmw
16790 @opindex mrmw
16791 Assume that the device supports the Read-Modify-Write
16792 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16794 @item -mshort-calls
16795 @opindex mshort-calls
16797 Assume that @code{RJMP} and @code{RCALL} can target the whole
16798 program memory.
16800 This option is used internally for multilib selection.  It is
16801 not an optimization option, and you don't need to set it by hand.
16803 @item -msp8
16804 @opindex msp8
16805 Treat the stack pointer register as an 8-bit register,
16806 i.e.@: assume the high byte of the stack pointer is zero.
16807 In general, you don't need to set this option by hand.
16809 This option is used internally by the compiler to select and
16810 build multilibs for architectures @code{avr2} and @code{avr25}.
16811 These architectures mix devices with and without @code{SPH}.
16812 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16813 the compiler driver adds or removes this option from the compiler
16814 proper's command line, because the compiler then knows if the device
16815 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16816 register or not.
16818 @item -mstrict-X
16819 @opindex mstrict-X
16820 Use address register @code{X} in a way proposed by the hardware.  This means
16821 that @code{X} is only used in indirect, post-increment or
16822 pre-decrement addressing.
16824 Without this option, the @code{X} register may be used in the same way
16825 as @code{Y} or @code{Z} which then is emulated by additional
16826 instructions.  
16827 For example, loading a value with @code{X+const} addressing with a
16828 small non-negative @code{const < 64} to a register @var{Rn} is
16829 performed as
16831 @example
16832 adiw r26, const   ; X += const
16833 ld   @var{Rn}, X        ; @var{Rn} = *X
16834 sbiw r26, const   ; X -= const
16835 @end example
16837 @item -mtiny-stack
16838 @opindex mtiny-stack
16839 Only change the lower 8@tie{}bits of the stack pointer.
16841 @item -mfract-convert-truncate
16842 @opindex mfract-convert-truncate
16843 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16845 @item -nodevicelib
16846 @opindex nodevicelib
16847 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16849 @item -Waddr-space-convert
16850 @opindex Waddr-space-convert
16851 Warn about conversions between address spaces in the case where the
16852 resulting address space is not contained in the incoming address space.
16854 @item -Wmisspelled-isr
16855 @opindex Wmisspelled-isr
16856 Warn if the ISR is misspelled, i.e. without __vector prefix.
16857 Enabled by default.
16858 @end table
16860 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16861 @cindex @code{EIND}
16862 Pointers in the implementation are 16@tie{}bits wide.
16863 The address of a function or label is represented as word address so
16864 that indirect jumps and calls can target any code address in the
16865 range of 64@tie{}Ki words.
16867 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16868 bytes of program memory space, there is a special function register called
16869 @code{EIND} that serves as most significant part of the target address
16870 when @code{EICALL} or @code{EIJMP} instructions are used.
16872 Indirect jumps and calls on these devices are handled as follows by
16873 the compiler and are subject to some limitations:
16875 @itemize @bullet
16877 @item
16878 The compiler never sets @code{EIND}.
16880 @item
16881 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16882 instructions or might read @code{EIND} directly in order to emulate an
16883 indirect call/jump by means of a @code{RET} instruction.
16885 @item
16886 The compiler assumes that @code{EIND} never changes during the startup
16887 code or during the application. In particular, @code{EIND} is not
16888 saved/restored in function or interrupt service routine
16889 prologue/epilogue.
16891 @item
16892 For indirect calls to functions and computed goto, the linker
16893 generates @emph{stubs}. Stubs are jump pads sometimes also called
16894 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16895 The stub contains a direct jump to the desired address.
16897 @item
16898 Linker relaxation must be turned on so that the linker generates
16899 the stubs correctly in all situations. See the compiler option
16900 @option{-mrelax} and the linker option @option{--relax}.
16901 There are corner cases where the linker is supposed to generate stubs
16902 but aborts without relaxation and without a helpful error message.
16904 @item
16905 The default linker script is arranged for code with @code{EIND = 0}.
16906 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16907 linker script has to be used in order to place the sections whose
16908 name start with @code{.trampolines} into the segment where @code{EIND}
16909 points to.
16911 @item
16912 The startup code from libgcc never sets @code{EIND}.
16913 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16914 For the impact of AVR-LibC on @code{EIND}, see the
16915 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16917 @item
16918 It is legitimate for user-specific startup code to set up @code{EIND}
16919 early, for example by means of initialization code located in
16920 section @code{.init3}. Such code runs prior to general startup code
16921 that initializes RAM and calls constructors, but after the bit
16922 of startup code from AVR-LibC that sets @code{EIND} to the segment
16923 where the vector table is located.
16924 @example
16925 #include <avr/io.h>
16927 static void
16928 __attribute__((section(".init3"),naked,used,no_instrument_function))
16929 init3_set_eind (void)
16931   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16932                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16934 @end example
16936 @noindent
16937 The @code{__trampolines_start} symbol is defined in the linker script.
16939 @item
16940 Stubs are generated automatically by the linker if
16941 the following two conditions are met:
16942 @itemize @minus
16944 @item The address of a label is taken by means of the @code{gs} modifier
16945 (short for @emph{generate stubs}) like so:
16946 @example
16947 LDI r24, lo8(gs(@var{func}))
16948 LDI r25, hi8(gs(@var{func}))
16949 @end example
16950 @item The final location of that label is in a code segment
16951 @emph{outside} the segment where the stubs are located.
16952 @end itemize
16954 @item
16955 The compiler emits such @code{gs} modifiers for code labels in the
16956 following situations:
16957 @itemize @minus
16958 @item Taking address of a function or code label.
16959 @item Computed goto.
16960 @item If prologue-save function is used, see @option{-mcall-prologues}
16961 command-line option.
16962 @item Switch/case dispatch tables. If you do not want such dispatch
16963 tables you can specify the @option{-fno-jump-tables} command-line option.
16964 @item C and C++ constructors/destructors called during startup/shutdown.
16965 @item If the tools hit a @code{gs()} modifier explained above.
16966 @end itemize
16968 @item
16969 Jumping to non-symbolic addresses like so is @emph{not} supported:
16971 @example
16972 int main (void)
16974     /* Call function at word address 0x2 */
16975     return ((int(*)(void)) 0x2)();
16977 @end example
16979 Instead, a stub has to be set up, i.e.@: the function has to be called
16980 through a symbol (@code{func_4} in the example):
16982 @example
16983 int main (void)
16985     extern int func_4 (void);
16987     /* Call function at byte address 0x4 */
16988     return func_4();
16990 @end example
16992 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16993 Alternatively, @code{func_4} can be defined in the linker script.
16994 @end itemize
16996 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16997 @cindex @code{RAMPD}
16998 @cindex @code{RAMPX}
16999 @cindex @code{RAMPY}
17000 @cindex @code{RAMPZ}
17001 Some AVR devices support memories larger than the 64@tie{}KiB range
17002 that can be accessed with 16-bit pointers.  To access memory locations
17003 outside this 64@tie{}KiB range, the content of a @code{RAMP}
17004 register is used as high part of the address:
17005 The @code{X}, @code{Y}, @code{Z} address register is concatenated
17006 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
17007 register, respectively, to get a wide address. Similarly,
17008 @code{RAMPD} is used together with direct addressing.
17010 @itemize
17011 @item
17012 The startup code initializes the @code{RAMP} special function
17013 registers with zero.
17015 @item
17016 If a @ref{AVR Named Address Spaces,named address space} other than
17017 generic or @code{__flash} is used, then @code{RAMPZ} is set
17018 as needed before the operation.
17020 @item
17021 If the device supports RAM larger than 64@tie{}KiB and the compiler
17022 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17023 is reset to zero after the operation.
17025 @item
17026 If the device comes with a specific @code{RAMP} register, the ISR
17027 prologue/epilogue saves/restores that SFR and initializes it with
17028 zero in case the ISR code might (implicitly) use it.
17030 @item
17031 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17032 If you use inline assembler to read from locations outside the
17033 16-bit address range and change one of the @code{RAMP} registers,
17034 you must reset it to zero after the access.
17036 @end itemize
17038 @subsubsection AVR Built-in Macros
17040 GCC defines several built-in macros so that the user code can test
17041 for the presence or absence of features.  Almost any of the following
17042 built-in macros are deduced from device capabilities and thus
17043 triggered by the @option{-mmcu=} command-line option.
17045 For even more AVR-specific built-in macros see
17046 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17048 @table @code
17050 @item __AVR_ARCH__
17051 Build-in macro that resolves to a decimal number that identifies the
17052 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17053 Possible values are:
17055 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17056 @code{4}, @code{5}, @code{51}, @code{6}
17058 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17059 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17061 respectively and
17063 @code{100},
17064 @code{102}, @code{103}, @code{104},
17065 @code{105}, @code{106}, @code{107}
17067 for @var{mcu}=@code{avrtiny},
17068 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17069 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17070 If @var{mcu} specifies a device, this built-in macro is set
17071 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17072 defined to @code{4}.
17074 @item __AVR_@var{Device}__
17075 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17076 the device's name. For example, @option{-mmcu=atmega8} defines the
17077 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17078 @code{__AVR_ATtiny261A__}, etc.
17080 The built-in macros' names follow
17081 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17082 the device name as from the AVR user manual. The difference between
17083 @var{Device} in the built-in macro and @var{device} in
17084 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17086 If @var{device} is not a device but only a core architecture like
17087 @samp{avr51}, this macro is not defined.
17089 @item __AVR_DEVICE_NAME__
17090 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17091 the device's name. For example, with @option{-mmcu=atmega8} the macro
17092 is defined to @code{atmega8}.
17094 If @var{device} is not a device but only a core architecture like
17095 @samp{avr51}, this macro is not defined.
17097 @item __AVR_XMEGA__
17098 The device / architecture belongs to the XMEGA family of devices.
17100 @item __AVR_HAVE_ELPM__
17101 The device has the @code{ELPM} instruction.
17103 @item __AVR_HAVE_ELPMX__
17104 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17105 R@var{n},Z+} instructions.
17107 @item __AVR_HAVE_MOVW__
17108 The device has the @code{MOVW} instruction to perform 16-bit
17109 register-register moves.
17111 @item __AVR_HAVE_LPMX__
17112 The device has the @code{LPM R@var{n},Z} and
17113 @code{LPM R@var{n},Z+} instructions.
17115 @item __AVR_HAVE_MUL__
17116 The device has a hardware multiplier. 
17118 @item __AVR_HAVE_JMP_CALL__
17119 The device has the @code{JMP} and @code{CALL} instructions.
17120 This is the case for devices with more than 8@tie{}KiB of program
17121 memory.
17123 @item __AVR_HAVE_EIJMP_EICALL__
17124 @itemx __AVR_3_BYTE_PC__
17125 The device has the @code{EIJMP} and @code{EICALL} instructions.
17126 This is the case for devices with more than 128@tie{}KiB of program memory.
17127 This also means that the program counter
17128 (PC) is 3@tie{}bytes wide.
17130 @item __AVR_2_BYTE_PC__
17131 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17132 with up to 128@tie{}KiB of program memory.
17134 @item __AVR_HAVE_8BIT_SP__
17135 @itemx __AVR_HAVE_16BIT_SP__
17136 The stack pointer (SP) register is treated as 8-bit respectively
17137 16-bit register by the compiler.
17138 The definition of these macros is affected by @option{-mtiny-stack}.
17140 @item __AVR_HAVE_SPH__
17141 @itemx __AVR_SP8__
17142 The device has the SPH (high part of stack pointer) special function
17143 register or has an 8-bit stack pointer, respectively.
17144 The definition of these macros is affected by @option{-mmcu=} and
17145 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17146 by @option{-msp8}.
17148 @item __AVR_HAVE_RAMPD__
17149 @itemx __AVR_HAVE_RAMPX__
17150 @itemx __AVR_HAVE_RAMPY__
17151 @itemx __AVR_HAVE_RAMPZ__
17152 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17153 @code{RAMPZ} special function register, respectively.
17155 @item __NO_INTERRUPTS__
17156 This macro reflects the @option{-mno-interrupts} command-line option.
17158 @item __AVR_ERRATA_SKIP__
17159 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17160 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17161 instructions because of a hardware erratum.  Skip instructions are
17162 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17163 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17164 set.
17166 @item __AVR_ISA_RMW__
17167 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17169 @item __AVR_SFR_OFFSET__=@var{offset}
17170 Instructions that can address I/O special function registers directly
17171 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17172 address as if addressed by an instruction to access RAM like @code{LD}
17173 or @code{STS}. This offset depends on the device architecture and has
17174 to be subtracted from the RAM address in order to get the
17175 respective I/O@tie{}address.
17177 @item __AVR_SHORT_CALLS__
17178 The @option{-mshort-calls} command line option is set.
17180 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17181 Some devices support reading from flash memory by means of @code{LD*}
17182 instructions.  The flash memory is seen in the data address space
17183 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17184 is not defined, this feature is not available.  If defined,
17185 the address space is linear and there is no need to put
17186 @code{.rodata} into RAM.  This is handled by the default linker
17187 description file, and is currently available for
17188 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17189 there is no need to use address spaces like @code{__flash} or
17190 features like attribute @code{progmem} and @code{pgm_read_*}.
17192 @item __WITH_AVRLIBC__
17193 The compiler is configured to be used together with AVR-Libc.
17194 See the @option{--with-avrlibc} configure option.
17196 @end table
17198 @node Blackfin Options
17199 @subsection Blackfin Options
17200 @cindex Blackfin Options
17202 @table @gcctabopt
17203 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17204 @opindex mcpu=
17205 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17206 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17207 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17208 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17209 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17210 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17211 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17212 @samp{bf561}, @samp{bf592}.
17214 The optional @var{sirevision} specifies the silicon revision of the target
17215 Blackfin processor.  Any workarounds available for the targeted silicon revision
17216 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17217 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17218 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17219 hexadecimal digits representing the major and minor numbers in the silicon
17220 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17221 is not defined.  If @var{sirevision} is @samp{any}, the
17222 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17223 If this optional @var{sirevision} is not used, GCC assumes the latest known
17224 silicon revision of the targeted Blackfin processor.
17226 GCC defines a preprocessor macro for the specified @var{cpu}.
17227 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17228 provided by libgloss to be linked in if @option{-msim} is not given.
17230 Without this option, @samp{bf532} is used as the processor by default.
17232 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17233 only the preprocessor macro is defined.
17235 @item -msim
17236 @opindex msim
17237 Specifies that the program will be run on the simulator.  This causes
17238 the simulator BSP provided by libgloss to be linked in.  This option
17239 has effect only for @samp{bfin-elf} toolchain.
17240 Certain other options, such as @option{-mid-shared-library} and
17241 @option{-mfdpic}, imply @option{-msim}.
17243 @item -momit-leaf-frame-pointer
17244 @opindex momit-leaf-frame-pointer
17245 Don't keep the frame pointer in a register for leaf functions.  This
17246 avoids the instructions to save, set up and restore frame pointers and
17247 makes an extra register available in leaf functions.
17249 @item -mspecld-anomaly
17250 @opindex mspecld-anomaly
17251 When enabled, the compiler ensures that the generated code does not
17252 contain speculative loads after jump instructions. If this option is used,
17253 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17255 @item -mno-specld-anomaly
17256 @opindex mno-specld-anomaly
17257 Don't generate extra code to prevent speculative loads from occurring.
17259 @item -mcsync-anomaly
17260 @opindex mcsync-anomaly
17261 When enabled, the compiler ensures that the generated code does not
17262 contain CSYNC or SSYNC instructions too soon after conditional branches.
17263 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17265 @item -mno-csync-anomaly
17266 @opindex mno-csync-anomaly
17267 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17268 occurring too soon after a conditional branch.
17270 @item -mlow-64k
17271 @opindex mlow-64k
17272 When enabled, the compiler is free to take advantage of the knowledge that
17273 the entire program fits into the low 64k of memory.
17275 @item -mno-low-64k
17276 @opindex mno-low-64k
17277 Assume that the program is arbitrarily large.  This is the default.
17279 @item -mstack-check-l1
17280 @opindex mstack-check-l1
17281 Do stack checking using information placed into L1 scratchpad memory by the
17282 uClinux kernel.
17284 @item -mid-shared-library
17285 @opindex mid-shared-library
17286 Generate code that supports shared libraries via the library ID method.
17287 This allows for execute in place and shared libraries in an environment
17288 without virtual memory management.  This option implies @option{-fPIC}.
17289 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17291 @item -mno-id-shared-library
17292 @opindex mno-id-shared-library
17293 Generate code that doesn't assume ID-based shared libraries are being used.
17294 This is the default.
17296 @item -mleaf-id-shared-library
17297 @opindex mleaf-id-shared-library
17298 Generate code that supports shared libraries via the library ID method,
17299 but assumes that this library or executable won't link against any other
17300 ID shared libraries.  That allows the compiler to use faster code for jumps
17301 and calls.
17303 @item -mno-leaf-id-shared-library
17304 @opindex mno-leaf-id-shared-library
17305 Do not assume that the code being compiled won't link against any ID shared
17306 libraries.  Slower code is generated for jump and call insns.
17308 @item -mshared-library-id=n
17309 @opindex mshared-library-id
17310 Specifies the identification number of the ID-based shared library being
17311 compiled.  Specifying a value of 0 generates more compact code; specifying
17312 other values forces the allocation of that number to the current
17313 library but is no more space- or time-efficient than omitting this option.
17315 @item -msep-data
17316 @opindex msep-data
17317 Generate code that allows the data segment to be located in a different
17318 area of memory from the text segment.  This allows for execute in place in
17319 an environment without virtual memory management by eliminating relocations
17320 against the text section.
17322 @item -mno-sep-data
17323 @opindex mno-sep-data
17324 Generate code that assumes that the data segment follows the text segment.
17325 This is the default.
17327 @item -mlong-calls
17328 @itemx -mno-long-calls
17329 @opindex mlong-calls
17330 @opindex mno-long-calls
17331 Tells the compiler to perform function calls by first loading the
17332 address of the function into a register and then performing a subroutine
17333 call on this register.  This switch is needed if the target function
17334 lies outside of the 24-bit addressing range of the offset-based
17335 version of subroutine call instruction.
17337 This feature is not enabled by default.  Specifying
17338 @option{-mno-long-calls} restores the default behavior.  Note these
17339 switches have no effect on how the compiler generates code to handle
17340 function calls via function pointers.
17342 @item -mfast-fp
17343 @opindex mfast-fp
17344 Link with the fast floating-point library. This library relaxes some of
17345 the IEEE floating-point standard's rules for checking inputs against
17346 Not-a-Number (NAN), in the interest of performance.
17348 @item -minline-plt
17349 @opindex minline-plt
17350 Enable inlining of PLT entries in function calls to functions that are
17351 not known to bind locally.  It has no effect without @option{-mfdpic}.
17353 @item -mmulticore
17354 @opindex mmulticore
17355 Build a standalone application for multicore Blackfin processors. 
17356 This option causes proper start files and link scripts supporting 
17357 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17358 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17360 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17361 selects the one-application-per-core programming model.  Without
17362 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17363 programming model is used. In this model, the main function of Core B
17364 should be named as @code{coreb_main}.
17366 If this option is not used, the single-core application programming
17367 model is used.
17369 @item -mcorea
17370 @opindex mcorea
17371 Build a standalone application for Core A of BF561 when using
17372 the one-application-per-core programming model. Proper start files
17373 and link scripts are used to support Core A, and the macro
17374 @code{__BFIN_COREA} is defined.
17375 This option can only be used in conjunction with @option{-mmulticore}.
17377 @item -mcoreb
17378 @opindex mcoreb
17379 Build a standalone application for Core B of BF561 when using
17380 the one-application-per-core programming model. Proper start files
17381 and link scripts are used to support Core B, and the macro
17382 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17383 should be used instead of @code{main}. 
17384 This option can only be used in conjunction with @option{-mmulticore}.
17386 @item -msdram
17387 @opindex msdram
17388 Build a standalone application for SDRAM. Proper start files and
17389 link scripts are used to put the application into SDRAM, and the macro
17390 @code{__BFIN_SDRAM} is defined.
17391 The loader should initialize SDRAM before loading the application.
17393 @item -micplb
17394 @opindex micplb
17395 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17396 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17397 are enabled; for standalone applications the default is off.
17398 @end table
17400 @node C6X Options
17401 @subsection C6X Options
17402 @cindex C6X Options
17404 @table @gcctabopt
17405 @item -march=@var{name}
17406 @opindex march
17407 This specifies the name of the target architecture.  GCC uses this
17408 name to determine what kind of instructions it can emit when generating
17409 assembly code.  Permissible names are: @samp{c62x},
17410 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17412 @item -mbig-endian
17413 @opindex mbig-endian
17414 Generate code for a big-endian target.
17416 @item -mlittle-endian
17417 @opindex mlittle-endian
17418 Generate code for a little-endian target.  This is the default.
17420 @item -msim
17421 @opindex msim
17422 Choose startup files and linker script suitable for the simulator.
17424 @item -msdata=default
17425 @opindex msdata=default
17426 Put small global and static data in the @code{.neardata} section,
17427 which is pointed to by register @code{B14}.  Put small uninitialized
17428 global and static data in the @code{.bss} section, which is adjacent
17429 to the @code{.neardata} section.  Put small read-only data into the
17430 @code{.rodata} section.  The corresponding sections used for large
17431 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17433 @item -msdata=all
17434 @opindex msdata=all
17435 Put all data, not just small objects, into the sections reserved for
17436 small data, and use addressing relative to the @code{B14} register to
17437 access them.
17439 @item -msdata=none
17440 @opindex msdata=none
17441 Make no use of the sections reserved for small data, and use absolute
17442 addresses to access all data.  Put all initialized global and static
17443 data in the @code{.fardata} section, and all uninitialized data in the
17444 @code{.far} section.  Put all constant data into the @code{.const}
17445 section.
17446 @end table
17448 @node CRIS Options
17449 @subsection CRIS Options
17450 @cindex CRIS Options
17452 These options are defined specifically for the CRIS ports.
17454 @table @gcctabopt
17455 @item -march=@var{architecture-type}
17456 @itemx -mcpu=@var{architecture-type}
17457 @opindex march
17458 @opindex mcpu
17459 Generate code for the specified architecture.  The choices for
17460 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17461 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17462 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17463 @samp{v10}.
17465 @item -mtune=@var{architecture-type}
17466 @opindex mtune
17467 Tune to @var{architecture-type} everything applicable about the generated
17468 code, except for the ABI and the set of available instructions.  The
17469 choices for @var{architecture-type} are the same as for
17470 @option{-march=@var{architecture-type}}.
17472 @item -mmax-stack-frame=@var{n}
17473 @opindex mmax-stack-frame
17474 Warn when the stack frame of a function exceeds @var{n} bytes.
17476 @item -metrax4
17477 @itemx -metrax100
17478 @opindex metrax4
17479 @opindex metrax100
17480 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17481 @option{-march=v3} and @option{-march=v8} respectively.
17483 @item -mmul-bug-workaround
17484 @itemx -mno-mul-bug-workaround
17485 @opindex mmul-bug-workaround
17486 @opindex mno-mul-bug-workaround
17487 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17488 models where it applies.  This option is active by default.
17490 @item -mpdebug
17491 @opindex mpdebug
17492 Enable CRIS-specific verbose debug-related information in the assembly
17493 code.  This option also has the effect of turning off the @samp{#NO_APP}
17494 formatted-code indicator to the assembler at the beginning of the
17495 assembly file.
17497 @item -mcc-init
17498 @opindex mcc-init
17499 Do not use condition-code results from previous instruction; always emit
17500 compare and test instructions before use of condition codes.
17502 @item -mno-side-effects
17503 @opindex mno-side-effects
17504 Do not emit instructions with side effects in addressing modes other than
17505 post-increment.
17507 @item -mstack-align
17508 @itemx -mno-stack-align
17509 @itemx -mdata-align
17510 @itemx -mno-data-align
17511 @itemx -mconst-align
17512 @itemx -mno-const-align
17513 @opindex mstack-align
17514 @opindex mno-stack-align
17515 @opindex mdata-align
17516 @opindex mno-data-align
17517 @opindex mconst-align
17518 @opindex mno-const-align
17519 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17520 stack frame, individual data and constants to be aligned for the maximum
17521 single data access size for the chosen CPU model.  The default is to
17522 arrange for 32-bit alignment.  ABI details such as structure layout are
17523 not affected by these options.
17525 @item -m32-bit
17526 @itemx -m16-bit
17527 @itemx -m8-bit
17528 @opindex m32-bit
17529 @opindex m16-bit
17530 @opindex m8-bit
17531 Similar to the stack- data- and const-align options above, these options
17532 arrange for stack frame, writable data and constants to all be 32-bit,
17533 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17535 @item -mno-prologue-epilogue
17536 @itemx -mprologue-epilogue
17537 @opindex mno-prologue-epilogue
17538 @opindex mprologue-epilogue
17539 With @option{-mno-prologue-epilogue}, the normal function prologue and
17540 epilogue which set up the stack frame are omitted and no return
17541 instructions or return sequences are generated in the code.  Use this
17542 option only together with visual inspection of the compiled code: no
17543 warnings or errors are generated when call-saved registers must be saved,
17544 or storage for local variables needs to be allocated.
17546 @item -mno-gotplt
17547 @itemx -mgotplt
17548 @opindex mno-gotplt
17549 @opindex mgotplt
17550 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17551 instruction sequences that load addresses for functions from the PLT part
17552 of the GOT rather than (traditional on other architectures) calls to the
17553 PLT@.  The default is @option{-mgotplt}.
17555 @item -melf
17556 @opindex melf
17557 Legacy no-op option only recognized with the cris-axis-elf and
17558 cris-axis-linux-gnu targets.
17560 @item -mlinux
17561 @opindex mlinux
17562 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17564 @item -sim
17565 @opindex sim
17566 This option, recognized for the cris-axis-elf, arranges
17567 to link with input-output functions from a simulator library.  Code,
17568 initialized data and zero-initialized data are allocated consecutively.
17570 @item -sim2
17571 @opindex sim2
17572 Like @option{-sim}, but pass linker options to locate initialized data at
17573 0x40000000 and zero-initialized data at 0x80000000.
17574 @end table
17576 @node CR16 Options
17577 @subsection CR16 Options
17578 @cindex CR16 Options
17580 These options are defined specifically for the CR16 ports.
17582 @table @gcctabopt
17584 @item -mmac
17585 @opindex mmac
17586 Enable the use of multiply-accumulate instructions. Disabled by default.
17588 @item -mcr16cplus
17589 @itemx -mcr16c
17590 @opindex mcr16cplus
17591 @opindex mcr16c
17592 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17593 is default.
17595 @item -msim
17596 @opindex msim
17597 Links the library libsim.a which is in compatible with simulator. Applicable
17598 to ELF compiler only.
17600 @item -mint32
17601 @opindex mint32
17602 Choose integer type as 32-bit wide.
17604 @item -mbit-ops
17605 @opindex mbit-ops
17606 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17608 @item -mdata-model=@var{model}
17609 @opindex mdata-model
17610 Choose a data model. The choices for @var{model} are @samp{near},
17611 @samp{far} or @samp{medium}. @samp{medium} is default.
17612 However, @samp{far} is not valid with @option{-mcr16c}, as the
17613 CR16C architecture does not support the far data model.
17614 @end table
17616 @node Darwin Options
17617 @subsection Darwin Options
17618 @cindex Darwin options
17620 These options are defined for all architectures running the Darwin operating
17621 system.
17623 FSF GCC on Darwin does not create ``fat'' object files; it creates
17624 an object file for the single architecture that GCC was built to
17625 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17626 @option{-arch} options are used; it does so by running the compiler or
17627 linker multiple times and joining the results together with
17628 @file{lipo}.
17630 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17631 @samp{i686}) is determined by the flags that specify the ISA
17632 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17633 @option{-force_cpusubtype_ALL} option can be used to override this.
17635 The Darwin tools vary in their behavior when presented with an ISA
17636 mismatch.  The assembler, @file{as}, only permits instructions to
17637 be used that are valid for the subtype of the file it is generating,
17638 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17639 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17640 and prints an error if asked to create a shared library with a less
17641 restrictive subtype than its input files (for instance, trying to put
17642 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17643 for executables, @command{ld}, quietly gives the executable the most
17644 restrictive subtype of any of its input files.
17646 @table @gcctabopt
17647 @item -F@var{dir}
17648 @opindex F
17649 Add the framework directory @var{dir} to the head of the list of
17650 directories to be searched for header files.  These directories are
17651 interleaved with those specified by @option{-I} options and are
17652 scanned in a left-to-right order.
17654 A framework directory is a directory with frameworks in it.  A
17655 framework is a directory with a @file{Headers} and/or
17656 @file{PrivateHeaders} directory contained directly in it that ends
17657 in @file{.framework}.  The name of a framework is the name of this
17658 directory excluding the @file{.framework}.  Headers associated with
17659 the framework are found in one of those two directories, with
17660 @file{Headers} being searched first.  A subframework is a framework
17661 directory that is in a framework's @file{Frameworks} directory.
17662 Includes of subframework headers can only appear in a header of a
17663 framework that contains the subframework, or in a sibling subframework
17664 header.  Two subframeworks are siblings if they occur in the same
17665 framework.  A subframework should not have the same name as a
17666 framework; a warning is issued if this is violated.  Currently a
17667 subframework cannot have subframeworks; in the future, the mechanism
17668 may be extended to support this.  The standard frameworks can be found
17669 in @file{/System/Library/Frameworks} and
17670 @file{/Library/Frameworks}.  An example include looks like
17671 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17672 the name of the framework and @file{header.h} is found in the
17673 @file{PrivateHeaders} or @file{Headers} directory.
17675 @item -iframework@var{dir}
17676 @opindex iframework
17677 Like @option{-F} except the directory is a treated as a system
17678 directory.  The main difference between this @option{-iframework} and
17679 @option{-F} is that with @option{-iframework} the compiler does not
17680 warn about constructs contained within header files found via
17681 @var{dir}.  This option is valid only for the C family of languages.
17683 @item -gused
17684 @opindex gused
17685 Emit debugging information for symbols that are used.  For stabs
17686 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17687 This is by default ON@.
17689 @item -gfull
17690 @opindex gfull
17691 Emit debugging information for all symbols and types.
17693 @item -mmacosx-version-min=@var{version}
17694 The earliest version of MacOS X that this executable will run on
17695 is @var{version}.  Typical values of @var{version} include @code{10.1},
17696 @code{10.2}, and @code{10.3.9}.
17698 If the compiler was built to use the system's headers by default,
17699 then the default for this option is the system version on which the
17700 compiler is running, otherwise the default is to make choices that
17701 are compatible with as many systems and code bases as possible.
17703 @item -mkernel
17704 @opindex mkernel
17705 Enable kernel development mode.  The @option{-mkernel} option sets
17706 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17707 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17708 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17709 applicable.  This mode also sets @option{-mno-altivec},
17710 @option{-msoft-float}, @option{-fno-builtin} and
17711 @option{-mlong-branch} for PowerPC targets.
17713 @item -mone-byte-bool
17714 @opindex mone-byte-bool
17715 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17716 By default @code{sizeof(bool)} is @code{4} when compiling for
17717 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17718 option has no effect on x86.
17720 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17721 to generate code that is not binary compatible with code generated
17722 without that switch.  Using this switch may require recompiling all
17723 other modules in a program, including system libraries.  Use this
17724 switch to conform to a non-default data model.
17726 @item -mfix-and-continue
17727 @itemx -ffix-and-continue
17728 @itemx -findirect-data
17729 @opindex mfix-and-continue
17730 @opindex ffix-and-continue
17731 @opindex findirect-data
17732 Generate code suitable for fast turnaround development, such as to
17733 allow GDB to dynamically load @file{.o} files into already-running
17734 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17735 are provided for backwards compatibility.
17737 @item -all_load
17738 @opindex all_load
17739 Loads all members of static archive libraries.
17740 See man ld(1) for more information.
17742 @item -arch_errors_fatal
17743 @opindex arch_errors_fatal
17744 Cause the errors having to do with files that have the wrong architecture
17745 to be fatal.
17747 @item -bind_at_load
17748 @opindex bind_at_load
17749 Causes the output file to be marked such that the dynamic linker will
17750 bind all undefined references when the file is loaded or launched.
17752 @item -bundle
17753 @opindex bundle
17754 Produce a Mach-o bundle format file.
17755 See man ld(1) for more information.
17757 @item -bundle_loader @var{executable}
17758 @opindex bundle_loader
17759 This option specifies the @var{executable} that will load the build
17760 output file being linked.  See man ld(1) for more information.
17762 @item -dynamiclib
17763 @opindex dynamiclib
17764 When passed this option, GCC produces a dynamic library instead of
17765 an executable when linking, using the Darwin @file{libtool} command.
17767 @item -force_cpusubtype_ALL
17768 @opindex force_cpusubtype_ALL
17769 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17770 one controlled by the @option{-mcpu} or @option{-march} option.
17772 @item -allowable_client  @var{client_name}
17773 @itemx -client_name
17774 @itemx -compatibility_version
17775 @itemx -current_version
17776 @itemx -dead_strip
17777 @itemx -dependency-file
17778 @itemx -dylib_file
17779 @itemx -dylinker_install_name
17780 @itemx -dynamic
17781 @itemx -exported_symbols_list
17782 @itemx -filelist
17783 @need 800
17784 @itemx -flat_namespace
17785 @itemx -force_flat_namespace
17786 @itemx -headerpad_max_install_names
17787 @itemx -image_base
17788 @itemx -init
17789 @itemx -install_name
17790 @itemx -keep_private_externs
17791 @itemx -multi_module
17792 @itemx -multiply_defined
17793 @itemx -multiply_defined_unused
17794 @need 800
17795 @itemx -noall_load
17796 @itemx -no_dead_strip_inits_and_terms
17797 @itemx -nofixprebinding
17798 @itemx -nomultidefs
17799 @itemx -noprebind
17800 @itemx -noseglinkedit
17801 @itemx -pagezero_size
17802 @itemx -prebind
17803 @itemx -prebind_all_twolevel_modules
17804 @itemx -private_bundle
17805 @need 800
17806 @itemx -read_only_relocs
17807 @itemx -sectalign
17808 @itemx -sectobjectsymbols
17809 @itemx -whyload
17810 @itemx -seg1addr
17811 @itemx -sectcreate
17812 @itemx -sectobjectsymbols
17813 @itemx -sectorder
17814 @itemx -segaddr
17815 @itemx -segs_read_only_addr
17816 @need 800
17817 @itemx -segs_read_write_addr
17818 @itemx -seg_addr_table
17819 @itemx -seg_addr_table_filename
17820 @itemx -seglinkedit
17821 @itemx -segprot
17822 @itemx -segs_read_only_addr
17823 @itemx -segs_read_write_addr
17824 @itemx -single_module
17825 @itemx -static
17826 @itemx -sub_library
17827 @need 800
17828 @itemx -sub_umbrella
17829 @itemx -twolevel_namespace
17830 @itemx -umbrella
17831 @itemx -undefined
17832 @itemx -unexported_symbols_list
17833 @itemx -weak_reference_mismatches
17834 @itemx -whatsloaded
17835 @opindex allowable_client
17836 @opindex client_name
17837 @opindex compatibility_version
17838 @opindex current_version
17839 @opindex dead_strip
17840 @opindex dependency-file
17841 @opindex dylib_file
17842 @opindex dylinker_install_name
17843 @opindex dynamic
17844 @opindex exported_symbols_list
17845 @opindex filelist
17846 @opindex flat_namespace
17847 @opindex force_flat_namespace
17848 @opindex headerpad_max_install_names
17849 @opindex image_base
17850 @opindex init
17851 @opindex install_name
17852 @opindex keep_private_externs
17853 @opindex multi_module
17854 @opindex multiply_defined
17855 @opindex multiply_defined_unused
17856 @opindex noall_load
17857 @opindex no_dead_strip_inits_and_terms
17858 @opindex nofixprebinding
17859 @opindex nomultidefs
17860 @opindex noprebind
17861 @opindex noseglinkedit
17862 @opindex pagezero_size
17863 @opindex prebind
17864 @opindex prebind_all_twolevel_modules
17865 @opindex private_bundle
17866 @opindex read_only_relocs
17867 @opindex sectalign
17868 @opindex sectobjectsymbols
17869 @opindex whyload
17870 @opindex seg1addr
17871 @opindex sectcreate
17872 @opindex sectobjectsymbols
17873 @opindex sectorder
17874 @opindex segaddr
17875 @opindex segs_read_only_addr
17876 @opindex segs_read_write_addr
17877 @opindex seg_addr_table
17878 @opindex seg_addr_table_filename
17879 @opindex seglinkedit
17880 @opindex segprot
17881 @opindex segs_read_only_addr
17882 @opindex segs_read_write_addr
17883 @opindex single_module
17884 @opindex static
17885 @opindex sub_library
17886 @opindex sub_umbrella
17887 @opindex twolevel_namespace
17888 @opindex umbrella
17889 @opindex undefined
17890 @opindex unexported_symbols_list
17891 @opindex weak_reference_mismatches
17892 @opindex whatsloaded
17893 These options are passed to the Darwin linker.  The Darwin linker man page
17894 describes them in detail.
17895 @end table
17897 @node DEC Alpha Options
17898 @subsection DEC Alpha Options
17900 These @samp{-m} options are defined for the DEC Alpha implementations:
17902 @table @gcctabopt
17903 @item -mno-soft-float
17904 @itemx -msoft-float
17905 @opindex mno-soft-float
17906 @opindex msoft-float
17907 Use (do not use) the hardware floating-point instructions for
17908 floating-point operations.  When @option{-msoft-float} is specified,
17909 functions in @file{libgcc.a} are used to perform floating-point
17910 operations.  Unless they are replaced by routines that emulate the
17911 floating-point operations, or compiled in such a way as to call such
17912 emulations routines, these routines issue floating-point
17913 operations.   If you are compiling for an Alpha without floating-point
17914 operations, you must ensure that the library is built so as not to call
17915 them.
17917 Note that Alpha implementations without floating-point operations are
17918 required to have floating-point registers.
17920 @item -mfp-reg
17921 @itemx -mno-fp-regs
17922 @opindex mfp-reg
17923 @opindex mno-fp-regs
17924 Generate code that uses (does not use) the floating-point register set.
17925 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17926 register set is not used, floating-point operands are passed in integer
17927 registers as if they were integers and floating-point results are passed
17928 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17929 so any function with a floating-point argument or return value called by code
17930 compiled with @option{-mno-fp-regs} must also be compiled with that
17931 option.
17933 A typical use of this option is building a kernel that does not use,
17934 and hence need not save and restore, any floating-point registers.
17936 @item -mieee
17937 @opindex mieee
17938 The Alpha architecture implements floating-point hardware optimized for
17939 maximum performance.  It is mostly compliant with the IEEE floating-point
17940 standard.  However, for full compliance, software assistance is
17941 required.  This option generates code fully IEEE-compliant code
17942 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17943 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17944 defined during compilation.  The resulting code is less efficient but is
17945 able to correctly support denormalized numbers and exceptional IEEE
17946 values such as not-a-number and plus/minus infinity.  Other Alpha
17947 compilers call this option @option{-ieee_with_no_inexact}.
17949 @item -mieee-with-inexact
17950 @opindex mieee-with-inexact
17951 This is like @option{-mieee} except the generated code also maintains
17952 the IEEE @var{inexact-flag}.  Turning on this option causes the
17953 generated code to implement fully-compliant IEEE math.  In addition to
17954 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17955 macro.  On some Alpha implementations the resulting code may execute
17956 significantly slower than the code generated by default.  Since there is
17957 very little code that depends on the @var{inexact-flag}, you should
17958 normally not specify this option.  Other Alpha compilers call this
17959 option @option{-ieee_with_inexact}.
17961 @item -mfp-trap-mode=@var{trap-mode}
17962 @opindex mfp-trap-mode
17963 This option controls what floating-point related traps are enabled.
17964 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17965 The trap mode can be set to one of four values:
17967 @table @samp
17968 @item n
17969 This is the default (normal) setting.  The only traps that are enabled
17970 are the ones that cannot be disabled in software (e.g., division by zero
17971 trap).
17973 @item u
17974 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17975 as well.
17977 @item su
17978 Like @samp{u}, but the instructions are marked to be safe for software
17979 completion (see Alpha architecture manual for details).
17981 @item sui
17982 Like @samp{su}, but inexact traps are enabled as well.
17983 @end table
17985 @item -mfp-rounding-mode=@var{rounding-mode}
17986 @opindex mfp-rounding-mode
17987 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17988 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17991 @table @samp
17992 @item n
17993 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17994 the nearest machine number or towards the even machine number in case
17995 of a tie.
17997 @item m
17998 Round towards minus infinity.
18000 @item c
18001 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
18003 @item d
18004 Dynamic rounding mode.  A field in the floating-point control register
18005 (@var{fpcr}, see Alpha architecture reference manual) controls the
18006 rounding mode in effect.  The C library initializes this register for
18007 rounding towards plus infinity.  Thus, unless your program modifies the
18008 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18009 @end table
18011 @item -mtrap-precision=@var{trap-precision}
18012 @opindex mtrap-precision
18013 In the Alpha architecture, floating-point traps are imprecise.  This
18014 means without software assistance it is impossible to recover from a
18015 floating trap and program execution normally needs to be terminated.
18016 GCC can generate code that can assist operating system trap handlers
18017 in determining the exact location that caused a floating-point trap.
18018 Depending on the requirements of an application, different levels of
18019 precisions can be selected:
18021 @table @samp
18022 @item p
18023 Program precision.  This option is the default and means a trap handler
18024 can only identify which program caused a floating-point exception.
18026 @item f
18027 Function precision.  The trap handler can determine the function that
18028 caused a floating-point exception.
18030 @item i
18031 Instruction precision.  The trap handler can determine the exact
18032 instruction that caused a floating-point exception.
18033 @end table
18035 Other Alpha compilers provide the equivalent options called
18036 @option{-scope_safe} and @option{-resumption_safe}.
18038 @item -mieee-conformant
18039 @opindex mieee-conformant
18040 This option marks the generated code as IEEE conformant.  You must not
18041 use this option unless you also specify @option{-mtrap-precision=i} and either
18042 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18043 is to emit the line @samp{.eflag 48} in the function prologue of the
18044 generated assembly file.
18046 @item -mbuild-constants
18047 @opindex mbuild-constants
18048 Normally GCC examines a 32- or 64-bit integer constant to
18049 see if it can construct it from smaller constants in two or three
18050 instructions.  If it cannot, it outputs the constant as a literal and
18051 generates code to load it from the data segment at run time.
18053 Use this option to require GCC to construct @emph{all} integer constants
18054 using code, even if it takes more instructions (the maximum is six).
18056 You typically use this option to build a shared library dynamic
18057 loader.  Itself a shared library, it must relocate itself in memory
18058 before it can find the variables and constants in its own data segment.
18060 @item -mbwx
18061 @itemx -mno-bwx
18062 @itemx -mcix
18063 @itemx -mno-cix
18064 @itemx -mfix
18065 @itemx -mno-fix
18066 @itemx -mmax
18067 @itemx -mno-max
18068 @opindex mbwx
18069 @opindex mno-bwx
18070 @opindex mcix
18071 @opindex mno-cix
18072 @opindex mfix
18073 @opindex mno-fix
18074 @opindex mmax
18075 @opindex mno-max
18076 Indicate whether GCC should generate code to use the optional BWX,
18077 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18078 sets supported by the CPU type specified via @option{-mcpu=} option or that
18079 of the CPU on which GCC was built if none is specified.
18081 @item -mfloat-vax
18082 @itemx -mfloat-ieee
18083 @opindex mfloat-vax
18084 @opindex mfloat-ieee
18085 Generate code that uses (does not use) VAX F and G floating-point
18086 arithmetic instead of IEEE single and double precision.
18088 @item -mexplicit-relocs
18089 @itemx -mno-explicit-relocs
18090 @opindex mexplicit-relocs
18091 @opindex mno-explicit-relocs
18092 Older Alpha assemblers provided no way to generate symbol relocations
18093 except via assembler macros.  Use of these macros does not allow
18094 optimal instruction scheduling.  GNU binutils as of version 2.12
18095 supports a new syntax that allows the compiler to explicitly mark
18096 which relocations should apply to which instructions.  This option
18097 is mostly useful for debugging, as GCC detects the capabilities of
18098 the assembler when it is built and sets the default accordingly.
18100 @item -msmall-data
18101 @itemx -mlarge-data
18102 @opindex msmall-data
18103 @opindex mlarge-data
18104 When @option{-mexplicit-relocs} is in effect, static data is
18105 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18106 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18107 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18108 16-bit relocations off of the @code{$gp} register.  This limits the
18109 size of the small data area to 64KB, but allows the variables to be
18110 directly accessed via a single instruction.
18112 The default is @option{-mlarge-data}.  With this option the data area
18113 is limited to just below 2GB@.  Programs that require more than 2GB of
18114 data must use @code{malloc} or @code{mmap} to allocate the data in the
18115 heap instead of in the program's data segment.
18117 When generating code for shared libraries, @option{-fpic} implies
18118 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18120 @item -msmall-text
18121 @itemx -mlarge-text
18122 @opindex msmall-text
18123 @opindex mlarge-text
18124 When @option{-msmall-text} is used, the compiler assumes that the
18125 code of the entire program (or shared library) fits in 4MB, and is
18126 thus reachable with a branch instruction.  When @option{-msmall-data}
18127 is used, the compiler can assume that all local symbols share the
18128 same @code{$gp} value, and thus reduce the number of instructions
18129 required for a function call from 4 to 1.
18131 The default is @option{-mlarge-text}.
18133 @item -mcpu=@var{cpu_type}
18134 @opindex mcpu
18135 Set the instruction set and instruction scheduling parameters for
18136 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18137 style name or the corresponding chip number.  GCC supports scheduling
18138 parameters for the EV4, EV5 and EV6 family of processors and
18139 chooses the default values for the instruction set from the processor
18140 you specify.  If you do not specify a processor type, GCC defaults
18141 to the processor on which the compiler was built.
18143 Supported values for @var{cpu_type} are
18145 @table @samp
18146 @item ev4
18147 @itemx ev45
18148 @itemx 21064
18149 Schedules as an EV4 and has no instruction set extensions.
18151 @item ev5
18152 @itemx 21164
18153 Schedules as an EV5 and has no instruction set extensions.
18155 @item ev56
18156 @itemx 21164a
18157 Schedules as an EV5 and supports the BWX extension.
18159 @item pca56
18160 @itemx 21164pc
18161 @itemx 21164PC
18162 Schedules as an EV5 and supports the BWX and MAX extensions.
18164 @item ev6
18165 @itemx 21264
18166 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18168 @item ev67
18169 @itemx 21264a
18170 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18171 @end table
18173 Native toolchains also support the value @samp{native},
18174 which selects the best architecture option for the host processor.
18175 @option{-mcpu=native} has no effect if GCC does not recognize
18176 the processor.
18178 @item -mtune=@var{cpu_type}
18179 @opindex mtune
18180 Set only the instruction scheduling parameters for machine type
18181 @var{cpu_type}.  The instruction set is not changed.
18183 Native toolchains also support the value @samp{native},
18184 which selects the best architecture option for the host processor.
18185 @option{-mtune=native} has no effect if GCC does not recognize
18186 the processor.
18188 @item -mmemory-latency=@var{time}
18189 @opindex mmemory-latency
18190 Sets the latency the scheduler should assume for typical memory
18191 references as seen by the application.  This number is highly
18192 dependent on the memory access patterns used by the application
18193 and the size of the external cache on the machine.
18195 Valid options for @var{time} are
18197 @table @samp
18198 @item @var{number}
18199 A decimal number representing clock cycles.
18201 @item L1
18202 @itemx L2
18203 @itemx L3
18204 @itemx main
18205 The compiler contains estimates of the number of clock cycles for
18206 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18207 (also called Dcache, Scache, and Bcache), as well as to main memory.
18208 Note that L3 is only valid for EV5.
18210 @end table
18211 @end table
18213 @node FR30 Options
18214 @subsection FR30 Options
18215 @cindex FR30 Options
18217 These options are defined specifically for the FR30 port.
18219 @table @gcctabopt
18221 @item -msmall-model
18222 @opindex msmall-model
18223 Use the small address space model.  This can produce smaller code, but
18224 it does assume that all symbolic values and addresses fit into a
18225 20-bit range.
18227 @item -mno-lsim
18228 @opindex mno-lsim
18229 Assume that runtime support has been provided and so there is no need
18230 to include the simulator library (@file{libsim.a}) on the linker
18231 command line.
18233 @end table
18235 @node FT32 Options
18236 @subsection FT32 Options
18237 @cindex FT32 Options
18239 These options are defined specifically for the FT32 port.
18241 @table @gcctabopt
18243 @item -msim
18244 @opindex msim
18245 Specifies that the program will be run on the simulator.  This causes
18246 an alternate runtime startup and library to be linked.
18247 You must not use this option when generating programs that will run on
18248 real hardware; you must provide your own runtime library for whatever
18249 I/O functions are needed.
18251 @item -mlra
18252 @opindex mlra
18253 Enable Local Register Allocation.  This is still experimental for FT32,
18254 so by default the compiler uses standard reload.
18256 @item -mnodiv
18257 @opindex mnodiv
18258 Do not use div and mod instructions.
18260 @item -mft32b
18261 @opindex mft32b
18262 Enable use of the extended instructions of the FT32B processor.
18264 @item -mcompress
18265 @opindex mcompress
18266 Compress all code using the Ft32B code compression scheme.
18268 @item -mnopm
18269 @opindex  mnopm
18270 Do not generate code that reads program memory.
18272 @end table
18274 @node FRV Options
18275 @subsection FRV Options
18276 @cindex FRV Options
18278 @table @gcctabopt
18279 @item -mgpr-32
18280 @opindex mgpr-32
18282 Only use the first 32 general-purpose registers.
18284 @item -mgpr-64
18285 @opindex mgpr-64
18287 Use all 64 general-purpose registers.
18289 @item -mfpr-32
18290 @opindex mfpr-32
18292 Use only the first 32 floating-point registers.
18294 @item -mfpr-64
18295 @opindex mfpr-64
18297 Use all 64 floating-point registers.
18299 @item -mhard-float
18300 @opindex mhard-float
18302 Use hardware instructions for floating-point operations.
18304 @item -msoft-float
18305 @opindex msoft-float
18307 Use library routines for floating-point operations.
18309 @item -malloc-cc
18310 @opindex malloc-cc
18312 Dynamically allocate condition code registers.
18314 @item -mfixed-cc
18315 @opindex mfixed-cc
18317 Do not try to dynamically allocate condition code registers, only
18318 use @code{icc0} and @code{fcc0}.
18320 @item -mdword
18321 @opindex mdword
18323 Change ABI to use double word insns.
18325 @item -mno-dword
18326 @opindex mno-dword
18328 Do not use double word instructions.
18330 @item -mdouble
18331 @opindex mdouble
18333 Use floating-point double instructions.
18335 @item -mno-double
18336 @opindex mno-double
18338 Do not use floating-point double instructions.
18340 @item -mmedia
18341 @opindex mmedia
18343 Use media instructions.
18345 @item -mno-media
18346 @opindex mno-media
18348 Do not use media instructions.
18350 @item -mmuladd
18351 @opindex mmuladd
18353 Use multiply and add/subtract instructions.
18355 @item -mno-muladd
18356 @opindex mno-muladd
18358 Do not use multiply and add/subtract instructions.
18360 @item -mfdpic
18361 @opindex mfdpic
18363 Select the FDPIC ABI, which uses function descriptors to represent
18364 pointers to functions.  Without any PIC/PIE-related options, it
18365 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18366 assumes GOT entries and small data are within a 12-bit range from the
18367 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18368 are computed with 32 bits.
18369 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18371 @item -minline-plt
18372 @opindex minline-plt
18374 Enable inlining of PLT entries in function calls to functions that are
18375 not known to bind locally.  It has no effect without @option{-mfdpic}.
18376 It's enabled by default if optimizing for speed and compiling for
18377 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18378 optimization option such as @option{-O3} or above is present in the
18379 command line.
18381 @item -mTLS
18382 @opindex mTLS
18384 Assume a large TLS segment when generating thread-local code.
18386 @item -mtls
18387 @opindex mtls
18389 Do not assume a large TLS segment when generating thread-local code.
18391 @item -mgprel-ro
18392 @opindex mgprel-ro
18394 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18395 that is known to be in read-only sections.  It's enabled by default,
18396 except for @option{-fpic} or @option{-fpie}: even though it may help
18397 make the global offset table smaller, it trades 1 instruction for 4.
18398 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18399 one of which may be shared by multiple symbols, and it avoids the need
18400 for a GOT entry for the referenced symbol, so it's more likely to be a
18401 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18403 @item -multilib-library-pic
18404 @opindex multilib-library-pic
18406 Link with the (library, not FD) pic libraries.  It's implied by
18407 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18408 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18409 it explicitly.
18411 @item -mlinked-fp
18412 @opindex mlinked-fp
18414 Follow the EABI requirement of always creating a frame pointer whenever
18415 a stack frame is allocated.  This option is enabled by default and can
18416 be disabled with @option{-mno-linked-fp}.
18418 @item -mlong-calls
18419 @opindex mlong-calls
18421 Use indirect addressing to call functions outside the current
18422 compilation unit.  This allows the functions to be placed anywhere
18423 within the 32-bit address space.
18425 @item -malign-labels
18426 @opindex malign-labels
18428 Try to align labels to an 8-byte boundary by inserting NOPs into the
18429 previous packet.  This option only has an effect when VLIW packing
18430 is enabled.  It doesn't create new packets; it merely adds NOPs to
18431 existing ones.
18433 @item -mlibrary-pic
18434 @opindex mlibrary-pic
18436 Generate position-independent EABI code.
18438 @item -macc-4
18439 @opindex macc-4
18441 Use only the first four media accumulator registers.
18443 @item -macc-8
18444 @opindex macc-8
18446 Use all eight media accumulator registers.
18448 @item -mpack
18449 @opindex mpack
18451 Pack VLIW instructions.
18453 @item -mno-pack
18454 @opindex mno-pack
18456 Do not pack VLIW instructions.
18458 @item -mno-eflags
18459 @opindex mno-eflags
18461 Do not mark ABI switches in e_flags.
18463 @item -mcond-move
18464 @opindex mcond-move
18466 Enable the use of conditional-move instructions (default).
18468 This switch is mainly for debugging the compiler and will likely be removed
18469 in a future version.
18471 @item -mno-cond-move
18472 @opindex mno-cond-move
18474 Disable the use of conditional-move instructions.
18476 This switch is mainly for debugging the compiler and will likely be removed
18477 in a future version.
18479 @item -mscc
18480 @opindex mscc
18482 Enable the use of conditional set instructions (default).
18484 This switch is mainly for debugging the compiler and will likely be removed
18485 in a future version.
18487 @item -mno-scc
18488 @opindex mno-scc
18490 Disable the use of conditional set instructions.
18492 This switch is mainly for debugging the compiler and will likely be removed
18493 in a future version.
18495 @item -mcond-exec
18496 @opindex mcond-exec
18498 Enable the use of conditional execution (default).
18500 This switch is mainly for debugging the compiler and will likely be removed
18501 in a future version.
18503 @item -mno-cond-exec
18504 @opindex mno-cond-exec
18506 Disable the use of conditional execution.
18508 This switch is mainly for debugging the compiler and will likely be removed
18509 in a future version.
18511 @item -mvliw-branch
18512 @opindex mvliw-branch
18514 Run a pass to pack branches into VLIW instructions (default).
18516 This switch is mainly for debugging the compiler and will likely be removed
18517 in a future version.
18519 @item -mno-vliw-branch
18520 @opindex mno-vliw-branch
18522 Do not run a pass to pack branches into VLIW instructions.
18524 This switch is mainly for debugging the compiler and will likely be removed
18525 in a future version.
18527 @item -mmulti-cond-exec
18528 @opindex mmulti-cond-exec
18530 Enable optimization of @code{&&} and @code{||} in conditional execution
18531 (default).
18533 This switch is mainly for debugging the compiler and will likely be removed
18534 in a future version.
18536 @item -mno-multi-cond-exec
18537 @opindex mno-multi-cond-exec
18539 Disable optimization of @code{&&} and @code{||} in conditional execution.
18541 This switch is mainly for debugging the compiler and will likely be removed
18542 in a future version.
18544 @item -mnested-cond-exec
18545 @opindex mnested-cond-exec
18547 Enable nested conditional execution optimizations (default).
18549 This switch is mainly for debugging the compiler and will likely be removed
18550 in a future version.
18552 @item -mno-nested-cond-exec
18553 @opindex mno-nested-cond-exec
18555 Disable nested conditional execution optimizations.
18557 This switch is mainly for debugging the compiler and will likely be removed
18558 in a future version.
18560 @item -moptimize-membar
18561 @opindex moptimize-membar
18563 This switch removes redundant @code{membar} instructions from the
18564 compiler-generated code.  It is enabled by default.
18566 @item -mno-optimize-membar
18567 @opindex mno-optimize-membar
18569 This switch disables the automatic removal of redundant @code{membar}
18570 instructions from the generated code.
18572 @item -mtomcat-stats
18573 @opindex mtomcat-stats
18575 Cause gas to print out tomcat statistics.
18577 @item -mcpu=@var{cpu}
18578 @opindex mcpu
18580 Select the processor type for which to generate code.  Possible values are
18581 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18582 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18584 @end table
18586 @node GNU/Linux Options
18587 @subsection GNU/Linux Options
18589 These @samp{-m} options are defined for GNU/Linux targets:
18591 @table @gcctabopt
18592 @item -mglibc
18593 @opindex mglibc
18594 Use the GNU C library.  This is the default except
18595 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18596 @samp{*-*-linux-*android*} targets.
18598 @item -muclibc
18599 @opindex muclibc
18600 Use uClibc C library.  This is the default on
18601 @samp{*-*-linux-*uclibc*} targets.
18603 @item -mmusl
18604 @opindex mmusl
18605 Use the musl C library.  This is the default on
18606 @samp{*-*-linux-*musl*} targets.
18608 @item -mbionic
18609 @opindex mbionic
18610 Use Bionic C library.  This is the default on
18611 @samp{*-*-linux-*android*} targets.
18613 @item -mandroid
18614 @opindex mandroid
18615 Compile code compatible with Android platform.  This is the default on
18616 @samp{*-*-linux-*android*} targets.
18618 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18619 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18620 this option makes the GCC driver pass Android-specific options to the linker.
18621 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18622 to be defined.
18624 @item -tno-android-cc
18625 @opindex tno-android-cc
18626 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18627 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18628 @option{-fno-rtti} by default.
18630 @item -tno-android-ld
18631 @opindex tno-android-ld
18632 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18633 linking options to the linker.
18635 @end table
18637 @node H8/300 Options
18638 @subsection H8/300 Options
18640 These @samp{-m} options are defined for the H8/300 implementations:
18642 @table @gcctabopt
18643 @item -mrelax
18644 @opindex mrelax
18645 Shorten some address references at link time, when possible; uses the
18646 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18647 ld, Using ld}, for a fuller description.
18649 @item -mh
18650 @opindex mh
18651 Generate code for the H8/300H@.
18653 @item -ms
18654 @opindex ms
18655 Generate code for the H8S@.
18657 @item -mn
18658 @opindex mn
18659 Generate code for the H8S and H8/300H in the normal mode.  This switch
18660 must be used either with @option{-mh} or @option{-ms}.
18662 @item -ms2600
18663 @opindex ms2600
18664 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18666 @item -mexr
18667 @opindex mexr
18668 Extended registers are stored on stack before execution of function
18669 with monitor attribute. Default option is @option{-mexr}.
18670 This option is valid only for H8S targets.
18672 @item -mno-exr
18673 @opindex mno-exr
18674 Extended registers are not stored on stack before execution of function 
18675 with monitor attribute. Default option is @option{-mno-exr}. 
18676 This option is valid only for H8S targets.
18678 @item -mint32
18679 @opindex mint32
18680 Make @code{int} data 32 bits by default.
18682 @item -malign-300
18683 @opindex malign-300
18684 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18685 The default for the H8/300H and H8S is to align longs and floats on
18686 4-byte boundaries.
18687 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18688 This option has no effect on the H8/300.
18689 @end table
18691 @node HPPA Options
18692 @subsection HPPA Options
18693 @cindex HPPA Options
18695 These @samp{-m} options are defined for the HPPA family of computers:
18697 @table @gcctabopt
18698 @item -march=@var{architecture-type}
18699 @opindex march
18700 Generate code for the specified architecture.  The choices for
18701 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18702 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18703 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18704 architecture option for your machine.  Code compiled for lower numbered
18705 architectures runs on higher numbered architectures, but not the
18706 other way around.
18708 @item -mpa-risc-1-0
18709 @itemx -mpa-risc-1-1
18710 @itemx -mpa-risc-2-0
18711 @opindex mpa-risc-1-0
18712 @opindex mpa-risc-1-1
18713 @opindex mpa-risc-2-0
18714 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18716 @item -mcaller-copies
18717 @opindex mcaller-copies
18718 The caller copies function arguments passed by hidden reference.  This
18719 option should be used with care as it is not compatible with the default
18720 32-bit runtime.  However, only aggregates larger than eight bytes are
18721 passed by hidden reference and the option provides better compatibility
18722 with OpenMP.
18724 @item -mjump-in-delay
18725 @opindex mjump-in-delay
18726 This option is ignored and provided for compatibility purposes only.
18728 @item -mdisable-fpregs
18729 @opindex mdisable-fpregs
18730 Prevent floating-point registers from being used in any manner.  This is
18731 necessary for compiling kernels that perform lazy context switching of
18732 floating-point registers.  If you use this option and attempt to perform
18733 floating-point operations, the compiler aborts.
18735 @item -mdisable-indexing
18736 @opindex mdisable-indexing
18737 Prevent the compiler from using indexing address modes.  This avoids some
18738 rather obscure problems when compiling MIG generated code under MACH@.
18740 @item -mno-space-regs
18741 @opindex mno-space-regs
18742 Generate code that assumes the target has no space registers.  This allows
18743 GCC to generate faster indirect calls and use unscaled index address modes.
18745 Such code is suitable for level 0 PA systems and kernels.
18747 @item -mfast-indirect-calls
18748 @opindex mfast-indirect-calls
18749 Generate code that assumes calls never cross space boundaries.  This
18750 allows GCC to emit code that performs faster indirect calls.
18752 This option does not work in the presence of shared libraries or nested
18753 functions.
18755 @item -mfixed-range=@var{register-range}
18756 @opindex mfixed-range
18757 Generate code treating the given register range as fixed registers.
18758 A fixed register is one that the register allocator cannot use.  This is
18759 useful when compiling kernel code.  A register range is specified as
18760 two registers separated by a dash.  Multiple register ranges can be
18761 specified separated by a comma.
18763 @item -mlong-load-store
18764 @opindex mlong-load-store
18765 Generate 3-instruction load and store sequences as sometimes required by
18766 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18767 the HP compilers.
18769 @item -mportable-runtime
18770 @opindex mportable-runtime
18771 Use the portable calling conventions proposed by HP for ELF systems.
18773 @item -mgas
18774 @opindex mgas
18775 Enable the use of assembler directives only GAS understands.
18777 @item -mschedule=@var{cpu-type}
18778 @opindex mschedule
18779 Schedule code according to the constraints for the machine type
18780 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18781 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18782 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18783 proper scheduling option for your machine.  The default scheduling is
18784 @samp{8000}.
18786 @item -mlinker-opt
18787 @opindex mlinker-opt
18788 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18789 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18790 linkers in which they give bogus error messages when linking some programs.
18792 @item -msoft-float
18793 @opindex msoft-float
18794 Generate output containing library calls for floating point.
18795 @strong{Warning:} the requisite libraries are not available for all HPPA
18796 targets.  Normally the facilities of the machine's usual C compiler are
18797 used, but this cannot be done directly in cross-compilation.  You must make
18798 your own arrangements to provide suitable library functions for
18799 cross-compilation.
18801 @option{-msoft-float} changes the calling convention in the output file;
18802 therefore, it is only useful if you compile @emph{all} of a program with
18803 this option.  In particular, you need to compile @file{libgcc.a}, the
18804 library that comes with GCC, with @option{-msoft-float} in order for
18805 this to work.
18807 @item -msio
18808 @opindex msio
18809 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18810 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18811 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18812 options are available under HP-UX and HI-UX@.
18814 @item -mgnu-ld
18815 @opindex mgnu-ld
18816 Use options specific to GNU @command{ld}.
18817 This passes @option{-shared} to @command{ld} when
18818 building a shared library.  It is the default when GCC is configured,
18819 explicitly or implicitly, with the GNU linker.  This option does not
18820 affect which @command{ld} is called; it only changes what parameters
18821 are passed to that @command{ld}.
18822 The @command{ld} that is called is determined by the
18823 @option{--with-ld} configure option, GCC's program search path, and
18824 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18825 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18826 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18828 @item -mhp-ld
18829 @opindex mhp-ld
18830 Use options specific to HP @command{ld}.
18831 This passes @option{-b} to @command{ld} when building
18832 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18833 links.  It is the default when GCC is configured, explicitly or
18834 implicitly, with the HP linker.  This option does not affect
18835 which @command{ld} is called; it only changes what parameters are passed to that
18836 @command{ld}.
18837 The @command{ld} that is called is determined by the @option{--with-ld}
18838 configure option, GCC's program search path, and finally by the user's
18839 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18840 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18841 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18843 @item -mlong-calls
18844 @opindex mno-long-calls
18845 Generate code that uses long call sequences.  This ensures that a call
18846 is always able to reach linker generated stubs.  The default is to generate
18847 long calls only when the distance from the call site to the beginning
18848 of the function or translation unit, as the case may be, exceeds a
18849 predefined limit set by the branch type being used.  The limits for
18850 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18851 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18852 240,000 bytes.
18854 Distances are measured from the beginning of functions when using the
18855 @option{-ffunction-sections} option, or when using the @option{-mgas}
18856 and @option{-mno-portable-runtime} options together under HP-UX with
18857 the SOM linker.
18859 It is normally not desirable to use this option as it degrades
18860 performance.  However, it may be useful in large applications,
18861 particularly when partial linking is used to build the application.
18863 The types of long calls used depends on the capabilities of the
18864 assembler and linker, and the type of code being generated.  The
18865 impact on systems that support long absolute calls, and long pic
18866 symbol-difference or pc-relative calls should be relatively small.
18867 However, an indirect call is used on 32-bit ELF systems in pic code
18868 and it is quite long.
18870 @item -munix=@var{unix-std}
18871 @opindex march
18872 Generate compiler predefines and select a startfile for the specified
18873 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18874 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18875 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18876 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18877 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18878 and later.
18880 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18881 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18882 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18883 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18884 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18885 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18887 It is @emph{important} to note that this option changes the interfaces
18888 for various library routines.  It also affects the operational behavior
18889 of the C library.  Thus, @emph{extreme} care is needed in using this
18890 option.
18892 Library code that is intended to operate with more than one UNIX
18893 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18894 as appropriate.  Most GNU software doesn't provide this capability.
18896 @item -nolibdld
18897 @opindex nolibdld
18898 Suppress the generation of link options to search libdld.sl when the
18899 @option{-static} option is specified on HP-UX 10 and later.
18901 @item -static
18902 @opindex static
18903 The HP-UX implementation of setlocale in libc has a dependency on
18904 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18905 when the @option{-static} option is specified, special link options
18906 are needed to resolve this dependency.
18908 On HP-UX 10 and later, the GCC driver adds the necessary options to
18909 link with libdld.sl when the @option{-static} option is specified.
18910 This causes the resulting binary to be dynamic.  On the 64-bit port,
18911 the linkers generate dynamic binaries by default in any case.  The
18912 @option{-nolibdld} option can be used to prevent the GCC driver from
18913 adding these link options.
18915 @item -threads
18916 @opindex threads
18917 Add support for multithreading with the @dfn{dce thread} library
18918 under HP-UX@.  This option sets flags for both the preprocessor and
18919 linker.
18920 @end table
18922 @node IA-64 Options
18923 @subsection IA-64 Options
18924 @cindex IA-64 Options
18926 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18928 @table @gcctabopt
18929 @item -mbig-endian
18930 @opindex mbig-endian
18931 Generate code for a big-endian target.  This is the default for HP-UX@.
18933 @item -mlittle-endian
18934 @opindex mlittle-endian
18935 Generate code for a little-endian target.  This is the default for AIX5
18936 and GNU/Linux.
18938 @item -mgnu-as
18939 @itemx -mno-gnu-as
18940 @opindex mgnu-as
18941 @opindex mno-gnu-as
18942 Generate (or don't) code for the GNU assembler.  This is the default.
18943 @c Also, this is the default if the configure option @option{--with-gnu-as}
18944 @c is used.
18946 @item -mgnu-ld
18947 @itemx -mno-gnu-ld
18948 @opindex mgnu-ld
18949 @opindex mno-gnu-ld
18950 Generate (or don't) code for the GNU linker.  This is the default.
18951 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18952 @c is used.
18954 @item -mno-pic
18955 @opindex mno-pic
18956 Generate code that does not use a global pointer register.  The result
18957 is not position independent code, and violates the IA-64 ABI@.
18959 @item -mvolatile-asm-stop
18960 @itemx -mno-volatile-asm-stop
18961 @opindex mvolatile-asm-stop
18962 @opindex mno-volatile-asm-stop
18963 Generate (or don't) a stop bit immediately before and after volatile asm
18964 statements.
18966 @item -mregister-names
18967 @itemx -mno-register-names
18968 @opindex mregister-names
18969 @opindex mno-register-names
18970 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18971 the stacked registers.  This may make assembler output more readable.
18973 @item -mno-sdata
18974 @itemx -msdata
18975 @opindex mno-sdata
18976 @opindex msdata
18977 Disable (or enable) optimizations that use the small data section.  This may
18978 be useful for working around optimizer bugs.
18980 @item -mconstant-gp
18981 @opindex mconstant-gp
18982 Generate code that uses a single constant global pointer value.  This is
18983 useful when compiling kernel code.
18985 @item -mauto-pic
18986 @opindex mauto-pic
18987 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18988 This is useful when compiling firmware code.
18990 @item -minline-float-divide-min-latency
18991 @opindex minline-float-divide-min-latency
18992 Generate code for inline divides of floating-point values
18993 using the minimum latency algorithm.
18995 @item -minline-float-divide-max-throughput
18996 @opindex minline-float-divide-max-throughput
18997 Generate code for inline divides of floating-point values
18998 using the maximum throughput algorithm.
19000 @item -mno-inline-float-divide
19001 @opindex mno-inline-float-divide
19002 Do not generate inline code for divides of floating-point values.
19004 @item -minline-int-divide-min-latency
19005 @opindex minline-int-divide-min-latency
19006 Generate code for inline divides of integer values
19007 using the minimum latency algorithm.
19009 @item -minline-int-divide-max-throughput
19010 @opindex minline-int-divide-max-throughput
19011 Generate code for inline divides of integer values
19012 using the maximum throughput algorithm.
19014 @item -mno-inline-int-divide
19015 @opindex mno-inline-int-divide
19016 Do not generate inline code for divides of integer values.
19018 @item -minline-sqrt-min-latency
19019 @opindex minline-sqrt-min-latency
19020 Generate code for inline square roots
19021 using the minimum latency algorithm.
19023 @item -minline-sqrt-max-throughput
19024 @opindex minline-sqrt-max-throughput
19025 Generate code for inline square roots
19026 using the maximum throughput algorithm.
19028 @item -mno-inline-sqrt
19029 @opindex mno-inline-sqrt
19030 Do not generate inline code for @code{sqrt}.
19032 @item -mfused-madd
19033 @itemx -mno-fused-madd
19034 @opindex mfused-madd
19035 @opindex mno-fused-madd
19036 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19037 instructions.  The default is to use these instructions.
19039 @item -mno-dwarf2-asm
19040 @itemx -mdwarf2-asm
19041 @opindex mno-dwarf2-asm
19042 @opindex mdwarf2-asm
19043 Don't (or do) generate assembler code for the DWARF line number debugging
19044 info.  This may be useful when not using the GNU assembler.
19046 @item -mearly-stop-bits
19047 @itemx -mno-early-stop-bits
19048 @opindex mearly-stop-bits
19049 @opindex mno-early-stop-bits
19050 Allow stop bits to be placed earlier than immediately preceding the
19051 instruction that triggered the stop bit.  This can improve instruction
19052 scheduling, but does not always do so.
19054 @item -mfixed-range=@var{register-range}
19055 @opindex mfixed-range
19056 Generate code treating the given register range as fixed registers.
19057 A fixed register is one that the register allocator cannot use.  This is
19058 useful when compiling kernel code.  A register range is specified as
19059 two registers separated by a dash.  Multiple register ranges can be
19060 specified separated by a comma.
19062 @item -mtls-size=@var{tls-size}
19063 @opindex mtls-size
19064 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19067 @item -mtune=@var{cpu-type}
19068 @opindex mtune
19069 Tune the instruction scheduling for a particular CPU, Valid values are
19070 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19071 and @samp{mckinley}.
19073 @item -milp32
19074 @itemx -mlp64
19075 @opindex milp32
19076 @opindex mlp64
19077 Generate code for a 32-bit or 64-bit environment.
19078 The 32-bit environment sets int, long and pointer to 32 bits.
19079 The 64-bit environment sets int to 32 bits and long and pointer
19080 to 64 bits.  These are HP-UX specific flags.
19082 @item -mno-sched-br-data-spec
19083 @itemx -msched-br-data-spec
19084 @opindex mno-sched-br-data-spec
19085 @opindex msched-br-data-spec
19086 (Dis/En)able data speculative scheduling before reload.
19087 This results in generation of @code{ld.a} instructions and
19088 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19089 The default setting is disabled.
19091 @item -msched-ar-data-spec
19092 @itemx -mno-sched-ar-data-spec
19093 @opindex msched-ar-data-spec
19094 @opindex mno-sched-ar-data-spec
19095 (En/Dis)able data speculative scheduling after reload.
19096 This results in generation of @code{ld.a} instructions and
19097 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19098 The default setting is enabled.
19100 @item -mno-sched-control-spec
19101 @itemx -msched-control-spec
19102 @opindex mno-sched-control-spec
19103 @opindex msched-control-spec
19104 (Dis/En)able control speculative scheduling.  This feature is
19105 available only during region scheduling (i.e.@: before reload).
19106 This results in generation of the @code{ld.s} instructions and
19107 the corresponding check instructions @code{chk.s}.
19108 The default setting is disabled.
19110 @item -msched-br-in-data-spec
19111 @itemx -mno-sched-br-in-data-spec
19112 @opindex msched-br-in-data-spec
19113 @opindex mno-sched-br-in-data-spec
19114 (En/Dis)able speculative scheduling of the instructions that
19115 are dependent on the data speculative loads before reload.
19116 This is effective only with @option{-msched-br-data-spec} enabled.
19117 The default setting is enabled.
19119 @item -msched-ar-in-data-spec
19120 @itemx -mno-sched-ar-in-data-spec
19121 @opindex msched-ar-in-data-spec
19122 @opindex mno-sched-ar-in-data-spec
19123 (En/Dis)able speculative scheduling of the instructions that
19124 are dependent on the data speculative loads after reload.
19125 This is effective only with @option{-msched-ar-data-spec} enabled.
19126 The default setting is enabled.
19128 @item -msched-in-control-spec
19129 @itemx -mno-sched-in-control-spec
19130 @opindex msched-in-control-spec
19131 @opindex mno-sched-in-control-spec
19132 (En/Dis)able speculative scheduling of the instructions that
19133 are dependent on the control speculative loads.
19134 This is effective only with @option{-msched-control-spec} enabled.
19135 The default setting is enabled.
19137 @item -mno-sched-prefer-non-data-spec-insns
19138 @itemx -msched-prefer-non-data-spec-insns
19139 @opindex mno-sched-prefer-non-data-spec-insns
19140 @opindex msched-prefer-non-data-spec-insns
19141 If enabled, data-speculative instructions are chosen for schedule
19142 only if there are no other choices at the moment.  This makes
19143 the use of the data speculation much more conservative.
19144 The default setting is disabled.
19146 @item -mno-sched-prefer-non-control-spec-insns
19147 @itemx -msched-prefer-non-control-spec-insns
19148 @opindex mno-sched-prefer-non-control-spec-insns
19149 @opindex msched-prefer-non-control-spec-insns
19150 If enabled, control-speculative instructions are chosen for schedule
19151 only if there are no other choices at the moment.  This makes
19152 the use of the control speculation much more conservative.
19153 The default setting is disabled.
19155 @item -mno-sched-count-spec-in-critical-path
19156 @itemx -msched-count-spec-in-critical-path
19157 @opindex mno-sched-count-spec-in-critical-path
19158 @opindex msched-count-spec-in-critical-path
19159 If enabled, speculative dependencies are considered during
19160 computation of the instructions priorities.  This makes the use of the
19161 speculation a bit more conservative.
19162 The default setting is disabled.
19164 @item -msched-spec-ldc
19165 @opindex msched-spec-ldc
19166 Use a simple data speculation check.  This option is on by default.
19168 @item -msched-control-spec-ldc
19169 @opindex msched-spec-ldc
19170 Use a simple check for control speculation.  This option is on by default.
19172 @item -msched-stop-bits-after-every-cycle
19173 @opindex msched-stop-bits-after-every-cycle
19174 Place a stop bit after every cycle when scheduling.  This option is on
19175 by default.
19177 @item -msched-fp-mem-deps-zero-cost
19178 @opindex msched-fp-mem-deps-zero-cost
19179 Assume that floating-point stores and loads are not likely to cause a conflict
19180 when placed into the same instruction group.  This option is disabled by
19181 default.
19183 @item -msel-sched-dont-check-control-spec
19184 @opindex msel-sched-dont-check-control-spec
19185 Generate checks for control speculation in selective scheduling.
19186 This flag is disabled by default.
19188 @item -msched-max-memory-insns=@var{max-insns}
19189 @opindex msched-max-memory-insns
19190 Limit on the number of memory insns per instruction group, giving lower
19191 priority to subsequent memory insns attempting to schedule in the same
19192 instruction group. Frequently useful to prevent cache bank conflicts.
19193 The default value is 1.
19195 @item -msched-max-memory-insns-hard-limit
19196 @opindex msched-max-memory-insns-hard-limit
19197 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19198 disallowing more than that number in an instruction group.
19199 Otherwise, the limit is ``soft'', meaning that non-memory operations
19200 are preferred when the limit is reached, but memory operations may still
19201 be scheduled.
19203 @end table
19205 @node LM32 Options
19206 @subsection LM32 Options
19207 @cindex LM32 options
19209 These @option{-m} options are defined for the LatticeMico32 architecture:
19211 @table @gcctabopt
19212 @item -mbarrel-shift-enabled
19213 @opindex mbarrel-shift-enabled
19214 Enable barrel-shift instructions.
19216 @item -mdivide-enabled
19217 @opindex mdivide-enabled
19218 Enable divide and modulus instructions.
19220 @item -mmultiply-enabled
19221 @opindex multiply-enabled
19222 Enable multiply instructions.
19224 @item -msign-extend-enabled
19225 @opindex msign-extend-enabled
19226 Enable sign extend instructions.
19228 @item -muser-enabled
19229 @opindex muser-enabled
19230 Enable user-defined instructions.
19232 @end table
19234 @node M32C Options
19235 @subsection M32C Options
19236 @cindex M32C options
19238 @table @gcctabopt
19239 @item -mcpu=@var{name}
19240 @opindex mcpu=
19241 Select the CPU for which code is generated.  @var{name} may be one of
19242 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19243 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19244 the M32C/80 series.
19246 @item -msim
19247 @opindex msim
19248 Specifies that the program will be run on the simulator.  This causes
19249 an alternate runtime library to be linked in which supports, for
19250 example, file I/O@.  You must not use this option when generating
19251 programs that will run on real hardware; you must provide your own
19252 runtime library for whatever I/O functions are needed.
19254 @item -memregs=@var{number}
19255 @opindex memregs=
19256 Specifies the number of memory-based pseudo-registers GCC uses
19257 during code generation.  These pseudo-registers are used like real
19258 registers, so there is a tradeoff between GCC's ability to fit the
19259 code into available registers, and the performance penalty of using
19260 memory instead of registers.  Note that all modules in a program must
19261 be compiled with the same value for this option.  Because of that, you
19262 must not use this option with GCC's default runtime libraries.
19264 @end table
19266 @node M32R/D Options
19267 @subsection M32R/D Options
19268 @cindex M32R/D options
19270 These @option{-m} options are defined for Renesas M32R/D architectures:
19272 @table @gcctabopt
19273 @item -m32r2
19274 @opindex m32r2
19275 Generate code for the M32R/2@.
19277 @item -m32rx
19278 @opindex m32rx
19279 Generate code for the M32R/X@.
19281 @item -m32r
19282 @opindex m32r
19283 Generate code for the M32R@.  This is the default.
19285 @item -mmodel=small
19286 @opindex mmodel=small
19287 Assume all objects live in the lower 16MB of memory (so that their addresses
19288 can be loaded with the @code{ld24} instruction), and assume all subroutines
19289 are reachable with the @code{bl} instruction.
19290 This is the default.
19292 The addressability of a particular object can be set with the
19293 @code{model} attribute.
19295 @item -mmodel=medium
19296 @opindex mmodel=medium
19297 Assume objects may be anywhere in the 32-bit address space (the compiler
19298 generates @code{seth/add3} instructions to load their addresses), and
19299 assume all subroutines are reachable with the @code{bl} instruction.
19301 @item -mmodel=large
19302 @opindex mmodel=large
19303 Assume objects may be anywhere in the 32-bit address space (the compiler
19304 generates @code{seth/add3} instructions to load their addresses), and
19305 assume subroutines may not be reachable with the @code{bl} instruction
19306 (the compiler generates the much slower @code{seth/add3/jl}
19307 instruction sequence).
19309 @item -msdata=none
19310 @opindex msdata=none
19311 Disable use of the small data area.  Variables are put into
19312 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19313 @code{section} attribute has been specified).
19314 This is the default.
19316 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19317 Objects may be explicitly put in the small data area with the
19318 @code{section} attribute using one of these sections.
19320 @item -msdata=sdata
19321 @opindex msdata=sdata
19322 Put small global and static data in the small data area, but do not
19323 generate special code to reference them.
19325 @item -msdata=use
19326 @opindex msdata=use
19327 Put small global and static data in the small data area, and generate
19328 special instructions to reference them.
19330 @item -G @var{num}
19331 @opindex G
19332 @cindex smaller data references
19333 Put global and static objects less than or equal to @var{num} bytes
19334 into the small data or BSS sections instead of the normal data or BSS
19335 sections.  The default value of @var{num} is 8.
19336 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19337 for this option to have any effect.
19339 All modules should be compiled with the same @option{-G @var{num}} value.
19340 Compiling with different values of @var{num} may or may not work; if it
19341 doesn't the linker gives an error message---incorrect code is not
19342 generated.
19344 @item -mdebug
19345 @opindex mdebug
19346 Makes the M32R-specific code in the compiler display some statistics
19347 that might help in debugging programs.
19349 @item -malign-loops
19350 @opindex malign-loops
19351 Align all loops to a 32-byte boundary.
19353 @item -mno-align-loops
19354 @opindex mno-align-loops
19355 Do not enforce a 32-byte alignment for loops.  This is the default.
19357 @item -missue-rate=@var{number}
19358 @opindex missue-rate=@var{number}
19359 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19360 or 2.
19362 @item -mbranch-cost=@var{number}
19363 @opindex mbranch-cost=@var{number}
19364 @var{number} can only be 1 or 2.  If it is 1 then branches are
19365 preferred over conditional code, if it is 2, then the opposite applies.
19367 @item -mflush-trap=@var{number}
19368 @opindex mflush-trap=@var{number}
19369 Specifies the trap number to use to flush the cache.  The default is
19370 12.  Valid numbers are between 0 and 15 inclusive.
19372 @item -mno-flush-trap
19373 @opindex mno-flush-trap
19374 Specifies that the cache cannot be flushed by using a trap.
19376 @item -mflush-func=@var{name}
19377 @opindex mflush-func=@var{name}
19378 Specifies the name of the operating system function to call to flush
19379 the cache.  The default is @samp{_flush_cache}, but a function call
19380 is only used if a trap is not available.
19382 @item -mno-flush-func
19383 @opindex mno-flush-func
19384 Indicates that there is no OS function for flushing the cache.
19386 @end table
19388 @node M680x0 Options
19389 @subsection M680x0 Options
19390 @cindex M680x0 options
19392 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19393 The default settings depend on which architecture was selected when
19394 the compiler was configured; the defaults for the most common choices
19395 are given below.
19397 @table @gcctabopt
19398 @item -march=@var{arch}
19399 @opindex march
19400 Generate code for a specific M680x0 or ColdFire instruction set
19401 architecture.  Permissible values of @var{arch} for M680x0
19402 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19403 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19404 architectures are selected according to Freescale's ISA classification
19405 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19406 @samp{isab} and @samp{isac}.
19408 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19409 code for a ColdFire target.  The @var{arch} in this macro is one of the
19410 @option{-march} arguments given above.
19412 When used together, @option{-march} and @option{-mtune} select code
19413 that runs on a family of similar processors but that is optimized
19414 for a particular microarchitecture.
19416 @item -mcpu=@var{cpu}
19417 @opindex mcpu
19418 Generate code for a specific M680x0 or ColdFire processor.
19419 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19420 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19421 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19422 below, which also classifies the CPUs into families:
19424 @multitable @columnfractions 0.20 0.80
19425 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19426 @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}
19427 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19428 @item @samp{5206e} @tab @samp{5206e}
19429 @item @samp{5208} @tab @samp{5207} @samp{5208}
19430 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19431 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19432 @item @samp{5216} @tab @samp{5214} @samp{5216}
19433 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19434 @item @samp{5225} @tab @samp{5224} @samp{5225}
19435 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19436 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19437 @item @samp{5249} @tab @samp{5249}
19438 @item @samp{5250} @tab @samp{5250}
19439 @item @samp{5271} @tab @samp{5270} @samp{5271}
19440 @item @samp{5272} @tab @samp{5272}
19441 @item @samp{5275} @tab @samp{5274} @samp{5275}
19442 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19443 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19444 @item @samp{5307} @tab @samp{5307}
19445 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19446 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19447 @item @samp{5407} @tab @samp{5407}
19448 @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}
19449 @end multitable
19451 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19452 @var{arch} is compatible with @var{cpu}.  Other combinations of
19453 @option{-mcpu} and @option{-march} are rejected.
19455 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19456 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19457 where the value of @var{family} is given by the table above.
19459 @item -mtune=@var{tune}
19460 @opindex mtune
19461 Tune the code for a particular microarchitecture within the
19462 constraints set by @option{-march} and @option{-mcpu}.
19463 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19464 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19465 and @samp{cpu32}.  The ColdFire microarchitectures
19466 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19468 You can also use @option{-mtune=68020-40} for code that needs
19469 to run relatively well on 68020, 68030 and 68040 targets.
19470 @option{-mtune=68020-60} is similar but includes 68060 targets
19471 as well.  These two options select the same tuning decisions as
19472 @option{-m68020-40} and @option{-m68020-60} respectively.
19474 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19475 when tuning for 680x0 architecture @var{arch}.  It also defines
19476 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19477 option is used.  If GCC is tuning for a range of architectures,
19478 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19479 it defines the macros for every architecture in the range.
19481 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19482 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19483 of the arguments given above.
19485 @item -m68000
19486 @itemx -mc68000
19487 @opindex m68000
19488 @opindex mc68000
19489 Generate output for a 68000.  This is the default
19490 when the compiler is configured for 68000-based systems.
19491 It is equivalent to @option{-march=68000}.
19493 Use this option for microcontrollers with a 68000 or EC000 core,
19494 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19496 @item -m68010
19497 @opindex m68010
19498 Generate output for a 68010.  This is the default
19499 when the compiler is configured for 68010-based systems.
19500 It is equivalent to @option{-march=68010}.
19502 @item -m68020
19503 @itemx -mc68020
19504 @opindex m68020
19505 @opindex mc68020
19506 Generate output for a 68020.  This is the default
19507 when the compiler is configured for 68020-based systems.
19508 It is equivalent to @option{-march=68020}.
19510 @item -m68030
19511 @opindex m68030
19512 Generate output for a 68030.  This is the default when the compiler is
19513 configured for 68030-based systems.  It is equivalent to
19514 @option{-march=68030}.
19516 @item -m68040
19517 @opindex m68040
19518 Generate output for a 68040.  This is the default when the compiler is
19519 configured for 68040-based systems.  It is equivalent to
19520 @option{-march=68040}.
19522 This option inhibits the use of 68881/68882 instructions that have to be
19523 emulated by software on the 68040.  Use this option if your 68040 does not
19524 have code to emulate those instructions.
19526 @item -m68060
19527 @opindex m68060
19528 Generate output for a 68060.  This is the default when the compiler is
19529 configured for 68060-based systems.  It is equivalent to
19530 @option{-march=68060}.
19532 This option inhibits the use of 68020 and 68881/68882 instructions that
19533 have to be emulated by software on the 68060.  Use this option if your 68060
19534 does not have code to emulate those instructions.
19536 @item -mcpu32
19537 @opindex mcpu32
19538 Generate output for a CPU32.  This is the default
19539 when the compiler is configured for CPU32-based systems.
19540 It is equivalent to @option{-march=cpu32}.
19542 Use this option for microcontrollers with a
19543 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19544 68336, 68340, 68341, 68349 and 68360.
19546 @item -m5200
19547 @opindex m5200
19548 Generate output for a 520X ColdFire CPU@.  This is the default
19549 when the compiler is configured for 520X-based systems.
19550 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19551 in favor of that option.
19553 Use this option for microcontroller with a 5200 core, including
19554 the MCF5202, MCF5203, MCF5204 and MCF5206.
19556 @item -m5206e
19557 @opindex m5206e
19558 Generate output for a 5206e ColdFire CPU@.  The option is now
19559 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19561 @item -m528x
19562 @opindex m528x
19563 Generate output for a member of the ColdFire 528X family.
19564 The option is now deprecated in favor of the equivalent
19565 @option{-mcpu=528x}.
19567 @item -m5307
19568 @opindex m5307
19569 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19570 in favor of the equivalent @option{-mcpu=5307}.
19572 @item -m5407
19573 @opindex m5407
19574 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19575 in favor of the equivalent @option{-mcpu=5407}.
19577 @item -mcfv4e
19578 @opindex mcfv4e
19579 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19580 This includes use of hardware floating-point instructions.
19581 The option is equivalent to @option{-mcpu=547x}, and is now
19582 deprecated in favor of that option.
19584 @item -m68020-40
19585 @opindex m68020-40
19586 Generate output for a 68040, without using any of the new instructions.
19587 This results in code that can run relatively efficiently on either a
19588 68020/68881 or a 68030 or a 68040.  The generated code does use the
19589 68881 instructions that are emulated on the 68040.
19591 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19593 @item -m68020-60
19594 @opindex m68020-60
19595 Generate output for a 68060, without using any of the new instructions.
19596 This results in code that can run relatively efficiently on either a
19597 68020/68881 or a 68030 or a 68040.  The generated code does use the
19598 68881 instructions that are emulated on the 68060.
19600 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19602 @item -mhard-float
19603 @itemx -m68881
19604 @opindex mhard-float
19605 @opindex m68881
19606 Generate floating-point instructions.  This is the default for 68020
19607 and above, and for ColdFire devices that have an FPU@.  It defines the
19608 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19609 on ColdFire targets.
19611 @item -msoft-float
19612 @opindex msoft-float
19613 Do not generate floating-point instructions; use library calls instead.
19614 This is the default for 68000, 68010, and 68832 targets.  It is also
19615 the default for ColdFire devices that have no FPU.
19617 @item -mdiv
19618 @itemx -mno-div
19619 @opindex mdiv
19620 @opindex mno-div
19621 Generate (do not generate) ColdFire hardware divide and remainder
19622 instructions.  If @option{-march} is used without @option{-mcpu},
19623 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19624 architectures.  Otherwise, the default is taken from the target CPU
19625 (either the default CPU, or the one specified by @option{-mcpu}).  For
19626 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19627 @option{-mcpu=5206e}.
19629 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19631 @item -mshort
19632 @opindex mshort
19633 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19634 Additionally, parameters passed on the stack are also aligned to a
19635 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19637 @item -mno-short
19638 @opindex mno-short
19639 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19641 @item -mnobitfield
19642 @itemx -mno-bitfield
19643 @opindex mnobitfield
19644 @opindex mno-bitfield
19645 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19646 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19648 @item -mbitfield
19649 @opindex mbitfield
19650 Do use the bit-field instructions.  The @option{-m68020} option implies
19651 @option{-mbitfield}.  This is the default if you use a configuration
19652 designed for a 68020.
19654 @item -mrtd
19655 @opindex mrtd
19656 Use a different function-calling convention, in which functions
19657 that take a fixed number of arguments return with the @code{rtd}
19658 instruction, which pops their arguments while returning.  This
19659 saves one instruction in the caller since there is no need to pop
19660 the arguments there.
19662 This calling convention is incompatible with the one normally
19663 used on Unix, so you cannot use it if you need to call libraries
19664 compiled with the Unix compiler.
19666 Also, you must provide function prototypes for all functions that
19667 take variable numbers of arguments (including @code{printf});
19668 otherwise incorrect code is generated for calls to those
19669 functions.
19671 In addition, seriously incorrect code results if you call a
19672 function with too many arguments.  (Normally, extra arguments are
19673 harmlessly ignored.)
19675 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19676 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19678 @item -mno-rtd
19679 @opindex mno-rtd
19680 Do not use the calling conventions selected by @option{-mrtd}.
19681 This is the default.
19683 @item -malign-int
19684 @itemx -mno-align-int
19685 @opindex malign-int
19686 @opindex mno-align-int
19687 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19688 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19689 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19690 Aligning variables on 32-bit boundaries produces code that runs somewhat
19691 faster on processors with 32-bit busses at the expense of more memory.
19693 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19694 aligns structures containing the above types differently than
19695 most published application binary interface specifications for the m68k.
19697 @item -mpcrel
19698 @opindex mpcrel
19699 Use the pc-relative addressing mode of the 68000 directly, instead of
19700 using a global offset table.  At present, this option implies @option{-fpic},
19701 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19702 not presently supported with @option{-mpcrel}, though this could be supported for
19703 68020 and higher processors.
19705 @item -mno-strict-align
19706 @itemx -mstrict-align
19707 @opindex mno-strict-align
19708 @opindex mstrict-align
19709 Do not (do) assume that unaligned memory references are handled by
19710 the system.
19712 @item -msep-data
19713 Generate code that allows the data segment to be located in a different
19714 area of memory from the text segment.  This allows for execute-in-place in
19715 an environment without virtual memory management.  This option implies
19716 @option{-fPIC}.
19718 @item -mno-sep-data
19719 Generate code that assumes that the data segment follows the text segment.
19720 This is the default.
19722 @item -mid-shared-library
19723 Generate code that supports shared libraries via the library ID method.
19724 This allows for execute-in-place and shared libraries in an environment
19725 without virtual memory management.  This option implies @option{-fPIC}.
19727 @item -mno-id-shared-library
19728 Generate code that doesn't assume ID-based shared libraries are being used.
19729 This is the default.
19731 @item -mshared-library-id=n
19732 Specifies the identification number of the ID-based shared library being
19733 compiled.  Specifying a value of 0 generates more compact code; specifying
19734 other values forces the allocation of that number to the current
19735 library, but is no more space- or time-efficient than omitting this option.
19737 @item -mxgot
19738 @itemx -mno-xgot
19739 @opindex mxgot
19740 @opindex mno-xgot
19741 When generating position-independent code for ColdFire, generate code
19742 that works if the GOT has more than 8192 entries.  This code is
19743 larger and slower than code generated without this option.  On M680x0
19744 processors, this option is not needed; @option{-fPIC} suffices.
19746 GCC normally uses a single instruction to load values from the GOT@.
19747 While this is relatively efficient, it only works if the GOT
19748 is smaller than about 64k.  Anything larger causes the linker
19749 to report an error such as:
19751 @cindex relocation truncated to fit (ColdFire)
19752 @smallexample
19753 relocation truncated to fit: R_68K_GOT16O foobar
19754 @end smallexample
19756 If this happens, you should recompile your code with @option{-mxgot}.
19757 It should then work with very large GOTs.  However, code generated with
19758 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19759 the value of a global symbol.
19761 Note that some linkers, including newer versions of the GNU linker,
19762 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19763 you should only need to use @option{-mxgot} when compiling a single
19764 object file that accesses more than 8192 GOT entries.  Very few do.
19766 These options have no effect unless GCC is generating
19767 position-independent code.
19769 @item -mlong-jump-table-offsets
19770 @opindex mlong-jump-table-offsets
19771 Use 32-bit offsets in @code{switch} tables.  The default is to use
19772 16-bit offsets.
19774 @end table
19776 @node MCore Options
19777 @subsection MCore Options
19778 @cindex MCore options
19780 These are the @samp{-m} options defined for the Motorola M*Core
19781 processors.
19783 @table @gcctabopt
19785 @item -mhardlit
19786 @itemx -mno-hardlit
19787 @opindex mhardlit
19788 @opindex mno-hardlit
19789 Inline constants into the code stream if it can be done in two
19790 instructions or less.
19792 @item -mdiv
19793 @itemx -mno-div
19794 @opindex mdiv
19795 @opindex mno-div
19796 Use the divide instruction.  (Enabled by default).
19798 @item -mrelax-immediate
19799 @itemx -mno-relax-immediate
19800 @opindex mrelax-immediate
19801 @opindex mno-relax-immediate
19802 Allow arbitrary-sized immediates in bit operations.
19804 @item -mwide-bitfields
19805 @itemx -mno-wide-bitfields
19806 @opindex mwide-bitfields
19807 @opindex mno-wide-bitfields
19808 Always treat bit-fields as @code{int}-sized.
19810 @item -m4byte-functions
19811 @itemx -mno-4byte-functions
19812 @opindex m4byte-functions
19813 @opindex mno-4byte-functions
19814 Force all functions to be aligned to a 4-byte boundary.
19816 @item -mcallgraph-data
19817 @itemx -mno-callgraph-data
19818 @opindex mcallgraph-data
19819 @opindex mno-callgraph-data
19820 Emit callgraph information.
19822 @item -mslow-bytes
19823 @itemx -mno-slow-bytes
19824 @opindex mslow-bytes
19825 @opindex mno-slow-bytes
19826 Prefer word access when reading byte quantities.
19828 @item -mlittle-endian
19829 @itemx -mbig-endian
19830 @opindex mlittle-endian
19831 @opindex mbig-endian
19832 Generate code for a little-endian target.
19834 @item -m210
19835 @itemx -m340
19836 @opindex m210
19837 @opindex m340
19838 Generate code for the 210 processor.
19840 @item -mno-lsim
19841 @opindex mno-lsim
19842 Assume that runtime support has been provided and so omit the
19843 simulator library (@file{libsim.a)} from the linker command line.
19845 @item -mstack-increment=@var{size}
19846 @opindex mstack-increment
19847 Set the maximum amount for a single stack increment operation.  Large
19848 values can increase the speed of programs that contain functions
19849 that need a large amount of stack space, but they can also trigger a
19850 segmentation fault if the stack is extended too much.  The default
19851 value is 0x1000.
19853 @end table
19855 @node MeP Options
19856 @subsection MeP Options
19857 @cindex MeP options
19859 @table @gcctabopt
19861 @item -mabsdiff
19862 @opindex mabsdiff
19863 Enables the @code{abs} instruction, which is the absolute difference
19864 between two registers.
19866 @item -mall-opts
19867 @opindex mall-opts
19868 Enables all the optional instructions---average, multiply, divide, bit
19869 operations, leading zero, absolute difference, min/max, clip, and
19870 saturation.
19873 @item -maverage
19874 @opindex maverage
19875 Enables the @code{ave} instruction, which computes the average of two
19876 registers.
19878 @item -mbased=@var{n}
19879 @opindex mbased=
19880 Variables of size @var{n} bytes or smaller are placed in the
19881 @code{.based} section by default.  Based variables use the @code{$tp}
19882 register as a base register, and there is a 128-byte limit to the
19883 @code{.based} section.
19885 @item -mbitops
19886 @opindex mbitops
19887 Enables the bit operation instructions---bit test (@code{btstm}), set
19888 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19889 test-and-set (@code{tas}).
19891 @item -mc=@var{name}
19892 @opindex mc=
19893 Selects which section constant data is placed in.  @var{name} may
19894 be @samp{tiny}, @samp{near}, or @samp{far}.
19896 @item -mclip
19897 @opindex mclip
19898 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19899 useful unless you also provide @option{-mminmax}.
19901 @item -mconfig=@var{name}
19902 @opindex mconfig=
19903 Selects one of the built-in core configurations.  Each MeP chip has
19904 one or more modules in it; each module has a core CPU and a variety of
19905 coprocessors, optional instructions, and peripherals.  The
19906 @code{MeP-Integrator} tool, not part of GCC, provides these
19907 configurations through this option; using this option is the same as
19908 using all the corresponding command-line options.  The default
19909 configuration is @samp{default}.
19911 @item -mcop
19912 @opindex mcop
19913 Enables the coprocessor instructions.  By default, this is a 32-bit
19914 coprocessor.  Note that the coprocessor is normally enabled via the
19915 @option{-mconfig=} option.
19917 @item -mcop32
19918 @opindex mcop32
19919 Enables the 32-bit coprocessor's instructions.
19921 @item -mcop64
19922 @opindex mcop64
19923 Enables the 64-bit coprocessor's instructions.
19925 @item -mivc2
19926 @opindex mivc2
19927 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19929 @item -mdc
19930 @opindex mdc
19931 Causes constant variables to be placed in the @code{.near} section.
19933 @item -mdiv
19934 @opindex mdiv
19935 Enables the @code{div} and @code{divu} instructions.
19937 @item -meb
19938 @opindex meb
19939 Generate big-endian code.
19941 @item -mel
19942 @opindex mel
19943 Generate little-endian code.
19945 @item -mio-volatile
19946 @opindex mio-volatile
19947 Tells the compiler that any variable marked with the @code{io}
19948 attribute is to be considered volatile.
19950 @item -ml
19951 @opindex ml
19952 Causes variables to be assigned to the @code{.far} section by default.
19954 @item -mleadz
19955 @opindex mleadz
19956 Enables the @code{leadz} (leading zero) instruction.
19958 @item -mm
19959 @opindex mm
19960 Causes variables to be assigned to the @code{.near} section by default.
19962 @item -mminmax
19963 @opindex mminmax
19964 Enables the @code{min} and @code{max} instructions.
19966 @item -mmult
19967 @opindex mmult
19968 Enables the multiplication and multiply-accumulate instructions.
19970 @item -mno-opts
19971 @opindex mno-opts
19972 Disables all the optional instructions enabled by @option{-mall-opts}.
19974 @item -mrepeat
19975 @opindex mrepeat
19976 Enables the @code{repeat} and @code{erepeat} instructions, used for
19977 low-overhead looping.
19979 @item -ms
19980 @opindex ms
19981 Causes all variables to default to the @code{.tiny} section.  Note
19982 that there is a 65536-byte limit to this section.  Accesses to these
19983 variables use the @code{%gp} base register.
19985 @item -msatur
19986 @opindex msatur
19987 Enables the saturation instructions.  Note that the compiler does not
19988 currently generate these itself, but this option is included for
19989 compatibility with other tools, like @code{as}.
19991 @item -msdram
19992 @opindex msdram
19993 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19995 @item -msim
19996 @opindex msim
19997 Link the simulator run-time libraries.
19999 @item -msimnovec
20000 @opindex msimnovec
20001 Link the simulator runtime libraries, excluding built-in support
20002 for reset and exception vectors and tables.
20004 @item -mtf
20005 @opindex mtf
20006 Causes all functions to default to the @code{.far} section.  Without
20007 this option, functions default to the @code{.near} section.
20009 @item -mtiny=@var{n}
20010 @opindex mtiny=
20011 Variables that are @var{n} bytes or smaller are allocated to the
20012 @code{.tiny} section.  These variables use the @code{$gp} base
20013 register.  The default for this option is 4, but note that there's a
20014 65536-byte limit to the @code{.tiny} section.
20016 @end table
20018 @node MicroBlaze Options
20019 @subsection MicroBlaze Options
20020 @cindex MicroBlaze Options
20022 @table @gcctabopt
20024 @item -msoft-float
20025 @opindex msoft-float
20026 Use software emulation for floating point (default).
20028 @item -mhard-float
20029 @opindex mhard-float
20030 Use hardware floating-point instructions.
20032 @item -mmemcpy
20033 @opindex mmemcpy
20034 Do not optimize block moves, use @code{memcpy}.
20036 @item -mno-clearbss
20037 @opindex mno-clearbss
20038 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20040 @item -mcpu=@var{cpu-type}
20041 @opindex mcpu=
20042 Use features of, and schedule code for, the given CPU.
20043 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20044 where @var{X} is a major version, @var{YY} is the minor version, and
20045 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20046 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20048 @item -mxl-soft-mul
20049 @opindex mxl-soft-mul
20050 Use software multiply emulation (default).
20052 @item -mxl-soft-div
20053 @opindex mxl-soft-div
20054 Use software emulation for divides (default).
20056 @item -mxl-barrel-shift
20057 @opindex mxl-barrel-shift
20058 Use the hardware barrel shifter.
20060 @item -mxl-pattern-compare
20061 @opindex mxl-pattern-compare
20062 Use pattern compare instructions.
20064 @item -msmall-divides
20065 @opindex msmall-divides
20066 Use table lookup optimization for small signed integer divisions.
20068 @item -mxl-stack-check
20069 @opindex mxl-stack-check
20070 This option is deprecated.  Use @option{-fstack-check} instead.
20072 @item -mxl-gp-opt
20073 @opindex mxl-gp-opt
20074 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20076 @item -mxl-multiply-high
20077 @opindex mxl-multiply-high
20078 Use multiply high instructions for high part of 32x32 multiply.
20080 @item -mxl-float-convert
20081 @opindex mxl-float-convert
20082 Use hardware floating-point conversion instructions.
20084 @item -mxl-float-sqrt
20085 @opindex mxl-float-sqrt
20086 Use hardware floating-point square root instruction.
20088 @item -mbig-endian
20089 @opindex mbig-endian
20090 Generate code for a big-endian target.
20092 @item -mlittle-endian
20093 @opindex mlittle-endian
20094 Generate code for a little-endian target.
20096 @item -mxl-reorder
20097 @opindex mxl-reorder
20098 Use reorder instructions (swap and byte reversed load/store).
20100 @item -mxl-mode-@var{app-model}
20101 Select application model @var{app-model}.  Valid models are
20102 @table @samp
20103 @item executable
20104 normal executable (default), uses startup code @file{crt0.o}.
20106 @item xmdstub
20107 for use with Xilinx Microprocessor Debugger (XMD) based
20108 software intrusive debug agent called xmdstub. This uses startup file
20109 @file{crt1.o} and sets the start address of the program to 0x800.
20111 @item bootstrap
20112 for applications that are loaded using a bootloader.
20113 This model uses startup file @file{crt2.o} which does not contain a processor
20114 reset vector handler. This is suitable for transferring control on a
20115 processor reset to the bootloader rather than the application.
20117 @item novectors
20118 for applications that do not require any of the
20119 MicroBlaze vectors. This option may be useful for applications running
20120 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20121 @end table
20123 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20124 @option{-mxl-mode-@var{app-model}}.
20126 @end table
20128 @node MIPS Options
20129 @subsection MIPS Options
20130 @cindex MIPS options
20132 @table @gcctabopt
20134 @item -EB
20135 @opindex EB
20136 Generate big-endian code.
20138 @item -EL
20139 @opindex EL
20140 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20141 configurations.
20143 @item -march=@var{arch}
20144 @opindex march
20145 Generate code that runs on @var{arch}, which can be the name of a
20146 generic MIPS ISA, or the name of a particular processor.
20147 The ISA names are:
20148 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20149 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20150 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20151 @samp{mips64r5} and @samp{mips64r6}.
20152 The processor names are:
20153 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20154 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20155 @samp{5kc}, @samp{5kf},
20156 @samp{20kc},
20157 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20158 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20159 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20160 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20161 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20162 @samp{i6400},
20163 @samp{interaptiv},
20164 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20165 @samp{m4k},
20166 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20167 @samp{m5100}, @samp{m5101},
20168 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20169 @samp{orion},
20170 @samp{p5600},
20171 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20172 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20173 @samp{rm7000}, @samp{rm9000},
20174 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20175 @samp{sb1},
20176 @samp{sr71000},
20177 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20178 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20179 @samp{xlr} and @samp{xlp}.
20180 The special value @samp{from-abi} selects the
20181 most compatible architecture for the selected ABI (that is,
20182 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20184 The native Linux/GNU toolchain also supports the value @samp{native},
20185 which selects the best architecture option for the host processor.
20186 @option{-march=native} has no effect if GCC does not recognize
20187 the processor.
20189 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20190 (for example, @option{-march=r2k}).  Prefixes are optional, and
20191 @samp{vr} may be written @samp{r}.
20193 Names of the form @samp{@var{n}f2_1} refer to processors with
20194 FPUs clocked at half the rate of the core, names of the form
20195 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20196 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20197 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20198 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20199 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20200 accepted as synonyms for @samp{@var{n}f1_1}.
20202 GCC defines two macros based on the value of this option.  The first
20203 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20204 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20205 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20206 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20207 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20209 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20210 above.  In other words, it has the full prefix and does not
20211 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20212 the macro names the resolved architecture (either @code{"mips1"} or
20213 @code{"mips3"}).  It names the default architecture when no
20214 @option{-march} option is given.
20216 @item -mtune=@var{arch}
20217 @opindex mtune
20218 Optimize for @var{arch}.  Among other things, this option controls
20219 the way instructions are scheduled, and the perceived cost of arithmetic
20220 operations.  The list of @var{arch} values is the same as for
20221 @option{-march}.
20223 When this option is not used, GCC optimizes for the processor
20224 specified by @option{-march}.  By using @option{-march} and
20225 @option{-mtune} together, it is possible to generate code that
20226 runs on a family of processors, but optimize the code for one
20227 particular member of that family.
20229 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20230 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20231 @option{-march} ones described above.
20233 @item -mips1
20234 @opindex mips1
20235 Equivalent to @option{-march=mips1}.
20237 @item -mips2
20238 @opindex mips2
20239 Equivalent to @option{-march=mips2}.
20241 @item -mips3
20242 @opindex mips3
20243 Equivalent to @option{-march=mips3}.
20245 @item -mips4
20246 @opindex mips4
20247 Equivalent to @option{-march=mips4}.
20249 @item -mips32
20250 @opindex mips32
20251 Equivalent to @option{-march=mips32}.
20253 @item -mips32r3
20254 @opindex mips32r3
20255 Equivalent to @option{-march=mips32r3}.
20257 @item -mips32r5
20258 @opindex mips32r5
20259 Equivalent to @option{-march=mips32r5}.
20261 @item -mips32r6
20262 @opindex mips32r6
20263 Equivalent to @option{-march=mips32r6}.
20265 @item -mips64
20266 @opindex mips64
20267 Equivalent to @option{-march=mips64}.
20269 @item -mips64r2
20270 @opindex mips64r2
20271 Equivalent to @option{-march=mips64r2}.
20273 @item -mips64r3
20274 @opindex mips64r3
20275 Equivalent to @option{-march=mips64r3}.
20277 @item -mips64r5
20278 @opindex mips64r5
20279 Equivalent to @option{-march=mips64r5}.
20281 @item -mips64r6
20282 @opindex mips64r6
20283 Equivalent to @option{-march=mips64r6}.
20285 @item -mips16
20286 @itemx -mno-mips16
20287 @opindex mips16
20288 @opindex mno-mips16
20289 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20290 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20292 MIPS16 code generation can also be controlled on a per-function basis
20293 by means of @code{mips16} and @code{nomips16} attributes.
20294 @xref{Function Attributes}, for more information.
20296 @item -mflip-mips16
20297 @opindex mflip-mips16
20298 Generate MIPS16 code on alternating functions.  This option is provided
20299 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20300 not intended for ordinary use in compiling user code.
20302 @item -minterlink-compressed
20303 @itemx -mno-interlink-compressed
20304 @opindex minterlink-compressed
20305 @opindex mno-interlink-compressed
20306 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20307 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20309 For example, code using the standard ISA encoding cannot jump directly
20310 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20311 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20312 knows that the target of the jump is not compressed.
20314 @item -minterlink-mips16
20315 @itemx -mno-interlink-mips16
20316 @opindex minterlink-mips16
20317 @opindex mno-interlink-mips16
20318 Aliases of @option{-minterlink-compressed} and
20319 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20320 and are retained for backwards compatibility.
20322 @item -mabi=32
20323 @itemx -mabi=o64
20324 @itemx -mabi=n32
20325 @itemx -mabi=64
20326 @itemx -mabi=eabi
20327 @opindex mabi=32
20328 @opindex mabi=o64
20329 @opindex mabi=n32
20330 @opindex mabi=64
20331 @opindex mabi=eabi
20332 Generate code for the given ABI@.
20334 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20335 generates 64-bit code when you select a 64-bit architecture, but you
20336 can use @option{-mgp32} to get 32-bit code instead.
20338 For information about the O64 ABI, see
20339 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20341 GCC supports a variant of the o32 ABI in which floating-point registers
20342 are 64 rather than 32 bits wide.  You can select this combination with
20343 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20344 and @code{mfhc1} instructions and is therefore only supported for
20345 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20347 The register assignments for arguments and return values remain the
20348 same, but each scalar value is passed in a single 64-bit register
20349 rather than a pair of 32-bit registers.  For example, scalar
20350 floating-point values are returned in @samp{$f0} only, not a
20351 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20352 remains the same in that the even-numbered double-precision registers
20353 are saved.
20355 Two additional variants of the o32 ABI are supported to enable
20356 a transition from 32-bit to 64-bit registers.  These are FPXX
20357 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20358 The FPXX extension mandates that all code must execute correctly
20359 when run using 32-bit or 64-bit registers.  The code can be interlinked
20360 with either FP32 or FP64, but not both.
20361 The FP64A extension is similar to the FP64 extension but forbids the
20362 use of odd-numbered single-precision registers.  This can be used
20363 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20364 processors and allows both FP32 and FP64A code to interlink and
20365 run in the same process without changing FPU modes.
20367 @item -mabicalls
20368 @itemx -mno-abicalls
20369 @opindex mabicalls
20370 @opindex mno-abicalls
20371 Generate (do not generate) code that is suitable for SVR4-style
20372 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20373 systems.
20375 @item -mshared
20376 @itemx -mno-shared
20377 Generate (do not generate) code that is fully position-independent,
20378 and that can therefore be linked into shared libraries.  This option
20379 only affects @option{-mabicalls}.
20381 All @option{-mabicalls} code has traditionally been position-independent,
20382 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20383 as an extension, the GNU toolchain allows executables to use absolute
20384 accesses for locally-binding symbols.  It can also use shorter GP
20385 initialization sequences and generate direct calls to locally-defined
20386 functions.  This mode is selected by @option{-mno-shared}.
20388 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20389 objects that can only be linked by the GNU linker.  However, the option
20390 does not affect the ABI of the final executable; it only affects the ABI
20391 of relocatable objects.  Using @option{-mno-shared} generally makes
20392 executables both smaller and quicker.
20394 @option{-mshared} is the default.
20396 @item -mplt
20397 @itemx -mno-plt
20398 @opindex mplt
20399 @opindex mno-plt
20400 Assume (do not assume) that the static and dynamic linkers
20401 support PLTs and copy relocations.  This option only affects
20402 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20403 has no effect without @option{-msym32}.
20405 You can make @option{-mplt} the default by configuring
20406 GCC with @option{--with-mips-plt}.  The default is
20407 @option{-mno-plt} otherwise.
20409 @item -mxgot
20410 @itemx -mno-xgot
20411 @opindex mxgot
20412 @opindex mno-xgot
20413 Lift (do not lift) the usual restrictions on the size of the global
20414 offset table.
20416 GCC normally uses a single instruction to load values from the GOT@.
20417 While this is relatively efficient, it only works if the GOT
20418 is smaller than about 64k.  Anything larger causes the linker
20419 to report an error such as:
20421 @cindex relocation truncated to fit (MIPS)
20422 @smallexample
20423 relocation truncated to fit: R_MIPS_GOT16 foobar
20424 @end smallexample
20426 If this happens, you should recompile your code with @option{-mxgot}.
20427 This works with very large GOTs, although the code is also
20428 less efficient, since it takes three instructions to fetch the
20429 value of a global symbol.
20431 Note that some linkers can create multiple GOTs.  If you have such a
20432 linker, you should only need to use @option{-mxgot} when a single object
20433 file accesses more than 64k's worth of GOT entries.  Very few do.
20435 These options have no effect unless GCC is generating position
20436 independent code.
20438 @item -mgp32
20439 @opindex mgp32
20440 Assume that general-purpose registers are 32 bits wide.
20442 @item -mgp64
20443 @opindex mgp64
20444 Assume that general-purpose registers are 64 bits wide.
20446 @item -mfp32
20447 @opindex mfp32
20448 Assume that floating-point registers are 32 bits wide.
20450 @item -mfp64
20451 @opindex mfp64
20452 Assume that floating-point registers are 64 bits wide.
20454 @item -mfpxx
20455 @opindex mfpxx
20456 Do not assume the width of floating-point registers.
20458 @item -mhard-float
20459 @opindex mhard-float
20460 Use floating-point coprocessor instructions.
20462 @item -msoft-float
20463 @opindex msoft-float
20464 Do not use floating-point coprocessor instructions.  Implement
20465 floating-point calculations using library calls instead.
20467 @item -mno-float
20468 @opindex mno-float
20469 Equivalent to @option{-msoft-float}, but additionally asserts that the
20470 program being compiled does not perform any floating-point operations.
20471 This option is presently supported only by some bare-metal MIPS
20472 configurations, where it may select a special set of libraries
20473 that lack all floating-point support (including, for example, the
20474 floating-point @code{printf} formats).  
20475 If code compiled with @option{-mno-float} accidentally contains
20476 floating-point operations, it is likely to suffer a link-time
20477 or run-time failure.
20479 @item -msingle-float
20480 @opindex msingle-float
20481 Assume that the floating-point coprocessor only supports single-precision
20482 operations.
20484 @item -mdouble-float
20485 @opindex mdouble-float
20486 Assume that the floating-point coprocessor supports double-precision
20487 operations.  This is the default.
20489 @item -modd-spreg
20490 @itemx -mno-odd-spreg
20491 @opindex modd-spreg
20492 @opindex mno-odd-spreg
20493 Enable the use of odd-numbered single-precision floating-point registers
20494 for the o32 ABI.  This is the default for processors that are known to
20495 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20496 is set by default.
20498 @item -mabs=2008
20499 @itemx -mabs=legacy
20500 @opindex mabs=2008
20501 @opindex mabs=legacy
20502 These options control the treatment of the special not-a-number (NaN)
20503 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20504 @code{neg.@i{fmt}} machine instructions.
20506 By default or when @option{-mabs=legacy} is used the legacy
20507 treatment is selected.  In this case these instructions are considered
20508 arithmetic and avoided where correct operation is required and the
20509 input operand might be a NaN.  A longer sequence of instructions that
20510 manipulate the sign bit of floating-point datum manually is used
20511 instead unless the @option{-ffinite-math-only} option has also been
20512 specified.
20514 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20515 this case these instructions are considered non-arithmetic and therefore
20516 operating correctly in all cases, including in particular where the
20517 input operand is a NaN.  These instructions are therefore always used
20518 for the respective operations.
20520 @item -mnan=2008
20521 @itemx -mnan=legacy
20522 @opindex mnan=2008
20523 @opindex mnan=legacy
20524 These options control the encoding of the special not-a-number (NaN)
20525 IEEE 754 floating-point data.
20527 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20528 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20529 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20530 by the first bit of their trailing significand field being 1.
20532 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20533 this case qNaNs are denoted by the first bit of their trailing
20534 significand field being 1, whereas sNaNs are denoted by the first bit of
20535 their trailing significand field being 0.
20537 The default is @option{-mnan=legacy} unless GCC has been configured with
20538 @option{--with-nan=2008}.
20540 @item -mllsc
20541 @itemx -mno-llsc
20542 @opindex mllsc
20543 @opindex mno-llsc
20544 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20545 implement atomic memory built-in functions.  When neither option is
20546 specified, GCC uses the instructions if the target architecture
20547 supports them.
20549 @option{-mllsc} is useful if the runtime environment can emulate the
20550 instructions and @option{-mno-llsc} can be useful when compiling for
20551 nonstandard ISAs.  You can make either option the default by
20552 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20553 respectively.  @option{--with-llsc} is the default for some
20554 configurations; see the installation documentation for details.
20556 @item -mdsp
20557 @itemx -mno-dsp
20558 @opindex mdsp
20559 @opindex mno-dsp
20560 Use (do not use) revision 1 of the MIPS DSP ASE@.
20561 @xref{MIPS DSP Built-in Functions}.  This option defines the
20562 preprocessor macro @code{__mips_dsp}.  It also defines
20563 @code{__mips_dsp_rev} to 1.
20565 @item -mdspr2
20566 @itemx -mno-dspr2
20567 @opindex mdspr2
20568 @opindex mno-dspr2
20569 Use (do not use) revision 2 of the MIPS DSP ASE@.
20570 @xref{MIPS DSP Built-in Functions}.  This option defines the
20571 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20572 It also defines @code{__mips_dsp_rev} to 2.
20574 @item -msmartmips
20575 @itemx -mno-smartmips
20576 @opindex msmartmips
20577 @opindex mno-smartmips
20578 Use (do not use) the MIPS SmartMIPS ASE.
20580 @item -mpaired-single
20581 @itemx -mno-paired-single
20582 @opindex mpaired-single
20583 @opindex mno-paired-single
20584 Use (do not use) paired-single floating-point instructions.
20585 @xref{MIPS Paired-Single Support}.  This option requires
20586 hardware floating-point support to be enabled.
20588 @item -mdmx
20589 @itemx -mno-mdmx
20590 @opindex mdmx
20591 @opindex mno-mdmx
20592 Use (do not use) MIPS Digital Media Extension instructions.
20593 This option can only be used when generating 64-bit code and requires
20594 hardware floating-point support to be enabled.
20596 @item -mips3d
20597 @itemx -mno-mips3d
20598 @opindex mips3d
20599 @opindex mno-mips3d
20600 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20601 The option @option{-mips3d} implies @option{-mpaired-single}.
20603 @item -mmicromips
20604 @itemx -mno-micromips
20605 @opindex mmicromips
20606 @opindex mno-mmicromips
20607 Generate (do not generate) microMIPS code.
20609 MicroMIPS code generation can also be controlled on a per-function basis
20610 by means of @code{micromips} and @code{nomicromips} attributes.
20611 @xref{Function Attributes}, for more information.
20613 @item -mmt
20614 @itemx -mno-mt
20615 @opindex mmt
20616 @opindex mno-mt
20617 Use (do not use) MT Multithreading instructions.
20619 @item -mmcu
20620 @itemx -mno-mcu
20621 @opindex mmcu
20622 @opindex mno-mcu
20623 Use (do not use) the MIPS MCU ASE instructions.
20625 @item -meva
20626 @itemx -mno-eva
20627 @opindex meva
20628 @opindex mno-eva
20629 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20631 @item -mvirt
20632 @itemx -mno-virt
20633 @opindex mvirt
20634 @opindex mno-virt
20635 Use (do not use) the MIPS Virtualization (VZ) instructions.
20637 @item -mxpa
20638 @itemx -mno-xpa
20639 @opindex mxpa
20640 @opindex mno-xpa
20641 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20643 @item -mlong64
20644 @opindex mlong64
20645 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20646 an explanation of the default and the way that the pointer size is
20647 determined.
20649 @item -mlong32
20650 @opindex mlong32
20651 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20653 The default size of @code{int}s, @code{long}s and pointers depends on
20654 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20655 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20656 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20657 or the same size as integer registers, whichever is smaller.
20659 @item -msym32
20660 @itemx -mno-sym32
20661 @opindex msym32
20662 @opindex mno-sym32
20663 Assume (do not assume) that all symbols have 32-bit values, regardless
20664 of the selected ABI@.  This option is useful in combination with
20665 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20666 to generate shorter and faster references to symbolic addresses.
20668 @item -G @var{num}
20669 @opindex G
20670 Put definitions of externally-visible data in a small data section
20671 if that data is no bigger than @var{num} bytes.  GCC can then generate
20672 more efficient accesses to the data; see @option{-mgpopt} for details.
20674 The default @option{-G} option depends on the configuration.
20676 @item -mlocal-sdata
20677 @itemx -mno-local-sdata
20678 @opindex mlocal-sdata
20679 @opindex mno-local-sdata
20680 Extend (do not extend) the @option{-G} behavior to local data too,
20681 such as to static variables in C@.  @option{-mlocal-sdata} is the
20682 default for all configurations.
20684 If the linker complains that an application is using too much small data,
20685 you might want to try rebuilding the less performance-critical parts with
20686 @option{-mno-local-sdata}.  You might also want to build large
20687 libraries with @option{-mno-local-sdata}, so that the libraries leave
20688 more room for the main program.
20690 @item -mextern-sdata
20691 @itemx -mno-extern-sdata
20692 @opindex mextern-sdata
20693 @opindex mno-extern-sdata
20694 Assume (do not assume) that externally-defined data is in
20695 a small data section if the size of that data is within the @option{-G} limit.
20696 @option{-mextern-sdata} is the default for all configurations.
20698 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20699 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20700 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20701 is placed in a small data section.  If @var{Var} is defined by another
20702 module, you must either compile that module with a high-enough
20703 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20704 definition.  If @var{Var} is common, you must link the application
20705 with a high-enough @option{-G} setting.
20707 The easiest way of satisfying these restrictions is to compile
20708 and link every module with the same @option{-G} option.  However,
20709 you may wish to build a library that supports several different
20710 small data limits.  You can do this by compiling the library with
20711 the highest supported @option{-G} setting and additionally using
20712 @option{-mno-extern-sdata} to stop the library from making assumptions
20713 about externally-defined data.
20715 @item -mgpopt
20716 @itemx -mno-gpopt
20717 @opindex mgpopt
20718 @opindex mno-gpopt
20719 Use (do not use) GP-relative accesses for symbols that are known to be
20720 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20721 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20722 configurations.
20724 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20725 might not hold the value of @code{_gp}.  For example, if the code is
20726 part of a library that might be used in a boot monitor, programs that
20727 call boot monitor routines pass an unknown value in @code{$gp}.
20728 (In such situations, the boot monitor itself is usually compiled
20729 with @option{-G0}.)
20731 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20732 @option{-mno-extern-sdata}.
20734 @item -membedded-data
20735 @itemx -mno-embedded-data
20736 @opindex membedded-data
20737 @opindex mno-embedded-data
20738 Allocate variables to the read-only data section first if possible, then
20739 next in the small data section if possible, otherwise in data.  This gives
20740 slightly slower code than the default, but reduces the amount of RAM required
20741 when executing, and thus may be preferred for some embedded systems.
20743 @item -muninit-const-in-rodata
20744 @itemx -mno-uninit-const-in-rodata
20745 @opindex muninit-const-in-rodata
20746 @opindex mno-uninit-const-in-rodata
20747 Put uninitialized @code{const} variables in the read-only data section.
20748 This option is only meaningful in conjunction with @option{-membedded-data}.
20750 @item -mcode-readable=@var{setting}
20751 @opindex mcode-readable
20752 Specify whether GCC may generate code that reads from executable sections.
20753 There are three possible settings:
20755 @table @gcctabopt
20756 @item -mcode-readable=yes
20757 Instructions may freely access executable sections.  This is the
20758 default setting.
20760 @item -mcode-readable=pcrel
20761 MIPS16 PC-relative load instructions can access executable sections,
20762 but other instructions must not do so.  This option is useful on 4KSc
20763 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20764 It is also useful on processors that can be configured to have a dual
20765 instruction/data SRAM interface and that, like the M4K, automatically
20766 redirect PC-relative loads to the instruction RAM.
20768 @item -mcode-readable=no
20769 Instructions must not access executable sections.  This option can be
20770 useful on targets that are configured to have a dual instruction/data
20771 SRAM interface but that (unlike the M4K) do not automatically redirect
20772 PC-relative loads to the instruction RAM.
20773 @end table
20775 @item -msplit-addresses
20776 @itemx -mno-split-addresses
20777 @opindex msplit-addresses
20778 @opindex mno-split-addresses
20779 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20780 relocation operators.  This option has been superseded by
20781 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20783 @item -mexplicit-relocs
20784 @itemx -mno-explicit-relocs
20785 @opindex mexplicit-relocs
20786 @opindex mno-explicit-relocs
20787 Use (do not use) assembler relocation operators when dealing with symbolic
20788 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20789 is to use assembler macros instead.
20791 @option{-mexplicit-relocs} is the default if GCC was configured
20792 to use an assembler that supports relocation operators.
20794 @item -mcheck-zero-division
20795 @itemx -mno-check-zero-division
20796 @opindex mcheck-zero-division
20797 @opindex mno-check-zero-division
20798 Trap (do not trap) on integer division by zero.
20800 The default is @option{-mcheck-zero-division}.
20802 @item -mdivide-traps
20803 @itemx -mdivide-breaks
20804 @opindex mdivide-traps
20805 @opindex mdivide-breaks
20806 MIPS systems check for division by zero by generating either a
20807 conditional trap or a break instruction.  Using traps results in
20808 smaller code, but is only supported on MIPS II and later.  Also, some
20809 versions of the Linux kernel have a bug that prevents trap from
20810 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20811 allow conditional traps on architectures that support them and
20812 @option{-mdivide-breaks} to force the use of breaks.
20814 The default is usually @option{-mdivide-traps}, but this can be
20815 overridden at configure time using @option{--with-divide=breaks}.
20816 Divide-by-zero checks can be completely disabled using
20817 @option{-mno-check-zero-division}.
20819 @item -mload-store-pairs
20820 @itemx -mno-load-store-pairs
20821 @opindex mload-store-pairs
20822 @opindex mno-load-store-pairs
20823 Enable (disable) an optimization that pairs consecutive load or store
20824 instructions to enable load/store bonding.  This option is enabled by
20825 default but only takes effect when the selected architecture is known
20826 to support bonding.
20828 @item -mmemcpy
20829 @itemx -mno-memcpy
20830 @opindex mmemcpy
20831 @opindex mno-memcpy
20832 Force (do not force) the use of @code{memcpy} for non-trivial block
20833 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20834 most constant-sized copies.
20836 @item -mlong-calls
20837 @itemx -mno-long-calls
20838 @opindex mlong-calls
20839 @opindex mno-long-calls
20840 Disable (do not disable) use of the @code{jal} instruction.  Calling
20841 functions using @code{jal} is more efficient but requires the caller
20842 and callee to be in the same 256 megabyte segment.
20844 This option has no effect on abicalls code.  The default is
20845 @option{-mno-long-calls}.
20847 @item -mmad
20848 @itemx -mno-mad
20849 @opindex mmad
20850 @opindex mno-mad
20851 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20852 instructions, as provided by the R4650 ISA@.
20854 @item -mimadd
20855 @itemx -mno-imadd
20856 @opindex mimadd
20857 @opindex mno-imadd
20858 Enable (disable) use of the @code{madd} and @code{msub} integer
20859 instructions.  The default is @option{-mimadd} on architectures
20860 that support @code{madd} and @code{msub} except for the 74k 
20861 architecture where it was found to generate slower code.
20863 @item -mfused-madd
20864 @itemx -mno-fused-madd
20865 @opindex mfused-madd
20866 @opindex mno-fused-madd
20867 Enable (disable) use of the floating-point multiply-accumulate
20868 instructions, when they are available.  The default is
20869 @option{-mfused-madd}.
20871 On the R8000 CPU when multiply-accumulate instructions are used,
20872 the intermediate product is calculated to infinite precision
20873 and is not subject to the FCSR Flush to Zero bit.  This may be
20874 undesirable in some circumstances.  On other processors the result
20875 is numerically identical to the equivalent computation using
20876 separate multiply, add, subtract and negate instructions.
20878 @item -nocpp
20879 @opindex nocpp
20880 Tell the MIPS assembler to not run its preprocessor over user
20881 assembler files (with a @samp{.s} suffix) when assembling them.
20883 @item -mfix-24k
20884 @itemx -mno-fix-24k
20885 @opindex mfix-24k
20886 @opindex mno-fix-24k
20887 Work around the 24K E48 (lost data on stores during refill) errata.
20888 The workarounds are implemented by the assembler rather than by GCC@.
20890 @item -mfix-r4000
20891 @itemx -mno-fix-r4000
20892 @opindex mfix-r4000
20893 @opindex mno-fix-r4000
20894 Work around certain R4000 CPU errata:
20895 @itemize @minus
20896 @item
20897 A double-word or a variable shift may give an incorrect result if executed
20898 immediately after starting an integer division.
20899 @item
20900 A double-word or a variable shift may give an incorrect result if executed
20901 while an integer multiplication is in progress.
20902 @item
20903 An integer division may give an incorrect result if started in a delay slot
20904 of a taken branch or a jump.
20905 @end itemize
20907 @item -mfix-r4400
20908 @itemx -mno-fix-r4400
20909 @opindex mfix-r4400
20910 @opindex mno-fix-r4400
20911 Work around certain R4400 CPU errata:
20912 @itemize @minus
20913 @item
20914 A double-word or a variable shift may give an incorrect result if executed
20915 immediately after starting an integer division.
20916 @end itemize
20918 @item -mfix-r10000
20919 @itemx -mno-fix-r10000
20920 @opindex mfix-r10000
20921 @opindex mno-fix-r10000
20922 Work around certain R10000 errata:
20923 @itemize @minus
20924 @item
20925 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20926 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20927 @end itemize
20929 This option can only be used if the target architecture supports
20930 branch-likely instructions.  @option{-mfix-r10000} is the default when
20931 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20932 otherwise.
20934 @item -mfix-rm7000
20935 @itemx -mno-fix-rm7000
20936 @opindex mfix-rm7000
20937 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20938 workarounds are implemented by the assembler rather than by GCC@.
20940 @item -mfix-vr4120
20941 @itemx -mno-fix-vr4120
20942 @opindex mfix-vr4120
20943 Work around certain VR4120 errata:
20944 @itemize @minus
20945 @item
20946 @code{dmultu} does not always produce the correct result.
20947 @item
20948 @code{div} and @code{ddiv} do not always produce the correct result if one
20949 of the operands is negative.
20950 @end itemize
20951 The workarounds for the division errata rely on special functions in
20952 @file{libgcc.a}.  At present, these functions are only provided by
20953 the @code{mips64vr*-elf} configurations.
20955 Other VR4120 errata require a NOP to be inserted between certain pairs of
20956 instructions.  These errata are handled by the assembler, not by GCC itself.
20958 @item -mfix-vr4130
20959 @opindex mfix-vr4130
20960 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20961 workarounds are implemented by the assembler rather than by GCC,
20962 although GCC avoids using @code{mflo} and @code{mfhi} if the
20963 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20964 instructions are available instead.
20966 @item -mfix-sb1
20967 @itemx -mno-fix-sb1
20968 @opindex mfix-sb1
20969 Work around certain SB-1 CPU core errata.
20970 (This flag currently works around the SB-1 revision 2
20971 ``F1'' and ``F2'' floating-point errata.)
20973 @item -mr10k-cache-barrier=@var{setting}
20974 @opindex mr10k-cache-barrier
20975 Specify whether GCC should insert cache barriers to avoid the
20976 side-effects of speculation on R10K processors.
20978 In common with many processors, the R10K tries to predict the outcome
20979 of a conditional branch and speculatively executes instructions from
20980 the ``taken'' branch.  It later aborts these instructions if the
20981 predicted outcome is wrong.  However, on the R10K, even aborted
20982 instructions can have side effects.
20984 This problem only affects kernel stores and, depending on the system,
20985 kernel loads.  As an example, a speculatively-executed store may load
20986 the target memory into cache and mark the cache line as dirty, even if
20987 the store itself is later aborted.  If a DMA operation writes to the
20988 same area of memory before the ``dirty'' line is flushed, the cached
20989 data overwrites the DMA-ed data.  See the R10K processor manual
20990 for a full description, including other potential problems.
20992 One workaround is to insert cache barrier instructions before every memory
20993 access that might be speculatively executed and that might have side
20994 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20995 controls GCC's implementation of this workaround.  It assumes that
20996 aborted accesses to any byte in the following regions does not have
20997 side effects:
20999 @enumerate
21000 @item
21001 the memory occupied by the current function's stack frame;
21003 @item
21004 the memory occupied by an incoming stack argument;
21006 @item
21007 the memory occupied by an object with a link-time-constant address.
21008 @end enumerate
21010 It is the kernel's responsibility to ensure that speculative
21011 accesses to these regions are indeed safe.
21013 If the input program contains a function declaration such as:
21015 @smallexample
21016 void foo (void);
21017 @end smallexample
21019 then the implementation of @code{foo} must allow @code{j foo} and
21020 @code{jal foo} to be executed speculatively.  GCC honors this
21021 restriction for functions it compiles itself.  It expects non-GCC
21022 functions (such as hand-written assembly code) to do the same.
21024 The option has three forms:
21026 @table @gcctabopt
21027 @item -mr10k-cache-barrier=load-store
21028 Insert a cache barrier before a load or store that might be
21029 speculatively executed and that might have side effects even
21030 if aborted.
21032 @item -mr10k-cache-barrier=store
21033 Insert a cache barrier before a store that might be speculatively
21034 executed and that might have side effects even if aborted.
21036 @item -mr10k-cache-barrier=none
21037 Disable the insertion of cache barriers.  This is the default setting.
21038 @end table
21040 @item -mflush-func=@var{func}
21041 @itemx -mno-flush-func
21042 @opindex mflush-func
21043 Specifies the function to call to flush the I and D caches, or to not
21044 call any such function.  If called, the function must take the same
21045 arguments as the common @code{_flush_func}, that is, the address of the
21046 memory range for which the cache is being flushed, the size of the
21047 memory range, and the number 3 (to flush both caches).  The default
21048 depends on the target GCC was configured for, but commonly is either
21049 @code{_flush_func} or @code{__cpu_flush}.
21051 @item mbranch-cost=@var{num}
21052 @opindex mbranch-cost
21053 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21054 This cost is only a heuristic and is not guaranteed to produce
21055 consistent results across releases.  A zero cost redundantly selects
21056 the default, which is based on the @option{-mtune} setting.
21058 @item -mbranch-likely
21059 @itemx -mno-branch-likely
21060 @opindex mbranch-likely
21061 @opindex mno-branch-likely
21062 Enable or disable use of Branch Likely instructions, regardless of the
21063 default for the selected architecture.  By default, Branch Likely
21064 instructions may be generated if they are supported by the selected
21065 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21066 and processors that implement those architectures; for those, Branch
21067 Likely instructions are not be generated by default because the MIPS32
21068 and MIPS64 architectures specifically deprecate their use.
21070 @item -mcompact-branches=never
21071 @itemx -mcompact-branches=optimal
21072 @itemx -mcompact-branches=always
21073 @opindex mcompact-branches=never
21074 @opindex mcompact-branches=optimal
21075 @opindex mcompact-branches=always
21076 These options control which form of branches will be generated.  The
21077 default is @option{-mcompact-branches=optimal}.
21079 The @option{-mcompact-branches=never} option ensures that compact branch
21080 instructions will never be generated.
21082 The @option{-mcompact-branches=always} option ensures that a compact
21083 branch instruction will be generated if available.  If a compact branch
21084 instruction is not available, a delay slot form of the branch will be
21085 used instead.
21087 This option is supported from MIPS Release 6 onwards.
21089 The @option{-mcompact-branches=optimal} option will cause a delay slot
21090 branch to be used if one is available in the current ISA and the delay
21091 slot is successfully filled.  If the delay slot is not filled, a compact
21092 branch will be chosen if one is available.
21094 @item -mfp-exceptions
21095 @itemx -mno-fp-exceptions
21096 @opindex mfp-exceptions
21097 Specifies whether FP exceptions are enabled.  This affects how
21098 FP instructions are scheduled for some processors.
21099 The default is that FP exceptions are
21100 enabled.
21102 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21103 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21104 FP pipe.
21106 @item -mvr4130-align
21107 @itemx -mno-vr4130-align
21108 @opindex mvr4130-align
21109 The VR4130 pipeline is two-way superscalar, but can only issue two
21110 instructions together if the first one is 8-byte aligned.  When this
21111 option is enabled, GCC aligns pairs of instructions that it
21112 thinks should execute in parallel.
21114 This option only has an effect when optimizing for the VR4130.
21115 It normally makes code faster, but at the expense of making it bigger.
21116 It is enabled by default at optimization level @option{-O3}.
21118 @item -msynci
21119 @itemx -mno-synci
21120 @opindex msynci
21121 Enable (disable) generation of @code{synci} instructions on
21122 architectures that support it.  The @code{synci} instructions (if
21123 enabled) are generated when @code{__builtin___clear_cache} is
21124 compiled.
21126 This option defaults to @option{-mno-synci}, but the default can be
21127 overridden by configuring GCC with @option{--with-synci}.
21129 When compiling code for single processor systems, it is generally safe
21130 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21131 does not invalidate the instruction caches on all cores and may lead
21132 to undefined behavior.
21134 @item -mrelax-pic-calls
21135 @itemx -mno-relax-pic-calls
21136 @opindex mrelax-pic-calls
21137 Try to turn PIC calls that are normally dispatched via register
21138 @code{$25} into direct calls.  This is only possible if the linker can
21139 resolve the destination at link time and if the destination is within
21140 range for a direct call.
21142 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21143 an assembler and a linker that support the @code{.reloc} assembly
21144 directive and @option{-mexplicit-relocs} is in effect.  With
21145 @option{-mno-explicit-relocs}, this optimization can be performed by the
21146 assembler and the linker alone without help from the compiler.
21148 @item -mmcount-ra-address
21149 @itemx -mno-mcount-ra-address
21150 @opindex mmcount-ra-address
21151 @opindex mno-mcount-ra-address
21152 Emit (do not emit) code that allows @code{_mcount} to modify the
21153 calling function's return address.  When enabled, this option extends
21154 the usual @code{_mcount} interface with a new @var{ra-address}
21155 parameter, which has type @code{intptr_t *} and is passed in register
21156 @code{$12}.  @code{_mcount} can then modify the return address by
21157 doing both of the following:
21158 @itemize
21159 @item
21160 Returning the new address in register @code{$31}.
21161 @item
21162 Storing the new address in @code{*@var{ra-address}},
21163 if @var{ra-address} is nonnull.
21164 @end itemize
21166 The default is @option{-mno-mcount-ra-address}.
21168 @item -mframe-header-opt
21169 @itemx -mno-frame-header-opt
21170 @opindex mframe-header-opt
21171 Enable (disable) frame header optimization in the o32 ABI.  When using the
21172 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21173 function to write out register arguments.  When enabled, this optimization
21174 will suppress the allocation of the frame header if it can be determined that
21175 it is unused.
21177 This optimization is off by default at all optimization levels.
21179 @item -mlxc1-sxc1
21180 @itemx -mno-lxc1-sxc1
21181 @opindex mlxc1-sxc1
21182 When applicable, enable (disable) the generation of @code{lwxc1},
21183 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21185 @item -mmadd4
21186 @itemx -mno-madd4
21187 @opindex mmadd4
21188 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21189 @code{madd.d} and related instructions.  Enabled by default.
21191 @end table
21193 @node MMIX Options
21194 @subsection MMIX Options
21195 @cindex MMIX Options
21197 These options are defined for the MMIX:
21199 @table @gcctabopt
21200 @item -mlibfuncs
21201 @itemx -mno-libfuncs
21202 @opindex mlibfuncs
21203 @opindex mno-libfuncs
21204 Specify that intrinsic library functions are being compiled, passing all
21205 values in registers, no matter the size.
21207 @item -mepsilon
21208 @itemx -mno-epsilon
21209 @opindex mepsilon
21210 @opindex mno-epsilon
21211 Generate floating-point comparison instructions that compare with respect
21212 to the @code{rE} epsilon register.
21214 @item -mabi=mmixware
21215 @itemx -mabi=gnu
21216 @opindex mabi=mmixware
21217 @opindex mabi=gnu
21218 Generate code that passes function parameters and return values that (in
21219 the called function) are seen as registers @code{$0} and up, as opposed to
21220 the GNU ABI which uses global registers @code{$231} and up.
21222 @item -mzero-extend
21223 @itemx -mno-zero-extend
21224 @opindex mzero-extend
21225 @opindex mno-zero-extend
21226 When reading data from memory in sizes shorter than 64 bits, use (do not
21227 use) zero-extending load instructions by default, rather than
21228 sign-extending ones.
21230 @item -mknuthdiv
21231 @itemx -mno-knuthdiv
21232 @opindex mknuthdiv
21233 @opindex mno-knuthdiv
21234 Make the result of a division yielding a remainder have the same sign as
21235 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21236 remainder follows the sign of the dividend.  Both methods are
21237 arithmetically valid, the latter being almost exclusively used.
21239 @item -mtoplevel-symbols
21240 @itemx -mno-toplevel-symbols
21241 @opindex mtoplevel-symbols
21242 @opindex mno-toplevel-symbols
21243 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21244 code can be used with the @code{PREFIX} assembly directive.
21246 @item -melf
21247 @opindex melf
21248 Generate an executable in the ELF format, rather than the default
21249 @samp{mmo} format used by the @command{mmix} simulator.
21251 @item -mbranch-predict
21252 @itemx -mno-branch-predict
21253 @opindex mbranch-predict
21254 @opindex mno-branch-predict
21255 Use (do not use) the probable-branch instructions, when static branch
21256 prediction indicates a probable branch.
21258 @item -mbase-addresses
21259 @itemx -mno-base-addresses
21260 @opindex mbase-addresses
21261 @opindex mno-base-addresses
21262 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21263 base address automatically generates a request (handled by the assembler
21264 and the linker) for a constant to be set up in a global register.  The
21265 register is used for one or more base address requests within the range 0
21266 to 255 from the value held in the register.  The generally leads to short
21267 and fast code, but the number of different data items that can be
21268 addressed is limited.  This means that a program that uses lots of static
21269 data may require @option{-mno-base-addresses}.
21271 @item -msingle-exit
21272 @itemx -mno-single-exit
21273 @opindex msingle-exit
21274 @opindex mno-single-exit
21275 Force (do not force) generated code to have a single exit point in each
21276 function.
21277 @end table
21279 @node MN10300 Options
21280 @subsection MN10300 Options
21281 @cindex MN10300 options
21283 These @option{-m} options are defined for Matsushita MN10300 architectures:
21285 @table @gcctabopt
21286 @item -mmult-bug
21287 @opindex mmult-bug
21288 Generate code to avoid bugs in the multiply instructions for the MN10300
21289 processors.  This is the default.
21291 @item -mno-mult-bug
21292 @opindex mno-mult-bug
21293 Do not generate code to avoid bugs in the multiply instructions for the
21294 MN10300 processors.
21296 @item -mam33
21297 @opindex mam33
21298 Generate code using features specific to the AM33 processor.
21300 @item -mno-am33
21301 @opindex mno-am33
21302 Do not generate code using features specific to the AM33 processor.  This
21303 is the default.
21305 @item -mam33-2
21306 @opindex mam33-2
21307 Generate code using features specific to the AM33/2.0 processor.
21309 @item -mam34
21310 @opindex mam34
21311 Generate code using features specific to the AM34 processor.
21313 @item -mtune=@var{cpu-type}
21314 @opindex mtune
21315 Use the timing characteristics of the indicated CPU type when
21316 scheduling instructions.  This does not change the targeted processor
21317 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21318 @samp{am33-2} or @samp{am34}.
21320 @item -mreturn-pointer-on-d0
21321 @opindex mreturn-pointer-on-d0
21322 When generating a function that returns a pointer, return the pointer
21323 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21324 only in @code{a0}, and attempts to call such functions without a prototype
21325 result in errors.  Note that this option is on by default; use
21326 @option{-mno-return-pointer-on-d0} to disable it.
21328 @item -mno-crt0
21329 @opindex mno-crt0
21330 Do not link in the C run-time initialization object file.
21332 @item -mrelax
21333 @opindex mrelax
21334 Indicate to the linker that it should perform a relaxation optimization pass
21335 to shorten branches, calls and absolute memory addresses.  This option only
21336 has an effect when used on the command line for the final link step.
21338 This option makes symbolic debugging impossible.
21340 @item -mliw
21341 @opindex mliw
21342 Allow the compiler to generate @emph{Long Instruction Word}
21343 instructions if the target is the @samp{AM33} or later.  This is the
21344 default.  This option defines the preprocessor macro @code{__LIW__}.
21346 @item -mnoliw
21347 @opindex mnoliw
21348 Do not allow the compiler to generate @emph{Long Instruction Word}
21349 instructions.  This option defines the preprocessor macro
21350 @code{__NO_LIW__}.
21352 @item -msetlb
21353 @opindex msetlb
21354 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21355 instructions if the target is the @samp{AM33} or later.  This is the
21356 default.  This option defines the preprocessor macro @code{__SETLB__}.
21358 @item -mnosetlb
21359 @opindex mnosetlb
21360 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21361 instructions.  This option defines the preprocessor macro
21362 @code{__NO_SETLB__}.
21364 @end table
21366 @node Moxie Options
21367 @subsection Moxie Options
21368 @cindex Moxie Options
21370 @table @gcctabopt
21372 @item -meb
21373 @opindex meb
21374 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21375 configurations.
21377 @item -mel
21378 @opindex mel
21379 Generate little-endian code.
21381 @item -mmul.x
21382 @opindex mmul.x
21383 Generate mul.x and umul.x instructions.  This is the default for
21384 @samp{moxiebox-*-*} configurations.
21386 @item -mno-crt0
21387 @opindex mno-crt0
21388 Do not link in the C run-time initialization object file.
21390 @end table
21392 @node MSP430 Options
21393 @subsection MSP430 Options
21394 @cindex MSP430 Options
21396 These options are defined for the MSP430:
21398 @table @gcctabopt
21400 @item -masm-hex
21401 @opindex masm-hex
21402 Force assembly output to always use hex constants.  Normally such
21403 constants are signed decimals, but this option is available for
21404 testsuite and/or aesthetic purposes.
21406 @item -mmcu=
21407 @opindex mmcu=
21408 Select the MCU to target.  This is used to create a C preprocessor
21409 symbol based upon the MCU name, converted to upper case and pre- and
21410 post-fixed with @samp{__}.  This in turn is used by the
21411 @file{msp430.h} header file to select an MCU-specific supplementary
21412 header file.
21414 The option also sets the ISA to use.  If the MCU name is one that is
21415 known to only support the 430 ISA then that is selected, otherwise the
21416 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21417 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21418 name selects the 430X ISA.
21420 In addition an MCU-specific linker script is added to the linker
21421 command line.  The script's name is the name of the MCU with
21422 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21423 command line defines the C preprocessor symbol @code{__XXX__} and
21424 cause the linker to search for a script called @file{xxx.ld}.
21426 This option is also passed on to the assembler.
21428 @item -mwarn-mcu
21429 @itemx -mno-warn-mcu
21430 @opindex mwarn-mcu
21431 @opindex mno-warn-mcu
21432 This option enables or disables warnings about conflicts between the
21433 MCU name specified by the @option{-mmcu} option and the ISA set by the
21434 @option{-mcpu} option and/or the hardware multiply support set by the
21435 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21436 MCU names.  This option is on by default.
21438 @item -mcpu=
21439 @opindex mcpu=
21440 Specifies the ISA to use.  Accepted values are @samp{msp430},
21441 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21442 @option{-mmcu=} option should be used to select the ISA.
21444 @item -msim
21445 @opindex msim
21446 Link to the simulator runtime libraries and linker script.  Overrides
21447 any scripts that would be selected by the @option{-mmcu=} option.
21449 @item -mlarge
21450 @opindex mlarge
21451 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21453 @item -msmall
21454 @opindex msmall
21455 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21457 @item -mrelax
21458 @opindex mrelax
21459 This option is passed to the assembler and linker, and allows the
21460 linker to perform certain optimizations that cannot be done until
21461 the final link.
21463 @item mhwmult=
21464 @opindex mhwmult=
21465 Describes the type of hardware multiply supported by the target.
21466 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21467 for the original 16-bit-only multiply supported by early MCUs.
21468 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21469 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21470 A value of @samp{auto} can also be given.  This tells GCC to deduce
21471 the hardware multiply support based upon the MCU name provided by the
21472 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21473 the MCU name is not recognized then no hardware multiply support is
21474 assumed.  @code{auto} is the default setting.
21476 Hardware multiplies are normally performed by calling a library
21477 routine.  This saves space in the generated code.  When compiling at
21478 @option{-O3} or higher however the hardware multiplier is invoked
21479 inline.  This makes for bigger, but faster code.
21481 The hardware multiply routines disable interrupts whilst running and
21482 restore the previous interrupt state when they finish.  This makes
21483 them safe to use inside interrupt handlers as well as in normal code.
21485 @item -minrt
21486 @opindex minrt
21487 Enable the use of a minimum runtime environment - no static
21488 initializers or constructors.  This is intended for memory-constrained
21489 devices.  The compiler includes special symbols in some objects
21490 that tell the linker and runtime which code fragments are required.
21492 @item -mcode-region=
21493 @itemx -mdata-region=
21494 @opindex mcode-region
21495 @opindex mdata-region
21496 These options tell the compiler where to place functions and data that
21497 do not have one of the @code{lower}, @code{upper}, @code{either} or
21498 @code{section} attributes.  Possible values are @code{lower},
21499 @code{upper}, @code{either} or @code{any}.  The first three behave
21500 like the corresponding attribute.  The fourth possible value -
21501 @code{any} - is the default.  It leaves placement entirely up to the
21502 linker script and how it assigns the standard sections
21503 (@code{.text}, @code{.data}, etc) to the memory regions.
21505 @item -msilicon-errata=
21506 @opindex msilicon-errata
21507 This option passes on a request to assembler to enable the fixes for
21508 the named silicon errata.
21510 @item -msilicon-errata-warn=
21511 @opindex msilicon-errata-warn
21512 This option passes on a request to the assembler to enable warning
21513 messages when a silicon errata might need to be applied.
21515 @end table
21517 @node NDS32 Options
21518 @subsection NDS32 Options
21519 @cindex NDS32 Options
21521 These options are defined for NDS32 implementations:
21523 @table @gcctabopt
21525 @item -mbig-endian
21526 @opindex mbig-endian
21527 Generate code in big-endian mode.
21529 @item -mlittle-endian
21530 @opindex mlittle-endian
21531 Generate code in little-endian mode.
21533 @item -mreduced-regs
21534 @opindex mreduced-regs
21535 Use reduced-set registers for register allocation.
21537 @item -mfull-regs
21538 @opindex mfull-regs
21539 Use full-set registers for register allocation.
21541 @item -mcmov
21542 @opindex mcmov
21543 Generate conditional move instructions.
21545 @item -mno-cmov
21546 @opindex mno-cmov
21547 Do not generate conditional move instructions.
21549 @item -mext-perf
21550 @opindex mperf-ext
21551 Generate performance extension instructions.
21553 @item -mno-ext-perf
21554 @opindex mno-perf-ext
21555 Do not generate performance extension instructions.
21557 @item -mext-perf2
21558 @opindex mperf-ext
21559 Generate performance extension 2 instructions.
21561 @item -mno-ext-perf2
21562 @opindex mno-perf-ext
21563 Do not generate performance extension 2 instructions.
21565 @item -mext-string
21566 @opindex mperf-ext
21567 Generate string extension instructions.
21569 @item -mno-ext-string
21570 @opindex mno-perf-ext
21571 Do not generate string extension instructions.
21573 @item -mv3push
21574 @opindex mv3push
21575 Generate v3 push25/pop25 instructions.
21577 @item -mno-v3push
21578 @opindex mno-v3push
21579 Do not generate v3 push25/pop25 instructions.
21581 @item -m16-bit
21582 @opindex m16-bit
21583 Generate 16-bit instructions.
21585 @item -mno-16-bit
21586 @opindex mno-16-bit
21587 Do not generate 16-bit instructions.
21589 @item -misr-vector-size=@var{num}
21590 @opindex misr-vector-size
21591 Specify the size of each interrupt vector, which must be 4 or 16.
21593 @item -mcache-block-size=@var{num}
21594 @opindex mcache-block-size
21595 Specify the size of each cache block,
21596 which must be a power of 2 between 4 and 512.
21598 @item -march=@var{arch}
21599 @opindex march
21600 Specify the name of the target architecture.
21602 @item -mcmodel=@var{code-model}
21603 @opindex mcmodel
21604 Set the code model to one of
21605 @table @asis
21606 @item @samp{small}
21607 All the data and read-only data segments must be within 512KB addressing space.
21608 The text segment must be within 16MB addressing space.
21609 @item @samp{medium}
21610 The data segment must be within 512KB while the read-only data segment can be
21611 within 4GB addressing space.  The text segment should be still within 16MB
21612 addressing space.
21613 @item @samp{large}
21614 All the text and data segments can be within 4GB addressing space.
21615 @end table
21617 @item -mctor-dtor
21618 @opindex mctor-dtor
21619 Enable constructor/destructor feature.
21621 @item -mrelax
21622 @opindex mrelax
21623 Guide linker to relax instructions.
21625 @end table
21627 @node Nios II Options
21628 @subsection Nios II Options
21629 @cindex Nios II options
21630 @cindex Altera Nios II options
21632 These are the options defined for the Altera Nios II processor.
21634 @table @gcctabopt
21636 @item -G @var{num}
21637 @opindex G
21638 @cindex smaller data references
21639 Put global and static objects less than or equal to @var{num} bytes
21640 into the small data or BSS sections instead of the normal data or BSS
21641 sections.  The default value of @var{num} is 8.
21643 @item -mgpopt=@var{option}
21644 @itemx -mgpopt
21645 @itemx -mno-gpopt
21646 @opindex mgpopt
21647 @opindex mno-gpopt
21648 Generate (do not generate) GP-relative accesses.  The following 
21649 @var{option} names are recognized:
21651 @table @samp
21653 @item none
21654 Do not generate GP-relative accesses.
21656 @item local
21657 Generate GP-relative accesses for small data objects that are not 
21658 external, weak, or uninitialized common symbols.  
21659 Also use GP-relative addressing for objects that
21660 have been explicitly placed in a small data section via a @code{section}
21661 attribute.
21663 @item global
21664 As for @samp{local}, but also generate GP-relative accesses for
21665 small data objects that are external, weak, or common.  If you use this option,
21666 you must ensure that all parts of your program (including libraries) are
21667 compiled with the same @option{-G} setting.
21669 @item data
21670 Generate GP-relative accesses for all data objects in the program.  If you
21671 use this option, the entire data and BSS segments
21672 of your program must fit in 64K of memory and you must use an appropriate
21673 linker script to allocate them within the addressable range of the
21674 global pointer.
21676 @item all
21677 Generate GP-relative addresses for function pointers as well as data
21678 pointers.  If you use this option, the entire text, data, and BSS segments
21679 of your program must fit in 64K of memory and you must use an appropriate
21680 linker script to allocate them within the addressable range of the
21681 global pointer.
21683 @end table
21685 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21686 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21688 The default is @option{-mgpopt} except when @option{-fpic} or
21689 @option{-fPIC} is specified to generate position-independent code.
21690 Note that the Nios II ABI does not permit GP-relative accesses from
21691 shared libraries.
21693 You may need to specify @option{-mno-gpopt} explicitly when building
21694 programs that include large amounts of small data, including large
21695 GOT data sections.  In this case, the 16-bit offset for GP-relative
21696 addressing may not be large enough to allow access to the entire 
21697 small data section.
21699 @item -mgprel-sec=@var{regexp}
21700 @opindex mgprel-sec
21701 This option specifies additional section names that can be accessed via
21702 GP-relative addressing.  It is most useful in conjunction with 
21703 @code{section} attributes on variable declarations 
21704 (@pxref{Common Variable Attributes}) and a custom linker script.  
21705 The @var{regexp} is a POSIX Extended Regular Expression.
21707 This option does not affect the behavior of the @option{-G} option, and 
21708 and the specified sections are in addition to the standard @code{.sdata} 
21709 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21711 @item -mr0rel-sec=@var{regexp}
21712 @opindex mr0rel-sec
21713 This option specifies names of sections that can be accessed via a 
21714 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21715 of the 32-bit address space.  It is most useful in conjunction with 
21716 @code{section} attributes on variable declarations 
21717 (@pxref{Common Variable Attributes}) and a custom linker script.  
21718 The @var{regexp} is a POSIX Extended Regular Expression.
21720 In contrast to the use of GP-relative addressing for small data, 
21721 zero-based addressing is never generated by default and there are no 
21722 conventional section names used in standard linker scripts for sections
21723 in the low or high areas of memory.
21725 @item -mel
21726 @itemx -meb
21727 @opindex mel
21728 @opindex meb
21729 Generate little-endian (default) or big-endian (experimental) code,
21730 respectively.
21732 @item -march=@var{arch}
21733 @opindex march
21734 This specifies the name of the target Nios II architecture.  GCC uses this
21735 name to determine what kind of instructions it can emit when generating
21736 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21738 The preprocessor macro @code{__nios2_arch__} is available to programs,
21739 with value 1 or 2, indicating the targeted ISA level.
21741 @item -mbypass-cache
21742 @itemx -mno-bypass-cache
21743 @opindex mno-bypass-cache
21744 @opindex mbypass-cache
21745 Force all load and store instructions to always bypass cache by 
21746 using I/O variants of the instructions. The default is not to
21747 bypass the cache.
21749 @item -mno-cache-volatile 
21750 @itemx -mcache-volatile       
21751 @opindex mcache-volatile 
21752 @opindex mno-cache-volatile
21753 Volatile memory access bypass the cache using the I/O variants of 
21754 the load and store instructions. The default is not to bypass the cache.
21756 @item -mno-fast-sw-div
21757 @itemx -mfast-sw-div
21758 @opindex mno-fast-sw-div
21759 @opindex mfast-sw-div
21760 Do not use table-based fast divide for small numbers. The default 
21761 is to use the fast divide at @option{-O3} and above.
21763 @item -mno-hw-mul
21764 @itemx -mhw-mul
21765 @itemx -mno-hw-mulx
21766 @itemx -mhw-mulx
21767 @itemx -mno-hw-div
21768 @itemx -mhw-div
21769 @opindex mno-hw-mul
21770 @opindex mhw-mul
21771 @opindex mno-hw-mulx
21772 @opindex mhw-mulx
21773 @opindex mno-hw-div
21774 @opindex mhw-div
21775 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21776 instructions by the compiler. The default is to emit @code{mul}
21777 and not emit @code{div} and @code{mulx}.
21779 @item -mbmx
21780 @itemx -mno-bmx
21781 @itemx -mcdx
21782 @itemx -mno-cdx
21783 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21784 CDX (code density) instructions.  Enabling these instructions also
21785 requires @option{-march=r2}.  Since these instructions are optional
21786 extensions to the R2 architecture, the default is not to emit them.
21788 @item -mcustom-@var{insn}=@var{N}
21789 @itemx -mno-custom-@var{insn}
21790 @opindex mcustom-@var{insn}
21791 @opindex mno-custom-@var{insn}
21792 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21793 custom instruction with encoding @var{N} when generating code that uses 
21794 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21795 instruction 253 for single-precision floating-point add operations instead
21796 of the default behavior of using a library call.
21798 The following values of @var{insn} are supported.  Except as otherwise
21799 noted, floating-point operations are expected to be implemented with
21800 normal IEEE 754 semantics and correspond directly to the C operators or the
21801 equivalent GCC built-in functions (@pxref{Other Builtins}).
21803 Single-precision floating point:
21804 @table @asis
21806 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21807 Binary arithmetic operations.
21809 @item @samp{fnegs}
21810 Unary negation.
21812 @item @samp{fabss}
21813 Unary absolute value.
21815 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21816 Comparison operations.
21818 @item @samp{fmins}, @samp{fmaxs}
21819 Floating-point minimum and maximum.  These instructions are only
21820 generated if @option{-ffinite-math-only} is specified.
21822 @item @samp{fsqrts}
21823 Unary square root operation.
21825 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21826 Floating-point trigonometric and exponential functions.  These instructions
21827 are only generated if @option{-funsafe-math-optimizations} is also specified.
21829 @end table
21831 Double-precision floating point:
21832 @table @asis
21834 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21835 Binary arithmetic operations.
21837 @item @samp{fnegd}
21838 Unary negation.
21840 @item @samp{fabsd}
21841 Unary absolute value.
21843 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21844 Comparison operations.
21846 @item @samp{fmind}, @samp{fmaxd}
21847 Double-precision minimum and maximum.  These instructions are only
21848 generated if @option{-ffinite-math-only} is specified.
21850 @item @samp{fsqrtd}
21851 Unary square root operation.
21853 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21854 Double-precision trigonometric and exponential functions.  These instructions
21855 are only generated if @option{-funsafe-math-optimizations} is also specified.
21857 @end table
21859 Conversions:
21860 @table @asis
21861 @item @samp{fextsd}
21862 Conversion from single precision to double precision.
21864 @item @samp{ftruncds}
21865 Conversion from double precision to single precision.
21867 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21868 Conversion from floating point to signed or unsigned integer types, with
21869 truncation towards zero.
21871 @item @samp{round}
21872 Conversion from single-precision floating point to signed integer,
21873 rounding to the nearest integer and ties away from zero.
21874 This corresponds to the @code{__builtin_lroundf} function when
21875 @option{-fno-math-errno} is used.
21877 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21878 Conversion from signed or unsigned integer types to floating-point types.
21880 @end table
21882 In addition, all of the following transfer instructions for internal
21883 registers X and Y must be provided to use any of the double-precision
21884 floating-point instructions.  Custom instructions taking two
21885 double-precision source operands expect the first operand in the
21886 64-bit register X.  The other operand (or only operand of a unary
21887 operation) is given to the custom arithmetic instruction with the
21888 least significant half in source register @var{src1} and the most
21889 significant half in @var{src2}.  A custom instruction that returns a
21890 double-precision result returns the most significant 32 bits in the
21891 destination register and the other half in 32-bit register Y.  
21892 GCC automatically generates the necessary code sequences to write
21893 register X and/or read register Y when double-precision floating-point
21894 instructions are used.
21896 @table @asis
21898 @item @samp{fwrx}
21899 Write @var{src1} into the least significant half of X and @var{src2} into
21900 the most significant half of X.
21902 @item @samp{fwry}
21903 Write @var{src1} into Y.
21905 @item @samp{frdxhi}, @samp{frdxlo}
21906 Read the most or least (respectively) significant half of X and store it in
21907 @var{dest}.
21909 @item @samp{frdy}
21910 Read the value of Y and store it into @var{dest}.
21911 @end table
21913 Note that you can gain more local control over generation of Nios II custom
21914 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21915 and @code{target("no-custom-@var{insn}")} function attributes
21916 (@pxref{Function Attributes})
21917 or pragmas (@pxref{Function Specific Option Pragmas}).
21919 @item -mcustom-fpu-cfg=@var{name}
21920 @opindex mcustom-fpu-cfg
21922 This option enables a predefined, named set of custom instruction encodings
21923 (see @option{-mcustom-@var{insn}} above).  
21924 Currently, the following sets are defined:
21926 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21927 @gccoptlist{-mcustom-fmuls=252 @gol
21928 -mcustom-fadds=253 @gol
21929 -mcustom-fsubs=254 @gol
21930 -fsingle-precision-constant}
21932 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21933 @gccoptlist{-mcustom-fmuls=252 @gol
21934 -mcustom-fadds=253 @gol
21935 -mcustom-fsubs=254 @gol
21936 -mcustom-fdivs=255 @gol
21937 -fsingle-precision-constant}
21939 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21940 @gccoptlist{-mcustom-floatus=243 @gol
21941 -mcustom-fixsi=244 @gol
21942 -mcustom-floatis=245 @gol
21943 -mcustom-fcmpgts=246 @gol
21944 -mcustom-fcmples=249 @gol
21945 -mcustom-fcmpeqs=250 @gol
21946 -mcustom-fcmpnes=251 @gol
21947 -mcustom-fmuls=252 @gol
21948 -mcustom-fadds=253 @gol
21949 -mcustom-fsubs=254 @gol
21950 -mcustom-fdivs=255 @gol
21951 -fsingle-precision-constant}
21953 Custom instruction assignments given by individual
21954 @option{-mcustom-@var{insn}=} options override those given by
21955 @option{-mcustom-fpu-cfg=}, regardless of the
21956 order of the options on the command line.
21958 Note that you can gain more local control over selection of a FPU
21959 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21960 function attribute (@pxref{Function Attributes})
21961 or pragma (@pxref{Function Specific Option Pragmas}).
21963 @end table
21965 These additional @samp{-m} options are available for the Altera Nios II
21966 ELF (bare-metal) target:
21968 @table @gcctabopt
21970 @item -mhal
21971 @opindex mhal
21972 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21973 startup and termination code, and is typically used in conjunction with
21974 @option{-msys-crt0=} to specify the location of the alternate startup code
21975 provided by the HAL BSP.
21977 @item -msmallc
21978 @opindex msmallc
21979 Link with a limited version of the C library, @option{-lsmallc}, rather than
21980 Newlib.
21982 @item -msys-crt0=@var{startfile}
21983 @opindex msys-crt0
21984 @var{startfile} is the file name of the startfile (crt0) to use 
21985 when linking.  This option is only useful in conjunction with @option{-mhal}.
21987 @item -msys-lib=@var{systemlib}
21988 @opindex msys-lib
21989 @var{systemlib} is the library name of the library that provides
21990 low-level system calls required by the C library,
21991 e.g. @code{read} and @code{write}.
21992 This option is typically used to link with a library provided by a HAL BSP.
21994 @end table
21996 @node Nvidia PTX Options
21997 @subsection Nvidia PTX Options
21998 @cindex Nvidia PTX options
21999 @cindex nvptx options
22001 These options are defined for Nvidia PTX:
22003 @table @gcctabopt
22005 @item -m32
22006 @itemx -m64
22007 @opindex m32
22008 @opindex m64
22009 Generate code for 32-bit or 64-bit ABI.
22011 @item -mmainkernel
22012 @opindex mmainkernel
22013 Link in code for a __main kernel.  This is for stand-alone instead of
22014 offloading execution.
22016 @item -moptimize
22017 @opindex moptimize
22018 Apply partitioned execution optimizations.  This is the default when any
22019 level of optimization is selected.
22021 @item -msoft-stack
22022 @opindex msoft-stack
22023 Generate code that does not use @code{.local} memory
22024 directly for stack storage. Instead, a per-warp stack pointer is
22025 maintained explicitly. This enables variable-length stack allocation (with
22026 variable-length arrays or @code{alloca}), and when global memory is used for
22027 underlying storage, makes it possible to access automatic variables from other
22028 threads, or with atomic instructions. This code generation variant is used
22029 for OpenMP offloading, but the option is exposed on its own for the purpose
22030 of testing the compiler; to generate code suitable for linking into programs
22031 using OpenMP offloading, use option @option{-mgomp}.
22033 @item -muniform-simt
22034 @opindex muniform-simt
22035 Switch to code generation variant that allows to execute all threads in each
22036 warp, while maintaining memory state and side effects as if only one thread
22037 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22038 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22039 current lane index equals the master lane index), and the register being
22040 assigned is copied via a shuffle instruction from the master lane.  Outside of
22041 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22042 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22043 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22044 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22045 with current lane index to compute the master lane index.
22047 @item -mgomp
22048 @opindex mgomp
22049 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22050 @option{-muniform-simt} options, and selects corresponding multilib variant.
22052 @end table
22054 @node PDP-11 Options
22055 @subsection PDP-11 Options
22056 @cindex PDP-11 Options
22058 These options are defined for the PDP-11:
22060 @table @gcctabopt
22061 @item -mfpu
22062 @opindex mfpu
22063 Use hardware FPP floating point.  This is the default.  (FIS floating
22064 point on the PDP-11/40 is not supported.)
22066 @item -msoft-float
22067 @opindex msoft-float
22068 Do not use hardware floating point.
22070 @item -mac0
22071 @opindex mac0
22072 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22074 @item -mno-ac0
22075 @opindex mno-ac0
22076 Return floating-point results in memory.  This is the default.
22078 @item -m40
22079 @opindex m40
22080 Generate code for a PDP-11/40.
22082 @item -m45
22083 @opindex m45
22084 Generate code for a PDP-11/45.  This is the default.
22086 @item -m10
22087 @opindex m10
22088 Generate code for a PDP-11/10.
22090 @item -mbcopy-builtin
22091 @opindex mbcopy-builtin
22092 Use inline @code{movmemhi} patterns for copying memory.  This is the
22093 default.
22095 @item -mbcopy
22096 @opindex mbcopy
22097 Do not use inline @code{movmemhi} patterns for copying memory.
22099 @item -mint16
22100 @itemx -mno-int32
22101 @opindex mint16
22102 @opindex mno-int32
22103 Use 16-bit @code{int}.  This is the default.
22105 @item -mint32
22106 @itemx -mno-int16
22107 @opindex mint32
22108 @opindex mno-int16
22109 Use 32-bit @code{int}.
22111 @item -mfloat64
22112 @itemx -mno-float32
22113 @opindex mfloat64
22114 @opindex mno-float32
22115 Use 64-bit @code{float}.  This is the default.
22117 @item -mfloat32
22118 @itemx -mno-float64
22119 @opindex mfloat32
22120 @opindex mno-float64
22121 Use 32-bit @code{float}.
22123 @item -mabshi
22124 @opindex mabshi
22125 Use @code{abshi2} pattern.  This is the default.
22127 @item -mno-abshi
22128 @opindex mno-abshi
22129 Do not use @code{abshi2} pattern.
22131 @item -mbranch-expensive
22132 @opindex mbranch-expensive
22133 Pretend that branches are expensive.  This is for experimenting with
22134 code generation only.
22136 @item -mbranch-cheap
22137 @opindex mbranch-cheap
22138 Do not pretend that branches are expensive.  This is the default.
22140 @item -munix-asm
22141 @opindex munix-asm
22142 Use Unix assembler syntax.  This is the default when configured for
22143 @samp{pdp11-*-bsd}.
22145 @item -mdec-asm
22146 @opindex mdec-asm
22147 Use DEC assembler syntax.  This is the default when configured for any
22148 PDP-11 target other than @samp{pdp11-*-bsd}.
22149 @end table
22151 @node picoChip Options
22152 @subsection picoChip Options
22153 @cindex picoChip options
22155 These @samp{-m} options are defined for picoChip implementations:
22157 @table @gcctabopt
22159 @item -mae=@var{ae_type}
22160 @opindex mcpu
22161 Set the instruction set, register set, and instruction scheduling
22162 parameters for array element type @var{ae_type}.  Supported values
22163 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22165 @option{-mae=ANY} selects a completely generic AE type.  Code
22166 generated with this option runs on any of the other AE types.  The
22167 code is not as efficient as it would be if compiled for a specific
22168 AE type, and some types of operation (e.g., multiplication) do not
22169 work properly on all types of AE.
22171 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22172 for compiled code, and is the default.
22174 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22175 option may suffer from poor performance of byte (char) manipulation,
22176 since the DSP AE does not provide hardware support for byte load/stores.
22178 @item -msymbol-as-address
22179 Enable the compiler to directly use a symbol name as an address in a
22180 load/store instruction, without first loading it into a
22181 register.  Typically, the use of this option generates larger
22182 programs, which run faster than when the option isn't used.  However, the
22183 results vary from program to program, so it is left as a user option,
22184 rather than being permanently enabled.
22186 @item -mno-inefficient-warnings
22187 Disables warnings about the generation of inefficient code.  These
22188 warnings can be generated, for example, when compiling code that
22189 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22190 no hardware support for byte-level memory operations, so all byte
22191 load/stores must be synthesized from word load/store operations.  This is
22192 inefficient and a warning is generated to indicate
22193 that you should rewrite the code to avoid byte operations, or to target
22194 an AE type that has the necessary hardware support.  This option disables
22195 these warnings.
22197 @end table
22199 @node PowerPC Options
22200 @subsection PowerPC Options
22201 @cindex PowerPC options
22203 These are listed under @xref{RS/6000 and PowerPC Options}.
22205 @node PowerPC SPE Options
22206 @subsection PowerPC SPE Options
22207 @cindex PowerPC SPE options
22209 These @samp{-m} options are defined for PowerPC SPE:
22210 @table @gcctabopt
22211 @item -mmfcrf
22212 @itemx -mno-mfcrf
22213 @itemx -mpopcntb
22214 @itemx -mno-popcntb
22215 @opindex mmfcrf
22216 @opindex mno-mfcrf
22217 @opindex mpopcntb
22218 @opindex mno-popcntb
22219 You use these options to specify which instructions are available on the
22220 processor you are using.  The default value of these options is
22221 determined when configuring GCC@.  Specifying the
22222 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22223 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22224 rather than the options listed above.
22226 The @option{-mmfcrf} option allows GCC to generate the move from
22227 condition register field instruction implemented on the POWER4
22228 processor and other processors that support the PowerPC V2.01
22229 architecture.
22230 The @option{-mpopcntb} option allows GCC to generate the popcount and
22231 double-precision FP reciprocal estimate instruction implemented on the
22232 POWER5 processor and other processors that support the PowerPC V2.02
22233 architecture.
22235 @item -mcpu=@var{cpu_type}
22236 @opindex mcpu
22237 Set architecture type, register usage, and
22238 instruction scheduling parameters for machine type @var{cpu_type}.
22239 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22240 and @samp{native}.
22242 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22243 endian), with an appropriate, generic processor model assumed for
22244 scheduling purposes.
22246 Specifying @samp{native} as cpu type detects and selects the
22247 architecture option that corresponds to the host processor of the
22248 system performing the compilation.
22249 @option{-mcpu=native} has no effect if GCC does not recognize the
22250 processor.
22252 The other options specify a specific processor.  Code generated under
22253 those options runs best on that processor, and may not run at all on
22254 others.
22256 The @option{-mcpu} options automatically enable or disable the
22257 following options:
22259 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22260 -mpopcntb -mpopcntd @gol
22261 -msingle-float -mdouble-float @gol
22262 -mfloat128}
22264 The particular options set for any particular CPU varies between
22265 compiler versions, depending on what setting seems to produce optimal
22266 code for that CPU; it doesn't necessarily reflect the actual hardware's
22267 capabilities.  If you wish to set an individual option to a particular
22268 value, you may specify it after the @option{-mcpu} option, like
22269 @option{-mcpu=8548}.
22271 @item -mtune=@var{cpu_type}
22272 @opindex mtune
22273 Set the instruction scheduling parameters for machine type
22274 @var{cpu_type}, but do not set the architecture type or register usage,
22275 as @option{-mcpu=@var{cpu_type}} does.  The same
22276 values for @var{cpu_type} are used for @option{-mtune} as for
22277 @option{-mcpu}.  If both are specified, the code generated uses the
22278 architecture and registers set by @option{-mcpu}, but the
22279 scheduling parameters set by @option{-mtune}.
22281 @item -msecure-plt
22282 @opindex msecure-plt
22283 Generate code that allows @command{ld} and @command{ld.so}
22284 to build executables and shared
22285 libraries with non-executable @code{.plt} and @code{.got} sections.
22286 This is a PowerPC
22287 32-bit SYSV ABI option.
22289 @item -mbss-plt
22290 @opindex mbss-plt
22291 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22292 fills in, and
22293 requires @code{.plt} and @code{.got}
22294 sections that are both writable and executable.
22295 This is a PowerPC 32-bit SYSV ABI option.
22297 @item -misel
22298 @itemx -mno-isel
22299 @opindex misel
22300 @opindex mno-isel
22301 This switch enables or disables the generation of ISEL instructions.
22303 @item -misel=@var{yes/no}
22304 This switch has been deprecated.  Use @option{-misel} and
22305 @option{-mno-isel} instead.
22307 @item -mspe
22308 @itemx -mno-spe
22309 @opindex mspe
22310 @opindex mno-spe
22311 This switch enables or disables the generation of SPE simd
22312 instructions.
22314 @item -mspe=@var{yes/no}
22315 This option has been deprecated.  Use @option{-mspe} and
22316 @option{-mno-spe} instead.
22318 @item -mfloat128
22319 @itemx -mno-float128
22320 @opindex mfloat128
22321 @opindex mno-float128
22322 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22323 and use either software emulation for IEEE 128-bit floating point or
22324 hardware instructions.
22326 @item -mfloat-gprs=@var{yes/single/double/no}
22327 @itemx -mfloat-gprs
22328 @opindex mfloat-gprs
22329 This switch enables or disables the generation of floating-point
22330 operations on the general-purpose registers for architectures that
22331 support it.
22333 The argument @samp{yes} or @samp{single} enables the use of
22334 single-precision floating-point operations.
22336 The argument @samp{double} enables the use of single and
22337 double-precision floating-point operations.
22339 The argument @samp{no} disables floating-point operations on the
22340 general-purpose registers.
22342 This option is currently only available on the MPC854x.
22344 @item -mfull-toc
22345 @itemx -mno-fp-in-toc
22346 @itemx -mno-sum-in-toc
22347 @itemx -mminimal-toc
22348 @opindex mfull-toc
22349 @opindex mno-fp-in-toc
22350 @opindex mno-sum-in-toc
22351 @opindex mminimal-toc
22352 Modify generation of the TOC (Table Of Contents), which is created for
22353 every executable file.  The @option{-mfull-toc} option is selected by
22354 default.  In that case, GCC allocates at least one TOC entry for
22355 each unique non-automatic variable reference in your program.  GCC
22356 also places floating-point constants in the TOC@.  However, only
22357 16,384 entries are available in the TOC@.
22359 If you receive a linker error message that saying you have overflowed
22360 the available TOC space, you can reduce the amount of TOC space used
22361 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22362 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22363 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22364 generate code to calculate the sum of an address and a constant at
22365 run time instead of putting that sum into the TOC@.  You may specify one
22366 or both of these options.  Each causes GCC to produce very slightly
22367 slower and larger code at the expense of conserving TOC space.
22369 If you still run out of space in the TOC even when you specify both of
22370 these options, specify @option{-mminimal-toc} instead.  This option causes
22371 GCC to make only one TOC entry for every file.  When you specify this
22372 option, GCC produces code that is slower and larger but which
22373 uses extremely little TOC space.  You may wish to use this option
22374 only on files that contain less frequently-executed code.
22376 @item -maix32
22377 @opindex maix32
22378 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22380 @item -mxl-compat
22381 @itemx -mno-xl-compat
22382 @opindex mxl-compat
22383 @opindex mno-xl-compat
22384 Produce code that conforms more closely to IBM XL compiler semantics
22385 when using AIX-compatible ABI@.  Pass floating-point arguments to
22386 prototyped functions beyond the register save area (RSA) on the stack
22387 in addition to argument FPRs.  Do not assume that most significant
22388 double in 128-bit long double value is properly rounded when comparing
22389 values and converting to double.  Use XL symbol names for long double
22390 support routines.
22392 The AIX calling convention was extended but not initially documented to
22393 handle an obscure K&R C case of calling a function that takes the
22394 address of its arguments with fewer arguments than declared.  IBM XL
22395 compilers access floating-point arguments that do not fit in the
22396 RSA from the stack when a subroutine is compiled without
22397 optimization.  Because always storing floating-point arguments on the
22398 stack is inefficient and rarely needed, this option is not enabled by
22399 default and only is necessary when calling subroutines compiled by IBM
22400 XL compilers without optimization.
22402 @item -malign-natural
22403 @itemx -malign-power
22404 @opindex malign-natural
22405 @opindex malign-power
22406 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22407 @option{-malign-natural} overrides the ABI-defined alignment of larger
22408 types, such as floating-point doubles, on their natural size-based boundary.
22409 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22410 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22412 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22413 is not supported.
22415 @item -msoft-float
22416 @itemx -mhard-float
22417 @opindex msoft-float
22418 @opindex mhard-float
22419 Generate code that does not use (uses) the floating-point register set.
22420 Software floating-point emulation is provided if you use the
22421 @option{-msoft-float} option, and pass the option to GCC when linking.
22423 @item -msingle-float
22424 @itemx -mdouble-float
22425 @opindex msingle-float
22426 @opindex mdouble-float
22427 Generate code for single- or double-precision floating-point operations.
22428 @option{-mdouble-float} implies @option{-msingle-float}.
22430 @item -mmultiple
22431 @itemx -mno-multiple
22432 @opindex mmultiple
22433 @opindex mno-multiple
22434 Generate code that uses (does not use) the load multiple word
22435 instructions and the store multiple word instructions.  These
22436 instructions are generated by default on POWER systems, and not
22437 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22438 PowerPC systems, since those instructions do not work when the
22439 processor is in little-endian mode.  The exceptions are PPC740 and
22440 PPC750 which permit these instructions in little-endian mode.
22442 @item -mupdate
22443 @itemx -mno-update
22444 @opindex mupdate
22445 @opindex mno-update
22446 Generate code that uses (does not use) the load or store instructions
22447 that update the base register to the address of the calculated memory
22448 location.  These instructions are generated by default.  If you use
22449 @option{-mno-update}, there is a small window between the time that the
22450 stack pointer is updated and the address of the previous frame is
22451 stored, which means code that walks the stack frame across interrupts or
22452 signals may get corrupted data.
22454 @item -mavoid-indexed-addresses
22455 @itemx -mno-avoid-indexed-addresses
22456 @opindex mavoid-indexed-addresses
22457 @opindex mno-avoid-indexed-addresses
22458 Generate code that tries to avoid (not avoid) the use of indexed load
22459 or store instructions. These instructions can incur a performance
22460 penalty on Power6 processors in certain situations, such as when
22461 stepping through large arrays that cross a 16M boundary.  This option
22462 is enabled by default when targeting Power6 and disabled otherwise.
22464 @item -mfused-madd
22465 @itemx -mno-fused-madd
22466 @opindex mfused-madd
22467 @opindex mno-fused-madd
22468 Generate code that uses (does not use) the floating-point multiply and
22469 accumulate instructions.  These instructions are generated by default
22470 if hardware floating point is used.  The machine-dependent
22471 @option{-mfused-madd} option is now mapped to the machine-independent
22472 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22473 mapped to @option{-ffp-contract=off}.
22475 @item -mno-strict-align
22476 @itemx -mstrict-align
22477 @opindex mno-strict-align
22478 @opindex mstrict-align
22479 On System V.4 and embedded PowerPC systems do not (do) assume that
22480 unaligned memory references are handled by the system.
22482 @item -mrelocatable
22483 @itemx -mno-relocatable
22484 @opindex mrelocatable
22485 @opindex mno-relocatable
22486 Generate code that allows (does not allow) a static executable to be
22487 relocated to a different address at run time.  A simple embedded
22488 PowerPC system loader should relocate the entire contents of
22489 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22490 a table of 32-bit addresses generated by this option.  For this to
22491 work, all objects linked together must be compiled with
22492 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22493 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22495 @item -mrelocatable-lib
22496 @itemx -mno-relocatable-lib
22497 @opindex mrelocatable-lib
22498 @opindex mno-relocatable-lib
22499 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22500 @code{.fixup} section to allow static executables to be relocated at
22501 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22502 alignment of @option{-mrelocatable}.  Objects compiled with
22503 @option{-mrelocatable-lib} may be linked with objects compiled with
22504 any combination of the @option{-mrelocatable} options.
22506 @item -mno-toc
22507 @itemx -mtoc
22508 @opindex mno-toc
22509 @opindex mtoc
22510 On System V.4 and embedded PowerPC systems do not (do) assume that
22511 register 2 contains a pointer to a global area pointing to the addresses
22512 used in the program.
22514 @item -mlittle
22515 @itemx -mlittle-endian
22516 @opindex mlittle
22517 @opindex mlittle-endian
22518 On System V.4 and embedded PowerPC systems compile code for the
22519 processor in little-endian mode.  The @option{-mlittle-endian} option is
22520 the same as @option{-mlittle}.
22522 @item -mbig
22523 @itemx -mbig-endian
22524 @opindex mbig
22525 @opindex mbig-endian
22526 On System V.4 and embedded PowerPC systems compile code for the
22527 processor in big-endian mode.  The @option{-mbig-endian} option is
22528 the same as @option{-mbig}.
22530 @item -mdynamic-no-pic
22531 @opindex mdynamic-no-pic
22532 On Darwin and Mac OS X systems, compile code so that it is not
22533 relocatable, but that its external references are relocatable.  The
22534 resulting code is suitable for applications, but not shared
22535 libraries.
22537 @item -msingle-pic-base
22538 @opindex msingle-pic-base
22539 Treat the register used for PIC addressing as read-only, rather than
22540 loading it in the prologue for each function.  The runtime system is
22541 responsible for initializing this register with an appropriate value
22542 before execution begins.
22544 @item -mprioritize-restricted-insns=@var{priority}
22545 @opindex mprioritize-restricted-insns
22546 This option controls the priority that is assigned to
22547 dispatch-slot restricted instructions during the second scheduling
22548 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22549 or @samp{2} to assign no, highest, or second-highest (respectively)
22550 priority to dispatch-slot restricted
22551 instructions.
22553 @item -msched-costly-dep=@var{dependence_type}
22554 @opindex msched-costly-dep
22555 This option controls which dependences are considered costly
22556 by the target during instruction scheduling.  The argument
22557 @var{dependence_type} takes one of the following values:
22559 @table @asis
22560 @item @samp{no}
22561 No dependence is costly.
22563 @item @samp{all}
22564 All dependences are costly.
22566 @item @samp{true_store_to_load}
22567 A true dependence from store to load is costly.
22569 @item @samp{store_to_load}
22570 Any dependence from store to load is costly.
22572 @item @var{number}
22573 Any dependence for which the latency is greater than or equal to
22574 @var{number} is costly.
22575 @end table
22577 @item -minsert-sched-nops=@var{scheme}
22578 @opindex minsert-sched-nops
22579 This option controls which NOP insertion scheme is used during
22580 the second scheduling pass.  The argument @var{scheme} takes one of the
22581 following values:
22583 @table @asis
22584 @item @samp{no}
22585 Don't insert NOPs.
22587 @item @samp{pad}
22588 Pad with NOPs any dispatch group that has vacant issue slots,
22589 according to the scheduler's grouping.
22591 @item @samp{regroup_exact}
22592 Insert NOPs to force costly dependent insns into
22593 separate groups.  Insert exactly as many NOPs as needed to force an insn
22594 to a new group, according to the estimated processor grouping.
22596 @item @var{number}
22597 Insert NOPs to force costly dependent insns into
22598 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22599 @end table
22601 @item -mcall-sysv
22602 @opindex mcall-sysv
22603 On System V.4 and embedded PowerPC systems compile code using calling
22604 conventions that adhere to the March 1995 draft of the System V
22605 Application Binary Interface, PowerPC processor supplement.  This is the
22606 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22608 @item -mcall-sysv-eabi
22609 @itemx -mcall-eabi
22610 @opindex mcall-sysv-eabi
22611 @opindex mcall-eabi
22612 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22614 @item -mcall-sysv-noeabi
22615 @opindex mcall-sysv-noeabi
22616 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22618 @item -mcall-aixdesc
22619 @opindex m
22620 On System V.4 and embedded PowerPC systems compile code for the AIX
22621 operating system.
22623 @item -mcall-linux
22624 @opindex mcall-linux
22625 On System V.4 and embedded PowerPC systems compile code for the
22626 Linux-based GNU system.
22628 @item -mcall-freebsd
22629 @opindex mcall-freebsd
22630 On System V.4 and embedded PowerPC systems compile code for the
22631 FreeBSD operating system.
22633 @item -mcall-netbsd
22634 @opindex mcall-netbsd
22635 On System V.4 and embedded PowerPC systems compile code for the
22636 NetBSD operating system.
22638 @item -mcall-openbsd
22639 @opindex mcall-netbsd
22640 On System V.4 and embedded PowerPC systems compile code for the
22641 OpenBSD operating system.
22643 @item -maix-struct-return
22644 @opindex maix-struct-return
22645 Return all structures in memory (as specified by the AIX ABI)@.
22647 @item -msvr4-struct-return
22648 @opindex msvr4-struct-return
22649 Return structures smaller than 8 bytes in registers (as specified by the
22650 SVR4 ABI)@.
22652 @item -mabi=@var{abi-type}
22653 @opindex mabi
22654 Extend the current ABI with a particular extension, or remove such extension.
22655 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22656 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22657 @samp{elfv1}, @samp{elfv2}@.
22659 @item -mabi=spe
22660 @opindex mabi=spe
22661 Extend the current ABI with SPE ABI extensions.  This does not change
22662 the default ABI, instead it adds the SPE ABI extensions to the current
22663 ABI@.
22665 @item -mabi=no-spe
22666 @opindex mabi=no-spe
22667 Disable Book-E SPE ABI extensions for the current ABI@.
22669 @item -mabi=ibmlongdouble
22670 @opindex mabi=ibmlongdouble
22671 Change the current ABI to use IBM extended-precision long double.
22672 This is not likely to work if your system defaults to using IEEE
22673 extended-precision long double.  If you change the long double type
22674 from IEEE extended-precision, the compiler will issue a warning unless
22675 you use the @option{-Wno-psabi} option.
22677 @item -mabi=ieeelongdouble
22678 @opindex mabi=ieeelongdouble
22679 Change the current ABI to use IEEE extended-precision long double.
22680 This is not likely to work if your system defaults to using IBM
22681 extended-precision long double.  If you change the long double type
22682 from IBM extended-precision, the compiler will issue a warning unless
22683 you use the @option{-Wno-psabi} option.
22685 @item -mabi=elfv1
22686 @opindex mabi=elfv1
22687 Change the current ABI to use the ELFv1 ABI.
22688 This is the default ABI for big-endian PowerPC 64-bit Linux.
22689 Overriding the default ABI requires special system support and is
22690 likely to fail in spectacular ways.
22692 @item -mabi=elfv2
22693 @opindex mabi=elfv2
22694 Change the current ABI to use the ELFv2 ABI.
22695 This is the default ABI for little-endian PowerPC 64-bit Linux.
22696 Overriding the default ABI requires special system support and is
22697 likely to fail in spectacular ways.
22699 @item -mgnu-attribute
22700 @itemx -mno-gnu-attribute
22701 @opindex mgnu-attribute
22702 @opindex mno-gnu-attribute
22703 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22704 .gnu.attributes section that specify ABI variations in function
22705 parameters or return values.
22707 @item -mprototype
22708 @itemx -mno-prototype
22709 @opindex mprototype
22710 @opindex mno-prototype
22711 On System V.4 and embedded PowerPC systems assume that all calls to
22712 variable argument functions are properly prototyped.  Otherwise, the
22713 compiler must insert an instruction before every non-prototyped call to
22714 set or clear bit 6 of the condition code register (@code{CR}) to
22715 indicate whether floating-point values are passed in the floating-point
22716 registers in case the function takes variable arguments.  With
22717 @option{-mprototype}, only calls to prototyped variable argument functions
22718 set or clear the bit.
22720 @item -msim
22721 @opindex msim
22722 On embedded PowerPC systems, assume that the startup module is called
22723 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22724 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22725 configurations.
22727 @item -mmvme
22728 @opindex mmvme
22729 On embedded PowerPC systems, assume that the startup module is called
22730 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22731 @file{libc.a}.
22733 @item -mads
22734 @opindex mads
22735 On embedded PowerPC systems, assume that the startup module is called
22736 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22737 @file{libc.a}.
22739 @item -myellowknife
22740 @opindex myellowknife
22741 On embedded PowerPC systems, assume that the startup module is called
22742 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22743 @file{libc.a}.
22745 @item -mvxworks
22746 @opindex mvxworks
22747 On System V.4 and embedded PowerPC systems, specify that you are
22748 compiling for a VxWorks system.
22750 @item -memb
22751 @opindex memb
22752 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22753 header to indicate that @samp{eabi} extended relocations are used.
22755 @item -meabi
22756 @itemx -mno-eabi
22757 @opindex meabi
22758 @opindex mno-eabi
22759 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22760 Embedded Applications Binary Interface (EABI), which is a set of
22761 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22762 means that the stack is aligned to an 8-byte boundary, a function
22763 @code{__eabi} is called from @code{main} to set up the EABI
22764 environment, and the @option{-msdata} option can use both @code{r2} and
22765 @code{r13} to point to two separate small data areas.  Selecting
22766 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22767 no EABI initialization function is called from @code{main}, and the
22768 @option{-msdata} option only uses @code{r13} to point to a single
22769 small data area.  The @option{-meabi} option is on by default if you
22770 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22772 @item -msdata=eabi
22773 @opindex msdata=eabi
22774 On System V.4 and embedded PowerPC systems, put small initialized
22775 @code{const} global and static data in the @code{.sdata2} section, which
22776 is pointed to by register @code{r2}.  Put small initialized
22777 non-@code{const} global and static data in the @code{.sdata} section,
22778 which is pointed to by register @code{r13}.  Put small uninitialized
22779 global and static data in the @code{.sbss} section, which is adjacent to
22780 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22781 incompatible with the @option{-mrelocatable} option.  The
22782 @option{-msdata=eabi} option also sets the @option{-memb} option.
22784 @item -msdata=sysv
22785 @opindex msdata=sysv
22786 On System V.4 and embedded PowerPC systems, put small global and static
22787 data in the @code{.sdata} section, which is pointed to by register
22788 @code{r13}.  Put small uninitialized global and static data in the
22789 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22790 The @option{-msdata=sysv} option is incompatible with the
22791 @option{-mrelocatable} option.
22793 @item -msdata=default
22794 @itemx -msdata
22795 @opindex msdata=default
22796 @opindex msdata
22797 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22798 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22799 same as @option{-msdata=sysv}.
22801 @item -msdata=data
22802 @opindex msdata=data
22803 On System V.4 and embedded PowerPC systems, put small global
22804 data in the @code{.sdata} section.  Put small uninitialized global
22805 data in the @code{.sbss} section.  Do not use register @code{r13}
22806 to address small data however.  This is the default behavior unless
22807 other @option{-msdata} options are used.
22809 @item -msdata=none
22810 @itemx -mno-sdata
22811 @opindex msdata=none
22812 @opindex mno-sdata
22813 On embedded PowerPC systems, put all initialized global and static data
22814 in the @code{.data} section, and all uninitialized data in the
22815 @code{.bss} section.
22817 @item -mblock-move-inline-limit=@var{num}
22818 @opindex mblock-move-inline-limit
22819 Inline all block moves (such as calls to @code{memcpy} or structure
22820 copies) less than or equal to @var{num} bytes.  The minimum value for
22821 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22822 targets.  The default value is target-specific.
22824 @item -G @var{num}
22825 @opindex G
22826 @cindex smaller data references (PowerPC)
22827 @cindex .sdata/.sdata2 references (PowerPC)
22828 On embedded PowerPC systems, put global and static items less than or
22829 equal to @var{num} bytes into the small data or BSS sections instead of
22830 the normal data or BSS section.  By default, @var{num} is 8.  The
22831 @option{-G @var{num}} switch is also passed to the linker.
22832 All modules should be compiled with the same @option{-G @var{num}} value.
22834 @item -mregnames
22835 @itemx -mno-regnames
22836 @opindex mregnames
22837 @opindex mno-regnames
22838 On System V.4 and embedded PowerPC systems do (do not) emit register
22839 names in the assembly language output using symbolic forms.
22841 @item -mlongcall
22842 @itemx -mno-longcall
22843 @opindex mlongcall
22844 @opindex mno-longcall
22845 By default assume that all calls are far away so that a longer and more
22846 expensive calling sequence is required.  This is required for calls
22847 farther than 32 megabytes (33,554,432 bytes) from the current location.
22848 A short call is generated if the compiler knows
22849 the call cannot be that far away.  This setting can be overridden by
22850 the @code{shortcall} function attribute, or by @code{#pragma
22851 longcall(0)}.
22853 Some linkers are capable of detecting out-of-range calls and generating
22854 glue code on the fly.  On these systems, long calls are unnecessary and
22855 generate slower code.  As of this writing, the AIX linker can do this,
22856 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22857 to the GNU linker for 32-bit PowerPC systems as well.
22859 In the future, GCC may ignore all longcall specifications
22860 when the linker is known to generate glue.
22862 @item -mtls-markers
22863 @itemx -mno-tls-markers
22864 @opindex mtls-markers
22865 @opindex mno-tls-markers
22866 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22867 specifying the function argument.  The relocation allows the linker to
22868 reliably associate function call with argument setup instructions for
22869 TLS optimization, which in turn allows GCC to better schedule the
22870 sequence.
22872 @item -mrecip
22873 @itemx -mno-recip
22874 @opindex mrecip
22875 This option enables use of the reciprocal estimate and
22876 reciprocal square root estimate instructions with additional
22877 Newton-Raphson steps to increase precision instead of doing a divide or
22878 square root and divide for floating-point arguments.  You should use
22879 the @option{-ffast-math} option when using @option{-mrecip} (or at
22880 least @option{-funsafe-math-optimizations},
22881 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22882 @option{-fno-trapping-math}).  Note that while the throughput of the
22883 sequence is generally higher than the throughput of the non-reciprocal
22884 instruction, the precision of the sequence can be decreased by up to 2
22885 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22886 roots.
22888 @item -mrecip=@var{opt}
22889 @opindex mrecip=opt
22890 This option controls which reciprocal estimate instructions
22891 may be used.  @var{opt} is a comma-separated list of options, which may
22892 be preceded by a @code{!} to invert the option:
22894 @table @samp
22896 @item all
22897 Enable all estimate instructions.
22899 @item default
22900 Enable the default instructions, equivalent to @option{-mrecip}.
22902 @item none
22903 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22905 @item div
22906 Enable the reciprocal approximation instructions for both
22907 single and double precision.
22909 @item divf
22910 Enable the single-precision reciprocal approximation instructions.
22912 @item divd
22913 Enable the double-precision reciprocal approximation instructions.
22915 @item rsqrt
22916 Enable the reciprocal square root approximation instructions for both
22917 single and double precision.
22919 @item rsqrtf
22920 Enable the single-precision reciprocal square root approximation instructions.
22922 @item rsqrtd
22923 Enable the double-precision reciprocal square root approximation instructions.
22925 @end table
22927 So, for example, @option{-mrecip=all,!rsqrtd} enables
22928 all of the reciprocal estimate instructions, except for the
22929 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22930 which handle the double-precision reciprocal square root calculations.
22932 @item -mrecip-precision
22933 @itemx -mno-recip-precision
22934 @opindex mrecip-precision
22935 Assume (do not assume) that the reciprocal estimate instructions
22936 provide higher-precision estimates than is mandated by the PowerPC
22937 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22938 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22939 The double-precision square root estimate instructions are not generated by
22940 default on low-precision machines, since they do not provide an
22941 estimate that converges after three steps.
22943 @item -mpointers-to-nested-functions
22944 @itemx -mno-pointers-to-nested-functions
22945 @opindex mpointers-to-nested-functions
22946 Generate (do not generate) code to load up the static chain register
22947 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22948 systems where a function pointer points to a 3-word descriptor giving
22949 the function address, TOC value to be loaded in register @code{r2}, and
22950 static chain value to be loaded in register @code{r11}.  The
22951 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22952 call through pointers to nested functions or pointers
22953 to functions compiled in other languages that use the static chain if
22954 you use @option{-mno-pointers-to-nested-functions}.
22956 @item -msave-toc-indirect
22957 @itemx -mno-save-toc-indirect
22958 @opindex msave-toc-indirect
22959 Generate (do not generate) code to save the TOC value in the reserved
22960 stack location in the function prologue if the function calls through
22961 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22962 saved in the prologue, it is saved just before the call through the
22963 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22965 @item -mcompat-align-parm
22966 @itemx -mno-compat-align-parm
22967 @opindex mcompat-align-parm
22968 Generate (do not generate) code to pass structure parameters with a
22969 maximum alignment of 64 bits, for compatibility with older versions
22970 of GCC.
22972 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22973 structure parameter on a 128-bit boundary when that structure contained
22974 a member requiring 128-bit alignment.  This is corrected in more
22975 recent versions of GCC.  This option may be used to generate code
22976 that is compatible with functions compiled with older versions of
22977 GCC.
22979 The @option{-mno-compat-align-parm} option is the default.
22981 @item -mstack-protector-guard=@var{guard}
22982 @itemx -mstack-protector-guard-reg=@var{reg}
22983 @itemx -mstack-protector-guard-offset=@var{offset}
22984 @itemx -mstack-protector-guard-symbol=@var{symbol}
22985 @opindex mstack-protector-guard
22986 @opindex mstack-protector-guard-reg
22987 @opindex mstack-protector-guard-offset
22988 @opindex mstack-protector-guard-symbol
22989 Generate stack protection code using canary at @var{guard}.  Supported
22990 locations are @samp{global} for global canary or @samp{tls} for per-thread
22991 canary in the TLS block (the default with GNU libc version 2.4 or later).
22993 With the latter choice the options
22994 @option{-mstack-protector-guard-reg=@var{reg}} and
22995 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22996 which register to use as base register for reading the canary, and from what
22997 offset from that base register. The default for those is as specified in the
22998 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22999 the offset with a symbol reference to a canary in the TLS block.
23000 @end table
23003 @node RISC-V Options
23004 @subsection RISC-V Options
23005 @cindex RISC-V Options
23007 These command-line options are defined for RISC-V targets:
23009 @table @gcctabopt
23010 @item -mbranch-cost=@var{n}
23011 @opindex mbranch-cost
23012 Set the cost of branches to roughly @var{n} instructions.
23014 @item -mplt
23015 @itemx -mno-plt
23016 @opindex plt
23017 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23018 non-PIC.  The default is @option{-mplt}.
23020 @item -mabi=@var{ABI-string}
23021 @opindex mabi
23022 Specify integer and floating-point calling convention.  @var{ABI-string}
23023 contains two parts: the size of integer types and the registers used for
23024 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23025 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23026 32-bit), and that floating-point values up to 64 bits wide are passed in F
23027 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23028 allows the compiler to generate code that uses the F and D extensions but only
23029 allows floating-point values up to 32 bits long to be passed in registers; or
23030 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23031 passed in registers.
23033 The default for this argument is system dependent, users who want a specific
23034 calling convention should specify one explicitly.  The valid calling
23035 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23036 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23037 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23038 invalid because the ABI requires 64-bit values be passed in F registers, but F
23039 registers are only 32 bits wide.
23041 @item -mfdiv
23042 @itemx -mno-fdiv
23043 @opindex mfdiv
23044 Do or don't use hardware floating-point divide and square root instructions.
23045 This requires the F or D extensions for floating-point registers.  The default
23046 is to use them if the specified architecture has these instructions.
23048 @item -mdiv
23049 @itemx -mno-div
23050 @opindex mdiv
23051 Do or don't use hardware instructions for integer division.  This requires the
23052 M extension.  The default is to use them if the specified architecture has
23053 these instructions.
23055 @item -march=@var{ISA-string}
23056 @opindex march
23057 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23058 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23060 @item -mtune=@var{processor-string}
23061 @opindex mtune
23062 Optimize the output for the given processor, specified by microarchitecture
23063 name.
23065 @item -mpreferred-stack-boundary=@var{num}
23066 @opindex mpreferred-stack-boundary
23067 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23068 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23069 the default is 4 (16 bytes or 128-bits).
23071 @strong{Warning:} If you use this switch, then you must build all modules with
23072 the same value, including any libraries.  This includes the system libraries
23073 and startup modules.
23075 @item -msmall-data-limit=@var{n}
23076 @opindex msmall-data-limit
23077 Put global and static data smaller than @var{n} bytes into a special section
23078 (on some targets).
23080 @item -msave-restore
23081 @itemx -mno-save-restore
23082 @opindex msave-restore
23083 Do or don't use smaller but slower prologue and epilogue code that uses
23084 library function calls.  The default is to use fast inline prologues and
23085 epilogues.
23087 @item -mstrict-align
23088 @itemx -mno-strict-align
23089 @opindex mstrict-align
23090 Do not or do generate unaligned memory accesses.  The default is set depending
23091 on whether the processor we are optimizing for supports fast unaligned access
23092 or not.
23094 @item -mcmodel=medlow
23095 @opindex mcmodel=medlow
23096 Generate code for the medium-low code model. The program and its statically
23097 defined symbols must lie within a single 2 GiB address range and must lie
23098 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23099 statically or dynamically linked. This is the default code model.
23101 @item -mcmodel=medany
23102 @opindex mcmodel=medany
23103 Generate code for the medium-any code model. The program and its statically
23104 defined symbols must be within any single 2 GiB address range. Programs can be
23105 statically or dynamically linked.
23107 @item -mexplicit-relocs
23108 @itemx -mno-exlicit-relocs
23109 Use or do not use assembler relocation operators when dealing with symbolic
23110 addresses.  The alternative is to use assembler macros instead, which may
23111 limit optimization.
23113 @item -mrelax
23114 @itemx -mno-relax
23115 Take advantage of linker relaxations to reduce the number of instructions
23116 required to materialize symbol addresses. The default is to take advantage of
23117 linker relaxations.
23119 @end table
23121 @node RL78 Options
23122 @subsection RL78 Options
23123 @cindex RL78 Options
23125 @table @gcctabopt
23127 @item -msim
23128 @opindex msim
23129 Links in additional target libraries to support operation within a
23130 simulator.
23132 @item -mmul=none
23133 @itemx -mmul=g10
23134 @itemx -mmul=g13
23135 @itemx -mmul=g14
23136 @itemx -mmul=rl78
23137 @opindex mmul
23138 Specifies the type of hardware multiplication and division support to
23139 be used.  The simplest is @code{none}, which uses software for both
23140 multiplication and division.  This is the default.  The @code{g13}
23141 value is for the hardware multiply/divide peripheral found on the
23142 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23143 the multiplication and division instructions supported by the RL78/G14
23144 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23145 the value @code{mg10} is an alias for @code{none}.
23147 In addition a C preprocessor macro is defined, based upon the setting
23148 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23149 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23151 @item -mcpu=g10
23152 @itemx -mcpu=g13
23153 @itemx -mcpu=g14
23154 @itemx -mcpu=rl78
23155 @opindex mcpu
23156 Specifies the RL78 core to target.  The default is the G14 core, also
23157 known as an S3 core or just RL78.  The G13 or S2 core does not have
23158 multiply or divide instructions, instead it uses a hardware peripheral
23159 for these operations.  The G10 or S1 core does not have register
23160 banks, so it uses a different calling convention.
23162 If this option is set it also selects the type of hardware multiply
23163 support to use, unless this is overridden by an explicit
23164 @option{-mmul=none} option on the command line.  Thus specifying
23165 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23166 peripheral and specifying @option{-mcpu=g10} disables the use of
23167 hardware multiplications altogether.
23169 Note, although the RL78/G14 core is the default target, specifying
23170 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23171 change the behavior of the toolchain since it also enables G14
23172 hardware multiply support.  If these options are not specified on the
23173 command line then software multiplication routines will be used even
23174 though the code targets the RL78 core.  This is for backwards
23175 compatibility with older toolchains which did not have hardware
23176 multiply and divide support.
23178 In addition a C preprocessor macro is defined, based upon the setting
23179 of this option.  Possible values are: @code{__RL78_G10__},
23180 @code{__RL78_G13__} or @code{__RL78_G14__}.
23182 @item -mg10
23183 @itemx -mg13
23184 @itemx -mg14
23185 @itemx -mrl78
23186 @opindex mg10
23187 @opindex mg13
23188 @opindex mg14
23189 @opindex mrl78
23190 These are aliases for the corresponding @option{-mcpu=} option.  They
23191 are provided for backwards compatibility.
23193 @item -mallregs
23194 @opindex mallregs
23195 Allow the compiler to use all of the available registers.  By default
23196 registers @code{r24..r31} are reserved for use in interrupt handlers.
23197 With this option enabled these registers can be used in ordinary
23198 functions as well.
23200 @item -m64bit-doubles
23201 @itemx -m32bit-doubles
23202 @opindex m64bit-doubles
23203 @opindex m32bit-doubles
23204 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23205 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23206 @option{-m32bit-doubles}.
23208 @item -msave-mduc-in-interrupts
23209 @itemx -mno-save-mduc-in-interrupts
23210 @opindex msave-mduc-in-interrupts
23211 @opindex mno-save-mduc-in-interrupts
23212 Specifies that interrupt handler functions should preserve the
23213 MDUC registers.  This is only necessary if normal code might use
23214 the MDUC registers, for example because it performs multiplication
23215 and division operations.  The default is to ignore the MDUC registers
23216 as this makes the interrupt handlers faster.  The target option -mg13
23217 needs to be passed for this to work as this feature is only available
23218 on the G13 target (S2 core).  The MDUC registers will only be saved
23219 if the interrupt handler performs a multiplication or division
23220 operation or it calls another function.
23222 @end table
23224 @node RS/6000 and PowerPC Options
23225 @subsection IBM RS/6000 and PowerPC Options
23226 @cindex RS/6000 and PowerPC Options
23227 @cindex IBM RS/6000 and PowerPC Options
23229 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23230 @table @gcctabopt
23231 @item -mpowerpc-gpopt
23232 @itemx -mno-powerpc-gpopt
23233 @itemx -mpowerpc-gfxopt
23234 @itemx -mno-powerpc-gfxopt
23235 @need 800
23236 @itemx -mpowerpc64
23237 @itemx -mno-powerpc64
23238 @itemx -mmfcrf
23239 @itemx -mno-mfcrf
23240 @itemx -mpopcntb
23241 @itemx -mno-popcntb
23242 @itemx -mpopcntd
23243 @itemx -mno-popcntd
23244 @itemx -mfprnd
23245 @itemx -mno-fprnd
23246 @need 800
23247 @itemx -mcmpb
23248 @itemx -mno-cmpb
23249 @itemx -mmfpgpr
23250 @itemx -mno-mfpgpr
23251 @itemx -mhard-dfp
23252 @itemx -mno-hard-dfp
23253 @opindex mpowerpc-gpopt
23254 @opindex mno-powerpc-gpopt
23255 @opindex mpowerpc-gfxopt
23256 @opindex mno-powerpc-gfxopt
23257 @opindex mpowerpc64
23258 @opindex mno-powerpc64
23259 @opindex mmfcrf
23260 @opindex mno-mfcrf
23261 @opindex mpopcntb
23262 @opindex mno-popcntb
23263 @opindex mpopcntd
23264 @opindex mno-popcntd
23265 @opindex mfprnd
23266 @opindex mno-fprnd
23267 @opindex mcmpb
23268 @opindex mno-cmpb
23269 @opindex mmfpgpr
23270 @opindex mno-mfpgpr
23271 @opindex mhard-dfp
23272 @opindex mno-hard-dfp
23273 You use these options to specify which instructions are available on the
23274 processor you are using.  The default value of these options is
23275 determined when configuring GCC@.  Specifying the
23276 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23277 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23278 rather than the options listed above.
23280 Specifying @option{-mpowerpc-gpopt} allows
23281 GCC to use the optional PowerPC architecture instructions in the
23282 General Purpose group, including floating-point square root.  Specifying
23283 @option{-mpowerpc-gfxopt} allows GCC to
23284 use the optional PowerPC architecture instructions in the Graphics
23285 group, including floating-point select.
23287 The @option{-mmfcrf} option allows GCC to generate the move from
23288 condition register field instruction implemented on the POWER4
23289 processor and other processors that support the PowerPC V2.01
23290 architecture.
23291 The @option{-mpopcntb} option allows GCC to generate the popcount and
23292 double-precision FP reciprocal estimate instruction implemented on the
23293 POWER5 processor and other processors that support the PowerPC V2.02
23294 architecture.
23295 The @option{-mpopcntd} option allows GCC to generate the popcount
23296 instruction implemented on the POWER7 processor and other processors
23297 that support the PowerPC V2.06 architecture.
23298 The @option{-mfprnd} option allows GCC to generate the FP round to
23299 integer instructions implemented on the POWER5+ processor and other
23300 processors that support the PowerPC V2.03 architecture.
23301 The @option{-mcmpb} option allows GCC to generate the compare bytes
23302 instruction implemented on the POWER6 processor and other processors
23303 that support the PowerPC V2.05 architecture.
23304 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23305 general-purpose register instructions implemented on the POWER6X
23306 processor and other processors that support the extended PowerPC V2.05
23307 architecture.
23308 The @option{-mhard-dfp} option allows GCC to generate the decimal
23309 floating-point instructions implemented on some POWER processors.
23311 The @option{-mpowerpc64} option allows GCC to generate the additional
23312 64-bit instructions that are found in the full PowerPC64 architecture
23313 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23314 @option{-mno-powerpc64}.
23316 @item -mcpu=@var{cpu_type}
23317 @opindex mcpu
23318 Set architecture type, register usage, and
23319 instruction scheduling parameters for machine type @var{cpu_type}.
23320 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23321 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23322 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23323 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23324 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23325 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23326 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23327 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23328 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23329 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23330 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23331 @samp{rs64}, and @samp{native}.
23333 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23334 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23335 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23336 architecture machine types, with an appropriate, generic processor
23337 model assumed for scheduling purposes.
23339 Specifying @samp{native} as cpu type detects and selects the
23340 architecture option that corresponds to the host processor of the
23341 system performing the compilation.
23342 @option{-mcpu=native} has no effect if GCC does not recognize the
23343 processor.
23345 The other options specify a specific processor.  Code generated under
23346 those options runs best on that processor, and may not run at all on
23347 others.
23349 The @option{-mcpu} options automatically enable or disable the
23350 following options:
23352 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23353 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23354 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
23355 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23356 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
23357 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23359 The particular options set for any particular CPU varies between
23360 compiler versions, depending on what setting seems to produce optimal
23361 code for that CPU; it doesn't necessarily reflect the actual hardware's
23362 capabilities.  If you wish to set an individual option to a particular
23363 value, you may specify it after the @option{-mcpu} option, like
23364 @option{-mcpu=970 -mno-altivec}.
23366 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23367 not enabled or disabled by the @option{-mcpu} option at present because
23368 AIX does not have full support for these options.  You may still
23369 enable or disable them individually if you're sure it'll work in your
23370 environment.
23372 @item -mtune=@var{cpu_type}
23373 @opindex mtune
23374 Set the instruction scheduling parameters for machine type
23375 @var{cpu_type}, but do not set the architecture type or register usage,
23376 as @option{-mcpu=@var{cpu_type}} does.  The same
23377 values for @var{cpu_type} are used for @option{-mtune} as for
23378 @option{-mcpu}.  If both are specified, the code generated uses the
23379 architecture and registers set by @option{-mcpu}, but the
23380 scheduling parameters set by @option{-mtune}.
23382 @item -mcmodel=small
23383 @opindex mcmodel=small
23384 Generate PowerPC64 code for the small model: The TOC is limited to
23385 64k.
23387 @item -mcmodel=medium
23388 @opindex mcmodel=medium
23389 Generate PowerPC64 code for the medium model: The TOC and other static
23390 data may be up to a total of 4G in size.  This is the default for 64-bit
23391 Linux.
23393 @item -mcmodel=large
23394 @opindex mcmodel=large
23395 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23396 in size.  Other data and code is only limited by the 64-bit address
23397 space.
23399 @item -maltivec
23400 @itemx -mno-altivec
23401 @opindex maltivec
23402 @opindex mno-altivec
23403 Generate code that uses (does not use) AltiVec instructions, and also
23404 enable the use of built-in functions that allow more direct access to
23405 the AltiVec instruction set.  You may also need to set
23406 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23407 enhancements.
23409 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23410 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23411 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23412 match array element order corresponding to the endianness of the
23413 target.  That is, element zero identifies the leftmost element in a
23414 vector register when targeting a big-endian platform, and identifies
23415 the rightmost element in a vector register when targeting a
23416 little-endian platform.
23418 @item -maltivec=be
23419 @opindex maltivec=be
23420 Generate AltiVec instructions using big-endian element order,
23421 regardless of whether the target is big- or little-endian.  This is
23422 the default when targeting a big-endian platform.  Using this option
23423 is currently deprecated.  Support for this feature will be removed in
23424 GCC 9.
23426 The element order is used to interpret element numbers in AltiVec
23427 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23428 @code{vec_insert}.  By default, these match array element order
23429 corresponding to the endianness for the target.
23431 @item -maltivec=le
23432 @opindex maltivec=le
23433 Generate AltiVec instructions using little-endian element order,
23434 regardless of whether the target is big- or little-endian.  This is
23435 the default when targeting a little-endian platform.  This option is
23436 currently ignored when targeting a big-endian platform.
23438 The element order is used to interpret element numbers in AltiVec
23439 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23440 @code{vec_insert}.  By default, these match array element order
23441 corresponding to the endianness for the target.
23443 @item -mvrsave
23444 @itemx -mno-vrsave
23445 @opindex mvrsave
23446 @opindex mno-vrsave
23447 Generate VRSAVE instructions when generating AltiVec code.
23449 @item -msecure-plt
23450 @opindex msecure-plt
23451 Generate code that allows @command{ld} and @command{ld.so}
23452 to build executables and shared
23453 libraries with non-executable @code{.plt} and @code{.got} sections.
23454 This is a PowerPC
23455 32-bit SYSV ABI option.
23457 @item -mbss-plt
23458 @opindex mbss-plt
23459 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23460 fills in, and
23461 requires @code{.plt} and @code{.got}
23462 sections that are both writable and executable.
23463 This is a PowerPC 32-bit SYSV ABI option.
23465 @item -misel
23466 @itemx -mno-isel
23467 @opindex misel
23468 @opindex mno-isel
23469 This switch enables or disables the generation of ISEL instructions.
23471 @item -misel=@var{yes/no}
23472 This switch has been deprecated.  Use @option{-misel} and
23473 @option{-mno-isel} instead.
23475 @item -mpaired
23476 @itemx -mno-paired
23477 @opindex mpaired
23478 @opindex mno-paired
23479 This switch enables or disables the generation of PAIRED simd
23480 instructions.
23482 @item -mvsx
23483 @itemx -mno-vsx
23484 @opindex mvsx
23485 @opindex mno-vsx
23486 Generate code that uses (does not use) vector/scalar (VSX)
23487 instructions, and also enable the use of built-in functions that allow
23488 more direct access to the VSX instruction set.
23490 @item -mcrypto
23491 @itemx -mno-crypto
23492 @opindex mcrypto
23493 @opindex mno-crypto
23494 Enable the use (disable) of the built-in functions that allow direct
23495 access to the cryptographic instructions that were added in version
23496 2.07 of the PowerPC ISA.
23498 @item -mdirect-move
23499 @itemx -mno-direct-move
23500 @opindex mdirect-move
23501 @opindex mno-direct-move
23502 Generate code that uses (does not use) the instructions to move data
23503 between the general purpose registers and the vector/scalar (VSX)
23504 registers that were added in version 2.07 of the PowerPC ISA.
23506 @item -mhtm
23507 @itemx -mno-htm
23508 @opindex mhtm
23509 @opindex mno-htm
23510 Enable (disable) the use of the built-in functions that allow direct
23511 access to the Hardware Transactional Memory (HTM) instructions that
23512 were added in version 2.07 of the PowerPC ISA.
23514 @item -mpower8-fusion
23515 @itemx -mno-power8-fusion
23516 @opindex mpower8-fusion
23517 @opindex mno-power8-fusion
23518 Generate code that keeps (does not keeps) some integer operations
23519 adjacent so that the instructions can be fused together on power8 and
23520 later processors.
23522 @item -mpower8-vector
23523 @itemx -mno-power8-vector
23524 @opindex mpower8-vector
23525 @opindex mno-power8-vector
23526 Generate code that uses (does not use) the vector and scalar
23527 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23528 enable the use of built-in functions that allow more direct access to
23529 the vector instructions.
23531 @item -mquad-memory
23532 @itemx -mno-quad-memory
23533 @opindex mquad-memory
23534 @opindex mno-quad-memory
23535 Generate code that uses (does not use) the non-atomic quad word memory
23536 instructions.  The @option{-mquad-memory} option requires use of
23537 64-bit mode.
23539 @item -mquad-memory-atomic
23540 @itemx -mno-quad-memory-atomic
23541 @opindex mquad-memory-atomic
23542 @opindex mno-quad-memory-atomic
23543 Generate code that uses (does not use) the atomic quad word memory
23544 instructions.  The @option{-mquad-memory-atomic} option requires use of
23545 64-bit mode.
23547 @item -mfloat128
23548 @itemx -mno-float128
23549 @opindex mfloat128
23550 @opindex mno-float128
23551 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23552 and use either software emulation for IEEE 128-bit floating point or
23553 hardware instructions.
23555 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23556 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23557 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23558 floating point support only works on PowerPC Linux systems.
23560 The default for @option{-mfloat128} is enabled on PowerPC Linux
23561 systems using the VSX instruction set, and disabled on other systems.
23563 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23564 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23565 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23566 floating point instructions.  Otherwise, if you do not specify to
23567 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23568 system, IEEE 128-bit floating point will be done with software
23569 emulation.
23571 @item -mfloat128-hardware
23572 @itemx -mno-float128-hardware
23573 @opindex mfloat128-hardware
23574 @opindex mno-float128-hardware
23575 Enable/disable using ISA 3.0 hardware instructions to support the
23576 @var{__float128} data type.
23578 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23579 Linux systems using the ISA 3.0 instruction set, and disabled on other
23580 systems.
23582 @item -m32
23583 @itemx -m64
23584 @opindex m32
23585 @opindex m64
23586 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23587 targets (including GNU/Linux).  The 32-bit environment sets int, long
23588 and pointer to 32 bits and generates code that runs on any PowerPC
23589 variant.  The 64-bit environment sets int to 32 bits and long and
23590 pointer to 64 bits, and generates code for PowerPC64, as for
23591 @option{-mpowerpc64}.
23593 @item -mfull-toc
23594 @itemx -mno-fp-in-toc
23595 @itemx -mno-sum-in-toc
23596 @itemx -mminimal-toc
23597 @opindex mfull-toc
23598 @opindex mno-fp-in-toc
23599 @opindex mno-sum-in-toc
23600 @opindex mminimal-toc
23601 Modify generation of the TOC (Table Of Contents), which is created for
23602 every executable file.  The @option{-mfull-toc} option is selected by
23603 default.  In that case, GCC allocates at least one TOC entry for
23604 each unique non-automatic variable reference in your program.  GCC
23605 also places floating-point constants in the TOC@.  However, only
23606 16,384 entries are available in the TOC@.
23608 If you receive a linker error message that saying you have overflowed
23609 the available TOC space, you can reduce the amount of TOC space used
23610 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23611 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23612 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23613 generate code to calculate the sum of an address and a constant at
23614 run time instead of putting that sum into the TOC@.  You may specify one
23615 or both of these options.  Each causes GCC to produce very slightly
23616 slower and larger code at the expense of conserving TOC space.
23618 If you still run out of space in the TOC even when you specify both of
23619 these options, specify @option{-mminimal-toc} instead.  This option causes
23620 GCC to make only one TOC entry for every file.  When you specify this
23621 option, GCC produces code that is slower and larger but which
23622 uses extremely little TOC space.  You may wish to use this option
23623 only on files that contain less frequently-executed code.
23625 @item -maix64
23626 @itemx -maix32
23627 @opindex maix64
23628 @opindex maix32
23629 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23630 @code{long} type, and the infrastructure needed to support them.
23631 Specifying @option{-maix64} implies @option{-mpowerpc64},
23632 while @option{-maix32} disables the 64-bit ABI and
23633 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23635 @item -mxl-compat
23636 @itemx -mno-xl-compat
23637 @opindex mxl-compat
23638 @opindex mno-xl-compat
23639 Produce code that conforms more closely to IBM XL compiler semantics
23640 when using AIX-compatible ABI@.  Pass floating-point arguments to
23641 prototyped functions beyond the register save area (RSA) on the stack
23642 in addition to argument FPRs.  Do not assume that most significant
23643 double in 128-bit long double value is properly rounded when comparing
23644 values and converting to double.  Use XL symbol names for long double
23645 support routines.
23647 The AIX calling convention was extended but not initially documented to
23648 handle an obscure K&R C case of calling a function that takes the
23649 address of its arguments with fewer arguments than declared.  IBM XL
23650 compilers access floating-point arguments that do not fit in the
23651 RSA from the stack when a subroutine is compiled without
23652 optimization.  Because always storing floating-point arguments on the
23653 stack is inefficient and rarely needed, this option is not enabled by
23654 default and only is necessary when calling subroutines compiled by IBM
23655 XL compilers without optimization.
23657 @item -mpe
23658 @opindex mpe
23659 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23660 application written to use message passing with special startup code to
23661 enable the application to run.  The system must have PE installed in the
23662 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23663 must be overridden with the @option{-specs=} option to specify the
23664 appropriate directory location.  The Parallel Environment does not
23665 support threads, so the @option{-mpe} option and the @option{-pthread}
23666 option are incompatible.
23668 @item -malign-natural
23669 @itemx -malign-power
23670 @opindex malign-natural
23671 @opindex malign-power
23672 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23673 @option{-malign-natural} overrides the ABI-defined alignment of larger
23674 types, such as floating-point doubles, on their natural size-based boundary.
23675 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23676 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23678 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23679 is not supported.
23681 @item -msoft-float
23682 @itemx -mhard-float
23683 @opindex msoft-float
23684 @opindex mhard-float
23685 Generate code that does not use (uses) the floating-point register set.
23686 Software floating-point emulation is provided if you use the
23687 @option{-msoft-float} option, and pass the option to GCC when linking.
23689 @item -msingle-float
23690 @itemx -mdouble-float
23691 @opindex msingle-float
23692 @opindex mdouble-float
23693 Generate code for single- or double-precision floating-point operations.
23694 @option{-mdouble-float} implies @option{-msingle-float}.
23696 @item -msimple-fpu
23697 @opindex msimple-fpu
23698 Do not generate @code{sqrt} and @code{div} instructions for hardware
23699 floating-point unit.
23701 @item -mfpu=@var{name}
23702 @opindex mfpu
23703 Specify type of floating-point unit.  Valid values for @var{name} are
23704 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
23705 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
23706 @samp{sp_full} (equivalent to @option{-msingle-float}),
23707 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
23709 @item -mxilinx-fpu
23710 @opindex mxilinx-fpu
23711 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
23713 @item -mmultiple
23714 @itemx -mno-multiple
23715 @opindex mmultiple
23716 @opindex mno-multiple
23717 Generate code that uses (does not use) the load multiple word
23718 instructions and the store multiple word instructions.  These
23719 instructions are generated by default on POWER systems, and not
23720 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23721 PowerPC systems, since those instructions do not work when the
23722 processor is in little-endian mode.  The exceptions are PPC740 and
23723 PPC750 which permit these instructions in little-endian mode.
23725 @item -mupdate
23726 @itemx -mno-update
23727 @opindex mupdate
23728 @opindex mno-update
23729 Generate code that uses (does not use) the load or store instructions
23730 that update the base register to the address of the calculated memory
23731 location.  These instructions are generated by default.  If you use
23732 @option{-mno-update}, there is a small window between the time that the
23733 stack pointer is updated and the address of the previous frame is
23734 stored, which means code that walks the stack frame across interrupts or
23735 signals may get corrupted data.
23737 @item -mavoid-indexed-addresses
23738 @itemx -mno-avoid-indexed-addresses
23739 @opindex mavoid-indexed-addresses
23740 @opindex mno-avoid-indexed-addresses
23741 Generate code that tries to avoid (not avoid) the use of indexed load
23742 or store instructions. These instructions can incur a performance
23743 penalty on Power6 processors in certain situations, such as when
23744 stepping through large arrays that cross a 16M boundary.  This option
23745 is enabled by default when targeting Power6 and disabled otherwise.
23747 @item -mfused-madd
23748 @itemx -mno-fused-madd
23749 @opindex mfused-madd
23750 @opindex mno-fused-madd
23751 Generate code that uses (does not use) the floating-point multiply and
23752 accumulate instructions.  These instructions are generated by default
23753 if hardware floating point is used.  The machine-dependent
23754 @option{-mfused-madd} option is now mapped to the machine-independent
23755 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23756 mapped to @option{-ffp-contract=off}.
23758 @item -mmulhw
23759 @itemx -mno-mulhw
23760 @opindex mmulhw
23761 @opindex mno-mulhw
23762 Generate code that uses (does not use) the half-word multiply and
23763 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23764 These instructions are generated by default when targeting those
23765 processors.
23767 @item -mdlmzb
23768 @itemx -mno-dlmzb
23769 @opindex mdlmzb
23770 @opindex mno-dlmzb
23771 Generate code that uses (does not use) the string-search @samp{dlmzb}
23772 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23773 generated by default when targeting those processors.
23775 @item -mno-bit-align
23776 @itemx -mbit-align
23777 @opindex mno-bit-align
23778 @opindex mbit-align
23779 On System V.4 and embedded PowerPC systems do not (do) force structures
23780 and unions that contain bit-fields to be aligned to the base type of the
23781 bit-field.
23783 For example, by default a structure containing nothing but 8
23784 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23785 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23786 the structure is aligned to a 1-byte boundary and is 1 byte in
23787 size.
23789 @item -mno-strict-align
23790 @itemx -mstrict-align
23791 @opindex mno-strict-align
23792 @opindex mstrict-align
23793 On System V.4 and embedded PowerPC systems do not (do) assume that
23794 unaligned memory references are handled by the system.
23796 @item -mrelocatable
23797 @itemx -mno-relocatable
23798 @opindex mrelocatable
23799 @opindex mno-relocatable
23800 Generate code that allows (does not allow) a static executable to be
23801 relocated to a different address at run time.  A simple embedded
23802 PowerPC system loader should relocate the entire contents of
23803 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23804 a table of 32-bit addresses generated by this option.  For this to
23805 work, all objects linked together must be compiled with
23806 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23807 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23809 @item -mrelocatable-lib
23810 @itemx -mno-relocatable-lib
23811 @opindex mrelocatable-lib
23812 @opindex mno-relocatable-lib
23813 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23814 @code{.fixup} section to allow static executables to be relocated at
23815 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23816 alignment of @option{-mrelocatable}.  Objects compiled with
23817 @option{-mrelocatable-lib} may be linked with objects compiled with
23818 any combination of the @option{-mrelocatable} options.
23820 @item -mno-toc
23821 @itemx -mtoc
23822 @opindex mno-toc
23823 @opindex mtoc
23824 On System V.4 and embedded PowerPC systems do not (do) assume that
23825 register 2 contains a pointer to a global area pointing to the addresses
23826 used in the program.
23828 @item -mlittle
23829 @itemx -mlittle-endian
23830 @opindex mlittle
23831 @opindex mlittle-endian
23832 On System V.4 and embedded PowerPC systems compile code for the
23833 processor in little-endian mode.  The @option{-mlittle-endian} option is
23834 the same as @option{-mlittle}.
23836 @item -mbig
23837 @itemx -mbig-endian
23838 @opindex mbig
23839 @opindex mbig-endian
23840 On System V.4 and embedded PowerPC systems compile code for the
23841 processor in big-endian mode.  The @option{-mbig-endian} option is
23842 the same as @option{-mbig}.
23844 @item -mdynamic-no-pic
23845 @opindex mdynamic-no-pic
23846 On Darwin and Mac OS X systems, compile code so that it is not
23847 relocatable, but that its external references are relocatable.  The
23848 resulting code is suitable for applications, but not shared
23849 libraries.
23851 @item -msingle-pic-base
23852 @opindex msingle-pic-base
23853 Treat the register used for PIC addressing as read-only, rather than
23854 loading it in the prologue for each function.  The runtime system is
23855 responsible for initializing this register with an appropriate value
23856 before execution begins.
23858 @item -mprioritize-restricted-insns=@var{priority}
23859 @opindex mprioritize-restricted-insns
23860 This option controls the priority that is assigned to
23861 dispatch-slot restricted instructions during the second scheduling
23862 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23863 or @samp{2} to assign no, highest, or second-highest (respectively) 
23864 priority to dispatch-slot restricted
23865 instructions.
23867 @item -msched-costly-dep=@var{dependence_type}
23868 @opindex msched-costly-dep
23869 This option controls which dependences are considered costly
23870 by the target during instruction scheduling.  The argument
23871 @var{dependence_type} takes one of the following values:
23873 @table @asis
23874 @item @samp{no}
23875 No dependence is costly.
23877 @item @samp{all}
23878 All dependences are costly.
23880 @item @samp{true_store_to_load}
23881 A true dependence from store to load is costly.
23883 @item @samp{store_to_load}
23884 Any dependence from store to load is costly.
23886 @item @var{number}
23887 Any dependence for which the latency is greater than or equal to 
23888 @var{number} is costly.
23889 @end table
23891 @item -minsert-sched-nops=@var{scheme}
23892 @opindex minsert-sched-nops
23893 This option controls which NOP insertion scheme is used during
23894 the second scheduling pass.  The argument @var{scheme} takes one of the
23895 following values:
23897 @table @asis
23898 @item @samp{no}
23899 Don't insert NOPs.
23901 @item @samp{pad}
23902 Pad with NOPs any dispatch group that has vacant issue slots,
23903 according to the scheduler's grouping.
23905 @item @samp{regroup_exact}
23906 Insert NOPs to force costly dependent insns into
23907 separate groups.  Insert exactly as many NOPs as needed to force an insn
23908 to a new group, according to the estimated processor grouping.
23910 @item @var{number}
23911 Insert NOPs to force costly dependent insns into
23912 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23913 @end table
23915 @item -mcall-sysv
23916 @opindex mcall-sysv
23917 On System V.4 and embedded PowerPC systems compile code using calling
23918 conventions that adhere to the March 1995 draft of the System V
23919 Application Binary Interface, PowerPC processor supplement.  This is the
23920 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23922 @item -mcall-sysv-eabi
23923 @itemx -mcall-eabi
23924 @opindex mcall-sysv-eabi
23925 @opindex mcall-eabi
23926 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23928 @item -mcall-sysv-noeabi
23929 @opindex mcall-sysv-noeabi
23930 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23932 @item -mcall-aixdesc
23933 @opindex m
23934 On System V.4 and embedded PowerPC systems compile code for the AIX
23935 operating system.
23937 @item -mcall-linux
23938 @opindex mcall-linux
23939 On System V.4 and embedded PowerPC systems compile code for the
23940 Linux-based GNU system.
23942 @item -mcall-freebsd
23943 @opindex mcall-freebsd
23944 On System V.4 and embedded PowerPC systems compile code for the
23945 FreeBSD operating system.
23947 @item -mcall-netbsd
23948 @opindex mcall-netbsd
23949 On System V.4 and embedded PowerPC systems compile code for the
23950 NetBSD operating system.
23952 @item -mcall-openbsd
23953 @opindex mcall-netbsd
23954 On System V.4 and embedded PowerPC systems compile code for the
23955 OpenBSD operating system.
23957 @item -maix-struct-return
23958 @opindex maix-struct-return
23959 Return all structures in memory (as specified by the AIX ABI)@.
23961 @item -msvr4-struct-return
23962 @opindex msvr4-struct-return
23963 Return structures smaller than 8 bytes in registers (as specified by the
23964 SVR4 ABI)@.
23966 @item -mabi=@var{abi-type}
23967 @opindex mabi
23968 Extend the current ABI with a particular extension, or remove such extension.
23969 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23970 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23971 @samp{elfv1}, @samp{elfv2}@.
23973 @item -mabi=spe
23974 @opindex mabi=spe
23975 Extend the current ABI with SPE ABI extensions.  This does not change
23976 the default ABI, instead it adds the SPE ABI extensions to the current
23977 ABI@.
23979 @item -mabi=no-spe
23980 @opindex mabi=no-spe
23981 Disable Book-E SPE ABI extensions for the current ABI@.
23983 @item -mabi=ibmlongdouble
23984 @opindex mabi=ibmlongdouble
23985 Change the current ABI to use IBM extended-precision long double.
23986 This is not likely to work if your system defaults to using IEEE
23987 extended-precision long double.  If you change the long double type
23988 from IEEE extended-precision, the compiler will issue a warning unless
23989 you use the @option{-Wno-psabi} option.
23991 @item -mabi=ieeelongdouble
23992 @opindex mabi=ieeelongdouble
23993 Change the current ABI to use IEEE extended-precision long double.
23994 This is not likely to work if your system defaults to using IBM
23995 extended-precision long double.  If you change the long double type
23996 from IBM extended-precision, the compiler will issue a warning unless
23997 you use the @option{-Wno-psabi} option.
23999 @item -mabi=elfv1
24000 @opindex mabi=elfv1
24001 Change the current ABI to use the ELFv1 ABI.
24002 This is the default ABI for big-endian PowerPC 64-bit Linux.
24003 Overriding the default ABI requires special system support and is
24004 likely to fail in spectacular ways.
24006 @item -mabi=elfv2
24007 @opindex mabi=elfv2
24008 Change the current ABI to use the ELFv2 ABI.
24009 This is the default ABI for little-endian PowerPC 64-bit Linux.
24010 Overriding the default ABI requires special system support and is
24011 likely to fail in spectacular ways.
24013 @item -mgnu-attribute
24014 @itemx -mno-gnu-attribute
24015 @opindex mgnu-attribute
24016 @opindex mno-gnu-attribute
24017 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24018 .gnu.attributes section that specify ABI variations in function
24019 parameters or return values.
24021 @item -mprototype
24022 @itemx -mno-prototype
24023 @opindex mprototype
24024 @opindex mno-prototype
24025 On System V.4 and embedded PowerPC systems assume that all calls to
24026 variable argument functions are properly prototyped.  Otherwise, the
24027 compiler must insert an instruction before every non-prototyped call to
24028 set or clear bit 6 of the condition code register (@code{CR}) to
24029 indicate whether floating-point values are passed in the floating-point
24030 registers in case the function takes variable arguments.  With
24031 @option{-mprototype}, only calls to prototyped variable argument functions
24032 set or clear the bit.
24034 @item -msim
24035 @opindex msim
24036 On embedded PowerPC systems, assume that the startup module is called
24037 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24038 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24039 configurations.
24041 @item -mmvme
24042 @opindex mmvme
24043 On embedded PowerPC systems, assume that the startup module is called
24044 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24045 @file{libc.a}.
24047 @item -mads
24048 @opindex mads
24049 On embedded PowerPC systems, assume that the startup module is called
24050 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24051 @file{libc.a}.
24053 @item -myellowknife
24054 @opindex myellowknife
24055 On embedded PowerPC systems, assume that the startup module is called
24056 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24057 @file{libc.a}.
24059 @item -mvxworks
24060 @opindex mvxworks
24061 On System V.4 and embedded PowerPC systems, specify that you are
24062 compiling for a VxWorks system.
24064 @item -memb
24065 @opindex memb
24066 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24067 header to indicate that @samp{eabi} extended relocations are used.
24069 @item -meabi
24070 @itemx -mno-eabi
24071 @opindex meabi
24072 @opindex mno-eabi
24073 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24074 Embedded Applications Binary Interface (EABI), which is a set of
24075 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24076 means that the stack is aligned to an 8-byte boundary, a function
24077 @code{__eabi} is called from @code{main} to set up the EABI
24078 environment, and the @option{-msdata} option can use both @code{r2} and
24079 @code{r13} to point to two separate small data areas.  Selecting
24080 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24081 no EABI initialization function is called from @code{main}, and the
24082 @option{-msdata} option only uses @code{r13} to point to a single
24083 small data area.  The @option{-meabi} option is on by default if you
24084 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24086 @item -msdata=eabi
24087 @opindex msdata=eabi
24088 On System V.4 and embedded PowerPC systems, put small initialized
24089 @code{const} global and static data in the @code{.sdata2} section, which
24090 is pointed to by register @code{r2}.  Put small initialized
24091 non-@code{const} global and static data in the @code{.sdata} section,
24092 which is pointed to by register @code{r13}.  Put small uninitialized
24093 global and static data in the @code{.sbss} section, which is adjacent to
24094 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24095 incompatible with the @option{-mrelocatable} option.  The
24096 @option{-msdata=eabi} option also sets the @option{-memb} option.
24098 @item -msdata=sysv
24099 @opindex msdata=sysv
24100 On System V.4 and embedded PowerPC systems, put small global and static
24101 data in the @code{.sdata} section, which is pointed to by register
24102 @code{r13}.  Put small uninitialized global and static data in the
24103 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24104 The @option{-msdata=sysv} option is incompatible with the
24105 @option{-mrelocatable} option.
24107 @item -msdata=default
24108 @itemx -msdata
24109 @opindex msdata=default
24110 @opindex msdata
24111 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24112 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24113 same as @option{-msdata=sysv}.
24115 @item -msdata=data
24116 @opindex msdata=data
24117 On System V.4 and embedded PowerPC systems, put small global
24118 data in the @code{.sdata} section.  Put small uninitialized global
24119 data in the @code{.sbss} section.  Do not use register @code{r13}
24120 to address small data however.  This is the default behavior unless
24121 other @option{-msdata} options are used.
24123 @item -msdata=none
24124 @itemx -mno-sdata
24125 @opindex msdata=none
24126 @opindex mno-sdata
24127 On embedded PowerPC systems, put all initialized global and static data
24128 in the @code{.data} section, and all uninitialized data in the
24129 @code{.bss} section.
24131 @item -mreadonly-in-sdata
24132 @itemx -mreadonly-in-sdata
24133 @opindex mreadonly-in-sdata
24134 @opindex mno-readonly-in-sdata
24135 Put read-only objects in the @code{.sdata} section as well.  This is the
24136 default.
24138 @item -mblock-move-inline-limit=@var{num}
24139 @opindex mblock-move-inline-limit
24140 Inline all block moves (such as calls to @code{memcpy} or structure
24141 copies) less than or equal to @var{num} bytes.  The minimum value for
24142 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24143 targets.  The default value is target-specific.
24145 @item -G @var{num}
24146 @opindex G
24147 @cindex smaller data references (PowerPC)
24148 @cindex .sdata/.sdata2 references (PowerPC)
24149 On embedded PowerPC systems, put global and static items less than or
24150 equal to @var{num} bytes into the small data or BSS sections instead of
24151 the normal data or BSS section.  By default, @var{num} is 8.  The
24152 @option{-G @var{num}} switch is also passed to the linker.
24153 All modules should be compiled with the same @option{-G @var{num}} value.
24155 @item -mregnames
24156 @itemx -mno-regnames
24157 @opindex mregnames
24158 @opindex mno-regnames
24159 On System V.4 and embedded PowerPC systems do (do not) emit register
24160 names in the assembly language output using symbolic forms.
24162 @item -mlongcall
24163 @itemx -mno-longcall
24164 @opindex mlongcall
24165 @opindex mno-longcall
24166 By default assume that all calls are far away so that a longer and more
24167 expensive calling sequence is required.  This is required for calls
24168 farther than 32 megabytes (33,554,432 bytes) from the current location.
24169 A short call is generated if the compiler knows
24170 the call cannot be that far away.  This setting can be overridden by
24171 the @code{shortcall} function attribute, or by @code{#pragma
24172 longcall(0)}.
24174 Some linkers are capable of detecting out-of-range calls and generating
24175 glue code on the fly.  On these systems, long calls are unnecessary and
24176 generate slower code.  As of this writing, the AIX linker can do this,
24177 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24178 to the GNU linker for 32-bit PowerPC systems as well.
24180 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24181 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24182 addresses represent the callee and the branch island.  The
24183 Darwin/PPC linker prefers the first address and generates a @code{bl
24184 callee} if the PPC @code{bl} instruction reaches the callee directly;
24185 otherwise, the linker generates @code{bl L42} to call the branch
24186 island.  The branch island is appended to the body of the
24187 calling function; it computes the full 32-bit address of the callee
24188 and jumps to it.
24190 On Mach-O (Darwin) systems, this option directs the compiler emit to
24191 the glue for every direct call, and the Darwin linker decides whether
24192 to use or discard it.
24194 In the future, GCC may ignore all longcall specifications
24195 when the linker is known to generate glue.
24197 @item -mtls-markers
24198 @itemx -mno-tls-markers
24199 @opindex mtls-markers
24200 @opindex mno-tls-markers
24201 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24202 specifying the function argument.  The relocation allows the linker to
24203 reliably associate function call with argument setup instructions for
24204 TLS optimization, which in turn allows GCC to better schedule the
24205 sequence.
24207 @item -mrecip
24208 @itemx -mno-recip
24209 @opindex mrecip
24210 This option enables use of the reciprocal estimate and
24211 reciprocal square root estimate instructions with additional
24212 Newton-Raphson steps to increase precision instead of doing a divide or
24213 square root and divide for floating-point arguments.  You should use
24214 the @option{-ffast-math} option when using @option{-mrecip} (or at
24215 least @option{-funsafe-math-optimizations},
24216 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24217 @option{-fno-trapping-math}).  Note that while the throughput of the
24218 sequence is generally higher than the throughput of the non-reciprocal
24219 instruction, the precision of the sequence can be decreased by up to 2
24220 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24221 roots.
24223 @item -mrecip=@var{opt}
24224 @opindex mrecip=opt
24225 This option controls which reciprocal estimate instructions
24226 may be used.  @var{opt} is a comma-separated list of options, which may
24227 be preceded by a @code{!} to invert the option:
24229 @table @samp
24231 @item all
24232 Enable all estimate instructions.
24234 @item default 
24235 Enable the default instructions, equivalent to @option{-mrecip}.
24237 @item none 
24238 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24240 @item div 
24241 Enable the reciprocal approximation instructions for both 
24242 single and double precision.
24244 @item divf 
24245 Enable the single-precision reciprocal approximation instructions.
24247 @item divd 
24248 Enable the double-precision reciprocal approximation instructions.
24250 @item rsqrt 
24251 Enable the reciprocal square root approximation instructions for both
24252 single and double precision.
24254 @item rsqrtf 
24255 Enable the single-precision reciprocal square root approximation instructions.
24257 @item rsqrtd 
24258 Enable the double-precision reciprocal square root approximation instructions.
24260 @end table
24262 So, for example, @option{-mrecip=all,!rsqrtd} enables
24263 all of the reciprocal estimate instructions, except for the
24264 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24265 which handle the double-precision reciprocal square root calculations.
24267 @item -mrecip-precision
24268 @itemx -mno-recip-precision
24269 @opindex mrecip-precision
24270 Assume (do not assume) that the reciprocal estimate instructions
24271 provide higher-precision estimates than is mandated by the PowerPC
24272 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24273 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24274 The double-precision square root estimate instructions are not generated by
24275 default on low-precision machines, since they do not provide an
24276 estimate that converges after three steps.
24278 @item -mveclibabi=@var{type}
24279 @opindex mveclibabi
24280 Specifies the ABI type to use for vectorizing intrinsics using an
24281 external library.  The only type supported at present is @samp{mass},
24282 which specifies to use IBM's Mathematical Acceleration Subsystem
24283 (MASS) libraries for vectorizing intrinsics using external libraries.
24284 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24285 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24286 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24287 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24288 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24289 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24290 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24291 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24292 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24293 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24294 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24295 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24296 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24297 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24298 for power7.  Both @option{-ftree-vectorize} and
24299 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24300 libraries must be specified at link time.
24302 @item -mfriz
24303 @itemx -mno-friz
24304 @opindex mfriz
24305 Generate (do not generate) the @code{friz} instruction when the
24306 @option{-funsafe-math-optimizations} option is used to optimize
24307 rounding of floating-point values to 64-bit integer and back to floating
24308 point.  The @code{friz} instruction does not return the same value if
24309 the floating-point number is too large to fit in an integer.
24311 @item -mpointers-to-nested-functions
24312 @itemx -mno-pointers-to-nested-functions
24313 @opindex mpointers-to-nested-functions
24314 Generate (do not generate) code to load up the static chain register
24315 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24316 systems where a function pointer points to a 3-word descriptor giving
24317 the function address, TOC value to be loaded in register @code{r2}, and
24318 static chain value to be loaded in register @code{r11}.  The
24319 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24320 call through pointers to nested functions or pointers
24321 to functions compiled in other languages that use the static chain if
24322 you use @option{-mno-pointers-to-nested-functions}.
24324 @item -msave-toc-indirect
24325 @itemx -mno-save-toc-indirect
24326 @opindex msave-toc-indirect
24327 Generate (do not generate) code to save the TOC value in the reserved
24328 stack location in the function prologue if the function calls through
24329 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24330 saved in the prologue, it is saved just before the call through the
24331 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24333 @item -mcompat-align-parm
24334 @itemx -mno-compat-align-parm
24335 @opindex mcompat-align-parm
24336 Generate (do not generate) code to pass structure parameters with a
24337 maximum alignment of 64 bits, for compatibility with older versions
24338 of GCC.
24340 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24341 structure parameter on a 128-bit boundary when that structure contained
24342 a member requiring 128-bit alignment.  This is corrected in more
24343 recent versions of GCC.  This option may be used to generate code
24344 that is compatible with functions compiled with older versions of
24345 GCC.
24347 The @option{-mno-compat-align-parm} option is the default.
24349 @item -mstack-protector-guard=@var{guard}
24350 @itemx -mstack-protector-guard-reg=@var{reg}
24351 @itemx -mstack-protector-guard-offset=@var{offset}
24352 @itemx -mstack-protector-guard-symbol=@var{symbol}
24353 @opindex mstack-protector-guard
24354 @opindex mstack-protector-guard-reg
24355 @opindex mstack-protector-guard-offset
24356 @opindex mstack-protector-guard-symbol
24357 Generate stack protection code using canary at @var{guard}.  Supported
24358 locations are @samp{global} for global canary or @samp{tls} for per-thread
24359 canary in the TLS block (the default with GNU libc version 2.4 or later).
24361 With the latter choice the options
24362 @option{-mstack-protector-guard-reg=@var{reg}} and
24363 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24364 which register to use as base register for reading the canary, and from what
24365 offset from that base register. The default for those is as specified in the
24366 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24367 the offset with a symbol reference to a canary in the TLS block.
24368 @end table
24370 @node RX Options
24371 @subsection RX Options
24372 @cindex RX Options
24374 These command-line options are defined for RX targets:
24376 @table @gcctabopt
24377 @item -m64bit-doubles
24378 @itemx -m32bit-doubles
24379 @opindex m64bit-doubles
24380 @opindex m32bit-doubles
24381 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24382 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24383 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24384 works on 32-bit values, which is why the default is
24385 @option{-m32bit-doubles}.
24387 @item -fpu
24388 @itemx -nofpu
24389 @opindex fpu
24390 @opindex nofpu
24391 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24392 floating-point hardware.  The default is enabled for the RX600
24393 series and disabled for the RX200 series.
24395 Floating-point instructions are only generated for 32-bit floating-point 
24396 values, however, so the FPU hardware is not used for doubles if the
24397 @option{-m64bit-doubles} option is used.
24399 @emph{Note} If the @option{-fpu} option is enabled then
24400 @option{-funsafe-math-optimizations} is also enabled automatically.
24401 This is because the RX FPU instructions are themselves unsafe.
24403 @item -mcpu=@var{name}
24404 @opindex mcpu
24405 Selects the type of RX CPU to be targeted.  Currently three types are
24406 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24407 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24409 The only difference between @samp{RX600} and @samp{RX610} is that the
24410 @samp{RX610} does not support the @code{MVTIPL} instruction.
24412 The @samp{RX200} series does not have a hardware floating-point unit
24413 and so @option{-nofpu} is enabled by default when this type is
24414 selected.
24416 @item -mbig-endian-data
24417 @itemx -mlittle-endian-data
24418 @opindex mbig-endian-data
24419 @opindex mlittle-endian-data
24420 Store data (but not code) in the big-endian format.  The default is
24421 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24422 format.
24424 @item -msmall-data-limit=@var{N}
24425 @opindex msmall-data-limit
24426 Specifies the maximum size in bytes of global and static variables
24427 which can be placed into the small data area.  Using the small data
24428 area can lead to smaller and faster code, but the size of area is
24429 limited and it is up to the programmer to ensure that the area does
24430 not overflow.  Also when the small data area is used one of the RX's
24431 registers (usually @code{r13}) is reserved for use pointing to this
24432 area, so it is no longer available for use by the compiler.  This
24433 could result in slower and/or larger code if variables are pushed onto
24434 the stack instead of being held in this register.
24436 Note, common variables (variables that have not been initialized) and
24437 constants are not placed into the small data area as they are assigned
24438 to other sections in the output executable.
24440 The default value is zero, which disables this feature.  Note, this
24441 feature is not enabled by default with higher optimization levels
24442 (@option{-O2} etc) because of the potentially detrimental effects of
24443 reserving a register.  It is up to the programmer to experiment and
24444 discover whether this feature is of benefit to their program.  See the
24445 description of the @option{-mpid} option for a description of how the
24446 actual register to hold the small data area pointer is chosen.
24448 @item -msim
24449 @itemx -mno-sim
24450 @opindex msim
24451 @opindex mno-sim
24452 Use the simulator runtime.  The default is to use the libgloss
24453 board-specific runtime.
24455 @item -mas100-syntax
24456 @itemx -mno-as100-syntax
24457 @opindex mas100-syntax
24458 @opindex mno-as100-syntax
24459 When generating assembler output use a syntax that is compatible with
24460 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24461 assembler, but it has some restrictions so it is not generated by default.
24463 @item -mmax-constant-size=@var{N}
24464 @opindex mmax-constant-size
24465 Specifies the maximum size, in bytes, of a constant that can be used as
24466 an operand in a RX instruction.  Although the RX instruction set does
24467 allow constants of up to 4 bytes in length to be used in instructions,
24468 a longer value equates to a longer instruction.  Thus in some
24469 circumstances it can be beneficial to restrict the size of constants
24470 that are used in instructions.  Constants that are too big are instead
24471 placed into a constant pool and referenced via register indirection.
24473 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24474 or 4 means that constants of any size are allowed.
24476 @item -mrelax
24477 @opindex mrelax
24478 Enable linker relaxation.  Linker relaxation is a process whereby the
24479 linker attempts to reduce the size of a program by finding shorter
24480 versions of various instructions.  Disabled by default.
24482 @item -mint-register=@var{N}
24483 @opindex mint-register
24484 Specify the number of registers to reserve for fast interrupt handler
24485 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24486 means that register @code{r13} is reserved for the exclusive use
24487 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24488 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24489 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24490 A value of 0, the default, does not reserve any registers.
24492 @item -msave-acc-in-interrupts
24493 @opindex msave-acc-in-interrupts
24494 Specifies that interrupt handler functions should preserve the
24495 accumulator register.  This is only necessary if normal code might use
24496 the accumulator register, for example because it performs 64-bit
24497 multiplications.  The default is to ignore the accumulator as this
24498 makes the interrupt handlers faster.
24500 @item -mpid
24501 @itemx -mno-pid
24502 @opindex mpid
24503 @opindex mno-pid
24504 Enables the generation of position independent data.  When enabled any
24505 access to constant data is done via an offset from a base address
24506 held in a register.  This allows the location of constant data to be
24507 determined at run time without requiring the executable to be
24508 relocated, which is a benefit to embedded applications with tight
24509 memory constraints.  Data that can be modified is not affected by this
24510 option.
24512 Note, using this feature reserves a register, usually @code{r13}, for
24513 the constant data base address.  This can result in slower and/or
24514 larger code, especially in complicated functions.
24516 The actual register chosen to hold the constant data base address
24517 depends upon whether the @option{-msmall-data-limit} and/or the
24518 @option{-mint-register} command-line options are enabled.  Starting
24519 with register @code{r13} and proceeding downwards, registers are
24520 allocated first to satisfy the requirements of @option{-mint-register},
24521 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24522 is possible for the small data area register to be @code{r8} if both
24523 @option{-mint-register=4} and @option{-mpid} are specified on the
24524 command line.
24526 By default this feature is not enabled.  The default can be restored
24527 via the @option{-mno-pid} command-line option.
24529 @item -mno-warn-multiple-fast-interrupts
24530 @itemx -mwarn-multiple-fast-interrupts
24531 @opindex mno-warn-multiple-fast-interrupts
24532 @opindex mwarn-multiple-fast-interrupts
24533 Prevents GCC from issuing a warning message if it finds more than one
24534 fast interrupt handler when it is compiling a file.  The default is to
24535 issue a warning for each extra fast interrupt handler found, as the RX
24536 only supports one such interrupt.
24538 @item -mallow-string-insns
24539 @itemx -mno-allow-string-insns
24540 @opindex mallow-string-insns
24541 @opindex mno-allow-string-insns
24542 Enables or disables the use of the string manipulation instructions
24543 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24544 @code{SWHILE} and also the @code{RMPA} instruction.  These
24545 instructions may prefetch data, which is not safe to do if accessing
24546 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24547 for more information).
24549 The default is to allow these instructions, but it is not possible for
24550 GCC to reliably detect all circumstances where a string instruction
24551 might be used to access an I/O register, so their use cannot be
24552 disabled automatically.  Instead it is reliant upon the programmer to
24553 use the @option{-mno-allow-string-insns} option if their program
24554 accesses I/O space.
24556 When the instructions are enabled GCC defines the C preprocessor
24557 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24558 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24560 @item -mjsr
24561 @itemx -mno-jsr
24562 @opindex mjsr
24563 @opindex mno-jsr
24564 Use only (or not only) @code{JSR} instructions to access functions.
24565 This option can be used when code size exceeds the range of @code{BSR}
24566 instructions.  Note that @option{-mno-jsr} does not mean to not use
24567 @code{JSR} but instead means that any type of branch may be used.
24568 @end table
24570 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24571 has special significance to the RX port when used with the
24572 @code{interrupt} function attribute.  This attribute indicates a
24573 function intended to process fast interrupts.  GCC ensures
24574 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24575 and/or @code{r13} and only provided that the normal use of the
24576 corresponding registers have been restricted via the
24577 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24578 options.
24580 @node S/390 and zSeries Options
24581 @subsection S/390 and zSeries Options
24582 @cindex S/390 and zSeries Options
24584 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24586 @table @gcctabopt
24587 @item -mhard-float
24588 @itemx -msoft-float
24589 @opindex mhard-float
24590 @opindex msoft-float
24591 Use (do not use) the hardware floating-point instructions and registers
24592 for floating-point operations.  When @option{-msoft-float} is specified,
24593 functions in @file{libgcc.a} are used to perform floating-point
24594 operations.  When @option{-mhard-float} is specified, the compiler
24595 generates IEEE floating-point instructions.  This is the default.
24597 @item -mhard-dfp
24598 @itemx -mno-hard-dfp
24599 @opindex mhard-dfp
24600 @opindex mno-hard-dfp
24601 Use (do not use) the hardware decimal-floating-point instructions for
24602 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24603 specified, functions in @file{libgcc.a} are used to perform
24604 decimal-floating-point operations.  When @option{-mhard-dfp} is
24605 specified, the compiler generates decimal-floating-point hardware
24606 instructions.  This is the default for @option{-march=z9-ec} or higher.
24608 @item -mlong-double-64
24609 @itemx -mlong-double-128
24610 @opindex mlong-double-64
24611 @opindex mlong-double-128
24612 These switches control the size of @code{long double} type. A size
24613 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24614 type. This is the default.
24616 @item -mbackchain
24617 @itemx -mno-backchain
24618 @opindex mbackchain
24619 @opindex mno-backchain
24620 Store (do not store) the address of the caller's frame as backchain pointer
24621 into the callee's stack frame.
24622 A backchain may be needed to allow debugging using tools that do not understand
24623 DWARF call frame information.
24624 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24625 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24626 the backchain is placed into the topmost word of the 96/160 byte register
24627 save area.
24629 In general, code compiled with @option{-mbackchain} is call-compatible with
24630 code compiled with @option{-mmo-backchain}; however, use of the backchain
24631 for debugging purposes usually requires that the whole binary is built with
24632 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24633 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24634 to build a linux kernel use @option{-msoft-float}.
24636 The default is to not maintain the backchain.
24638 @item -mpacked-stack
24639 @itemx -mno-packed-stack
24640 @opindex mpacked-stack
24641 @opindex mno-packed-stack
24642 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24643 specified, the compiler uses the all fields of the 96/160 byte register save
24644 area only for their default purpose; unused fields still take up stack space.
24645 When @option{-mpacked-stack} is specified, register save slots are densely
24646 packed at the top of the register save area; unused space is reused for other
24647 purposes, allowing for more efficient use of the available stack space.
24648 However, when @option{-mbackchain} is also in effect, the topmost word of
24649 the save area is always used to store the backchain, and the return address
24650 register is always saved two words below the backchain.
24652 As long as the stack frame backchain is not used, code generated with
24653 @option{-mpacked-stack} is call-compatible with code generated with
24654 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24655 S/390 or zSeries generated code that uses the stack frame backchain at run
24656 time, not just for debugging purposes.  Such code is not call-compatible
24657 with code compiled with @option{-mpacked-stack}.  Also, note that the
24658 combination of @option{-mbackchain},
24659 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24660 to build a linux kernel use @option{-msoft-float}.
24662 The default is to not use the packed stack layout.
24664 @item -msmall-exec
24665 @itemx -mno-small-exec
24666 @opindex msmall-exec
24667 @opindex mno-small-exec
24668 Generate (or do not generate) code using the @code{bras} instruction
24669 to do subroutine calls.
24670 This only works reliably if the total executable size does not
24671 exceed 64k.  The default is to use the @code{basr} instruction instead,
24672 which does not have this limitation.
24674 @item -m64
24675 @itemx -m31
24676 @opindex m64
24677 @opindex m31
24678 When @option{-m31} is specified, generate code compliant to the
24679 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24680 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24681 particular to generate 64-bit instructions.  For the @samp{s390}
24682 targets, the default is @option{-m31}, while the @samp{s390x}
24683 targets default to @option{-m64}.
24685 @item -mzarch
24686 @itemx -mesa
24687 @opindex mzarch
24688 @opindex mesa
24689 When @option{-mzarch} is specified, generate code using the
24690 instructions available on z/Architecture.
24691 When @option{-mesa} is specified, generate code using the
24692 instructions available on ESA/390.  Note that @option{-mesa} is
24693 not possible with @option{-m64}.
24694 When generating code compliant to the GNU/Linux for S/390 ABI,
24695 the default is @option{-mesa}.  When generating code compliant
24696 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24698 @item -mhtm
24699 @itemx -mno-htm
24700 @opindex mhtm
24701 @opindex mno-htm
24702 The @option{-mhtm} option enables a set of builtins making use of
24703 instructions available with the transactional execution facility
24704 introduced with the IBM zEnterprise EC12 machine generation
24705 @ref{S/390 System z Built-in Functions}.
24706 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24708 @item -mvx
24709 @itemx -mno-vx
24710 @opindex mvx
24711 @opindex mno-vx
24712 When @option{-mvx} is specified, generate code using the instructions
24713 available with the vector extension facility introduced with the IBM
24714 z13 machine generation.
24715 This option changes the ABI for some vector type values with regard to
24716 alignment and calling conventions.  In case vector type values are
24717 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24718 command will be added to mark the resulting binary with the ABI used.
24719 @option{-mvx} is enabled by default when using @option{-march=z13}.
24721 @item -mzvector
24722 @itemx -mno-zvector
24723 @opindex mzvector
24724 @opindex mno-zvector
24725 The @option{-mzvector} option enables vector language extensions and
24726 builtins using instructions available with the vector extension
24727 facility introduced with the IBM z13 machine generation.
24728 This option adds support for @samp{vector} to be used as a keyword to
24729 define vector type variables and arguments.  @samp{vector} is only
24730 available when GNU extensions are enabled.  It will not be expanded
24731 when requesting strict standard compliance e.g. with @option{-std=c99}.
24732 In addition to the GCC low-level builtins @option{-mzvector} enables
24733 a set of builtins added for compatibility with AltiVec-style
24734 implementations like Power and Cell.  In order to make use of these
24735 builtins the header file @file{vecintrin.h} needs to be included.
24736 @option{-mzvector} is disabled by default.
24738 @item -mmvcle
24739 @itemx -mno-mvcle
24740 @opindex mmvcle
24741 @opindex mno-mvcle
24742 Generate (or do not generate) code using the @code{mvcle} instruction
24743 to perform block moves.  When @option{-mno-mvcle} is specified,
24744 use a @code{mvc} loop instead.  This is the default unless optimizing for
24745 size.
24747 @item -mdebug
24748 @itemx -mno-debug
24749 @opindex mdebug
24750 @opindex mno-debug
24751 Print (or do not print) additional debug information when compiling.
24752 The default is to not print debug information.
24754 @item -march=@var{cpu-type}
24755 @opindex march
24756 Generate code that runs on @var{cpu-type}, which is the name of a
24757 system representing a certain processor type.  Possible values for
24758 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24759 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24760 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24761 @samp{native}.
24763 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24764 @samp{g6} are deprecated and will be removed with future releases.
24766 Specifying @samp{native} as cpu type can be used to select the best
24767 architecture option for the host processor.
24768 @option{-march=native} has no effect if GCC does not recognize the
24769 processor.
24771 @item -mtune=@var{cpu-type}
24772 @opindex mtune
24773 Tune to @var{cpu-type} everything applicable about the generated code,
24774 except for the ABI and the set of available instructions.
24775 The list of @var{cpu-type} values is the same as for @option{-march}.
24776 The default is the value used for @option{-march}.
24778 @item -mtpf-trace
24779 @itemx -mno-tpf-trace
24780 @opindex mtpf-trace
24781 @opindex mno-tpf-trace
24782 Generate code that adds (does not add) in TPF OS specific branches to trace
24783 routines in the operating system.  This option is off by default, even
24784 when compiling for the TPF OS@.
24786 @item -mfused-madd
24787 @itemx -mno-fused-madd
24788 @opindex mfused-madd
24789 @opindex mno-fused-madd
24790 Generate code that uses (does not use) the floating-point multiply and
24791 accumulate instructions.  These instructions are generated by default if
24792 hardware floating point is used.
24794 @item -mwarn-framesize=@var{framesize}
24795 @opindex mwarn-framesize
24796 Emit a warning if the current function exceeds the given frame size.  Because
24797 this is a compile-time check it doesn't need to be a real problem when the program
24798 runs.  It is intended to identify functions that most probably cause
24799 a stack overflow.  It is useful to be used in an environment with limited stack
24800 size e.g.@: the linux kernel.
24802 @item -mwarn-dynamicstack
24803 @opindex mwarn-dynamicstack
24804 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24805 arrays.  This is generally a bad idea with a limited stack size.
24807 @item -mstack-guard=@var{stack-guard}
24808 @itemx -mstack-size=@var{stack-size}
24809 @opindex mstack-guard
24810 @opindex mstack-size
24811 If these options are provided the S/390 back end emits additional instructions in
24812 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24813 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24814 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24815 the frame size of the compiled function is chosen.
24816 These options are intended to be used to help debugging stack overflow problems.
24817 The additionally emitted code causes only little overhead and hence can also be
24818 used in production-like systems without greater performance degradation.  The given
24819 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24820 @var{stack-guard} without exceeding 64k.
24821 In order to be efficient the extra code makes the assumption that the stack starts
24822 at an address aligned to the value given by @var{stack-size}.
24823 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24825 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24826 @opindex mhotpatch
24827 If the hotpatch option is enabled, a ``hot-patching'' function
24828 prologue is generated for all functions in the compilation unit.
24829 The funtion label is prepended with the given number of two-byte
24830 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24831 the label, 2 * @var{post-halfwords} bytes are appended, using the
24832 largest NOP like instructions the architecture allows (maximum
24833 1000000).
24835 If both arguments are zero, hotpatching is disabled.
24837 This option can be overridden for individual functions with the
24838 @code{hotpatch} attribute.
24839 @end table
24841 @node Score Options
24842 @subsection Score Options
24843 @cindex Score Options
24845 These options are defined for Score implementations:
24847 @table @gcctabopt
24848 @item -meb
24849 @opindex meb
24850 Compile code for big-endian mode.  This is the default.
24852 @item -mel
24853 @opindex mel
24854 Compile code for little-endian mode.
24856 @item -mnhwloop
24857 @opindex mnhwloop
24858 Disable generation of @code{bcnz} instructions.
24860 @item -muls
24861 @opindex muls
24862 Enable generation of unaligned load and store instructions.
24864 @item -mmac
24865 @opindex mmac
24866 Enable the use of multiply-accumulate instructions. Disabled by default.
24868 @item -mscore5
24869 @opindex mscore5
24870 Specify the SCORE5 as the target architecture.
24872 @item -mscore5u
24873 @opindex mscore5u
24874 Specify the SCORE5U of the target architecture.
24876 @item -mscore7
24877 @opindex mscore7
24878 Specify the SCORE7 as the target architecture. This is the default.
24880 @item -mscore7d
24881 @opindex mscore7d
24882 Specify the SCORE7D as the target architecture.
24883 @end table
24885 @node SH Options
24886 @subsection SH Options
24888 These @samp{-m} options are defined for the SH implementations:
24890 @table @gcctabopt
24891 @item -m1
24892 @opindex m1
24893 Generate code for the SH1.
24895 @item -m2
24896 @opindex m2
24897 Generate code for the SH2.
24899 @item -m2e
24900 Generate code for the SH2e.
24902 @item -m2a-nofpu
24903 @opindex m2a-nofpu
24904 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24905 that the floating-point unit is not used.
24907 @item -m2a-single-only
24908 @opindex m2a-single-only
24909 Generate code for the SH2a-FPU, in such a way that no double-precision
24910 floating-point operations are used.
24912 @item -m2a-single
24913 @opindex m2a-single
24914 Generate code for the SH2a-FPU assuming the floating-point unit is in
24915 single-precision mode by default.
24917 @item -m2a
24918 @opindex m2a
24919 Generate code for the SH2a-FPU assuming the floating-point unit is in
24920 double-precision mode by default.
24922 @item -m3
24923 @opindex m3
24924 Generate code for the SH3.
24926 @item -m3e
24927 @opindex m3e
24928 Generate code for the SH3e.
24930 @item -m4-nofpu
24931 @opindex m4-nofpu
24932 Generate code for the SH4 without a floating-point unit.
24934 @item -m4-single-only
24935 @opindex m4-single-only
24936 Generate code for the SH4 with a floating-point unit that only
24937 supports single-precision arithmetic.
24939 @item -m4-single
24940 @opindex m4-single
24941 Generate code for the SH4 assuming the floating-point unit is in
24942 single-precision mode by default.
24944 @item -m4
24945 @opindex m4
24946 Generate code for the SH4.
24948 @item -m4-100
24949 @opindex m4-100
24950 Generate code for SH4-100.
24952 @item -m4-100-nofpu
24953 @opindex m4-100-nofpu
24954 Generate code for SH4-100 in such a way that the
24955 floating-point unit is not used.
24957 @item -m4-100-single
24958 @opindex m4-100-single
24959 Generate code for SH4-100 assuming the floating-point unit is in
24960 single-precision mode by default.
24962 @item -m4-100-single-only
24963 @opindex m4-100-single-only
24964 Generate code for SH4-100 in such a way that no double-precision
24965 floating-point operations are used.
24967 @item -m4-200
24968 @opindex m4-200
24969 Generate code for SH4-200.
24971 @item -m4-200-nofpu
24972 @opindex m4-200-nofpu
24973 Generate code for SH4-200 without in such a way that the
24974 floating-point unit is not used.
24976 @item -m4-200-single
24977 @opindex m4-200-single
24978 Generate code for SH4-200 assuming the floating-point unit is in
24979 single-precision mode by default.
24981 @item -m4-200-single-only
24982 @opindex m4-200-single-only
24983 Generate code for SH4-200 in such a way that no double-precision
24984 floating-point operations are used.
24986 @item -m4-300
24987 @opindex m4-300
24988 Generate code for SH4-300.
24990 @item -m4-300-nofpu
24991 @opindex m4-300-nofpu
24992 Generate code for SH4-300 without in such a way that the
24993 floating-point unit is not used.
24995 @item -m4-300-single
24996 @opindex m4-300-single
24997 Generate code for SH4-300 in such a way that no double-precision
24998 floating-point operations are used.
25000 @item -m4-300-single-only
25001 @opindex m4-300-single-only
25002 Generate code for SH4-300 in such a way that no double-precision
25003 floating-point operations are used.
25005 @item -m4-340
25006 @opindex m4-340
25007 Generate code for SH4-340 (no MMU, no FPU).
25009 @item -m4-500
25010 @opindex m4-500
25011 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
25012 assembler.
25014 @item -m4a-nofpu
25015 @opindex m4a-nofpu
25016 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25017 floating-point unit is not used.
25019 @item -m4a-single-only
25020 @opindex m4a-single-only
25021 Generate code for the SH4a, in such a way that no double-precision
25022 floating-point operations are used.
25024 @item -m4a-single
25025 @opindex m4a-single
25026 Generate code for the SH4a assuming the floating-point unit is in
25027 single-precision mode by default.
25029 @item -m4a
25030 @opindex m4a
25031 Generate code for the SH4a.
25033 @item -m4al
25034 @opindex m4al
25035 Same as @option{-m4a-nofpu}, except that it implicitly passes
25036 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25037 instructions at the moment.
25039 @item -mb
25040 @opindex mb
25041 Compile code for the processor in big-endian mode.
25043 @item -ml
25044 @opindex ml
25045 Compile code for the processor in little-endian mode.
25047 @item -mdalign
25048 @opindex mdalign
25049 Align doubles at 64-bit boundaries.  Note that this changes the calling
25050 conventions, and thus some functions from the standard C library do
25051 not work unless you recompile it first with @option{-mdalign}.
25053 @item -mrelax
25054 @opindex mrelax
25055 Shorten some address references at link time, when possible; uses the
25056 linker option @option{-relax}.
25058 @item -mbigtable
25059 @opindex mbigtable
25060 Use 32-bit offsets in @code{switch} tables.  The default is to use
25061 16-bit offsets.
25063 @item -mbitops
25064 @opindex mbitops
25065 Enable the use of bit manipulation instructions on SH2A.
25067 @item -mfmovd
25068 @opindex mfmovd
25069 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25070 alignment constraints.
25072 @item -mrenesas
25073 @opindex mrenesas
25074 Comply with the calling conventions defined by Renesas.
25076 @item -mno-renesas
25077 @opindex mno-renesas
25078 Comply with the calling conventions defined for GCC before the Renesas
25079 conventions were available.  This option is the default for all
25080 targets of the SH toolchain.
25082 @item -mnomacsave
25083 @opindex mnomacsave
25084 Mark the @code{MAC} register as call-clobbered, even if
25085 @option{-mrenesas} is given.
25087 @item -mieee
25088 @itemx -mno-ieee
25089 @opindex mieee
25090 @opindex mno-ieee
25091 Control the IEEE compliance of floating-point comparisons, which affects the
25092 handling of cases where the result of a comparison is unordered.  By default
25093 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25094 enabled @option{-mno-ieee} is implicitly set, which results in faster
25095 floating-point greater-equal and less-equal comparisons.  The implicit settings
25096 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25098 @item -minline-ic_invalidate
25099 @opindex minline-ic_invalidate
25100 Inline code to invalidate instruction cache entries after setting up
25101 nested function trampolines.
25102 This option has no effect if @option{-musermode} is in effect and the selected
25103 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25104 instruction.
25105 If the selected code generation option does not allow the use of the @code{icbi}
25106 instruction, and @option{-musermode} is not in effect, the inlined code
25107 manipulates the instruction cache address array directly with an associative
25108 write.  This not only requires privileged mode at run time, but it also
25109 fails if the cache line had been mapped via the TLB and has become unmapped.
25111 @item -misize
25112 @opindex misize
25113 Dump instruction size and location in the assembly code.
25115 @item -mpadstruct
25116 @opindex mpadstruct
25117 This option is deprecated.  It pads structures to multiple of 4 bytes,
25118 which is incompatible with the SH ABI@.
25120 @item -matomic-model=@var{model}
25121 @opindex matomic-model=@var{model}
25122 Sets the model of atomic operations and additional parameters as a comma
25123 separated list.  For details on the atomic built-in functions see
25124 @ref{__atomic Builtins}.  The following models and parameters are supported:
25126 @table @samp
25128 @item none
25129 Disable compiler generated atomic sequences and emit library calls for atomic
25130 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25132 @item soft-gusa
25133 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25134 built-in functions.  The generated atomic sequences require additional support
25135 from the interrupt/exception handling code of the system and are only suitable
25136 for SH3* and SH4* single-core systems.  This option is enabled by default when
25137 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25138 this option also partially utilizes the hardware atomic instructions
25139 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25140 @samp{strict} is specified.  
25142 @item soft-tcb
25143 Generate software atomic sequences that use a variable in the thread control
25144 block.  This is a variation of the gUSA sequences which can also be used on
25145 SH1* and SH2* targets.  The generated atomic sequences require additional
25146 support from the interrupt/exception handling code of the system and are only
25147 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25148 parameter has to be specified as well.
25150 @item soft-imask
25151 Generate software atomic sequences that temporarily disable interrupts by
25152 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25153 in privileged mode and is only suitable for single-core systems.  Additional
25154 support from the interrupt/exception handling code of the system is not
25155 required.  This model is enabled by default when the target is
25156 @code{sh*-*-linux*} and SH1* or SH2*.
25158 @item hard-llcs
25159 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25160 instructions only.  This is only available on SH4A and is suitable for
25161 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25162 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25163 Code compiled with this option is also compatible with other software
25164 atomic model interrupt/exception handling systems if executed on an SH4A
25165 system.  Additional support from the interrupt/exception handling code of the
25166 system is not required for this model.
25168 @item gbr-offset=
25169 This parameter specifies the offset in bytes of the variable in the thread
25170 control block structure that should be used by the generated atomic sequences
25171 when the @samp{soft-tcb} model has been selected.  For other models this
25172 parameter is ignored.  The specified value must be an integer multiple of four
25173 and in the range 0-1020.
25175 @item strict
25176 This parameter prevents mixed usage of multiple atomic models, even if they
25177 are compatible, and makes the compiler generate atomic sequences of the
25178 specified model only.
25180 @end table
25182 @item -mtas
25183 @opindex mtas
25184 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25185 Notice that depending on the particular hardware and software configuration
25186 this can degrade overall performance due to the operand cache line flushes
25187 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25188 processors the @code{tas.b} instruction must be used with caution since it
25189 can result in data corruption for certain cache configurations.
25191 @item -mprefergot
25192 @opindex mprefergot
25193 When generating position-independent code, emit function calls using
25194 the Global Offset Table instead of the Procedure Linkage Table.
25196 @item -musermode
25197 @itemx -mno-usermode
25198 @opindex musermode
25199 @opindex mno-usermode
25200 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25201 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25202 inlined code would not work in user mode.  @option{-musermode} is the default
25203 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25204 @option{-musermode} has no effect, since there is no user mode.
25206 @item -multcost=@var{number}
25207 @opindex multcost=@var{number}
25208 Set the cost to assume for a multiply insn.
25210 @item -mdiv=@var{strategy}
25211 @opindex mdiv=@var{strategy}
25212 Set the division strategy to be used for integer division operations.
25213 @var{strategy} can be one of: 
25215 @table @samp
25217 @item call-div1
25218 Calls a library function that uses the single-step division instruction
25219 @code{div1} to perform the operation.  Division by zero calculates an
25220 unspecified result and does not trap.  This is the default except for SH4,
25221 SH2A and SHcompact.
25223 @item call-fp
25224 Calls a library function that performs the operation in double precision
25225 floating point.  Division by zero causes a floating-point exception.  This is
25226 the default for SHcompact with FPU.  Specifying this for targets that do not
25227 have a double precision FPU defaults to @code{call-div1}.
25229 @item call-table
25230 Calls a library function that uses a lookup table for small divisors and
25231 the @code{div1} instruction with case distinction for larger divisors.  Division
25232 by zero calculates an unspecified result and does not trap.  This is the default
25233 for SH4.  Specifying this for targets that do not have dynamic shift
25234 instructions defaults to @code{call-div1}.
25236 @end table
25238 When a division strategy has not been specified the default strategy is
25239 selected based on the current target.  For SH2A the default strategy is to
25240 use the @code{divs} and @code{divu} instructions instead of library function
25241 calls.
25243 @item -maccumulate-outgoing-args
25244 @opindex maccumulate-outgoing-args
25245 Reserve space once for outgoing arguments in the function prologue rather
25246 than around each call.  Generally beneficial for performance and size.  Also
25247 needed for unwinding to avoid changing the stack frame around conditional code.
25249 @item -mdivsi3_libfunc=@var{name}
25250 @opindex mdivsi3_libfunc=@var{name}
25251 Set the name of the library function used for 32-bit signed division to
25252 @var{name}.
25253 This only affects the name used in the @samp{call} division strategies, and
25254 the compiler still expects the same sets of input/output/clobbered registers as
25255 if this option were not present.
25257 @item -mfixed-range=@var{register-range}
25258 @opindex mfixed-range
25259 Generate code treating the given register range as fixed registers.
25260 A fixed register is one that the register allocator can not use.  This is
25261 useful when compiling kernel code.  A register range is specified as
25262 two registers separated by a dash.  Multiple register ranges can be
25263 specified separated by a comma.
25265 @item -mbranch-cost=@var{num}
25266 @opindex mbranch-cost=@var{num}
25267 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25268 make the compiler try to generate more branch-free code if possible.  
25269 If not specified the value is selected depending on the processor type that
25270 is being compiled for.
25272 @item -mzdcbranch
25273 @itemx -mno-zdcbranch
25274 @opindex mzdcbranch
25275 @opindex mno-zdcbranch
25276 Assume (do not assume) that zero displacement conditional branch instructions
25277 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25278 compiler prefers zero displacement branch code sequences.  This is
25279 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25280 disabled by specifying @option{-mno-zdcbranch}.
25282 @item -mcbranch-force-delay-slot
25283 @opindex mcbranch-force-delay-slot
25284 Force the usage of delay slots for conditional branches, which stuffs the delay
25285 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25286 this option is disabled.  It can be enabled to work around hardware bugs as
25287 found in the original SH7055.
25289 @item -mfused-madd
25290 @itemx -mno-fused-madd
25291 @opindex mfused-madd
25292 @opindex mno-fused-madd
25293 Generate code that uses (does not use) the floating-point multiply and
25294 accumulate instructions.  These instructions are generated by default
25295 if hardware floating point is used.  The machine-dependent
25296 @option{-mfused-madd} option is now mapped to the machine-independent
25297 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25298 mapped to @option{-ffp-contract=off}.
25300 @item -mfsca
25301 @itemx -mno-fsca
25302 @opindex mfsca
25303 @opindex mno-fsca
25304 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25305 and cosine approximations.  The option @option{-mfsca} must be used in
25306 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25307 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25308 approximations even if @option{-funsafe-math-optimizations} is in effect.
25310 @item -mfsrra
25311 @itemx -mno-fsrra
25312 @opindex mfsrra
25313 @opindex mno-fsrra
25314 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25315 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25316 in combination with @option{-funsafe-math-optimizations} and
25317 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25318 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25319 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25320 in effect.
25322 @item -mpretend-cmove
25323 @opindex mpretend-cmove
25324 Prefer zero-displacement conditional branches for conditional move instruction
25325 patterns.  This can result in faster code on the SH4 processor.
25327 @item -mfdpic
25328 @opindex fdpic
25329 Generate code using the FDPIC ABI.
25331 @end table
25333 @node Solaris 2 Options
25334 @subsection Solaris 2 Options
25335 @cindex Solaris 2 options
25337 These @samp{-m} options are supported on Solaris 2:
25339 @table @gcctabopt
25340 @item -mclear-hwcap
25341 @opindex mclear-hwcap
25342 @option{-mclear-hwcap} tells the compiler to remove the hardware
25343 capabilities generated by the Solaris assembler.  This is only necessary
25344 when object files use ISA extensions not supported by the current
25345 machine, but check at runtime whether or not to use them.
25347 @item -mimpure-text
25348 @opindex mimpure-text
25349 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25350 the compiler to not pass @option{-z text} to the linker when linking a
25351 shared object.  Using this option, you can link position-dependent
25352 code into a shared object.
25354 @option{-mimpure-text} suppresses the ``relocations remain against
25355 allocatable but non-writable sections'' linker error message.
25356 However, the necessary relocations trigger copy-on-write, and the
25357 shared object is not actually shared across processes.  Instead of
25358 using @option{-mimpure-text}, you should compile all source code with
25359 @option{-fpic} or @option{-fPIC}.
25361 @end table
25363 These switches are supported in addition to the above on Solaris 2:
25365 @table @gcctabopt
25366 @item -pthreads
25367 @opindex pthreads
25368 This is a synonym for @option{-pthread}.
25369 @end table
25371 @node SPARC Options
25372 @subsection SPARC Options
25373 @cindex SPARC options
25375 These @samp{-m} options are supported on the SPARC:
25377 @table @gcctabopt
25378 @item -mno-app-regs
25379 @itemx -mapp-regs
25380 @opindex mno-app-regs
25381 @opindex mapp-regs
25382 Specify @option{-mapp-regs} to generate output using the global registers
25383 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25384 global register 1, each global register 2 through 4 is then treated as an
25385 allocable register that is clobbered by function calls.  This is the default.
25387 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25388 specify @option{-mno-app-regs}.  You should compile libraries and system
25389 software with this option.
25391 @item -mflat
25392 @itemx -mno-flat
25393 @opindex mflat
25394 @opindex mno-flat
25395 With @option{-mflat}, the compiler does not generate save/restore instructions
25396 and uses a ``flat'' or single register window model.  This model is compatible
25397 with the regular register window model.  The local registers and the input
25398 registers (0--5) are still treated as ``call-saved'' registers and are
25399 saved on the stack as needed.
25401 With @option{-mno-flat} (the default), the compiler generates save/restore
25402 instructions (except for leaf functions).  This is the normal operating mode.
25404 @item -mfpu
25405 @itemx -mhard-float
25406 @opindex mfpu
25407 @opindex mhard-float
25408 Generate output containing floating-point instructions.  This is the
25409 default.
25411 @item -mno-fpu
25412 @itemx -msoft-float
25413 @opindex mno-fpu
25414 @opindex msoft-float
25415 Generate output containing library calls for floating point.
25416 @strong{Warning:} the requisite libraries are not available for all SPARC
25417 targets.  Normally the facilities of the machine's usual C compiler are
25418 used, but this cannot be done directly in cross-compilation.  You must make
25419 your own arrangements to provide suitable library functions for
25420 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25421 @samp{sparclite-*-*} do provide software floating-point support.
25423 @option{-msoft-float} changes the calling convention in the output file;
25424 therefore, it is only useful if you compile @emph{all} of a program with
25425 this option.  In particular, you need to compile @file{libgcc.a}, the
25426 library that comes with GCC, with @option{-msoft-float} in order for
25427 this to work.
25429 @item -mhard-quad-float
25430 @opindex mhard-quad-float
25431 Generate output containing quad-word (long double) floating-point
25432 instructions.
25434 @item -msoft-quad-float
25435 @opindex msoft-quad-float
25436 Generate output containing library calls for quad-word (long double)
25437 floating-point instructions.  The functions called are those specified
25438 in the SPARC ABI@.  This is the default.
25440 As of this writing, there are no SPARC implementations that have hardware
25441 support for the quad-word floating-point instructions.  They all invoke
25442 a trap handler for one of these instructions, and then the trap handler
25443 emulates the effect of the instruction.  Because of the trap handler overhead,
25444 this is much slower than calling the ABI library routines.  Thus the
25445 @option{-msoft-quad-float} option is the default.
25447 @item -mno-unaligned-doubles
25448 @itemx -munaligned-doubles
25449 @opindex mno-unaligned-doubles
25450 @opindex munaligned-doubles
25451 Assume that doubles have 8-byte alignment.  This is the default.
25453 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25454 alignment only if they are contained in another type, or if they have an
25455 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25456 Specifying this option avoids some rare compatibility problems with code
25457 generated by other compilers.  It is not the default because it results
25458 in a performance loss, especially for floating-point code.
25460 @item -muser-mode
25461 @itemx -mno-user-mode
25462 @opindex muser-mode
25463 @opindex mno-user-mode
25464 Do not generate code that can only run in supervisor mode.  This is relevant
25465 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25466 is the default.
25468 @item -mfaster-structs
25469 @itemx -mno-faster-structs
25470 @opindex mfaster-structs
25471 @opindex mno-faster-structs
25472 With @option{-mfaster-structs}, the compiler assumes that structures
25473 should have 8-byte alignment.  This enables the use of pairs of
25474 @code{ldd} and @code{std} instructions for copies in structure
25475 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25476 However, the use of this changed alignment directly violates the SPARC
25477 ABI@.  Thus, it's intended only for use on targets where the developer
25478 acknowledges that their resulting code is not directly in line with
25479 the rules of the ABI@.
25481 @item -mstd-struct-return
25482 @itemx -mno-std-struct-return
25483 @opindex mstd-struct-return
25484 @opindex mno-std-struct-return
25485 With @option{-mstd-struct-return}, the compiler generates checking code
25486 in functions returning structures or unions to detect size mismatches
25487 between the two sides of function calls, as per the 32-bit ABI@.
25489 The default is @option{-mno-std-struct-return}.  This option has no effect
25490 in 64-bit mode.
25492 @item -mlra
25493 @itemx -mno-lra
25494 @opindex mlra
25495 @opindex mno-lra
25496 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25497 so @option{-mno-lra} needs to be passed to get old Reload.
25499 @item -mcpu=@var{cpu_type}
25500 @opindex mcpu
25501 Set the instruction set, register set, and instruction scheduling parameters
25502 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25503 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25504 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25505 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25506 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25507 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25509 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25510 which selects the best architecture option for the host processor.
25511 @option{-mcpu=native} has no effect if GCC does not recognize
25512 the processor.
25514 Default instruction scheduling parameters are used for values that select
25515 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25516 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25518 Here is a list of each supported architecture and their supported
25519 implementations.
25521 @table @asis
25522 @item v7
25523 cypress, leon3v7
25525 @item v8
25526 supersparc, hypersparc, leon, leon3
25528 @item sparclite
25529 f930, f934, sparclite86x
25531 @item sparclet
25532 tsc701
25534 @item v9
25535 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25536 niagara7, m8
25537 @end table
25539 By default (unless configured otherwise), GCC generates code for the V7
25540 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25541 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25542 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25543 SPARCStation 1, 2, IPX etc.
25545 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25546 architecture.  The only difference from V7 code is that the compiler emits
25547 the integer multiply and integer divide instructions which exist in SPARC-V8
25548 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25549 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25550 2000 series.
25552 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25553 the SPARC architecture.  This adds the integer multiply, integer divide step
25554 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25555 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25556 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25557 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25558 MB86934 chip, which is the more recent SPARClite with FPU@.
25560 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25561 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25562 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25563 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25564 optimizes it for the TEMIC SPARClet chip.
25566 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25567 architecture.  This adds 64-bit integer and floating-point move instructions,
25568 3 additional floating-point condition code registers and conditional move
25569 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25570 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25571 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25572 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25573 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25574 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25575 additionally optimizes it for Sun UltraSPARC T2 chips. With
25576 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25577 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25578 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25579 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25580 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25581 additionally optimizes it for Oracle M8 chips.
25583 @item -mtune=@var{cpu_type}
25584 @opindex mtune
25585 Set the instruction scheduling parameters for machine type
25586 @var{cpu_type}, but do not set the instruction set or register set that the
25587 option @option{-mcpu=@var{cpu_type}} does.
25589 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25590 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25591 that select a particular CPU implementation.  Those are
25592 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25593 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25594 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25595 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25596 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25597 and GNU/Linux toolchains, @samp{native} can also be used.
25599 @item -mv8plus
25600 @itemx -mno-v8plus
25601 @opindex mv8plus
25602 @opindex mno-v8plus
25603 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25604 difference from the V8 ABI is that the global and out registers are
25605 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25606 mode for all SPARC-V9 processors.
25608 @item -mvis
25609 @itemx -mno-vis
25610 @opindex mvis
25611 @opindex mno-vis
25612 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25613 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25615 @item -mvis2
25616 @itemx -mno-vis2
25617 @opindex mvis2
25618 @opindex mno-vis2
25619 With @option{-mvis2}, GCC generates code that takes advantage of
25620 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25621 default is @option{-mvis2} when targeting a cpu that supports such
25622 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25623 also sets @option{-mvis}.
25625 @item -mvis3
25626 @itemx -mno-vis3
25627 @opindex mvis3
25628 @opindex mno-vis3
25629 With @option{-mvis3}, GCC generates code that takes advantage of
25630 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25631 default is @option{-mvis3} when targeting a cpu that supports such
25632 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25633 also sets @option{-mvis2} and @option{-mvis}.
25635 @item -mvis4
25636 @itemx -mno-vis4
25637 @opindex mvis4
25638 @opindex mno-vis4
25639 With @option{-mvis4}, GCC generates code that takes advantage of
25640 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25641 default is @option{-mvis4} when targeting a cpu that supports such
25642 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25643 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25645 @item -mvis4b
25646 @itemx -mno-vis4b
25647 @opindex mvis4b
25648 @opindex mno-vis4b
25649 With @option{-mvis4b}, GCC generates code that takes advantage of
25650 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25651 the additional VIS instructions introduced in the Oracle SPARC
25652 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25653 cpu that supports such instructions, such as m8 and later.  Setting
25654 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25655 @option{-mvis2} and @option{-mvis}.
25657 @item -mcbcond
25658 @itemx -mno-cbcond
25659 @opindex mcbcond
25660 @opindex mno-cbcond
25661 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25662 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25663 when targeting a CPU that supports such instructions, such as Niagara-4 and
25664 later.
25666 @item -mfmaf
25667 @itemx -mno-fmaf
25668 @opindex mfmaf
25669 @opindex mno-fmaf
25670 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25671 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25672 when targeting a CPU that supports such instructions, such as Niagara-3 and
25673 later.
25675 @item -mfsmuld
25676 @itemx -mno-fsmuld
25677 @opindex mfsmuld
25678 @opindex mno-fsmuld
25679 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25680 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25681 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25682 or V9 with FPU except @option{-mcpu=leon}.
25684 @item -mpopc
25685 @itemx -mno-popc
25686 @opindex mpopc
25687 @opindex mno-popc
25688 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25689 Population Count instruction.  The default is @option{-mpopc}
25690 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25691 later.
25693 @item -msubxc
25694 @itemx -mno-subxc
25695 @opindex msubxc
25696 @opindex mno-subxc
25697 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25698 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25699 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25700 later.
25702 @item -mfix-at697f
25703 @opindex mfix-at697f
25704 Enable the documented workaround for the single erratum of the Atmel AT697F
25705 processor (which corresponds to erratum #13 of the AT697E processor).
25707 @item -mfix-ut699
25708 @opindex mfix-ut699
25709 Enable the documented workarounds for the floating-point errata and the data
25710 cache nullify errata of the UT699 processor.
25712 @item -mfix-ut700
25713 @opindex mfix-ut700
25714 Enable the documented workaround for the back-to-back store errata of
25715 the UT699E/UT700 processor.
25717 @item -mfix-gr712rc
25718 @opindex mfix-gr712rc
25719 Enable the documented workaround for the back-to-back store errata of
25720 the GR712RC processor.
25721 @end table
25723 These @samp{-m} options are supported in addition to the above
25724 on SPARC-V9 processors in 64-bit environments:
25726 @table @gcctabopt
25727 @item -m32
25728 @itemx -m64
25729 @opindex m32
25730 @opindex m64
25731 Generate code for a 32-bit or 64-bit environment.
25732 The 32-bit environment sets int, long and pointer to 32 bits.
25733 The 64-bit environment sets int to 32 bits and long and pointer
25734 to 64 bits.
25736 @item -mcmodel=@var{which}
25737 @opindex mcmodel
25738 Set the code model to one of
25740 @table @samp
25741 @item medlow
25742 The Medium/Low code model: 64-bit addresses, programs
25743 must be linked in the low 32 bits of memory.  Programs can be statically
25744 or dynamically linked.
25746 @item medmid
25747 The Medium/Middle code model: 64-bit addresses, programs
25748 must be linked in the low 44 bits of memory, the text and data segments must
25749 be less than 2GB in size and the data segment must be located within 2GB of
25750 the text segment.
25752 @item medany
25753 The Medium/Anywhere code model: 64-bit addresses, programs
25754 may be linked anywhere in memory, the text and data segments must be less
25755 than 2GB in size and the data segment must be located within 2GB of the
25756 text segment.
25758 @item embmedany
25759 The Medium/Anywhere code model for embedded systems:
25760 64-bit addresses, the text and data segments must be less than 2GB in
25761 size, both starting anywhere in memory (determined at link time).  The
25762 global register %g4 points to the base of the data segment.  Programs
25763 are statically linked and PIC is not supported.
25764 @end table
25766 @item -mmemory-model=@var{mem-model}
25767 @opindex mmemory-model
25768 Set the memory model in force on the processor to one of
25770 @table @samp
25771 @item default
25772 The default memory model for the processor and operating system.
25774 @item rmo
25775 Relaxed Memory Order
25777 @item pso
25778 Partial Store Order
25780 @item tso
25781 Total Store Order
25783 @item sc
25784 Sequential Consistency
25785 @end table
25787 These memory models are formally defined in Appendix D of the SPARC-V9
25788 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25790 @item -mstack-bias
25791 @itemx -mno-stack-bias
25792 @opindex mstack-bias
25793 @opindex mno-stack-bias
25794 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25795 frame pointer if present, are offset by @minus{}2047 which must be added back
25796 when making stack frame references.  This is the default in 64-bit mode.
25797 Otherwise, assume no such offset is present.
25798 @end table
25800 @node SPU Options
25801 @subsection SPU Options
25802 @cindex SPU options
25804 These @samp{-m} options are supported on the SPU:
25806 @table @gcctabopt
25807 @item -mwarn-reloc
25808 @itemx -merror-reloc
25809 @opindex mwarn-reloc
25810 @opindex merror-reloc
25812 The loader for SPU does not handle dynamic relocations.  By default, GCC
25813 gives an error when it generates code that requires a dynamic
25814 relocation.  @option{-mno-error-reloc} disables the error,
25815 @option{-mwarn-reloc} generates a warning instead.
25817 @item -msafe-dma
25818 @itemx -munsafe-dma
25819 @opindex msafe-dma
25820 @opindex munsafe-dma
25822 Instructions that initiate or test completion of DMA must not be
25823 reordered with respect to loads and stores of the memory that is being
25824 accessed.
25825 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25826 memory accesses, but that can lead to inefficient code in places where the
25827 memory is known to not change.  Rather than mark the memory as volatile,
25828 you can use @option{-msafe-dma} to tell the compiler to treat
25829 the DMA instructions as potentially affecting all memory.  
25831 @item -mbranch-hints
25832 @opindex mbranch-hints
25834 By default, GCC generates a branch hint instruction to avoid
25835 pipeline stalls for always-taken or probably-taken branches.  A hint
25836 is not generated closer than 8 instructions away from its branch.
25837 There is little reason to disable them, except for debugging purposes,
25838 or to make an object a little bit smaller.
25840 @item -msmall-mem
25841 @itemx -mlarge-mem
25842 @opindex msmall-mem
25843 @opindex mlarge-mem
25845 By default, GCC generates code assuming that addresses are never larger
25846 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25847 a full 32-bit address.
25849 @item -mstdmain
25850 @opindex mstdmain
25852 By default, GCC links against startup code that assumes the SPU-style
25853 main function interface (which has an unconventional parameter list).
25854 With @option{-mstdmain}, GCC links your program against startup
25855 code that assumes a C99-style interface to @code{main}, including a
25856 local copy of @code{argv} strings.
25858 @item -mfixed-range=@var{register-range}
25859 @opindex mfixed-range
25860 Generate code treating the given register range as fixed registers.
25861 A fixed register is one that the register allocator cannot use.  This is
25862 useful when compiling kernel code.  A register range is specified as
25863 two registers separated by a dash.  Multiple register ranges can be
25864 specified separated by a comma.
25866 @item -mea32
25867 @itemx -mea64
25868 @opindex mea32
25869 @opindex mea64
25870 Compile code assuming that pointers to the PPU address space accessed
25871 via the @code{__ea} named address space qualifier are either 32 or 64
25872 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25873 all object code in an executable must be compiled with the same setting.
25875 @item -maddress-space-conversion
25876 @itemx -mno-address-space-conversion
25877 @opindex maddress-space-conversion
25878 @opindex mno-address-space-conversion
25879 Allow/disallow treating the @code{__ea} address space as superset
25880 of the generic address space.  This enables explicit type casts
25881 between @code{__ea} and generic pointer as well as implicit
25882 conversions of generic pointers to @code{__ea} pointers.  The
25883 default is to allow address space pointer conversions.
25885 @item -mcache-size=@var{cache-size}
25886 @opindex mcache-size
25887 This option controls the version of libgcc that the compiler links to an
25888 executable and selects a software-managed cache for accessing variables
25889 in the @code{__ea} address space with a particular cache size.  Possible
25890 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25891 and @samp{128}.  The default cache size is 64KB.
25893 @item -matomic-updates
25894 @itemx -mno-atomic-updates
25895 @opindex matomic-updates
25896 @opindex mno-atomic-updates
25897 This option controls the version of libgcc that the compiler links to an
25898 executable and selects whether atomic updates to the software-managed
25899 cache of PPU-side variables are used.  If you use atomic updates, changes
25900 to a PPU variable from SPU code using the @code{__ea} named address space
25901 qualifier do not interfere with changes to other PPU variables residing
25902 in the same cache line from PPU code.  If you do not use atomic updates,
25903 such interference may occur; however, writing back cache lines is
25904 more efficient.  The default behavior is to use atomic updates.
25906 @item -mdual-nops
25907 @itemx -mdual-nops=@var{n}
25908 @opindex mdual-nops
25909 By default, GCC inserts NOPs to increase dual issue when it expects
25910 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25911 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25912 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25914 @item -mhint-max-nops=@var{n}
25915 @opindex mhint-max-nops
25916 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25917 be at least 8 instructions away from the branch it is affecting.  GCC
25918 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25919 generate the branch hint.
25921 @item -mhint-max-distance=@var{n}
25922 @opindex mhint-max-distance
25923 The encoding of the branch hint instruction limits the hint to be within
25924 256 instructions of the branch it is affecting.  By default, GCC makes
25925 sure it is within 125.
25927 @item -msafe-hints
25928 @opindex msafe-hints
25929 Work around a hardware bug that causes the SPU to stall indefinitely.
25930 By default, GCC inserts the @code{hbrp} instruction to make sure
25931 this stall won't happen.
25933 @end table
25935 @node System V Options
25936 @subsection Options for System V
25938 These additional options are available on System V Release 4 for
25939 compatibility with other compilers on those systems:
25941 @table @gcctabopt
25942 @item -G
25943 @opindex G
25944 Create a shared object.
25945 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25947 @item -Qy
25948 @opindex Qy
25949 Identify the versions of each tool used by the compiler, in a
25950 @code{.ident} assembler directive in the output.
25952 @item -Qn
25953 @opindex Qn
25954 Refrain from adding @code{.ident} directives to the output file (this is
25955 the default).
25957 @item -YP,@var{dirs}
25958 @opindex YP
25959 Search the directories @var{dirs}, and no others, for libraries
25960 specified with @option{-l}.
25962 @item -Ym,@var{dir}
25963 @opindex Ym
25964 Look in the directory @var{dir} to find the M4 preprocessor.
25965 The assembler uses this option.
25966 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25967 @c the generic assembler that comes with Solaris takes just -Ym.
25968 @end table
25970 @node TILE-Gx Options
25971 @subsection TILE-Gx Options
25972 @cindex TILE-Gx options
25974 These @samp{-m} options are supported on the TILE-Gx:
25976 @table @gcctabopt
25977 @item -mcmodel=small
25978 @opindex mcmodel=small
25979 Generate code for the small model.  The distance for direct calls is
25980 limited to 500M in either direction.  PC-relative addresses are 32
25981 bits.  Absolute addresses support the full address range.
25983 @item -mcmodel=large
25984 @opindex mcmodel=large
25985 Generate code for the large model.  There is no limitation on call
25986 distance, pc-relative addresses, or absolute addresses.
25988 @item -mcpu=@var{name}
25989 @opindex mcpu
25990 Selects the type of CPU to be targeted.  Currently the only supported
25991 type is @samp{tilegx}.
25993 @item -m32
25994 @itemx -m64
25995 @opindex m32
25996 @opindex m64
25997 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25998 environment sets int, long, and pointer to 32 bits.  The 64-bit
25999 environment sets int to 32 bits and long and pointer to 64 bits.
26001 @item -mbig-endian
26002 @itemx -mlittle-endian
26003 @opindex mbig-endian
26004 @opindex mlittle-endian
26005 Generate code in big/little endian mode, respectively.
26006 @end table
26008 @node TILEPro Options
26009 @subsection TILEPro Options
26010 @cindex TILEPro options
26012 These @samp{-m} options are supported on the TILEPro:
26014 @table @gcctabopt
26015 @item -mcpu=@var{name}
26016 @opindex mcpu
26017 Selects the type of CPU to be targeted.  Currently the only supported
26018 type is @samp{tilepro}.
26020 @item -m32
26021 @opindex m32
26022 Generate code for a 32-bit environment, which sets int, long, and
26023 pointer to 32 bits.  This is the only supported behavior so the flag
26024 is essentially ignored.
26025 @end table
26027 @node V850 Options
26028 @subsection V850 Options
26029 @cindex V850 Options
26031 These @samp{-m} options are defined for V850 implementations:
26033 @table @gcctabopt
26034 @item -mlong-calls
26035 @itemx -mno-long-calls
26036 @opindex mlong-calls
26037 @opindex mno-long-calls
26038 Treat all calls as being far away (near).  If calls are assumed to be
26039 far away, the compiler always loads the function's address into a
26040 register, and calls indirect through the pointer.
26042 @item -mno-ep
26043 @itemx -mep
26044 @opindex mno-ep
26045 @opindex mep
26046 Do not optimize (do optimize) basic blocks that use the same index
26047 pointer 4 or more times to copy pointer into the @code{ep} register, and
26048 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26049 option is on by default if you optimize.
26051 @item -mno-prolog-function
26052 @itemx -mprolog-function
26053 @opindex mno-prolog-function
26054 @opindex mprolog-function
26055 Do not use (do use) external functions to save and restore registers
26056 at the prologue and epilogue of a function.  The external functions
26057 are slower, but use less code space if more than one function saves
26058 the same number of registers.  The @option{-mprolog-function} option
26059 is on by default if you optimize.
26061 @item -mspace
26062 @opindex mspace
26063 Try to make the code as small as possible.  At present, this just turns
26064 on the @option{-mep} and @option{-mprolog-function} options.
26066 @item -mtda=@var{n}
26067 @opindex mtda
26068 Put static or global variables whose size is @var{n} bytes or less into
26069 the tiny data area that register @code{ep} points to.  The tiny data
26070 area can hold up to 256 bytes in total (128 bytes for byte references).
26072 @item -msda=@var{n}
26073 @opindex msda
26074 Put static or global variables whose size is @var{n} bytes or less into
26075 the small data area that register @code{gp} points to.  The small data
26076 area can hold up to 64 kilobytes.
26078 @item -mzda=@var{n}
26079 @opindex mzda
26080 Put static or global variables whose size is @var{n} bytes or less into
26081 the first 32 kilobytes of memory.
26083 @item -mv850
26084 @opindex mv850
26085 Specify that the target processor is the V850.
26087 @item -mv850e3v5
26088 @opindex mv850e3v5
26089 Specify that the target processor is the V850E3V5.  The preprocessor
26090 constant @code{__v850e3v5__} is defined if this option is used.
26092 @item -mv850e2v4
26093 @opindex mv850e2v4
26094 Specify that the target processor is the V850E3V5.  This is an alias for
26095 the @option{-mv850e3v5} option.
26097 @item -mv850e2v3
26098 @opindex mv850e2v3
26099 Specify that the target processor is the V850E2V3.  The preprocessor
26100 constant @code{__v850e2v3__} is defined if this option is used.
26102 @item -mv850e2
26103 @opindex mv850e2
26104 Specify that the target processor is the V850E2.  The preprocessor
26105 constant @code{__v850e2__} is defined if this option is used.
26107 @item -mv850e1
26108 @opindex mv850e1
26109 Specify that the target processor is the V850E1.  The preprocessor
26110 constants @code{__v850e1__} and @code{__v850e__} are defined if
26111 this option is used.
26113 @item -mv850es
26114 @opindex mv850es
26115 Specify that the target processor is the V850ES.  This is an alias for
26116 the @option{-mv850e1} option.
26118 @item -mv850e
26119 @opindex mv850e
26120 Specify that the target processor is the V850E@.  The preprocessor
26121 constant @code{__v850e__} is defined if this option is used.
26123 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26124 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26125 are defined then a default target processor is chosen and the
26126 relevant @samp{__v850*__} preprocessor constant is defined.
26128 The preprocessor constants @code{__v850} and @code{__v851__} are always
26129 defined, regardless of which processor variant is the target.
26131 @item -mdisable-callt
26132 @itemx -mno-disable-callt
26133 @opindex mdisable-callt
26134 @opindex mno-disable-callt
26135 This option suppresses generation of the @code{CALLT} instruction for the
26136 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26137 architecture.
26139 This option is enabled by default when the RH850 ABI is
26140 in use (see @option{-mrh850-abi}), and disabled by default when the
26141 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26142 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26144 @item -mrelax
26145 @itemx -mno-relax
26146 @opindex mrelax
26147 @opindex mno-relax
26148 Pass on (or do not pass on) the @option{-mrelax} command-line option
26149 to the assembler.
26151 @item -mlong-jumps
26152 @itemx -mno-long-jumps
26153 @opindex mlong-jumps
26154 @opindex mno-long-jumps
26155 Disable (or re-enable) the generation of PC-relative jump instructions.
26157 @item -msoft-float
26158 @itemx -mhard-float
26159 @opindex msoft-float
26160 @opindex mhard-float
26161 Disable (or re-enable) the generation of hardware floating point
26162 instructions.  This option is only significant when the target
26163 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26164 instructions are being generated then the C preprocessor symbol
26165 @code{__FPU_OK__} is defined, otherwise the symbol
26166 @code{__NO_FPU__} is defined.
26168 @item -mloop
26169 @opindex mloop
26170 Enables the use of the e3v5 LOOP instruction.  The use of this
26171 instruction is not enabled by default when the e3v5 architecture is
26172 selected because its use is still experimental.
26174 @item -mrh850-abi
26175 @itemx -mghs
26176 @opindex mrh850-abi
26177 @opindex mghs
26178 Enables support for the RH850 version of the V850 ABI.  This is the
26179 default.  With this version of the ABI the following rules apply:
26181 @itemize
26182 @item
26183 Integer sized structures and unions are returned via a memory pointer
26184 rather than a register.
26186 @item
26187 Large structures and unions (more than 8 bytes in size) are passed by
26188 value.
26190 @item
26191 Functions are aligned to 16-bit boundaries.
26193 @item
26194 The @option{-m8byte-align} command-line option is supported.
26196 @item
26197 The @option{-mdisable-callt} command-line option is enabled by
26198 default.  The @option{-mno-disable-callt} command-line option is not
26199 supported.
26200 @end itemize
26202 When this version of the ABI is enabled the C preprocessor symbol
26203 @code{__V850_RH850_ABI__} is defined.
26205 @item -mgcc-abi
26206 @opindex mgcc-abi
26207 Enables support for the old GCC version of the V850 ABI.  With this
26208 version of the ABI the following rules apply:
26210 @itemize
26211 @item
26212 Integer sized structures and unions are returned in register @code{r10}.
26214 @item
26215 Large structures and unions (more than 8 bytes in size) are passed by
26216 reference.
26218 @item
26219 Functions are aligned to 32-bit boundaries, unless optimizing for
26220 size.
26222 @item
26223 The @option{-m8byte-align} command-line option is not supported.
26225 @item
26226 The @option{-mdisable-callt} command-line option is supported but not
26227 enabled by default.
26228 @end itemize
26230 When this version of the ABI is enabled the C preprocessor symbol
26231 @code{__V850_GCC_ABI__} is defined.
26233 @item -m8byte-align
26234 @itemx -mno-8byte-align
26235 @opindex m8byte-align
26236 @opindex mno-8byte-align
26237 Enables support for @code{double} and @code{long long} types to be
26238 aligned on 8-byte boundaries.  The default is to restrict the
26239 alignment of all objects to at most 4-bytes.  When
26240 @option{-m8byte-align} is in effect the C preprocessor symbol
26241 @code{__V850_8BYTE_ALIGN__} is defined.
26243 @item -mbig-switch
26244 @opindex mbig-switch
26245 Generate code suitable for big switch tables.  Use this option only if
26246 the assembler/linker complain about out of range branches within a switch
26247 table.
26249 @item -mapp-regs
26250 @opindex mapp-regs
26251 This option causes r2 and r5 to be used in the code generated by
26252 the compiler.  This setting is the default.
26254 @item -mno-app-regs
26255 @opindex mno-app-regs
26256 This option causes r2 and r5 to be treated as fixed registers.
26258 @end table
26260 @node VAX Options
26261 @subsection VAX Options
26262 @cindex VAX options
26264 These @samp{-m} options are defined for the VAX:
26266 @table @gcctabopt
26267 @item -munix
26268 @opindex munix
26269 Do not output certain jump instructions (@code{aobleq} and so on)
26270 that the Unix assembler for the VAX cannot handle across long
26271 ranges.
26273 @item -mgnu
26274 @opindex mgnu
26275 Do output those jump instructions, on the assumption that the
26276 GNU assembler is being used.
26278 @item -mg
26279 @opindex mg
26280 Output code for G-format floating-point numbers instead of D-format.
26281 @end table
26283 @node Visium Options
26284 @subsection Visium Options
26285 @cindex Visium options
26287 @table @gcctabopt
26289 @item -mdebug
26290 @opindex mdebug
26291 A program which performs file I/O and is destined to run on an MCM target
26292 should be linked with this option.  It causes the libraries libc.a and
26293 libdebug.a to be linked.  The program should be run on the target under
26294 the control of the GDB remote debugging stub.
26296 @item -msim
26297 @opindex msim
26298 A program which performs file I/O and is destined to run on the simulator
26299 should be linked with option.  This causes libraries libc.a and libsim.a to
26300 be linked.
26302 @item -mfpu
26303 @itemx -mhard-float
26304 @opindex mfpu
26305 @opindex mhard-float
26306 Generate code containing floating-point instructions.  This is the
26307 default.
26309 @item -mno-fpu
26310 @itemx -msoft-float
26311 @opindex mno-fpu
26312 @opindex msoft-float
26313 Generate code containing library calls for floating-point.
26315 @option{-msoft-float} changes the calling convention in the output file;
26316 therefore, it is only useful if you compile @emph{all} of a program with
26317 this option.  In particular, you need to compile @file{libgcc.a}, the
26318 library that comes with GCC, with @option{-msoft-float} in order for
26319 this to work.
26321 @item -mcpu=@var{cpu_type}
26322 @opindex mcpu
26323 Set the instruction set, register set, and instruction scheduling parameters
26324 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26325 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26327 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26329 By default (unless configured otherwise), GCC generates code for the GR5
26330 variant of the Visium architecture.  
26332 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26333 architecture.  The only difference from GR5 code is that the compiler will
26334 generate block move instructions.
26336 @item -mtune=@var{cpu_type}
26337 @opindex mtune
26338 Set the instruction scheduling parameters for machine type @var{cpu_type},
26339 but do not set the instruction set or register set that the option
26340 @option{-mcpu=@var{cpu_type}} would.
26342 @item -msv-mode
26343 @opindex msv-mode
26344 Generate code for the supervisor mode, where there are no restrictions on
26345 the access to general registers.  This is the default.
26347 @item -muser-mode
26348 @opindex muser-mode
26349 Generate code for the user mode, where the access to some general registers
26350 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26351 mode; on the GR6, only registers r29 to r31 are affected.
26352 @end table
26354 @node VMS Options
26355 @subsection VMS Options
26357 These @samp{-m} options are defined for the VMS implementations:
26359 @table @gcctabopt
26360 @item -mvms-return-codes
26361 @opindex mvms-return-codes
26362 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26363 condition (e.g.@ error) codes.
26365 @item -mdebug-main=@var{prefix}
26366 @opindex mdebug-main=@var{prefix}
26367 Flag the first routine whose name starts with @var{prefix} as the main
26368 routine for the debugger.
26370 @item -mmalloc64
26371 @opindex mmalloc64
26372 Default to 64-bit memory allocation routines.
26374 @item -mpointer-size=@var{size}
26375 @opindex mpointer-size=@var{size}
26376 Set the default size of pointers. Possible options for @var{size} are
26377 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26378 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26379 The later option disables @code{pragma pointer_size}.
26380 @end table
26382 @node VxWorks Options
26383 @subsection VxWorks Options
26384 @cindex VxWorks Options
26386 The options in this section are defined for all VxWorks targets.
26387 Options specific to the target hardware are listed with the other
26388 options for that target.
26390 @table @gcctabopt
26391 @item -mrtp
26392 @opindex mrtp
26393 GCC can generate code for both VxWorks kernels and real time processes
26394 (RTPs).  This option switches from the former to the latter.  It also
26395 defines the preprocessor macro @code{__RTP__}.
26397 @item -non-static
26398 @opindex non-static
26399 Link an RTP executable against shared libraries rather than static
26400 libraries.  The options @option{-static} and @option{-shared} can
26401 also be used for RTPs (@pxref{Link Options}); @option{-static}
26402 is the default.
26404 @item -Bstatic
26405 @itemx -Bdynamic
26406 @opindex Bstatic
26407 @opindex Bdynamic
26408 These options are passed down to the linker.  They are defined for
26409 compatibility with Diab.
26411 @item -Xbind-lazy
26412 @opindex Xbind-lazy
26413 Enable lazy binding of function calls.  This option is equivalent to
26414 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26416 @item -Xbind-now
26417 @opindex Xbind-now
26418 Disable lazy binding of function calls.  This option is the default and
26419 is defined for compatibility with Diab.
26420 @end table
26422 @node x86 Options
26423 @subsection x86 Options
26424 @cindex x86 Options
26426 These @samp{-m} options are defined for the x86 family of computers.
26428 @table @gcctabopt
26430 @item -march=@var{cpu-type}
26431 @opindex march
26432 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26433 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26434 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26435 to generate code that may not run at all on processors other than the one
26436 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26437 @option{-mtune=@var{cpu-type}}.
26439 The choices for @var{cpu-type} are:
26441 @table @samp
26442 @item native
26443 This selects the CPU to generate code for at compilation time by determining
26444 the processor type of the compiling machine.  Using @option{-march=native}
26445 enables all instruction subsets supported by the local machine (hence
26446 the result might not run on different machines).  Using @option{-mtune=native}
26447 produces code optimized for the local machine under the constraints
26448 of the selected instruction set.  
26450 @item x86-64
26451 A generic CPU with 64-bit extensions.
26453 @item i386
26454 Original Intel i386 CPU@.
26456 @item i486
26457 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26459 @item i586
26460 @itemx pentium
26461 Intel Pentium CPU with no MMX support.
26463 @item lakemont
26464 Intel Lakemont MCU, based on Intel Pentium CPU.
26466 @item pentium-mmx
26467 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26469 @item pentiumpro
26470 Intel Pentium Pro CPU@.
26472 @item i686
26473 When used with @option{-march}, the Pentium Pro
26474 instruction set is used, so the code runs on all i686 family chips.
26475 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26477 @item pentium2
26478 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26479 support.
26481 @item pentium3
26482 @itemx pentium3m
26483 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26484 set support.
26486 @item pentium-m
26487 Intel Pentium M; low-power version of Intel Pentium III CPU
26488 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26490 @item pentium4
26491 @itemx pentium4m
26492 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26494 @item prescott
26495 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26496 set support.
26498 @item nocona
26499 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26500 SSE2 and SSE3 instruction set support.
26502 @item core2
26503 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26504 instruction set support.
26506 @item nehalem
26507 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26508 SSE4.1, SSE4.2 and POPCNT instruction set support.
26510 @item westmere
26511 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26512 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26514 @item sandybridge
26515 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26516 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26518 @item ivybridge
26519 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26520 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26521 instruction set support.
26523 @item haswell
26524 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26525 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26526 BMI, BMI2 and F16C instruction set support.
26528 @item broadwell
26529 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26530 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26531 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26533 @item skylake
26534 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26535 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26536 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26537 XSAVES instruction set support.
26539 @item bonnell
26540 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26541 instruction set support.
26543 @item silvermont
26544 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26545 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26547 @item knl
26548 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26549 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26550 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26551 AVX512CD instruction set support.
26553 @item knm
26554 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26555 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26556 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26557 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26559 @item skylake-avx512
26560 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26561 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26562 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26563 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26565 @item cannonlake
26566 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26567 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26568 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26569 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26570 AVX512IFMA, SHA and UMIP instruction set support.
26572 @item icelake-client
26573 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26574 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26575 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26576 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26577 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26578 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26580 @item icelake-server
26581 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26582 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26583 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26584 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26585 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26586 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26587 set support.
26589 @item k6
26590 AMD K6 CPU with MMX instruction set support.
26592 @item k6-2
26593 @itemx k6-3
26594 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26596 @item athlon
26597 @itemx athlon-tbird
26598 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26599 support.
26601 @item athlon-4
26602 @itemx athlon-xp
26603 @itemx athlon-mp
26604 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26605 instruction set support.
26607 @item k8
26608 @itemx opteron
26609 @itemx athlon64
26610 @itemx athlon-fx
26611 Processors based on the AMD K8 core with x86-64 instruction set support,
26612 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26613 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26614 instruction set extensions.)
26616 @item k8-sse3
26617 @itemx opteron-sse3
26618 @itemx athlon64-sse3
26619 Improved versions of AMD K8 cores with SSE3 instruction set support.
26621 @item amdfam10
26622 @itemx barcelona
26623 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26624 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26625 instruction set extensions.)
26627 @item bdver1
26628 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26629 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26630 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26631 @item bdver2
26632 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26633 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26634 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26635 extensions.)
26636 @item bdver3
26637 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26638 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26639 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26640 64-bit instruction set extensions.
26641 @item bdver4
26642 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26643 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26644 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26645 SSE4.2, ABM and 64-bit instruction set extensions.
26647 @item znver1
26648 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26649 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26650 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26651 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26652 instruction set extensions.
26654 @item btver1
26655 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26656 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26657 instruction set extensions.)
26659 @item btver2
26660 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26661 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26662 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26664 @item winchip-c6
26665 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26666 set support.
26668 @item winchip2
26669 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26670 instruction set support.
26672 @item c3
26673 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26674 (No scheduling is implemented for this chip.)
26676 @item c3-2
26677 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26678 (No scheduling is implemented for this chip.)
26680 @item c7
26681 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26682 (No scheduling is implemented for this chip.)
26684 @item samuel-2
26685 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26686 (No scheduling is implemented for this chip.)
26688 @item nehemiah
26689 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26690 (No scheduling is implemented for this chip.)
26692 @item esther
26693 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26694 (No scheduling is implemented for this chip.)
26696 @item eden-x2
26697 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26698 (No scheduling is implemented for this chip.)
26700 @item eden-x4
26701 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26702 AVX and AVX2 instruction set support.
26703 (No scheduling is implemented for this chip.)
26705 @item nano
26706 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26707 instruction set support.
26708 (No scheduling is implemented for this chip.)
26710 @item nano-1000
26711 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26712 instruction set support.
26713 (No scheduling is implemented for this chip.)
26715 @item nano-2000
26716 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26717 instruction set support.
26718 (No scheduling is implemented for this chip.)
26720 @item nano-3000
26721 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26722 instruction set support.
26723 (No scheduling is implemented for this chip.)
26725 @item nano-x2
26726 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26727 instruction set support.
26728 (No scheduling is implemented for this chip.)
26730 @item nano-x4
26731 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26732 instruction set support.
26733 (No scheduling is implemented for this chip.)
26735 @item geode
26736 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26737 @end table
26739 @item -mtune=@var{cpu-type}
26740 @opindex mtune
26741 Tune to @var{cpu-type} everything applicable about the generated code, except
26742 for the ABI and the set of available instructions.  
26743 While picking a specific @var{cpu-type} schedules things appropriately
26744 for that particular chip, the compiler does not generate any code that
26745 cannot run on the default machine type unless you use a
26746 @option{-march=@var{cpu-type}} option.
26747 For example, if GCC is configured for i686-pc-linux-gnu
26748 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26749 but still runs on i686 machines.
26751 The choices for @var{cpu-type} are the same as for @option{-march}.
26752 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26754 @table @samp
26755 @item generic
26756 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26757 If you know the CPU on which your code will run, then you should use
26758 the corresponding @option{-mtune} or @option{-march} option instead of
26759 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26760 of your application will have, then you should use this option.
26762 As new processors are deployed in the marketplace, the behavior of this
26763 option will change.  Therefore, if you upgrade to a newer version of
26764 GCC, code generation controlled by this option will change to reflect
26765 the processors
26766 that are most common at the time that version of GCC is released.
26768 There is no @option{-march=generic} option because @option{-march}
26769 indicates the instruction set the compiler can use, and there is no
26770 generic instruction set applicable to all processors.  In contrast,
26771 @option{-mtune} indicates the processor (or, in this case, collection of
26772 processors) for which the code is optimized.
26774 @item intel
26775 Produce code optimized for the most current Intel processors, which are
26776 Haswell and Silvermont for this version of GCC.  If you know the CPU
26777 on which your code will run, then you should use the corresponding
26778 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26779 But, if you want your application performs better on both Haswell and
26780 Silvermont, then you should use this option.
26782 As new Intel processors are deployed in the marketplace, the behavior of
26783 this option will change.  Therefore, if you upgrade to a newer version of
26784 GCC, code generation controlled by this option will change to reflect
26785 the most current Intel processors at the time that version of GCC is
26786 released.
26788 There is no @option{-march=intel} option because @option{-march} indicates
26789 the instruction set the compiler can use, and there is no common
26790 instruction set applicable to all processors.  In contrast,
26791 @option{-mtune} indicates the processor (or, in this case, collection of
26792 processors) for which the code is optimized.
26793 @end table
26795 @item -mcpu=@var{cpu-type}
26796 @opindex mcpu
26797 A deprecated synonym for @option{-mtune}.
26799 @item -mfpmath=@var{unit}
26800 @opindex mfpmath
26801 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26802 for @var{unit} are:
26804 @table @samp
26805 @item 387
26806 Use the standard 387 floating-point coprocessor present on the majority of chips and
26807 emulated otherwise.  Code compiled with this option runs almost everywhere.
26808 The temporary results are computed in 80-bit precision instead of the precision
26809 specified by the type, resulting in slightly different results compared to most
26810 of other chips.  See @option{-ffloat-store} for more detailed description.
26812 This is the default choice for non-Darwin x86-32 targets.
26814 @item sse
26815 Use scalar floating-point instructions present in the SSE instruction set.
26816 This instruction set is supported by Pentium III and newer chips,
26817 and in the AMD line
26818 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26819 instruction set supports only single-precision arithmetic, thus the double and
26820 extended-precision arithmetic are still done using 387.  A later version, present
26821 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26822 arithmetic too.
26824 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26825 or @option{-msse2} switches to enable SSE extensions and make this option
26826 effective.  For the x86-64 compiler, these extensions are enabled by default.
26828 The resulting code should be considerably faster in the majority of cases and avoid
26829 the numerical instability problems of 387 code, but may break some existing
26830 code that expects temporaries to be 80 bits.
26832 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26833 and the default choice for x86-32 targets with the SSE2 instruction set
26834 when @option{-ffast-math} is enabled.
26836 @item sse,387
26837 @itemx sse+387
26838 @itemx both
26839 Attempt to utilize both instruction sets at once.  This effectively doubles the
26840 amount of available registers, and on chips with separate execution units for
26841 387 and SSE the execution resources too.  Use this option with care, as it is
26842 still experimental, because the GCC register allocator does not model separate
26843 functional units well, resulting in unstable performance.
26844 @end table
26846 @item -masm=@var{dialect}
26847 @opindex masm=@var{dialect}
26848 Output assembly instructions using selected @var{dialect}.  Also affects
26849 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26850 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26851 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26852 not support @samp{intel}.
26854 @item -mieee-fp
26855 @itemx -mno-ieee-fp
26856 @opindex mieee-fp
26857 @opindex mno-ieee-fp
26858 Control whether or not the compiler uses IEEE floating-point
26859 comparisons.  These correctly handle the case where the result of a
26860 comparison is unordered.
26862 @item -m80387
26863 @itemx -mhard-float
26864 @opindex 80387
26865 @opindex mhard-float
26866 Generate output containing 80387 instructions for floating point.
26868 @item -mno-80387
26869 @itemx -msoft-float
26870 @opindex no-80387
26871 @opindex msoft-float
26872 Generate output containing library calls for floating point.
26874 @strong{Warning:} the requisite libraries are not part of GCC@.
26875 Normally the facilities of the machine's usual C compiler are used, but
26876 this cannot be done directly in cross-compilation.  You must make your
26877 own arrangements to provide suitable library functions for
26878 cross-compilation.
26880 On machines where a function returns floating-point results in the 80387
26881 register stack, some floating-point opcodes may be emitted even if
26882 @option{-msoft-float} is used.
26884 @item -mno-fp-ret-in-387
26885 @opindex mno-fp-ret-in-387
26886 Do not use the FPU registers for return values of functions.
26888 The usual calling convention has functions return values of types
26889 @code{float} and @code{double} in an FPU register, even if there
26890 is no FPU@.  The idea is that the operating system should emulate
26891 an FPU@.
26893 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26894 in ordinary CPU registers instead.
26896 @item -mno-fancy-math-387
26897 @opindex mno-fancy-math-387
26898 Some 387 emulators do not support the @code{sin}, @code{cos} and
26899 @code{sqrt} instructions for the 387.  Specify this option to avoid
26900 generating those instructions.  This option is the default on
26901 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26902 indicates that the target CPU always has an FPU and so the
26903 instruction does not need emulation.  These
26904 instructions are not generated unless you also use the
26905 @option{-funsafe-math-optimizations} switch.
26907 @item -malign-double
26908 @itemx -mno-align-double
26909 @opindex malign-double
26910 @opindex mno-align-double
26911 Control whether GCC aligns @code{double}, @code{long double}, and
26912 @code{long long} variables on a two-word boundary or a one-word
26913 boundary.  Aligning @code{double} variables on a two-word boundary
26914 produces code that runs somewhat faster on a Pentium at the
26915 expense of more memory.
26917 On x86-64, @option{-malign-double} is enabled by default.
26919 @strong{Warning:} if you use the @option{-malign-double} switch,
26920 structures containing the above types are aligned differently than
26921 the published application binary interface specifications for the x86-32
26922 and are not binary compatible with structures in code compiled
26923 without that switch.
26925 @item -m96bit-long-double
26926 @itemx -m128bit-long-double
26927 @opindex m96bit-long-double
26928 @opindex m128bit-long-double
26929 These switches control the size of @code{long double} type.  The x86-32
26930 application binary interface specifies the size to be 96 bits,
26931 so @option{-m96bit-long-double} is the default in 32-bit mode.
26933 Modern architectures (Pentium and newer) prefer @code{long double}
26934 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26935 conforming to the ABI, this is not possible.  So specifying
26936 @option{-m128bit-long-double} aligns @code{long double}
26937 to a 16-byte boundary by padding the @code{long double} with an additional
26938 32-bit zero.
26940 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26941 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26943 Notice that neither of these options enable any extra precision over the x87
26944 standard of 80 bits for a @code{long double}.
26946 @strong{Warning:} if you override the default value for your target ABI, this
26947 changes the size of 
26948 structures and arrays containing @code{long double} variables,
26949 as well as modifying the function calling convention for functions taking
26950 @code{long double}.  Hence they are not binary-compatible
26951 with code compiled without that switch.
26953 @item -mlong-double-64
26954 @itemx -mlong-double-80
26955 @itemx -mlong-double-128
26956 @opindex mlong-double-64
26957 @opindex mlong-double-80
26958 @opindex mlong-double-128
26959 These switches control the size of @code{long double} type. A size
26960 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26961 type. This is the default for 32-bit Bionic C library.  A size
26962 of 128 bits makes the @code{long double} type equivalent to the
26963 @code{__float128} type. This is the default for 64-bit Bionic C library.
26965 @strong{Warning:} if you override the default value for your target ABI, this
26966 changes the size of
26967 structures and arrays containing @code{long double} variables,
26968 as well as modifying the function calling convention for functions taking
26969 @code{long double}.  Hence they are not binary-compatible
26970 with code compiled without that switch.
26972 @item -malign-data=@var{type}
26973 @opindex malign-data
26974 Control how GCC aligns variables.  Supported values for @var{type} are
26975 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26976 and earlier, @samp{abi} uses alignment value as specified by the
26977 psABI, and @samp{cacheline} uses increased alignment value to match
26978 the cache line size.  @samp{compat} is the default.
26980 @item -mlarge-data-threshold=@var{threshold}
26981 @opindex mlarge-data-threshold
26982 When @option{-mcmodel=medium} is specified, data objects larger than
26983 @var{threshold} are placed in the large data section.  This value must be the
26984 same across all objects linked into the binary, and defaults to 65535.
26986 @item -mrtd
26987 @opindex mrtd
26988 Use a different function-calling convention, in which functions that
26989 take a fixed number of arguments return with the @code{ret @var{num}}
26990 instruction, which pops their arguments while returning.  This saves one
26991 instruction in the caller since there is no need to pop the arguments
26992 there.
26994 You can specify that an individual function is called with this calling
26995 sequence with the function attribute @code{stdcall}.  You can also
26996 override the @option{-mrtd} option by using the function attribute
26997 @code{cdecl}.  @xref{Function Attributes}.
26999 @strong{Warning:} this calling convention is incompatible with the one
27000 normally used on Unix, so you cannot use it if you need to call
27001 libraries compiled with the Unix compiler.
27003 Also, you must provide function prototypes for all functions that
27004 take variable numbers of arguments (including @code{printf});
27005 otherwise incorrect code is generated for calls to those
27006 functions.
27008 In addition, seriously incorrect code results if you call a
27009 function with too many arguments.  (Normally, extra arguments are
27010 harmlessly ignored.)
27012 @item -mregparm=@var{num}
27013 @opindex mregparm
27014 Control how many registers are used to pass integer arguments.  By
27015 default, no registers are used to pass arguments, and at most 3
27016 registers can be used.  You can control this behavior for a specific
27017 function by using the function attribute @code{regparm}.
27018 @xref{Function Attributes}.
27020 @strong{Warning:} if you use this switch, and
27021 @var{num} is nonzero, then you must build all modules with the same
27022 value, including any libraries.  This includes the system libraries and
27023 startup modules.
27025 @item -msseregparm
27026 @opindex msseregparm
27027 Use SSE register passing conventions for float and double arguments
27028 and return values.  You can control this behavior for a specific
27029 function by using the function attribute @code{sseregparm}.
27030 @xref{Function Attributes}.
27032 @strong{Warning:} if you use this switch then you must build all
27033 modules with the same value, including any libraries.  This includes
27034 the system libraries and startup modules.
27036 @item -mvect8-ret-in-mem
27037 @opindex mvect8-ret-in-mem
27038 Return 8-byte vectors in memory instead of MMX registers.  This is the
27039 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27040 Studio compilers until version 12.  Later compiler versions (starting
27041 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27042 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27043 you need to remain compatible with existing code produced by those
27044 previous compiler versions or older versions of GCC@.
27046 @item -mpc32
27047 @itemx -mpc64
27048 @itemx -mpc80
27049 @opindex mpc32
27050 @opindex mpc64
27051 @opindex mpc80
27053 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27054 is specified, the significands of results of floating-point operations are
27055 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27056 significands of results of floating-point operations to 53 bits (double
27057 precision) and @option{-mpc80} rounds the significands of results of
27058 floating-point operations to 64 bits (extended double precision), which is
27059 the default.  When this option is used, floating-point operations in higher
27060 precisions are not available to the programmer without setting the FPU
27061 control word explicitly.
27063 Setting the rounding of floating-point operations to less than the default
27064 80 bits can speed some programs by 2% or more.  Note that some mathematical
27065 libraries assume that extended-precision (80-bit) floating-point operations
27066 are enabled by default; routines in such libraries could suffer significant
27067 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27068 when this option is used to set the precision to less than extended precision.
27070 @item -mstackrealign
27071 @opindex mstackrealign
27072 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27073 option generates an alternate prologue and epilogue that realigns the
27074 run-time stack if necessary.  This supports mixing legacy codes that keep
27075 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27076 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27077 applicable to individual functions.
27079 @item -mpreferred-stack-boundary=@var{num}
27080 @opindex mpreferred-stack-boundary
27081 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27082 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27083 the default is 4 (16 bytes or 128 bits).
27085 @strong{Warning:} When generating code for the x86-64 architecture with
27086 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27087 used to keep the stack boundary aligned to 8 byte boundary.  Since
27088 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27089 intended to be used in controlled environment where stack space is
27090 important limitation.  This option leads to wrong code when functions
27091 compiled with 16 byte stack alignment (such as functions from a standard
27092 library) are called with misaligned stack.  In this case, SSE
27093 instructions may lead to misaligned memory access traps.  In addition,
27094 variable arguments are handled incorrectly for 16 byte aligned
27095 objects (including x87 long double and __int128), leading to wrong
27096 results.  You must build all modules with
27097 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27098 includes the system libraries and startup modules.
27100 @item -mincoming-stack-boundary=@var{num}
27101 @opindex mincoming-stack-boundary
27102 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27103 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27104 the one specified by @option{-mpreferred-stack-boundary} is used.
27106 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27107 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27108 suffer significant run time performance penalties.  On Pentium III, the
27109 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27110 properly if it is not 16-byte aligned.
27112 To ensure proper alignment of this values on the stack, the stack boundary
27113 must be as aligned as that required by any value stored on the stack.
27114 Further, every function must be generated such that it keeps the stack
27115 aligned.  Thus calling a function compiled with a higher preferred
27116 stack boundary from a function compiled with a lower preferred stack
27117 boundary most likely misaligns the stack.  It is recommended that
27118 libraries that use callbacks always use the default setting.
27120 This extra alignment does consume extra stack space, and generally
27121 increases code size.  Code that is sensitive to stack space usage, such
27122 as embedded systems and operating system kernels, may want to reduce the
27123 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27125 @need 200
27126 @item -mmmx
27127 @opindex mmmx
27128 @need 200
27129 @itemx -msse
27130 @opindex msse
27131 @need 200
27132 @itemx -msse2
27133 @opindex msse2
27134 @need 200
27135 @itemx -msse3
27136 @opindex msse3
27137 @need 200
27138 @itemx -mssse3
27139 @opindex mssse3
27140 @need 200
27141 @itemx -msse4
27142 @opindex msse4
27143 @need 200
27144 @itemx -msse4a
27145 @opindex msse4a
27146 @need 200
27147 @itemx -msse4.1
27148 @opindex msse4.1
27149 @need 200
27150 @itemx -msse4.2
27151 @opindex msse4.2
27152 @need 200
27153 @itemx -mavx
27154 @opindex mavx
27155 @need 200
27156 @itemx -mavx2
27157 @opindex mavx2
27158 @need 200
27159 @itemx -mavx512f
27160 @opindex mavx512f
27161 @need 200
27162 @itemx -mavx512pf
27163 @opindex mavx512pf
27164 @need 200
27165 @itemx -mavx512er
27166 @opindex mavx512er
27167 @need 200
27168 @itemx -mavx512cd
27169 @opindex mavx512cd
27170 @need 200
27171 @itemx -mavx512vl
27172 @opindex mavx512vl
27173 @need 200
27174 @itemx -mavx512bw
27175 @opindex mavx512bw
27176 @need 200
27177 @itemx -mavx512dq
27178 @opindex mavx512dq
27179 @need 200
27180 @itemx -mavx512ifma
27181 @opindex mavx512ifma
27182 @need 200
27183 @itemx -mavx512vbmi
27184 @opindex mavx512vbmi
27185 @need 200
27186 @itemx -msha
27187 @opindex msha
27188 @need 200
27189 @itemx -maes
27190 @opindex maes
27191 @need 200
27192 @itemx -mpclmul
27193 @opindex mpclmul
27194 @need 200
27195 @itemx -mclflushopt
27196 @opindex mclflushopt
27197 @need 200
27198 @itemx -mfsgsbase
27199 @opindex mfsgsbase
27200 @need 200
27201 @itemx -mrdrnd
27202 @opindex mrdrnd
27203 @need 200
27204 @itemx -mf16c
27205 @opindex mf16c
27206 @need 200
27207 @itemx -mfma
27208 @opindex mfma
27209 @need 200
27210 @itemx -mpconfig
27211 @opindex mpconfig
27212 @need 200
27213 @itemx -mwbnoinvd
27214 @opindex mwbnoinvd
27215 @need 200
27216 @itemx -mfma4
27217 @opindex mfma4
27218 @need 200
27219 @itemx -mprefetchwt1
27220 @opindex mprefetchwt1
27221 @need 200
27222 @itemx -mxop
27223 @opindex mxop
27224 @need 200
27225 @itemx -mlwp
27226 @opindex mlwp
27227 @need 200
27228 @itemx -m3dnow
27229 @opindex m3dnow
27230 @need 200
27231 @itemx -m3dnowa
27232 @opindex m3dnowa
27233 @need 200
27234 @itemx -mpopcnt
27235 @opindex mpopcnt
27236 @need 200
27237 @itemx -mabm
27238 @opindex mabm
27239 @need 200
27240 @itemx -mbmi
27241 @opindex mbmi
27242 @need 200
27243 @itemx -mbmi2
27244 @need 200
27245 @itemx -mlzcnt
27246 @opindex mlzcnt
27247 @need 200
27248 @itemx -mfxsr
27249 @opindex mfxsr
27250 @need 200
27251 @itemx -mxsave
27252 @opindex mxsave
27253 @need 200
27254 @itemx -mxsaveopt
27255 @opindex mxsaveopt
27256 @need 200
27257 @itemx -mxsavec
27258 @opindex mxsavec
27259 @need 200
27260 @itemx -mxsaves
27261 @opindex mxsaves
27262 @need 200
27263 @itemx -mrtm
27264 @opindex mrtm
27265 @need 200
27266 @itemx -mtbm
27267 @opindex mtbm
27268 @need 200
27269 @itemx -mmpx
27270 @opindex mmpx
27271 @need 200
27272 @itemx -mmwaitx
27273 @opindex mmwaitx
27274 @need 200
27275 @itemx -mclzero
27276 @opindex mclzero
27277 @need 200
27278 @itemx -mpku
27279 @opindex mpku
27280 @need 200
27281 @itemx -mcet
27282 @opindex mcet
27283 @need 200
27284 @itemx -mavx512vbmi2
27285 @opindex mavx512vbmi2
27286 @need 200
27287 @itemx -mgfni
27288 @opindex mgfni
27289 @need 200
27290 @itemx -mvaes
27291 @opindex mvaes
27292 @need 200
27293 @itemx -mvpclmulqdq
27294 @opindex mvpclmulqdq
27295 @need 200
27296 @itemx -mavx512bitalg
27297 @opindex mavx512bitalg
27298 @need 200
27299 @itemx -mavx512vpopcntdq
27300 @opindex mavx512vpopcntdq
27301 These switches enable the use of instructions in the MMX, SSE,
27302 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27303 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27304 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
27305 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27306 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
27307 extended instruction sets.
27308 Each has a corresponding @option{-mno-} option to disable use of these
27309 instructions.
27311 These extensions are also available as built-in functions: see
27312 @ref{x86 Built-in Functions}, for details of the functions enabled and
27313 disabled by these switches.
27315 To generate SSE/SSE2 instructions automatically from floating-point
27316 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27318 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27319 generates new AVX instructions or AVX equivalence for all SSEx instructions
27320 when needed.
27322 These options enable GCC to use these extended instructions in
27323 generated code, even without @option{-mfpmath=sse}.  Applications that
27324 perform run-time CPU detection must compile separate files for each
27325 supported architecture, using the appropriate flags.  In particular,
27326 the file containing the CPU detection code should be compiled without
27327 these options.
27329 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
27330 options.  The @option{-mibt} option enables indirect branch tracking support
27331 and the @option{-mshstk} option enables shadow stack support from
27332 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
27333 a number of built-in functions for fine-grained control in a CET-based
27334 application.  See @xref{x86 Built-in Functions}, for more information.
27336 @item -mdump-tune-features
27337 @opindex mdump-tune-features
27338 This option instructs GCC to dump the names of the x86 performance 
27339 tuning features and default settings. The names can be used in 
27340 @option{-mtune-ctrl=@var{feature-list}}.
27342 @item -mtune-ctrl=@var{feature-list}
27343 @opindex mtune-ctrl=@var{feature-list}
27344 This option is used to do fine grain control of x86 code generation features.
27345 @var{feature-list} is a comma separated list of @var{feature} names. See also
27346 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27347 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27348 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27349 developers. Using it may lead to code paths not covered by testing and can
27350 potentially result in compiler ICEs or runtime errors.
27352 @item -mno-default
27353 @opindex mno-default
27354 This option instructs GCC to turn off all tunable features. See also 
27355 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27357 @item -mcld
27358 @opindex mcld
27359 This option instructs GCC to emit a @code{cld} instruction in the prologue
27360 of functions that use string instructions.  String instructions depend on
27361 the DF flag to select between autoincrement or autodecrement mode.  While the
27362 ABI specifies the DF flag to be cleared on function entry, some operating
27363 systems violate this specification by not clearing the DF flag in their
27364 exception dispatchers.  The exception handler can be invoked with the DF flag
27365 set, which leads to wrong direction mode when string instructions are used.
27366 This option can be enabled by default on 32-bit x86 targets by configuring
27367 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27368 instructions can be suppressed with the @option{-mno-cld} compiler option
27369 in this case.
27371 @item -mvzeroupper
27372 @opindex mvzeroupper
27373 This option instructs GCC to emit a @code{vzeroupper} instruction
27374 before a transfer of control flow out of the function to minimize
27375 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27376 intrinsics.
27378 @item -mprefer-avx128
27379 @opindex mprefer-avx128
27380 This option instructs GCC to use 128-bit AVX instructions instead of
27381 256-bit AVX instructions in the auto-vectorizer.
27383 @item -mprefer-vector-width=@var{opt}
27384 @opindex mprefer-vector-width
27385 This option instructs GCC to use @var{opt}-bit vector width in instructions
27386 instead of default on the selected platform.
27388 @table @samp
27389 @item none
27390 No extra limitations applied to GCC other than defined by the selected platform.
27392 @item 128
27393 Prefer 128-bit vector width for instructions.
27395 @item 256
27396 Prefer 256-bit vector width for instructions.
27398 @item 512
27399 Prefer 512-bit vector width for instructions.
27400 @end table
27402 @item -mcx16
27403 @opindex mcx16
27404 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27405 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27406 objects.  This is useful for atomic updates of data structures exceeding one
27407 machine word in size.  The compiler uses this instruction to implement
27408 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27409 128-bit integers, a library call is always used.
27411 @item -msahf
27412 @opindex msahf
27413 This option enables generation of @code{SAHF} instructions in 64-bit code.
27414 Early Intel Pentium 4 CPUs with Intel 64 support,
27415 prior to the introduction of Pentium 4 G1 step in December 2005,
27416 lacked the @code{LAHF} and @code{SAHF} instructions
27417 which are supported by AMD64.
27418 These are load and store instructions, respectively, for certain status flags.
27419 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27420 @code{drem}, and @code{remainder} built-in functions;
27421 see @ref{Other Builtins} for details.
27423 @item -mmovbe
27424 @opindex mmovbe
27425 This option enables use of the @code{movbe} instruction to implement
27426 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27428 @item -mibt
27429 @opindex mibt
27430 This option tells the compiler to use indirect branch tracking support
27431 (for indirect calls and jumps) from x86 Control-flow Enforcement
27432 Technology (CET).  The option has effect only if the
27433 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
27434 is specified. The option @option{-mibt} is on by default when the
27435 @code{-mcet} option is specified.
27437 @item -mshstk
27438 @opindex mshstk
27439 This option tells the compiler to use shadow stack support (return
27440 address tracking) from x86 Control-flow Enforcement Technology (CET).
27441 The option has effect only if the @option{-fcf-protection=full} or
27442 @option{-fcf-protection=return} option is specified.  The option
27443 @option{-mshstk} is on by default when the @option{-mcet} option is
27444 specified.
27446 @item -mcrc32
27447 @opindex mcrc32
27448 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27449 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27450 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27452 @item -mrecip
27453 @opindex mrecip
27454 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27455 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27456 with an additional Newton-Raphson step
27457 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27458 (and their vectorized
27459 variants) for single-precision floating-point arguments.  These instructions
27460 are generated only when @option{-funsafe-math-optimizations} is enabled
27461 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27462 Note that while the throughput of the sequence is higher than the throughput
27463 of the non-reciprocal instruction, the precision of the sequence can be
27464 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27466 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27467 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27468 combination), and doesn't need @option{-mrecip}.
27470 Also note that GCC emits the above sequence with additional Newton-Raphson step
27471 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27472 already with @option{-ffast-math} (or the above option combination), and
27473 doesn't need @option{-mrecip}.
27475 @item -mrecip=@var{opt}
27476 @opindex mrecip=opt
27477 This option controls which reciprocal estimate instructions
27478 may be used.  @var{opt} is a comma-separated list of options, which may
27479 be preceded by a @samp{!} to invert the option:
27481 @table @samp
27482 @item all
27483 Enable all estimate instructions.
27485 @item default
27486 Enable the default instructions, equivalent to @option{-mrecip}.
27488 @item none
27489 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27491 @item div
27492 Enable the approximation for scalar division.
27494 @item vec-div
27495 Enable the approximation for vectorized division.
27497 @item sqrt
27498 Enable the approximation for scalar square root.
27500 @item vec-sqrt
27501 Enable the approximation for vectorized square root.
27502 @end table
27504 So, for example, @option{-mrecip=all,!sqrt} enables
27505 all of the reciprocal approximations, except for square root.
27507 @item -mveclibabi=@var{type}
27508 @opindex mveclibabi
27509 Specifies the ABI type to use for vectorizing intrinsics using an
27510 external library.  Supported values for @var{type} are @samp{svml} 
27511 for the Intel short
27512 vector math library and @samp{acml} for the AMD math core library.
27513 To use this option, both @option{-ftree-vectorize} and
27514 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27515 ABI-compatible library must be specified at link time.
27517 GCC currently emits calls to @code{vmldExp2},
27518 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27519 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27520 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27521 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27522 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27523 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27524 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27525 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27526 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27527 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27528 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27529 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27530 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27531 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27532 when @option{-mveclibabi=acml} is used.  
27534 @item -mabi=@var{name}
27535 @opindex mabi
27536 Generate code for the specified calling convention.  Permissible values
27537 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27538 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27539 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27540 You can control this behavior for specific functions by
27541 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27542 @xref{Function Attributes}.
27544 @item -mforce-indirect-call
27545 @opindex mforce-indirect-call
27546 Force all calls to functions to be indirect. This is useful
27547 when using Intel Processor Trace where it generates more precise timing
27548 information for function calls.
27550 @item -mcall-ms2sysv-xlogues
27551 @opindex mcall-ms2sysv-xlogues
27552 @opindex mno-call-ms2sysv-xlogues
27553 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27554 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27555 default, the code for saving and restoring these registers is emitted inline,
27556 resulting in fairly lengthy prologues and epilogues.  Using
27557 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27558 use stubs in the static portion of libgcc to perform these saves and restores,
27559 thus reducing function size at the cost of a few extra instructions.
27561 @item -mtls-dialect=@var{type}
27562 @opindex mtls-dialect
27563 Generate code to access thread-local storage using the @samp{gnu} or
27564 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27565 @samp{gnu2} is more efficient, but it may add compile- and run-time
27566 requirements that cannot be satisfied on all systems.
27568 @item -mpush-args
27569 @itemx -mno-push-args
27570 @opindex mpush-args
27571 @opindex mno-push-args
27572 Use PUSH operations to store outgoing parameters.  This method is shorter
27573 and usually equally fast as method using SUB/MOV operations and is enabled
27574 by default.  In some cases disabling it may improve performance because of
27575 improved scheduling and reduced dependencies.
27577 @item -maccumulate-outgoing-args
27578 @opindex maccumulate-outgoing-args
27579 If enabled, the maximum amount of space required for outgoing arguments is
27580 computed in the function prologue.  This is faster on most modern CPUs
27581 because of reduced dependencies, improved scheduling and reduced stack usage
27582 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27583 increase in code size.  This switch implies @option{-mno-push-args}.
27585 @item -mthreads
27586 @opindex mthreads
27587 Support thread-safe exception handling on MinGW.  Programs that rely
27588 on thread-safe exception handling must compile and link all code with the
27589 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27590 @option{-D_MT}; when linking, it links in a special thread helper library
27591 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27593 @item -mms-bitfields
27594 @itemx -mno-ms-bitfields
27595 @opindex mms-bitfields
27596 @opindex mno-ms-bitfields
27598 Enable/disable bit-field layout compatible with the native Microsoft
27599 Windows compiler.  
27601 If @code{packed} is used on a structure, or if bit-fields are used,
27602 it may be that the Microsoft ABI lays out the structure differently
27603 than the way GCC normally does.  Particularly when moving packed
27604 data between functions compiled with GCC and the native Microsoft compiler
27605 (either via function call or as data in a file), it may be necessary to access
27606 either format.
27608 This option is enabled by default for Microsoft Windows
27609 targets.  This behavior can also be controlled locally by use of variable
27610 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27611 and @ref{x86 Type Attributes}.
27613 The Microsoft structure layout algorithm is fairly simple with the exception
27614 of the bit-field packing.  
27615 The padding and alignment of members of structures and whether a bit-field 
27616 can straddle a storage-unit boundary are determine by these rules:
27618 @enumerate
27619 @item Structure members are stored sequentially in the order in which they are
27620 declared: the first member has the lowest memory address and the last member
27621 the highest.
27623 @item Every data object has an alignment requirement.  The alignment requirement
27624 for all data except structures, unions, and arrays is either the size of the
27625 object or the current packing size (specified with either the
27626 @code{aligned} attribute or the @code{pack} pragma),
27627 whichever is less.  For structures, unions, and arrays,
27628 the alignment requirement is the largest alignment requirement of its members.
27629 Every object is allocated an offset so that:
27631 @smallexample
27632 offset % alignment_requirement == 0
27633 @end smallexample
27635 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27636 unit if the integral types are the same size and if the next bit-field fits
27637 into the current allocation unit without crossing the boundary imposed by the
27638 common alignment requirements of the bit-fields.
27639 @end enumerate
27641 MSVC interprets zero-length bit-fields in the following ways:
27643 @enumerate
27644 @item If a zero-length bit-field is inserted between two bit-fields that
27645 are normally coalesced, the bit-fields are not coalesced.
27647 For example:
27649 @smallexample
27650 struct
27651  @{
27652    unsigned long bf_1 : 12;
27653    unsigned long : 0;
27654    unsigned long bf_2 : 12;
27655  @} t1;
27656 @end smallexample
27658 @noindent
27659 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27660 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27662 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27663 alignment of the zero-length bit-field is greater than the member that follows it,
27664 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27666 For example:
27668 @smallexample
27669 struct
27670  @{
27671    char foo : 4;
27672    short : 0;
27673    char bar;
27674  @} t2;
27676 struct
27677  @{
27678    char foo : 4;
27679    short : 0;
27680    double bar;
27681  @} t3;
27682 @end smallexample
27684 @noindent
27685 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27686 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27687 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27688 of the structure.
27690 Taking this into account, it is important to note the following:
27692 @enumerate
27693 @item If a zero-length bit-field follows a normal bit-field, the type of the
27694 zero-length bit-field may affect the alignment of the structure as whole. For
27695 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27696 normal bit-field, and is of type short.
27698 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27699 still affect the alignment of the structure:
27701 @smallexample
27702 struct
27703  @{
27704    char foo : 6;
27705    long : 0;
27706  @} t4;
27707 @end smallexample
27709 @noindent
27710 Here, @code{t4} takes up 4 bytes.
27711 @end enumerate
27713 @item Zero-length bit-fields following non-bit-field members are ignored:
27715 @smallexample
27716 struct
27717  @{
27718    char foo;
27719    long : 0;
27720    char bar;
27721  @} t5;
27722 @end smallexample
27724 @noindent
27725 Here, @code{t5} takes up 2 bytes.
27726 @end enumerate
27729 @item -mno-align-stringops
27730 @opindex mno-align-stringops
27731 Do not align the destination of inlined string operations.  This switch reduces
27732 code size and improves performance in case the destination is already aligned,
27733 but GCC doesn't know about it.
27735 @item -minline-all-stringops
27736 @opindex minline-all-stringops
27737 By default GCC inlines string operations only when the destination is 
27738 known to be aligned to least a 4-byte boundary.  
27739 This enables more inlining and increases code
27740 size, but may improve performance of code that depends on fast
27741 @code{memcpy}, @code{strlen},
27742 and @code{memset} for short lengths.
27744 @item -minline-stringops-dynamically
27745 @opindex minline-stringops-dynamically
27746 For string operations of unknown size, use run-time checks with
27747 inline code for small blocks and a library call for large blocks.
27749 @item -mstringop-strategy=@var{alg}
27750 @opindex mstringop-strategy=@var{alg}
27751 Override the internal decision heuristic for the particular algorithm to use
27752 for inlining string operations.  The allowed values for @var{alg} are:
27754 @table @samp
27755 @item rep_byte
27756 @itemx rep_4byte
27757 @itemx rep_8byte
27758 Expand using i386 @code{rep} prefix of the specified size.
27760 @item byte_loop
27761 @itemx loop
27762 @itemx unrolled_loop
27763 Expand into an inline loop.
27765 @item libcall
27766 Always use a library call.
27767 @end table
27769 @item -mmemcpy-strategy=@var{strategy}
27770 @opindex mmemcpy-strategy=@var{strategy}
27771 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27772 should be inlined and what inline algorithm to use when the expected size
27773 of the copy operation is known. @var{strategy} 
27774 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27775 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27776 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27777 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27778 in the list must be specified in increasing order.  The minimal byte size for 
27779 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27780 preceding range.
27782 @item -mmemset-strategy=@var{strategy}
27783 @opindex mmemset-strategy=@var{strategy}
27784 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27785 @code{__builtin_memset} expansion.
27787 @item -momit-leaf-frame-pointer
27788 @opindex momit-leaf-frame-pointer
27789 Don't keep the frame pointer in a register for leaf functions.  This
27790 avoids the instructions to save, set up, and restore frame pointers and
27791 makes an extra register available in leaf functions.  The option
27792 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27793 which might make debugging harder.
27795 @item -mtls-direct-seg-refs
27796 @itemx -mno-tls-direct-seg-refs
27797 @opindex mtls-direct-seg-refs
27798 Controls whether TLS variables may be accessed with offsets from the
27799 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27800 or whether the thread base pointer must be added.  Whether or not this
27801 is valid depends on the operating system, and whether it maps the
27802 segment to cover the entire TLS area.
27804 For systems that use the GNU C Library, the default is on.
27806 @item -msse2avx
27807 @itemx -mno-sse2avx
27808 @opindex msse2avx
27809 Specify that the assembler should encode SSE instructions with VEX
27810 prefix.  The option @option{-mavx} turns this on by default.
27812 @item -mfentry
27813 @itemx -mno-fentry
27814 @opindex mfentry
27815 If profiling is active (@option{-pg}), put the profiling
27816 counter call before the prologue.
27817 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27818 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27820 @item -mrecord-mcount
27821 @itemx -mno-record-mcount
27822 @opindex mrecord-mcount
27823 If profiling is active (@option{-pg}), generate a __mcount_loc section
27824 that contains pointers to each profiling call. This is useful for
27825 automatically patching and out calls.
27827 @item -mnop-mcount
27828 @itemx -mno-nop-mcount
27829 @opindex mnop-mcount
27830 If profiling is active (@option{-pg}), generate the calls to
27831 the profiling functions as NOPs. This is useful when they
27832 should be patched in later dynamically. This is likely only
27833 useful together with @option{-mrecord-mcount}.
27835 @item -mskip-rax-setup
27836 @itemx -mno-skip-rax-setup
27837 @opindex mskip-rax-setup
27838 When generating code for the x86-64 architecture with SSE extensions
27839 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27840 register when there are no variable arguments passed in vector registers.
27842 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27843 saving vector registers on stack when passing variable arguments, the
27844 impacts of this option are callees may waste some stack space,
27845 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27846 those issues, regardless the RAX register value.
27848 @item -m8bit-idiv
27849 @itemx -mno-8bit-idiv
27850 @opindex m8bit-idiv
27851 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27852 much faster than 32-bit/64-bit integer divide.  This option generates a
27853 run-time check.  If both dividend and divisor are within range of 0
27854 to 255, 8-bit unsigned integer divide is used instead of
27855 32-bit/64-bit integer divide.
27857 @item -mavx256-split-unaligned-load
27858 @itemx -mavx256-split-unaligned-store
27859 @opindex mavx256-split-unaligned-load
27860 @opindex mavx256-split-unaligned-store
27861 Split 32-byte AVX unaligned load and store.
27863 @item -mstack-protector-guard=@var{guard}
27864 @itemx -mstack-protector-guard-reg=@var{reg}
27865 @itemx -mstack-protector-guard-offset=@var{offset}
27866 @opindex mstack-protector-guard
27867 @opindex mstack-protector-guard-reg
27868 @opindex mstack-protector-guard-offset
27869 Generate stack protection code using canary at @var{guard}.  Supported
27870 locations are @samp{global} for global canary or @samp{tls} for per-thread
27871 canary in the TLS block (the default).  This option has effect only when
27872 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27874 With the latter choice the options
27875 @option{-mstack-protector-guard-reg=@var{reg}} and
27876 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27877 which segment register (@code{%fs} or @code{%gs}) to use as base register
27878 for reading the canary, and from what offset from that base register.
27879 The default for those is as specified in the relevant ABI.
27881 @item -mmitigate-rop
27882 @opindex mmitigate-rop
27883 Try to avoid generating code sequences that contain unintended return
27884 opcodes, to mitigate against certain forms of attack. At the moment,
27885 this option is limited in what it can do and should not be relied
27886 on to provide serious protection.
27888 @item -mgeneral-regs-only
27889 @opindex mgeneral-regs-only
27890 Generate code that uses only the general-purpose registers.  This
27891 prevents the compiler from using floating-point, vector, mask and bound
27892 registers.
27894 @item -mindirect-branch=@var{choice}
27895 @opindex -mindirect-branch
27896 Convert indirect call and jump with @var{choice}.  The default is
27897 @samp{keep}, which keeps indirect call and jump unmodified.
27898 @samp{thunk} converts indirect call and jump to call and return thunk.
27899 @samp{thunk-inline} converts indirect call and jump to inlined call
27900 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27901 to external call and return thunk provided in a separate object file.
27902 You can control this behavior for a specific function by using the
27903 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27905 Note that @option{-mcmodel=large} is incompatible with
27906 @option{-mindirect-branch=thunk} and
27907 @option{-mindirect-branch=thunk-extern} since the thunk function may
27908 not be reachable in the large code model.
27910 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27911 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27912 since the external thunk can not be modified to disable control-flow
27913 check.
27915 @item -mfunction-return=@var{choice}
27916 @opindex -mfunction-return
27917 Convert function return with @var{choice}.  The default is @samp{keep},
27918 which keeps function return unmodified.  @samp{thunk} converts function
27919 return to call and return thunk.  @samp{thunk-inline} converts function
27920 return to inlined call and return thunk.  @samp{thunk-extern} converts
27921 function return to external call and return thunk provided in a separate
27922 object file.  You can control this behavior for a specific function by
27923 using the function attribute @code{function_return}.
27924 @xref{Function Attributes}.
27926 Note that @option{-mcmodel=large} is incompatible with
27927 @option{-mfunction-return=thunk} and
27928 @option{-mfunction-return=thunk-extern} since the thunk function may
27929 not be reachable in the large code model.
27932 @item -mindirect-branch-register
27933 @opindex -mindirect-branch-register
27934 Force indirect call and jump via register.
27936 @end table
27938 These @samp{-m} switches are supported in addition to the above
27939 on x86-64 processors in 64-bit environments.
27941 @table @gcctabopt
27942 @item -m32
27943 @itemx -m64
27944 @itemx -mx32
27945 @itemx -m16
27946 @itemx -miamcu
27947 @opindex m32
27948 @opindex m64
27949 @opindex mx32
27950 @opindex m16
27951 @opindex miamcu
27952 Generate code for a 16-bit, 32-bit or 64-bit environment.
27953 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27954 to 32 bits, and
27955 generates code that runs on any i386 system.
27957 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27958 types to 64 bits, and generates code for the x86-64 architecture.
27959 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27960 and @option{-mdynamic-no-pic} options.
27962 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27963 to 32 bits, and
27964 generates code for the x86-64 architecture.
27966 The @option{-m16} option is the same as @option{-m32}, except for that
27967 it outputs the @code{.code16gcc} assembly directive at the beginning of
27968 the assembly output so that the binary can run in 16-bit mode.
27970 The @option{-miamcu} option generates code which conforms to Intel MCU
27971 psABI.  It requires the @option{-m32} option to be turned on.
27973 @item -mno-red-zone
27974 @opindex mno-red-zone
27975 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27976 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27977 stack pointer that is not modified by signal or interrupt handlers
27978 and therefore can be used for temporary data without adjusting the stack
27979 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27981 @item -mcmodel=small
27982 @opindex mcmodel=small
27983 Generate code for the small code model: the program and its symbols must
27984 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27985 Programs can be statically or dynamically linked.  This is the default
27986 code model.
27988 @item -mcmodel=kernel
27989 @opindex mcmodel=kernel
27990 Generate code for the kernel code model.  The kernel runs in the
27991 negative 2 GB of the address space.
27992 This model has to be used for Linux kernel code.
27994 @item -mcmodel=medium
27995 @opindex mcmodel=medium
27996 Generate code for the medium model: the program is linked in the lower 2
27997 GB of the address space.  Small symbols are also placed there.  Symbols
27998 with sizes larger than @option{-mlarge-data-threshold} are put into
27999 large data or BSS sections and can be located above 2GB.  Programs can
28000 be statically or dynamically linked.
28002 @item -mcmodel=large
28003 @opindex mcmodel=large
28004 Generate code for the large model.  This model makes no assumptions
28005 about addresses and sizes of sections.
28007 @item -maddress-mode=long
28008 @opindex maddress-mode=long
28009 Generate code for long address mode.  This is only supported for 64-bit
28010 and x32 environments.  It is the default address mode for 64-bit
28011 environments.
28013 @item -maddress-mode=short
28014 @opindex maddress-mode=short
28015 Generate code for short address mode.  This is only supported for 32-bit
28016 and x32 environments.  It is the default address mode for 32-bit and
28017 x32 environments.
28018 @end table
28020 @node x86 Windows Options
28021 @subsection x86 Windows Options
28022 @cindex x86 Windows Options
28023 @cindex Windows Options for x86
28025 These additional options are available for Microsoft Windows targets:
28027 @table @gcctabopt
28028 @item -mconsole
28029 @opindex mconsole
28030 This option
28031 specifies that a console application is to be generated, by
28032 instructing the linker to set the PE header subsystem type
28033 required for console applications.
28034 This option is available for Cygwin and MinGW targets and is
28035 enabled by default on those targets.
28037 @item -mdll
28038 @opindex mdll
28039 This option is available for Cygwin and MinGW targets.  It
28040 specifies that a DLL---a dynamic link library---is to be
28041 generated, enabling the selection of the required runtime
28042 startup object and entry point.
28044 @item -mnop-fun-dllimport
28045 @opindex mnop-fun-dllimport
28046 This option is available for Cygwin and MinGW targets.  It
28047 specifies that the @code{dllimport} attribute should be ignored.
28049 @item -mthread
28050 @opindex mthread
28051 This option is available for MinGW targets. It specifies
28052 that MinGW-specific thread support is to be used.
28054 @item -municode
28055 @opindex municode
28056 This option is available for MinGW-w64 targets.  It causes
28057 the @code{UNICODE} preprocessor macro to be predefined, and
28058 chooses Unicode-capable runtime startup code.
28060 @item -mwin32
28061 @opindex mwin32
28062 This option is available for Cygwin and MinGW targets.  It
28063 specifies that the typical Microsoft Windows predefined macros are to
28064 be set in the pre-processor, but does not influence the choice
28065 of runtime library/startup code.
28067 @item -mwindows
28068 @opindex mwindows
28069 This option is available for Cygwin and MinGW targets.  It
28070 specifies that a GUI application is to be generated by
28071 instructing the linker to set the PE header subsystem type
28072 appropriately.
28074 @item -fno-set-stack-executable
28075 @opindex fno-set-stack-executable
28076 This option is available for MinGW targets. It specifies that
28077 the executable flag for the stack used by nested functions isn't
28078 set. This is necessary for binaries running in kernel mode of
28079 Microsoft Windows, as there the User32 API, which is used to set executable
28080 privileges, isn't available.
28082 @item -fwritable-relocated-rdata
28083 @opindex fno-writable-relocated-rdata
28084 This option is available for MinGW and Cygwin targets.  It specifies
28085 that relocated-data in read-only section is put into the @code{.data}
28086 section.  This is a necessary for older runtimes not supporting
28087 modification of @code{.rdata} sections for pseudo-relocation.
28089 @item -mpe-aligned-commons
28090 @opindex mpe-aligned-commons
28091 This option is available for Cygwin and MinGW targets.  It
28092 specifies that the GNU extension to the PE file format that
28093 permits the correct alignment of COMMON variables should be
28094 used when generating code.  It is enabled by default if
28095 GCC detects that the target assembler found during configuration
28096 supports the feature.
28097 @end table
28099 See also under @ref{x86 Options} for standard options.
28101 @node Xstormy16 Options
28102 @subsection Xstormy16 Options
28103 @cindex Xstormy16 Options
28105 These options are defined for Xstormy16:
28107 @table @gcctabopt
28108 @item -msim
28109 @opindex msim
28110 Choose startup files and linker script suitable for the simulator.
28111 @end table
28113 @node Xtensa Options
28114 @subsection Xtensa Options
28115 @cindex Xtensa Options
28117 These options are supported for Xtensa targets:
28119 @table @gcctabopt
28120 @item -mconst16
28121 @itemx -mno-const16
28122 @opindex mconst16
28123 @opindex mno-const16
28124 Enable or disable use of @code{CONST16} instructions for loading
28125 constant values.  The @code{CONST16} instruction is currently not a
28126 standard option from Tensilica.  When enabled, @code{CONST16}
28127 instructions are always used in place of the standard @code{L32R}
28128 instructions.  The use of @code{CONST16} is enabled by default only if
28129 the @code{L32R} instruction is not available.
28131 @item -mfused-madd
28132 @itemx -mno-fused-madd
28133 @opindex mfused-madd
28134 @opindex mno-fused-madd
28135 Enable or disable use of fused multiply/add and multiply/subtract
28136 instructions in the floating-point option.  This has no effect if the
28137 floating-point option is not also enabled.  Disabling fused multiply/add
28138 and multiply/subtract instructions forces the compiler to use separate
28139 instructions for the multiply and add/subtract operations.  This may be
28140 desirable in some cases where strict IEEE 754-compliant results are
28141 required: the fused multiply add/subtract instructions do not round the
28142 intermediate result, thereby producing results with @emph{more} bits of
28143 precision than specified by the IEEE standard.  Disabling fused multiply
28144 add/subtract instructions also ensures that the program output is not
28145 sensitive to the compiler's ability to combine multiply and add/subtract
28146 operations.
28148 @item -mserialize-volatile
28149 @itemx -mno-serialize-volatile
28150 @opindex mserialize-volatile
28151 @opindex mno-serialize-volatile
28152 When this option is enabled, GCC inserts @code{MEMW} instructions before
28153 @code{volatile} memory references to guarantee sequential consistency.
28154 The default is @option{-mserialize-volatile}.  Use
28155 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28157 @item -mforce-no-pic
28158 @opindex mforce-no-pic
28159 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28160 position-independent code (PIC), this option disables PIC for compiling
28161 kernel code.
28163 @item -mtext-section-literals
28164 @itemx -mno-text-section-literals
28165 @opindex mtext-section-literals
28166 @opindex mno-text-section-literals
28167 These options control the treatment of literal pools.  The default is
28168 @option{-mno-text-section-literals}, which places literals in a separate
28169 section in the output file.  This allows the literal pool to be placed
28170 in a data RAM/ROM, and it also allows the linker to combine literal
28171 pools from separate object files to remove redundant literals and
28172 improve code size.  With @option{-mtext-section-literals}, the literals
28173 are interspersed in the text section in order to keep them as close as
28174 possible to their references.  This may be necessary for large assembly
28175 files.  Literals for each function are placed right before that function.
28177 @item -mauto-litpools
28178 @itemx -mno-auto-litpools
28179 @opindex mauto-litpools
28180 @opindex mno-auto-litpools
28181 These options control the treatment of literal pools.  The default is
28182 @option{-mno-auto-litpools}, which places literals in a separate
28183 section in the output file unless @option{-mtext-section-literals} is
28184 used.  With @option{-mauto-litpools} the literals are interspersed in
28185 the text section by the assembler.  Compiler does not produce explicit
28186 @code{.literal} directives and loads literals into registers with
28187 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28188 do relaxation and place literals as necessary.  This option allows
28189 assembler to create several literal pools per function and assemble
28190 very big functions, which may not be possible with
28191 @option{-mtext-section-literals}.
28193 @item -mtarget-align
28194 @itemx -mno-target-align
28195 @opindex mtarget-align
28196 @opindex mno-target-align
28197 When this option is enabled, GCC instructs the assembler to
28198 automatically align instructions to reduce branch penalties at the
28199 expense of some code density.  The assembler attempts to widen density
28200 instructions to align branch targets and the instructions following call
28201 instructions.  If there are not enough preceding safe density
28202 instructions to align a target, no widening is performed.  The
28203 default is @option{-mtarget-align}.  These options do not affect the
28204 treatment of auto-aligned instructions like @code{LOOP}, which the
28205 assembler always aligns, either by widening density instructions or
28206 by inserting NOP instructions.
28208 @item -mlongcalls
28209 @itemx -mno-longcalls
28210 @opindex mlongcalls
28211 @opindex mno-longcalls
28212 When this option is enabled, GCC instructs the assembler to translate
28213 direct calls to indirect calls unless it can determine that the target
28214 of a direct call is in the range allowed by the call instruction.  This
28215 translation typically occurs for calls to functions in other source
28216 files.  Specifically, the assembler translates a direct @code{CALL}
28217 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28218 The default is @option{-mno-longcalls}.  This option should be used in
28219 programs where the call target can potentially be out of range.  This
28220 option is implemented in the assembler, not the compiler, so the
28221 assembly code generated by GCC still shows direct call
28222 instructions---look at the disassembled object code to see the actual
28223 instructions.  Note that the assembler uses an indirect call for
28224 every cross-file call, not just those that really are out of range.
28225 @end table
28227 @node zSeries Options
28228 @subsection zSeries Options
28229 @cindex zSeries options
28231 These are listed under @xref{S/390 and zSeries Options}.
28234 @c man end
28236 @node Spec Files
28237 @section Specifying Subprocesses and the Switches to Pass to Them
28238 @cindex Spec Files
28240 @command{gcc} is a driver program.  It performs its job by invoking a
28241 sequence of other programs to do the work of compiling, assembling and
28242 linking.  GCC interprets its command-line parameters and uses these to
28243 deduce which programs it should invoke, and which command-line options
28244 it ought to place on their command lines.  This behavior is controlled
28245 by @dfn{spec strings}.  In most cases there is one spec string for each
28246 program that GCC can invoke, but a few programs have multiple spec
28247 strings to control their behavior.  The spec strings built into GCC can
28248 be overridden by using the @option{-specs=} command-line switch to specify
28249 a spec file.
28251 @dfn{Spec files} are plain-text files that are used to construct spec
28252 strings.  They consist of a sequence of directives separated by blank
28253 lines.  The type of directive is determined by the first non-whitespace
28254 character on the line, which can be one of the following:
28256 @table @code
28257 @item %@var{command}
28258 Issues a @var{command} to the spec file processor.  The commands that can
28259 appear here are:
28261 @table @code
28262 @item %include <@var{file}>
28263 @cindex @code{%include}
28264 Search for @var{file} and insert its text at the current point in the
28265 specs file.
28267 @item %include_noerr <@var{file}>
28268 @cindex @code{%include_noerr}
28269 Just like @samp{%include}, but do not generate an error message if the include
28270 file cannot be found.
28272 @item %rename @var{old_name} @var{new_name}
28273 @cindex @code{%rename}
28274 Rename the spec string @var{old_name} to @var{new_name}.
28276 @end table
28278 @item *[@var{spec_name}]:
28279 This tells the compiler to create, override or delete the named spec
28280 string.  All lines after this directive up to the next directive or
28281 blank line are considered to be the text for the spec string.  If this
28282 results in an empty string then the spec is deleted.  (Or, if the
28283 spec did not exist, then nothing happens.)  Otherwise, if the spec
28284 does not currently exist a new spec is created.  If the spec does
28285 exist then its contents are overridden by the text of this
28286 directive, unless the first character of that text is the @samp{+}
28287 character, in which case the text is appended to the spec.
28289 @item [@var{suffix}]:
28290 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28291 and up to the next directive or blank line are considered to make up the
28292 spec string for the indicated suffix.  When the compiler encounters an
28293 input file with the named suffix, it processes the spec string in
28294 order to work out how to compile that file.  For example:
28296 @smallexample
28297 .ZZ:
28298 z-compile -input %i
28299 @end smallexample
28301 This says that any input file whose name ends in @samp{.ZZ} should be
28302 passed to the program @samp{z-compile}, which should be invoked with the
28303 command-line switch @option{-input} and with the result of performing the
28304 @samp{%i} substitution.  (See below.)
28306 As an alternative to providing a spec string, the text following a
28307 suffix directive can be one of the following:
28309 @table @code
28310 @item @@@var{language}
28311 This says that the suffix is an alias for a known @var{language}.  This is
28312 similar to using the @option{-x} command-line switch to GCC to specify a
28313 language explicitly.  For example:
28315 @smallexample
28316 .ZZ:
28317 @@c++
28318 @end smallexample
28320 Says that .ZZ files are, in fact, C++ source files.
28322 @item #@var{name}
28323 This causes an error messages saying:
28325 @smallexample
28326 @var{name} compiler not installed on this system.
28327 @end smallexample
28328 @end table
28330 GCC already has an extensive list of suffixes built into it.
28331 This directive adds an entry to the end of the list of suffixes, but
28332 since the list is searched from the end backwards, it is effectively
28333 possible to override earlier entries using this technique.
28335 @end table
28337 GCC has the following spec strings built into it.  Spec files can
28338 override these strings or create their own.  Note that individual
28339 targets can also add their own spec strings to this list.
28341 @smallexample
28342 asm          Options to pass to the assembler
28343 asm_final    Options to pass to the assembler post-processor
28344 cpp          Options to pass to the C preprocessor
28345 cc1          Options to pass to the C compiler
28346 cc1plus      Options to pass to the C++ compiler
28347 endfile      Object files to include at the end of the link
28348 link         Options to pass to the linker
28349 lib          Libraries to include on the command line to the linker
28350 libgcc       Decides which GCC support library to pass to the linker
28351 linker       Sets the name of the linker
28352 predefines   Defines to be passed to the C preprocessor
28353 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28354              by default
28355 startfile    Object files to include at the start of the link
28356 @end smallexample
28358 Here is a small example of a spec file:
28360 @smallexample
28361 %rename lib                 old_lib
28363 *lib:
28364 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28365 @end smallexample
28367 This example renames the spec called @samp{lib} to @samp{old_lib} and
28368 then overrides the previous definition of @samp{lib} with a new one.
28369 The new definition adds in some extra command-line options before
28370 including the text of the old definition.
28372 @dfn{Spec strings} are a list of command-line options to be passed to their
28373 corresponding program.  In addition, the spec strings can contain
28374 @samp{%}-prefixed sequences to substitute variable text or to
28375 conditionally insert text into the command line.  Using these constructs
28376 it is possible to generate quite complex command lines.
28378 Here is a table of all defined @samp{%}-sequences for spec
28379 strings.  Note that spaces are not generated automatically around the
28380 results of expanding these sequences.  Therefore you can concatenate them
28381 together or combine them with constant text in a single argument.
28383 @table @code
28384 @item %%
28385 Substitute one @samp{%} into the program name or argument.
28387 @item %i
28388 Substitute the name of the input file being processed.
28390 @item %b
28391 Substitute the basename of the input file being processed.
28392 This is the substring up to (and not including) the last period
28393 and not including the directory.
28395 @item %B
28396 This is the same as @samp{%b}, but include the file suffix (text after
28397 the last period).
28399 @item %d
28400 Marks the argument containing or following the @samp{%d} as a
28401 temporary file name, so that that file is deleted if GCC exits
28402 successfully.  Unlike @samp{%g}, this contributes no text to the
28403 argument.
28405 @item %g@var{suffix}
28406 Substitute a file name that has suffix @var{suffix} and is chosen
28407 once per compilation, and mark the argument in the same way as
28408 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28409 name is now chosen in a way that is hard to predict even when previously
28410 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28411 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28412 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28413 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28414 was simply substituted with a file name chosen once per compilation,
28415 without regard to any appended suffix (which was therefore treated
28416 just like ordinary text), making such attacks more likely to succeed.
28418 @item %u@var{suffix}
28419 Like @samp{%g}, but generates a new temporary file name
28420 each time it appears instead of once per compilation.
28422 @item %U@var{suffix}
28423 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28424 new one if there is no such last file name.  In the absence of any
28425 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28426 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28427 involves the generation of two distinct file names, one
28428 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28429 simply substituted with a file name chosen for the previous @samp{%u},
28430 without regard to any appended suffix.
28432 @item %j@var{suffix}
28433 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28434 writable, and if @option{-save-temps} is not used; 
28435 otherwise, substitute the name
28436 of a temporary file, just like @samp{%u}.  This temporary file is not
28437 meant for communication between processes, but rather as a junk
28438 disposal mechanism.
28440 @item %|@var{suffix}
28441 @itemx %m@var{suffix}
28442 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28443 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28444 all.  These are the two most common ways to instruct a program that it
28445 should read from standard input or write to standard output.  If you
28446 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28447 construct: see for example @file{f/lang-specs.h}.
28449 @item %.@var{SUFFIX}
28450 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28451 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28452 terminated by the next space or %.
28454 @item %w
28455 Marks the argument containing or following the @samp{%w} as the
28456 designated output file of this compilation.  This puts the argument
28457 into the sequence of arguments that @samp{%o} substitutes.
28459 @item %o
28460 Substitutes the names of all the output files, with spaces
28461 automatically placed around them.  You should write spaces
28462 around the @samp{%o} as well or the results are undefined.
28463 @samp{%o} is for use in the specs for running the linker.
28464 Input files whose names have no recognized suffix are not compiled
28465 at all, but they are included among the output files, so they are
28466 linked.
28468 @item %O
28469 Substitutes the suffix for object files.  Note that this is
28470 handled specially when it immediately follows @samp{%g, %u, or %U},
28471 because of the need for those to form complete file names.  The
28472 handling is such that @samp{%O} is treated exactly as if it had already
28473 been substituted, except that @samp{%g, %u, and %U} do not currently
28474 support additional @var{suffix} characters following @samp{%O} as they do
28475 following, for example, @samp{.o}.
28477 @item %p
28478 Substitutes the standard macro predefinitions for the
28479 current target machine.  Use this when running @command{cpp}.
28481 @item %P
28482 Like @samp{%p}, but puts @samp{__} before and after the name of each
28483 predefined macro, except for macros that start with @samp{__} or with
28484 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28487 @item %I
28488 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28489 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28490 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28491 and @option{-imultilib} as necessary.
28493 @item %s
28494 Current argument is the name of a library or startup file of some sort.
28495 Search for that file in a standard list of directories and substitute
28496 the full name found.  The current working directory is included in the
28497 list of directories scanned.
28499 @item %T
28500 Current argument is the name of a linker script.  Search for that file
28501 in the current list of directories to scan for libraries. If the file
28502 is located insert a @option{--script} option into the command line
28503 followed by the full path name found.  If the file is not found then
28504 generate an error message.  Note: the current working directory is not
28505 searched.
28507 @item %e@var{str}
28508 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28509 Use this when inconsistent options are detected.
28511 @item %(@var{name})
28512 Substitute the contents of spec string @var{name} at this point.
28514 @item %x@{@var{option}@}
28515 Accumulate an option for @samp{%X}.
28517 @item %X
28518 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28519 spec string.
28521 @item %Y
28522 Output the accumulated assembler options specified by @option{-Wa}.
28524 @item %Z
28525 Output the accumulated preprocessor options specified by @option{-Wp}.
28527 @item %a
28528 Process the @code{asm} spec.  This is used to compute the
28529 switches to be passed to the assembler.
28531 @item %A
28532 Process the @code{asm_final} spec.  This is a spec string for
28533 passing switches to an assembler post-processor, if such a program is
28534 needed.
28536 @item %l
28537 Process the @code{link} spec.  This is the spec for computing the
28538 command line passed to the linker.  Typically it makes use of the
28539 @samp{%L %G %S %D and %E} sequences.
28541 @item %D
28542 Dump out a @option{-L} option for each directory that GCC believes might
28543 contain startup files.  If the target supports multilibs then the
28544 current multilib directory is prepended to each of these paths.
28546 @item %L
28547 Process the @code{lib} spec.  This is a spec string for deciding which
28548 libraries are included on the command line to the linker.
28550 @item %G
28551 Process the @code{libgcc} spec.  This is a spec string for deciding
28552 which GCC support library is included on the command line to the linker.
28554 @item %S
28555 Process the @code{startfile} spec.  This is a spec for deciding which
28556 object files are the first ones passed to the linker.  Typically
28557 this might be a file named @file{crt0.o}.
28559 @item %E
28560 Process the @code{endfile} spec.  This is a spec string that specifies
28561 the last object files that are passed to the linker.
28563 @item %C
28564 Process the @code{cpp} spec.  This is used to construct the arguments
28565 to be passed to the C preprocessor.
28567 @item %1
28568 Process the @code{cc1} spec.  This is used to construct the options to be
28569 passed to the actual C compiler (@command{cc1}).
28571 @item %2
28572 Process the @code{cc1plus} spec.  This is used to construct the options to be
28573 passed to the actual C++ compiler (@command{cc1plus}).
28575 @item %*
28576 Substitute the variable part of a matched option.  See below.
28577 Note that each comma in the substituted string is replaced by
28578 a single space.
28580 @item %<S
28581 Remove all occurrences of @code{-S} from the command line.  Note---this
28582 command is position dependent.  @samp{%} commands in the spec string
28583 before this one see @code{-S}, @samp{%} commands in the spec string
28584 after this one do not.
28586 @item %:@var{function}(@var{args})
28587 Call the named function @var{function}, passing it @var{args}.
28588 @var{args} is first processed as a nested spec string, then split
28589 into an argument vector in the usual fashion.  The function returns
28590 a string which is processed as if it had appeared literally as part
28591 of the current spec.
28593 The following built-in spec functions are provided:
28595 @table @code
28596 @item @code{getenv}
28597 The @code{getenv} spec function takes two arguments: an environment
28598 variable name and a string.  If the environment variable is not
28599 defined, a fatal error is issued.  Otherwise, the return value is the
28600 value of the environment variable concatenated with the string.  For
28601 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28603 @smallexample
28604 %:getenv(TOPDIR /include)
28605 @end smallexample
28607 expands to @file{/path/to/top/include}.
28609 @item @code{if-exists}
28610 The @code{if-exists} spec function takes one argument, an absolute
28611 pathname to a file.  If the file exists, @code{if-exists} returns the
28612 pathname.  Here is a small example of its usage:
28614 @smallexample
28615 *startfile:
28616 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28617 @end smallexample
28619 @item @code{if-exists-else}
28620 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28621 spec function, except that it takes two arguments.  The first argument is
28622 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28623 returns the pathname.  If it does not exist, it returns the second argument.
28624 This way, @code{if-exists-else} can be used to select one file or another,
28625 based on the existence of the first.  Here is a small example of its usage:
28627 @smallexample
28628 *startfile:
28629 crt0%O%s %:if-exists(crti%O%s) \
28630 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28631 @end smallexample
28633 @item @code{replace-outfile}
28634 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28635 first argument in the outfiles array and replaces it with the second argument.  Here
28636 is a small example of its usage:
28638 @smallexample
28639 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28640 @end smallexample
28642 @item @code{remove-outfile}
28643 The @code{remove-outfile} spec function takes one argument.  It looks for the
28644 first argument in the outfiles array and removes it.  Here is a small example
28645 its usage:
28647 @smallexample
28648 %:remove-outfile(-lm)
28649 @end smallexample
28651 @item @code{pass-through-libs}
28652 The @code{pass-through-libs} spec function takes any number of arguments.  It
28653 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28654 assumes are the names of linker input library archive files) and returns a
28655 result containing all the found arguments each prepended by
28656 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28657 intended to be passed to the LTO linker plugin.
28659 @smallexample
28660 %:pass-through-libs(%G %L %G)
28661 @end smallexample
28663 @item @code{print-asm-header}
28664 The @code{print-asm-header} function takes no arguments and simply
28665 prints a banner like:
28667 @smallexample
28668 Assembler options
28669 =================
28671 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28672 @end smallexample
28674 It is used to separate compiler options from assembler options
28675 in the @option{--target-help} output.
28676 @end table
28678 @item %@{S@}
28679 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28680 If that switch is not specified, this substitutes nothing.  Note that
28681 the leading dash is omitted when specifying this option, and it is
28682 automatically inserted if the substitution is performed.  Thus the spec
28683 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28684 and outputs the command-line option @option{-foo}.
28686 @item %W@{S@}
28687 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28688 deleted on failure.
28690 @item %@{S*@}
28691 Substitutes all the switches specified to GCC whose names start
28692 with @code{-S}, but which also take an argument.  This is used for
28693 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28694 GCC considers @option{-o foo} as being
28695 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28696 text, including the space.  Thus two arguments are generated.
28698 @item %@{S*&T*@}
28699 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28700 (the order of @code{S} and @code{T} in the spec is not significant).
28701 There can be any number of ampersand-separated variables; for each the
28702 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28704 @item %@{S:X@}
28705 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28707 @item %@{!S:X@}
28708 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28710 @item %@{S*:X@}
28711 Substitutes @code{X} if one or more switches whose names start with
28712 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28713 once, no matter how many such switches appeared.  However, if @code{%*}
28714 appears somewhere in @code{X}, then @code{X} is substituted once
28715 for each matching switch, with the @code{%*} replaced by the part of
28716 that switch matching the @code{*}.
28718 If @code{%*} appears as the last part of a spec sequence then a space
28719 is added after the end of the last substitution.  If there is more
28720 text in the sequence, however, then a space is not generated.  This
28721 allows the @code{%*} substitution to be used as part of a larger
28722 string.  For example, a spec string like this:
28724 @smallexample
28725 %@{mcu=*:--script=%*/memory.ld@}
28726 @end smallexample
28728 @noindent
28729 when matching an option like @option{-mcu=newchip} produces:
28731 @smallexample
28732 --script=newchip/memory.ld
28733 @end smallexample
28735 @item %@{.S:X@}
28736 Substitutes @code{X}, if processing a file with suffix @code{S}.
28738 @item %@{!.S:X@}
28739 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28741 @item %@{,S:X@}
28742 Substitutes @code{X}, if processing a file for language @code{S}.
28744 @item %@{!,S:X@}
28745 Substitutes @code{X}, if not processing a file for language @code{S}.
28747 @item %@{S|P:X@}
28748 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28749 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28750 @code{*} sequences as well, although they have a stronger binding than
28751 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28752 alternatives must be starred, and only the first matching alternative
28753 is substituted.
28755 For example, a spec string like this:
28757 @smallexample
28758 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28759 @end smallexample
28761 @noindent
28762 outputs the following command-line options from the following input
28763 command-line options:
28765 @smallexample
28766 fred.c        -foo -baz
28767 jim.d         -bar -boggle
28768 -d fred.c     -foo -baz -boggle
28769 -d jim.d      -bar -baz -boggle
28770 @end smallexample
28772 @item %@{S:X; T:Y; :D@}
28774 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28775 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28776 be as many clauses as you need.  This may be combined with @code{.},
28777 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28780 @end table
28782 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28783 or similar construct can use a backslash to ignore the special meaning
28784 of the character following it, thus allowing literal matching of a
28785 character that is otherwise specially treated.  For example,
28786 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28787 @option{-std=iso9899:1999} option is given.
28789 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28790 construct may contain other nested @samp{%} constructs or spaces, or
28791 even newlines.  They are processed as usual, as described above.
28792 Trailing white space in @code{X} is ignored.  White space may also
28793 appear anywhere on the left side of the colon in these constructs,
28794 except between @code{.} or @code{*} and the corresponding word.
28796 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28797 handled specifically in these constructs.  If another value of
28798 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28799 @option{-W} switch is found later in the command line, the earlier
28800 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28801 just one letter, which passes all matching options.
28803 The character @samp{|} at the beginning of the predicate text is used to
28804 indicate that a command should be piped to the following command, but
28805 only if @option{-pipe} is specified.
28807 It is built into GCC which switches take arguments and which do not.
28808 (You might think it would be useful to generalize this to allow each
28809 compiler's spec to say which switches take arguments.  But this cannot
28810 be done in a consistent fashion.  GCC cannot even decide which input
28811 files have been specified without knowing which switches take arguments,
28812 and it must know which input files to compile in order to tell which
28813 compilers to run).
28815 GCC also knows implicitly that arguments starting in @option{-l} are to be
28816 treated as compiler output files, and passed to the linker in their
28817 proper position among the other output files.
28819 @node Environment Variables
28820 @section Environment Variables Affecting GCC
28821 @cindex environment variables
28823 @c man begin ENVIRONMENT
28824 This section describes several environment variables that affect how GCC
28825 operates.  Some of them work by specifying directories or prefixes to use
28826 when searching for various kinds of files.  Some are used to specify other
28827 aspects of the compilation environment.
28829 Note that you can also specify places to search using options such as
28830 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28831 take precedence over places specified using environment variables, which
28832 in turn take precedence over those specified by the configuration of GCC@.
28833 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28834 GNU Compiler Collection (GCC) Internals}.
28836 @table @env
28837 @item LANG
28838 @itemx LC_CTYPE
28839 @c @itemx LC_COLLATE
28840 @itemx LC_MESSAGES
28841 @c @itemx LC_MONETARY
28842 @c @itemx LC_NUMERIC
28843 @c @itemx LC_TIME
28844 @itemx LC_ALL
28845 @findex LANG
28846 @findex LC_CTYPE
28847 @c @findex LC_COLLATE
28848 @findex LC_MESSAGES
28849 @c @findex LC_MONETARY
28850 @c @findex LC_NUMERIC
28851 @c @findex LC_TIME
28852 @findex LC_ALL
28853 @cindex locale
28854 These environment variables control the way that GCC uses
28855 localization information which allows GCC to work with different
28856 national conventions.  GCC inspects the locale categories
28857 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28858 so.  These locale categories can be set to any value supported by your
28859 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28860 Kingdom encoded in UTF-8.
28862 The @env{LC_CTYPE} environment variable specifies character
28863 classification.  GCC uses it to determine the character boundaries in
28864 a string; this is needed for some multibyte encodings that contain quote
28865 and escape characters that are otherwise interpreted as a string
28866 end or escape.
28868 The @env{LC_MESSAGES} environment variable specifies the language to
28869 use in diagnostic messages.
28871 If the @env{LC_ALL} environment variable is set, it overrides the value
28872 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28873 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28874 environment variable.  If none of these variables are set, GCC
28875 defaults to traditional C English behavior.
28877 @item TMPDIR
28878 @findex TMPDIR
28879 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28880 files.  GCC uses temporary files to hold the output of one stage of
28881 compilation which is to be used as input to the next stage: for example,
28882 the output of the preprocessor, which is the input to the compiler
28883 proper.
28885 @item GCC_COMPARE_DEBUG
28886 @findex GCC_COMPARE_DEBUG
28887 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28888 @option{-fcompare-debug} to the compiler driver.  See the documentation
28889 of this option for more details.
28891 @item GCC_EXEC_PREFIX
28892 @findex GCC_EXEC_PREFIX
28893 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28894 names of the subprograms executed by the compiler.  No slash is added
28895 when this prefix is combined with the name of a subprogram, but you can
28896 specify a prefix that ends with a slash if you wish.
28898 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28899 an appropriate prefix to use based on the pathname it is invoked with.
28901 If GCC cannot find the subprogram using the specified prefix, it
28902 tries looking in the usual places for the subprogram.
28904 The default value of @env{GCC_EXEC_PREFIX} is
28905 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28906 the installed compiler. In many cases @var{prefix} is the value
28907 of @code{prefix} when you ran the @file{configure} script.
28909 Other prefixes specified with @option{-B} take precedence over this prefix.
28911 This prefix is also used for finding files such as @file{crt0.o} that are
28912 used for linking.
28914 In addition, the prefix is used in an unusual way in finding the
28915 directories to search for header files.  For each of the standard
28916 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28917 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28918 replacing that beginning with the specified prefix to produce an
28919 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28920 @file{foo/bar} just before it searches the standard directory 
28921 @file{/usr/local/lib/bar}.
28922 If a standard directory begins with the configured
28923 @var{prefix} then the value of @var{prefix} is replaced by
28924 @env{GCC_EXEC_PREFIX} when looking for header files.
28926 @item COMPILER_PATH
28927 @findex COMPILER_PATH
28928 The value of @env{COMPILER_PATH} is a colon-separated list of
28929 directories, much like @env{PATH}.  GCC tries the directories thus
28930 specified when searching for subprograms, if it cannot find the
28931 subprograms using @env{GCC_EXEC_PREFIX}.
28933 @item LIBRARY_PATH
28934 @findex LIBRARY_PATH
28935 The value of @env{LIBRARY_PATH} is a colon-separated list of
28936 directories, much like @env{PATH}.  When configured as a native compiler,
28937 GCC tries the directories thus specified when searching for special
28938 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28939 using GCC also uses these directories when searching for ordinary
28940 libraries for the @option{-l} option (but directories specified with
28941 @option{-L} come first).
28943 @item LANG
28944 @findex LANG
28945 @cindex locale definition
28946 This variable is used to pass locale information to the compiler.  One way in
28947 which this information is used is to determine the character set to be used
28948 when character literals, string literals and comments are parsed in C and C++.
28949 When the compiler is configured to allow multibyte characters,
28950 the following values for @env{LANG} are recognized:
28952 @table @samp
28953 @item C-JIS
28954 Recognize JIS characters.
28955 @item C-SJIS
28956 Recognize SJIS characters.
28957 @item C-EUCJP
28958 Recognize EUCJP characters.
28959 @end table
28961 If @env{LANG} is not defined, or if it has some other value, then the
28962 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28963 recognize and translate multibyte characters.
28964 @end table
28966 @noindent
28967 Some additional environment variables affect the behavior of the
28968 preprocessor.
28970 @include cppenv.texi
28972 @c man end
28974 @node Precompiled Headers
28975 @section Using Precompiled Headers
28976 @cindex precompiled headers
28977 @cindex speed of compilation
28979 Often large projects have many header files that are included in every
28980 source file.  The time the compiler takes to process these header files
28981 over and over again can account for nearly all of the time required to
28982 build the project.  To make builds faster, GCC allows you to
28983 @dfn{precompile} a header file.
28985 To create a precompiled header file, simply compile it as you would any
28986 other file, if necessary using the @option{-x} option to make the driver
28987 treat it as a C or C++ header file.  You may want to use a
28988 tool like @command{make} to keep the precompiled header up-to-date when
28989 the headers it contains change.
28991 A precompiled header file is searched for when @code{#include} is
28992 seen in the compilation.  As it searches for the included file
28993 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28994 compiler looks for a precompiled header in each directory just before it
28995 looks for the include file in that directory.  The name searched for is
28996 the name specified in the @code{#include} with @samp{.gch} appended.  If
28997 the precompiled header file cannot be used, it is ignored.
28999 For instance, if you have @code{#include "all.h"}, and you have
29000 @file{all.h.gch} in the same directory as @file{all.h}, then the
29001 precompiled header file is used if possible, and the original
29002 header is used otherwise.
29004 Alternatively, you might decide to put the precompiled header file in a
29005 directory and use @option{-I} to ensure that directory is searched
29006 before (or instead of) the directory containing the original header.
29007 Then, if you want to check that the precompiled header file is always
29008 used, you can put a file of the same name as the original header in this
29009 directory containing an @code{#error} command.
29011 This also works with @option{-include}.  So yet another way to use
29012 precompiled headers, good for projects not designed with precompiled
29013 header files in mind, is to simply take most of the header files used by
29014 a project, include them from another header file, precompile that header
29015 file, and @option{-include} the precompiled header.  If the header files
29016 have guards against multiple inclusion, they are skipped because
29017 they've already been included (in the precompiled header).
29019 If you need to precompile the same header file for different
29020 languages, targets, or compiler options, you can instead make a
29021 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29022 header in the directory, perhaps using @option{-o}.  It doesn't matter
29023 what you call the files in the directory; every precompiled header in
29024 the directory is considered.  The first precompiled header
29025 encountered in the directory that is valid for this compilation is
29026 used; they're searched in no particular order.
29028 There are many other possibilities, limited only by your imagination,
29029 good sense, and the constraints of your build system.
29031 A precompiled header file can be used only when these conditions apply:
29033 @itemize
29034 @item
29035 Only one precompiled header can be used in a particular compilation.
29037 @item
29038 A precompiled header cannot be used once the first C token is seen.  You
29039 can have preprocessor directives before a precompiled header; you cannot
29040 include a precompiled header from inside another header.
29042 @item
29043 The precompiled header file must be produced for the same language as
29044 the current compilation.  You cannot use a C precompiled header for a C++
29045 compilation.
29047 @item
29048 The precompiled header file must have been produced by the same compiler
29049 binary as the current compilation is using.
29051 @item
29052 Any macros defined before the precompiled header is included must
29053 either be defined in the same way as when the precompiled header was
29054 generated, or must not affect the precompiled header, which usually
29055 means that they don't appear in the precompiled header at all.
29057 The @option{-D} option is one way to define a macro before a
29058 precompiled header is included; using a @code{#define} can also do it.
29059 There are also some options that define macros implicitly, like
29060 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29061 defined this way.
29063 @item If debugging information is output when using the precompiled
29064 header, using @option{-g} or similar, the same kind of debugging information
29065 must have been output when building the precompiled header.  However,
29066 a precompiled header built using @option{-g} can be used in a compilation
29067 when no debugging information is being output.
29069 @item The same @option{-m} options must generally be used when building
29070 and using the precompiled header.  @xref{Submodel Options},
29071 for any cases where this rule is relaxed.
29073 @item Each of the following options must be the same when building and using
29074 the precompiled header:
29076 @gccoptlist{-fexceptions}
29078 @item
29079 Some other command-line options starting with @option{-f},
29080 @option{-p}, or @option{-O} must be defined in the same way as when
29081 the precompiled header was generated.  At present, it's not clear
29082 which options are safe to change and which are not; the safest choice
29083 is to use exactly the same options when generating and using the
29084 precompiled header.  The following are known to be safe:
29086 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29087 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29088 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29089 -pedantic-errors}
29091 @end itemize
29093 For all of these except the last, the compiler automatically
29094 ignores the precompiled header if the conditions aren't met.  If you
29095 find an option combination that doesn't work and doesn't cause the
29096 precompiled header to be ignored, please consider filing a bug report,
29097 see @ref{Bugs}.
29099 If you do use differing options when generating and using the
29100 precompiled header, the actual behavior is a mixture of the
29101 behavior for the options.  For instance, if you use @option{-g} to
29102 generate the precompiled header but not when using it, you may or may
29103 not get debugging information for routines in the precompiled header.